rippledのパブリックメソッド

以下のパブリックAPIメソッドを使用して、XRP Ledgerサーバーと直接通信します。パブリックメソッドは必ずしも一般大衆向けに設計されたのではありませんが、サーバーに接続されたあらゆるクライアントが使用します。パブリックメソッドは、サーバーを運用している組織のメンバーまたは顧客向けのものと考えてください。

アカウントメソッド

XRP Ledgerのアカウントとは、XRPの保有者と取引の送信者を意味ます。以下のメソッドを使用して、アカウント情報を処理します。

  • account_channels - アカウントがチャンネルのソースであるペイメントチャネルのリストを取得します。
  • account_currencies - アカウントが送受信できる通貨のリストを取得します。
  • account_info - アカウントについての基本データを取得します。
  • account_lines - アカウントのトラストラインについての情報を取得します。
  • account_objects - アカウントが保有しているすべてのレジャーオブジェクトを取得します。
  • account_offers - アカウントの通貨取引オファーについての情報を取得します。
  • account_tx - アカウントのトランザクションについての情報を取得します。
  • gateway_balances - アカウントによって発行された総額を計算します。
  • noripple_check - アカウントのDefaultRippleおよびNoRipple設定への推奨される変更を取得します。

レジャーメソッド

レジャーバージョンには、ヘッダー、トランザクションツリー、状態ツリーが含まれ、さらにその中にアカウント設定、トラストライン、残高、トランザクション、その他のデータが含まれます。以下のメソッドを使用して、レジャー情報を取得します。

  • ledger - レジャーバージョンについての情報を取得します。
  • ledger_closed - 最新の閉鎖済みレジャーバージョンを取得します。
  • ledger_current - 現在処理中のレジャーバージョンを取得します。
  • ledger_data - レジャーバージョンの生データコンテンツを取得します。
  • ledger_entry - レジャーバージョンから1つのエレメントを取得します。

トランザクションメソッド

トランザクションだけが、XRP Ledgerの共有されている状態を変更できます。XRP Ledgerに対するすべてのビジネスはトランザクションの形態をとります。以下のメソッドを使用して、トランザクションを処理します。

  • sign - トランザクションに暗号で署名します。
  • sign_for - マルチ署名に署名を提供します。
  • submit - トランザクションをネットワークに送信します。
  • submit_multisigned - マルチ署名済みトランザクションをネットワークに送信します。
  • transaction_entry - レジャーの特定のバージョンからトランザクションについての情報を取得します。
  • tx - 手元にあるすべてのレジャーからトランザクションについての情報を取得します。
  • tx_history - 最新の全トランザクションについての情報を取得します。

パスおよびオーダーブックのメソッド

パスは、支払いが送信者から受信者に届くまでに中間ステップでたどる道筋を定義します。パスは、送信者と受信者をオーダーブックを介してつなぐことで、複数通貨間の支払いを可能にします。パスと他のオーダーブックに関しては、以下のメソッドを使用します。

  • book_offers - 2つの通貨を交換するオファーに関する情報を取得します。
  • deposit_authorized - あるアカウントが別のアカウントへの支払いの直接送信について承認されているかどうかを調べます。
  • path_find - 2つのアカウント間の支払いのパスを見つけて、更新を受け取ります。
  • ripple_path_find - 2つのアカウント間の支払いのパスを1回だけ見つけます。

Payment Channel メソッド

Payment Channel は、2名の当事者間での一方向の繰り返しの支払い、またはそれに伴う一時的な貸付を容易に行えるようにするためのツールです。Payment Channelに関しては、以下のメソッドを使用します。

  • channel_authorize - ペイメントチャネルへのクレーム(支払請求)に署名します。
  • channel_verify - payment channel クレームの署名をチェックします。

サブスクリプションメソッド

以下のメソッドにより、各種イベントの発生時にサーバーからクライアントに更新が通知されるように設定できます。これにより、イベントを即座に把握し、対処することができます。WebSocket APIのみ。

  • subscribe - 特定の対象について更新の通知を受けます。
  • unsubscribe - 特定の対象についての更新の通知を停止します。

サーバー情報メソッド

以下のメソッドを使用して、rippledサーバーの現在の状態についての情報を取得します。

  • fee - トランザクションコストについての情報を取得します。
  • server_info - サーバーのステータスを人間が読めるフォーマットで取得します。
  • server_state - サーバーのステータスを機械が読み取れるフォーマットで取得します。

ユーティリティメソッド

以下のメソッドを使用して、pingや乱数生成などの便利なタスクを実行します。

  • json - プロキシとして使用して、他のコマンドを実行します。コマンドのパラメーターをJSON値として受け入れます。コマンドラインのみ。
  • ping - サーバーとの接続を確認します。
  • random - 乱数を生成します。

廃止予定のメソッド

owner_infoコマンドは廃止される予定です。代わりにaccount_objectsを使用してください。