submit
submitメソッドはトランザクションを適用し、トランザクションの確認と将来のレジャーへの記録が行われるように、ネットワークに送信します。
このコマンドには、以下の2つのモードがあります。
- 送信専用モードは、署名済みのシリアル化されたトランザクションをBlobとして取得し、そのままネットワークに送信します。署名済みのトランザクションオブジェクトは不変のものであるため、送信後は、どの部分も修正したり、自動的に内容を入力したりすることはできません。
- 署名と送信モードでは、JSONフォーマットのトランザクションオブジェクトを取得し、signメソッドと同じ方法でトランザクションを完成させて署名し、署名済みのトランザクションを送信します。テストと開発に関しては、このモードのみ使用することをお勧めします。
トランザクションを可能な限り確実に送信するには、トランザクションを事前に生成してsignメソッドで署名し、停電発生後もアクセスできるいずれかの場所に保存した後、tx_blobとしてsubmitメソッドで送信します。送信後は、ネットワークをtxメソッドコマンドで監視して、トランザクションが正常に適用されたかどうかを確認します。再起動やその他の問題が発生した場合ても、tx_blobのトランザクションを問題なく再送信できます。シーケンス番号が以前のトランザクションと同一であるため、トランザクションが2回適用されることはありません。
送信専用モード
送信専用のリクエストでは、以下のパラメーターを指定します。
Field | 型 | 説明 |
|---|---|---|
tx_blob | 文字列 | 送信する署名済みトランザクションの16進表現。マルチシグトランザクションを送信することもできます。 |
fail_hard | ブール値 | （省略可。デフォルトはfalse）trueにした場合は、トランザクションがローカルで失敗したときに再試行されず、他のサーバにも中継されません。 |
リクエストのフォーマット
{
"id": 3,
"command": "submit",
"tx_blob": "1200002280000000240000001E61D4838D7EA4C6800000000000000000000000000055534400000000004B4E9C06F24296074F7BC48F92A97916C6DC5EA968400000000000000B732103AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB7447304502210095D23D8AF107DF50651F266259CC7139D0CD0C64ABBA3A958156352A0D95A21E02207FCF9B77D7510380E49FF250C21B57169E14E9B4ACFD314CEDC79DDD0A38B8A681144B4E9C06F24296074F7BC48F92A97916C6DC5EA983143E9D4A2B8AA0780F682D136F7A56D6724EF53754"
}署名と送信モード
このモードでは、トランザクションに署名してただちに送信します。このモードは、テストで使用することを目的としています。マルチシグトランザクションには使用できません。
デフォルトでは、署名と送信モードは管理者専用です。 サーバでパブリック署名が有効になっている場合は、パブリックメソッドとして使用できます。
トランザクションの署名に使用するシークレットキーは、以下の方法で提供できます。
secret値を指定し、key_typeフィールドを省略します。この値は、XRP Ledgerのbase58シード、RFC-1751、16進値のフォーマットで記述するか、文字列パスフレーズとして記述します（secp256k1キーのみ）。key_type値と、seed、seed_hex、またはpassphraseのいずれか1つを提供します。secretフィールドは省略します（コマンドライン構文ではサポートされません）。
リクエストには以下のパラメーターが含まれます。
Field | 型 | 説明 |
|---|---|---|
tx_json | オブジェクト | JSONフォーマットのトランザクション定義。自動入力可能なフィールドについては、省略することも可能です。 |
secret | 文字列 | （省略可） トランザクションを提供するアカウントのシークレットキー。トランザクションへの署名に使用されます。信頼できないサーバに対して、またはセキュリティが確保されていないネットワーク接続を通じて機密情報を送信しないでください。key_type、seed、seed_hex、passphraseと同時に使用することはできません。 |
seed | 文字列 | （省略可） トランザクションを提供するアカウントのシークレットキー。トランザクションへの署名に使用されます。XRP Ledgerのbase58フォーマットにする必要があります。指定する場合は、key_typeも指定する必要があります。secret、seed_hex、passphraseと同時に使用することはできません。 |
seed_hex | 文字列 | （省略可） トランザクションを提供するアカウントのシークレットキー。トランザクションへの署名に使用されます。16進フォーマットにする必要があります。指定する場合は、key_typeも指定する必要があります。secret、seed、passphraseと同時に使用することはできません。 |
passphrase | 文字列 | （省略可） トランザクションを提供するアカウントのシークレットキー。文字列パスフレーズとして、トランザクションへの署名に使用されます。指定する場合は、key_typeも指定する必要があります。secret、seed、seed_hexと同時に使用することはできません。 |
key_type | 文字列 | （省略可） このリクエストで提供する暗号鍵の種類。有効な種類は、secp256k1またはed25519です。デフォルトはsecp256k1です。secretと同時に使用することはできません。注意: Ed25519のサポートは実験的な機能です。 |
fail_hard | ブール値 | （省略可。デフォルトはfalse）trueにした場合は、トランザクションがローカルで失敗したときに再試行されず、他のサーバにも中継されません。 |
offline | ブール値 | （省略可。デフォルトはfalse）trueにする場合は、トランザクションの生成時に、値を自動で入力または検証しようとしないでください。 |
build_path | ブール値 | （省略可） Payment型のトランザクションに対して指定した場合、署名前にPathsフィールドが自動で入力されます。トランザクションがXRP間の直接移動である場合は、このフィールドを省略してください。注意: サーバは、このフィールドの値ではなく、このフィールドが存在するかどうかを調べます。この動作は変更される可能性があります。 |
fee_mult_max | 整数 | （省略可。デフォルトは10、推奨値は1000）Feeパラメーターを省略する場合は、自動的に提供されるFee値が長期の基本トランザクションコストとこの値の積以下になるよう、このフィールドで制限します。 |
fee_div_max | 整数 | （省略可。デフォルトは1）fee_mult_maxと併用して、制限に使用される分数の乗数を作成します。具体的には、サーバは基本トランザクションコストをfee_mult_maxで乗算した後、この値で除算して上限値（整数値に丸められます）を割り出します。自動的に提供されるFee値が上限値を超えている場合、submitコマンドは失敗します。 |
サーバによって特定のフィールドにどのように値が自動入力されるかについては、signメソッドをご覧ください。
リクエストのフォーマット
リクエストのフォーマットの例:
{
"id": 2,
"api_version": 2,
"command": "submit",
"tx_json" : {
"TransactionType" : "Payment",
"Account" : "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"Destination" : "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
"DeliverMax" : {
"currency" : "USD",
"value" : "1",
"issuer" : "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn"
}
},
"secret" : "s████████████████████████████",
"offline": false,
"fee_mult_max": 1000
}レスポンスのフォーマット
処理が成功したレスポンスの例:
{
"id": 1,
"api_version": 2,
"status": "success",
"type": "response",
"result": {
"accepted" : true,
"account_sequence_available" : 362,
"account_sequence_next" : 362,
"applied" : true,
"broadcast" : true,
"engine_result": "tesSUCCESS",
"engine_result_code": 0,
"engine_result_message": "The transaction was applied. Only final in a validated ledger.",
"kept" : true,
"open_ledger_cost": "10",
"queued" : false,
"tx_blob": "1200002280000000240000016861D4838D7EA4C6800000000000000000000000000055534400000000004B4E9C06F24296074F7BC48F92A97916C6DC5EA9684000000000002710732103AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB7446304402200E5C2DD81FDF0BE9AB2A8D797885ED49E804DBF28E806604D878756410CA98B102203349581946B0DDA06B36B35DBC20EDA27552C1F167BCF5C6ECFF49C6A46F858081144B4E9C06F24296074F7BC48F92A97916C6DC5EA983143E9D4A2B8AA0780F682D136F7A56D6724EF53754",
"tx_json": {
"Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"DeliverMax": {
"currency": "USD",
"issuer": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"value": "1"
},
"Destination": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
"Fee": "10000",
"Flags": 2147483648,
"Sequence": 360,
"SigningPubKey": "03AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB",
"TransactionType": "Payment",
"TxnSignature": "304402200E5C2DD81FDF0BE9AB2A8D797885ED49E804DBF28E806604D878756410CA98B102203349581946B0DDA06B36B35DBC20EDA27552C1F167BCF5C6ECFF49C6A46F8580",
"hash": "4D5D90890F8D49519E4151938601EF3D0B30B16CD6A519D9C99102C9FA77F7E0"
},
"validated_ledger_index" : 21184416
}
}このレスポンスは標準フォーマットに従っており、結果が正しい場合、以下のフィールドが含まれます。
Field | 型 | 説明 |
|---|---|---|
engine_result | 文字列 | トランザクションの暫定的な結果を示すコード。例: tesSUCCESS |
engine_result_code | 整数 | トランザクションの暫定的な結果を示し、engine_resultと直接の相関関係にある数値コード |
engine_result_message | 文字列 | 人間が読める形式の、トランザクションの暫定的な結果の説明 |
tx_blob | 文字列 | トランザクション全体の16進文字列表現 |
tx_json | オブジェクト | トランザクション全体のJSON表現 |
注意
WebSocketのレスポンスに
"status":"success"が含まれていても、これはコマンドが正常に受け付けられたことを示すものであり、トランザクションが正常に実行されたことを示しているわけでは ありません 。トランザクションは、さまざまな状況で正常に処理されない可能性があります。例えば、ペイメントの2つのアカウントを接続するトラストラインの欠落や、トランザクション生成後のレジャーの状態の変化などです。問題が特にない場合も、トランザクションが含まれているバージョンのレジャーを閉鎖し検証するまでに数秒かかることがあります。詳細は、トランザクションのレスポンスの完全なリストをご覧ください。トランザクションの結果は、検証済みバージョンのレジャーにトランザクションが表示されるまで、最終的なものと考えないでください。注意
このコマンドの結果としてエラーメッセージが表示された場合、リクエストから取得されたシークレットキーがメッセージの中に記述されている可能性があります。（リクエストに含まれているものが署名済みのtx_blobである場合は問題ありません）。これらのエラーが他者から見えない状態であることを確認してください。
- シークレットキーが記述されているエラーは、複数の人物が参照できるログファイルに書き込まないでください。
- シークレットキーが記述されているエラーは、誰でも参照できる場所にデバッグを目的として貼り付けないでください。
- シークレットキーが記述されているエラーメッセージは、誤ってWebサイトに表示しないようにしてください。
考えられるエラー
- いずれかの汎用エラータイプ。
amendmentBlocked-rippledサーバでの修正がブロックされているため、トランザクションをネットワークに送信できません。highFee-fee_mult_maxパラメーターが指定されましたが、サーバの現在の手数料の乗数が指定値を超えています（署名と送信モードのみ）。internalJson- トランザクションをJSONへとシリアル化するときに、内部エラーが発生しました。このエラーは、無効な署名や一部フィールドの形式の誤りなど、トランザクションのさまざまな側面が原因となって発生する可能性があります。internalSubmit- トランザクションを送信するときに内部エラーが発生しました。このエラーは、無効な署名や一部フィールドの形式の誤りなど、トランザクションのさまざまな側面が原因となって発生する可能性があります。internalTransaction- トランザクションを処理するときに内部エラーが発生しました。このエラーは、無効な署名や一部フィールドの形式の誤りなど、トランザクションのさまざまな側面が原因となって発生する可能性があります。invalidParams- 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。invalidTransaction- トランザクションの形式が誤っているか、その他の理由で無効なものになっています。noPath- トランザクションにパスが含まれておらず、サーバは、このペイメントの発生経路となるパスを検出できませんでした。（署名と送信モードのみ）。tooBusy- トランザクションにパスが含まれていませんが、サーバがビジーであるため、パス検出処理をすぐに実行できません。管理者として接続している場合は発生しません。（署名と送信モードのみ）。