Ripple（瑞波) JavaScript(node.js) 客户端接口库RippleAPI

介绍

RippleAPI是XRP Ledger的官方客户端库。目前，RippleAPI仅适用于JavaScript。使用RippleAPI，您可以：

• 从XRP分类帐历史中查询交易
• 无需连接任何服务器即可安全签署交易
• 将交易提交到XRP分类帐，包括付款，订单，设置更改和其他类型
• 生成新的XRP分类帐地址
• ... 等等。

RippleAPI只提供接入验证，一成不变的交易数据。

样板

使用以下样板代码使用RippleAPI封装您的自定义代码。

const RippleAPI = require('ripple-lib').RippleAPI;

const api = new RippleAPI({
  server: 'wss://s1.ripple.com' // Public rippled server hosted by Ripple, Inc.
});
api.on('error', (errorCode, errorMessage) => {
  console.log(errorCode + ': ' + errorMessage);
});
api.on('connected', () => {
  console.log('connected');
});
api.on('disconnected', (code) => {
  // code - [close code](https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent) sent by the server
  // will be 1000 if this was normal closure
  console.log('disconnected, code:', code);
});
api.connect().then(() => {
  /* insert code here */
}).then(() => {
  return api.disconnect();
}).catch(console.error);

RippleAPI被设计为在Node.js版本6.11.3中工作。如果您使用Babel进行ECMAScript 6支持，RippleAPI可以在较旧的Node.js版本上运行。

本文档中的代码示例使用ECMAScript 6（ES6）功能编写，但RippleAPI也适用于ECMAScript 5（ES5）。无论您使用ES5还是ES6，返回Promises的方法都会返回ES6样式的promise。

本文档中的所有代码片段假定您已经用这个样板包围了它们。如果您省略“catch”部分，则错误可能不可见。每当发生无法与特定请求关联的错误时，就会发出“错误”事件。如果侦听器未注册，则每当发生事件时都会抛出异常。

参数

RippleAPI构造函数可选地接受一个参数，一个具有以下选项的对象：

名称	类型	描述
授权	串	对格式为username：password的波纹服务器进行HTTP基本验证的可选用户名和密码。
证书	串	可选包含PEM格式客户端证书密钥的字符串。（可以是一系列证书）。
feeCushion	数	在提交交易时所需费用上升的情况下，通过增加估计费用的可选因子来提供缓冲。默认为1.2。
键	串	可选包含PEM格式客户端的私钥的字符串。（可以是一组键）。
密码	串	可选客户端私钥的密码。
代理	uri字符串	HTTP / HTTPS代理用于连接到波纹服务器的可选 URI。
proxyAuthorization	串	可选用户名和密码，以格式username：password的格式对代理进行HTTP基本身份验证。
服务器	uri字符串	用于连接到波纹websocket端口的可选 URI。必须以wss://或开头ws://。
时间到	整数	在考虑请求失败之前，以毫秒为单位的可选超时。
跟踪	布尔	可选如果为true，则记录波及的请求和对stdout的响应。
trustedCertificates	阵列\ <字符串>	可选的PEM格式SSL证书数组在连接到代理时可信任。如果您想在代理服务器上使用自签名证书，这很有用。注意：每个元素必须包含一个证书; 级联证书无效。

如果您省略server参数，RippleAPI将脱机运行。

安装

1. 安装Node.js和Yarn。大多数Linux发行版都有一个Node.js包; 检查它是你想要的版本。
2. 使用纱线来安装RippleAPI： yarn install ripple-lib

在安装ripple-lib之后，可以使用样板文件创建脚本并使用Node.js可执行文件运行它们，通常命名为node：

  `node script.js`

离线功能

RippleAPI还可以在没有互联网连接的情况下运行。这对于通过安全的隔离机器生成机密和签署交易非常有用。

要在离线模式下实例化RippleAPI，请使用以下样板代码：

const RippleAPI = require('ripple-lib').RippleAPI;

const api = new RippleAPI();
/* insert code here */

取决于XRP分类帐状态的方法在离线模式下不可用。为了准备交易离线，您必须指定fee，sequence以及maxLedgerVersion在参数交易指令。脱机时可以使用以下方法：

