docs: Replicates changes made to Infura tutorials

MetaMask · Aug 1, 2024 · 168b879 · 168b879
1 parent c56eaf5
commit 168b879
Show file tree

Hide file tree

Showing 2 changed files with 171 additions and 101 deletions.
diff --git a/services/tutorials/ethereum/send-a-transaction/send-a-transaction-ethers.md b/services/tutorials/ethereum/send-a-transaction/send-a-transaction-ethers.md
@@ -2,14 +2,17 @@
 description: Send a transaction using Ethers.
 ---
 
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
 # Use ethers.js
 
-Send a regular transaction from one account to another with the [`ethers.js`](https://docs.ethers.io/v5/) JavaScript library.
+In this tutorial, you'll send a transaction of 0.001 ETH from one account to another using the [`ethers.js`](https://docs.ethers.io/v5/) JavaScript library.
 
 ## Prerequisites
 
-- [Node.js](https://nodejs.org/en/download/).
-- An Ethereum account containing some [Sepolia test ETH](https://www.infura.io/faucet).
+- [Node.js](https://nodejs.org/en/download/)
+- An Ethereum account
 
 :::info
 
@@ -19,94 +22,135 @@ Use [MetaMask](https://metamask.io) or similar to create an Ethereum account for
 
 ## Steps
 
-### 1. Create a project directory
+### 1. Select your network and verify funds
+
+<Tabs>
+  <TabItem value="View" label="Sepolia" default>
+
+Verify that your wallet has testnet ETH for the Sepolia network. You may use the [Infura faucet](https://www.infura.io/faucet) to top up. 
+
+</TabItem>
+<TabItem value="Retrieve" label="Alternative network" default>
+
+To use an alternative network:
+- Update your [environment file](#4-create-the-env-file) with the alternative network name 
+- Have testnet ETH for that network
+</TabItem>
+</Tabs>
+
+### 2. Create a project directory
 
-Create a new directory:
+Create a new directory for your project. This can be done from the command line:
 
 ```bash
 mkdir infura
 ```
 
-`cd` into the directory:
+Change into the new directory:
 
 ```bash
 cd infura
 ```
 
-### 2. install the dependencies
+### 3. Install required packages
+
+Install the `ethers` and `dotenv` packages in the project directory.
+
+:::info
+
+The [`dotenv`](../../developer-tools/javascript-dotenv.md) package allows you to use a `.env` file to securely store private environment variables on your local machine.
+
+:::
+
+Install the `ethers` package:
+
 
 ```bash
 npm install --save ethers
 ```
 
-### 3. Create a .env file
+Install the `dotenv` package:
+
+```
+npm install dotenv --save
+```
+
+### 4. Create the `.env` file
 
 Create a `.env` file in your project directory to store the project and Ethereum account details.
 
+<Tabs>
+  <TabItem value="View" label="Syntax" default>
+
+Replace the following values in the `.env` file:
+
 ```bash
-ETHEREUM_NETWORK = "sepolia"
+ETHEREUM_NETWORK = "<network>"
 INFURA_API_KEY = "<API-KEY>"
 SIGNER_PRIVATE_KEY = "<PRIVATE-KEY>"
 ```
 
-Ensure you replace the following values in the `.env` file:
+- `<NETWORK>` with "sepolia" or the network you are using.
+- `<API-KEY>` with your API key of the web3 project.
+- `<PRIVATE-KEY>` with the [private key of your Ethereum account](https://metamask.zendesk.com/hc/en-us/articles/360015289632-How-to-Export-an-Account-Private-Key). A transaction must be signed with the sender's private key. Make sure that you prefix the `SIGNER_PRIVATE_KEY` value with `0x`. The private key you export from MetaMask isn't prefixed with `0x`.
 
-- `<API-KEY>` with the API key of the Web3 project.
-- `<PRIVATE-KEY>` with the [private key of your Ethereum account](https://metamask.zendesk.com/hc/en-us/articles/360015289632-How-to-Export-an-Account-Private-Key). A transaction must be signed with the sender's private key.
+</TabItem>
+<TabItem value="Retrieve" label="Example" default>
 
-If using a network other than Sepolia, ensure you update `ETHEREUM_NETWORK` with the network name.
+```text
+ETHEREUM_NETWORK = "sepolia"
+INFURA_API_KEY = "d23...x...6e"
+SIGNER_PRIVATE_KEY = "0x561...x...61df"
+```
+</TabItem>
+</Tabs>
 
 :::danger
 
-Never disclose your private key. Anyone with your private keys can steal any assets held in your account.
+Never disclose your private key. Anyone with your private keys can steal the assets controlled by those keys.
 
 :::
 
-### 4. Create `eip1559_tx.js` file
+### 5. Create `eip1559_tx.js` file
 
-In this example, we'll create a JavaScript file (`eip1559_tx.js`) in the project directory which configures and sends the transaction.
+Create a file `eip1559_tx.js` in the project directory which configures and sends the transaction. For example:
 
 :::info
 
-Replace `to_account` with the relevant details.
+Optional: to send test ETH to an account of your choice, update line 15 with your selected account.
 
 :::
 
-```go
-const { ethers } = require("ethers");
-
-async function main() {
-  // Configuring the connection to an Ethereum node
-  const network = process.env.ETHEREUM_NETWORK;
-  const provider = new ethers.providers.InfuraProvider(
-    network,
-    process.env.INFURA_API_KEY
-  );
-
-  // Creating a signing account from a private key
-  const signer = new ethers.Wallet(process.env.SIGNER_PRIVATE_KEY, provider);
-
-  // Creating and sending the transaction object
-  const tx = await signer.sendTransaction({
-    to: "<to_account>",
-    value: ethers.utils.parseUnits("0.001", "ether"),
-  });
-  console.log("Mining transaction...");
-  console.log(`https://${network}.etherscan.io/tx/${tx.hash}`);
-
-  // Waiting for the transaction to be mined
-  const receipt = await tx.wait();
-  // The transaction is now on chain!
-  console.log(`Mined in block ${receipt.blockNumber}`);
-}
-
-require("dotenv").config();
-main();
+```javascript showLineNumbers
+const { ethers, parseUnits } = require("ethers");
+
+    async function main() {
+      // Configuring the connection to an Ethereum node
+      const network = process.env.ETHEREUM_NETWORK;
+      const provider = new ethers.InfuraProvider(
+        network,
+        process.env.INFURA_API_KEY
+      );
+      // Creating a signing account from a private key
+      const signer = new ethers.Wallet(process.env.SIGNER_PRIVATE_KEY).connect(provider);
+
+      // Creating and sending the transaction object
+      const tx = await signer.sendTransaction({
+        to: "0x618917c657e9F5b346c0141CB14F5D3CED65D449", // Replace with your selected account
+        value: parseUnits("0.001", "ether"),
+      });
+      console.log("Mining transaction...");
+      console.log(`https://${network}.etherscan.io/tx/${tx.hash}`);
+      // Waiting for the transaction to be mined
+      const receipt = await tx.wait();
+      // The transaction is now on chain!
+      console.log(`Mined in block ${receipt.blockNumber}`);
+    }
 ```
 
-### 5. Execute the transaction
+### 6. Execute the transaction
 
-Run the script:
+To execute the transaction, run:
 
 ```bash
 node eip1559_tx.js
@@ -122,7 +166,7 @@ Mined in block 7587728
 
 You can search for the transaction on a block explorer like [Sepolia Etherscan](https://www.infura.io/faucet).
 
-### 6. Fine tune the transaction details (optional)
+### Fine tune the transaction details (optional)
 
 To change default values, update the `signer.sendTransaction` method to include an `estimateGas` result.
 
@@ -131,7 +175,7 @@ const limit = provider.estimateGas({
   from: signer.address,
   to: "<to_address_goes_here>",
   value: ethers.utils.parseUnits("0.001", "ether"),
-})
+});
 
 // Creating and sending the transaction object
 const tx = await signer.sendTransaction({
@@ -141,5 +185,5 @@ const tx = await signer.sendTransaction({
   nonce: signer.getTransactionCount(),
   maxPriorityFeePerGas: ethers.utils.parseUnits("2", "gwei"),
   chainId: 3,
-})
+});
 ```