JSON RPC方法 | Loom SDK

概述

为了与Web3.js兼容，LoomProvider添加了一些与以太坊JSON RPC方法完全兼容的方法，这些方法可以由Loom QueryService或LoomProvider直接调用，在本教程中我们将讨论LoomProvider。

LoomProvider 调用 JSON RPC 方法

提供程序应该是客户端和Loom DAppChain之间的桥梁，下面的代码是LoomProvider实例化的示例，并调用JSON RPC来获取eth_accounts的帐户。

const privateKey = CryptoUtils.generatePrivateKey();
const publicKey = CryptoUtils.publicKeyFromPrivateKey(privateKey);

// Create the client
const client = new Client(
  "default",
  "ws://127.0.0.1:46658/websocket",
  "ws://127.0.0.1:46658/queryws"
);

// The address for the caller of the function
const from = LocalAddress.fromPublicKey(publicKey).toString();

// Instantiate loom provider
const loomProvider = new LoomProvider(client, privateKey);

// eth_accounts JSON RPC call
const jsonRPCString = '{"id": 1,"jsonrpc": "2.0", "method": "eth_accounts", "params": []}'

// Parse JSON is a necessary step before send
await loomProvider.sendAsync(JSON.parse(jsonRPCString))

// Return should be something like
// {
//   "id":1,
//   "jsonrpc": "2.0",
//   "result": ["0x407d73d8a49eeb85d32cf465507dd71d507100c1"]
// }

eth_accounts

说明

返回 LoomProvider 拥有的地址列表。

参数

无

返回值

Array of DATA, 20个字节 - 客户端拥有的地址。

示例

// eth_accounts JSON RPC调用
const jsonRPCString = '{"id": 1,"jsonrpc": "2.0", "method": "eth_accounts", "params": []}'

// Parse JSON是发送之前的必要步骤
await loomProvider.sendAsync(JSON.parse(jsonRPCString))

// 返回将是这样的
// {
//   "id":1,
//   "jsonrpc": "2.0",
//   "result": ["0x407d73d8a49eeb85d32cf465507dd71d507100c1"]
// }

eth_blockNumber

说明

返回最近完成的区块的编号。

参数

无

返回值

QUANTITY - 客户端所在的当前区块编号的整数。

示例

// eth_blockNumber JSON RPC调用
const jsonRPCString = '{"jsonrpc":"2.0","method":"eth_blockNumber","params":[],"id":83}'

// Parse JSON是发送之前的必要步骤
await loomProvider.sendAsync(JSON.parse(jsonRPCString))

// 返回将是这样的
// {
//   "id":83,
//   "jsonrpc": "2.0",
//   "result": "0x4b7" // 1207
// }

eth_call

说明

立即执行一个新的信息调用，而不在区块链上创建事务。

参数

Object - 事务调用对象

from: DATA, 20个字节 - 发送事务的地址
to: DATA, 20个字节 - 事务指向的地址。
data: DATA - 方法签名和被编码参数的哈希。详细信息请参阅Ethereum Contract ABI

返回值

DATA - 已执行合约的返回值。

示例

// eth_call JSON RPC调用
const jsonRPCString = '{"jsonrpc":"2.0","method":"eth_call","params":[{see above}],"id":1}'

// Parse JSON是发送之前的必要步骤
await loomProvider.sendAsync(JSON.parse(jsonRPCString))

// 返回将是这样的
// {
//   "id":1,
//   "jsonrpc": "2.0",
//   "result": "0x"
// }

eth_getBlockByNumber

说明

按块编号返回有关块的信息。

参数

QUANTITY|TAG - 块编号的整数，或“最早”、“最新”、“未决”的默认块参数字符串。
Boolean - 如果为true，则返回完整的事务对象，如果为false，则仅返回事务的哈希值。

返回值

Object - 区块对象，或null当没有找到任何区块时：

