此篇内容尚无原站英文对应版本;切换语言后可浏览英文资料库。
检索关于公共分类帐的信息。
请求格式的示例:
该
以下字段弃用的并且可以在不另行通知被删除:
如果请求指定
可能的错误:
{
"id": 14,
"command": "ledger",
"ledger_index": "validated",
"full": false,
"accounts": false,
"transactions": false,
"expand": false,
"owner_funds": false
}
{
"method": "ledger",
"params": [
{
"ledger_index": "validated",
"accounts": false,
"full": false,
"transactions": false,
"expand": false,
"owner_funds": false
}
]
}
#Syntax: ledger ledger_index|ledger_hash [full|tx] # "full" is equivalent to "full": true # "tx" is equivalent to "transactions": true streamd ledger current该请求可以包含以下参数:
Field |
Type | Description |
|---|---|---|
ledger_hash |
String | (可选)要使用的分类帐版本的20字节十六进制字符串。(请参阅指定分类帐) |
ledger_index |
String or Unsigned Integer | (可选)要使用的分类帐的序号或快捷字符串自动选择分类帐。(请参阅指定分类帐) |
full |
Boolean | (可选) 需要管理员。如果true返回整个分类帐的完整信息。如果您未指定分类账版本,则忽略。默认为false。(相当于启用transactions,accounts和expand)注意:这是一个非常大量的数据 - 数百兆字节! |
accounts |
Boolean | (可选) 需要管理员。如果true,返回账簿中的账户信息。如果您未指定分类账版本,则忽略。默认为false。警告:这会返回大量的数据! |
transactions |
Boolean | (可选)如果true返回指定分类帐版本中的交易信息。默认为false。如果您未指定分类账版本,则忽略。 |
expand |
Boolean | (可选)为交易/帐户信息提供完整的JSON格式信息,而不仅仅是散列。默认为false。除非您请求交易或帐户,否则将被忽略。 |
owner_funds |
Boolean | (可选)如果在响应中的OfferCreate事务的元数据中true包含owner_funds字段。默认为false。忽略除非包含交易并且expand是真实的。 |
binary |
Boolean | (可选)如果true和transactions和expand都同时true以二进制格式(十六进制字符串)而不是JSON格式返回事务信息。 |
queue |
Boolean | (可选)如果true,并且该命令正在请求current分类帐,则会在结果中包含排队的事务数组。 |
ledger字段已弃用,可能会被删除,恕不另行通知。
一个成功回应的例子:
{
"id": 14,
"result": {
"ledger": {
"accepted": true,
"account_hash": "C3FED0CFCF26EF342D1213435258C9EB3098620FC2096DFFA1244B333386E64E",
"close_time": 575706870,
"close_time_human": "2018-Mar-30 06:34:30",
"close_time_resolution": 10,
"closed": true,
"hash": "03B5A2196152202BFD2F78CEE331ED05AF33D0C381BFD9F168A25C14FCF60870",
"ledger_hash": "03B5A2196152202BFD2F78CEE331ED05AF33D0C381BFD9F168A25C14FCF60870",
"ledger_index": "156118",
"parent_hash": "DEEC565070B7689FC64F6B64DEAD224DCFF037E8A85D8C237627C6460B3EB95B",
"seqNum": "156118",
"totalCoins": "99999999999992838",
"total_coins": "99999999999992838",
"transaction_hash": "0000000000000000000000000000000000000000000000000000000000000000"
},
"ledger_index": 156118,
"validated": true
},
"status": "success",
"type": "response"
}
200 OK
{
"result": {
"ledger": {
"accepted": true,
"account_hash": "C3FED0CFCF26EF342D1213435258C9EB3098620FC2096DFFA1244B333386E64E",
"close_time": 575706870,
"close_time_human": "2018-Mar-30 06:34:30",
"close_time_resolution": 10,
"closed": true,
"hash": "03B5A2196152202BFD2F78CEE331ED05AF33D0C381BFD9F168A25C14FCF60870",
"ledger_hash": "03B5A2196152202BFD2F78CEE331ED05AF33D0C381BFD9F168A25C14FCF60870",
"ledger_index": "156118",
"parent_hash": "DEEC565070B7689FC64F6B64DEAD224DCFF037E8A85D8C237627C6460B3EB95B",
"seqNum": "156118",
"totalCoins": "99999999999992838",
"total_coins": "99999999999992838",
"transaction_hash": "0000000000000000000000000000000000000000000000000000000000000000"
},
"ledger_index": 156118,
"validated": true
},
"status": "success",
"type": "response"
}
响应遵循标准格式,成功结果包含有关分类账的信息,包括以下字段:
Field |
Type | Description |
|---|---|---|
ledger |
Object | 此分类帐的完整标题数据。 |
ledger.account_hash |
String | 以十六进制格式显示此分类帐中所有帐户状态信息的散列 |
ledger.accountState |
Array | (除非有请求,则省略)此分类帐中的所有帐户状态信息。 |
ledger.close_time |
Integer | 这个分类帐的时间在Stream Epoch以后几秒钟内关闭 |
ledger.close_time_human |
String | 这个分类帐的时间以可读的格式关闭 |
ledger.close_time_resolution |
Integer | 总帐关闭时间在这几秒钟内四舍五入。 |
ledger.closed |
Boolean | 这个分类帐是否已经关闭 |
ledger.ledger_hash |
String | 唯一标识整个分类帐的散列。 |
ledger.ledger_index |
String | 该分类帐的总帐索引,作为引用的整数 |
ledger.parent_hash |
String | 唯一标识在此之前出现的分类帐的散列。 |
ledger.total_coins |
String | 作为引用的整数,网络中的STM下降总数。(这会随着交易成本销毁STM而降低。) |
ledger.transaction_hash |
String | 包含在此分类帐中的交易信息散列,如十六进制 |
ledger.transactions |
Array | (未请求时省略)在此分类帐版本中应用的交易。默认情况下,成员是交易'识别哈希字符串。如果请求指定expand为true,则成员完全是交易的表示形式,而不是JSON或二进制形式,具体取决于请求是否指定binary为true。 |
ledger_hash |
String | 唯一标识整个分类帐的散列。 |
ledger_index |
Number | 该分类帐的总帐索引。 |
queue_data |
Array | (除非使用queue参数请求,否则忽略)按照与队列相同的顺序描述排队事务的对象数组。如果请求指定expand为true,则成员包含事务的完整表示,可以采用JSON或二进制形式,具体取决于请求是否指定binary为true。需要费用修正。 |
accepted,hash,seqNum,totalCoins。
queue_data数组的每个成员表示队列中的一个事务。此对象的某些字段可能会因为尚未计算而被忽略。该对象的字段如下所示:
| Field | Value | Description |
|---|---|---|
account |
String | 该地址发送此排队交易。 |
tx |
String or Object | 默认情况下,这是一个包含事务标识哈希的字符串。如果事务以二进制格式扩展,那么这是一个对象,它的唯一字段是tx_blob,以十进制字符串形式包含事务的二进制形式。如果事务以JSON格式扩展,则这是一个包含事务对象的对象,包括事务在该hash字段中标识的散列。 |
retries_remaining |
Number | 此次交易在被投放前可以重试多少次。 |
preflight_result |
String | 初步交易检查的初步结果。这总是tesSUCCESS。 |
last_result |
String | (可以省略)如果这个事务在得到retriable(ter)结果后留在队列中,这就是ter它得到的确切结果代码。 |
auth_change |
Boolean | (可以省略)此事务是否更改此地址授权事务的方式。 |
fee |
String | (可能省略)此交易的交易成本,以STM为单位。 |
fee_level |
String | (可以省略)此交易的交易成本,相对于此类交易的最低成本,以费用级别表示。 |
max_spend_drops |
String | (也可以省略) STM的最大量,in drops,该交易可能发送或破坏。 |
"owner_funds": true并扩展了事务,则响应owner_funds在metaData每个OfferCreate-type事务的对象中都有一个字段。这个领域的目的是为了更容易地跟踪每个新的经过验证的分类账的供应资金状况。此字段的定义与Order Book订购流中该字段的版本稍有不同:
Field |
值 | 描述 |
|---|---|---|
owner_funds |
String | 在此分类账中执行所有交易后TakerGets,Account发送此OfferCreate交易的货币的数量金额。这不检查货币金额是否被冻结。 |
- 任何通用错误类型。
invalidParams- 一个或多个字段指定不正确,或缺少一个或多个必填字段。lgrNotFound- 由ledger_hash或者ledger_index不存在的分类账,或者确实存在,但服务器没有。noPermission- 如果您指定full或者accounts为true,但没有以管理员身份连接到服务器(通常,admin需要连接本地端口)。
