riplle-lib 1.10.1

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

@@ -0,0 +1,90 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getLedger",
+  "type": "object",
+  "properties": {
+    "stateHash": {
+      "$ref": "hash256",
+      "description": "Hash of all state information in this ledger."
+    },
+    "closeTime": {
+      "type": "string",
+      "format": "date-time",
+      "description": "The approximate time when this ledger was closed. This number is rounded based on the `closeTimeResolution`. If it would have been rounded to the same time as a previous ledger, the close time is recorded as 1 second later instead."
+    },
+    "closeTimeResolution": {
+      "type": "integer",
+      "minimum": 1,
+      "description": "A number of seconds, indicating how much the `closeTime` could be rounded. Ledger close times are approximate so that small differences in servers clocks don't hinder consensus."
+    },
+    "closeFlags": {
+      "type": "integer",
+      "minimum": 0,
+      "description": "A bit-map of flags relating to the closing of this ledger. Currently, the ledger has only one flag defined for `closeFlags`: **sLCF_NoConsensusTime** (value 1). If this flag is enabled, it means that validators disagreed on the correct close time for the ledger, but built otherwise the same ledger, so they declared consensus while \"agreeing to disagree\" on the close time. In this case, the consensus ledger contains a `closeTime` value that is 1 second after that of the previous ledger. (In this case, there is no official close time, but the actual real-world close time is probably 3-6 seconds later than the specified `closeTime`.)"
+    },
+    "ledgerHash": {
+      "$ref": "hash256",
+      "description": "Unique identifying hash of the entire ledger."
+    },
+    "ledgerVersion": {
+      "$ref": "ledgerVersion",
+      "description": "The ledger version of this ledger."
+    },
+    "parentLedgerHash": {
+      "$ref": "hash256",
+      "description": "Unique identifying hash of the ledger that came immediately before this one."
+    },
+    "parentCloseTime": {
+      "type": "string",
+      "format": "date-time",
+      "description": "The previous ledger's recorded close time."
+    },
+    "totalDrops": {
+      "$ref": "value",
+      "description": "Total number of drops (1/1,000,000th of an XRP) in the network, as a quoted integer. (This decreases as transaction fees cause XRP to be destroyed.)"
+    },
+    "transactionHash": {
+      "$ref": "hash256",
+      "description": "Hash of the transaction information included in this ledger."
+    },
+    "transactions": {
+      "description": "Array of all transactions that were validated in this ledger. Transactions are represented in the same format as the return value of [getTransaction](#gettransaction).",
+      "type": "array",
+      "items": {
+        "$ref": "getTransaction",
+        "description": "A transaction in the same format as the return value of [getTransaction](#gettransaction)."
+      }
+    },
+    "transactionHashes": {
+      "description": "An array of hashes of all transactions that were validated in this ledger.",
+      "type": "array",
+      "items": {
+        "$ref": "transactionHash"
+      }
+    },
+    "rawState": {
+      "type": "string",
+      "description": "A JSON string containing all state data for this ledger in rippled JSON format."
+    },
+    "stateHashes": {
+      "description": "An array of hashes of all state data in this ledger.",
+      "type": "array",
+      "items": {
+        "$ref": "hash256"
+      }
+    }
+  },
+  "required": [
+    "stateHash",
+    "closeTime",
+    "closeTimeResolution",
+    "closeFlags",
+    "ledgerHash",
+    "ledgerVersion",
+    "parentLedgerHash",
+    "parentCloseTime",
+    "totalDrops",
+    "transactionHash"
+  ],
+  "additionalProperties": false
+}

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

@@ -0,0 +1,17 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getOrderbook",
+  "type": "object",
+  "properties": {
+    "bids": {
+      "$ref": "orderbookOrders",
+      "description": "The buy orders in the order book."
+    },
+    "asks": {
+      "$ref": "orderbookOrders",
+      "description": "The sell orders in the order book."
+    }
+  },
+  "required": ["bids", "asks"],
+  "additionalProperties": false
+}

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

@@ -0,0 +1,36 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getOrders",
+  "type": "array",
+  "items": {
+    "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
+      }
+    },
+    "required": ["specification", "properties"],
+    "additionalProperties": false
+  }
+}

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

