From 0e2e9b5a80c4fe6b2f64a334ae1401787d248a19 Mon Sep 17 00:00:00 2001 From: armatrix Date: Sun, 9 Feb 2025 00:05:14 +0000 Subject: [PATCH] update command output --- src/SUMMARY.md | 24 ++- src/output/cast/cast-call | 2 +- src/output/cheatcodes/forge-test-cheatcodes | 4 +- .../forge-test-cheatcodes-expectrevert | 4 +- .../cheatcodes/forge-test-cheatcodes-tracing | 4 +- src/output/cheatcodes/forge-test-simple | 6 +- src/output/deps/forge-install | 2 +- src/output/deps/tree | 2 +- src/output/foundry-template/forge-build | 4 +- src/output/foundry-template/forge-test | 8 +- src/output/fuzz_testing/forge-test-fail-fuzz | 8 +- src/output/fuzz_testing/forge-test-no-fuzz | 6 +- .../fuzz_testing/forge-test-success-fuzz | 8 +- src/output/hello_foundry/forge-build | 4 +- src/output/hello_foundry/forge-init | 6 +- src/output/hello_foundry/forge-test | 6 +- src/output/hello_foundry/tree | 2 +- src/output/hello_foundry/tree-with-files | 3 +- src/output/nft_tutorial/forge-test | 28 +-- .../forge-test-match-contract-and-test | 6 +- src/output/test_filters/forge-test-match-path | 6 +- src/reference/cli/SUMMARY.md | 24 ++- src/reference/cli/anvil.md | 70 ++++++-- src/reference/cli/anvil/completions.md | 41 ++++- src/reference/cli/anvil/generate-fig-spec.md | 38 +++- src/reference/cli/cast.md | 68 ++++++- src/reference/cli/cast/4byte-decode.md | 38 +++- src/reference/cli/cast/4byte-event.md | 41 ++++- src/reference/cli/cast/4byte.md | 41 ++++- src/reference/cli/cast/abi-encode.md | 47 ++++- src/reference/cli/cast/access-list.md | 56 +++++- src/reference/cli/cast/address-zero.md | 38 +++- src/reference/cli/cast/admin.md | 49 +++++- src/reference/cli/cast/age.md | 47 +++++ src/reference/cli/cast/artifact.md | 107 +++++++++++ src/reference/cli/cast/balance.md | 47 +++++ src/reference/cli/cast/base-fee.md | 47 +++++ src/reference/cli/cast/bind.md | 33 ++++ src/reference/cli/cast/block-number.md | 47 +++++ src/reference/cli/cast/block.md | 47 ++++- src/reference/cli/cast/call.md | 65 ++++++- src/reference/cli/cast/call/--create.md | 33 ++++ src/reference/cli/cast/calldata.md | 45 ++++- src/reference/cli/cast/chain-id.md | 47 +++++ src/reference/cli/cast/chain.md | 47 +++++ src/reference/cli/cast/client.md | 47 +++++ src/reference/cli/cast/code.md | 49 +++++- src/reference/cli/cast/codehash.md | 96 ++++++++++ src/reference/cli/cast/codesize.md | 47 +++++ src/reference/cli/cast/completions.md | 41 ++++- src/reference/cli/cast/compute-address.md | 47 +++++ src/reference/cli/cast/concat-hex.md | 41 ++++- src/reference/cli/cast/constructor-args.md | 102 +++++++++++ src/reference/cli/cast/create2.md | 86 +++++++-- src/reference/cli/cast/creation-code.md | 111 ++++++++++++ src/reference/cli/cast/decode-abi.md | 56 ++++++ src/reference/cli/cast/decode-calldata.md | 52 ++++++ src/reference/cli/cast/decode-eof.md | 41 ++++- src/reference/cli/cast/decode-error.md | 55 ++++++ src/reference/cli/cast/decode-event.md | 55 ++++++ src/reference/cli/cast/decode-string.md | 49 ++++++ src/reference/cli/cast/decode-transaction.md | 41 ++++- src/reference/cli/cast/disassemble.md | 43 ++++- src/reference/cli/cast/estimate.md | 54 ++++++ src/reference/cli/cast/estimate/--create.md | 33 ++++ src/reference/cli/cast/etherscan-source.md | 59 ++++++- src/reference/cli/cast/find-block.md | 47 +++++ .../cli/cast/format-bytes32-string.md | 41 ++++- src/reference/cli/cast/format-units.md | 54 ++++++ src/reference/cli/cast/from-bin.md | 38 +++- src/reference/cli/cast/from-fixed-point.md | 45 ++++- src/reference/cli/cast/from-rlp.md | 44 ++++- src/reference/cli/cast/from-utf8.md | 41 ++++- src/reference/cli/cast/from-wei.md | 35 +++- src/reference/cli/cast/gas-price.md | 47 +++++ src/reference/cli/cast/generate-fig-spec.md | 38 +++- src/reference/cli/cast/hash-message.md | 49 ++++++ src/reference/cli/cast/hash-zero.md | 38 +++- src/reference/cli/cast/implementation.md | 56 +++++- src/reference/cli/cast/index-erc7201.md | 46 ++++- src/reference/cli/cast/index.md | 49 +++++- src/reference/cli/cast/interface.md | 36 +++- src/reference/cli/cast/keccak.md | 41 ++++- src/reference/cli/cast/logs.md | 49 +++++- src/reference/cli/cast/lookup-address.md | 49 +++++- src/reference/cli/cast/max-int.md | 43 ++++- src/reference/cli/cast/max-uint.md | 43 ++++- src/reference/cli/cast/min-int.md | 43 ++++- src/reference/cli/cast/mktx.md | 54 ++++++ src/reference/cli/cast/mktx/--create.md | 49 +++++- src/reference/cli/cast/namehash.md | 41 ++++- src/reference/cli/cast/nonce.md | 47 +++++ .../cli/cast/parse-bytes32-address.md | 41 ++++- .../cli/cast/parse-bytes32-string.md | 41 ++++- src/reference/cli/cast/parse-units.md | 54 ++++++ src/reference/cli/cast/pretty-calldata.md | 33 ++++ src/reference/cli/cast/proof.md | 47 +++++ src/reference/cli/cast/publish.md | 47 +++++ src/reference/cli/cast/receipt.md | 47 ++++- src/reference/cli/cast/resolve-name.md | 49 +++++- src/reference/cli/cast/rpc.md | 47 +++++ src/reference/cli/cast/run.md | 73 +++++++- src/reference/cli/cast/selectors.md | 46 ++++- src/reference/cli/cast/send.md | 61 ++++++- src/reference/cli/cast/send/--create.md | 49 +++++- src/reference/cli/cast/shl.md | 53 +++++- src/reference/cli/cast/shr.md | 53 +++++- src/reference/cli/cast/sig-event.md | 41 ++++- src/reference/cli/cast/sig.md | 45 ++++- src/reference/cli/cast/storage-root.md | 96 ++++++++++ src/reference/cli/cast/storage.md | 69 +++++++- src/reference/cli/cast/to-ascii.md | 41 ++++- src/reference/cli/cast/to-base.md | 47 ++++- src/reference/cli/cast/to-bytes32.md | 41 ++++- .../cli/cast/to-check-sum-address.md | 41 ++++- src/reference/cli/cast/to-dec.md | 43 ++++- src/reference/cli/cast/to-fixed-point.md | 45 ++++- src/reference/cli/cast/to-hex.md | 43 ++++- src/reference/cli/cast/to-hexdata.md | 35 +++- src/reference/cli/cast/to-int256.md | 41 ++++- src/reference/cli/cast/to-rlp.md | 35 +++- src/reference/cli/cast/to-uint256.md | 41 ++++- src/reference/cli/cast/to-unit.md | 35 +++- src/reference/cli/cast/to-utf8.md | 41 ++++- src/reference/cli/cast/to-wei.md | 35 +++- src/reference/cli/cast/tx.md | 47 ++++- src/reference/cli/cast/upload-signature.md | 35 +++- src/reference/cli/cast/wallet.md | 38 +++- src/reference/cli/cast/wallet/address.md | 33 ++++ .../cli/cast/wallet/decrypt-keystore.md | 54 +++++- src/reference/cli/cast/wallet/import.md | 33 ++++ src/reference/cli/cast/wallet/list.md | 65 ++++++- src/reference/cli/cast/wallet/new-mnemonic.md | 52 +++++- src/reference/cli/cast/wallet/new.md | 36 +++- src/reference/cli/cast/wallet/private-key.md | 36 +++- src/reference/cli/cast/wallet/sign-auth.md | 47 +++++ src/reference/cli/cast/wallet/sign.md | 33 ++++ src/reference/cli/cast/wallet/vanity.md | 33 ++++ src/reference/cli/cast/wallet/verify.md | 49 +++++- src/reference/cli/chisel.md | 77 +++++--- src/reference/cli/chisel/clear-cache.md | 38 +++- src/reference/cli/chisel/eval.md | 49 ++++++ src/reference/cli/chisel/list.md | 38 +++- src/reference/cli/chisel/load.md | 41 ++++- src/reference/cli/chisel/view.md | 41 ++++- src/reference/cli/forge.md | 47 ++++- src/reference/cli/forge/bind-json.md | 53 +++++- src/reference/cli/forge/bind.md | 53 +++++- src/reference/cli/forge/build.md | 61 ++++++- src/reference/cli/forge/cache.md | 38 +++- src/reference/cli/forge/cache/clean.md | 33 ++++ src/reference/cli/forge/cache/ls.md | 35 +++- src/reference/cli/forge/clean.md | 33 ++++ src/reference/cli/forge/clone.md | 36 +++- src/reference/cli/forge/compiler.md | 49 ++++++ src/reference/cli/forge/compiler/resolve.md | 51 ++++++ src/reference/cli/forge/completions.md | 41 ++++- src/reference/cli/forge/config.md | 89 +++++++--- src/reference/cli/forge/coverage.md | 166 +++++++++++------- src/reference/cli/forge/create.md | 99 +++++++++-- src/reference/cli/forge/debug.md | 79 ++++++--- src/reference/cli/forge/doc.md | 33 ++++ src/reference/cli/forge/eip712.md | 53 +++++- src/reference/cli/forge/flatten.md | 33 ++++ src/reference/cli/forge/fmt.md | 33 ++++ src/reference/cli/forge/geiger.md | 41 ++++- src/reference/cli/forge/generate-fig-spec.md | 38 +++- src/reference/cli/forge/generate.md | 38 +++- src/reference/cli/forge/generate/test.md | 42 ++++- src/reference/cli/forge/init.md | 36 +++- src/reference/cli/forge/inspect.md | 59 ++++++- src/reference/cli/forge/install.md | 38 +++- src/reference/cli/forge/remappings.md | 33 ++++ src/reference/cli/forge/remove.md | 33 ++++ src/reference/cli/forge/script.md | 104 ++++++++--- src/reference/cli/forge/selectors.md | 41 ++++- src/reference/cli/forge/selectors/cache.md | 76 ++++++++ .../cli/forge/selectors/collision.md | 53 +++++- src/reference/cli/forge/selectors/find.md | 80 +++++++++ src/reference/cli/forge/selectors/list.md | 33 ++++ src/reference/cli/forge/selectors/upload.md | 33 ++++ src/reference/cli/forge/snapshot.md | 166 +++++++++++------- src/reference/cli/forge/soldeer.md | 84 ++++----- src/reference/cli/forge/soldeer/init.md | 60 +++++++ src/reference/cli/forge/soldeer/install.md | 83 ++++++++- src/reference/cli/forge/soldeer/login.md | 46 ++++- src/reference/cli/forge/soldeer/push.md | 61 ++++++- src/reference/cli/forge/soldeer/uninstall.md | 51 ++++++ src/reference/cli/forge/soldeer/update.md | 57 +++++- src/reference/cli/forge/soldeer/version.md | 45 +++++ src/reference/cli/forge/test.md | 156 +++++++++------- src/reference/cli/forge/tree.md | 33 ++++ src/reference/cli/forge/update.md | 33 ++++ src/reference/cli/forge/verify-bytecode.md | 67 +++++-- src/reference/cli/forge/verify-check.md | 48 ++++- src/reference/cli/forge/verify-contract.md | 65 ++++++- 196 files changed, 8263 insertions(+), 790 deletions(-) create mode 100644 src/reference/cli/cast/artifact.md create mode 100644 src/reference/cli/cast/codehash.md create mode 100644 src/reference/cli/cast/constructor-args.md create mode 100644 src/reference/cli/cast/creation-code.md create mode 100644 src/reference/cli/cast/decode-abi.md create mode 100644 src/reference/cli/cast/decode-calldata.md create mode 100644 src/reference/cli/cast/decode-error.md create mode 100644 src/reference/cli/cast/decode-event.md create mode 100644 src/reference/cli/cast/decode-string.md create mode 100644 src/reference/cli/cast/format-units.md create mode 100644 src/reference/cli/cast/hash-message.md create mode 100644 src/reference/cli/cast/parse-units.md create mode 100644 src/reference/cli/cast/storage-root.md create mode 100644 src/reference/cli/chisel/eval.md create mode 100644 src/reference/cli/forge/compiler.md create mode 100644 src/reference/cli/forge/compiler/resolve.md create mode 100644 src/reference/cli/forge/selectors/cache.md create mode 100644 src/reference/cli/forge/selectors/find.md create mode 100644 src/reference/cli/forge/soldeer/init.md create mode 100644 src/reference/cli/forge/soldeer/uninstall.md create mode 100644 src/reference/cli/forge/soldeer/version.md diff --git a/src/SUMMARY.md b/src/SUMMARY.md index f2f6969b5..dbfe783a0 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -91,6 +91,8 @@ - [`forge cache ls`](./reference/cli/forge/cache/ls.md) - [`forge clean`](./reference/cli/forge/clean.md) - [`forge clone`](./reference/cli/forge/clone.md) + - [`forge compiler`](./reference/cli/forge/compiler.md) + - [`forge compiler resolve`](./reference/cli/forge/compiler/resolve.md) - [`forge completions`](./reference/cli/forge/completions.md) - [`forge config`](./reference/cli/forge/config.md) - [`forge coverage`](./reference/cli/forge/coverage.md) @@ -114,13 +116,17 @@ - [`forge selectors collision`](./reference/cli/forge/selectors/collision.md) - [`forge selectors upload`](./reference/cli/forge/selectors/upload.md) - [`forge selectors list`](./reference/cli/forge/selectors/list.md) + - [`forge selectors find`](./reference/cli/forge/selectors/find.md) + - [`forge selectors cache`](./reference/cli/forge/selectors/cache.md) - [`forge snapshot`](./reference/cli/forge/snapshot.md) - [`forge soldeer`](./reference/cli/forge/soldeer.md) + - [`forge soldeer init`](./reference/cli/forge/soldeer/init.md) - [`forge soldeer install`](./reference/cli/forge/soldeer/install.md) - [`forge soldeer update`](./reference/cli/forge/soldeer/update.md) - [`forge soldeer login`](./reference/cli/forge/soldeer/login.md) - [`forge soldeer push`](./reference/cli/forge/soldeer/push.md) - - [`forge soldeer version-dry-run`](./reference/cli/forge/soldeer/version-dry-run.md) + - [`forge soldeer uninstall`](./reference/cli/forge/soldeer/uninstall.md) + - [`forge soldeer version`](./reference/cli/forge/soldeer/version.md) - [`forge test`](./reference/cli/forge/test.md) - [`forge tree`](./reference/cli/forge/tree.md) - [`forge update`](./reference/cli/forge/update.md) @@ -131,12 +137,12 @@ - [`cast 4byte`](./reference/cli/cast/4byte.md) - [`cast 4byte-decode`](./reference/cli/cast/4byte-decode.md) - [`cast 4byte-event`](./reference/cli/cast/4byte-event.md) - - [`cast abi-decode`](./reference/cli/cast/abi-decode.md) - [`cast abi-encode`](./reference/cli/cast/abi-encode.md) - [`cast access-list`](./reference/cli/cast/access-list.md) - [`cast address-zero`](./reference/cli/cast/address-zero.md) - [`cast admin`](./reference/cli/cast/admin.md) - [`cast age`](./reference/cli/cast/age.md) + - [`cast artifact`](./reference/cli/cast/artifact.md) - [`cast balance`](./reference/cli/cast/balance.md) - [`cast base-fee`](./reference/cli/cast/base-fee.md) - [`cast bind`](./reference/cli/cast/bind.md) @@ -145,17 +151,24 @@ - [`cast call`](./reference/cli/cast/call.md) - [`cast call --create`](./reference/cli/cast/call/--create.md) - [`cast calldata`](./reference/cli/cast/calldata.md) - - [`cast calldata-decode`](./reference/cli/cast/calldata-decode.md) - [`cast chain`](./reference/cli/cast/chain.md) - [`cast chain-id`](./reference/cli/cast/chain-id.md) - [`cast client`](./reference/cli/cast/client.md) - [`cast code`](./reference/cli/cast/code.md) + - [`cast codehash`](./reference/cli/cast/codehash.md) - [`cast codesize`](./reference/cli/cast/codesize.md) - [`cast completions`](./reference/cli/cast/completions.md) - [`cast compute-address`](./reference/cli/cast/compute-address.md) - [`cast concat-hex`](./reference/cli/cast/concat-hex.md) + - [`cast constructor-args`](./reference/cli/cast/constructor-args.md) - [`cast create2`](./reference/cli/cast/create2.md) + - [`cast creation-code`](./reference/cli/cast/creation-code.md) + - [`cast decode-abi`](./reference/cli/cast/decode-abi.md) + - [`cast decode-calldata`](./reference/cli/cast/decode-calldata.md) - [`cast decode-eof`](./reference/cli/cast/decode-eof.md) + - [`cast decode-error`](./reference/cli/cast/decode-error.md) + - [`cast decode-event`](./reference/cli/cast/decode-event.md) + - [`cast decode-string`](./reference/cli/cast/decode-string.md) - [`cast decode-transaction`](./reference/cli/cast/decode-transaction.md) - [`cast disassemble`](./reference/cli/cast/disassemble.md) - [`cast estimate`](./reference/cli/cast/estimate.md) @@ -163,6 +176,7 @@ - [`cast etherscan-source`](./reference/cli/cast/etherscan-source.md) - [`cast find-block`](./reference/cli/cast/find-block.md) - [`cast format-bytes32-string`](./reference/cli/cast/format-bytes32-string.md) + - [`cast format-units`](./reference/cli/cast/format-units.md) - [`cast from-bin`](./reference/cli/cast/from-bin.md) - [`cast from-fixed-point`](./reference/cli/cast/from-fixed-point.md) - [`cast from-rlp`](./reference/cli/cast/from-rlp.md) @@ -170,6 +184,7 @@ - [`cast from-wei`](./reference/cli/cast/from-wei.md) - [`cast gas-price`](./reference/cli/cast/gas-price.md) - [`cast generate-fig-spec`](./reference/cli/cast/generate-fig-spec.md) + - [`cast hash-message`](./reference/cli/cast/hash-message.md) - [`cast hash-zero`](./reference/cli/cast/hash-zero.md) - [`cast implementation`](./reference/cli/cast/implementation.md) - [`cast index`](./reference/cli/cast/index.md) @@ -187,6 +202,7 @@ - [`cast nonce`](./reference/cli/cast/nonce.md) - [`cast parse-bytes32-address`](./reference/cli/cast/parse-bytes32-address.md) - [`cast parse-bytes32-string`](./reference/cli/cast/parse-bytes32-string.md) + - [`cast parse-units`](./reference/cli/cast/parse-units.md) - [`cast pretty-calldata`](./reference/cli/cast/pretty-calldata.md) - [`cast proof`](./reference/cli/cast/proof.md) - [`cast publish`](./reference/cli/cast/publish.md) @@ -202,6 +218,7 @@ - [`cast sig`](./reference/cli/cast/sig.md) - [`cast sig-event`](./reference/cli/cast/sig-event.md) - [`cast storage`](./reference/cli/cast/storage.md) + - [`cast storage-root`](./reference/cli/cast/storage-root.md) - [`cast to-ascii`](./reference/cli/cast/to-ascii.md) - [`cast to-base`](./reference/cli/cast/to-base.md) - [`cast to-bytes32`](./reference/cli/cast/to-bytes32.md) @@ -238,6 +255,7 @@ - [`chisel load`](./reference/cli/chisel/load.md) - [`chisel view`](./reference/cli/chisel/view.md) - [`chisel clear-cache`](./reference/cli/chisel/clear-cache.md) + - [`chisel eval`](./reference/cli/chisel/eval.md) - [`forge` Commands](./reference/forge/README.md) - [General Commands](./reference/forge/general-commands.md) - [forge](./reference/forge/forge.md) diff --git a/src/output/cast/cast-call b/src/output/cast/cast-call index 42668e388..220b5596a 100644 --- a/src/output/cast/cast-call +++ b/src/output/cast/cast-call @@ -3,6 +3,6 @@ $ cast call 0x6b175474e89094c44da98b954eedeac495271d0f "totalSupply()(uint256)" --rpc-url https://eth-mainnet.alchemyapi.io/v2/Lc7oIGYeL_QvInzI0Wiu_pOZZDEKBrdf // ANCHOR_END: command // ANCHOR: output -3099782695409715937812063309 [3.099e27] +3484509098774049242440991707 [3.484e27] // ANCHOR_END: output // ANCHOR_END: all diff --git a/src/output/cheatcodes/forge-test-cheatcodes b/src/output/cheatcodes/forge-test-cheatcodes index e9496c755..59f0d5e0d 100644 --- a/src/output/cheatcodes/forge-test-cheatcodes +++ b/src/output/cheatcodes/forge-test-cheatcodes @@ -8,8 +8,8 @@ No files changed, compilation skipped Ran 2 tests for test/OwnerUpOnly.t.sol:OwnerUpOnlyTest [PASS] testFail_IncrementAsNotOwner() (gas: 8314) [PASS] test_IncrementAsOwner() (gas: 29161) -Suite result: ok. 2 passed; 0 failed; 0 skipped; finished in 517.12µs (213.19µs CPU time) +Suite result: ok. 2 passed; 0 failed; 0 skipped; finished in 469.22µs (161.02µs CPU time) -Ran 1 test suite in 5.30ms (517.12µs CPU time): 2 tests passed, 0 failed, 0 skipped (2 total tests) +Ran 1 test suite in 5.86ms (469.22µs 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 3b28e29ef..f106b6027 100644 --- a/src/output/cheatcodes/forge-test-cheatcodes-expectrevert +++ b/src/output/cheatcodes/forge-test-cheatcodes-expectrevert @@ -7,8 +7,8 @@ No files changed, compilation skipped Ran 1 test for test/OwnerUpOnly.t.sol:OwnerUpOnlyTest [PASS] test_IncrementAsOwner() (gas: 29161) -Suite result: ok. 1 passed; 0 failed; 0 skipped; finished in 424.56µs (65.33µs CPU time) +Suite result: ok. 1 passed; 0 failed; 0 skipped; finished in 377.48µs (51.22µs CPU time) -Ran 1 test suite in 5.26ms (424.56µs CPU time): 1 tests passed, 0 failed, 0 skipped (1 total tests) +Ran 1 test suite in 5.77ms (377.48µs 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 b919fdb50..f7b326e50 100644 --- a/src/output/cheatcodes/forge-test-cheatcodes-tracing +++ b/src/output/cheatcodes/forge-test-cheatcodes-tracing @@ -15,8 +15,8 @@ Traces: │ └─ ← [Revert] Unauthorized() └─ ← [Revert] Unauthorized() -Suite result: ok. 1 passed; 0 failed; 0 skipped; finished in 431.31µs (76.09µs CPU time) +Suite result: ok. 1 passed; 0 failed; 0 skipped; finished in 430.79µs (72.66µs CPU time) -Ran 1 test suite in 5.30ms (431.31µs CPU time): 1 tests passed, 0 failed, 0 skipped (1 total tests) +Ran 1 test suite in 5.93ms (430.79µs 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 ea3d44ce5..5ecbc3cb2 100644 --- a/src/output/cheatcodes/forge-test-simple +++ b/src/output/cheatcodes/forge-test-simple @@ -4,13 +4,13 @@ $ forge test --match-test test_IncrementAsOwner // 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 1.08s Compiler run successful! Ran 1 test for test/OwnerUpOnly.t.sol:OwnerUpOnlyTest [PASS] test_IncrementAsOwner() (gas: 29161) -Suite result: ok. 1 passed; 0 failed; 0 skipped; finished in 450.56µs (67.93µs CPU time) +Suite result: ok. 1 passed; 0 failed; 0 skipped; finished in 427.48µs (74.31µs CPU time) -Ran 1 test suite in 5.12ms (450.56µs CPU time): 1 tests passed, 0 failed, 0 skipped (1 total tests) +Ran 1 test suite in 5.74ms (427.48µs 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 80d9b5be6..aecd24762 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.AsFw0SJ9nj/deps/lib/solmate (url: Some("https://github.com/transmissions11/solmate"), tag: None) +Installing solmate in /tmp/tmp.Kki0lmlEdm/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 5a6b51dd8..ed515f7f8 100644 --- a/src/output/foundry-template/forge-build +++ b/src/output/foundry-template/forge-build @@ -3,8 +3,8 @@ $ forge build // ANCHOR_END: command // ANCHOR: output -Compiling 28 files with Solc 0.8.25 -Solc 0.8.25 finished in 1.32s +Compiling 28 files with Solc 0.8.28 +Solc 0.8.28 finished in 1.08s 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 84e60b60a..9924ca504 100644 --- a/src/output/foundry-template/forge-test +++ b/src/output/foundry-template/forge-test @@ -5,12 +5,12 @@ $ forge test // ANCHOR: output No files changed, compilation skipped -Ran 3 tests for test/Foo.t.sol:FooTest -[PASS] testFork_Example() (gas: 3779) +Ran 3 tests for tests/Foo.t.sol:FooTest +[PASS] testFork_Example() (gas: 3755) [PASS] testFuzz_Example(uint256) (runs: 1000, μ: 9111, ~: 9111) [PASS] test_Example() (gas: 11861) -Suite result: ok. 3 passed; 0 failed; 0 skipped; finished in 20.37ms (20.17ms CPU time) +Suite result: ok. 3 passed; 0 failed; 0 skipped; finished in 19.83ms (19.61ms CPU time) -Ran 1 test suite in 21.72ms (20.37ms CPU time): 3 tests passed, 0 failed, 0 skipped (3 total tests) +Ran 1 test suite in 20.76ms (19.83ms 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 0cbfbd99b..db10150f9 100644 --- a/src/output/fuzz_testing/forge-test-fail-fuzz +++ b/src/output/fuzz_testing/forge-test-fail-fuzz @@ -4,13 +4,13 @@ $ forge test --allow-failure // ANCHOR_END: command // ANCHOR: output Compiling 1 files with Solc 0.8.10 -Solc 0.8.10 finished in 1.06s +Solc 0.8.10 finished in 1.03s Compiler run successful! Ran 1 test for test/Safe.t.sol:SafeTest -[FAIL. Reason: EvmError: Revert; counterexample: calldata=0x29facca700000000000000000000002fd0fc08a1662c6d1cf78a42c2a428331085d9f057 args=[69883667574493385951707896100185482437096176742487 [6.988e49]]] testFuzz_Withdraw(uint256) (runs: 5, μ: 19531, ~: 19531) -Suite result: FAILED. 0 passed; 1 failed; 0 skipped; finished in 1.01ms (602.63µs CPU time) +[FAIL: EvmError: Revert; counterexample: calldata=0x29facca70000000000000000000000012af9f5065feeba8161959fb284152e8374cff075 args=[1706853479939201995200496943570665579621827735669 [1.706e48]]] testFuzz_Withdraw(uint256) (runs: 9, μ: 19531, ~: 19531) +Suite result: FAILED. 0 passed; 1 failed; 0 skipped; finished in 821.99µs (503.19µs CPU time) -Ran 1 test suite in 5.57ms (1.01ms CPU time): 0 tests passed, 1 failed, 0 skipped (1 total tests) +Ran 1 test suite in 5.95ms (821.99µs 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 e787a9e60..557bb5dfc 100644 --- a/src/output/fuzz_testing/forge-test-no-fuzz +++ b/src/output/fuzz_testing/forge-test-no-fuzz @@ -4,13 +4,13 @@ $ forge test // ANCHOR_END: command // ANCHOR: output Compiling 24 files with Solc 0.8.10 -Solc 0.8.10 finished in 1.10s +Solc 0.8.10 finished in 1.06s Compiler run successful! Ran 1 test for test/Safe.t.sol:SafeTest [PASS] test_Withdraw() (gas: 19463) -Suite result: ok. 1 passed; 0 failed; 0 skipped; finished in 410.30µs (56.99µs CPU time) +Suite result: ok. 1 passed; 0 failed; 0 skipped; finished in 399.46µs (61.43µs CPU time) -Ran 1 test suite in 5.33ms (410.30µs CPU time): 1 tests passed, 0 failed, 0 skipped (1 total tests) +Ran 1 test suite in 5.70ms (399.46µs CPU time): 1 tests passed, 0 failed, 0 skipped (1 total tests) // ANCHOR_END: output // ANCHOR_END: all diff --git a/src/output/fuzz_testing/forge-test-success-fuzz b/src/output/fuzz_testing/forge-test-success-fuzz index e50cf3959..896360b53 100644 --- a/src/output/fuzz_testing/forge-test-success-fuzz +++ b/src/output/fuzz_testing/forge-test-success-fuzz @@ -4,13 +4,13 @@ $ forge test // ANCHOR_END: command // ANCHOR: output Compiling 1 files with Solc 0.8.10 -Solc 0.8.10 finished in 1.05s +Solc 0.8.10 finished in 1.04s Compiler run successful! Ran 1 test for test/Safe.t.sol:SafeTest -[PASS] testFuzz_Withdraw(uint96) (runs: 257, μ: 19109, ~: 19631) -Suite result: ok. 1 passed; 0 failed; 0 skipped; finished in 5.02ms (4.65ms CPU time) +[PASS] testFuzz_Withdraw(uint96) (runs: 257, μ: 19578, ~: 19631) +Suite result: ok. 1 passed; 0 failed; 0 skipped; finished in 4.85ms (4.50ms CPU time) -Ran 1 test suite in 5.89ms (5.02ms CPU time): 1 tests passed, 0 failed, 0 skipped (1 total tests) +Ran 1 test suite in 5.81ms (4.85ms 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 8f934dec9..da0b9e7ee 100644 --- a/src/output/hello_foundry/forge-build +++ b/src/output/hello_foundry/forge-build @@ -3,8 +3,8 @@ $ forge build // ANCHOR_END: command // ANCHOR: output -Compiling 27 files with Solc 0.8.19 -Solc 0.8.19 finished in 1.08s +Compiling 22 files with Solc 0.8.19 +Solc 0.8.19 finished in 722.41ms 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 3cb51f54f..db9081d36 100644 --- a/src/output/hello_foundry/forge-init +++ b/src/output/hello_foundry/forge-init @@ -3,9 +3,9 @@ $ forge init hello_foundry // ANCHOR_END: command // ANCHOR: output -Initializing /tmp/tmp.bysUx20bFO/hello_foundry... -Installing forge-std in /tmp/tmp.bysUx20bFO/hello_foundry/lib/forge-std (url: Some("https://github.com/foundry-rs/forge-std"), tag: None) - Installed forge-std v1.9.2 +Initializing /tmp/tmp.Ul6eUSCitN/hello_foundry... +Installing forge-std in /tmp/tmp.Ul6eUSCitN/hello_foundry/lib/forge-std (url: Some("https://github.com/foundry-rs/forge-std"), tag: None) + Installed forge-std v1.9.6 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 35ad9dcba..468ef4779 100644 --- a/src/output/hello_foundry/forge-test +++ b/src/output/hello_foundry/forge-test @@ -6,10 +6,10 @@ $ forge test No files changed, compilation skipped Ran 2 tests for test/Counter.t.sol:CounterTest -[PASS] testFuzz_SetNumber(uint256) (runs: 256, μ: 31054, ~: 31288) +[PASS] testFuzz_SetNumber(uint256) (runs: 256, μ: 30977, ~: 31288) [PASS] test_Increment() (gas: 31303) -Suite result: ok. 2 passed; 0 failed; 0 skipped; finished in 8.02ms (7.67ms CPU time) +Suite result: ok. 2 passed; 0 failed; 0 skipped; finished in 8.75ms (8.40ms CPU time) -Ran 1 test suite in 9.19ms (8.02ms CPU time): 2 tests passed, 0 failed, 0 skipped (2 total tests) +Ran 1 test suite in 9.67ms (8.75ms 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 7ba60b7be..a33658964 100644 --- a/src/output/hello_foundry/tree-with-files +++ b/src/output/hello_foundry/tree-with-files @@ -8,6 +8,7 @@ $ tree . -L 3 -I output ├── foundry.toml ├── lib │   └── forge-std +│   ├── CONTRIBUTING.md │   ├── LICENSE-APACHE │   ├── LICENSE-MIT │   ├── README.md @@ -23,6 +24,6 @@ $ tree . -L 3 -I output └── test └── Counter.t.sol -8 directories, 10 files +9 directories, 11 files // ANCHOR_END: output // ANCHOR_END: all diff --git a/src/output/nft_tutorial/forge-test b/src/output/nft_tutorial/forge-test index 8fb31de57..28e684b3e 100644 --- a/src/output/nft_tutorial/forge-test +++ b/src/output/nft_tutorial/forge-test @@ -5,17 +5,6 @@ $ forge test // ANCHOR: output No files changed, compilation skipped -Ran 8 tests for test/SolmateNft.sol:SolmateNftTests -[PASS] testBalanceIncremented() (gas: 217400) -[PASS] testFailMaxSupplyReached() (gas: 134524) -[PASS] testFailMintToZeroAddress() (gas: 34521) -[PASS] testFailNoMintPricePaid() (gas: 5568) -[PASS] testFailUnSafeContractReceiver() (gas: 3524) -[PASS] testMintPricePaid() (gas: 81321) -[PASS] testNewMintOwnerRegistered() (gas: 190741) -[PASS] testSafeContractReceiver() (gas: 272636) -Suite result: ok. 8 passed; 0 failed; 0 skipped; finished in 1.29ms (1.33ms CPU time) - Ran 8 tests for test/OpenZeppelinNft.t.sol:OpenZeppelinNftTests [PASS] testBalanceIncremented() (gas: 217829) [PASS] testFailMaxSupplyReached() (gas: 134524) @@ -24,9 +13,20 @@ Ran 8 tests for test/OpenZeppelinNft.t.sol:OpenZeppelinNftTests [PASS] testFailUnSafeContractReceiver() (gas: 3524) [PASS] testMintPricePaid() (gas: 81554) [PASS] testNewMintOwnerRegistered() (gas: 190956) -[PASS] testSafeContractReceiver() (gas: 273132) -Suite result: ok. 8 passed; 0 failed; 0 skipped; finished in 1.33ms (1.16ms CPU time) +[PASS] testSafeContractReceiver() (gas: 273151) +Suite result: ok. 8 passed; 0 failed; 0 skipped; finished in 1.60ms (1.27ms CPU time) + +Ran 8 tests for test/SolmateNft.sol:SolmateNftTests +[PASS] testBalanceIncremented() (gas: 217400) +[PASS] testFailMaxSupplyReached() (gas: 134524) +[PASS] testFailMintToZeroAddress() (gas: 34521) +[PASS] testFailNoMintPricePaid() (gas: 5568) +[PASS] testFailUnSafeContractReceiver() (gas: 3524) +[PASS] testMintPricePaid() (gas: 81321) +[PASS] testNewMintOwnerRegistered() (gas: 190741) +[PASS] testSafeContractReceiver() (gas: 272655) +Suite result: ok. 8 passed; 0 failed; 0 skipped; finished in 1.60ms (1.33ms CPU time) -Ran 2 test suites in 5.71ms (2.62ms CPU time): 16 tests passed, 0 failed, 0 skipped (16 total tests) +Ran 2 test suites in 6.16ms (3.20ms CPU time): 16 tests passed, 0 failed, 0 skipped (16 total tests) // 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 291ca2f5a..737526a09 100644 --- a/src/output/test_filters/forge-test-match-contract-and-test +++ b/src/output/test_filters/forge-test-match-contract-and-test @@ -4,14 +4,14 @@ $ forge test --match-contract ComplicatedContractTest --match-test test_Deposit // ANCHOR_END: command // ANCHOR: output Compiling 24 files with Solc 0.8.10 -Solc 0.8.10 finished in 1.08s +Solc 0.8.10 finished in 1.04s 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.09ms (1.01ms CPU time) +Suite result: ok. 2 passed; 0 failed; 0 skipped; finished in 1.27ms (1.36ms CPU time) -Ran 1 test suite in 5.35ms (1.09ms CPU time): 2 tests passed, 0 failed, 0 skipped (2 total tests) +Ran 1 test suite in 5.80ms (1.27ms 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 db258aa09..e9ce58719 100644 --- a/src/output/test_filters/forge-test-match-path +++ b/src/output/test_filters/forge-test-match-path @@ -4,13 +4,13 @@ $ forge test --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.03s +Solc 0.8.10 finished in 1.01s 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 339.14µs (46.60µs CPU time) +Suite result: ok. 1 passed; 0 failed; 0 skipped; finished in 324.25µs (61.93µs CPU time) -Ran 1 test suite in 5.06ms (339.14µs CPU time): 1 tests passed, 0 failed, 0 skipped (1 total tests) +Ran 1 test suite in 5.80ms (324.25µ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 b42d0c32b..c439379ba 100644 --- a/src/reference/cli/SUMMARY.md +++ b/src/reference/cli/SUMMARY.md @@ -7,6 +7,8 @@ - [`forge cache ls`](./forge/cache/ls.md) - [`forge clean`](./forge/clean.md) - [`forge clone`](./forge/clone.md) + - [`forge compiler`](./forge/compiler.md) + - [`forge compiler resolve`](./forge/compiler/resolve.md) - [`forge completions`](./forge/completions.md) - [`forge config`](./forge/config.md) - [`forge coverage`](./forge/coverage.md) @@ -30,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) @@ -48,12 +54,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) @@ -62,17 +68,24 @@ - [`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) - [`cast concat-hex`](./cast/concat-hex.md) + - [`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) @@ -80,6 +93,7 @@ - [`cast etherscan-source`](./cast/etherscan-source.md) - [`cast find-block`](./cast/find-block.md) - [`cast format-bytes32-string`](./cast/format-bytes32-string.md) + - [`cast format-units`](./cast/format-units.md) - [`cast from-bin`](./cast/from-bin.md) - [`cast from-fixed-point`](./cast/from-fixed-point.md) - [`cast from-rlp`](./cast/from-rlp.md) @@ -87,6 +101,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) @@ -104,6 +119,7 @@ - [`cast nonce`](./cast/nonce.md) - [`cast parse-bytes32-address`](./cast/parse-bytes32-address.md) - [`cast parse-bytes32-string`](./cast/parse-bytes32-string.md) + - [`cast parse-units`](./cast/parse-units.md) - [`cast pretty-calldata`](./cast/pretty-calldata.md) - [`cast proof`](./cast/proof.md) - [`cast publish`](./cast/publish.md) @@ -119,6 +135,7 @@ - [`cast sig`](./cast/sig.md) - [`cast sig-event`](./cast/sig-event.md) - [`cast storage`](./cast/storage.md) + - [`cast storage-root`](./cast/storage-root.md) - [`cast to-ascii`](./cast/to-ascii.md) - [`cast to-base`](./cast/to-base.md) - [`cast to-bytes32`](./cast/to-bytes32.md) @@ -157,4 +174,5 @@ - [`chisel load`](./chisel/load.md) - [`chisel view`](./chisel/view.md) - [`chisel clear-cache`](./chisel/clear-cache.md) + - [`chisel eval`](./chisel/eval.md) diff --git a/src/reference/cli/anvil.md b/src/reference/cli/anvil.md index 7645f0e1f..432d196a0 100644 --- a/src/reference/cli/anvil.md +++ b/src/reference/cli/anvil.md @@ -27,7 +27,7 @@ Options: [default: 10000] - --config-out + --config-out Writes output of `anvil` as json to user-specified file --derivation-path @@ -46,7 +46,8 @@ Options: --hardfork The EVM hardfork to use. - Choose the hardfork by name, e.g. `shanghai`, `paris`, `london`, etc... [default: latest] + Choose the hardfork by name, e.g. `cancun`, `shanghai`, `paris`, `london`, etc... + [default: latest] --init Initialize the genesis block with the given `genesis.json` file @@ -56,6 +57,11 @@ Options: [aliases: ipcpath] + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of logical cores + + [aliases: jobs] + --load-state Initialize the chain from a previously saved state snapshot @@ -98,6 +104,14 @@ Options: [default: 8545] + --preserve-historical-states + Preserve historical state snapshots when dumping the state. + + This will save the in-memory states of the chain at particular block hashes. + + These historical states will be loaded into the memory when `--load-state` / `--state`, + and aids in RPC calls beyond the block at which state was dumped. + --prune-history [] Don't keep full chain history. If a number argument is specified, at most this number of states is kept in memory. @@ -109,9 +123,6 @@ Options: See --state and --dump-state - --silent - Don't print anything on startup and don't print logs - --slots-in-an-epoch Slots in an epoch @@ -132,12 +143,43 @@ Options: -V, --version Print version +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. + Server options: --allow-origin The cors `allow_origin` header [default: *] + --cache-path + Path to the cache directory where states are stored + --host The hosts the server will listen on @@ -242,6 +284,11 @@ Environment config: --disable-code-size-limit Disable EIP-170: Contract code size limit + --disable-min-priority-fee + Disable the enforcement of a minimum suggested priority fee + + [aliases: no-priority-fee] + --gas-limit The block gas limit @@ -249,15 +296,11 @@ Environment config: The gas price EVM options: - --alphanet - Enable Alphanet features - - [aliases: alphanet] - --auto-impersonate - Enable autoImpersonate on startup + Enables automatic impersonation on startup. This allows any transaction sender to be + simulated as different accounts, which is useful for testing contract behavior - [aliases: auto-impersonate] + [aliases: auto-unlock] --disable-console-log Disable printing of `console.log` invocations to stdout @@ -272,6 +315,9 @@ EVM options: --memory-limit The memory limit per EVM execution in bytes + --odyssey + Enable Odyssey features + --optimism Run an Optimism chain diff --git a/src/reference/cli/anvil/completions.md b/src/reference/cli/anvil/completions.md index 215058b54..465871832 100644 --- a/src/reference/cli/anvil/completions.md +++ b/src/reference/cli/anvil/completions.md @@ -4,11 +4,46 @@ Generate shell completions script ```bash $ anvil completions --help -Usage: anvil completions +Usage: anvil completions [OPTIONS] Arguments: - [possible values: bash, elvish, fish, powershell, zsh] + + [possible values: bash, elvish, fish, powershell, zsh] Options: - -h, --help Print help + -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/anvil/generate-fig-spec.md b/src/reference/cli/anvil/generate-fig-spec.md index 098e30a57..a48923133 100644 --- a/src/reference/cli/anvil/generate-fig-spec.md +++ b/src/reference/cli/anvil/generate-fig-spec.md @@ -4,8 +4,42 @@ Generate Fig autocompletion spec ```bash $ anvil generate-fig-spec --help -Usage: anvil generate-fig-spec +Usage: anvil generate-fig-spec [OPTIONS] Options: - -h, --help Print help + -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.md b/src/reference/cli/cast.md index e2cb5e8e2..2d69b02bd 100644 --- a/src/reference/cli/cast.md +++ b/src/reference/cli/cast.md @@ -4,7 +4,7 @@ Perform Ethereum RPC calls from the comfort of your command line ```bash $ cast --help -Usage: cast +Usage: cast [OPTIONS] Commands: 4byte Get the function signatures for the given selector from @@ -12,13 +12,14 @@ Commands: 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] 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] @@ -26,25 +27,37 @@ Commands: block-number Get the latest block number [aliases: bn] call Perform a call on an account without publishing a 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] + 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] concat-hex Concatenate hex strings [aliases: --concat-hex, ch] + constructor-args Display constructor arguments used for the contract initialization + [aliases: cra] create2 Generate a deterministic contract address using CREATE2 [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 + 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] format-bytes32-string Formats a string into bytes32 encoding [aliases: --format-bytes32-string] + format-units Format a number from smallest unit to decimal with arbitrary decimals + [aliases: --format-units, fun] from-bin Convert binary data into hex data [aliases: --from-bin, from-binx, fb] from-fixed-point Convert a fixed point number into an integer [aliases: --from-fix, ff] from-rlp Decodes RLP hex-encoded data [aliases: --from-rlp] @@ -53,9 +66,11 @@ Commands: 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) - implementation Fetch the EIP-1967 implementation account [aliases: impl] + implementation Fetch the EIP-1967 implementation for a contract Can read from the + implementation slot or the beacon slot [aliases: impl] index Compute the storage slot for an entry in a mapping [aliases: in] index-erc7201 Compute storage slots as specified by `ERC-7201: Namespaced Storage Layout` [aliases: index7201, in7201] @@ -75,6 +90,8 @@ Commands: parse-bytes32-address Parses a checksummed address from bytes32 encoding. [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] @@ -90,6 +107,7 @@ Commands: sig Get the selector for a function [aliases: si] 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] to-ascii Convert hex data to an ASCII string [aliases: --to-ascii, tas, 2as] to-base Converts a number of one base to another [aliases: --to-base, --to-radix, to-radix, tr, 2r] @@ -113,8 +131,44 @@ Commands: wallet Wallet management utilities [aliases: w] Options: - -h, --help Print help - -V, --version Print version + -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 + 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. Find more information in the book: http://book.getfoundry.sh/reference/cast/cast.html ``` \ No newline at end of file diff --git a/src/reference/cli/cast/4byte-decode.md b/src/reference/cli/cast/4byte-decode.md index 4d3b8a15d..fa37a33b6 100644 --- a/src/reference/cli/cast/4byte-decode.md +++ b/src/reference/cli/cast/4byte-decode.md @@ -7,11 +7,43 @@ $ cast 4byte-decode --help Usage: cast 4byte-decode [OPTIONS] [CALLDATA] Arguments: - [CALLDATA] The ABI-encoded calldata + [CALLDATA] + The ABI-encoded calldata Options: - -h, --help Print help + -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: - -j, --json Print the decoded calldata as JSON + --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/4byte-event.md b/src/reference/cli/cast/4byte-event.md index 69daffa32..1093de60d 100644 --- a/src/reference/cli/cast/4byte-event.md +++ b/src/reference/cli/cast/4byte-event.md @@ -4,11 +4,46 @@ Get the event signature for a given topic 0 from https://openchain.xyz ```bash $ cast 4byte-event --help -Usage: cast 4byte-event [TOPIC_0] +Usage: cast 4byte-event [OPTIONS] [TOPIC_0] Arguments: - [TOPIC_0] Topic 0 + [TOPIC_0] + Topic 0 Options: - -h, --help Print help + -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/4byte.md b/src/reference/cli/cast/4byte.md index 02e091efd..9a39d82d8 100644 --- a/src/reference/cli/cast/4byte.md +++ b/src/reference/cli/cast/4byte.md @@ -4,11 +4,46 @@ Get the function signatures for the given selector from https://openchain.xyz ```bash $ cast 4byte --help -Usage: cast 4byte [SELECTOR] +Usage: cast 4byte [OPTIONS] [SELECTOR] Arguments: - [SELECTOR] The function selector + [SELECTOR] + The function selector Options: - -h, --help Print help + -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/abi-encode.md b/src/reference/cli/cast/abi-encode.md index ef5f940bf..a6ec2688a 100644 --- a/src/reference/cli/cast/abi-encode.md +++ b/src/reference/cli/cast/abi-encode.md @@ -7,10 +7,49 @@ $ cast abi-encode --help Usage: cast abi-encode [OPTIONS] [ARGS]... Arguments: - The function signature - [ARGS]... The arguments of the function + + The function signature + + [ARGS]... + The arguments of the function Options: - --packed Whether to use packed encoding - -h, --help Print help + --packed + Whether to use packed encoding + + -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/access-list.md b/src/reference/cli/cast/access-list.md index 480a9e25d..a8b07ab84 100644 --- a/src/reference/cli/cast/access-list.md +++ b/src/reference/cli/cast/access-list.md @@ -25,9 +25,10 @@ Options: -h, --help Print help (see a summary with '-h') -Display options: - -j, --json - Print the access list as JSON + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of logical cores + + [aliases: jobs] Transaction options: --gas-limit @@ -75,6 +76,13 @@ Transaction options: 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 @@ -101,6 +109,20 @@ Ethereum options: [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=] + -e, --etherscan-api-key The Etherscan (or equivalent) API key @@ -174,4 +196,32 @@ Wallet options - hardware wallet: Wallet options - remote: --aws Use AWS Key Management Service + +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 72e93d8d2..102964531 100644 --- a/src/reference/cli/cast/address-zero.md +++ b/src/reference/cli/cast/address-zero.md @@ -4,8 +4,42 @@ Prints the zero address ```bash $ cast address-zero --help -Usage: cast address-zero +Usage: cast address-zero [OPTIONS] Options: - -h, --help Print help + -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/admin.md b/src/reference/cli/cast/admin.md index 92ba81739..702a684d1 100644 --- a/src/reference/cli/cast/admin.md +++ b/src/reference/cli/cast/admin.md @@ -8,7 +8,7 @@ Usage: cast admin [OPTIONS] Arguments: - The address to get the nonce for + The address from which the admin account will be fetched Options: -B, --block @@ -41,6 +41,53 @@ Options: [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/age.md b/src/reference/cli/cast/age.md index 0a110ec28..e5fc1c894 100644 --- a/src/reference/cli/cast/age.md +++ b/src/reference/cli/cast/age.md @@ -38,6 +38,53 @@ Options: [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/artifact.md b/src/reference/cli/cast/artifact.md new file mode 100644 index 000000000..0b3bf1182 --- /dev/null +++ b/src/reference/cli/cast/artifact.md @@ -0,0 +1,107 @@ +# cast artifact + +Generate an artifact file, that can be used to deploy a contract locally + +```bash +$ cast artifact --help +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 0e3c8c32d..0d317713f 100644 --- a/src/reference/cli/cast/balance.md +++ b/src/reference/cli/cast/balance.md @@ -44,10 +44,57 @@ Options: [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=] + --erc20 erc20 address to query, with the method `balanceOf(address) return (uint256)`, alias with '--erc721' -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/base-fee.md b/src/reference/cli/cast/base-fee.md index 55caa0207..19a8477fa 100644 --- a/src/reference/cli/cast/base-fee.md +++ b/src/reference/cli/cast/base-fee.md @@ -38,6 +38,53 @@ Options: [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/bind.md b/src/reference/cli/cast/bind.md index f1eb3795a..093d54400 100644 --- a/src/reference/cli/cast/bind.md +++ b/src/reference/cli/cast/bind.md @@ -47,4 +47,37 @@ 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/block-number.md b/src/reference/cli/cast/block-number.md index ea5d9ff7d..331394645 100644 --- a/src/reference/cli/cast/block-number.md +++ b/src/reference/cli/cast/block-number.md @@ -36,6 +36,53 @@ Options: [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/block.md b/src/reference/cli/cast/block.md index b7b483ca6..6408d6f82 100644 --- a/src/reference/cli/cast/block.md +++ b/src/reference/cli/cast/block.md @@ -44,10 +44,53 @@ Options: [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: - -j, --json - Print the block as JSON + --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.md b/src/reference/cli/cast/call.md index 5c1ed1b3c..321ae10b0 100644 --- a/src/reference/cli/cast/call.md +++ b/src/reference/cli/cast/call.md @@ -44,15 +44,16 @@ Options: Can also be the tags earliest, finalized, safe, latest, or pending. - --alphanet - Enable Alphanet features + --odyssey + Enable Odyssey features -h, --help Print help (see a summary with '-h') -Display options: - -j, --json - Print the decoded output as JSON + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of logical cores + + [aliases: jobs] Transaction options: --gas-limit @@ -100,6 +101,13 @@ Transaction options: 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 @@ -126,6 +134,20 @@ Ethereum options: [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=] + -e, --etherscan-api-key The Etherscan (or equivalent) API key @@ -166,6 +188,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 @@ -199,4 +226,32 @@ Wallet options - hardware wallet: Wallet options - remote: --aws Use AWS Key Management Service + +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 3dc63e29f..8e55edb87 100644 --- a/src/reference/cli/cast/call/--create.md +++ b/src/reference/cli/cast/call/--create.md @@ -26,4 +26,37 @@ 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/calldata.md b/src/reference/cli/cast/calldata.md index f7022e897..590569ccb 100644 --- a/src/reference/cli/cast/calldata.md +++ b/src/reference/cli/cast/calldata.md @@ -4,12 +4,49 @@ ABI-encode a function with arguments ```bash $ cast calldata --help -Usage: cast calldata [ARGS]... +Usage: cast calldata [OPTIONS] [ARGS]... Arguments: - The function signature in the format `()()` - [ARGS]... The arguments to encode + + The function signature in the format `()()` + + [ARGS]... + The arguments to encode Options: - -h, --help Print help + -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/chain-id.md b/src/reference/cli/cast/chain-id.md index abe03f1ce..54aff8b3b 100644 --- a/src/reference/cli/cast/chain-id.md +++ b/src/reference/cli/cast/chain-id.md @@ -32,6 +32,53 @@ Options: [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/chain.md b/src/reference/cli/cast/chain.md index d8589cc2e..20431f5c1 100644 --- a/src/reference/cli/cast/chain.md +++ b/src/reference/cli/cast/chain.md @@ -32,6 +32,53 @@ Options: [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/client.md b/src/reference/cli/cast/client.md index 2fe3985ec..8192d08a1 100644 --- a/src/reference/cli/cast/client.md +++ b/src/reference/cli/cast/client.md @@ -32,6 +32,53 @@ Options: [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/code.md b/src/reference/cli/cast/code.md index ecbb32b04..5abb20cbc 100644 --- a/src/reference/cli/cast/code.md +++ b/src/reference/cli/cast/code.md @@ -17,7 +17,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 @@ -44,6 +44,53 @@ Options: [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/codehash.md b/src/reference/cli/cast/codehash.md new file mode 100644 index 000000000..146982508 --- /dev/null +++ b/src/reference/cli/cast/codehash.md @@ -0,0 +1,96 @@ +# cast codehash + +Get the codehash for an account + +```bash +$ cast codehash --help +Usage: cast codehash [OPTIONS] [SLOTS]... + +Arguments: + + The address to get the codehash for + + [SLOTS]... + The storage slot numbers (hex or decimal) + +Options: + -B, --block + The block height to query at. + + Can also be the tags earliest, finalized, safe, latest, or pending. + + -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/codesize.md b/src/reference/cli/cast/codesize.md index 40af2a842..9b30fbab4 100644 --- a/src/reference/cli/cast/codesize.md +++ b/src/reference/cli/cast/codesize.md @@ -41,6 +41,53 @@ Options: [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/completions.md b/src/reference/cli/cast/completions.md index b5f8f6e0d..b466fa8ea 100644 --- a/src/reference/cli/cast/completions.md +++ b/src/reference/cli/cast/completions.md @@ -4,11 +4,46 @@ Generate shell completions script ```bash $ cast completions --help -Usage: cast completions +Usage: cast completions [OPTIONS] Arguments: - [possible values: bash, elvish, fish, powershell, zsh] + + [possible values: bash, elvish, fish, powershell, zsh] Options: - -h, --help Print help + -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/compute-address.md b/src/reference/cli/cast/compute-address.md index 1d77a6d7d..c67a4d40d 100644 --- a/src/reference/cli/cast/compute-address.md +++ b/src/reference/cli/cast/compute-address.md @@ -39,6 +39,53 @@ Options: [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/concat-hex.md b/src/reference/cli/cast/concat-hex.md index b04168cdb..f8569547b 100644 --- a/src/reference/cli/cast/concat-hex.md +++ b/src/reference/cli/cast/concat-hex.md @@ -4,11 +4,46 @@ Concatenate hex strings ```bash $ cast concat-hex --help -Usage: cast concat-hex [DATA]... +Usage: cast concat-hex [OPTIONS] [DATA]... Arguments: - [DATA]... The data to concatenate + [DATA]... + The data to concatenate Options: - -h, --help Print help + -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/constructor-args.md b/src/reference/cli/cast/constructor-args.md new file mode 100644 index 000000000..c4873a423 --- /dev/null +++ b/src/reference/cli/cast/constructor-args.md @@ -0,0 +1,102 @@ +# cast constructor-args + +Display constructor arguments used for the contract initialization + +```bash +$ cast constructor-args --help +Usage: cast constructor-args [OPTIONS] + +Arguments: + + An Ethereum address, for which the bytecode will be fetched + +Options: + --abi-path + Path to file containing the contract's JSON ABI. It's necessary if the target contract is + not verified on Etherscan + + -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/create2.md b/src/reference/cli/cast/create2.md index 6cb5357c8..3286da439 100644 --- a/src/reference/cli/cast/create2.md +++ b/src/reference/cli/cast/create2.md @@ -7,19 +7,75 @@ $ cast create2 --help Usage: cast create2 [OPTIONS] Options: - -s, --starts-with Prefix for the contract address - -e, --ends-with Suffix for the contract address - -m, --matching Sequence that the address has to match - -c, --case-sensitive Case sensitive matching - -d, --deployer
Address of the contract deployer [default: - 0x4e59b44847b379578588920ca78fbf26c0b4956c] - -i, --init-code Init code of the contract to be deployed - --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 - logical cores - --caller
Address of the caller. Used for the first 20 bytes of the salt - --seed The random number generator's seed, used to initialize the salt - --no-random Don't initialize the salt with a random value, and instead use the - default value of 0 - -h, --help Print help + -s, --starts-with + Prefix for the contract address + + -e, --ends-with + Suffix for the contract address + + -m, --matching + Sequence that the address has to match + + -c, --case-sensitive + Case sensitive matching + + -d, --deployer
+ Address of the contract deployer + + [default: 0x4e59b44847b379578588920ca78fbf26c0b4956c] + + --salt + Salt to be used for the contract deployment. This option separate from the default salt + mining with filters + + -i, --init-code + Init code of the contract to be deployed + + --init-code-hash + Init code hash of the contract to be deployed + + -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 + + --seed + The random number generator's seed, used to initialize the salt + + --no-random + Don't initialize the salt with a random value, and instead use the default value of 0 + + -h, --help + Print help (see a summary with '-h') + +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/creation-code.md b/src/reference/cli/cast/creation-code.md new file mode 100644 index 000000000..12ce13972 --- /dev/null +++ b/src/reference/cli/cast/creation-code.md @@ -0,0 +1,111 @@ +# cast creation-code + +Download a contract creation code from Etherscan and RPC + +```bash +$ cast creation-code --help +Usage: cast creation-code [OPTIONS] + +Arguments: + + An Ethereum address, for which the bytecode will be fetched + +Options: + --abi-path + Path to file containing the contract's JSON ABI. It's necessary if the target contract is + not verified on Etherscan + + --disassemble + Disassemble bytecodes into individual opcodes + + --without-args + Return creation bytecode without constructor arguments appended + + --only-args + Return only constructor arguments + + -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/decode-abi.md b/src/reference/cli/cast/decode-abi.md new file mode 100644 index 000000000..0ff2b4e86 --- /dev/null +++ b/src/reference/cli/cast/decode-abi.md @@ -0,0 +1,56 @@ +# cast decode-abi + +Decode ABI-encoded input or output data. + +```bash +$ cast decode-abi --help +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..c1d63c127 --- /dev/null +++ b/src/reference/cli/cast/decode-calldata.md @@ -0,0 +1,52 @@ +# cast decode-calldata + +Decode ABI-encoded input data. + +```bash +$ cast decode-calldata --help +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 aeae03535..dd0bc8a50 100644 --- a/src/reference/cli/cast/decode-eof.md +++ b/src/reference/cli/cast/decode-eof.md @@ -4,11 +4,46 @@ Decodes EOF container bytes ```bash $ cast decode-eof --help -Usage: cast decode-eof [EOF] +Usage: cast decode-eof [OPTIONS] [EOF] Arguments: - [EOF] + [EOF] + Options: - -h, --help Print help + -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-error.md b/src/reference/cli/cast/decode-error.md new file mode 100644 index 000000000..bd13d9d26 --- /dev/null +++ b/src/reference/cli/cast/decode-error.md @@ -0,0 +1,55 @@ +# cast decode-error + +Decode custom error data + +```bash +$ cast decode-error --help +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..05371ea68 --- /dev/null +++ b/src/reference/cli/cast/decode-event.md @@ -0,0 +1,55 @@ +# cast decode-event + +Decode event data + +```bash +$ cast decode-event --help +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..0931992b3 --- /dev/null +++ b/src/reference/cli/cast/decode-string.md @@ -0,0 +1,49 @@ +# cast decode-string + +Decode ABI-encoded string. + +```bash +$ cast decode-string --help +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 7bd3c6a3a..29e0e026c 100644 --- a/src/reference/cli/cast/decode-transaction.md +++ b/src/reference/cli/cast/decode-transaction.md @@ -4,11 +4,46 @@ Decodes a raw signed EIP 2718 typed transaction ```bash $ cast decode-transaction --help -Usage: cast decode-transaction [TX] +Usage: cast decode-transaction [OPTIONS] [TX] Arguments: - [TX] + [TX] + Options: - -h, --help Print help + -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/disassemble.md b/src/reference/cli/cast/disassemble.md index 589803b02..513924333 100644 --- a/src/reference/cli/cast/disassemble.md +++ b/src/reference/cli/cast/disassemble.md @@ -1,14 +1,49 @@ # 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 -Usage: cast disassemble +Usage: cast disassemble [OPTIONS] [BYTECODE] Arguments: - The hex encoded bytecode + [BYTECODE] + The hex-encoded bytecode Options: - -h, --help Print help + -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/estimate.md b/src/reference/cli/cast/estimate.md index 274dea5f8..e95f7bb18 100644 --- a/src/reference/cli/cast/estimate.md +++ b/src/reference/cli/cast/estimate.md @@ -29,6 +29,11 @@ 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 @@ -75,6 +80,13 @@ Transaction options: 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 @@ -101,6 +113,20 @@ Ethereum options: [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=] + -e, --etherscan-api-key The Etherscan (or equivalent) API key @@ -174,4 +200,32 @@ Wallet options - hardware wallet: Wallet options - remote: --aws Use AWS Key Management Service + +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/estimate/--create.md b/src/reference/cli/cast/estimate/--create.md index e55e299ed..a4ac526fd 100644 --- a/src/reference/cli/cast/estimate/--create.md +++ b/src/reference/cli/cast/estimate/--create.md @@ -26,4 +26,37 @@ 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/etherscan-source.md b/src/reference/cli/cast/etherscan-source.md index 3f66021d5..2b6c10c63 100644 --- a/src/reference/cli/cast/etherscan-source.md +++ b/src/reference/cli/cast/etherscan-source.md @@ -7,12 +7,59 @@ $ cast etherscan-source --help Usage: cast etherscan-source [OPTIONS]
Arguments: -
The contract's address +
+ The contract's address Options: - -f, --flatten Whether to flatten the source code - -d The output directory/file to expand source tree into - -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=] - -h, --help Print help + -f, --flatten + Whether to flatten the source code + + -d + The output directory/file to expand source tree into + + -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=] + + -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/find-block.md b/src/reference/cli/cast/find-block.md index bdbba6102..432abefec 100644 --- a/src/reference/cli/cast/find-block.md +++ b/src/reference/cli/cast/find-block.md @@ -36,6 +36,53 @@ Options: [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/format-bytes32-string.md b/src/reference/cli/cast/format-bytes32-string.md index 32fd661b7..c2a54c6d2 100644 --- a/src/reference/cli/cast/format-bytes32-string.md +++ b/src/reference/cli/cast/format-bytes32-string.md @@ -4,11 +4,46 @@ Formats a string into bytes32 encoding ```bash $ cast format-bytes32-string --help -Usage: cast format-bytes32-string [STRING] +Usage: cast format-bytes32-string [OPTIONS] [STRING] Arguments: - [STRING] The string to format + [STRING] + The string to format Options: - -h, --help Print help + -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/format-units.md b/src/reference/cli/cast/format-units.md new file mode 100644 index 000000000..4e20a6ddd --- /dev/null +++ b/src/reference/cli/cast/format-units.md @@ -0,0 +1,54 @@ +# cast format-units + +Format a number from smallest unit to decimal with arbitrary decimals. + +```bash +$ cast format-units --help +Usage: cast format-units [OPTIONS] [VALUE] [UNIT] + +Arguments: + [VALUE] + The value to format + + [UNIT] + The unit to format to + + [default: 18] + +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/from-bin.md b/src/reference/cli/cast/from-bin.md index 1b71df449..f29b02aaa 100644 --- a/src/reference/cli/cast/from-bin.md +++ b/src/reference/cli/cast/from-bin.md @@ -4,8 +4,42 @@ Convert binary data into hex data ```bash $ cast from-bin --help -Usage: cast from-bin +Usage: cast from-bin [OPTIONS] Options: - -h, --help Print help + -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/from-fixed-point.md b/src/reference/cli/cast/from-fixed-point.md index a123c6322..22e4fc83a 100644 --- a/src/reference/cli/cast/from-fixed-point.md +++ b/src/reference/cli/cast/from-fixed-point.md @@ -4,12 +4,49 @@ Convert a fixed point number into an integer ```bash $ cast from-fixed-point --help -Usage: cast from-fixed-point [DECIMALS] [VALUE] +Usage: cast from-fixed-point [OPTIONS] [DECIMALS] [VALUE] Arguments: - [DECIMALS] The number of decimals to use - [VALUE] The value to convert + [DECIMALS] + The number of decimals to use + + [VALUE] + The value to convert Options: - -h, --help Print help + -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/from-rlp.md b/src/reference/cli/cast/from-rlp.md index df98574f5..bacd009e2 100644 --- a/src/reference/cli/cast/from-rlp.md +++ b/src/reference/cli/cast/from-rlp.md @@ -4,11 +4,49 @@ Decodes RLP hex-encoded data ```bash $ cast from-rlp --help -Usage: cast from-rlp [VALUE] +Usage: cast from-rlp [OPTIONS] [VALUE] Arguments: - [VALUE] The RLP hex-encoded data + [VALUE] + The RLP hex-encoded data Options: - -h, --help Print help + --as-int + Decode the RLP data as int + + -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/from-utf8.md b/src/reference/cli/cast/from-utf8.md index 579c55d1f..bc6227dda 100644 --- a/src/reference/cli/cast/from-utf8.md +++ b/src/reference/cli/cast/from-utf8.md @@ -4,11 +4,46 @@ Convert UTF8 text to hex ```bash $ cast from-utf8 --help -Usage: cast from-utf8 [TEXT] +Usage: cast from-utf8 [OPTIONS] [TEXT] Arguments: - [TEXT] The text to convert + [TEXT] + The text to convert Options: - -h, --help Print help + -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/from-wei.md b/src/reference/cli/cast/from-wei.md index 62481ebf3..324da9b4a 100644 --- a/src/reference/cli/cast/from-wei.md +++ b/src/reference/cli/cast/from-wei.md @@ -4,7 +4,7 @@ Convert wei into an ETH amount. ```bash $ cast from-wei --help -Usage: cast from-wei [VALUE] [UNIT] +Usage: cast from-wei [OPTIONS] [VALUE] [UNIT] Arguments: [VALUE] @@ -18,4 +18,37 @@ Arguments: 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/gas-price.md b/src/reference/cli/cast/gas-price.md index 15e4df946..a313642cc 100644 --- a/src/reference/cli/cast/gas-price.md +++ b/src/reference/cli/cast/gas-price.md @@ -32,6 +32,53 @@ Options: [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/generate-fig-spec.md b/src/reference/cli/cast/generate-fig-spec.md index c7e49c332..2bc9e328c 100644 --- a/src/reference/cli/cast/generate-fig-spec.md +++ b/src/reference/cli/cast/generate-fig-spec.md @@ -4,8 +4,42 @@ Generate Fig autocompletion spec ```bash $ cast generate-fig-spec --help -Usage: cast generate-fig-spec +Usage: cast generate-fig-spec [OPTIONS] Options: - -h, --help Print help + -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/hash-message.md b/src/reference/cli/cast/hash-message.md new file mode 100644 index 000000000..75e0eea03 --- /dev/null +++ b/src/reference/cli/cast/hash-message.md @@ -0,0 +1,49 @@ +# cast hash-message + +Hash a message according to EIP-191 + +```bash +$ cast hash-message --help +Usage: cast hash-message [OPTIONS] [MESSAGE] + +Arguments: + [MESSAGE] + The message to hash + +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/hash-zero.md b/src/reference/cli/cast/hash-zero.md index 9e82cf2fc..e509f0477 100644 --- a/src/reference/cli/cast/hash-zero.md +++ b/src/reference/cli/cast/hash-zero.md @@ -4,8 +4,42 @@ Prints the zero hash ```bash $ cast hash-zero --help -Usage: cast hash-zero +Usage: cast hash-zero [OPTIONS] Options: - -h, --help Print help + -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/implementation.md b/src/reference/cli/cast/implementation.md index 851cdf978..518563900 100644 --- a/src/reference/cli/cast/implementation.md +++ b/src/reference/cli/cast/implementation.md @@ -1,6 +1,6 @@ # cast implementation -Fetch the EIP-1967 implementation account +Fetch the EIP-1967 implementation for a contract Can read from the implementation slot or the beacon ```bash $ cast implementation --help @@ -8,7 +8,7 @@ Usage: cast implementation [OPTIONS] Arguments: - The address to get the nonce for + The address for which the implementation will be fetched Options: -B, --block @@ -16,6 +16,11 @@ Options: Can also be the tags earliest, finalized, safe, latest, or pending. + --beacon + Fetch the implementation from the beacon slot. + + If not specified, the implementation slot is used. + -r, --rpc-url The RPC endpoint @@ -41,6 +46,53 @@ Options: [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/index-erc7201.md b/src/reference/cli/cast/index-erc7201.md index 38cf8393e..7a208141c 100644 --- a/src/reference/cli/cast/index-erc7201.md +++ b/src/reference/cli/cast/index-erc7201.md @@ -7,10 +7,48 @@ $ cast index-erc7201 --help Usage: cast index-erc7201 [OPTIONS] [ID] Arguments: - [ID] The arbitrary identifier + [ID] + The arbitrary identifier Options: - --formula-id The formula ID. Currently the only supported formula is `erc7201` - [default: erc7201] - -h, --help Print help + --formula-id + The formula ID. Currently the only supported formula is `erc7201` + + [default: erc7201] + + -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/index.md b/src/reference/cli/cast/index.md index 6a346a552..125f8fcfd 100644 --- a/src/reference/cli/cast/index.md +++ b/src/reference/cli/cast/index.md @@ -4,13 +4,52 @@ Compute the storage slot for an entry in a mapping ```bash $ cast index --help -Usage: cast index +Usage: cast index [OPTIONS] Arguments: - The mapping key type - The mapping key - The storage slot of the mapping + + The mapping key type + + + The mapping key + + + The storage slot of the mapping Options: - -h, --help Print help + -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/interface.md b/src/reference/cli/cast/interface.md index 3d8365237..2f056bcc5 100644 --- a/src/reference/cli/cast/interface.md +++ b/src/reference/cli/cast/interface.md @@ -28,9 +28,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 @@ -43,4 +40,37 @@ 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/keccak.md b/src/reference/cli/cast/keccak.md index 04865a902..b2278c448 100644 --- a/src/reference/cli/cast/keccak.md +++ b/src/reference/cli/cast/keccak.md @@ -4,11 +4,46 @@ Hash arbitrary data using Keccak-256 ```bash $ cast keccak --help -Usage: cast keccak [DATA] +Usage: cast keccak [OPTIONS] [DATA] Arguments: - [DATA] The data to hash + [DATA] + The data to hash Options: - -h, --help Print help + -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/logs.md b/src/reference/cli/cast/logs.md index 7056ad75e..818d1fd84 100644 --- a/src/reference/cli/cast/logs.md +++ b/src/reference/cli/cast/logs.md @@ -36,9 +36,10 @@ Options: -h, --help Print help (see a summary with '-h') -Display options: - -j, --json - Print the logs as JSON.s + -j, --threads + Number of threads to use. Specifying 0 defaults to the number of logical cores + + [aliases: jobs] Ethereum options: -r, --rpc-url @@ -66,6 +67,20 @@ Ethereum options: [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=] + -e, --etherscan-api-key The Etherscan (or equivalent) API key @@ -139,4 +154,32 @@ Wallet options - hardware wallet: Wallet options - remote: --aws Use AWS Key Management Service + +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 cd11d6023..163d85403 100644 --- a/src/reference/cli/cast/lookup-address.md +++ b/src/reference/cli/cast/lookup-address.md @@ -11,7 +11,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 @@ -39,6 +39,53 @@ Options: [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/max-int.md b/src/reference/cli/cast/max-int.md index 5b4c6ed6a..8bb13ef42 100644 --- a/src/reference/cli/cast/max-int.md +++ b/src/reference/cli/cast/max-int.md @@ -4,11 +4,48 @@ Prints the maximum value of the given integer type ```bash $ cast max-int --help -Usage: cast max-int [TYPE] +Usage: cast max-int [OPTIONS] [TYPE] Arguments: - [TYPE] The integer type to get the maximum value of [default: int256] + [TYPE] + The integer type to get the maximum value of + + [default: int256] Options: - -h, --help Print help + -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/max-uint.md b/src/reference/cli/cast/max-uint.md index a404ca930..045ab2a91 100644 --- a/src/reference/cli/cast/max-uint.md +++ b/src/reference/cli/cast/max-uint.md @@ -4,11 +4,48 @@ Prints the maximum value of the given integer type ```bash $ cast max-uint --help -Usage: cast max-uint [TYPE] +Usage: cast max-uint [OPTIONS] [TYPE] Arguments: - [TYPE] The unsigned integer type to get the maximum value of [default: uint256] + [TYPE] + The unsigned integer type to get the maximum value of + + [default: uint256] Options: - -h, --help Print help + -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/min-int.md b/src/reference/cli/cast/min-int.md index 5ebd63793..e3f75be62 100644 --- a/src/reference/cli/cast/min-int.md +++ b/src/reference/cli/cast/min-int.md @@ -4,11 +4,48 @@ Prints the minimum value of the given integer type ```bash $ cast min-int --help -Usage: cast min-int [TYPE] +Usage: cast min-int [OPTIONS] [TYPE] Arguments: - [TYPE] The integer type to get the minimum value of [default: int256] + [TYPE] + The integer type to get the minimum value of + + [default: int256] Options: - -h, --help Print help + -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/mktx.md b/src/reference/cli/cast/mktx.md index 035daffaa..ffec3e90c 100644 --- a/src/reference/cli/cast/mktx.md +++ b/src/reference/cli/cast/mktx.md @@ -26,6 +26,11 @@ 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 @@ -72,6 +77,13 @@ Transaction options: 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 @@ -101,6 +113,20 @@ Ethereum options: [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=] + -e, --etherscan-api-key The Etherscan (or equivalent) API key @@ -174,4 +200,32 @@ Wallet options - hardware wallet: Wallet options - remote: --aws Use AWS Key Management Service + +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/mktx/--create.md b/src/reference/cli/cast/mktx/--create.md index 5d8c920cf..c8947a28d 100644 --- a/src/reference/cli/cast/mktx/--create.md +++ b/src/reference/cli/cast/mktx/--create.md @@ -4,13 +4,52 @@ Use to deploy raw contract bytecode ```bash $ cast mktx --create --help -Usage: cast mktx --create [SIG] [ARGS]... +Usage: cast mktx --create [OPTIONS] [SIG] [ARGS]... Arguments: - The initialization bytecode of the contract to deploy - [SIG] The signature of the constructor - [ARGS]... The constructor arguments + + The initialization bytecode of the contract to deploy + + [SIG] + The signature of the constructor + + [ARGS]... + The constructor arguments Options: - -h, --help Print help + -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/namehash.md b/src/reference/cli/cast/namehash.md index 585da83ea..9b0adf888 100644 --- a/src/reference/cli/cast/namehash.md +++ b/src/reference/cli/cast/namehash.md @@ -4,11 +4,46 @@ Calculate the ENS namehash of a name ```bash $ cast namehash --help -Usage: cast namehash [NAME] +Usage: cast namehash [OPTIONS] [NAME] Arguments: - [NAME] + [NAME] + Options: - -h, --help Print help + -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/nonce.md b/src/reference/cli/cast/nonce.md index 9dc1376cf..034afce71 100644 --- a/src/reference/cli/cast/nonce.md +++ b/src/reference/cli/cast/nonce.md @@ -41,6 +41,53 @@ Options: [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/parse-bytes32-address.md b/src/reference/cli/cast/parse-bytes32-address.md index 2b5393860..995f1adcd 100644 --- a/src/reference/cli/cast/parse-bytes32-address.md +++ b/src/reference/cli/cast/parse-bytes32-address.md @@ -4,11 +4,46 @@ Parses a checksummed address from bytes32 encoding. ```bash $ cast parse-bytes32-address --help -Usage: cast parse-bytes32-address [BYTES] +Usage: cast parse-bytes32-address [OPTIONS] [BYTES] Arguments: - [BYTES] + [BYTES] + Options: - -h, --help Print help + -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/parse-bytes32-string.md b/src/reference/cli/cast/parse-bytes32-string.md index 0e730a260..4f757d315 100644 --- a/src/reference/cli/cast/parse-bytes32-string.md +++ b/src/reference/cli/cast/parse-bytes32-string.md @@ -4,11 +4,46 @@ Parses a string from bytes32 encoding ```bash $ cast parse-bytes32-string --help -Usage: cast parse-bytes32-string [BYTES] +Usage: cast parse-bytes32-string [OPTIONS] [BYTES] Arguments: - [BYTES] The string to parse + [BYTES] + The string to parse Options: - -h, --help Print help + -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/parse-units.md b/src/reference/cli/cast/parse-units.md new file mode 100644 index 000000000..500898393 --- /dev/null +++ b/src/reference/cli/cast/parse-units.md @@ -0,0 +1,54 @@ +# cast parse-units + +Convert a number from decimal to smallest unit with arbitrary decimals. + +```bash +$ cast parse-units --help +Usage: cast parse-units [OPTIONS] [VALUE] [UNIT] + +Arguments: + [VALUE] + The value to convert + + [UNIT] + The unit to convert to + + [default: 18] + +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/pretty-calldata.md b/src/reference/cli/cast/pretty-calldata.md index 5586e693e..ee65a5aec 100644 --- a/src/reference/cli/cast/pretty-calldata.md +++ b/src/reference/cli/cast/pretty-calldata.md @@ -16,4 +16,37 @@ 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/proof.md b/src/reference/cli/cast/proof.md index 552399360..bb0e73f62 100644 --- a/src/reference/cli/cast/proof.md +++ b/src/reference/cli/cast/proof.md @@ -44,6 +44,53 @@ Options: [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/publish.md b/src/reference/cli/cast/publish.md index 6308458be..728fe5a21 100644 --- a/src/reference/cli/cast/publish.md +++ b/src/reference/cli/cast/publish.md @@ -41,6 +41,53 @@ Options: [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/receipt.md b/src/reference/cli/cast/receipt.md index a0867797a..422aba856 100644 --- a/src/reference/cli/cast/receipt.md +++ b/src/reference/cli/cast/receipt.md @@ -49,10 +49,53 @@ Options: [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: - -j, --json - Print as JSON + --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/resolve-name.md b/src/reference/cli/cast/resolve-name.md index 125e49a3f..d1dafecad 100644 --- a/src/reference/cli/cast/resolve-name.md +++ b/src/reference/cli/cast/resolve-name.md @@ -11,7 +11,7 @@ Arguments: The name to lookup Options: - -v, --verify + --verify Perform a reverse lookup to verify that the name is correct -r, --rpc-url @@ -39,6 +39,53 @@ Options: [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/rpc.md b/src/reference/cli/cast/rpc.md index 8efceba6f..0d0a68d00 100644 --- a/src/reference/cli/cast/rpc.md +++ b/src/reference/cli/cast/rpc.md @@ -53,6 +53,53 @@ Options: [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/run.md b/src/reference/cli/cast/run.md index f12bfc55e..99e0e3f95 100644 --- a/src/reference/cli/cast/run.md +++ b/src/reference/cli/cast/run.md @@ -20,19 +20,26 @@ Options: -t, --trace-printer Print out opcode traces - -q, --quick + --quick Executes the transaction only with the state from the previous block. May result in different results than the live execution! - -v, --verbose - Prints the full address of the contract - -l, --label