mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-20 19:55:54 +00:00
110 lines
1.9 KiB
Markdown
110 lines
1.9 KiB
Markdown
---
|
|
html: random.html
|
|
parent: utility-methods.html
|
|
blurb: Generate a random number.
|
|
labels:
|
|
- Core Server
|
|
---
|
|
# random
|
|
|
|
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/Random.cpp "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:
|
|
|
|
<!-- MULTICODE_BLOCK_START -->
|
|
|
|
*WebSocket*
|
|
|
|
```json
|
|
{
|
|
"id": 1,
|
|
"command": "random"
|
|
}
|
|
```
|
|
|
|
*JSON-RPC*
|
|
|
|
```json
|
|
{
|
|
"method": "random",
|
|
"params": [
|
|
{}
|
|
]
|
|
}
|
|
```
|
|
|
|
*Commandline*
|
|
|
|
```sh
|
|
#Syntax: random
|
|
rippled random
|
|
```
|
|
|
|
<!-- MULTICODE_BLOCK_END -->
|
|
|
|
The request includes no parameters.
|
|
|
|
## Response Format
|
|
|
|
An example of a successful response:
|
|
|
|
<!-- MULTICODE_BLOCK_START -->
|
|
|
|
*WebSocket*
|
|
|
|
```json
|
|
{
|
|
"id": 1,
|
|
"result": {
|
|
"random": "8ED765AEBBD6767603C2C9375B2679AEC76E6A8133EF59F04F9FC1AAA70E41AF"
|
|
},
|
|
"status": "success",
|
|
"type": "response"
|
|
}
|
|
```
|
|
|
|
*JSON-RPC*
|
|
|
|
```json
|
|
200 OK
|
|
|
|
{
|
|
"result": {
|
|
"random": "4E57146AA47BC6E88FDFE8BAA235B900126C916B6CC521550996F590487B837A",
|
|
"status": "success"
|
|
}
|
|
}
|
|
```
|
|
|
|
*Commandline*
|
|
|
|
```json
|
|
{
|
|
"result" : {
|
|
"random" : "DB7C23C7F224CD410912E68A997BE0FD0FA7175A4C74B829BE5A80ED0DBAA0C5",
|
|
"status" : "success"
|
|
}
|
|
}
|
|
```
|
|
|
|
<!-- MULTICODE_BLOCK_END -->
|
|
|
|
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.
|
|
|
|
<!--{# common link defs #}-->
|
|
{% include '_snippets/rippled-api-links.md' %}
|
|
{% include '_snippets/tx-type-links.md' %}
|
|
{% include '_snippets/rippled_versions.md' %}
|