ripple-lib/dist/npm/common/schemas/input/generate-address.json

Deprecated - consider migrating to xrpl.js: https://xrpl.org/xrpljs2-migration-guide.html

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "generateAddressParameters",
  "type": "object",
  "properties": {
    "options": {
      "type": "object",
      "description": "Options to control how the address and secret are generated.",
      "properties": {
        "entropy": {
          "type": "array",
          "items": {
            "type": "integer",
            "minimum": 0,
            "maximum": 255
          },
          "description": "The entropy to use to generate the seed. Must be an array of length 16 with values from 0-255 (16 bytes of entropy)"
        },
        "algorithm": {
          "type": "string",
          "enum": ["ecdsa-secp256k1", "ed25519"],
          "description": "The digital signature algorithm to generate an address for. Can be `ecdsa-secp256k1` (default) or `ed25519`."
        },
        "test": {
          "type": "boolean",
          "description": "Specifies whether the address is intended for use on a test network such as Testnet or Devnet. If `true`, the address should only be used for testing, and starts with `T`. If `false`, the address should only be used on Mainnet, and starts with `X`."
        },
        "includeClassicAddress": {
          "type": "boolean",
          "description": "If `true`, also return the classic address."
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}