Files
xrpl-dev-portal/content/references/http-websocket-apis/public-api-methods/utility-methods/random.md

1.9 KiB

html, parent, blurb, labels
html parent blurb labels
random.html utility-methods.html Generate a random number.
Core Server

random

[Source]

The random command provides a random number to be used as a source of entropy for random number generation by clients.

Request Format

An example of the request format:

WebSocket

{
    "id": 1,
    "command": "random"
}

JSON-RPC

{
    "method": "random",
    "params": [
        {}
    ]
}

Commandline

#Syntax: random
rippled random

The request includes no parameters.

Response Format

An example of a successful response:

WebSocket

{
    "id": 1,
    "result": {
        "random": "8ED765AEBBD6767603C2C9375B2679AEC76E6A8133EF59F04F9FC1AAA70E41AF"
    },
    "status": "success",
    "type": "response"
}

JSON-RPC

200 OK

{
    "result": {
        "random": "4E57146AA47BC6E88FDFE8BAA235B900126C916B6CC521550996F590487B837A",
        "status": "success"
    }
}

Commandline

{
   "result" : {
      "random" : "DB7C23C7F224CD410912E68A997BE0FD0FA7175A4C74B829BE5A80ED0DBAA0C5",
      "status" : "success"
   }
}

The response follows the [standard format][], with a successful result containing the following field:

Field Type Description
random String Random 256-bit hex value.

Possible Errors

  • Any of the [universal error types][].
  • internal - Some internal error occurred, possibly relating to the random number generator.

{% include '_snippets/rippled-api-links.md' %} {% include '_snippets/tx-type-links.md' %} {% include '_snippets/rippled_versions.md' %}