• preparePayment
• prepareTrustline
• prepareOrder
• prepareOrderCancellation
• prepareSettings
• prepareEscrowCreation
• prepareEscrowCancellation
• prepareEscrowExecution
• 标志
• generateAddress
• computeLedgerHash

基本类型

地址

"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59"

每个XRP分类帐帐户都有一个地址，该地址是该帐户公钥的散列的base58编码。XRP分类帐地址始终以小写字母开头r。

账户序列号

每个XRP分类帐帐户都有一个序号，用于保持交易顺序。每笔交易都必须有一个序列号。只有在发送它的账户中具有下一个序列号时才能执行交易。这可以防止一次事务执行两次，并且事务执行不按顺序执行。序列号从1账户开始的每个交易开始并递增。

货币

货币表示为3个字符的货币代码或40个字符的大写十六进制字符串。我们建议仅使用大写的ISO 4217货币代码。信任线上不允许使用字符串“XRP”，因为它是为XRP分类帐本币设置的。以下字符：所有大写字母和小写字母，数字，以及符号?，!，@，#，$，%，^，&，*，<，>，(，)，{，}，[，]，和|。

值

甲值是表示为一个十进制字符串的货币的量。注意：JavaScript的原生数字格式没有足够的精度来表示所有值。XRP与其他货币的精度不同。

XRP在小数点后有6位有效数字。换句话说，XRP不能被分成小于0.000001（1e-6）的正值。XRP的最大值为100000000000（1e11）。

非XRP值有16位精度的十进制数字，最大值为9999999999999999e80。最小的正非XRP值是1e-81。

量

示例量：

{
  "currency": "USD",
  "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM",
  "value": "100"
}

示例XRP数量：

{
  "currency": "XRP",
  "value": "2000"
}

的量是表示货币，对该货币的量，并在保持该值的trustline对方的数据结构。对于XRP，没有交易对手。

一个宽松的金额允许所有货币将被省略的对手。如果交易对手未在交易规格内指定金额，则任何交易对手均可用于该金额。

甲不严松弛量允许使用或将被省略的这两个交易对方和值。

甲平衡比可具有负值的量。

名称	类型	描述
货币	货币	用于表示货币的三字符代码或十六进制字符串
对手	地址	可选项欠款或欠款的帐户的波动地址（如果currency是“XRP”则省略）
值	值	可选货币数量，表示为保留浮点精度的字符串

交易概览

交易类型

事务类型由下表第一列中的字符串指定。

类型	描述
付款	甲payment交易代表的值从一个帐户转移到另一个。根据所采取的路径，可能会自动进行额外的价值交换，以方便付款。
订购	一个order交易创建了一个限价订单。它定义了交换货币的意图，并在XRP分类帐的订单簿中创建了一个订单，如果放置时未完全满足订单。订单可以部分实现。
orderCancellation	一个orderCancellation交易取消在XRP莱杰的订单一个订单。
trustline	一个trustline交易创建或修改两个账户之间的信任线。
设置	一个settings事务修改的XRP总帐帐户的设置。
escrowCreation	一个escrowCreation事务在分类账上创建一个托管，这个分支锁定XRP，直到满足一个加密条件或到期。这就像XRP Ledger充当托管代理的托管服务。
escrowCancellation	一个escrowCancellation交易解锁资金托管，并将其发送回代管的创造者，但托管期满后，它才有效。
escrowExecution	一个escrowExecution交易解锁资金托管，并将它们发送到中介的目的地，但如果提供的加密条件的用户才能使用。
checkCreate	一个checkCreate交易创建的分类帐，这是一种延期支付，可以通过其预定目标兑现的支票。
checkCancel	一个checkCancel交易取消的unreedemed检查，从台账不发送任何钱取出。
checkCash	一个checkCash交易兑换的支票最高可获得由相应的授权量checkCreate交易。只有destination支票的地址可以兑现。

交易流程

执行交易RippleAPI需要以下四个步骤：

1. 准备 - 根据规范和说明创建未签名的事务。有一种方法来准备每种类型的交易：
   • preparePayment
   • prepareTrustline
   • prepareOrder
   • prepareOrderCancellation
   • prepareSettings
   • prepareEscrowCreation
   • prepareEscrowCancellation
   • prepareEscrowExecution
   • prepareCheckCreate
   • prepareCheckCancel
   • prepareCheckCash
