Merge pull request #30 from blocknative/v0.3.1.5

V0.3.1.5

.github/ISSUE_TEMPLATE/bug.md

@@ -1,30 +1,71 @@
 ---
 name: Report a bug
-about: Something with go-ethereum is not working as expected
+about: Something with bor client is not working as expected
 title: ''
 labels: 'type:bug'
 assignees: ''
 ---
 
-#### System information
+Our support team has aggregated some common issues and their solutions from past which are faced while running or interacting with a bor client. In order to prevent redundant efforts, we would encourage you to have a look at the [FAQ's section](https://docs.polygon.technology/docs/faq/technical-faqs) of our documentation mentioning the same, before filing an issue here. In case of additional support, you can also join our [discord](https://discord.com/invite/zdwkdvMNY2) server
 
-Geth version: `geth version`
-OS & Version: Windows/Linux/OSX
-Commit hash : (if `develop`)
+<!--
+NOTE: Please make sure to check of any addresses / private keys / rpc url's / IP's before sharing the logs or anything from the additional information section (start.sh or heimdall config).
+-->
 
-#### Expected behaviour
+#### **System information**
 
+Bor client version: [e.g. v0.2.16] <!--Can be found by running the command `bor version`-->
 
-#### Actual behaviour
+Heimdall client version: [e.g. v0.2.10] <!--Can be found by running the command `heimdalld version`-->
 
+OS & Version: Windows / Linux / OSX
 
-#### Steps to reproduce the behaviour
+Environment: Polygon Mainnet / Polygon Mumbai / Devnet
 
+Type of node: Validator / Sentry / Archive
 
-#### Backtrace
+Additional Information: <!--Modifications in the client (if any)-->
 
-````
-[backtrace]
-````
+#### **Overview of the problem**
 
-When submitting logs: please submit them as text and not screenshots.
+Please describe the issue you experiencing.
+<!--
+Mention in detail about the issue. Also mention the actual and expected behaviour.
+-->
+
+#### **Reproduction Steps**
+
+Please mention the steps required to reproduce this issue. 
+
+<!--
+E.g. 
+1. Start bor using these flags. 
+2. Node is unable to connect with other peers in the network and keeps disconnecting. 
+-->
+
+#### **Logs / Traces / Output / Error Messages**
+
+Please post any logs/traces/output/error messages (as text and not screenshots) which you believe may have caused the issue. If the log is longer than a few dozen lines, please include the URL to the [gist](https://gist.github.com/) of the log instead of posting it in the issue.
+
+**Additional Information**
+
+In order to debug the issue faster, we would stongly encourage if you can provide some of the details mentioned below (whichever seems relevant to your issue)
+
+1. Your `start.sh` file or `bor.service`, if you're facing some peering issue or unable to use some service (like `http` endpoint) as expected. Moreover, if possible mention the chain configuration printed while starting the node which looks something like `Initialised chain configuration config="{ChainID: 137, ..., Engine: bor}"`
+<!--
+It should be start.sh if you're using bor v0.2.x and bor.service (ideally located under `/lib/systemd/system/`) if it's bor v0.3.x. Mention this file if you're facing any issues like unable to use some flag/s according to their expected behaviour.
+-->
+2. The result of `eth.syncing`, `admin.peers.length`, `admin.nodeInfo`, value of the `maxpeers` flag in start.sh, and bootnodes/static nodes (if any) is you're facing some syncing issue.
+<!--
+You can get the above results by attaching to the IPC using the command `bor attach $BORDIR/bor.ipc` or `bor attach $DATADIR/bor.ipc` and running the mentioned commands. 
+Mention this if you're facing issues where bor keeps stalling and is not importing new blocks or making any progress. Adding chain configuration mentioned in the previous step would also be really helpful here as it might also be a genesis mismatch issue.
+-->
+3. Your `heimdall-config.toml` parameters for checking the ETH and BOR RPC url's, incase of issue with bor heimdall communication. 
+<!--
+The location should be `~/.heimdalld/config/` if running heimdall v0.2.x and `/var/lib/heimdalld/config` if running heimdall v0.3.x. 
+As a sub-set of syncing issues, if your node keeps printing logs like `Retrying again in 5 seconds to fetch data from Heimdall`, it might be an issue with the communication between your bor node and heimdall node. In this case, also check if all the heimdall services (heimdalld, bridge, rest-server) are running correctly.
+-->
+4. The CURL request (for that specific error) if you're facing any issues or identify a bug while making RPC request.  
+<!--
+Make sure you hide the IP of your machine if you're doing the request externally.  
+-->

.github/ISSUE_TEMPLATE/feature.md

@@ -8,10 +8,11 @@ assignees: ''
 
 # Rationale
 
-Why should this feature exist?
+The motivation behind the feature and why should this feature exist?
 What are the use-cases?
 
 # Implementation
 
-Do you have ideas regarding the implementation of this feature?
-Are you willing to implement this feature?
+Do you have ideas regarding the implementation of this feature? (Mention reference links if any)
+Any alternative solutions or features you've considered?
+Are you willing to implement this feature?

.github/ISSUE_TEMPLATE/question.md

@@ -1,9 +1,11 @@
 ---
-name: Ask a question
-about: Something is unclear
+name: Question/Support
+about: Ask a question or request support
 title: ''
 labels: 'type:docs'
 assignees: ''
 ---
 
-This should only be used in very rare cases e.g. if you are not 100% sure if something is a bug or asking a question that leads to improving the documentation. For general questions please use [discord](https://discord.gg/nthXNEv) or the Ethereum stack exchange at https://ethereum.stackexchange.com.
+This should only be used in very rare cases e.g. if you are not 100% sure if something is a bug or asking a question that leads to improving the documentation. 
+
+For general questions please join our [discord](https://discord.com/invite/zdwkdvMNY2) server.

.github/matic-cli-config.yml

@@ -3,9 +3,13 @@ defaultFee: 2000
 borChainId: "15001"
 heimdallChainId: heimdall-15001
 contractsBranch: jc/v0.3.1-backport
+sprintSize: 64
+blockNumber: '0'
+blockTime: '2'
 numOfValidators: 3
 numOfNonValidators: 0
 ethURL: http://ganache:9545
+ethHostUser: ubuntu
 devnetType: docker
 borDockerBuildContext: "../../bor"
-heimdallDockerBuildContext: "https://github.com/maticnetwork/heimdall.git#develop"
+heimdallDockerBuildContext: "https://github.com/maticnetwork/heimdall.git#develop"

.github/pull_request_template.md

@@ -0,0 +1,44 @@
+# Description
+
+Please provide a detailed description of what was done in this PR
+
+# Changes
+
+- [ ] Bugfix (non-breaking change that solves an issue)
+- [ ] Hotfix (change that solves an urgent issue, and requires immediate attention)
+- [ ] New feature (non-breaking change that adds functionality)
+- [ ] Breaking change (change that is not backwards-compatible and/or changes current functionality)
+
+# Breaking changes
+
+Please complete this section if any breaking changes have been made, otherwise delete it
+
+# Checklist
+
+- [ ] I have added at least 2 reviewer or the whole pos-v1 team
+- [ ] I have added sufficient documentation in code
+- [ ] I will be resolving comments - if any - by pushing each fix in a separate commit and linking the commit hash in the comment reply
+
+# Cross repository changes
+
+- [ ] This PR requires changes to heimdall
+    - In case link the PR here:
+- [ ] This PR requires changes to matic-cli
+    - In case link the PR here:
+
+## Testing
+
+- [ ] I have added unit tests
+- [ ] I have added tests to CI
+- [ ] I have tested this code manually on local environment
+- [ ] I have tested this code manually on remote devnet using express-cli
+- [ ] I have tested this code manually on mumbai
+- [ ] I have created new e2e tests into express-cli
+
+### Manual tests
+
+Please complete this section with the steps you performed if you ran manual tests for this functionality, otherwise delete it
+
+# Additional comments
+
+Please post additional comments in this section if you have them, otherwise delete it

.github/workflows/ci.yml

@@ -8,7 +8,7 @@ on:
   pull_request:
     branches:
       - "**"
-    types: [opened, synchronize, edited]
+    types: [opened, synchronize]
 
 concurrency:
   group: build-${{ github.event.pull_request.number || github.ref }}
@@ -19,7 +19,7 @@ jobs:
     if: (github.event.action != 'closed' || github.event.pull_request.merged == true)
     strategy:
       matrix:
-        os: [ ubuntu-20.04, macos-11 ] # list of os: https://github.com/actions/virtual-environments
+        os: [ ubuntu-20.04 ] # list of os: https://github.com/actions/virtual-environments
     runs-on: ${{ matrix.os }}
     steps:
         - uses: actions/checkout@v3
@@ -29,7 +29,7 @@ jobs:
 
         - uses: actions/setup-go@v3
           with:
-            go-version: 1.18.x
+            go-version: 1.19.x
 
         - name: Install dependencies on Linux
           if: runner.os == 'Linux'
@@ -63,7 +63,7 @@ jobs:
 
         - name: test-integration
           run: make test-integration
-        
+
         - name: Upload coverage to Codecov
           uses: codecov/codecov-action@v1
           with:
@@ -104,7 +104,7 @@ jobs:
           uses: actions/checkout@v3
           with:
             repository: maticnetwork/matic-cli
-            ref: v0.3.0-dev
+            ref: arpit/pos-655-2
             path: matic-cli
 
         - name: Install dependencies on Linux
@@ -154,7 +154,7 @@ jobs:
             cd matic-cli/devnet/code/contracts
             npm run truffle exec scripts/deposit.js -- --network development $(jq -r .root.tokens.MaticToken contractAddresses.json) 100000000000000000000
             cd -
-            bash bor/integration-tests/smoke_test.sh
+            timeout 20m bash bor/integration-tests/smoke_test.sh
 
         - name: Upload logs
           if: always()

.gitignore

@@ -53,3 +53,5 @@ profile.cov
 ./bor-debug-*
 
 dist
+
+*.csv

.gitmodules

@@ -6,3 +6,6 @@
 	path = tests/evm-benchmarks
 	url = https://github.com/ipsilon/evm-benchmarks
 	shallow = true
+[submodule "tests/testdata"]
+	path = tests/testdata
+	url = https://github.com/ethereum/tests.git

.golangci.yml

@@ -50,6 +50,7 @@ linters:
     - unconvert
     - unparam
     - wsl
+    - asasalint
     #- errorlint causes stack overflow. TODO: recheck after each golangci update
 
 linters-settings:

Makefile

@@ -34,6 +34,10 @@ bor:
 protoc:
 	protoc --go_out=. --go-grpc_out=. ./internal/cli/server/proto/*.proto
 
+generate-mocks:
+	go generate mockgen -destination=./tests/bor/mocks/IHeimdallClient.go -package=mocks ./consensus/bor IHeimdallClient
+	go generate mockgen -destination=./eth/filters/IBackend.go -package=filters ./eth/filters Backend
+
 geth:
 	$(GORUN) build/ci.go install ./cmd/geth
 	@echo "Done building."
@@ -61,7 +65,7 @@ test-race:
 	$(GOTEST) --timeout 15m -race -shuffle=on $(TESTALL)
 
 test-integration:
-	$(GOTEST) --timeout 30m -tags integration $(TESTE2E)
+	$(GOTEST) --timeout 60m -tags integration $(TESTE2E)
 
 escape:
 	cd $(path) && go test -gcflags "-m -m" -run none -bench=BenchmarkJumpdest* -benchmem -memprofile mem.out
@@ -71,7 +75,7 @@ lint:
 
 lintci-deps:
 	rm -f ./build/bin/golangci-lint
-	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b ./build/bin v1.46.0
+	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b ./build/bin v1.48.0
 
 goimports:
 	goimports -local "$(PACKAGE)" -w .
@@ -93,7 +97,7 @@ devtools:
 	$(GOBUILD) -o $(GOBIN)/codecgen github.com/ugorji/go/codec/codecgen
 	$(GOBUILD) -o $(GOBIN)/abigen ./cmd/abigen
 	$(GOBUILD) -o $(GOBIN)/mockgen github.com/golang/mock/mockgen
-	$(GOBUILD) -o $(GOBIN)/protoc-gen-go github.com/golang/protobuf/protoc-gen-go
+	$(GOBUILD) -o $(GOBIN)/protoc-gen-go google.golang.org/protobuf/cmd/protoc-gen-go
 	PATH=$(GOBIN):$(PATH) go generate ./common
 	PATH=$(GOBIN):$(PATH) go generate ./core/types
 	PATH=$(GOBIN):$(PATH) go generate ./consensus/bor
@@ -192,7 +196,7 @@ geth-windows-amd64:
 	@ls -ld $(GOBIN)/geth-windows-* | grep amd64
 
 PACKAGE_NAME          := github.com/maticnetwork/bor
-GOLANG_CROSS_VERSION  ?= v1.18.1
+GOLANG_CROSS_VERSION  ?= v1.19.1
 
 .PHONY: release-dry-run
 release-dry-run:
@@ -220,6 +224,7 @@ release:
 		-e DOCKER_PASSWORD \
 		-e SLACK_WEBHOOK \
 		-v /var/run/docker.sock:/var/run/docker.sock \
+		-v $(HOME)/.docker/config.json:/root/.docker/config.json \
 		-v `pwd`:/go/src/$(PACKAGE_NAME) \
 		-w /go/src/$(PACKAGE_NAME) \
 		goreleaser/goreleaser-cross:${GOLANG_CROSS_VERSION} \

README.md

@@ -1,5 +1,5 @@
 # Bor Overview
-Bor is the Official Golang implementation of the Matic protocol. It is a fork of Go Ethereum - https://github.com/ethereum/go-ethereum and EVM compabile.
+Bor is the Official Golang implementation of the Matic protocol. It is a fork of Go Ethereum - https://github.com/ethereum/go-ethereum and EVM compatible.
 
 ![Forks](https://img.shields.io/github/forks/maticnetwork/bor?style=social)
 ![Stars](https://img.shields.io/github/stars/maticnetwork/bor?style=social)