number: QUANTITY - 块号。当区块待处理时为null。
hash: DATA, 32 字节 - 区块的哈希值。当区块待处理时为null。
parentHash: DATA`, 32字节 - 父块的哈希值。
logsBloom: DATA, 256字节 - 块日志的Bloom过滤器。当区块未处理时为null。
timestamp: QUANTITY - 用于核对区块的unix时间戳。
transactions: Array - 事务对象数组。或32字节事务哈希，具体取决于给定的最新参数。

示例

// eth_getBlockByNumber JSON RPC调用
const jsonRPCString = '{"jsonrpc":"2.0","method":"eth_getBlockByNumber","params":["0x1b4", true],"id":1}'

// Parse JSON是发送之前的必要步骤
await loomProvider.sendAsync(JSON.parse(jsonRPCString))

// 返回将是这样的
// {
// "id":1,
// "jsonrpc":"2.0",
// "result": {
//     "number": "0x1b4", // 436
//     "hash": "0xe670ec64341771606e55d6b4ca35a1a6b75ee3d5145a99d05921026d1527331",
//     "parentHash": "0x9646252be9520f6e71339a8df9c55e4d7619deeb018d2a3f2d21fc165dde5eb5",
//     "logsBloom": "0xe670ec64341771606e55d6b4ca35a1a6b75ee3d5145a99d05921026d1527331",
//     "timestamp": "0x54e34e8e" // 1424182926
//     "transactions": [{...},{ ... }]
//   }
// } }]
//   }
// }

eth_getBlockByHash

说明

通过哈希返回有关区块的信息。

参数

DATA - 32字节 - 区块的哈希。
Boolean - 如果为true，则返回完整的事务对象，如果为false，则仅返回事务的哈希值。

返回值

Object - 区块对象，或当没有找到任何区块时为null：

number: QUANTITY - 区块遍号。当区块待处理时为null。
hash: DATA, 32 字节 - 区块的哈希值。当区块待处理时为null。
parentHash: DATA, 32字节 - 父块的哈希值。
logsBloom: DATA, 256字节 - 区块日志的Bloom过滤器。当区块未处理时为null。
timestamp: QUANTITY - 用于核对区块的unix时间戳。
transactions: Array - 事务对象数组。或32字节事务哈希，具体取决于给定的最新参数。

示例

// eth_getBlockByHash JSON RPC调用
const jsonRPCString = '{"jsonrpc":"2.0","method":"eth_getTransactionByHash","params":["0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238"],"id":1}'

// Parse JSON是发送之前的必要步骤
await loomProvider.sendAsync(JSON.parse(jsonRPCString))

// 返回将是这样的
// {
// "id":1,
// "jsonrpc":"2.0",
// "result": {
//     "number": "0x1b4", // 436
//     "hash": "0xe670ec64341771606e55d6b4ca35a1a6b75ee3d5145a99d05921026d1527331",
//     "parentHash": "0x9646252be9520f6e71339a8df9c55e4d7619deeb018d2a3f2d21fc165dde5eb5",
//     "logsBloom": "0xe670ec64341771606e55d6b4ca35a1a6b75ee3d5145a99d05921026d1527331",
//     "timestamp": "0x54e34e8e" // 1424182926
//     "transactions": [{...},{ ...
  }]
//   }
// }

eth_getCode

说明

在给定地址处返回代码。

参数

DATA,20字节 - 地址

返回值

DATA - 来自给定地址的代码。

示例

// eth_getCode JSON RPC调用
const jsonRPCString = '{"jsonrpc":"2.0","method":"eth_getCode","params":["0xa94f5374fce5edbc8e2a8697c15331677e6ebf0b", "0x2"],"id":1}'

// Parse JSON是发送之前的必要步骤
await loomProvider.sendAsync(JSON.parse(jsonRPCString))

// 返回将是这样的
// {
//   "id":1,
//   "jsonrpc": "2.0",
//   "result": "0x600160008035811a818181146012578301005b601b6001356025565b8060005260206000f25b600060078202905091905056"
// }

eth_getFilterChanges

说明

过滤器的轮询方法，返回自上次轮询以来发生的日志数组。

参数

QUANTITY - 过滤器ID。

返回值

Array -日志对象数组, 如果自上次轮询以来没有任何更改, 则为空数组。

对于使用 eth_newBlockFilter 创建的过滤器, 返回是块的哈希值 (数据, 32 字节), 例如 ["0x3454645634534......"]。
对于使用 eth_newBlockFilter 创建的过滤器, 返回是事务的哈希值 (DATA, 32 字节), 例如 ["0x6345343454645......"]。
对于使用` eth_newFilter </ code>创建的过滤器，日志将是具有以下参数的对象：
removed: TAG - 由于链重新配置而删除日志时为true。如果它是一个有效日志，则为false。
logIndex：QUANTITY - 区块中日志索引位置的整数。当日志为待处理时为null。
transactionIndex：QUANTITY - 事务索引位置的整数，日志是由此创建的。当日志为待处理时为null。
- transactionHash：DATA，32字节 - 事务的哈希，这个日志根据此创建。当日志为待处理时为null。
- blockHash: DATA, 32 字节 - 这个日志所在区块的哈希。当它待处理时为null。当日志待处理时为null。
- blockNumber: QUANTITY - 这个日志所在的区块编号。当它待处理时为null。当日志待处理时为null。
- address: DATA, 20 字节 - 这个日志起源的地址。
- data: DATA - 包含日志的一个或多个32字节的非索引参数。
- topics: Array of DATA - 数组0到 4 32 字节索引日志参数的DATA。（在Solidity：第一个topic是事件（例如Deposit(address,bytes32,uint256)）签名的哈希，除非你用匿名说明符声明了该事件。）
示例
```
// eth_getFilterChanges JSON RPC调用
const jsonRPCString = '{"jsonrpc":"2.0","method":"eth_getFilterChanges","params":["0x16"],"id":73}'

// Parse JSON是发送之前的必要步骤
await loomProvider.sendAsync(JSON.parse(jsonRPCString))

// 返回将是这样的
// {
//   "id":1,
//   "jsonrpc":"2.0",
//   "result": [{
//     "logIndex": "0x1", // 1
//     "blockNumber":"0x1b4", // 436
//     "blockHash": "0x8216c5785ac562ff41e2dcfdf5785ac562ff41e2dcfdf829c5a142f1fccd7d",
//     "transactionHash":  "0xdf829c5a142f1fccd7d8216c5785ac562ff41e2dcfdf5785ac562ff41e2dcf",
//     "transactionIndex": "0x0", // 0
//     "address": "0x16c5785ac562ff41e2dcfdf829c5a142f1fccd7d",
//     "data":"0x0000000000000000000000000000000000000000000000000000000000000000",
//     "topics": ["0x59ebeb90bc63057b6515673c3ecf9438e5058bca0f92585014eced636878c9a5"]
//     },{
//       ...
//     }]
// }
```
eth_getLogs

