FE Release 2024-05-15

.github/workflows/goreleaser-actions.yml

@@ -27,7 +27,7 @@ jobs:
         with:
           key: docker-release-${{ runner.os }}-${{ matrix.package }}
 
-      - uses: dorny/paths-filter@v2
+      - uses: dorny/paths-filter@v3
         name: check if any changes warrant a new build of goreleaser-cgo-cross-compiler
         id: changes
         with:

.github/workflows/lerna.yaml

@@ -4,6 +4,7 @@ on:
     types: [closed]
     paths:
       - 'packages/**'
+      - 'docs/**'
     branches:
       - master
 

.github/workflows/solidity.yml

@@ -30,7 +30,7 @@ jobs:
           fetch-depth: 0
           # if any of these packages use submodules in the future, please uncomment this line
           # submodules: 'recursive'
-      - uses: dorny/paths-filter@v2
+      - uses: dorny/paths-filter@v3
         id: filter_solidity
         with:
           #  make sure to update run-goreleaser when adding a new package here

.github/workflows/ui-preview.yaml

@@ -6,7 +6,7 @@ on:
   pull_request:
     paths:
       - 'packages/explorer-ui/**'
-      - 'packages/docs/**'
+      - 'docs/bridge/**'
       - 'packages/synapse-interface/**'
 jobs:
   changes:
@@ -21,14 +21,14 @@ jobs:
           fetch-depth: 0
           # if any of these packages use submodules in the future, please uncomment this line
           # submodules: 'recursive'
-      - uses: dorny/paths-filter@v2
+      - uses: dorny/paths-filter@v3
         id: filter_ui
         with:
           #  make sure to update run-goreleaser when adding a new package here
           # also add to the get-project-id step
           filters: |
             explorer-ui: 'packages/explorer-ui/**'
-            docs: 'packages/docs/**'
+            docs: 'docs/bridge/**'
             synapse-interface: 'packages/synapse-interface/**'
       - id: length
         run: |
@@ -47,6 +47,8 @@ jobs:
       matrix:
         package: ${{ fromJson(needs.changes.outputs.packages) }}
     env:
+      # TODO: this appears to work even if package is not in packages/[package]
+      # (see the addition of docs for details). It's possible workign directory can be removd.
       WORKING_DIRECTORY: 'packages/${{matrix.package}}'
       GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
       VERCEL_TOKEN: '${{ secrets.VERCEL_TOKEN }}'
@@ -77,16 +79,22 @@ jobs:
           echo "VERCEL_PROJECT_ID=$TARGET_ID" >> $GITHUB_ENV
       - name: Install Vercel CLI
         run: npm install --global [email protected]
-      - name: Pull Vercel Environment Information
-        run: vercel pull --yes --environment=preview --token=${{ secrets.VERCEL_TOKEN }}
-      - name: Build Project Artifacts
-        run: vercel build --token=${{ secrets.VERCEL_TOKEN }}
       - name: Deploy to Vercel (Output Preview/Inspect Links)
+        if: ${{ format('refs/heads/{0}', github.event.repository.default_branch) != github.ref }}
         id: deploy
         run: |
+          vercel pull --yes --environment=preview --token=${{ secrets.VERCEL_TOKEN }}
+          vercel build --token=${{ secrets.VERCEL_TOKEN }}
           export DEPLOY_URL=$(vercel deploy --prebuilt --token=${{ secrets.VERCEL_TOKEN }})
           echo "DEPLOY_URL=$DEPLOY_URL" >> $GITHUB_ENV
           echo "::set-output name=url::$DEPLOY_URL"
+      - name: Deploy to Vercel (Output Prod)
+        if: ${{ format('refs/heads/{0}', github.event.repository.default_branch) == github.ref }}
+        run: |
+          vercel pull --yes --environment=preview --token=${{ secrets.VERCEL_TOKEN }}
+          vercel build --token=${{ secrets.VERCEL_TOKEN }} --prod
+          vercel deploy --prebuilt --token=${{ secrets.VERCEL_TOKEN }} --prod
+
       - name: Update PR Description
         if: ${{ github.event_name == 'pull_request' && format('refs/heads/{0}', github.event.repository.default_branch) != github.ref }}
         uses: actions/github-script@v3

