xrpl.js

xrpl.js

用於與 XRP Ledger 互動的 JavaScript/TypeScript 函式庫

這是建議的用於將 JavaScript/TypeScript 應用程式與 XRP Ledger 整合的程式庫，特別是如果您打算使用 IOU、支付路徑、去中心化交易、帳戶設定、支付管道、託管、多重簽名等高級功能。

➡️參考文檔

請參閱所有類別、方法和實用程式的完整參考文件。

特徵

1. 管理金鑰和建立測試憑證（ Wallet && Client.fundWallet() ）

2. 將交易提交至 XRP Ledger（ Client.submit(...)和交易類型）

3. 發送請求以觀察帳本（使用公共 API 方法的Client.request(...) ）

4. 訂閱分類帳中的變更（例如分類帳、交易等…）

5. 將帳本資料解析為更方便的格式（ xrpToDrops和rippleTimeToISOTime ）

所有這些都適用於 Node.js（針對 v18+ 進行了測試）和 Web 瀏覽器（針對 Chrome 進行了測試）。

快速入門

要求

• 推薦使用Node.js v18 。我們還支援 v20。其他版本可能可以工作，但不經常進行測試。

安裝 xrpl.js

在現有專案（帶有 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

它經過：

1. 建立一個新的測試帳戶

2. 發送支付交易

3. 並發送請求查看您的帳戶餘額！

個案設定步驟

如果您將 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 進行開發時，您將廣泛使用兩個網站：

1. xrpl.org 是以下內容的主要來源：

• 分類帳如何運作（參見概念）

• 有哪些類型的交易（Transaction Types）

• 您可以發送的請求（公共 API 方法）

• 與帳本各種功能互動的教學（教程）

2. 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 來新增您的專案！）