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 EnableAmendmentFlags NFTokenCreateOfferFlags NFTokenMintFlags OfferCreateFlags PaymentChannelClaimFlags PaymentFlags TrustSetFlags AccountSetFlagsInterface NFTokenCreateOfferFlagsInterface NFTokenMintFlagsInterface OfferCreateFlagsInterface PaymentChannelClaimFlagsInterface PaymentFlagsInterface TrustSetFlagsInterface

Utilities

hashes authorizeChannel convertHexToString convertStringToHex 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 FeeRequest GatewayBalancesRequest LedgerClosedRequest LedgerCurrentRequest LedgerDataRequest LedgerEntryRequest LedgerRequest ManifestRequest NFTBuyOffersRequest NFTHistoryRequest NFTInfoRequest NFTSellOffersRequest NoRippleCheckRequest PingRequest RandomRequest RipplePathFindRequest ServerInfoRequest ServerStateRequest SubmitMultisignedRequest SubmitRequest SubscribeRequest TransactionEntryRequest TxRequest UnsubscribeRequest PathFindRequest Request

Responses

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 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 AccountInfoAccountFlags AccountLinesTrustline AccountOffer AccountQueueData AccountQueueTransaction AccountTxTransaction Balance BaseRequest BaseResponse BaseTransaction BookOffer BookOfferCurrency Channel ClientOptions CreatedNode DeletedNode 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 TransactionMetadata UnsubscribeBook XRP AccountObject AccountObjectType Amount BooksSnapshot Currency LedgerDataLabeledLedgerEntry LedgerDataLedgerState LedgerIndex Node Path ServerState StateAccountingFinal StreamType deriveAddress deriveKeypair verifyKeypairSignature classicAddressToXAddress decode decodeAccountID decodeAccountPublic decodeNodePublic decodeSeed decodeXAddress encode encodeAccountID encodeAccountPublic encodeForMultiSigning encodeForSigning encodeForSigningClaim encodeNodePublic encodeSeed encodeXAddress getNFTokenID isCreatedNode isDeletedNode isModifiedNode isValidClassicAddress isValidXAddress keyToRFC1751Mnemonic parseAccountRootFlags parseNFTokenID rfc1751MnemonicToKey setTransactionFlagsToNumber xAddressToClassicAddress

Pseudo Transaction Models

EnableAmendment UNLModify SetFee

Other

deriveAddress

deriveAddress: ((publicKey) => string)

Type declaration

    • (publicKey): string

    • Parameters

      • publicKey: any

      Returns string

deriveKeypair

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

Type declaration

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

    • Parameters

      • seed: string
      • Optional options: object

      Returns {
          privateKey: string;
          publicKey: string;
      }

      • privateKey: string
      • publicKey: string

verifyKeypairSignature

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

Type declaration

    • (messageHex, signature, publicKey): boolean

    • Parameters

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

      Returns boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc