xrpl

Clients

BroadcastClient Client

Signing

Wallet multisign

Transaction Models

AccountDelete AccountSet CheckCancel CheckCash CheckCreate DepositPreauth EscrowCancel EscrowCreate EscrowFinish OfferCancel OfferCreate Payment PaymentChannelClaim PaymentChannelCreate PaymentChannelFund SetRegularKey SignerListSet TicketCreate TransactionAndMetadata TrustSet Transaction

Transaction Flags

AccountSetAsfFlags AccountSetTfFlags NFTokenCreateOfferFlags NFTokenMintFlags OfferCreateFlags PaymentChannelClaimFlags PaymentFlags TrustSetFlags AccountSetFlagsInterface NFTokenCreateOfferFlagsInterface NFTokenMintFlagsInterface OfferCreateFlagsInterface PaymentChannelClaimFlagsInterface PaymentFlagsInterface TrustSetFlagsInterface

Utilities

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

Requests

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

Responses

AccountChannelsResponse AccountCurrenciesResponse AccountInfoResponse AccountLinesResponse AccountNFTsResponse AccountObjectsResponse AccountOffersResponse AccountTxResponse BookOffersResponse ChannelVerifyResponse DepositAuthorizedResponse ErrorResponse FederatorInfoResponse FeeResponse GatewayBalancesResponse LedgerClosedResponse LedgerCurrentResponse LedgerDataResponse LedgerEntryResponse LedgerResponse ManifestResponse NFTBuyOffersResponse NFTSellOffersResponse NoRippleCheckResponse PathFindResponse PingResponse RandomResponse RipplePathFindResponse 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 AccountOffer BookOffer ClientOptions NFTokenAcceptOffer NFTokenBurn NFTokenCancelOffer NFTokenCreateOffer NFTokenMint PathFindCloseRequest PathFindCreateRequest PathFindStatusRequest TransactionMetadata deriveAddress deriveKeypair verifyKeypairSignature classicAddressToXAddress decode decodeAccountID decodeAccountPublic decodeNodePublic decodeSeed decodeXAddress encode encodeAccountID encodeAccountPublic encodeForMultiSigning encodeForSigning encodeForSigningClaim encodeNodePublic encodeSeed encodeXAddress isValidClassicAddress isValidXAddress keyToRFC1751Mnemonic parseAccountRootFlags parseNFTokenID rfc1751MnemonicToKey setTransactionFlagsToNumber xAddressToClassicAddress

Other

deriveAddress

deriveAddress: ((publicKey: any) => string)

Type declaration

    • (publicKey: any): string

    • Parameters

      • publicKey: any

      Returns string

deriveKeypair

deriveKeypair: ((seed: string, options?: object) => { privateKey: string; publicKey: string })

Type declaration

    • (seed: string, options?: object): { privateKey: string; publicKey: string }

    • Parameters

      • seed: string
      • Optional options: object

      Returns { privateKey: string; publicKey: string }

      • privateKey: string
      • publicKey: string

verifyKeypairSignature

verifyKeypairSignature: ((messageHex: any, signature: any, publicKey: any) => boolean)

Type declaration

    • (messageHex: any, signature: any, publicKey: any): boolean

    • Parameters

      • messageHex: any
      • signature: any
      • publicKey: any

      Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc