xrpl.js

xrpl.js

Una biblioteca JavaScript/TypeScript para interactuar con XRP Ledger

Esta es la biblioteca recomendada para integrar una aplicación JavaScript/TypeScript con XRP Ledger, especialmente si tiene la intención de utilizar funciones avanzadas como pagarés, rutas de pago, intercambio descentralizado, configuración de cuenta, canales de pago, depósitos en garantía, firma múltiple y más. .

➡️ Documentación de referencia

Consulte la documentación de referencia completa para todas las clases, métodos y utilidades.

Características

1. Administrar claves y crear credenciales de prueba ( Wallet && Client.fundWallet() )

2. Envío de transacciones al XRP Ledger ( Client.submit(...) y tipos de transacciones)

3. Envío de solicitudes para observar el libro mayor ( Client.request(...) usando métodos API públicos)

4. Suscribirse a cambios en el libro mayor (por ejemplo, libro mayor, transacciones y más...)

5. Analizar los datos del libro mayor en formatos más convenientes ( xrpToDrops y rippleTimeToISOTime )

Todo lo cual funciona en Node.js (probado para v18+) y navegadores web (probado para Chrome).

Inicio rápido

Requisitos

• Se recomienda Node.js v18 . También admitimos v20. Es posible que otras versiones funcionen, pero no se prueban con frecuencia.

Instalación de xrpl.js

En un proyecto existente (con paquete.json), instale xrpl.js con:

$ npm install --save xrpl

O con yarn :

$ yarn add xrpl

Uso de ejemplo:

 const xrpl = require("xrpl");función asíncrona principal() {
  cliente const = new xrpl.Client("wss://s.altnet.rippletest.net:51233");
  espere cliente.connect();

  respuesta constante = await client.request({comando: "account_info", cuenta: "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",ledger_index: "validado",
  });
  console.log(respuesta);

  espere client.disconnect();}main();

Para ver un ejemplo más detallado, puedes copiar/bifurcar esta plantilla de Code Sandbox.
https://codesandbox.io/s/xrpl-intro-pxgdjr?file=/src/App.js

Pasa por:

1. Creando una nueva cuenta de prueba

2. Enviar una transacción de pago

3. ¡Y enviando solicitudes para ver el saldo de su cuenta!

Pasos de configuración caso por caso

Si está utilizando xrpl.js con React o Deno, deberá realizar un par de pasos adicionales para configurarlo:

• Usando xrpl.js con una CDN

• Usando xrpl.js con create-react-app

• Usando xrpl.js con React Native

• Usando xrpl.js con Vite React

• Usando xrpl.js con Deno

Documentación

A medida que desarrolla con xrpl.js, hay dos sitios que utilizará ampliamente:

1. xrpl.org es la fuente principal de:

• Cómo funciona el libro mayor (Ver Conceptos)

• Qué tipos de transacciones hay (Tipos de transacciones)

• Solicitudes que puede enviar (métodos API públicos)

• Tutoriales para interactuar con varias funciones del libro mayor (Tutoriales)

2. js.xrpl.org tiene los documentos de referencia para esta biblioteca

Listas de correo

Si desea saber cuándo lanzamos nuevas versiones de xrpl.js, puede unirse a nuestra lista de correo de poco tráfico (aproximadamente 1 correo electrónico por semana):

• Suscríbete a xrpl-announce

Si está utilizando XRP Ledger en producción, debe ejecutar un servidor ripple y suscribirse también a la lista de correo del servidor ripple.

• Suscríbete al servidor Ripple

pidiendo ayuda

Uno de los mejores lugares para pedir ayuda es XRPL Developer Discord: hay un canal para xrpl.js donde otros miembros de la comunidad pueden ayudarlo a descubrir cómo lograr sus objetivos.

También puedes crear un problema aquí y haremos todo lo posible para responder dentro de los 3 días.

Enlaces clave

• Documentos de referencia de xrpl.js

• xrpl.org (Documentos detallados sobre cómo funciona XRPL)

• Ejemplos de código XRPL

• #javascript en XRPL Developer Discord para preguntas y soporte

• xrpl-announce (la lista de correo para nuevas versiones de xrpl.js)

• Aplicaciones que usan xrpl.js (¡puedes abrir un PR para agregar tu proyecto!)