1.0.1 • Published 3 years ago

node-cosmo-game-sdk v1.0.1

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

node-cosmo-game-sdk

API Cosmo Game для разработки ботов, приложений, сайтов.

npm package

Установка

Windows:

  • Скачайте и установите, желательно, последнюю версию Node.JS
  • Создайте в удобном месте папку, например cosmo_market
  • Перейдите в командную строку из этой папки: напишите cmd за место пути до папки Рис.1
  • В появившейся консоли пропишите: npm i --save node-cosmo-game-sdk Рис.2

Ubuntu:

  • Установите Node.JS по этому гайду
  • Создайте в удобном месте папку, например cosmo_market
  • Перейдите в папку: cd (путь до вашей папки)
  • Пропишите: npm i --save node-cosmo-game-sdk

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

Для начала использования, вам нужно создать в своей папке исполняемый файл, пусть это будет index.js

Теперь его нужно открыть и импортировать библиотеку:

const COSMOAPI = require('node-cosmo-game-sdk');
const cosmo = new COSMOAPI(options);
ОпцияТипОписание
optionsObjectОпции конструктора
options.keyStringКлюч для взаимодействия с API
options.userIdNumberВаш айди ВК

Где взять эти значения

  • Получение ключа (key): в настройках бота есть команда Получить API ключ
  • Получение айди вк (userId):

Откройте свою аватарку и в адресной строке вы увидите подобное: https://vk.com/id1?z=photo1_456264771%2Falbum1_0%2Frev

Вашим айди будет являться число после слова photo. В этом случае 1

API

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

const test = async () => {
    const result = await cosmo.methods.getTransfers(type, offset, limit, cb);
    console.log(result);
}
test();
ПараметрТипОписание
typeStringТип необходимых переводов, доступно: all - любые, in - пополнения, out - переводы
offsetNumberСмещение, необходимое для выборки определённого подмножества переводов
limitNumberКоличество переводов которое нужно получить, максимальное значение 100
cbFunctionФункция CallBack при ошибке

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

const test = () => {
    const result = await cosmo.methods.createTransfer(toId, amount, cb); // 1 коин = 1_000 ед.
    console.log(result);
}
test();
ПараметрТипОписание
toIdNumberАйди получателя
amountNumberСумма перевода
cbFunctionФункция CallBack при ошибке

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

const test = async() => {
    const myBalance = await cosmo.methods.getMyBalance(cb);
    console.log(myBalance);
}
test();
ПараметрТипОписание
cbFunctionФункция CallBack при ошибке

Ссылки