JavaScript 应用编程接口库

为了使网页应用程序能够与以太坊区块链进行交互（例如：读取区块链数据或发送交易信息到网络），软件必须连接到以太坊节点。

为此，每种以太坊客户端都实现了 JSON-RPC 规范，因而应用程序可以依赖一组统一的方法。

如果你想要用 JavaScript 连接到一个以太坊节点，可以使用原生 JavaScript，不过生态系统中存在一些方便的库，使得这个事情变得更加容易。通过这些库，开发者可以方便地写下直观的一行函数来初始化（后端的）JSON RPC 请求并用于与以太坊进行交互。

请注意，合并后，运行节点需要两种互联的以太坊软件 - 执行客户端和共识客户端。请确保你的节点同时包含执行客户端和共识客户端。如果你的节点不在本地计算机上（例如，你的节点在 AWS 实例上运行），请相应地更新教程中的 IP 地址。有关更多信息，请参阅我们关于运行节点的页面。

前提条件

除了了解 JavaScript 外，了解以太坊堆栈和以太坊客户端也许是有帮助的。

为什么要使用库？

这些库降低了与一个以太坊节点直接交互的复杂性。它们还提供实用功能（例如：将以太币转换为 Gwei），因此作为开发者，你可以花费更少的时间处理以太坊客户端的复杂问题，而将更多的时间集中于处理应用程序的独特功能。

库功能

连接到以太坊节点

使用提供程序，这些库允许你连接到以太坊并读取它的数据，不管是通过 JSON-RPC、INFURA、Etherscan、Alchemy 还是 Metamask。

Ethers 示例

1// 一个浏览器提供程序包装了一个标准 Web3 提供程序，后者由
2// MetaMask 作为 window.ethereum 注入每个页面
3const provider = new ethers.BrowserProvider(window.ethereum)
4
5// MetaMask 插件还允许为交易签名，
6// 以发送以太币并付款改变区块链内的状态。
7// 为此，我们需要帐户签名者...
8const signer = provider.getSigner()
 复制

Web3js 示例

1var web3 = new Web3("http://localhost:8545")
2// or
3var web3 = new Web3(new Web3.providers.HttpProvider("http://localhost:8545"))
4
5// change provider
6web3.setProvider("ws://localhost:8546")
7// or
8web3.setProvider(new Web3.providers.WebsocketProvider("ws://localhost:8546"))
9
10// Using the IPC provider in node.js
11var net = require("net")
12var web3 = new Web3("/Users/myuser/Library/Ethereum/geth.ipc", net) // mac os path
13// or
14var web3 = new Web3(
15  new Web3.providers.IpcProvider("/Users/myuser/Library/Ethereum/geth.ipc", net)
16) // mac os path
17// on windows the path is: "\\\\.\\pipe\\geth.ipc"
18// on linux the path is: "/users/myuser/.ethereum/geth.ipc"
显示全部
 复制

一旦设置，你将能够查询区块链的以下内容：

区块号
燃料估算
智能合约事件
网络 ID
以及更多...

钱包功能

这些库为你提供了创建钱包、管理密匙和签署交易的功能。

这里提供了 Ethers 中的一个示例

1// 从助记符创建一个钱包实例...
2mnemonic =
3  "announce room limb pattern dry unit scale effort smooth jazz weasel alcohol"
4walletMnemonic = Wallet.fromPhrase(mnemonic)
5
6// ...或者来自一个私钥
7walletPrivateKey = new Wallet(walletMnemonic.privateKey)
8
9walletMnemonic.address === walletPrivateKey.address
10// true
11
12// 根据签名者应用程序接口，该地址为 Promise
13walletMnemonic.getAddress()
14// { Promise: '0x71CB05EE1b1F506fF321Da3dac38f25c0c9ce6E1' }
15
16// 钱包地址也可同步使用
17walletMnemonic.address
18// '0x71CB05EE1b1F506fF321Da3dac38f25c0c9ce6E1'
19
20// 内部加密组件
21walletMnemonic.privateKey
22// '0x1da6847600b0ee25e9ad9a52abbd786dd2502fa4005dd5af9310b7cc7a3b25db'
23walletMnemonic.publicKey
24// '0x04b9e72dfd423bcf95b3801ac93f4392be5ff22143f9980eb78b3a860c4843bfd04829ae61cdba4b3b1978ac5fc64f5cc2f4350e35a108a9c9a92a81200a60cd64'
25
26// 钱包助记词
27walletMnemonic.mnemonic
28// {
29//   locale: 'en',
30//   path: 'm/44\'/60\'/0\'/0/0',
31//   phrase: 'announce room limb pattern dry unit scale effort smooth jazz weasel alcohol'
32// }
33
34// 注意：使用私钥创建的钱包
35//       没有助记词（派生阻止了它）
36walletPrivateKey.mnemonic
37// null
38
39// 为信息签名
40walletMnemonic.signMessage("Hello World")
41// { Promise: '0x14280e5885a19f60e536de50097e96e3738c7acae4e9e62d67272d794b8127d31c03d9cd59781d4ee31fb4e1b893bd9b020ec67dfa65cfb51e2bdadbb1de26d91c' }
42
43tx = {
44  to: "0x8ba1f109551bD432803012645Ac136ddd64DBA72",
45  value: utils.parseEther("1.0"),
46}
47
48// 为交易签名
49walletMnemonic.signTransaction(tx)
50// { Promise: '0xf865808080948ba1f109551bd432803012645ac136ddd64dba72880de0b6b3a7640000801ca0918e294306d177ab7bd664f5e141436563854ebe0a3e523b9690b4922bbb52b8a01181612cec9c431c4257a79b8c9f0c980a2c49bb5a0e6ac52949163eeb565dfc' }
51
52// connect 方法返回连接到提供程序
53// 的 Wallet 的新实例
54wallet = walletMnemonic.connect(provider)
55
56// 查询网络
57wallet.getBalance()
58// { Promise: { BigNumber: "42" } }
59wallet.getTransactionCount()
60// { Promise: 0 }
61
62// 发送以太币
63wallet.sendTransaction(tx)
显示全部
 复制

