Commit Graph

9 Commits

Author SHA1 Message Date
Waylon Jepsen 0356db1fae
Contracts chapter (#2281) 2023-03-21 11:15:41 -07:00
DaniPopes 319b86a643
chore: replace rpc urls with generic ones (#2199) 2023-02-27 15:16:33 -07:00
DaniPopes b0ef6ee9a2
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 09:36:12 -08:00
0xKitsune eaaa01a7d6
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 11:19:34 -08:00
Andrea Simeoni 08f8e8771a
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 10:25:32 -08:00
m0ham3dx b5eddf1985
mx - CI - mdbook addons - admonition(callouts) and mermaid (code driven diagrams) with example implementation (#2025)
* P1 (#1)

* CI trigger test with changes

* CI trigger test with changes - type fix

* Post Trigger Rendering Test

* remove actions triggers on P1 branch used during testing

* mx - P1 Prep PR - with configured md-admonition and md-mermaid   (#2)

* CI trigger test with changes

* CI trigger test with changes - type fix

* Post Trigger Rendering Test

* remove actions triggers on P1 branch used during testing

* Add example callouts (admonitions) and mermaid diagram in intro.md

* Update book/getting-started/intro.md

Co-authored-by: Georgios Konstantopoulos <me@gakonst.com>
2023-01-08 04:29:16 +02:00
Andrea Simeoni 7e6c3ba983
docs: mock-provider (#2011)
* MockProvider example + mdbook reference

* review: use eyre::Result

Co-authored-by: Andrea Simeoni <>
2023-01-05 17:55:23 +02:00
Georgios Konstantopoulos 578b1c4d2d docs: add rw/quorum provider 2023-01-04 14:11:04 +02:00
Andrea Simeoni da0363918b
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 12:36:31 +02:00