Skip to content

Commit d080ea9

Browse files
authored
Merge pull request #10627 from mlibre/patch-3
Point to new Web3JS docs site
2 parents 0e86fd7 + 7a53a9e commit d080ea9

File tree

67 files changed

+97
-97
lines changed
  • src/content
    • developers
      • docs
      • tutorials
        • hello-world-smart-contract-fullstack
        • how-to-mint-an-nft
        • kickstart-your-dapp-frontend-development-wth-create-eth-app
        • nft-minter
        • sending-transactions-using-web3-and-alchemy
        • set-up-web3js-to-use-ethereum-in-javascript
        • the-graph-fixing-web3-data-querying
    • translations
      • de/developers
      • es/developers
      • fr/developers
        • docs/apis/javascript
        • tutorials
          • how-to-mint-an-nft
          • kickstart-your-dapp-frontend-development-wth-create-eth-app
          • nft-minter
          • sending-transactions-using-web3-and-alchemy
          • set-up-web3js-to-use-ethereum-in-javascript
          • the-graph-fixing-web3-data-querying
      • hu/developers/docs/apis/javascript
      • id/developers
        • docs/apis/javascript
        • tutorials
          • how-to-mint-an-nft
          • kickstart-your-dapp-frontend-development-wth-create-eth-app
          • nft-minter
          • sending-transactions-using-web3-and-alchemy
          • set-up-web3js-to-use-ethereum-in-javascript
          • the-graph-fixing-web3-data-querying
      • it/developers
        • docs
        • tutorials
          • how-to-mint-an-nft
          • kickstart-your-dapp-frontend-development-wth-create-eth-app
          • nft-minter
          • sending-transactions-using-web3-and-alchemy
          • set-up-web3js-to-use-ethereum-in-javascript
          • the-graph-fixing-web3-data-querying
      • ja/developers
        • docs/apis/javascript
        • tutorials
          • how-to-mint-an-nft
          • kickstart-your-dapp-frontend-development-wth-create-eth-app
          • nft-minter
          • sending-transactions-using-web3-and-alchemy
          • set-up-web3js-to-use-ethereum-in-javascript
          • the-graph-fixing-web3-data-querying
      • pl/developers
        • docs/apis/javascript
        • tutorials/the-graph-fixing-web3-data-querying
      • pt-br/developers
      • ro/developers
        • docs/apis/javascript
        • tutorials
          • how-to-mint-an-nft
          • kickstart-your-dapp-frontend-development-wth-create-eth-app
          • nft-minter
          • sending-transactions-using-web3-and-alchemy
          • set-up-web3js-to-use-ethereum-in-javascript
          • the-graph-fixing-web3-data-querying
      • tr/developers
        • docs/apis/javascript
        • tutorials
          • how-to-mint-an-nft
          • kickstart-your-dapp-frontend-development-wth-create-eth-app
          • sending-transactions-using-web3-and-alchemy
      • zh/developers
        • docs/apis/javascript
        • tutorials
          • how-to-mint-an-nft
          • kickstart-your-dapp-frontend-development-wth-create-eth-app
          • nft-minter
          • sending-transactions-using-web3-and-alchemy
          • set-up-web3js-to-use-ethereum-in-javascript
          • the-graph-fixing-web3-data-querying

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

67 files changed

+97
-97
lines changed

