Easy Client

Easy Clientは、クライアント側でリクエストに署名をし、トランザクションとして送信するためのツールです。 Axiosベースに作られているので、トランザクションに署名する機能のついたHTTPクライアントといえます。

インストール

Easy Clientはnpmで公開されています。npmコマンドまたはyarnコマンドを用いてインストールできます。

$ npm install @uniqys/easy-client
# or
$ yarn add @uniqys/easy-client
1
2
3

API

EasyClient

const easy = new EasyClient(signer, config)
1

引数

  • signer: 署名に必要なオブジェクト。詳細はeasy-clientパッケージのSignerを参照してください。
  • config: EasyClientで用いるAxiosRequestConfig。詳細はAxiosを参照してください。

EasyClient.<request type>

以下のリクエストに対応しています。

  • easy.request(config)
  • easy.get(url[, config])
  • easy.delete(url[, config])
  • easy.head(url[, config])
  • easy.options(url[, config])
  • easy.post(url[, data[, config]])
  • easy.put(url[, data[, config]])
  • easy.patch(url[, data[, config]])

引数

  • url: リクエストを送るURL。
  • data: リクエストに含めるデータ。
  • config: AxiosRequestConfig{ sign: <boolean> }という設定項目を追加したオブジェクト。sign = trueに設定すると、リクエストに署名をしてから送信します。

EasyClient.api

Outer APIに接続するためのメソッドを利用できます。

  • easy.api.account(address)
  • easy.api.nonce(address)
  • easy.api.balance(address)
  • easy.api.awaiting(id)

Outer APIの仕様に関しては、こちらを確認してください。

EasyClientForBrowser

EasyClientForBrowserは開発時に用いるEasyClientです。EasyClientを継承しています。 EasyClientForBrowserでは、トランザクションに署名をする際にアラートを発火させます。 アラートに対してAcceptすることで、リクエストに署名をしてから送信されます。

注意

@uniqys/easy-clientEasyClientForBrowserを用いる場合は、ユーザのウォレットキーをブラウザのlocalStorageに保存しているので、安全ではありません。プロダクションでの利用は非推奨です。 また、現在公式のウォレットはありませんが、独自でウォレットを開発する場合はEasyClientを用いて開発する必要があります。

const easy = new EasyClientForBrowser(baseUrl)
1

引数

  • baseUrl: アプリケーションのベースのURL。

EasyClientForWeb3

EasyClientForWeb3web3.jsと連携し、MetamaskやQuragéなどの既存のウォレットの利用を可能にしたEasyClientです。 EasyClientを継承しています。

const easy = new EasyClientForWeb3(web3.currentProvider, baseUrl)
1

引数

  • baseUrl: アプリケーションのベースのURL。

CDN経由での利用

easy.jsは、Easyというグローバルオブジェクトの中にEasyClientForBrowserEasyClientForWeb3のインスタンスをそれぞれBrowserWeb3 という名前で生成します。

<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/@uniqys/easy-client/lib/easy.js"></script>
<script type="text/javascript">
const easyBrowser = new Easy.Browser(location.origin) // EasyClientForBrowser
const easyWeb3 = new Easy.Web3(web3.currentProvider, location.origin) // EasyClientForWeb3
...
</script>
1
2
3
4
5
6
最終更新: 6/5/2019, 7:10:22 AM