riplle-lib 1.10.1

package/dist/npm/common/schemas/output/ledger-event.json

@@ -0,0 +1,46 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "ledgerEvent",
+  "description": "A ledger event message",
+  "type": "object",
+  "properties": {
+    "baseFeeXRP": {
+      "$ref": "value",
+      "description": "Base fee, in XRP."
+    },
+    "ledgerHash": {
+      "$ref": "hash256",
+      "description": "Unique hash of the ledger that was closed, as hex."
+    },
+    "ledgerVersion": {
+      "$ref": "ledgerVersion",
+      "description": "Ledger version of the ledger that closed."
+    },
+    "ledgerTimestamp": {
+      "type": "string",
+      "format": "date-time",
+      "description": "The time at which this ledger closed."
+    },
+    "reserveBaseXRP": {
+      "$ref": "value",
+      "description": "The minimum reserve, in XRP, that is required for an account."
+    },
+    "reserveIncrementXRP": {
+      "$ref": "value",
+      "description": "The increase in account reserve that is added for each item the account owns, such as offers or trust lines."
+    },
+    "transactionCount": {
+      "type": "integer",
+      "minimum": 0,
+      "description": "Number of new transactions included in this ledger."
+    },
+    "validatedLedgerVersions": {
+      "type": "string",
+      "description": "Range of ledgers that the server has available. This may be discontiguous."
+    }
+  },
+  "addtionalProperties": false,
+  "required": ["baseFeeXRP", "ledgerHash", "ledgerTimestamp",
+    "reserveBaseXRP", "reserveIncrementXRP", "transactionCount",
+    "ledgerVersion", "validatedLedgerVersions"]
+}

package/dist/npm/common/schemas/output/order-change.json

@@ -0,0 +1,40 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "orderChange",
+  "type": "object",
+  "description": "A change to an order.",
+  "properties": {
+    "direction": {
+      "type": "string",
+      "enum": ["buy", "sell"],
+      "description": "Equal to \"buy\" for buy orders and \"sell\" for sell orders."
+    },
+    "quantity": {
+      "$ref": "amount",
+      "description": "The amount to be bought or sold by the maker."
+    },
+    "totalPrice": {
+      "$ref": "amount",
+      "description": "The total amount to be paid or received by the taker."
+    },
+    "makerExchangeRate": {
+      "$ref": "value",
+      "description": "The exchange rate between the `quantity` currency and the `totalPrice` currency from the point of view of the maker."
+    },
+    "sequence": {
+      "$ref": "sequence",
+      "description": "The order sequence number, used to identify the order for cancellation"
+    },
+    "status": {
+      "enum": ["created", "filled", "partially-filled", "cancelled"],
+      "description": "The status of the order. One of \"created\", \"filled\", \"partially-filled\", \"cancelled\"."
+    },
+    "expirationTime": {
+      "type": "string",
+      "format": "date-time",
+      "description": "The time after which the order expires, if any."
+    }
+  },
+  "required": ["direction", "quantity", "totalPrice", "sequence", "status"],
+  "additionalProperties": false
+}

package/dist/npm/common/schemas/output/orderbook-orders.json

@@ -0,0 +1,58 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "orderbookOrders",
+  "type": "array",
+  "items": {
+    "description": "An order in the order book.",
+    "type": "object",
+    "properties": {
+      "specification": {
+        "$ref": "order",
+        "description": "An order specification that would create an order equivalent to the current state of this order."
+      },
+      "properties": {
+        "description": "Properties of the order not in the specification.",
+        "type": "object",
+        "properties": {
+          "maker": {
+            "$ref": "address",
+            "description": "The address of the account that submitted the order."
+          },
+          "sequence": {
+            "$ref": "sequence",
+            "description": "The account sequence number of the transaction that created this order."
+          },
+          "makerExchangeRate": {
+            "$ref": "value",
+            "description": "The exchange rate from the point of view of the account that submitted the order (also known as \"quality\")."
+          }
+        },
+        "required": ["maker", "sequence", "makerExchangeRate"],
+        "addtionalProperties": false
+      },
+      "state": {
+        "description": "The state of the order.",
+        "type": "object",
+        "properties": {
+          "fundedAmount": {
+            "$ref": "amount",
+            "description": "How much of the amount the maker would have to pay that the maker currently holds."
+          },
+          "priceOfFundedAmount": {
+            "$ref": "amount",
+            "description": "How much the `fundedAmount` would convert to through the exchange rate of this order."
+          }
+        },
+        "required": ["fundedAmount", "priceOfFundedAmount"],
+        "additionalProperties": false
+      },
+      "data": {
+        "description": "The raw order data. This may include `owner_funds`, `Flags`, and other fields.",
+        "type": "object",
+        "additionalProperties": true
+      }
+    },
+    "required": ["specification", "properties", "data"],
+    "additionalProperties": false
+  }
+}

