@bithomp/xrpl-api 3.2.4 → 3.2.8

package/lib/ledger/account_tx.d.ts

@@ -11,6 +11,7 @@ export interface GetTransactionsOptions {
     marker?: any;
     balanceChanges?: boolean;
     specification?: boolean;
+    includeRawTransactions?: boolean;
 }
 export declare function getTransactions(account: string, options?: GetTransactionsOptions): Promise<object | ErrorResponse>;
 export interface FindTransactionsOptions extends GetTransactionsOptions {
@@ -24,6 +25,5 @@ export interface FindTransactionsOptions extends GetTransactionsOptions {
     timeout?: number;
     legacy?: boolean;
     formatted?: boolean;
-    includeRawTransactions?: boolean;
 }
 export declare function findTransactions(account: string, options?: FindTransactionsOptions): Promise<object[] | ErrorResponse>;

package/lib/ledger/account_tx.js

@@ -101,10 +101,12 @@ async function getTransactions(account, options = { limit: DEFAULT_LIMIT }) {
                     transaction.balanceChanges = (0, xrpl_1.getBalanceChanges)(transaction.meta);
                 }
                 if (options.specification === true) {
-                    const details = (0, transaction_1.getAccountTxDetails)(transaction, true);
+                    const details = (0, transaction_1.getAccountTxDetails)(transaction, options.includeRawTransactions);
                     transaction.specification = details.specification;
                     transaction.outcome = details.outcome;
-                    transaction.rawTransaction = details.rawTransaction;
+                    if (details.rawTransaction) {
+                        transaction.rawTransaction = details.rawTransaction;
+                    }
                 }
             }
         }
@@ -163,10 +165,12 @@ async function findTransactions(account, options = { limit: DEFAULT_LIMIT, timeo
                     newTransaction.balanceChanges = (0, xrpl_1.getBalanceChanges)(newTransaction.meta);
                 }
                 if (loadOptions.specification === true) {
-                    const details = (0, transaction_1.getAccountTxDetails)(newTransaction, true);
+                    const details = (0, transaction_1.getAccountTxDetails)(newTransaction, options.includeRawTransactions);
                     newTransaction.specification = details.specification;
                     newTransaction.outcome = details.outcome;
-                    newTransaction.rawTransaction = details.rawTransaction;
+                    if (details.rawTransaction) {
+                        newTransaction.rawTransaction = details.rawTransaction;
+                    }
                 }
             }
         }

package/lib/ledger/transaction.js

@@ -93,10 +93,12 @@ async function getTransaction(transaction, options = {}) {
             result.balanceChanges = xrpl.getBalanceChanges(result.meta);
         }
         if (options.specification === true) {
-            const details = (0, transaction_1.getTxDetails)(result, true, undefined, options.definitions);
+            const details = (0, transaction_1.getTxDetails)(result, options.includeRawTransaction, undefined, options.definitions);
             result.specification = details.specification;
             result.outcome = details.outcome;
-            result.rawTransaction = details.rawTransaction;
+            if (details.rawTransaction) {
+                result.rawTransaction = details.rawTransaction;
+            }
         }
     }
     return result;
@@ -165,10 +167,12 @@ async function getTransactionByCTID(ctid, options = {}) {
         result.balanceChanges = xrpl.getBalanceChanges(result.meta);
     }
     if (options.specification === true) {
-        const details = (0, transaction_1.getTxDetails)(result, true, undefined, options.definitions);
+        const details = (0, transaction_1.getTxDetails)(result, options.includeRawTransaction, undefined, options.definitions);
         result.specification = details.specification;
         result.outcome = details.outcome;
-        result.rawTransaction = details.rawTransaction;
+        if (details.rawTransaction) {
+            result.rawTransaction = details.rawTransaction;
+        }
     }
     return result;
 }

package/lib/models/transaction.d.ts

@@ -33,10 +33,10 @@ export interface AccountPaymentParamsInterface {
     lastLedgerSequence?: number;
     networkID?: number;
 }
