1.0.4 • Published 3 years ago

holops v1.0.4

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

Холоп API

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

NPM

Установка

npm npm i holops

Подключение

const {
    Holops
} = require('holops')
const hapi = new Holops('Token', 'user_id')

Методы API

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);

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

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

Пример:

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

    console.log(result); // {pay: true, sum: 12, date: unix, name: 'HYDRA WHEEL', photo: 'vk.com', iduser: 548313221} (Параметр pay означает отправили вы или вам: true - Вы, false - Вам)
}

run().catch(console.error);

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

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

Пример:

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

run().catch(console.error);

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

ПараметрТипОбязателенОписание
toIdnumberдаID пользователя, которому Вы собираетесь совершить перевод
amountnumberдаКоличество монет, которое Вы собираетесь перевести указанному пользователю
moneystringдаИндитификатор монеты/багосов
--------
Параметр (money)Описание
--------
moneyмонеты
money_newбагосы

Пример:

async function run() {
    const info = await hapi.sendPayment(1, 1, 'money');
    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', 2096);

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

run().catch(console.error);
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