xrpl.js

xrpl.js

Библиотека JavaScript/TypeScript для взаимодействия с XRP Ledger.

Это рекомендуемая библиотека для интеграции приложения JavaScript/TypeScript с XRP Ledger, особенно если вы собираетесь использовать расширенные функции, такие как долговые расписки, пути оплаты, децентрализованный обмен, настройки учетной записи, каналы оплаты, условное депонирование, мультиподпись и многое другое. .

➡️ Справочная документация

См. полную справочную документацию по всем классам, методам и утилитам.

Функции

1. Управление ключами и создание тестовых учетных данных ( Wallet && Client.fundWallet() )

2. Отправка транзакций в реестр XRP ( Client.submit(...) и типы транзакций)

3. Отправка запросов на наблюдение за реестром ( Client.request(...) с использованием общедоступных методов API)

4. Подписка на изменения в реестре (например, реестр, транзакции и т. д.)

5. Разбор данных реестра в более удобные форматы ( xrpToDrops и rippleTimeToISOTime )

Все это работает в Node.js (проверено на версии 18+) и веб-браузерах (проверено на 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 = новый xrpl.Client("wss://s.altnet.rippletest.net:51233");
  ожидайте client.connect();

  const ответ = await client.request({команда: "account_info",account: "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",ledger_index: "проверено",
  });
  console.log(ответ);

  ожидайте client.disconnect();}main();

Для более подробного примера вы можете скопировать/развить этот шаблон Code Sandbox!
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 является основным источником:

• Как работает реестр (см. Концепции)

• Какие виды транзакций бывают (Типы транзакций)

• Запросы, которые вы можете отправлять (методы общедоступного API)

• Учебники по взаимодействию с различными функциями реестра (Tutorials)

2. js.xrpl.org содержит справочную документацию по этой библиотеке.

Списки рассылки

Если вы хотите узнать, когда мы выпустим новые версии xrpl.js, вы можете присоединиться к нашему списку рассылки с низким трафиком (около 1 письма в неделю):

• Подписаться на xrpl-announce

Если вы используете XRP Ledger в производстве, вам следует запустить сервер Ripple и подписаться на список рассылки Ripple-сервера.

• Подписаться на ripple-сервер

Прошу помощи

Одно из лучших мест, где можно обратиться за помощью, — это Discord для разработчиков XRPL. Там есть канал для xrpl.js, где другие члены сообщества могут помочь вам понять, как достичь ваших целей.

Вы также можете создать проблему здесь, и мы сделаем все возможное, чтобы ответить в течение 3 дней.

Ключевые ссылки

• Справочная документация по xrpl.js

• xrpl.org (подробная документация о том, как работает XRPL)

• Примеры кода XRPL

• #javascript в Discord для разработчиков XRPL для вопросов и поддержки

• xrpl-announce (список рассылки новых версий xrpl.js)

• Приложения, использующие xrpl.js (вы можете открыть PR, чтобы добавить свой проект!)