Skip to content

Commit

Permalink
replaced underscores with asterisks in md files
Browse files Browse the repository at this point in the history
  • Loading branch information
ingridnovak committed May 19, 2024
1 parent 403f90c commit a0eca6f
Show file tree
Hide file tree
Showing 101 changed files with 602 additions and 602 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ probe-4byte-decode - Decode ABI-encoded calldata using https://sig.eth.samczsun.

### SYNOPSIS

`probe 4byte-decode` [*options*] _calldata_
`probe 4byte-decode` [*options*] *calldata*

### DESCRIPTION

Expand All @@ -18,7 +18,7 @@ Decode ABI-encoded calldata using https://sig.eth.samczsun.com.

#### 4byte Options

`--id` _id_
`--id` *id*
    The index of the resolved signature to use.
    
    https://sig.eth.samczsun.com can have multiple possible signatures for a given selector.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ probe-4byte-event - Get the event signature for a given topic 0 from https://sig

### SYNOPSIS

`probe 4byte-event` [*options*] _topic_0_
`probe 4byte-event` [*options*] *topic_0*

### DESCRIPTION

Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-1/reference/probe/probe-4byte.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ probe-4byte - Get the function signatures for the given selector from https://si

### SYNOPSIS

`probe 4byte` [*options*] _sig_
`probe 4byte` [*options*] *sig*

### DESCRIPTION

Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-1/reference/probe/probe-abi-decode.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ probe-abi-decode - Decode ABI-encoded input or output data.

### SYNOPSIS

`probe abi-decode` [*options*] _sig_ _calldata_
`probe abi-decode` [*options*] *sig* *calldata*

### DESCRIPTION

Decode ABI-encoded input or output data.

By default, the command will decode output data. To decode input data, pass `--input` or use [`probe calldata-decode`](./probe-calldata-decode.md).

The signature (_sig_) is a fragment in the form `<function name>(<types...>)(<types...>)`.
The signature (*sig*) is a fragment in the form `<function name>(<types...>)(<types...>)`.

### OPTIONS

Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-1/reference/probe/probe-abi-encode.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ probe-abi-encode - ABI encode the given function arguments, excluding the select

### SYNOPSIS

`probe abi-encode` [*options*] _sig_ [*args...*]
`probe abi-encode` [*options*] *sig* [*args...*]

### DESCRIPTION

ABI encode the given function, excluding the selector.

The signature (_sig_) is a fragment in the form `<function name>(<types...>)`.
The signature (*sig*) is a fragment in the form `<function name>(<types...>)`.

### OPTIONS

Expand Down
26 changes: 13 additions & 13 deletions versioned_docs/version-1/reference/probe/probe-access-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ probe-access-list - Create an access list for a transaction.

### SYNOPSIS

`probe access-list` [*options*] _to_ _sig_ [*args...*]
`probe access-list` [*options*] *to* *sig* [*args...*]

### DESCRIPTION

Create an access list for a transaction.

The destination (_to_) can be an ENS name or an address.
The destination (*to*) can be an ENS name or an address.

The signature (_sig_) can be:
The signature (*sig*) can be:

- A fragment: `someFunction(uint256,bytes32)`
- A selector and encoded calldata: `0xcdba2fd40000000000000000000000000000000000000000000000000000000000007a69`
Expand All @@ -26,8 +26,8 @@ The signature (_sig_) can be:

#### Query Options

`-B` _block_
`--block` _block_
`-B` *block *
`--block` *block *
&nbsp;&nbsp;&nbsp;&nbsp;The block height you want to query at.

&nbsp;&nbsp;&nbsp;&nbsp;Can be a block number, or any of the tags: `earliest`, `finalized`, `safe`, `latest` or `pending`.
Expand Down Expand Up @@ -60,17 +60,17 @@ The signature (_sig_) can be:

#### Wallet Options - Keystore

`--keystore` _path_
`--keystore` *path*
&nbsp;&nbsp;&nbsp;&nbsp;Use the keystore in the given folder or file.
&nbsp;&nbsp;&nbsp;&nbsp;Environment: `ETH_KEYSTORE`

