LumeWeb
/
ethers-rs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
ethers-rs/book/SUMMARY.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

93 lines
2.7 KiB
Markdown
Raw Normal View History

docs: mdbook (#1994) * mdbook init + summary * Getting started section * intro typos * intro typos and wording * intro typos and wording * Big numbers section * Big numbers: added section titles + docs refinement * Removed index prefix from file names * Update docs/mdbook/book.toml Co-authored-by: Andrea Simeoni <> Co-authored-by: Georgios Konstantopoulos <me@gakonst.com>
2023-01-03 13:18:38 +00:00
# Summary
# Getting started
Contracts chapter (#2281)
2023-03-21 18:15:41 +00:00
- [Intro](./getting-started/intro.md)
- [Start a new project](./getting-started/start_a_new_project.md)
- [Connect to an Ethereum node](./getting-started/connect_to_an_ethereum_node.md)
docs: mdbook (#1994) * mdbook init + summary * Getting started section * intro typos * intro typos and wording * intro typos and wording * Big numbers section * Big numbers: added section titles + docs refinement * Removed index prefix from file names * Update docs/mdbook/book.toml Co-authored-by: Andrea Simeoni <> Co-authored-by: Georgios Konstantopoulos <me@gakonst.com>
2023-01-03 13:18:38 +00:00
# Reference guide
Contracts chapter (#2281)
2023-03-21 18:15:41 +00:00
Book - Providers Chapter (#2023) * started building out providers chapter for the book, updated the intro for the chapter as well as the Http section. Added advanced usage section. * Updated WS and Ipc chapter, working on usage, furthering descriptions * updated ipc section, added code snippets * updating the ws section, adding code snippet for example using the subscribe_pending_tx method * Updated the provider section to include info on the ens and _node_client fields, udpated the advanced usage section to include CallBuilder and raw_call. * added examples to ipc and ws chapters, cleared todos * added note about windows ipc named pipes * added spaces to comments * fixed comment, removed all usage of unwrap() * updated Http provider to initialize without ::<Http:: * updated the Ipc provider to initialize without setting the polling interval * Update book/providers/providers.md Co-authored-by: Georgios Konstantopoulos <me@gakonst.com>
2023-01-17 19:19:34 +00:00
- [Providers](./providers/providers.md)
ci: mdbook (#2003) * Applied same book structure as Reth * ci: [WIP] added book workflow * fix warning mdbook version different from template plugin version * ci: added deploy step * Http provider docs * IPC provider docs * RetryClient docs * WebSocket provider docs Co-authored-by: Andrea Simeoni <>
2023-01-04 10:36:31 +00:00
- [Http](./providers/http.md)
Book - Providers Chapter (#2023) * started building out providers chapter for the book, updated the intro for the chapter as well as the Http section. Added advanced usage section. * Updated WS and Ipc chapter, working on usage, furthering descriptions * updated ipc section, added code snippets * updating the ws section, adding code snippet for example using the subscribe_pending_tx method * Updated the provider section to include info on the ens and _node_client fields, udpated the advanced usage section to include CallBuilder and raw_call. * added examples to ipc and ws chapters, cleared todos * added note about windows ipc named pipes * added spaces to comments * fixed comment, removed all usage of unwrap() * updated Http provider to initialize without ::<Http:: * updated the Ipc provider to initialize without setting the polling interval * Update book/providers/providers.md Co-authored-by: Georgios Konstantopoulos <me@gakonst.com>
2023-01-17 19:19:34 +00:00
- [WebSocket](./providers/ws.md)
ci: mdbook (#2003) * Applied same book structure as Reth * ci: [WIP] added book workflow * fix warning mdbook version different from template plugin version * ci: added deploy step * Http provider docs * IPC provider docs * RetryClient docs * WebSocket provider docs Co-authored-by: Andrea Simeoni <>
2023-01-04 10:36:31 +00:00
- [IPC](./providers/ipc.md)
docs: mock-provider (#2011) * MockProvider example + mdbook reference * review: use eyre::Result Co-authored-by: Andrea Simeoni <>
2023-01-05 15:55:23 +00:00
- [Mock](./providers/mock.md)
docs: add rw/quorum provider
2023-01-04 12:11:04 +00:00
- [Quorum](./providers/quorum.md)
ci: mdbook (#2003) * Applied same book structure as Reth * ci: [WIP] added book workflow * fix warning mdbook version different from template plugin version * ci: added deploy step * Http provider docs * IPC provider docs * RetryClient docs * WebSocket provider docs Co-authored-by: Andrea Simeoni <>
2023-01-04 10:36:31 +00:00
- [Retry](./providers/retry.md)
docs: add rw/quorum provider
2023-01-04 12:11:04 +00:00
- [RW](./providers/rw.md)
docs: update providers book and examples (#2098) * fmt * add README.md * fix advanced_usage * add custom transport example and chapter * update Http * update providers examples Cargo.toml * update websockets * update ipc * update other providers * update providers index
2023-01-31 17:36:12 +00:00
- [Custom](./providers/custom.md)
Book - Providers Chapter (#2023) * started building out providers chapter for the book, updated the intro for the chapter as well as the Http section. Added advanced usage section. * Updated WS and Ipc chapter, working on usage, furthering descriptions * updated ipc section, added code snippets * updating the ws section, adding code snippet for example using the subscribe_pending_tx method * Updated the provider section to include info on the ens and _node_client fields, udpated the advanced usage section to include CallBuilder and raw_call. * added examples to ipc and ws chapters, cleared todos * added note about windows ipc named pipes * added spaces to comments * fixed comment, removed all usage of unwrap() * updated Http provider to initialize without ::<Http:: * updated the Ipc provider to initialize without setting the polling interval * Update book/providers/providers.md Co-authored-by: Georgios Konstantopoulos <me@gakonst.com>
2023-01-17 19:19:34 +00:00
- [Advanced Usage](./providers/advanced_usage.md)
Book - Middleware Chapter (#2033) * docs: added middleware intro page + diagram * docs: added middleware sections + embed examples * docs: simplified diagram * docs: added `quorum` transport to diagram * Removed duplicate style * mermaid style file in the book root dir * typo Co-authored-by: Andrea Simeoni <>
2023-01-13 18:25:32 +00:00
- [Middleware](./middleware/middleware.md)
- [Builder](./middleware/builder.md)
- [Create custom middleware](./middleware/custom.md)
- [Gas escalator](./middleware/gas-escalator.md)
- [Gas oracle](./middleware/gas-oracle.md)
- [Nonce manager](./middleware/nonce-manager.md)
- [Policy](./middleware/policy.md)
- [Signer](./middleware/signer.md)
docs: mdbook (#1994) * mdbook init + summary * Getting started section * intro typos * intro typos and wording * intro typos and wording * Big numbers section * Big numbers: added section titles + docs refinement * Removed index prefix from file names * Update docs/mdbook/book.toml Co-authored-by: Andrea Simeoni <> Co-authored-by: Georgios Konstantopoulos <me@gakonst.com>
2023-01-03 13:18:38 +00:00
- [Time lag]()
- [Transformer]()
Contracts chapter (#2281)
2023-03-21 18:15:41 +00:00
- [Contracts](./contracts/contracts.md)
- [Abigen](./contracts/abigen.md)
- [Compile](./contracts/compile.md)
- [Creating Instances](./contracts/creating-instances.md)
- [Deploy Anvil](./contracts/deploy-anvil.md)
- [Deploy from ABI and bytecode](./contracts/deploy-from-abi-and-bytecode.md)
- [Deploy Moonbeam](./contracts/doploy-moonbeam.md)
- [Events](./contracts/events.md)
- [Events with meta](./contracts/events-with-meta.md)
- [Methods](contracts/methods.md)
docs: mdbook (#1994) * mdbook init + summary * Getting started section * intro typos * intro typos and wording * intro typos and wording * Big numbers section * Big numbers: added section titles + docs refinement * Removed index prefix from file names * Update docs/mdbook/book.toml Co-authored-by: Andrea Simeoni <> Co-authored-by: Georgios Konstantopoulos <me@gakonst.com>
2023-01-03 13:18:38 +00:00
- [Events]()
- [Logs and filtering]()
- [Solidity topics]()
- [Subscriptions]()
- [Watch blocks]()
- [Subscribe events by type]()
- [Subscribe logs]()
- [Queries]()
- [Blocks]()
- [Contracts]()
- [Events]()
- [Paginated logs]()
- [UniswapV2 pair]()
- [Transactions]()
- [Transactions]()
- [Call override]()
- [Create raw transaction]()
- [Create typed transaction]()
- [Decode input]()
- [EIP-1559]()
Contracts chapter (#2281)
2023-03-21 18:15:41 +00:00
- [ENS]()
docs: mdbook (#1994) * mdbook init + summary * Getting started section * intro typos * intro typos and wording * intro typos and wording * Big numbers section * Big numbers: added section titles + docs refinement * Removed index prefix from file names * Update docs/mdbook/book.toml Co-authored-by: Andrea Simeoni <> Co-authored-by: Georgios Konstantopoulos <me@gakonst.com>
2023-01-03 13:18:38 +00:00
- [Estimate gas]()
- [Get gas price]()
- [Get gas price USD]()
- [Remove liquidity]()
- [Set gas for a transaction]()
- [Send raw transaction]()
- [Send typed transaction]()
- [Trace]()
- [Transaction receipt]()
- [Transaction status]()
- [Transfer ETH]()
- [Wallets]()
- [Address book]()
- [Mnemonic]()
- [Ledger]()
- [Local]()
- [Permit hash]()
- [Sign message]()
- [Trezor]()
- [Yubi]()
- [Big numbers](./big-numbers/intro.md)
Contracts chapter (#2281)
2023-03-21 18:15:41 +00:00
- [Comparison and equivalence](./big-numbers/comparison-and-equivalence.md)
docs: mdbook (#1994) * mdbook init + summary * Getting started section * intro typos * intro typos and wording * intro typos and wording * Big numbers section * Big numbers: added section titles + docs refinement * Removed index prefix from file names * Update docs/mdbook/book.toml Co-authored-by: Andrea Simeoni <> Co-authored-by: Georgios Konstantopoulos <me@gakonst.com>
2023-01-03 13:18:38 +00:00
- [Conversion](./big-numbers/conversion.md)
- [Creating Instances](./big-numbers/creating_instances.md)
- [Math operations](./big-numbers/math-operations.md)
- [Utilities](./big-numbers/utilities.md)
- [Anvil]()
Contracts chapter (#2281)
2023-03-21 18:15:41 +00:00
- [Boot anvil]()
- [Deploy contracts]()
- [Fork]()
- [Testing]()