ripple-lib/dist/npm/common/schemas/objects/instructions.json

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

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "instructions",
  "link": "transaction-instructions",
  "description": "Instructions for executing the transaction",
  "type": "object",
  "properties": {
    "sequence": {
      "description": "The initiating account's sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set.",
      "$ref": "sequence"
    },
    "ticketSequence": {
      "description": "The ticket sequence to be used for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set.",
      "$ref": "ticket-sequence"
    },
    "fee": {
      "description": "An exact fee to pay for the transaction, before multiplying for multi-signed transactions. See [Transaction Fees](#transaction-fees) for more information.",
      "$ref": "value"
    },
    "maxFee": {
      "description": "Deprecated: Use `maxFeeXRP` in the RippleAPI constructor instead. The maximum fee to pay for this transaction. If this exceeds `maxFeeXRP`, use `maxFeeXRP` instead. See [Transaction Fees](#transaction-fees) for more information.",
      "$ref": "value"
    },
    "maxLedgerVersion": {
      "description": "The highest ledger version that the transaction can be included in. If this option and `maxLedgerVersionOffset` are both omitted, the default is 3 greater than the current validated ledger version (equivalent to `maxLedgerVersionOffset=3`). Use `null` to not set a maximum ledger version. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'.",
      "oneOf": [
        {"$ref": "ledgerVersion"},
        {"type": "null"}
      ]
    },
    "maxLedgerVersionOffset": {
      "description": "Offset from current validated ledger version to highest ledger version that the transaction can be included in.",
      "type": "integer",
      "minimum": 0
    },
    "signersCount": {
      "description": "Number of signers that can multi-sign this transaction.",
      "type": "integer",
      "minimum": 1
    }
  },
  "additionalProperties": false,
  "not": {
    "anyOf": [
      {
        "description": "fee and maxFee are mutually exclusive",
        "required": ["fee", "maxFee"]
      },
      {
        "description": "maxLedgerVersion and maxLedgerVersionOffset are mutually exclusive",
        "required": ["maxLedgerVersion", "maxLedgerVersionOffset"]
      },
      {
        "description": "sequence and ticketSequence are mutually exclusive",
        "required": ["sequence", "ticketSequence"]
      }
    ]
  }
}