package/dist/npm/common/schemas/output/outcome.json

@@ -0,0 +1,57 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "outcome",
+  "type": "object",
+  "description": "The outcome of the transaction (what effects it had).",
+  "properties": {
+    "result": {
+      "type": "string",
+      "description": "Result code returned by rippled. See [Transaction Results](https://xrpl.org/transaction-results.html) for a complete list."
+    },
+    "timestamp": {
+      "type": "string",
+      "format": "date-time",
+      "description": "The timestamp when the transaction was validated. (May be missing when requesting transactions in binary mode.)"
+    },
+    "fee": {
+      "$ref": "value",
+      "description": "The XRP fee that was charged for the transaction."
+    },
+    "deliveredAmount": {
+      "$ref": "amount",
+      "description": "For payment transactions, it is impossible to reliably compute the actual delivered amount from the balanceChanges due to fixed precision. If the payment is not a partial payment and the transaction succeeded, the deliveredAmount should always be considered to be the amount specified in the transaction."
+    },
+    "balanceChanges": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "array",
+        "description": "Key is the XRP Ledger address; value is an array of signed amounts representing changes of balances for that address.",
+        "items": {"$ref": "balance"}
+      }
+    },
+    "orderbookChanges": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "array",
+        "description": "Key is the maker's XRP Ledger address; value is an array of changes",
+        "items": {"$ref": "orderChange"}
+      }
+    },
+    "channelChanges": {
+      "type": "object",
+      "description": "Properties reflecting the details of the payment channel."
+    },
+    "ledgerVersion": {
+      "$ref": "ledgerVersion",
+      "description": "The ledger version that the transaction was validated in."
+    },
+    "indexInLedger": {
+      "type": "integer",
+      "minimum": 0,
+      "description": "The ordering index of the transaction in the ledger."
+    }
+  },
+  "required": ["result", "fee", "balanceChanges",
+    "orderbookChanges", "ledgerVersion", "indexInLedger"],
+  "additionalProperties": false
+}

package/dist/npm/common/schemas/output/prepare.json

@@ -0,0 +1,47 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "prepare",
+  "description": "Result of prepare function",
+  "type": "object",
+  "properties": {
+    "txJSON": {
+      "type": "string",
+      "description": "The prepared transaction in rippled JSON format."
+    },
+    "instructions": {
+      "description": "The instructions for how to execute the transaction after adding automatic defaults.",
+      "type": "object",
+      "properties": {
+        "fee": {
+          "$ref": "value",
+          "description": "The fee to pay for the transaction. See [Transaction Fees](#transaction-fees) for more information. For multi-signed transactions, this fee is multiplied by (N+1), where N is the number of signatures you plan to provide."
+        },
+        "sequence": {
+          "$ref": "sequence",
+          "description": "The initiating account's sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set."
+        },
+        "ticketSequence": {
+          "$ref": "ticket-sequence",
+          "description": "The initiating account's ticket sequence number for this transaction. `sequence` and `ticketSequence` are mutually exclusive, only one of them can be set."
+        },
+        "maxLedgerVersion": {
+          "oneOf": [
+            {"$ref": "ledgerVersion"},
+            {"type": "null"}
+          ],
+          "description": "The highest ledger version that the transaction can be included in. Set to `null` if there is no maximum. If not null, this must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'."
+        }
+      },
+      "additionalProperties": false,
+      "required": ["fee", "maxLedgerVersion"],
+      "anyOf": [
+          { "required":
+            [ "sequence" ] },
+          { "required":
+            [ "ticketSequence" ] }
+        ]
+      }
+  },
+  "additionalProperties": false,
+  "required": ["txJSON", "instructions"]
+}

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

