Skip to content

Commit

Permalink
update command output (#1247)
Browse files Browse the repository at this point in the history
Co-authored-by: mattsse <[email protected]>
  • Loading branch information
github-actions[bot] and mattsse authored Jul 28, 2024
1 parent a7819a8 commit c16d203
Show file tree
Hide file tree
Showing 32 changed files with 108 additions and 58 deletions.
1 change: 1 addition & 0 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,7 @@
- [`cast compute-address`](./reference/cli/cast/compute-address.md)
- [`cast concat-hex`](./reference/cli/cast/concat-hex.md)
- [`cast create2`](./reference/cli/cast/create2.md)
- [`cast decode-eof`](./reference/cli/cast/decode-eof.md)
- [`cast decode-transaction`](./reference/cli/cast/decode-transaction.md)
- [`cast disassemble`](./reference/cli/cast/disassemble.md)
- [`cast estimate`](./reference/cli/cast/estimate.md)
Expand Down
2 changes: 1 addition & 1 deletion src/output/cast/cast-call

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions src/output/cheatcodes/forge-test-cheatcodes

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions src/output/cheatcodes/forge-test-cheatcodes-expectrevert

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions src/output/cheatcodes/forge-test-cheatcodes-tracing

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions src/output/cheatcodes/forge-test-simple

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/output/deps/forge-install

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions src/output/foundry-template/forge-test

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions src/output/fuzz_testing/forge-test-fail-fuzz

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions src/output/fuzz_testing/forge-test-no-fuzz

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions src/output/fuzz_testing/forge-test-success-fuzz

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions src/output/hello_foundry/forge-init

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions src/output/hello_foundry/forge-test

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions src/output/nft_tutorial/forge-test

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions src/output/test_filters/forge-test-match-contract-and-test

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions src/output/test_filters/forge-test-match-path

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions src/reference/cli/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@
- [`cast compute-address`](./cast/compute-address.md)
- [`cast concat-hex`](./cast/concat-hex.md)
- [`cast create2`](./cast/create2.md)
- [`cast decode-eof`](./cast/decode-eof.md)
- [`cast decode-transaction`](./cast/decode-transaction.md)
- [`cast disassemble`](./cast/disassemble.md)
- [`cast estimate`](./cast/estimate.md)
Expand Down
3 changes: 3 additions & 0 deletions src/reference/cli/anvil.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,9 @@ Options:
BIP39 mnemonic phrase used for generating accounts. Cannot be used if `mnemonic_random` or
`mnemonic_seed` are used
--mixed-mining
[aliases: mixed-mining]
--mnemonic-random [<MNEMONIC_RANDOM>]
Automatically generates a BIP39 mnemonic phrase, and derives accounts from it. Cannot be
used with other `mnemonic` options. You can specify the number of words you want in the
Expand Down
4 changes: 3 additions & 1 deletion src/reference/cli/cast.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,9 @@ Commands:
[aliases: ca]
concat-hex Concatenate hex strings [aliases: --concat-hex, ch]
create2 Generate a deterministic contract address using CREATE2 [aliases: c2]
decode-transaction Decodes a raw signed EIP 2718 typed transaction [aliases: dt]
decode-eof Decodes EOF container bytes
decode-transaction Decodes a raw signed EIP 2718 typed transaction [aliases: dt,
decode-tx]
disassemble Disassembles hex encoded bytecode into individual / human readable
opcodes [aliases: da]
estimate Estimate the gas cost of a transaction [aliases: e]
Expand Down
5 changes: 4 additions & 1 deletion src/reference/cli/cast/4byte-decode.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,14 @@ Decode ABI-encoded calldata using https://openchain.xyz

```bash
$ cast 4byte-decode --help
Usage: cast 4byte-decode [CALLDATA]
Usage: cast 4byte-decode [OPTIONS] [CALLDATA]

Arguments:
[CALLDATA] The ABI-encoded calldata

Options:
-h, --help Print help

Display options:
-j, --json Print the decoded calldata as JSON
```
4 changes: 4 additions & 0 deletions src/reference/cli/cast/abi-decode.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,8 @@ Options:
Decode input data instead of output data:
-i, --input
Whether to decode the input or output data

Display options:
-j, --json
Print the decoded calldata as JSON
```
5 changes: 4 additions & 1 deletion src/reference/cli/cast/access-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,10 @@ Transaction options:
[env: ETH_GAS_LIMIT=]

--gas-price <PRICE>
Gas price for legacy transactions, or max fee per gas for EIP1559 transactions
Gas price for legacy transactions, or max fee per gas for EIP1559 transactions, either
specified in wei, or as a string with a unit type.

Examples: 1ether, 10gwei, 0.01ether

[env: ETH_GAS_PRICE=]

Expand Down
5 changes: 4 additions & 1 deletion src/reference/cli/cast/call.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,10 @@ Transaction options:
[env: ETH_GAS_LIMIT=]

--gas-price <PRICE>
Gas price for legacy transactions, or max fee per gas for EIP1559 transactions
Gas price for legacy transactions, or max fee per gas for EIP1559 transactions, either
specified in wei, or as a string with a unit type.

Examples: 1ether, 10gwei, 0.01ether

[env: ETH_GAS_PRICE=]

Expand Down
6 changes: 5 additions & 1 deletion src/reference/cli/cast/calldata-decode.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Decode ABI-encoded input data.

```bash
$ cast calldata-decode --help
Usage: cast calldata-decode <SIG> <CALLDATA>
Usage: cast calldata-decode [OPTIONS] <SIG> <CALLDATA>

Arguments:
<SIG>
Expand All @@ -16,4 +16,8 @@ Arguments:
Options:
-h, --help
Print help (see a summary with '-h')

Display options:
-j, --json
Print the decoded calldata as JSON
```
14 changes: 14 additions & 0 deletions src/reference/cli/cast/decode-eof.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# cast decode-eof

Decodes EOF container bytes

```bash
$ cast decode-eof --help
Usage: cast decode-eof [EOF]

Arguments:
[EOF]

Options:
-h, --help Print help
```
5 changes: 4 additions & 1 deletion src/reference/cli/cast/estimate.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,10 @@ Transaction options:
[env: ETH_GAS_LIMIT=]

--gas-price <PRICE>
Gas price for legacy transactions, or max fee per gas for EIP1559 transactions
Gas price for legacy transactions, or max fee per gas for EIP1559 transactions, either
specified in wei, or as a string with a unit type.

Examples: 1ether, 10gwei, 0.01ether

[env: ETH_GAS_PRICE=]

Expand Down
8 changes: 7 additions & 1 deletion src/reference/cli/cast/mktx.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,10 @@ Transaction options:
[env: ETH_GAS_LIMIT=]

--gas-price <PRICE>
Gas price for legacy transactions, or max fee per gas for EIP1559 transactions
Gas price for legacy transactions, or max fee per gas for EIP1559 transactions, either
specified in wei, or as a string with a unit type.

Examples: 1ether, 10gwei, 0.01ether

[env: ETH_GAS_PRICE=]

Expand Down Expand Up @@ -64,6 +67,9 @@ Transaction options:

[env: ETH_BLOB_GAS_PRICE=]

--path <BLOB_DATA_PATH>
The path of blob data to be sent

Ethereum options:
-r, --rpc-url <URL>
The RPC endpoint
Expand Down
11 changes: 7 additions & 4 deletions src/reference/cli/cast/send.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,10 @@ Transaction options:
[env: ETH_GAS_LIMIT=]
--gas-price <PRICE>
Gas price for legacy transactions, or max fee per gas for EIP1559 transactions
Gas price for legacy transactions, or max fee per gas for EIP1559 transactions, either
specified in wei, or as a string with a unit type.
Examples: 1ether, 10gwei, 0.01ether
[env: ETH_GAS_PRICE=]
Expand Down Expand Up @@ -81,6 +84,9 @@ Transaction options:
[env: ETH_BLOB_GAS_PRICE=]
--path <BLOB_DATA_PATH>
The path of blob data to be sent
Ethereum options:
-r, --rpc-url <URL>
The RPC endpoint
Expand Down Expand Up @@ -147,9 +153,6 @@ Wallet options - raw:
[default: 0]
--path <BLOB_DATA_PATH>
The path of blob data to be sent
Wallet options - keystore:
--keystore <PATH>
Use the keystore in the given folder or file
Expand Down
5 changes: 4 additions & 1 deletion src/reference/cli/forge/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,10 @@ Transaction options:
[env: ETH_GAS_LIMIT=]
--gas-price <PRICE>
Gas price for legacy transactions, or max fee per gas for EIP1559 transactions
Gas price for legacy transactions, or max fee per gas for EIP1559 transactions, either
specified in wei, or as a string with a unit type.
Examples: 1ether, 10gwei, 0.01ether
[env: ETH_GAS_PRICE=]
Expand Down
Loading

0 comments on commit c16d203

Please sign in to comment.