feat!: hard-fork (#43)

* Hard-fork by renaming the repo.

* Update gitignore

* Update makefile

* Update codegen

* Update readme

* Format codebase

* Copy lint rules from node's repo

* Fix linter [2]

* Fix linter [3]

* Fix linter [4]

* Fix linter [5]

* Match node's go version

* Copy CI flow from node's repo

* Fix linter & add CODEOWNERS

* Disable leader-less test suite

* Update go.mod to work with node's go.mod

* update linter

* Use dynamic free ports

* Bump cosmos-sdk dep

* Disable -race in CI

Author: swift1337

.github/CODEOWNERS

@@ -0,0 +1,3 @@
+* @zeta-chain/protocol-engineering
+
+.github/** @zeta-chain/devops

.github/workflows/ci.yml

@@ -20,16 +20,25 @@ jobs:
         with:
           go-version: ${{ matrix.go-version }}
       - name: Test
-        run: go test -race -timeout 25m ./...
+        run: go test -timeout 25m ./...
   lint:
-    name: lint
     runs-on: ubuntu-22.04
+    timeout-minutes: 15
+    env:
+      GO111MODULE: on
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-go@v5
+      - name: Checkout Source
+        uses: actions/checkout@v4
         with:
-          go-version: 1.22
-      - name: golangci-lint
+          fetch-depth: 0
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: '1.23'
+
+      - name: Run golangci-lint
         uses: golangci/golangci-lint-action@v6
         with:
-          version: v1.56.2
+          version: v1.63.4
+          skip-cache: true

.gitignore

@@ -2,22 +2,14 @@
 .DS_Store
 *.swp
 *.swo
-.vscode
-.idea
 .env*
 
-# Build
-vendor
-.vendor-new
-observe
-
 # IDE
+.vscode/
 .idea/
-*.iml
 
 bin/
 thord
-*.exe
 .testCoverage.txt
 c.out
 *.leveldb/

.gitlab-ci.yml

@@ -1,24 +1,53 @@
+run:
+  go: "1.22.11"
+  timeout: 5m
+  tests: false # exclude test from linting
+
 linters:
   disable-all: true
   enable:
-    - deadcode
     - errcheck
-    - golint
+    - revive
     - ineffassign
     - unconvert
     - misspell
+    - goimports
     - govet
+    - stylecheck
+    - typecheck
+    - misspell
+    # - prealloc not really useful imo
+    - dogsled
+    - goconst
+    - bodyclose
+    - unconvert
+    - unused
+    - gci
+    - gofmt
+    - whitespace
+
 linters-settings:
   gocyclo:
     min-complexity: 11
   errcheck:
-    ignore: fmt:.*,io/ioutil:^Read.*,github.com/spf13/cobra:MarkFlagRequired,github.com/spf13/viper:BindPFlag
-  golint:
-    min-confidence: 1.1
+    exclude-functions:
+      - fmt:.*
+      - io/ioutil:^Read.*,
+      - github.com/spf13/cobra:MarkFlagRequired
+      - github.com/spf13/viper:BindPFlag
+  exhaustive:
+    check-generated: false
+  gci:
+    # Gci controls Go package import order and makes it always deterministic
+    # https://golangci-lint.run/usage/linters/#gci
+    sections:
+      - standard
+      - default
+      - prefix(github.com/zeta-chain/go-tss)
+    skip-generated: true
+
 issues:
+  exclude-generated: strict
   exclude:
     - composite
-run:
-  tests: false
-  deadline: 15m
-  timeout: 5m
+  exclude-dirs: [ ".git", ".github" ]

.golangci.yml

@@ -1,50 +1,42 @@
-module = gitlab.com/thorchain/tss/go-tss
+module = github.com/zeta-chain/go-tss
 
-.PHONY: clear tools install test test-watch lint-pre lint lint-verbose protob build docker-gitlab-login docker-gitlab-push docker-gitlab-build
+help: ## List of commands
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
 
-all: lint build
+deps: ## Install required dev tooling:
+	go install github.com/golangci/golangci-lint/cmd/[email protected]
+	go install github.com/segmentio/[email protected]
 
-clear:
-	clear
-
-tools:
+tools: ## Installs tss tools
 	go install ./cmd/tss-recovery
 	go install ./cmd/tss-benchgen
 	go install ./cmd/tss-benchsign
 
-install: go.sum
+install: go.sum ## Compiles & install go-tss binary
 	go install ./cmd/tss
 
-go.sum: go.mod
+go.sum: go.mod ## Go sum
 	@echo "--> Ensure dependencies have not been modified"
 	go mod verify
 
-test:
-	@go test --race -timeout 30m ./...
+test: ## Runs tests
+	@go test -race -timeout 30m ./...
 
-test-watch: clear
-	@gow -c test -tags testnet -mod=readonly ./...
+fmt: ## Formats the code
+	@echo "Fixing long lines"
+	@golines -w --max-len=120 --ignore-generated --ignored-dirs=".git" --base-formatter="gofmt" .
 
-unittest:
-	@go test --race -v -coverprofile=coverage.out -timeout 30m ./...
-	@go tool cover -func=coverage.out
+	@echo "Formatting code"
+	@golangci-lint run --enable-only 'gci' --enable-only 'gofmt' --enable-only 'whitespace' --fix
 
-lint-pre:
-	@gofumpt -l cmd common keygen keysign messages p2p storage tss # for display
-	@test -z "$(shell gofumpt -l cmd common keygen keysign messages p2p storage tss)" # cause error
-	@go mod verify
+lint-pre: ## Runs pre-lint check
+	@test -z $(gofmt -l .)
+	go mod verify
 
-lint: lint-pre
+lint: lint-pre ## Runs linter
 	@golangci-lint run
 
-lint-verbose: lint-pre
-	@golangci-lint run -v
-
-protob:
+codegen: ## Generates proto
 	protoc --go_out=module=$(module):. ./messages/*.proto
 
-build: protob
-	go build ./...
-
-docker-build:
-	docker build -t registry.gitlab.com/thorchain/tss/go-tss .
+.PHONY: deps tools install test fmt lint-pre lint codegen

Makefile

@@ -1,11 +1,5 @@
-# THORCHain TSS
+# Zetachain Threshold Signature Scheme (TSS) P2P server
 
-This repository wraps tss-lib with the networking level coordination code used in Thorchain.
-
-### How to contribute
-
-* Create an issue or find an existing issue on https://gitlab.com/thorchain/tss/go-tss/-/issues
-* Assign the issue to yourself
-* Raise a PR, making sure to include "Resolves #<issue number>" in the description
-* Make sure the pipeline is green
-* Once PR is approved, the team will merge it to master
+- Forked from https://gitlab.com/thorchain/tss/go-tss
+- Based on https://github.com/bnb-chain/tss-lib
+- Used by `zetaclientd`: https://github.com/zeta-chain/node

README.md

@@ -98,7 +98,7 @@ func (m *Manager) SetPartyInfo(partyMap *sync.Map, partyIDMap map[string]*btss.P
 	}
 	m.partyInfo = partyInfo
 	var localParty btss.Party
-	m.partyInfo.PartyMap.Range(func(key, value interface{}) bool {
+	m.partyInfo.PartyMap.Range(func(_, value any) bool {
 		localParty = value.(btss.Party)
 		return false
 	})

blame/manager.go

@@ -8,8 +8,8 @@ import (
 	mapset "github.com/deckarep/golang-set"
 	"github.com/libp2p/go-libp2p/core/peer"
 
-	"gitlab.com/thorchain/tss/go-tss/conversion"
-	"gitlab.com/thorchain/tss/go-tss/messages"
+	"github.com/zeta-chain/go-tss/conversion"
+	"github.com/zeta-chain/go-tss/messages"
 )
 
 func (m *Manager) tssTimeoutBlame(lastMessageType string, partyIDMap map[string]*btss.PartyID) ([]string, error) {
@@ -182,7 +182,8 @@ func (m *Manager) TssMissingShareBlame(rounds int, algo messages.Algo) ([]Node,
 				isUnicast = false
 
 			default:
-				m.logger.Error().Msgf("fail to find the algorithm for this keygen/keysign, set unicast as false by default")
+				m.logger.Error().
+					Msgf("fail to find the algorithm for this keygen/keysign, set unicast as false by default")
 				isUnicast = false
 			}
 

blame/policy.go

@@ -1,6 +1,6 @@
 package blame
 
-import "gitlab.com/thorchain/tss/go-tss/conversion"
+import "github.com/zeta-chain/go-tss/conversion"
 
 // GetBlamePubKeysInList returns the nodes public key who are in the peer list
 func (m *Manager) getBlamePubKeysInList(peers []string) ([]string, error) {