@bithomp/xrpl-api
Version:
A Bithomp JavaScript/TypeScript library for interacting with the XRP Ledger
163 lines (162 loc) • 12.2 kB
TypeScript
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";
import { FormattedDepositPreauthSpecification } from "../types/deposits";
import { FormattedEscrowCancelSpecification, FormattedEscrowCreateSpecification, FormattedEscrowFinishSpecification } from "../types/escrows";
import { FormattedOfferCancelSpecification, FormattedOfferCreateSpecification } from "../types/offers";
import { FormattedPaymentSpecification } from "../types/payments";
import { FormattedPaymentChannelClaimSpecification, FormattedPaymentChannelCreateSpecification, FormattedPaymentChannelFundSpecification } from "../types/payment_channels";
import { FormattedTicketCreateSpecification } from "../types/tickets";
import { FormattedTrustlineSpecification } from "../types/trustlines";
import { FormattedNFTokenBurnSpecification, FormattedNFTokenMintSpecification, FormattedNFTokenModifySpecification, FormattedNFTokenCancelOfferSpecification, FormattedNFTokenCreateOfferSpecification, FormattedNFTokenAcceptOfferSpecification } from "../types/nftokens";
import { FormattedURITokenBurnSpecification, FormattedURITokenBuySpecification, FormattedURITokenCreateSellOfferSpecification, FormattedURITokenCancelSellOfferSpecification, FormattedURITokenMintSpecification } from "../types/uritokens";
import { FormattedImportSpecification } from "../types/import";
import { FormattedInvokeSpecification } from "../types/invoke";
import { FormattedUNLReportSpecification } from "../types/unl_reports";
import { FormattedRemitsSpecification } from "../types/remits";
import { FormattedClawbackSpecification } from "../types/clawback";
import { FormattedAmmBidSpecification, FormattedAmmCreateSpecification, FormattedAmmDeleteSpecification, FormattedAmmDepositSpecification, FormattedAmmWithdrawSpecification, FormattedAmmVoteSpecification, FormattedAmmClawbackSpecification } from "../types/amm";
import { FormattedDIDSetSpecification, FormattedDIDDeleteSpecification } from "../types/did";
import { FormattedOracleSetSpecification, FormattedOracleDeleteSpecification } from "../types/oracle";
import { FormattedMPTokenIssuanceCreateSpecification, FormattedMPTokenAuthorizeSpecification, FormattedMPTokenIssuanceSetSpecification, FormattedMPTokenIssuanceDestroySpecification } from "../types/mptokens";
import { FormattedCredentialCreateSpecification, FormattedCredentialAcceptSpecification, FormattedCredentialDeleteSpecification } from "../types/credentials";
import { FormattedDelegateSetSpecification } from "../types/delegate";
import { FormattedSetRemarksSpecification } from "../types/remarks";
import { FormattedGenesisMintSpecification } from "../types/genesis_mint";
import { FormattedBatchSpecification } from "../types/batch";
import { FormattedAmendmentSpecification } from "../types/amendments";
import { FormattedFeeUpdateSpecification } from "../types/fees";
import parseSettings from "./specification/settings";
import parseAccountDelete from "./specification/account-delete";
import parseCheckCancel from "./specification/check-cancel";
import parseCheckCash from "./specification/check-cash";
import parseCheckCreate from "./specification/check-create";
import parseDepositPreauth from "./specification/deposit-preauth";
import parseEscrowCancel from "./specification/escrow-cancel";
import parseEscrowCreation from "./specification/escrow-create";
import parseEscrowFinish from "./specification/escrow-finish";
import parseOfferCancel from "./specification/offer-cancel";
import parseOfferCreate from "./specification/offer-create";
import parsePayment from "./specification/payment";
import parsePaymentChannelClaim from "./specification/payment-channel-claim";
import parsePaymentChannelCreate from "./specification/payment-channel-create";
import parsePaymentChannelFund from "./specification/payment-channel-fund";
import parseTicketCreate from "./specification/ticket-create";
import parseTrustSet from "./specification/trust-set";
import parseNFTokenBurn from "./specification/nftoken-burn";
import parseNFTokenMint from "./specification/nftoken-mint";
import parseNFTokenModify from "./specification/nftoken-modify";
import parseNFTokenCancelOffer from "./specification/nftoken-cancel-offer";
import parseNFTokenCreateOffer from "./specification/nftoken-create-offer";
import parseNFTokenAcceptOffer from "./specification/nftoken-accept-offer";
import parseURITokenBurn from "./specification/uritoken-burn";
import parseURITokenBuy from "./specification/uritoken-buy";
import parseURITokenCancelSellOffer from "./specification/uritoken-cancel-sell-offer";
import parseURITokenCreateSellOffer from "./specification/uritoken-create-sell-offer";
import parseURITokenMint from "./specification/uritoken-mint";
import parseImport from "./specification/import";
import parseInvoke from "./specification/invoke";
import parseUNLReport from "./specification/unl-report";
import parseRemit from "./specification/remit";
import parseClawback from "./specification/clawback";
import parseAmmBid from "./specification/amm-bid";
import parseAmmCreate from "./specification/amm-create";
import parseAmmDelete from "./specification/amm-delete";
import parseAmmDeposit from "./specification/amm-deposit";
import parseAmmWithdraw from "./specification/amm-withdraw";
import parseAmmVote from "./specification/amm-vote";
import parseAmmClawback from "./specification/amm-clawback";
import parseDIDSet from "./specification/did-set";
import parseDIDDelete from "./specification/did-delete";
import parseOracleSet from "./specification/oracle-set";
import parseOracleDelete from "./specification/oracle-delete";
import parseMPTokenIssuanceCreate from "./specification/mptoken-issuance-create";
import parseMPTokenAuthorize from "./specification/mptoken-authorize";
import parseMPTokenIssuanceSet from "./specification/mptoken-issuance-set";
import parseMPTokenIssuanceDestroy from "./specification/mptoken-issuance-destroy";
import parseDelegateSet from "./specification/delegate-set";
import parseSetRemarks from "./specification/set-remarks";
import parseCredentialCreate from "./specification/credential-create";
import parseCredentialAccept from "./specification/credential-accept";
import parseCredentialDelete from "./specification/credential-delete";
import parseGenesisMint from "./specification/genesis-mint";
import parseBatch from "./specification/batch";
import parseAmendment from "./specification/amendment";
import parseFeeUpdate from "./specification/fee-update";
import parseUNLModify from "./specification/unl-modify";
declare function parseTransactionType(type: string): string;
export declare const parserTypeFunc: {
settings: typeof parseSettings;
accountDelete: typeof parseAccountDelete;
checkCancel: typeof parseCheckCancel;
checkCash: typeof parseCheckCash;
checkCreate: typeof parseCheckCreate;
depositPreauth: typeof parseDepositPreauth;
escrowCancellation: typeof parseEscrowCancel;
escrowCreation: typeof parseEscrowCreation;
escrowExecution: typeof parseEscrowFinish;
orderCancellation: typeof parseOfferCancel;
order: typeof parseOfferCreate;
payment: typeof parsePayment;
paymentChannelClaim: typeof parsePaymentChannelClaim;
paymentChannelCreate: typeof parsePaymentChannelCreate;
paymentChannelFund: typeof parsePaymentChannelFund;
ticketCreate: typeof parseTicketCreate;
trustline: typeof parseTrustSet;
nftokenBurn: typeof parseNFTokenBurn;
nftokenMint: typeof parseNFTokenMint;
NFTokenModify: typeof parseNFTokenModify;
nftokenCancelOffer: typeof parseNFTokenCancelOffer;
nftokenCreateOffer: typeof parseNFTokenCreateOffer;
nftokenAcceptOffer: typeof parseNFTokenAcceptOffer;
uritokenBurn: typeof parseURITokenBurn;
uritokenBuy: typeof parseURITokenBuy;
uritokenCreateSellOffer: typeof parseURITokenCreateSellOffer;
uritokenCancelSellOffer: typeof parseURITokenCancelSellOffer;
uritokenMint: typeof parseURITokenMint;
import: typeof parseImport;
invoke: typeof parseInvoke;
unlReport: typeof parseUNLReport;
remit: typeof parseRemit;
clawback: typeof parseClawback;
ammBid: typeof parseAmmBid;
ammCreate: typeof parseAmmCreate;
ammDelete: typeof parseAmmDelete;
ammDeposit: typeof parseAmmDeposit;
ammWithdraw: typeof parseAmmWithdraw;
ammVote: typeof parseAmmVote;
AMMClawback: typeof parseAmmClawback;
didSet: typeof parseDIDSet;
didDelete: typeof parseDIDDelete;
oracleSet: typeof parseOracleSet;
oracleDelete: typeof parseOracleDelete;
MPTokenIssuanceCreate: typeof parseMPTokenIssuanceCreate;
MPTokenAuthorize: typeof parseMPTokenAuthorize;
MPTokenIssuanceSet: typeof parseMPTokenIssuanceSet;
MPTokenIssuanceDestroy: typeof parseMPTokenIssuanceDestroy;
CredentialCreate: typeof parseCredentialCreate;
CredentialAccept: typeof parseCredentialAccept;
CredentialDelete: typeof parseCredentialDelete;
DelegateSet: typeof parseDelegateSet;
SetRemarks: typeof parseSetRemarks;
genesisMint: typeof parseGenesisMint;
Batch: typeof parseBatch;
amendment: typeof parseAmendment;
feeUpdate: typeof parseFeeUpdate;
UNLModify: typeof parseUNLModify;
};
export type FormattedSpecification = FormattedUnrecognizedParserSpecification | FormattedSettingsSpecification | FormattedAccountDeleteSpecification | FormattedCheckCancelSpecification | FormattedCheckCashSpecification | FormattedCheckCreateSpecification | FormattedDepositPreauthSpecification | FormattedEscrowCancelSpecification | FormattedEscrowCreateSpecification | FormattedEscrowFinishSpecification | FormattedOfferCancelSpecification | FormattedOfferCreateSpecification | FormattedPaymentSpecification | FormattedPaymentChannelClaimSpecification | FormattedPaymentChannelCreateSpecification | FormattedPaymentChannelFundSpecification | FormattedTicketCreateSpecification | FormattedTrustlineSpecification | FormattedNFTokenBurnSpecification | FormattedNFTokenMintSpecification | FormattedNFTokenModifySpecification | FormattedNFTokenCancelOfferSpecification | FormattedNFTokenCreateOfferSpecification | FormattedNFTokenAcceptOfferSpecification | FormattedURITokenBurnSpecification | FormattedURITokenBuySpecification | FormattedURITokenCreateSellOfferSpecification | FormattedURITokenCancelSellOfferSpecification | FormattedURITokenMintSpecification | FormattedImportSpecification | FormattedInvokeSpecification | FormattedUNLReportSpecification | FormattedRemitsSpecification | FormattedClawbackSpecification | FormattedAmmBidSpecification | FormattedAmmCreateSpecification | FormattedAmmDeleteSpecification | FormattedAmmDepositSpecification | FormattedAmmWithdrawSpecification | FormattedAmmVoteSpecification | FormattedAmmClawbackSpecification | FormattedDIDSetSpecification | FormattedDIDDeleteSpecification | FormattedOracleSetSpecification | FormattedOracleDeleteSpecification | FormattedMPTokenIssuanceCreateSpecification | FormattedMPTokenAuthorizeSpecification | FormattedMPTokenIssuanceSetSpecification | FormattedMPTokenIssuanceDestroySpecification | FormattedCredentialCreateSpecification | FormattedCredentialAcceptSpecification | FormattedCredentialDeleteSpecification | FormattedDelegateSetSpecification | FormattedSetRemarksSpecification | FormattedGenesisMintSpecification | FormattedBatchSpecification | FormattedAmendmentSpecification | FormattedFeeUpdateSpecification;
export interface FormattedTransaction {
type: string;
address: string;
sequence: number;
id: string;
specification: FormattedSpecification;
outcome?: Outcome;
rawTransaction?: string;
}
declare function parseTransaction(tx: any, includeRawTransaction?: boolean, nativeCurrency?: string, definitions?: XrplDefinitionsBase): FormattedTransaction;
export { parseTransactionType, parseTransaction };