src/content/developers/docs/apis/javascript/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -232,14 +232,14 @@ ethers.utils.formatEther(balance)
232232
// '2.337132817842795605'
233233
```
234234

235-
- [Web3js utility functions](https://web3js.readthedocs.io/en/v1.2.11/web3-utils.html#)
235+
- [Web3js utility functions](https://docs.web3js.org/api/web3-utils)
236236
- [Ethers utility functions](https://docs.ethers.io/v5/api/utils/)
237237

238238
## Available libraries {#available-libraries}
239239

240240
**Web3.js -** **_Ethereum JavaScript API._**
241241

242-
- [Documentation](https://web3js.readthedocs.io/en/1.0/)
242+
- [Documentation](https://docs.web3js.org/)
243243
- [GitHub](https://github.com/ethereum/web3.js/)
244244

245245
**Ethers.js -** **_Complete Ethereum wallet implementation and utilities in JavaScript and TypeScript._**

src/content/developers/docs/consensus-mechanisms/pos/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Whereas under proof-of-work, the timing of blocks is determined by the mining di
3333

3434
The following provides an end-to-end explanation of how a transaction gets executed in Ethereum proof-of-stake.
3535

36-
1. A user creates and signs a [transaction](/developers/docs/transactions/) with their private key. This is usually handled by a wallet or a library such as [ether.js](https://docs.ethers.io/v5/), [web3js](https://web3js.readthedocs.io/en/v1.8.1/), [web3py](https://web3py.readthedocs.io/en/v5/) etc but under the hood the user is making a request to a node using the Ethereum [JSON-RPC API](/developers/docs/apis/json-rpc/). The user defines the amount of gas that they are prepared to pay as a tip to a validator to encourage them to include the transaction in a block. The [tips](/developers/docs/gas/#priority-fee) get paid to the validator while the [base fee](/developers/docs/gas/#base-fee) gets burned.
36+
1. A user creates and signs a [transaction](/developers/docs/transactions/) with their private key. This is usually handled by a wallet or a library such as [ether.js](https://docs.ethers.io/v5/), [web3js](https://docs.web3js.org/), [web3py](https://web3py.readthedocs.io/en/v5/) etc but under the hood the user is making a request to a node using the Ethereum [JSON-RPC API](/developers/docs/apis/json-rpc/). The user defines the amount of gas that they are prepared to pay as a tip to a validator to encourage them to include the transaction in a block. The [tips](/developers/docs/gas/#priority-fee) get paid to the validator while the [base fee](/developers/docs/gas/#base-fee) gets burned.
3737
2. The transaction is submitted to an Ethereum [execution client](/developers/docs/nodes-and-clients/#execution-client) which verifies its validity. This means ensuring that the sender has enough ETH to fulfill the transaction and they have signed it with the correct key.
3838
3. If the transaction is valid, the execution client adds it to its local mempool (list of pending transactions) and also broadcasts it to other nodes over the execution layer gossip network. When other nodes hear about the transaction they add it to their local mempool too. Advanced users might refrain from broadcasting their transaction and instead forward it to specialized block builders such as [Flashbots Auction](https://docs.flashbots.net/flashbots-auction/overview). This allows them to organize the transactions in upcoming blocks for maximum profit ([MEV](/developers/docs/mev/#mev-extraction)).
3939
4. One of the nodes on the network is the block proposer for the current slot, having previously been selected pseudo-randomly using RANDAO. This node is responsible for building and broadcasting the next block to be added to the Ethereum blockchain and updating the global state. The node is made up of three parts: an execution client, a consensus client and a validator client. The execution client bundles transactions from the local mempool into an "execution payload" and executes them locally to generate a state change. This information is passed to the consensus client where the execution payload is wrapped as part of a "beacon block" that also contains information about rewards, penalties, slashings, attestations etc. that enable the network to agree on the sequence of blocks at the head of the chain. The communication between the execution and consensus clients is described in more detail in [Connecting the Consensus and Execution Clients](/developers/docs/networking-layer/#connecting-clients).

src/content/developers/docs/nodes-and-clients/node-architecture/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The execution client is responsible for transaction handling, transaction gossip
2222

2323
The execution client creates execution payloads - the list of transactions, updated state trie, and other execution-related data. Consensus clients include the execution payload in every block. The execution client is also responsible for re-executing transactions in new blocks to ensure they are valid. Executing transactions is done on the execution client's embedded computer, known as the [Ethereum Virtual Machine (EVM)](/developers/docs/evm).
2424

25-
The execution client also offers a user interface to Ethereum through [RPC methods](/developers/docs/apis/json-rpc) that enable users to query the Ethereum blockchain, submit transactions and deploy smart contracts. It's common for RPC calls to be handled by a library like [Web3js](https://web3js.readthedocs.io/en/v1.8.0/), [Web3py](https://web3py.readthedocs.io/en/v5/), or by a user-interface such as a browser wallet.
25+
The execution client also offers a user interface to Ethereum through [RPC methods](/developers/docs/apis/json-rpc) that enable users to query the Ethereum blockchain, submit transactions and deploy smart contracts. It's common for RPC calls to be handled by a library like [Web3js](https://docs.web3js.org/), [Web3py](https://web3py.readthedocs.io/en/v5/), or by a user-interface such as a browser wallet.
2626

2727
In summary, the execution client is:
2828

src/content/developers/tutorials/hello-world-smart-contract-fullstack/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -906,7 +906,7 @@ If you don't have it already, first install [Alchemy Web3](https://github.com/al
906906
npm install @alch/alchemy-web3
907907
```
908908

