开发文档

account_channels

(需要启用PayChan amendment ) 该account_channels方法返回有关帐户的付款渠道的信息。这仅包括指定帐户是渠道来源的渠道,而不是目的地。(一个渠道的“来源”和“所有者”是相同的。)所有检索到的信息都与特定版本的分类账相关。 请求格式的示例:
{
  "id": 1,
  "command": "account_channels",
  "account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH",
  "destination_account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
  "ledger_index": "validated"
}
{
    "method": "account_channels",
    "params": [{
        "account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH",
        "destination_account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
        "ledger_index": "validated"
    }]
}
#Syntax: account_channels <account> [<destination_account>] [<ledger>]
rippled account_channels rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn validated
该请求包含以下参数:
领域 类型 描述
account String 账户的唯一标识符,通常是账户的地址。该请求返回此帐户是渠道所有者/来源的渠道。
destination_account String (可选)帐户的唯一标识符,通常是帐户的地址。如果提供,则将结果过滤到目标为此帐户的付款渠道。
ledger_hash String (可选)要使用的分类帐版本的20字节十六进制字符串。(请参阅指定分类帐)
ledger_index String or Unsigned Integer (可选)要使用的分类帐的序号或快捷字符串自动选择分类帐。(请参阅指定分类帐)
limit Integer (可选)限制要检索的事务数量。服务器不需要遵守这个值。必须在10到400的范围内,默认为200。
marker (Not Specified) (可选)来自之前分页响应的值。在该响应停止的情况下继续恢复数据。
一个成功回应的例子:
{
  "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
  }
}
200 OK

{
    "result": {
        "account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH",
        "channels": [{
            "account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH",
            "amount": "100000000",
            "balance": "0",
            "channel_id": "5DB01B7FFED6B67E6B0414DED11E051D2EE2B7619CE0EAA6286D67A3A4D5BDB3",
            "destination_account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
            "destination_tag": 20170428,
            "public_key": "aB44YfzW24VDEJQ2UuLPV2PvqcPCSoLnL7y5M1EzhdW4LnK5xMS3",
            "public_key_hex": "023693F15967AE357D0327974AD46FE3C127113B1110D6044FD41E723689F81CC6",
            "settle_delay": 86400
        }],
        "ledger_hash": "B9D3D80EDF4083A06B2D51202E0BFB63C46FC0985E015D06767C21A62853BF6D",
        "ledger_index": 37230600,
        "status": "success",
        "validated": true
    }
}
200 OK

{
    "result": {
        "account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH",
        "channels": [{
            "account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH",
            "amount": "100000000",
            "balance": "0",
            "channel_id": "5DB01B7FFED6B67E6B0414DED11E051D2EE2B7619CE0EAA6286D67A3A4D5BDB3",
            "destination_account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
            "destination_tag": 20170428,
            "public_key": "aB44YfzW24VDEJQ2UuLPV2PvqcPCSoLnL7y5M1EzhdW4LnK5xMS3",
            "public_key_hex": "023693F15967AE357D0327974AD46FE3C127113B1110D6044FD41E723689F81CC6",
            "settle_delay": 86400
        }],
        "ledger_hash": "B9D3D80EDF4083A06B2D51202E0BFB63C46FC0985E015D06767C21A62853BF6D",
        "ledger_index": 37230600,
        "status": "success",
        "validated": true
    }
}
响应遵循标准格式,成功结果包含以下字段:
领域 类型 描述
account String 付款渠道的来源/所有者的地址。这对应于account请求的字段。
channels Array of Channel Objects 此account拥有的付款渠道。
ledger_hash String 用于生成此响应的分类帐版本的标识哈希。
ledger_index Number 用于生成此响应的分类账版本的Ledger Index。
validated Boolean (可能会被忽略)如果true,这个答复中的信息来自一个经过验证的分类帐版本。否则,信息可能会更改。
limit Number (可能会被省略)限制这个请求实际返回了多少个通道对象。
marker (Not Specified) (可以省略)分页的服务器定义值。将此通话传递给下一个通话,以便在此通话结束后继续收到结果。在此之后没有附加页面时省略。
每个通道对象都有以下字段:
领域 类型 描述
account String 频道的所有者,作为地址。
amount String 分配给此频道的STM总量。
balance String 截至所使用的分类帐版本,从此渠道支付的STM总额。(可以通过从amount减去balance计算STM留在通道的量)。
channel_id String 此通道的唯一标识符,为64个字符的十六进制字符串。这也是分类账状态数据中通道对象的ID。
destination_account String 该渠道的目标帐户作为地址。只有此帐户可以在渠道打开时收到STM。
public_key String (可以省略)支付频道的公钥,为base58格式。对这个频道签署的声明必须使用匹配的密钥对进行兑换。
public_key_hex String (可省略)如果在创建渠道时指定了付款渠道的公钥,则为十六进制格式。对这个渠道签署的声明必须使用匹配的密钥对进行兑换。
settle_delay Unsigned Integer 在渠道所有者请求关闭渠道后,付款渠道必须保持打开的秒数。
expiration Unsigned Integer (可以省略)自Stream Epoch起,以秒为单位的时间,此通道设置为过期时间。此到期日期是可变的。如果这是最近一次验证分类账的关闭时间之前,则该渠道已过期。
cancel_after Unsigned Integer (可以省略)自Stream Epoch以来的秒数,如果在通道创建时指定了此通道的不可变过期时间(以秒为单位)。如果这是最近一次验证分类账的关闭时间之前,则该渠道已过期。
source_tag Unsigned Integer (可省略) 32位无符号整数,用作通过此支付渠道进行支付的源标签(如果在渠道创建时指定了该整数)。这表明付款渠道的发起人或其他用途在源帐户。通常,如果您退出此渠道的付款,则应在退货付款中指定DestinationTag值。
destination_tag Unsigned Integer (可省略)一个32位无符号整数,用作通过此通道进行支付的目的地标记(如果在通道创建时指定了该整数)。这表明付款渠道的受益人或目的地账户的其他用途。
可能的错误:
  • 任何通用错误类型。
  • invalidParams - 一个或多个字段指定不正确,或缺少一个或多个必填字段。
  • actNotFound- account请求字段中指定的地址不对应分类帐中的账户。
  • lgrNotFound- 由ledger_hash或者ledger_index不存在的分类账,或者确实存在,但服务器没有。
THE NEXT CONNECTION

下一次连接,从这里开始。

加入 Stream 社区,一起探索价值互联。

联系我们