(fix) Try to fix clippy warnings

Zilliqa · Aug 9, 2024 · 3f64d0f · 3f64d0f
1 parent e888936
commit 3f64d0f
Show file tree

Hide file tree

Showing 9 changed files with 119 additions and 61 deletions.
diff --git a/.trunk/trunk.yaml b/.trunk/trunk.yaml
@@ -9,7 +9,7 @@ plugins:
 
 lint:
   enabled:
-    - clippy@1.65.0
+    - clippy@1.80.1
     - [email protected]
     - [email protected]
     - [email protected]
@@ -28,7 +28,7 @@ lint:
     - [email protected]
     - [email protected]
     - [email protected]
-    - rustfmt@1.65.0
+    - rustfmt@1.80.1
     # - [email protected] - removed for being over-prissy and wanting tab indents - rrw 2023-04-25
   ignore:
     - linters: [gitleaks]
@@ -57,6 +57,7 @@ lint:
         - "**/templates/*"
         - "templates/**"
         - "**/templates/**"
+        - "smart-contracts/test/zilbridge/tokens/switcheo/**"
 
 runtimes:
   enabled:

diff --git a/bridge-validators/src/block.rs b/bridge-validators/src/block.rs
@@ -122,9 +122,7 @@ impl BlockPolling for ChainClient {
 
     async fn get_historic_blocks(&self, from: u64, to: u64) -> Result<()> {
         let concurrent_requests = futures::stream::iter(
-            (from..to)
-                .into_iter()
-                .map(|block_number| self.client.get_block(block_number)),
+            (from..to).map(|block_number| self.client.get_block(block_number)),
         )
         .buffer_unordered(3)
         .map(|r| {

diff --git a/bridge-validators/src/bridge_node.rs b/bridge-validators/src/bridge_node.rs
@@ -77,7 +77,7 @@ impl BridgeNode {
         self.chain_client
             .get_events(
                 event.filter,
-                self.chain_client.chain_gateway_block_deployed.into(),
+                self.chain_client.chain_gateway_block_deployed,
                 to_block,
             )
             .await

diff --git a/bridge-validators/src/p2p_node.rs b/bridge-validators/src/p2p_node.rs
@@ -219,10 +219,12 @@ impl P2pNode {
                         Ok(Ok(())) => unreachable!(),
                         Ok(Err(e)) => {
                             error!(%e);
+                            #[allow(clippy::useless_conversion)]
                             return Err(e.into())
                         }
                         Err(e) =>{
                             error!(%e);
+                            #[allow(clippy::useless_conversion)]
                             return Err(e.into())
                         }
                     }

diff --git a/bridge-validators/src/validator_node.rs b/bridge-validators/src/validator_node.rs
@@ -139,10 +139,12 @@ impl ValidatorNode {
                         Ok(Ok(())) => unreachable!(),
                         Ok(Err(e)) => {
                             error!(%e);
+                            #[allow(clippy::useless_conversion)]
                             return Err(e.into())
                         }
                         Err(e) =>{
                             error!(%e);
+                            #[allow(clippy::useless_conversion)]
                             return Err(e.into())
                         }
                     }

diff --git a/bridge-web/README.md b/bridge-web/README.md
@@ -12,12 +12,14 @@ npm run dev
 ## Running locally
 
 ```sh
-mitmweb --mode reverse:https://data-seed-prebsc-1-s1.binance.org:8545/ --no-web-open-browser --listen-port 5556 --web-port 5557
+mitmweb --mode reverse:https://data-seed-prebsc-1-s1.binance.org:8545/ \
+  --no-web-open-browser --listen-port 5556 --web-port 5557
 export VITE_BSC_TESTNET_API=http://localhost:5556
 export VITE_BSC_TESTNET_KEY=
 ```
 
-This is designed so that if you have a quiknode endpoint, you can set `VITE_BSC_TESTNET_KEY` to your key.
+This is designed so that if you have a quiknode endpoint, you can set
+`VITE_BSC_TESTNET_KEY` to your key.
 
 ## How to modify the encoded configuration
 

diff --git a/docs/todo.md b/docs/todo.md
@@ -1,4 +1,14 @@
 # TODOs
 
-1. Refactor SafeMath out of all the zilbridge takeover contracts; less conformant, but it's the default in 0.8.x and above.
-2. The validator should check whether the transaction it proxied ran out of gas (meter the gas used by the subtransaction and if the subtxn failed and it has < 15/16, say, gas left, it probably ran out - try again with more gas).
+1. Refactor SafeMath out of all the zilbridge takeover contracts; less
+   conformant, but it's the default in 0.8.x and above.
+
+2. The validator should check whether the transaction it proxied ran
+   out of gas (meter the gas used by the subtransaction and if the
+   subtxn failed and it has < 15/16, say, gas left, it probably ran
+   out - try again with more gas).
+
+3. We don't cope well when (as quite often happens) a chain (usually BSC)
+   simply never confirms receipt of a transaction and we need to send it
+   again (or just assume it succeeded, because although it has run, the
+   chain isn't prepared to tell us this).
diff --git a/docs/zilbridge.md b/docs/zilbridge.md
@@ -22,7 +22,8 @@ This means we need to either proxy or replace it.
 Replacing it is undesirable, because the address of the CCM is baked
 into the configuration files for the relayers.
 
-My first attempt was to proxy it with a `CCMExtendProxy`, but this doesn't work, because:
+My first attempt was to proxy it with a `CCMExtendProxy`, but this
+doesn't work, because:
 
 - To upgrade you have to call `ccmProxy::upgradeEthCrossChainManager()`
 - (side-note: this calls the _current_ `eccm.upgradeToNew()` which
@@ -93,54 +94,69 @@ Set `PRIVATE_KEY_TESTNET` to the validator privkey, and
 After each step (each script run) in the below, you will need to:
 
 - Verify the contracts you just deployed.
-- Update the `testnet_config.s.sol` file with the addresses of the contracts you just deployed.
+- Update the `testnet_config.s.sol` file with the addresses of the
+  contracts you just deployed.
 
 In most cases, the script will give you the name of the
 `testnet_config.s.sol` constant to update.
 
 Run with:
 
 ```sh
-forge script script/bsc-testnet/deployMockZilBridge.s.sol --rpc-url https://bsc-testnet.bnbchain.org --broadcast
+forge script script/bsc-testnet/deployMockZilBridge.s.sol \
+   --rpc-url https://bsc-testnet.bnbchain.org --broadcast
 
-forge verify-contract <address> --rpc-url https://bsc-testnet.bnbchain.org --chain-id 97
+forge verify-contract <address> --rpc-url https://bsc-testnet.bnbchain.org \
+  --chain-id 97
 # Now fill in the data to test_config.s.sol
-forge script script/bsc-testnet/deployXBridgeOverMockZilBridge.s.sol --rpc-url https://bsc-testnet.bnbchain.org --broadcast
-forge verify-contract <address> --rpc-url https://bsc-testnet.bnbchain.org --chain-id 97
+forge script script/bsc-testnet/deployXBridgeOverMockZilBridge.s.sol \
+   --rpc-url https://bsc-testnet.bnbchain.org --broadcast
+forge verify-contract <address> --rpc-url https://bsc-testnet.bnbchain.org \
+  --chain-id 97
 # and again ..
-forge script scripts/bsc-testnet/deployZilBridgeTokenManagers.s.sol --rpc-url https://bsc-testnet.bnbchain.org --broadcast
-forge verify-contract <address> --rpc-url https://bsc-testnet.bnbchain.org --chain-id 97
+forge script scripts/bsc-testnet/deployZilBridgeTokenManagers.s.sol \
+  --rpc-url https://bsc-testnet.bnbchain.org --broadcast
+forge verify-contract <address> --rpc-url https://bsc-testnet.bnbchain.org \
+  --chain-id 97
 
 ```
 
-Remember to verify all your contracts on BSC, or you will get hopelessly confused later.
+Remember to verify all your contracts on BSC, or you will get
+hopelessly confused later.
 
-Now we need to deploy some contracts on the Zilliqa testnet. You can verify on Zilliqa via sourcify:
+Now we need to deploy some contracts on the Zilliqa testnet. You can
+verify on Zilliqa via sourcify:
 
-```
-forge verify-contract <address> --rpc-url https://dev-api.zilliqa.com --chain-id 33101 --verifier sourcify
+```sh
+forge verify-contract <address> --rpc-url https://dev-api.zilliqa.com \
+  --chain-id 33101 --verifier sourcify
 ```
 
 We'll need our own token manager. This is identical to the
 `LockAndReleaseTokenManager`, but contains some additional
 functionality to deal with bridging native tokens (so that bridged ZIL
 can be made to work).
 
-```
-forge script script/zq-testnet/deployNativeTokenManagerV3.s.sol --rpc-url https://dev-api.zilliqa.com --broadcast --legacy
-forge script script/zq-testnet/setChainGatewayOnTokenManager.s.sol --rpc-url https://dev-api.zilliqa.com --broadcast --legacy
+```sh
+forge script script/zq-testnet/deployNativeTokenManagerV3.s.sol \
+  --rpc-url https://dev-api.zilliqa.com --broadcast --legacy
+forge script script/zq-testnet/setChainGatewayOnTokenManager.s.sol \
+  --rpc-url https://dev-api.zilliqa.com --broadcast --legacy
 ```
 
 Now we can deploy some contracts to the BNB testnet:
 
-```
-forge script script/bsc-testnet/deployZilBridgeTokens.s.sol --tc Deployment --rpc-url https://bsc-testnet.bnbchain.org --broadcast
-forge verify-contract <address> --rpc-url https://bsc-testnet.bnbchain.org --chain-id 97
+```sh
+forge script script/bsc-testnet/deployZilBridgeTokens.s.sol \
+  --tc Deployment --rpc-url https://bsc-testnet.bnbchain.org \
+  --broadcast
+forge verify-contract <address> --rpc-url https://bsc-testnet.bnbchain.org \
+  --chain-id 97
 ```
 
 And the corresponding tokens to the Zilliqa testnet:
 
-```
+```sh
 cd scilla-contracts
 pnpm i
 export TOKEN_MANAGER_ADDRESS=(value of zq_lockAndReleaseOrNativeTokenManager)
@@ -150,15 +166,19 @@ npx hardhat run scripts/deploy.ts --network zq_testnet
 
 And now we ship an ERC20 proxy for our ZRC2 and switcheo tokens.
 
-```
-forge script script/zq-testnet/deployZRC2ERC20.s.sol --rpc-url https://dev-api.zilliqa.com --broadcast --legacy
+```sh
+forge script script/zq-testnet/deployZRC2ERC20.s.sol \
+  --rpc-url https://dev-api.zilliqa.com --broadcast --legacy
 ```
 
-And now we can set up routing for the tokens we just deployed. This is "just" calls, so
+And now we can set up routing for the tokens we just deployed. This is
+"just" calls, so
 
-```
-forge script script/bsc-testnet/setZilBridgeRouting.s.sol --rpc-url https://bsc-testnet.bnbchain.org --broadcast
-forge script script/zq-testnet/setZilBridgeRouting.s.sol --rpc-url https://dev-api.zilliqa.com --broadcast --legacy
+```sh
+forge script script/bsc-testnet/setZilBridgeRouting.s.sol \
+  --rpc-url https://bsc-testnet.bnbchain.org --broadcast
+forge script script/zq-testnet/setZilBridgeRouting.s.sol \
+  --rpc-url https://dev-api.zilliqa.com --broadcast --legacy
 ```
 
 ### Testing
@@ -174,26 +194,30 @@ export VITE_BSC_TESTNET_API=http://localhost:6128
 export VITE_BSC_TESTNET_KEY=""
 ```
 
-Remember to omit the trailing '/' from `VITE_BSC_TESTNET_API` or you will get CORS errors.
+Remember to omit the trailing '/' from `VITE_BSC_TESTNET_API` or you
+will get CORS errors.
 
 And run:
 
-```
-mitmweb --mode reverse:https://data-seed-prebsc-1-s1.binance.org:8545/ --no-web-open-browser --listen-port 6128 --web-port 6001
+```sh
+mitmweb --mode reverse:https://data-seed-prebsc-1-s1.binance.org:8545/ \
+  --no-web-open-browser --listen-port 6128 --web-port 6001
 ```
 
-Put the token and token manager addresses from `testnet_config.s.sol` into `bridge-web/src/config/config.ts` .
+Put the token and token manager addresses from `testnet_config.s.sol`
+into `bridge-web/src/config/config.ts` .
 
 You can transfer yourself some tokens by setting
 `ZILBRIDGE_TEST_ADDRESS` and `ZILBRIDGE_TEST_AMOUNT` and running:
 
-```
-forge script script/bsc-testnet/zilBridgeTransferERC20.s.sol --rpc-url https://bsc-testnet.bnbchain.org --broadcast
+```sh
+forge script script/bsc-testnet/zilBridgeTransferERC20.s.sol \
+  --rpc-url https://bsc-testnet.bnbchain.org --broadcast
 ```
 
 And, setting `ZILBRIDGE_SCILLA_TOKEN_ADDRESS` to the Scilla token address:
 
-```
+```sh
 npx hardhat run scripts/transfer.ts
 ```
 
@@ -207,45 +231,62 @@ in.
 
 ### Debugging from-zilliqa transfers
 
-Since Zilliqa testnet doesn't support tracing, this is done by bisection. You only need one way, since we only care about the sending txn working.
+Since Zilliqa testnet doesn't support tracing, this is done by
+bisection. You only need one way, since we only care about the sending
+txn working.
 
 - Redeploy the token manager on ZQ:
 
-```
-forge script script/zq-testnet/deployNativeTokenManagerV3.s.sol --rpc-url https://dev-api.zilliqa.com --broadcast --legacy
+```sh
+forge script script/zq-testnet/deployNativeTokenManagerV3.s.sol \
+  --rpc-url https://dev-api.zilliqa.com --broadcast --legacy
 <edit config>
-forge script script/zq-testnet/setChainGatewayOnTokenManager.s.sol --rpc-url https://dev-api.zilliqa.com --broadcast --legacy
-forge verify-contract <address> --rpc-url https://dev-api.zilliqa.com --chain-id 33101
+forge script script/zq-testnet/setChainGatewayOnTokenManager.s.sol \
+  --rpc-url https://dev-api.zilliqa.com --broadcast --legacy
+forge verify-contract <address> --rpc-url https://dev-api.zilliqa.com \
+ --chain-id 33101
 ```
 
-- Now write some routing - it actually doesn't matter that the routing gets messed up, because we're only testing Zilliqa ZRC2 out, and the native ZRC2 doesn't
-  care what the token manager is:
+Now write some routing - it actually doesn't matter that the routing
+gets messed up, because we're only testing Zilliqa ZRC2 out, and the
+native ZRC2 doesn't care what the token manager is:
 
-```
-forge script script/zq-testnet/setZilBridgeRouting.s.sol --rpc-url https://dev-api.zilliqa.com --broadcast --legacy
+```sh
+forge script script/zq-testnet/setZilBridgeRouting.s.sol \
+  --rpc-url https://dev-api.zilliqa.com --broadcast --legacy
 ```
 
 - Run `transfer.ts` to transfer some `ZBTEST` to the wallet you want to test.
 - List the new token manager in `config.ts` in `bridge-web`
 
-Now you can send a `transfer()` request and see if it works .. you'll need to redeploy the test token contracts and rerun routing setup (from both sides!) to fix the bridge when the bugs are sorted.
+Now you can send a `transfer()` request and see if it works .. you'll
+need to redeploy the test token contracts and rerun routing setup
+(from both sides!) to fix the bridge when the bugs are sorted.
 
-When you're done, you'll need to redeploy the rest of the tokens, so that the bridged ZRC2 has the right token manager set, then set up routing again:
+When you're done, you'll need to redeploy the rest of the tokens, so
+that the bridged ZRC2 has the right token manager set, then set up
+routing again:
 
-```
+```sh
 cd scilla-contracts
 pnpm i
-export TOKEN_MANAGER_ADDRESS=(value of zq_lockAndReleaseOrNativeTokenManager WITHOUT 0x prefix)
-# NOW EDIT scripts/deploy.ts for the address of the Zilliqa testnet token manager.
+export TOKEN_MANAGER_ADDRESS=(value of
+  zq_lockAndReleaseOrNativeTokenManager WITHOUT 0x prefix)
+
+# NOW EDIT scripts/deploy.ts for the address of the
+# Zilliqa testnet token manager.
 npx hardhat run scripts/deploy.ts --network zq_testnet
 ```
 
 Remember to update `testnet_config.sol`, then:
 
-```
-forge script script/zq-testnet/deployZRC2ERC20.s.sol --rpc-url https://dev-api.zilliqa.com --broadcast --legacy
-forge script script/bsc-testnet/setZilBridgeRouting.s.sol --rpc-url https://bsc-testnet.bnbchain.org --broadcast
-forge script script/zq-testnet/setZilBridgeRouting.s.sol --rpc-url https://dev-api.zilliqa.com --broadcast --legacy
+```sh
+forge script script/zq-testnet/deployZRC2ERC20.s.sol \
+  --rpc-url https://dev-api.zilliqa.com --broadcast --legacy
+forge script script/bsc-testnet/setZilBridgeRouting.s.sol \
+  --rpc-url https://bsc-testnet.bnbchain.org --broadcast
+forge script script/zq-testnet/setZilBridgeRouting.s.sol \
+  --rpc-url https://dev-api.zilliqa.com --broadcast --legacy
 ```
 
 And you can now get testing again.
diff --git a/scilla-contracts/README.md b/scilla-contracts/README.md
@@ -1,6 +1,8 @@
 # Sample Hardhat Project
 
-This project demonstrates a basic Hardhat use case. It comes with a sample contract, a test for that contract, and a Hardhat Ignition module that deploys that contract.
+This project demonstrates a basic Hardhat use case. It comes with a
+sample contract, a test for that contract, and a Hardhat Ignition
+module that deploys that contract.
 
 Try running some of the following tasks: