@bithomp/xrpl-api 3.7.30 → 3.7.37

package/lib/src/parse/transaction.js

@@ -0,0 +1,228 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parserTypeFunc = void 0;
+exports.parseTransactionType = parseTransactionType;
+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"));
+const check_cash_1 = __importDefault(require("./specification/check-cash"));
+const check_create_1 = __importDefault(require("./specification/check-create"));
+const deposit_preauth_1 = __importDefault(require("./specification/deposit-preauth"));
+const escrow_cancel_1 = __importDefault(require("./specification/escrow-cancel"));
+const escrow_create_1 = __importDefault(require("./specification/escrow-create"));
+const escrow_finish_1 = __importDefault(require("./specification/escrow-finish"));
+const offer_cancel_1 = __importDefault(require("./specification/offer-cancel"));
+const offer_create_1 = __importDefault(require("./specification/offer-create"));
+const payment_1 = __importDefault(require("./specification/payment"));
+const payment_channel_claim_1 = __importDefault(require("./specification/payment-channel-claim"));
+const payment_channel_create_1 = __importDefault(require("./specification/payment-channel-create"));
+const payment_channel_fund_1 = __importDefault(require("./specification/payment-channel-fund"));
+const ticket_create_1 = __importDefault(require("./specification/ticket-create"));
+const trust_set_1 = __importDefault(require("./specification/trust-set"));
+const nftoken_burn_1 = __importDefault(require("./specification/nftoken-burn"));
+const nftoken_mint_1 = __importDefault(require("./specification/nftoken-mint"));
+const nftoken_modify_1 = __importDefault(require("./specification/nftoken-modify"));
+const nftoken_cancel_offer_1 = __importDefault(require("./specification/nftoken-cancel-offer"));
+const nftoken_create_offer_1 = __importDefault(require("./specification/nftoken-create-offer"));
+const nftoken_accept_offer_1 = __importDefault(require("./specification/nftoken-accept-offer"));
+const uritoken_burn_1 = __importDefault(require("./specification/uritoken-burn"));
+const uritoken_buy_1 = __importDefault(require("./specification/uritoken-buy"));
+const uritoken_cancel_sell_offer_1 = __importDefault(require("./specification/uritoken-cancel-sell-offer"));
+const uritoken_create_sell_offer_1 = __importDefault(require("./specification/uritoken-create-sell-offer"));
+const uritoken_mint_1 = __importDefault(require("./specification/uritoken-mint"));
+const import_1 = __importDefault(require("./specification/import"));
+const invoke_1 = __importDefault(require("./specification/invoke"));
+const unl_report_1 = __importDefault(require("./specification/unl-report"));
+const remit_1 = __importDefault(require("./specification/remit"));
+const clawback_1 = __importDefault(require("./specification/clawback"));
+const amm_bid_1 = __importDefault(require("./specification/amm-bid"));
+const amm_create_1 = __importDefault(require("./specification/amm-create"));
+const amm_delete_1 = __importDefault(require("./specification/amm-delete"));
+const amm_deposit_1 = __importDefault(require("./specification/amm-deposit"));
+const amm_withdraw_1 = __importDefault(require("./specification/amm-withdraw"));
+const amm_vote_1 = __importDefault(require("./specification/amm-vote"));
+const amm_clawback_1 = __importDefault(require("./specification/amm-clawback"));
+const did_set_1 = __importDefault(require("./specification/did-set"));
+const did_delete_1 = __importDefault(require("./specification/did-delete"));
+const oracle_set_1 = __importDefault(require("./specification/oracle-set"));
+const oracle_delete_1 = __importDefault(require("./specification/oracle-delete"));
+const mptoken_issuance_create_1 = __importDefault(require("./specification/mptoken-issuance-create"));
+const mptoken_authorize_1 = __importDefault(require("./specification/mptoken-authorize"));
+const mptoken_issuance_set_1 = __importDefault(require("./specification/mptoken-issuance-set"));
+const mptoken_issuance_destroy_1 = __importDefault(require("./specification/mptoken-issuance-destroy"));
+const delegate_set_1 = __importDefault(require("./specification/delegate-set"));
+const set_remarks_1 = __importDefault(require("./specification/set-remarks"));
+const credential_create_1 = __importDefault(require("./specification/credential-create"));
+const credential_accept_1 = __importDefault(require("./specification/credential-accept"));
+const credential_delete_1 = __importDefault(require("./specification/credential-delete"));
+const permissioned_domain_set_1 = __importDefault(require("./specification/permissioned-domain-set"));
+const genesis_mint_1 = __importDefault(require("./specification/genesis-mint"));
+const batch_1 = __importDefault(require("./specification/batch"));
+const cron_1 = __importDefault(require("./specification/cron"));
+const cron_set_1 = __importDefault(require("./specification/cron-set"));
+const amendment_1 = __importDefault(require("./specification/amendment"));
+const fee_update_1 = __importDefault(require("./specification/fee-update"));
+const unl_modify_1 = __importDefault(require("./specification/unl-modify"));
+const transactionTypeToType = {
+    AccountSet: "settings",
+    AccountDelete: "accountDelete",
+    CheckCancel: "checkCancel",
+    CheckCash: "checkCash",
+    CheckCreate: "checkCreate",
+    DepositPreauth: "depositPreauth",
+    EscrowCancel: "escrowCancellation",
+    EscrowCreate: "escrowCreation",
+    EscrowFinish: "escrowExecution",
+    OfferCancel: "orderCancellation",
+    OfferCreate: "order",
+    Payment: "payment",
+    PaymentChannelClaim: "paymentChannelClaim",
+    PaymentChannelCreate: "paymentChannelCreate",
+    PaymentChannelFund: "paymentChannelFund",
+    SetRegularKey: "settings",
+    SignerListSet: "settings",
+    TicketCreate: "ticketCreate",
+    TrustSet: "trustline",
+    NFTokenBurn: "nftokenBurn",
+    NFTokenMint: "nftokenMint",
+    NFTokenModify: "NFTokenModify",
+    NFTokenCancelOffer: "nftokenCancelOffer",
+    NFTokenCreateOffer: "nftokenCreateOffer",
+    NFTokenAcceptOffer: "nftokenAcceptOffer",
+    URITokenMint: "uritokenMint",
+    URITokenBurn: "uritokenBurn",
+    URITokenCreateSellOffer: "uritokenCreateSellOffer",
+    URITokenCancelSellOffer: "uritokenCancelSellOffer",
+    URITokenBuy: "uritokenBuy",
+    Import: "import",
+    Invoke: "invoke",
+    UNLReport: "unlReport",
+    Remit: "remit",
+    Clawback: "clawback",
+    AMMBid: "ammBid",
+    AMMCreate: "ammCreate",
+    AMMDelete: "ammDelete",
+    AMMDeposit: "ammDeposit",
+    AMMWithdraw: "ammWithdraw",
+    AMMVote: "ammVote",
+    AMMClawback: "AMMClawback",
+    DIDSet: "didSet",
+    DIDDelete: "didDelete",
+    OracleSet: "oracleSet",
+    OracleDelete: "oracleDelete",
+    MPTokenIssuanceCreate: "MPTokenIssuanceCreate",
+    MPTokenAuthorize: "MPTokenAuthorize",
+    MPTokenIssuanceSet: "MPTokenIssuanceSet",
+    MPTokenIssuanceDestroy: "MPTokenIssuanceDestroy",
+    CredentialCreate: "CredentialCreate",
+    CredentialAccept: "CredentialAccept",
+    CredentialDelete: "CredentialDelete",
+    PermissionedDomainSet: "PermissionedDomainSet",
+    DelegateSet: "DelegateSet",
+    SetRemarks: "SetRemarks",
+    GenesisMint: "genesisMint",
+    Batch: "Batch",
+    Cron: "Cron",
+    CronSet: "CronSet",
+    EnableAmendment: "amendment",
+    SetFee: "feeUpdate",
+    UNLModify: "UNLModify",
+};
+function parseTransactionType(type) {
+    return transactionTypeToType[type] || type;
+}
+exports.parserTypeFunc = {
+    settings: settings_1.default,
+    accountDelete: account_delete_1.default,
+    checkCancel: check_cancel_1.default,
+    checkCash: check_cash_1.default,
+    checkCreate: check_create_1.default,
+    depositPreauth: deposit_preauth_1.default,
+    escrowCancellation: escrow_cancel_1.default,
+    escrowCreation: escrow_create_1.default,
+    escrowExecution: escrow_finish_1.default,
+    orderCancellation: offer_cancel_1.default,
+    order: offer_create_1.default,
+    payment: payment_1.default,
+    paymentChannelClaim: payment_channel_claim_1.default,
+    paymentChannelCreate: payment_channel_create_1.default,
+    paymentChannelFund: payment_channel_fund_1.default,
+    ticketCreate: ticket_create_1.default,
+    trustline: trust_set_1.default,
+    nftokenBurn: nftoken_burn_1.default,
+    nftokenMint: nftoken_mint_1.default,
+    NFTokenModify: nftoken_modify_1.default,
+    nftokenCancelOffer: nftoken_cancel_offer_1.default,
+    nftokenCreateOffer: nftoken_create_offer_1.default,
+    nftokenAcceptOffer: nftoken_accept_offer_1.default,
+    uritokenBurn: uritoken_burn_1.default,
+    uritokenBuy: uritoken_buy_1.default,
+    uritokenCreateSellOffer: uritoken_create_sell_offer_1.default,
+    uritokenCancelSellOffer: uritoken_cancel_sell_offer_1.default,
+    uritokenMint: uritoken_mint_1.default,
+    import: import_1.default,
+    invoke: invoke_1.default,
+    unlReport: unl_report_1.default,
+    remit: remit_1.default,
+    clawback: clawback_1.default,
+    ammBid: amm_bid_1.default,
+    ammCreate: amm_create_1.default,
+    ammDelete: amm_delete_1.default,
+    ammDeposit: amm_deposit_1.default,
+    ammWithdraw: amm_withdraw_1.default,
+    ammVote: amm_vote_1.default,
+    AMMClawback: amm_clawback_1.default,
+    didSet: did_set_1.default,
+    didDelete: did_delete_1.default,
+    oracleSet: oracle_set_1.default,
+    oracleDelete: oracle_delete_1.default,
+    MPTokenIssuanceCreate: mptoken_issuance_create_1.default,
+    MPTokenAuthorize: mptoken_authorize_1.default,
+    MPTokenIssuanceSet: mptoken_issuance_set_1.default,
+    MPTokenIssuanceDestroy: mptoken_issuance_destroy_1.default,
+    CredentialCreate: credential_create_1.default,
+    CredentialAccept: credential_accept_1.default,
+    CredentialDelete: credential_delete_1.default,
+    PermissionedDomainSet: permissioned_domain_set_1.default,
+    DelegateSet: delegate_set_1.default,
+    SetRemarks: set_remarks_1.default,
+    genesisMint: genesis_mint_1.default,
+    Batch: batch_1.default,
+    Cron: cron_1.default,
+    CronSet: cron_set_1.default,
+    amendment: amendment_1.default,
+    feeUpdate: fee_update_1.default,
+    UNLModify: unl_modify_1.default,
+};
+function parseTransaction(tx, includeRawTransaction, nativeCurrency, definitions) {
+    let universalTx = tx;
+    if (universalTx.tx_json) {
+        universalTx = { ...universalTx, ...universalTx.tx_json };
+    }
+    const type = parseTransactionType(universalTx.TransactionType);
+    const parser = exports.parserTypeFunc[type];
+    const specification = parser ? parser(universalTx, nativeCurrency, definitions) : (0, unrecognized_1.default)(universalTx);
+    if (!parser && includeRawTransaction !== false) {
+        includeRawTransaction = true;
+    }
+    const outcome = (0, outcome_1.parseOutcome)(universalTx, nativeCurrency, definitions);
+    return (0, common_1.removeUndefined)({
+        type,
+        address: (0, account_1.parseAccount)(universalTx.Account),
+        sequence: universalTx.Sequence,
+        ticketSequence: universalTx.TicketSequence,
+        id: universalTx.hash,
+        ctid: universalTx.ctid,
+        specification: (0, common_1.removeUndefined)(specification),
+        outcome: outcome ? (0, common_1.removeUndefined)(outcome) : undefined,
+        rawTransaction: includeRawTransaction ? JSON.stringify(tx) : undefined,
+    });
+}

