Sinner

.codecov.yml

@@ -67,6 +67,10 @@ flags:
     paths:
       - services/scribe/
     carryforward: true
+  sinner:
+    paths:
+      - services/sinner/
+    carryforward: true
   solidity:
     paths:
       - packages/contracts-core/

.github/workflows/go.yml

@@ -200,6 +200,12 @@ jobs:
               fi
             done
 
+            # Check if max retries is exceeded for this package.
+            if [ $retries -eq $max_num_retries ]; then
+                echo "Max retries exceeded for $pkg"
+                exit 1
+            fi
+
             if [ -f profile.cov ]; then
               tail -n +2 profile.cov >> coverage.txt
               rm profile.cov

README.md

@@ -66,10 +66,12 @@ root
 │   ├── <a href="./packages/explorer-ui">explorer-ui</a>: Explorer UI
 │   ├── <a href="./packages/sdk-router">sdk-router</a>: SDK router
 │   ├── <a href="./packages/sdk-router">synapse-interface</a>: Synapse frontend code
-├── <a href="./tools">services</a>
+├── <a href="./services">services</a>
+│   ├── <a href="./services/cctp-relayer">CCTP Relayer</a>: CCTP message relayer
 │   ├── <a href="./services/explorer">explorer</a>: Bridge/messaging explorer backend
-│   ├── <a href="./services/omnirpc">omnirpc</a>: Latency aware RPC Client used across multiple-chains at once
 │   ├── <a href="./services/scribe">scribe</a>: Generalized ethereum event logger
