xrpl.js

xrpl.js

Uma biblioteca JavaScript/TypeScript para interagir com o XRP Ledger

Esta é a biblioteca recomendada para integrar um aplicativo JavaScript/TypeScript com o XRP Ledger, especialmente se você pretende usar funcionalidades avançadas, como IOUs, caminhos de pagamento, troca descentralizada, configurações de conta, canais de pagamento, garantias, assinatura múltipla e muito mais .

➡️ Documentação de referência

Consulte a documentação de referência completa para todas as classes, métodos e utilitários.

Características

1. Gerenciando chaves e criando credenciais de teste ( Wallet && Client.fundWallet() )

2. Envio de transações para o razão XRP ( Client.submit(...) e tipos de transação)

3. Envio de solicitações para observar o razão ( Client.request(...) usando métodos de API pública)

4. Assinando alterações no razão (por exemplo, razão, transações e muito mais...)

5. Análise de dados contábeis em formatos mais convenientes ( xrpToDrops e rippleTimeToISOTime )

Tudo isso funciona em Node.js (testado para v18+) e navegadores da web (testado para Chrome).

Início rápido

Requisitos

• Node.js v18 é recomendado. Também oferecemos suporte à v20. Outras versões podem funcionar, mas não são testadas com frequência.

Instalando xrpl.js

Em um projeto existente (com package.json), instale xrpl.js com:

$ npm install --save xrpl

Ou com yarn :

$ yarn add xrpl

Exemplo de uso:

 const xrpl = require("xrpl");função assíncrona main() {
  cliente const = novo xrpl.Client("wss://s.altnet.rippletest.net:51233");
  aguarde client.connect();

  resposta const = aguardar client.request({command: "account_info",account: "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",ledger_index: "validado",
  });
  console.log(resposta);

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

Para um exemplo mais aprofundado, você pode copiar/bifurcar este modelo Code Sandbox!
https://codesandbox.io/s/xrpl-intro-pxgdjr?file=/src/App.js

Passa por:

1. Criando uma nova conta de teste

2. Enviando uma transação de pagamento

3. E enviando solicitações para ver o saldo da sua conta!

Etapas de configuração caso a caso

Se estiver usando xrpl.js com React ou Deno, você precisará executar algumas etapas extras para configurá-lo:

• Usando xrpl.js com um CDN

• Usando xrpl.js com create-react-app

• Usando xrpl.js com React Native

• Usando xrpl.js com Vite React

• Usando xrpl.js com Deno

Documentação

À medida que você desenvolve com xrpl.js, há dois sites que você usará extensivamente:

1. xrpl.org é a fonte principal para:

• Como funciona o razão (ver Conceitos)

• Que tipos de transações existem (Tipos de transação)

• Solicitações que você pode enviar (métodos de API pública)

• Tutoriais para interagir com vários recursos do razão (Tutoriais)

2. js.xrpl.org possui os documentos de referência para esta biblioteca

Listas de discussão

Se quiser saber quando lançarmos novas versões do xrpl.js, você pode ingressar em nossa lista de discussão de baixo tráfego (cerca de 1 e-mail por semana):

• Assine o xrpl-announce

Se estiver usando o XRP Ledger em produção, você deve executar um servidor rippled e assinar também a lista de discussão do servidor ripple.

• Inscreva-se no servidor ripple

Pedindo ajuda

Um dos melhores lugares para pedir ajuda é no XRPL Developer Discord - há um canal para xrpl.js onde outros membros da comunidade podem ajudá-lo a descobrir como atingir seus objetivos.

Você também pode criar um problema aqui e faremos o possível para responder dentro de três dias.

Links principais

• Documentos de referência do xrpl.js

• xrpl.org (documentos detalhados sobre como o XRPL funciona)

• Amostras de código XRPL

• #javascript no XRPL Developer Discord para perguntas e suporte

• xrpl-announce (A lista de discussão para novas versões do xrpl.js)

• Aplicativos que usam xrpl.js (você pode abrir um PR para adicionar seu projeto!)