Merge pull request #324 from 0xProject/v2.0.0-beta

Release V2.0.0 beta

Author: fabioberger

.circleci/config.yml

@@ -43,3 +43,16 @@ jobs:
       - run:
           name: Test installing Mesh without CGO
           command: CGO_ENABLED=0 go install ./...
+      - run:
+          name: Install TS RPC client dependencies
+          command: cd rpc/clients/typescript && yarn install
+      - run:
+          name: Run TS RPC client linter
+          command: cd rpc/clients/typescript && yarn lint
+      - run:
+          name: Build TS RPC client
+          command: cd rpc/clients/typescript && yarn build
+      - run:
+          name: Run TS RPC client tests
+          command: cd rpc/clients/typescript && yarn test
+

.gitbook.yaml

@@ -0,0 +1,5 @@
+root: ./docs/
+
+structure:
+    readme: ../README.md
+    summary: ./SUMMARY.md

.gitignore

@@ -1,6 +1,9 @@
+.DS_Store
 vendor/
 node_modules/
 TODO.md
 0x_mesh/
 examples/javascript_websocket_client/node_modules
 examples/javascript_websocket_client/lib
+rpc/clients/typescript/node_modules
+rpc/clients/typescript/lib

Gopkg.lock

@@ -108,3 +108,7 @@
 [[constraint]]
   name = "github.com/libp2p/go-libp2p-autonat-svc"
   version = "0.0.6"
+
+[[constraint]]
+  name = "github.com/hashicorp/golang-lru"
+  version = "0.5.1"

Gopkg.toml

@@ -33,7 +33,7 @@ test-all: test-go test-wasm
 
 .PHONY: test-go
 test-go:
-	go test ./... -race
+	go test ./... -race -timeout 30s
 
 
 .PHONY: test-wasm
@@ -65,6 +65,10 @@ mesh-bootstrap:
 db-integrity-check:
 	go install ./cmd/db-integrity-check
 
+.PHONY: cut-release
+cut-release:
+	go run ./cmd/cut-release/main.go
+
 
 .PHONY: all
 all: mesh mesh-keygen mesh-bootstrap db-integrity-check

Makefile

