noripple_check

noripple_checkコマンドを使用すると、アカウントのDefaultRippleフィールドとそのトラストラインのNoRippleフラグの状態を、推奨される設定と比較して迅速にチェックできます。

リクエストのフォーマット

リクエストのフォーマットの例:

{
   "id": 0,
   "command": "noripple_check",
   "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
   "role": "gateway",
   "ledger_index": "current",
   "limit": 2,
   "transactions": true
}

注記

このメソッドのコマンドライン構文はありません。コマンドラインからアクセスするにはjsonメソッドを使用してください。

リクエストには以下のパラメーターが含まれます。

`Field`	型	説明
`account`	文字列	アカウントの一意のIDであり、通常はアカウントのアドレスです。
`role`	文字列	アドレスが`gateway`と`user`のいずれを指しているか。推奨事項はアカウントの役割に応じて異なります。イシュアーのDefaultRippleを有効にし、すべてのトラストラインでNoRippleを無効にする必要があります。ユーザのDefaultRippleを無効にし、すべてのトラストラインでNoRippleを有効にする必要があります。
`transactions`	ブール値	（省略可） `true`の場合、提案されるトランザクション（JSONオブジェクト）の配列を指定します。問題を修正するために、これらのトランザクションに署名して送信することができます。デフォルトでは`false`です。
`limit`	符号なし整数	（省略可）結果に含めることができるトラストライン問題の最大数。デフォルトでは300です。
`ledger_hash`	文字列	（省略可）使用するレジャーバージョンの20バイトの16進数文字列。（レジャーの指定をご覧ください。
`ledger_index`	文字列または符号なし整数	（省略可）使用するレジャーのシーケンス番号、またはレジャーを自動的に選択するためのショートカット文字列。（レジャーの指定をご覧ください。

レスポンスのフォーマット

処理が成功したレスポンスの例:

{
 "id": 0,
 "status": "success",
 "type": "response",
 "result": {
   "ledger_current_index": 14342939,
   "problems": [
     "You should immediately set your default ripple flag",
     "You should clear the no ripple flag on your XAU line to r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z",
     "You should clear the no ripple flag on your USD line to rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q"
   ],
   "transactions": [
     {
       "Account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
       "Fee": 10000,
       "Sequence": 1406,
       "SetFlag": 8,
       "TransactionType": "AccountSet"
     },
     {
       "Account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
       "Fee": 10000,
       "Flags": 262144,
       "LimitAmount": {
         "currency": "XAU",
         "issuer": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z",
         "value": "0"
       },
       "Sequence": 1407,
       "TransactionType": "TrustSet"
     },
     {
       "Account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
       "Fee": 10000,
       "Flags": 262144,
       "LimitAmount": {
         "currency": "USD",
         "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
         "value": "5"
       },
       "Sequence": 1408,
       "TransactionType": "TrustSet"
     }
   ],
   "validated": false
 }
}

レスポンスは標準フォーマットに従っており、正常に完了した場合は結果に次のフィールドが含まれています。

`Field`	型	説明
`ledger_current_index`	数値	これらの結果の計算に使用するレジャーのシーケンス番号。
`problems`	配列	人間が読み取ることができる形式の問題の記述が含まれている文字列の配列。アカウントのDefaultRipple設定が推奨に従っていない場合は、最大1つのエントリが含まれます。加えて、NoRipple設定が推奨に従っていないトラストラインのエントリ（最大で`limit`に指定されている数）も含まれます。
`transactions`	配列	（省略される場合があります）リクエストで`transactions`が`true`に指定されている場合、これはJSONオブジェクトの配列です。各JSONオブジェクトは、JSON形式のトランザクションで、記述されている問題の1つを修正します。この配列の長さは`problems`配列と同じであり、各エントリは、その配列の同じインデックスで記述されている問題の修正を目的としています。

考えられるエラー

汎用エラータイプのすべて。
invalidParams - 1つ以上のフィールドの指定が正しくないか、1つ以上の必須フィールドが指定されていません。API v1では、transactionsフィールドに非ブール値を指定した場合にこのエラーが発生します。
actNotFound - リクエストのaccountフィールドに指定されているアドレスが、レジャーのアカウントに対応していません。
lgrNotFound - ledger_hashまたはledger_indexに指定されているレジャーが存在しないか、存在しているがサーバにはありません。