帮助更新此页面

🌏

本页面有新版本,但现在只有英文版。请帮助我们翻译最新版本。

此页不完整。如果您是这方面的专家,请编辑这一页,并将您的智慧撒在上面。

JavaScript 应用编程接口库

上次编辑: , Invalid DateTime
Edit page

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

因此,每个以太坊客户端都遵循 JSON-RPC 规范,以此有一个统一的端口可供应用程序们执行。

如果您想要用 JavaScript 连接到一个以太坊节点, 可以使用原生 JavaScript,不过生态系统中存在一些方便的库,使得这个事情变得更加容易。 通过这些库,开发者可以写下直观易懂甚至单行的代码就能初始化与以太坊的互动(背后使用 JSON RPC 请求)。

前置要求

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

为什么要使用库?

这些库降低了大多数与一个以太坊节点交互的复杂度。 它们还提供实用的函数(例如:将 ETH 转化为 Gwei),而作为开发者,您可以花费更少的时间来处理以太坊客户端的复杂问题,从而将更多的时间集中于处理您的应用程序的独特功能。

库的可用功能

连接到以太坊节点

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

Ether 示例

1// 一个 Web3Provider 包含了标准的 Web3 提供者(provider),这个提供者
2//相当于将 Metamask 作为一个以太坊窗口注入到每个页面中。
3const provider = new ethers.providers.eb3Provider(window.eferum)
4
5// Metamask 插件同时可以签署每一笔交易
6// 从而更改区块链中的状态。
7// 为此,我们需要帐户签名者...
8const signer = provider.getSigner()
9
📋 复制

Web3js 示例

1var web3 = new Web3("http://localhost:8545")
2// 或
3var web3 = new Web3(new Web3.providers.HttpProvider("http://localhost:8545"))
4
5// 更改提供者
6web3.setProvider("ws://localhost:8546")
7// 或
8web3.setProvider(new Web3.providers.WebsocketProvider("ws://localhost:8546"))
9
10// 在 node.js 中使用 IPC 提供者
11var net = require("net")
12var web3 = new Web3("/Users/myuser/Library/Etherum/geth). pc", net// mac os path
13// 或
14var web3 = new Web3(
15 new Web3.providers. pcProvider("/Users/myuser/Library/Etherum/geth.ipc", net"
16) // mac os path
17// 在 windows 操作系统上的路径是 "\\\\pipe\\geth.ipc"
18// 在 linux 上的路径是 "/users/myuser/.efer/geth.ipc"
19
显示全部
📋 复制

一旦设置,您将能够查询区块链的以下内容:

  • 区块高度
  • gas 评估
  • 智能合约事件
  • 网络 ID
  • 以及更多...

钱包功能

这些库给予开发者创建钱包的功能,用于管理密匙和对交易进行签署。

这里提供了一个 Ether 的例子

1// 从助记符创建一个钱包实例...
2mnemonic =
3 "announce room limb pattern dry unit scale effort smooth jazz weasel alcohol"
4walletMnemonic = Wallet.fromMnemonic(mnemonic)
5
6// ...或者从一个私有密匙中创建
7walletPrivateKey = new Wallet(walletMnemonic.privateKey)
8
9walletMnemonic.address === walletPrivateKey.address
10// true
11
12// 每个签署 API 都是一个异步操作地址
13walletMnemonic.getAddress()
14// { Promise: '0x71CB05EE1b1F506fF321Da3dac38f25c0c9ce6E1' }
15
16// 每个钱包地址同时也可以是同步的
17walletMnemonic.address
18// '0x71CB05EE1b1F506fF321Da3dac38f25c0c9ce6E1'
19
20// 内部加密组件
21walletMnemonic.privateKey
22// '0x1da6847600b0ee25e9ad9a52abbd786dd2502fa4005dd5af9310b7cc7a3b25db'
23walletMnemonic.publicKey
24// '0x04b9e72dfd423bcf95b3801ac93f4392be5ff22143f9980eb78b3a860c4843bfd04829ae61cdba4b3b1978ac5fc64f5cc2f4350e35a108a9c9a92a81200a60cd64'
25
26// 钱包的助记符(mnemonic)
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// 这个连接方法会返回一个新的连接到提供者的钱包实例
53wallet = walletMnemonic.connect(provider)
54
55// 查询以太坊网络
56wallet.getBalance()
57// { Promise: { BigNumber: "42" } }
58wallet.getTransactionCount()
59// { Promise: 0 }
60
61// 发送 Ether
62wallet.sendTransaction(tx)
63
显示全部
📋 复制

阅读完整文档

一旦设置,您将能够:

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

与智能合同交互的方法

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}
16
显示全部
📋 复制

可能会产生类似下面的 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}]
25
显示全部
📋 复制

这意味着你可以:

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

实用功能

这些实用功能类似快捷键操作,可以让开发者在构建以太坊时更加简单些。

我们默认以太坊的价值单位是 Wei(以太坊的最小价值单位) 1 ETH = 1,000,000,000,000,000,000 WEI - 这意味着开发者们可以处理计量很大的数字。 使用 web3.utils.toWei 可以将 ether 转换为 Wei 。

在 Ether 中,它看起来像这样:

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

可用的库

Web3.js - 以太坊 JavaScript API。

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

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

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

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

Alchemyweb3 - 用于包裹 Web3.js 的库,带自动重试和增强 API。

延伸阅读

你知道有什么社区资源帮助过你吗? 编辑并添加本页面!

👈
前一页开发框架
下一个后端API
👉