hcoinapi
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.5 • Public • Published

    Hydra API

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

    NPM

    Установка

    npm npm i hcoinapi

    Подключение

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

    Методы API

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

    Параметр Тип Обязателен Описание
    tx Number нет Количество переводов (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

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

    Пример:

    async function run() {
        const trans = await hapi.formatCoins(1000000.100);
    
        console.log(trans); // (1 000 000,1)
    }
    
    run().catch(console.error);

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

    Параметр Тип Обязателен Описание
    userId Number да 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 - Редактировать информацию о Вашем проекте

    Параметр Тип Обязателен Описание
    name string Да Название проекта
    avatar string Да Прямая ссылка на новый аватар проекта
    group_id number Да 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 - Совершить перевод монет указанному пользователю

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

    Пример:

    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

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

    Затем Вам нужно подписаться на входящие переводы, используя функцию 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);

    Keywords

    Install

    npm i hcoinapi

    DownloadsWeekly Downloads

    1

    Version

    1.0.5

    License

    ISC

    Unpacked Size

    12 kB

    Total Files

    4

    Last publish

    Collaborators

    • kytyukov