You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

instructions.json 2.6KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. {
  2. "$schema": "http://json-schema.org/draft-04/schema#",
  3. "title": "instructions",
  4. "link": "transaction-instructions",
  5. "description": "Instructions for executing the transaction",
  6. "type": "object",
  7. "properties": {
  8. "sequence": {
  9. "description": "The initiating account's sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set.",
  10. "$ref": "sequence"
  11. },
  12. "ticketSequence": {
  13. "description": "The ticket sequence to be used for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set.",
  14. "$ref": "ticket-sequence"
  15. },
  16. "fee": {
  17. "description": "An exact fee to pay for the transaction, before multiplying for multi-signed transactions. See [Transaction Fees](#transaction-fees) for more information.",
  18. "$ref": "value"
  19. },
  20. "maxFee": {
  21. "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.",
  22. "$ref": "value"
  23. },
  24. "maxLedgerVersion": {
  25. "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'.",
  26. "oneOf": [
  27. {"$ref": "ledgerVersion"},
  28. {"type": "null"}
  29. ]
  30. },
  31. "maxLedgerVersionOffset": {
  32. "description": "Offset from current validated ledger version to highest ledger version that the transaction can be included in.",
  33. "type": "integer",
  34. "minimum": 0
  35. },
  36. "signersCount": {
  37. "description": "Number of signers that can multi-sign this transaction.",
  38. "type": "integer",
  39. "minimum": 1
  40. }
  41. },
  42. "additionalProperties": false,
  43. "not": {
  44. "anyOf": [
  45. {
  46. "description": "fee and maxFee are mutually exclusive",
  47. "required": ["fee", "maxFee"]
  48. },
  49. {
  50. "description": "maxLedgerVersion and maxLedgerVersionOffset are mutually exclusive",
  51. "required": ["maxLedgerVersion", "maxLedgerVersionOffset"]
  52. },
  53. {
  54. "description": "sequence and ticketSequence are mutually exclusive",
  55. "required": ["sequence", "ticketSequence"]
  56. }
  57. ]
  58. }
  59. }