riplle-lib 1.10.1

package/dist/npm/common/schemas/input/prepare-escrow-cancellation.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "prepareEscrowCancellationParameters",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The address of the account that is creating the transaction."
+    },
+    "escrowCancellation": {
+      "$ref": "escrowCancellation",
+      "description": "The specification of the escrow cancellation to prepare."
+    },
+    "instructions": {"$ref": "instructions"}
+  },
+  "additionalProperties": false,
+  "required": ["address", "escrowCancellation"]
+}

package/dist/npm/common/schemas/input/prepare-escrow-creation.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "prepareEscrowCreationParameters",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The address of the account that is creating the transaction."
+    },
+    "escrowCreation": {
+      "$ref": "escrowCreation",
+      "description": "The specification of the escrow creation to prepare."
+    },
+    "instructions": {"$ref": "instructions"}
+  },
+  "additionalProperties": false,
+  "required": ["address", "escrowCreation"]
+}

package/dist/npm/common/schemas/input/prepare-escrow-execution.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "prepareEscrowExecutionParameters",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The address of the account that is creating the transaction."
+    },
+    "escrowExecution": {
+      "$ref": "escrowExecution",
+      "description": "The specification of the escrow execution to prepare."
+    },
+    "instructions": {"$ref": "instructions"}
+  },
+  "additionalProperties": false,
+  "required": ["address", "escrowExecution"]
+}

package/dist/npm/common/schemas/input/prepare-order-cancellation.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "prepareOrderCancellationParameters",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The address of the account that is creating the transaction."
+    },
+    "orderCancellation": {
+      "$ref": "orderCancellation",
+      "description": "The specification of the order cancellation to prepare."
+    },
+    "instructions": {"$ref": "instructions"}
+  },
+  "additionalProperties": false,
+  "required": ["address", "orderCancellation"]
+}

package/dist/npm/common/schemas/input/prepare-order.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "prepareOrderParameters",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The address of the account that is creating the transaction."
+    },
+    "order": {
+      "$ref": "order",
+      "description": "The specification of the order to prepare."
+    },
+    "instructions": {"$ref": "instructions"}
+  },
+  "additionalProperties": false,
+  "required": ["address", "order"]
+}

package/dist/npm/common/schemas/input/prepare-payment-channel-claim.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "preparePaymentChannelClaimParameters",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The address of the account that is creating the transaction."
+    },
+    "paymentChannelClaim": {
+      "$ref": "paymentChannelClaim",
+      "description": "Details of the channel and claim."
+    },
+    "instructions": {"$ref": "instructions"}
+  },
+  "additionalProperties": false,
+  "required": ["address", "paymentChannelClaim"]
+}

package/dist/npm/common/schemas/input/prepare-payment-channel-create.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "preparePaymentChannelCreateParameters",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The address of the account that is creating the transaction."
+    },
+    "paymentChannelCreate": {
+      "$ref": "paymentChannelCreate",
+      "description": "The specification of the payment channel to create."
+    },
+    "instructions": {"$ref": "instructions"}
+  },
+  "additionalProperties": false,
+  "required": ["address", "paymentChannelCreate"]
+}

package/dist/npm/common/schemas/input/prepare-payment-channel-fund.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "preparePaymentChannelFundParameters",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The address of the account that is creating the transaction."
+    },
+    "paymentChannelFund": {
+      "$ref": "paymentChannelFund",
+      "description": "The channel to fund, and the details of how to fund it."
+    },
+    "instructions": {"$ref": "instructions"}
+  },
+  "additionalProperties": false,
+  "required": ["address", "paymentChannelFund"]
+}

package/dist/npm/common/schemas/input/prepare-payment.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "preparePaymentParameters",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The address of the account that is creating the transaction."
+    },
+    "payment": {
+      "$ref": "payment",
+      "description": "The specification of the payment to prepare."
+    },
+    "instructions": {"$ref": "instructions"}
+  },
+  "additionalProperties": false,
+  "required": ["address", "payment"]
+}

package/dist/npm/common/schemas/input/prepare-settings.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "prepareSettingsParameters",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The address of the account that is creating the transaction."
+    },
+    "settings": {
+      "$ref": "settings",
+      "description": "The specification of the settings to prepare."
+    },
+    "instructions": {"$ref": "instructions"}
+  },
+  "additionalProperties": false,
+  "required": ["address", "settings"]
+}

package/dist/npm/common/schemas/input/prepare-ticket-create.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "prepareTicketParameters",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The address of the account that is creating the transaction."
+    },
+    "ticketCount": {
+      "type": "number",
+      "description": "The number of tickets to be created."
+    },
+    "instructions": {"$ref": "instructions"}
+  },
+  "additionalProperties": false,
+  "required": ["address", "ticketCount"]
+}

package/dist/npm/common/schemas/input/prepare-trustline.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "prepareTrustlineParameters",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The address of the account that is creating the transaction."
+    },
+    "trustline": {
+      "$ref": "trustline",
+      "description": "The specification of the trustline to prepare."
+    },
+    "instructions": {"$ref": "instructions"}
+  },
+  "additionalProperties": false,
+  "required": ["address", "trustline"]
+}

