Files
xrpl-dev-portal/content/rippled-api-methods/validation_create.md
2018-01-22 16:27:33 -08:00

3.6 KiB

validation_create

[Source]

Use the validation_create command to generate the keys for a rippled validator. Similar to the wallet_propose command, this command makes no real changes, but only generates a set of keys in the proper format.

The validation_create method is an admin command that cannot be run by unprivileged users.

Request Format

An example of the request format:

WebSocket

{
    "id": 0,
    "command": "validation_create",
    "secret": "BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIRE"
}

JSON-RPC

{
    "method": "validation_create",
    "params": [
        {
            "secret": "BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIRE"
        }
    ]
}

Commandline

#Syntax: validation_create [secret]
rippled validation_create "BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIRE"

The request includes the following parameters:

Field Type Description
secret String (Optional) Use this value as a seed to generate the credentials. The same secret always generates the same credentials. You can provide the seed in RFC-1751 format or Ripple's [base58][] format. If omitted, generate a random seed.

Note: The security of your validator depends on the entropy of your seed. Do not use a secret value for real business purposes unless it is generated with a strong source of randomness. Ripple recommends omitting the secret when generating new credentials for the first time.

Response Format

An example of a successful response:

JSON-RPC

{
   "result" : {
      "status" : "success",
      "validation_key" : "FAWN JAVA JADE HEAL VARY HER REEL SHAW GAIL ARCH BEN IRMA",
      "validation_public_key" : "n9Mxf6qD4J55XeLSCEpqaePW4GjoCR5U1ZeGZGJUCNe3bQa4yQbG",
      "validation_seed" : "ssZkdwURFMBXenJPbrpE14b6noJSu"
   }
}

Commandline

Loading: "/etc/rippled.cfg"
Connecting to 127.0.0.1:5005
{
   "result" : {
      "status" : "success",
      "validation_key" : "FAWN JAVA JADE HEAL VARY HER REEL SHAW GAIL ARCH BEN IRMA",
      "validation_public_key" : "n9Mxf6qD4J55XeLSCEpqaePW4GjoCR5U1ZeGZGJUCNe3bQa4yQbG",
      "validation_seed" : "ssZkdwURFMBXenJPbrpE14b6noJSu"
   }
}

The response follows the standard format, with a successful result containing the following fields:

Field Type Description
validation_key String The secret key for these validation credentials, in RFC-1751 format.
validation_public_key String The public key for these validation credentials, in Ripple's [base58][] encoded string format.
validation_seed String The secret key for these validation credentials, in Ripple's [base58][] encoded string format.

Possible Errors

  • Any of the universal error types.
  • badSeed - The request provided an invalid seed value. This usually means that the seed value appears to be a valid string of a different format, such as an account address or validation public key.