+│   ├── <a href="./services/omnirpc">omnirpc</a>: Latency aware RPC Client used across multiple-chains at once
+│   ├── <a href="./services/sinner">sinner</a>: [Synapse Interchain Network](https://interchain.synapseprotocol.com/) indexer & query interface
 ├── <a href="./tools">tools</a>
 │   ├── <a href="./tools/abigen">abigen</a>: Used to generate abigen bindings for go
 │   ├── <a href="./tools/bundle">bundle</a>: Modified version of <a href="https://pkg.go.dev/golang.org/x/[email protected]/cmd/bundle"> go bundler </a> with improved shadowing support

docker/sinner.Dockerfile

@@ -0,0 +1,15 @@
+FROM gcr.io/distroless/static:latest
+
+LABEL org.label-schema.description="Sinner Docker file"
+LABEL org.label-schema.name="ghcr.io/synapsecns/sanguine/sinner"
+LABEL org.label-schema.schema-version="1.0.0"
+LABEL org.label-schema.vcs-url="https://github.com/synapsecns/sanguine"
+LABEL org.opencontainers.image.source="https://github.com/synapsecns/sanguine"
+LABEL org.opencontainers.image.description="Sinner Docker image"
+
+USER nonroot:nonroot
+
+WORKDIR /app
+COPY --chown=nonroot:nonroot sinner /app/sinner
+
+ENTRYPOINT ["/app/sinner"]

go.work

@@ -16,5 +16,6 @@ use (
 	./services/explorer
 	./services/omnirpc
 	./services/scribe
+	./services/sinner
 	./tools
 )

services/scribe/api/data_test.go

@@ -50,11 +50,17 @@ func (g APISuite) TestRetrieveData() {
 	logs, err := g.gqlClient.GetLogs(g.GetTestContext(), int(chainID), 1)
 	Nil(g.T(), err)
 	// there were 20 logs created (2 per loop, in a loop of 10)
-	Equal(g.T(), len(logs.Response), 20)
+	Equal(g.T(), 20, len(logs.Response))
 	logsRange, err := g.gqlClient.GetLogsRange(g.GetTestContext(), int(chainID), 2, 5, 1)
 	Nil(g.T(), err)
 	// from 2-5, there were 8 logs created (2 per loop, in a range of 4)
-	Equal(g.T(), len(logsRange.Response), 8)
+	Equal(g.T(), 8, len(logsRange.Response))
+
+	// Test getting logs in a range in ascending order.
+	logsRangeAsc, err := g.gqlClient.GetLogsRange(g.GetTestContext(), int(chainID), 5, 2, 1)
+	Nil(g.T(), err)
+	Equal(g.T(), 8, len(logsRangeAsc.Response))
+	Equal(g.T(), 2, logsRangeAsc.Response[0].BlockNumber)
 
 	// test get logs and get logs in a range (GRPC)
 	grpcLogs, res, err := g.grpcRestClient.ScribeServiceApi.ScribeServiceFilterLogs(g.GetTestContext(), rest.V1FilterLogsRequest{
@@ -213,17 +219,17 @@ func (g APISuite) TestBlockTimeDataEquality() {
 	Nil(g.T(), err)
 
 	// check that the data is equal
-	Equal(g.T(), *retrievedBlockTime.Response, int(blockTime))
+	Equal(g.T(), int(blockTime), *retrievedBlockTime.Response)
 
 	// check that the last stored block is correct
 	lastBlock, err := g.gqlClient.GetLastStoredBlockNumber(g.GetTestContext(), int(chainID))
 	Nil(g.T(), err)
-	Equal(g.T(), *lastBlock.Response, int(blockNumber))
+	Equal(g.T(), int(blockNumber), *lastBlock.Response)
 
 	// check that the first stored block is correct
 	firstBlock, err := g.gqlClient.GetFirstStoredBlockNumber(g.GetTestContext(), int(chainID))
 	Nil(g.T(), err)
-	Equal(g.T(), *firstBlock.Response, int(blockNumber))
+	Equal(g.T(), int(blockNumber), *firstBlock.Response)
 }
 
 func (g *APISuite) buildLog(contractAddress common.Address, blockNumber uint64) types.Log {
@@ -291,7 +297,7 @@ func (g APISuite) TestLastContractIndexed() {
 	Nil(g.T(), err)
 
 	// check that the data is equal
-	Equal(g.T(), *retrievedBlockTime.Response, int(blockNumber))
+	Equal(g.T(), int(blockNumber), *retrievedBlockTime.Response)
 }
 
 // nolint:dupl
@@ -390,7 +396,7 @@ func (g APISuite) TestLastConfirmedBlock() {
 	Nil(g.T(), err)
 
 	// check that the data is equal
-	Equal(g.T(), *retrievedBlockTime.Response, int(blockNumber))
+	Equal(g.T(), int(blockNumber), *retrievedBlockTime.Response)
 }
 
 // nolint:dupl

services/scribe/cmd/cmd.md

@@ -2,7 +2,7 @@
 [![Go Reference](https://pkg.go.dev/badge/github.com/synapsecns/sanguine/services/scribe.svg)](https://pkg.go.dev/github.com/synapsecns/sanguine/services/scribe)
 [![Go Report Card](https://goreportcard.com/badge/github.com/synapsecns/sanguine/services/scribe)](https://goreportcard.com/report/github.com/synapsecns/sanguine/services/scribe)
 
-Scribe is a multi chain indexing service. Scribe is designed to take a list of contracts specified by chain id and store logs, receipts, and txs for every event, past to present, in a mysql database.
+Scribe is a multi-chain indexing service. Scribe is designed to take a list of contracts specified by chain id and store logs, receipts, and txs for every event, past to present, in a mysql database.
 
 Use cases
 - Analytics for on chain events

services/scribe/db/suite_test.go

@@ -43,7 +43,6 @@ func NewEventDBSuite(tb testing.TB) *DBSuite {
 
 func (t *DBSuite) SetupTest() {
 	t.TestSuite.SetupTest()
-
 	t.logIndex.Store(0)
 
 	sqliteStore, err := sqlite.NewSqliteStore(t.GetTestContext(), filet.TmpDir(t.T(), ""), t.scribeMetrics, false)

services/sinner/.goreleaser.yml

@@ -0,0 +1,87 @@
+project_name: sinner
+
+monorepo:
+  tag_prefix: services/sinner/
+  dir: services/sinner/
+
+# for now, this is a library release
+builds:
+  # Linux AMD64
+  - id: sinner
+    binary: sinner
+    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"
+    # required workaround for https://github.com/Shopify/sarama/issues/2206
+    # See: https://github.com/golang/go/issues/35067#issuecomment-544805311 because we're statically compiling,
+    # without forcing netgo, we use the cgo resolver which will not work for .local (a canonical tld in kubernetes)
+    # the other way to resolve this would be to modify the nsswitch.conf in the container, but that's a bit less clean.
+    # osusergo was included as a recommendation here: https://github.com/kubernetes/kubernetes/pull/114225#issuecomment-1348920040
+    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:
+  # Docker AMD64
+  - goos: linux
+    goarch: amd64
+    image_templates:
+      - 'ghcr.io/synapsecns/sanguine/sinner:latest'
+      - 'ghcr.io/synapsecns/sanguine/sinner:{{ .FullCommit }}'
+      - 'ghcr.io/synapsecns/sanguine/sinner:{{ .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/sinner.Dockerfile
+    ids:
+      - sinner
+
+# track sizes
+report_sizes: true
+
+# modified timestamps
+metadata:
+  # Set the modified timestamp on the metadata files.
+  #
+  # Templates: allowed.
+  mod_timestamp: '{{ .CommitTimestamp }}'
+
+# produce software bill of lading
+sboms:
+  - artifacts: archive
+

services/sinner/Makefile

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

services/sinner/README.md

@@ -0,0 +1,109 @@
+# Sinner
+[![Go Reference](https://pkg.go.dev/badge/github.com/synapsecns/sanguine/services/sinner.svg)](https://pkg.go.dev/github.com/synapsecns/sanguine/services/sinner)
+[![Go Report Card](https://goreportcard.com/badge/github.com/synapsecns/sanguine/services/sinner)](https://goreportcard.com/report/github.com/synapsecns/sanguine/services/sinner)
+
+Sinner tracks the message lifecycle for the synapse interchain network.
+
+## Scope
+
+While this applications goal is to encompass the full range of events sent through SIN, the initial scope is much smaller & pragmatically focused on developers building on SIN & the developent of the off-chain protocols itself. To that end, at a high level the goal of the application is to track the message through the following stages. Completed types are contained in the table below:
+
+## Config:
+
+Example Indexer Config:
+
+```yaml
+default_refresh_rate: 1
+scribe_url: "http://scribe.com/graphql"
+db_path: "/tmp/a.db"
+db_type: sqlite
+skip_migrations: false
+chains:
+  - chain_id: 444
+    contracts:
+      - address: "0x537ab51470984D6D9aDF8953C0D2ed8eDA4050ED"
+        start_block: 1
+        contract_type: origin
+      - address: "0xA944636Ac279e0346AF96Ef7e236025C6cBFE609"
+        start_block: 1
+        contract_type: execution_hub
+  - chain_id: 421614
+    contracts:
+      - address: "0x537ab51470984D6D9aDF8953C0D2ed8eDA4050ED"
+        start_block: 1
+        contract_type: origin
+      - address: "0xA944636Ac279e0346AF96Ef7e236025C6cBFE609"
+        start_block: 1
+        contract_type: execution_hub
+  - chain_id: 11155111
+    contracts:
+      - address: "0x537ab51470984D6D9aDF8953C0D2ed8eDA4050ED"
+        start_block: 1
+        contract_type: origin
+      - address: "0xA944636Ac279e0346AF96Ef7e236025C6cBFE609"
+        start_block: 1
+        contract_type: execution_hub
+```
+
+Example Server Config
+
+  ```yaml
+http_port: 8080
+db_path: "/tmp/a.db"
+db_type: sqlite
+skip_migrations: true
+  ```
+
+If running the `unified` command, the config will be a combination of the above two configs (simply add the `http_port` to the top of your indexer config).
+### **Message Stages**
+
+1. [x] Message sent on origin chain.
+2. [ ] At least one Guard submitted the snapshot for the origin chain taken after the message was sent.
+3. [ ] At least one Notary submitted the snapshot for the origin chain taken after the message was sent.
+4. [ ] Attestation created from any of the (3) snapshots was submitted to the destination chain.
+5. [ ] Optimistic period for the message has passed (awaiting the execution).
+6. [ ] An Executor tried to execute the message, but the destination app reverted (awaiting the retry).
+7. [x] An Executor successfully executed the message.
+
+
+### **Tracked Events & States**
+
+_Note: the above only reflects progress in tracking message states in Sinner, not the agents_
+
+1. [x] `Origin` on origin chain emits an event for every sent message.
+  * `event Sent(bytes32 indexed messageHash, uint32 indexed nonce, uint32 indexed destination, bytes message);`
+2. [ ] `Summit` on Synapse Chain emits an event for every state in the Guard snapshot that was submitted.
+  * `event StateSaved(bytes state);`
+  * We are interested in the states that have:
+    * Origin domain matching the origin domain of the message.
+    * Nonce higher or equal as the nonce of the message.
+3. [ ] `Inbox` on Synapse Chain emits an event for every snapshot that was submitted (both Guard and Notary).
+  * `event SnapshotAccepted(uint32 indexed domain, address indexed agent, bytes snapPayload, bytes snapSignature)`
+  * We are only interested in Notary snapshots, so `domain != 0`.
+    * Notary domain could be different from the origin domain of the message, that's fine.
+  * [ ] `snapPayload` is a concatenation of encoded states. We are interested in the states that have:
+    * Origin domain matching the origin domain of the message.
+    * Nonce higher or equal as the nonce of the message.
+  * [ ] In the same transaction <code>Summit</code> emits an event with the created attestation: - <code>event AttestationSaved(bytes attestation);</code>
+
+   In other words, the submitted Guard/Notary snapshot "enables" messages coming from the set of origin domains (matching the domains of the states) with nonce less or equal to the nonce of the submitted state for the origin domain.
+
+4. `LightInbox` on the destination chain emits an event for every submitted attestation.
+  * [ ] `event AttestationAccepted(uint32 domain, address notary, bytes attPayload, bytes attSignature);`
+  * [ ] We are only interested in the attestation with payload matching any of the attestations from (3).
+  * [ ] Optimistic period for the message starts when the first suitable attestation is submitted.
+5. This could be tracked by checking the timestamp of the last mined destination block, no events needed.
+6. `Destination` emits the event whenever an Executor tries to execute the message.
+  * [ ] `event Executed(uint32 indexed remoteDomain, bytes32 indexed messageHash, bool success);`
+  * [ ] We are only interested in the events that have:
+    * `remoteDomain` matching the origin domain of the message.
+    * `messageHash` matching the hash of the message (emitted in (1)).
+    * `success` equal to `false`.
+  * [ ] These "failed" messages could be later retried by any Executor.
+7. [x] `Destination` emits the event whenever an Executor successfully executes the message.
+  * `event Executed(uint32 indexed remoteDomain, bytes32 indexed messageHash, bool success);`
+  * We are only interested in the events that have:
+    * `remoteDomain` matching the origin domain of the message.
+    * `messageHash` matching the hash of the message (emitted in (1)).
+    * `success` equal to `true`.
+  * [ ] The executed message could not be retried anymore.

services/sinner/api/doc.go

@@ -0,0 +1,2 @@
+// Package api contains the api used by sinner
+package api