1.2.1 • Published 3 years ago

rich-coin-sdk v1.2.1

Weekly downloads
-
License
ISC
Repository
-
Last release
3 years ago

rich-coin-sdk

Модуль для работы с API Rich Coin

Установка

  • Пропишите в командную строку: npm i rich-coin-sdk

Начало работы

Импортируем библиотеку:

const RichCoinInit = require('rich-coin-sdk');
const RichCoin = new RichCoinInit("key api", merchantId).API();

API

getHistory - Получает список переводов

async function run() {
    const result = await RichCoin.getHistory(lastTx);
    console.log(result);
}
run();
ПараметрТипОписание
lastTxNumberЧисло, количество последних переводов

sendPayment - Делает перевод другому пользователю (в десятичных долях)

async function run() {
    const result = await RichCoin.sendPayment(toId, amount, fromShop); // 1 коин = 1000 ед.
    console.log(result);
}
run();
ПараметрТипОписание
toIdNumberАйди получателя
amountNumberСумма перевода
fromShopBooleanЕсли true, то платеж отправится от имени магазина

getBalance - Получает баланс по айди пользователей

getMyBalance - Получает баланс текущего пользователя

async function run() {
    const balances = await RichCoin.getBalance([1, 100, 236908027]);
    const myBalance = await RichCoin.getMyBalance();
    console.log({ balances, myBalance });
}
run();

Среди этих методов аргумент принимает только getBalance:

ПараметрТипОписание
userIdsNumber|Number[]Массив айди пользователей

startPolling - Запускает обмен запросами между клиентом и сервером в режиме реального времени (WebSocket). Является лучшим и быстрым способом получения событий:

RichCoin.startPolling(callback);
/* Тут ваши действия со слушателем */
ПараметрТипОписание
callbackFunctionФункция обратного вызова, принимает в себя аргумент event

startFinding - Запускает ежесекундные запросы чтоб "поймать" новый перевод. Является лучшим способом проверки пополнений:

RichCoin.startFinding(callback, [202, 3994, 434, 344]);
/* Тут ваши действия со слушателем */
ПараметрТипОписание
callbackFunctionФункция обратного вызова, принимает в себя аргумент event
txnIdsNumber []Массив идентификаторов переводов.
1.2.1

3 years ago

1.2.0

3 years ago

1.1.9

3 years ago

1.1.8

3 years ago

1.1.7

3 years ago

1.1.6

3 years ago

1.1.5

3 years ago

1.1.4

3 years ago

1.1.3

3 years ago

1.1.2

3 years ago

1.1.1

3 years ago

1.0.1

3 years ago

1.0.0

3 years ago