diff --git a/src/output/cheatcodes/forge-test-cheatcodes b/src/output/cheatcodes/forge-test-cheatcodes index 61b11b7d0..c0ef267c9 100644 --- a/src/output/cheatcodes/forge-test-cheatcodes +++ b/src/output/cheatcodes/forge-test-cheatcodes @@ -8,10 +8,10 @@ No files changed, compilation skipped No files changed, compilation skipped Ran 2 tests for test/OwnerUpOnly.t.sol:OwnerUpOnlyTest -[PASS] testFail_IncrementAsNotOwner() (gas: 216319) -[PASS] test_IncrementAsOwner() (gas: 734680) -Suite result: ok. 2 passed; 0 failed; 0 skipped; finished in 35.53ms (27.31ms CPU time) +[PASS] testFail_IncrementAsNotOwner() (gas: 120313) +[PASS] test_IncrementAsOwner() (gas: 350662) +Suite result: ok. 2 passed; 0 failed; 0 skipped; finished in 26.27ms (22.38ms CPU time) -Ran 1 test suite in 36.34ms (35.53ms CPU time): 2 tests passed, 0 failed, 0 skipped (2 total tests) +Ran 1 test suite in 26.75ms (26.27ms CPU time): 2 tests passed, 0 failed, 0 skipped (2 total tests) // ANCHOR_END: output // ANCHOR_END: all diff --git a/src/output/cheatcodes/forge-test-cheatcodes-expectrevert b/src/output/cheatcodes/forge-test-cheatcodes-expectrevert index 31f8bfaeb..2eb46c24c 100644 --- a/src/output/cheatcodes/forge-test-cheatcodes-expectrevert +++ b/src/output/cheatcodes/forge-test-cheatcodes-expectrevert @@ -8,9 +8,9 @@ No files changed, compilation skipped No files changed, compilation skipped Ran 1 test for test/OwnerUpOnly.t.sol:OwnerUpOnlyTest -[PASS] test_IncrementAsOwner() (gas: 734680) -Suite result: ok. 1 passed; 0 failed; 0 skipped; finished in 34.49ms (19.06ms CPU time) +[PASS] test_IncrementAsOwner() (gas: 350662) +Suite result: ok. 1 passed; 0 failed; 0 skipped; finished in 25.34ms (15.66ms CPU time) -Ran 1 test suite in 35.33ms (34.49ms CPU time): 1 tests passed, 0 failed, 0 skipped (1 total tests) +Ran 1 test suite in 25.82ms (25.34ms CPU time): 1 tests passed, 0 failed, 0 skipped (1 total tests) // ANCHOR_END: output // ANCHOR_END: all diff --git a/src/output/cheatcodes/forge-test-cheatcodes-tracing b/src/output/cheatcodes/forge-test-cheatcodes-tracing index edbf264b5..0848e8c47 100644 --- a/src/output/cheatcodes/forge-test-cheatcodes-tracing +++ b/src/output/cheatcodes/forge-test-cheatcodes-tracing @@ -8,17 +8,17 @@ No files changed, compilation skipped No files changed, compilation skipped Ran 1 test for test/OwnerUpOnly.t.sol:OwnerUpOnlyTest -[PASS] testFail_IncrementAsNotOwner() (gas: 216319) +[PASS] testFail_IncrementAsNotOwner() (gas: 120313) Traces: - [216319] OwnerUpOnlyTest::testFail_IncrementAsNotOwner() + [120313] OwnerUpOnlyTest::testFail_IncrementAsNotOwner() ├─ [0] VM::prank(0x0000000000000000000000000000000000000000) │ └─ ← [Return] - ├─ [208252] OwnerUpOnly::increment() + ├─ [112246] OwnerUpOnly::increment() │ └─ ← [Revert] Unauthorized() └─ ← [Revert] Unauthorized() -Suite result: ok. 1 passed; 0 failed; 0 skipped; finished in 21.84ms (6.47ms CPU time) +Suite result: ok. 1 passed; 0 failed; 0 skipped; finished in 16.20ms (5.89ms CPU time) -Ran 1 test suite in 22.73ms (21.84ms CPU time): 1 tests passed, 0 failed, 0 skipped (1 total tests) +Ran 1 test suite in 16.91ms (16.20ms CPU time): 1 tests passed, 0 failed, 0 skipped (1 total tests) // ANCHOR_END: output // ANCHOR_END: all diff --git a/src/output/cheatcodes/forge-test-simple b/src/output/cheatcodes/forge-test-simple index 5a433bcbe..db4c3d5aa 100644 --- a/src/output/cheatcodes/forge-test-simple +++ b/src/output/cheatcodes/forge-test-simple @@ -4,17 +4,17 @@ $ forge test --zksync --match-test test_IncrementAsOwner // ANCHOR_END: command // ANCHOR: output Compiling 24 files with Solc 0.8.10 -Solc 0.8.10 finished in 801.67ms +Solc 0.8.10 finished in 978.00ms Compiler run successful! Compiling 24 files with zksolc and solc 0.8.10 -zksolc and solc 0.8.10 finished in 5.98s +zksolc and solc 0.8.10 finished in 4.83s Compiler run successful! Ran 1 test for test/OwnerUpOnly.t.sol:OwnerUpOnlyTest -[PASS] test_IncrementAsOwner() (gas: 734680) -Suite result: ok. 1 passed; 0 failed; 0 skipped; finished in 34.55ms (19.27ms CPU time) +[PASS] test_IncrementAsOwner() (gas: 350662) +Suite result: ok. 1 passed; 0 failed; 0 skipped; finished in 25.51ms (15.46ms CPU time) -Ran 1 test suite in 35.22ms (34.55ms CPU time): 1 tests passed, 0 failed, 0 skipped (1 total tests) +Ran 1 test suite in 26.01ms (25.51ms CPU time): 1 tests passed, 0 failed, 0 skipped (1 total tests) // ANCHOR_END: output // ANCHOR_END: all diff --git a/src/output/deps/forge-install b/src/output/deps/forge-install index 348827f22..34458ca30 100644 --- a/src/output/deps/forge-install +++ b/src/output/deps/forge-install @@ -3,7 +3,7 @@ $ forge install transmissions11/solmate // ANCHOR_END: command // ANCHOR: output -Installing solmate in /tmp/tmp.ECnnuozGYk/deps/lib/solmate (url: Some("https://github.com/transmissions11/solmate"), tag: None) +Installing solmate in /private/var/folders/6j/32rm_n4s37x_wmkgds7r8hqw0000gn/T/tmp.s9T2EZ913p/deps/lib/solmate (url: Some("https://github.com/transmissions11/solmate"), tag: None) Installed solmate // ANCHOR_END: output // ANCHOR_END: all diff --git a/src/output/deps/tree b/src/output/deps/tree index abb51fcf6..cac595a49 100644 --- a/src/output/deps/tree +++ b/src/output/deps/tree @@ -8,6 +8,6 @@ lib ├── solmate └── weird-erc20 -3 directories, 0 files +4 directories, 0 files // ANCHOR_END: output // ANCHOR_END: all diff --git a/src/output/foundry-template/forge-build b/src/output/foundry-template/forge-build index 863c1ffb6..abd7ddf61 100644 --- a/src/output/foundry-template/forge-build +++ b/src/output/foundry-template/forge-build @@ -4,8 +4,8 @@ $ forge build --zksync // ANCHOR_END: command // ANCHOR: output -Compiling 28 files with zksolc and solc 0.8.25 -zksolc and solc 0.8.25 finished in 6.15s +Compiling 28 files with zksolc and solc 0.8.28 +zksolc and solc 0.8.28 finished in 3.32s Compiler run successful! // ANCHOR_END: output // ANCHOR_END: all diff --git a/src/output/foundry-template/forge-test b/src/output/foundry-template/forge-test index 606b485a6..b9d0212b7 100644 --- a/src/output/foundry-template/forge-test +++ b/src/output/foundry-template/forge-test @@ -3,18 +3,18 @@ $ forge test --zksync // ANCHOR_END: command // ANCHOR: output -Compiling 25 files with Solc 0.8.25 -Solc 0.8.25 finished in 925.41ms +Compiling 25 files with Solc 0.8.28 +Solc 0.8.28 finished in 891.16ms Compiler run successful! No files changed, compilation skipped -Ran 3 tests for test/Foo.t.sol:FooTest -[PASS] testFork_Example() (gas: 3779) -[PASS] testFuzz_Example(uint256) (runs: 1000, μ: 213166, ~: 213166) -[PASS] test_Example() (gas: 215916) -Suite result: ok. 3 passed; 0 failed; 0 skipped; finished in 6.51s (6.51s CPU time) +Ran 3 tests for tests/Foo.t.sol:FooTest +[PASS] testFork_Example() (gas: 3755) +[PASS] testFuzz_Example(uint256) (runs: 1000, μ: 117160, ~: 117160) +[PASS] test_Example() (gas: 119910) +Suite result: ok. 3 passed; 0 failed; 0 skipped; finished in 5.23s (5.23s CPU time) -Ran 1 test suite in 6.52s (6.51s CPU time): 3 tests passed, 0 failed, 0 skipped (3 total tests) +Ran 1 test suite in 5.23s (5.23s CPU time): 3 tests passed, 0 failed, 0 skipped (3 total tests) // ANCHOR_END: output // ANCHOR_END: all diff --git a/src/output/fuzz_testing/forge-test-fail-fuzz b/src/output/fuzz_testing/forge-test-fail-fuzz index c03a876c0..3b8bf3342 100644 --- a/src/output/fuzz_testing/forge-test-fail-fuzz +++ b/src/output/fuzz_testing/forge-test-fail-fuzz @@ -4,7 +4,7 @@ $ forge test --zksync --allow-failure // ANCHOR_END: command // ANCHOR: output Compiling 1 files with Solc 0.8.10 -Solc 0.8.10 finished in 819.99ms +Solc 0.8.10 finished in 941.22ms Compiler run successful with warnings: Warning (9302): Return value of low-level calls not used. --> test/Safe.t.sol:11:9: @@ -20,7 +20,7 @@ Warning (9302): Return value of low-level calls not used. Compiling 1 files with zksolc and solc 0.8.10 -zksolc and solc 0.8.10 finished in 5.79s +zksolc and solc 0.8.10 finished in 5.14s Compiler run successful with warnings: Warning (9302) Warning: Return value of low-level calls not used. @@ -36,12 +36,15 @@ Warning: Return value of low-level calls not used. 30 | payable(address(safe)).call{value: amount}(""); | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -2024-10-06T00:06:15.308856Z ERROR foundry_zksync_core::vm::tracers::cheatcode: call may fail or behave unexpectedly due to empty code target=0x7fa9385be102ac3eac297483dd6233d62b3e1496 calldata="" +2025-01-09T13:58:44.187764Z ERROR foundry_zksync_core::vm::tracers::cheatcode: call may fail or behave unexpectedly due to empty code target=0x7fa9385be102ac3eac297483dd6233d62b3e1496 calldata="" +2025-01-09T13:58:44.200605Z ERROR foundry_zksync_core::vm::tracers::cheatcode: call may fail or behave unexpectedly due to empty code target=0x7fa9385be102ac3eac297483dd6233d62b3e1496 calldata="" +2025-01-09T13:58:44.206499Z ERROR foundry_zksync_core::vm::inspect: tx execution halted: Account validation error: Error function_selector = 0x4e487b71, data = 0x4e487b710000000000000000000000000000000000000000000000000000000000000011 +2025-01-09T13:58:44.212336Z ERROR foundry_zksync_core::vm::tracers::cheatcode: call may fail or behave unexpectedly due to empty code target=0x7fa9385be102ac3eac297483dd6233d62b3e1496 calldata="" Ran 1 test for test/Safe.t.sol:SafeTest -[FAIL. Reason: assertion failed; counterexample: calldata=0x29facca700000000000000000000000000000000000001e35e0786a154ba56aa29228e12 args=[38296303183566758584479465508370 [3.829e31]]] testFuzz_Withdraw(uint256) (runs: 0, μ: 0, ~: 0) -Suite result: FAILED. 0 passed; 1 failed; 0 skipped; finished in 29.00ms (13.46ms CPU time) +[FAIL: panic: arithmetic underflow or overflow (0x11); counterexample: calldata=0x29facca7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffd args=[115792089237316195423570985008687907853269984665640564039457584007913129639933 [1.157e77]]] testFuzz_Withdraw(uint256) (runs: 2, μ: 254285, ~: 254285) +Suite result: FAILED. 0 passed; 1 failed; 0 skipped; finished in 47.57ms (37.50ms CPU time) -Ran 1 test suite in 29.74ms (29.00ms CPU time): 0 tests passed, 1 failed, 0 skipped (1 total tests) +Ran 1 test suite in 48.20ms (47.57ms CPU time): 0 tests passed, 1 failed, 0 skipped (1 total tests) // ANCHOR_END: output // ANCHOR_END: all diff --git a/src/output/fuzz_testing/forge-test-no-fuzz b/src/output/fuzz_testing/forge-test-no-fuzz index 6d5618549..6b4c875fb 100644 --- a/src/output/fuzz_testing/forge-test-no-fuzz +++ b/src/output/fuzz_testing/forge-test-no-fuzz @@ -4,7 +4,7 @@ $ forge test --zksync // ANCHOR_END: command // ANCHOR: output Compiling 24 files with Solc 0.8.10 -Solc 0.8.10 finished in 1.11s +Solc 0.8.10 finished in 932.46ms Compiler run successful with warnings: Warning (9302): Return value of low-level calls not used. --> test/Safe.t.sol:11:9: @@ -20,7 +20,7 @@ Warning (9302): Return value of low-level calls not used. Compiling 24 files with zksolc and solc 0.8.10 -zksolc and solc 0.8.10 finished in 5.81s +zksolc and solc 0.8.10 finished in 4.84s Compiler run successful with warnings: Warning (9302) Warning: Return value of low-level calls not used. @@ -36,12 +36,12 @@ Warning: Return value of low-level calls not used. 27 | payable(address(safe)).call{value: 1 ether}(""); | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -2024-10-06T00:06:07.481112Z ERROR foundry_zksync_core::vm::tracers::cheatcode: call may fail or behave unexpectedly due to empty code target=0x7fa9385be102ac3eac297483dd6233d62b3e1496 calldata="" +2025-01-09T13:58:37.379545Z ERROR foundry_zksync_core::vm::tracers::cheatcode: call may fail or behave unexpectedly due to empty code target=0x7fa9385be102ac3eac297483dd6233d62b3e1496 calldata="" Ran 1 test for test/Safe.t.sol:SafeTest -[PASS] test_Withdraw() (gas: 1199829) -Suite result: ok. 1 passed; 0 failed; 0 skipped; finished in 28.85ms (13.44ms CPU time) +[PASS] test_Withdraw() (gas: 303811) +Suite result: ok. 1 passed; 0 failed; 0 skipped; finished in 21.51ms (11.75ms CPU time) -Ran 1 test suite in 29.66ms (28.85ms CPU time): 1 tests passed, 0 failed, 0 skipped (1 total tests) +Ran 1 test suite in 21.94ms (21.51ms CPU time): 1 tests passed, 0 failed, 0 skipped (1 total tests) // ANCHOR_END: output // ANCHOR_END: all diff --git a/src/output/hello_foundry/forge-build b/src/output/hello_foundry/forge-build index f564f10b4..5ba0dd78d 100644 --- a/src/output/hello_foundry/forge-build +++ b/src/output/hello_foundry/forge-build @@ -4,8 +4,8 @@ $ forge build --zksync // ANCHOR_END: command // ANCHOR: output -Compiling 27 files with zksolc and solc 0.8.26 -zksolc and solc 0.8.26 finished in 3.97s +Compiling 27 files with zksolc and solc 0.8.27 +zksolc and solc 0.8.27 finished in 2.94s Compiler run successful! // ANCHOR_END: output // ANCHOR_END: all diff --git a/src/output/hello_foundry/forge-init b/src/output/hello_foundry/forge-init index 5eec0ca5d..434d87ed8 100644 --- a/src/output/hello_foundry/forge-init +++ b/src/output/hello_foundry/forge-init @@ -1,11 +1,13 @@ // ANCHOR: all // ANCHOR: command -$ forge init hello_foundry +$ forge init --zksync hello_foundry // ANCHOR_END: command // ANCHOR: output -Initializing /tmp/tmp.v1NmqnC8e5/hello_foundry... -Installing forge-std in /tmp/tmp.v1NmqnC8e5/hello_foundry/lib/forge-std (url: Some("https://github.com/foundry-rs/forge-std"), tag: None) - Installed forge-std v1.9.3 +Initializing /private/var/folders/6j/32rm_n4s37x_wmkgds7r8hqw0000gn/T/tmp.ZDB04pl4A0/hello_foundry... +Installing forge-std in /private/var/folders/6j/32rm_n4s37x_wmkgds7r8hqw0000gn/T/tmp.ZDB04pl4A0/hello_foundry/lib/forge-std (url: Some("https://github.com/foundry-rs/forge-std"), tag: None) + Installed forge-std v1.9.5 +Installing forge-zksync-std in /private/var/folders/6j/32rm_n4s37x_wmkgds7r8hqw0000gn/T/tmp.ZDB04pl4A0/hello_foundry/lib/forge-zksync-std (url: Some("https://github.com/Moonsong-Labs/forge-zksync-std"), tag: None) + Installed forge-zksync-std Initialized forge project // ANCHOR_END: output // ANCHOR_END: all diff --git a/src/output/hello_foundry/forge-test b/src/output/hello_foundry/forge-test index 997789530..57c667bd4 100644 --- a/src/output/hello_foundry/forge-test +++ b/src/output/hello_foundry/forge-test @@ -4,16 +4,16 @@ $ forge test --zksync // ANCHOR_END: command // ANCHOR: output Compiling 25 files with Solc 0.8.27 -Solc 0.8.27 finished in 902.81ms +Solc 0.8.27 finished in 769.11ms Compiler run successful! No files changed, compilation skipped Ran 2 tests for test/Counter.t.sol:CounterTest -[PASS] testFuzz_SetNumber(uint256) (runs: 256, μ: 31210, ~: 31288) -[PASS] test_Increment() (gas: 31303) -Suite result: ok. 2 passed; 0 failed; 0 skipped; finished in 5.75ms (5.36ms CPU time) +[PASS] testFuzz_SetNumber(uint256) (runs: 256, μ: 248949, ~: 245684) +[PASS] test_Increment() (gas: 238615) +Suite result: ok. 2 passed; 0 failed; 0 skipped; finished in 2.68s (2.68s CPU time) -Ran 1 test suite in 10.34ms (5.75ms CPU time): 2 tests passed, 0 failed, 0 skipped (2 total tests) +Ran 1 test suite in 2.68s (2.68s CPU time): 2 tests passed, 0 failed, 0 skipped (2 total tests) // ANCHOR_END: output // ANCHOR_END: all diff --git a/src/output/hello_foundry/tree b/src/output/hello_foundry/tree index 9ca6a65ac..32d3e06b2 100644 --- a/src/output/hello_foundry/tree +++ b/src/output/hello_foundry/tree @@ -9,6 +9,6 @@ $ tree . -d -L 1 ├── src └── test -4 directories +5 directories // ANCHOR_END: output // ANCHOR_END: all diff --git a/src/output/hello_foundry/tree-with-files b/src/output/hello_foundry/tree-with-files index c27e13dc1..aea3a443f 100644 --- a/src/output/hello_foundry/tree-with-files +++ b/src/output/hello_foundry/tree-with-files @@ -4,18 +4,24 @@ $ tree . -L 3 -I output // ANCHOR_END: command // ANCHOR: output . +├── README.md ├── foundry.toml ├── lib -│   └── forge-std -│   ├── foundry.toml -│   ├── LICENSE-APACHE -│   ├── LICENSE-MIT -│   ├── package.json +│   ├── forge-std +│   │   ├── CONTRIBUTING.md +│   │   ├── LICENSE-APACHE +│   │   ├── LICENSE-MIT +│   │   ├── README.md +│   │   ├── foundry.toml +│   │   ├── package.json +│   │   ├── scripts +│   │   ├── src +│   │   └── test +│   └── forge-zksync-std +│   ├── LICENSE │   ├── README.md -│   ├── scripts -│   ├── src -│   └── test -├── README.md +│   ├── foundry.toml +│   └── src ├── script │   └── Counter.s.sol ├── src @@ -23,6 +29,6 @@ $ tree . -L 3 -I output └── test └── Counter.t.sol -8 directories, 11 files +11 directories, 14 files // ANCHOR_END: output // ANCHOR_END: all diff --git a/src/output/test_filters/forge-test-match-contract-and-test b/src/output/test_filters/forge-test-match-contract-and-test index 88b846930..12128c688 100644 --- a/src/output/test_filters/forge-test-match-contract-and-test +++ b/src/output/test_filters/forge-test-match-contract-and-test @@ -4,18 +4,18 @@ $ forge test --zksync --match-contract ComplicatedContractTest --match-test test // ANCHOR_END: command // ANCHOR: output Compiling 24 files with Solc 0.8.10 -Solc 0.8.10 finished in 1.14s +Solc 0.8.10 finished in 908.20ms Compiler run successful! Compiling 24 files with zksolc and solc 0.8.10 -zksolc and solc 0.8.10 finished in 5.54s +zksolc and solc 0.8.10 finished in 6.14s Compiler run successful! Ran 2 tests for test/ComplicatedContract.t.sol:ComplicatedContractTest [PASS] test_DepositERC20() (gas: 102193) [PASS] test_DepositETH() (gas: 61414) -Suite result: ok. 2 passed; 0 failed; 0 skipped; finished in 1.28ms (1.39ms CPU time) +Suite result: ok. 2 passed; 0 failed; 0 skipped; finished in 649.00µs (670.50µs CPU time) -Ran 1 test suite in 5.27ms (1.28ms CPU time): 2 tests passed, 0 failed, 0 skipped (2 total tests) +Ran 1 test suite in 2.02ms (649.00µs CPU time): 2 tests passed, 0 failed, 0 skipped (2 total tests) // ANCHOR_END: output // ANCHOR_END: all diff --git a/src/output/test_filters/forge-test-match-path b/src/output/test_filters/forge-test-match-path index a37611cc3..1d6fb7af1 100644 --- a/src/output/test_filters/forge-test-match-path +++ b/src/output/test_filters/forge-test-match-path @@ -4,17 +4,17 @@ $ forge test --zksync --match-path test/ContractB.t.sol // ANCHOR_END: command // ANCHOR: output Compiling 1 files with Solc 0.8.10 -Solc 0.8.10 finished in 1.08s +Solc 0.8.10 finished in 897.98ms Compiler run successful! Compiling 1 files with zksolc and solc 0.8.10 -zksolc and solc 0.8.10 finished in 5.17s +zksolc and solc 0.8.10 finished in 4.33s Compiler run successful! Ran 1 test for test/ContractB.t.sol:ContractBTest [PASS] testExample() (gas: 257) -Suite result: ok. 1 passed; 0 failed; 0 skipped; finished in 397.78µs (61.04µs CPU time) +Suite result: ok. 1 passed; 0 failed; 0 skipped; finished in 240.04µs (52.92µs CPU time) -Ran 1 test suite in 4.86ms (397.78µs CPU time): 1 tests passed, 0 failed, 0 skipped (1 total tests) +Ran 1 test suite in 4.83ms (240.04µs CPU time): 1 tests passed, 0 failed, 0 skipped (1 total tests) // ANCHOR_END: output // ANCHOR_END: all diff --git a/src/reference/cli/SUMMARY.md b/src/reference/cli/SUMMARY.md index cd96727a3..93089c170 100644 --- a/src/reference/cli/SUMMARY.md +++ b/src/reference/cli/SUMMARY.md @@ -32,13 +32,17 @@ - [`forge selectors collision`](./forge/selectors/collision.md) - [`forge selectors upload`](./forge/selectors/upload.md) - [`forge selectors list`](./forge/selectors/list.md) + - [`forge selectors find`](./forge/selectors/find.md) + - [`forge selectors cache`](./forge/selectors/cache.md) - [`forge snapshot`](./forge/snapshot.md) - [`forge soldeer`](./forge/soldeer.md) + - [`forge soldeer init`](./forge/soldeer/init.md) - [`forge soldeer install`](./forge/soldeer/install.md) - [`forge soldeer update`](./forge/soldeer/update.md) - [`forge soldeer login`](./forge/soldeer/login.md) - [`forge soldeer push`](./forge/soldeer/push.md) - - [`forge soldeer version-dry-run`](./forge/soldeer/version-dry-run.md) + - [`forge soldeer uninstall`](./forge/soldeer/uninstall.md) + - [`forge soldeer version`](./forge/soldeer/version.md) - [`forge test`](./forge/test.md) - [`forge tree`](./forge/tree.md) - [`forge update`](./forge/update.md) @@ -49,12 +53,12 @@ - [`cast 4byte`](./cast/4byte.md) - [`cast 4byte-decode`](./cast/4byte-decode.md) - [`cast 4byte-event`](./cast/4byte-event.md) - - [`cast abi-decode`](./cast/abi-decode.md) - [`cast abi-encode`](./cast/abi-encode.md) - [`cast access-list`](./cast/access-list.md) - [`cast address-zero`](./cast/address-zero.md) - [`cast admin`](./cast/admin.md) - [`cast age`](./cast/age.md) + - [`cast artifact`](./cast/artifact.md) - [`cast balance`](./cast/balance.md) - [`cast base-fee`](./cast/base-fee.md) - [`cast bind`](./cast/bind.md) @@ -63,11 +67,11 @@ - [`cast call`](./cast/call.md) - [`cast call --create`](./cast/call/--create.md) - [`cast calldata`](./cast/calldata.md) - - [`cast calldata-decode`](./cast/calldata-decode.md) - [`cast chain`](./cast/chain.md) - [`cast chain-id`](./cast/chain-id.md) - [`cast client`](./cast/client.md) - [`cast code`](./cast/code.md) + - [`cast codehash`](./cast/codehash.md) - [`cast codesize`](./cast/codesize.md) - [`cast completions`](./cast/completions.md) - [`cast compute-address`](./cast/compute-address.md) @@ -75,7 +79,12 @@ - [`cast constructor-args`](./cast/constructor-args.md) - [`cast create2`](./cast/create2.md) - [`cast creation-code`](./cast/creation-code.md) + - [`cast decode-abi`](./cast/decode-abi.md) + - [`cast decode-calldata`](./cast/decode-calldata.md) - [`cast decode-eof`](./cast/decode-eof.md) + - [`cast decode-error`](./cast/decode-error.md) + - [`cast decode-event`](./cast/decode-event.md) + - [`cast decode-string`](./cast/decode-string.md) - [`cast decode-transaction`](./cast/decode-transaction.md) - [`cast disassemble`](./cast/disassemble.md) - [`cast estimate`](./cast/estimate.md) @@ -91,6 +100,7 @@ - [`cast from-wei`](./cast/from-wei.md) - [`cast gas-price`](./cast/gas-price.md) - [`cast generate-fig-spec`](./cast/generate-fig-spec.md) + - [`cast hash-message`](./cast/hash-message.md) - [`cast hash-zero`](./cast/hash-zero.md) - [`cast implementation`](./cast/implementation.md) - [`cast index`](./cast/index.md) @@ -125,7 +135,6 @@ - [`cast sig-event`](./cast/sig-event.md) - [`cast storage`](./cast/storage.md) - [`cast storage-root`](./cast/storage-root.md) - - [`cast string-decode`](./cast/string-decode.md) - [`cast to-ascii`](./cast/to-ascii.md) - [`cast to-base`](./cast/to-base.md) - [`cast to-bytes32`](./cast/to-bytes32.md) @@ -148,8 +157,10 @@ - [`cast wallet vanity`](./cast/wallet/vanity.md) - [`cast wallet address`](./cast/wallet/address.md) - [`cast wallet sign`](./cast/wallet/sign.md) + - [`cast wallet sign-auth`](./cast/wallet/sign-auth.md) - [`cast wallet verify`](./cast/wallet/verify.md) - [`cast wallet import`](./cast/wallet/import.md) - [`cast wallet list`](./cast/wallet/list.md) - [`cast wallet private-key`](./cast/wallet/private-key.md) - [`cast wallet decrypt-keystore`](./cast/wallet/decrypt-keystore.md) + diff --git a/src/reference/cli/cast.md b/src/reference/cli/cast.md index 00e39c2ad..fb35caffb 100644 --- a/src/reference/cli/cast.md +++ b/src/reference/cli/cast.md @@ -10,45 +10,40 @@ $ cast --help Usage: cast [OPTIONS] Commands: - 4byte Get the function signatures for the given selector - from https://openchain.xyz [aliases: 4, 4b] - 4byte-decode Decode ABI-encoded calldata using - https://openchain.xyz [aliases: 4d, 4bd] + 4byte Get the function signatures for the given selector from + https://openchain.xyz [aliases: 4, 4b] + 4byte-decode Decode ABI-encoded calldata using https://openchain.xyz + [aliases: 4d, 4bd] 4byte-event Get the event signature for a given topic 0 from - https://openchain.xyz [aliases: 4e, 4be, - topic0-event, t0e] - abi-decode Decode ABI-encoded input or output data [aliases: - ad, --abi-decode] - abi-encode ABI encode the given function argument, excluding - the selector [aliases: ae] - access-list Create an access list for a transaction [aliases: - ac, acl] - address-zero Prints the zero address [aliases: --address-zero, - az] + https://openchain.xyz [aliases: 4e, 4be, topic0-event, + t0e] + abi-encode ABI encode the given function argument, excluding the + selector [aliases: ae] + access-list Create an access list for a transaction [aliases: ac, + acl] + address-zero Prints the zero address [aliases: --address-zero, az] admin Fetch the EIP-1967 admin account [aliases: adm] age Get the timestamp of a block [aliases: a] + artifact Generate an artifact file, that can be used to deploy a + contract locally [aliases: ar] balance Get the balance of an account in wei [aliases: b] - base-fee Get the basefee of a block [aliases: ba, fee, - basefee] - bind Generate a rust binding from a given ABI [aliases: - bi] + base-fee Get the basefee of a block [aliases: ba, fee, basefee] + bind Generate a rust binding from a given ABI [aliases: bi] block Get information about a block [aliases: bl] block-number Get the latest block number [aliases: bn] call Perform a call on an account without publishing a - transaction [aliases: c] + transaction [aliases: c] calldata ABI-encode a function with arguments [aliases: cd] - calldata-decode Decode ABI-encoded input data [aliases: - --calldata-decode, cdd] chain Get the symbolic name of the current chain chain-id Get the Ethereum chain ID [aliases: ci, cid] client Get the current client version [aliases: cl] - code Get the runtime bytecode of a contract [aliases: - co] - codesize Get the runtime bytecode size of a contract - [aliases: cs] + code Get the runtime bytecode of a contract [aliases: co] + codehash Get the codehash for an account + codesize Get the runtime bytecode size of a contract [aliases: + cs] completions Generate shell completions script [aliases: com] compute-address Compute the contract address from a given nonce and - deployer address [aliases: ca] + deployer address [aliases: ca] concat-hex Concatenate hex strings [aliases: --concat-hex, ch] constructor-args Display constructor arguments used for the contract initialization [aliases: cra] @@ -56,16 +51,26 @@ Commands: [aliases: c2] creation-code Download a contract creation code from Etherscan and RPC [aliases: cc] + decode-abi Decode ABI-encoded input or output data [aliases: + abi-decode, --abi-decode, ad] + decode-calldata Decode ABI-encoded input data [aliases: + calldata-decode, --calldata-decode, cdd] decode-eof Decodes EOF container bytes + decode-error Decode custom error data [aliases: error-decode, + --error-decode, erd] + decode-event Decode event data [aliases: event-decode, + --event-decode, ed] + decode-string Decode ABI-encoded string [aliases: string-decode, + --string-decode, sd] decode-transaction Decodes a raw signed EIP 2718 typed transaction - [aliases: dt, decode-tx] - disassemble Disassembles hex encoded bytecode into individual / - human readable opcodes [aliases: da] + [aliases: dt, decode-tx] + disassemble Disassembles a hex-encoded bytecode into a + human-readable representation [aliases: da] estimate Estimate the gas cost of a transaction [aliases: e] etherscan-source Get the source code of a contract from Etherscan - [aliases: et, src] - find-block Get the block number closest to the provided - timestamp [aliases: f] + [aliases: et, src] + find-block Get the block number closest to the provided timestamp + [aliases: f] format-bytes32-string Formats a string into bytes32 encoding [aliases: --format-bytes32-string] format-units Format a number from smallest unit to decimal with @@ -76,122 +81,140 @@ Commands: --from-fix, ff] from-rlp Decodes RLP hex-encoded data [aliases: --from-rlp] from-utf8 Convert UTF8 text to hex [aliases: --from-ascii, - --from-utf8, from-ascii, fu, fa] - from-wei Convert wei into an ETH amount [aliases: - --from-wei, fw] + --from-utf8, from-ascii, fu, fa] + from-wei Convert wei into an ETH amount [aliases: --from-wei, + fw] gas-price Get the current gas price [aliases: g] generate-fig-spec Generate Fig autocompletion spec [aliases: fig] + hash-message Hash a message according to EIP-191 [aliases: + --hash-message, hm] hash-zero Prints the zero hash [aliases: --hash-zero, hz] help Print this message or the help of the given - subcommand(s) + subcommand(s) implementation Fetch the EIP-1967 implementation account [aliases: - impl] + impl] index Compute the storage slot for an entry in a mapping - [aliases: in] + [aliases: in] index-erc7201 Compute storage slots as specified by `ERC-7201: - Namespaced Storage Layout` [aliases: index7201, - in7201] + Namespaced Storage Layout` [aliases: index7201, in7201] interface Generate a Solidity interface from a given ABI - [aliases: i] + [aliases: i] keccak Hash arbitrary data using Keccak-256 [aliases: k, - keccak256] + keccak256] logs Get logs by signature or topic [aliases: l] lookup-address Perform an ENS reverse lookup [aliases: la] max-int Prints the maximum value of the given integer type - [aliases: --max-int, maxi] + [aliases: --max-int, maxi] max-uint Prints the maximum value of the given integer type - [aliases: --max-uint, maxu] + [aliases: --max-uint, maxu] min-int Prints the minimum value of the given integer type - [aliases: --min-int, mini] + [aliases: --min-int, mini] mktx Build and sign a transaction [aliases: m] - namehash Calculate the ENS namehash of a name [aliases: na, - nh] + namehash Calculate the ENS namehash of a name [aliases: na, nh] nonce Get the nonce for an account [aliases: n] parse-bytes32-address Parses a checksummed address from bytes32 encoding. - [aliases: --parse-bytes32-address] + [aliases: --parse-bytes32-address] parse-bytes32-string Parses a string from bytes32 encoding [aliases: --parse-bytes32-string] parse-units Convert a number from decimal to smallest unit with arbitrary decimals [aliases: --parse-units, pun] pretty-calldata Pretty print calldata [aliases: pc] proof Generate a storage proof for a given storage slot - [aliases: pr] - publish Publish a raw transaction to the network [aliases: - p] - receipt Get the transaction receipt for a transaction - [aliases: re] + [aliases: pr] + publish Publish a raw transaction to the network [aliases: p] + receipt Get the transaction receipt for a transaction [aliases: + re] resolve-name Perform an ENS lookup [aliases: rn] rpc Perform a raw JSON-RPC request [aliases: rp] - run Runs a published transaction in a local environment - and prints the trace [aliases: r] - selectors Extracts function selectors and arguments from - bytecode [aliases: sel] + run Runs a published transaction in a local environment and + prints the trace [aliases: r] + selectors Extracts function selectors and arguments from bytecode + [aliases: sel] send Sign and publish a transaction [aliases: s] shl Perform a left shifting operation shr Perform a right shifting operation sig Get the selector for a function [aliases: si] - sig-event Generate event signatures from event string - [aliases: se] + sig-event Generate event signatures from event string [aliases: + se] storage Get the raw value of a contract's storage slot [aliases: st] storage-root Get the storage root for an account [aliases: sr] - string-decode Decode ABI-encoded string [aliases: --string-decode, - sd] to-ascii Convert hex data to an ASCII string [aliases: - --to-ascii, tas, 2as] + --to-ascii, tas, 2as] to-base Converts a number of one base to another [aliases: - --to-base, --to-radix, to-radix, tr, 2r] - to-bytes32 Right-pads hex data to 32 bytes [aliases: - --to-bytes32, tb, 2b] + --to-base, --to-radix, to-radix, tr, 2r] + to-bytes32 Right-pads hex data to 32 bytes [aliases: --to-bytes32, + tb, 2b] to-check-sum-address Convert an address to a checksummed format (EIP-55) - [aliases: --to-checksum-address, --to-checksum, - to-checksum, ta, 2a] + [aliases: --to-checksum-address, --to-checksum, + to-checksum, ta, 2a] to-dec Converts a number of one base to decimal [aliases: - --to-dec, td, 2d] - to-fixed-point Convert an integer into a fixed point number - [aliases: --to-fix, tf, 2f] + --to-dec, td, 2d] + to-fixed-point Convert an integer into a fixed point number [aliases: + --to-fix, tf, 2f] to-hex Converts a number of one base to another [aliases: - --to-hex, th, 2h] + --to-hex, th, 2h] to-hexdata Normalize the input to lowercase, 0x-prefixed hex - [aliases: --to-hexdata, thd, 2hd] + [aliases: --to-hexdata, thd, 2hd] to-int256 Convert a number to a hex-encoded int256 [aliases: - --to-int256, ti, 2i] - to-rlp RLP encodes hex data, or an array of hex data - [aliases: --to-rlp] + --to-int256, ti, 2i] + to-rlp RLP encodes hex data, or an array of hex data [aliases: + --to-rlp] to-uint256 Convert a number to a hex-encoded uint256 [aliases: - --to-uint256, tu, 2u] - to-unit Convert an ETH amount into another unit (ether, - gwei or wei) [aliases: --to-unit, tun, 2un] - to-utf8 Convert hex data to a utf-8 string [aliases: - --to-utf8, tu8, 2u8] - to-wei Convert an ETH amount to wei [aliases: --to-wei, - tw, 2w] + --to-uint256, tu, 2u] + to-unit Convert an ETH amount into another unit (ether, gwei or + wei) [aliases: --to-unit, tun, 2un] + to-utf8 Convert hex data to a utf-8 string [aliases: --to-utf8, + tu8, 2u8] + to-wei Convert an ETH amount to wei [aliases: --to-wei, tw, + 2w] tx Get information about a transaction [aliases: t] - upload-signature Upload the given signatures to - https://openchain.xyz [aliases: ups] + upload-signature Upload the given signatures to https://openchain.xyz + [aliases: ups] wallet Wallet management utilities [aliases: w] Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + -V, --version Print version Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. Find more information in the book: http://book.getfoundry.sh/reference/cast/cast.html diff --git a/src/reference/cli/cast/4byte-decode.md b/src/reference/cli/cast/4byte-decode.md index 4736d8757..f07f220a5 100644 --- a/src/reference/cli/cast/4byte-decode.md +++ b/src/reference/cli/cast/4byte-decode.md @@ -7,7 +7,7 @@ $ cast 4byte-decode --help ``` ```txt -Usage: cast 4byte-decode [CALLDATA] +Usage: cast 4byte-decode [OPTIONS] [CALLDATA] Arguments: [CALLDATA] @@ -17,21 +17,39 @@ Options: -h, --help Print help (see a summary with '-h') -Display options: - -j, --json - Print the decoded calldata as JSON + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] +Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/4byte-event.md b/src/reference/cli/cast/4byte-event.md index ec5aad07f..3285f9008 100644 --- a/src/reference/cli/cast/4byte-event.md +++ b/src/reference/cli/cast/4byte-event.md @@ -17,18 +17,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/4byte.md b/src/reference/cli/cast/4byte.md index 76df84704..6e7e5cfe6 100644 --- a/src/reference/cli/cast/4byte.md +++ b/src/reference/cli/cast/4byte.md @@ -17,18 +17,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/abi-encode.md b/src/reference/cli/cast/abi-encode.md index 0ee3590cf..8f6ca2ba9 100644 --- a/src/reference/cli/cast/abi-encode.md +++ b/src/reference/cli/cast/abi-encode.md @@ -23,18 +23,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/access-list.md b/src/reference/cli/cast/access-list.md index 6f0ca1024..d7359233b 100644 --- a/src/reference/cli/cast/access-list.md +++ b/src/reference/cli/cast/access-list.md @@ -28,23 +28,11 @@ Options: -h, --help Print help (see a summary with '-h') -Display options: - -j, --json - Print the access list as JSON - - --color - Log messages coloring - - Possible values: - - auto: Intelligently guess whether to use color output (default) - - always: Force color output - - never: Force disable color output - - -q, --quiet - Do not print log messages - - --verbose - Use verbose output + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] Transaction options: --gas-limit @@ -54,7 +42,10 @@ Transaction options: --gas-price Gas price for legacy transactions, or max fee per gas for EIP1559 - transactions + transactions, either specified in wei, or as a string with a unit + type. + + Examples: 1ether, 10gwei, 0.01ether [env: ETH_GAS_PRICE=] @@ -85,6 +76,18 @@ Transaction options: [env: ETH_BLOB_GAS_PRICE=] + --auth + EIP-7702 authorization list. + + Can be either a hex-encoded signed authorization or an address. + + --access-list [] + EIP-2930 access list. + + Accepts either a JSON-encoded access list or an empty value to create + the access list via an RPC call to `eth_createAccessList`. To retrieve + only the access list portion, use the `cast access-list` command. + Ethereum options: -r, --rpc-url The RPC endpoint @@ -124,6 +127,11 @@ Ethereum options: [env: ETH_RPC_TIMEOUT=] + --rpc-headers + Specify custom headers for RPC requests + + [env: ETH_RPC_HEADERS=] + -e, --etherscan-api-key The Etherscan (or equivalent) API key @@ -194,4 +202,34 @@ Wallet options - hardware wallet: -t, --trezor Use a Trezor hardware wallet + +Display options: + --color + The color of the log messages + + Possible values: + - auto: Intelligently guess whether to use color output (default) + - always: Force color output + - never: Force disable color output + + --json + Format log messages as JSON + + -q, --quiet + Do not print log messages + + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/address-zero.md b/src/reference/cli/cast/address-zero.md index 2963bf311..6d5aed9a5 100644 --- a/src/reference/cli/cast/address-zero.md +++ b/src/reference/cli/cast/address-zero.md @@ -13,18 +13,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/admin.md b/src/reference/cli/cast/admin.md index 2d7d7496b..0df6c5886 100644 --- a/src/reference/cli/cast/admin.md +++ b/src/reference/cli/cast/admin.md @@ -57,21 +57,47 @@ Options: [env: ETH_RPC_TIMEOUT=] + --rpc-headers + Specify custom headers for RPC requests + + [env: ETH_RPC_HEADERS=] + -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/age.md b/src/reference/cli/cast/age.md index bde5823cf..ed0d5243b 100644 --- a/src/reference/cli/cast/age.md +++ b/src/reference/cli/cast/age.md @@ -54,21 +54,47 @@ Options: [env: ETH_RPC_TIMEOUT=] + --rpc-headers + Specify custom headers for RPC requests + + [env: ETH_RPC_HEADERS=] + -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/artifact.md b/src/reference/cli/cast/artifact.md new file mode 100644 index 000000000..d51257907 --- /dev/null +++ b/src/reference/cli/cast/artifact.md @@ -0,0 +1,117 @@ +# cast artifact + +Generate an artifact file, that can be used to deploy a contract locally + +```bash +$ cast artifact --help +``` + +```txt +Usage: cast artifact [OPTIONS] + +Arguments: + + An Ethereum address, for which the artifact will be produced + +Options: + --abi-path + Path to file containing the contract's JSON ABI. It's necessary if the + target contract is not verified on Etherscan + + -o, --output + The path to the output file. + + If not specified, the artifact will be output to stdout. + + -e, --etherscan-api-key + The Etherscan (or equivalent) API key + + [env: ETHERSCAN_API_KEY=] + + -c, --chain + The chain name or EIP-155 chain ID + + [env: CHAIN=] + + -r, --rpc-url + The RPC endpoint + + [env: ETH_RPC_URL=] + + --flashbots + Use the Flashbots RPC URL with fast mode + (). + + This shares the transaction privately with all registered builders. + + See: + + + --jwt-secret + JWT Secret for the RPC endpoint. + + The JWT secret will be used to create a JWT for a RPC. For example, + the following can be used to simulate a CL `engine_forkchoiceUpdated` + call: + + cast rpc --jwt-secret engine_forkchoiceUpdatedV2 + '["0x6bb38c26db65749ab6e472080a3d20a2f35776494e72016d1e339593f21c59bc", + "0x6bb38c26db65749ab6e472080a3d20a2f35776494e72016d1e339593f21c59bc", + "0x6bb38c26db65749ab6e472080a3d20a2f35776494e72016d1e339593f21c59bc"]' + + [env: ETH_RPC_JWT_SECRET=] + + --rpc-timeout + Timeout for the RPC request in seconds. + + The specified timeout will be used to override the default timeout for + RPC requests. + + Default value: 45 + + [env: ETH_RPC_TIMEOUT=] + + --rpc-headers + Specify custom headers for RPC requests + + [env: ETH_RPC_HEADERS=] + + -h, --help + Print help (see a summary with '-h') + + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + +Display options: + --color + The color of the log messages + + Possible values: + - auto: Intelligently guess whether to use color output (default) + - always: Force color output + - never: Force disable color output + + --json + Format log messages as JSON + + -q, --quiet + Do not print log messages + + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. +``` \ No newline at end of file diff --git a/src/reference/cli/cast/balance.md b/src/reference/cli/cast/balance.md index 31806d151..b7265967d 100644 --- a/src/reference/cli/cast/balance.md +++ b/src/reference/cli/cast/balance.md @@ -60,6 +60,11 @@ Options: [env: ETH_RPC_TIMEOUT=] + --rpc-headers + Specify custom headers for RPC requests + + [env: ETH_RPC_HEADERS=] + --erc20 erc20 address to query, with the method `balanceOf(address) return (uint256)`, alias with '--erc721' @@ -67,18 +72,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/base-fee.md b/src/reference/cli/cast/base-fee.md index 15fe0e401..e5044243e 100644 --- a/src/reference/cli/cast/base-fee.md +++ b/src/reference/cli/cast/base-fee.md @@ -54,21 +54,47 @@ Options: [env: ETH_RPC_TIMEOUT=] + --rpc-headers + Specify custom headers for RPC requests + + [env: ETH_RPC_HEADERS=] + -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/bind.md b/src/reference/cli/cast/bind.md index 42bd039c1..22c4a4181 100644 --- a/src/reference/cli/cast/bind.md +++ b/src/reference/cli/cast/bind.md @@ -51,18 +51,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/block-number.md b/src/reference/cli/cast/block-number.md index 8557020df..ff6349b3f 100644 --- a/src/reference/cli/cast/block-number.md +++ b/src/reference/cli/cast/block-number.md @@ -53,21 +53,47 @@ Options: [env: ETH_RPC_TIMEOUT=] + --rpc-headers + Specify custom headers for RPC requests + + [env: ETH_RPC_HEADERS=] + -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/block.md b/src/reference/cli/cast/block.md index b79d15dcf..a54926628 100644 --- a/src/reference/cli/cast/block.md +++ b/src/reference/cli/cast/block.md @@ -60,24 +60,47 @@ Options: [env: ETH_RPC_TIMEOUT=] + --rpc-headers + Specify custom headers for RPC requests + + [env: ETH_RPC_HEADERS=] + -h, --help Print help (see a summary with '-h') -Display options: - -j, --json - Print the block as JSON + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] +Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/call.md b/src/reference/cli/cast/call.md index 3e4228205..f97167124 100644 --- a/src/reference/cli/cast/call.md +++ b/src/reference/cli/cast/call.md @@ -49,26 +49,17 @@ Options: Can also be the tags earliest, finalized, safe, latest, or pending. + --odyssey + Enable Odyssey features + -h, --help Print help (see a summary with '-h') -Display options: - -j, --json - Print the decoded output as JSON - - --color - Log messages coloring - - Possible values: - - auto: Intelligently guess whether to use color output (default) - - always: Force color output - - never: Force disable color output - - -q, --quiet - Do not print log messages - - --verbose - Use verbose output + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] Transaction options: --gas-limit @@ -78,7 +69,10 @@ Transaction options: --gas-price Gas price for legacy transactions, or max fee per gas for EIP1559 - transactions + transactions, either specified in wei, or as a string with a unit + type. + + Examples: 1ether, 10gwei, 0.01ether [env: ETH_GAS_PRICE=] @@ -109,6 +103,18 @@ Transaction options: [env: ETH_BLOB_GAS_PRICE=] + --auth + EIP-7702 authorization list. + + Can be either a hex-encoded signed authorization or an address. + + --access-list [] + EIP-2930 access list. + + Accepts either a JSON-encoded access list or an empty value to create + the access list via an RPC call to `eth_createAccessList`. To retrieve + only the access list portion, use the `cast access-list` command. + Ethereum options: -r, --rpc-url The RPC endpoint @@ -148,6 +154,11 @@ Ethereum options: [env: ETH_RPC_TIMEOUT=] + --rpc-headers + Specify custom headers for RPC requests + + [env: ETH_RPC_HEADERS=] + -e, --etherscan-api-key The Etherscan (or equivalent) API key @@ -188,6 +199,11 @@ Wallet options - raw: [default: 0] + --with-local-artifacts + Use current project artifacts for trace decoding + + [aliases: la] + Wallet options - keystore: --keystore Use the keystore in the given folder or file @@ -218,4 +234,34 @@ Wallet options - hardware wallet: -t, --trezor Use a Trezor hardware wallet + +Display options: + --color + The color of the log messages + + Possible values: + - auto: Intelligently guess whether to use color output (default) + - always: Force color output + - never: Force disable color output + + --json + Format log messages as JSON + + -q, --quiet + Do not print log messages + + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/call/--create.md b/src/reference/cli/cast/call/--create.md index 5c3a9f657..caa107558 100644 --- a/src/reference/cli/cast/call/--create.md +++ b/src/reference/cli/cast/call/--create.md @@ -30,18 +30,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/calldata.md b/src/reference/cli/cast/calldata.md index 62272b7d0..01e4041b1 100644 --- a/src/reference/cli/cast/calldata.md +++ b/src/reference/cli/cast/calldata.md @@ -20,18 +20,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/chain-id.md b/src/reference/cli/cast/chain-id.md index 4c752b35f..ba7d32dbc 100644 --- a/src/reference/cli/cast/chain-id.md +++ b/src/reference/cli/cast/chain-id.md @@ -48,21 +48,47 @@ Options: [env: ETH_RPC_TIMEOUT=] + --rpc-headers + Specify custom headers for RPC requests + + [env: ETH_RPC_HEADERS=] + -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/chain.md b/src/reference/cli/cast/chain.md index 40e6d567b..c8689c99b 100644 --- a/src/reference/cli/cast/chain.md +++ b/src/reference/cli/cast/chain.md @@ -48,21 +48,47 @@ Options: [env: ETH_RPC_TIMEOUT=] + --rpc-headers + Specify custom headers for RPC requests + + [env: ETH_RPC_HEADERS=] + -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/client.md b/src/reference/cli/cast/client.md index 81de5a3e3..514d7ddf8 100644 --- a/src/reference/cli/cast/client.md +++ b/src/reference/cli/cast/client.md @@ -48,21 +48,47 @@ Options: [env: ETH_RPC_TIMEOUT=] + --rpc-headers + Specify custom headers for RPC requests + + [env: ETH_RPC_HEADERS=] + -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/code.md b/src/reference/cli/cast/code.md index f1b325080..2c7872570 100644 --- a/src/reference/cli/cast/code.md +++ b/src/reference/cli/cast/code.md @@ -20,7 +20,7 @@ Options: Can also be the tags earliest, finalized, safe, latest, or pending. -d, --disassemble - Disassemble bytecodes into individual opcodes + Disassemble bytecodes -r, --rpc-url The RPC endpoint @@ -60,21 +60,47 @@ Options: [env: ETH_RPC_TIMEOUT=] + --rpc-headers + Specify custom headers for RPC requests + + [env: ETH_RPC_HEADERS=] + -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/codehash.md b/src/reference/cli/cast/codehash.md index ef57fe48f..e01da552a 100644 --- a/src/reference/cli/cast/codehash.md +++ b/src/reference/cli/cast/codehash.md @@ -60,21 +60,47 @@ Options: [env: ETH_RPC_TIMEOUT=] + --rpc-headers + Specify custom headers for RPC requests + + [env: ETH_RPC_HEADERS=] + -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/codesize.md b/src/reference/cli/cast/codesize.md index 1e7ae902f..407937fe6 100644 --- a/src/reference/cli/cast/codesize.md +++ b/src/reference/cli/cast/codesize.md @@ -57,21 +57,47 @@ Options: [env: ETH_RPC_TIMEOUT=] + --rpc-headers + Specify custom headers for RPC requests + + [env: ETH_RPC_HEADERS=] + -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/completions.md b/src/reference/cli/cast/completions.md index 99a1b7cd7..c7e3e4bec 100644 --- a/src/reference/cli/cast/completions.md +++ b/src/reference/cli/cast/completions.md @@ -17,18 +17,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/compute-address.md b/src/reference/cli/cast/compute-address.md index c111f1b10..583e608e6 100644 --- a/src/reference/cli/cast/compute-address.md +++ b/src/reference/cli/cast/compute-address.md @@ -55,21 +55,47 @@ Options: [env: ETH_RPC_TIMEOUT=] + --rpc-headers + Specify custom headers for RPC requests + + [env: ETH_RPC_HEADERS=] + -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/concat-hex.md b/src/reference/cli/cast/concat-hex.md index 752c696cd..f4e6dfc7a 100644 --- a/src/reference/cli/cast/concat-hex.md +++ b/src/reference/cli/cast/concat-hex.md @@ -17,18 +17,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/constructor-args.md b/src/reference/cli/cast/constructor-args.md index a027c8a3d..c2abfc414 100644 --- a/src/reference/cli/cast/constructor-args.md +++ b/src/reference/cli/cast/constructor-args.md @@ -66,21 +66,47 @@ Options: [env: ETH_RPC_TIMEOUT=] + --rpc-headers + Specify custom headers for RPC requests + + [env: ETH_RPC_HEADERS=] + -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/create2.md b/src/reference/cli/cast/create2.md index 3d20d9b71..b4e1561d6 100644 --- a/src/reference/cli/cast/create2.md +++ b/src/reference/cli/cast/create2.md @@ -37,9 +37,11 @@ Options: --init-code-hash Init code hash of the contract to be deployed - -j, --jobs - Number of threads to use. Defaults to and caps at the number of + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of logical cores + + [aliases: jobs] --caller
Address of the caller. Used for the first 20 bytes of the salt @@ -56,16 +58,31 @@ Options: Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/creation-code.md b/src/reference/cli/cast/creation-code.md index b455603d6..9d059097c 100644 --- a/src/reference/cli/cast/creation-code.md +++ b/src/reference/cli/cast/creation-code.md @@ -75,21 +75,47 @@ Options: [env: ETH_RPC_TIMEOUT=] + --rpc-headers + Specify custom headers for RPC requests + + [env: ETH_RPC_HEADERS=] + -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/decode-abi.md b/src/reference/cli/cast/decode-abi.md new file mode 100644 index 000000000..1d490b95c --- /dev/null +++ b/src/reference/cli/cast/decode-abi.md @@ -0,0 +1,62 @@ +# cast decode-abi + +Decode ABI-encoded input or output data. + +```bash +$ cast decode-abi --help +``` + +```txt +Usage: cast decode-abi [OPTIONS] + +Arguments: + + The function signature in the format `()()` + + + The ABI-encoded calldata + +Options: + -h, --help + Print help (see a summary with '-h') + + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + +Decode input data instead of output data: + -i, --input + Whether to decode the input or output data + +Display options: + --color + The color of the log messages + + Possible values: + - auto: Intelligently guess whether to use color output (default) + - always: Force color output + - never: Force disable color output + + --json + Format log messages as JSON + + -q, --quiet + Do not print log messages + + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. +``` \ No newline at end of file diff --git a/src/reference/cli/cast/decode-calldata.md b/src/reference/cli/cast/decode-calldata.md new file mode 100644 index 000000000..ac0abdad7 --- /dev/null +++ b/src/reference/cli/cast/decode-calldata.md @@ -0,0 +1,58 @@ +# cast decode-calldata + +Decode ABI-encoded input data. + +```bash +$ cast decode-calldata --help +``` + +```txt +Usage: cast decode-calldata [OPTIONS] + +Arguments: + + The function signature in the format `()()` + + + The ABI-encoded calldata + +Options: + -h, --help + Print help (see a summary with '-h') + + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + +Display options: + --color + The color of the log messages + + Possible values: + - auto: Intelligently guess whether to use color output (default) + - always: Force color output + - never: Force disable color output + + --json + Format log messages as JSON + + -q, --quiet + Do not print log messages + + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. +``` \ No newline at end of file diff --git a/src/reference/cli/cast/decode-eof.md b/src/reference/cli/cast/decode-eof.md index c6c2e3f1f..fdc99e772 100644 --- a/src/reference/cli/cast/decode-eof.md +++ b/src/reference/cli/cast/decode-eof.md @@ -17,18 +17,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/decode-error.md b/src/reference/cli/cast/decode-error.md new file mode 100644 index 000000000..637838a81 --- /dev/null +++ b/src/reference/cli/cast/decode-error.md @@ -0,0 +1,61 @@ +# cast decode-error + +Decode custom error data + +```bash +$ cast decode-error --help +``` + +```txt +Usage: cast decode-error [OPTIONS] + +Arguments: + + The error data to decode + +Options: + --sig + The error signature. If none provided then tries to decode from local + cache or `https://api.openchain.xyz` + + [aliases: error-sig] + + -h, --help + Print help (see a summary with '-h') + + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + +Display options: + --color + The color of the log messages + + Possible values: + - auto: Intelligently guess whether to use color output (default) + - always: Force color output + - never: Force disable color output + + --json + Format log messages as JSON + + -q, --quiet + Do not print log messages + + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. +``` \ No newline at end of file diff --git a/src/reference/cli/cast/decode-event.md b/src/reference/cli/cast/decode-event.md new file mode 100644 index 000000000..625465aea --- /dev/null +++ b/src/reference/cli/cast/decode-event.md @@ -0,0 +1,61 @@ +# cast decode-event + +Decode event data + +```bash +$ cast decode-event --help +``` + +```txt +Usage: cast decode-event [OPTIONS] + +Arguments: + + The event data to decode + +Options: + --sig + The event signature. If none provided then tries to decode from local + cache or `https://api.openchain.xyz` + + [aliases: event-sig] + + -h, --help + Print help (see a summary with '-h') + + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + +Display options: + --color + The color of the log messages + + Possible values: + - auto: Intelligently guess whether to use color output (default) + - always: Force color output + - never: Force disable color output + + --json + Format log messages as JSON + + -q, --quiet + Do not print log messages + + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. +``` \ No newline at end of file diff --git a/src/reference/cli/cast/decode-string.md b/src/reference/cli/cast/decode-string.md new file mode 100644 index 000000000..0acf2ce7e --- /dev/null +++ b/src/reference/cli/cast/decode-string.md @@ -0,0 +1,55 @@ +# cast decode-string + +Decode ABI-encoded string. + +```bash +$ cast decode-string --help +``` + +```txt +Usage: cast decode-string [OPTIONS] + +Arguments: + + The ABI-encoded string + +Options: + -h, --help + Print help (see a summary with '-h') + + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + +Display options: + --color + The color of the log messages + + Possible values: + - auto: Intelligently guess whether to use color output (default) + - always: Force color output + - never: Force disable color output + + --json + Format log messages as JSON + + -q, --quiet + Do not print log messages + + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. +``` \ No newline at end of file diff --git a/src/reference/cli/cast/decode-transaction.md b/src/reference/cli/cast/decode-transaction.md index 748471d26..07eb92b5b 100644 --- a/src/reference/cli/cast/decode-transaction.md +++ b/src/reference/cli/cast/decode-transaction.md @@ -17,18 +17,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/disassemble.md b/src/reference/cli/cast/disassemble.md index 886faa2ad..7c9cc8d4e 100644 --- a/src/reference/cli/cast/disassemble.md +++ b/src/reference/cli/cast/disassemble.md @@ -1,34 +1,55 @@ # cast disassemble -Disassembles hex encoded bytecode into individual / human readable opcodes +Disassembles a hex-encoded bytecode into a human-readable representation ```bash $ cast disassemble --help ``` ```txt -Usage: cast disassemble [OPTIONS] +Usage: cast disassemble [OPTIONS] [BYTECODE] Arguments: - - The hex encoded bytecode + [BYTECODE] + The hex-encoded bytecode Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/estimate.md b/src/reference/cli/cast/estimate.md index 511135995..87e172d38 100644 --- a/src/reference/cli/cast/estimate.md +++ b/src/reference/cli/cast/estimate.md @@ -32,6 +32,12 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Transaction options: --gas-limit Gas limit for the transaction @@ -40,7 +46,10 @@ Transaction options: --gas-price Gas price for legacy transactions, or max fee per gas for EIP1559 - transactions + transactions, either specified in wei, or as a string with a unit + type. + + Examples: 1ether, 10gwei, 0.01ether [env: ETH_GAS_PRICE=] @@ -71,6 +80,18 @@ Transaction options: [env: ETH_BLOB_GAS_PRICE=] + --auth + EIP-7702 authorization list. + + Can be either a hex-encoded signed authorization or an address. + + --access-list [] + EIP-2930 access list. + + Accepts either a JSON-encoded access list or an empty value to create + the access list via an RPC call to `eth_createAccessList`. To retrieve + only the access list portion, use the `cast access-list` command. + Ethereum options: -r, --rpc-url The RPC endpoint @@ -110,6 +131,11 @@ Ethereum options: [env: ETH_RPC_TIMEOUT=] + --rpc-headers + Specify custom headers for RPC requests + + [env: ETH_RPC_HEADERS=] + -e, --etherscan-api-key The Etherscan (or equivalent) API key @@ -181,22 +207,33 @@ Wallet options - hardware wallet: -t, --trezor Use a Trezor hardware wallet -Wallet options - remote: - --aws - Use AWS Key Management Service - Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/estimate/--create.md b/src/reference/cli/cast/estimate/--create.md index 87d55804f..46a9556bf 100644 --- a/src/reference/cli/cast/estimate/--create.md +++ b/src/reference/cli/cast/estimate/--create.md @@ -30,18 +30,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/etherscan-source.md b/src/reference/cli/cast/etherscan-source.md index 39f3fdd2b..6956a2960 100644 --- a/src/reference/cli/cast/etherscan-source.md +++ b/src/reference/cli/cast/etherscan-source.md @@ -33,18 +33,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/find-block.md b/src/reference/cli/cast/find-block.md index 2698c3fab..965600409 100644 --- a/src/reference/cli/cast/find-block.md +++ b/src/reference/cli/cast/find-block.md @@ -52,21 +52,47 @@ Options: [env: ETH_RPC_TIMEOUT=] + --rpc-headers + Specify custom headers for RPC requests + + [env: ETH_RPC_HEADERS=] + -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/format-bytes32-string.md b/src/reference/cli/cast/format-bytes32-string.md index e83b2e2a6..94f953a64 100644 --- a/src/reference/cli/cast/format-bytes32-string.md +++ b/src/reference/cli/cast/format-bytes32-string.md @@ -17,18 +17,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/format-units.md b/src/reference/cli/cast/format-units.md index 44eebc541..64355661e 100644 --- a/src/reference/cli/cast/format-units.md +++ b/src/reference/cli/cast/format-units.md @@ -22,18 +22,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/from-bin.md b/src/reference/cli/cast/from-bin.md index 2136124cf..15c7df38a 100644 --- a/src/reference/cli/cast/from-bin.md +++ b/src/reference/cli/cast/from-bin.md @@ -13,18 +13,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/from-fixed-point.md b/src/reference/cli/cast/from-fixed-point.md index 340c72358..3824dbbe8 100644 --- a/src/reference/cli/cast/from-fixed-point.md +++ b/src/reference/cli/cast/from-fixed-point.md @@ -20,18 +20,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/from-rlp.md b/src/reference/cli/cast/from-rlp.md index 0c6584a7d..54fa20a41 100644 --- a/src/reference/cli/cast/from-rlp.md +++ b/src/reference/cli/cast/from-rlp.md @@ -20,18 +20,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/from-utf8.md b/src/reference/cli/cast/from-utf8.md index bca4f65a6..d421bf263 100644 --- a/src/reference/cli/cast/from-utf8.md +++ b/src/reference/cli/cast/from-utf8.md @@ -17,18 +17,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/from-wei.md b/src/reference/cli/cast/from-wei.md index d25c065af..2a8b8f7e3 100644 --- a/src/reference/cli/cast/from-wei.md +++ b/src/reference/cli/cast/from-wei.md @@ -22,18 +22,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/gas-price.md b/src/reference/cli/cast/gas-price.md index 6bc4c1419..9c21a85b9 100644 --- a/src/reference/cli/cast/gas-price.md +++ b/src/reference/cli/cast/gas-price.md @@ -48,21 +48,47 @@ Options: [env: ETH_RPC_TIMEOUT=] + --rpc-headers + Specify custom headers for RPC requests + + [env: ETH_RPC_HEADERS=] + -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/generate-fig-spec.md b/src/reference/cli/cast/generate-fig-spec.md index 3ad322018..b9f28659c 100644 --- a/src/reference/cli/cast/generate-fig-spec.md +++ b/src/reference/cli/cast/generate-fig-spec.md @@ -13,18 +13,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/hash-message.md b/src/reference/cli/cast/hash-message.md index cc9704248..270a7586f 100644 --- a/src/reference/cli/cast/hash-message.md +++ b/src/reference/cli/cast/hash-message.md @@ -17,18 +17,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/hash-zero.md b/src/reference/cli/cast/hash-zero.md index 39d3563ea..01447d11f 100644 --- a/src/reference/cli/cast/hash-zero.md +++ b/src/reference/cli/cast/hash-zero.md @@ -13,18 +13,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/implementation.md b/src/reference/cli/cast/implementation.md index 4a87b1ce6..26f6db608 100644 --- a/src/reference/cli/cast/implementation.md +++ b/src/reference/cli/cast/implementation.md @@ -57,21 +57,47 @@ Options: [env: ETH_RPC_TIMEOUT=] + --rpc-headers + Specify custom headers for RPC requests + + [env: ETH_RPC_HEADERS=] + -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/index-erc7201.md b/src/reference/cli/cast/index-erc7201.md index 617d95717..5d896e239 100644 --- a/src/reference/cli/cast/index-erc7201.md +++ b/src/reference/cli/cast/index-erc7201.md @@ -22,18 +22,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/index.md b/src/reference/cli/cast/index.md index 55a0064ab..c2c2eac81 100644 --- a/src/reference/cli/cast/index.md +++ b/src/reference/cli/cast/index.md @@ -23,18 +23,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/interface.md b/src/reference/cli/cast/interface.md index bb6238d52..f33c36e48 100644 --- a/src/reference/cli/cast/interface.md +++ b/src/reference/cli/cast/interface.md @@ -7,17 +7,20 @@ $ cast interface --help ``` ```txt -Usage: cast interface [OPTIONS] +Usage: cast interface [OPTIONS] Arguments: - - The contract address, or the path to an ABI file. - - If an address is specified, then the ABI is fetched from Etherscan. + + The target contract, which can be one of: - A file path to an ABI JSON + file. - A contract identifier in the form `:` or + just ``. - An Ethereum address, for which the ABI will + be fetched from Etherscan Options: -n, --name - The name to use for the generated interface + The name to use for the generated interface. + + Only relevant when retrieving the ABI from a file. -p, --pragma Solidity pragma version @@ -29,10 +32,6 @@ Options: If not specified, the interface will be output to stdout. - -j, --json - If specified, the interface will be output as JSON rather than - Solidity - -e, --etherscan-api-key The Etherscan (or equivalent) API key @@ -46,18 +45,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/keccak.md b/src/reference/cli/cast/keccak.md index dcceab66d..41baac96f 100644 --- a/src/reference/cli/cast/keccak.md +++ b/src/reference/cli/cast/keccak.md @@ -17,18 +17,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/logs.md b/src/reference/cli/cast/logs.md index 2e2d0a4a0..438dfd21b 100644 --- a/src/reference/cli/cast/logs.md +++ b/src/reference/cli/cast/logs.md @@ -40,23 +40,11 @@ Options: -h, --help Print help (see a summary with '-h') -Display options: - -j, --json - Print the logs as JSON.s - - --color - Log messages coloring - - Possible values: - - auto: Intelligently guess whether to use color output (default) - - always: Force color output - - never: Force disable color output - - -q, --quiet - Do not print log messages - - --verbose - Use verbose output + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] Ethereum options: -r, --rpc-url @@ -97,6 +85,11 @@ Ethereum options: [env: ETH_RPC_TIMEOUT=] + --rpc-headers + Specify custom headers for RPC requests + + [env: ETH_RPC_HEADERS=] + -e, --etherscan-api-key The Etherscan (or equivalent) API key @@ -167,4 +160,34 @@ Wallet options - hardware wallet: -t, --trezor Use a Trezor hardware wallet + +Display options: + --color + The color of the log messages + + Possible values: + - auto: Intelligently guess whether to use color output (default) + - always: Force color output + - never: Force disable color output + + --json + Format log messages as JSON + + -q, --quiet + Do not print log messages + + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/lookup-address.md b/src/reference/cli/cast/lookup-address.md index 40962454a..ce7e5588b 100644 --- a/src/reference/cli/cast/lookup-address.md +++ b/src/reference/cli/cast/lookup-address.md @@ -14,7 +14,7 @@ Arguments: The account to perform the lookup for Options: - -v, --verify + --verify Perform a normal lookup to verify that the address is correct -r, --rpc-url @@ -55,21 +55,47 @@ Options: [env: ETH_RPC_TIMEOUT=] + --rpc-headers + Specify custom headers for RPC requests + + [env: ETH_RPC_HEADERS=] + -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/max-int.md b/src/reference/cli/cast/max-int.md index 12b2decdc..96b3117a2 100644 --- a/src/reference/cli/cast/max-int.md +++ b/src/reference/cli/cast/max-int.md @@ -19,18 +19,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/max-uint.md b/src/reference/cli/cast/max-uint.md index e820eeac6..1a822bb7b 100644 --- a/src/reference/cli/cast/max-uint.md +++ b/src/reference/cli/cast/max-uint.md @@ -19,18 +19,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/min-int.md b/src/reference/cli/cast/min-int.md index 356959a26..ad7e1e0bb 100644 --- a/src/reference/cli/cast/min-int.md +++ b/src/reference/cli/cast/min-int.md @@ -19,18 +19,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/mktx.md b/src/reference/cli/cast/mktx.md index 4b0419358..114734de0 100644 --- a/src/reference/cli/cast/mktx.md +++ b/src/reference/cli/cast/mktx.md @@ -29,6 +29,12 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Transaction options: --gas-limit Gas limit for the transaction @@ -37,7 +43,10 @@ Transaction options: --gas-price Gas price for legacy transactions, or max fee per gas for EIP1559 - transactions + transactions, either specified in wei, or as a string with a unit + type. + + Examples: 1ether, 10gwei, 0.01ether [env: ETH_GAS_PRICE=] @@ -68,6 +77,18 @@ Transaction options: [env: ETH_BLOB_GAS_PRICE=] + --auth + EIP-7702 authorization list. + + Can be either a hex-encoded signed authorization or an address. + + --access-list [] + EIP-2930 access list. + + Accepts either a JSON-encoded access list or an empty value to create + the access list via an RPC call to `eth_createAccessList`. To retrieve + only the access list portion, use the `cast access-list` command. + --path The path of blob data to be sent @@ -110,6 +131,11 @@ Ethereum options: [env: ETH_RPC_TIMEOUT=] + --rpc-headers + Specify custom headers for RPC requests + + [env: ETH_RPC_HEADERS=] + -e, --etherscan-api-key The Etherscan (or equivalent) API key @@ -181,22 +207,33 @@ Wallet options - hardware wallet: -t, --trezor Use a Trezor hardware wallet -Wallet options - remote: - --aws - Use AWS Key Management Service - Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/mktx/--create.md b/src/reference/cli/cast/mktx/--create.md index d3d853ce0..bd291a571 100644 --- a/src/reference/cli/cast/mktx/--create.md +++ b/src/reference/cli/cast/mktx/--create.md @@ -23,18 +23,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/namehash.md b/src/reference/cli/cast/namehash.md index 1ac3aba9f..f7bdb943c 100644 --- a/src/reference/cli/cast/namehash.md +++ b/src/reference/cli/cast/namehash.md @@ -17,18 +17,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/nonce.md b/src/reference/cli/cast/nonce.md index 46f6643fd..b8ff98ea4 100644 --- a/src/reference/cli/cast/nonce.md +++ b/src/reference/cli/cast/nonce.md @@ -57,21 +57,47 @@ Options: [env: ETH_RPC_TIMEOUT=] + --rpc-headers + Specify custom headers for RPC requests + + [env: ETH_RPC_HEADERS=] + -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/parse-bytes32-address.md b/src/reference/cli/cast/parse-bytes32-address.md index f8fe44e35..f8641fc0b 100644 --- a/src/reference/cli/cast/parse-bytes32-address.md +++ b/src/reference/cli/cast/parse-bytes32-address.md @@ -17,18 +17,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/parse-bytes32-string.md b/src/reference/cli/cast/parse-bytes32-string.md index 9f30e676a..a61585812 100644 --- a/src/reference/cli/cast/parse-bytes32-string.md +++ b/src/reference/cli/cast/parse-bytes32-string.md @@ -17,18 +17,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/parse-units.md b/src/reference/cli/cast/parse-units.md index 33712b0ae..78e23d192 100644 --- a/src/reference/cli/cast/parse-units.md +++ b/src/reference/cli/cast/parse-units.md @@ -22,18 +22,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/pretty-calldata.md b/src/reference/cli/cast/pretty-calldata.md index 89e168062..5e667d0b2 100644 --- a/src/reference/cli/cast/pretty-calldata.md +++ b/src/reference/cli/cast/pretty-calldata.md @@ -20,18 +20,39 @@ Options: -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/proof.md b/src/reference/cli/cast/proof.md index 4b2b69cce..97982a8bb 100644 --- a/src/reference/cli/cast/proof.md +++ b/src/reference/cli/cast/proof.md @@ -60,21 +60,47 @@ Options: [env: ETH_RPC_TIMEOUT=] + --rpc-headers + Specify custom headers for RPC requests + + [env: ETH_RPC_HEADERS=] + -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/publish.md b/src/reference/cli/cast/publish.md index c84db5b76..e150f0644 100644 --- a/src/reference/cli/cast/publish.md +++ b/src/reference/cli/cast/publish.md @@ -57,21 +57,47 @@ Options: [env: ETH_RPC_TIMEOUT=] + --rpc-headers + Specify custom headers for RPC requests + + [env: ETH_RPC_HEADERS=] + -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/receipt.md b/src/reference/cli/cast/receipt.md index 31439ba7f..6defca796 100644 --- a/src/reference/cli/cast/receipt.md +++ b/src/reference/cli/cast/receipt.md @@ -65,24 +65,47 @@ Options: [env: ETH_RPC_TIMEOUT=] + --rpc-headers + Specify custom headers for RPC requests + + [env: ETH_RPC_HEADERS=] + -h, --help Print help (see a summary with '-h') -Display options: - -j, --json - Print as JSON + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] +Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/resolve-name.md b/src/reference/cli/cast/resolve-name.md index 084b94aca..dd8f14098 100644 --- a/src/reference/cli/cast/resolve-name.md +++ b/src/reference/cli/cast/resolve-name.md @@ -14,7 +14,7 @@ Arguments: The name to lookup Options: - -v, --verify + --verify Perform a reverse lookup to verify that the name is correct -r, --rpc-url @@ -55,21 +55,47 @@ Options: [env: ETH_RPC_TIMEOUT=] + --rpc-headers + Specify custom headers for RPC requests + + [env: ETH_RPC_HEADERS=] + -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/rpc.md b/src/reference/cli/cast/rpc.md index 79ae7e7dd..907854b03 100644 --- a/src/reference/cli/cast/rpc.md +++ b/src/reference/cli/cast/rpc.md @@ -69,21 +69,47 @@ Options: [env: ETH_RPC_TIMEOUT=] + --rpc-headers + Specify custom headers for RPC requests + + [env: ETH_RPC_HEADERS=] + -h, --help Print help (see a summary with '-h') + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of + logical cores + + [aliases: jobs] + Display options: --color - Log messages coloring + The color of the log messages Possible values: - auto: Intelligently guess whether to use color output (default) - always: Force color output - never: Force disable color output + --json + Format log messages as JSON + -q, --quiet Do not print log messages - --verbose - Use verbose output + -v, --verbosity... + Verbosity level of the log messages. + + Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv). + + Depending on the context the verbosity levels have different meanings. + + For example, the verbosity levels of the EVM are: + - 2 (-vv): Print logs for all tests. + - 3 (-vvv): Print execution traces for failing tests. + - 4 (-vvvv): Print execution traces for all tests, and setup traces + for failing tests. + - 5 (-vvvvv): Print execution and setup traces for all tests, + including storage changes. ``` \ No newline at end of file diff --git a/src/reference/cli/cast/run.md b/src/reference/cli/cast/run.md index a3430731b..b56df728e 100644 --- a/src/reference/cli/cast/run.md +++ b/src/reference/cli/cast/run.md @@ -28,14 +28,21 @@ Options: May result in different results than the live execution! - -v, --verbose - Prints the full address of the contract - -l, --label