使用以太坊區塊鏈節點

本頁說明如何呼叫乙太坊節點 API。您必須先取得 API 金鑰和節點端點網址,才能存取乙太坊區塊鏈節點。如果尚未判斷這些值,請按照使用區塊鏈節點指南操作。

JSON-RPC

本節說明如何查詢以太坊區塊鏈節點的 JSON-RPC API

執行用戶端 RPC 範例

您可以透過 JSON-RPC 查詢執行用戶端 (完整節點的 Geth 或封存節點的 Erigon)。如需一般 JSON-RPC 規格,請參閱 Ethereum API 規格;如需 Geth 專用說明文件,請參閱 Geth RPC 說明文件

舉例來說,如要呼叫 eth_getBlockByNumber() 方法:

curl -H POST \
  -H "X-goog-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "id":1,
    "jsonrpc":"2.0",
    "method": "eth_getBlockByNumber",
    "params": ["0x1", true]
  }' \
  http://YOUR_NODES_URL

其中:

  • id 是由用戶端 (要求發起者) 設定的 ID。例如:1
  • jsonrpc 是 JSON-RPC 版本。例如:2.0
  • method 是方法的名稱。例如:eth_getBlockByNumber
  • params 是要與 method 一併使用的值。
  • YOUR_NODES_URL 是「取得區塊鏈節點網址」中傳回的位址。例如:json-rpc.ejp4j0b1rdiq06p8lxksd5z25.blockchainnodeengine.com
  • YOUR_API_KEY 是您在「建立 API 金鑰」中建立的金鑰。

如要進一步瞭解 Request 物件的格式,請參閱 JSON-RPC2.0 規格

上述指令的回應範例如下:

{
   "id" : 1,
   "jsonrpc" : "2.0",
   "result" : {
      "difficulty" : "0x3ff800000",
      "extraData" : "0x476574682f76312e302e302f6c696e75782f676f312e342e32",
      "gasLimit" : "0x1388",
      "gasUsed" : "0x0",
      "hash" : "0x88e96d4537bea4d9c05d12549907b32561d3bf31f45aae734cdc119f13406cb6",
      "logsBloom": "0x0000000000000000000000000000000000000",
      "miner" : "0x05a56e2d52c817161883f50c441c3228cfe54d9f",
      "mixHash" : "0x969b900de27b6ac6a67742365dd65f55a0526c41fd18e1b16f1a1215c2e66f59",
      "nonce" : "0x539bd4979fef1ec4",
      "number" : "0x1",
      "parentHash" : "0xd4e56740f876aef8c010b86a40d5f56745a118d0906a34e69aec8c0db1cb8fa3",
      "receiptsRoot" : "0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421",
      "sha3Uncles" : "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347",
      "size" : "0x219",
      "stateRoot" : "0xd67e4d450343046425ae4271474353857ab860dbc0a1dde64b41b5cd3a532bf3",
      "timestamp" : "0x55ba4224",
      "totalDifficulty" : "0x7ff800000",
      "transactions" : [],
      "transactionsRoot" : "0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421",
      "uncles" : []
   }
}

信標節點 RPC

Blockchain Node Engine 也會公開以太坊共識用戶端端點。 舉例來說,如要在 slot 1 索取驗證器的狀態:

curl \
-H "X-goog-api-key: YOUR_API_KEY" "Content-Type: application/json" \
'http://beacon.YOUR_NODES_URL/eth/v1/beacon/states/head/validators/1'

您也可以提供 API 金鑰做為 HTTP 標頭,而非查詢參數。以下查詢會產生相同結果:

curl \
-H "Content-Type: application/json" \
'http://beacon.YOUR_NODES_URL/eth/v1/beacon/states/head/validators/1?key=YOUR_API_KEY'

進一步說明:

上述指令的回應範例如下:

{
  "execution_optimistic": false,
  "data": {
    "index": "1",
    "balance": "36835614902",
    "status": "active_ongoing",
    "validator": {
      "pubkey": "0x1234abcd",
      "withdrawal_credentials": "0x1234abcd",
      "effective_balance": "32000000000",
      "slashed": false,
      "activation_eligibility_epoch": "0",
      "activation_epoch": "0",
      "exit_epoch": "18446744073709551615",
      "withdrawable_epoch": "18446744073709551615"
    }
  }
}

