sai-trading: project scaffolding with script to deploy all Sai contracts (#2433)

* chore: changelog

* sai-trading: add first set of artifacts

* sai-trading: toml for build info

* sai-trading: start a small program that uses a running nibid process for local testing

* chore: add out.txt to gitignore; add justfile comment

* sai-trading: project scaffolding with script to deploy all Sai contracts

* sai-trading: get a simple test going that checks for the running network in the background

* test(ci): need to install bun before running the script

* use which instead of command -v

* fix array concatenation

* make pr title lint more flexible to account for sai-trading and revert changes to app, proto, api

* test(.github): fix just install if statement

* chore: linter

* fix(linter): revert the build tag issue and disable that small piece of govet

* Delete TODO_ANALYSIS.md

Author: Unique-Divine

.cursorignore

@@ -41,6 +41,8 @@ dist/
 # x/sudo/
 # x/tokenfactory/
 
+# DON'T ignore out.txt
+!out.txt
 
 # Boilerplate
 # *.pb.go

.github/workflows/e2e-evm.yml

@@ -88,3 +88,65 @@ jobs:
         env:
           JSON_RPC_ENDPOINT: http://127.0.0.1:8545
           MNEMONIC: guard cream sadness conduct invite crumble clock pudding hole grit liar hotel maid produce squeeze return argue turtle know drive eight casino maze host
+
+  sai-trading:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: "Check for EVM-related changes"
+        id: check_changes
+        uses: dorny/paths-filter@v3
+        with:
+          filters: |
+            check_changes:
+              - "sai-trading/**/*.ts"
+              - "sai-trading/artifacts/*"
+              - "sai-trading/**/*.go"
+
+      - name: Set up Go
+        if: steps.check_changes.outputs.check_changes == 'true'
+        uses: actions/setup-go@v5
+        with:
+          go-version: 1.24
+          # cache: "The action has a built-in functionality for caching and
+          # restoring go modules and build outputs. It uses [actions/cache@v4]."
+          # - Handles go module cache (go env GOMODCACHE).
+          # - Handles go build cache (go env GOCACHE).
+          cache: true
+
+      - name: "Install just"
+        if: steps.check_changes.outputs.check_changes == 'true'
+        # casey/just: https://just.systems/man/en/chapter_6.html
+        # taiki-e/install-action: https://github.com/taiki-e/install-action
+        uses: taiki-e/install-action@just
+
+      - name: "Build the nibid binary"
+        if: steps.check_changes.outputs.check_changes == 'true'
+        run: |
+          just install
+
+      - if: steps.check_changes.outputs.check_changes == 'true'
+        # For running things and for package management "
+        uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: 1.2.22 # Values: latest, <sha>, 1.2.3, canary
+        # Outputs:
+        # - cache-hit    : Whether the executable was read from cache. Ex. "true"
+        # - bun-version  : The output from running `bun-version`. Ex. "1.0.0"
+        # - bun-revision : The output from running `bun-revision`.
+
+      - if: steps.check_changes.outputs.check_changes == 'true'
+        working-directory: "sai-trading"
+        run: |
+          bun install
+
+      - if: steps.check_changes.outputs.check_changes == 'true'
+        run: |
+          just localnet --no-build &
+          sleep 10
+
+      - if: steps.check_changes.outputs.check_changes == 'true'
+        working-directory: "sai-trading"
+        run: |
+          just test

.github/workflows/pr-title-lint.yml

@@ -11,7 +11,7 @@ jobs:
       - uses: seferov/[email protected]
         with:
           # V2: Includes Nibiru-specific qualifiers and allows for
-          title-regex: '^(evm|build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test){1}(\([\w\-\.\/]+\))?(!)?: ([\w ])+([\s\S]*)'
+          title-regex: '^(evm|sai-trading|build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test){1}(\([\w\-\.\/]+\))?(!)?: ([\w ])+([\s\S]*)'
           # V1: Old regex taken from Gist: https://gist.github.com/marcojahn/482410b728c31b221b70ea6d2c433f0c
           # title-regex: '^(evm|build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test){1}(\([\w\-\.]+\))?(!)?: ([\w ])+([\s\S]*)'
           # title-regex-flags (Optional)

.gitignore

@@ -347,6 +347,7 @@ sketch
 
 public/js/
 .npmrc
+out.txt
 
 playwright/test-results/
 playwright/playwright-report/

go.mod

@@ -258,6 +258,8 @@ require (
 	sigs.k8s.io/yaml v1.4.0 // indirect
 )
 
+// Replace block for Nibiru
+// TODO: Remove rocksdb dep: https://github.com/NibiruChain/nibiru/issues/2432
 replace (
 	cosmossdk.io/api => cosmossdk.io/api v0.3.1
 

justfile

@@ -99,7 +99,7 @@ lint:
     golangci/golangci-lint:$image_version \
     golangci-lint run -v --fix 2>&1
 
-# Runs a Nibiru local network. Ex: "just localnet", "just localnet --features featureA"
+# Runs a Nibiru local network. Ex: "just localnet", "just localnet --no-build", "just localnet --features featureA"
 localnet *PASS_FLAGS:
   make localnet FLAGS="{{PASS_FLAGS}}"
 

sai-trading/.gitignore

@@ -0,0 +1,2 @@
+artifacts/solidity/build-info
+*.dbg.json

sai-trading/README.md

@@ -0,0 +1,44 @@
+# Nibiru/Sai-Trading
+
+Rough notes (for now)
+
+## Plan
+
+- [ ] Use sai-perps version for both the EVM interface and Wasm contracts.
+
+---
+
+### Pulling in artifacts
+
+Sketching out the flow from the "sai-perps" repo:
+
+```bash
+root="$(pwd)" # Nibiru/sai-trading
+
+# Assuming sai-perps is temporarily locally cloned:
+# npx degit ... OR downlaod from release assets
+sai_perps="$root/sai-perps" 
+
+cp "$sai_perps/artifacts/*" artifacts/
+(cd $sai_perps just evm-install && just evm-build)
+rm -rf artifacts/solidity
+cp -r "$sai_perps/evm-interface/artifacts" artifacts/solidity
+```
+
+cp "
+
+```bash
+cp "$sai_perps/evm-interface/artifacts/contracts/PerpVaultEvmInterface.sol/PerpVaultEvmInterface.json" artifacts/
+jq '{sourceName, contractName, abi, bytecode}' artifacts/PerpVaultEvmInterface.json > tmp.json
+mv tmp.json artifacts/PerpVaultEvmInterface.json
+```
+
+### yq for artifacts build info:
+
+The `yq` tool is written in Go as a dependency free binary.
+
+```bash
+go install github.com/mikefarah/yq/v4@latest
+```
+https://github.com/mikefarah/yq?tab=readme-ov-file#github-action
+

sai-trading/artifacts-lock.toml

@@ -0,0 +1,8 @@
+[[artifacts]]
+# sai_trading_version: Version number for this tool (Nibiru/sai-trading)
+sai_trading_version = "0.0.1" # vX.Y.Z
+
+# sai_perps_version: This is the version number for the Wasm bytecode files and
+# the sai-perps/evm-interface Solidity contract(s).
+sai_perps_version = "" # vX.Y.Z
+sai_perps_commit = "https://github.com/NibiruChain/sai-perps/tree/4a801ec7572e83597a88c11a9be9a48e26dfaf5e"