xrpl

Index

Clients

Client

Signing

Wallet multisign

Transaction Models

AccountDelete AccountSet CheckCancel CheckCash CheckCreate DIDDelete DIDSet DepositPreauth EscrowCancel EscrowCreate EscrowFinish OfferCancel OfferCreate Payment PaymentChannelClaim PaymentChannelCreate PaymentChannelFund SetRegularKey SignerListSet TicketCreate TransactionAndMetadata TrustSet XChainAccountCreateCommit XChainAddAccountCreateAttestation XChainAddClaimAttestation XChainClaim XChainCommit XChainCreateBridge XChainCreateClaimID XChainModifyBridge PseudoTransaction SubmittableTransaction Transaction

Transaction Flags

AMMDepositFlags AMMWithdrawFlags AccountSetAsfFlags AccountSetTfFlags EnableAmendmentFlags NFTokenCreateOfferFlags NFTokenMintFlags OfferCreateFlags PaymentChannelClaimFlags PaymentFlags TrustSetFlags XChainModifyBridgeFlags AccountSetFlagsInterface NFTokenCreateOfferFlagsInterface NFTokenMintFlagsInterface OfferCreateFlagsInterface PaymentChannelClaimFlagsInterface PaymentFlagsInterface TrustSetFlagsInterface XChainModifyBridgeFlagsInterface

Utilities

hashes convertHexToString convertStringToHex decimalToQuality decimalToTransferRate deriveXAddress dropsToXrp getBalanceChanges hasNextPage isValidAddress isValidSecret isoTimeToRippleTime percentToQuality percentToTransferRate qualityToDecimal rippleTimeToISOTime rippleTimeToUnixTime signPaymentChannelClaim transferRateToDecimal unixTimeToRippleTime validate verifyPaymentChannelClaim verifySignature xrpToDrops

Requests

AMMInfoRequest AccountChannelsRequest AccountCurrenciesRequest AccountInfoRequest AccountLinesRequest AccountNFTsRequest AccountObjectsRequest AccountOffersRequest AccountTxRequest BookOffersRequest ChannelVerifyRequest DepositAuthorizedRequest FeeRequest GatewayBalancesRequest LedgerClosedRequest LedgerCurrentRequest LedgerDataRequest LedgerEntryRequest LedgerRequest ManifestRequest NFTBuyOffersRequest NFTHistoryRequest NFTInfoRequest NFTSellOffersRequest NoRippleCheckRequest PingRequest RandomRequest RipplePathFindRequest ServerDefinitionsRequest ServerInfoRequest ServerStateRequest SubmitMultisignedRequest SubmitRequest SubscribeRequest TransactionEntryRequest TxRequest UnsubscribeRequest PathFindRequest Request

Responses

AMMInfoResponse AccountChannelsResponse AccountCurrenciesResponse AccountInfoResponse AccountLinesResponse AccountNFToken AccountNFTsResponse AccountObjectsResponse AccountOffersResponse AccountTxResponse BookOffersResponse ChannelVerifyResponse DepositAuthorizedResponse ErrorResponse FeeResponse GatewayBalancesResponse LedgerClosedResponse LedgerCurrentResponse LedgerDataResponse LedgerEntryResponse LedgerResponse ManifestResponse NFTBuyOffersResponse NFTHistoryResponse NFTInfoResponse NFTOffer NFTSellOffersResponse NFToken NoRippleCheckResponse PathFindResponse PingResponse RandomResponse RipplePathFindResponse ServerDefinitionsResponse ServerInfoResponse ServerStateResponse SubmitMultisignedResponse SubmitResponse SubscribeResponse TransactionEntryResponse TxResponse UnsubscribeResponse Response

Streams

ConsensusStream LedgerStream OrderBookStream PathFindStream PeerStatusStream TransactionStream ValidationStream Stream

Errors

ConnectionError DisconnectedError NotConnectedError NotFoundError ResponseFormatError RippledError RippledNotInitializedError TimeoutError UnexpectedError ValidationError XRPLFaucetError XrplError

Other

LedgerEntry ECDSA AMMBid AMMCreate AMMDelete AMMDeposit AMMDepositFlagsInterface AMMVote AMMWithdraw AMMWithdrawFlagsInterface AccountInfoAccountFlags AccountLinesTrustline AccountOffer AccountQueueData AccountQueueTransaction AccountTxTransaction AuthAccount Balance BaseRequest BaseResponse BaseTransaction BookOffer BookOfferCurrency Channel Clawback ClientOptions CreatedNode DeletedNode FundingOptions GatewayBalance IssuedCurrency IssuedCurrencyAmount JobType LedgerBinary LedgerDataBinaryLedgerEntry LedgerModifiedOfferCreateTransaction LedgerQueueData LedgerStreamResponse Memo ModifiedNode NFTHistoryTransaction NFTokenAcceptOffer NFTokenBurn NFTokenCancelOffer NFTokenCreateOffer NFTokenMint PathFindCloseRequest PathFindCreateRequest PathFindPathOption PathFindStatusRequest PathStep ResponseOnlyTxInfo ResponseWarning RipplePathFindPathOption SetFeePostAmendment SetFeePreAmendment Signer SignerEntry SourceCurrencyAmount StateAccounting SubscribeBook TransactionMetadataBase UnsubscribeBook XChainBridge XRP AccountObject AccountObjectType Amount BooksSnapshot Currency LedgerDataLabeledLedgerEntry LedgerDataLedgerState LedgerIndex MarkerRequest MarkerResponse Node Path RequestAllResponseMap RequestResponseMap ServerState StateAccountingFinal StreamType TransactionMetadata classicAddressToXAddress decode decodeAccountID decodeAccountPublic decodeNodePublic decodeSeed decodeXAddress deriveAddress deriveKeypair encode encodeAccountID encodeAccountPublic encodeForMultiSigning encodeForSigning encodeForSigningClaim encodeNodePublic encodeSeed encodeXAddress getNFTokenID getXChainClaimID isCreatedNode isDeletedNode isModifiedNode isValidClassicAddress isValidXAddress keyToRFC1751Mnemonic parseAccountRootFlags parseNFTokenID rfc1751MnemonicToKey setTransactionFlagsToNumber verifyKeypairSignature walletFromSecretNumbers xAddressToClassicAddress

Pseudo Transaction Models

EnableAmendment UNLModify SetFee

Settings

Member Visibility

Theme

Generated using TypeDoc