@@ -0,0 +1,7 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "signPaymentChannelClaim",
+  "type": "string",
+  "$ref": "signature",
+  "additionalProperties": false
+}

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

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "sign",
+  "type": "object",
+  "properties": {
+    "signedTransaction": {
+      "type": "string",
+      "pattern": "^[A-F0-9]+$",
+      "description": "The signed transaction represented as an uppercase hexadecimal string."
+    },
+    "id": {
+      "$ref": "transactionHash",
+      "description": "The [Transaction ID](#transaction-id) of the signed transaction."
+    }
+  },
+  "required": ["signedTransaction", "id"],
+  "additionalProperties": false
+}

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

@@ -0,0 +1,37 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "submit",
+  "type": "object",
+  "properties": {
+    "resultCode": {
+      "type": "string",
+      "description": "Deprecated: Use `engine_result` instead."
+    },
+    "resultMessage": {
+      "type": "string",
+      "description": "Deprecated: Use `engine_result_message` instead."
+    },
+    "engine_result": {
+      "type": "string",
+      "description": "Code indicating the preliminary result of the transaction, for example `tesSUCCESS`. [List of transaction responses](https://xrpl.org/transaction-results.html)"
+    },
+    "engine_result_code": {
+      "type": "integer",
+      "description": "Numeric code indicating the preliminary result of the transaction, directly correlated to `engine_result`"
+    },
+    "engine_result_message": {
+      "type": "string",
+      "description": "Human-readable explanation of the transaction's preliminary result."
+    },
+    "tx_blob": {
+      "type": "string",
+      "description": "The complete transaction in hex string format."
+    },
+    "tx_json": {
+      "$ref": "tx-json",
+      "description": "The complete transaction in JSON format."
+    }
+  },
+  "required": ["resultCode", "resultMessage", "engine_result", "engine_result_code", "engine_result_message", "tx_blob", "tx_json"],
+  "additionalProperties": false
+}

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

@@ -0,0 +1,6 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "verifyPaymentChannelClaim",
+  "type": "boolean",
+  "additionalProperties": false
+}

package/dist/npm/common/schemas/specifications/account-delete.json

@@ -0,0 +1,30 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "accountDelete",
+  "link": "account-delete",
+  "type": "object",
+  "properties": {
+    "destination": {
+      "$ref": "address",
+      "description": "Address of an account to receive any leftover XRP after deleting the sending account. Must be a funded account in the ledger, and must not be the sending account."
+    },
+    "destinationTag": {
+      "$ref": "tag",
+      "description": "(Optional) Arbitrary destination tag that identifies a hosted recipient or other information for the recipient of the deleted account's leftover XRP."
+    },
+    "destinationXAddress": {
+      "$ref": "address",
+      "description": "X-address of an account to receive any leftover XRP after deleting the sending account. Must be a funded account in the ledger, and must not be the sending account."
+    },
+    "memos": {"$ref": "memos"}
+  },
+  "anyOf": [
+    {
+      "required": ["destination"]
+    },
+    {
+      "required": ["destinationXAddress"]
+    }
+  ],
+  "additionalProperties": false
+}

package/dist/npm/common/schemas/specifications/check-cancel.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "checkCancel",
+  "link": "check-cancel",
+  "type": "object",
+  "properties": {
+    "checkID": {
+      "$ref": "hash256",
+      "description": "The ID of the Check ledger object to cancel, as a 64-character hexadecimal string."
+    },
+    "memos": {"$ref": "memos"}
+  },
+  "required": ["checkID"],
+  "additionalProperties": false
+}

