کیت‌های توسعه

کیت توسعه رسمی JavaScript نشانی‌های ورود و پیوندهای امضا را می‌سازد و API مربوط به Hivesigner را به‌جای شما صدا می‌زند. برای Python کتابخانه‌هایی از سوی جامعه هست. هر زبان دیگری می‌تواند مستقیم REST API را صدا بزند.

کیت توسعه JavaScript

این کیت همان بسته npm با نام hivesigner است. کد منبع آن در https://github.com/ecency/hivesigner-sdk است. با TypeScript نوشته شده و انواع خودش را همراه دارد.

نسخه ۴ به Node.js نسخه ۱۸ یا بالاتر نیاز دارد، چون از fetch درون‌ساخته استفاده می‌کند. در مرورگرها به ES2017 یا بالاتر نیاز دارد. جایی که fetch سراسری نباشد، پیش از به‌کارگیری کیت یک polyfill بیفزایید. روی Node.js قدیمی‌تر روی نسخه ۳ بمانید.

نصب

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

کیت برای مبادله جریان کد تابعی ندارد. سرور شما خودش کد و کلید محرمانه کلاینت را به API می‌فرستد، همان‌گونه که کد را مبادله کنید نشان می‌دهد.

کاربر را بگیرید

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

account حساب Hive کاربر است، همان‌گونه که زنجیره برمی‌گرداند. scope فهرست می‌کند که توکن چه چیزی را مجاز می‌کند.

انتشار

broadcast(operations) عملیات را به API می‌فرستد و 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() فراخوانی خروج در کیت است. توکن را به نقطه لغو در 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 بسنجید.