chore: ran pre-commit run --all

Ifechukwudaniel · Ifechukwudaniel · commit 4380ef444cd8 · 2025-01-17T23:49:54.000Z
diff --git a/.github/workflows/cli-stylus-check.yml b/.github/workflows/cli-stylus-check.yml
@@ -56,7 +56,7 @@ jobs:
       matrix:
         # Get early warning of new lints which are regularly introduced in beta
         # channels.
-        toolchain: [ stable, beta ]
+        toolchain: [stable, beta]
     steps:
       - uses: actions/checkout@v4
         with:
@@ -72,7 +72,7 @@ jobs:
       - name: Cargo clippy
         uses: giraffate/clippy-action@v1
         with:
-          reporter: 'github-pr-check'
+          reporter: "github-pr-check"
           github_token: ${{ secrets.GITHUB_TOKEN }}
   doc:
     # Run docs generation on nightly rather than stable. This enables features
diff --git a/.github/workflows/cli-stylus-nostd.yml b/.github/workflows/cli-stylus-nostd.yml
@@ -24,7 +24,7 @@ jobs:
     name: ${{ matrix.target }}
     strategy:
       matrix:
-        target: [ wasm32-unknown-unknown ]
+        target: [wasm32-unknown-unknown]
     steps:
       - uses: actions/checkout@v4
         with:
diff --git a/.github/workflows/publish-pythnet-stylus-sdk.yml b/.github/workflows/publish-pythnet-stylus-sdk.yml
@@ -15,4 +15,4 @@ jobs:
       - run: cargo publish --token ${CARGO_REGISTRY_TOKEN}
         env:
           CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
-        working-directory: target_chains/ethereum/sdk/stylus
+        working-directory: target_chains/ethereum/sdk/stylus
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -165,7 +165,7 @@ repos:
         files: lazer
       - id: cargo-fmt-stylus-sdk
         name: Cargo format for Stylus SDK
-        language: "rust"        
+        language: "rust"
         entry: cargo +1.82.0 fmt --manifest-path ./target_chains/ethereum/sdk/stylus/Cargo.toml --all
         pass_filenames: false
         files: target_chains/ethereum/sdk/stylus
