SDK

Официалният JavaScript SDK съставя адреси за вход и връзки за подпис и извиква API на Hivesigner вместо вас. За Python съществуват библиотеки от общността. Всеки друг език може да извиква REST API директно.

JavaScript SDK

SDK е npm пакетът hivesigner. Изходният му код е на https://github.com/ecency/hivesigner-sdk. Написан е на TypeScript и носи своите типове.

Версия 4 изисква Node.js 18 или по-нов, защото използва вградения fetch. В браузъри изисква ES2017 или по-нов. Където няма глобален fetch, добавете polyfill, преди да използвате 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 приема само posting операции, чийто автор е потребителят на токена: vote, comment, delete_comment, comment_options, custom_json с posting правомощия, 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, преди да разчитате на тях.