diff --git a/docs/Concepts/Client-Libraries.md b/docs/Concepts/Client-Libraries.md index 76959cb202a..f288ab889d0 100644 --- a/docs/Concepts/Client-Libraries.md +++ b/docs/Concepts/Client-Libraries.md @@ -9,7 +9,7 @@ Dapps use client libraries, such as [web3.js](https://github.com/ethereum/web3.j forward JSON-RPC requests to Hyperledger Besu. Any client library implementing core Ethereum RPC methods works with Besu. -Use the [web3.js-eea library](../HowTo/Interact/Client-Libraries/eeajs.md) with Besu for +Use the [web3js-eea library](../HowTo/Interact/Client-Libraries/web3js-eea.md) with Besu for [privacy features](../Concepts/Privacy/Privacy-Overview.md). ![Client Libraries](../images/Hyperledger-Besu-Client-Libraries.png) diff --git a/docs/HowTo/Interact/Client-Libraries/eeajs.md b/docs/HowTo/Interact/Client-Libraries/web3js-eea.md similarity index 81% rename from docs/HowTo/Interact/Client-Libraries/eeajs.md rename to docs/HowTo/Interact/Client-Libraries/web3js-eea.md index 4008775b091..dc4cc6171d5 100644 --- a/docs/HowTo/Interact/Client-Libraries/eeajs.md +++ b/docs/HowTo/Interact/Client-Libraries/web3js-eea.md @@ -1,21 +1,21 @@ --- -description: web3.js-eea client library +description: web3js-eea client library --- -# web3.js-eea client library +# web3js-eea client library -The [web3.js-eea library](https://github.com/PegaSysEng/eeajs) adds a property to your web3 +The [web3js-eea library](https://github.com/PegaSysEng/web3js-eea) adds a property to your web3 instance by extending [web3](https://github.com/ethereum/web3.js/). Use the library to create and send RLP-encoded transactions using JSON-RPC. !!! note - web3.js-eea supports JSON-RPC over HTTP only. + web3js-eea supports JSON-RPC over HTTP only. ## Prerequisites * [Node.js (version > 10)](https://nodejs.org/en/download/) -## Add web3.js-eea to project +## Add web3js-eea to project ```bash npm install web3-eea @@ -63,7 +63,7 @@ contract binary. `web3.eea.sendRawTransaction(contractOptions)` returns the transaction hash. To get the private transaction receipt, use `web3.eea.getTransactionReceipt(txHash)`. -## web3.js-eea methods +## web3js-eea methods -For more information about the web3.js-eea methods, see the -[web3.js-eea reference documentation](../../../Reference/web3js-eea-Methods.md). +For more information about the web3js-eea methods, see the +[web3js-eea reference documentation](../../../Reference/web3js-eea-Methods.md). diff --git a/docs/HowTo/Send-Transactions/Creating-Sending-Private-Transactions.md b/docs/HowTo/Send-Transactions/Creating-Sending-Private-Transactions.md index 770f49b5602..fcb8d8dea11 100644 --- a/docs/HowTo/Send-Transactions/Creating-Sending-Private-Transactions.md +++ b/docs/HowTo/Send-Transactions/Creating-Sending-Private-Transactions.md @@ -6,7 +6,7 @@ description: Creating and sending private transactions with Hyperledger Besu Create and send [private transactions](../../Concepts/Privacy/Privacy-Overview.md) using: -* [web3.js-eea client library](../Interact/Client-Libraries/eeajs.md) or +* [web3js-eea client library](../Interact/Client-Libraries/web3js-eea.md) or [web3j client library](https://github.com/web3j/web3j) * [`eea_sendTransaction` with EthSigner](https://docs.ethsigner.pegasys.tech/en/latest/Using-EthSigner/Using-EthSigner/) * [`eea_sendRawTransaction`](#eea_sendrawtransaction) @@ -164,7 +164,7 @@ private transactions to create a contract. !!! tip The `example` directory in the - [web3.js-eea client library](../Interact/Client-Libraries/eeajs.md) contains examples of + [web3js-eea client library](../Interact/Client-Libraries/web3js-eea.md) contains examples of signing and encoding private transactions. diff --git a/docs/Reference/web3js-eea-Methods.md b/docs/Reference/web3js-eea-Methods.md index e93773060a6..e8bbc52ae68 100644 --- a/docs/Reference/web3js-eea-Methods.md +++ b/docs/Reference/web3js-eea-Methods.md @@ -4,7 +4,7 @@ description: web3js-eea methods reference # web3js-eea -Use the [web3.js-eea library](https://github.com/PegaSysEng/eeajs) to +Use the [web3js-eea library](https://github.com/PegaSysEng/web3js-eea) to [create and send private transactions]. ## Options parameter diff --git a/docs/Tutorials/Examples/Privacy-Example.md b/docs/Tutorials/Examples/Privacy-Example.md index c23f101b2f1..eeeefc983ee 100644 --- a/docs/Tutorials/Examples/Privacy-Example.md +++ b/docs/Tutorials/Examples/Privacy-Example.md @@ -12,7 +12,7 @@ You can use the [Block Explorer](Private-Network-Example.md#block-explorer), mak [JSON-RPC requests](Private-Network-Example.md#run-json-rpc-requests), and [create transactions using Metamask] as described in the [private network example](Private-Network-Example.md). This tutorial describes how to use the -examples provided in the EEAJS library to +examples provided in the web3js-eea library to [create and send private transactions](#send-private-transactions-and-read-values). !!! important @@ -48,15 +48,15 @@ git clone https://github.com/PegaSysEng/besu-sample-networks.git To use a specific version of Hyperledger Besu, set the `BESU_VERSION` environment variable. -## Clone EEAJS libraries +## Clone web3js-eea libraries -Clone the `PegaSysEng/eeajs` library: +Clone the `PegaSysEng/web3js-eea` library: ```bash -git clone https://github.com/PegaSysEng/eeajs.git +git clone https://github.com/PegaSysEng/web3js-eea.git ``` -In the `eeajs` directory: +In the `web3js-eea` directory: ```bash npm install @@ -102,7 +102,7 @@ Web block explorer address : http://localhost:25000 * The Event Emitter script deploys a contract with a privacy group of Node1 and Node2. That is, the other nodes cannot access the contract. After deploying the contract, Event Emitter stores a value. -In the `eeajs` directory, run `eventEmitter.js`: +In the `web3js-eea` directory, run `eventEmitter.js`: ```bash node example/eventEmitter.js diff --git a/docs/Tutorials/Privacy/eeajs-Multinode-example.md b/docs/Tutorials/Privacy/web3js-eea-Multinode-example.md similarity index 94% rename from docs/Tutorials/Privacy/eeajs-Multinode-example.md rename to docs/Tutorials/Privacy/web3js-eea-Multinode-example.md index cd9934623ee..fe4fa505b5d 100644 --- a/docs/Tutorials/Privacy/eeajs-Multinode-example.md +++ b/docs/Tutorials/Privacy/web3js-eea-Multinode-example.md @@ -1,19 +1,19 @@ --- -description: web3.js-eea client library multinode example +description: web3js-eea client library multinode example --- -# Use the multinode example in the web3.js-eea client library +# Use the multinode example in the web3js-eea client library -To use the examples provided in the EEA JS library with +To use the examples provided in the web3js-eea library with [your privacy network](Configuring-Privacy.md): -1. Clone the **PegaSysEng/eeajs** repository: +1. Clone the **PegaSysEng/web3js-eea** repository: ```bash git clone https://github.com/PegaSysEng/web3js-eea ``` -1. In the `eeajs` directory: +1. In the `web3js-eea` directory: ```bash npm install diff --git a/mkdocs.yml b/mkdocs.yml index 7d215f58458..3e247189183 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -82,7 +82,7 @@ nav: - Use GraphQL over HTTP: HowTo/Interact/APIs/GraphQL.md - Authenticate JSON-RPC Requests: HowTo/Interact/APIs/Authentication.md - Client Libraries: - - Use the web3.js-eea Client Library: HowTo/Interact/Client-Libraries/eeajs.md + - Use the web3js-eea Client Library: HowTo/Interact/Client-Libraries/web3js-eea.md - Filters: - Access Logs Using JSON-RPC API: HowTo/Interact/Filters/Accessing-Logs-Using-JSON-RPC.md - Find and Connect to Peers: @@ -144,7 +144,7 @@ nav: - Privacy: - Create a Privacy-Enabled Network: Tutorials/Privacy/Configuring-Privacy.md - Configure a Multi-Tenant Network: Tutorials/Privacy/Configuring-Multi-Tenancy.md - - Use web3.js-eea Multinode Example: Tutorials/Privacy/eeajs-Multinode-example.md + - Use web3js-eea Multinode Example: Tutorials/Privacy/web3js-eea-Multinode-example.md - Concepts: - Architecture: Concepts/ArchitectureOverview.md - Consensus Protocols: @@ -183,7 +183,7 @@ nav: - Besu API Methods: Reference/API-Methods.md - Besu API Objects: Reference/API-Objects.md - Genesis File Items: Reference/Config-Items.md - - web3.js-eaa Methods: Reference/web3js-eea-Methods.md + - web3js-eaa Methods: Reference/web3js-eea-Methods.md - Plugin API Interfaces: Reference/Plugin-API-Interfaces.md - Accounts for Testing: Reference/Accounts-for-Testing.md - Security Disclosure Policy: Reference/Responsible-Disclosure.md