package/dist/npm/common/schemas/specifications/check-cash.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "checkCash",
+  "link": "check-cash",
+  "type": "object",
+  "properties": {
+    "checkID": {
+      "$ref": "hash256",
+      "description": "The ID of the Check ledger object to cash, as a 64-character hexadecimal string."
+    },
+    "amount": {
+      "$ref": "laxAmount",
+      "description": "Redeem the Check for exactly this amount, if possible. The currency must match that of the sendMax of the corresponding CheckCreate transaction. You must provide either this field or deliverMin."
+    },
+    "deliverMin": {
+      "$ref": "laxAmount",
+      "description": "Redeem the Check for at least this amount and for as much as possible. The currency must match that of the sendMax of the corresponding CheckCreate transaction. You must provide either this field or amount."
+    },
+    "memos": {"$ref": "memos"}
+  },
+  "required": ["checkID"],
+  "oneOf": [
+    {"required": ["amount"]},
+    {"required": ["deliverMin"]}
+  ],
+  "additionalProperties": false
+}

package/dist/npm/common/schemas/specifications/check-create.json

@@ -0,0 +1,32 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "checkCreate",
+  "link": "check-create",
+  "type": "object",
+  "properties": {
+    "destination": {
+      "$ref": "address",
+      "description": "Address of the account that can cash the check."
+    },
+    "sendMax": {
+      "$ref": "laxAmount",
+      "description": "Amount of source currency the check is allowed to debit the sender, including transfer fees on non-XRP currencies."
+    },
+    "destinationTag": {
+      "$ref": "tag",
+      "description": "Destination tag that identifies the reason for the check, or a hosted recipient to pay."
+    },
+    "expiration": {
+      "type": "string",
+      "format": "date-time",
+      "description": "Time after which the check is no longer valid."
+    },
+    "invoiceID": {
+      "$ref": "hash256",
+      "description": "256-bit hash, as a 64-character hexadecimal string, representing a specific reason or identifier for this check."
+    },
+    "memos": {"$ref": "memos"}
+  },
+  "required": ["destination", "sendMax"],
+  "additionalProperties": false
+}

package/dist/npm/common/schemas/specifications/deposit-preauth.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "depositPreauth",
+  "link": "deposit-preauth",
+  "type": "object",
+  "properties": {
+    "authorize": {
+      "$ref": "address",
+      "description": "Address of the account that can cash the check."
+    },
+    "unauthorize": {
+      "$ref": "address",
+      "description": "Address of the account that can cash the check."
+    },
+    "memos": {"$ref": "memos"}
+  },
+  "oneOf": [
+    {"required": ["authorize"]},
+    {"required": ["unauthorize"]}
+  ],
+  "additionalProperties": false
+}

package/dist/npm/common/schemas/specifications/escrow-cancellation.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "escrowCancellation",
+  "link": "escrow-cancellation",
+  "type": "object",
+  "properties": {
+    "memos": {"$ref": "memos"},
+    "owner": {
+      "$ref": "address",
+      "description": "The address of the owner of the escrow to cancel."
+    },
+    "escrowSequence": {
+      "$ref": "sequence",
+      "description": "The [account sequence number](#account-sequence-number) of the [Escrow Creation](#escrow-creation) transaction for the escrow to cancel."
+    }
+  },
+  "required": ["owner", "escrowSequence"],
+  "additionalProperties": false
+}

package/dist/npm/common/schemas/specifications/escrow-creation.json

@@ -0,0 +1,42 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "escrowCreation",
+  "link": "escrow-creation",
+  "type": "object",
+  "properties": {
+    "amount": {
+      "$ref": "value",
+      "description": "Amount of XRP for sender to escrow."
+    },
+    "destination": {
+      "$ref": "address",
+      "description": "Address to receive escrowed XRP."
+    },
+    "memos": {"$ref": "memos"},
+    "condition": {
+      "type": "string",
+      "description": "A hex value representing a [PREIMAGE-SHA-256 crypto-condition](https://tools.ietf.org/html/draft-thomas-crypto-conditions-02#section-8.1). If present, `fulfillment` is required upon execution.",
+      "pattern": "^[A-F0-9]{0,256}$"
+    },
+    "allowCancelAfter": {
+      "type": "string",
+      "format": "date-time",
+      "description": "If present, the escrow may be cancelled after this time."
+    },
+    "allowExecuteAfter": {
+      "type": "string",
+      "format": "date-time",
+      "description": "If present, the escrow can not be executed before this time."
+    },
+    "sourceTag": {
+      "$ref": "tag",
+      "description": "Source tag."
+    },
+    "destinationTag": {
+      "$ref": "tag",
+      "description": "Destination tag."
+    }
+  },
+  "required": ["amount", "destination"],
+  "additionalProperties": false
+}