.vscode/settings.json

@@ -4,17 +4,21 @@
     "editor.defaultFormatter": "dbaeumer.vscode-eslint"
   },
   "[typescriptreact]": {
-      "editor.defaultFormatter": "esbenp.prettier-vscode"
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
   },
   "eslint.workingDirectories": [
-    { "directory": "packages/contracts", "changeProcessCWD": true }
+    {
+      "directory": "packages/contracts",
+      "changeProcessCWD": true
+    }
   ],
   "eslint.nodePath": "./node_modules/eslint/bin/",
   "eslint.format.enable": true,
   "editorconfig.generateAuto": false,
   "files.trimTrailingWhitespace": true,
   "solidity.packageDefaultDependenciesContractsDirectory": "contracts",
   "solidity.packageDefaultDependenciesDirectory": "lib",
-  "solidity.compileUsingRemoteVersion": "v0.8.17",
-  "solidity.formatter": "prettier"
-}
+  "solidity.compileUsingRemoteVersion": "v0.8.17+commit.8df45f5f",
+  "solidity.formatter": "prettier",
+  "solidity.defaultCompiler": "remote"
+}

.yamllint.yml

@@ -2,6 +2,7 @@ ignore: |
   **/node_modules/**
   **/charts/**
   **/swagger.yaml
+  **/openapi.yaml
 
 rules:
   document-start:

CODEOWNERS

@@ -15,8 +15,7 @@ ethergo/ @trajan0x
 make/ @trajan0x
 
 packages/contracts-core/ @ChiTimesChi @trajan0x
-packages/contracts-rfq @ChiTimesChi @mikeyrf
-packages/docs/  @trajan0x
+packages/contracts-rfq @ChiTimesChi
 packages/sdk-router/ @aureliusbtc @ChiTimesChi @trajan0x
 packages/explorer-ui/ @trajan0x  @bigboydiamonds @abtestingalpha
 packages/rest-api/ @trajan0x @Defi-Moses

CONTRIBUTING.md

