Improve RPC API compatibility for Ethers.js

.circleci/config.yml

@@ -114,7 +114,7 @@ parameters:
 executors:
   golang:
     docker:
-      - image: circleci/golang:1.16
+      - image: "us.gcr.io/celo-testnet/circleci-node12-golang1.17.5"
     working_directory: ~/repos/geth
     environment:
       # Change the go modules to be cached under ~/repos so that we can add
@@ -309,6 +309,7 @@ jobs:
       - attach_workspace:
           at: ~/repos
       - *restore-go-mod-cache
+      - run: make prepare-ethersjs-project
       - run: go get github.com/jstemmer/go-junit-report
       - run:
           name: Run tests
@@ -330,6 +331,7 @@ jobs:
       - attach_workspace:
           at: ~/repos
       - *restore-go-mod-cache
+      - run: make prepare-ethersjs-project
       - run: go get github.com/jstemmer/go-junit-report
       - run:
           name: Run tests
@@ -351,11 +353,12 @@ jobs:
       - attach_workspace:
           at: ~/repos
       - *restore-go-mod-cache
+      - run: make prepare-ethersjs-project
         # Run the tests with coverage parse the coverage and output the summary
       - run:
           name: Run tests and print coverage summary
           command: |
-            go test -coverprofile cov.out -coverpkg ./consensus/istanbul/... ./e2e_test 
+            go test -v -coverprofile cov.out -coverpkg ./consensus/istanbul/... ./e2e_test 
             go run tools/parsecov/main.go -packagePrefix github.com/celo-org/celo-blockchain/ cov.out > summary
             cat summary
 

.circleci/node-golang-dockerfile/Dockerfile

@@ -0,0 +1,7 @@
+# This has been pushed to us.gcr.io/celo-testnet/circleci-node12-golang1.17.5
+FROM circleci/node:12
+
+COPY --from=circleci/golang:1.17.5 /usr/local/go/ /usr/local/go/
+
+ENV PATH="/home/circleci/go/bin:${PATH}"
+ENV PATH="/usr/local/go/bin:${PATH}"

Makefile

@@ -7,7 +7,7 @@
 .PHONY: geth-linux-arm geth-linux-arm-5 geth-linux-arm-6 geth-linux-arm-7 geth-linux-arm64
 .PHONY: geth-darwin geth-darwin-amd64
 .PHONY: geth-windows geth-windows-386 geth-windows-amd64
-.PHONY: prepare-system-contracts
+.PHONY: prepare prepare-system-contracts prepare-ethersjs-project
 
 GOBIN = ./build/bin
 GO ?= latest
@@ -45,6 +45,13 @@ geth:
 	@echo "Done building."
 	@echo "Run \"$(GOBIN)/geth\" to launch geth."
 
+prepare: prepare-system-contracts prepare-ethersjs-project
+
+prepare-ethersjs-project: ./ethersjs-api-check/node_modules
+
+./ethersjs-api-check/node_modules: ./ethersjs-api-check/package.json ./ethersjs-api-check/package-lock.json
+	@cd ./ethersjs-api-check && npm ci
+
 # This rule checks out celo-monorepo under MONOREPO_PATH at the commit contained in
 # monorepo_commit and compiles the system solidity contracts. It then copies the
 # compiled contracts from the monorepo to the compiled-system-contracts, so

README.md

@@ -14,7 +14,7 @@ Most functionality of this client is similar to `go-ethereum`, also known as `ge
 
 ## Building the source
 
-Building `geth` requires both a Go (version 1.16) and a C compiler.
+Building `geth` requires both Go (min version 1.15) and a C compiler.
 You can install them using your favourite package manager. Once the dependencies are installed, run
 
 ```shell
@@ -58,7 +58,12 @@ The Celo blockchain client comes with several wrappers/executables found in the
 
 ## Running tests
 
-Prior to running tests you will need to run `make prepare-system-contracts`.
+Prior to running tests you will need to run `make prepare`, this will run two sub rules.
+
+Without first running this `make prepare`, certain tests will fail.
+
+### prepare-system-contracts
+
 This will shallow checkout the
 [celo-monorepo](https://github.com/celo-org/celo-monorepo) under
 `../.celo-blockchain-monorepo-checkout` relative to this project's root at the
@@ -86,8 +91,8 @@ those checked out by the `prepare-system-contracts` rule, and the checkouts
 created by the `prepare-system-contracts` rule should not be manually modifed,
 aside from changing the contract source.
 
-
-Without first running this make rule, certain tests will fail.
+### prepare-ethersjs-project
+This will install dependencies for the `ethersjs-api-check` typescript project.
 
 ## Running Celo
 

e2e_test/e2e_test.go

@@ -5,6 +5,8 @@ import (
 	"errors"
 	"fmt"
 	"math/big"
+	"os/exec"
+	"strings"
 	"sync"
 	"testing"
 	"time"
@@ -451,3 +453,52 @@ func pruneStateOfBlock(ctx context.Context, node *test.Node, blockHash common.Ha
 
 	return nil
 }
+
+func TestEthersJSCompatibility(t *testing.T) {
+	ac := test.AccountConfig(1, 1)
+	gc, ec, err := test.BuildConfig(ac)
+	require.NoError(t, err)
+	network, shutdown, err := test.NewNetwork(ac, gc, ec)
+	require.NoError(t, err)
+	defer shutdown()
+
+	ctx, cancel := context.WithTimeout(context.Background(), time.Second*20)
+	defer cancel()
+
+	num, err := network[0].WsClient.BlockNumber(ctx)
+	require.NoError(t, err)
+
+	// Execute typescript tests to check ethers.js compatibility.
+	//
+	// The '--networkaddr' and '--blocknum' flags are npm config variables, the
+	// values become available under 'process.env.npm_config_networkaddr' and
+	// 'process.env.npm_config_blocknum' in typescript test. Everything after
+	// '--' are flags that are passed to mocha and these flags are controlling
+	// which tests to run.
+
+	// The tests don't seem to work on CI with IPV6 addresses so we convert to IPV4 here
+	addr := strings.Replace(network[0].Node.HTTPEndpoint(), "[::]", "127.0.0.1", 1)
+
+	cmd := exec.Command("npm", "run", "test", "--networkaddr="+addr, "--blocknum="+hexutil.Uint64(num).String(), "--", "--invert", "--grep", "block with pruned")
+	cmd.Dir = "../ethersjs-api-check/"
+	println("executing mocha test with", cmd.String())
+	output, err := cmd.CombinedOutput()
+	println(string(output))
+	require.NoError(t, err)
+
+	err = network[0].Tracker.AwaitBlock(ctx, num+1)
+	require.NoError(t, err)
+	block := network[0].Tracker.GetProcessedBlock(num)
+
+	// Prune state
+	err = pruneStateOfBlock(ctx, network[0], block.Hash())
+	require.NoError(t, err)
+
+	// Execute typescript tests to check what happens with a pruned block.
+	cmd = exec.Command("npm", "run", "test", "--networkaddr="+addr, "--blocknum="+hexutil.Uint64(num).String(), "--", "--grep", "block with pruned")
+	cmd.Dir = "../ethersjs-api-check/"
+	println("executing mocha test with", cmd.String())
+	output, err = cmd.CombinedOutput()
+	println(string(output))
+	require.NoError(t, err)
+}

ethersjs-api-check/.gitignore

@@ -0,0 +1,3 @@
+node_modules
+dist
+