[all] Communication

.codecov.yml

@@ -22,6 +22,14 @@ flags:
     paths:
       - agents/
     carryforward: true
+  committee:
+    paths:
+      - committee/
+    carryforward: true
+  sin-executor:
+    paths:
+      - sin-executor/
+    carryforward: true
   screener-api:
     paths:
       - contrib/screener-api/

.github/workflows/go.yml

@@ -541,18 +541,18 @@ jobs:
       # Foundry is required for flattening
       - name: Install Foundry
         uses: foundry-rs/foundry-toolchain@v1
-        if: ${{ contains(matrix.package, 'agents') || contains(matrix.package, 'services/rfq') }}
+        if: ${{ contains(matrix.package, 'agents') || contains(matrix.package, 'services/rfq') || contains(matrix.package, 'sin-executor') || contains(matrix.package, 'committee') }}
         with:
           version: nightly
 
       - name: Install Node Dependencies
         run: yarn install --immutable
-        if: ${{ contains(matrix.package, 'agents') || contains(matrix.package, 'services/rfq') }}
+        if: ${{ contains(matrix.package, 'agents') || contains(matrix.package, 'services/rfq') || contains(matrix.package, 'sin-executor') || contains(matrix.package, 'committee') }}
 
       # Generate flattened files
       - name: Run flattener
         run: npx lerna exec npm run build:go
-        if: ${{ contains(matrix.package, 'agents') || contains(matrix.package, 'services/rfq') }}
+        if: ${{ contains(matrix.package, 'agents') || contains(matrix.package, 'services/rfq') || contains(matrix.package, 'sin-executor') || contains(matrix.package, 'committee') }}
 
       # Setup Go
       - uses: actions/setup-go@v4

.github/workflows/goreleaser-actions.yml

@@ -176,6 +176,12 @@ jobs:
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
+      - name: debug
+        run: go version
+
+      - name: debug2
+        run: goreleaser -v
+
       - name: Run GoReleaser (Release)
         if: steps.branch-name.outputs.is_default == 'true'
         run: goreleaser  --timeout 900m --clean --debug -f ${{matrix.package}}/.goreleaser.yml

.github/workflows/solidity.yml

@@ -6,11 +6,13 @@ on:
       - 'packages/contracts-core/**'
       - 'packages/contracts-rfq/**'
       - '.github/workflows/solidity.yml'
+      - 'packages/contracts-communication'
       - 'packages/solidity-devops/**'
   push:
     paths:
       - 'packages/contracts-core/**'
       - 'packages/contracts-rfq/**'
+      - 'packages/contracts-communication'
       - 'packages/solidity-devops/**'
       - '.github/workflows/solidity.yml'
 
@@ -37,6 +39,7 @@ jobs:
             contracts-core: 'packages/contracts-core/**'
             contracts-rfq: 'packages/contracts-rfq/**'
             solidity-devops: 'packages/solidity-devops/**'
+            contracts-communication: 'packages/contracts-communication/**'
       - id: length
         run: |
           export FILTER_LENGTH=$(echo $FILTERED_PATHS | jq '. | length')
@@ -80,6 +83,7 @@ jobs:
           {
             "contracts-core": "${{ secrets.VERCEL_CONTRACT_DOCS_PROJECT_ID}}",
             "contracts-rfq": "${{ secrets.VERCEL_CONTRACT_RFQ_DOCS_PROJECT_ID }}",
+            "contracts-communication": "${{ secrets.VERCEL_COMMUNICATION_DOCS_PROJECT_ID }}",
             "solidity-devops": "${{ secrets.VERCEL_DEVOPS_DOCS_PROJECT_ID }}"
           }
           END

.gitignore

@@ -128,3 +128,4 @@ fastcache.tmp*
 # ignore all go built files in local dirs
 main
 .devnet/
+

.golangci.yml

@@ -99,6 +99,8 @@ linters:
     - spancheck
     # simply annoying
     - perfsprint
+    # malfunctions on embedded structs
+    - typecheck
   fast: false
 
 issues:

committee/.goreleaser.yml

