SDK

공식 JavaScript SDK는 로그인 URL과 서명 링크를 만들고 Hivesigner API를 대신 호출해 줍니다. Python에는 커뮤니티 라이브러리가 있습니다. 다른 언어에서는 REST API를 직접 호출하면 됩니다.

JavaScript SDK

SDK는 npm 패키지 hivesigner입니다. 소스는 https://github.com/ecency/hivesigner-sdk 에 있습니다. TypeScript로 쓰였고 타입 정의도 함께 들어 있습니다.

버전 4는 내장 fetch를 쓰므로 Node.js 18 이상이 필요합니다. 브라우저에서는 ES2017 이상이 필요합니다. 전역 fetch가 없는 환경에서는 SDK를 쓰기 전에 polyfill을 넣으세요. 더 오래된 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)은 로그인 URL을 돌려줍니다.

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' })는 계정을 지정하지 않고 같은 URL로 사용자를 보냅니다.

토큰 흐름에서는 콜백이 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가 사용자를 대신해 브로드캐스트합니다. 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()는 더 이상 쓰지 않습니다. 사용자의 프로필을 바꾸려면 새 posting_json_metadata와 함께 account_update2를 브로드캐스트하세요.

로그아웃

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와 맞춰 보세요.