说明

返回与给定过滤器对象匹配的所有日志的数组。

参数
1. Object - 过滤器选项：
- fromBlock: QUANTITY|TAG - (可选，默认："latest") 整数区块号，或最后挖出来的区块链或”pending“（待处理）为“latest“（最新），还没有挖的事务为”earliest“（最早）。
- toBlock: QUANTITY|TAG - (可选，默认："latest") 整数区块号，或最后挖出来的区块链或”pending“（待处理）为“latest“（最新），还没有挖的事务为”earliest“（最早）。
- address: DATA|数组, 20 字节 - (可选) 合约地址或者日志应该由此起源的地址列表。
- topics: DATA的数组 - (可选) 32 字节的DATA 主题的数组。主题是与顺序相关的。每个主题也可以是 DATA 的数组，其中有 "or" 选项。
- blockhash: DATA, 32 字节 - (可选, 未来) 添加 EIP-234 后，blockHash 将成为新的过滤器选项，它使用32字节的哈希 blockHash 来限制返回到单个区块的日志。使用 blockHash 等同于 fromBlock = toBlock = 带有哈希 blockHash 的区块号。如果过滤器条件中出现了 blockHash，则 fromBlock 和 toBlock 都不会被允许。
返回值

请参见 eth_getFilterChanges

示例
```
// eth_getFilterChanges JSON RPC call
const jsonRPCString = '{"jsonrpc":"2.0","method":"eth_getLogs","params":[{"topics":["0x000000000000000000000000a94f5374fce5edbc8e2a8697c15331677e6ebf0b"]}],"id":74}'

// 解析JSON是发送等待loomProvider.sendAsync(JSON.parse(jsonRPCString)之前的必要步骤)
```
结果请参见 eth_getFilterChanges

eth_getTransactionReceipt

说明

通过事务哈希返回事务的回执。

注意该回执对于待处理事务记录不可用。

参数
1. DATA，32 字节 - 事务哈希
返回值

Object - 事务收据对象，或null当没有找到任何回执时：
- transactionHash: DATA, 32字节 - 事务哈希。
- transactionIndex: QUANTITY - 区块中事务索引位置的整数。
- blockHash: DATA, 32 字节 - 此事务所在区块的哈希。
- blockNumber: QUANTITY - 此事务所在的区块号。
- from: DATA, 20 字节 - 发送者的地址。
- to: DATA, 20 字节 - 接受者的地址。当它是一个合约创建事务时为null。
- contractAddress: DATA, 20 字节 - 如果事务是一个合约创建，则合约地址被创建，否则为null。
- logs: Array - 日志对象的数组，这个事务被生成。
- status: QUANTITY 1 (成功) 或 0 (失败)
示例
```
// eth_getTransactionReceipt JSON RPC call
const jsonRPCString = '{"jsonrpc":"2.0","method":"eth_getTransactionReceipt","params":["0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238"],"id":1}'

// Parse JSON is a necessary step before send
await loomProvider.sendAsync(JSON.parse(jsonRPCString))

// Return should be something like
// {
// "id":1,
// "jsonrpc":"2.0",
// "result": {
//      transactionHash: '0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238',
//      transactionIndex:  '0x1', // 1
//      blockNumber: '0xb', // 11
//      blockHash: '0xc6ef2fc5426d6ad6fd9e2a26abeab0aa2411b7ab17f30a99d3cb96aed1d1055b',
//      contractAddress: '0xb60e8dd61c5d32be8058bb8eb970870f07233155', // or null, if none was created
//      logs: [{
//          // logs as returned by getFilterLogs, etc.
//      }, ...],
//      status: '0x1'
//   }
// }
```
eth_newBlockFilter

