@kyuzan/annapurna-sdk-js

Annapurna NFT Platform Client SDK

Usage no npm install needed!

<script type="module">
  import kyuzanAnnapurnaSdkJs from 'https://cdn.skypack.dev/@kyuzan/annapurna-sdk-js';
</script>

README

@KyuzanInc/mint-sdk-js

Kyuzan Inc. MINT の SDK

Source Code

KyuzanInc/mint-sdk-js

Getting Started

Install

    % npm i @kyuzan/annapurna-sdk-js

API Documentation

docs

AccessToken と ProjectId の取得

Kyuzan に連絡

本番用、開発用単位でプロジェクトを生成して運用する想定。 現状は Kyuzan が用意する、

NFT のマスターデータ入稿

Kyuzan に連絡

About ETH

通常の NFT ショップなどは ETH は、ether という単位で取引される。（日本円でいうと円）

ETH にとって wei が最小単位である。（銭）

1ether === 1000000000000000000wei

ETH in SDK

SDK では基本的には、number型を用いて ether 単位で通貨を扱う。

一部、BigNumberクラスとして通貨を扱っている。wei をnumber型で扱うと、環境によってはオーバーフローを起こすため、BigNumberクラスを用いて表現しているためだ。

SDK では通貨のユーティリティーとして以下を提供している。

  • SDK.formatEther を用いると、BigNumberから ether 単位に変換したstringを取得できる
  • SDK.parseEtherを用いると、ether の文字列からweiを表現したBigNumberを取得できる

How to Get ETH for Rinkeby(Test Env)

テスト環境で使える ETH の入手方法は以下の通り

  1. ウォレットのアドレスをメモ
  2. https://faucet.rinkeby.io/ のサイトにアクセス
  3. Tweet リンクをクリック
  4. 0x0000.....部分を 1 でメモしたアドレスに置換する
  5. Tweet
  6. Tweet の URL をコピーしサイトの Input に貼り付ける
  7. Give me Ether ボタンを押す
  8. しばらくすると入金される

Developing SDK

  • - want: 同時入札による競り負けエラーは、sdk 側で判別できるように
  • CI: test
  • CI: npm publish(ドキュメント生成・test・semver)
  • SDK を用いた MINT ローカル開発手順
  • Backend との IF。OpenAPI を用いた、ドキュメント・型・クライアントの自動生成