2. 签名 - 在本地对交易进行密码签名并保存交易ID。签名是账户所有者授权交易发生的方式。对于多重签名交易，必须收集signedTransaction返回的字段sign并将其传递给组合方法。
3. 提交 - 将交易提交到连接的服务器。
4. 验证 - 通过使用getTransaction查询验证事务是否已验证。这是必要的，因为即使交易成功提交，交易也可能失败。

交易费用

每笔交易都必须销毁少量的XRP作为发送交易的费用。这也被称为交易费用。交易成本被设计为随着XRP分类帐的负载而增加，这使得故意或无意中过载支持XRP分类帐的对等网络非常昂贵。

您可以选择想要支付的费用的大小或者使用默认值。您可以通过getFee方法得到关于下一个总帐所需费用的估算值。

交易说明

交易指令指示如何执行交易，与交易规范互补。

名称	类型	描述
费用	值	可选精确的费用为交易支付。请参阅交易费用了解更多信息。
maxFee	值	可选交易支付的最高费用。请参阅交易费用了解更多信息。
maxLedgerVersion	整数，空	可选事务可包含的最高分类帐版本。如果maxLedgerVersionOffset省略此选项，则该maxLedgerVersion选项将默认为比当前经验证的分类帐版本（等同于maxLedgerVersionOffset=3）大3。使用null不设置最高总账版本。
maxLedgerVersionOffset	整数	从当前经验证的分类帐版本到交易可包含的最高分类账版本的可选抵销。
序列	序列	可选该交易的初始帐户序号。
signersCount	整数	可选签署者的数目将签署此交易。

我们建议您指定一个，maxLedgerVersion以便您可以快速确定失败的事务将来永远不会成功。在XRP分类账的经过共识验证的分类帐版本超过交易记录后，交易不可能成功maxLedgerVersion。如果省略maxLedgerVersion，“准备”方法会自动提供一个maxLedgerVersion等于当前分类帐加3的值，它包含在“准备 ”方法的返回值中。

交易ID

"F4AB442A6D4CBB935D66E1DA7309A5FC71C7143ED4049053EC14E3875B0CF9BF"

事务ID是唯一标识事务的64位十六进制字符串。事务ID是使用强大的散列函数从事务指令和规范派生而来的。

您可以使用getTransaction方法通过ID查找事务。

交易记事

每个事务可以有选择地为用户应用程序提供一个备忘录数组。memos每个事务规范中的字段都是具有以下结构的对象数组：

名称	类型	描述
数据	串	可选任意字符串，通常包含备忘录的内容。
格式	串	可选通常包含有关备忘录如何编码的信息，例如作为MIME类型。只允许URL中允许使用的字符。
类型	串	可选通常，定义此备忘录格式的唯一关系（根据RFC 5988）。只允许URL中允许使用的字符。

交易规格

一交易规范指定事务应该做的事情。每种交易类型都有其自己的规格类型。

付款

有关说明，请参阅交易类型。

名称	类型	描述
资源	目的	资金的来源将被发送。
资源。地址	地址	要发送的地址。
资源。量	laxAmount	确切的金额发送。如果未指定交易对手，则可以使用任何交易对手的金额。（这个字段是独立于source.maxAmount的）
资源。标签	整数	可选任意无符号的32位整数，用于标识付款原因或非Ripple帐户。
资源。maxAmount	laxAmount	最大发送金额。（这个字段是独立于source.amount的）
目的地	目的	要发送的资金的目的地。
目的地。地址	地址	要收到的地址。
目的地。量	laxAmount	确切数额交付给收件人。如果未指定交易对手，则可以使用任何交易对手的金额。（该字段与destination.minAmount独占）。
目的地。标签	整数	可选任意无符号的32位整数，用于标识付款原因或非Ripple帐户。
目的地。地址	地址	要发送到的地址。
目的地。MINAMOUNT	laxAmount	最低交付金额。（这个字段是唯一的destination.amount）
allowPartialPayment	布尔	可选如果为真，即使由于流动性缺乏或源帐户资金不足而导致无法交付全部金额，也应继续执行此付款。
invoiceID	串	可选可以用来识别特定付款的256位散列。
limitQuality	布尔	可选仅在所有转换的输入：输出比率等于或优于destination.amount：source.maxAmount的比率时采用路径。
备忘录	备忘录	可选的备忘录数组附加到事务。
noDirectRipple	布尔	可选如果指定了true和路径，发件人希望XRP分类帐忽略从源帐户到目标帐户的任何直接路径。这可以用来利用套利机会或者希望从热钱包向错误地将信任线直接设置到热钱包的用户发布余额的网关。
路径	串	可选用于执行付款的信任线和订单的路径。