package/lib/src/parse/utils.d.ts

@@ -0,0 +1,33 @@
+import { Node, TransactionMetadata } from "xrpl";
+import { IssuedCurrencyAmount, FormattedIssuedCurrencyAmount, FormattedIssuedMPTAmount } from "../types";
+type NormalizedNode = {
+    diffType: string;
+    entryType: string;
+    ledgerIndex: string;
+    newFields: {
+        [field: string]: unknown;
+    };
+    finalFields: {
+        [field: string]: unknown;
+    };
+    previousFields: {
+        [field: string]: unknown;
+    };
+    PreviousTxnID?: string;
+    PreviousTxnLgrSeq?: number;
+};
+declare function adjustQualityForXRP(quality: string, takerGetsCurrency: string | null, takerPaysCurrency: string | null): string;
+declare function parseQuality(quality?: number | null): number | undefined;
+declare function parseTimestamp(rippleTime?: number | null): string | undefined;
+declare function isPartialPayment(tx: any): boolean;
+declare function removeGenericCounterparty(amount: IssuedCurrencyAmount | FormattedIssuedCurrencyAmount | FormattedIssuedMPTAmount, address: string): FormattedIssuedCurrencyAmount | FormattedIssuedMPTAmount;
+declare function normalizeNode(affectedNode: Node): NormalizedNode;
+declare function normalizeNodes(metadata: TransactionMetadata): NormalizedNode[];
+declare function hexToString(hex: string | undefined): string | undefined;
+declare function decodeHexData(data?: string): string | undefined;
+declare function stringToHex(value: string | undefined): string | undefined;
+declare function bytesToHex(value: Uint8Array | ArrayBufferLike): string;
+declare function hexToBytes(value: string): Uint8Array;
+declare function parseUint32(buf: Buffer, cur: number): string;
+declare function parseUint64(buf: Buffer, cur: number): string;
+export { NormalizedNode, parseQuality, parseTimestamp, adjustQualityForXRP, isPartialPayment, removeGenericCounterparty, normalizeNodes, normalizeNode, hexToString, decodeHexData, stringToHex, bytesToHex, hexToBytes, parseUint32, parseUint64, };