package/dist/npm/common/schemas/specifications/escrow-execution.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "escrowExecution",
+  "link": "escrow-execution",
+  "type": "object",
+  "properties": {
+    "memos": {"$ref": "memos"},
+    "owner": {
+      "$ref": "address",
+      "description": "The address of the owner of the escrow to execute."
+    },
+    "escrowSequence": {
+      "$ref": "sequence",
+      "description": "The [account sequence number](#account-sequence-number) of the [Escrow Creation](#escrow-creation) transaction for the escrow to execute."
+    },
+    "condition": {
+      "type": "string",
+      "description": "A hex value representing a [PREIMAGE-SHA-256 crypto-condition](https://tools.ietf.org/html/draft-thomas-crypto-conditions-02#section-8.1). This must match the original `condition` from the escrow creation transaction.",
+      "pattern": "^[A-F0-9]{0,256}$"
+    },
+    "fulfillment": {
+      "type": "string",
+      "description": "A hex value representing the [PREIMAGE-SHA-256 crypto-condition](https://tools.ietf.org/html/draft-thomas-crypto-conditions-02#section-8.1) fulfillment for `condition`.",
+      "pattern": "^[A-F0-9]+$"
+    }
+  },
+  "required": ["owner", "escrowSequence"],
+  "additionalProperties": false
+}

package/dist/npm/common/schemas/specifications/get-payment.json

@@ -0,0 +1,39 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getPayment",
+  "description": "A specification of a payment in a response for getTransaction or getTransactions.",
+  "type": "object",
+  "properties": {
+    "source": {
+      "$ref": "sourceAdjustment",
+      "description": "The source of the funds to be sent."
+    },
+    "destination": {
+      "$ref": "destinationAddressTag",
+      "description": "The destination of the funds to be sent. Since this is a payment response, the amount is not shown here. For the amount that the transaction delivered, see `outcome.deliveredAmount`."
+    },
+    "paths": {
+      "type": "string",
+      "description": "The paths of trustlines and orders to use in executing the payment."
+    },
+    "memos": {"$ref": "memos"},
+    "invoiceID": {
+      "description": "A 256-bit hash that can be used to identify a particular payment.",
+      "$ref": "hash256"
+    },
+    "allowPartialPayment": {
+      "description": "If true, this payment can deliver less than the full amount.",
+      "type": "boolean"
+    },
+    "noDirectRipple": {
+      "description": "If true and paths are specified, the sender would like the XRP Ledger to disregard any direct paths from the source account to the destination account. This may be used to take advantage of an arbitrage opportunity or by gateways wishing to issue balances from a hot wallet to a user who has mistakenly set a trustline directly to the hot wallet.",
+      "type": "boolean"
+    },
+    "limitQuality": {
+      "description": "Only take paths where all the conversions have an input:output ratio that is equal or better than the ratio of destination.amount:source.maxAmount.",
+      "type": "boolean"
+    }
+  },
+  "required": ["source", "destination"],
+  "additionalProperties": false
+}

package/dist/npm/common/schemas/specifications/order-cancellation.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "orderCancellation",
+  "link": "order-cancellation",
+  "type": "object",
+  "properties": {
+    "orderSequence": {
+      "$ref": "sequence",
+      "description": "The [account sequence number](#account-sequence-number) of the order to cancel."
+    },
+    "memos": {"$ref": "memos"}
+  },
+  "required": ["orderSequence"],
+  "additionalProperties": false
+}