例

{
  "source": {
    "address": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
    "maxAmount": {
      "value": "0.01",
      "currency": "USD",
      "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM"
    }
  },
  "destination": {
    "address": "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo",
    "amount": {
      "value": "0.01",
      "currency": "USD",
      "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM"
    }
  }
}

Trustline

有关说明，请参阅交易类型。

名称	类型	描述
货币	货币	此信任线适用的货币。
对手	地址	此信任线将信任扩展到的帐户的地址。
限制	值	信任线的所有者可通过信任线承担的最大金额。
合法	布尔	可选如果为true，则授权交易对手从该账户持有发行。
冻结的	布尔	可选如果为true，则信任线会被冻结，这意味着资金只能发送给所有者。
备忘录	备忘录	可选的备忘录数组附加到事务。
qualityIn	数	此信任线上的可选收款余额按此比率计价。
qualityOut	数	此信任线上的可选余额按此比率估值。
ripplingDisabled	布尔	可选如果属实，付款不能通过此信任线涟漪。

例

{
  "currency": "USD",
  "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM",
  "limit": "10000",
  "qualityIn": 0.91,
  "qualityOut": 0.87,
  "ripplingDisabled": true,
  "frozen": false,
  "memos": [
    {
      "type": "test",
      "format": "plain/text",
      "data": "texted data"
    }
  ]
}

订购

有关说明，请参阅交易类型。

名称	类型	描述
方向	串	等于购买订单的“买入”和卖出订单的“卖出”。
数量	量	买或卖的货币数量。
totalPrice	量	quantity要购买或出售的总价格。
expirationTime	日期时间字符串	作为ISO 8601日期时间之后，此优惠不再有效的可选时间。
fillOrKill	布尔	可选将报价视为填写或填写订单。只尝试匹配分类帐中的现有优惠，并且只有在可以交换全部数量的情况下才这样做。
immediateOrCancel	布尔	可选将该报价视为立即订单或取消订单。如果启用，报价将永远不会成为分类账节点：它只会尝试匹配分类帐中的现有报价。
备忘录	备忘录	可选的备忘录数组附加到事务。
orderToReplace	序列	可选在创建新订单之前取消的订单的科目序号，有效替换旧订单。
被动	布尔	可选如果启用，报价不会使用与其完全匹配的报价，而是成为分类帐中的报价节点。它仍然会使用跨越它的优惠。

例

{
  "direction": "buy",
  "quantity": {
    "currency": "USD",
    "counterparty": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM",
    "value": "10.1"
  },
  "totalPrice": {
    "currency": "XRP",
    "value": "2"
  },
  "passive": true,
  "fillOrKill": true
}

订单取消

有关说明，请参阅交易类型。

名称	类型	描述
orderSequence	序列	要取消的订单的科目序号。
备忘录	备忘录	可选的备忘录数组附加到事务。

例

{
  "orderSequence": 23
}

设置

有关说明，请参阅交易类型。

名称	类型	描述
defaultRipple	布尔	可选默认情况下，启用此帐户的信任线上的荡漾。（新波纹0.27.3）
depositAuth	布尔	此帐户可选启用存款授权。如果设置，则交易无法将任何类型的价值发送到此帐户，除非这些交易的发件人是帐户本身。（需要DepositAuth修正）
disableMasterKey	布尔	可选不允许使用主密钥为此帐户签署交易。
disallowIncomingXRP	布尔	可选指示客户端应用程序不应将XRP发送到此帐户。不是由波纹执行。
域	串	可选 拥有此帐户的域，以十六进制字符串表示以小写字母表示的域的ASCII。
emailHash	串，空	用于生成化身图像的电子邮件地址的可选哈希。通常，客户使用Gravatar来显示该图像。使用null清除。
enableTransactionIDTracking	布尔	可选跟踪此帐户最近一次交易的ID。
globalFreeze	布尔	可选冻结由此帐户发布的所有资产。
备忘录	备忘录	可选的备忘录数组附加到事务。
messageKey	串	可选公钥，用于将加密邮件发送到此帐户。通常，它应该是一个secp256k1密钥，与Ripple其余部分使用的加密相同。
noFreeze	布尔	可选永久放弃冻结个人信任额度的能力。启用后，此标志永远不会被禁用。
passwordSpent	布尔	可选指示帐户已使用其免费的SetRegularKey事务。
regularKey	地址，null	可选新密钥对的公钥，用作此帐户的常规密钥，作为与帐户地址相同格式的基本58编码字符串。使用null去除正规钥匙。
requireAuthorization	布尔	可选如果设置，此帐户必须单独批准其他用户，以便这些用户持有此帐户的发行。
requireDestinationTag	布尔	可选需要传入付款才能指定目的地代码。
签名者	目的	可选设置，用于确定可使用多个帐户代表该帐户使用哪些帐户组签署交易。
签名者。阈	整数	可选目标号码的签名者权重。只有提供的签名的总和权重等于或大于此值时，此列表中的多重签名才有效。要删除签名者设置，请使用该值0。
签名者。权重	排列	每个签名者的可选签名权重。
签名者。权重[]	目的	地址和体重的关联。
signers.weights []。地址	地址	一个Ripple帐户地址
signers.weights []。重量	整数	这个账户的签名算作门槛权重。
TRANSFERRATE	数，空	可选 用户转移此账户的发行时收取的费用，作为发送1个单位必须发送的十进制金额。精确度最高可达9位数，超过小数点。使用null设置不收取任何费用。

例

{
  "domain": "ripple.com",
  "memos": [
    {
      "type": "test",
      "format": "plain/text",
      "data": "texted data"
    }
  ]
}

托管创建

有关说明，请参阅交易类型。

名称	类型	描述
量	值	发件人托管的XRP金额。
目的地	地址	地址以接收托管的XRP。
allowCancelAfter	日期时间字符串	可选如果存在，此次托管可能会在此时间后取消。
allowExecuteAfter	日期时间字符串	可选如果存在，在此时间之前不能执行托管。
条件	串	可选一个表示PREIMAGE-SHA-256密码条件的十六进制值。如果存在，fulfillment在执行时需要。
destinationTag	整数	可选的目标标记。
备忘录	备忘录	可选的备忘录数组附加到事务。
sourceTag	整数	可选的源标签。

例

{
  "destination": "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo",
  "amount": "0.01",
  "allowExecuteAfter": "2014-09-24T21:21:50.000Z",
  "allowCancelAfter":  "2017-01-01T00:00:00.000Z"
}

托管取消

有关说明，请参阅交易类型。

名称	类型	描述
所有者	地址	要取消的托管所有者的地址。
escrowSequence	序列	托管创建交易的账户序列号，用于取消托管。
备忘录	备忘录	可选的备忘录数组附加到事务。

例

{
  "owner": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
  "escrowSequence": 1234
}

托管执行

有关说明，请参阅交易类型。

名称	类型	描述
所有者	地址	要执行的托管所有者的地址。
escrowSequence	序列	托管执行的托管创建交易的科目顺序号。
条件	串	可选一个表示PREIMAGE-SHA-256密码条件的十六进制值。这必须与condition托管创建交易中的原件相匹配。
履行	串	可选用于表示PREIMAGE-SHA-256密码条件满足的十六进制值condition。
备忘录	备忘录	可选的备忘录数组附加到事务。

例

{
  "owner": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
  "escrowSequence": 1234,
  "condition": "A0258020E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855810100",
  "fulfillment": "A0028000"
}

选中创建

有关说明，请参阅交易类型。

