ledger

[ソース]

公開レジャーに関する情報を取得します。

要求フォーマット

要求フォーマットの例:

{
   "id":14,
   "command":"ledger",
   "ledger_index":"validated",
   "full": false,
   "accounts": false,
   "transactions": false,
   "expand": false,
   "owner_funds": false
}
{
   "method":"ledger",
   "params":[
       {
           "ledger_index":"validated",
           "accounts": false,
           "full": false,
           "transactions": false,
           "expand": false,
           "owner_funds": false
       }
   ]
}
#Syntax: ledger ledger_index|ledger_hash [full|tx]
# "full" is equivalent to "full": true
# "tx" is equivalent to "transactions": true
rippled ledger current

試してみる

要求には以下のパラメーターを含めることができます。

Field 説明
ledger_hash 文字列 (省略可) 使用するレジャーバージョンの20バイトの16進文字列。(レジャーの指定を参照してください)
ledger_index 文字列または符号なし整数 (省略可) 使用するレジャーのシーケンス番号、またはレジャーを自動的に選択するためのショートカット文字列。(レジャーの指定を参照してください)
full ブール値 (省略可) 管理者が必要。 trueの場合、レジャー全体に関するすべての情報が返されます。レジャーバージョンを指定しない場合は無視されます。デフォルトではfalseです。(これはtransactionsaccounts、およびexpandを有効にする操作と同等です。) 注意: 数百メガバイトのオーダーについて、非常に大量のデータが返されます。
accounts ブール値 (省略可) 管理者が必要。 trueの場合、レジャーのアカウントに関する情報が返されます。レジャーバージョンを指定しない場合は無視されます。デフォルトではfalseです。注意: 非常に大量のデータが返されます。
transactions ブール値 (省略可) trueの場合、指定されたレジャーバージョンのトランザクションに関する情報が返されます。デフォルトではfalseです。レジャーバージョンを指定しない場合は無視されます。
expand ブール値 (省略可) ハッシュのみではなく、トランザクション/アカウントの完全な情報がJSONフォーマットで提供されます。デフォルトではfalseです。トランザクション、アカウント、またはその両方を要求しない場合は無視されます。
owner_funds ブール値 (省略可) trueの場合、応答のOfferCreateトランザクションのメタデータにowner_fundsフィールドが含まれます。デフォルトではfalseです。トランザクションが含まれておらず、expandがtrueではない場合には無視されます。
binary ブール値 (省略可) trueで、かつtransactionsexpandが両方ともtrueの場合、JSONフォーマットではなくバイナリフォーマット(16進文字列)でトランザクション情報が返されます。新規: rippled 0.28.0
queue ブール値 (省略可) trueで、かつコマンドがcurrentレジャーを要求している場合、キューに入れらているトランザクションの配列が結果に含まれます。

ledgerフィールドは廃止予定であり、今後予告なしに削除される可能性があります。

応答フォーマット

処理が成功した応答の例:

