用于与 XRP Ledger 交互的 JavaScript/TypeScript 库
这是推荐的用于将 JavaScript/TypeScript 应用程序与 XRP Ledger 集成的库,特别是如果您打算使用 IOU、支付路径、去中心化交易、账户设置、支付渠道、托管、多重签名等高级功能。
请参阅所有类、方法和实用程序的完整参考文档。
管理密钥和创建测试凭证( Wallet
&& Client.fundWallet()
)
将交易提交到 XRP Ledger( Client.submit(...)
和交易类型)
发送请求以观察账本(使用公共 API 方法的Client.request(...)
)
订阅分类账中的更改(例如分类账、交易等……)
将账本数据解析为更方便的格式( xrpToDrops
和rippleTimeToISOTime
)
所有这些都适用于 Node.js(针对 v18+ 进行了测试)和 Web 浏览器(针对 Chrome 进行了测试)。
推荐使用Node.js v18 。我们还支持 v20。其他版本可能可以工作,但不经常进行测试。
在现有项目(带有 package.json)中,使用以下命令安装 xrpl.js:
$ npm install --save xrpl
或者用yarn
:
$ yarn add xrpl
用法示例:
const xrpl = require("xrpl"); 异步函数 main() { const client = new xrpl.Client("wss://s.altnet.rippletest.net:51233"); 等待客户端.connect(); const response = wait client.request({command: "account_info",account: "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",ledger_index: "已验证", }); 控制台.log(响应); 等待 client.disconnect();}main();
如需更深入的示例,您可以复制/分叉此代码沙盒模板!
https://codesandbox.io/s/xrpl-intro-pxgdjr?file=/src/App.js
它经过:
创建一个新的测试帐户
发送支付交易
并发送请求查看您的帐户余额!
如果您将 xrpl.js 与 React 或 Deno 结合使用,则需要执行几个额外的步骤来进行设置:
将 xrpl.js 与 CDN 结合使用
将 xrpl.js 与create-react-app
一起使用
将 xrpl.js 与React Native
结合使用
将 xrpl.js 与Vite React
结合使用
将 xrpl.js 与Deno
结合使用
当您使用 xrpl.js 进行开发时,您将广泛使用两个站点:
xrpl.org 是以下内容的主要来源:
分类账如何工作(参见概念)
有哪些类型的交易(Transaction Types)
您可以发送的请求(公共 API 方法)
与账本各种功能交互的教程(教程)
js.xrpl.org 有该库的参考文档
如果您想了解我们何时发布 xrpl.js 新版本,您可以加入我们的低流量邮件列表(每周大约 1 封电子邮件):
订阅 xrpl 公告
如果您在生产中使用 XRP Ledger,您应该运行rippled 服务器并订阅ripple-server 邮件列表。
订阅ripple-server
寻求帮助的最佳地点之一是 XRPL Developer Discord - 有一个 xrpl.js 频道,其他社区成员可以帮助您弄清楚如何实现您的目标。
也欢迎您在这里提出问题,我们将尽力在 3 天内回复。
xrpl.js 参考文档
xrpl.org(有关 XRPL 如何工作的详细文档)
XRPL 代码示例
#javascript 在 XRPL 开发者 Discord 中寻求问题和支持
xrpl-announce(新 xrpl.js 版本的邮件列表)
使用 xrpl.js 的应用程序(您可以打开 PR 来添加您的项目!)