@@ -0,0 +1,64 @@
+project_name: committee
+
+monorepo:
+  tag_prefix: committee/
+  dir: committee/
+
+builds:
+  # Linux AMD64
+  - id: committee
+    binary: committee
+    ldflags:
+      # We need to build a static binary because we are building in a glibc based system and running in a musl container
+      - -s -w -extldflags '-static'
+    # see above about workaround
+    tags:
+      - netgo
+      - osusergo
+    env:
+      - CC=gcc
+      - CXX=g++
+    main: main.go
+    goos:
+      - linux
+    goarch:
+      - amd64
+# add a source archive at release time
+source:
+  enabled: true
+
+# Archives
+archives:
+  - format: tar.gz
+    wrap_in_directory: true
+    format_overrides:
+      - goos: windows
+        format: zip
+    name_template: '{{.ProjectName}}-{{.Version}}_{{.Os}}_{{.Arch}}'
+    files:
+      - README.md
+
+checksum:
+  name_template: checksums.txt
+
+# Add a changelog
+changelog:
+  sort: asc
+
+dockers:
+  # Linux AMD64
+  - goos: linux
+    goarch: amd64
+    image_templates:
+      - 'ghcr.io/synapsecns/sanguine/committee:latest'
+      - 'ghcr.io/synapsecns/sanguine/committee:{{ .FullCommit }}'
+      - 'ghcr.io/synapsecns/sanguine/committee:{{ .Tag }}'
+    build_flag_templates:
+      - '--label=org.opencontainers.image.created={{.Date}}'
+      - '--label=org.opencontainers.image.name={{.ProjectName}}'
+      - '--label=org.opencontainers.image.revision={{.FullCommit}}'
+      - '--label=org.opencontainers.image.version={{.Version}}'
+      - '--label=org.opencontainers.image.source={{.GitURL}}'
+    dockerfile: ../docker/committee.Dockerfile
+    ids:
+      - committee

committee/Makefile

@@ -0,0 +1,7 @@
+include ../make/go.Makefile
+
+generate: ## Generate code
+	cd $(GIT_ROOT)/packages/contracts-communication && yarn build:go
+	go generate ./...
+
+

committee/README.md

@@ -0,0 +1,7 @@
+# Committee
+
+Committee is an example implementation of a SIN committee. It is based on libp2p.
+
+## Networking
+
+Committee uses libp2p for networking. It uses the

committee/cmd/cmd.go

@@ -0,0 +1,35 @@
+// Package cmd provides the command line interface for the committee node.
+package cmd
+
+import (
+	"fmt"
+	"github.com/synapsecns/sanguine/core/commandline"
+	"github.com/synapsecns/sanguine/core/config"
+	"github.com/synapsecns/sanguine/core/metrics"
+	"github.com/urfave/cli/v2"
+)
+
+// Start starts the committee node.
+func Start(args []string, buildInfo config.BuildInfo) {
+	app := cli.NewApp()
+	app.Name = buildInfo.Name()
+	app.Description = buildInfo.VersionString() + "committee provider for synapse"
+	app.Usage = fmt.Sprintf("%s --help", buildInfo.Name())
+	app.EnableBashCompletion = true
+
+	app.Before = func(c *cli.Context) error {
+		// nolint:wrapcheck
+		return metrics.Setup(c.Context, buildInfo)
+	}
+
+	// commands
+	app.Commands = cli.Commands{runCommand}
+	shellCommand := commandline.GenerateShellCommand(app.Commands)
+	app.Commands = append(app.Commands, shellCommand)
+	app.Action = shellCommand.Action
+
+	err := app.Run(args)
+	if err != nil {
+		panic(err)
+	}
+}

committee/cmd/commands.go

@@ -0,0 +1,56 @@
+package cmd
+
+import (
+	"fmt"
+	"github.com/synapsecns/sanguine/committee/config"
+	"github.com/synapsecns/sanguine/committee/node"
+	"github.com/synapsecns/sanguine/core/commandline"
+	"github.com/synapsecns/sanguine/core/metrics"
+	"github.com/urfave/cli/v2"
+	"gopkg.in/yaml.v2"
+	"os"
+	"path/filepath"
+)
+
+var configFlag = &cli.StringFlag{
+	Name:      "config",
+	Usage:     "path to the config file",
+	TakesFile: true,
+}
+
+var runCommand = &cli.Command{
+	Name:        "run",
+	Description: "run the committee node",
+	Flags: []cli.Flag{
+		configFlag,
+		&commandline.LogLevel,
+	},
+	Action: func(c *cli.Context) error {
+		commandline.SetLogLevel(c)
+
+		input, err := os.ReadFile(filepath.Clean(c.String(configFlag.Name)))
+		if err != nil {
+			return fmt.Errorf("could not read config file: %w", err)
+		}
+
+		metricsProvider := metrics.Get()
+
+		var cfg config.Config
+		// TODO: consider moving this for marshal/unmarshall tests
+		err = yaml.Unmarshal(input, &cfg)
+		if err != nil {
+			return fmt.Errorf("could not unmarshal config: %w", err)
+		}
+
+		createdNode, err := node.NewNode(c.Context, metricsProvider, cfg)
+		if err != nil {
+			return fmt.Errorf("could not create node: %w", err)
+		}
+
+		err = createdNode.Start(c.Context)
+		if err != nil {
+			return fmt.Errorf("could not start node: %w", err)
+		}
+		return nil
+	},
+}