名称	类型	描述
目的地	地址	可以兑现支票的账户地址。
sendMax	laxAmount	允许支票支付发件人的源货币金额，包括非XRP货币的转账费用。
destinationTag	整数	可选的目的地标记，标识检查的原因或托管收件人付款。
呼气	日期时间字符串	可选时间过后，支票不再有效。
invoiceID	串	可选的 256位散列，作为64个字符的十六进制字符串，表示此检查的具体原因或标识符。

例

{
  "destination": "rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW",
  "sendMax": {
    "currency": "XRP",
    "value": "1"
  }
}

检查取消

有关说明，请参阅交易类型。

名称	类型	描述
checkID	串	作为一个64个字符的十六进制字符串取消检查分类帐对象的ID。

例

{
  "checkID": "49647F0D748DC3FE26BDACBC57F251AADEFFF391403EC9BF87C97F67E9977FB0"
}

检查现金

有关说明，请参阅交易类型。

名称	类型	描述
checkID	串	将支票分类帐对象的ID设置为现金，作为64个字符的十六进制字符串。
量	laxAmount	可选兑换检查确切金额，如果可能的话。货币必须与相应的CheckCreate交易的sendMax相匹配。您必须提供此字段或deliverMin。
deliverMin	laxAmount	可选兑换检查至少这个数量和尽可能多。货币必须与相应的CheckCreate交易的sendMax相匹配。您必须提供此字段或金额。

例

{
  "amount": {
    "currency": "XRP",
    "value": "1"
  },
  "checkID": "838766BA2B995C00744175F69A1B11E32C3DBC40E64801A4056FCBD657F57334"
}

付款渠道创建

有关说明，请参阅交易类型。

名称	类型	描述
量	值	发送者在此频道留出的XRP数量。
目的地	地址	收到XRP针对此频道的声明地址。
settleDelay	数	如果源地址具有未声明的XRP，则在关闭通道之前必须等待的秒数。
公钥	串	该来源将用于签署针对此频道的版权声明的密钥对的公钥。
cancelAfter	日期时间字符串	此频道到期的可选时间。
destinationTag	整数	可选的目标标记。
sourceTag	整数	可选的源标签。

例

{
  "amount": "1",
  "destination": "rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW",
  "settleDelay": 86400,
  "publicKey": "32D2471DB72B27E3310F355BB33E339BF26F8392D5A93D3BC0FC3B566612DA0F0A"
}

支付渠道基金

有关说明，请参阅交易类型。

名称	类型	描述
量	值	XRP用于为频道提供资金的数量。
渠道	串	256位十六进制通道标识符。
呼气	日期时间字符串	可选此通道的新到期日期。

例

{
  "channel": "C1AE6DDDEEC05CF2978C0BAD6FE302948E9533691DC749DCDD3B9E5992CA6198",
  "amount": "1"
}

付款频道索赔

有关说明，请参阅交易类型。

名称	类型	描述
渠道	串	256位十六进制通道标识符。
量	值	处理索赔后，此通道的可选 XRP余额。
平衡	值	通过签名授权的可选 XRP数量。
关	布尔	可选请求关闭频道。
公钥	串	频道发件人的可选公钥
更新	布尔	可选清除频道的到期时间。
签名	串	此索赔的可选签名。

例

{
  "channel": "C1AE6DDDEEC05CF2978C0BAD6FE302948E9533691DC749DCDD3B9E5992CA6198"
}

API方法

连

connect(): Promise

告诉RippleAPI实例连接到它的波纹服务器。

参数

此方法没有参数。

返回值

此方法返回一个承诺，当连接建立时用void值解析。

例

有关代码示例，请参阅Boilerplate。

断开

disconnect(): Promise

告诉RippleAPI实例从其波动的服务器断开连接。

参数

此方法没有参数。

返回值

该方法返回一个承诺，当连接被销毁时用一个空值解析。

例

有关代码示例，请参阅Boilerplate

已连接

isConnected(): boolean

检查RippleAPI实例是否连接到其波动的服务器。

参数

此方法没有参数。

返回值

true如果连接并且false未连接，则此方法返回。

例

return api.isConnected();

true

getServerInfo

getServerInfo(): Promise