{
 "id":4,
 "status":"success",
 "type":"response",
 "result":{
   "ledger":{
     "accepted": true,
     "account_hash":"FD2709F6C07284C3EE85EDE32AC452D9013A89D9B9E781D67D9784457E86A9BB",
     "close_flags":0,
     "close_time":508541181,
     "close_time_human":"2016-Feb-11 21:26:21",
     "close_time_resolution":10,
     "closed": true,
     "hash":"F1433E9D15F33E746B8820DEEE4879F48181704364E459332561DF8E52E4EB7E",
     "ledger_hash":"F1433E9D15F33E746B8820DEEE4879F48181704364E459332561DF8E52E4EB7E",
     "ledger_index":"18851530",
     "parent_close_time":508541180,
     "parent_hash":"8300B70AA5A865961DED7DAC5B88047028762D5946ECA887D09D32DE442E2305",
     "seqNum":"18851530",
     "totalCoins":"99998102799411646",
     "total_coins":"99998102799411646",
     "transaction_hash":"E0DB0471A1D198611E1C050ADA4AE74EEB38CEC26E0550663E0FCB1364212A3B"
   },
   "ledger_hash":"F1433E9D15F33E746B8820DEEE4879F48181704364E459332561DF8E52E4EB7E",
   "ledger_index":18851530,
   "validated": true
 }
}
200 OK
{
   "result":{
       "ledger":{
           "accepted": true,
           "account_hash":"B089E7CD4F5167249951611AAEC863D4BF84FF098500E9CB50561F1A89EED825",
           "close_flags":0,
           "close_time":508541222,
           "close_time_human":"2016-Feb-11 21:27:02",
           "close_time_resolution":10,
           "closed": true,
           "hash":"85E6D422F1A3AE0BEA315C4F09CD0B45022312A4BBF0D308246E901536B61157",
           "ledger_hash":"85E6D422F1A3AE0BEA315C4F09CD0B45022312A4BBF0D308246E901536B61157",
           "ledger_index":"18851543",
           "parent_close_time":508541221,
           "parent_hash":"C382DB117F2D5AAECFBFB43EA509F8E56D6E1D1297CE00C0D02A3EE695ABB78F",
           "seqNum":"18851543",
           "totalCoins":"99998102795090646",
           "total_coins":"99998102795090646",
           "transaction_hash":"BEC71A3CAD11BFC4E4013CD109F220E0850E9A3808B15FAA6DAE4D898970EFAF"
       },
       "ledger_hash":"85E6D422F1A3AE0BEA315C4F09CD0B45022312A4BBF0D308246E901536B61157",
       "ledger_index":18851543,
       "status":"success",
       "validated": true
   }
}

応答は標準フォーマットに従っており、正常に完了した場合は結果にレジャーに関する情報を表す次のフィールドが含まれています。

Field 説明
ledger オブジェクト このレジャーの完全なヘッダーデータ。
ledger.account_hash 文字列 このレジャーのすべてのアカウント状態情報のハッシュ(16進数)
ledger.accountState 配列 (要求されていない場合は省略)このレジャーのすべてのアカウント状態情報
ledger.close_flags 整数 このレジャーの閉鎖に関連するフラグのビットマップ。現在、レジャーでは1つのフラグだけがclose_flagsとして定義されています(sLCF_NoConsensusTime(値1))。このフラグが有効な場合、レジャーの正確な閉鎖時刻についてバリデータの間で意見が対立しましたが、作成しているレジャーは同一のものであるため、バリデータは閉鎖時刻について「合意をしないことに合意する」とした上でコンセンサスを宣言しました。この場合、コンセンサスレジャーのclose_timeの値は直前のバージョンの閉鎖時刻の1秒後です。(この場合、正式な閉鎖時刻がありませんが、実際の閉鎖時刻はおそらく指定されているclose_timeの3~6秒後です。)
ledger.close_time 整数 レジャーが閉鎖された時刻(Rippleエポック以降の経過秒数
ledger.close_time_human 文字列 人間が読めるフォーマットでのこのレジャーが閉鎖された時刻
ledger.close_time_resolution 整数 レジャー閉鎖時刻はこの秒数の範囲内で丸めらます。
ledger.closed ブール値 このレジャーが閉鎖されているかどうか。
ledger.ledger_hash 文字列 レジャー全体の一意の識別用ハッシュ。
ledger.ledger_index 文字列 このレジャーのレジャーインデックス。整数を引用符で囲んだ形式で示されます。
ledger.parent_close_time 整数 前のレジャーが閉鎖された時刻。
ledger.parent_hash 文字列 このレジャーの直前のレジャーの一意の識別用ハッシュ。
ledger.total_coins 文字列 ネットワークのXRPの合計(drop数)。整数を引用符で囲んだ形式で示されます。(トランザクションコストによりXRPが消却されると、この値は減少します。)
ledger.transaction_hash 文字列 このレジャーに記録されているトランザクション情報のハッシュ(16進数)
ledger.transactions 配列 (要求されていない場合は省略)このレジャーバージョンで適用されたトランザクション。デフォルトでは、メンバーはトランザクションの識別用ハッシュ文字列です。要求でexpandがtrueとして指定されている場合は、メンバーはJSONフォーマットまたはバイナリフォーマットでのトランザクションの完全な表現です。フォーマットは、要求でbinaryがtrueとして指定されていたかどうかに応じて決まります。
ledger_hash 文字列 レジャー全体の一意の識別用ハッシュ。
ledger_index 数値 このレジャーのレジャーインデックス
queue_data 配列 queueパラメーターで要求されている場合を除いて省略)キューに入れられたトランザクションをキューと同じ順序で記述するオブジェクトの配列。要求でexpandがtrueに指定されている場合は、メンバーにはJSONフォーマットまたはバイナリフォーマットでのトランザクションの完全な表現が含まれています。フォーマットは、要求でbinaryがtrueとして指定されていたかどうかによって決まります。FeeEscalation Amendmentが必要です。新規: rippled 0.70.0