package/lib/src/parse/utils.js

@@ -0,0 +1,119 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseQuality = parseQuality;
+exports.parseTimestamp = parseTimestamp;
+exports.adjustQualityForXRP = adjustQualityForXRP;
+exports.isPartialPayment = isPartialPayment;
+exports.removeGenericCounterparty = removeGenericCounterparty;
+exports.normalizeNodes = normalizeNodes;
+exports.normalizeNode = normalizeNode;
+exports.hexToString = hexToString;
+exports.decodeHexData = decodeHexData;
+exports.stringToHex = stringToHex;
+exports.bytesToHex = bytesToHex;
+exports.hexToBytes = hexToBytes;
+exports.parseUint32 = parseUint32;
+exports.parseUint64 = parseUint64;
+const lodash_1 = __importDefault(require("lodash"));
+const bignumber_js_1 = __importDefault(require("bignumber.js"));
+const xrpl_1 = require("xrpl");
+const models_1 = require("../models");
+const client_1 = require("../client");
+function adjustQualityForXRP(quality, takerGetsCurrency, takerPaysCurrency) {
+    const numeratorShift = takerPaysCurrency === (0, client_1.getNativeCurrency)() ? -6 : 0;
+    const denominatorShift = takerGetsCurrency === (0, client_1.getNativeCurrency)() ? -6 : 0;
+    const shift = numeratorShift - denominatorShift;
+    return shift === 0 ? new bignumber_js_1.default(quality).toString() : new bignumber_js_1.default(quality).shiftedBy(shift).toString();
+}
+function parseQuality(quality) {
+    if (typeof quality !== "number") {
+        return undefined;
+    }
+    return new bignumber_js_1.default(quality).shiftedBy(-9).toNumber();
+}
+function parseTimestamp(rippleTime) {
+    if (typeof rippleTime !== "number") {
+        return undefined;
+    }
+    return (0, models_1.ledgerTimeToISO8601)(rippleTime);
+}
+function isPartialPayment(tx) {
+    return (tx.Flags & xrpl_1.PaymentFlags.tfPartialPayment) !== 0;
+}
+function removeGenericCounterparty(amount, address) {
+    if ("counterparty" in amount) {
+        return amount.counterparty === address ? lodash_1.default.omit(amount, "counterparty") : amount;
+    }
+    if ("issuer" in amount) {
+        return amount.issuer === address ? lodash_1.default.omit(amount, "issuer") : amount;
+    }
+    return amount;
+}
+function normalizeNode(affectedNode) {
+    const diffType = Object.keys(affectedNode)[0];
+    const node = affectedNode[diffType];
+    return Object.assign({}, node, {
+        diffType,
+        entryType: node.LedgerEntryType,
+        ledgerIndex: node.LedgerIndex,
+        newFields: node.NewFields || {},
+        finalFields: node.FinalFields || {},
+        previousFields: node.PreviousFields || {},
+    });
+}
+function normalizeNodes(metadata) {
+    if (!metadata.AffectedNodes) {
+        return [];
+    }
+    return metadata.AffectedNodes.map(normalizeNode);
+}
+function hexToString(hex) {
+    return hex ? Buffer.from(hex, "hex").toString("utf-8") : undefined;
+}
+function decodeHexData(data) {
+    if (!data) {
+        return undefined;
+    }
+    const decoded = hexToString(data);
+    if (decoded && decoded.includes("�")) {
+        return data;
+    }
+    return decoded;
+}
+function stringToHex(value) {
+    return value ? Buffer.from(value, "utf8").toString("hex").toUpperCase() : undefined;
+}
+function bytesToHex(value) {
+    return Buffer.from(value)
+        .toString("hex")
+        .toUpperCase();
+}
+function hexToBytes(value) {
+    if (value.length % 2 !== 0) {
+        throw new Error("Invalid hex string length");
+    }
+    if (!/^[0-9a-fA-F]*$/.test(value)) {
+        throw new Error("Invalid hex string");
+    }
+    if (value.length === 0) {
+        return new Uint8Array(0);
+    }
+    return Uint8Array.from(Buffer.from(value, "hex"));
+}
+function parseUint32(buf, cur) {
+    return ((BigInt(buf[cur]) << 24n) + (BigInt(buf[cur + 1]) << 16n) + (BigInt(buf[cur + 2]) << 8n) + BigInt(buf[cur + 3]) + "");
+}
+function parseUint64(buf, cur) {
+    return ((BigInt(buf[cur]) << 56n) +
+        (BigInt(buf[cur + 1]) << 48n) +
+        (BigInt(buf[cur + 2]) << 40n) +
+        (BigInt(buf[cur + 3]) << 32n) +
+        (BigInt(buf[cur + 4]) << 24n) +
+        (BigInt(buf[cur + 5]) << 16n) +
+        (BigInt(buf[cur + 6]) << 8n) +
+        BigInt(buf[cur + 7]) +
+        "");
+}

