mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-20 12:15:51 +00:00
Rename json schemas (#931)
Rename files for consistency with their titles: * Rename amount-base to amountbase * Rename tx-hash to transaction-hash * Rename id to transactionHash * Rename objects/settings.json to objects/settings-plus-memos.json * Rename ledgerversion to ledger-version
This commit is contained in:
@@ -1136,7 +1136,7 @@ Retrieves a transaction by its [Transaction ID](#transaction-id).
|
||||
|
||||
Name | Type | Description
|
||||
---- | ---- | -----------
|
||||
id | [id](#transaction-id) | A hash of a transaction used to identify the transaction, represented in hexadecimal.
|
||||
id | [transactionHash](#transaction-id) | A hash of a transaction used to identify the transaction, represented in hexadecimal.
|
||||
options | object | *Optional* Options to limit the ledger versions to search.
|
||||
*options.* maxLedgerVersion | integer | *Optional* The highest ledger version to search
|
||||
*options.* maxLedgerVersion | string | *Optional* The highest ledger version to search
|
||||
@@ -1149,7 +1149,7 @@ This method returns a promise that resolves with a transaction object containing
|
||||
|
||||
Name | Type | Description
|
||||
---- | ---- | -----------
|
||||
id | [id](#transaction-id) | A hash of the transaction that can be used to identify it.
|
||||
id | [transactionHash](#transaction-id) | A hash of the transaction that can be used to identify it.
|
||||
address | [address](#address) | The address of the account that initiated the transaction.
|
||||
sequence | [sequence](#account-sequence-number) | The account sequence number of the transaction for the account that initiated it.
|
||||
type | [transactionType](#transaction-types) | The type of the transaction.
|
||||
@@ -4079,7 +4079,7 @@ transactionHash | string | Hash of the transaction information included in this
|
||||
rawState | string | *Optional* A JSON string containing all state data for this ledger in rippled JSON format.
|
||||
rawTransactions | string | *Optional* A JSON string containing rippled format transaction JSON for all transactions that were validated in this ledger.
|
||||
stateHashes | array\<string\> | *Optional* An array of hashes of all state data in this ledger.
|
||||
transactionHashes | array\<[id](#transaction-id)\> | *Optional* An array of hashes of all transactions that were validated in this ledger.
|
||||
transactionHashes | array\<[transactionHash](#transaction-id)\> | *Optional* An array of hashes of all transactions that were validated in this ledger.
|
||||
transactions | array\<[getTransaction](#gettransaction)\> | *Optional* Array of all transactions that were validated in this ledger. Transactions are represented in the same format as the return value of [getTransaction](#gettransaction).
|
||||
|
||||
### Example
|
||||
@@ -4971,7 +4971,7 @@ This method returns an object with the following structure:
|
||||
Name | Type | Description
|
||||
---- | ---- | -----------
|
||||
signedTransaction | string | The signed transaction represented as an uppercase hexadecimal string.
|
||||
id | [id](#transaction-id) | The [Transaction ID](#transaction-id) of the signed transaction.
|
||||
id | [transactionHash](#transaction-id) | The [Transaction ID](#transaction-id) of the signed transaction.
|
||||
|
||||
### Example
|
||||
|
||||
@@ -5010,7 +5010,7 @@ This method returns an object with the following structure:
|
||||
Name | Type | Description
|
||||
---- | ---- | -----------
|
||||
signedTransaction | string | The signed transaction represented as an uppercase hexadecimal string.
|
||||
id | [id](#transaction-id) | The [Transaction ID](#transaction-id) of the signed transaction.
|
||||
id | [transactionHash](#transaction-id) | The [Transaction ID](#transaction-id) of the signed transaction.
|
||||
|
||||
### Example
|
||||
|
||||
@@ -5212,7 +5212,7 @@ ledger | object | The ledger header to hash.
|
||||
*ledger.* rawState | string | *Optional* A JSON string containing all state data for this ledger in rippled JSON format.
|
||||
*ledger.* rawTransactions | string | *Optional* A JSON string containing rippled format transaction JSON for all transactions that were validated in this ledger.
|
||||
*ledger.* stateHashes | array\<string\> | *Optional* An array of hashes of all state data in this ledger.
|
||||
*ledger.* transactionHashes | array\<[id](#transaction-id)\> | *Optional* An array of hashes of all transactions that were validated in this ledger.
|
||||
*ledger.* transactionHashes | array\<[transactionHash](#transaction-id)\> | *Optional* An array of hashes of all transactions that were validated in this ledger.
|
||||
*ledger.* transactions | array\<[getTransaction](#gettransaction)\> | *Optional* Array of all transactions that were validated in this ledger. Transactions are represented in the same format as the return value of [getTransaction](#gettransaction).
|
||||
|
||||
### Return Value
|
||||
|
||||
@@ -52,4 +52,4 @@ A *lax lax amount* allows either or both the counterparty and value to be omitte
|
||||
|
||||
A *balance* is an amount than can have a negative value.
|
||||
|
||||
<%- renderSchema('objects/amount-base.json') %>
|
||||
<%- renderSchema('objects/amountbase.json') %>
|
||||
|
||||
@@ -9,13 +9,13 @@ function loadSchemas() {
|
||||
// listed explicitly for webpack (instead of scanning schemas directory)
|
||||
const schemas = [
|
||||
require('./schemas/objects/tx-json.json'),
|
||||
require('./schemas/objects/tx-type.json'),
|
||||
require('./schemas/objects/transaction-type.json'),
|
||||
require('./schemas/objects/hash128.json'),
|
||||
require('./schemas/objects/hash256.json'),
|
||||
require('./schemas/objects/sequence.json'),
|
||||
require('./schemas/objects/signature.json'),
|
||||
require('./schemas/objects/issue.json'),
|
||||
require('./schemas/objects/ledgerversion.json'),
|
||||
require('./schemas/objects/ledger-version.json'),
|
||||
require('./schemas/objects/max-adjustment.json'),
|
||||
require('./schemas/objects/memo.json'),
|
||||
require('./schemas/objects/memos.json'),
|
||||
@@ -31,19 +31,19 @@ function loadSchemas() {
|
||||
require('./schemas/objects/min-adjustment.json'),
|
||||
require('./schemas/objects/source-exact-adjustment.json'),
|
||||
require('./schemas/objects/destination-exact-adjustment.json'),
|
||||
require('./schemas/objects/tx-hash.json'),
|
||||
require('./schemas/objects/transaction-hash.json'),
|
||||
require('./schemas/objects/address.json'),
|
||||
require('./schemas/objects/adjustment.json'),
|
||||
require('./schemas/objects/quality.json'),
|
||||
require('./schemas/objects/amount.json'),
|
||||
require('./schemas/objects/amount-base.json'),
|
||||
require('./schemas/objects/amountbase.json'),
|
||||
require('./schemas/objects/balance.json'),
|
||||
require('./schemas/objects/blob.json'),
|
||||
require('./schemas/objects/currency.json'),
|
||||
require('./schemas/objects/signed-value.json'),
|
||||
require('./schemas/objects/orderbook.json'),
|
||||
require('./schemas/objects/instructions.json'),
|
||||
require('./schemas/objects/settings.json'),
|
||||
require('./schemas/objects/settings-plus-memos.json'),
|
||||
require('./schemas/specifications/settings.json'),
|
||||
require('./schemas/specifications/payment.json'),
|
||||
require('./schemas/specifications/escrow-cancellation.json'),
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
"description": "Parameters for getTransaction",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {"$ref": "id"},
|
||||
"id": {"$ref": "transactionHash"},
|
||||
"options": {
|
||||
"description": "Options to limit the ledger versions to search.",
|
||||
"properties": {
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"$schema": "http://json-schema.org/draft-04/schema#",
|
||||
"title": "id",
|
||||
"title": "transactionHash",
|
||||
"link": "transaction-id",
|
||||
"description": "A hash of a transaction used to identify the transaction, represented in hexadecimal.",
|
||||
"type": "string",
|
||||
@@ -63,7 +63,7 @@
|
||||
"description": "An array of hashes of all transactions that were validated in this ledger.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "id"
|
||||
"$ref": "transactionHash"
|
||||
}
|
||||
},
|
||||
"rawState": {
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
"description": "The outcome of the transaction (what effects it had)."
|
||||
},
|
||||
"id": {
|
||||
"$ref": "id",
|
||||
"$ref": "transactionHash",
|
||||
"description": "A hash of the transaction that can be used to identify it."
|
||||
},
|
||||
"address": {
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
"description": "The signed transaction represented as an uppercase hexadecimal string."
|
||||
},
|
||||
"id": {
|
||||
"$ref": "id",
|
||||
"$ref": "transactionHash",
|
||||
"description": "The [Transaction ID](#transaction-id) of the signed transaction."
|
||||
}
|
||||
},
|
||||
|
||||
Reference in New Issue
Block a user