@@ -4,6 +4,18 @@ Contributions should roughly follow the [uber style guide](https://github.com/ub
 
 <!-- todo: more-->
 
+## Adding a new JS/TS Package
+
+If you need to make a new JS/TS package, here are the steps to follow:
+
+- If adding under `packages/*`, no need to do anything further.
+- Otherwise, make sure you add the package to:
+  - `.github/workflows/lerna.yml` under paths. This will make sure that the package is built and tested in CI.
+  - `workspaces.packages` in packages.json. This will make sure that the package is built and tested locally.
+  - `lerna.json` under `packages` and `version` fields. This will make sure that the package is versioned correctly.
+- If the package is a library that you'd like to publish, simply set the `private` field in `package.json` to `false` and the `publishConfig` access to public.
+- If the package is a UI, please see [here](./.github/workflows/ui-preview.md) for instructions on configuring vercel. Make sure to update the paths there as well.
+
 ## Linting
 
 Linting for go is used using [golangci-lint](https://golangci-lint.run/) at the latest released version. Please upgrade or install using your package manager. and run `make lint` from your desired module.

agents/go.mod

@@ -58,6 +58,7 @@ require (
 	github.com/deckarep/golang-set/v2 v2.1.0 // indirect
 	github.com/deepmap/oapi-codegen v1.8.2 // indirect
 	github.com/edsrzf/mmap-go v1.0.0 // indirect
+	github.com/flowchartsman/swaggerui v0.0.0-20221017034628-909ed4f3701b // indirect
 	github.com/fsnotify/fsnotify v1.6.0 // indirect
 	github.com/gballet/go-libpcsclite v0.0.0-20191108122812-4678299bea08 // indirect
 	github.com/getsentry/sentry-go v0.18.0 // indirect

agents/go.sum

@@ -398,6 +398,8 @@ github.com/felixge/httpsnoop v1.0.3/go.mod h1:m8KPJKqk1gH5J9DgRY2ASl2lWCfGKXixSw
 github.com/fjl/memsize v0.0.0-20190710130421-bcb5799ab5e5/go.mod h1:VvhXpOYNQvB+uIk2RvXzuaQtkQJzzIx6lSBe1xv7hi0=
 github.com/fjl/memsize v0.0.2 h1:27txuSD9or+NZlnOWdKUxeBzTAUkWCVh+4Gf2dWFOzA=
 github.com/fjl/memsize v0.0.2/go.mod h1:VvhXpOYNQvB+uIk2RvXzuaQtkQJzzIx6lSBe1xv7hi0=
+github.com/flowchartsman/swaggerui v0.0.0-20221017034628-909ed4f3701b h1:oy54yVy300Db264NfQCJubZHpJOl+SoT6udALQdFbSI=
+github.com/flowchartsman/swaggerui v0.0.0-20221017034628-909ed4f3701b/go.mod h1:/RJwPD5L4xWgCbqQ1L5cB12ndgfKKT54n9cZFf+8pus=
 github.com/fogleman/gg v1.2.1-0.20190220221249-0403632d5b90/go.mod h1:R/bRT+9gY/C5z7JzPU0zXsXHKM4/ayA+zqcVNZzPa1k=
 github.com/frankban/quicktest v1.11.3/go.mod h1:wRf/ReqHper53s+kmmSZizM8NamnL3IM0I9ntUbOk+k=
 github.com/friendsofgo/graphiql v0.2.2 h1:ccnuxpjgIkB+Lr9YB2ZouiZm7wvciSfqwpa9ugWzmn0=

charts/screener/Chart.yaml

@@ -15,7 +15,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.2.4
+version: 0.2.5
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

charts/screener/templates/configmap.yaml

@@ -9,5 +9,5 @@ metadata:
     release: {{ .Release.Name }}
     heritage: {{ .Release.Service }}
 data:
-{{ toYaml .Values.files | indent 2 }}
+{{ tpl (toYaml .Values.files) . | indent 2 }}
 {{- end }}

committee/go.mod

@@ -123,6 +123,7 @@ require (
 	github.com/fatih/structtag v1.2.0 // indirect
 	github.com/felixge/httpsnoop v1.0.3 // indirect
 	github.com/fjl/memsize v0.0.2 // indirect
+	github.com/flowchartsman/swaggerui v0.0.0-20221017034628-909ed4f3701b // indirect
 	github.com/flynn/noise v1.1.0 // indirect
 	github.com/francoispqt/gojay v1.2.13 // indirect
 	github.com/fsnotify/fsnotify v1.6.0 // indirect

committee/go.sum

@@ -383,6 +383,8 @@ github.com/felixge/httpsnoop v1.0.3/go.mod h1:m8KPJKqk1gH5J9DgRY2ASl2lWCfGKXixSw
 github.com/fjl/memsize v0.0.0-20190710130421-bcb5799ab5e5/go.mod h1:VvhXpOYNQvB+uIk2RvXzuaQtkQJzzIx6lSBe1xv7hi0=
 github.com/fjl/memsize v0.0.2 h1:27txuSD9or+NZlnOWdKUxeBzTAUkWCVh+4Gf2dWFOzA=
 github.com/fjl/memsize v0.0.2/go.mod h1:VvhXpOYNQvB+uIk2RvXzuaQtkQJzzIx6lSBe1xv7hi0=
+github.com/flowchartsman/swaggerui v0.0.0-20221017034628-909ed4f3701b h1:oy54yVy300Db264NfQCJubZHpJOl+SoT6udALQdFbSI=
+github.com/flowchartsman/swaggerui v0.0.0-20221017034628-909ed4f3701b/go.mod h1:/RJwPD5L4xWgCbqQ1L5cB12ndgfKKT54n9cZFf+8pus=
 github.com/flynn/go-shlex v0.0.0-20150515145356-3f9db97f8568/go.mod h1:xEzjJPgXI435gkrCt3MPfRiAkVrwSbHsst4LCFVfpJc=
 github.com/flynn/noise v1.1.0 h1:KjPQoQCEFdZDiP03phOvGi11+SVVhBG2wOWAorLsstg=
 github.com/flynn/noise v1.1.0/go.mod h1:xbMo+0i6+IGbYdJhF31t2eR1BIU0CYc12+BNAKwUTag=

contrib/promexporter/go.sum

@@ -615,6 +615,8 @@ github.com/felixge/httpsnoop v1.0.3/go.mod h1:m8KPJKqk1gH5J9DgRY2ASl2lWCfGKXixSw
 github.com/fjl/memsize v0.0.0-20190710130421-bcb5799ab5e5/go.mod h1:VvhXpOYNQvB+uIk2RvXzuaQtkQJzzIx6lSBe1xv7hi0=
 github.com/fjl/memsize v0.0.2 h1:27txuSD9or+NZlnOWdKUxeBzTAUkWCVh+4Gf2dWFOzA=
 github.com/fjl/memsize v0.0.2/go.mod h1:VvhXpOYNQvB+uIk2RvXzuaQtkQJzzIx6lSBe1xv7hi0=
+github.com/flowchartsman/swaggerui v0.0.0-20221017034628-909ed4f3701b h1:oy54yVy300Db264NfQCJubZHpJOl+SoT6udALQdFbSI=
+github.com/flowchartsman/swaggerui v0.0.0-20221017034628-909ed4f3701b/go.mod h1:/RJwPD5L4xWgCbqQ1L5cB12ndgfKKT54n9cZFf+8pus=
 github.com/fogleman/gg v1.2.1-0.20190220221249-0403632d5b90/go.mod h1:R/bRT+9gY/C5z7JzPU0zXsXHKM4/ayA+zqcVNZzPa1k=
 github.com/form3tech-oss/jwt-go v3.2.2+incompatible/go.mod h1:pbq4aXjuKjdthFRnoDwaVPLA+WlJuPGy+QneDUgJi2k=
 github.com/form3tech-oss/jwt-go v3.2.3+incompatible/go.mod h1:pbq4aXjuKjdthFRnoDwaVPLA+WlJuPGy+QneDUgJi2k=

contrib/screener-api/client/client.go

@@ -3,7 +3,14 @@ package client
 
 import (
 	"context"
+	"crypto/hmac"
+	"crypto/sha256"
+	"encoding/hex"
+	"encoding/json"
 	"fmt"
+	"strings"
+	"time"
+
 	"github.com/dubonzi/otelresty"
 	"github.com/go-resty/resty/v2"
 	"github.com/google/uuid"
@@ -14,6 +21,7 @@ import (
 // ScreenerClient is an interface for the Screener API.
 type ScreenerClient interface {
 	ScreenAddress(ctx context.Context, ruleset, address string) (blocked bool, err error)
+	BlacklistAddress(ctx context.Context, appsecret string, appid string, body BlackListBody) (string, error)
 }
 
 type clientImpl struct {
@@ -37,6 +45,7 @@ type blockedResponse struct {
 	Blocked bool `json:"risk"`
 }
 
+// ScreenAddress checks if an address is blocked by the screener.
 func (c clientImpl) ScreenAddress(ctx context.Context, ruleset, address string) (bool, error) {
 	var blockedRes blockedResponse
 	resp, err := c.rClient.R().
@@ -54,6 +63,73 @@ func (c clientImpl) ScreenAddress(ctx context.Context, ruleset, address string)
 	return blockedRes.Blocked, nil
 }
 
+// BlackListBody is the json payload that represents a blacklisted address.
+type BlackListBody struct {
+	Type    string `json:"type"`
+	ID      string `json:"id"`
+	Data    string `json:"data"`
+	Address string `json:"address"`
+	Network string `json:"network"`
+	Tag     string `json:"tag"`
+	Remark  string `json:"remark"`
+}
+
+type blacklistResponse struct {
+	Status string `json:"status"`
+	Error  string `json:"error"`
+}
+
+func (c clientImpl) BlacklistAddress(ctx context.Context, appsecret string, appid string, body BlackListBody) (string, error) {
+	var blacklistRes blacklistResponse
+
+	nonce := strings.ReplaceAll(uuid.New().String(), "-", "")[:32]
+	timestamp := fmt.Sprintf("%d", time.Now().Unix())
+	queryString := ""
+
+	bodyBz, err := json.Marshal(body)
+	if err != nil {
+		return "", fmt.Errorf("error marshaling body: %w", err)
+	}
+
+	message := fmt.Sprintf("%s%s%s%s%s%s%s",
+		appid, timestamp, nonce, "POST", "/api/data/sync/", queryString, string(bodyBz))
+
+	signature := GenerateSignature(appsecret, message)
+
+	resp, err := c.rClient.R().
+		SetContext(ctx).
+		SetHeader("Content-Type", "application/json").
+		SetHeader("AppID", appid).
+		SetHeader("Timestamp", timestamp).
+		SetHeader("Nonce", nonce).
+		SetHeader("QueryString", queryString).
+		SetHeader("Signature", signature).
+		SetBody(body).
+		SetResult(&blacklistRes).
+		Post("/api/data/sync/")
+
+	if err != nil {
+		return resp.Status(), fmt.Errorf("error from server: %s: %w", resp.String(), err)
+	}
+
+	if resp.IsError() {
+		return resp.Status(), fmt.Errorf("error from server: %s", resp.String())
+	}
+
+	return blacklistRes.Status, nil
+}
+
+// GenerateSignature generates a signature for the request.
+func GenerateSignature(
+	secret,
+	message string,
+) string {
+	key := []byte(secret)
+	h := hmac.New(sha256.New, key)
+	h.Write([]byte(message))
+	return hex.EncodeToString(h.Sum(nil))
+}
+
 // NewNoOpClient creates a new no-op client for the Screener API.
 // it returns false for every address.
 func NewNoOpClient() (ScreenerClient, error) {
@@ -66,4 +142,8 @@ func (n noOpClient) ScreenAddress(_ context.Context, _, _ string) (bool, error)
 	return false, nil
 }
 
+func (n noOpClient) BlacklistAddress(_ context.Context, _ string, _ string, _ BlackListBody) (string, error) {
+	return "", nil
+}
+
 var _ ScreenerClient = noOpClient{}

contrib/screener-api/config/config.go

@@ -4,6 +4,10 @@ import "time"
 
 // Config is the configuration for the screener.
 type Config struct {
+	// AppSecret is the app secret
+	AppSecret string `yaml:"app-secret"`
+	// AppID is the app id
+	AppID string `yaml:"app-id"`
 	// TRMKey is the api key for trmlabs
 	TRMKey string `yaml:"trm-key"`
 	// Rules of [caller_type]->risk_type

contrib/screener-api/db/db.go

@@ -4,10 +4,29 @@ package db
 import (
 	"context"
 	"errors"
-	"github.com/synapsecns/sanguine/contrib/screener-api/trmlabs"
 	"time"
+
+	"github.com/synapsecns/sanguine/contrib/screener-api/trmlabs"
 )
 
+// BlacklistedAddressWriterDB provides methods to write blacklisted addresses to the database.
+type BlacklistedAddressWriterDB interface {
+	PutBlacklistedAddress(ctx context.Context, body BlacklistedAddress) error
+	DeleteBlacklistedAddress(ctx context.Context, id string) error
+	UpdateBlacklistedAddress(ctx context.Context, id string, body BlacklistedAddress) error
+}
+
+// BlacklistedAddressReaderDB provides methods to read blacklisted addresses from the database.
+type BlacklistedAddressReaderDB interface {
+	GetBlacklistedAddress(ctx context.Context, address string) (*BlacklistedAddress, error)
+}
+
+// BlacklistedAddressDB is the interface for reading and writing blacklisted addresses to the database.
+type BlacklistedAddressDB interface {
+	BlacklistedAddressWriterDB
+	BlacklistedAddressReaderDB
+}
+
 // RuleWriterDB is the interface for writing rules to the database.
 type RuleWriterDB interface {
 	PutAddressIndicators(ctx context.Context, address string, riskIndicator []trmlabs.AddressRiskIndicator) error
@@ -24,5 +43,11 @@ type RuleDB interface {
 	RuleReaderDB
 }
 
+// DB is the general database interface for the screener-api.
+type DB interface {
+	BlacklistedAddressDB
+	RuleDB
+}
+
 // ErrNoAddressNotCached is returned when an address is not cached.
 var ErrNoAddressNotCached = errors.New("address not cached")