package/lib/src/types/account.d.ts

@@ -0,0 +1,26 @@
+import { FormattedBaseSpecification } from "./specification";
+import { IssuedCurrencyAmount, FormattedIssuedCurrencyAmount, FormattedIssuedMPTAmount } from "./amounts";
+export type FormattedAccountDeleteSpecification = {
+    source?: FormattedSourceAddress;
+    destination?: FormattedDestinationAddress;
+} & FormattedBaseSpecification;
+export type FormattedSourceAddress = {
+    address: string;
+    maxAmount?: IssuedCurrencyAmount | FormattedIssuedCurrencyAmount | FormattedIssuedMPTAmount;
+    tag?: number;
+};
+export type FormattedDestinationAddress = {
+    address: string;
+    tag?: number;
+};
+export type FormattedSignerRegularKey = {
+    address: string;
+};
+export type FormattedAccountInfoData = {
+    sequence: number;
+    xrpBalance: string;
+    ownerCount: number;
+    previousInitiatedTransactionID?: string;
+    previousAffectingTransactionID: string;
+    previousAffectingTransactionLedgerVersion: number;
+};

package/lib/src/types/account.js

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

package/lib/src/types/adjustments.d.ts

@@ -0,0 +1,16 @@
+import { IssuedCurrencyAmount, FormattedIssuedCurrencyAmount } from "./amounts";
+export type Adjustment = {
+    address: string;
+    amount: IssuedCurrencyAmount | FormattedIssuedCurrencyAmount;
+    tag?: number;
+};
+export type MaxAdjustment = {
+    address: string;
+    maxAmount: IssuedCurrencyAmount | FormattedIssuedCurrencyAmount;
+    tag?: number;
+};
+export type MinAdjustment = {
+    address: string;
+    minAmount: IssuedCurrencyAmount | FormattedIssuedCurrencyAmount;
+    tag?: number;
+};

