diff --git a/docs/index.md b/docs/index.md index a76545aa..fe87576e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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\ | *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\ | *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 diff --git a/docs/src/basictypes.md.ejs b/docs/src/basictypes.md.ejs index 9efae9a2..15060c40 100644 --- a/docs/src/basictypes.md.ejs +++ b/docs/src/basictypes.md.ejs @@ -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') %> diff --git a/src/common/schema-validator.ts b/src/common/schema-validator.ts index a0b10feb..2f22c71e 100644 --- a/src/common/schema-validator.ts +++ b/src/common/schema-validator.ts @@ -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'), diff --git a/src/common/schemas/input/get-transaction.json b/src/common/schemas/input/get-transaction.json index 174cd393..53c991ac 100644 --- a/src/common/schemas/input/get-transaction.json +++ b/src/common/schemas/input/get-transaction.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": { diff --git a/src/common/schemas/objects/amount-base.json b/src/common/schemas/objects/amountbase.json similarity index 100% rename from src/common/schemas/objects/amount-base.json rename to src/common/schemas/objects/amountbase.json diff --git a/src/common/schemas/objects/ledgerversion.json b/src/common/schemas/objects/ledger-version.json similarity index 100% rename from src/common/schemas/objects/ledgerversion.json rename to src/common/schemas/objects/ledger-version.json diff --git a/src/common/schemas/objects/settings.json b/src/common/schemas/objects/settings-plus-memos.json similarity index 100% rename from src/common/schemas/objects/settings.json rename to src/common/schemas/objects/settings-plus-memos.json diff --git a/src/common/schemas/objects/tx-hash.json b/src/common/schemas/objects/transaction-hash.json similarity index 89% rename from src/common/schemas/objects/tx-hash.json rename to src/common/schemas/objects/transaction-hash.json index e9620527..95b54676 100644 --- a/src/common/schemas/objects/tx-hash.json +++ b/src/common/schemas/objects/transaction-hash.json @@ -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", diff --git a/src/common/schemas/objects/tx-type.json b/src/common/schemas/objects/transaction-type.json similarity index 100% rename from src/common/schemas/objects/tx-type.json rename to src/common/schemas/objects/transaction-type.json diff --git a/src/common/schemas/output/get-ledger.json b/src/common/schemas/output/get-ledger.json index ce029bca..ffb5d4f0 100644 --- a/src/common/schemas/output/get-ledger.json +++ b/src/common/schemas/output/get-ledger.json @@ -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": { diff --git a/src/common/schemas/output/get-transaction.json b/src/common/schemas/output/get-transaction.json index 0f860110..869762ae 100644 --- a/src/common/schemas/output/get-transaction.json +++ b/src/common/schemas/output/get-transaction.json @@ -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": { diff --git a/src/common/schemas/output/sign.json b/src/common/schemas/output/sign.json index 5399aecd..b62e94be 100644 --- a/src/common/schemas/output/sign.json +++ b/src/common/schemas/output/sign.json @@ -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." } },