Introduces Tickets as a way to reserve a transaction sequence number for later execution. Creates the Ticket ledger node type and the transaction types TicketCreate and TicketCancel.
This amendment is still in development. -
+ diff --git a/content/reference-rippled.md b/content/reference-rippled.md index 485eac55af..5900b615ef 100755 --- a/content/reference-rippled.md +++ b/content/reference-rippled.md @@ -224,8 +224,9 @@ The fields of a successful response include: | Field | Type | Description | |-------|------|-------------| | `id` | (Varies) | (WebSocket only) ID provided in the request that prompted this response | -| `status` (WebSocket)status (WebSocket) <br> result.status (JSON-RPC and Commandline)status"success" if the request was successful. In the WebSocket API responses, this is included at the top level; in JSON-RPC and Commandline responses, this is included as a sub-field of the "result" object.success indicates the request was successfully received and understood by the server.result.statussuccess indicates the request was successfully received and understood by the server.type"response", which indicates a successful response to a command. Asynchronous notifications use a different value such as "ledgerClosed" or "transaction".response indicates a successful response to a command. Asynchronous notifications use a different value such as ledgerClosed or transaction.resulttrue, and the FeeEscalation amendment is enabled, also returns stats about queued transactions associated with this account. Can only be used when querying for the data from the current open ledger. (New in [rippled 0.33.0][])true, and the MultiSign amendment is enabled, also returns any SignerList objects associated with this account. (New in [rippled 0.31.0][])The following fields are deprecated and should not be provided: ident, ledger.
An example of a successful response:
-{
- "id": 5,
- "status": "success",
- "type": "response",
- "result": {
- "account_data": {
- "Account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
- "Balance": "27389517749",
- "Flags": 0,
- "LedgerEntryType": "AccountRoot",
- "OwnerCount": 18,
- "PreviousTxnID": "2F804E1A00DBCBDAFBDB7D001409F79FE196785EB68FBA463E5924002BE4DEE9",
- "PreviousTxnLgrSeq": 6405716,
- "Sequence": 1400,
- "index": "4F83A2CF7E70F77F79A307E6A472BFC2585B806A70833CCD1C26105BAE0D6E05"
- },
- "ledger_current_index": 6507948
- }
+ "id": 5,
+ "status": "success",
+ "type": "response",
+ "result": {
+ "account_data": {
+ "Account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn",
+ "Balance": "999999999960",
+ "Flags": 8388608,
+ "LedgerEntryType": "AccountRoot",
+ "OwnerCount": 0,
+ "PreviousTxnID": "4294BEBE5B569A18C0A2702387C9B1E7146DC3A5850C1E87204951C6FDAA4C42",
+ "PreviousTxnLgrSeq": 3,
+ "Sequence": 6,
+ "index": "92FA6A9FC8EA6018D5D16532D7795C91BFB0831355BDFDA177E86C8BF997985F"
+ },
+ "ledger_current_index": 4,
+ "queue_data": {
+ "auth_change_queued": true,
+ "highest_sequence": 10,
+ "lowest_sequence": 6,
+ "max_spend_drops_total": "500",
+ "transactions": [
+
+ {
+ "auth_change": false,
+ "fee": "100",
+ "fee_level": "2560",
+ "max_spend_drops": "100",
+ "seq": 6
+ },
+
+ ... (trimmed for length) ...
+
+ {
+ "LastLedgerSequence": 10,
+ "auth_change": true,
+ "fee": "100",
+ "fee_level": "2560",
+ "max_spend_drops": "100",
+ "seq": 10
+ }
+ ],
+ "txn_count": 5
+ },
+ "validated": false
+ }
+}
+{
+ "result": {
+ "account_data": {
+ "Account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn",
+ "Balance": "999999999960",
+ "Flags": 8388608,
+ "LedgerEntryType": "AccountRoot",
+ "OwnerCount": 0,
+ "PreviousTxnID": "4294BEBE5B569A18C0A2702387C9B1E7146DC3A5850C1E87204951C6FDAA4C42",
+ "PreviousTxnLgrSeq": 3,
+ "Sequence": 6,
+ "index": "92FA6A9FC8EA6018D5D16532D7795C91BFB0831355BDFDA177E86C8BF997985F"
+ },
+ "ledger_current_index": 4,
+ "queue_data": {
+ "auth_change_queued": true,
+ "highest_sequence": 10,
+ "lowest_sequence": 6,
+ "max_spend_drops_total": "500",
+ "transactions": [
+
+ {
+ "auth_change": false,
+ "fee": "100",
+ "fee_level": "2560",
+ "max_spend_drops": "100",
+ "seq": 6
+ },
+
+ ... (trimmed for length) ...
+
+ {
+ "LastLedgerSequence": 10,
+ "auth_change": true,
+ "fee": "100",
+ "fee_level": "2560",
+ "max_spend_drops": "100",
+ "seq": 10
+ }
+ ],
+ "txn_count": 5
+ },
+ "status": "success",
+ "validated": false
+ }
}
ledger_current_index is provided instead) The sequence number of the ledger used when retrieving this information. The information does not contain any changes from ledgers newer than this one.queue specified as true) Information about queued transactions sent by this account. Some information is calculated "lazily" and may not be available. This information describes the state of the local rippled server, which may be different from other servers in the consensus network.rippled 0.26.0][])The queue_data parameter, if present, contains the following fields:
| Field | +Type | +Description | +
|---|---|---|
| txn_count | +Integer | +Number of queued transactions from this address. | +
| auth_change_queued | +Boolean | +(May be omitted) Whether a transaction in the queue changes this address's ways of authorizing transactions. If true, this address can queue no further transactions until that transaction has been executed or dropped from the queue. |
+
| lowest_sequence | +Integer | +(May be omitted) The lowest Sequence Number among transactions queued by this address. | +
| highest_sequence | +Integer | +(May be omitted) The highest Sequence Number among transactions queued by this address. | +
| max_spend_drops_total | +String | +(May be omitted) Integer amount of drops of XRP that could be debited from this address if every transaction in the queue consumes the maximum amount of XRP possible. | +
| transactions | +Array | +(May be omitted) Information about each queued transaction from this address. | +
Each object in the transactions array, if present, may contain any or all of the following fields:
| Field | +Type | +Description | +
|---|---|---|
| auth_change | +Boolean | +Whether this transaction changes this address's ways of authorizing transactions. | +
| fee | +String | +The Transaction Cost of this transaction, in drops of XRP. | +
| fee_level | +String | +The transaction cost of this transaction, relative to the minimum cost for this type of transaction, in fee levels. | +
| max_spend_drops | +The maximum amount of XRP, in drops, this transaction could send or destroy. | ++ |
| seq | +Integer | +The Sequence Number of this transaction. | +
invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing.invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing. For example, the request specified queue as true but specified a ledger_index that is not the current open ledger.actNotFound - The address specified in the account field of the request does not correspond to an account in the ledger.lgrNotFound - The ledger specified by the ledger_hash or ledger_index does not exist, or it does exist but the server does not have it.