package/lib/src/types/adjustments.js

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

package/lib/src/types/amendments.d.ts

@@ -0,0 +1,4 @@
+import { FormattedBaseSpecification } from "./specification";
+export type FormattedAmendmentSpecification = {
+    amendment: string;
+} & FormattedBaseSpecification;

package/lib/src/types/amendments.js

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

package/lib/src/types/amm.d.ts

@@ -0,0 +1,98 @@
+import { AMMDepositFlags, AMMWithdrawFlags, AMMClawbackFlags } from "xrpl";
+import { FormattedBaseSpecification } from "./specification";
+import { FormattedAmount, FormattedIssuedCurrency } from "./amounts";
+import { TxGlobalFlagsKeysInterface } from "./global";
+export interface VoteSlotInterface {
+    VoteEntry: {
+        Account: string;
+        TradingFee: number;
+        VoteWeight: number;
+    };
+}
+export declare const AMMDepositFlagsKeys: {
+    lpToken: AMMDepositFlags;
+    singleAsset: AMMDepositFlags;
+    twoAsset: AMMDepositFlags;
+    oneAssetLPToken: AMMDepositFlags;
+    limitLPToken: AMMDepositFlags;
+    twoAssetIfEmpty: AMMDepositFlags;
+};
+export declare function getAMMDepositFlagsKeys(nativeCurrency?: string): Record<string, number>;
+export interface AMMDepositFlagsKeysInterface extends TxGlobalFlagsKeysInterface {
+    lpToken?: boolean;
+    singleAsset?: boolean;
+    twoAsset?: boolean;
+    oneAssetLPToken?: boolean;
+    limitLPToken?: boolean;
+}
+export declare const AMMWithdrawFlagsKeys: {
+    lpToken: AMMWithdrawFlags;
+    withdrawAll: AMMWithdrawFlags;
+    oneAssetWithdrawAll: AMMWithdrawFlags;
+    singleAsset: AMMWithdrawFlags;
+    twoAsset: AMMWithdrawFlags;
+    oneAssetLPToken: AMMWithdrawFlags;
+    limitLPToken: AMMWithdrawFlags;
+};
+export declare function getAMMWithdrawFlagsKeys(nativeCurrency?: string): Record<string, number>;
+export interface AMMWithdrawFlagsKeysInterface extends TxGlobalFlagsKeysInterface {
+    lpToken?: boolean;
+    withdrawAll?: boolean;
+    oneAssetWithdrawAll?: boolean;
+    singleAsset?: boolean;
+    twoAsset?: boolean;
+    oneAssetLPToken?: boolean;
+    limitLPToken?: boolean;
+}
+export declare const AMMClawbackFlagsKeys: {
+    clawTwoAssets: AMMClawbackFlags;
+};
+export declare function getAMMClawbackFlagsKeys(nativeCurrency?: string): Record<string, number>;
+export interface AMMClawbackFlagsKeysInterface extends TxGlobalFlagsKeysInterface {
+    clawTwoAssets?: boolean;
+}
+export type FormattedAmmBidSpecification = {
+    asset?: FormattedIssuedCurrency;
+    asset2?: FormattedIssuedCurrency;
+    bidMin?: FormattedAmount;
+    bidMax?: FormattedAmount;
+    authorizedAccounts?: string[];
+} & FormattedBaseSpecification;
+export type FormattedAmmCreateSpecification = {
+    amount: FormattedAmount;
+    amount2: FormattedAmount;
+    tradingFee: Number;
+} & FormattedBaseSpecification;
+export type FormattedAmmDeleteSpecification = {
+    asset?: FormattedIssuedCurrency;
+    asset2?: FormattedIssuedCurrency;
+} & FormattedBaseSpecification;
+export type FormattedAmmDepositSpecification = {
+    asset?: FormattedIssuedCurrency;
+    asset2?: FormattedIssuedCurrency;
+    amount?: FormattedAmount;
+    amount2?: FormattedAmount;
+    ePrice?: FormattedAmount;
+    lpTokenOut?: FormattedAmount;
+    flags?: AMMDepositFlagsKeysInterface;
+} & FormattedBaseSpecification;
+export type FormattedAmmWithdrawSpecification = {
+    asset?: FormattedIssuedCurrency;
+    asset2?: FormattedIssuedCurrency;
+    amount?: FormattedAmount;
+    amount2?: FormattedAmount;
+    ePrice?: FormattedAmount;
+    lpTokenIn?: FormattedAmount;
+    flags?: AMMWithdrawFlagsKeysInterface;
+} & FormattedBaseSpecification;
+export type FormattedAmmVoteSpecification = {
+    asset?: FormattedIssuedCurrency;
+    asset2?: FormattedIssuedCurrency;
+    tradingFee: Number;
+} & FormattedBaseSpecification;
+export type FormattedAmmClawbackSpecification = {
+    asset?: FormattedIssuedCurrency;
+    asset2?: FormattedIssuedCurrency;
+    amount?: FormattedAmount;
+    holder?: string;
+} & FormattedBaseSpecification;

