init
This commit is contained in:
nitowa
+26
@@ -0,0 +1,26 @@
|
||||
{
|
||||
"$schema": "http://json-schema.org/draft-04/schema#",
|
||||
"title": "generateAddress",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"xAddress": {
|
||||
"$ref": "xAddress",
|
||||
"description": "A randomly generated XRP Ledger address in X-address format."
|
||||
},
|
||||
"classicAddress": {
|
||||
"$ref": "classicAddress",
|
||||
"description": "A randomly generated XRP Ledger Account ID (classic address)."
|
||||
},
|
||||
"address": {
|
||||
"$ref": "classicAddress",
|
||||
"description": "Deprecated: Use `classicAddress` instead."
|
||||
},
|
||||
"secret": {
|
||||
"type": "string",
|
||||
"format": "secret",
|
||||
"description": "The secret corresponding to the address."
|
||||
}
|
||||
},
|
||||
"required": ["xAddress", "classicAddress", "address", "secret"],
|
||||
"additionalProperties": false
|
||||
}
|
||||
+18
@@ -0,0 +1,18 @@
|
||||
{
|
||||
"$schema": "http://json-schema.org/draft-04/schema#",
|
||||
"title": "generateXAddress",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"xAddress": {
|
||||
"$ref": "xAddress",
|
||||
"description": "A randomly generated XRP Ledger address in X-address format."
|
||||
},
|
||||
"secret": {
|
||||
"type": "string",
|
||||
"format": "secret",
|
||||
"description": "The secret corresponding to the address."
|
||||
}
|
||||
},
|
||||
"required": ["xAddress", "secret"],
|
||||
"additionalProperties": false
|
||||
}
|
||||
+40
@@ -0,0 +1,40 @@
|
||||
{
|
||||
"$schema": "http://json-schema.org/draft-04/schema#",
|
||||
"title": "getAccountInfo",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"sequence": {
|
||||
"$ref": "sequence",
|
||||
"description": "The next (smallest unused) sequence number for this account."
|
||||
},
|
||||
"xrpBalance": {
|
||||
"$ref": "value",
|
||||
"description": "The XRP balance owned by the account."
|
||||
},
|
||||
"ownerCount": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"description": "Number of other ledger entries (specifically, trust lines and offers) attributed to this account. This is used to calculate the total reserve required to use the account."
|
||||
},
|
||||
"previousInitiatedTransactionID": {
|
||||
"$ref": "hash256",
|
||||
"description": "Hash value representing the most recent transaction that was initiated by this account."
|
||||
},
|
||||
"previousAffectingTransactionID": {
|
||||
"$ref": "hash256",
|
||||
"description": "Hash value representing the most recent transaction that affected this account node directly. **Note:** This does not include changes to the account’s trust lines and offers."
|
||||
},
|
||||
"previousAffectingTransactionLedgerVersion": {
|
||||
"$ref": "ledgerVersion",
|
||||
"description": "The ledger version that the transaction identified by the `previousAffectingTransactionID` was validated in."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"sequence",
|
||||
"xrpBalance",
|
||||
"ownerCount",
|
||||
"previousAffectingTransactionID",
|
||||
"previousAffectingTransactionLedgerVersion"
|
||||
],
|
||||
"additionalProperties": false
|
||||
}
|
||||
+48
@@ -0,0 +1,48 @@
|
||||
{
|
||||
"$schema": "http://json-schema.org/draft-04/schema#",
|
||||
"title": "AccountObjectsResponse",
|
||||
"description": "Response format for account_objects",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"account": {
|
||||
"$ref": "address",
|
||||
"description":
|
||||
"Unique address of the account this request corresponds to."
|
||||
},
|
||||
"account_objects": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object"
|
||||
},
|
||||
"description":
|
||||
"Array of objects owned by this account. Each object is in its raw ledger format."
|
||||
},
|
||||
"ledger_hash": {
|
||||
"type": "string",
|
||||
"description":
|
||||
"(May be omitted) The identifying hash of the ledger that was used to generate this response."
|
||||
},
|
||||
"ledger_index": {
|
||||
"$ref": "ledgerVersion",
|
||||
"description":
|
||||
"(May be omitted) The sequence number of the ledger that was used to generate this response."
|
||||
},
|
||||
"ledger_current_index": {
|
||||
"$ref": "ledgerVersion",
|
||||
"description":
|
||||
"(May be omitted) The sequence number of the ledger that was used to generate this response."
|
||||
},
|
||||
"limit": {
|
||||
"type": "integer",
|
||||
"description":
|
||||
"(May be omitted) The limit that was used in this request, if any."
|
||||
},
|
||||
"validated": {
|
||||
"type": "boolean",
|
||||
"description":
|
||||
"If included and set to true, the information in this request comes from a validated ledger version. Otherwise, the information is subject to change."
|
||||
}
|
||||
},
|
||||
"required": ["account", "account_objects"],
|
||||
"additionalProperties": false
|
||||
}
|
||||
+33
@@ -0,0 +1,33 @@
|
||||
{
|
||||
"$schema": "http://json-schema.org/draft-04/schema#",
|
||||
"title": "getBalanceSheet",
|
||||
"description": "getBalanceSheet response",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"balances": {
|
||||
"type": "array",
|
||||
"items": {"$ref": "amount"},
|
||||
"description": "Amounts issued to the \"hotwallet\" accounts from the request. The keys are the accounts' addresses, and the values are arrays of currency amounts they hold. The issuer (omitted from the currency amounts) is the account from the request."
|
||||
},
|
||||
"assets": {
|
||||
"type": "array",
|
||||
"items": {"$ref": "amount"},
|
||||
"description": "Total amounts held that are issued by others. For the recommended gateway configuration, there should be none."
|
||||
},
|
||||
"obligations": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"required": ["currency", "value"],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"currency": {"$ref": "currency"},
|
||||
"value": {"$ref": "value"}
|
||||
},
|
||||
"description": "An amount that is owed."
|
||||
},
|
||||
"description": "Total amounts issued to accounts that are not hot wallets, as a map of currencies to the total value issued."
|
||||
}
|
||||
},
|
||||
"additionalProperties": false
|
||||
}
|
||||
+6
@@ -0,0 +1,6 @@
|
||||
{
|
||||
"$schema": "http://json-schema.org/draft-04/schema#",
|
||||
"title": "getBalances",
|
||||
"type": "array",
|
||||
"items": {"$ref": "balance"}
|
||||
}
|
||||
+90
@@ -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
|
||||
}
|
||||
+17
@@ -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
|
||||
}
|
||||
+36
@@ -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
|
||||
}
|
||||
}
|
||||
+24
@@ -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
|
||||
}
|
||||
}
|
||||
+67
@@ -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
|
||||
}
|
||||
+117
@@ -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
|
||||
}
|
||||
+8
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"$schema": "http://json-schema.org/draft-04/schema#",
|
||||
"title": "getSettings",
|
||||
"$ref": "settingsPlusMemos",
|
||||
"not": {
|
||||
"required": ["memos"]
|
||||
}
|
||||
}
|
||||
+237
@@ -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"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
+8
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"$schema": "http://json-schema.org/draft-04/schema#",
|
||||
"title": "getTransactions",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "getTransaction"
|
||||
}
|
||||
}
|
||||
+49
@@ -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
|
||||
}
|
||||
}
|
||||
+46
@@ -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"]
|
||||
}
|
||||
+40
@@ -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
|
||||
}
|
||||
+58
@@ -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
|
||||
}
|
||||
}
|
||||
+57
@@ -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
|
||||
}
|
||||
+47
@@ -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"]
|
||||
}
|
||||
Generated
Vendored
+7
@@ -0,0 +1,7 @@
|
||||
{
|
||||
"$schema": "http://json-schema.org/draft-04/schema#",
|
||||
"title": "signPaymentChannelClaim",
|
||||
"type": "string",
|
||||
"$ref": "signature",
|
||||
"additionalProperties": false
|
||||
}
|
||||
+18
@@ -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
|
||||
}
|
||||
+37
@@ -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
|
||||
}
|
||||
Generated
Vendored
+6
@@ -0,0 +1,6 @@
|
||||
{
|
||||
"$schema": "http://json-schema.org/draft-04/schema#",
|
||||
"title": "verifyPaymentChannelClaim",
|
||||
"type": "boolean",
|
||||
"additionalProperties": false
|
||||
}
|
||||
Reference in New Issue
Block a user