init services/explorer

.gitmodules

@@ -7,3 +7,6 @@
 [submodule "packages/contracts/lib/forge-std"]
 	path = packages/contracts/lib/forge-std
 	url = https://github.com/foundry-rs/forge-std
+[submodule "services/explorer/external/contracts/synapse-contracts"]
+	path = services/explorer/external/contracts/synapse-contracts
+	url = https://github.com/synapsecns/synapse-contracts

services/explorer/.gitignore

@@ -0,0 +1,2 @@
+external/synapse-contracts/
+sandbox/

services/explorer/.goreleaser.yaml

@@ -0,0 +1,36 @@
+project_name: explorer
+
+monorepo:
+  tag_prefix: services/explorer/
+  dir: services/explorer/
+
+builds:
+  - skip: true
+
+# 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}}'
+    replacements:
+      amd64: x86_64
+      arm64: ARM64
+      darwin: macOS
+      linux: Linux
+      windows: Windows
+    files:
+      - README.md
+
+checksum:
+  name_template: checksums.txt
+
+# Add a changelog
+changelog:
+  sort: asc

services/explorer/Makefile

@@ -0,0 +1 @@
+../../make/go.Makefile

services/explorer/README.md

@@ -0,0 +1,4 @@
+# Explorer
+
+See [#167](https://github.com/synapsecns/sanguine/issues/167) to learn more.
+

services/explorer/cmd/cmd.go

@@ -0,0 +1,28 @@
+package cmd
+
+import (
+	// used to embed markdown.
+	_ "embed"
+	"github.com/synapsecns/sanguine/core/commandline"
+	"github.com/urfave/cli/v2"
+)
+
+// Start starts the command line.
+func Start(args []string) {
+	app := cli.NewApp()
+	app.Name = "explorer"
+	app.Description = "An indexer + API serving platform analytics"
+	app.Usage = "explorer help"
+	app.EnableBashCompletion = true
+
+	// commands
+	app.Commands = cli.Commands{infoCommand, backfillCommand, serverCommand}
+	shellCommand := commandline.GenerateShellCommand(app.Commands)
+	app.Commands = append(app.Commands, shellCommand)
+	app.Action = shellCommand.Action
+
+	err := app.Run(args)
+	if err != nil {
+		panic(err)
+	}
+}

services/explorer/cmd/cmd.md

@@ -0,0 +1,22 @@
+# Explorer
+
+Explorer is an indexer and API serving platform analytics.
+
+`./explorer placeholder`: A placeholder
+
+## Directory Structure
+
+<pre>
+explorer
+├── <a href="./cmd">cmd</a>: CLI
+├── <a href="./config">config</a>: Config for the Explorer
+├── <a href="./db">db</a>: Currently holds schema for db
+├── <a href="./contracts">contracts</a>: Holds contracts generated via abigen
+│   ├── <a href="./contracts/bridge">bridge</a>: SynapseBridge contract and more
+│   ├── <a href="./contracts/bridgeconfig">bridgeconfig</a>: BridgeConfig contract and more
+│   └── <a href="./contracts/swap">swap</a>: SwapFlashLoan contract and more
+├── <a href="./internal">internal</a>: Workaround go-generate error, requiring file
+└── <a href="./external">external</a>: External packages
+└── └── <a href="./external/flattened-contracts">flattened-contracts</a>: Holds flattened contracts used by the /contracts generate.go files
+
+</pre>

services/explorer/cmd/commands.go

@@ -0,0 +1,47 @@
+package cmd
+
+import (
+	// used to embed markdown.
+	_ "embed"
+	"fmt"
+	"os"
+
+	"github.com/hashicorp/consul/sdk/freeport"
+
+	markdown "github.com/MichaelMure/go-term-markdown"
+	"github.com/ethereum/go-ethereum/ethclient"
+	"github.com/jftuga/termsize"
+	"github.com/synapsecns/sanguine/core/dbcommon"
+	"github.com/urfave/cli/v2"
+)
+
+//go:embed cmd.md
+var help string
+
+// infoCommand references the help info from the cmd.md file and presents it.
+var infoCommand = &cli.Command{
+	Name:        "info",
+	Description: "learn how to use explorer cli",
+	Action: func(c *cli.Context) error {
+		fmt.Println(string(markdown.Render(help, termsize.Width(), 6)))
+		return nil
+	},
+}
+
+
+//placeholder
+var placeholderCommand = &cli.Command{
+	Name:        "gm",
+	Description: "gm",
+	Usage:       "gm",
+	Action: func(c *cli.Context) error {
+		fmt.Println("gm")
+	}
+}
+
+func init() {
+	ports := freeport.Get(1)
+	if len(ports) > 0 {
+		portFlag.Value = uint(ports[0])
+	}
+}

services/explorer/cmd/doc.go

@@ -0,0 +1,2 @@
+// Package cmd: CLI infra
+package cmd

services/explorer/cmd/generate.go

@@ -0,0 +1 @@
+package cmd

services/explorer/config/config.go

@@ -0,0 +1,47 @@
+//parses the input config.yaml file
+package config
+
+import (
+	"fmt"
+
+	"github.com/davecgh/go-spew/spew"
+	"github.com/jftuga/ellipsis"
+	"gopkg.in/yaml.v3"
+)
+
+// Config holds the config for the chain.
+type Config struct {
+	// chainID -> chainConfig
+	Chains map[uint32]ChainConfig `yaml:"chains"`
+	// Port is the port
+	Port uint16 `yaml:"port,omitempty"`
+	// RefreshInterval is the refresh interval of rpc latency
+	// expressed in seconds
+	RefreshInterval int `yaml:"refresh_interval,omitempty"`
+}
+
+// ChainConfig is the config for a single chain.
+type ChainConfig struct {
+	// RPCS is a list of rpcs to use
+	RPCs []string `yaml:"rpcs"`
+	// Checks is how many rpcs must return the same result for it to be used. This does not apply to height/status based methods
+	Checks uint16 `yaml:"confirmations,omitempty"`
+}
+
+// UnmarshallConfig unmarshalls a config.
+func UnmarshallConfig(input []byte) (cfg Config, err error) {
+	err = yaml.Unmarshal(input, &cfg)
+	if err != nil {
+		return Config{}, fmt.Errorf("could not unmarshall config %s: %w", ellipsis.Shorten(string(input), 30), err)
+	}
+	return cfg, nil
+}
+
+// Marshall a config to yaml.
+func (c Config) Marshall() ([]byte, error) {
+	output, err := yaml.Marshal(c)
+	if err != nil {
+		return nil, fmt.Errorf("could not unmarshall config %s: %w", ellipsis.Shorten(spew.Sdump(c), 20), err)
+	}
+	return output, nil
+}

services/explorer/config/config_test.go

@@ -0,0 +1,75 @@
+package config_test
+
+import (
+	"github.com/brianvoe/gofakeit/v6"
+	. "github.com/stretchr/testify/assert"
+	"github.com/synapsecns/sanguine/services/omnirpc/config"
+	"golang.org/x/exp/slices"
+	"testing"
+)
+
+func TestConfig(t *testing.T) {
+	testConfig := config.Config{
+		Chains: map[uint32]config.ChainConfig{
+			1: {
+				RPCs:   []string{gofakeit.URL(), gofakeit.URL(), gofakeit.URL()},
+				Checks: gofakeit.Uint16(),
+			},
+			2: {
+				RPCs:   []string{gofakeit.URL(), gofakeit.URL(), gofakeit.URL()},
+				Checks: gofakeit.Uint16(),
+			},
+		},
+		Port:            gofakeit.Uint16(),
+		RefreshInterval: gofakeit.Second(),
+	}
+
+	out, err := testConfig.Marshall()
+	Nil(t, err)
+
+	unmarshalledConfig, err := config.UnmarshallConfig(out)
+	Nil(t, err)
+
+	Equal(t, testConfig, unmarshalledConfig)
+}
+
+func TestUnmarshallMarshall(t *testing.T) {
+	rpcConf, err := config.UnmarshallConfig([]byte(testYaml))
+	Nil(t, err)
+
+	True(t, slices.Contains(rpcConf.Chains[1].RPCs, "https://api.mycryptoapi.com/eth"))
+	True(t, slices.Contains(rpcConf.Chains[1].RPCs, "https://api.bitstack.com/v1/wNFxbiJyQsSeLrX8RRCHi7NpRxrlErZk/DjShIqLishPCTB9HiMkPHXjUM9CNM9Na/ETH/mainnet"))
+	True(t, slices.Contains(rpcConf.Chains[2].RPCs, "https://node.eggs.cool"))
+}
+
+const testYaml = `
+chains:
+    0:
+        rpcs:
+            - https://rpc.kardiachain.io/
+        confirmations: 1
+    1:
+        rpcs:
+            - https://api.mycryptoapi.com/eth
+            - https://rpc.flashbots.net/
+            - https://eth-mainnet.gateway.pokt.network/v1/5f3453978e354ab992c4da79
+            - https://cloudflare-eth.com/
+            - https://mainnet-nethermind.blockscout.com/
+            - https://nodes.mewapi.io/rpc/eth
+            - https://main-rpc.linkpool.io/
+            - https://mainnet.eth.cloud.ava.do/
+            - https://ethereumnodelight.app.runonflux.io
+            - https://rpc.ankr.com/eth
+            - https://eth-rpc.gateway.pokt.network
+            - https://main-light.eth.linkpool.io
+            - https://eth-mainnet.public.blastapi.io
+            - http://18.211.207.34:8545
+            - https://eth-mainnet.nodereal.io/v1/1659dfb40aa24bbb8153a677b98064d7
+            - wss://eth-mainnet.nodereal.io/ws/v1/1659dfb40aa24bbb8153a677b98064d7
+            - https://api.bitstack.com/v1/wNFxbiJyQsSeLrX8RRCHi7NpRxrlErZk/DjShIqLishPCTB9HiMkPHXjUM9CNM9Na/ETH/mainnet
+        confirmations: 1
+    2:
+        rpcs:
+            - https://node.eggs.cool
+            - https://node.expanse.tech
+        confirmations: 1`

services/explorer/config/doc.go

@@ -0,0 +1,2 @@
+// Package config: enables .yaml files to be passed and parsed to specify indexer behavior
+package config