package/lib/src/types/amm.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AMMClawbackFlagsKeys = exports.AMMWithdrawFlagsKeys = exports.AMMDepositFlagsKeys = void 0;
+exports.getAMMDepositFlagsKeys = getAMMDepositFlagsKeys;
+exports.getAMMWithdrawFlagsKeys = getAMMWithdrawFlagsKeys;
+exports.getAMMClawbackFlagsKeys = getAMMClawbackFlagsKeys;
+const xrpl_1 = require("xrpl");
+const global_1 = require("./global");
+const common_1 = require("../common");
+exports.AMMDepositFlagsKeys = {
+    lpToken: xrpl_1.AMMDepositFlags.tfLPToken,
+    singleAsset: xrpl_1.AMMDepositFlags.tfSingleAsset,
+    twoAsset: xrpl_1.AMMDepositFlags.tfTwoAsset,
+    oneAssetLPToken: xrpl_1.AMMDepositFlags.tfOneAssetLPToken,
+    limitLPToken: xrpl_1.AMMDepositFlags.tfLimitLPToken,
+    twoAssetIfEmpty: xrpl_1.AMMDepositFlags.tfTwoAssetIfEmpty,
+};
+const nativeCurrencyAMMDepositFlags = {};
+function getAMMDepositFlagsKeys(nativeCurrency) {
+    if (!nativeCurrency) {
+        nativeCurrency = common_1.MAINNET_NATIVE_CURRENCY;
+    }
+    if (!nativeCurrencyAMMDepositFlags[nativeCurrency]) {
+        nativeCurrencyAMMDepositFlags[nativeCurrency] = {
+            ...(0, global_1.getTxGlobalFlagsKeys)(nativeCurrency),
+            ...exports.AMMDepositFlagsKeys,
+        };
+    }
+    return nativeCurrencyAMMDepositFlags[nativeCurrency];
+}
+exports.AMMWithdrawFlagsKeys = {
+    lpToken: xrpl_1.AMMWithdrawFlags.tfLPToken,
+    withdrawAll: xrpl_1.AMMWithdrawFlags.tfWithdrawAll,
+    oneAssetWithdrawAll: xrpl_1.AMMWithdrawFlags.tfOneAssetWithdrawAll,
+    singleAsset: xrpl_1.AMMWithdrawFlags.tfSingleAsset,
+    twoAsset: xrpl_1.AMMWithdrawFlags.tfTwoAsset,
+    oneAssetLPToken: xrpl_1.AMMWithdrawFlags.tfOneAssetLPToken,
+    limitLPToken: xrpl_1.AMMWithdrawFlags.tfLimitLPToken,
+};
+const nativeCurrencyAMMWithdrawFlags = {};
+function getAMMWithdrawFlagsKeys(nativeCurrency) {
+    if (!nativeCurrency) {
+        nativeCurrency = common_1.MAINNET_NATIVE_CURRENCY;
+    }
+    if (!nativeCurrencyAMMWithdrawFlags[nativeCurrency]) {
+        nativeCurrencyAMMWithdrawFlags[nativeCurrency] = {
+            ...(0, global_1.getTxGlobalFlagsKeys)(nativeCurrency),
+            ...exports.AMMWithdrawFlagsKeys,
+        };
+    }
+    return nativeCurrencyAMMWithdrawFlags[nativeCurrency];
+}
+exports.AMMClawbackFlagsKeys = {
+    clawTwoAssets: xrpl_1.AMMClawbackFlags.tfClawTwoAssets,
+};
+const nativeCurrencyAMMClawbackFlags = {};
+function getAMMClawbackFlagsKeys(nativeCurrency) {
+    if (!nativeCurrency) {
+        nativeCurrency = common_1.MAINNET_NATIVE_CURRENCY;
+    }
+    if (!nativeCurrencyAMMClawbackFlags[nativeCurrency]) {
+        nativeCurrencyAMMClawbackFlags[nativeCurrency] = {
+            ...(0, global_1.getTxGlobalFlagsKeys)(nativeCurrency),
+            ...exports.AMMClawbackFlagsKeys,
+        };
+    }
+    return nativeCurrencyAMMClawbackFlags[nativeCurrency];
+}

