rippel-lib 1.10.1

package/dist/npm/common/schemas/input/generate-address.json

@@ -0,0 +1,37 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "generateAddressParameters",
+  "type": "object",
+  "properties": {
+    "options": {
+      "type": "object",
+      "description": "Options to control how the address and secret are generated.",
+      "properties": {
+        "entropy": {
+          "type": "array",
+          "items": {
+            "type": "integer",
+            "minimum": 0,
+            "maximum": 255
+          },
+          "description": "The entropy to use to generate the seed. Must be an array of length 16 with values from 0-255 (16 bytes of entropy)"
+        },
+        "algorithm": {
+          "type": "string",
+          "enum": ["ecdsa-secp256k1", "ed25519"],
+          "description": "The digital signature algorithm to generate an address for. Can be `ecdsa-secp256k1` (default) or `ed25519`."
+        },
+        "test": {
+          "type": "boolean",
+          "description": "Specifies whether the address is intended for use on a test network such as Testnet or Devnet. If `true`, the address should only be used for testing, and starts with `T`. If `false`, the address should only be used on Mainnet, and starts with `X`."
+        },
+        "includeClassicAddress": {
+          "type": "boolean",
+          "description": "If `true`, also return the classic address."
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false
+}

package/dist/npm/common/schemas/input/generate-x-address.json

@@ -0,0 +1,37 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "generateXAddressParameters",
+  "type": "object",
+  "properties": {
+    "options": {
+      "type": "object",
+      "description": "Options to control how the address and secret are generated.",
+      "properties": {
+        "entropy": {
+          "type": "array",
+          "items": {
+            "type": "integer",
+            "minimum": 0,
+            "maximum": 255
+          },
+          "description": "The entropy to use to generate the seed. Must be an array of length 16 with values from 0-255 (16 bytes of entropy)"
+        },
+        "algorithm": {
+          "type": "string",
+          "enum": ["ecdsa-secp256k1", "ed25519"],
+          "description": "The digital signature algorithm to generate an address for. Can be `ecdsa-secp256k1` (default) or `ed25519`."
+        },
+        "test": {
+          "type": "boolean",
+          "description": "Specifies whether the address is intended for use on a test network such as Testnet or Devnet. If `true`, the address should only be used for testing, and starts with `T`. If `false`, the address should only be used on Mainnet, and starts with `X`."
+        },
+        "includeClassicAddress": {
+          "type": "boolean",
+          "description": "Specifies whether the classic address should also be included in the returned payload."
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false
+}

package/dist/npm/common/schemas/input/get-account-info.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getAccountInfoParameters",
+  "description": "Parameters for getAccountInfo",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The address of the account to get the account info of."
+    },
+    "options": {
+      "description": "Options that affect what to return.",
+      "properties": {
+        "ledgerVersion": {
+          "$ref": "ledgerVersion",
+          "description": "Get the account info as of this historical ledger version."
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "required": ["address"],
+  "additionalProperties": false
+}

package/dist/npm/common/schemas/input/get-account-objects.json

@@ -0,0 +1,56 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getAccountObjectsOptions",
+  "description": "Request options for getAccountObjects",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The address of the account to get the account objects of."
+    },
+    "options": {
+      "description": "Options that affect what to return.",
+      "properties": {
+        "type": {
+          "type": "string",
+          "enum": [
+            "check",
+            "escrow",
+            "offer",
+            "payment_channel",
+            "signer_list",
+            "state"
+          ],
+          "description":
+            "(Optional) Filter results to include only this type of ledger object. The valid types are: `check`, `escrow`, `offer`, `payment_channel`, `signer_list`, and `state` (trust line)."
+        },
+        "ledgerHash": {
+          "type": "string",
+          "description":
+            "(Optional) A 20-byte hex string for the ledger version to use."
+        },
+        "ledgerIndex": {
+          "oneOf": [
+            {
+              "$ref": "ledgerVersion"
+            },
+            {
+              "type": "string"
+            }
+          ],
+          "description":
+            "(Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically."
+        },
+        "limit": {
+          "type": "integer",
+          "minimum": 1,
+          "description":
+            "(Optional) The maximum number of objects to include in the results."
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "required": ["address"],
+  "additionalProperties": false
+}

package/dist/npm/common/schemas/input/get-balance-sheet.json

@@ -0,0 +1,30 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getBalanceSheetParameters",
+  "description": "Parameters for getBalanceSheet",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The XRP Ledger address of the account to get the balance sheet of."
+    },
+    "options": {
+      "properties": {
+        "excludeAddresses": {
+          "type": "array",
+          "items": {"$ref": "address"},
+          "uniqueItems": true,
+          "description": "Addresses to exclude from the balance totals."
+        },
+        "ledgerVersion": {
+          "$ref": "ledgerVersion",
+          "description": "Get the balance sheet as of this historical ledger version."
+        }
+      },
+      "description": "Options to determine how the balances are calculated.",
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false,
+  "required": ["address"]
+}

package/dist/npm/common/schemas/input/get-balances.json

@@ -0,0 +1,37 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getBalancesParameters",
+  "description": "Parameters for getBalances",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The address of the account to get balances for."
+    },
+    "options": {
+      "description": "Options to filter and determine which balances to return.",
+      "properties": {
+        "counterparty": {
+          "$ref": "address",
+          "description": "Only return balances with this counterparty."
+        },
+        "currency": {
+          "$ref": "currency",
+          "description": "Only return balances for this currency."
+        },
+        "limit": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "Return at most this many balances."
+        },
+        "ledgerVersion": {
+          "$ref": "ledgerVersion",
+          "description": "Return balances as they were in this historical ledger version."
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false,
+  "required": ["address"]
+}

package/dist/npm/common/schemas/input/get-fee.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getFeeParameters",
+  "description": "Parameters for getFee",
+  "type": "object",
+  "properties": {
+    "cushion": {
+      "type": "number",
+      "description": "The fee is the product of the base fee, the `load_factor`, and this cushion. Default is provided by the `RippleAPI` constructor's `feeCushion`."
+    }
+  },
+  "additionalProperties": false
+}

package/dist/npm/common/schemas/input/get-ledger.json

@@ -0,0 +1,35 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getLedgerParameters",
+  "description": "Parameters for getLedger",
+  "type": "object",
+  "properties": {
+    "options": {
+      "description": "Options affecting what ledger and how much data to return.",
+      "properties": {
+        "ledgerHash": {
+          "type": "string",
+          "description": "Get ledger data for this historical ledger hash."
+        },
+        "ledgerVersion": {
+          "$ref": "ledgerVersion",
+          "description": "Get ledger data for this historical ledger version."
+        },
+        "includeAllData": {
+          "type": "boolean",
+          "description": "Include the details of the transactions or state information if `includeTransactions` or `includeState` is set."
+        },
+        "includeTransactions": {
+          "type": "boolean",
+          "description": "Return an array of transactions in this ledger. By default, provides the identifying hashes for each transaction. If `includeAllData` is true, include the entire transaction JSON for each transaction instead."
+        },
+        "includeState": {
+          "type": "boolean",
+          "description": "Return an array of state data in this ledger. By default, provides the identifying hashes of state data. If `includeAllData` is true, return the state data in JSON form instead. **Admin required:** This is a very large amount of data."
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false
+}

package/dist/npm/common/schemas/input/get-orderbook.json

@@ -0,0 +1,33 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getOrderbookParameters",
+  "description": "Parameters for getOrderbook",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "Address of an account to use as point-of-view. (This affects which unfunded offers are returned.)"
+    },
+    "orderbook": {
+      "$ref": "orderbook",
+      "description": "The order book to get."
+    },
+    "options": {
+      "description": "Options to determine what to return.",
+      "properties": {
+        "limit": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "Return at most this many orders from the order book."
+        },
+        "ledgerVersion": {
+          "$ref": "ledgerVersion",
+          "description": "Return the order book as of this historical ledger version."
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "required": ["address", "orderbook"],
+  "additionalProperties": false
+}

package/dist/npm/common/schemas/input/get-orders.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getOrdersParameters",
+  "description": "Parameters for getOrders",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The XRP Ledger address of the account to get open orders for."
+    },
+    "options": {
+      "description": "Options that determine what orders to return.",
+      "properties": {
+        "limit": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "Return at most this many orders."
+        },
+        "ledgerVersion": {
+          "$ref": "ledgerVersion",
+          "description": "Return orders as of this historical ledger version."
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "required": ["address"],
+  "additionalProperties": false
+}

package/dist/npm/common/schemas/input/get-paths.json

@@ -0,0 +1,69 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getPathsParameters",
+  "type": "object",
+  "properties": {
+    "pathfind": {
+      "description": "Specification of a pathfind request.",
+      "properties": {
+        "source": {
+          "description": "Properties of the source of funds.",
+          "type": "object",
+          "properties": {
+            "address": {
+              "$ref": "address",
+              "description": "The XRP Ledger address of the planned sender."
+            },
+            "amount": {
+              "$ref": "laxAmount",
+              "description": "The amount of funds to send."
+            },
+            "currencies": {
+              "description": "An array of currencies (with optional counterparty) that may be used in the payment paths.",
+              "type": "array",
+              "items": {
+                "description": "A currency with optional counterparty.",
+                "type": "object",
+                "properties": {
+                  "currency": {"$ref": "currency"},
+                  "counterparty": {
+                    "$ref": "address",
+                    "description": "The counterparty for the currency; if omitted any counterparty may be used."
+                  }
+                },
+                "required": ["currency"],
+                "additionalProperties": false
+              },
+              "uniqueItems": true
+            }
+          },
+          "not": {
+            "required": ["amount", "currencies"]
+          },
+          "additionalProperties": false,
+          "required": ["address"]
+        },
+        "destination": {
+          "description": "Properties of the destination of funds.",
+          "type": "object",
+          "properties": {
+            "address": {
+              "$ref": "address",
+              "description": "An address representing the destination of the transaction."
+            },
+            "amount": {
+              "$ref": "laxLaxAmount",
+              "description": "The amount to be received by the receiver (`value` may be ommitted if a source amount is specified)."
+            }
+          },
+          "required": ["address", "amount"],
+          "additionalProperties": false
+        }
+      },
+      "required": ["source", "destination"],
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false,
+  "required": ["pathfind"]
+}

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

@@ -0,0 +1,14 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getPaymentChannelParameters",
+  "description": "Parameters for getPaymentChannel",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "hash256",
+      "description": "256-bit hexadecimal channel identifier."
+    }
+  },
+  "additionalProperties": false,
+  "required": ["id"]
+}

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

@@ -0,0 +1,24 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getSettingsParameters",
+  "description": "Parameters for getSettings",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The address of the account to get the settings of."
+    },
+    "options": {
+      "description": "Options that affect what to return.",
+      "properties": {
+        "ledgerVersion": {
+          "$ref": "ledgerVersion",
+          "description": "Get the settings as of this historical ledger version."
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "required": ["address"],
+  "additionalProperties": false
+}

package/dist/npm/common/schemas/input/get-transaction.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getTransactionParameters",
+  "description": "Parameters for getTransaction",
+  "type": "object",
+  "properties": {
+    "id": {"$ref": "transactionHash"},
+    "options": {
+      "description": "Options to limit the ledger versions to search or include raw transaction data.",
+      "properties": {
+        "minLedgerVersion": {
+          "$ref": "ledgerVersion",
+          "description": "The lowest ledger version to search. This must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'."
+        },
+        "maxLedgerVersion": {
+          "$ref": "ledgerVersion",
+          "description": "The highest ledger version to search. This must be an integer greater than 0, or one of the following strings: 'validated', 'closed', 'current'."
+        },
+        "includeRawTransaction": {
+          "description": "Include raw transaction data. For advanced users; exercise caution when interpreting this data."
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false,
+  "required": ["id"]
+}

package/dist/npm/common/schemas/input/get-transactions.json

@@ -0,0 +1,71 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getTransactionsParameters",
+  "description": "Parameters for getTransactions",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The address of the account to get transactions for."
+    },
+    "options": {
+      "description": "Options to filter the resulting transactions.",
+      "properties": {
+        "start": {
+          "$ref": "hash256",
+          "description": "If specified, start the results from this transaction. You cannot use `start` with `minLedgerVersion` or `maxLedgerVersion`. When `start` is specified, these ledger versions are determined internally."
+        },
+        "limit": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "If specified, return at most this many transactions."
+        },
+        "minLedgerVersion": {
+          "$ref": "ledgerVersion",
+          "description": "Return only transactions in this ledger version or higher."
+        },
+        "maxLedgerVersion": {
+          "$ref": "ledgerVersion",
+          "description": "Return only transactions in this ledger version or lower."
+        },
+        "earliestFirst": {
+          "type": "boolean",
+          "description": "If true, sort transactions so that the earliest ones come first. By default, the newest transactions come first."
+        },
+        "excludeFailures": {
+          "type": "boolean",
+          "description": "If true, the result omits transactions that did not succeed."
+        },
+        "initiated": {
+          "type": "boolean",
+          "description": "If true, return only transactions initiated by the account specified by `address`. If false, return only transactions not initiated by the account specified by `address`."
+        },
+        "counterparty": {
+          "$ref": "address",
+          "description": "If provided, only return transactions with this account as a counterparty to the transaction."
+        },
+        "types": {
+          "type": "array",
+          "items": {"$ref": "transactionType"},
+          "description": "Only return transactions of the specified [Transaction Types](#transaction-types)."
+        },
+        "includeRawTransactions": {
+          "description": "Include raw transaction data. For advanced users; exercise caution when interpreting this data. "
+        },
+        "binary": {
+          "type": "boolean",
+          "description": "If true, return transactions in binary format rather than JSON."
+        }
+      },
+      "additionalProperties": false,
+      "not": {
+        "anyOf": [
+          {"required": ["start", "minLedgerVersion"]},
+          {"required": ["start", "maxLedgerVersion"]}
+        ]
+      }
+    }
+  },
+  "additionalProperties": false,
+  "required": ["address"]
+}

package/dist/npm/common/schemas/input/get-trustlines.json

@@ -0,0 +1,37 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getTrustlinesParameters",
+  "description": "Parameters for getTrustlines",
+  "type": "object",
+  "properties": {
+    "address": {
+      "$ref": "address",
+      "description": "The address of the account to get trustlines for."
+    },
+    "options": {
+      "description": "Options to filter and determine which trustlines to return.",
+      "properties": {
+        "counterparty": {
+          "$ref": "address",
+          "description": "Only return trustlines with this counterparty."
+        },
+        "currency": {
+          "$ref": "currency",
+          "description": "Only return trustlines for this currency."
+        },
+        "limit": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "Return at most this many trustlines."
+        },
+        "ledgerVersion": {
+          "$ref": "ledgerVersion",
+          "description": "Return trustlines as they were in this historical ledger version."
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false,
+  "required": ["address"]
+}

package/dist/npm/common/schemas/input/prepare-check-cancel.json

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

package/dist/npm/common/schemas/input/prepare-check-cash.json

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

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

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