diff --git a/lib/examples b/lib/examples index 15c1d3e..f223a20 160000 --- a/lib/examples +++ b/lib/examples @@ -1 +1 @@ -Subproject commit 15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1 +Subproject commit f223a201c72334216bef763331a8924636021e38 diff --git a/scripts/update.sh b/scripts/update.sh index 282fd13..1bb544c 100755 --- a/scripts/update.sh +++ b/scripts/update.sh @@ -21,6 +21,9 @@ SNIPPETS_PATH="./vocs/docs/snippets" MDX_SNIPPETS_PATH="./vocs/docs/pages/examples" # Templates path MDX_TEMPLATES_PATH="./vocs/docs/pages/templates" +# Sidebar items TS file +SIDEBAR_ITEMS_PATH="./vocs/example-items.ts" + # This script will do the following: # # 1. Update the submodules. @@ -132,6 +135,56 @@ EOF # Duplicate specific examples that symlink to other examples cp $MDX_SNIPPETS_PATH/contracts/deploy_from_contract.mdx $MDX_SNIPPETS_PATH/sol-macro/contract.mdx + # Generate sidebar items TS file + echo "Generating sidebar items at $SIDEBAR_ITEMS_PATH" + + # Header of the TS file + cat << 'EOF' > "$SIDEBAR_ITEMS_PATH" +// DO NOT EDIT THIS FILE. ANY CHANGES MADE TO THIS FILE WILL BE OVERWRITTEN. + +import { SidebarItem } from "vocs"; + +export const exampleItems: SidebarItem[] = [ +EOF + + # For each template directory (category) + for TEMPLATE_DIR in "$MDX_TEMPLATES_PATH"/*/; do + [ -d "$TEMPLATE_DIR" ] || continue + EXAMPLE_DIRNAME=$(basename "$TEMPLATE_DIR") + README_FILE="$TEMPLATE_DIR/README.mdx" + + # Skip if there's no README template yet + [ -f "$README_FILE" ] || continue + + # Generate section label + SECTION_LABEL=$(grep -m1 '^## ' "$README_FILE" | sed 's/^##[[:space:]]*//') + + # Start section block + printf " { text: '%s', collapsed: true, link: '/examples/%s/README', items: [\n" \ + "$SECTION_LABEL" "$EXAMPLE_DIRNAME" >> "$SIDEBAR_ITEMS_PATH" + + # Parse bullet list lines: - [Title](/examples/.../file) + while IFS= read -r line; do + # Require lines that start with "- [" to avoid false positives + if [[ "$line" == "- ["* ]]; then + trimmed="${line#- }" + title_part="${trimmed#\[}" + TEXT="${title_part%%]*}" + link_part="${trimmed#*](/}" + LINK="/${link_part%%)*}" + ESCAPED_TEXT=${TEXT//\'/\\\'} + printf " { text: '%s', link: '%s' },\n" \ + "$ESCAPED_TEXT" "$LINK" >> "$SIDEBAR_ITEMS_PATH" + fi + done < <(cat "$README_FILE"; echo) + + # Close section block + echo " ]}," >> "$SIDEBAR_ITEMS_PATH" + done + + # Footer of the TS file + echo "]" >> "$SIDEBAR_ITEMS_PATH" + # Match the current example files list with the updated example files list # If there are differences, print them UPDATED_EXAMPLE_FILES=$(find $SNIPPETS_PATH -type f) diff --git a/vocs/bun.lockb b/vocs/bun.lockb index d38eaff..fd3d8ad 100755 Binary files a/vocs/bun.lockb and b/vocs/bun.lockb differ diff --git a/vocs/docs/pages/examples/advanced/any_network.mdx b/vocs/docs/pages/examples/advanced/any_network.mdx index eaf56d6..347e58f 100644 --- a/vocs/docs/pages/examples/advanced/any_network.mdx +++ b/vocs/docs/pages/examples/advanced/any_network.mdx @@ -1,7 +1,7 @@ {/*DO NOT EDIT THIS FILE. IT IS GENERATED BY RUNNING `./scripts/update.sh` ANY CHANGES MADE TO THIS FILE WILL BE OVERWRITTEN EDIT OR CREATE THIS TEMPLATE INSTEAD: ./vocs/docs/pages/templates/advanced/README.mdx -LATEST UPDATE: https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1 +LATEST UPDATE: https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38 */} ## Example: `any_network` @@ -15,4 +15,4 @@ To run this example: // [!include ~/snippets/advanced/examples/any_network.rs] ``` -Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1/examples/advanced/examples/any_network.rs). +Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38/examples/advanced/examples/any_network.rs). diff --git a/vocs/docs/pages/examples/advanced/decoding_json_abi.mdx b/vocs/docs/pages/examples/advanced/decoding_json_abi.mdx index 89a67f2..fb6a8fa 100644 --- a/vocs/docs/pages/examples/advanced/decoding_json_abi.mdx +++ b/vocs/docs/pages/examples/advanced/decoding_json_abi.mdx @@ -1,7 +1,7 @@ {/*DO NOT EDIT THIS FILE. IT IS GENERATED BY RUNNING `./scripts/update.sh` ANY CHANGES MADE TO THIS FILE WILL BE OVERWRITTEN EDIT OR CREATE THIS TEMPLATE INSTEAD: ./vocs/docs/pages/templates/advanced/README.mdx -LATEST UPDATE: https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1 +LATEST UPDATE: https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38 */} ## Example: `decoding_json_abi` @@ -15,4 +15,4 @@ To run this example: // [!include ~/snippets/advanced/examples/decoding_json_abi.rs] ``` -Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1/examples/advanced/examples/decoding_json_abi.rs). +Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38/examples/advanced/examples/decoding_json_abi.rs). diff --git a/vocs/docs/pages/examples/advanced/encoding_dyn_abi.mdx b/vocs/docs/pages/examples/advanced/encoding_dyn_abi.mdx index bf8a785..192c463 100644 --- a/vocs/docs/pages/examples/advanced/encoding_dyn_abi.mdx +++ b/vocs/docs/pages/examples/advanced/encoding_dyn_abi.mdx @@ -1,7 +1,7 @@ {/*DO NOT EDIT THIS FILE. IT IS GENERATED BY RUNNING `./scripts/update.sh` ANY CHANGES MADE TO THIS FILE WILL BE OVERWRITTEN EDIT OR CREATE THIS TEMPLATE INSTEAD: ./vocs/docs/pages/templates/advanced/README.mdx -LATEST UPDATE: https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1 +LATEST UPDATE: https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38 */} ## Example: `encoding_dyn_abi` @@ -15,4 +15,4 @@ To run this example: // [!include ~/snippets/advanced/examples/encoding_dyn_abi.rs] ``` -Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1/examples/advanced/examples/encoding_dyn_abi.rs). +Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38/examples/advanced/examples/encoding_dyn_abi.rs). diff --git a/vocs/docs/pages/examples/advanced/encoding_sol_static.mdx b/vocs/docs/pages/examples/advanced/encoding_sol_static.mdx index 228e9ab..98b5747 100644 --- a/vocs/docs/pages/examples/advanced/encoding_sol_static.mdx +++ b/vocs/docs/pages/examples/advanced/encoding_sol_static.mdx @@ -1,7 +1,7 @@ {/*DO NOT EDIT THIS FILE. IT IS GENERATED BY RUNNING `./scripts/update.sh` ANY CHANGES MADE TO THIS FILE WILL BE OVERWRITTEN EDIT OR CREATE THIS TEMPLATE INSTEAD: ./vocs/docs/pages/templates/advanced/README.mdx -LATEST UPDATE: https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1 +LATEST UPDATE: https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38 */} ## Example: `encoding_sol_static` @@ -15,4 +15,4 @@ To run this example: // [!include ~/snippets/advanced/examples/encoding_sol_static.rs] ``` -Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1/examples/advanced/examples/encoding_sol_static.rs). +Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38/examples/advanced/examples/encoding_sol_static.rs). diff --git a/vocs/docs/pages/examples/advanced/foundry_fork_db.mdx b/vocs/docs/pages/examples/advanced/foundry_fork_db.mdx index f07a228..1405064 100644 --- a/vocs/docs/pages/examples/advanced/foundry_fork_db.mdx +++ b/vocs/docs/pages/examples/advanced/foundry_fork_db.mdx @@ -1,7 +1,7 @@ {/*DO NOT EDIT THIS FILE. IT IS GENERATED BY RUNNING `./scripts/update.sh` ANY CHANGES MADE TO THIS FILE WILL BE OVERWRITTEN EDIT OR CREATE THIS TEMPLATE INSTEAD: ./vocs/docs/pages/templates/advanced/README.mdx -LATEST UPDATE: https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1 +LATEST UPDATE: https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38 */} ## Example: `foundry_fork_db` @@ -15,4 +15,4 @@ To run this example: // [!include ~/snippets/advanced/examples/foundry_fork_db.rs] ``` -Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1/examples/advanced/examples/foundry_fork_db.rs). +Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38/examples/advanced/examples/foundry_fork_db.rs). diff --git a/vocs/docs/pages/examples/advanced/reth_db_provider.mdx b/vocs/docs/pages/examples/advanced/uniswap_u256_alloy_profit.mdx similarity index 53% rename from vocs/docs/pages/examples/advanced/reth_db_provider.mdx rename to vocs/docs/pages/examples/advanced/uniswap_u256_alloy_profit.mdx index 5c1ec17..e8b2df7 100644 --- a/vocs/docs/pages/examples/advanced/reth_db_provider.mdx +++ b/vocs/docs/pages/examples/advanced/uniswap_u256_alloy_profit.mdx @@ -1,18 +1,18 @@ {/*DO NOT EDIT THIS FILE. IT IS GENERATED BY RUNNING `./scripts/update.sh` ANY CHANGES MADE TO THIS FILE WILL BE OVERWRITTEN EDIT OR CREATE THIS TEMPLATE INSTEAD: ./vocs/docs/pages/templates/advanced/README.mdx -LATEST UPDATE: https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1 +LATEST UPDATE: https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38 */} -## Example: `reth_db_provider` +## Example: `uniswap_u256_alloy_profit` To run this example: - Clone the [examples](https://github.com/alloy-rs/examples) repository: `git clone git@github.com:alloy-rs/examples.git` -- Run: `cargo run --example reth_db_provider` +- Run: `cargo run --example uniswap_u256_alloy_profit` ```rust -// [!include ~/snippets/advanced/examples/reth_db_provider.rs] +// [!include ~/snippets/advanced/examples/uniswap_u256_alloy_profit.rs] ``` -Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1/examples/advanced/examples/reth_db_provider.rs). +Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38/examples/advanced/examples/uniswap_u256_alloy_profit.rs). diff --git a/vocs/docs/pages/examples/advanced/uniswap_u256_alloy_simulation.mdx b/vocs/docs/pages/examples/advanced/uniswap_u256_alloy_simulation.mdx new file mode 100644 index 0000000..c9c1a95 --- /dev/null +++ b/vocs/docs/pages/examples/advanced/uniswap_u256_alloy_simulation.mdx @@ -0,0 +1,18 @@ +{/*DO NOT EDIT THIS FILE. IT IS GENERATED BY RUNNING `./scripts/update.sh` +ANY CHANGES MADE TO THIS FILE WILL BE OVERWRITTEN +EDIT OR CREATE THIS TEMPLATE INSTEAD: ./vocs/docs/pages/templates/advanced/README.mdx +LATEST UPDATE: https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38 +*/} + +## Example: `uniswap_u256_alloy_simulation` + +To run this example: + +- Clone the [examples](https://github.com/alloy-rs/examples) repository: `git clone git@github.com:alloy-rs/examples.git` +- Run: `cargo run --example uniswap_u256_alloy_simulation` + +```rust +// [!include ~/snippets/advanced/examples/uniswap_u256_alloy_simulation.rs] +``` + +Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38/examples/advanced/examples/uniswap_u256_alloy_simulation.rs). diff --git a/vocs/docs/pages/examples/advanced/uniswap_u256_ethers_profit.mdx b/vocs/docs/pages/examples/advanced/uniswap_u256_ethers_profit.mdx new file mode 100644 index 0000000..876045b --- /dev/null +++ b/vocs/docs/pages/examples/advanced/uniswap_u256_ethers_profit.mdx @@ -0,0 +1,18 @@ +{/*DO NOT EDIT THIS FILE. IT IS GENERATED BY RUNNING `./scripts/update.sh` +ANY CHANGES MADE TO THIS FILE WILL BE OVERWRITTEN +EDIT OR CREATE THIS TEMPLATE INSTEAD: ./vocs/docs/pages/templates/advanced/README.mdx +LATEST UPDATE: https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38 +*/} + +## Example: `uniswap_u256_ethers_profit` + +To run this example: + +- Clone the [examples](https://github.com/alloy-rs/examples) repository: `git clone git@github.com:alloy-rs/examples.git` +- Run: `cargo run --example uniswap_u256_ethers_profit` + +```rust +// [!include ~/snippets/advanced/examples/uniswap_u256_ethers_profit.rs] +``` + +Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38/examples/advanced/examples/uniswap_u256_ethers_profit.rs). diff --git a/vocs/docs/pages/examples/big-numbers/comparison_equivalence.mdx b/vocs/docs/pages/examples/big-numbers/comparison_equivalence.mdx index 2e7cd67..13ec5e7 100644 --- a/vocs/docs/pages/examples/big-numbers/comparison_equivalence.mdx +++ b/vocs/docs/pages/examples/big-numbers/comparison_equivalence.mdx @@ -1,7 +1,7 @@ {/*DO NOT EDIT THIS FILE. IT IS GENERATED BY RUNNING `./scripts/update.sh` ANY CHANGES MADE TO THIS FILE WILL BE OVERWRITTEN EDIT OR CREATE THIS TEMPLATE INSTEAD: ./vocs/docs/pages/templates/big-numbers/README.mdx -LATEST UPDATE: https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1 +LATEST UPDATE: https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38 */} ## Example: `comparison_equivalence` @@ -15,4 +15,4 @@ To run this example: // [!include ~/snippets/big-numbers/examples/comparison_equivalence.rs] ``` -Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1/examples/big-numbers/examples/comparison_equivalence.rs). +Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38/examples/big-numbers/examples/comparison_equivalence.rs). diff --git a/vocs/docs/pages/examples/big-numbers/conversion.mdx b/vocs/docs/pages/examples/big-numbers/conversion.mdx index 4d7cc6e..c32b737 100644 --- a/vocs/docs/pages/examples/big-numbers/conversion.mdx +++ b/vocs/docs/pages/examples/big-numbers/conversion.mdx @@ -1,7 +1,7 @@ {/*DO NOT EDIT THIS FILE. IT IS GENERATED BY RUNNING `./scripts/update.sh` ANY CHANGES MADE TO THIS FILE WILL BE OVERWRITTEN EDIT OR CREATE THIS TEMPLATE INSTEAD: ./vocs/docs/pages/templates/big-numbers/README.mdx -LATEST UPDATE: https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1 +LATEST UPDATE: https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38 */} ## Example: `conversion` @@ -15,4 +15,4 @@ To run this example: // [!include ~/snippets/big-numbers/examples/conversion.rs] ``` -Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1/examples/big-numbers/examples/conversion.rs). +Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38/examples/big-numbers/examples/conversion.rs). diff --git a/vocs/docs/pages/examples/big-numbers/create_instances.mdx b/vocs/docs/pages/examples/big-numbers/create_instances.mdx index ceb1933..b8d42c5 100644 --- a/vocs/docs/pages/examples/big-numbers/create_instances.mdx +++ b/vocs/docs/pages/examples/big-numbers/create_instances.mdx @@ -1,7 +1,7 @@ {/*DO NOT EDIT THIS FILE. IT IS GENERATED BY RUNNING `./scripts/update.sh` ANY CHANGES MADE TO THIS FILE WILL BE OVERWRITTEN EDIT OR CREATE THIS TEMPLATE INSTEAD: ./vocs/docs/pages/templates/big-numbers/README.mdx -LATEST UPDATE: https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1 +LATEST UPDATE: https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38 */} ## Example: `create_instances` @@ -15,4 +15,4 @@ To run this example: // [!include ~/snippets/big-numbers/examples/create_instances.rs] ``` -Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1/examples/big-numbers/examples/create_instances.rs). +Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38/examples/big-numbers/examples/create_instances.rs). diff --git a/vocs/docs/pages/examples/big-numbers/math_operations.mdx b/vocs/docs/pages/examples/big-numbers/math_operations.mdx index ce184e2..a3dcdcc 100644 --- a/vocs/docs/pages/examples/big-numbers/math_operations.mdx +++ b/vocs/docs/pages/examples/big-numbers/math_operations.mdx @@ -1,7 +1,7 @@ {/*DO NOT EDIT THIS FILE. IT IS GENERATED BY RUNNING `./scripts/update.sh` ANY CHANGES MADE TO THIS FILE WILL BE OVERWRITTEN EDIT OR CREATE THIS TEMPLATE INSTEAD: ./vocs/docs/pages/templates/big-numbers/README.mdx -LATEST UPDATE: https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1 +LATEST UPDATE: https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38 */} ## Example: `math_operations` @@ -15,4 +15,4 @@ To run this example: // [!include ~/snippets/big-numbers/examples/math_operations.rs] ``` -Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1/examples/big-numbers/examples/math_operations.rs). +Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38/examples/big-numbers/examples/math_operations.rs). diff --git a/vocs/docs/pages/examples/big-numbers/math_utilities.mdx b/vocs/docs/pages/examples/big-numbers/math_utilities.mdx index 97210eb..6b3be9b 100644 --- a/vocs/docs/pages/examples/big-numbers/math_utilities.mdx +++ b/vocs/docs/pages/examples/big-numbers/math_utilities.mdx @@ -1,7 +1,7 @@ {/*DO NOT EDIT THIS FILE. IT IS GENERATED BY RUNNING `./scripts/update.sh` ANY CHANGES MADE TO THIS FILE WILL BE OVERWRITTEN EDIT OR CREATE THIS TEMPLATE INSTEAD: ./vocs/docs/pages/templates/big-numbers/README.mdx -LATEST UPDATE: https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1 +LATEST UPDATE: https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38 */} ## Example: `math_utilities` @@ -15,4 +15,4 @@ To run this example: // [!include ~/snippets/big-numbers/examples/math_utilities.rs] ``` -Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1/examples/big-numbers/examples/math_utilities.rs). +Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38/examples/big-numbers/examples/math_utilities.rs). diff --git a/vocs/docs/pages/examples/comparison/compare_new_heads.mdx b/vocs/docs/pages/examples/comparison/compare_new_heads.mdx index 8928c92..777dc9f 100644 --- a/vocs/docs/pages/examples/comparison/compare_new_heads.mdx +++ b/vocs/docs/pages/examples/comparison/compare_new_heads.mdx @@ -1,7 +1,7 @@ {/*DO NOT EDIT THIS FILE. IT IS GENERATED BY RUNNING `./scripts/update.sh` ANY CHANGES MADE TO THIS FILE WILL BE OVERWRITTEN EDIT OR CREATE THIS TEMPLATE INSTEAD: ./vocs/docs/pages/templates/comparison/README.mdx -LATEST UPDATE: https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1 +LATEST UPDATE: https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38 */} ## Example: `compare_new_heads` @@ -15,4 +15,4 @@ To run this example: // [!include ~/snippets/comparison/examples/compare_new_heads.rs] ``` -Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1/examples/comparison/examples/compare_new_heads.rs). +Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38/examples/comparison/examples/compare_new_heads.rs). diff --git a/vocs/docs/pages/examples/comparison/compare_pending_txs.mdx b/vocs/docs/pages/examples/comparison/compare_pending_txs.mdx index 5c4a62e..80ad807 100644 --- a/vocs/docs/pages/examples/comparison/compare_pending_txs.mdx +++ b/vocs/docs/pages/examples/comparison/compare_pending_txs.mdx @@ -1,7 +1,7 @@ {/*DO NOT EDIT THIS FILE. IT IS GENERATED BY RUNNING `./scripts/update.sh` ANY CHANGES MADE TO THIS FILE WILL BE OVERWRITTEN EDIT OR CREATE THIS TEMPLATE INSTEAD: ./vocs/docs/pages/templates/comparison/README.mdx -LATEST UPDATE: https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1 +LATEST UPDATE: https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38 */} ## Example: `compare_pending_txs` @@ -15,4 +15,4 @@ To run this example: // [!include ~/snippets/comparison/examples/compare_pending_txs.rs] ``` -Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1/examples/comparison/examples/compare_pending_txs.rs). +Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38/examples/comparison/examples/compare_pending_txs.rs). diff --git a/vocs/docs/pages/examples/contracts/arb_profit_calc.mdx b/vocs/docs/pages/examples/contracts/arb_profit_calc.mdx index b93bd90..31ef702 100644 --- a/vocs/docs/pages/examples/contracts/arb_profit_calc.mdx +++ b/vocs/docs/pages/examples/contracts/arb_profit_calc.mdx @@ -1,7 +1,7 @@ {/*DO NOT EDIT THIS FILE. IT IS GENERATED BY RUNNING `./scripts/update.sh` ANY CHANGES MADE TO THIS FILE WILL BE OVERWRITTEN EDIT OR CREATE THIS TEMPLATE INSTEAD: ./vocs/docs/pages/templates/contracts/README.mdx -LATEST UPDATE: https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1 +LATEST UPDATE: https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38 */} ## Example: `arb_profit_calc` @@ -15,4 +15,4 @@ To run this example: // [!include ~/snippets/contracts/examples/arb_profit_calc.rs] ``` -Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1/examples/contracts/examples/arb_profit_calc.rs). +Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38/examples/contracts/examples/arb_profit_calc.rs). diff --git a/vocs/docs/pages/examples/contracts/deploy_and_link_library.mdx b/vocs/docs/pages/examples/contracts/deploy_and_link_library.mdx index 75c4175..15e2de7 100644 --- a/vocs/docs/pages/examples/contracts/deploy_and_link_library.mdx +++ b/vocs/docs/pages/examples/contracts/deploy_and_link_library.mdx @@ -1,7 +1,7 @@ {/*DO NOT EDIT THIS FILE. IT IS GENERATED BY RUNNING `./scripts/update.sh` ANY CHANGES MADE TO THIS FILE WILL BE OVERWRITTEN EDIT OR CREATE THIS TEMPLATE INSTEAD: ./vocs/docs/pages/templates/contracts/README.mdx -LATEST UPDATE: https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1 +LATEST UPDATE: https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38 */} ## Example: `deploy_and_link_library` @@ -15,4 +15,4 @@ To run this example: // [!include ~/snippets/contracts/examples/deploy_and_link_library.rs] ``` -Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1/examples/contracts/examples/deploy_and_link_library.rs). +Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38/examples/contracts/examples/deploy_and_link_library.rs). diff --git a/vocs/docs/pages/examples/contracts/deploy_from_artifact.mdx b/vocs/docs/pages/examples/contracts/deploy_from_artifact.mdx index 72e9727..2f8c465 100644 --- a/vocs/docs/pages/examples/contracts/deploy_from_artifact.mdx +++ b/vocs/docs/pages/examples/contracts/deploy_from_artifact.mdx @@ -1,7 +1,7 @@ {/*DO NOT EDIT THIS FILE. IT IS GENERATED BY RUNNING `./scripts/update.sh` ANY CHANGES MADE TO THIS FILE WILL BE OVERWRITTEN EDIT OR CREATE THIS TEMPLATE INSTEAD: ./vocs/docs/pages/templates/contracts/README.mdx -LATEST UPDATE: https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1 +LATEST UPDATE: https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38 */} ## Example: `deploy_from_artifact` @@ -15,4 +15,4 @@ To run this example: // [!include ~/snippets/contracts/examples/deploy_from_artifact.rs] ``` -Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1/examples/contracts/examples/deploy_from_artifact.rs). +Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38/examples/contracts/examples/deploy_from_artifact.rs). diff --git a/vocs/docs/pages/examples/contracts/deploy_from_bytecode.mdx b/vocs/docs/pages/examples/contracts/deploy_from_bytecode.mdx index db4bea3..118618d 100644 --- a/vocs/docs/pages/examples/contracts/deploy_from_bytecode.mdx +++ b/vocs/docs/pages/examples/contracts/deploy_from_bytecode.mdx @@ -1,7 +1,7 @@ {/*DO NOT EDIT THIS FILE. IT IS GENERATED BY RUNNING `./scripts/update.sh` ANY CHANGES MADE TO THIS FILE WILL BE OVERWRITTEN EDIT OR CREATE THIS TEMPLATE INSTEAD: ./vocs/docs/pages/templates/contracts/README.mdx -LATEST UPDATE: https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1 +LATEST UPDATE: https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38 */} ## Example: `deploy_from_bytecode` @@ -15,4 +15,4 @@ To run this example: // [!include ~/snippets/contracts/examples/deploy_from_bytecode.rs] ``` -Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1/examples/contracts/examples/deploy_from_bytecode.rs). +Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38/examples/contracts/examples/deploy_from_bytecode.rs). diff --git a/vocs/docs/pages/examples/contracts/deploy_from_contract.mdx b/vocs/docs/pages/examples/contracts/deploy_from_contract.mdx index 7d8ea92..83cf4a9 100644 --- a/vocs/docs/pages/examples/contracts/deploy_from_contract.mdx +++ b/vocs/docs/pages/examples/contracts/deploy_from_contract.mdx @@ -1,7 +1,7 @@ {/*DO NOT EDIT THIS FILE. IT IS GENERATED BY RUNNING `./scripts/update.sh` ANY CHANGES MADE TO THIS FILE WILL BE OVERWRITTEN EDIT OR CREATE THIS TEMPLATE INSTEAD: ./vocs/docs/pages/templates/contracts/README.mdx -LATEST UPDATE: https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1 +LATEST UPDATE: https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38 */} ## Example: `deploy_from_contract` @@ -15,4 +15,4 @@ To run this example: // [!include ~/snippets/contracts/examples/deploy_from_contract.rs] ``` -Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1/examples/contracts/examples/deploy_from_contract.rs). +Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38/examples/contracts/examples/deploy_from_contract.rs). diff --git a/vocs/docs/pages/examples/contracts/helpers.mdx b/vocs/docs/pages/examples/contracts/helpers.mdx index 7088896..65d06d9 100644 --- a/vocs/docs/pages/examples/contracts/helpers.mdx +++ b/vocs/docs/pages/examples/contracts/helpers.mdx @@ -1,7 +1,7 @@ {/*DO NOT EDIT THIS FILE. IT IS GENERATED BY RUNNING `./scripts/update.sh` ANY CHANGES MADE TO THIS FILE WILL BE OVERWRITTEN EDIT OR CREATE THIS TEMPLATE INSTEAD: ./vocs/docs/pages/templates/contracts/README.mdx -LATEST UPDATE: https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1 +LATEST UPDATE: https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38 */} ## Example: `helpers` @@ -15,4 +15,4 @@ To run this example: // [!include ~/snippets/contracts/examples/helpers.rs] ``` -Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1/examples/contracts/examples/helpers.rs). +Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38/examples/contracts/examples/helpers.rs). diff --git a/vocs/docs/pages/examples/contracts/interact_with_abi.mdx b/vocs/docs/pages/examples/contracts/interact_with_abi.mdx index 27fe557..a91be73 100644 --- a/vocs/docs/pages/examples/contracts/interact_with_abi.mdx +++ b/vocs/docs/pages/examples/contracts/interact_with_abi.mdx @@ -1,7 +1,7 @@ {/*DO NOT EDIT THIS FILE. IT IS GENERATED BY RUNNING `./scripts/update.sh` ANY CHANGES MADE TO THIS FILE WILL BE OVERWRITTEN EDIT OR CREATE THIS TEMPLATE INSTEAD: ./vocs/docs/pages/templates/contracts/README.mdx -LATEST UPDATE: https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1 +LATEST UPDATE: https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38 */} ## Example: `interact_with_abi` @@ -15,4 +15,4 @@ To run this example: // [!include ~/snippets/contracts/examples/interact_with_abi.rs] ``` -Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1/examples/contracts/examples/interact_with_abi.rs). +Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38/examples/contracts/examples/interact_with_abi.rs). diff --git a/vocs/docs/pages/examples/contracts/interact_with_contract_instance.mdx b/vocs/docs/pages/examples/contracts/interact_with_contract_instance.mdx index ab0ce6f..89c99c9 100644 --- a/vocs/docs/pages/examples/contracts/interact_with_contract_instance.mdx +++ b/vocs/docs/pages/examples/contracts/interact_with_contract_instance.mdx @@ -1,7 +1,7 @@ {/*DO NOT EDIT THIS FILE. IT IS GENERATED BY RUNNING `./scripts/update.sh` ANY CHANGES MADE TO THIS FILE WILL BE OVERWRITTEN EDIT OR CREATE THIS TEMPLATE INSTEAD: ./vocs/docs/pages/templates/contracts/README.mdx -LATEST UPDATE: https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1 +LATEST UPDATE: https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38 */} ## Example: `interact_with_contract_instance` @@ -15,4 +15,4 @@ To run this example: // [!include ~/snippets/contracts/examples/interact_with_contract_instance.rs] ``` -Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1/examples/contracts/examples/interact_with_contract_instance.rs). +Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38/examples/contracts/examples/interact_with_contract_instance.rs). diff --git a/vocs/docs/pages/examples/contracts/jsonrpc_error_decoding.mdx b/vocs/docs/pages/examples/contracts/jsonrpc_error_decoding.mdx index e2d3828..d5832a5 100644 --- a/vocs/docs/pages/examples/contracts/jsonrpc_error_decoding.mdx +++ b/vocs/docs/pages/examples/contracts/jsonrpc_error_decoding.mdx @@ -1,7 +1,7 @@ {/*DO NOT EDIT THIS FILE. IT IS GENERATED BY RUNNING `./scripts/update.sh` ANY CHANGES MADE TO THIS FILE WILL BE OVERWRITTEN EDIT OR CREATE THIS TEMPLATE INSTEAD: ./vocs/docs/pages/templates/contracts/README.mdx -LATEST UPDATE: https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1 +LATEST UPDATE: https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38 */} ## Example: `jsonrpc_error_decoding` @@ -15,4 +15,4 @@ To run this example: // [!include ~/snippets/contracts/examples/jsonrpc_error_decoding.rs] ``` -Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1/examples/contracts/examples/jsonrpc_error_decoding.rs). +Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38/examples/contracts/examples/jsonrpc_error_decoding.rs). diff --git a/vocs/docs/pages/examples/contracts/revert_decoding.mdx b/vocs/docs/pages/examples/contracts/revert_decoding.mdx index d85559c..6ed4c19 100644 --- a/vocs/docs/pages/examples/contracts/revert_decoding.mdx +++ b/vocs/docs/pages/examples/contracts/revert_decoding.mdx @@ -1,7 +1,7 @@ {/*DO NOT EDIT THIS FILE. IT IS GENERATED BY RUNNING `./scripts/update.sh` ANY CHANGES MADE TO THIS FILE WILL BE OVERWRITTEN EDIT OR CREATE THIS TEMPLATE INSTEAD: ./vocs/docs/pages/templates/contracts/README.mdx -LATEST UPDATE: https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1 +LATEST UPDATE: https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38 */} ## Example: `revert_decoding` @@ -15,4 +15,4 @@ To run this example: // [!include ~/snippets/contracts/examples/revert_decoding.rs] ``` -Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1/examples/contracts/examples/revert_decoding.rs). +Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38/examples/contracts/examples/revert_decoding.rs). diff --git a/vocs/docs/pages/examples/contracts/simulation_uni_v2.mdx b/vocs/docs/pages/examples/contracts/simulation_uni_v2.mdx index 073d2ff..7447ee7 100644 --- a/vocs/docs/pages/examples/contracts/simulation_uni_v2.mdx +++ b/vocs/docs/pages/examples/contracts/simulation_uni_v2.mdx @@ -1,7 +1,7 @@ {/*DO NOT EDIT THIS FILE. IT IS GENERATED BY RUNNING `./scripts/update.sh` ANY CHANGES MADE TO THIS FILE WILL BE OVERWRITTEN EDIT OR CREATE THIS TEMPLATE INSTEAD: ./vocs/docs/pages/templates/contracts/README.mdx -LATEST UPDATE: https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1 +LATEST UPDATE: https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38 */} ## Example: `simulation_uni_v2` @@ -15,4 +15,4 @@ To run this example: // [!include ~/snippets/contracts/examples/simulation_uni_v2.rs] ``` -Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1/examples/contracts/examples/simulation_uni_v2.rs). +Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38/examples/contracts/examples/simulation_uni_v2.rs). diff --git a/vocs/docs/pages/examples/contracts/unknown_return_types.mdx b/vocs/docs/pages/examples/contracts/unknown_return_types.mdx index bba39d2..593e697 100644 --- a/vocs/docs/pages/examples/contracts/unknown_return_types.mdx +++ b/vocs/docs/pages/examples/contracts/unknown_return_types.mdx @@ -1,7 +1,7 @@ {/*DO NOT EDIT THIS FILE. IT IS GENERATED BY RUNNING `./scripts/update.sh` ANY CHANGES MADE TO THIS FILE WILL BE OVERWRITTEN EDIT OR CREATE THIS TEMPLATE INSTEAD: ./vocs/docs/pages/templates/contracts/README.mdx -LATEST UPDATE: https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1 +LATEST UPDATE: https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38 */} ## Example: `unknown_return_types` @@ -15,4 +15,4 @@ To run this example: // [!include ~/snippets/contracts/examples/unknown_return_types.rs] ``` -Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/15c1d3e6e758d6a9dfe747200b5c8d12f5a027f1/examples/contracts/examples/unknown_return_types.rs). +Find the source code on Github [here](https://github.com/alloy-rs/examples/tree/f223a201c72334216bef763331a8924636021e38/examples/contracts/examples/unknown_return_types.rs). diff --git a/vocs/docs/pages/examples/ens/README.mdx b/vocs/docs/pages/examples/ens/README.mdx new file mode 100644 index 0000000..55f3f6b --- /dev/null +++ b/vocs/docs/pages/examples/ens/README.mdx @@ -0,0 +1,3 @@ +import Template from '../../templates/ens/README.mdx' + +