add express relay skeleton (#123)

* add express relay skeleton

* positive unit tests added

* add tests with dummy protocol

* permission id -> permission key

* add lookup tables

* minor improvements

* few improvements + notes on what else to test

* address comments

* refactor to litesvm + changes

* moar tests, refactoring

* remove ts tests

* for a few tests moar

* minor changes

* address some comments

* minor changes

* some moar tests

* 1fix

* address some moar comments

* add readme

* revert the use of option for protocol_config

* add more docs

* initial tilt setup for solana

* got bidding to server working

* fix some tilt things

* peanuts

* some refactoring

* reorg a few things

* address comments

* add check for single submit_bid ix

* address comments

Author: anihamde

.gitignore

@@ -24,3 +24,6 @@ contracts/latestEnvironment.json
 **/target/
 node_modules
 .idea
+
+# Ignore stored SVM keypairs
+keypairs/*.json

README.md

@@ -24,25 +24,33 @@ The checks are also performed in the CI to ensure the code follows consistent fo
 
 Since express relay is a multi-service project, we use [Tilt](https://tilt.dev/) to manage the development environment.
 It is a great tool for local development and testing.
-Tilt requires `anvil`, `forge`, `poetry`, and rust to be installed on your machine.
+Tilt requires `anvil`, `forge`, `poetry`, rust, and the Solana CLI to be installed on your machine.
 
 Here are the installation instructions for each:
 
 - Rust: https://www.rust-lang.org/tools/install
 - Foundry (anvil,forge,cast, etc.): https://book.getfoundry.sh/getting-started/installation
 - Poetry: https://python-poetry.org/docs/#installation
 - Tilt: https://docs.tilt.dev/install.html
+- Solana CLI: https://docs.solanalabs.com/cli/install
+
+Note that for the Solana CLI, you may need to alter your terminal's `PATH` variable to include the Solana programs. To make this work with Tilt, you should include the `PATH` update in your `~/.bashrc` or `~/.zshrc` file depending on which shell your machine uses.
 
 Run `tilt up` in the root of the repo to start the development environment.
 You can access the ui at `http://localhost:10350/`.
 
 Here is what tilt up does in order:
 
-1. Starts `anvil`: local EVM chain to test the contracts with
-2. Deploy express relay contracts
-3. Start the auction server
-4. Start the liquidation monitor
-5. Start the simple searcher
+1. [EVM] Starts `anvil`: local EVM chain to test the contracts with
+2. [EVM] Deploy express relay contracts
+3. [SVM] Builds Solana programs
+4. [SVM] Starts `solana-test-validator`: Solana localnet to test the programs with
+5. [SVM] Airdrops SOL to searcher, admin, and relayer signer wallet
+6. [SVM] Initializes the SVM programs on the localnet
+7. Start the auction server
+8. [EVM] Start the liquidation monitor
+9. [EVM] Start the simple searcher
+10. [SVM] Submits an SVM transaction bid to the auction server
 
 There are some useful gadgets in Tilt ui for creating new vaults and checking the vault status.
 You can use them to test the system end to end.

Tiltfile

@@ -1,42 +1,48 @@
 load("ext://uibutton", "cmd_button", "location", "text_input")
 
 
-rpc_port = "9545"
-rpc_url = "http://127.0.0.1:%s" % rpc_port
-ws_url = "ws://127.0.0.1:%s" % rpc_port
+rpc_port_anvil = "9545"
+rpc_url_anvil = "http://127.0.0.1:%s" % rpc_port_anvil
+ws_url_anvil = "ws://127.0.0.1:%s" % rpc_port_anvil
+
+rpc_port_solana = "8899"
+rpc_port_solana_ws = "8900"
+rpc_url_solana = "http://127.0.0.1:%s" % rpc_port_solana
+ws_url_solana = "ws://127.0.0.1:%s" % rpc_port_solana_ws
 
 # Default anvil private key
 private_key = "0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80"
-
 block_time = "2"
+
+# evm resources
 local_resource(
-    "anvil",
+    "evm-anvil",
     serve_cmd="anvil --gas-limit 500000000000000000 --block-time %s -p %s"
-    % (block_time, rpc_port),
+    % (block_time, rpc_port_anvil),
     readiness_probe=probe(
         period_secs=5,
         exec=exec_action(
-            ["cast", "cid", "--rpc-url", rpc_url]
+            ["cast", "cid", "--rpc-url", rpc_url_anvil]
         ),  # get chain id as a readiness probe
     ),
 )
 
 forge_base_command = (
     "forge script script/Vault.s.sol --via-ir --private-key $PRIVATE_KEY --fork-url %s -vvv"
-    % rpc_url
+    % rpc_url_anvil
 )
 
 # we set automine to true before deployment and then set the interval to the block time after the deployment
 # to speed up the deployment
 local_resource(
-    "deploy-contracts",
+    "evm-deploy-contracts",
     "cast rp --rpc-url http://localhost:9545 evm_setAutomine true; "
     + forge_base_command
     + " --sig 'setUpLocalnet()' --broadcast; "
     + "cast rp --rpc-url http://localhost:9545 evm_setIntervalMining %s" % block_time,
     dir="contracts",
     env={"PRIVATE_KEY": private_key},
-    resource_deps=["anvil"],
+    resource_deps=["evm-anvil"],
 )
 
 cmd_button(
@@ -49,7 +55,7 @@ cmd_button(
         + " --sig 'getVault(uint256)' $VAULT --broadcast",
     ],
     location=location.NAV,
-    resource="deploy-contracts",
+    resource="evm-deploy-contracts",
     env=["PRIVATE_KEY=" + private_key],
     icon_name="search",
     text="Get vault state",
@@ -68,43 +74,42 @@ cmd_button(
         + " --sig 'createLiquidatableVault()' --broadcast",
     ],
     location=location.NAV,
-    resource="deploy-contracts",
+    resource="evm-deploy-contracts",
     env=["PRIVATE_KEY=" + private_key],
     icon_name="add",
 )
 
 local_resource(
-    "create-configs", "python3 integration.py %s %s" % (rpc_url, ws_url), resource_deps=["deploy-contracts"]
+    "evm-create-configs", "python3 evm_integration.py %s %s" % (rpc_url_anvil, ws_url_anvil), resource_deps=["evm-deploy-contracts"]
 )
 
 local_resource(
     "auction-server",
     serve_cmd="source ../tilt-resources.env; source ./.env; cargo run -- run --database-url $DATABASE_URL --subwallet-private-key $RELAYER_PRIVATE_KEY --secret-key $SECRET_KEY",
     serve_dir="auction-server",
-    resource_deps=["create-configs"],
+    resource_deps=["evm-create-configs"],
     readiness_probe=probe(period_secs=5, http_get=http_get_action(port=9000)),
 )
 
-
 monitor_command = (
     "source tilt-resources.env; "
     + "poetry -C per_sdk run "
     + "python3 -m per_sdk.protocols.token_vault_monitor "
     + "--chain-id development "
-    + "--rpc-url %s " % (rpc_url)
+    + "--rpc-url %s " % (rpc_url_anvil)
     + "--vault-contract $TOKEN_VAULT "
     + "--weth-contract $WETH "
     + "--liquidation-server-url http://localhost:9000 "
     + "--mock-pyth"
 )
 
 local_resource(
-    "monitor",
+    "evm-monitor",
     serve_cmd=monitor_command,
-    resource_deps=["deploy-contracts", "auction-server", "create-configs"],
+    resource_deps=["evm-deploy-contracts", "auction-server", "evm-create-configs"],
 )
 
-searcher_command = (
+evm_searcher_command = (
     "source tilt-resources.env;"
     + "poetry -C per_sdk run "
     + "python3 -m per_sdk.searcher.simple_searcher "
@@ -119,7 +124,47 @@ searcher_command = (
     + "--permit2-address $PERMIT2 "
 )
 local_resource(
-    "searcher",
-    serve_cmd=searcher_command,
-    resource_deps=["deploy-contracts", "auction-server", "create-configs"],
+    "evm-searcher",
+    serve_cmd=evm_searcher_command,
+    resource_deps=["evm-deploy-contracts", "auction-server", "evm-create-configs"],
+)
+
+
+# svm resources
+local_resource(
+    "svm-build-programs",
+    "cargo build-sbf",
+    dir="express_relay",
+)
+
+local_resource(
+    "svm-localnet",
+    serve_cmd="solana-test-validator $(./test-validator-params.sh)",
+    serve_dir="express_relay",
+    # check readiness by sending a health GET query to the RPC url
+    readiness_probe=probe(
+        period_secs=10,
+        http_get = http_get_action(port=int(rpc_port_solana), host="localhost", scheme="http", path="/health")
+    ),
+    resource_deps=["svm-build-programs"],
+)
+
+local_resource(
+    "svm-setup-accounts",
+    "poetry -C per_sdk run python3 -m per_sdk.svm.setup_accounts --rpc-url %s" % rpc_url_solana,
+    resource_deps=["svm-localnet"]
+)
+
+# need to run initialize instructions for the programs one time, script skips if already initialized
+local_resource(
+    "svm-initialize-programs",
+    "poetry -C per_sdk run python3 -m per_sdk.svm.initialize_programs -v --file-private-key-payer keypairs/searcher.json --file-private-key-admin keypairs/admin.json --file-private-key-relayer-signer keypairs/relayer_signer.json --express-relay-program GwEtasTAxdS9neVE4GPUpcwR7DB7AizntQSPcG36ubZM --dummy-program HYCgALnu6CM2gkQVopa1HGaNf8Vzbs9bomWRiKP267P3 --rpc-url %s" % rpc_url_solana,
+    resource_deps=["svm-setup-accounts"]
+)
+
+# craft dummy tx, submits as a bid to auction server or submits relayer-signed tx directly to solana cluster
+local_resource(
+    "svm-submit-bid",
+    "poetry -C per_sdk run python3 -m per_sdk.svm.dummy_tx -v --file-private-key-searcher keypairs/searcher.json --file-private-key-relayer-signer keypairs/relayer_signer.json --bid 100 --auction-server-url http://localhost:9000 --express-relay-program GwEtasTAxdS9neVE4GPUpcwR7DB7AizntQSPcG36ubZM --dummy-program HYCgALnu6CM2gkQVopa1HGaNf8Vzbs9bomWRiKP267P3",
+    resource_deps=["svm-initialize-programs", "auction-server"],
 )

integration.py renamed to evm_integration.py

@@ -0,0 +1,7 @@
+.anchor
+.DS_Store
+target
+**/*.rs.bk
+node_modules
+test-ledger
+.yarn

express_relay/.gitignore

@@ -0,0 +1,7 @@
+.anchor
+.DS_Store
+target
+node_modules
+dist
+build
+test-ledger

express_relay/.prettierignore

@@ -0,0 +1,16 @@
+[toolchain]
+
+[features]
+resolution = true
+skip-lint = false
+
+[programs.localnet]
+dummy = "HYCgALnu6CM2gkQVopa1HGaNf8Vzbs9bomWRiKP267P3"
+express_relay = "GwEtasTAxdS9neVE4GPUpcwR7DB7AizntQSPcG36ubZM"
+
+[registry]
+url = "https://api.apr.dev"
+
+[provider]
+cluster = "Localnet"
+wallet = "~/.config/solana/id.json"