Une bibliothèque JavaScript/TypeScript pour interagir avec le XRP Ledger
Il s'agit de la bibliothèque recommandée pour intégrer une application JavaScript/TypeScript avec XRP Ledger, en particulier si vous avez l'intention d'utiliser des fonctionnalités avancées telles que les reconnaissances de dette, les modes de paiement, l'échange décentralisé, les paramètres de compte, les canaux de paiement, les dépôts, la signature multiple, etc. .
Consultez la documentation de référence complète pour toutes les classes, méthodes et utilitaires.
Gestion des clés et création d'identifiants de test ( Wallet
&& Client.fundWallet()
)
Soumission de transactions au XRP Ledger ( Client.submit(...)
et types de transactions)
Envoi de requêtes pour observer le grand livre ( Client.request(...)
à l'aide de méthodes API publiques)
S'abonner aux modifications du grand livre (Ex. grand livre, transactions, etc.)
Analyser les données du grand livre dans des formats plus pratiques ( xrpToDrops
et rippleTimeToISOTime
)
Tout cela fonctionne dans Node.js (testé pour v18+) et dans les navigateurs Web (testé pour Chrome).
Node.js v18 est recommandé. Nous prenons également en charge la v20. D'autres versions peuvent fonctionner mais ne sont pas fréquemment testées.
Dans un projet existant (avec package.json), installez xrpl.js avec :
$ npm install --save xrpl
Ou avec yarn
:
$ yarn add xrpl
Exemple d'utilisation :
const xrpl = require("xrpl");fonction async main() { const client = new xrpl.Client("wss://s.altnet.rippletest.net:51233"); attendre client.connect(); const réponse = wait client.request({commande : "account_info",compte : "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",ledger_index : "validé", }); console.log(réponse); wait client.disconnect();}main();
Pour un exemple plus approfondi, vous pouvez copier/ducker ce modèle Code Sandbox !
https://codesandbox.io/s/xrpl-intro-pxgdjr?file=/src/App.js
Cela passe par :
Création d'un nouveau compte de test
Envoi d'une opération de paiement
Et envoyer des demandes pour voir le solde de votre compte !
Si vous utilisez xrpl.js avec React ou Deno, vous devrez suivre quelques étapes supplémentaires pour le configurer :
Utiliser xrpl.js avec un CDN
Utiliser xrpl.js avec create-react-app
Utiliser xrpl.js avec React Native
Utiliser xrpl.js avec Vite React
Utiliser xrpl.js avec Deno
Au fur et à mesure que vous développez avec xrpl.js, vous utiliserez largement deux sites :
xrpl.org est la principale source pour :
Comment fonctionne le grand livre (Voir Concepts)
Quels types de transactions existe-t-il (types de transactions)
Requêtes que vous pouvez envoyer (méthodes API publiques)
Tutoriels pour interagir avec diverses fonctionnalités du grand livre (Tutoriels)
js.xrpl.org a les documents de référence pour cette bibliothèque
Si vous souhaitez être informé de la date de sortie des nouvelles versions de xrpl.js, vous pouvez rejoindre notre liste de diffusion à faible trafic (environ 1 e-mail par semaine) :
Abonnez-vous à xrpl-announce
Si vous utilisez XRP Ledger en production, vous devez exécuter un serveur Ripple et vous abonner également à la liste de diffusion du serveur Ripple.
Abonnez-vous au serveur Ripple
L'un des meilleurs endroits pour demander de l'aide est le XRPL Developer Discord. Il existe un canal pour xrpl.js où d'autres membres de la communauté peuvent vous aider à comprendre comment atteindre vos objectifs.
Vous êtes également invités à créer un problème ici et nous ferons de notre mieux pour répondre dans les 3 jours.
Documents de référence xrpl.js
xrpl.org (Documents détaillés sur le fonctionnement du XRPL)
Exemples de codes XRPL
#javascript dans le XRPL Developer Discord pour les questions et l'assistance
xrpl-announce (La liste de diffusion des nouvelles versions de xrpl.js)
Applications qui utilisent xrpl.js (Vous pouvez ouvrir un PR pour ajouter votre projet !)