rippled
服务器通信,则可以使用WebSocket API或JSON-RPC API。两个API都使用相同的命令列表,每个命令中的参数几乎完全相同。或者,您可以使用RippleAPI,它是一个简化的JavaScript客户端库,可直接与rippled
来自Node.js或Web浏览器的服务器进行通信。rippled
服务器可被配置为接受固定(WSS :),无担保(WS :) WebSocket连接,或两者。rippled
可以将服务器配置为接受HTTP,HTTPS或两者。)对于提示多个响应的命令,可以提供回调URL。一般来说,我们推荐使用WebSocket,因为WebSocket的推送范例具有较少的延迟和较少的网络开销。WebSocket也更可靠; 您可以不用担心丢失的消息和建立多个连接。另一方面,对JSON-RPC有广泛的支持,因为您可以使用标准的HTTP库来连接到rippled
JSON-RPC API。
注意:该rippled
程序还可以用作快速命令行客户端向正在运行的rippled
服务器发出JSON-RPC请求。命令行界面仅用于管理目的,并不是受支持的API。
WebSocket和JSON-RPC API仍在开发中,并且可能会发生变化。如果您希望收到即将发生的更改和未来版本的通知rippled
,请订阅Ripple服务器邮件列表:
https://groups.google.com/forum/#!forum/ripple-server
在可以针对rippled
服务器运行任何命令之前,您必须知道要连接到哪个服务器。大多数服务器都配置为不直接接受来自外部网络的API请求。
或者,您可以运行自己的本地副本rippled
。如果您想访问任何管理命令,则这是必需的。在这种情况下,您应该使用您配置服务器绑定的任何IP和端口。(例如127.0.0.1:54321
)此外,要访问管理功能,您必须从配置文件中的标记为admin的端口/ IP地址进行连接。
的示例配置文件侦听本地环回网络(127.0.0.1)上的连接,在端口6006上的端口5005和网页套接字(WS)JSON-RPC(HTTP),和将所有连接的客户端作为管理员。
如果您正在尝试使用XRP分类帐中的某些方法,则可以跳过编写自己的WebSocket代码并直接在Ripple WebSocket API工具中使用该API 。稍后,当您想连接到自己的rippled
服务器时,可以在浏览器或Node.js中构建自己的客户端。
打开WebSocket到rippled
服务器后,可以使用以下属性作为JSON对象发送命令:
"command"
字段中"id"
任意值的字段。对此请求的响应使用相同的"id"
字段。这样,即使响应按顺序到达,您也知道哪个请求会提示哪个响应。响应来自JSON对象。
目前Ripple(公司)在以下地区维护一套公共WebSocket服务器:
Domain |
港口 | 笔记 |
---|---|---|
s1.ripple.com |
443 | wss:// 只要; 通用服务器 |
s2.ripple.com |
443 | wss:// 只要; 全历史服务器 |
这些公共服务器不适合持续或商业用途,并且可能随时无法使用。对于常规使用,您应该运行自己的rippled
服务器或与您信任的人签约。
您可以使用任何HTTP客户端(例如Poster for Firefox或Postman for Chrome)将JSON-RPC调用为rippled
服务器。大多数编程语言都有一个用于创建HTTP请求的库。
要发出JSON-RPC请求,请将HTTP POST请求发送到服务器正在侦听JSON-RPC连接/
的端口和IP上的根路径()rippled
。您可以使用HTTP / 1.0或HTTP / 1.1。如果你使用HTTPS,你应该使用TLS v1.2。出于安全原因,rippled
不支持 SSL v3或更早版本。
始终包含一个Content-Type
包含值的标题application/json
。
如果您打算提出多个请求,请使用Keep-Alives,以便您不必关闭并重新打开请求之间的连接。
将请求主体作为具有以下属性的JSON对象发送:
"method"
字段中"params"
字段。这个字段的内容应该是一个只包含一个嵌套JSON对象并包含该命令所有参数的单项数组。响应也是一个JSON对象。
目前,Ripple(公司)在以下地区维护一套公共JSON-RPC服务器:
Domain |
港口 | 笔记 |
---|---|---|
s1.ripple.com |
51234 | 通用服务器 |
s2.ripple.com |
51234 | 全历史服务器 |
这些公共服务器不适合持续或商业用途,并且可能随时无法使用。对于常规使用,您应该运行自己的rippled
服务器或与您信任的人签约。
命令行界面连接到与JSON-RPC相同的服务,因此公共服务器和服务器配置相同。作为命令行客户端,rippled
连接到本地实例。例如:
rippled --conf=/etc/rippled.cfg server_info
注意:命令行界面仅用于管理目的,并不是受支持的API。
命令行将命令放在任何常规(以破折号为前缀的)命令行选项之后,后面是一组有限的参数,以空格分隔。对于可能包含空格或其他不常用字符的任何参数值,请使用单引号将其封装起来。
{
"id": 2,
"command": "account_info",
"account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"strict": true,
"ledger_index": "validated"
}
{
"id": 2,
"status": "success",
"type": "response",
"result": {
"account_data": {
"Account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"Balance": "27389517749",
"Flags": 0,
"LedgerEntryType": "AccountRoot",
"OwnerCount": 18,
"PreviousTxnID": "B6B410172C0B65575D89E464AF5B99937CC568822929ABF87DA75CBD11911932",
"PreviousTxnLgrSeq": 6592159,
"Sequence": 1400,
"index": "4F83A2CF7E70F77F79A307E6A472BFC2585B806A70833CCD1C26105BAE0D6E05"
},
"ledger_index": 6760970
}
}
成功回应的领域包括:
Field |
类型 | 描述 |
---|---|---|
id |
(可变) | (仅限WebSocket)在提示此响应的请求中提供的ID |
status |
串 | (仅限WebSocket)该值success 表示服务器已成功接收并理解该请求。 |
result.status |
串 | (JSON-RPC和Commandline)该值success 表示服务器已成功接收并理解该请求。 |
type |
串 | (仅限WebSocket)该值response 表示对命令的成功响应。异步通知使用不同的值,例如ledgerClosed 或transaction 。 |
result |
目的 | 查询的结果; 内容因命令而异。 |
命令行方法的响应格式与JSON-RPC响应相同,因为它们使用相同的接口。
列出可能发生错误的所有可能方式是不可能的。有些可能发生在传输层(例如,网络连接丢失),在这种情况下,结果会因您使用的客户端和传输方式而异。但是,如果rippled
服务器成功接收到您的请求,它会尝试以标准化错误格式进行响应。
一些示例错误:
{
"id": 3,
"status": "error",
"type": "response",
"error": "ledgerIndexMalformed",
"request": {
"account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"command": "account_info",
"id": 3,
"ledger_index": "-",
"strict": true
}
}
Field |
类型 | 描述 |
---|---|---|
id |
(可变) | 提供此响应的Web套接字请求中提供的ID |
status |
串 | "error" 如果请求导致错误 |
type |
串 | 通常"response" ,这表示对命令的成功响应。 |
error |
串 | 发生错误类型的唯一代码 |
request |
目的 | 以JSON格式提示此错误的请求副本。警告:如果请求包含任何帐户机密,则将其复制到此处! |
某些JSON-RPC请求会在HTTP层上响应一个错误代码。在这些情况下,响应是响应主体中的纯文本解释。例如,如果您忘记在method
参数中指定命令,则响应如下所示:
HTTP Status: 400 Bad Request
Null method
对于HTTP状态码200 OK返回的其他错误,响应格式为JSON格式,其中包含以下字段:
Field |
类型 | 描述 |
---|---|---|
result |
目的 | 包含对查询的响应的对象 |
result.error |
串 | 发生错误类型的唯一代码 |
result.status |
串 | "error" 如果请求导致错误 |
result.request |
目的 | 以JSON格式提示此错误的请求副本。警告:如果请求包含任何帐户机密,则将其复制到此处!注意:不管请求是什么,请求都以WebSocket格式重新格式化。 |
当您的请求导致错误时,整个请求将作为响应的一部分被复制,以便您可以尝试调试错误。但是,这也包括作为请求的一部分传递的任何秘密。在分享错误消息时,请非常小心,不要将重要的帐户机密泄露给他人。
所有方法都可能返回error
代码的以下任何值:
unknownCmd
-请求不包含命令的rippled
服务器识别。jsonInvalid
- (仅限WebSocket)请求不是正确的JSON对象。
missingCommand
- (仅限WebSocket)请求没有指定一个command
字段。
tooBusy
- 服务器负载过重,无法立即执行此命令。如果以管理员身份连接,通常不会返回。noNetwork
- 服务器无法连接到XRP Ledger对等网络的其余部分(并且未以独立模式运行)。noCurrent
- 由于高负载,网络问题,验证程序故障,配置错误或其他问题,服务器不知道当前分类帐的内容。noClosed
- 服务器没有封闭式分类帐,通常是因为它尚未完成启动。wsTextRequired
- (仅限WebSocket)请求的操作码不是文本对XRP分类帐的所有更改都是作为交易的结果发生的。唯一可以更改XRP分类帐内容的API方法是提交事务的命令。即使如此,只有在交易获得共识流程批准后,变更才会永久生效。大多数其他公共方法表示查看XRP分类帐中表示的数据的不同方法,或请求有关服务器状态的信息。
交易提交命令:
submit
命令submit_multisigned
命令有关您可以提交的各种交易的更多信息,请参阅交易参考。
Websocket和JSON-RPC API的API方法由命令名称定义,并分为公用命令和管理命令。公共命令不一定适用于普通公众,但是它们被连接到服务器的任何客户端使用。(将公共命令看作是运行服务器的组织的成员或客户,而管理命令用于负责保持服务器运行的人员。)公共命令包括诸如检查分类账状态,查找连接用户的路径以及提交交易等等。另一方面,管理命令仅用于受信任的服务器操作员,并包含用于管理,监视和调试服务器的命令。
account_currencies
- 获取一个帐户可以发送或接收的货币列表account_channels
- 获取帐户是渠道来源的付款渠道列表account_info
- 获取有关帐户的基本数据account_lines
- 获取有关帐户信任关系的信息account_objects
- 获取帐户拥有的所有分类帐对象account_offers
- 获取有关帐户货币兑换优惠的信息account_tx
- 获取有关帐户交易的信息book_offers
- 获取有关优惠以交换两种货币的信息channel_authorize
- 从付款渠道签署金钱索赔channel_verify
- 查看付款渠道声明的签名fee
- 获取有关交易成本的信息gateway_balances
- 计算帐户发出的总金额ledger
- 获取关于账本版本的信息ledger_closed
- 获取最新的封闭式账本版本ledger_current
- 获取当前工作分类帐版本ledger_data
- 获取账本版本的原始内容ledger_entry
- 从账本版本中获取一个元素noripple_check
- 获取对帐户的DefaultRipple和NoRipple设置的建议更改path_find
- 在两个帐户之间查找付款路径并接收更新ping
- 确认与服务器的连接random
- 生成一个随机数ripple_path_find
- 在两个帐户之间找到一次付款路径,一次server_info
- 以可读格式检索服务器的状态server_state
- 以机器可读格式检索服务器的状态sign
- 密码签署交易sign_for
- 有助于多重签名submit
- 向网络发送交易submit_multisigned
- 向网络发送多重签名的交易subscribe
- 听取有关特定主题的更新transaction_entry
- 从特定分类帐版本中检索有关交易的信息tx
- 从手边的所有分类账中检索有关交易的信息tx_history
- 检索有关所有最近交易的信息unsubscribe
- 停止收听有关特定主题的更新该owner_info
命令已弃用。account_objects
改为使用。
只有在配置文件标识为admin的主机和端口上连接时,rippled
管理命令才可用。(默认情况下,命令行客户端使用管理连接。)
can_delete
- 允许在线删除分类账至特定分类帐connect
- 强制将波纹服务器连接到特定的对等端consensus_info
- 获取有关共识状态的信息feature
- 获取有关协议修订的信息fetch_info
- 获取有关服务器与网络同步的信息get_counts
- 获取有关服务器内部和内存使用情况的统计信息ledger_accept
- 关闭并在独立模式下推进分类帐ledger_cleaner
- 配置分类账清算服务来检查损坏的数据ledger_request
- 查询对等服务器的特定分类帐版本log_level
- 获取或修改日志冗长logrotate
- 重新打开日志文件peers
- 获取有关连接的对等服务器的信息print
- 获取有关内部子系统的信息stop
- 关闭波纹服务器validation_create
- 为新的波纹验证器生成密钥validation_seed
- 临时设置用于验证的密钥validators
- 获取有关当前验证器的信息validator_list_sites
- 获取有关发布验证器列表的网站的信息wallet_propose
- 为新帐户生成密钥以下管理命令已弃用,可能会在不做进一步通知的情况下被删除:
ledger_header
- 改为使用该ledger
命令。unl_add
,unl_delete
,unl_list
,unl_load
,unl_network
,unl_reset
,unl_score
-使用UNL管理配置文件来代替。wallet_seed
- wallet_propose
改为使用。您可以将该rippled
应用程序(作为单独的实例)用作JSON-RPC客户端。在这种模式下,它具有从命令提示符用单行触发大多数API方法的语法,如每种方法中所述。但是,某些方法或选项没有命令行语法。对于不支持的语法,您可以使用以下方法:
json
- 通过命令行传递JSON注意:命令行界面仅用于管理目的,并不是受支持的API。
XRP分类账中的“账户”代表XRP的持有人和交易发送人。账户可以发送和接收XRP和已发行资产,参与分散交换,并更改自己的设置。创建一个帐户涉及生成密钥,然后从另一个帐户接收XRP。有关更多信息,请参阅帐户。
[资源]
该account_currencies
命令根据其信任线检索帐户可以发送或接收的货币列表。(这不是一个彻底确认的列表,但它可以用来填充用户界面。)
请求格式的示例:
{
"command": "account_currencies",
"account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"strict": true,
"ledger_index": "validated"
}
尝试一下!
该请求包含以下参数:
Field |
类型 | 描述 |
---|---|---|
account |
串 | 该帐户的唯一标识符,通常是帐户的地址。 |
strict |
布尔 | (可选)如果为true,则只接受帐户参数的地址或公钥。默认为false。 |
ledger_hash |
串 | (可选)要使用的分类帐版本的20字节十六进制字符串。(请参阅指定分类帐) |
ledger_index |
字符串或无符号整数 | (可选)要使用的分类帐的序号或快捷字符串自动选择分类帐。(请参阅指定分类帐) |
以下字段已弃用,不应提供:account_index
。
一个成功回应的例子:
{
"result": {
"ledger_index": 11775844,
"receive_currencies": [
"BTC",
"CNY",
"DYM",
"EUR",
"JOE",
"MXN",
"USD",
"015841551A748AD2C1F76FF6ECB0CCCD00000000"
],
"send_currencies": [
"ASP",
"BTC",
"CHF",
"CNY",
"DYM",
"EUR",
"JOE",
"JPY",
"MXN",
"USD"
],
"validated": true
},
"status": "success",
"type": "response"
}
响应遵循标准格式,成功结果包含以下字段:
Field |
类型 | 描述 |
---|---|---|
ledger_hash |
字符串 - 散列 | (可省略)用于检索此数据的分类帐版本的标识哈希,如十六进制。 |
ledger_index |
整数 - 总帐索引 | 用于检索此数据的分类帐版本的序列号。 |
receive_currencies |
字符串数组 | 此帐户可以接收的货币的货币代码列表。 |
send_currencies |
字符串数组 | 此帐户可以发送货币的货币代码列表。 |
validated |
布尔 | 如果true 这些数据来自验证分类账。 |
注意:账户可以发送或接收的货币是基于对其信任行的检查而定义的。如果一个账户有一个货币的信任线并且有足够的空间来增加余额,它就可以收到该货币。如果信任线的余额可能减少,则该账户可以发送该币种。此方法不检查信任行是否被冻结或授权。
invalidParams
- 一个或多个字段指定不正确,或缺少一个或多个必填字段。actNotFound
- account
请求字段中指定的地址不对应分类帐中的账户。lgrNotFound
- 由ledger_hash
或者ledger_index
不存在的分类账,或者确实存在,但服务器没有。[资源]
(需要启用PayChan修正。)
该account_channels
方法返回有关帐户的付款渠道的信息。这仅包括指定帐户是渠道来源的渠道,而不是目的地。(一个频道的“来源”和“所有者”是相同的。)所有检索到的信息都与特定版本的分类账相关。
请求格式的示例:
{
"id": 1,
"command": "account_channels",
"account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH",
"destination_account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"ledger_index": "validated"
}
该请求包含以下参数:
领域 | 类型 | 描述 |
---|---|---|
account |
串 | 账户的唯一标识符,通常是账户的地址。该请求返回此帐户是频道所有者/来源的频道。 |
destination_account |
串 | (可选)帐户的唯一标识符,通常是帐户的地址。如果提供,则将结果过滤到目标为此帐户的付款渠道。 |
ledger_hash |
串 | (可选)要使用的分类帐版本的20字节十六进制字符串。(请参阅指定分类帐) |
ledger_index |
字符串或无符号整数 | (可选)要使用的分类帐的序号或快捷字符串自动选择分类帐。(请参阅指定分类帐) |
limit |
整数 | (可选)限制要检索的事务数量。服务器不需要遵守这个值。必须在10到400的范围内,默认为200。 |
marker |
(未标明) | (可选)来自之前分页响应的值。在该响应停止的情况下继续恢复数据。 |
一个成功回应的例子:
{
"id": 2,
"status": "success",
"type": "response",
"result": {
"account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH",
"channels": [
{
"account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH",
"amount": "100000000",
"balance": "1000000",
"channel_id": "5DB01B7FFED6B67E6B0414DED11E051D2EE2B7619CE0EAA6286D67A3A4D5BDB3",
"destination_account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"destination_tag": 20170428,
"expiration": 547073182,
"public_key": "aB44YfzW24VDEJQ2UuLPV2PvqcPCSoLnL7y5M1EzhdW4LnK5xMS3",
"public_key_hex": "023693F15967AE357D0327974AD46FE3C127113B1110D6044FD41E723689F81CC6",
"settle_delay": 86400
}
],
"ledger_hash": "F168208EECDAA57DDAC32780CDD8330FA3E89F0E84D27A9052AA2F88681EBD08",
"ledger_index": 37230642,
"validated": true
}
}
响应遵循标准格式,成功结果包含以下字段:
领域 | 类型 | 描述 |
---|---|---|
account |
串 | 付款渠道的来源/所有者的地址。这对应于account 请求的字段。 |
channels |
通道对象数组 | 由此拥有的付款渠道account 。 |
ledger_hash |
串 | 用于生成此响应的分类帐版本的标识哈希。 |
ledger_index |
数 | 该总帐指数的分类帐版本用来产生这种反应。 |
validated |
布尔 | (可能会被忽略)如果true 这个答复中的信息来自一个经过验证的分类帐版本。否则,信息可能会更改。 |
limit |
数 | (可能会被省略)这个请求实际返回了多少个通道对象的限制。 |
marker |
(未标明) | (可以省略)分页的服务器定义值。将此通话传递给下一个通话,以便在此通话结束后继续收到结果。在此之后没有附加页面时省略。 |
每个通道对象都有以下字段:
领域 | 类型 | 描述 |
---|---|---|
account |
串 | 频道的所有者,作为地址。 |
amount |
串 | 分配给此频道的XRP总量。 |
balance |
串 | 截至所使用的分类帐版本,从此渠道支付的XRP总额为下降。(可以通过减去计算XRP留在通道的量balance 从amount )。 |
channel_id |
串 | 此通道的唯一标识符,为64个字符的十六进制字符串。这也是分类账状态数据中通道对象的ID。 |
destination_account |
串 | 该频道的目标帐户作为地址。只有此帐户可以在频道打开时收到XRP。 |
public_key |
串 | (可以省略)支付频道的公钥,为base58格式。对这个频道签署的声明必须使用匹配的密钥对进行兑换。 |
public_key_hex |
串 | (可省略)如果在创建频道时指定了付款频道的公钥,则为十六进制格式。对这个频道签署的声明必须使用匹配的密钥对进行兑换。 |
settle_delay |
无符号整数 | 在频道所有者请求关闭频道后,付款频道必须保持打开的秒数。 |
expiration |
无符号整数 | (可以省略)自Ripple Epoch起,以秒为单位的时间,此通道设置为过期时间。此到期日期是可变的。如果这是最近一次验证分类账的关闭时间之前,则该渠道已过期。 |
cancel_after |
无符号整数 | (可以省略)自Ripple Epoch以来的秒数,如果在通道创建时指定了此通道的不可变过期时间(以秒为单位)。如果这是最近一次验证分类账的关闭时间之前,则该渠道已过期。 |
source_tag |
无符号整数 | (可省略) 32位无符号整数,用作通过此支付渠道进行支付的源标签(如果在渠道创建时指定了该整数)。这表明付款渠道的发起人或其他用途在源帐户。通常,如果您退出此渠道的付款,则应DestinationTag 在退货付款中指定此值。 |
destination_tag |
无符号整数 | (可省略)一个32位无符号整数,用作通过此通道进行支付的目的地标记(如果在通道创建时指定了该整数)。这表明付款渠道的受益人或目的地账户的其他用途。 |
invalidParams
- 一个或多个字段指定不正确,或缺少一个或多个必填字段。actNotFound
- account
请求字段中指定的地址不对应分类帐中的账户。lgrNotFound
- 由ledger_hash
或者ledger_index
不存在的分类账,或者确实存在,但服务器没有。[资源]
该account_info
命令将检索有关帐户,其活动和XRP余额的信息。所有检索到的信息都与分类账的特定版本有关。
account_info请求的示例:
{
"id": 2,
"command": "account_info",
"account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"strict": true,
"ledger_index": "current",
"queue": true
}
尝试一下!
该请求包含以下参数:
Field |
类型 | 描述 |
---|---|---|
account |
串 | 该帐户的唯一标识符,通常是帐户的地址。 |
strict |
布尔 | (可选,默认为False)如果设置为True,则该account 字段只接受公钥或XRP分类帐地址。 |
ledger_hash |
串 | (可选)要使用的分类帐版本的20字节十六进制字符串。(请参阅指定分类帐) |
ledger_index |
字符串或无符号整数 | (可选)要使用的分类帐的序号或快捷字符串自动选择分类帐。(请参阅指定分类帐) |
queue |
布尔 | (可选)如果启用true 了费用调整修正,还会返回有关与此帐户关联的排队交易的统计信息。只能在查询当前开放分类账的数据时使用。 |
signer_lists |
布尔 | (可选)如果启用true 了MultiSign修订,还会返回与此帐户关联的任何SignerList对象。 |
以下字段已弃用,不应提供:ident
,ledger
。
一个成功回应的例子:
{
"id": 5,
"status": "success",
"type": "response",
"result": {
"account_data": {
"Account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn",
"Balance": "999999999960",
"Flags": 8388608,
"LedgerEntryType": "AccountRoot",
"OwnerCount": 0,
"PreviousTxnID": "4294BEBE5B569A18C0A2702387C9B1E7146DC3A5850C1E87204951C6FDAA4C42",
"PreviousTxnLgrSeq": 3,
"Sequence": 6,
"index": "92FA6A9FC8EA6018D5D16532D7795C91BFB0831355BDFDA177E86C8BF997985F"
},
"ledger_current_index": 4,
"queue_data": {
"auth_change_queued": true,
"highest_sequence": 10,
"lowest_sequence": 6,
"max_spend_drops_total": "500",
"transactions": [
{
"auth_change": false,
"fee": "100",
"fee_level": "2560",
"max_spend_drops": "100",
"seq": 6
},
... (trimmed for length) ...
{
"LastLedgerSequence": 10,
"auth_change": true,
"fee": "100",
"fee_level": "2560",
"max_spend_drops": "100",
"seq": 10
}
],
"txn_count": 5
},
"validated": false
}
}
响应遵循标准格式,结果包含请求的帐户,其数据以及它所应用的分类帐,如下所示:
Field |
类型 | 描述 |
---|---|---|
account_data |
目的 | 该AccountRoot台账对象与此帐户的信息,存储在总账。 |
signer_lists |
排列 | (除非指定的请求signer_lists 和至少一个SignerList与帐户相关联,否则省略。)与此帐户关联的SignerList分类帐对象的数组进行多重签名。由于帐户最多只能拥有一个SignerList,因此如果该阵列存在,该阵列必须只有一个成员。 |
ledger_current_index |
整数 | (如果ledger_index 提供,则省略)检索此信息时使用的最新分类帐的序列号。这些信息不包含任何比这个更新的分类账更改。 |
ledger_index |
整数 | (如果ledger_current_index 提供,则省略)检索此信息时使用的分类帐的序列号。这些信息不包含任何比这个更新的分类账更改。 |
queue_data |
目的 | (除非queue 指定为true 和查询当前开立的分类帐,否则省略。)有关此帐户发送的排队交易的信息。该信息描述本地rippled 服务器的状态,该状态可能与共识网络中的其他服务器不同。有些字段可能会被忽略,因为这些值是由排队机制“懒散地”计算的。 |
validated |
布尔 | 如果此数据来自经过验证的分类账版本,则为真; 如果省略或设置为false,则此数据不是最终的。 |
该queue_data
参数(如果存在)包含以下字段:
Field |
类型 | 描述 |
---|---|---|
txn_count |
整数 | 此地址的排队交易数量。 |
auth_change_queued |
布尔 | (可以省略)队列中的事务是否更改此地址授权事务的方式。如果true ,该地址可以在该事务已经被执行或从队列中删除之前不进行进一步的事务处理。 |
lowest_sequence |
整数 | (可以省略)这个地址排队的事务中的最低序列号。 |
highest_sequence |
整数 | (可以省略)这个地址排队的事务中的最高序列号。 |
max_spend_drops_total |
串 | (可省略)如果队列中的每个事务消耗尽可能多的XRP,则可以从该地址中扣除的XRP的整数丢弃量。 |
transactions |
排列 | (可省略)关于此地址中每个排队事务的信息。 |
transactions
数组中的每个对象(如果存在)都可以包含以下任何或全部字段:
Field |
类型 | 描述 |
---|---|---|
auth_change |
布尔 | 此交易是否更改此地址授权交易的方式。 |
fee |
串 | 此交易的交易成本,以XRP为单位。 |
fee_level |
串 | 这笔交易的交易成本,相对于此类交易的最低成本,按收费水平计算。 |
max_spend_drops |
串 | XRP的最高金额,滴,此交易可以发送或破坏。 |
seq |
整数 | 此事务的序列号。 |
invalidParams
- 一个或多个字段指定不正确,或缺少一个或多个必填字段。例如,指定queue
为true
但ledger_index
不是当前开放分类账的指定的请求。actNotFound
- account
请求字段中指定的地址不对应分类帐中的账户。lgrNotFound
- 由ledger_hash
或者ledger_index
不存在的分类账,或者确实存在,但服务器没有。[资源]
该account_lines
方法返回有关账户信任额度的信息,包括所有非XRP货币和资产的余额。所有检索到的信息都与分类账的特定版本有关。
请求格式的示例:
{
"id": 1,
"command": "account_lines",
"account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"ledger": "current"
}
尝试一下!
该请求接受以下参数:
Field |
类型 | 描述 |
---|---|---|
account |
串 | 该帐户的唯一标识符,通常是帐户的地址。 |
ledger_hash |
串 | (可选)要使用的分类帐版本的20字节十六进制字符串。(请参阅指定分类帐) |
ledger_index |
字符串或无符号整数 | (可选)要使用的分类帐的序号或快捷字符串自动选择分类帐。(请参阅指定分类帐) |
peer |
串 | (可选)第二个帐户的地址。如果提供,只显示连接两个帐户的信任线。 |
limit |
整数 | (可选,默认值有所不同)限制要检索的事务数量。服务器不需要遵守这个值。必须在10到400的范围内。 |
marker |
(未标明) | (可选)来自之前分页响应的值。在该响应停止的情况下继续恢复数据。 |
以下参数已被弃用,可能会被删除,恕不另行通知:ledger
和peer_index
。
一个成功回应的例子:
{
"id": 1,
"status": "success",
"type": "response",
"result": {
"account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"lines": [
{
"account": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z",
"balance": "0",
"currency": "ASP",
"limit": "0",
"limit_peer": "10",
"quality_in": 0,
"quality_out": 0
},
{
"account": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z",
"balance": "0",
"currency": "XAU",
"limit": "0",
"limit_peer": "0",
"no_ripple": true,
"no_ripple_peer": true,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
"balance": "3.497605752725159",
"currency": "USD",
"limit": "5",
"limit_peer": "0",
"no_ripple": true,
"quality_in": 0,
"quality_out": 0
}
]
}
}
响应遵循标准格式,包含帐户地址和信任线对象数组的成功结果。具体而言,结果对象包含以下字段:
Field |
类型 | 描述 |
---|---|---|
account |
串 | 此请求所对应帐户的唯一地址。这是用于信任线目的的“透视帐户”。 |
lines |
排列 | 信任线对象数组,如下所述。如果信任线的数量很大,则一次只返回到此次数limit 。 |
ledger_current_index |
整数 | (如果ledger_hash 或ledger_index 提供,则省略)检索此数据时使用的分类帐版本的序号。 |
ledger_index |
整数 | (如果ledger_current_index 改为提供,则省略)请求中提供的序列号,用于检索此数据时使用的分类帐版本。 |
ledger_hash |
串 | (可以省略)请求中提供的Hex哈希检索此数据时使用的分类帐版本。 |
marker |
(未标明) | 指示响应的服务器定义的值是分页的。将此传递给下一个电话以恢复此通话停止的位置。在此之后没有附加页面时省略。 |
每个信任线对象具有以下字段的某种组合:
Field |
类型 | 描述 |
---|---|---|
account |
串 | 该信任线对手的唯一地址。 |
balance |
串 | 表示当前针对此行保留的数字余额。积极的平衡意味着角度账户持有价值; 负差额意味着远景账户欠款。 |
currency |
串 | 一个货币代码,标识这个信任线可以容纳什么货币。 |
limit |
串 | 此帐户愿意欠对方帐户的最大金额 |
limit_peer |
串 | 交易对手账户愿意欠透视账户的最大金额 |
quality_in |
无符号整数 | 该账户对该信任额度上的收入余额进行评估的比率,即每10亿个单位的这个值的比率。(例如,5亿的值代表0.5:1的比率。)作为特例,0被视为1:1的比例。 |
quality_out |
无符号整数 | 账户价值在此信任额度上的外发余额的比率,作为此值每10亿单位的比率。(例如,5亿的值代表0.5:1的比率。)作为特例,0被视为1:1的比例。 |
no_ripple |
布尔 | (可以省略)true 如果此帐户已启用此行的NoRipple标志。如果省略,则与之相同false 。 |
no_ripple_peer |
布尔 | (可以省略)true 如果对等帐户已启用NoRipple标志。如果省略,则与之相同false 。 |
authorized |
布尔 | (可以省略)true 如果此帐户已授权此信任热线。如果省略,则与之相同false 。 |
peer_authorized |
布尔 | (可以省略)true 如果同行帐户授权此信任线。如果省略,则与之相同false 。 |
freeze |
布尔 | (可以省略)true 如果此帐户冻结了此信任线。如果省略,则与之相同false 。 |
freeze_peer |
布尔 | (可以省略)true 如果同行账户冻结了这个信任线。如果省略,则与之相同false 。 |
invalidParams
- 一个或多个字段指定不正确,或缺少一个或多个必填字段。actNotFound
- 请求字段中指定的地址account
不对应分类账中的账户。lgrNotFound
- 由ledger_hash
或者ledger_index
不存在的分类账,或者确实存在,但服务器没有。actMalformed
- 如果marker
提供的字段不可接受。[资源]
该account_offers
方法检索由特定帐户作为特定分类账版本的优惠清单。
请求格式的示例:
{
"id": 2,
"command": "account_offers",
"account": "rpP2JgiMyTF5jR5hLG3xHCPi1knBb1v9cM",
"ledger": "current"
}
尝试一下!
请求可以包含以下参数:
Field |
类型 | 描述 |
---|---|---|
account |
串 | 该帐户的唯一标识符,通常是帐户的地址。 |
ledger |
无符号整数或字符串 | (不推荐使用,可选)要使用的分类帐版本的唯一标识符,例如分类帐序列号,散列或诸如“已验证”的快捷方式。 |
ledger_hash |
串 | (可选)标识要使用的分类帐版本的20字节十六进制字符串。 |
ledger_index |
(可选) 总帐索引 | (可选,默认为current )要使用的分类帐的序列号,或“当前”,“关闭”或“验证”以动态选择分类帐。(请参阅指定分类帐) |
limit |
整数 | (可选,默认值有所不同)限制要检索的事务数量。服务器不需要遵守这个值。必须在10到400的范围内。 |
marker |
(未标明) | (可选)来自之前分页响应的值。在该响应停止的情况下继续恢复数据。 |
以下参数已弃用,可能会被取消,恕不另行通知:ledger
。
一个成功回应的例子:
{
"id": 9,
"status": "success",
"type": "response",
"result": {
"account": "rpP2JgiMyTF5jR5hLG3xHCPi1knBb1v9cM",
"ledger_current_index": 18539550,
"offers": [
{
"flags": 0,
"quality": "0.00000000574666765650638",
"seq": 6577664,
"taker_gets": "33687728098",
"taker_pays": {
"currency": "EUR",
"issuer": "rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq",
"value": "193.5921774819578"
}
},
{
"flags": 0,
"quality": "7989247009094510e-27",
"seq": 6572128,
"taker_gets": "2361918758",
"taker_pays": {
"currency": "XAU",
"issuer": "rrh7rf1gV2pXAoqA8oYbpHd8TKv5ZQeo67",
"value": "0.01886995237307572"
}
},
... trimmed for length ...
],
"validated": false
}
}
响应遵循标准格式,成功结果包含以下字段:
Field |
类型 | 描述 |
---|---|---|
account |
串 | 唯一地址标识提供商品的帐户 |
offers |
排列 | 对象数组,其中每个对象都表示此帐户所提供的优惠,与请求的帐本版本相同。如果报价数量很大,则一次只能返回limit 。 |
ledger_current_index |
整数 | (如果ledger_hash 或ledger_index 提供,则省略)检索此数据时使用的分类帐版本的序号。 |
ledger_index |
整数 | (如果ledger_current_index 改为提供,则省略)请求中提供的序列号,用于检索此数据时使用的分类帐版本。 |
ledger_hash |
串 | (可以省略)请求中提供的Hex哈希检索此数据时使用的分类帐版本。 |
marker |
(未标明) | (可以省略)服务器定义的值,表示响应是分页的。将此传递给下一个电话以恢复此通话停止的位置。在此之后没有信息页面时省略。 |
每个商品对象都包含以下字段:
Field |
类型 | 描述 |
---|---|---|
flags |
无符号整数 | 此优惠条目的选项设置为位标志。 |
seq |
无符号整数 | 创建此条目的事务的序列号。(交易序列号与账户相关。) |
taker_gets |
字符串或对象 | 接受报价的帐户接收的金额,作为表示XRP中金额的字符串或货币规格对象。(请参阅指定货币金额) |
taker_pays |
字符串或对象 | 接受报价的账户所提供的金额,作为表示XRP中金额的字符串或货币规格对象。(请参阅指定货币金额) |
quality |
串 | 报价的汇率,按原来的比例taker_pays 除以原始报价taker_gets 。执行报价时,最优质(最低)质量的报价首先被消耗; 提供具有相同质量的产品将从最旧到最新执行。 |
expiration |
无符号整数 | (可能会被忽略)之后,此优惠被视为无资金支持,因为自Ripple Epoch以来的秒数。另请参阅:优惠到期。 |
invalidParams
- 一个或多个字段指定不正确,或缺少一个或多个必填字段。actNotFound
- 请求字段中指定的地址account
不对应分类账中的账户。lgrNotFound
- 由ledger_hash
或者ledger_index
不存在的分类账,或者确实存在,但服务器没有。actMalformed
- 如果marker
提供的字段不可接受。[资源]
该account_objects
命令返回帐户拥有的所有对象的原始分类帐格式。有关帐户信任额度和余额的更高级别视图,请参阅account_lines
。
可能出现在account_objects
帐户响应中的对象类型包括:
请求格式的示例:
{
"id": 1,
"command": "account_objects",
"account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"ledger_index": "validated",
"type": "state",
"limit": 10
}
该请求包含以下参数:
Field |
类型 | 描述 |
---|---|---|
account |
串 | 账户的唯一标识符,通常是账户的地址。 |
type |
串 | (可选)如果包含,则过滤结果以仅包含此类型的分类帐对象。有效的类型有:check ,escrow ,offer ,payment_channel ,signer_list ,和state (信托线)。 |
ledger_hash |
串 | (可选)要使用的分类帐版本的20字节十六进制字符串。(请参阅指定分类帐) |
ledger_index |
字符串或无符号整数 | (可选)要使用的分类帐的序号或快捷字符串自动选择分类帐。(请参阅指定分类帐) |
limit |
无符号整数 | (可选)结果中包含的最大对象数。在非管理员连接上,必须在10到400的范围内。默认为200。 |
marker |
(未标明) | (可选)来自之前分页响应的值。在该响应停止的情况下继续恢复数据。 |
一个成功回应的例子:
{
"id": 8,
"status": "success",
"type": "response",
"result": {
"account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"account_objects": [
{
"Balance": {
"currency": "ASP",
"issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji",
"value": "0"
},
"Flags": 65536,
"HighLimit": {
"currency": "ASP",
"issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"value": "0"
},
"HighNode": "0000000000000000",
"LedgerEntryType": "RippleState",
"LowLimit": {
"currency": "ASP",
"issuer": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z",
"value": "10"
},
"LowNode": "0000000000000000",
"PreviousTxnID": "BF7555B0F018E3C5E2A3FF9437A1A5092F32903BE246202F988181B9CED0D862",
"PreviousTxnLgrSeq": 1438879,
"index": "2243B0B630EA6F7330B654EFA53E27A7609D9484E535AB11B7F946DF3D247CE9"
},
{
"Balance": {
"currency": "XAU",
"issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji",
"value": "0"
},
"Flags": 3342336,
"HighLimit": {
"currency": "XAU",
"issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"value": "0"
},
"HighNode": "0000000000000000",
"LedgerEntryType": "RippleState",
"LowLimit": {
"currency": "XAU",
"issuer": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z",
"value": "0"
},
"LowNode": "0000000000000000",
"PreviousTxnID": "79B26D7D34B950AC2C2F91A299A6888FABB376DD76CFF79D56E805BF439F6942",
"PreviousTxnLgrSeq": 5982530,
"index": "9ED4406351B7A511A012A9B5E7FE4059FA2F7650621379C0013492C315E25B97"
},
{
"Balance": {
"currency": "USD",
"issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji",
"value": "0"
},
"Flags": 1114112,
"HighLimit": {
"currency": "USD",
"issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
"value": "0"
},
"HighNode": "0000000000000000",
"LedgerEntryType": "RippleState",
"LowLimit": {
"currency": "USD",
"issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"value": "5"
},
"LowNode": "0000000000000000",
"PreviousTxnID": "6FE8C824364FB1195BCFEDCB368DFEE3980F7F78D3BF4DC4174BB4C86CF8C5CE",
"PreviousTxnLgrSeq": 10555014,
"index": "2DECFAC23B77D5AEA6116C15F5C6D4669EBAEE9E7EE050A40FE2B1E47B6A9419"
},
{
"Balance": {
"currency": "MXN",
"issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji",
"value": "481.992867407479"
},
"Flags": 65536,
"HighLimit": {
"currency": "MXN",
"issuer": "rHpXfibHgSb64n8kK9QWDpdbfqSpYbM9a4",
"value": "0"
},
"HighNode": "0000000000000000",
"LedgerEntryType": "RippleState",
"LowLimit": {
"currency": "MXN",
"issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"value": "1000"
},
"LowNode": "0000000000000000",
"PreviousTxnID": "A467BACE5F183CDE1F075F72435FE86BAD8626ED1048EDEFF7562A4CC76FD1C5",
"PreviousTxnLgrSeq": 3316170,
"index": "EC8B9B6B364AF6CB6393A423FDD2DDBA96375EC772E6B50A3581E53BFBDFDD9A"
},
{
"Balance": {
"currency": "EUR",
"issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji",
"value": "0.793598266778297"
},
"Flags": 1114112,
"HighLimit": {
"currency": "EUR",
"issuer": "rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun",
"value": "0"
},
"HighNode": "0000000000000000",
"LedgerEntryType": "RippleState",
"LowLimit": {
"currency": "EUR",
"issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"value": "1"
},
"LowNode": "0000000000000000",
"PreviousTxnID": "E9345D44433EA368CFE1E00D84809C8E695C87FED18859248E13662D46A0EC46",
"PreviousTxnLgrSeq": 5447146,
"index": "4513749B30F4AF8DA11F077C448128D6486BF12854B760E4E5808714588AA915"
},
{
"Balance": {
"currency": "CNY",
"issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji",
"value": "0"
},
"Flags": 2228224,
"HighLimit": {
"currency": "CNY",
"issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"value": "3"
},
"HighNode": "0000000000000000",
"LedgerEntryType": "RippleState",
"LowLimit": {
"currency": "CNY",
"issuer": "rnuF96W4SZoCJmbHYBFoJZpR8eCaxNvekK",
"value": "0"
},
"LowNode": "0000000000000008",
"PreviousTxnID": "2FDDC81F4394695B01A47913BEC4281AC9A283CC8F903C14ADEA970F60E57FCF",
"PreviousTxnLgrSeq": 5949673,
"index": "578C327DA8944BDE2E10C9BA36AFA2F43E06C8D1E8819FB225D266CBBCFDE5CE"
},
{
"Balance": {
"currency": "DYM",
"issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji",
"value": "1.336889190631542"
},
"Flags": 65536,
"HighLimit": {
"currency": "DYM",
"issuer": "rGwUWgN5BEg3QGNY3RX2HfYowjUTZdid3E",
"value": "0"
},
"HighNode": "0000000000000000",
"LedgerEntryType": "RippleState",
"LowLimit": {
"currency": "DYM",
"issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"value": "3"
},
"LowNode": "0000000000000000",
"PreviousTxnID": "6DA2BD02DFB83FA4DAFC2651860B60071156171E9C021D9E0372A61A477FFBB1",
"PreviousTxnLgrSeq": 8818732,
"index": "5A2A5FF12E71AEE57564E624117BBA68DEF78CD564EF6259F92A011693E027C7"
},
{
"Balance": {
"currency": "CHF",
"issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji",
"value": "-0.3488146605801446"
},
"Flags": 131072,
"HighLimit": {
"currency": "CHF",
"issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"value": "0"
},
"HighNode": "0000000000000000",
"LedgerEntryType": "RippleState",
"LowLimit": {
"currency": "CHF",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"value": "0"
},
"LowNode": "000000000000008C",
"PreviousTxnID": "722394372525A13D1EAAB005642F50F05A93CF63F7F472E0F91CDD6D38EB5869",
"PreviousTxnLgrSeq": 2687590,
"index": "F2DBAD20072527F6AD02CE7F5A450DBC72BE2ABB91741A8A3ADD30D5AD7A99FB"
},
{
"Balance": {
"currency": "BTC",
"issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji",
"value": "0"
},
"Flags": 131072,
"HighLimit": {
"currency": "BTC",
"issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"value": "3"
},
"HighNode": "0000000000000000",
"LedgerEntryType": "RippleState",
"LowLimit": {
"currency": "BTC",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"value": "0"
},
"LowNode": "0000000000000043",
"PreviousTxnID": "03EDF724397D2DEE70E49D512AECD619E9EA536BE6CFD48ED167AE2596055C9A",
"PreviousTxnLgrSeq": 8317037,
"index": "767C12AF647CDF5FEB9019B37018748A79C50EDAF87E8D4C7F39F78AA7CA9765"
},
{
"Balance": {
"currency": "USD",
"issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji",
"value": "-16.00534471983042"
},
"Flags": 131072,
"HighLimit": {
"currency": "USD",
"issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"value": "5000"
},
"HighNode": "0000000000000000",
"LedgerEntryType": "RippleState",
"LowLimit": {
"currency": "USD",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"value": "0"
},
"LowNode": "000000000000004A",
"PreviousTxnID": "CFFF5CFE623C9543308C6529782B6A6532207D819795AAFE85555DB8BF390FE7",
"PreviousTxnLgrSeq": 14365854,
"index": "826CF5BFD28F3934B518D0BDF3231259CBD3FD0946E3C3CA0C97D2C75D2D1A09"
}
],
"ledger_hash": "053DF17D2289D1C4971C22F235BC1FCA7D4B3AE966F842E5819D0749E0B8ECD3",
"ledger_index": 14378733,
"limit": 10,
"marker": "F60ADF645E78B69857D2E4AEC8B7742FEABC8431BD8611D099B428C3E816DF93,94A9F05FEF9A153229E2E997E64919FD75AAE2028C8153E8EBDB4440BD3ECBB5",
"validated": true
}
}
响应遵循标准格式,成功结果包含以下字段:
Field |
类型 | 描述 |
---|---|---|
account |
串 | 此请求所对应帐户的唯一地址 |
account_objects |
排列 | 此帐户拥有的对象数组。每个对象都处于其原始分类帐格式。 |
ledger_hash |
串 | (可以省略)用于生成此响应的分类帐的标识哈希。 |
ledger_index |
数 | (可以省略)用于生成此响应的分类帐版本的序列号。 |
ledger_current_index |
数 | (可以省略)用于生成此响应的当前正在进行分类帐版本的序列号。 |
limit |
数 | (可以省略)此请求中使用的限制(如果有)。 |
marker |
(未标明) | 指示响应的服务器定义的值是分页的。将此传递给下一个电话以恢复此通话停止的位置。在此之后没有附加页面时省略。 |
validated |
布尔 | 如果包含并设置为true ,则此回复中的信息来自经过验证的分类帐版本。否则,信息可能会更改。 |
invalidParams
- 一个或多个字段指定不正确,或缺少一个或多个必填字段。actNotFound
- 请求字段中指定的地址account
不对应分类账中的账户。lgrNotFound
- 由ledger_hash
或者ledger_index
不存在的分类账,或者确实存在,但服务器没有。[资源]
该account_tx
方法检索涉及指定帐户的交易列表。
请求格式的示例:
{
"id": 2,
"command": "account_tx",
"account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"ledger_index_min": -1,
"ledger_index_max": -1,
"binary": false,
"limit": 2,
"forward": false
}
尝试一下!
该请求包含以下参数:
Field |
类型 | 描述 |
---|---|---|
account |
串 | 账户的唯一标识符,通常是账户的地址。 |
ledger_index_min |
整数 | (可选)用于指定最早的分类帐以包含交易。的值-1 指示使用可用的最早的验证台账版本的服务器。 |
ledger_index_max |
整数 | (可选)用于指定最近的分类帐以包含来自的交易。的值-1 指示使用可用的最新验证台账版本的服务器。 |
ledger_hash |
串 | (可选)仅用于查找单个分类帐中的交易。(请参阅指定分类帐。) |
ledger_index |
字符串或无符号整数 | (可选)仅用于查找单个分类帐中的交易。(请参阅指定分类帐。) |
binary |
布尔 | (可选)默认为false 。如果设置为true ,则将事务作为十六进制字符串而不是JSON返回。 |
forward |
布尔 | (可选)默认为false 。如果设置为true ,则首先返回使用最旧的分类帐索引的值。否则,结果将首先与最新的分类帐编入索引。(结果的每页可能不是内部排序的,但页面总体排序。) |
limit |
整数 | (可选)默认值有所不同。限制要检索的事务数量。服务器不需要遵守这个值。 |
marker |
(未标明) | 来自之前分页响应的价值。在该响应停止的情况下继续恢复数据。即使服务器的可用分类账范围发生变化,该值也是稳定的。 |
[资源]
虽然这些领域被标记为可选,则必须使用至少一个在您的要求:ledger_index
,ledger_hash
,ledger_index_min
,或ledger_index_max
。
注意:对于WebSocket和JSON-RPC,该account_tx
方法还有一个不推荐的旧版本。出于这个原因,纹波建议不使用任何以下字段:offset
,count
,descending
,ledger_max
,和ledger_min
。如果您使用任何这些已弃用的字段,则该方法不支持分页。
与其他分页方法一样,您可以使用该marker
字段返回多页数据。
在请求之间的时间,"ledger_index_min": -1
并且"ledger_index_max": -1
可能会更改为指除他们以前做不同的分类帐的版本。marker
只要标记未指示请求中指定的分类范围之外的某个点,即使请求中的分类帐范围发生更改,该字段也可以安全分页。
一个成功回应的例子:
{
"id": 2,
"status": "success",
"type": "response",
"result": {
"account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"ledger_index_max": 6542489,
"ledger_index_min": 32570,
"limit": 2,
"transactions": [
{
"meta": {
"AffectedNodes": [
{
"ModifiedNode": { "FinalFields": { "Account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", "Balance": "9999999980", "Flags": 0, "OwnerCount": 2, "Sequence": 3 }, "LedgerEntryType": "AccountRoot", "LedgerIndex": "4F83A2CF7E70F77F79A307E6A472BFC2585B806A70833CCD1C26105BAE0D6E05", "PreviousFields": { "Balance": "9999999990", "OwnerCount": 1, "Sequence": 2 }, "PreviousTxnID": "389720F6FD8A144F171708F9ECB334D704CBCFEFBCDA152D931AC34FB5F9E32B", "PreviousTxnLgrSeq": 95405 } },
{
"CreatedNode": { "LedgerEntryType": "RippleState", "LedgerIndex": "718C6D58DD3BBAAAEBFE48B8FBE3C32C9F6F2EBC395233BA95D0057078EE07DB", "NewFields": { "Balance": { "currency": "USD", "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", "value": "0" }, "Flags": 131072, "HighLimit": { "currency": "USD", "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", "value": "100" }, "LowLimit": { "currency": "USD", "issuer": "r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV", "value": "0" } } } },
{
"ModifiedNode": { "FinalFields": { "Flags": 0, "Owner": "r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV", "RootIndex": "77F65EFF930ED7E93C6CC839C421E394D6B1B6A47CEA8A140D63EC9C712F46F5" }, "LedgerEntryType": "DirectoryNode", "LedgerIndex": "77F65EFF930ED7E93C6CC839C421E394D6B1B6A47CEA8A140D63EC9C712F46F5" } },
{
"ModifiedNode": { "FinalFields": { "Account": "r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV", "Balance": "78991384535796", "Flags": 0, "OwnerCount": 3, "Sequence": 188 }, "LedgerEntryType": "AccountRoot", "LedgerIndex": "B33FDD5CF3445E1A7F2BE9B06336BEBD73A5E3EE885D3EF93F7E3E2992E46F1A", "PreviousTxnID": "E9E1988A0F061679E5D14DE77DB0163CE0BBDC00F29E396FFD1DA0366E7D8904", "PreviousTxnLgrSeq": 195455 } },
{
"ModifiedNode": { "FinalFields": { "ExchangeRate": "4E11C37937E08000", "Flags": 0, "RootIndex": "F60ADF645E78B69857D2E4AEC8B7742FEABC8431BD8611D099B428C3E816DF93", "TakerGetsCurrency": "0000000000000000000000000000000000000000", "TakerGetsIssuer": "0000000000000000000000000000000000000000", "TakerPaysCurrency": "0000000000000000000000004254430000000000", "TakerPaysIssuer": "5E7B112523F68D2F5E879DB4EAC51C6698A69304" }, "LedgerEntryType": "DirectoryNode", "LedgerIndex": "F60ADF645E78B69857D2E4AEC8B7742FEABC8431BD8611D099B428C3E816DF93" } }
],
"TransactionIndex": 0,
"TransactionResult": "tesSUCCESS"
},
"tx": {
"Account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"Fee": "10",
"Flags": 0,
"LimitAmount": {
"currency": "USD",
"issuer": "r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV",
"value": "100" },
"Sequence": 2,
"SigningPubKey": "02BC8C02199949B15C005B997E7C8594574E9B02BA2D0628902E0532989976CF9D",
"TransactionType": "TrustSet",
"TxnSignature": "304402200EF81EC32E0DFA9BE376B20AFCA11765ED9FEA04CA8B77C7178DAA699F7F5AFF02202DA484DBD66521AC317D84F7717EC4614E2F5DB743E313E8B48440499CC0DBA4",
"date": 413620090,
"hash": "002AA492496A1543DBD3680BF8CF21B6D6A078CE4A01D2C1A4B63778033792CE",
"inLedger": 195480,
"ledger_index": 195480
},
"validated": true
},
{
"meta": {
"AffectedNodes": [
{
"ModifiedNode": { "FinalFields": { "Account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", "Balance": "9999999970", "Flags": 0, "OwnerCount": 3, "Sequence": 4 }, "LedgerEntryType": "AccountRoot", "LedgerIndex": "4F83A2CF7E70F77F79A307E6A472BFC2585B806A70833CCD1C26105BAE0D6E05", "PreviousFields": { "Balance": "9999999980", "OwnerCount": 2, "Sequence": 3 }, "PreviousTxnID": "002AA492496A1543DBD3680BF8CF21B6D6A078CE4A01D2C1A4B63778033792CE", "PreviousTxnLgrSeq": 195480 } },
{
"ModifiedNode": { "FinalFields": { "Flags": 0, "Owner": "r3PDtZSa5LiYp1Ysn1vMuMzB59RzV3W9QH", "RootIndex": "A39F044D860C5B5846AA7E0FAAD44DC8897F0A62B2F628AA073B21B3EC146010" }, "LedgerEntryType": "DirectoryNode", "LedgerIndex": "A39F044D860C5B5846AA7E0FAAD44DC8897F0A62B2F628AA073B21B3EC146010" } },
{
"ModifiedNode": { "LedgerEntryType": "AccountRoot", "LedgerIndex": "E0D7BDE68B468FF0B8D948FD865576517DA987569833A05374ADB9A72E870A06", "PreviousTxnID": "0222B59280D165D40C464EA75AAD08A4D152C46A38C0625DEECF6EE87FC5B9E1", "PreviousTxnLgrSeq": 343555 } },
{
"CreatedNode": { "LedgerEntryType": "RippleState", "LedgerIndex": "EA4BF03B4700123CDFFB6EB09DC1D6E28D5CEB7F680FB00FC24BC1C3BB2DB959", "NewFields": { "Balance": { "currency": "USD", "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", "value": "0" }, "Flags": 131072, "HighLimit": { "currency": "USD", "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", "value": "100" }, "LowLimit": { "currency": "USD", "issuer": "r3PDtZSa5LiYp1Ysn1vMuMzB59RzV3W9QH", "value": "0" } } } },
{
"ModifiedNode": { "FinalFields": { "ExchangeRate": "4E11C37937E08000", "Flags": 0, "RootIndex": "F60ADF645E78B69857D2E4AEC8B7742FEABC8431BD8611D099B428C3E816DF93", "TakerGetsCurrency": "0000000000000000000000000000000000000000", "TakerGetsIssuer": "0000000000000000000000000000000000000000", "TakerPaysCurrency": "0000000000000000000000004254430000000000", "TakerPaysIssuer": "5E7B112523F68D2F5E879DB4EAC51C6698A69304" }, "LedgerEntryType": "DirectoryNode", "LedgerIndex": "F60ADF645E78B69857D2E4AEC8B7742FEABC8431BD8611D099B428C3E816DF93" } }
],
"TransactionIndex": 0,
"TransactionResult": "tesSUCCESS"
},
"tx": {
"Account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"Fee": "10",
"Flags": 0,
"LimitAmount": {
"currency": "USD",
"issuer": "r3PDtZSa5LiYp1Ysn1vMuMzB59RzV3W9QH",
"value": "100" },
"Sequence": 3,
"SigningPubKey": "02BC8C02199949B15C005B997E7C8594574E9B02BA2D0628902E0532989976CF9D",
"TransactionType": "TrustSet",
"TxnSignature": "3044022058A89552068D1A274EE72BA71363E33E54E6608BC28A84DEC6EE530FC2B5C979022029F4D1EA1237A1F717C5F5EC526E6CFB6DF54C30BADD25EDDE7D2FDBC8F17E34",
"date": 416347560,
"hash": "53354D84BAE8FDFC3F4DA879D984D24B929E7FEB9100D2AD9EFCD2E126BCCDC8",
"inLedger": 343570,
"ledger_index": 343570
},
"validated": true
}
],
"validated": true
}
}
响应遵循标准格式,成功结果包含以下字段:
Field |
类型 | 描述 |
---|---|---|
account |
串 | 识别相关帐户的唯一地址 |
ledger_index_min |
整数 | 最早的分类账的序号实际上搜索了交易。 |
ledger_index_max |
整数 | 最近一次分类账的序列号实际上搜索了交易。 |
limit |
整数 | limit 请求中使用的值。(这可能与服务器实际实施的限制值不同。) |
marker |
(未标明) | 指示响应的服务器定义的值是分页的。将此传递给下一个电话以恢复此通话停止的位置。 |
transactions |
排列 | 如下所述,与请求标准匹配的事务数组。 |
validated |
布尔 | 如果包含并设置为true ,则此回复中的信息来自经过验证的分类帐版本。否则,信息可能会更改。 |
注:该服务器可以与不同的价值观回应ledger_index_min
并ledger_index_max
比你请求中提供,例如,如果它没有你手头上指定的版本。
每个事务对象都包含以下字段,具体取决于它是以JSON还是以十六进制字符串("binary":true
)格式请求的。
Field |
类型 | 描述 |
---|---|---|
ledger_index |
整数 | 包含此交易的分类帐版本的序号。 |
meta |
对象(JSON)或字符串(二进制) | 如果binary 为True,那么这是事务元数据的十六进制字符串。否则,事务元数据将包含在JSON格式中。 |
tx |
目的 | (仅限JSON模式)定义事务的JSON对象 |
tx_blob |
串 | (仅限二进制模式)唯一散列代表事务的字符串。 |
validated |
布尔 | 交易是否包含在经过验证的分类帐中。任何尚未处于验证分类帐中的交易可能会发生变化。 |
invalidParams
- 一个或多个字段指定不正确,或缺少一个或多个必填字段。actMalformed
- 请求字段中指定的地址account
格式不正确。actBitcoin
- 该字段中指定的地址account
格式化为比特币地址,而不是XRP分类帐地址。lgrIdxsInvalid
- 由ledger_index_min
或者ledger_index_max
不存在的分类账,或者存在但服务器不存在。[资源]
该noripple_check
命令提供了一种快速检查帐户的DefaultRipple字段以及其信任线的NoRipple标志的状态,并与建议的设置进行比较。
请求格式的示例:
{
"id": 0,
"command": "noripple_check",
"account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"role": "gateway",
"ledger_index": "current",
"limit": 2,
"transactions": true
}
注意:此方法没有命令行语法。使用该json
命令从命令行访问此命令。
该请求包含以下参数:
Field |
类型 | 描述 |
---|---|---|
account |
串 | 账户的唯一标识符,通常是账户的地址。 |
role |
串 | 地址是指a gateway 还是user 。建议取决于帐户的角色。发行人必须启用DefaultRipple,并且必须在所有信任线上禁用NoRipple。用户应该禁用DefaultRipple,并且应该在所有信任线上启用NoRipple。 |
transactions |
布尔 | (可选)如果true 将一组建议的事务包含为JSON对象,那么您可以签名并提交以解决问题。默认为false。 |
limit |
无符号整数 | (可选)要包含在结果中的最大信任线问题数。默认为300。 |
ledger_hash |
串 | (可选)要使用的分类帐版本的20字节十六进制字符串。(请参阅指定分类帐) |
ledger_index |
字符串或无符号整数 | (可选)要使用的分类帐的序号或快捷字符串自动选择分类帐。(请参阅指定分类帐) |
一个成功回应的例子:
{
"id": 0,
"status": "success",
"type": "response",
"result": {
"ledger_current_index": 14342939,
"problems": [
"You should immediately set your default ripple flag",
"You should clear the no ripple flag on your XAU line to r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z",
"You should clear the no ripple flag on your USD line to rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q"
],
"transactions": [
{
"Account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"Fee": 10000,
"Sequence": 1406,
"SetFlag": 8,
"TransactionType": "AccountSet"
},
{
"Account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"Fee": 10000,
"Flags": 262144,
"LimitAmount": {
"currency": "XAU",
"issuer": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z",
"value": "0"
},
"Sequence": 1407,
"TransactionType": "TrustSet"
},
{
"Account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"Fee": 10000,
"Flags": 262144,
"LimitAmount": {
"currency": "USD",
"issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
"value": "5"
},
"Sequence": 1408,
"TransactionType": "TrustSet"
}
],
"validated": false
}
}
响应遵循标准格式,成功结果包含以下字段:
Field |
类型 | 描述 |
---|---|---|
ledger_current_index |
数 | 用于计算这些结果的分类帐的序列号。 |
problems |
排列 | 具有人类可读性问题描述的字符串数组。如果帐户的DefaultRipple设置不符合建议条件,则最多包含一个条目,并且最多包含一个条目,limit 其信息行的NoRipple设置不符合建议。 |
transactions |
排列 | (可以省略)如果请求指定transactions 为true ,则这是一个JSON对象数组,每个JSON对象都是JSON形式的事务,它应该修复所描述的问题之一。此数组的长度与数组相同problems ,并且每个条目旨在解决在该数组的相同索引中描述的问题。 |
invalidParams
- 一个或多个字段指定不正确,或缺少一个或多个必填字段。actNotFound
- 请求字段中指定的地址account
不对应分类账中的账户。lgrNotFound
- 由ledger_hash
或者ledger_index
不存在的分类账,或者确实存在,但服务器没有。[资源]
该gateway_balances
命令计算给定账户发出的总余额,可选地排除操作地址持有的金额。
请求格式的示例:
{
"id": "example_gateway_balances_1",
"command": "gateway_balances",
"account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
"strict": true,
"hotwallet": ["rKm4uWpg9tfwbVSeATv4KxDe6mpE9yPkgJ","ra7JkEzrgeKHdzKgo4EUUVBnxggY4z37kt"],
"ledger_index": "validated"
}
该请求包含以下参数:
Field |
类型 | 描述 |
---|---|---|
account |
串 | 要检查的地址。这应该是发行地址 |
strict |
布尔 | (可选)如果为true,则只接受帐户参数的地址或公钥。默认为false。 |
hotwallet |
字符串或数组 | 从已发行的余额或一系列此类地址中排除的操作地址。 |
ledger_hash |
串 | (可选)要使用的分类帐版本的20字节十六进制字符串。(请参阅指定分类帐) |
ledger_index |
字符串或无符号整数 | (可选)要使用的分类帐版本的序列号或自动选择分类帐的快捷字符串。(请参阅指定分类帐) |
一个成功回应的例子:
{
"id": 3,
"status": "success",
"type": "response",
"result": {
"account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
"assets": {
"r9F6wk8HkXrgYWoJ7fsv4VrUBVoqDVtzkH": [
{
"currency": "BTC",
"value": "5444166510000000e-26"
}
],
"rPFLkxQk6xUGdGYEykqe7PR25Gr7mLHDc8": [
{
"currency": "EUR",
"value": "4000000000000000e-27"
}
],
"rPU6VbckqCLW4kb51CWqZdxvYyQrQVsnSj": [
{
"currency": "BTC",
"value": "1029900000000000e-26"
}
],
"rpR95n1iFkTqpoy1e878f4Z1pVHVtWKMNQ": [
{
"currency": "BTC",
"value": "4000000000000000e-30"
}
],
"rwmUaXsWtXU4Z843xSYwgt1is97bgY8yj6": [
{
"currency": "BTC",
"value": "8700000000000000e-30"
}
]
},
"balances": {
"rKm4uWpg9tfwbVSeATv4KxDe6mpE9yPkgJ": [
{
"currency": "EUR",
"value": "29826.1965999999"
}
],
"ra7JkEzrgeKHdzKgo4EUUVBnxggY4z37kt": [
{
"currency": "USD",
"value": "13857.70416"
}
]
},
"ledger_hash": "61DDBF304AF6E8101576BF161D447CA8E4F0170DDFBEAFFD993DC9383D443388",
"ledger_index": 14483195,
"obligations": {
"BTC": "5908.324927635318",
"EUR": "992471.7419793958",
"GBP": "4991.38706013193",
"USD": "1997134.20229482"
},
"validated": true
}
}
注意:此方法没有命令行语法。使用该json
命令从命令行访问此命令。
响应遵循标准格式,成功结果包含以下字段:
Field |
类型 | 描述 |
---|---|---|
account |
串 | 唯一地址,用于识别发行余额的帐户。 |
obligations |
目的 | (如果为空,则省略)发给未排除地址的总金额,作为货币对总值的映射。 |
balances |
目的 | (如果为空,则省略)hotwallet 从请求发放到地址的金额。这些密钥是地址,值是它们持有的货币数量的数组。 |
assets |
目的 | (如果为空,则省略)由他人发行的总金额。在推荐配置中,发布地址应该没有。 |
ledger_hash |
串 | (可以省略)用于生成此响应的分类帐的标识哈希。 |
ledger_index |
数 | (可以省略)用于生成此响应的分类帐版本的序列号。 |
ledger_current_index |
数 | (可以省略)用于生成此响应的当前正在进行分类帐版本的序列号。 |
invalidParams
- 一个或多个字段指定不正确,或缺少一个或多个必填字段。invalidHotWallet
- 该hotwallet
字段中指定的一个或多个地址不是持有该账户从请求中发行货币的账户的地址。actNotFound
- 请求字段中指定的地址account
不对应分类账中的账户。lgrNotFound
- 由ledger_hash
或者ledger_index
不存在的分类账,或者确实存在,但服务器没有。[资源]
使用该wallet_propose
方法生成密钥对和XRP分类帐地址。该命令仅生成关键字和地址值,不会以任何方式影响XRP帐簿本身。要成为储存在分类帐中的获得资金的地址,地址必须收到支付交易,该交易提供足够的XRP以满足储备金要求。
该wallet_propose
请求是一个不能由非特权用户运行的管理命令!(此命令仅限于防止人们嗅探网络流量中的帐户机密,因为管理命令通常不通过外部网络传输。)
请求格式的示例:
{
"command": "wallet_propose",
"seed": "snoPBrXtMeMyMHUVTgbuqAfg1SUTb",
"key_type": "secp256k1"
}
该请求可以包含以下参数:
Field |
类型 | 描述 |
---|---|---|
key_type |
串 | 该密钥对使用哪个椭圆曲线。有效值是ed25519 和secp256k1 (全部小写)。默认为secp256k1 。 |
passphrase |
串 | (可选)从此种子值生成密钥对和地址。该值可以格式化为十六进制,base58,RFC-1751或任意字符串。不能与seed or 一起使用seed_hex 。 |
seed |
串 | (可选)从base58编码的种子值生成密钥对和地址。不能与passphrase or 一起使用seed_hex 。 |
seed_hex |
串 | (可选)以十六进制格式从此种子值生成密钥对和地址。不能与passphrase or 一起使用seed 。 |
您必须提供至多一个以下字段:passphrase
,seed
,或seed_hex
。如果你忽略所有三个,rippled
使用随机种子。
注意:Ed25519支持是实验性的。该命令的命令行版本不能生成Ed25519密钥。
对于大多数情况,您应该使用由强大的随机性产生的种子值。任何知道地址种子价值的人都有权发送该地址签署的交易。通常,不带参数运行此命令是生成随机种子的好方法。
您可以指定已知种子的情况包括:
rippled
功能如果您确实指定了种子,则可以使用以下任何格式来指定它:
snoPBrXtMeMyMHUVTgbuqAfg1SUTb
。I IRE BOND BOW TRIO LAID SEAT GOAL HEN IBIS IBIS DARE
。DEDCE9CE67B451D852FD4E846FCDE31C
。masterpassphrase
。一个成功回应的例子:
{
"id": 2,
"status": "success",
"type": "response",
"result": {
"account_id": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
"key_type": "secp256k1",
"master_key": "I IRE BOND BOW TRIO LAID SEAT GOAL HEN IBIS IBIS DARE",
"master_seed": "snoPBrXtMeMyMHUVTgbuqAfg1SUTb",
"master_seed_hex": "DEDCE9CE67B451D852FD4E846FCDE31C",
"public_key": "aBQG8RQAzjs1eTKFEAQXr2gS4utcDiEC9wmi7pfUPTi27VCahwgw",
"public_key_hex": "0330E7FC9D56BB25D6893BA3F317AE5BCF33B3291BD63DB32654A313222F7FD020"
}
}
响应遵循标准格式,成功结果包含有关新(潜在)帐户的各种重要信息,包括以下字段:
Field |
类型 | 描述 |
---|---|---|
master_seed |
串 | 这是密钥对的私钥。以Ripple的base58编码字符串格式从其中获取有关此帐户的所有其他信息的主种子。通常,您使用此格式的密钥来签署交易。 |
master_seed_hex |
串 | 主种子,十六进制格式。一种简单的,广泛支持的方式来表示私钥。可以用来签署交易。 |
master_key |
串 | 主种子,采用RFC 1751格式。一个更容易记住,更易于记录的私钥版本。可以用来签署交易。 |
account_id |
串 | 该帐户的地址为base58格式。这不是公钥,而是它的哈希值。它也有校验和,所以打字错误几乎肯定会导致无效的地址,而不是有效的,但不同的地址。这是XRP分类帐中帐户的主要标识符。你告诉人们这是为了获得报酬,并在交易中使用它来表明你是谁,你支付什么,信任等等。多签名列表也使用这些来标识其他签名者。 |
public_key |
串 | 密钥对的公钥,采用Ripple的base58编码字符串格式。派生自master_seed 。 |
public_key_hex |
串 | 这是密钥对的公钥,以十六进制表示。派生自master_seed 。要验证交易中的签名,rippled 需要此公钥。这就是为什么签名交易的格式包含该SigningPubKey 字段中的公钥。 |
warning |
串 | (可以省略)如果请求指定了一个种子值,该字段会提供一个警告,表明它可能不安全。 |
您也可以使用此方法生成密钥对,以用作帐户的常规密钥对。您将一个常规密钥对分配给一个帐户,以便能够使用该密钥对签署大部分交易,并尽可能使主密钥对保持离线状态。
除了将其用作常规密钥对外,您还可以将其用作多签名列表(SignerList)的成员。
有关主密钥和常规密钥对的更多信息,请参阅加密密钥
有关多重签名和签名者列表的更多信息,请参见多重签名。
invalidParams
- 一个或多个字段指定不正确。badSeed
-该请求所指定的禁止使用的种子值(在passphrase
,seed
或seed_hex
字段),如一个空字符串,或字符串类似于XRP总帐地址。每台rippled
服务器都会保存XRP分类帐当前状态的完整副本,其中包含优化树形格式中网络中的所有帐户,交易,优惠和其他数据。由于提出了交易和优惠,每个服务器将它们整合到其当前的分类帐副本中,定期关闭它,并且(如果已配置)参与推进经过全球验证的版本。在网络达成共识之后,该分类帐版本将得到验证并永久不变。任何未包含在一个分类帐版本中的交易都将成为下一个验证版本中的候选项。
[资源]
检索关于公共分类帐的信息。
请求格式的示例:
{
"id": 14,
"command": "ledger",
"ledger_index": "validated",
"full": false,
"accounts": false,
"transactions": false,
"expand": false,
"owner_funds": false
}
尝试一下!
该请求可以包含以下参数:
Field |
类型 | 描述 |
---|---|---|
ledger_hash |
串 | (可选)要使用的分类帐版本的20字节十六进制字符串。(请参阅指定分类帐)。 |
ledger_index |
字符串或无符号整数 | (可选)要使用的分类帐的序号或快捷字符串自动选择分类帐。(请参阅指定分类帐) |
full |
布尔 | (可选) 需要管理员如果true 返回整个分类帐的完整信息。如果您未指定分类账版本,则忽略。默认为false 。(相当于启用transactions ,accounts 和expand )注意:这是一个非常大量的数据 - 数百兆字节! |
accounts |
布尔 | (可选) 需要管理员。如果true ,返回账簿中的账户信息。如果您未指定分类账版本,则忽略。默认为false 。警告:这会返回大量的数据! |
transactions |
布尔 | (可选)如果true 返回指定分类帐版本中的交易信息。默认为false 。如果您未指定分类账版本,则忽略。 |
expand |
布尔 | (可选)为交易/帐户信息提供完整的JSON格式信息,而不仅仅是散列。默认为false 。除非您请求交易或帐户,否则将被忽略。 |
owner_funds |
布尔 | (可选)如果在响应中的OfferCreate事务的元数据中true 包含owner_funds 字段。默认为false 。忽略除非包含交易并且expand 是真实的。 |
binary |
布尔 | (可选)如果true 和transactions 和expand 都同时true 以二进制格式(十六进制字符串)而不是JSON格式返回事务信息。 |
queue |
布尔 | (可选)如果true ,并且该命令正在请求current 分类帐,则会在结果中包含排队的事务数组。 |
该ledger
字段已弃用,可能会被删除,恕不另行通知。
一个成功回应的例子:
{
"id": 4,
"status": "success",
"type": "response",
"result": {
"ledger": {
"accepted": true,
"account_hash": "FD2709F6C07284C3EE85EDE32AC452D9013A89D9B9E781D67D9784457E86A9BB",
"close_flags": 0,
"close_time": 508541181,
"close_time_human": "2016-Feb-11 21:26:21",
"close_time_resolution": 10,
"closed": true,
"hash": "F1433E9D15F33E746B8820DEEE4879F48181704364E459332561DF8E52E4EB7E",
"ledger_hash": "F1433E9D15F33E746B8820DEEE4879F48181704364E459332561DF8E52E4EB7E",
"ledger_index": "18851530",
"parent_close_time": 508541180,
"parent_hash": "8300B70AA5A865961DED7DAC5B88047028762D5946ECA887D09D32DE442E2305",
"seqNum": "18851530",
"totalCoins": "99998102799411646",
"total_coins": "99998102799411646",
"transaction_hash": "E0DB0471A1D198611E1C050ADA4AE74EEB38CEC26E0550663E0FCB1364212A3B"
},
"ledger_hash": "F1433E9D15F33E746B8820DEEE4879F48181704364E459332561DF8E52E4EB7E",
"ledger_index": 18851530,
"validated": true
}
}
响应遵循标准格式,成功结果包含有关分类账的信息,包括以下字段:
Field |
类型 | 描述 |
---|---|---|
ledger |
目的 | 此分类帐的完整标题数据。 |
ledger.account_hash |
串 | 以十六进制格式显示此分类帐中所有帐户状态信息的散列 |
ledger.accounts |
排列 | (除非有请求,则省略)此分类帐中的所有帐户状态信息。 |
ledger.close_time |
整数 | 这个分类帐的时间在波纹时代以后几秒钟内关闭 |
ledger.close_time_human |
串 | 这个分类帐的时间以可读的格式关闭 |
ledger.close_time_resolution |
整数 | 总帐关闭时间在这几秒钟内四舍五入。 |
ledger.closed |
布尔 | 这个分类帐是否已经关闭 |
ledger.ledger_hash |
串 | 唯一标识整个分类帐的散列。 |
ledger.ledger_index |
串 | 该分类帐的总帐索引,作为引用的整数 |
ledger.parent_hash |
串 | 唯一标识在此之前出现的分类帐的散列。 |
ledger.total_coins |
串 | 作为引用的整数,网络中的XRP下降总数。(这会随着交易成本破坏XRP而降低。) |
ledger.transaction_hash |
串 | 包含在此分类帐中的交易信息散列,如十六进制 |
ledger.transactions |
排列 | (未请求时省略)在此分类帐版本中应用的交易。默认情况下,成员是交易'识别哈希字符串。如果请求指定expand 为true,则成员完全是交易的表示形式,而不是JSON或二进制形式,具体取决于请求是否指定binary 为true。 |
ledger_hash |
串 | 唯一标识整个分类帐的散列。 |
ledger_index |
数 | 该分类帐的总帐索引。 |
queue_data |
排列 | (除非使用queue 参数请求,否则忽略)按照与队列相同的顺序描述排队事务的对象数组。如果请求指定expand 为true,则成员包含事务的完整表示,可以采用JSON或二进制形式,具体取决于请求是否指定binary 为true。需要费用修正。 |
以下字段弃用的并且可以在不另行通知被删除:accepted
,hash
,seqNum
,totalCoins
。
queue_data
数组的每个成员表示队列中的一个事务。此对象的某些字段可能会因为尚未计算而被忽略。该对象的字段如下所示:
领域 | 值 | 描述 |
---|---|---|
account |
串 | 该地址发送此排队交易。 |
tx |
字符串或对象 | 默认情况下,这是一个包含事务标识哈希的字符串。如果事务以二进制格式扩展,那么这是一个对象,它的唯一字段是tx_blob ,以十进制字符串形式包含事务的二进制形式。如果事务以JSON格式扩展,则这是一个包含事务对象的对象,包括事务在该hash 字段中标识的散列。 |
retries_remaining |
数 | 此次交易在被投放前可以重试多少次。 |
preflight_result |
串 | 初步交易检查的初步结果。这总是tesSUCCESS 。 |
last_result |
串 | (可以省略)如果这个事务在得到retriable(ter )结果后留在队列中,这就是ter 它得到的确切结果代码。 |
auth_change |
布尔 | (可以省略)此事务是否更改此地址授权事务的方式。 |
fee |
串 | (可能省略)此交易的交易成本,以XRP为单位。 |
fee_level |
串 | (可以省略)此交易的交易成本,相对于此类交易的最低成本,以费用级别表示。 |
max_spend_drops |
串 | (也可以省略) XRP的最大量,以滴剂,该交易可能发送或破坏。 |
如果请求指定"owner_funds": true
并扩展了事务,则响应owner_funds
在metaData
每个OfferCreate-type事务的对象中都有一个字段。这个领域的目的是为了更容易地跟踪每个新的经过验证的分类账的供应资金状况。此字段的定义与Order Book订购流中该字段的版本稍有不同:
Field |
值 | 描述 |
---|---|---|
owner_funds |
串 | 在此分类账中执行所有交易后TakerGets ,Account 发送此OfferCreate交易的货币的数量金额。这不检查货币金额是否被冻结。 |
invalidParams
- 一个或多个字段指定不正确,或缺少一个或多个必填字段。lgrNotFound
- 由ledger_hash
或者ledger_index
不存在的分类账,或者确实存在,但服务器没有。noPermission
- 如果您指定full
或者accounts
为true,但没有以管理员身份连接到服务器(通常,admin需要连接本地端口)。[资源]
该ledger_closed
方法返回最近关闭的分类帐的唯一标识符。(这个分类账不一定是有效的和不可变的。)
请求格式的示例:
{
"id": 2,
"command": "ledger_closed"
}
尝试一下!
该方法不接受任何参数。
一个成功回应的例子:
{
"id": 1,
"status": "success",
"type": "response",
"result": {
"ledger_hash": "17ACB57A0F73B5160713E81FE72B2AC9F6064541004E272BD09F257D57C30C02",
"ledger_index": 6643099
}
}
响应遵循标准格式,成功结果包含以下字段:
Field |
类型 | 描述 |
---|---|---|
ledger_hash |
串 | 20字节的十六进制字符串,带有分类帐的唯一散列 |
ledger_index |
无符号整数 | 此分类帐的序号 |
[资源]
该ledger_current
方法返回当前正在进行的分类帐的唯一标识符。该命令对于测试非常有用,因为返回的分类账仍然不断变化。
请求格式的示例:
{
"id": 2,
"command": "ledger_current"
}
尝试一下!
该请求不包含参数。
一个成功回应的例子:
{
"id": 2,
"status": "success",
"type": "response",
"result": {
"ledger_current_index": 6643240
}
}
响应遵循标准格式,成功结果包含以下字段:
Field |
类型 | 描述 |
---|---|---|
ledger_current_index |
无符号整数 | 此分类帐的序号 |
一个ledger_hash
不提供现场,因为目前台账的散列不断与它的内容改变一起。
[资源]
该ledger_data
方法检索指定分类帐的内容。您可以遍历多个调用来检索单个分类帐版本的全部内容。
请求格式的示例:
{
"id": 2,
"ledger_hash": "842B57C1CC0613299A686D3E9F310EC0422C84D3911E5056389AA7E5808A93C8",
"command": "ledger_data",
"limit": 5,
"binary": true
}
注意:没有命令行语法ledger_data
。您可以使用该json
命令从命令行访问此方法。
请求可以包含以下字段:
Field |
类型 | 描述 |
---|---|---|
id |
(任意) | (仅限WebSocket)在响应延迟或无序时,将此请求与其他人分开的任何标识符。 |
ledger_hash |
串 | (可选)要使用的分类帐版本的20字节十六进制字符串。(请参阅指定分类帐) |
ledger_index |
字符串或无符号整数 | (可选)要使用的分类帐的序号或快捷字符串自动选择分类帐。(请参阅指定分类帐) |
binary |
布尔 | (可选,默认为False)如果设置为true,则返回分类帐对象为散列十六进制字符串而不是JSON。 |
limit |
整数 | (可选,默认不同)限制要检索的分类帐对象的数量。服务器不需要遵守这个值。 |
marker |
(未标明) | 来自之前分页响应的价值。在该响应停止的情况下继续恢复数据。 |
该ledger
字段已弃用,可能会被删除,恕不另行通知。
一个成功回应的例子:
{
"id": 2,
"result": {
"ledger_hash": "842B57C1CC0613299A686D3E9F310EC0422C84D3911E5056389AA7E5808A93C8",
"ledger_index": "6885842",
"marker": "0002A590029B53BE7857EFF9985F770EC792CE483720EB5E963C4D6A607D43DF",
"state": [
{
"data": "11006122000000002400000001250062FEA42D0000000055C204A65CF2542946289A3358C67D991B5E135FABFA89F271DBA7A150C08CA0466240000000354540208114C909F42250CFE8F12A7A1A0DFBD3CBD20F32CD79",
"index": "00001A2969BE1FC85F1D7A55282FA2E6D95C71D2E4B9C0FDD3D9994F3C00FF8F"
},
{
"data": "11006F22000000002400000003250035788533000000000000000034000000000000000055555B93628BF3EC318892BB7C7CDCB6732FF53D12B6EEC4FAF60DD1AEE1C6101F501071633D7DE1B6AEB32F87F1A73258B13FC8CC32942D53A66D4F038D7EA4C6800064D4838D7EA4C68000000000000000000000000000425443000000000035DD7DF146893456296BF4061FBE68735D28F3286540000000000F42408114A4B8F5F7B644AEDC3447F9459C132EEB016A133B",
"index": "000037C6659BB98F8D09F2F4CFEB27DE8EFEAFE54DD9E1C13AECDF5794B0C0F5"
},
{
"data": "11006F2200020000240000000A250067395C33000000000000000034000000000000000055A160BC41A45B6BB118DF23D77E4FF23C723431B917F50DCB41319ECC2821F34C5010DFA3B6DDAB58C7E8E5D944E736DA4B7046C30E4F460FD9DE4C1AA535D3D0C00064D554C88B43EFA00000000000000000000000000055534400000000000A20B3C85F482532A9578DBB3950B85CA06594D165400000B59B9F780081148366FB9ACD2A0FD822E31112D2EB6F98C317C2C1",
"index": "0000A8791F78CC9B39200E12A9BDAACCF40A72A512FA815525CFC9BA772990F7"
},
{
"data": "1100612200000000240000000125003E742F2D0000000055286498B513710CFEB2D723A554C7557983D1952DF4DEE342C40DCB43067C9A21624000000306DC42008114225BAB89C4A4B94624BB069D6DB3C819F934991C",
"index": "0000B717320558E2DE1A3B9FDB24E9A695BF05D1A44E4A4683212BB1DD0FBA23"
},
{
"data": "110072220002000025000B65783700000000000000003800000000000000005587591A63051645F37B85D1FBA55EE69B1C96BFF16904F5C99F03FB93D42D03756280000000000000000000000000000000000000004254430000000000000000000000000000000000000000000000000166800000000000000000000000000000000000000042544300000000000A20B3C85F482532A9578DBB3950B85CA06594D167D4C38D7EA4C680000000000000000000000000004254430000000000C795FDF8A637BCAAEDAD1C434033506236C82A2D",
"index": "000103996A3BAD918657F86E12A67D693E8FC8A814DA4B958A244B5F14D93E58"
}
]
},
"status": "success",
"type": "response"
}
响应遵循标准格式,成功结果包含以下字段:
Field |
类型 | 描述 |
---|---|---|
ledger_index |
无符号整数 | 此分类帐的序号 |
ledger_hash |
串 | 唯一标识整个分类帐的散列。 |
state |
排列 | 包含树中数据的JSON对象数组,如下所定义 |
marker |
(未标明) | 指示响应的服务器定义的值是分页的。将此传递给下一个电话以恢复此通话停止的位置。 |
state
数组中每个对象的格式取决于binary
请求中是否设置为true或不是。每个state
对象可能包含以下字段:
Field |
类型 | 描述 |
---|---|---|
data |
串 | (只包括如果"binary":true )所需数据的十六进制表示 |
LedgerEntryType |
串 | (仅包含if "binary":false )指示此对象代表什么类型的分类帐对象的字符串。请参阅总账格式的完整列表。 |
(其他字段) | (各种) | (仅包含if "binary":false )描述此对象的其他字段,取决于它是哪个LedgerEntryType。 |
index |
串 | 此分类帐条目的唯一标识符,如十六进制。 |
invalidParams
- 一个或多个字段指定不正确,或缺少一个或多个必填字段。lgrNotFound
- 由ledger_hash
或者ledger_index
不存在的分类账,或者确实存在,但服务器没有。[资源]
该ledger_entry
方法以原始格式从XRP分类帐返回单个分类帐对象。请参阅分类帐格式了解有关可检索的不同类型对象的信息。
注意:此方法没有命令行版本。您可以使用该json
命令从命令行访问此方法。
请求格式的示例:
{
"id": 3,
"command": "ledger_entry",
"type": "account_root",
"account_root": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"ledger_index": "validated"
}
尝试一下!
该方法可以检索几种不同类型的数据。您可以通过传递适当的参数来选择要检索哪种类型的项目。具体而言,您应该提供以下其中一个字段:
index
- 通过其唯一ID检索任何类型的分类帐对象account_root
- 检索AccountRoot对象。这大致相当于account_info命令。directory
- 检索包含其他分类账对象列表的DirectoryNodeoffer
- 检索要约对象,该对象定义了兑换货币的要约ripple_state
- 检索RippleState对象,该对象跟踪两个帐户之间的(非XRP)货币余额。如果您指定了多个上述项目,则服务器仅检索它们; 它选择的是未定义的。
该方法识别的参数完整列表如下:
Field |
类型 | 描述 |
---|---|---|
index |
串 | (可选)指定要检索的单个分类帐条目的唯一标识符。 |
account_root |
字符串 -地址 | (可选)指定要检索的AccountRoot对象。 |
directory |
对象或字符串 | (可选)指定一个DirectoryNode。(DirectoryNode对象每个都包含它们包含的事物的ID列表。)如果是字符串,则以十六进制解释为目录的唯一索引。如果一个对象需要其中一个dir_root 或者owner 作为一个子字段,还可以选择一个sub_index 子字段。 |
directory.sub_index |
无符号整数 | (可选)如果提供,跳到更高的“页面” 目录。 |
directory.dir_root |
串 | (如果directory 指定为对象并且directory.owner 未提供,则是必需的)以十六进制字符串标识要检索的目录的唯一索引。 |
directory.owner |
串 | (如果directory 指定为对象directory.dir_root 且未提供,则为必需)与此目录关联的帐户的唯一地址 |
offer |
对象或字符串 | (可选)指定要检索的Offer对象。如果是字符串,则解释为要约的唯一索引。如果某个对象需要子字段account 并seq 唯一标识该提议。 |
offer.account |
字符串 -地址 | (如果offer 指定,则为必填项)提交报价的帐户。 |
offer.seq |
无符号整数 | (如果offer 指定,则为必需)创建Offer对象的事务的序列号。 |
ripple_state |
目的 | (可选)指定要检索的RippleState(信任线)对象的对象。必须accounts 和currency 子字段唯一地指定要检索的RippleState条目。 |
ripple_state.accounts |
排列 | (如果ripple_state 指定,则为必需)帐户地址 es的2长度数组,定义由此RippleState对象链接的两个帐户 |
ripple_state.currency |
串 | (如果ripple_state 指定,则为必需)要检索的RippleState对象的货币代码。 |
binary |
布尔 | (可选)如果为true,则以十六进制字符串形式返回请求的分类帐对象的内容。否则,以JSON格式返回数据。缺省是true 如果搜索index 和false 否则。 |
ledger_hash |
串 | (可选)要使用的分类帐版本的20字节十六进制字符串。(请参阅指定分类帐) |
ledger_index |
字符串或无符号整数 | (可选)要使用的分类帐的序号或快捷字符串自动选择分类帐。(请参阅指定分类帐) |
的generator
和ledger
参数已过时,可以在没有进一步的通知被移除。
一个成功回应的例子:
"id": 3,
"result": {
"index": "4F83A2CF7E70F77F79A307E6A472BFC2585B806A70833CCD1C26105BAE0D6E05",
"ledger_index": 6889347,
"node": {
"Account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"Balance": "27389517749",
"Flags": 0,
"LedgerEntryType": "AccountRoot",
"OwnerCount": 18,
"PreviousTxnID": "B6B410172C0B65575D89E464AF5B99937CC568822929ABF87DA75CBD11911932",
"PreviousTxnLgrSeq": 6592159,
"Sequence": 1400,
"index": "4F83A2CF7E70F77F79A307E6A472BFC2585B806A70833CCD1C26105BAE0D6E05"
}
},
"status": "success",
"type": "response"
}
响应遵循标准格式,成功结果包含以下字段:
Field |
类型 | 描述 |
---|---|---|
index |
串 | 此ledger_entry的唯一标识键 |
ledger_index |
无符号整数 | 从中检索此数据的分类帐的唯一序号 |
node |
目的 | (如果"binary": true 指定,则省略)包含此分类帐对象数据的对象,根据分类帐格式。 |
node_binary |
串 | (除非"binary":true 指定,省略)分类帐对象的二进制数据,如十六进制。 |
invalidParams
- 一个或多个字段指定不正确,或缺少一个或多个必填字段。lgrNotFound
- 由ledger_hash
或者ledger_index
不存在的分类账,或者确实存在,但服务器没有。[资源]
该ledger_request
命令告诉服务器从其连接的对等方获取特定分类账版本。这只有在服务器的一个立即连接的同行拥有该分类账时才有效。您可能需要多次运行该命令才能完全获取分类帐。
该ledger_request
请求是一个不能由非特权用户运行的管理命令!
请求格式的示例:
{
"id": 102,
"command": "ledger_request",
"ledger_index": 13800000
}
该请求包含以下参数:
Field |
类型 | 描述 |
---|---|---|
ledger_index |
数 | (可选)通过其分类帐索引检索指定的分类帐。 |
ledger_hash |
串 | (可选)通过其标识哈希检索指定的分类帐。 |
您必须提供ledger_index
或者ledger_hash
但不是两者。
响应遵循标准格式。但是,如果请求没有指定的分类帐,即使成功地指示rippled
服务器开始检索分类帐,该请求也会返回失败响应。
注意:要检索分类帐,波动的服务器必须与其历史记录中的分类帐具有直接对等关系。如果没有对等方拥有请求的分类帐,则可以使用connect
命令或fixed_ips
配置文件的部分将Ripple的完整历史记录服务器添加到s2.ripple.com
,然后ledger_request
再次发出请求。
失败响应表示获取分类帐的状态。成功的响应包含与ledger
命令类似格式的分类帐信息。
Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
{
"result" : {
"acquiring" : {
"hash" : "01DDD89B6605E20338B8EEB8EB2B0E0DD2F685A2B164F3790C4D634B5734CC26",
"have_header" : false,
"peers" : 2,
"timeouts" : 0
},
"error" : "lgrNotFound",
"error_code" : 20,
"error_message" : "acquiring ledger containing requested index",
"request" : {
"command" : "ledger_request",
"ledger_index" : 18851277
},
"status" : "error"
}
}
三种可能的响应格式如下:
lgrNotFound
错误时,响应有一个字段,acquiring
一个Ledger请求对象指示从对等网络获取分类帐的进度。当服务器处于提取分类帐的过程中,但尚未完成时,rippled
服务器将返回一个分类帐请求对象,指示其获取分类帐的进度。该对象具有以下字段:
Field |
类型 | 描述 |
---|---|---|
hash |
串 | (可以省略)请求分类帐的散列,如果服务器知道它的话。 |
have_header |
布尔 | 服务器是否具有请求分类帐的标题部分。 |
have_state |
布尔 | (可以省略)服务器是否具有请求分类账的账户状态部分。 |
have_transactions |
布尔 | (可以省略)服务器是否具有请求分类账的交易部分。 |
needed_state_hashes |
字符串数组 | (可能省略)状态树中最多有16个哈希对象,服务器仍然需要检索。 |
needed_transaction_hashes |
字符串数组 | (可能会被省略)事务树中最多有16个对象散列,服务器仍然需要检索。 |
peers |
数 | 服务器查询多少个对等机构来查找此分类帐。 |
timeouts |
数 | 取得此分类帐的次数目前已超时。 |
invalidParams
- 一个或多个字段指定不正确,或缺少一个或多个必填字段。如果您指定等于或高于当前正在处理的分类帐的分类帐索引,也会发生此错误。lgrNotFound
- 如果分类帐尚未提供。这表明服务器已经开始提取分类账,尽管如果没有连接的对等方拥有请求的分类帐,它可能会失败。(以前,这个错误使用了代码ledgerNotFound
。)[资源]
该ledger_accept
方法强制服务器关闭当前工作分类帐并转到下一个分类帐号。此方法仅用于测试目的,并且仅在rippled
服务器运行独立模式时可用。
该ledger_accept
方法是不能由非特权用户运行的管理员命令!
请求格式的示例:
{
"id": "Accept my ledger!",
"command": "ledger_accept"
}
该请求不接受任何参数。
一个成功回应的例子:
{
"id": "Accept my ledger!",
"status": "success",
"type": "response",
"result": {
"ledger_current_index": 6643240
}
}
响应遵循标准格式,成功结果包含以下字段:
Field |
类型 | 描述 |
---|---|---|
ledger_current_index |
无符号整数 | 新创建的“当前”分类账的序号 |
注意:关闭分类帐时,rippled
确定该分类帐中交易的规范顺序并重播它们。这可以改变临时应用于当前分类帐的交易的结果。
notStandAlone
- 如果rippled
服务器当前不在独立模式下运行。事务是唯一可以修改XRP分类帐的共享状态的事务。XRP Ledger上的所有业务都采用交易形式,其中不仅包括付款,还包括货币兑换优惠,账户设置以及对账本本身属性的更改(如采用新功能)。
交易中有几个复杂的来源。与传统银行业务不同的是,受信任的第三方(银行或ACH)验证参与者的身份并确保他们的余额得到精确调整,Ripple使用密码学和分散计算能力来执行相同的操作。发送XRP不需要分布式网络本身以外的第三方。但是,XRP账户还支持以任何货币发行余额并在分散交易所进行交易。这带来了更多的权力,但这也意味着系统必须考虑到交易对手的风险货币转换和其他问题。XRP分类账必须十分健壮,才能跟踪哪些交易已被完全验证,即使受到硬件故障,攻击或自然灾害的影响。
[资源]
该tx
方法检索单个事务的信息。
请求格式的示例:
{
"id": 1,
"command": "tx",
"transaction": "E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDACFCD1698C7",
"binary": false
}
尝试一下!
该请求包含以下参数:
Field |
类型 | 描述 |
---|---|---|
transaction |
串 | 交易的256位散列,如十六进制。 |
binary |
布尔 | (可选,默认为false)如果为true,则将事务数据和元数据作为十六进制字符串而不是JSON返回 |
一个成功回应的例子:
{
"id": 1,
"result": {
"Account": "r3PDtZSa5LiYp1Ysn1vMuMzB59RzV3W9QH",
"Amount": {
"currency": "USD",
"issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"value": "1"
},
"Destination": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"Fee": "10",
"Flags": 0,
"Paths": [
[
{
"account": "r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV",
"currency": "USD",
"issuer": "r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV",
"type": 49,
"type_hex": "0000000000000031"
}
],
[
{
"account": "rD1jovjQeEpvaDwn9wKaYokkXXrqo4D23x",
"currency": "USD",
"issuer": "rD1jovjQeEpvaDwn9wKaYokkXXrqo4D23x",
"type": 49,
"type_hex": "0000000000000031"
},
{
"account": "rB5TihdPbKgMrkFqrqUC3yLdE8hhv4BdeY",
"currency": "USD",
"issuer": "rB5TihdPbKgMrkFqrqUC3yLdE8hhv4BdeY",
"type": 49,
"type_hex": "0000000000000031"
},
{
"account": "r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV",
"currency": "USD",
"issuer": "r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV",
"type": 49,
"type_hex": "0000000000000031"
}
]
],
"SendMax": {
"currency": "USD",
"issuer": "r3PDtZSa5LiYp1Ysn1vMuMzB59RzV3W9QH",
"value": "1.01"
},
"Sequence": 88,
"SigningPubKey": "02EAE5DAB54DD8E1C49641D848D5B97D1B29149106174322EDF98A1B2CCE5D7F8E",
"TransactionType": "Payment",
"TxnSignature": "30440220791B6A3E036ECEFFE99E8D4957564E8C84D1548C8C3E80A87ED1AA646ECCFB16022037C5CAC97E34E3021EBB426479F2ACF3ACA75DB91DCC48D1BCFB4CF547CFEAA0",
"hash": "E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDACFCD1698C7",
"inLedger": 348734,
"ledger_index": 348734,
"meta": {
"AffectedNodes": [
{
"ModifiedNode": {
"FinalFields": { "Account": "r3PDtZSa5LiYp1Ysn1vMuMzB59RzV3W9QH", "Balance": "59328999119", "Flags": 0, "OwnerCount": 11, "Sequence": 89 },
"LedgerEntryType": "AccountRoot",
"LedgerIndex": "E0D7BDE68B468FF0B8D948FD865576517DA987569833A05374ADB9A72E870A06",
"PreviousFields": { "Balance": "59328999129", "Sequence": 88 },
"PreviousTxnID": "C26AA6B4F7C3B9F55E17CD0D11F12032A1C7AD2757229FFD277C9447A8815E6E",
"PreviousTxnLgrSeq": 348700 }
},
{
"ModifiedNode": {
"FinalFields": { "Balance": { "currency": "USD", "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", "value": "-1" }, "Flags": 131072, "HighLimit": { "currency": "USD", "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", "value": "100" }, "HighNode": "0000000000000000", "LowLimit": { "currency": "USD", "issuer": "r3PDtZSa5LiYp1Ysn1vMuMzB59RzV3W9QH", "value": "0" }, "LowNode": "0000000000000000" },
"LedgerEntryType": "RippleState",
"LedgerIndex": "EA4BF03B4700123CDFFB6EB09DC1D6E28D5CEB7F680FB00FC24BC1C3BB2DB959",
"PreviousFields": { "Balance": { "currency": "USD", "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", "value": "0" } },
"PreviousTxnID": "53354D84BAE8FDFC3F4DA879D984D24B929E7FEB9100D2AD9EFCD2E126BCCDC8",
"PreviousTxnLgrSeq": 343570 }
}
],
"TransactionIndex": 0,
"TransactionResult": "tesSUCCESS"
},
"validated": true
},
"status": "success",
"type": "response"
}
响应遵循标准格式,成功结果包含Transaction对象的字段以及以下附加字段:
Field |
类型 | 描述 |
---|---|---|
hash |
串 | 交易的SHA-512散列 |
inLedger |
无符号整数 | (已弃用)别名ledger_index 。 |
ledger_index |
无符号整数 | 包含此交易的分类帐的序号。 |
meta |
目的 | 关于交易的各种元数据。 |
validated |
布尔 | 如果此数据来自经过验证的分类账版本,则为真; 如果省略或设置为false,则此数据不是最终的。 |
(各种) | (各种) | Transaction对象的其他字段 |
invalidParams
- 一个或多个字段指定不正确,或缺少一个或多个必填字段。txnNotFound
- 交易不存在,或者它是旧版账本的一部分,rippled
没有可用的。[资源]
该transaction_entry
方法从特定分类帐版本检索单个事务的信息。(tx
相比之下,该命令将搜索指定事务的所有分类帐,我们建议使用该方法。)
请求格式的示例:
{
"id": 4,
"command": "transaction_entry",
"tx_hash": "E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDACFCD1698C7",
"ledger_index": 348734
}
尝试一下!
该请求包含以下参数:
Field |
类型 | 描述 |
---|---|---|
ledger_hash |
串 | (可选)要使用的分类帐版本的20字节十六进制字符串。(请参阅指定分类帐) |
ledger_index |
字符串或无符号整数 | (可选)要使用的分类帐的序号或快捷字符串自动选择分类帐。(请参阅指定分类帐) |
tx_hash |
串 | 您正在查找的交易的唯一散列 |
注意:此方法不支持从当前正在进行的分类账中检索信息。您必须在ledger_index
或中指定分类帐版本ledger_hash
。
一个成功回应的例子:
{
"id": 4,
"result": {
"ledger_index": 348734,
"metadata": {
"AffectedNodes": [
{
"ModifiedNode": {
"FinalFields": { "Account": "r3PDtZSa5LiYp1Ysn1vMuMzB59RzV3W9QH", "Balance": "59328999119", "Flags": 0, "OwnerCount": 11, "Sequence": 89 },
"LedgerEntryType": "AccountRoot",
"LedgerIndex": "E0D7BDE68B468FF0B8D948FD865576517DA987569833A05374ADB9A72E870A06",
"PreviousFields": { "Balance": "59328999129", "Sequence": 88 },
"PreviousTxnID": "C26AA6B4F7C3B9F55E17CD0D11F12032A1C7AD2757229FFD277C9447A8815E6E",
"PreviousTxnLgrSeq": 348700 }
},
{
"ModifiedNode": {
"FinalFields": { "Balance": { "currency": "USD", "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", "value": "-1" }, "Flags": 131072, "HighLimit": { "currency": "USD", "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", "value": "100" }, "HighNode": "0000000000000000", "LowLimit": { "currency": "USD", "issuer": "r3PDtZSa5LiYp1Ysn1vMuMzB59RzV3W9QH", "value": "0" }, "LowNode": "0000000000000000" },
"LedgerEntryType": "RippleState",
"LedgerIndex": "EA4BF03B4700123CDFFB6EB09DC1D6E28D5CEB7F680FB00FC24BC1C3BB2DB959",
"PreviousFields": { "Balance": { "currency": "USD", "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji", "value": "0" } },
"PreviousTxnID": "53354D84BAE8FDFC3F4DA879D984D24B929E7FEB9100D2AD9EFCD2E126BCCDC8",
"PreviousTxnLgrSeq": 343570 }
}
],
"TransactionIndex": 0,
"TransactionResult": "tesSUCCESS"
},
"tx_json": {
"Account": "r3PDtZSa5LiYp1Ysn1vMuMzB59RzV3W9QH",
"Amount": {
"currency": "USD",
"issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"value": "1"
},
"Destination": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"Fee": "10",
"Flags": 0,
"Paths": [
[
{
"account": "r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV",
"currency": "USD",
"issuer": "r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV",
"type": 49,
"type_hex": "0000000000000031"
}
],
[
{
"account": "rD1jovjQeEpvaDwn9wKaYokkXXrqo4D23x",
"currency": "USD",
"issuer": "rD1jovjQeEpvaDwn9wKaYokkXXrqo4D23x",
"type": 49,
"type_hex": "0000000000000031"
},
{
"account": "rB5TihdPbKgMrkFqrqUC3yLdE8hhv4BdeY",
"currency": "USD",
"issuer": "rB5TihdPbKgMrkFqrqUC3yLdE8hhv4BdeY",
"type": 49,
"type_hex": "0000000000000031"
},
{
"account": "r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV",
"currency": "USD",
"issuer": "r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV",
"type": 49,
"type_hex": "0000000000000031"
}
]
],
"SendMax": {
"currency": "USD",
"issuer": "r3PDtZSa5LiYp1Ysn1vMuMzB59RzV3W9QH",
"value": "1.01"
},
"Sequence": 88,
"SigningPubKey": "02EAE5DAB54DD8E1C49641D848D5B97D1B29149106174322EDF98A1B2CCE5D7F8E",
"TransactionType": "Payment",
"TxnSignature": "30440220791B6A3E036ECEFFE99E8D4957564E8C84D1548C8C3E80A87ED1AA646ECCFB16022037C5CAC97E34E3021EBB426479F2ACF3ACA75DB91DCC48D1BCFB4CF547CFEAA0",
"hash": "E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDACFCD1698C7",
"inLedger": 348734,
"ledger_index": 348734
}
},
"status": "success",
"type": "response"
}
响应遵循标准格式,成功结果包含以下字段:
Field |
类型 | 描述 |
---|---|---|
ledger_index |
无符号整数 | 在该交易中找到的分类账版本的序列号; 这与请求中的一样。 |
ledger_hash |
串 | (可能被省略)发现该交易的分类帐版本的唯一散列; 这与请求中的一样。 |
metadata |
目的 | 关于交易的各种元数据。 |
tx_json |
目的 | Transaction对象的 JSON表示 |
服务器可能无法找到交易有几个可能的原因:
fieldNotFoundTransaction
- tx_hash
请求中忽略了该字段notYetImplemented
- 请求中未指定分类帐版本。lgrNotFound
- 由ledger_hash
或者ledger_index
不存在的分类账,或者确实存在,但服务器没有。transactionNotFound
- 在指定的分类帐中找不到请求中指定的交易。(它可能在不同的分类帐版本中,或根本不可用。)[资源]
该tx_history
方法检索一些最近进行的交易。
警告:此方法已弃用,可能会被删除,恕不另行通知。
请求格式的示例:
{
"id": 5,
"command": "tx_history",
"start": 0
}
尝试一下!
该请求包含以下参数:
Field |
类型 | 描述 |
---|---|---|
start |
无符号整数 | 要跳过的交易数量。 |
一个成功回应的例子:
{
"id": 2,
"status": "success",
"type": "response",
"result": {
"index": 0,
"txs": [
{
"Account": "r9bf8V4ae5xReYnKPXgnwERDFPoW34FhGy",
"Fee": "12",
"Flags": 2147483648,
"LastLedgerSequence": 6907169,
"Sequence": 3276,
"SigningPubKey": "03B7857216DF96BABCC839686670A67602B3EE50D0F12B41C15F73760B8ED394C1",
"TransactionType": "AccountSet",
"TxnSignature": "3045022100CC0A2688DC36DC47BDBD5A571407316DD16A6CB3289E60C9589531707D30EBDB022010A2ED1F8562FEF61461B89E90E9D7245F5DD1AAE6680401A60F7FDA60184312",
"hash": "30FF69D2F2C2FF517A82EC8BA62AA4879E27A6EAF2C9B4AA422B77C23CD11B35",
"inLedger": 6907162,
"ledger_index": 6907162
},
{
"Account": "rHsZHqa5oMQNL5hFm4kfLd47aEMYjPstpg",
"Fee": "15",
"Flags": 0,
"Sequence": 1479735,
"SigningPubKey": "025718736160FA6632F48EA4354A35AB0340F8D7DC7083799B9C57C3E937D71851",
"TakerGets": "9999999999",
"TakerPays": {
"currency": "USD",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"value": "48.050907917"
},
"TransactionType": "OfferCreate",
"TxnSignature": "3045022100C110F47609CED085E0C184396877685ACAFF0A5846C859E9A57A8E238788FAE2022042A578D36F3D911E2536A39D74B10A741EF4C77B40738DB66E9E4FA85B797DF2",
"hash": "A5DE72E2E97CB0FA548713FB7C8542FD1A9723EC556D386F13B25F052435B29F",
"inLedger": 6907162,
"ledger_index": 6907162
},
{
"Account": "r9bf8V4ae5xReYnKPXgnwERDFPoW34FhGy",
"Fee": "12",
"Flags": 2147483648,
"LastLedgerSequence": 6907169,
"Sequence": 3275,
"SigningPubKey": "03B7857216DF96BABCC839686670A67602B3EE50D0F12B41C15F73760B8ED394C1",
"TransactionType": "AccountSet",
"TxnSignature": "3044022030E4CCDCBA8D9984C16AD9807D0FE654D4C558C08728B33A6D9F4D05DA811CF102202A6B53015583A6C24054EE93D9B9DDF0D17133676848304BBA5156DD2C2875BE",
"hash": "55DFC8F7EF3976B5968DC462D91B29274E8097C35D43D6B3740AB20584336A9C",
"inLedger": 6907162,
"ledger_index": 6907162
},
{
"Account": "rHsZHqa5oMQNL5hFm4kfLd47aEMYjPstpg",
"Fee": "15",
"Flags": 131072,
"Sequence": 1479734,
"SigningPubKey": "025718736160FA6632F48EA4354A35AB0340F8D7DC7083799B9C57C3E937D71851",
"TakerGets": {
"currency": "BTC",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"value": "0.009194668"
},
"TakerPays": "1073380944",
"TransactionType": "OfferCreate",
"TxnSignature": "304402202C0D26EABE058FCE8B6862EF5CAB70674637CE32B1B4E2F3551B9D5A2E1CDC7E02202C191D2697C65478BC2C1489721EB5799A6F3D4A1ECD8FE87A0C4FDCA3704A03",
"hash": "2499BAE9947BE731D7FE2F8E7B6A55E1E5B43BA8D3A9F22E39F79A0CC027A1C8",
"inLedger": 6907161,
"ledger_index": 6907161
},
{
"Account": "rHsZHqa5oMQNL5hFm4kfLd47aEMYjPstpg",
"Fee": "15",
"Flags": 131072,
"Sequence": 1479733,
"SigningPubKey": "025718736160FA6632F48EA4354A35AB0340F8D7DC7083799B9C57C3E937D71851",
"TakerGets": {
"currency": "USD",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"value": "5.298037873"
},
"TakerPays": {
"currency": "BTC",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"value": "0.008937558999999999"
},
"TransactionType": "OfferCreate",
"TxnSignature": "3044022075EF6054ABD08F9B8287314AD4904944A74A6C3BBED9D035BCE7D409FC46E49E022025CFEE7F72BEC1F87EA83E3565CB653643A57CDD13661798D6B70F47AF63FDB6",
"hash": "F873CB065791DDD503580931A500BB896B9DBAFC9C285C1159B884354F3EF48B",
"inLedger": 6907161,
"ledger_index": 6907161
},
{
"Account": "rHsZHqa5oMQNL5hFm4kfLd47aEMYjPstpg",
"Fee": "15",
"Flags": 0,
"OfferSequence": 1479726,
"Sequence": 1479732,
"SigningPubKey": "025718736160FA6632F48EA4354A35AB0340F8D7DC7083799B9C57C3E937D71851",
"TransactionType": "OfferCancel",
"TxnSignature": "3045022100E82B813DA3896051EAAA3D53E197F8F426DF4E51F07A2AB83E43B10CD4008D8402204D93BABA74E63E775D44D77F4F9B07D69B0C86930F2865BBBBD2DC956FA8AE4E",
"hash": "203613CFA3CB7BFBCFABBBCF80D932DFBBFDECCBB869CCDBE756EAA4C8EEA41D",
"inLedger": 6907161,
"ledger_index": 6907161
},
{
"Account": "rHsZHqa5oMQNL5hFm4kfLd47aEMYjPstpg",
"Fee": "15",
"Flags": 0,
"OfferSequence": 1479725,
"Sequence": 1479731,
"SigningPubKey": "025718736160FA6632F48EA4354A35AB0340F8D7DC7083799B9C57C3E937D71851",
"TransactionType": "OfferCancel",
"TxnSignature": "30440220678FF2E754A879EAE72207F191614BBA01B8088CD174AF509E9AA11448798CD502205B326E187A0530E4E90BDD1ED875492836657E4D593FBD655F64604178693D2F",
"hash": "1CF4D0D583F6FC85BFD15A0BEF5E4779A8ACAD0DE43823F07C9CC2A20E29E422",
"inLedger": 6907161,
"ledger_index": 6907161
},
{
"Account": "rHsZHqa5oMQNL5hFm4kfLd47aEMYjPstpg",
"Fee": "15",
"Flags": 0,
"OfferSequence": 1479724,
"Sequence": 1479730,
"SigningPubKey": "025718736160FA6632F48EA4354A35AB0340F8D7DC7083799B9C57C3E937D71851",
"TransactionType": "OfferCancel",
"TxnSignature": "3045022100A5533E81A67B6A88B674864E898FDF31D83787FECE496544EBEE88E6FC220500022002438599B2A0E4F70C2B46FB049CD339F76E466399CA4A8F72C4ADA03F615D90",
"hash": "D96EC06F2ADF3CF7ED59BD76B8F1BDB127CDE46B45977B477703DB05B8DF5208",
"inLedger": 6907161,
"ledger_index": 6907161
},
{
"Account": "rHsZHqa5oMQNL5hFm4kfLd47aEMYjPstpg",
"Fee": "15",
"Flags": 0,
"OfferSequence": 1479723,
"Sequence": 1479729,
"SigningPubKey": "025718736160FA6632F48EA4354A35AB0340F8D7DC7083799B9C57C3E937D71851",
"TransactionType": "OfferCancel",
"TxnSignature": "304402206DEF8C70103AE45BCED6762B238E6F155A57D46300E8FF0A1CD0197362483CAE022007BBDFD93A0BC2473EE4537B44095D1BB5EB83F76661A14230FB3B27C4EABB6D",
"hash": "089D22F601FB52D0E55A8E27D393F05570DC24E92028BB9D9DCAD7BC3337ADF9",
"inLedger": 6907161,
"ledger_index": 6907161
},
{
"Account": "rHsZHqa5oMQNL5hFm4kfLd47aEMYjPstpg",
"Fee": "15",
"Flags": 0,
"OfferSequence": 1479722,
"Sequence": 1479728,
"SigningPubKey": "025718736160FA6632F48EA4354A35AB0340F8D7DC7083799B9C57C3E937D71851",
"TransactionType": "OfferCancel",
"TxnSignature": "3044022065051B7240DE1D46865453B3D7F8FC59FB2B9FD609196AB394F857B75E2B8409022044683F3A35740FC97655A8A4516184D8C582E5D88CA360301B1AD308F4126763",
"hash": "F6A660EF99E32D02B9AF761B14993CA1ED8BAF3507F580D90A7759ABFAF0284E",
"inLedger": 6907161,
"ledger_index": 6907161
},
{
"Account": "rUBLCjWdsPPMkppdFXVJWhHnr3FNqCzgG3",
"Fee": "15",
"Flags": 0,
"LastLedgerSequence": 6907168,
"Sequence": 173286,
"SigningPubKey": "03D606359EEA9C0A49CA9EF55F6AED6C8AEDDE604223C1BE51A2D0460A725CF173",
"TakerGets": {
"currency": "BTC",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"value": "0.44942631"
},
"TakerPays": {
"currency": "USD",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"value": "260"
},
"TransactionType": "OfferCreate",
"TxnSignature": "304502205395AF4127AD0B890AC9C47F765B4F4046C70C3DFC6F8DCD2729552FAA97F13C022100C8C2DBA6A466D76D0F103AC88DB166D1EC7F6339238E2C4245C2C26308B38058",
"hash": "F20F06F36B5FEFF43DD1E8AEDBE9A0ECEF0CE41402AE6F0FE4BEE1F2F82A4D54",
"inLedger": 6907161,
"ledger_index": 6907161
},
{
"Account": "rDVynssGDojUPpM4abx9rxYeHG4HiLGxC",
"Fee": "15",
"Flags": 2147483648,
"LastLedgerSequence": 6907169,
"OfferSequence": 859,
"Sequence": 860,
"SigningPubKey": "02C37DA8D793142BD190CE13BB697521A89D1DC318A045816EE657F42527EBFC4E",
"TakerGets": "19871628459",
"TakerPays": {
"currency": "BTC",
"issuer": "rfYv1TXnwgDDK4WQNbFALykYuEBnrR4pDX",
"value": "0.166766470665369"
},
"TransactionType": "OfferCreate",
"TxnSignature": "3044022074737D253A0DB39DBB6C63E5BD522C1313CC57658B0A567E1F1DD3414DA3817502201F333D81F29845C53A0271D0C5B005DEE4A250529DAD1A880838E242D358EE35",
"hash": "AD197326AEF75AA466F32FEA87358C9FB587F1C1ABF41C73E2C3EFDD83B6F33B",
"inLedger": 6907161,
"ledger_index": 6907161
},
{
"Account": "rHsZHqa5oMQNL5hFm4kfLd47aEMYjPstpg",
"Fee": "15",
"Flags": 0,
"OfferSequence": 1479721,
"Sequence": 1479727,
"SigningPubKey": "025718736160FA6632F48EA4354A35AB0340F8D7DC7083799B9C57C3E937D71851",
"TransactionType": "OfferCancel",
"TxnSignature": "3045022100CCD7336F78291E1BCAA4F86695119175E0DBC26281B2F13B30A24C726419DFCA022062547E0A4894CEAE87C42CABA94E0731134560F07D8860AE62F4A87AFD16BC43",
"hash": "20353EA4152C32E63941DE2F3175BA69657BA9FAB39D22BCE38B6CA1B3734D4B",
"inLedger": 6907161,
"ledger_index": 6907161
},
{
"Account": "r9bf8V4ae5xReYnKPXgnwERDFPoW34FhGy",
"Fee": "12",
"Flags": 2147483648,
"LastLedgerSequence": 6907168,
"Sequence": 3274,
"SigningPubKey": "03B7857216DF96BABCC839686670A67602B3EE50D0F12B41C15F73760B8ED394C1",
"TransactionType": "AccountSet",
"TxnSignature": "3045022100F8412BBB1DB830F314F7400E99570A9F92668ACCDEA6096144A47EDF98E18D5D02204AD89122224F353155EACC30F80BA214350968F744A480B4CD5A3174B473D6AF",
"hash": "16F266ABCC617CF906A25AA83BDDAD2577125E6A692A36543934AA0F0C3B77C0",
"inLedger": 6907161,
"ledger_index": 6907161
},
{
"Account": "r9bf8V4ae5xReYnKPXgnwERDFPoW34FhGy",
"Fee": "12",
"Flags": 2147483648,
"LastLedgerSequence": 6907167,
"Sequence": 3273,
"SigningPubKey": "03B7857216DF96BABCC839686670A67602B3EE50D0F12B41C15F73760B8ED394C1",
"TakerGets": "5397",
"TakerPays": {
"currency": "USD",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"value": "0.00002593363079073453"
},
"TransactionType": "OfferCreate",
"TxnSignature": "3044022061685E23375A299747DE45DA302966C6AF8C07D2DA9BEBB4F5572E3B02C6564D02207187E626EC817EFAFFAD002E75FC16E17A5BD54DA41D4E339F3C2A9F86FFD523",
"hash": "C9112B7C246FC8A9B377BD762F1D64F0DCA1128D55254A442E5735935A09D83E",
"inLedger": 6907160,
"ledger_index": 6907160
},
{
"Account": "rBHMbioz9znTCqgjZ6Nx43uWY43kToEPa9",
"Amount": {
"currency": "USD",
"issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
"value": "4"
},
"Destination": "r4X3WWZ3UZMDw3Z7T32FXK2NAaiitSWZ9c",
"Fee": "12",
"Flags": 0,
"LastLedgerSequence": 6907168,
"Paths": [
[
{
"account": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"type": 1,
"type_hex": "0000000000000001"
},
{
"currency": "XRP",
"type": 16,
"type_hex": "0000000000000010"
},
{
"currency": "USD",
"issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
"type": 48,
"type_hex": "0000000000000030"
},
{
"account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
"type": 1,
"type_hex": "0000000000000001"
}
],
[
{
"account": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"type": 1,
"type_hex": "0000000000000001"
},
{
"currency": "USD",
"issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
"type": 48,
"type_hex": "0000000000000030"
},
{
"account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
"type": 1,
"type_hex": "0000000000000001"
}
],
[
{
"account": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"type": 1,
"type_hex": "0000000000000001"
},
{
"currency": "XRP",
"type": 16,
"type_hex": "0000000000000010"
},
{
"currency": "USD",
"issuer": "rwmUaXsWtXU4Z843xSYwgt1is97bgY8yj6",
"type": 48,
"type_hex": "0000000000000030"
},
{
"account": "rwmUaXsWtXU4Z843xSYwgt1is97bgY8yj6",
"type": 1,
"type_hex": "0000000000000001"
},
{
"account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
"type": 1,
"type_hex": "0000000000000001"
}
],
[
{
"account": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"type": 1,
"type_hex": "0000000000000001"
},
{
"currency": "XRP",
"type": 16,
"type_hex": "0000000000000010"
},
{
"currency": "USD",
"issuer": "rfsEoNBUBbvkf4jPcFe2u9CyaQagLVHGfP",
"type": 48,
"type_hex": "0000000000000030"
},
{
"account": "rfsEoNBUBbvkf4jPcFe2u9CyaQagLVHGfP",
"type": 1,
"type_hex": "0000000000000001"
},
{
"account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
"type": 1,
"type_hex": "0000000000000001"
}
]
],
"SendMax": {
"currency": "USD",
"issuer": "rBHMbioz9znTCqgjZ6Nx43uWY43kToEPa9",
"value": "4.132649022"
},
"Sequence": 4660,
"SigningPubKey": "03DFEFC9A95AEF55232A2B89867745CE45373F5CE23C34D51D21343CEA92BD61AD",
"TransactionType": "Payment",
"TxnSignature": "30450220636E405B96C998BF5EBB665D519FA8B4431A6CB5962F754EEDD48EBE95F8C45F02210097851E297FEDA44F7DFED844AE109CF2D968BD58CD3C0E951B435278A91002FA",
"hash": "5007E8ECAE64482D258E915FFDEFAF2FE35ED9520BA7BB424BE280691F997435",
"inLedger": 6907160,
"ledger_index": 6907160
},
{
"Account": "rfESTMcbvbvCBqU1FTvGWiJP8cmUSu4GKg",
"Amount": {
"currency": "BTC",
"issuer": "rTJdjjQ5wWAMh8TL1ToXXD2mZzesa6DSX",
"value": "0.0998"
},
"Destination": "r3AWbdp2jQLXLywJypdoNwVSvr81xs3uhn",
"Fee": "10",
"Flags": 2147483648,
"InvoiceID": "A98FD36C17BE2B8511AD36DC335478E7E89F06262949F36EB88E2D683BBCC50A",
"SendMax": {
"currency": "BTC",
"issuer": "rTJdjjQ5wWAMh8TL1ToXXD2mZzesa6DSX",
"value": "0.100798"
},
"Sequence": 18697,
"SigningPubKey": "025D9E40A50D78347EB8AFF7A36222BBE173CB9D06E68D109D189FF8616FC21107",
"TransactionType": "Payment",
"TxnSignature": "3044022007AA39E0117963ABF03BAEF0C5AB45862093525344362D34B9F6BA8373A0C9DC02206AB4FE915F4CBDA84E668F7F21A9914DC95C83A72FB3F9A114B10D4ECB697A25",
"hash": "C738A5095DCE3A256C843AA48BB26F0339EAD3FF09B6D75C2EF50C4AD4B4D17C",
"inLedger": 6907159,
"ledger_index": 6907159
},
{
"Account": "rHsZHqa5oMQNL5hFm4kfLd47aEMYjPstpg",
"Fee": "15",
"Flags": 0,
"Sequence": 1479726,
"SigningPubKey": "025718736160FA6632F48EA4354A35AB0340F8D7DC7083799B9C57C3E937D71851",
"TakerGets": "37284087",
"TakerPays": {
"currency": "NZD",
"issuer": "rsP3mgGb2tcYUrxiLFiHJiQXhsziegtwBc",
"value": "0.291570426"
},
"TransactionType": "OfferCreate",
"TxnSignature": "3045022100F246F043C97C0DA7947793E9390DBA5AB0C6EB4A0165DADF0E96C939B70D113C0220797F572368EF68490813663C0E2ACF03424CB73B64F3D6C8508C7E8F6D2CC767",
"hash": "CAE39A38C222DF0BBC9AA25D30320220DC216646CE0A447F330BE279B20BD008",
"inLedger": 6907159,
"ledger_index": 6907159
},
{
"Account": "rHsZHqa5oMQNL5hFm4kfLd47aEMYjPstpg",
"Fee": "15",
"Flags": 0,
"Sequence": 1479725,
"SigningPubKey": "025718736160FA6632F48EA4354A35AB0340F8D7DC7083799B9C57C3E937D71851",
"TakerGets": "10000000000",
"TakerPays": {
"currency": "BTC",
"issuer": "ra9eZxMbJrUcgV8ui7aPc161FgrqWScQxV",
"value": "0.091183099"
},
"TransactionType": "OfferCreate",
"TxnSignature": "30440220376E6D149435B87CA761ED1A9BD205BA93C0C30D6EB1FB26D8B5D06A55977F510220213E882DD43BC78C96B51E43273D9BD451F8337DDF6960CBFB9802A347FF18E4",
"hash": "CC07A503ED60F14AF023AB839C726B73591DE5C986D1234671E2518D8F840E12",
"inLedger": 6907159,
"ledger_index": 6907159
},
{
"Account": "rHsZHqa5oMQNL5hFm4kfLd47aEMYjPstpg",
"Fee": "15",
"Flags": 0,
"Sequence": 1479724,
"SigningPubKey": "025718736160FA6632F48EA4354A35AB0340F8D7DC7083799B9C57C3E937D71851",
"TakerGets": "9094329166",
"TakerPays": {
"currency": "XAG",
"issuer": "r9Dr5xwkeLegBeXq6ujinjSBLQzQ1zQGjH",
"value": "3.022830117"
},
"TransactionType": "OfferCreate",
"TxnSignature": "3045022100CFD63762B3809B37B6A1294C4B4C8DA39023D66893045BA4AA9767DD8570A8F9022005F42B08E94190637158E80DAE99F3FB104EC2AA30F69BBA3417E5BBCDB5DB77",
"hash": "64029D736C34D21CDB100D976A06A988E2CA6E3BBC0DDFCE840D9619B853B47C",
"inLedger": 6907159,
"ledger_index": 6907159
}
]
}
}
响应遵循标准格式,成功结果包含以下字段:
Field |
类型 | 描述 |
---|---|---|
index |
无符号整数 | start 请求中使用的值。 |
txs |
排列 | 事务对象数组。 |
根据交易类型,每个交易对象中包含的字段略有不同。详情请参阅交易格式。
invalidParams
- 一个或多个字段指定不正确,或缺少一个或多个必填字段。noPermission
- start
指定的字段大于10000,但您没有以管理员身份连接到服务器。[资源]
仅限WebSocket API!该path_find
方法搜索可能进行事务的路径,并在路径随时间变化时定期发送更新。有关JSON-RPC支持的更简单版本,请参阅ripple_path_find
。对于在XRP中严格执行的付款,没有必要找到路径,因为XRP可以直接发送到任何账户。
有三种不同的path_find命令的模式或子命令。用subcommand
参数指定你想要的一个:
create
- 开始发送寻路信息close
- 停止发送寻路信息status
- 获取当前打开的寻路请求的信息尽管rippled
服务器试图找到最便宜的路径或用于付款的路径组合,但不能保证此方法返回的路径实际上是最佳路径。由于服务器负载,寻路可能无法找到最佳结果。此外,您应该小心来自不受信任的服务器的寻路结果。服务器可以被修改为返回比最佳路径更少的运营商收入。如果您没有自己可以信任的服务器,那么您应该比较来自不同方运行的多个服务器的寻路结果,以最大限度地降低单个服务器返回不良结果的风险。(注意:返回低于最优结果的服务器不一定是恶意行为的证据; 它也可能是服务器负载过重的症状。)
[资源]
该create
子命令path_find
会创建一个持续请求,以查找可从一个指定帐户进行支付交易的可能路径,以便另一个帐户接收所需数量的某种货币。初始响应包含两个地址之间建议的路径,这会导致收到所需的数量。之后,服务器将发送附加消息"type": "path_find"
,并更新潜在路径。更新的频率取决于服务器的判断,但通常意味着当有新的分类账版本时,每隔几秒就会有一次更新。
客户端一次只能打开一个寻路请求。如果另一个寻路请求已经在同一连接上打开,则旧请求会自动关闭并替换为新请求。
请求格式的示例:
{
"id": 8,
"command": "path_find",
"subcommand": "create",
"source_account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"destination_account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"destination_amount": {
"value": "0.001",
"currency": "USD",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
}
}
尝试一下!
该请求包含以下参数:
Field |
类型 | 描述 |
---|---|---|
subcommand |
串 | 使用"create" 发送创建子 |
source_account |
串 | 从中找到路径的帐户的唯一地址。(换句话说,将发送付款的帐户。) |
destination_account |
串 | 帐户的唯一地址以查找路径。(换句话说,将收到付款的帐户。) |
destination_amount |
字符串或对象 | 目标帐户在交易中收到的货币金额。特殊情况: 您可以指定"-1" (对于XRP)或提供-1作为该value 字段的内容(对于非XRP货币)。 |