`--account` _account-name_
`--account` *account-name*
&nbsp;&nbsp;&nbsp;&nbsp;Use a keystore from the default keystores folder (~/.foxar/keystores) by its filename.
&nbsp;&nbsp;&nbsp;&nbsp;Environment: `ETH_KEYSTORE_ACCOUNT`

`--interactive`

`--password` _password_
`--password` *password*
&nbsp;&nbsp;&nbsp;&nbsp;The keystore password. Used with `--keystore`.
&nbsp;&nbsp;&nbsp;&nbsp;Environment: `ETH_PASSWORD`

Expand All @@ -86,14 +86,14 @@ The signature (_sig_) can be:

#### Wallet Options - Remote

`-f` _address_
`--from` _address_
`-f` *address*
`--from` *address*
&nbsp;&nbsp;&nbsp;&nbsp;Sign the transaction with the specified account on the RPC.
&nbsp;&nbsp;&nbsp;&nbsp;Environment: `ETH_FROM`

#### RPC Options

`--rpc-url` _url_
`--rpc-url` *url*
&nbsp;&nbsp;&nbsp;&nbsp;The RPC endpoint. Accepts a URL or an existing alias in the [rpc_endpoints] table, like `mainnet`.
&nbsp;&nbsp;&nbsp;&nbsp;Environment: `ETH_RPC_URL`

Expand All @@ -102,10 +102,10 @@ The signature (_sig_) can be:

#### Etherscan Options

`--chain` _chain_name_
`--chain` *chain_name*
&nbsp;&nbsp;&nbsp;&nbsp;The Etherscan chain.

