SDK

Официальный SDK для JavaScript собирает адреса входа и ссылки подписи и вызывает API Hivesigner за вас. Для Python есть библиотеки сообщества. Любой другой язык может обращаться к REST API напрямую.

SDK для JavaScript

SDK — это пакет npm hivesigner. Его исходный код находится на https://github.com/ecency/hivesigner-sdk. Он написан на TypeScript и поставляется со своими типами.

Версии 4 нужен Node.js 18 или новее, потому что она использует встроенный fetch. В браузерах ей нужен ES2017 или новее. Там, где глобального fetch нет, добавьте полифил перед использованием SDK. На более старом Node.js оставайтесь на версии 3.

Установка

npm install hivesigner

Для страницы без шага сборки загрузите браузерную сборку. Она определяет глобальный hivesigner:

<script src="https://cdn.jsdelivr.net/npm/hivesigner@4/lib/hivesigner.min.js"></script>

Создайте клиент

import { Client } from 'hivesigner';

const client = new Client({
  app: 'CLIENT_ID',
  callbackURL: 'REDIRECT_URI',
  scope: ['posting'],
});

setApp, setCallbackURL, setScope, setAccessToken, removeAccessToken и setApiURL меняют клиент позже. Каждый из них возвращает клиент.

Выполните вход человека

getLoginURL(state, account) возвращает адрес входа:

const url = client.getLoginURL('STATE');
// https://hivesigner.com/oauth2/authorize?client_id=CLIENT_ID&redirect_uri=REDIRECT_URI&scope=posting&state=STATE

• state возвращается на ваш адрес возврата без изменений. Используйте его, чтобы связать ответ с запросом.
• account необязателен: это имя пользователя. Hivesigner выбирает этот аккаунт, если он есть на устройстве, и не учитывает его в противном случае.

В браузере client.login({ state: 'STATE' }) отправляет человека по тому же адресу, без аккаунта.

В потоке с токеном ваш адрес возврата получает access_token, expires_in и username. Передайте токен клиенту:

client.setAccessToken('ACCESS_TOKEN');

Метода для обмена в потоке с кодом в SDK нет. Ваш сервер сам отправляет код и секрет клиента в API, как показано в Обменяйте код.

Получите человека

const me = await client.me();
// { user, _id, name, account, scope, user_metadata }

account — это аккаунт Hive человека в том виде, в каком его возвращает сеть. scope перечисляет, что разрешает токен.

Отправка операций

broadcast(operations) отправляет операции в API, а тот отправляет их в сеть за человека. API принимает только постинг-операции, автором которых является человек из токена: vote, comment, delete_comment, comment_options, custom_json с постинг-полномочиями, claim_reward_balance и account_update2 для метаданных профиля. Смотрите Что принимает broadcast.

await client.broadcast([
  ['vote', { voter: 'USERNAME', author: 'AUTHOR', permlink: 'PERMLINK', weight: 10000 }],
]);

Называйте человека в каждой операции. API не подставляет __signer.

Эти вспомогательные методы собирают по одной операции и вызывают broadcast:

updateUserMetadata() устарел. Чтобы изменить профиль человека, отправьте account_update2 с новым posting_json_metadata.

Выход

revokeToken() — это вызов выхода в SDK. Он отправляет токен на адрес отзыва в API, а затем убирает его из клиента. Если вызов не удался, вызовите removeAccessToken() сами. Удалите токен и оттуда, где ваше приложение его сохранило.

Чтобы навсегда прекратить доступ вашего приложения, человек убирает его на https://hivesigner.com/authorized-apps. Смотрите Посмотреть и убрать доступ приложения.

Ссылки подписи

sendOperation(op, params), sendOperations(ops, params) и sendTransaction(tx, params) возвращают ссылку https://hivesigner.com/sign/.... params принимает callback, no_broadcast и signer. Смотрите Ссылки подписи.

import { sendOperation } from 'hivesigner';

const link = sendOperation(
  ['transfer', { from: '__signer', to: 'RECIPIENT', amount: '1.000 HIVE', memo: 'MEMO' }],
  { callback: 'https://YOUR_APP/paid' },
);

В TypeScript типы требуют третий аргумент: передайте undefined, чтобы получить ссылку.

В браузере передайте функцию третьим аргументом, чтобы открыть ссылку в новой вкладке. Эта функция не вызывается, и ничего не возвращается. Вызывайте её из обработчика щелчка, иначе браузер может заблокировать новую вкладку, и вызов выдаст ошибку.

Промисы и обратные вызовы

me, broadcast, вспомогательные методы и revokeToken возвращают промис. Передайте функцию последним аргументом, чтобы вместо этого использовать обратный вызов. Он получает (error, result).

// Promise
try {
  const result = await client.vote('USERNAME', 'AUTHOR', 'PERMLINK', 10000);
} catch (error) {
  console.error(error.error, error.error_description);
}

// Callback
client.vote('USERNAME', 'AUTHOR', 'PERMLINK', 10000, (error, result) => {
  if (error) console.error(error.error, error.error_description);
});

Когда API отвечает ошибкой, промис отклоняется с телом ошибки API, { error, error_description }. При обратном вызове это тело и будет аргументом error. Когда ответ не в формате JSON, отклонение несёт ошибку разбора.

Python

Эти библиотеки пришли от сообщества. Их сопровождают их авторы, а не команда Hivesigner. Сверьте их с REST API, прежде чем на них полагаться.