WebSocket

如要訂閱資料動態饋給,而非輪詢資料,可以使用區塊鏈節點執行用戶端的 WebSocket API。

舉例來說,如要訂閱新的鏈結標頭:

wscat -c wss://ws.YOUR_NODES_URL?key=YOUR_API_KEY
Connected (press CTRL+C to quit)
> {"jsonrpc":"2.0", "id": 1, "method": "eth_subscribe", "params": ["newHeads"]}

執行用戶端會傳回訂閱項目的 ID,例如:

{"jsonrpc":"2.0","id":1,"result":"0xf47df962ae9ba250ba9e9fb239b6894f"}

之後,用戶端會傳送每個新鏈結開頭區塊的詳細資料。以下是上述訂閱項目的事件範例:

{
   "jsonrpc" : "2.0",
   "method" : "eth_subscription",
   "params" : {
      "result" : {
         "baseFeePerGas" : "0x4bdc620b8",
         "difficulty" : "0x0",
         "extraData" : "0x496c6c756d696e61746520446d6f63726174697a6520447374726962757465",
         "gasLimit" : "0x1c9c380",
         "gasUsed" : "0xe24dae",
         "hash" : "0xbde840749c4d9086d17d66079d5f7d3d568ed4572329691e5b4a70f44a551816",
         "logsBloom": "0x0000000000000000000000000000000000000",
         "miner" : "0xb4c9e4617a16be36b92689b9e07e9f64757c1792",
         "mixHash" : "0xf68eb0b3ec50e1543de1cc7f09c7735ba20fa252124511756857078a3ff9a7cf",
         "nonce" : "0x0000000000000000",
         "number" : "0x109e280",
         "parentHash" : "0x54f78faba9fde0d15d7a9d6b80c4569435c7fdc5f1fef3255110373b66ce14de",
         "receiptsRoot" : "0x876bcb5772f8597fee4b063c57b7a51209eb428034efabf4cdf39a46901681b4",
         "sha3Uncles" : "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347",
         "stateRoot" : "0xfc5daf9608c8f2b9944bcfe0b9182148d85b1a6ad4dc52d3eb522dd02687c7e0",
         "timestamp" : "0x647fd287",
         "transactionsRoot" : "0x0acaef87e4609ea6075d88fdd404b3fbd25d796af9044522beefd3c708d37af8",
         "withdrawalsRoot" : "0x7adfc670253572678769e7d80db8c4c94b5d14d4e014274f39b679fdb5e72d98"
      },
      "subscription" : "0xf47df962ae9ba250ba9e9fb239b6894f"
   }
}

指標

乙太坊節點提供多項節點運作狀態指標。這些指標通常會由 PrometheusGrafana 等工具取用。

如要擷取信號用戶端公開的指標,可以使用下列指令:

curl https://bc-mc.YOUR_NODES_URL/metrics/prometheus?key=YOUR_API_KEY

這會產生類似以下的輸出內容:

# HELP async_tasks_count Total number of async tasks spawned using spawn
# TYPE async_tasks_count gauge
async_tasks_count{async_task_count="addr_broadcast"} 0
async_tasks_count{async_task_count="beacon_node"} 0
async_tasks_count{async_task_count="beacon_processor_manager"} 1
async_tasks_count{async_task_count="beacon_processor_reprocess_queue"} 1
async_tasks_count{async_task_count="beacon_processor_worker"} 0
async_tasks_count{async_task_count="discv5"} 4
async_tasks_count{async_task_count="el_fork_choice_update"} 0
async_tasks_count{async_task_count="eth1"} 1
...

執行用戶端和信標用戶端有各自的指標端點。 執行用戶端通常會加上 ec-mc 前置字元,信標用戶端則通常會加上 bc-mc 前置字元 (如上例所示)。

如要進一步瞭解各個用戶端軟體的指標,請參閱: