@bithomp/xrpl-api 2.7.15 → 3.0.0

package/lib/types/fees.d.ts

@@ -0,0 +1,7 @@
+import { FormattedBaseSpecification } from "./specification";
+export type FormattedFeeUpdateSpecification = {
+    baseFeeXRP: string;
+    referenceFeeUnits: number;
+    reserveBaseXRP: string;
+    reserveIncrementXRP: string;
+} & FormattedBaseSpecification;

package/lib/types/fees.js

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

package/lib/types/flags.d.ts

@@ -0,0 +1,5 @@
+declare const orderFlags: {
+    Passive: number;
+    Sell: number;
+};
+export { orderFlags };

package/lib/types/flags.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.orderFlags = void 0;
+const orderFlags = {
+    Passive: 0x00010000,
+    Sell: 0x00020000,
+};
+exports.orderFlags = orderFlags;

package/lib/types/hooks.d.ts

@@ -0,0 +1,14 @@
+export interface HookExecutionObjectInterface {
+    HookExecution: HookExecutionInterface;
+}
+export interface HookExecutionInterface {
+    HookAccount: string;
+    HookEmitCount: number;
+    HookExecutionIndex: number;
+    HookHash: string;
+    HookInstructionCount: string;
+    HookResult: number;
+    HookReturnCode: string;
+    HookReturnString: string;
+    HookStateChangeCount: number;
+}

package/lib/types/hooks.js

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

package/lib/types/import.d.ts

@@ -0,0 +1,23 @@
+import { FormattedBaseSpecification } from "./specification";
+import { FormattedSourceAddress } from "./account";
+import { FormattedSpecification } from "../parse/transaction";
+import { Outcome } from "./outcome";
+export type FormattedImportBlobSpecification = {
+    ledger: number;
+    validation: {
+        data: any;
+        unl: any;
+    };
+    transaction: {
+        id: string;
+        tx: any;
+        meta: any;
+        proof: any;
+        specification: FormattedSpecification;
+        outcome?: Outcome;
+    };
+};
+export type FormattedImportSpecification = {
+    source: FormattedSourceAddress;
+    blob: FormattedImportBlobSpecification | string;
+} & FormattedBaseSpecification;

package/lib/types/import.js

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

package/lib/types/index.d.ts

@@ -1 +1,24 @@
-export { IssuedCurrency, FormattedIssuedCurrency, IssuedCurrencyAmount, FormattedIssuedCurrencyAmount, Amount, FormattedAmount, } from "./amounts";
+export * from "./adjustments";
+export * from "./amounts";
+export * from "./ledger";
+export * from "./ledger_data";
+export * from "./ledger_entries";
+export * from "./memos";
+export * from "./checks";
+export * from "./deposits";
+export * from "./escrows";
+export * from "./offers";
+export * from "./queue_data";
+export * from "./settings";
+export * from "./signers";
+export * from "./transactions";
+export * from "./trustlines";
+export * from "./nftokens";
+export * from "./uritokens";
+export * from "./amendments";
+export * from "./fees";
+export * from "./import";
+export * from "./invoke";
+export * from "./unl_reports";
+export * from "./remits";
+export * from "./hooks";

package/lib/types/index.js

@@ -1,2 +1,40 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./adjustments"), exports);
+__exportStar(require("./amounts"), exports);
+__exportStar(require("./ledger"), exports);
+__exportStar(require("./ledger_data"), exports);
+__exportStar(require("./ledger_entries"), exports);
+__exportStar(require("./memos"), exports);
+__exportStar(require("./checks"), exports);
+__exportStar(require("./deposits"), exports);
+__exportStar(require("./escrows"), exports);
+__exportStar(require("./offers"), exports);
+__exportStar(require("./queue_data"), exports);
+__exportStar(require("./settings"), exports);
+__exportStar(require("./signers"), exports);
+__exportStar(require("./transactions"), exports);
+__exportStar(require("./trustlines"), exports);
+__exportStar(require("./nftokens"), exports);
+__exportStar(require("./uritokens"), exports);
+__exportStar(require("./amendments"), exports);
+__exportStar(require("./fees"), exports);
+__exportStar(require("./import"), exports);
+__exportStar(require("./invoke"), exports);
+__exportStar(require("./unl_reports"), exports);
+__exportStar(require("./remits"), exports);
+__exportStar(require("./hooks"), exports);

package/lib/types/invoke.d.ts

@@ -0,0 +1,6 @@
+import { FormattedBaseSpecification } from "./specification";
+import { FormattedSourceAddress, FormattedDestinationAddress } from "./account";
+export type FormattedInvokeSpecification = {
+    source: FormattedSourceAddress;
+    destination: FormattedDestinationAddress;
+} & FormattedBaseSpecification;

package/lib/types/invoke.js

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

package/lib/types/ledger.d.ts

@@ -0,0 +1,45 @@
+export interface Ledger {
+    account_hash: string;
+    close_time: number;
+    close_time_human: string;
+    close_time_resolution: number;
+    closed: boolean;
+    ledger_hash: string;
+    ledger_index: string;
+    parent_hash: string;
+    total_coins: string;
+    transaction_hash: string;
+    transactions: string[] | object[];
+    close_flags?: number;
+    parent_close_time?: number;
+    accountState?: any[];
+    validated?: boolean;
+}
+export type FormattedLedger = {
+    stateHash: string;
+    closeTime: string;
+    closeTimeResolution: number;
+    closeFlags: number;
+    ledgerHash: string;
+    ledgerVersion: number;
+    parentLedgerHash: string;
+    parentCloseTime: string;
+    totalDrops: string;
+    transactionHash: string;
+    transactions?: object[];
+    transactionHashes?: string[];
+    rawState?: string;
+    stateHashes?: string[];
+};
+export type LedgerClosedEvent = {
+    type: "ledgerClosed";
+    fee_base: number;
+    fee_ref: number;
+    ledger_hash: string;
+    ledger_index: number;
+    ledger_time: number;
+    reserve_base: number;
+    reserve_inc: number;
+    txn_count: number;
+    validated_ledgers: string;
+};

package/lib/types/ledger.js

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

package/lib/types/ledger_data.d.ts

@@ -0,0 +1,10 @@
+export interface LedgerData {
+    ledger_index: string;
+    ledger_hash: string;
+    marker: string;
+    state: ({
+        data?: string;
+        LedgerEntryType?: string;
+        index: string;
+    } & any)[];
+}

package/lib/types/ledger_data.js

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

package/lib/types/ledger_entries.d.ts

@@ -0,0 +1,158 @@
+import { SignerEntry } from "./signers";
+import { Amount } from "./amounts";
+export interface AccountRootLedgerEntry {
+    LedgerEntryType: "AccountRoot";
+    Account: string;
+    Balance: string;
+    Flags: number;
+    OwnerCount: number;
+    PreviousTxnID: string;
+    PreviousTxnLgrSeq: number;
+    Sequence: number;
+    AccountTxnID?: string;
+    Domain?: string;
+    EmailHash?: string;
+    MessageKey?: string;
+    RegularKey?: string;
+    TickSize?: number;
+    TransferRate?: number;
+    WalletLocator?: string;
+    WalletSize?: number;
+}
+export interface AmendmentsLedgerEntry {
+    LedgerEntryType: "Amendments";
+    Amendments?: string[];
+    Majorities?: any[];
+    Flags: 0;
+}
+export interface CheckLedgerEntry {
+    LedgerEntryType: "Check";
+    Account: string;
+    Destination: any;
+    string: any;
+    Flags: 0;
+    OwnerNode: string;
+    PreviousTxnID: string;
+    PreviousTxnLgrSeq: number;
+    SendMax: string | object;
+    Sequence: number;
+    DestinationNode: string;
+    DestinationTag: number;
+    Expiration: number;
+    InvoiceID: string;
+    SourceTag: number;
+}
+export interface DepositPreauthLedgerEntry {
+    LedgerEntryType: "DepositPreauth";
+    Account: string;
+    Authorize: string;
+    OwnerNode: string;
+    PreviousTxnID: string;
+    PreviousTxnLgrSeq: number;
+}
+export interface DirectoryNodeLedgerEntry {
+    LedgerEntryType: "DirectoryNode";
+    Flags: number;
+    RootIndex: string;
+    Indexes: string[];
+    IndexNext?: number;
+    IndexPrevious?: number;
+}
+export interface OfferDirectoryNodeLedgerEntry extends DirectoryNodeLedgerEntry {
+    TakerPaysCurrency: string;
+    TakerPaysIssuer: string;
+    TakerGetsCurrency: string;
+    TakerGetsIssuer: string;
+    ExchangeRate?: number;
+}
+export interface OwnerDirectoryNodeLedgerEntry extends DirectoryNodeLedgerEntry {
+    Owner: string;
+}
+export interface EscrowLedgerEntry {
+    LedgerEntryType: "Escrow";
+    Account: string;
+    Destination: string;
+    Amount: string;
+    Condition?: string;
+    CancelAfter?: number;
+    FinishAfter?: number;
+    Flags: number;
+    SourceTag?: number;
+    DestinationTag?: number;
+    OwnerNode: string;
+    DestinationNode?: string;
+    PreviousTxnID: string;
+    PreviousTxnLgrSeq: number;
+}
+export interface FeeSettingsLedgerEntry {
+    LedgerEntryType: "FeeSettings";
+    BaseFee: string;
+    ReferenceFeeUnits: number;
+    ReserveBase: number;
+    ReserveIncrement: number;
+    Flags: number;
+}
+export interface LedgerHashesLedgerEntry {
+    LedgerEntryType: "LedgerHashes";
+    Hashes: string[];
+    Flags: number;
+    FirstLedgerSequence?: number;
+    LastLedgerSequence?: number;
+}
+export interface OfferLedgerEntry {
+    LedgerEntryType: "Offer";
+    Flags: number;
+    Account: string;
+    Sequence: number;
+    TakerPays: Amount;
+    TakerGets: Amount;
+    BookDirectory: string;
+    BookNode: string;
+    OwnerNode: string;
+    PreviousTxnID: string;
+    PreviousTxnLgrSeq: number;
+    Expiration?: number;
+}
+export interface PayChannelLedgerEntry {
+    LedgerEntryType: "PayChannel";
+    Sequence: number;
+    Account: string;
+    Amount: string;
+    Balance: string;
+    PublicKey: string;
+    Destination: string;
+    SettleDelay: number;
+    Expiration?: number;
+    CancelAfter?: number;
+    SourceTag?: number;
+    DestinationTag?: number;
+    OwnerNode: string;
+    PreviousTxnID: string;
+    PreviousTxnLgrSeq: number;
+    index: string;
+}
+export interface RippleStateLedgerEntry {
+    LedgerEntryType: "RippleState";
+    Flags: number;
+    Balance: Amount;
+    LowLimit: Amount;
+    HighLimit: Amount;
+    PreviousTxnID: string;
+    PreviousTxnLgrSeq: number;
+    LowNode?: string;
+    HighNode?: string;
+    LowQualityIn?: number;
+    LowQualityOut?: number;
+    HighQualityIn?: number;
+    HighQualityOut?: number;
+}
+export interface SignerListLedgerEntry {
+    LedgerEntryType: "SignerList";
+    OwnerNode: string;
+    SignerQuorum: number;
+    SignerEntries: SignerEntry[];
+    SignerListID: number;
+    PreviousTxnID: string;
+    PreviousTxnLgrSeq: number;
+}
+export type LedgerEntry = AccountRootLedgerEntry | AmendmentsLedgerEntry | CheckLedgerEntry | DepositPreauthLedgerEntry | DirectoryNodeLedgerEntry | OfferDirectoryNodeLedgerEntry | OwnerDirectoryNodeLedgerEntry | EscrowLedgerEntry | FeeSettingsLedgerEntry | LedgerHashesLedgerEntry | OfferLedgerEntry | PayChannelLedgerEntry | RippleStateLedgerEntry | SignerListLedgerEntry;

package/lib/types/ledger_entries.js

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

package/lib/types/memos.d.ts

@@ -0,0 +1,12 @@
+export type Memo = {
+    Memo: {
+        MemoData?: string;
+        MemoType?: string;
+        MemoFormat?: string;
+    };
+};
+export type FormattedMemo = {
+    type?: string;
+    format?: string;
+    data?: string;
+};

package/lib/types/memos.js

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

package/lib/types/nftokens.d.ts

@@ -0,0 +1,50 @@
+import { NFTokenMintFlags, NFTokenCreateOfferFlags } from "xrpl";
+import { FormattedBaseSpecification } from "./specification";
+import { Amount } from "./amounts";
+import { FormattedSourceAddress, FormattedDestinationAddress } from "./account";
+export declare const NFTokenFlagsKeys: {
+    burnable: NFTokenMintFlags;
+    onlyXRP: NFTokenMintFlags;
+    trustLine: NFTokenMintFlags;
+    transferable: NFTokenMintFlags;
+};
+export interface NFTokenFlagsKeysInterface {
+    burnable?: boolean;
+    onlyXRP?: boolean;
+    trustLine?: boolean;
+    transferable?: boolean;
+}
+export declare const NFTokenOfferFlagsKeys: {
+    sellToken: NFTokenCreateOfferFlags;
+};
+export interface NFTokenOfferFlagsKeysInterface {
+    sellToken?: boolean;
+}
+export type FormattedNFTokenBurnSpecification = {
+    account: string;
+    nftokenID: string;
+} & FormattedBaseSpecification;
+export type FormattedNFTokenMintSpecification = {
+    nftokenTaxon: number;
+    issuer?: string;
+    transferFee?: number;
+    uri?: string;
+    flags?: NFTokenFlagsKeysInterface;
+} & FormattedBaseSpecification;
+export type FormattedNFTokenCancelOfferSpecification = {
+    nftokenOffers: string[];
+} & FormattedBaseSpecification;
+export type FormattedNFTokenCreateOfferSpecification = {
+    nftokenID: string;
+    amount: Amount;
+    owner?: string;
+    source?: FormattedSourceAddress;
+    destination?: FormattedDestinationAddress;
+    expiration?: number;
+    flags?: NFTokenOfferFlagsKeysInterface;
+} & FormattedBaseSpecification;
+export type FormattedNFTokenAcceptOfferSpecification = {
+    nftokenSellOffer?: string;
+    nftokenBuyOffer?: string;
+    nftokenBrokerFee?: string;
+} & FormattedBaseSpecification;

package/lib/types/nftokens.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NFTokenOfferFlagsKeys = exports.NFTokenFlagsKeys = void 0;
+const xrpl_1 = require("xrpl");
+exports.NFTokenFlagsKeys = {
+    burnable: xrpl_1.NFTokenMintFlags.tfBurnable,
+    onlyXRP: xrpl_1.NFTokenMintFlags.tfOnlyXRP,
+    trustLine: xrpl_1.NFTokenMintFlags.tfTrustLine,
+    transferable: xrpl_1.NFTokenMintFlags.tfTransferable,
+};
+exports.NFTokenOfferFlagsKeys = {
+    sellToken: xrpl_1.NFTokenCreateOfferFlags.tfSellNFToken,
+};

package/lib/types/offers.d.ts

@@ -0,0 +1,15 @@
+import { FormattedBaseSpecification } from "./specification";
+import { FormattedIssuedCurrencyAmount } from "./amounts";
+export type FormattedOfferCancelSpecification = {
+    orderSequence: number;
+} & FormattedBaseSpecification;
+export type FormattedOfferCreateSpecification = {
+    direction: string;
+    quantity: FormattedIssuedCurrencyAmount;
+    totalPrice: FormattedIssuedCurrencyAmount;
+    immediateOrCancel?: boolean;
+    fillOrKill?: boolean;
+    expirationTime?: string;
+    orderToReplace?: number;
+    passive?: boolean;
+} & FormattedBaseSpecification;

package/lib/types/offers.js

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

package/lib/types/outcome.d.ts

@@ -0,0 +1,33 @@
+export type Outcome = {
+    result?: string;
+    ledgerVersion?: number;
+    indexInLedger?: number;
+    fee?: string;
+    balanceChanges?: {
+        [key: string]: {
+            currency: string;
+            counterparty?: string;
+            value: string;
+        }[];
+    };
+    lockedBalanceChanges?: {
+        [key: string]: {
+            currency: string;
+            counterparty?: string;
+            value: string;
+        }[];
+    };
+    orderbookChanges?: object;
+    channelChanges?: object;
+    nftokenChanges?: object;
+    nftokenOfferChanges?: object;
+    uritokenChanges?: object;
+    uritokenSellOfferChanges?: object;
+    affectedObjects?: object;
+    deliveredAmount?: {
+        currency: string;
+        counterparty?: string;
+        value: string;
+    };
+    timestamp?: string;
+};