@@ -1,4 +1,4 @@
-[![Version](https://img.shields.io/badge/version-1.0.6--beta-orange.svg)](https://github.com/0xProject/0x-mesh/releases)
+[![Version](https://img.shields.io/badge/version-2.0.0--beta-orange.svg)](https://github.com/0xProject/0x-mesh/releases)
 [![Chat with us on Discord](https://img.shields.io/badge/chat-Discord-blueViolet.svg)](https://discord.gg/HF7fHwk)
 [![GoDoc](https://godoc.org/github.com/0xProject/0x-mesh?status.svg)](https://godoc.org/github.com/0xProject/0x-mesh)
 [![Circle CI](https://img.shields.io/circleci/project/0xProject/0x-mesh/master.svg)](https://circleci.com/gh/0xProject/0x-mesh/tree/master)
@@ -8,30 +8,24 @@
 0x Mesh is a peer-to-peer network for sharing orders that adhere to the
 [0x order message format](https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md#order-message-format).
 
-:no_entry: WARNING: This project is still under active development. Expect breaking changes before the official release. :no_entry:
-
-## Versions
-
-You are looking at the documentation for version `1.0.6-beta`. To see the
-documentation for a different version, visit the
-[Releases Page](https://github.com/0xProject/0x-mesh/releases).
+WARNING: This project is still under active development. Expect breaking changes before the official release.
 
 ## Deployment
 
-[The Deployment Guide](DEPLOYMENT.md)
+[The Deployment Guide](docs/DEPLOYMENT.md)
 will walk you through how to configure and deploy your own 0x Mesh node.
 
 ## Usage
 
 Once you have deployed a 0x Mesh node, the
-[Usage Guide](USAGE.md)
+[Usage Guide](docs/USAGE.md)
 explains how to interact with it using the JSON-RPC API.
 
 ## Development
 
 We love receiving contributions from the community :smile: If you are interested
 in helping develop 0x Mesh, please read the
-[Development Guide](DEVELOPMENT.md).
+[Development Guide](docs/DEVELOPMENT.md).
 If you are looking for a place to start, take a look at the
 [issues page](https://github.com/0xProject/0x-mesh/issues) and don't hesitate to
 [reach out to us on Discord](https://discord.gg/HF7fHwk).

README.md

@@ -0,0 +1,132 @@
+package main
+
+import (
+	"fmt"
+	"io/ioutil"
+	"log"
+	"os"
+	"os/exec"
+	"regexp"
+	"strings"
+
+	"github.com/plaid/go-envvar/envvar"
+)
+
+type envVars struct {
+	// Version is the new release version to use
+	Version string `envvar:"VERSION"`
+}
+
+func main() {
+	env := envVars{}
+	if err := envvar.Parse(&env); err != nil {
+		log.Fatal(err)
+	}
+
+	updateHardCodedVersions(env.Version)
+
+	generateTypescriptClientDocs()
+}
+
+func generateTypescriptClientDocs() {
+	// Run `yarn install` to make sure `TypeDoc` dep is installed
+	cmd := exec.Command("yarn", "install", "--frozen-lockfile")
+	cmd.Dir = "rpc/clients/typescript"
+	stdoutStderr, err := cmd.CombinedOutput()
+	if err != nil {
+		log.Print(string(stdoutStderr))
+		log.Fatal(err)
+	}
+
+	// Run `yarn docs:md` to generate MD docs
+	cmd = exec.Command("yarn", "docs:md")
+	cmd.Dir = "rpc/clients/typescript"
+	stdoutStderr, err = cmd.CombinedOutput()
+	if err != nil {
+		log.Print(string(stdoutStderr))
+		log.Fatal(err)
+	}
+
+	// Update SUMMARY.md
+	tsClientSummaryPath := "docs/json_rpc_clients/typescript/SUMMARY.md"
+	dat, err := ioutil.ReadFile(tsClientSummaryPath)
+	if err != nil {
+		log.Fatal(err)
+	}
+	// Modify the paths to be prefixed with `json_rpc_clients/typescript`
+	modifiedDat := strings.Replace(string(dat), "](", "](json_rpc_clients/typescript/", -1)
+	modifiedDat = strings.Replace(modifiedDat, "](json_rpc_clients/typescript/)", "]()", -1)
+	finalTsClientSummary := strings.Replace(modifiedDat, "* [", "  * [", -1)
+
+	// Replace the summary content nested under `Typescript client`
+	mainSummaryPath := "docs/SUMMARY.md"
+	dat, err = ioutil.ReadFile(mainSummaryPath)
+	if err != nil {
+		log.Fatal(err)
+	}
+	finalSummaryLines := []string{}
+	lines := strings.Split(string(dat), "\n")
+	isCutting := false
+	for _, l := range lines {
+		if strings.Contains(l, "<!-- END TYPEDOC GENERATED SUMMARY -->") {
+			isCutting = false
+			finalSummaryLines = append(finalSummaryLines, finalTsClientSummary)
+		}
+		if !isCutting {
+			finalSummaryLines = append(finalSummaryLines, l)
+		}
+		if strings.Contains(l, "<!-- START TYPEDOC GENERATED SUMMARY -->") {
+			isCutting = true
+		}
+	}
+	finalSummary := strings.Join(finalSummaryLines, "\n")
+	err = ioutil.WriteFile(mainSummaryPath, []byte(finalSummary), 0644)
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	// Remove the nested SUMMARY.MD file
+	err = os.Remove(tsClientSummaryPath)
+	if err != nil {
+		log.Fatal(err)
+	}
+}
+
+// Update the version string in all files that must be updated for a new release
+func updateHardCodedVersions(version string) {
+
+	// Update `rpc/clients/typescript/package.json`
+	tsClientPackageJSONPath := "rpc/clients/typescript/package.json"
+	newVersionString := fmt.Sprintf(`"version": "%s"`, version)
+	regex := `"version": "(.*)"`
+	updateFileWithRegex(tsClientPackageJSONPath, regex, newVersionString)
+
+	// Update `core.go`
+	corePath := "core/core.go"
+	newVersionString = fmt.Sprintf(`version$1= "%s"`, version)
+	regex = `version(.*)= "(.*)"`
+	updateFileWithRegex(corePath, regex, newVersionString)
+
+	// Update badge in README.md
+	pathToMDFilesWithBadges := []string{"README.md", "docs/USAGE.md", "docs/DEVELOPMENT.md", "docs/DEPLOYMENT.md"}
+	doubleDashVersion := strings.Replace(version, "-", "--", -1)
+	newSvgName := fmt.Sprintf("version-%s-orange.svg", doubleDashVersion)
+	regex = `version-(.*)-orange.svg`
+	for _, path := range pathToMDFilesWithBadges {
+		updateFileWithRegex(path, regex, newSvgName)
+	}
+}
+
+func updateFileWithRegex(filePath string, regex string, replacement string) {
+	dat, err := ioutil.ReadFile(filePath)
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	var re = regexp.MustCompile(regex)
+	modifiedDat := []byte(re.ReplaceAllString(string(dat), replacement))
+	err = ioutil.WriteFile(filePath, modifiedDat, 0644)
+	if err != nil {
+		log.Fatal(err)
+	}
+}

cmd/demo/add_peer/main.go cmd/add_peer/main.go

@@ -6,6 +6,8 @@
 package main
 
 import (
+	"context"
+
 	"github.com/0xProject/0x-mesh/core"
 	"github.com/plaid/go-envvar/envvar"
 	log "github.com/sirupsen/logrus"
@@ -39,17 +41,21 @@ func main() {
 	if err != nil {
 		log.WithField("error", err.Error()).Fatal("could not initialize app")
 	}
-	if err := app.Start(); err != nil {
-		log.WithField("error", err.Error()).Fatal("fatal error while starting app")
-	}
-	defer app.Close()
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
+
+	go func() {
+		if err := app.Start(ctx); err != nil {
+			cancel()
+			log.WithField("error", err.Error()).Error("core app exited with error")
+		}
+	}()
 
 	// Start RPC server.
 	go func() {
-		err := listenRPC(app, config)
-		if err != nil {
-			app.Close()
-			log.WithField("error", err.Error()).Fatal("RPC server returned error")
+		if err := listenRPC(app, config, ctx); err != nil {
+			cancel()
+			log.WithField("error", err.Error()).Error("RPC server returned error")
 		}
 	}()
 

cmd/cut-release/main.go

@@ -25,7 +25,7 @@ type rpcHandler struct {
 
 // listenRPC starts the RPC server and listens on config.RPCPort. It blocks
 // until there is an error or the RPC server is closed.
-func listenRPC(app *core.App, config standaloneConfig) error {
+func listenRPC(app *core.App, config standaloneConfig, ctx context.Context) error {
 	// Initialize the JSON RPC WebSocket server (but don't start it yet).
 	rpcAddr := fmt.Sprintf(":%d", config.RPCPort)
 	rpcHandler := &rpcHandler{
@@ -38,11 +38,16 @@ func listenRPC(app *core.App, config standaloneConfig) error {
 	go func() {
 		// Wait for the server to start listening and select an address.
 		for rpcServer.Addr() == nil {
+			select {
+			case <-ctx.Done():
+				return
+			default:
+			}
 			time.Sleep(10 * time.Millisecond)
 		}
 		log.WithField("address", rpcServer.Addr().String()).Info("started RPC server")
 	}()
-	return rpcServer.Listen()
+	return rpcServer.Listen(ctx)
 }
 
 // GetOrders is called when an RPC client calls GetOrders.
@@ -86,6 +91,17 @@ func (handler *rpcHandler) AddPeer(peerInfo peerstore.PeerInfo) error {
 	return nil
 }
 
+// GetStats is called when an RPC client calls GetStats,
+func (handler *rpcHandler) GetStats() (*rpc.GetStatsResponse, error) {
+	log.Debug("received GetStats request via RPC")
+	getStatsResponse, err := handler.app.GetStats()
+	if err != nil {
+		log.WithField("error", err.Error()).Error("internal error in GetStats RPC call")
+		return nil, constants.ErrInternal
+	}
+	return getStatsResponse, nil
+}
+
 // SubscribeToOrders is called when an RPC client sends a `mesh_subscribe` request with the `orders` topic parameter
 func (handler *rpcHandler) SubscribeToOrders(ctx context.Context) (*ethRpc.Subscription, error) {
 	log.Debug("received order event subscription request via RPC")