committee/config/config.go

@@ -0,0 +1,35 @@
+// Package config provides the configuration for the Synapse module.
+package config
+
+import (
+	"github.com/synapsecns/sanguine/ethergo/signer/config"
+	submitterConfig "github.com/synapsecns/sanguine/ethergo/submitter/config"
+)
+
+// Config is the config for the Synapse module.
+type Config struct {
+	// Chains is a map of chain IDs to chain configs.
+	Chains map[int]string `yaml:"chains"`
+	// OmnirpcURL is the URL of the Omni RPC.
+	OmnirpcURL string `yaml:"omnirpc_url"`
+	// Database is the database config.
+	Database DatabaseConfig `yaml:"database"`
+	// Signer is the signer config.
+	Signer config.SignerConfig `yaml:"signer"`
+	// Submitter is the submitter config.
+	SubmitterConfig submitterConfig.Config `yaml:"submitter_config"`
+	// ShouldRelay is whether the node should relay.
+	ShouldRelay bool `yaml:"should_relay"`
+	// BootstrapPeers is the list of bootstrap peers.
+	BootstrapPeers []string `yaml:"bootstrap_peers"`
+	// P2PPort is the port for the p2p server.
+	P2PPort int `yaml:"p2p_port"`
+	// UsePeerID is wether or not to use the secp256k1 key for peer identification. This is a beta feature and currently can lead to rate limits/high bills on kms so should be turned off for now.
+	UsePeerID bool `yaml:"use_peer_id"`
+}
+
+// DatabaseConfig represents the configuration for the database.
+type DatabaseConfig struct {
+	Type string `yaml:"type"`
+	DSN  string `yaml:"dsn"` // Data Source Name
+}

committee/contracts/interchaindb/doc.go

@@ -0,0 +1,2 @@
+// Package interchaindb contains the abi and contract bindings for the interchaindb contract.
+package interchaindb

committee/contracts/interchaindb/generate.go

@@ -0,0 +1,3 @@
+package interchaindb
+
+//go:generate go run github.com/synapsecns/sanguine/tools/abigen generate --sol ../../../packages/contracts-communication/flattened/InterchainDB.sol --pkg interchaindb --sol-version 0.8.20 --filename interchaindb --evm-version istanbul

committee/contracts/interchaindb/helpers.go

@@ -0,0 +1,35 @@
+package interchaindb
+
+import (
+	"fmt"
+	"github.com/ethereum/go-ethereum/accounts/abi/bind"
+	"github.com/ethereum/go-ethereum/common"
+	"github.com/ethereum/go-ethereum/core/vm"
+)
+
+// InterchainDBRef is a reference to a InterchainDB.
+//
+// nolint: golint
+type InterchainDBRef struct {
+	*InterchainDB
+	address common.Address
+}
+
+// Address is the contract address.
+func (s *InterchainDBRef) Address() common.Address {
+	return s.address
+}
+
+// NewInterchainDBRef creates a new SynapseModulf with a contract ref.
+func NewInterchainDBRef(address common.Address, backend bind.ContractBackend) (*InterchainDBRef, error) {
+	instance, err := NewInterchainDB(address, backend)
+	if err != nil {
+		return nil, fmt.Errorf("could not create instance of InterchainDB: %w", err)
+	}
+	return &InterchainDBRef{
+		InterchainDB: instance,
+		address:      address,
+	}, nil
+}
+
+var _ vm.ContractRef = &InterchainDBRef{}