package/lib/types/outcome.js

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

package/lib/types/path_find.d.ts

@@ -0,0 +1,28 @@
+import { FormattedIssuedCurrencyAmount } from "./amounts";
+import { Adjustment, MaxAdjustment, MinAdjustment } from "./adjustments";
+export type LaxLaxAmount = {
+    currency: string;
+    value?: string;
+    issuer?: string;
+    counterparty?: string;
+};
+export type Path = {
+    source: Adjustment | MaxAdjustment;
+    destination: Adjustment | MinAdjustment;
+    paths: string;
+};
+export type GetPaths = Path[];
+export type PathFind = {
+    source: {
+        address: string;
+        amount?: FormattedIssuedCurrencyAmount;
+        currencies?: {
+            currency: string;
+            counterparty?: string;
+        }[];
+    };
+    destination: {
+        address: string;
+        amount: LaxLaxAmount;
+    };
+};

package/lib/types/path_find.js

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

package/lib/types/payment_channels.d.ts

@@ -0,0 +1,25 @@
+import { FormattedBaseSpecification } from "./specification";
+import { FormattedAmount } from "./amounts";
+import { FormattedSourceAddress, FormattedDestinationAddress } from "./account";
+export type FormattedPaymentChannelClaimSpecification = {
+    channel: string;
+    balance?: FormattedAmount;
+    amount?: FormattedAmount;
+    signature: string;
+    publicKey: string;
+    renew?: boolean;
+    close?: boolean;
+} & FormattedBaseSpecification;
+export type FormattedPaymentChannelCreateSpecification = {
+    source?: FormattedSourceAddress;
+    destination?: FormattedDestinationAddress;
+    amount?: FormattedAmount;
+    settleDelay: number;
+    publicKey?: string;
+    cancelAfter?: string;
+} & FormattedBaseSpecification;
+export type FormattedPaymentChannelFundSpecification = {
+    channel: string;
+    amount?: FormattedAmount;
+    expiration?: string;
+} & FormattedBaseSpecification;

package/lib/types/payment_channels.js

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

package/lib/types/payments.d.ts

@@ -0,0 +1,11 @@
+import { FormattedBaseSpecification } from "./specification";
+import { FormattedSourceAddress, FormattedDestinationAddress } from "./account";
+export type FormattedPaymentSpecification = {
+    source: FormattedSourceAddress;
+    destination: FormattedDestinationAddress;
+    invoiceID?: string;
+    paths?: string;
+    allowPartialPayment?: boolean;
+    noDirectRipple?: boolean;
+    limitQuality?: boolean;
+} & FormattedBaseSpecification;

package/lib/types/payments.js

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

package/lib/types/queue_data.d.ts

@@ -0,0 +1,15 @@
+export interface QueueTransaction {
+    auth_change: boolean;
+    fee: string;
+    fee_level: string;
+    max_spend_drops: string;
+    seq: number;
+}
+export interface QueueData {
+    txn_count: number;
+    auth_change_queued?: boolean;
+    lowest_sequence?: number;
+    highest_sequence?: number;
+    max_spend_drops_total?: string;
+    transactions?: QueueTransaction[];
+}

package/lib/types/queue_data.js

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

package/lib/types/remits.d.ts

@@ -0,0 +1,18 @@
+import { FormattedBaseSpecification } from "./specification";
+import { FormattedDestinationAddress, FormattedSourceAddress } from "./account";
+import { Amount } from "./amounts";
+import { URITokenFlagsKeysInterface } from "./uritokens";
+export type FormattedRemitsSpecification = {
+    source: FormattedSourceAddress;
+    destination: FormattedDestinationAddress;
+    amounts?: Amount[];
+    uritokenIDs?: string[];
+    uritokenMint?: {
+        uri: string;
+        flags?: URITokenFlagsKeysInterface;
+        digest?: string;
+    };
+    blob?: string;
+    inform?: string;
+    invoiceID?: string;
+} & FormattedBaseSpecification;

package/lib/types/remits.js

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