From 98f6426dd1188ad006a8824612c8ee9caf422595 Mon Sep 17 00:00:00 2001 From: Wyatt Barnes Date: Wed, 17 Mar 2021 18:17:22 -0500 Subject: [PATCH] Debugging failing tests (#3959) * Remote node provider edits * remote node provider documentation edits Co-authored-by: smudgil <38195323+smudgil@users.noreply.github.com> --- CHANGELOG.md | 1 + docs/include_package-core.rst | 12 +++++++++++- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3ca2672dbb0..9e7919e050a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -356,6 +356,7 @@ Released with 1.0.0-beta.37 code base. ### Added - Github action for running tests for `web3-eth2-core` and `web3-eth2-beaconchain` packages (#3892) +- Added description to documentation on how to connect using a remote node provider (#3884) - Added Security risk warning to docs for `web3.utils.soliditySha3` (#3908) - `.nvmrc` file using Node.js version `v.14.15.1` (#3817) diff --git a/docs/include_package-core.rst b/docs/include_package-core.rst index 9cc0e9bc8c1..6d7225ca653 100644 --- a/docs/include_package-core.rst +++ b/docs/include_package-core.rst @@ -29,7 +29,7 @@ Returns ``Boolean`` ------- -Example +Example: Local Geth Node ------- .. code-block:: javascript @@ -52,6 +52,16 @@ Example // on windows the path is: "\\\\.\\pipe\\geth.ipc" // on linux the path is: "/users/myuser/.ethereum/geth.ipc" +------- +Example: Remote Node Provider +------- + +.. code-block:: javascript + + // Using a remote node provider, like Alchemy (https://www.alchemyapi.io/supernode), is simple. + var Web3 = require('web3'); + var web3 = new Web3("https://eth-mainnet.alchemyapi.io/v2/your-api-key"); + ------------------------------------------------------------------------------