Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Book - Providers Chapter #2023

Merged
merged 13 commits into from
Jan 17, 2023
Merged

Book - Providers Chapter #2023

merged 13 commits into from
Jan 17, 2023

Conversation

0xKitsune
Copy link
Collaborator

I am building out the Providers chapter for the book and I am opening up a draft PR as I continue development. Feel free to add any recommendations for information to add as I continue to build out the chapter further.

…o for the chapter as well as the Http section. Added advanced usage section.
@0xKitsune 0xKitsune marked this pull request as draft January 7, 2023 06:23
Copy link
Owner

@gakonst gakonst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

absolutely love it - let's keep running at it / clear the TODOs and I feel good w/ merging & iterating

@0xKitsune
Copy link
Collaborator Author

absolutely love it - let's keep running at it / clear the TODOs and I feel good w/ merging & iterating

Sounds good, I will update the chapter and address the TODOs so everything can get merged in.

@0xKitsune
Copy link
Collaborator Author

I just pushed an update clearing all of the TODOs as well as adding some new examples to the Ws section. Additionally I added some information to the Advanced Usage section, detailing how to use CallBuilder and the state override set.

@@ -1,5 +1,82 @@
# IPC provider
The IPC (Inter-Process Communication) transport is a way for a process to communicate with a running Ethereum client over a local Unix domain socket. If you are new to IPC, you can [follow this link to learn more](https://en.wikipedia.org/wiki/Inter-process_communication). Using the IPC transport allows the ethers library to send JSON-RPC requests to the Ethereum client and receive responses, without the need for a network connection or HTTP server. This can be useful for interacting with a local Ethereum node that is running on the same machine. Using Ipc [is faster than RPC](https://github.com/0xKitsune/geth-ipc-rpc-bench), however you will need to have a local node that you can connect to.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you also add a note on Windows IPC (Named pipes), recently added in #1976?
The only API difference is the path: \\<machine_address>\pipe\<pipe_name>, for a local geth: \\.\pipe\geth
Thanks ^^

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No problem, will add this in shortly.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just added a note about IPC on windows in the most recent push, let me know if you think there should be any changes.

book/providers/http.md Outdated Show resolved Hide resolved
book/providers/http.md Outdated Show resolved Hide resolved
book/providers/ipc.md Outdated Show resolved Hide resolved
book/providers/providers.md Outdated Show resolved Hide resolved
@gakonst gakonst marked this pull request as ready for review January 17, 2023 19:19
@gakonst gakonst merged commit eaaa01a into master Jan 17, 2023
@gakonst gakonst deleted the 0xKitsune/book-providers branch January 17, 2023 19:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants