snarkos-rpc

在Aleo上，完整节点运行一个JSON-RPC服务器，以启用API调用以获取数据和与网络中连接的节点进行交互。

RPC端口

snarkos --rpc-port 3030

默认RPC端口为3030。可以通过在启动节点时使用--rpc-port标志来指定自定义RPC端口。

私有RPC端点的身份验证

snarkos --rpc-username {USERNAME} --rpc-password {PASSWORD}

RPC服务器公开受保护的RPC端点，用于执行特定于账户的操作，如创建账户、创建交易和获取记录承诺。可以向受保护的RPC端点的RPC请求中添加身份验证头。

要启用此身份验证层，请在启动完整节点时提供身份验证凭据到--rpc-username和--rpc-password标志。

decoderawtransaction

从序列化交易字节返回有关交易的信息。

参数

响应

示例

curl --data-binary '{"jsonrpc": "2.0", "id":"documentation", "method": "decoderawtransaction", "params": ["transaction_hexstring"] }' -H 'content-type: application/json' http://127.0.0.1:3030/

getbestblockhash

返回最佳有效链的头部块哈希。

参数

None

响应

示例

curl --data-binary '{"jsonrpc": "2.0", "id":"documentation", "method": "getbestblockhash", "params": [] }' -H 'content-type: application/json' http://127.0.0.1:3030/

getblock

根据块哈希返回有关块的信息。

参数

响应

示例

curl --data-binary '{"jsonrpc": "2.0", "id":"documentation", "method": "getblock", "params": ["caf49293d36f0215cfb3296dbc871a0ef5e5dcfc61f91cd0c9ac2c730f84d853"] }' -H 'content-type: application/json' http://127.0.0.1:3030/

getblockcount

返回最佳有效链中的块数量。

参数

None

响应

示例

curl --data-binary '{"jsonrpc": "2.0", "id":"documentation", "method": "getblockcount", "params": [] }' -H 'content-type: application/json' http://127.0.0.1:3030/

getblockhash

返回最佳有效链中给定块高度的块哈希。

参数

响应

示例

curl --data-binary '{"jsonrpc": "2.0", "id":"documentation", "method": "getblockhash", "params": [100] }' -H 'content-type: application/json' http://127.0.0.1:3030/

getblocktemplate

返回此节点所知的当前内存池和共识信息。

参数

None

响应

示例

curl --data-binary '{"jsonrpc": "2.0", "id":"documentation", "method": "getblocktemplate", "params": [] }' -H 'content-type: application/json' http://127.0.0.1:3030/

getconnectioncount

返回此节点连接的节点数。

参数

None

响应

示例

curl --data-binary '{"jsonrpc": "2.0", "id":"documentation", "method": "getconnectioncount", "params": [] }' -H 'content-type: application/json' http://127.0.0.1:3030/

getnetworkgraph

返回此节点爬取的网络图（如果它是爬虫）。

参数

None

响应

示例

curl --data-binary '{"jsonrpc": "2.0", "id":"documentation", "method": "getnetworkgraph", "params": [] }' -H 'content-type: application/json' http://127.0.0.1:3030/

getnodeinfo

返回有关节点的信息。

参数

None

响应

示例

curl --data-binary '{"jsonrpc": "2.0", "id":"documentation", "method": "getnodeinfo", "params": [] }' -H 'content-type: application/json' http://127.0.0.1:3030/

getnodestats

返回与节点相关的统计信息。

参数

None

响应

示例

curl --data-binary '{"jsonrpc": "2.0", "id":"documentation", "method": "getnodestats", "params": [] }' -H 'content-type: application/json' http://127.0.0.1:3030/

getpeerinfo

返回节点已连接的对等节点。

参数

None

响应

示例

curl --data-binary '{"jsonrpc": "2.0", "id":"documentation", "method": "getpeerinfo", "params": [] }' -H 'content-type: application/json' http://127.0.0.1:3030/

getrawtransaction

根据交易ID返回交易的十六进制编码的字节。

参数

响应

示例

curl --data-binary '{"jsonrpc": "2.0", "id":"documentation", "method": "getrawtransaction", "params": ["83fc73b8a104d7cdabe514ec4ddfeb7fd6284ff8e0a757d25d8479ed0ffe608b"] }' -H 'content-type: application/json' http://127.0.0.1:3030/

gettransactioninfo

根据交易ID返回关于交易的详细信息。

参数

响应

示例

curl --data-binary '{"jsonrpc": "2.0", "id":"documentation", "method": "gettransactioninfo", "params": ["83fc73b8a104d7cdabe514ec4ddfeb7fd6284ff8e0a757d25d8479ed0ffe608b"] }' -H 'content-type: application/json' http://127.0.0.1:3030/

sendtransaction

将原始交易字节发送到该节点以将其添加到内存池。如果有效，交易将被存储并传播给所有对等节点。

参数

响应

示例

curl --data-binary '{"jsonrpc": "2.0", "id":"documentation", "method": "sendtransaction", "params": ["transaction_hexstring"] }' -H 'content-type: application/json' http://127.0.0.1:3030/

validaterawtransaction

验证交易并返回交易是否有效。

参数

响应

示例

curl --data-binary '{"jsonrpc": "2.0", "id":"documentation", "method": "validaterawtransaction", "params": ["transaction_hexstring"] }' -H 'content-type: application/json' http://127.0.0.1:3030/

connect

将给定的地址添加到节点的对等节点列表并尝试连接到它们。

受保护端点

是

参数

响应

null

示例

curl --user username:password --data-binary '{"jsonrpc": "2.0", "id":"1", "method": "connect", "params": ["127.0.0.1:4141", "127.0.0.1:4142"] }' -H 'content-type: application/json' http://127.0.0.1:3030/

createaccount

创建新的账户私钥及其对应的账户地址。

受保护端点

是

参数

None

响应

示例

curl --user username:password --data-binary '{"jsonrpc": "2.0", "id":"documentation", "method": "createaccount", "params": [] }' -H 'content-type: application/json' http://127.0.0.1:3030/ 

createrawtransaction

创建新的交易并返回编码的交易以及编码的记录。

受保护端点

是

参数

Transaction Recipient Object

响应

示例

curl --user username:password --data-binary '{ 
    "jsonrpc":"2.0",
    "id": "1",
    "method": "createrawtransaction",
    "params": [
       {
        "old_records": ["record_hexstring"],
        "old_account_private_keys": ["private_key_string"],
        "recipients": [{
                "address": "address_string",
                "amount": amount
        }],
        "memo": "memo_hexstring",
        "network_id": 0
       }
    ]
}' -H 'content-type: application/json' http://127.0.0.1:3030/

createtransaction

从给定的交易内核创建新的交易，并返回编码的交易和新记录。

受保护端点

是

参数

响应

示例

curl --user username:password --data-binary '{ 
    "jsonrpc":"2.0",
    "id": "1",
    "method": "createtransaction",
    "params": ["[private_key_0, private_key_1]", "transaction_kernel_hexstring"]
}' -H 'content-type: application/json' http://127.0.0.1:3030/

createtransactionkernel

创建新的交易内核。

受保护端点

是

参数

Transaction Recipient Object

响应

示例

curl --user username:password --data-binary '{ 
    "jsonrpc":"2.0",
    "id": "1",
    "method": "createtransactionkernel",
    "params": [
       {
        "old_records": ["record_hexstring"],
        "old_account_private_keys": ["private_key_string"],
        "recipients": [{
                "address": "address_string",
                "amount": amount
        }],
        "memo": "memo_hexstring",
        "network_id": 0
       }
    ]
}' -H 'content-type: application/json' http://127.0.0.1:3030/

decoderecord

从序列化的记录十六进制中返回关于记录的信息。

参数

响应

示例

curl --data-binary '{"jsonrpc": "2.0", "id":"documentation", "method": "decoderecord", "params": ["record_hexstring"] }' -H 'content-type: application/json' http://127.0.0.1:3030/

decryptrecord

解密加密记录并返回记录的十六进制编码字节。

参数

响应

示例

curl --user username:password --data-binary '{ 
    "jsonrpc":"2.0",
    "id": "1",
    "method": "decryptrecord",
    "params": [
       {
        "encrypted_record": "encrypted_record_string",
        "account_view_key": "account_view_key_string"
       }
    ]
}' -H 'content-type: application/json' http://127.0.0.1:3030/

disconnect

从给定地址断开节点连接。

受保护端点

是

参数

响应

null

示例

curl --user username:password --data-binary '{"jsonrpc": "2.0", "id":"1", "method": "disconnect", "params": ["127.0.0.1:4141"] }' -H 'content-type: application/json' http://127.0.0.1:3030/

getrawrecord

根据记录承诺返回记录的十六进制编码字节。

受保护端点

是

参数

响应

示例

curl --user username:password --data-binary '{"jsonrpc": "2.0", "id":"documentation", "method": "getrawrecord", "params": ["86be61d5f3bd795e31615d6834efefca01ad023d57c0383e2231e094bcabfc05"] }' -H 'content-type: application/json' http://127.0.0.1:3030/ 

getrecordcommitmentcount

返回全节点上存储的记录承诺数量。

受保护端点

是

参数

None

响应

示例

curl --user username:password --data-binary '{"jsonrpc": "2.0", "id":"documentation", "method": "getrecordcommitmentcount", "params": [] }' -H 'content-type: application/json' http://127.0.0.1:3030/ 

getrecordcommitments

返回全节点上存储的记录承诺列表。

受保护端点

是

参数

None

响应

示例

curl --user username:password --data-binary '{"jsonrpc": "2.0", "id":"documentation", "method": "getrecordcommitments", "params": [] }' -H 'content-type: application/json' http://127.0.0.1:3030/ 

贡献

如何更新此README

本README文件是在持续集成过程中自动生成的。要更新此README文件，请提交一个更新相应Markdown文件的pull request，该文件位于文档和配置文件中。