@@ -0,0 +1,24 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getPaths",
+  "type": "array",
+  "items": {
+    "type": "object",
+    "properties": {
+      "source": {
+        "$ref": "sourceAdjustment",
+        "description": "Properties of the source of the payment."
+      },
+      "destination": {
+        "$ref": "destinationAdjustment",
+        "description": "Properties of the destination of the payment."
+      },
+      "paths": {
+        "type": "string",
+        "description": "The paths of trustlines and orders to use in executing the payment."
+      }
+    },
+    "required": ["source", "destination", "paths"],
+    "additionalProperties": false
+  }
+}

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

@@ -0,0 +1,67 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getPaymentChannel",
+  "type": "object",
+  "properties": {
+    "account": {
+      "$ref": "address",
+      "description": "Address that created the payment channel."
+    },
+    "destination": {
+      "$ref": "address",
+      "description": "Address to receive XRP claims against this channel."
+    },
+    "amount": {
+      "$ref": "value",
+      "description": "The total amount of XRP funded in this channel."
+    },
+    "balance": {
+      "$ref": "value",
+      "description": "The total amount of XRP delivered by this channel."
+    },
+    "settleDelay": {
+      "type": "number",
+      "description": "Amount of seconds the source address must wait before closing the channel if it has unclaimed XRP."
+    },
+    "expiration": {
+      "type": "string",
+      "format": "date-time",
+      "description": "Time when this channel expires."
+    },
+    "publicKey": {
+      "$ref": "publicKey",
+      "description": "Public key of the key pair the source uses to sign claims against this channel."
+    },
+    "cancelAfter": {
+      "type": "string",
+      "format": "date-time",
+      "description": "Time when this channel expires as specified at creation."
+    },
+    "sourceTag": {
+      "$ref": "tag",
+      "description": "Source tag."
+    },
+    "destinationTag": {
+      "$ref": "tag",
+      "description": "Destination tag."
+    },
+    "previousAffectingTransactionID": {
+      "$ref": "hash256",
+      "description": "Hash value representing the most recent transaction that affected this payment channel."
+    },
+    "previousAffectingTransactionLedgerVersion": {
+      "$ref": "ledgerVersion",
+      "description": "The ledger version that the transaction identified by the `previousAffectingTransactionID` was validated in."
+    }
+  },
+  "required": [
+    "account",
+    "destination",
+    "amount",
+    "balance",
+    "settleDelay",
+    "previousAffectingTransactionID",
+    "previousAffectingTransactionLedgerVersion"
+  ],
+  "additionalProperties": false
+}

package/dist/npm/common/schemas/output/get-server-info.json

