init

2023-08-15 22:28:03 +02:00
commit 1dae68b1c7
5529 changed files with 1659171 additions and 0 deletions
@@ -0,0 +1,12 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "address",
+  "description": "An account address on the XRP Ledger",
+  "type": "string",
+  "format": "address",
+  "link": "address",
+  "oneOf": [
+    {"$ref": "xAddress"},
+    {"$ref": "classicAddress"}
+  ]
+}
@@ -0,0 +1,12 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "adjustment",
+  "type": "object",
+  "properties": {
+    "address": {"$ref": "address"},
+    "amount": {"$ref": "amount"},
+    "tag": {"$ref": "tag"}
+  },
+  "required": ["address", "amount"],
+  "additionalProperties": false
+}
@@ -0,0 +1,10 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "amount",
+  "link": "amount",
+  "description": "An Amount on the XRP Ledger",
+  "allOf": [
+    {"$ref": "amountbase"},
+    {"required": ["value"]}
+  ]
+}
@@ -0,0 +1,44 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "amountbase",
+  "description": "Base class for amount and issue",
+  "type": "object",
+  "properties": {
+    "value": {
+      "description": "The quantity of the currency, denoted as a string so that it does not lose precision",
+      "$ref": "value"
+    },
+    "currency": {
+      "description": "The three-character code or hexadecimal string used to denote currencies, or \"drops\" for the smallest unit of XRP.",
+      "$ref": "currency"
+    },
+    "counterparty": {
+      "description": "The XRP Ledger address of the account that owes or is owed the funds (omitted if `currency` is \"XRP\" or \"drops\")",
+      "$ref": "address"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["currency"],
+  "oneOf": [
+    {
+      "properties": {
+        "currency": {
+          "not": {
+            "enum": ["XRP", "drops"]
+          }
+        }
+      },
+      "required": ["counterparty"]
+    },
+    {
+      "properties": {
+        "currency": {
+          "enum": ["XRP", "drops"]
+        }
+      },
+      "not": {
+        "required": ["counterparty"]
+      }
+    }
+  ]
+}
@@ -0,0 +1,45 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "balance",
+  "description": "Balance amount",
+  "link": "amount",
+  "type": "object",
+  "properties": {
+    "value": {
+      "description": "The balance on the trustline",
+      "$ref": "signedValue"
+    },
+    "currency": {
+      "description": "The three-character code or hexadecimal string used to denote currencies",
+      "$ref": "currency"
+    },
+    "counterparty": {
+      "description": "The XRP Ledger address of the account that owes or is owed the funds.",
+      "$ref": "address"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["currency", "value"],
+  "oneOf": [
+    {
+      "properties": {
+        "currency": {
+          "not": {
+            "enum": ["XRP"]
+          }
+        }
+      },
+      "required": ["counterparty"]
+    },
+    {
+      "properties": {
+        "currency": {
+          "enum": ["XRP"]
+        }
+      },
+      "not": {
+        "required": ["counterparty"]
+      }
+    }
+  ]
+}
@@ -0,0 +1,8 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "blob",
+  "description": "An uppercase hexadecimal string representation of a transaction",
+  "type": "string",
+  "minLength": 1,
+  "pattern": "^[0-9A-F]*$"
+}
@@ -0,0 +1,9 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "classicAddress",
+  "description": "A classic address (Account ID) for the XRP Ledger",
+  "type": "string",
+  "format": "classicAddress",
+  "link": "classic-address",
+  "pattern": "^r[1-9A-HJ-NP-Za-km-z]{24,34}$"
+}
@@ -0,0 +1,8 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "currency",
+  "description": "The three-character code or hexadecimal string used to denote currencies",
+  "type": "string",
+  "link": "currency",
+  "pattern": "^([a-zA-Z0-9<>(){}[\\]|?!@#$%^&*]{3}|[A-F0-9]{40}|drops)$"
+}
@@ -0,0 +1,15 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "destinationAddressTag",
+  "description": "A destination address and optional tag, with no amount included. When parsing an incoming transaction, the original specification's amount is hidden to prevent misinterpretation. For the amount that the transaction delivered, see `outcome.deliveredAmount`.",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "An address representing the destination of the transaction."
+    },
+    "tag": {"$ref": "tag"}
+  },
+  "required": ["address"],
+  "additionalProperties": false
+}
@@ -0,0 +1,9 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "destinationAdjustment",
+  "type": "object",
+  "oneOf": [
+    {"$ref": "destinationExactAdjustment"},
+    {"$ref": "minAdjustment"}
+  ]
+}
@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "destinationExactAdjustment",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "An address representing the destination of the transaction."
+    },
+    "amount": {
+      "$ref": "laxAmount",
+      "description": "An exact amount to deliver to the recipient. If the counterparty is not specified, amounts with any counterparty may be used. (This field cannot be used with `destination.minAmount`.)"
+    },
+    "tag": {"$ref": "tag"}
+  },
+  "required": ["address", "amount"],
+  "additionalProperties": false
+}
@@ -0,0 +1,7 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "hash128",
+  "description": "The hexadecimal representation of a 128-bit hash",
+  "type": "string",
+  "pattern": "^[A-F0-9]{32}$"
+}
@@ -0,0 +1,7 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "hash256",
+  "description": "The hexadecimal representation of a 256-bit hash",
+  "type": "string",
+  "pattern": "^[A-F0-9]{64}$"
+}
@@ -0,0 +1,59 @@
+{
+  "$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"]
+      }
+    ]
+  }
+}
@@ -0,0 +1,9 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "issue",
+  "description": "The currency code, and the counterparty if it's not XRP.",
+  "allOf": [
+    {"$ref": "amountbase"},
+    {"not": {"required": ["value"]}}
+  ]
+}
@@ -0,0 +1,14 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "laxAmount",
+  "description": "Amount where counterparty is optional",
+  "link": "amount",
+  "type": "object",
+  "properties": {
+    "currency": {"$ref": "currency"},
+    "counterparty": {"$ref": "address"},
+    "value": {"$ref": "value"}
+  },
+  "required": ["currency", "value"],
+  "additionalProperties": false
+}
@@ -0,0 +1,14 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "laxLaxAmount",
+  "description": "Amount where counterparty and value are optional",
+  "link": "amount",
+  "type": "object",
+  "properties": {
+    "currency": {"$ref": "currency"},
+    "counterparty": {"$ref": "address"},
+    "value": {"$ref": "value"}
+  },
+  "required": ["currency"],
+  "additionalProperties": false
+}
@@ -0,0 +1,15 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "ledgerVersion",
+  "description": "A ledger version number",
+  "oneOf": [
+    {
+      "type": "integer",
+      "minimum": 1
+    },
+    {
+      "type": "string",
+      "enum": ["validated", "closed", "current"]
+    }
+  ]
+}
@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "maxAdjustment",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The address to send from."
+    },
+    "maxAmount": {
+      "$ref": "laxAmount",
+      "description": "The maximum amount to send. (This field cannot be used with source.amount)"
+    },
+    "tag": {"$ref": "tag"}
+  },
+  "required": ["address", "maxAmount"],
+  "additionalProperties": false
+}
@@ -0,0 +1,25 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "memo",
+  "description": "Memo objects represent arbitrary data that can be included in a transaction",
+  "type": "object",
+  "properties": {
+    "type": {
+      "pattern": "^[A-Za-z0-9\\-._~:/?#[\\]@!$&'()*+,;=%]*$",
+      "description": "Conventionally, a unique relation (according to [RFC 5988](http://tools.ietf.org/html/rfc5988#section-4)) that defines the format of this memo. Only characters allowed in URLs are permitted."
+    },
+    "format": {
+      "pattern": "^[A-Za-z0-9\\-._~:/?#[\\]@!$&'()*+,;=%]*$",
+      "description": "Conventionally containing information on how the memo is encoded, for example as a [MIME type](http://www.iana.org/assignments/media-types/media-types.xhtml). Only characters allowed in URLs are permitted."
+    },
+    "data": {
+      "type": "string",
+      "description": "Arbitrary string, conventionally containing the content of the memo."
+    }
+  },
+  "additionalProperties": false,
+  "anyOf": [
+    {"required": ["data"]},
+    {"required": ["type"]}
+  ]
+}
@@ -0,0 +1,10 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "memos",
+  "link": "transaction-memos",
+  "description": "Array of memos to attach to the transaction.",
+  "type": "array",
+  "items": {
+    "$ref": "memo"
+  }
+}
@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "minAdjustment",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "An address representing the destination of the transaction."
+    },
+    "minAmount": {
+      "$ref": "laxAmount",
+      "description": "The minimum amount to be delivered. (This field cannot be used with destination.amount)"
+    },
+    "tag": {"$ref": "tag"}
+  },
+  "required": ["address", "minAmount"],
+  "additionalProperties": false
+}
@@ -0,0 +1,11 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "orderbook",
+  "type": "object",
+  "properties": {
+    "base": {"$ref": "issue"},
+    "counter": {"$ref": "issue"}
+  },
+  "required": ["base", "counter"],
+  "additionalProperties": false
+}
@@ -0,0 +1,7 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "privateKey",
+  "description": "The hexadecimal representation of a secp256k1 or Ed25519 private key.",
+  "type": "string",
+  "pattern": "^[A-F0-9]+$"
+}
@@ -0,0 +1,7 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "publicKey",
+  "description": "The hexadecimal representation of a secp256k1 or Ed25519 public key.",
+  "type": "string",
+  "pattern": "^[A-F0-9]+$"
+}
@@ -0,0 +1,8 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "quality",
+  "description": "Ratio for incoming/outgoing transit fees.",
+  "type": "number",
+  "minimum": 0.000000001,
+  "maximum": 4.294967295
+}
@@ -0,0 +1,8 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "sequence",
+  "link": "account-sequence-number",
+  "description": "An account transaction sequence number",
+  "type": "integer",
+  "minimum": 0
+}
@@ -0,0 +1,120 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "settingsPlusMemos",
+  "type": "object",
+  "properties": {
+    "defaultRipple": {
+      "type": "boolean",
+      "description": "Enable [rippling](https://xrpl.org/rippling.html) on this account’s trust lines by default. Currency issuers should enable this setting; most others should not."
+    },
+    "depositAuth": {
+      "type": "boolean",
+      "description": "Enable [Deposit Authorization](https://xrpl.org/depositauth.html) on this account. If set, transactions cannot send value of any kind to this account unless the sender of those transactions is the account itself. (Requires the [DepositAuth amendment](https://xrpl.org/known-amendments.html#depositauth))"
+    },
+    "disableMasterKey": {
+      "type": "boolean",
+      "description": "Disallows use of the master key to sign transactions for this account. To disable the master key, you must authorize the transaction by signing it with the master key pair. You cannot use a regular key pair or a multi-signature. You can re-enable the master key pair using a regular key pair or multi-signature. See [AccountSet](https://xrpl.org/accountset.html)."
+    },
+    "disallowIncomingXRP": {
+      "type": "boolean",
+      "description": "Indicates that client applications should not send XRP to this account. Not enforced by rippled."
+    },
+    "domain": {
+      "type": "string",
+      "description": "The domain that owns this account, as a hexadecimal string representing the ASCII for the domain in lowercase."
+    },
+    "emailHash": {
+      "description": "Hash of an email address to be used for generating an avatar image. Conventionally, clients use Gravatar to display this image. Use `null` to clear.",
+      "oneOf": [
+        {"type": "null"},
+        {"$ref": "hash128"}
+      ]
+    },
+    "walletLocator": {
+      "description": "Transaction hash or any other 64 character hexadecimal string, that may or may not represent the result of a hash operation. Use `null` to clear.",
+      "oneOf": [
+        {"type": "null"},
+        {"$ref": "hash256"}
+      ]
+    },
+    "enableTransactionIDTracking": {
+      "type": "boolean",
+      "description": "Track the ID of this account’s most recent transaction."
+    },
+    "globalFreeze": {
+      "type": "boolean",
+      "description": "Freeze all assets issued by this account."
+    },
+    "memos": {"$ref": "memos"},
+    "messageKey": {
+      "type": "string",
+      "description": "Public key for sending encrypted messages to this account. Conventionally, it should be a secp256k1 key, the same encryption that is used by the rest of Ripple."
+    },
+    "noFreeze": {
+      "type": "boolean",
+      "description": "Permanently give up the ability to freeze individual trust lines. This flag can never be disabled after being enabled."
+    },
+    "passwordSpent": {
+      "type": "boolean",
+      "description": "Indicates that the account has used its free SetRegularKey transaction."
+    },
+    "regularKey": {
+      "oneOf": [
+        {"$ref": "address"},
+        {"type": "null"}
+      ],
+      "description": "The public key of a new keypair, to use as the regular key to this account, as a base-58-encoded string in the same format as an account address. Use `null` to remove the regular key."
+    },
+    "requireAuthorization": {
+      "type": "boolean",
+      "description": "If set, this account must individually give other users permission to hold this account’s issued tokens."
+    },
+    "requireDestinationTag": {
+      "type": "boolean",
+      "description": "Requires incoming payments to specify a destination tag."
+    },
+    "signers": {
+      "type": "object",
+      "description": "Settings that determine what sets of accounts can be used to sign a transaction on behalf of this account using multisigning.",
+      "properties": {
+        "threshold": {
+          "$ref": "uint32",
+          "description": "A target number for the signer weights. A multi-signature from this list is valid only if the sum weights of the signatures provided is equal or greater than this value. To delete the signers setting, use the value `0`."
+        },
+        "weights": {
+          "type": "array",
+          "description": "Weights of signatures for each signer.",
+          "items": {
+            "type": "object",
+            "description": "An association of an address and a weight.",
+            "properties": {
+              "address": {"$ref": "address"},
+              "weight": {
+                "$ref": "uint32",
+                "description": "The weight that the signature of this account counts as towards the threshold."
+              }
+            },
+            "required": ["address", "weight"],
+            "additionalProperties": false
+          },
+          "minItems": 1,
+          "maxItems": 8
+        }
+      },
+      "required": ["threshold"],
+      "additionalProperties": false
+    },
+    "transferRate": {
+      "description": "The fee to charge when users transfer this account’s issuances, as the decimal amount that must be sent to deliver 1 unit. Has precision up to 9 digits beyond the decimal point. Use `null` to set no fee.",
+      "oneOf": [
+        {"type": "null"},
+        {"type": "number", "minimum": 1, "maximum": 4.294967295}
+      ]
+    },
+    "tickSize": {
+      "description": "Tick size to use for offers involving a currency issued by this address. The exchange rates of those offers is rounded to this many significant digits. Valid values are 3 to 15 inclusive, or 0 to disable.",
+      "enum": [0, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]
+    }
+  },
+  "additionalProperties": false
+}
@@ -0,0 +1,7 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "signature",
+  "description": "The hexadecimal representation of a signature.",
+  "type": "string",
+  "pattern": "^[A-F0-9]+$"
+}
@@ -0,0 +1,8 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "signedValue",
+  "description": "A string representation of a floating point number",
+  "type": "string",
+  "link": "value",
+  "pattern": "^[-]?[0-9]*[.]?[0-9]+([eE][-+]?[0-9]+)?$"
+}
@@ -0,0 +1,9 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "sourceAdjustment",
+  "type": "object",
+  "oneOf": [
+    {"$ref": "sourceExactAdjustment"},
+    {"$ref": "maxAdjustment"}
+  ]
+}
@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "sourceExactAdjustment",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The address to send from."
+    },
+    "amount": {
+      "$ref": "laxAmount",
+      "description": "An exact amount to send. If the counterparty is not specified, amounts with any counterparty may be used. (This field cannot be used with source.maxAmount)"
+    },
+    "tag": {"$ref": "tag"}
+  },
+  "required": ["address", "amount"],
+  "additionalProperties": false
+}
@@ -0,0 +1,7 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "tag",
+  "description": "An arbitrary 32-bit unsigned integer. It typically maps to an off-ledger account; for example, a hosted wallet or exchange account.",
+  "type": "integer",
+  "$ref": "uint32"
+}
@@ -0,0 +1,8 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "ticket-sequence",
+  "link": "account-sequence-number",
+  "description": "An account transaction tickt sequence number",
+  "type": "integer",
+  "minimum": 1
+}
@@ -0,0 +1,8 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "transactionHash",
+  "link": "transaction-id",
+  "description": "A hash of a transaction used to identify the transaction, represented in hexadecimal.",
+  "type": "string",
+  "pattern": "^[A-F0-9]{64}$"
+}
@@ -0,0 +1,25 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "transactionType",
+  "link": "transaction-types",
+  "description": "The type of the transaction.",
+  "type": "string",
+  "enum": [
+    "payment",
+    "order",
+    "orderCancellation",
+    "trustline",
+    "settings",
+    "escrowCreation",
+    "escrowCancellation",
+    "escrowExecution",
+    "paymentChannelCreate",
+    "paymentChannelFund",
+    "paymentChannelClaim",
+    "checkCreate",
+    "checkCancel",
+    "checkCash",
+    "depositPreauth",
+    "accountDelete"
+  ]
+}
@@ -0,0 +1,12 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "tx-json",
+  "link": "https://xrpl.org/transaction-formats.html",
+  "description": "An object in rippled txJSON format",
+  "type": "object",
+  "properties": {
+    "Account": {"$ref": "address"},
+    "TransactionType": {"type": "string"}
+  },
+  "required": ["Account", "TransactionType"]
+}
@@ -0,0 +1,8 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "uint32",
+  "description": "A 32-bit unsigned integer",
+  "type": "integer",
+  "minimum": 0,
+  "maximum": 4294967295
+}
@@ -0,0 +1,8 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "value",
+  "link": "value",
+  "description": "A string representation of a non-negative floating point number",
+  "type": "string",
+  "pattern": "^[0-9]*[.]?[0-9]+([eE][-+]?[0-9]+)?$"
+}
@@ -0,0 +1,9 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "xAddress",
+  "description": "An XRP Ledger address in X-address format",
+  "type": "string",
+  "format": "xAddress",
+  "link": "x-address",
+  "pattern": "^[XT][1-9A-HJ-NP-Za-km-z]{46}$"
+}