909-
[Alchemy Web3](https://github.com/alchemyplatform/alchemy-web3) is a wrapper around [Web3.js](https://web3js.readthedocs.io/en/v1.2.9/), providing enhanced API methods and other crucial benefits to make your life as a web3 developer easier. It is designed to require minimal configuration so you can start using it in your app right away!
909+
[Alchemy Web3](https://github.com/alchemyplatform/alchemy-web3) is a wrapper around [Web3.js](https://docs.web3js.org/), providing enhanced API methods and other crucial benefits to make your life as a web3 developer easier. It is designed to require minimal configuration so you can start using it in your app right away!
910910

911911
Then, install the [dotenv](https://www.npmjs.com/package/dotenv) package in your project directory, so we have a secure place to store our API key after we fetch it.
912912

@@ -951,7 +951,7 @@ A contract ABI is necessary for specifying which function a contract will invoke
951951

952952
Your contract-abi.json should be stored in your src folder.
953953

954-
Armed with our contract address, ABI, and Alchemy Web3 endpoint, we can use the [contract method](https://web3js.readthedocs.io/en/v1.2.0/web3-eth-contract.html?highlight=constructor#web3-eth-contract) to load an instance of our smart contract. Import your contract ABI into the `interact.js` file and add your contract address.
954+
Armed with our contract address, ABI, and Alchemy Web3 endpoint, we can use the [contract method](https://docs.web3js.org/api/web3-eth-contract/class/Contract) to load an instance of our smart contract. Import your contract ABI into the `interact.js` file and add your contract address.
955955

956956
```javascript
957957
// interact.js

src/content/developers/tutorials/how-to-mint-an-nft/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ Now, to interact with our contract, we need to create an instance of it in our c
115115

116116
In the above example, our contract address is 0x5a738a5c5fe46a1fd5ee7dd7e38f722e2aef7778.
117117

118-
Next we will use the Web3 [contract method](https://web3js.readthedocs.io/en/v1.2.0/web3-eth-contract.html?highlight=constructor#web3-eth-contract) to create our contract using the ABI and address. In your `mint-nft.js` file, add the following:
118+
Next we will use the Web3 [contract method](https://docs.web3js.org/api/web3-eth-contract/class/Contract) to create our contract using the ABI and address. In your `mint-nft.js` file, add the following:
119119

120120
```js
121121
const contractAddress = "0x5a738a5c5fe46a1fd5ee7dd7e38f722e2aef7778"

src/content/developers/tutorials/kickstart-your-dapp-frontend-development-wth-create-eth-app/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ The _create-eth-app_ in particular is making use of the new [hooks effects](http
4646

4747
### ethers.js {#ethersjs}
4848

49-
While [Web3](https://web3js.readthedocs.io/en/v1.2.7/) is still mostly used, [ethers.js](https://docs.ethers.io/) has been getting a lot more traction as an alternative in the last year and is the one integrated into _create-eth-app_. You can work with this one, change it to Web3 or consider upgrading to [ethers.js v5](https://docs-beta.ethers.io/) which is almost out of beta.
49+
While [Web3](https://docs.web3js.org/) is still mostly used, [ethers.js](https://docs.ethers.io/) has been getting a lot more traction as an alternative in the last year and is the one integrated into _create-eth-app_. You can work with this one, change it to Web3 or consider upgrading to [ethers.js v5](https://docs-beta.ethers.io/) which is almost out of beta.
5050

5151
### The Graph {#the-graph}
5252

src/content/developers/tutorials/nft-minter/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -623,7 +623,7 @@ const { createAlchemyWeb3 } = require("@alch/alchemy-web3")
623623
const web3 = createAlchemyWeb3(alchemyKey)
624624
```
625625
626-
[Alchemy Web3](https://github.com/alchemyplatform/alchemy-web3) is a wrapper around [Web3.js](https://web3js.readthedocs.io/en/v1.2.9/), providing enhanced API methods and other crucial benefits to make your life as a web3 developer easier. It is designed to require minimal configuration so you can start using it in your app right away!
626+
[Alchemy Web3](https://github.com/alchemyplatform/alchemy-web3) is a wrapper around [Web3.js](https://docs.web3js.org/), providing enhanced API methods and other crucial benefits to make your life as a web3 developer easier. It is designed to require minimal configuration so you can start using it in your app right away!
627627
628628
Next, let's add our contract ABI and contract address to our file.
629629

src/content/developers/tutorials/sending-transactions-using-web3-and-alchemy/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@ Like most blockchain developers when they first start, you might have done some
4141

4242
`eth_sendTransaction` and `eth_sendRawTransaction` are both Ethereum API functions which broadcast a transaction to the Ethereum network so it will be added to a future block. They differ in how they handle signing of the transactions.
4343

44-
- [`eth_sendTransaction`](https://web3js.readthedocs.io/en/v1.2.0/web3-eth.html#eth-sendtransaction) is used for sending _unsigned_ transactions, which means the node you are sending to must manage your private key so it can sign the transaction before broadcasting it to the chain. Since Alchemy doesn't hold user's private keys, they do not support this method.
45-
- [`eth_sendRawTransaction`](https://docs.alchemyapi.io/documentation/alchemy-api-reference/json-rpc#eth_sendrawtransaction) is used to broadcast transactions that have already been signed. This means you first have to use [`signTransaction(tx, private_key)`](https://web3js.readthedocs.io/en/v1.2.0/web3-eth.html#signtransaction), then pass in the result into `eth_sendRawTransaction`.
44+
- [`eth_sendTransaction`](https://docs.web3js.org/api/web3-eth/function/sendTransaction) is used for sending _unsigned_ transactions, which means the node you are sending to must manage your private key so it can sign the transaction before broadcasting it to the chain. Since Alchemy doesn't hold user's private keys, they do not support this method.
45+
- [`eth_sendRawTransaction`](https://docs.alchemyapi.io/documentation/alchemy-api-reference/json-rpc#eth_sendrawtransaction) is used to broadcast transactions that have already been signed. This means you first have to use [`signTransaction(tx, private_key)`](https://docs.web3js.org/api/web3-eth-accounts/function/signTransaction), then pass in the result into `eth_sendRawTransaction`.
4646

47-
When using web3, `eth_sendRawTransaction` is accessed by calling the function [web3.eth.sendSignedTransaction](https://web3js.readthedocs.io/en/v1.2.0/web3-eth.html#sendsignedtransaction).
47+
When using web3, `eth_sendRawTransaction` is accessed by calling the function [web3.eth.sendSignedTransaction](https://docs.web3js.org/api/web3-eth/function/sendSignedTransaction).
4848

4949
This is what we will be using in this tutorial.
5050

src/content/developers/tutorials/set-up-web3js-to-use-ethereum-in-javascript/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ async function getBlockNumber() {
6666
getBlockNumber()
6767
```
6868

69-
You can see all the functions available on the Web3 instance in [the official web3.js documentation](https://web3js.readthedocs.io/en/v1.2.6/web3-eth.html#).
69+
You can see all the functions available on the Web3 instance in [the official web3.js documentation](https://docs.web3js.org/).
7070

7171
Most of Web3 libraries are asynchronous because in the background the library makes JSON RPC calls to the node which send backs the result.
7272

src/content/developers/tutorials/the-graph-fixing-web3-data-querying/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Now let's say in our dapp, we want to display total bets, the total games lost/w
5454
2. Fetch `totalGamesPlayerLost`.
5555
3. Subscribe to `BetPlaced` events.
5656

57-
We can listen to the [event in Web3](https://web3js.readthedocs.io/en/v1.2.11/web3-eth-contract.html#contract-events) as shown on the right, but it requires handling quite a few cases.
57+
We can listen to the [event in Web3](https://docs.web3js.org/api/web3/class/Contract#events) as shown on the right, but it requires handling quite a few cases.
5858

5959
```solidity
6060
GameContract.events.BetPlaced({

0 commit comments

Comments
 (0)