Skip to main content
Provides a quick way to check the status of the Default Ripple field for an account and the No Ripple flag of its trust lines, compared with the recommended settings. This method will use 20 Compute Units.

Reference: Here

Parameters

  • account (string, required) The address of the account.
  • role (string, required) Whether the address refers to a gateway or user. Recommendations depend on the role of the account.
  • transactions (boolean, optional) If true, include an array of suggested transactions, as JSON objects, that you can sign and submit to fix the problems. The default is false.
  • limit (unsigned integer, optional) The maximum number of trust line problems to include in the results. Defaults to 300.
  • ledger_hash (string, optional) The unique hash of the ledger version to use.
  • ledger_index (number or string, optional) The ledger index of the ledger to use, or a shortcut string such as validated, closed or current.

Returns

  • ledger_current_index or ledger_index (number) The ledger index of the ledger used to calculate these results.
  • problems (array) Array of strings with human-readable descriptions of the problems. Empty when the account matches the recommended settings.
  • transactions (array) May be omitted. If the request specified transactions as true, the JSON form of transactions that fix the described problems.
  • validated (boolean) If true, the information comes from a validated ledger version.
Over WebSocket, send {"id":1,"command":"noripple_check","account":"rMxCKbEDwqr76QuheSUMdEGf4B9xJ8m5De","role":"gateway","ledger_index":"validated","limit":2} to wss://mainnet.xrpl.validationcloud.io/v1/<YOUR_API_KEY_HERE>.