阅读完整文档(opens in a new tab)

一旦设置，你将能够：

创建帐户
发送交易
签署交易
以及更多...

与智能合约交互的方法

JavaScript 客户端库允许你的应用程序通过读取已编译合约的应用程序二进制接口 (ABI) 来调用智能合约函数。

ABI 本质上是以 JSON 格式解释了合约的功能，并且允许你像普通 JavaScript 对象一样使用它。

以下 Solidity 合约：

1contract Test {
2    uint a;
3    address d = 0x12345678901234567890123456789012;
4
5    function Test(uint testInt)  { a = testInt;}
6
7    event Event(uint indexed b, bytes32 c);
8
9    event Event2(uint indexed b, bytes32 c);
10
11    function foo(uint b, bytes32 c) returns(address) {
12        Event(b, c);
13        return d;
14    }
15}
显示全部
 复制

将会产生以下 JSON 代码：

1[{
2    "type":"constructor",
3    "payable":false,
4    "stateMutability":"nonpayable"
5    "inputs":[{"name":"testInt","type":"uint256"}],
6  },{
7    "type":"function",
8    "name":"foo",
9    "constant":false,
10    "payable":false,
11    "stateMutability":"nonpayable",
12    "inputs":[{"name":"b","type":"uint256"}, {"name":"c","type":"bytes32"}],
13    "outputs":[{"name":"","type":"address"}]
14  },{
15    "type":"event",
16    "name":"Event",
17    "inputs":[{"indexed":true,"name":"b","type":"uint256"}, {"indexed":false,"name":"c","type":"bytes32"}],
18    "anonymous":false
19  },{
20    "type":"event",
21    "name":"Event2",
22    "inputs":[{"indexed":true,"name":"b","type":"uint256"},{"indexed":false,"name":"c","type":"bytes32"}],
23    "anonymous":false
24}]
显示全部
 复制

这意味着你可以：

发送一笔交易到指定的智能合约上，并执行智能合约上的方法
调用方法去评估对燃料的需求量。这个方法的执行是在以太坊虚拟机中执行的。
部署一个合约
以及更多...

实用功能

这些实用功能为你提供了方便的快捷操作，让以太坊的构建变得更轻松一些。

以太币的默认价值单位是 Wei。 1 个以太币 = 1,000,000,000,000,000,000 WEI – 这意味着你需要处理很多的数字。使用 web3.utils.toWei 可以将以太币转换为 Wei。

在 ethers 中，它看起来是这样的：

1// 获取帐户中的资产（通过地址或者 ENS 名）
2balance = await provider.getBalance("ethers.eth")
3// { BigNumber: "2337132817842795605" }
4
5// 通常来说开发者可能会需要为用户格式化一下输出
6// 用户更喜欢以 ether（而非 wei）表示的价值
7ethers.utils.formatEther(balance)
8// '2.337132817842795605'
 复制

可用的库

Web3.js - 以太坊 JavaScript API。

Ethers.js - JavaScript 和 TypeScript 中完整的以太坊钱包实现和实用工具。

Graph - 用于为以太坊和星际文件系统数据建立索引并使用 GraphQL 对其进行查询的协议。

light.js - 针对轻客户端优化的高级响应式 JS 库。

GitHub(opens in a new tab)

Web3-wrapper - 可替代 Web3.js 的 Typescript。

Alchemyweb3 - Web3.js 的包装器，带自动重试和增强的应用程序接口。

Alchemy 非同质化代币应用程序接口 - 用于提取非同质化代币数据的应用程序接口，包括所有权、元数据属性等数据。

viem - 以太坊的 TypeScript 接口。

JavaScript 应用编程接口库

前提条件

为什么要使用库？

库功能

连接到以太坊节点

钱包功能

与智能合约交互的方法

实用功能

可用的库

延伸阅读

本文对你有帮助吗？

JavaScript 应用编程接口库

前提条件

为什么要使用库？

库功能

连接到以太坊节点

钱包功能

与智能合约交互的方法

实用功能

可用的库

延伸阅读

相关主题

相关教程

本文对你有帮助吗？