package/dist/npm/common/schemas/input/sign-payment-channel-claim.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "signPaymentChannelClaimParameters",
+  "type": "object",
+  "properties": {
+    "channel": {
+      "$ref": "hash256",
+      "description": "256-bit hexadecimal channel identifier."
+    },
+    "amount": {
+      "$ref": "value",
+      "description": "Amount of XRP authorized by the claim."
+    },
+    "privateKey": {
+      "$ref": "publicKey",
+      "description": "The private key to sign the payment channel claim."
+    }
+  },
+  "additionalProperties": false,
+  "required": ["channel", "amount", "privateKey"]
+}

package/dist/npm/common/schemas/input/sign.json

@@ -0,0 +1,55 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "signParameters",
+  "type": "object",
+  "properties": {
+    "txJSON": {
+      "type": "string",
+      "description": "Transaction represented as a JSON string in rippled format."
+    },
+    "secret": {
+      "type": "string",
+      "format": "secret",
+      "description": "The secret of the account that is initiating the transaction. (This field cannot be used with keypair)."
+    },
+    "keypair": {
+      "type": "object",
+      "properties": {
+        "privateKey": {
+          "type": "privateKey",
+          "description": "The uppercase hexadecimal representation of the secp256k1 or Ed25519 private key. Ed25519 keys are prefixed with 0xED. You can read about how keys are derived [here](https://xrpl.org/cryptographic-keys.html)."
+        },
+        "publicKey": {
+          "type": "publicKey",
+          "description": "The uppercase hexadecimal representation of the secp256k1 or Ed25519 public key. Ed25519 keys are prefixed with 0xED. You can read about how keys are derived [here](https://xrpl.org/cryptographic-keys.html)."
+        }
+      },
+      "description": "The private and public key of the account that is initiating the transaction. (This field cannot be used with secret).",
+      "required": ["privateKey", "publicKey"],
+      "additionalProperties": false
+    },
+    "options": {
+      "type": "object",
+      "description": "Options that control the type of signature to create.",
+      "properties": {
+        "signAs": {
+          "$ref": "address",
+          "description": "The account that the signature should count for in multisigning."
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false,
+  "required": ["txJSON"],
+  "oneOf": [
+    {
+      "required": ["secret"],
+      "not": {"required": ["keypair"]}
+    },
+    {
+      "required": ["keypair"],
+      "not": {"required": ["secret"]}
+    }
+  ]
+}

package/dist/npm/common/schemas/input/submit.json

@@ -0,0 +1,17 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "submitParameters",
+  "type": "object",
+  "properties": {
+    "signedTransaction": {
+      "$ref": "blob",
+      "description": "A signed transaction as returned by [sign](#sign)."
+    },
+    "failHard": {
+      "type": "boolean",
+      "description": "If `true`, and the transaction fails locally, do not retry or relay the transaction to other servers. Defaults to `false`."
+    }
+  },
+  "additionalProperties": false,
+  "required": ["signedTransaction"]
+}

package/dist/npm/common/schemas/input/verify-payment-channel-claim.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "verifyPaymentChannelClaimParameters",
+  "type": "object",
+  "properties": {
+    "channel": {
+      "$ref": "hash256",
+      "description": "256-bit hexadecimal channel identifier."
+    },
+    "amount": {
+      "$ref": "value",
+      "description": "Amount of XRP authorized by the claim."
+    },
+    "signature": {
+      "$ref": "signature",
+      "description": "Signature of this claim."
+    },
+    "publicKey": {
+      "$ref": "publicKey",
+      "description": "Public key of the channel's sender"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["channel", "amount", "signature", "publicKey"]
+}

package/dist/npm/common/schemas/objects/address.json

@@ -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"}
+  ]
+}

package/dist/npm/common/schemas/objects/adjustment.json

@@ -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
+}

package/dist/npm/common/schemas/objects/amount.json

@@ -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"]}
+  ]
+}

package/dist/npm/common/schemas/objects/amountbase.json

@@ -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"]
+      }
+    }
+  ]
+}

package/dist/npm/common/schemas/objects/balance.json

@@ -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"]
+      }
+    }
+  ]
+}

package/dist/npm/common/schemas/objects/blob.json

@@ -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]*$"
+}

package/dist/npm/common/schemas/objects/classic-address.json

@@ -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}$"
+}

package/dist/npm/common/schemas/objects/currency.json

@@ -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)$"
+}

package/dist/npm/common/schemas/objects/destination-address-tag.json

@@ -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
+}

package/dist/npm/common/schemas/objects/destination-adjustment.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "destinationAdjustment",
+  "type": "object",
+  "oneOf": [
+    {"$ref": "destinationExactAdjustment"},
+    {"$ref": "minAdjustment"}
+  ]
+}

package/dist/npm/common/schemas/objects/destination-exact-adjustment.json

@@ -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
+}

package/dist/npm/common/schemas/objects/hash128.json

@@ -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}$"
+}

package/dist/npm/common/schemas/objects/hash256.json

@@ -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}$"
+}

package/dist/npm/common/schemas/objects/instructions.json

@@ -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"]
+      }
+    ]
+  }
+}

package/dist/npm/common/schemas/objects/issue.json

@@ -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"]}}
+  ]
+}