-export declare function getTxDetails(tx: TransactionResponse, includeRawTransaction: boolean, nativeCurrency?: string, definitions?: XrplDefinitionsBase): FormattedTransaction;
-export declare function getAccountTxDetails(tx: AccountTransaction, includeRawTransaction: boolean, nativeCurrency?: string): FormattedTransaction;
-export declare function getLedgerTxDetails(tx: LedgerTransaction, ledgerIndex: number, closeTime: number, includeRawTransaction: boolean, nativeCurrency?: string, definitions?: XrplDefinitionsBase): FormattedTransaction;
-export declare function getStreamTxDetails(tx: StreamTransaction, includeRawTransaction: boolean, nativeCurrency?: string, definitions?: XrplDefinitionsBase): FormattedTransaction;
+export declare function getTxDetails(tx: TransactionResponse, includeRawTransaction?: boolean, nativeCurrency?: string, definitions?: XrplDefinitionsBase): FormattedTransaction;
+export declare function getAccountTxDetails(tx: AccountTransaction, includeRawTransaction?: boolean, nativeCurrency?: string): FormattedTransaction;
+export declare function getLedgerTxDetails(tx: LedgerTransaction, ledgerIndex: number, closeTime: number, includeRawTransaction?: boolean, nativeCurrency?: string, definitions?: XrplDefinitionsBase): FormattedTransaction;
+export declare function getStreamTxDetails(tx: StreamTransaction, includeRawTransaction?: boolean, nativeCurrency?: string, definitions?: XrplDefinitionsBase): FormattedTransaction;
 export declare function accountTxToTx(accountTx: AccountTransaction): TransactionResponse;
 export declare function ledgerTxToTx(ledgerTx: LedgerTransaction, ledgerIndex: number, closeTime: number): TransactionResponse;
 export declare function streamTxToTx(streamTx: StreamTransaction): TransactionResponse;

package/lib/parse/specification/oracle-set.js

@@ -35,7 +35,6 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 const assert = __importStar(require("assert"));
 const common_1 = require("../../common");
-const emit_details_1 = require("../ledger/emit_details");
 const memos_1 = require("../ledger/memos");
 const account_1 = require("../ledger/account");
 const oracle_changes_1 = require("../outcome/oracle_changes");
@@ -53,7 +52,6 @@ function parseDidSet(tx) {
         assetClass: tx.AssetClass,
         lastUpdateTime: tx.LastUpdateTime,
         priceDataSeries: tx.PriceDataSeries ? tx.PriceDataSeries.map(oracle_changes_1.parsePriceDataSeries) : undefined,
-        emittedDetails: (0, emit_details_1.parseEmittedDetails)(tx),
         memos: (0, memos_1.parseMemos)(tx),
     });
 }

package/lib/parse/specification/unrecognized.d.ts

@@ -0,0 +1,3 @@
+import { FormattedUnrecognizedParserSpecification } from "../../types/unrecognized";
+declare function unrecognizedParser(tx: any): FormattedUnrecognizedParserSpecification;
+export default unrecognizedParser;

package/lib/parse/specification/unrecognized.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const common_1 = require("../../common");
+const emit_details_1 = require("../ledger/emit_details");
+const memos_1 = require("../ledger/memos");
+const account_1 = require("../ledger/account");
+function unrecognizedParser(tx) {
+    const source = (0, common_1.removeUndefined)({
+        address: (0, account_1.parseAccount)(tx.Account),
+        tag: tx.SourceTag,
+    });
+    return (0, common_1.removeUndefined)({
+        UNAVAILABLE: "Unrecognized transaction type.",
+        SEE_RAW_TRANSACTION: "Since this type is unrecognized, `rawTransaction` is may included in this response.",
+        source: Object.keys(source).length > 0 ? source : undefined,
+        emittedDetails: (0, emit_details_1.parseEmittedDetails)(tx),
+        memos: (0, memos_1.parseMemos)(tx),
+    });
+}
+exports.default = unrecognizedParser;

