【RippleAPI】① 準備

RippleAPI (ripple-lib) でどんなことができるのか、実際にAPIを使って学んでいきましょう。
まずはAPIを使用するための環境を準備する手順解説します。
本手順は2018年12月25日時点のものですが、将来的に変更される可能性もございますのでご注意お願いします。

1. Node.jsのインストール

RippleAPIはJavaScriptで書かれているライブラリです。
JavaScriptは元々Web Browser上で動作するスクリプト言語にすぎませんでしたが、Node.jsの登場によってPCアプリケーションやWebサーバなど様々な環境で動作する汎用的なプログラミング言語へと進化しました。
RippleAPIもNode.js上で動作しますので、開発・動作させるコンピュータにインストールしておく必要があります。

2. プロジェクトの作成

Node.jsのインストールが終わったら、適当なフォルダーを用意して、そのフォルダー上でNode.jsのnpmコマンドを実行します。

npm init -y

コマンドの実行が成功すると、フォルダー内にpackage.jsonというファイルが作成されています。

3. RippleAPIパッケージのインストール

続いて、以下のnpmコマンドを実行します。

npm install ripple-lib

パッケージのインストールに成功すると、package.jsonのdependencies項目にripple-libが追加されます。

4. サンプルプログラム

それでは最初のプログラムを作成して、実行してみましょう。

test.js

const RippleAPI = require('ripple-lib').RippleAPI;
const api = new RippleAPI({
  server: 'wss://s1.ripple.com'
});

(async()=>{
  try {
    await api.connect();

    const myAddress = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59';
    let info = await api.getAccountInfo(myAddress);
    console.log(info);
    await api.disconnect();

  } catch (e) {
    console.error(e);
  }
})();

※myAddressは、RippleAPIサイトで例示されたサンプルアドレスです。

実行手順

以下のコマンドを実行します。

node test.js

実行結果

実行結果の例を以下に示します。

{ sequence: 1406,
  xrpBalance: '13314.753787',
  ownerCount: 17,
  previousAffectingTransactionID:
   '5A18ACA848D7786E2AC27A2FFB54483F2B6367B4375A4AE00D6DCC60B668D0BD',
  previousAffectingTransactionLedgerVersion: 42135765 }

※実行結果は上記とは異なる場合があります。

参考情報

RippleAPI Reference - XRP Ledger Dev Portal