Eine JavaScript/TypeScript-Bibliothek für die Interaktion mit dem XRP-Ledger
Dies ist die empfohlene Bibliothek für die Integration einer JavaScript-/TypeScript-App mit dem XRP-Ledger, insbesondere wenn Sie erweiterte Funktionen wie IOUs, Zahlungspfade, den dezentralen Austausch, Kontoeinstellungen, Zahlungskanäle, Treuhandkonten, Mehrfachsignaturen und mehr nutzen möchten .
Sehen Sie sich die vollständige Referenzdokumentation für alle Klassen, Methoden und Dienstprogramme an.
Schlüssel verwalten und Testanmeldeinformationen erstellen ( Wallet && Client.fundWallet() )
Übermittlung von Transaktionen an das XRP-Ledger ( Client.submit(...) & Transaktionstypen)
Senden von Anfragen zur Beobachtung des Ledgers ( Client.request(...) unter Verwendung öffentlicher API-Methoden)
Abonnieren von Änderungen im Hauptbuch (z. B. Hauptbuch, Transaktionen usw.)
Parsen von Ledger-Daten in praktischere Formate ( xrpToDrops und rippleTimeToISOTime )
All dies funktioniert in Node.js (getestet für v18+) und Webbrowsern (getestet für Chrome).
Node.js v18 wird empfohlen. Wir unterstützen auch v20. Andere Versionen funktionieren möglicherweise, werden jedoch nicht häufig getestet.
Installieren Sie in einem vorhandenen Projekt (mit package.json) xrpl.js mit:
$ npm install --save xrpl
Oder mit yarn :
$ yarn add xrpl
Beispielverwendung:
const xrpl = require("xrpl");async function main() {
const client = new xrpl.Client("wss://s.altnet.rippletest.net:51233");
Warten Sie auf client.connect();
const Response = waiting client.request({command: "account_info",account: "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",ledger_index: "validated",
});
console.log(response);
Warten Sie auf client.disconnect();}main(); Für ein ausführlicheres Beispiel können Sie diese Code-Sandbox-Vorlage kopieren/forken!
https://codesandbox.io/s/xrpl-intro-pxgdjr?file=/src/App.js
Es geht durch:
Erstellen eines neuen Testkontos
Senden einer Zahlungstransaktion
Und senden Sie Anfragen, um Ihren Kontostand einzusehen!
Wenn Sie xrpl.js mit React oder Deno verwenden, müssen Sie zum Einrichten ein paar zusätzliche Schritte ausführen:
Verwendung von xrpl.js mit einem CDN
Verwenden von xrpl.js mit create-react-app
Verwendung von xrpl.js mit React Native
Verwendung von xrpl.js mit Vite React
Verwendung von xrpl.js mit Deno
Während Sie mit xrpl.js entwickeln, gibt es zwei Websites, die Sie häufig nutzen werden:
xrpl.org ist die Hauptquelle für:
Wie das Hauptbuch funktioniert (siehe Konzepte)
Welche Arten von Transaktionen gibt es (Transaktionstypen)
Anfragen, die Sie senden können (öffentliche API-Methoden)
Tutorials zur Interaktion mit verschiedenen Funktionen des Ledgers (Tutorials)
js.xrpl.org verfügt über die Referenzdokumente für diese Bibliothek
Wenn Sie erfahren möchten, wann wir neue Versionen von xrpl.js veröffentlichen, können Sie sich unserer Mailingliste mit geringem Datenverkehr anschließen (ca. 1 E-Mail pro Woche):
Abonnieren Sie xrpl-announce
Wenn Sie das XRP-Ledger in der Produktion verwenden, sollten Sie einen Ripple-Server betreiben und sich auch für die Ripple-Server-Mailingliste anmelden.
Abonnieren Sie den Ripple-Server
Einer der besten Orte, um um Hilfe zu bitten, ist der XRPL Developer Discord. Dort gibt es einen Kanal für xrpl.js, in dem andere Community-Mitglieder Ihnen dabei helfen können, herauszufinden, wie Sie Ihre Ziele erreichen können.
Sie können hier auch gerne ein Problem erstellen und wir werden unser Bestes tun, um innerhalb von 3 Tagen zu antworten.
xrpl.js Referenzdokumente
xrpl.org (Detaillierte Dokumente zur Funktionsweise der XRPL)
XRPL-Codebeispiele
#javascript im XRPL Developer Discord für Fragen und Support
xrpl-announce (Die Mailingliste für neue xrpl.js-Versionen)
Anwendungen, die xrpl.js verwenden (Sie können eine PR öffnen, um Ihr Projekt hinzuzufügen!)
