Merge pull request #8 from randa-mu/fix/various

AnomalRoil · web-flow · commit e7bbc1d4b4e2 · 2025-08-28T14:32:47.000+02:00
Add rust actions
diff --git a/.github/actions/build-and-test.yml b/.github/actions/build-and-test.yml
diff --git a/.github/actions/rust-test-action/action.yml b/.github/actions/rust-test-action/action.yml
@@ -0,0 +1,47 @@
+name: 'Rust Test Action'
+description: 'Runs format check, clippy, and tests for a Rust crate'
+inputs:
+  working-directory:
+    required: true
+    description: 'Directory containing the Rust crate'
+  target-folder:
+    required: false
+    default: './target'
+    description: 'Target folder used for building'
+  extra-cache-key:
+    required: false
+    default: 'rust'
+    description: 'Additional key used for caching'
+  additional-flags:
+    required: false
+    default: ''
+    description: 'Additional flags for cargo commands'
+
+runs:
+  using: "composite"
+  steps:
+    # Pull cargo nextest binaries
+    - uses: taiki-e/install-action@v2
+      with:
+        tool: nextest,cargo-hack
+
+    - name: Cache Cargo
+      uses: Swatinem/rust-cache@v2
+      with:
+        prefix-key: ${{ runner.os }}-cargo
+        key: ${{ inputs.extra-cache-key }}
+
+    - name: Check formatting
+      working-directory: ${{ inputs.working-directory }}
+      run: cargo fmt --check ${{ inputs.additional-flags }}
+      shell: bash
+
+    - name: Check clippy
+      working-directory: ${{ inputs.working-directory }}
+      run: cargo hack clippy --each-feature --all-targets --target-dir ${{ inputs.target-folder }} -- -Dwarnings ${{ inputs.additional-flags }}
+      shell: bash
+
+    - name: Run all tests
+      working-directory: ${{ inputs.working-directory }}
+      run: cargo nextest run --target-dir ${{ inputs.target-folder }} --no-tests warn
+      shell: bash
diff --git a/.github/workflows/rust-build-and-tests.yml b/.github/workflows/rust-build-and-tests.yml
@@ -0,0 +1,56 @@
+name: rust-build-and-tests
+on:
+  push:
+    branches: [master]
+  pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: ci-${{ github.ref }}-onlyswaps
+  cancel-in-progress: true
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  rust-build-and-tests:
+    name: Build and test rust crates
+    runs-on: ["randamu-self-hosted-default"]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          submodules: 'recursive'
+          token: ${{ secrets.PAT_TOKEN }}
+
+      # 1. Compile onlysubs-solidity
+      - name: Cache npm onlysubs-solidity
+        uses: actions/cache@v3
+        with:
+          path: onlysubs-solidity/node_modules
+          key: ${{ runner.os }}-npm-onlysubs-solidity-${{ hashFiles('onlysubs-solidity/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-npm-onlysubs-solidity-
+
+      - name: onlysubs-solidity - Install dependencies
+        working-directory: ./onlysubs-solidity
+        run: npm ci
+
+      - name: Cache Solidity onlysubs-solidity
+        uses: actions/cache@v3
+        with:
+          path: onlysubs-solidity/out
+          key: ${{ runner.os }}-sol-onlysubs-solidity-${{ hashFiles('onlysubs-solidity/src/**/*.sol', 'onlysubs-solidity/lib/**/*.sol') }}
+          restore-keys: |
+            ${{ runner.os }}-sol-onlysubs-solidity-
+
+      - name: onlysubs-solidity - Build Solidity contracts
+        working-directory: ./onlysubs-solidity
+        run: npm run build:forge
+
+      # 2. Build and test workspace packages
+      - name: Lint & Test Rust Workspace
+        uses: ./.github/actions/rust-test-action
+        with:
+          working-directory: .
+          extra-cache-key: 'onlyswaps-solver'
diff --git a/README.md b/README.md
@@ -18,8 +18,10 @@ First retrieve and build submodules with `./build-dependencies.sh` then run `car
 
 ## Running locally
 - Start two anvil blockchains (note: block time is necessary or chain state can get confused):
-`$ anvil --port 1337 --chain-id 1337 --block-time 3`
-`$ anvil --port 1338 --chain-id 1338 --block-time 3`
+  ```bash
+  $ anvil --port 1337 --chain-id 1337 --block-time 3
+  $ anvil --port 1338 --chain-id 1338 --block-time 3
+  ```
 
 - Deploy the contracts from onlysubs-solidity by:
   - `cd` into [onlysubs-solidity](./onlysubs-solidity)
@@ -29,7 +31,7 @@ First retrieve and build submodules with `./build-dependencies.sh` then run `car
     BLS_PUBLIC_KEY_X0=17445541620214498517833872661220947475697073327136585274784354247720096233162
     BLS_PUBLIC_KEY_X1=18268991875563357240413244408004758684187086817233527689475815128036446189503
     BLS_PUBLIC_KEY_Y0=11401601170172090472795479479864222172123705188644469125048759621824127399516
-    BLS_PUBLIC_KEY_Y1=8044854403167346152897273335539146380878155193886184396711544300199836788154```
+    BLS_PUBLIC_KEY_Y1=8044854403167346152897273335539146380878155193886184396711544300199836788154
     ```
   - `source .env`
   - `$ forge script script/DeployAllContracts.s.sol --broadcast --rpc-url http://127.0.0.1:1337 --private-key $PRIVATE_KEY` 
diff --git a/src/api.rs b/src/api.rs
@@ -9,10 +9,7 @@ pub(crate) struct ApiServer {
 impl ApiServer {
     pub fn new(port: u16) -> Self {
         let app = Router::new().route("/health", get(healthcheck_handler));
-        Self {
-            port,
-            app,
-        }
+        Self { port, app }
     }
 
     pub async fn start(self) -> eyre::Result<()> {
diff --git a/src/app.rs b/src/app.rs
@@ -1,12 +1,12 @@
 use crate::executor::TradeExecutor;
+use crate::model::BlockEvent;
 use crate::network::Network;
 use crate::solver::Solver;
 use alloy::providers::DynProvider;
+use futures::StreamExt;
 use futures::future::try_join_all;
 use futures::stream::select_all;
 use std::collections::HashMap;
-use futures::StreamExt;
-use crate::model::BlockEvent;
 
 pub struct App {}
 impl App {
diff --git a/src/config.rs b/src/config.rs
@@ -1,16 +1,11 @@
-use std::fs;
 use clap::Parser;
 use serde::Deserialize;
 use shellexpand::tilde;
+use std::fs;
 
 #[derive(Parser, Debug)]
 pub(crate) struct CliArgs {
-    #[arg(
-        short = 'c',
-        long = "config-path",
-        env = "SOLVER_CONFIG_PATH",
-        default_value = "~/.solver/config.json"
-    )]
+    #[arg(short = 'c', long = "config-path", env = "SOLVER_CONFIG_PATH", default_value = "~/.solver/config.json")]
     pub config_path: String,
 
     #[arg(short = 's', long = "private-key", env = "SOLVER_PRIVATE_KEY")]
@@ -36,12 +31,7 @@ pub(crate) struct NetworkConfig {
 pub(crate) fn load_config_file(cli: &CliArgs) -> ConfigFile {
     println!("loading config file {}", cli.config_path);
     match fs::read(tilde(&cli.config_path).into_owned()) {
-        Ok(contents) => serde_json::from_slice(&contents)
-            .expect(format!("failed to parse config file at {}", cli.config_path).as_str()),
-        Err(err) => panic!(
-            "failed to read config file at {}: {:?}",
-            cli.config_path,
-            err.to_string()
-        ),
+        Ok(contents) => serde_json::from_slice(&contents).unwrap_or_else(|_| panic!("failed to parse config file at {}", cli.config_path)),
+        Err(err) => panic!("failed to read config file at {}: {:?}", cli.config_path, err.to_string()),
     }
 }
diff --git a/src/eth.rs b/src/eth.rs
@@ -1,13 +1,15 @@
 use alloy::sol;
 
 sol!(
+    #[allow(clippy::too_many_arguments)]
     #[derive(Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
     #[sol(rpc)]
     ERC20FaucetToken,
     "onlysubs-solidity/out/ERC20FaucetToken.sol/ERC20FaucetToken.json"
 );
 
 sol!(
+    #[allow(clippy::too_many_arguments)]
     #[derive(Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
     #[sol(rpc)]
     Router,
diff --git a/src/executor.rs b/src/executor.rs
@@ -41,7 +41,7 @@ impl<'a, P: Provider> TradeExecutor<'a, P> {
             match approve {
                 Ok(_) => {}
                 Err(e) => {
-                    println!("error approving trade: {}", e);
+                    println!("error approving trade: {e}");
                 }
             }
 
diff --git a/src/main.rs b/src/main.rs
@@ -1,20 +1,20 @@
-mod network;
 mod api;
-mod eth;
-mod config;
 mod app;
-mod solver;
-mod model;
+mod config;
+mod eth;
 mod executor;
+mod model;
+mod network;
+mod solver;
 mod util;
 
-use clap::Parser;
-use eyre::eyre;
-use dotenv::dotenv;
 use crate::api::ApiServer;
 use crate::app::App;
-use crate::config::{load_config_file, CliArgs, ConfigFile};
+use crate::config::{CliArgs, ConfigFile, load_config_file};
 use crate::network::Network;
+use clap::Parser;
+use dotenv::dotenv;
+use eyre::eyre;
 
 #[tokio::main]
 async fn main() -> eyre::Result<()> {
@@ -43,7 +43,7 @@ async fn main() -> eyre::Result<()> {
                 Err(e) => Err(eyre!("http server stopped unexpectedly: {}", e))
             }
         }
-        
+
         _ = sigterm.recv() => {
             println!("received SIGTERM, shutting down...");
             Ok(())
diff --git a/src/network.rs b/src/network.rs
@@ -1,21 +1,21 @@
 use crate::config::NetworkConfig;
+use crate::eth::ERC20FaucetToken;
+use crate::eth::ERC20FaucetToken::ERC20FaucetTokenInstance;
 use crate::eth::Router::RouterInstance;
 use crate::model::{BlockEvent, ChainState, Transfer};
 use crate::solver::ChainStateProvider;
 use alloy::network::EthereumWallet;
 use alloy::primitives::{Address, U256};
 use alloy::providers::{DynProvider, Provider, ProviderBuilder, WsConnect};
 use alloy::signers::local::PrivateKeySigner;
+use async_trait::async_trait;
 use futures::Stream;
+use futures::StreamExt;
 use futures::future::try_join_all;
 use itertools::Itertools;
 use std::collections::HashMap;
 use std::pin::Pin;
 use std::str::FromStr;
-use async_trait::async_trait;
-use futures::StreamExt;
-use crate::eth::ERC20FaucetToken;
-use crate::eth::ERC20FaucetToken::ERC20FaucetTokenInstance;
 
 pub(crate) struct Network<P> {
     pub chain_id: u64,
@@ -26,7 +26,7 @@ pub(crate) struct Network<P> {
 }
 
 impl Network<DynProvider> {
-    pub async fn create_many(private_key: &str, network_configs: &Vec<NetworkConfig>) -> eyre::Result<HashMap<u64, Self>> {
+    pub async fn create_many(private_key: &str, network_configs: &[NetworkConfig]) -> eyre::Result<HashMap<u64, Self>> {
         let mut networks = HashMap::new();
         let signer = PrivateKeySigner::from_str(private_key)?;
 
@@ -35,7 +35,7 @@ impl Network<DynProvider> {
             match network.withdraw_tokens().await {
                 Ok(()) => {}
                 Err(e) => {
-                    println!("failed to withdraw from faucet - probably already done: {}", e)
+                    println!("failed to withdraw from faucet - probably already done: {e}")
                 }
             };
 
@@ -48,7 +48,7 @@ impl Network<DynProvider> {
 
     pub async fn new(signer: &PrivateKeySigner, config: &NetworkConfig) -> eyre::Result<Self> {
         let url = config.rpc_url.clone();
-        let chain_id = config.chain_id.clone();
+        let chain_id = config.chain_id;
         let provider = ProviderBuilder::new()
             .with_gas_estimation()
             .wallet(EthereumWallet::new(signer.clone()))
@@ -57,7 +57,7 @@ impl Network<DynProvider> {
             .erased();
         let own_addr = signer.address();
 
-        println!("own addr: {}", own_addr);
+        println!("own addr: {own_addr}");
         Ok(Self {
             token: ERC20FaucetToken::new(config.rusd_address.parse()?, provider.clone()),
             router: RouterInstance::new(config.router_address.parse()?, provider.clone()),
@@ -86,7 +86,7 @@ impl<P: Provider> Network<P> {
     }
 
     pub async fn stream_block_numbers(&self) -> eyre::Result<Pin<Box<dyn Stream<Item = BlockEvent> + Send>>> {
-        let chain_id = self.chain_id.clone();
+        let chain_id = self.chain_id;
         let stream = self.provider.subscribe_blocks().await?.into_stream().map(move |header| BlockEvent {
             chain_id,
             block_number: header.number,
@@ -99,7 +99,7 @@ impl<P: Provider> Network<P> {
 #[async_trait]
 impl ChainStateProvider for Network<DynProvider> {
     async fn fetch_state(&self) -> eyre::Result<ChainState> {
-        let token_addr = self.token.address().clone();
+        let token_addr = *self.token.address();
         let native_balance = self.provider.get_balance(self.own_addr).await?;
         let token_balance = self.token.balanceOf(self.own_addr).call().await?;
         let already_fulfilled = self.router.getFulfilledTransfers().call().await?.into_iter().map_into().collect_vec();
diff --git a/src/solver.rs b/src/solver.rs
diff --git a/src/util.rs b/src/util.rs

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ impl<'a, P: Provider> TradeExecutor<'a, P> {`
`41`	`41`	`match approve {`
`42`	`42`	`Ok(_) => {}`
`43`	`43`	`Err(e) => {`
`44`		`- println!("error approving trade: {}", e);`
	`44`	`+ println!("error approving trade: {e}");`
`45`	`45`	`}`
`46`	`46`	`}`
`47`	`47`