JavasScript API 圖書館

為了使網路應用程式能夠與以太坊區塊鏈互動（即讀取區塊鏈資料和/或將交易傳送到網路），它必須連結到以太坊節點。

為了這個目的，每個以太坊用戶端需實作 JSON-RPC 規範，如此一來，應用程式就可以使用一組統一的方法。

如果你想使用 JavaScript 與以太坊節點連結，可以使用普通 JavaScript，但生態系統中存在幾個便利的程式庫，讓連結變得更加容易。借助這些程式庫，開發者可以編寫直覺的單行方法來初始化與以太坊互動的 JSON-RPC 請求（在後台）。

請注意，在合併後，如要運行節點，需要兩個互相連結的以太坊軟體：執行用戶端和共識用戶端。請確定你的節點包含執行用戶端和共識用戶端。如果你的節點不在本地機器上（比如你的節點在 AWS 執行個體上），請相應地修改教學中的 IP 位址。更多資訊請見我們的運行節點頁面。

基本資訊

除了瞭解 JavaScript 之外，瞭解<0>以太坊堆疊</0>和<1>以太坊用戶端</1>可能也會有所幫助。

為何使用資料圖書庫

函式庫簡化與以太坊節點的複雜步驟. 並提供其他效功能(例如: 轉化以太(ETH)到Gwei)使開發者花少時間處理以太坊客戶, 且花更多時間在提升應用程式獨特功能.

程式庫功能

連結以太坊節點

使用提供者，這些程式庫讓你能夠連結到以太坊並讀取其資料，無論是透過 JSON-RPC、INFURA、Etherscan、Alchemy 還是 MetaMask。

Ethers 範例

1// BrowserProvider 包裝了一個標準的 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// 或
3var web3 = new Web3(new Web3.providers.HttpProvider("http://localhost:8545"))
4
5// 更改Provider
6web3.setProvider("ws://localhost:8546")
7// 或
8web3.setProvider(new Web3.providers.WebsocketProvider("ws://localhost:8546"))
9
10// 使用 IPC provider 於 node.js
11var net = require("net")
12var web3 = new Web3("/Users/myuser/Library/Ethereum/geth.ipc", net) // mac os path
13// 或
14var web3 = new Web3(
15  new Web3.providers.IpcProvider("/Users/myuser/Library/Ethereum/geth.ipc", net)
16) // mac os 路徑
17// windows 路徑為: "\\\\.\\pipe\\geth.ipc"
18// linux 路徑為: "/users/myuser/.ethereum/geth.ipc"
顯示全部
 複製

設定完成後，將能夠在區塊鏈查詢：

區塊編碼
燃料預估值
智慧型合約活動
網路 id
和更多相關內容...

錢包功能

這些程式庫為你提供建立錢包、管理金鑰和簽署交易的功能。

下面是以太幣範例

1//由助記符(mnemonic) 創建錢包
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// 連接方法返回一個新的連接到提供者的
53// 錢包執行個體，
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) 呼叫智慧型合約函式。

應用程式二進位介面本質上以 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。

在以太幣中，如下所示：

1// 取得帳戶殘額(藉由地址或ENS名)
2balance = await provider.getBalance("ethers.eth")
3// { BigNumber: "2337132817842795605" }
4
5// 因用戶通常想看到以太(ETH)殘額, 通常開發者需
6// 顯示以太(ETH)殘額, 而不是Wei.
7ethers.utils.formatEther(balance)
8// '2.337132817842795605'
 複製

可用資料圖書庫

Web3.js - 以太坊 JavaScript 應用程式介面。

Ethers.js - 使用 JavaScript 和 TypeScript 的完整以太坊錢包實作和公用程式。

The Graph - 用於為以太坊和星際檔案係統資料編製索引並使用 GraphQL 進行查詢的協議。

light.js **針對輕量用戶端最佳化的高階回應式 JS 程式庫。**

Github(opens in a new tab)

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

Alchemyweb3 - 具有自動重試和增強型應用程式介面的 Web3.js 包裝函式。

Alchemy 非同質化代幣應用程式介面 - 用於擷取非同質化代幣資料的應用程式介面，包括所有權、中繼資料屬性以及更多。

viem - 以太坊的 TypeScript 介面。

衍生閱讀

知道對你有幫助的社群資源嗎？請編輯此頁面並新增資源！

設定 Web3js 以在 Javascript 中使用以太坊區塊鏈 – 在專案中設定 web3.js 的說明。
從 JavaScript 呼叫智慧型合約 – 使用 DAI 代幣，瞭解如何使用 JavaScript 呼叫合約函式。
使用 web3 和 Alchemy 傳送交易 – 從後端傳送交易的逐步演練。