package/lib/parse/transaction.d.ts

@@ -1,5 +1,6 @@
 import { XrplDefinitionsBase } from "ripple-binary-codec";
 import { Outcome } from "../types/outcome";
+import { FormattedUnrecognizedParserSpecification } from "../types/unrecognized";
 import { FormattedAccountDeleteSpecification } from "../types/account";
 import { FormattedSettingsSpecification } from "../types/settings";
 import { FormattedCheckCancelSpecification, FormattedCheckCashSpecification, FormattedCheckCreateSpecification } from "../types/checks";
@@ -25,7 +26,7 @@ import { FormattedGenesisMintSpecification } from "../types/genesis_mint";
 import { FormattedAmendmentSpecification } from "../types/amendments";
 import { FormattedFeeUpdateSpecification } from "../types/fees";
 declare function parseTransactionType(type: string): string;
-export type FormattedSpecification = FormattedSettingsSpecification | FormattedAccountDeleteSpecification | FormattedCheckCancelSpecification | FormattedCheckCashSpecification | FormattedCheckCreateSpecification | FormattedDepositPreauthSpecification | FormattedEscrowCancelSpecification | FormattedEscrowCreateSpecification | FormattedEscrowFinishSpecification | FormattedOfferCancelSpecification | FormattedOfferCreateSpecification | FormattedPaymentSpecification | FormattedPaymentChannelClaimSpecification | FormattedPaymentChannelCreateSpecification | FormattedPaymentChannelFundSpecification | FormattedTicketCreateSpecification | FormattedTrustlineSpecification | FormattedNFTokenBurnSpecification | FormattedNFTokenMintSpecification | FormattedNFTokenCancelOfferSpecification | FormattedNFTokenCreateOfferSpecification | FormattedNFTokenAcceptOfferSpecification | FormattedURITokenBurnSpecification | FormattedURITokenBuySpecification | FormattedURITokenCreateSellOfferSpecification | FormattedURITokenCancelSellOfferSpecification | FormattedURITokenMintSpecification | FormattedImportSpecification | FormattedInvokeSpecification | FormattedUNLReportSpecification | FormattedRemitsSpecification | FormattedClawbackSpecification | FormattedAmmBidSpecification | FormattedAmmCreateSpecification | FormattedAmmDeleteSpecification | FormattedAmmDepositSpecification | FormattedAmmWithdrawSpecification | FormattedAmmVoteSpecification | FormattedAmmClawbackSpecification | FormattedGenesisMintSpecification | FormattedAmendmentSpecification | FormattedFeeUpdateSpecification | FormattedDIDSetSpecification | FormattedDIDDeleteSpecification | FormattedOracleSetSpecification | FormattedOracleDeleteSpecification | FormattedMPTokenIssuanceCreateSpecification | FormattedMPTokenAuthorizeSpecification | FormattedMPTokenIssuanceSetSpecification | FormattedMPTokenIssuanceDestroySpecification;
+export type FormattedSpecification = FormattedUnrecognizedParserSpecification | FormattedSettingsSpecification | FormattedAccountDeleteSpecification | FormattedCheckCancelSpecification | FormattedCheckCashSpecification | FormattedCheckCreateSpecification | FormattedDepositPreauthSpecification | FormattedEscrowCancelSpecification | FormattedEscrowCreateSpecification | FormattedEscrowFinishSpecification | FormattedOfferCancelSpecification | FormattedOfferCreateSpecification | FormattedPaymentSpecification | FormattedPaymentChannelClaimSpecification | FormattedPaymentChannelCreateSpecification | FormattedPaymentChannelFundSpecification | FormattedTicketCreateSpecification | FormattedTrustlineSpecification | FormattedNFTokenBurnSpecification | FormattedNFTokenMintSpecification | FormattedNFTokenCancelOfferSpecification | FormattedNFTokenCreateOfferSpecification | FormattedNFTokenAcceptOfferSpecification | FormattedURITokenBurnSpecification | FormattedURITokenBuySpecification | FormattedURITokenCreateSellOfferSpecification | FormattedURITokenCancelSellOfferSpecification | FormattedURITokenMintSpecification | FormattedImportSpecification | FormattedInvokeSpecification | FormattedUNLReportSpecification | FormattedRemitsSpecification | FormattedClawbackSpecification | FormattedAmmBidSpecification | FormattedAmmCreateSpecification | FormattedAmmDeleteSpecification | FormattedAmmDepositSpecification | FormattedAmmWithdrawSpecification | FormattedAmmVoteSpecification | FormattedAmmClawbackSpecification | FormattedGenesisMintSpecification | FormattedAmendmentSpecification | FormattedFeeUpdateSpecification | FormattedDIDSetSpecification | FormattedDIDDeleteSpecification | FormattedOracleSetSpecification | FormattedOracleDeleteSpecification | FormattedMPTokenIssuanceCreateSpecification | FormattedMPTokenAuthorizeSpecification | FormattedMPTokenIssuanceSetSpecification | FormattedMPTokenIssuanceDestroySpecification;
 export interface FormattedTransaction {
     type: string;
     address: string;
@@ -35,5 +36,5 @@ export interface FormattedTransaction {
     outcome?: Outcome;
     rawTransaction?: string;
 }
-declare function parseTransaction(tx: any, includeRawTransaction: boolean, nativeCurrency?: string, definitions?: XrplDefinitionsBase): FormattedTransaction;
+declare function parseTransaction(tx: any, includeRawTransaction?: boolean, nativeCurrency?: string, definitions?: XrplDefinitionsBase): FormattedTransaction;
 export { parseTransactionType, parseTransaction };

package/lib/parse/transaction.js

@@ -8,6 +8,7 @@ exports.parseTransaction = parseTransaction;
 const common_1 = require("../common");
 const account_1 = require("./ledger/account");
 const outcome_1 = require("./outcome");
+const unrecognized_1 = __importDefault(require("./specification/unrecognized"));
 const settings_1 = __importDefault(require("./specification/settings"));
 const account_delete_1 = __importDefault(require("./specification/account-delete"));
 const check_cancel_1 = __importDefault(require("./specification/check-cancel"));
@@ -167,12 +168,6 @@ const parserTypeFunc = {
     amendment: amendment_1.default,
     feeUpdate: fee_update_1.default,
 };
-function unrecognizedParser(_tx) {
-    return {
-        UNAVAILABLE: "Unrecognized transaction type.",
-        SEE_RAW_TRANSACTION: "Since this type is unrecognized, `rawTransaction` is included in this response.",
-    };
-}
 function parseTransaction(tx, includeRawTransaction, nativeCurrency, definitions) {
     let universalTx = tx;
     if (universalTx.tx_json) {
@@ -180,8 +175,8 @@ function parseTransaction(tx, includeRawTransaction, nativeCurrency, definitions
     }
     const type = parseTransactionType(universalTx.TransactionType);
     const parser = parserTypeFunc[type];
-    const specification = parser ? parser(universalTx) : unrecognizedParser(universalTx);
-    if (!parser) {
+    const specification = parser ? parser(universalTx) : (0, unrecognized_1.default)(universalTx);
+    if (!parser && includeRawTransaction !== false) {
         includeRawTransaction = true;
     }
     const outcome = (0, outcome_1.parseOutcome)(universalTx, nativeCurrency, definitions);

package/lib/types/unrecognized.d.ts

@@ -0,0 +1,5 @@
+import { FormattedBaseSpecification } from "./specification";
+export type FormattedUnrecognizedParserSpecification = {
+    UNAVAILABLE: string;
+    SEE_RAW_TRANSACTION: string;
+} & FormattedBaseSpecification;

package/lib/types/unrecognized.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bithomp/xrpl-api",
-  "version": "3.2.4",
+  "version": "3.2.8",
   "description": "A Bithomp JavaScript/TypeScript library for interacting with the XRP Ledger",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",