@@ -0,0 +1,117 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getServerInfo",
+  "type": "object",
+  "properties": {
+    "buildVersion": {
+      "type": "string",
+      "description": "The version number of the running rippled version."
+    },
+    "completeLedgers": {
+      "type": "string",
+      "pattern": "[0-9,-]+",
+      "description": "Range expression indicating the sequence numbers of the ledger versions the local rippled has in its database. It is possible to be a disjoint sequence, e.g. “2500-5000,32570-7695432”."
+    },
+    "hostID": {
+      "type": "string",
+      "description": "On an admin request, returns the hostname of the server running the rippled instance; otherwise, returns a unique four letter word."
+    },
+    "ioLatencyMs": {
+      "type": "number",
+      "description": "Amount of time spent waiting for I/O operations, in milliseconds. If this number is not very, very low, then the rippled server is probably having serious load issues."
+    },
+    "load": {
+      "type": "object",
+      "description": "*(Admin only)* Detailed information about the current load state of the server.",
+      "properties": {
+        "jobTypes": {
+          "type": "array",
+          "description": "*(Admin only)* Information about the rate of different types of jobs the server is doing and how much time it spends on each.",
+          "items": {"type": "object"}
+        },
+        "threads": {
+          "type": "number",
+          "description": "*(Admin only)* The number of threads in the server’s main job pool, performing various operations."
+        }
+      },
+      "required": ["jobTypes", "threads"]
+    },
+    "lastClose": {
+      "type": "object",
+      "description": "Information about the last time the server closed a ledger.",
+      "properties": {
+        "convergeTimeS": {
+          "type": "number",
+          "description": "The time it took to reach a consensus for the last ledger closing, in seconds."
+        },
+        "proposers": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Number of trusted validators participating in the ledger closing."}
+      },
+      "required": ["convergeTimeS", "proposers"]
+    },
+    "loadFactor": {
+      "type": "number",
+      "description": "The load factor the server is currently enforcing, as a multiplier on the base transaction fee. The load factor is determined by the highest of the individual server’s load factor, cluster’s load factor, and the overall network’s load factor."
+    },
+    "peers": {
+      "type": "integer",
+      "minimum": 0,
+      "description": "How many other rippled servers the node is currently connected to."
+    },
+    "pubkeyNode": {
+      "type": "string",
+      "description": "Public key used to verify this node for internal communications; this key is automatically generated by the server the first time it starts up."
+    },
+    "pubkeyValidator": {
+      "type": "string",
+      "description": "*(Admin only)* Public key used by this node to sign ledger validations."
+    },
+    "serverState": {
+      "type": "string",
+      "description": "A string indicating to what extent the server is participating in the network. See [Possible Server States](https://xrpl.org/rippled-server-states.html) for more details.",
+      "enum": ["disconnected", "connected", "syncing", "tracking", "full", "validating", "proposing"]
+    },
+    "validatedLedger": {
+      "type": "object",
+      "description": "Information about the fully-validated ledger with the highest sequence number (the most recent).",
+      "properties": {
+        "age": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "The time since the ledger was closed, in seconds."
+        },
+        "baseFeeXRP": {
+          "$ref": "value",
+          "description": "Base fee, in XRP. This may be represented in scientific notation such as 1e-05 for 0.00005."
+        },
+        "hash": {
+          "$ref": "hash256",
+          "description": "Unique hash for the ledger, as an uppercase hexadecimal string."
+        },
+        "reserveBaseXRP": {
+          "$ref": "value",
+          "description": "Minimum amount of XRP necessary for every account to keep in reserve."
+        },
+        "reserveIncrementXRP": {
+          "$ref": "value",
+          "description": "Amount of XRP added to the account reserve for each object an account owns in the ledger."
+        },
+        "ledgerVersion": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Identifying ledger index of this ledger version."
+        }
+      },
+      "additionalProperties": false,
+      "required": ["age", "baseFeeXRP", "hash", "reserveBaseXRP", "reserveIncrementXRP", "ledgerVersion"]
+    },
+    "validationQuorum": {
+      "type": "number",
+      "description": "Minimum number of trusted validations required to validate a ledger version. Some circumstances may cause the server to require more validations."
+    }
+  },
+  "required": ["buildVersion", "completeLedgers", "hostID", "ioLatencyMs", "lastClose", "loadFactor", "peers", "pubkeyNode", "serverState", "validatedLedger", "validationQuorum"],
+  "additionalProperties": false
+}

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

@@ -0,0 +1,8 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getSettings",
+  "$ref": "settingsPlusMemos",
+  "not": {
+    "required": ["memos"]
+  }
+}

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