package/lib/src/types/amounts.d.ts

@@ -0,0 +1,20 @@
+export interface IssuedCurrency {
+    currency: string;
+    issuer?: string;
+}
+export interface FormattedIssuedCurrency {
+    currency: string;
+    counterparty?: string;
+}
+export interface IssuedCurrencyAmount extends IssuedCurrency {
+    value: string;
+}
+export interface FormattedIssuedCurrencyAmount extends FormattedIssuedCurrency {
+    value: string;
+}
+export interface FormattedIssuedMPTAmount {
+    mpt_issuance_id?: string;
+    value: string;
+}
+export type Amount = IssuedCurrencyAmount | FormattedIssuedMPTAmount | string;
+export type FormattedAmount = IssuedCurrency | FormattedIssuedCurrencyAmount | FormattedIssuedMPTAmount | string;

package/lib/src/types/amounts.js

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

package/lib/src/types/batch.d.ts

@@ -0,0 +1,21 @@
+import { BatchFlags } from "xrpl/dist/npm/models/transactions/batch";
+import { FormattedBaseSpecification } from "./specification";
+import { FormattedTransaction } from "../parse/transaction";
+import { TxGlobalFlagsKeysInterface } from "./global";
+export declare const BatchFlagsKeys: {
+    allOrNothing: BatchFlags;
+    onlyOne: BatchFlags;
+    untilFailure: BatchFlags;
+    independent: BatchFlags;
+};
+export declare function getBatchFlagsKeys(nativeCurrency?: string): Record<string, number>;
+export interface BatchFlagsKeysInterface extends TxGlobalFlagsKeysInterface {
+    allOrNothing?: boolean;
+    onlyOne?: boolean;
+    untilFailure?: boolean;
+    independent?: boolean;
+}
+export type FormattedBatchSpecification = {
+    transactions: FormattedTransaction[];
+    flags?: BatchFlagsKeysInterface;
+} & FormattedBaseSpecification;