说明

在节点内创建一个过滤器，当新的未决事务抵达的时候通知。想查询状态是否已经改变，调用eth_getFilterChanges。

参数

无

返回值

QUANTITY - 过滤器ID。

示例
```
// eth_newBlockFilter JSON RPC call
const jsonRPCString = '{"jsonrpc":"2.0","method":"eth_newBlockFilter","params":[],"id":73}'

// Parse JSON is a necessary step before send
await loomProvider.sendAsync(JSON.parse(jsonRPCString))

// Return should be something like
// {
//   "id":1,
//   "jsonrpc":  "2.0",
//   "result": "0x1" // 1
// }
```
eth_newFilter

说明

基于过滤器选项，创建一个过滤器对象，当状态改变（记录）时通知。想查询状态是否已经改变，调用 eth_getFilterChanges。

关于指定主题过滤器的注释：

主题是依赖于顺序的。具有主题[a，b] 的日志的事务将由以下主题过滤器匹配：
- [] "任意"
- [A] "A 在首位 (后面任意)"
- [null, B] "首位任何都可以 AND B 在第二位 (然后后面任意)"
- [A, B] "A 在首位 AND B 在第二位 (然后后面任意)"
- [[A, B], [A, B]] "(A OR B) 在首位 AND (A OR B) 在第二位 (后面任意)"
参数
1. Object - 过滤器选项：
- fromBlock: QUANTITY|TAG - (可选，默认："latest") 整数区块号，或最后挖出来的区块链或”pending“（待处理）为“latest“（最新），还没有挖的事务为”earliest“（最早）。
- toBlock: QUANTITY|TAG - (可选，默认："latest") 整数区块号，或最后挖出来的区块链或”pending“（待处理）为“latest“（最新），还没有挖的事务为”earliest“（最早）。
- address: DATA|数组, 20 字节 - (可选) 合约地址或者日志应该起源的地址列表。
- topics: Array of DATA, - (可选) 32字节DATA主题的数组。主题是依赖于顺序的。每个主题也可以是带有“or”选项的DATA数组。
返回值

QUANTITY - 过滤器ID。

示例
```
// eth_newFilter JSON RPC call
const jsonRPCString = '{"jsonrpc":"2.0","method":"eth_newFilter","params":[{"topics":["0x12341234"]}],"id":73}'

// Parse JSON is a necessary step before send
await loomProvider.sendAsync(JSON.parse(jsonRPCString))

// Return should be something like
// {
//   "id":1,
//   "jsonrpc": "2.0",
//   "result": "0x1" // 1
// }
```
eth_sendTransaction

说明

如果数据字段包含代码, 则创建新的消息调用事务或创建合约。

参数
1. Object - 事务对象
- from: DATA, 20 字节 - 发送事务的地址。
- to: DATA，20 字节 - (创建新合约时可选) 事务指向的地址。
- data: DATA - 已编译的合约代码或调用方法签名和编码参数的哈希。详情见Ethereum Contract ABI
返回值

DATA, 32 字节 - 事务哈希，或如果事务尚未可用，则为零哈希。

在创建合约后, 使用 eth_getTransactionReceipt 获取合约地址 (在事务被挖后)。

示例
```
// eth_sendTransaction JSON RPC call
const jsonRPCString = '{"jsonrpc":"2.0","method":"eth_sendTransaction","params":[{see above}],"id":1}'

// Parse JSON is a necessary step before send
await loomProvider.sendAsync(JSON.parse(jsonRPCString))

// Return should be something like
// {
//   "id":1,
//   "jsonrpc": "2.0",
//   "result": "0xe670ec64341771606e55d6b4ca35a1a6b75ee3d5145a99d05921026d1527331"
// }
```
eth_subscribe

说明

