Skip to content

Commit

Permalink
Change outdated links to openchain.xyz for signatures (#1362)
Browse files Browse the repository at this point in the history
  • Loading branch information
velvet-shark authored Nov 21, 2024
1 parent 842ab80 commit 4d4c5be
Show file tree
Hide file tree
Showing 8 changed files with 67 additions and 65 deletions.
16 changes: 8 additions & 8 deletions src/reference/cast/cast-4byte-decode.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,34 +2,34 @@

### NAME

cast-4byte-decode - Decode ABI-encoded calldata using <https://sig.eth.samczsun.com>.
cast-4byte-decode - Decode ABI-encoded calldata using <https://openchain.xyz/signatures>.

### SYNOPSIS

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

### DESCRIPTION

Decode ABI-encoded calldata using <https://sig.eth.samczsun.com>.
Decode ABI-encoded calldata using <https://openchain.xyz/signatures>.

### OPTIONS

#### 4byte Options

`--id` *id*
`--id` _id_
&nbsp;&nbsp;&nbsp;&nbsp;The index of the resolved signature to use.
&nbsp;&nbsp;&nbsp;&nbsp;
&nbsp;&nbsp;&nbsp;&nbsp;<https://sig.eth.samczsun.com> can have multiple possible signatures for a given selector.
&nbsp;&nbsp;&nbsp;&nbsp;<https://openchain.xyz/signatures> can have multiple possible signatures for a given selector.
&nbsp;&nbsp;&nbsp;&nbsp;The index can be an integer, or the tags "earliest" and "latest".

{{#include common-options.md}}

### EXAMPLES

1. Decode calldata for a `transfer` call:
```sh
cast 4byte-decode 0xa9059cbb000000000000000000000000e78388b4ce79068e89bf8aa7f218ef6b9ab0e9d00000000000000000000000000000000000000000000000000174b37380cea000
```
```sh
cast 4byte-decode 0xa9059cbb000000000000000000000000e78388b4ce79068e89bf8aa7f218ef6b9ab0e9d00000000000000000000000000000000000000000000000000174b37380cea000
```

### SEE ALSO

Expand Down
12 changes: 6 additions & 6 deletions src/reference/cast/cast-4byte-event.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

### NAME

cast-4byte-event - Get the event signature for a given topic 0 from <https://sig.eth.samczsun.com>.
cast-4byte-event - Get the event signature for a given topic 0 from <https://openchain.xyz/signatures>.

### SYNOPSIS

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

### DESCRIPTION

Get the event signature for a given topic 0 from <https://sig.eth.samczsun.com>.
Get the event signature for a given topic 0 from <https://openchain.xyz/signatures>.

### OPTIONS

Expand All @@ -19,9 +19,9 @@ Get the event signature for a given topic 0 from <https://sig.eth.samczsun.com>.
### EXAMPLES

1. Get the event signature for a topic 0 of `0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef`:
```sh
cast 4byte-event 0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef
```
```sh
cast 4byte-event 0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef
```

### SEE ALSO

Expand Down
12 changes: 6 additions & 6 deletions src/reference/cast/cast-4byte.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

### NAME

cast-4byte - Get the function signatures for the given selector from <https://sig.eth.samczsun.com>.
cast-4byte - Get the function signatures for the given selector from <https://openchain.xyz/signatures>.

### SYNOPSIS

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

### DESCRIPTION

Get the function signatures for the given selector from <https://sig.eth.samczsun.com>.
Get the function signatures for the given selector from <https://openchain.xyz/signatures>.

### OPTIONS

Expand All @@ -19,9 +19,9 @@ Get the function signatures for the given selector from <https://sig.eth.samczsu
### EXAMPLES

1. Get the function signature for the selector `0x8cc5ce99`:
```sh
cast 4byte 0x8cc5ce99
```
```sh
cast 4byte 0x8cc5ce99
```

### SEE ALSO

Expand Down
12 changes: 6 additions & 6 deletions src/reference/cast/cast-pretty-calldata.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,30 +6,30 @@ cast-pretty-calldata - Pretty print calldata.

### SYNOPSIS

``cast pretty-calldata`` [*options*] *calldata*
`cast pretty-calldata` [*options*] _calldata_

### DESCRIPTION

Pretty print calldata.

Tries to decode the calldata using <https://sig.eth.samczsun.com> unless `--offline` is passed.
Tries to decode the calldata using <https://openchain.xyz/signatures> unless `--offline` is passed.

### OPTIONS

#### 4byte Options

`-o`
`--offline`
&nbsp;&nbsp;&nbsp;&nbsp;Skip the <https://sig.eth.samczsun.com> lookup.
&nbsp;&nbsp;&nbsp;&nbsp;Skip the <https://openchain.xyz/signatures> lookup.

{{#include common-options.md}}

### EXAMPLES

1. Decode calldata for a `transfer` call:
```sh
cast pretty-calldata 0xa9059cbb000000000000000000000000e78388b4ce79068e89bf8aa7f218ef6b9ab0e9d00000000000000000000000000000000000000000000000000174b37380cea000
```
```sh
cast pretty-calldata 0xa9059cbb000000000000000000000000e78388b4ce79068e89bf8aa7f218ef6b9ab0e9d00000000000000000000000000000000000000000000000000174b37380cea000
```

### SEE ALSO

Expand Down
8 changes: 4 additions & 4 deletions src/reference/cast/cast-upload-signature.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ cast-upload-signature

### DESCRIPTION

Upload the given signatures to [https://sig.eth.samczsun.com](https://sig.eth.samczsun.com).
Upload the given signatures to [https://openchain.xyz/signatures](https://openchain.xyz/signatures).

### OPTIONS

Expand All @@ -19,7 +19,7 @@ Upload the given signatures to [https://sig.eth.samczsun.com](https://sig.eth.sa
### EXAMPLES

1. Upload signatures
```sh
cast upload-signature 'function approve(address,uint256)' \
```sh
cast upload-signature 'function approve(address,uint256)' \
'transfer(uint256)' 'event Transfer(uint256,address)'
```
```
32 changes: 16 additions & 16 deletions src/reference/cast/cast.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ cast - Perform Ethereum RPC calls from the comfort of your command line.

### SYNOPSIS

`cast` [*options*] *command* [*args*]
`cast` [*options*] _command_ [*args*]
`cast` [*options*] `--version`
`cast` [*options*] `--help`

Expand Down Expand Up @@ -132,13 +132,13 @@ This program is a set of tools to interact with Ethereum and perform conversions
&nbsp;&nbsp;&nbsp;&nbsp;ABI encode the given function arguments, excluding the selector.

[cast 4byte](./cast-4byte.md)
&nbsp;&nbsp;&nbsp;&nbsp;Get the function signatures for the given selector from <https://sig.eth.samczsun.com>.
&nbsp;&nbsp;&nbsp;&nbsp;Get the function signatures for the given selector from <https://openchain.xyz/signatures>.

[cast 4byte-decode](./cast-4byte-decode.md)
&nbsp;&nbsp;&nbsp;&nbsp;Decode ABI-encoded calldata using <https://sig.eth.samczsun.com>.
&nbsp;&nbsp;&nbsp;&nbsp;Decode ABI-encoded calldata using <https://openchain.xyz/signatures>.

[cast 4byte-event](./cast-4byte-event.md)
&nbsp;&nbsp;&nbsp;&nbsp;Get the event signature for a given topic 0 from <https://sig.eth.samczsun.com>.
&nbsp;&nbsp;&nbsp;&nbsp;Get the event signature for a given topic 0 from <https://openchain.xyz/signatures>.

[cast calldata](./cast-calldata.md)
&nbsp;&nbsp;&nbsp;&nbsp;ABI-encode a function with arguments.
Expand All @@ -153,7 +153,7 @@ This program is a set of tools to interact with Ethereum and perform conversions
&nbsp;&nbsp;&nbsp;&nbsp;Extracts function selectors and arguments from bytecode

[cast upload-signature](./cast-upload-signature.md)
&nbsp;&nbsp;&nbsp;&nbsp;Upload the given signatures to https://sig.eth.samczsun.com.
&nbsp;&nbsp;&nbsp;&nbsp;Upload the given signatures to https://openchain.xyz/signatures.

#### Conversion Commands

Expand Down Expand Up @@ -295,22 +295,22 @@ This program is a set of tools to interact with Ethereum and perform conversions

1. Call a function on a contract:

```sh
cast call 0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2 \
"balanceOf(address)(uint256)" 0x...
```
```sh
cast call 0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2 \
"balanceOf(address)(uint256)" 0x...
```

2. Decode raw calldata:

```sh
cast calldata-decode "transfer(address,uint256)" \
0xa9059cbb000000000000000000000000e78388b4ce79068e89bf8aa7f218ef6b9ab0e9d0000000000000000000000000000000000000000000000000008a8e4b1a3d8000
```
```sh
cast calldata-decode "transfer(address,uint256)" \
0xa9059cbb000000000000000000000000e78388b4ce79068e89bf8aa7f218ef6b9ab0e9d0000000000000000000000000000000000000000000000000008a8e4b1a3d8000
```

3. Encode calldata:
```sh
cast calldata "someFunc(address,uint256)" 0x... 1
```
```sh
cast calldata "someFunc(address,uint256)" 0x... 1
```

### BUGS

Expand Down
12 changes: 6 additions & 6 deletions src/reference/forge/forge-upload-selectors.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

### NAME

forge-upload-selectors - Uploads abi of given contract to https://sig.eth.samczsun.com function selector database.
forge-upload-selectors - Uploads abi of given contract to https://openchain.xyz/signatures function selector database.

### SYNOPSIS

``forge upload-selectors`` [*options*] *contract*
`forge upload-selectors` [*options*] _contract_

### DESCRIPTION

Uploads abi of given contract to https://sig.eth.samczsun.com function selector database.
Uploads abi of given contract to https://openchain.xyz/signatures function selector database.

### OPTIONS

Expand All @@ -21,6 +21,6 @@ Uploads abi of given contract to https://sig.eth.samczsun.com function selector
### EXAMPLES

1. Upload ABI to selector database
```sh
forge upload-selectors LinearVestingVault
```
```sh
forge upload-selectors LinearVestingVault
```
28 changes: 15 additions & 13 deletions src/reference/forge/forge.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ forge - Build, test, fuzz, debug and deploy Solidity contracts.

### SYNOPSIS

`forge` [*options*] *command* [*args*]
`forge` [*options*] _command_ [*args*]
`forge` [*options*] `--version`
`forge` [*options*] `--help`

Expand Down Expand Up @@ -101,16 +101,16 @@ This program is a set of tools to build, test, fuzz, debug and deploy Solidity s
&nbsp;&nbsp;&nbsp;&nbsp;Manage the Foundry cache.

[forge cache clean](./forge-cache-clean.md)
&nbsp;&nbsp;&nbsp;&nbsp;Cleans cached data from ``~/.foundry``.
&nbsp;&nbsp;&nbsp;&nbsp;Cleans cached data from `~/.foundry`.

[forge cache ls](./forge-cache-ls.md)
&nbsp;&nbsp;&nbsp;&nbsp;Shows cached data from ``~/.foundry``.
&nbsp;&nbsp;&nbsp;&nbsp;Shows cached data from `~/.foundry`.

[forge script](./forge-script.md)
&nbsp;&nbsp;&nbsp;&nbsp;Run a smart contract as a script, building transactions that can be sent onchain.

[forge upload-selectors](./forge-upload-selectors.md)
&nbsp;&nbsp;&nbsp;&nbsp;Uploads abi of given contract to https://sig.eth.samczsun.com function selector database.
&nbsp;&nbsp;&nbsp;&nbsp;Uploads abi of given contract to https://openchain.xyz/signatures function selector database.

[forge doc](./forge-doc.md)
&nbsp;&nbsp;&nbsp;&nbsp;Generate documentation for Solidity source files.
Expand Down Expand Up @@ -145,19 +145,21 @@ This program is a set of tools to build, test, fuzz, debug and deploy Solidity s
### EXAMPLES

1. Create a new Forge project:
```sh
forge init hello_foundry
```

```sh
forge init hello_foundry
```

2. Build a project:
```sh
forge build
```

```sh
forge build
```

3. Run a project's tests:
```sh
forge test
```
```sh
forge test
```
### BUGS
Expand Down

0 comments on commit 4d4c5be

Please sign in to comment.