`--etherscan-api-key` _key_
`--etherscan-api-key` *key*
&nbsp;&nbsp;&nbsp;&nbsp;Etherscan API key, or the key of an [Etherscan configuration table](../config/etherscan#etherscan).
&nbsp;&nbsp;&nbsp;&nbsp;Environment: `ETHERSCAN_API_KEY`

Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-1/reference/probe/probe-age.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ probe-age - Get the timestamp of a block.

Get the timestamp of a block.

The specified _block_ can be a block number, or any of the tags: `earliest`, `finalized`, `safe`, `latest` or `pending`. Default to `latest`.
The specified *block* can be a block number, or any of the tags: `earliest`, `finalized`, `safe`, `latest` or `pending`. Default to `latest`.

### OPTIONS

#### RPC Options

`--rpc-url` _url_
`--rpc-url` *url*
&nbsp;&nbsp;&nbsp;&nbsp;The RPC endpoint. Accepts a URL or an existing alias in the [rpc_endpoints] table, like `mainnet`.
&nbsp;&nbsp;&nbsp;&nbsp;Environment: `ETH_RPC_URL`

Expand Down
14 changes: 7 additions & 7 deletions versioned_docs/version-1/reference/probe/probe-balance.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,31 @@ probe-balance - Get the balance of an account in wei.

### SYNOPSIS

`probe balance` [*options*] _who_
`probe balance` [*options*] *who*

### DESCRIPTION

Get the balance of an account.

The argument _who_ can be an ENS name or an address.
The argument *who* can be an ENS name or an address.

### OPTIONS

#### Query Options

`-B` _block_
`--block` _block_
`-B` *block*
`--block` *block*
&nbsp;&nbsp;&nbsp;&nbsp;The block height you want to query at.

&nbsp;&nbsp;&nbsp;&nbsp;Can be a block number, or any of the tags: `earliest`, `finalized`, `safe`, `latest` or `pending`.

`-e` _ether_
`--ether` _ether_
`-e` *ether*
`--ether` *ether*
&nbsp;&nbsp;&nbsp;&nbsp; If this flag is used then balance will be shown in ether

#### RPC Options

`--rpc-url` _url_
`--rpc-url` *url*
&nbsp;&nbsp;&nbsp;&nbsp;The RPC endpoint. Accepts a URL or an existing alias in the [rpc_endpoints] table, like `mainnet`.
&nbsp;&nbsp;&nbsp;&nbsp;Environment: `ETH_RPC_URL`

Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-1/reference/probe/probe-basefee.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ probe-base-fee - Get the basefee of a block.

Get the basefee of a block.

The specified _block_ can be a block number, or any of the tags: `earliest`, `finalized`, `safe`, `latest` or `pending`. Default to `latest`.
The specified *block* can be a block number, or any of the tags: `earliest`, `finalized`, `safe`, `latest` or `pending`. Default to `latest`.

### OPTIONS

#### RPC Options

`--rpc-url` _url_
`--rpc-url` *url*
&nbsp;&nbsp;&nbsp;&nbsp;The RPC endpoint. Accepts a URL or an existing alias in the [rpc_endpoints] table, like `mainnet`.
&nbsp;&nbsp;&nbsp;&nbsp;Environment: `ETH_RPC_URL`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Get the latest block number.

#### RPC Options

`--rpc-url` _url_
`--rpc-url` *url*
&nbsp;&nbsp;&nbsp;&nbsp;The RPC endpoint. Accepts a URL or an existing alias in the [rpc_endpoints] table, like `mainnet`.
&nbsp;&nbsp;&nbsp;&nbsp;Environment: `ETH_RPC_URL`

Expand Down
8 changes: 4 additions & 4 deletions versioned_docs/version-1/reference/probe/probe-block.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ probe-block - Get information about a block.

Get information about a block.

The specified _block_ can be a block number, or any of the tags: `earliest`, `finalized`, `safe`, `latest` or `pending`. Default to `latest`.
The specified *block* can be a block number, or any of the tags: `earliest`, `finalized`, `safe`, `latest` or `pending`. Default to `latest`.

### OPTIONS

`-f` _field_
`--field` _field_
`-f` *field*
`--field` *field*
&nbsp;&nbsp;&nbsp;&nbsp; If specified, only get the given field of the block.

#### Display Options
Expand All @@ -30,7 +30,7 @@ The specified _block_ can be a block number, or any of the tags: `earliest`, `fi

#### RPC Options

`--rpc-url` _url_
`--rpc-url` *url*
&nbsp;&nbsp;&nbsp;&nbsp;The RPC endpoint. Accepts a URL or an existing alias in the [rpc_endpoints] table, like `mainnet`.
&nbsp;&nbsp;&nbsp;&nbsp;Environment: `ETH_RPC_URL`

Expand Down
26 changes: 13 additions & 13 deletions versioned_docs/version-1/reference/probe/probe-call.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ probe-call - Perform a call on an account without publishing a transaction.

### SYNOPSIS

`probe call` [*options*] _to_ _sig_ [*args...*]
`probe call` [*options*] *to* *sig* [*args...*]

### DESCRIPTION

Perform a call on an account without publishing a transaction.

The destination (_to_) can be an ENS name or an address.
The destination (*to*) can be an ENS name or an address.

The signature (_sig_) can be:
The signature (*sig*) can be:

- A fragment: `someFunction(uint256,bytes32)`
- A selector and encoded calldata: `0xcdba2fd40000000000000000000000000000000000000000000000000000000000007a69`
Expand All @@ -38,8 +38,8 @@ The signature (_sig_) can be:

#### Query Options

`-B` _block_
`--block` _block_
`-B` *block*
`--block` *block*
&nbsp;&nbsp;&nbsp;&nbsp;The block height you want to query at.

&nbsp;&nbsp;&nbsp;&nbsp;Can be a block number, or any of the tags: `earliest`, `finalized`, `safe`, `latest` or `pending`.
Expand Down Expand Up @@ -72,17 +72,17 @@ The signature (_sig_) can be:

#### Wallet Options - Keystore

`--keystore` _path_
`--keystore` *path*
&nbsp;&nbsp;&nbsp;&nbsp;Use the keystore in the given folder or file.
&nbsp;&nbsp;&nbsp;&nbsp;Environment: `ETH_KEYSTORE`

`--account` _account-name_
`--account` *account-name*
&nbsp;&nbsp;&nbsp;&nbsp;Use a keystore from the default keystores folder (~/.foxar/keystores) by its filename.
&nbsp;&nbsp;&nbsp;&nbsp;Environment: `ETH_KEYSTORE_ACCOUNT`

`--interactive`

`--password` _password_
`--password` *password*
&nbsp;&nbsp;&nbsp;&nbsp;The keystore password. Used with `--keystore`.
&nbsp;&nbsp;&nbsp;&nbsp;Environment: `ETH_PASSWORD`

Expand All @@ -98,14 +98,14 @@ The signature (_sig_) can be:

#### Wallet Options - Remote

`-f` _address_
`--from` _address_
`-f` *address*
`--from` *address*
&nbsp;&nbsp;&nbsp;&nbsp;Sign the transaction with the specified account on the RPC.
&nbsp;&nbsp;&nbsp;&nbsp;Environment: `ETH_FROM`

#### RPC Options

`--rpc-url` _url_
`--rpc-url` *url*
&nbsp;&nbsp;&nbsp;&nbsp;The RPC endpoint. Accepts a URL or an existing alias in the [rpc_endpoints] table, like `mainnet`.
&nbsp;&nbsp;&nbsp;&nbsp;Environment: `ETH_RPC_URL`

Expand All @@ -114,10 +114,10 @@ The signature (_sig_) can be:

#### Etherscan Options

`--chain` _chain_name_
`--chain` *chain_name*
&nbsp;&nbsp;&nbsp;&nbsp;The Etherscan chain.

`--etherscan-api-key` _key_
`--etherscan-api-key` *key*
&nbsp;&nbsp;&nbsp;&nbsp;Etherscan API key, or the key of an [Etherscan configuration table](../config/etherscan#etherscan).
&nbsp;&nbsp;&nbsp;&nbsp;Environment: `ETHERSCAN_API_KEY`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ probe-calldata-decode - Decode ABI-encoded input data.

### SYNOPSIS

`probe calldata-decode` [*options*] _sig_ _calldata_
`probe calldata-decode` [*options*] *sig* *calldata*

### DESCRIPTION

Decode ABI-encoded input data.

The signature (_sig_) is a fragment in the form `<function name>(<types...>)`.
The signature (*sig*) is a fragment in the form `<function name>(<types...>)`.

### OPTIONS

Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-1/reference/probe/probe-calldata.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ probe-calldata - ABI-encode a function with arguments.

### SYNOPSIS

`probe calldata` [*options*] _sig_ [*args...*]
`probe calldata` [*options*] *sig* [*args...*]

### DESCRIPTION

ABI-encode a function with arguments.

The signature (_sig_) is a fragment in the form `<function name>(<types...>)`.
The signature (*sig*) is a fragment in the form `<function name>(<types...>)`.

### OPTIONS

Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-1/reference/probe/probe-chain-id.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Get the Ethereum [chain ID][chain-id] from the RPC endpoint we are connected to.

#### RPC Options

`--rpc-url` _url_
`--rpc-url` *url*
&nbsp;&nbsp;&nbsp;&nbsp;The RPC endpoint. Accepts a URL or an existing alias in the [rpc_endpoints] table, like `mainnet`.
&nbsp;&nbsp;&nbsp;&nbsp;Environment: `ETH_RPC_URL`

Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-1/reference/probe/probe-chain.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Get the symbolic chain name from the RPC endpoint we are connected to.

#### RPC Options

`--rpc-url` _url_
`--rpc-url` *url*
&nbsp;&nbsp;&nbsp;&nbsp;The RPC endpoint. Accepts a URL or an existing alias in the [rpc_endpoints] table, like `mainnet`.
&nbsp;&nbsp;&nbsp;&nbsp;Environment: `ETH_RPC_URL`

Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-1/reference/probe/probe-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Get the current client version.

#### RPC Options

`--rpc-url` _url_
`--rpc-url` *url*
&nbsp;&nbsp;&nbsp;&nbsp;The RPC endpoint. Accepts a URL or an existing alias in the [rpc_endpoints] table, like `mainnet`.
&nbsp;&nbsp;&nbsp;&nbsp;Environment: `ETH_RPC_URL`

Expand Down
Loading

0 comments on commit a0eca6f

Please sign in to comment.