diff --git a/target_chains/ethereum/sdk/stylus/GUIDELINES.md b/target_chains/ethereum/sdk/stylus/GUIDELINES.md
@@ -2,4 +2,4 @@
 
 For best practices, coding standards, and other essential guidelines, please refer to the official [OpenZeppelin Rust Contracts Stylus Engineering Guidelines](https://github.com/OpenZeppelin/rust-contracts-stylus/blob/main/GUIDELINES.md).
 
-This document outlines the principles and practices for  ths codebase , maintainable, and secure Rust code within the context of the Rust Contracts Stylus project. 
+This document outlines the principles and practices for ths codebase , maintainable, and secure Rust code within the context of the Rust Contracts Stylus project.
diff --git a/target_chains/ethereum/sdk/stylus/README.md b/target_chains/ethereum/sdk/stylus/README.md
@@ -33,7 +33,6 @@ To consume prices, use the functions interface. Be sure to read the function doc
 
 For example, to read the latest price, call [`getPriceNoOlderThan`](https://github.com/pyth-network/pyth-crosschain/blob/stylus-sdk/target_chains/ethereum/sdk/stylus/contracts/src/pyth/functions.rs) with the Price ID of the price feed you are interested in:
 
-
 You can interact directly with the Pyth contract, which implements the IPyth functions, instead of using call functions:
 
 ```rust
@@ -61,7 +60,6 @@ impl ProxyCallsExample {
 
 [MockPyth](./mock.rs) is a mock contract that can be deployed locally to simulate Pyth contract behavior. To set and update price feeds, call `updatePriceFeeds` and provide an array of encoded price feeds as the argument. Encoded price feeds can be created using the `create_price_feed_update_data` function in the mock contract, which is also available in the functions module.
 
-
 ## Test Documentation
 
 ### Running Unit Tests for `pyth-stylus`
@@ -73,10 +71,10 @@ cargo test -p pyth-stylus --all-features
 ```
 
 This command will:
+
 - Target the `pyth-stylus` package specifically (`-p pyth-stylus`).
 - Enable **all features** defined in the package during the test run (`--all-features`).
 
-
 ### Running End-to-End Tests
 
 To run the end-to-end tests for `pyth-stylus`, follow these steps:
@@ -92,7 +90,6 @@ To run the end-to-end tests for `pyth-stylus`, follow these steps:
    ./scripts/e2e-tests.sh
    ```
 
-
 ### Releases
 
 We use [Semantic Versioning](https://semver.org/) for our releases. To release a new version of this package and publish it to npm, follow these steps:
diff --git a/target_chains/ethereum/sdk/stylus/contracts/Cargo.toml b/target_chains/ethereum/sdk/stylus/contracts/Cargo.toml
@@ -31,5 +31,3 @@ crate-type = ["lib", "cdylib"]
 
 [lints]
 workspace = true
-
-
diff --git a/target_chains/ethereum/sdk/stylus/examples/extend-pyth-example/Cargo.toml b/target_chains/ethereum/sdk/stylus/examples/extend-pyth-example/Cargo.toml
@@ -24,4 +24,4 @@ e2e.workspace = true
 crate-type = ["lib", "cdylib"]
 
 [features]
-e2e = []
+e2e = []
diff --git a/target_chains/ethereum/sdk/stylus/examples/extend-pyth-example/README.MD b/target_chains/ethereum/sdk/stylus/examples/extend-pyth-example/README.MD
@@ -1 +1 @@
-# This is an example using the sdk and extending it to  use other funtions 
+# This is an example using the sdk and extending it to use other funtions
diff --git a/target_chains/ethereum/sdk/stylus/examples/function-example/Cargo.toml b/target_chains/ethereum/sdk/stylus/examples/function-example/Cargo.toml
@@ -24,4 +24,4 @@ e2e.workspace = true
 crate-type = ["lib", "cdylib"]
 
 [features]
-e2e = []
+e2e = []
diff --git a/target_chains/ethereum/sdk/stylus/examples/function-example/README.MD b/target_chains/ethereum/sdk/stylus/examples/function-example/README.MD
@@ -1 +1 @@
-# This is an example using function call as defined in the sdk
+# This is an example using function call as defined in the sdk
diff --git a/target_chains/ethereum/sdk/stylus/examples/function-example/src/constructor.sol b/target_chains/ethereum/sdk/stylus/examples/function-example/src/constructor.sol
@@ -32,4 +32,4 @@ contract FunctionCallsExample {
         priceFeed = PriceFeed(_priceId, price, ema_price);
         ema_priceFeed = PriceFeed(_priceId, ema_price, ema_price);
     }
-}
+}
diff --git a/target_chains/ethereum/sdk/stylus/examples/pyth-example/Cargo.toml b/target_chains/ethereum/sdk/stylus/examples/pyth-example/Cargo.toml
@@ -24,4 +24,4 @@ e2e.workspace = true
 crate-type = ["lib", "cdylib"]
 
 [features]
-e2e = []
+e2e = []
diff --git a/target_chains/ethereum/sdk/stylus/examples/pyth-example/README.MD b/target_chains/ethereum/sdk/stylus/examples/pyth-example/README.MD
@@ -1 +1 @@
-# This is an example using  sdk with an example contract
+# This is an example using sdk with an example contract
diff --git a/target_chains/ethereum/sdk/stylus/pyth-mock-solidity/README.md b/target_chains/ethereum/sdk/stylus/pyth-mock-solidity/README.md
@@ -1,14 +1,13 @@
 ## Foundry
 
-**The goal of the folder is to deploy a mock  solidity pyth contract using the pyth sdk**
-
+**The goal of the folder is to deploy a mock solidity pyth contract using the pyth sdk**
 
 Foundry consists of:
 
--   **Forge**: Ethereum testing framework (like Truffle, Hardhat, and DappTools).
--   **Cast**: Swiss army knife for interacting with EVM smart contracts, sending transactions, and getting chain data.
--   **Anvil**: Local Ethereum node, akin to Ganache, Hardhat Network.
--   **Chisel**: Fast, utilitarian, and verbose solidity REPL.
+- **Forge**: Ethereum testing framework (like Truffle, Hardhat, and DappTools).
+- **Cast**: Swiss army knife for interacting with EVM smart contracts, sending transactions, and getting chain data.
+- **Anvil**: Local Ethereum node, akin to Ganache, Hardhat Network.
+- **Chisel**: Fast, utilitarian, and verbose solidity REPL.
 
 ## Documentation
 
diff --git a/target_chains/ethereum/sdk/stylus/pyth-mock-solidity/package.json b/target_chains/ethereum/sdk/stylus/pyth-mock-solidity/package.json
@@ -5,7 +5,7 @@
   "directories": {
     "lib": "lib",
     "test": "test"
-  }, 
+  },
   "keywords": [],
   "author": "",
   "license": "ISC",
diff --git a/target_chains/ethereum/sdk/stylus/pyth-mock-solidity/remappings.txt b/target_chains/ethereum/sdk/stylus/pyth-mock-solidity/remappings.txt
@@ -1 +1 @@
-@pythnetwork/pyth-sdk-solidity/=node_modules/@pythnetwork/pyth-sdk-solidity
+@pythnetwork/pyth-sdk-solidity/=node_modules/@pythnetwork/pyth-sdk-solidity
diff --git a/target_chains/ethereum/sdk/stylus/pyth-mock-solidity/script/MockPyth.s.sol b/target_chains/ethereum/sdk/stylus/pyth-mock-solidity/script/MockPyth.s.sol
@@ -6,14 +6,23 @@ import {MockPythSample} from "../src/MockPyth.sol";
 
 contract MockPythScript is Script {
     uint randNonce = 0;
-    string[] tickers  =  ["ETH", "BTC", "USDT", "BNB", "SOL", "MATIC", "ADA", "DOT", "DOGE", "SHIB"];
-    bytes[]  priceData = new bytes[](tickers.length);
+    string[] tickers = [
+        "ETH",
+        "BTC",
+        "USDT",
+        "BNB",
+        "SOL",
+        "MATIC",
+        "ADA",
+        "DOT",
+        "DOGE",
+        "SHIB"
+    ];
+    bytes[] priceData = new bytes[](tickers.length);
     bytes32[] priceIds = new bytes32[](tickers.length);
     MockPythSample pyth_contract;
 
-    function setUp() public {
-    
-    }
+    function setUp() public {}
 
     function run() public {
         vm.startBroadcast();
@@ -24,19 +33,26 @@ contract MockPythScript is Script {
         pyth_contract.updatePriceFeeds{value: update_cost}(priceData);
         vm.stopBroadcast();
     }
-    
+
     function deploy(uint validTimePeriod, uint singleUpdateFeeInWei) internal {
-        pyth_contract = new MockPythSample(validTimePeriod, singleUpdateFeeInWei);
+        pyth_contract = new MockPythSample(
+            validTimePeriod,
+            singleUpdateFeeInWei
+        );
     }
 
     function _generateInitialData() internal {
         for (uint i = 0; i < tickers.length; i++) {
             priceIds[i] = keccak256(abi.encodePacked(tickers[i]));
-            
-            uint randomBase = uint(keccak256(abi.encodePacked(block.timestamp, priceIds[i], msg.sender)));
-            
-            int64 price = int64(uint64(_deriveRandom(randomBase, 1) % 10 ));
-            uint64 conf = uint64(_deriveRandom(randomBase, 2) % 10); 
+
+            uint randomBase = uint(
+                keccak256(
+                    abi.encodePacked(block.timestamp, priceIds[i], msg.sender)
+                )
+            );
+
+            int64 price = int64(uint64(_deriveRandom(randomBase, 1) % 10));
+            uint64 conf = uint64(_deriveRandom(randomBase, 2) % 10);
             int32 expo = int32(uint32(_deriveRandom(randomBase, 3) % 40));
             int64 emaPrice = int64(uint64(_deriveRandom(randomBase, 4) % 10));
             uint64 emaConf = uint64(_deriveRandom(randomBase, 5) % 10);
@@ -51,12 +67,11 @@ contract MockPythScript is Script {
                 0
             );
         }
-        
     }
 
     // Internal function to generate deterministic random numbers from a base seed
     function _deriveRandom(uint base, uint salt) internal pure returns (uint) {
-        return uint(keccak256(abi.encodePacked(base, salt)) ) + 1;
+        return uint(keccak256(abi.encodePacked(base, salt))) + 1;
     }
 
     function uint2str(uint256 _i) internal pure returns (string memory str) {
@@ -65,17 +80,15 @@ contract MockPythScript is Script {
         }
         uint256 j = _i;
         uint256 length;
-        while (j != 0)
-        {
+        while (j != 0) {
             length++;
             j /= 10;
         }
         bytes memory bstr = new bytes(length);
         uint256 k = length;
         j = _i;
-        while (j != 0)
-        {
-            bstr[--k] = bytes1(uint8(48 + j % 10));
+        while (j != 0) {
+            bstr[--k] = bytes1(uint8(48 + (j % 10)));
             j /= 10;
         }
         str = string(bstr);
diff --git a/target_chains/ethereum/sdk/stylus/pyth-mock-solidity/src/MockPyth.sol b/target_chains/ethereum/sdk/stylus/pyth-mock-solidity/src/MockPyth.sol
@@ -6,8 +6,7 @@ import {console} from "forge-std/console.sol";
 
 contract MockPythSample is MockPyth {
     constructor(
-        uint validTimePeriod, uint singleUpdateFeeInWei
-    )  MockPyth(validTimePeriod, singleUpdateFeeInWei) {
-        
-    }
-}
+        uint validTimePeriod,
+        uint singleUpdateFeeInWei
+    ) MockPyth(validTimePeriod, singleUpdateFeeInWei) {}
+}
diff --git a/target_chains/ethereum/sdk/stylus/pyth-mock-solidity/test/MockPyth.t.sol b/target_chains/ethereum/sdk/stylus/pyth-mock-solidity/test/MockPyth.t.sol
@@ -4,6 +4,5 @@ pragma solidity ^0.8.13;
 import {Test, console} from "forge-std/Test.sol";
 
 contract MockPythTest is Test {
-    function setUp() public {
-    }
+    function setUp() public {}
 }
diff --git a/target_chains/ethereum/sdk/stylus/scripts/bench.sh b/target_chains/ethereum/sdk/stylus/scripts/bench.sh
@@ -14,7 +14,7 @@ export PRIVATE_KEY=0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f
 export WALLER_ADDRESS=0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266
 ls
 cd "nitro-testnode"
-./test-node.bash script send-l2 --to address_$WALLER_ADDRESS --ethamount 0.1    
+./test-node.bash script send-l2 --to address_$WALLER_ADDRESS --ethamount 0.1
 
 cd ..
 cd "pyth-mock-solidity"
diff --git a/target_chains/ethereum/sdk/stylus/scripts/check-wasm.sh b/target_chains/ethereum/sdk/stylus/scripts/check-wasm.sh
@@ -1,5 +1,5 @@
 #!/bin/bash
-# This script compiles Rust contracts to WebAssembly and validates the .wasm binaries for correctness using cargo stylus check. 
+# This script compiles Rust contracts to WebAssembly and validates the .wasm binaries for correctness using cargo stylus check.
 # It retrieves crate names from Cargo.toml files in the examples directory and ensures each compiled contract is valid
 
 set -e
diff --git a/target_chains/ethereum/sdk/stylus/scripts/deploy.sh b/target_chains/ethereum/sdk/stylus/scripts/deploy.sh
@@ -1,5 +1,5 @@
 #!/bin/bash
-# This script compiles Rust contracts to WebAssembly and deploys the .wasm binaries to a blockchain using `cargo stylus deploy`. 
+# This script compiles Rust contracts to WebAssembly and deploys the .wasm binaries to a blockchain using `cargo stylus deploy`.
 # It retrieves crate names from Cargo.toml files in the examples directory and automates the deployment process for each contract.
 
 set -e
@@ -13,7 +13,7 @@ export PRIVATE_KEY=0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f
 export WALLER_ADDRESS=0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266
 
 cd "nitro-testnode"
-./test-node.bash script send-l2 --to address_$WALLER_ADDRESS --ethamount 0.1    
+./test-node.bash script send-l2 --to address_$WALLER_ADDRESS --ethamount 0.1
 
 
 cd ..
diff --git a/target_chains/ethereum/sdk/stylus/scripts/e2e-tests.sh b/target_chains/ethereum/sdk/stylus/scripts/e2e-tests.sh
@@ -12,7 +12,7 @@ export WALLER_ADDRESS=0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266
 
 cd ..
 cd "nitro-testnode"
-./test-node.bash script send-l2 --to address_$WALLER_ADDRESS --ethamount 0.1    
+./test-node.bash script send-l2 --to address_$WALLER_ADDRESS --ethamount 0.1
 
 cd ..
 cd "pyth-mock-solidity"
@@ -34,4 +34,4 @@ cargo +"$NIGHTLY_TOOLCHAIN" build --release --target wasm32-unknown-unknown -Z b
 export RPC_URL=http://localhost:8547
 # We should use stable here once nitro-testnode is updated and the contracts fit
 # the size limit. Work tracked [here](https://github.com/OpenZeppelin/rust-contracts-stylus/issues/87)
-cargo +"$NIGHTLY_TOOLCHAIN" test --features std,e2e --test "*" 
+cargo +"$NIGHTLY_TOOLCHAIN" test --features std,e2e --test "*"

Original file line number	Diff line number	Diff line change
`@@ -2,4 +2,4 @@`
`2`	`2`
`3`	`3`	`For best practices, coding standards, and other essential guidelines, please refer to the official [OpenZeppelin Rust Contracts Stylus Engineering Guidelines](https://github.com/OpenZeppelin/rust-contracts-stylus/blob/main/GUIDELINES.md).`
`4`	`4`
`5`		`-This document outlines the principles and practices for ths codebase , maintainable, and secure Rust code within the context of the Rust Contracts Stylus project.`
	`5`	`+This document outlines the principles and practices for ths codebase , maintainable, and secure Rust code within the context of the Rust Contracts Stylus project.`
-Original file line number
+Diff line change
 [lints]
 workspace = true
+-
+-
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-# This is an example using the sdk and extending it to use other funtions`
	`1`	`+# This is an example using the sdk and extending it to use other funtions`