以下のフィールドは廃止予定であり、今後予告なしに削除される可能性があります。acceptedhash(代わりにledger_hashを使用)、seqNum(代わりにledger_indexを使用)、totalCoins(代わりにtotal_coinsを使用)。

queue_data配列の各メンバーは、キュー内の1つのトランザクションを表します。このオブジェクトの一部フィールドは、まだ計算されていないために省略されることがあります。このオブジェクトのフィールドを次に示します。

フィールド 説明
account 文字列 このキューに入れられたトランザクションの送信者のアドレス
tx 文字列またはオブジェクト デフォルトでは、これはトランザクションの識別用ハッシュを含む文字列です。トランザクションがバイナリフォーマットで展開されている場合、これはtx_blobが唯一のフィールドであるオブジェクトであり、バイナリー形式のトランザクションが10進文字列として含まれています。トランザクションがJSONフォーマットで展開されている場合、これはhashフィールドにトランザクションの識別用ハッシュが指定されているトランザクションオブジェクトを含むオブジェクトです。
retries_remaining 数値 このトランザクションの再試行可能回数。この回数を超えるとトランザクションが除外されます。
preflight_result 文字列 初期トランザクションチェックの一時的な結果。これは常にtesSUCCESSです。
last_result 文字列 (省略される場合があります)再試行可能な (ter) の結果を取得した後でこのトランザクションがキューに残っている場合、これは取得した正確なter結果コードです。
auth_change ブール値 (省略される場合があります) このトランザクションがこのアドレスのトランザクション承認方法を変更するかどうかを示します。
fee 文字列 (省略される場合があります) このトランザクションのトランザクションコストXRPのdrop数)。
fee_level 文字列 (省略される場合があります) このタイプのトランザクションの最少コストと比較した、このトランザクションのトランザクションコスト(手数料レベル)。
max_spend_drops 文字列 (省略される場合があります) このトランザクションで送信または消却できるXRP、drop単位の最高額。

要求に"owner_funds": trueが指定されておりトランザクションが展開されている場合、応答には、各OfferCreateトランザクションmetaDataオブジェクトのowner_fundsフィールドが含まれています。このフィールドの目的は、新しい検証済みレジャーごとにオファーの資金化ステータスを容易に追跡できるようにすることです。このフィールドの定義は、オーダーブックサブスクリプションストリームでのこのフィールドのバージョンとはわずかに異なります。

Field 説明
owner_funds 文字列 このレジャーのすべてのトランザクションの実行後に、このOfferCreateトランザクションを送信するAccountが保有するTakerGets通貨の額。この通貨額が凍結されているかどうかはチェックされません。

考えられるエラー

  • 汎用エラータイプのすべて。
  • invalidParams - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。
  • lgrNotFound - ledger_hashまたはledger_indexで指定したレジャーが存在しないか、存在してはいるもののサーバーが保有していません。
  • noPermission - fullまたはaccountsをtrueとして指定したが、管理者としてサーバーに接続していない場合(通常、管理者はローカルポートで接続する必要があります)。