@@ -0,0 +1,237 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getTransaction",
+  "description": "getTransaction response",
+  "link": "gettransaction",
+  "properties": {
+    "type": {
+      "$ref": "transactionType"
+    },
+    "specification": {
+      "description": "A specification that would produce the same outcome as this transaction. *Exception:* For payment transactions, this omits the `destination.amount` field, to prevent misunderstanding. The structure of the specification depends on the value of the `type` field (see [Transaction Types](#transaction-types) for details). *Note:* This is **not** necessarily the same as the original specification."
+    },
+    "outcome": {
+      "$ref": "outcome",
+      "description": "The outcome of the transaction (what effects it had)."
+    },
+    "id": {
+      "$ref": "transactionHash",
+      "description": "A hash of the transaction that can be used to identify it."
+    },
+    "address": {
+      "$ref": "address",
+      "description": "The address of the account that initiated the transaction."
+    },
+    "sequence": {
+      "$ref": "sequence",
+      "description": "The account sequence number of the transaction for the account that initiated it."
+    },
+    "rawTransaction": {
+      "description": "The raw transaction data as a JSON string. For advanced users only; exercise caution when interpreting this data.",
+      "type": "string"
+    }
+  },
+  "required": [
+    "id",
+    "address",
+    "sequence",
+    "type",
+    "specification",
+    "outcome"
+  ],
+  "additionalProperties": false,
+  "oneOf": [
+    {
+      "properties": {
+        "type": {
+          "enum": [
+            "payment"
+          ]
+        },
+        "specification": {
+          "$ref": "getPayment"
+        }
+      }
+    },
+    {
+      "properties": {
+        "type": {
+          "enum": [
+            "order"
+          ]
+        },
+        "specification": {
+          "$ref": "order"
+        }
+      }
+    },
+    {
+      "properties": {
+        "type": {
+          "enum": [
+            "orderCancellation"
+          ]
+        },
+        "specification": {
+          "$ref": "orderCancellation"
+        }
+      }
+    },
+    {
+      "properties": {
+        "type": {
+          "enum": [
+            "trustline"
+          ]
+        },
+        "specification": {
+          "$ref": "trustline"
+        }
+      }
+    },
+    {
+      "properties": {
+        "type": {
+          "enum": [
+            "settings"
+          ]
+        },
+        "specification": {
+          "$ref": "getSettings"
+        }
+      }
+    },
+    {
+      "properties": {
+        "type": {
+          "enum": [
+            "checkCreate"
+          ]
+        },
+        "specification": {
+          "$ref": "checkCreate"
+        }
+      }
+    },
+    {
+      "properties": {
+        "type": {
+          "enum": [
+            "checkCancel"
+          ]
+        },
+        "specification": {
+          "$ref": "checkCancel"
+        }
+      }
+    },
+    {
+      "properties": {
+        "type": {
+          "enum": [
+            "checkCash"
+          ]
+        },
+        "specification": {
+          "$ref": "checkCash"
+        }
+      }
+    },
+    {
+      "properties": {
+        "type": {
+          "enum": [
+            "escrowCreation"
+          ]
+        },
+        "specification": {
+          "$ref": "escrowCreation"
+        }
+      }
+    },
+    {
+      "properties": {
+        "type": {
+          "enum": [
+            "escrowCancellation"
+          ]
+        },
+        "specification": {
+          "$ref": "escrowCancellation"
+        }
+      }
+    },
+    {
+      "properties": {
+        "type": {
+          "enum": [
+            "escrowExecution"
+          ]
+        },
+        "specification": {
+          "$ref": "escrowExecution"
+        }
+      }
+    },
+    {
+      "properties": {
+        "type": {
+          "enum": [
+            "paymentChannelCreate"
+          ]
+        },
+        "specification": {
+          "$ref": "paymentChannelCreate"
+        }
+      }
+    },
+    {
+      "properties": {
+        "type": {
+          "enum": [
+            "paymentChannelFund"
+          ]
+        },
+        "specification": {
+          "$ref": "paymentChannelFund"
+        }
+      }
+    },
+    {
+      "properties": {
+        "type": {
+          "enum": [
+            "paymentChannelClaim"
+          ]
+        },
+        "specification": {
+          "$ref": "paymentChannelClaim"
+        }
+      }
+    },
+    {
+      "properties": {
+        "type": {
+          "enum": [
+            "depositPreauth"
+          ]
+        },
+        "specification": {
+          "$ref": "depositPreauth"
+        }
+      }
+    },
+    {
+      "properties": {
+        "type": {
+          "enum": [
+            "accountDelete"
+          ]
+        },
+        "specification": {
+          "$ref": "accountDelete"
+        }
+      }
+    }
+  ]
+}

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

@@ -0,0 +1,8 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getTransactions",
+  "type": "array",
+  "items": {
+    "$ref": "getTransaction"
+  }
+}

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

@@ -0,0 +1,49 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "getTrustlines",
+  "type": "array",
+  "items": {
+    "properties": {
+      "specification": {
+        "$ref": "trustline",
+        "description": "A trust line specification that would produce this trust line in its current state."
+      },
+      "counterparty": {
+        "properties": {
+          "limit": {
+            "$ref": "value",
+            "description": "The maximum amount that the counterparty can be owed through the trust line."
+          },
+          "ripplingDisabled": {
+            "type": "boolean",
+            "description": "If true, payments cannot ripple through this trustline."
+          },
+          "frozen": {
+            "type": "boolean",
+            "description": "If true, the trust line is frozen, which means that funds can only be sent directly to the counterparty."
+          },
+          "authorized": {
+            "type": "boolean",
+            "description": "If true, the counterparty authorizes this party to hold issuances from the counterparty."
+          }
+        },
+        "description": "Properties of the trustline from the perspective of the counterparty.",
+        "required": ["limit"],
+        "additionalProperties": false
+      },
+      "state": {
+        "properties": {
+          "balance": {
+            "$ref": "signedValue",
+            "description": "The balance on the trust line, representing which party owes the other and by how much."
+          }
+        },
+        "description": "Non-settings details of the trust line's state.",
+        "required": ["balance"],
+        "additionalProperties": false
+      }
+    },
+    "required": ["specification", "counterparty", "state"],
+    "additionalProperties": false
+  }
+}