1.0.5 • Published 3 years ago

hcoinapi v1.0.5

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

Hydra API

NodeJS библиотека для работы с API сервиса "Hydra Coin"

NPM

Установка

npm npm i hcoinapi

Подключение

const {
    HydraApi
} = require('hcoinapi')
const hapi = new HydraApi('Token', user_id)

Методы API

getTransactionList - Получает список ваших транзакций

ПараметрТипОбязателенОписание
txNumberнетКоличество переводов (0 - все переводы)

Пример:

async function run() {
    const result = await hapi.getTransactionList(0);

    console.log(result);
}

run().catch(console.error);

formatCoins - Делает получаемое из API значение коинов читабельным. Например, приходит значение 1000000,100. Этот метод сделает значение таким: 1 000 000,1

ПараметрТипОбязателенОписание
coinsNumberдаВходящее значение коинов

Пример:

async function run() {
    const trans = await hapi.formatCoins(1000000.100);

    console.log(trans); // (1 000 000,1)
}

run().catch(console.error);

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

ПараметрТипОбязателенОписание
userIdNumberдаID пользователя, чей баланс нужно вернуть

Пример:

async function run() {
    const info = await hapi.getBalance(1);
    console.log(info);
};

run().catch(console.error);

getProjectInfo - Получить информацию о Вашем проекте

Пример:

async function run() {
    const info = await hapi.getProjectInfo()
    console.log(info)
}
run().catch(console.error);

editProjectInfo - Редактировать информацию о Вашем проекте

ПараметрТипОбязателенОписание
namestringДаНазвание проекта
avatarstringДаПрямая ссылка на новый аватар проекта
group_idnumberДаID группы проекта
  • Все параметры должны быть переданы

Пример:

async function run() {
    const info = await hapi.editProjectInfo(
        'My app',
        'vk.com/images/camera_200.png',
        1
    );
    console.log(info)
};

run().catch(console.error);

sendPayment - Совершить перевод монет указанному пользователю

ПараметрТипОбязателенОписание
toIdnumberдаID пользователя, которому Вы собираетесь совершить перевод
amountnumberдаКоличество монет, которое Вы собираетесь перевести указанному пользователю

Пример:

async function run() {
    const info = await hapi.sendPayment(1, 1);
    console.log(info);
};

run().catch(console.error);

getPaymentLink - Получить ссылку на перевод монет проекту

Пример:

async function run() {
    const info = await hapi.getPaymentLink();
    console.log(info);
};

run().catch(console.error);

Прослушивание входящих переводов:

Наша библиотека автоматически сверяет hash входящих переводов, защищая Вас от злоумышленников.

Для начала Вам стоит вызвать функцию start

ПараметрТипОбязателенОписание
pathstring\numberдаВаш IP адрес или домен
portnumberнетПрослушиваемый порт

Затем Вам нужно подписаться на входящие переводы, используя функцию onPayment, в параметры который нужно передать callback функцию.

Пример:

function run() {
    hapi.start('http://82.112.51.71', 80);

    hapi.onPayment(context => {
        const {
            amount,
            fromId
        } = context;
        console.log(context);
    });
};

run().catch(console.error);
1.0.5

3 years ago

1.0.4

3 years ago

1.0.3

3 years ago

1.0.2

3 years ago

1.0.1

3 years ago

1.0.0

3 years ago