Honeycluster Docs – Check NoRipple flag settings

Account Methods

Check NoRipple flag settings

wss://honeycluster.io

rpc method: noripple_check

Checks an account for recommended NoRipple flag settings and returns suggested fixes if problems are found.

Try it now

Response · noripple_check WS Response

{
  "result": {
    "ledger_index": 89012345,
    "problems": [
      "You should immediately set your default ripple flag"
    ],
    "transactions": [
      {
        "Account": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
        "TransactionType": "AccountSet"
      }
    ]
  },
  "status": "success",
  "type": "response",
  "id": 1
}

Request Message

noripple_check WS Request

application/json

Check NoRipple flag settings

Field	Type	Description
`command` required	string	WebSocket command name
`id`	object	Client-supplied identifier to correlate requests with responses.
`account`	string	The account to check NoRipple settings for.
`role`	enum<string>	Whether to check from a "gateway" or "user" perspective. Determines recommended settings. Available `gatewayuser`
`transactions`	boolean	If true, include an array of suggested transactions to fix any problems.
`ledger_index`	object	A ledger index (sequence number) or shortcut string identifying which ledger to use.
`ledger_hash`	string	256-bit hex hash identifying a specific ledger version.
`limit`	integer	Maximum number of results to return. Clio servers may return more than this.
`api_version`	object	API version for the response format. Version 2 is the default for rippled 2.0+.

Example

Json

{
  "command": "noripple_check",
  "id": 1,
  "account": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
  "role": "gateway",
  "ledger_index": "validated",
  "transactions": true
}

Response Message

noripple_check WS Response

application/json

WebSocket response for noripple_check

Field	Type	Description
`result`	object
`status`	enum<string>	Available `successerror`
`type`	string
`id`	stringnumber	Echo of the client-provided correlation ID

Example

Json

{
  "result": {
    "ledger_index": 89012345,
    "problems": [
      "You should immediately set your default ripple flag"
    ],
    "transactions": [
      {
        "Account": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
        "TransactionType": "AccountSet"
      }
    ]
  },
  "status": "success",
  "type": "response",
  "id": 1
}

Request

Payload · JSON

const ws = new WebSocket('wss://honeycluster.io');

ws.addEventListener('open', () => {
  const request = {
    "command": "noripple_check",
    "id": 1,
    "account": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
    "role": "gateway",
    "ledger_index": "validated",
    "transactions": true
  };
  ws.send(JSON.stringify(request));
});

ws.addEventListener('message', (event: MessageEvent<string>) => {
  const response: unknown = JSON.parse(event.data);
  console.log(response);
  ws.close();
});

Response · noripple_check WS Response

{
  "result": {
    "ledger_index": 89012345,
    "problems": [
      "You should immediately set your default ripple flag"
    ],
    "transactions": [
      {
        "Account": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
        "TransactionType": "AccountSet"
      }
    ]
  },
  "status": "success",
  "type": "response",
  "id": 1
}