通过订阅特定事件运行。节点会返回订阅id。对于与订阅匹配的每个事件，与相关数据一起的通知与订阅ID将被一起发送。

参数
1. object, 具有以下 (可选) 字段
- address, 地址或地址数组。仅返回从这些地址创建的日志 (可选)
- topics, 仅与指定主题匹配的日志 (可选)
返回值

订阅 id

示例
```
// eth_subscribe JSON RPC call
const jsonRPCString = '{"id": 1, "method": "eth_subscribe", "params": ["logs", {"address": "0x8320fe7702b96808f7bbc0d4a888ed1468216cfd", "topics": ["0xd78a0cb8bb633d06981248b816e7bd33c2a35a6089241d099fa519e361cab902"]}]}'

// Parse JSON is a necessary step before send
await loomProvider.sendAsync(JSON.parse(jsonRPCString))

// Return should be something like
// {
//   "jsonrpc":"2.0",
//   "id":2,
//   "result":"0x4a8a4c0517381924f9838102c5a4dcb7"
// }
```
eth_uninstallFilter

说明

卸载具有给定id的过滤器。当不再需要监视的时候，应该总是被调用。另外，当过滤器在一段时间不被eth_getFilterChanges 请求的话将过期。

参数
1. QUANTITY - 过滤器ID。
返回值

Boolean - true 如果过滤器成功被卸载，否则 false。

示例
```
// eth_uninstallFilter JSON RPC call
const jsonRPCString = '{"jsonrpc":"2.0","method":"eth_uninstallFilter","params":["0xb"],"id":73}'

// Parse JSON is a necessary step before send
await loomProvider.sendAsync(JSON.parse(jsonRPCString))

// Return should be something like
// {
//   "id":1,
//   "jsonrpc": "2.0",
//   "result": true
// }
```
net_version

说明

返回当前网络id。

参数

无

返回值

String - 当前网络id。
- "474747": 当前已定义网络id, 返回的数字仅为 474747
示例
```
// net_version JSON RPC call
const jsonRPCString = '{"jsonrpc":"2.0","method":"net_version","params":[],"id":67}'

// Parse JSON is a necessary step before send
await loomProvider.sendAsync(JSON.parse(jsonRPCString))

// Return should be something like
// {
//   "id":67,
//   "jsonrpc": "2.0",
//   "result": "474747"
// }
```

Karma Hardware Security Modules

# 概述

# LoomProvider 调用 JSON RPC 方法

# eth_accounts

# 说明

# 参数

# 返回值

# 示例

# eth_blockNumber

# 说明

# 参数

# 返回值

# 示例

# eth_call

# 说明

# 参数

# 返回值

# 示例

# eth_getBlockByNumber

# 说明

# 参数

# 返回值

# 示例

# eth_getBlockByHash

# 说明

# 参数

# 返回值

# 示例

# eth_getCode

# 说明

# 参数

# 返回值

# 示例

# eth_getFilterChanges

# 说明

# 参数

# 返回值

# 示例

# eth_getLogs

# 说明

# 参数

# 返回值

# 示例

# eth_getTransactionReceipt

# 说明

# 参数

# 返回值

# 示例

# eth_newBlockFilter

# 说明

# 参数

# 返回值

# 示例

# eth_newFilter

# 说明

# 关于指定主题过滤器的注释：

# 参数

# 返回值

# 示例

# eth_sendTransaction

# 说明

# 参数

# 返回值

# 示例

# eth_subscribe

# 说明

# 参数

# 返回值

# 示例

# eth_uninstallFilter

# 说明

# 参数

# 返回值

# 示例

# net_version

# 说明

# 参数

# 返回值

# 示例

概述

LoomProvider 调用 JSON RPC 方法

eth_accounts

说明

参数

返回值

示例

eth_blockNumber

说明

参数

返回值

示例

eth_call

说明

参数

返回值

示例

eth_getBlockByNumber

说明

参数

返回值

示例

eth_getBlockByHash

说明

参数

返回值

示例

eth_getCode

说明

参数

返回值

示例

eth_getFilterChanges

说明

参数

返回值

示例

eth_getLogs

说明

参数

返回值

示例

eth_getTransactionReceipt

说明

参数

返回值

示例

eth_newBlockFilter

说明

参数

返回值

示例

eth_newFilter

说明

关于指定主题过滤器的注释：

参数

返回值

示例

eth_sendTransaction

说明

参数

返回值

示例

eth_subscribe

说明

参数

返回值

示例

eth_uninstallFilter

说明

参数

返回值

示例

net_version

说明

参数

返回值

示例