From 4f035fd0d6eba3f1cd3325419e92405c8a06d130 Mon Sep 17 00:00:00 2001 From: ledhed2222 Date: Mon, 24 Jan 2022 13:08:35 -0500 Subject: [PATCH] custom faucet hosts and various typing fixes for NFT support that were originally missed (#1882) * various typing fixes for NFT support that were originally missed * add optional faucet URL to fundWallet * run docgen and commit changes * fixes integration tests --- docs/classes/BroadcastClient.html | 168 ++++++++++-------- docs/classes/Client.html | 166 +++++++++-------- docs/classes/ConnectionError.html | 8 +- docs/classes/DisconnectedError.html | 8 +- docs/classes/NotConnectedError.html | 8 +- docs/classes/NotFoundError.html | 8 +- docs/classes/ResponseFormatError.html | 8 +- docs/classes/RippledError.html | 8 +- docs/classes/RippledNotInitializedError.html | 8 +- docs/classes/TimeoutError.html | 8 +- docs/classes/UnexpectedError.html | 8 +- docs/classes/ValidationError.html | 8 +- docs/classes/Wallet.html | 24 +-- docs/classes/XRPLFaucetError.html | 8 +- docs/classes/XrplError.html | 8 +- docs/enums/AccountSetAsfFlags.html | 20 +-- docs/enums/AccountSetTfFlags.html | 12 +- docs/enums/LedgerEntry.AccountRootFlags.html | 18 +- docs/enums/LedgerEntry.OfferFlags.html | 2 +- docs/enums/LedgerEntry.RippleStateFlags.html | 2 +- docs/enums/LedgerEntry.SignerListFlags.html | 2 +- docs/enums/NFTokenCreateOfferFlags.html | 2 +- docs/enums/NFTokenMintFlags.html | 8 +- docs/enums/OfferCreateFlags.html | 8 +- docs/enums/PaymentChannelClaimFlags.html | 4 +- docs/enums/PaymentFlags.html | 6 +- docs/enums/TrustSetFlags.html | 10 +- docs/interfaces/AccountChannelsRequest.html | 16 +- docs/interfaces/AccountChannelsResponse.html | 4 +- docs/interfaces/AccountCurrenciesRequest.html | 12 +- .../interfaces/AccountCurrenciesResponse.html | 4 +- docs/interfaces/AccountDelete.html | 28 +-- docs/interfaces/AccountInfoRequest.html | 16 +- docs/interfaces/AccountInfoResponse.html | 4 +- docs/interfaces/AccountLinesRequest.html | 16 +- docs/interfaces/AccountLinesResponse.html | 4 +- docs/interfaces/AccountNFTsRequest.html | 10 +- docs/interfaces/AccountNFTsResponse.html | 4 +- docs/interfaces/AccountObjectsRequest.html | 18 +- docs/interfaces/AccountObjectsResponse.html | 4 +- docs/interfaces/AccountOffersRequest.html | 16 +- docs/interfaces/AccountOffersResponse.html | 4 +- docs/interfaces/AccountSet.html | 38 ++-- docs/interfaces/AccountSetFlagsInterface.html | 2 +- docs/interfaces/AccountTxRequest.html | 22 +-- docs/interfaces/AccountTxResponse.html | 4 +- docs/interfaces/BookOffer.html | 30 ++-- docs/interfaces/BookOffersRequest.html | 16 +- docs/interfaces/BookOffersResponse.html | 4 +- docs/interfaces/ChannelVerifyRequest.html | 12 +- docs/interfaces/ChannelVerifyResponse.html | 4 +- docs/interfaces/CheckCancel.html | 26 +-- docs/interfaces/CheckCash.html | 30 ++-- docs/interfaces/CheckCreate.html | 34 ++-- docs/interfaces/ClientOptions.html | 2 +- docs/interfaces/ConsensusStream.html | 4 +- docs/interfaces/DepositAuthorizedRequest.html | 12 +- .../interfaces/DepositAuthorizedResponse.html | 4 +- docs/interfaces/DepositPreauth.html | 28 +-- docs/interfaces/ErrorResponse.html | 2 +- docs/interfaces/EscrowCancel.html | 28 +-- docs/interfaces/EscrowCreate.html | 36 ++-- docs/interfaces/EscrowFinish.html | 32 ++-- docs/interfaces/FeeRequest.html | 4 +- docs/interfaces/FeeResponse.html | 4 +- docs/interfaces/GatewayBalancesRequest.html | 14 +- docs/interfaces/GatewayBalancesResponse.html | 4 +- docs/interfaces/LedgerClosedRequest.html | 4 +- docs/interfaces/LedgerClosedResponse.html | 2 +- docs/interfaces/LedgerCurrentRequest.html | 4 +- docs/interfaces/LedgerCurrentResponse.html | 4 +- docs/interfaces/LedgerDataRequest.html | 14 +- docs/interfaces/LedgerDataResponse.html | 4 +- docs/interfaces/LedgerEntry.AccountRoot.html | 32 ++-- ...LedgerEntry.AccountRootFlagsInterface.html | 18 +- docs/interfaces/LedgerEntry.Amendments.html | 8 +- docs/interfaces/LedgerEntry.Check.html | 28 +-- .../LedgerEntry.DepositPreauth.html | 14 +- .../interfaces/LedgerEntry.DirectoryNode.html | 22 +-- docs/interfaces/LedgerEntry.Escrow.html | 28 +-- docs/interfaces/LedgerEntry.FeeSettings.html | 12 +- docs/interfaces/LedgerEntry.Ledger.html | 28 +-- docs/interfaces/LedgerEntry.LedgerHashes.html | 8 +- docs/interfaces/LedgerEntry.NegativeUNL.html | 8 +- docs/interfaces/LedgerEntry.Offer.html | 24 +-- docs/interfaces/LedgerEntry.PayChannel.html | 32 ++-- docs/interfaces/LedgerEntry.RippleState.html | 26 +-- docs/interfaces/LedgerEntry.SignerList.html | 16 +- docs/interfaces/LedgerEntry.Ticket.html | 14 +- docs/interfaces/LedgerEntryRequest.html | 28 +-- docs/interfaces/LedgerEntryResponse.html | 4 +- docs/interfaces/LedgerRequest.html | 22 +-- docs/interfaces/LedgerResponse.html | 4 +- docs/interfaces/LedgerStream.html | 18 +- docs/interfaces/ManifestRequest.html | 6 +- docs/interfaces/ManifestResponse.html | 4 +- docs/interfaces/NFTBuyOffersRequest.html | 6 +- docs/interfaces/NFTBuyOffersResponse.html | 4 +- docs/interfaces/NFTSellOffersRequest.html | 6 +- docs/interfaces/NFTSellOffersResponse.html | 4 +- docs/interfaces/NFTokenAcceptOffer.html | 30 ++-- docs/interfaces/NFTokenBurn.html | 26 +-- docs/interfaces/NFTokenCancelOffer.html | 26 +-- docs/interfaces/NFTokenCreateOffer.html | 32 ++-- .../NFTokenCreateOfferFlagsInterface.html | 2 +- docs/interfaces/NFTokenMint.html | 30 ++-- .../interfaces/NFTokenMintFlagsInterface.html | 2 +- docs/interfaces/NoRippleCheckRequest.html | 16 +- docs/interfaces/NoRippleCheckResponse.html | 4 +- docs/interfaces/OfferCancel.html | 26 +-- docs/interfaces/OfferCreate.html | 30 ++-- .../interfaces/OfferCreateFlagsInterface.html | 2 +- docs/interfaces/OrderBookStream.html | 2 +- docs/interfaces/PathFindCloseRequest.html | 6 +- docs/interfaces/PathFindCreateRequest.html | 16 +- docs/interfaces/PathFindResponse.html | 4 +- docs/interfaces/PathFindStatusRequest.html | 6 +- docs/interfaces/PathFindStream.html | 16 +- docs/interfaces/Payment.html | 36 ++-- docs/interfaces/PaymentChannelClaim.html | 32 ++-- .../PaymentChannelClaimFlagsInterface.html | 4 +- docs/interfaces/PaymentChannelCreate.html | 36 ++-- docs/interfaces/PaymentChannelFund.html | 30 ++-- docs/interfaces/PaymentFlagsInterface.html | 6 +- docs/interfaces/PeerStatusStream.html | 14 +- docs/interfaces/PingRequest.html | 4 +- docs/interfaces/PingResponse.html | 2 +- docs/interfaces/RandomRequest.html | 4 +- docs/interfaces/RandomResponse.html | 2 +- docs/interfaces/RipplePathFindRequest.html | 18 +- docs/interfaces/RipplePathFindResponse.html | 4 +- docs/interfaces/ServerInfoRequest.html | 4 +- docs/interfaces/ServerInfoResponse.html | 4 +- docs/interfaces/ServerStateRequest.html | 4 +- docs/interfaces/ServerStateResponse.html | 2 +- docs/interfaces/SetRegularKey.html | 26 +-- docs/interfaces/SignerListSet.html | 28 +-- docs/interfaces/SubmitMultisignedRequest.html | 8 +- .../interfaces/SubmitMultisignedResponse.html | 4 +- docs/interfaces/SubmitRequest.html | 8 +- docs/interfaces/SubmitResponse.html | 4 +- docs/interfaces/SubscribeRequest.html | 18 +- docs/interfaces/SubscribeResponse.html | 2 +- docs/interfaces/TicketCreate.html | 26 +-- docs/interfaces/TransactionAndMetadata.html | 2 +- docs/interfaces/TransactionEntryRequest.html | 10 +- docs/interfaces/TransactionEntryResponse.html | 4 +- docs/interfaces/TransactionMetadata.html | 2 +- docs/interfaces/TransactionStream.html | 20 +-- docs/interfaces/TrustSet.html | 28 +-- docs/interfaces/TrustSetFlagsInterface.html | 10 +- docs/interfaces/TxRequest.html | 12 +- docs/interfaces/TxResponse.html | 4 +- docs/interfaces/UnsubscribeRequest.html | 12 +- docs/interfaces/UnsubscribeResponse.html | 2 +- docs/interfaces/ValidationStream.html | 26 +-- docs/modules.html | 68 +++---- docs/modules/LedgerEntry.html | 2 +- packages/xrpl/src/Wallet/fundWallet.ts | 37 +++- packages/xrpl/src/client/index.ts | 10 ++ .../xrpl/src/models/methods/accountNFTs.ts | 1 + packages/xrpl/test/integration/fundWallet.ts | 33 ++++ packages/xrpl/test/wallet/fundWallet.ts | 18 +- 163 files changed, 1285 insertions(+), 1182 deletions(-) diff --git a/docs/classes/BroadcastClient.html b/docs/classes/BroadcastClient.html index 3d7d2f84..6ce463cf 100644 --- a/docs/classes/BroadcastClient.html +++ b/docs/classes/BroadcastClient.html @@ -1,13 +1,13 @@ BroadcastClient | xrpl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BroadcastClient

Client that can rely on multiple different servers.

-

Hierarchy

Index

Constructor

Abstraction

Core

Faucet

Fee

Network

Other

Constructor

constructor

Hierarchy

Index

Constructor

Abstraction

Core

Faucet

Fee

Network

Other

Constructor

constructor

Abstraction

getBalances

getBalances: (address: string, options: { ledger_hash?: string; ledger_index?: LedgerIndex; limit?: number; peer?: string }) => Promise<{ currency: string; issuer?: string; value: string }[]> = getBalances

Type declaration

    • (address: string, options: { ledger_hash?: string; ledger_index?: LedgerIndex; limit?: number; peer?: string }): Promise<{ currency: string; issuer?: string; value: string }[]>
    • +

    Returns BroadcastClient

Abstraction

getBalances

getBalances: (address: string, options: { ledger_hash?: string; ledger_index?: LedgerIndex; limit?: number; peer?: string }) => Promise<{ currency: string; issuer?: string; value: string }[]> = getBalances

Type declaration

    • (address: string, options: { ledger_hash?: string; ledger_index?: LedgerIndex; limit?: number; peer?: string }): Promise<{ currency: string; issuer?: string; value: string }[]>

    • Get XRP/non-XRP balances for an account.

      Parameters

      • address: string

        Address of the account to retrieve balances for.

        @@ -25,10 +25,10 @@ ledger_index.

      • Optional peer?: string

        Filter balances by peer.

    Returns Promise<{ currency: string; issuer?: string; value: string }[]>

    An array of XRP/non-XRP balances for the given account.

    -

getLedgerIndex

getLedgerIndex: () => Promise<number> = getLedgerIndex

Type declaration

    • (): Promise<number>
    • +

getLedgerIndex

getLedgerIndex: () => Promise<number> = getLedgerIndex

Type declaration

    • (): Promise<number>

    • Returns the index of the most recently validated ledger.

      Returns Promise<number>

      The most recently validated ledger index.

      -

getOrderbook

getOrderbook: (takerPays: TakerAmount, takerGets: TakerAmount, options: { ledger_hash?: string; ledger_index?: LedgerIndex; limit?: number; taker?: string }) => Promise<{ buy: BookOffer[]; sell: BookOffer[] }> = getOrderbook

Type declaration

    • (takerPays: TakerAmount, takerGets: TakerAmount, options: { ledger_hash?: string; ledger_index?: LedgerIndex; limit?: number; taker?: string }): Promise<{ buy: BookOffer[]; sell: BookOffer[] }>
    • +

getOrderbook

getOrderbook: (takerPays: TakerAmount, takerGets: TakerAmount, options: { ledger_hash?: string; ledger_index?: LedgerIndex; limit?: number; taker?: string }) => Promise<{ buy: BookOffer[]; sell: BookOffer[] }> = getOrderbook

Type declaration

    • (takerPays: TakerAmount, takerGets: TakerAmount, options: { ledger_hash?: string; ledger_index?: LedgerIndex; limit?: number; taker?: string }): Promise<{ buy: BookOffer[]; sell: BookOffer[] }>

    • Fetch orderbook (buy/sell orders) between two accounts.

      Parameters

      • takerPays: TakerAmount

        Specification of which currency the account taking the @@ -50,7 +50,7 @@ the order book. Defaults to 20.

      • Optional taker?: string

        Filter orders by taker.

    Returns Promise<{ buy: BookOffer[]; sell: BookOffer[] }>

    An object containing buy and sell objects.

    -

getXrpBalance

getXrpBalance: (address: string, options: { ledger_hash?: string; ledger_index?: LedgerIndex }) => Promise<string> = getXrpBalance

Type declaration

    • (address: string, options: { ledger_hash?: string; ledger_index?: LedgerIndex }): Promise<string>
    • +

getXrpBalance

getXrpBalance: (address: string, options: { ledger_hash?: string; ledger_index?: LedgerIndex }) => Promise<string> = getXrpBalance

Type declaration

    • (address: string, options: { ledger_hash?: string; ledger_index?: LedgerIndex }): Promise<string>

    • Get the XRP balance for an account.

      example
      const client = new Client(wss://s.altnet.rippletest.net:51233)
      const balance = await client.getXrpBalance('rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn')
      console.log(balance)
      /// '200'
      @@ -65,7 +65,7 @@ a given ledger_hash.

      Retrieve the account balances at a given ledger_index.

Returns Promise<string>

The XRP balance of the account (as a string).

-

Core

autofill

autofill: <T>(transaction: T, signersCount?: number) => Promise<T> = autofill

Type declaration

    • <T>(transaction: T, signersCount?: number): Promise<T>
    • +

Core

autofill

autofill: <T>(transaction: T, signersCount?: number) => Promise<T> = autofill

Type declaration

    • <T>(transaction: T, signersCount?: number): Promise<T>

    • Autofills fields in a transaction. This will set Sequence, Fee, lastLedgerSequence according to the current state of the server this Client is connected to. It also converts all X-Addresses to classic addresses and @@ -76,7 +76,7 @@ flags interfaces into numbers.

      The expected number of signers for this transaction. Only used for multisigned transactions.

    Returns Promise<T>

    The autofilled transaction.

    -

submit

submit: (transaction: string | Transaction, opts?: { autofill?: boolean; failHard?: boolean; wallet?: Wallet }) => Promise<SubmitResponse> = submit

Type declaration

submit

submit: (transaction: string | Transaction, opts?: { autofill?: boolean; failHard?: boolean; wallet?: Wallet }) => Promise<SubmitResponse> = submit

Type declaration

    • Submits a signed/unsigned transaction. Steps performed on a transaction:

        @@ -96,7 +96,7 @@ Steps performed on a transaction:

    • Optional wallet?: Wallet

      A wallet to sign a transaction. It must be provided when submitting an unsigned transaction.

Returns Promise<SubmitResponse>

A promise that contains SubmitResponse.

-

submitAndWait

submitAndWait: (transaction: string | Transaction, opts?: { autofill?: boolean; failHard?: boolean; wallet?: Wallet }) => Promise<TxResponse> = submitAndWait

Type declaration

submitAndWait

submitAndWait: (transaction: string | Transaction, opts?: { autofill?: boolean; failHard?: boolean; wallet?: Wallet }) => Promise<TxResponse> = submitAndWait

Type declaration

Returns Promise<TxResponse>

A promise that contains TxResponse, that will return when the transaction has been validated.

-

Faucet

fundWallet

fundWallet: (wallet?: Wallet) => Promise<{ balance: number; wallet: Wallet }> = fundWallet

Type declaration

    • (wallet?: Wallet): Promise<{ balance: number; wallet: Wallet }>
    • +

Faucet

fundWallet

fundWallet: (wallet?: null | Wallet, options?: { faucetUrl?: string }) => Promise<{ balance: number; wallet: Wallet }> = fundWallet

Type declaration

    • (wallet?: null | Wallet, options?: { faucetUrl?: string }): Promise<{ balance: number; wallet: Wallet }>

    • Generates a random wallet with some amount of XRP (usually 1000 XRP).

      example
      const api = new xrpl.Client("wss://s.altnet.rippletest.net:51233")
      await api.connect()
      const { wallet, balance } = await api.fundWallet()
      throws

      When either Client isn't connected or unable to fund wallet address.

      -

      Parameters

      • Optional wallet: Wallet
        -

        An existing XRPL Wallet to fund, if undefined, a new Wallet will be created.

        -

      Returns Promise<{ balance: number; wallet: Wallet }>

      A Wallet on the Testnet or Devnet that contains some amount of XRP, +

      Parameters

      • Optional wallet: null | Wallet
        +

        An existing XRPL Wallet to fund. If undefined or null, a new Wallet will be created.

        +
      • Optional options: { faucetUrl?: string }
        +

        See below.

        +
        • Optional faucetUrl?: string
          +

          A custom URL for a faucet server. On devnet and +testnet, fundWallet will attempt to determine the correct server +automatically. In other environments, or if you would like to customize the +faucet URL in devnet or testnet, you should provide the URL using this +option.

          +

      Returns Promise<{ balance: number; wallet: Wallet }>

      A Wallet on the Testnet or Devnet that contains some amount of XRP, and that wallet's balance in XRP.

      -

Fee

Readonly feeCushion

feeCushion: number
+

Fee

Readonly feeCushion

feeCushion: number

Factor to multiply estimated fee by to provide a cushion in case the required fee rises during submission of a transaction. Defaults to 1.2.

-

Readonly maxFeeXRP

maxFeeXRP: string
+

Readonly maxFeeXRP

maxFeeXRP: string

Maximum transaction cost to allow, in decimal XRP. Must be a string-encoded number. Defaults to '2'.

-

Network

url

  • get url(): string

Network

url

  • get url(): string

  • Get the url that the client is connected to.

    category

    Network

    Returns string

    The URL of the server this client is connected to.

    -

connect

  • connect(): Promise<void>

connect

  • connect(): Promise<void>

disconnect

  • disconnect(): Promise<void>

disconnect

  • disconnect(): Promise<void>

isConnected

  • isConnected(): boolean

isConnected

  • isConnected(): boolean

request

request

Other

Private Readonly clients

clients: Client[]

Readonly connection

connection: Connection

prepareTransaction

prepareTransaction: <T>(transaction: T, signersCount?: number) => Promise<T> = autofill

Type declaration

    • <T>(transaction: T, signersCount?: number): Promise<T>
    • +

Other

Private Readonly clients

clients: Client[]

Readonly connection

connection: Connection

prepareTransaction

prepareTransaction: <T>(transaction: T, signersCount?: number) => Promise<T> = autofill

Type declaration

    • <T>(transaction: T, signersCount?: number): Promise<T>

    • Autofills fields in a transaction. This will set Sequence, Fee, lastLedgerSequence according to the current state of the server this Client is connected to. It also converts all X-Addresses to classic addresses and @@ -308,7 +328,7 @@ listeners. The values in the array are strings or Symbols.

      Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

      since

      v1.0.0

      -

      Returns number

Private getMethodNames

  • getMethodNames(): string[]

Private getMethodNames

  • getMethodNames(): string[]

listenerCount

  • listenerCount(eventName: string | symbol): number

off

  • off(eventName: string | symbol, listener: (...args: any[]) => void): BroadcastClient

  • Alias for emitter.removeListener().

    since

    v10.0.0

    -

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns BroadcastClient

on

on

requestAll

requestAll

requestNextPage

requestNextPage

getLedgerIndex

getLedgerIndex: () => Promise<number> = getLedgerIndex

Type declaration

    • (): Promise<number>
    • +

getLedgerIndex

getLedgerIndex: () => Promise<number> = getLedgerIndex

Type declaration

    • (): Promise<number>

    • Returns the index of the most recently validated ledger.

      Returns Promise<number>

      The most recently validated ledger index.

      -

getOrderbook

getOrderbook: (takerPays: TakerAmount, takerGets: TakerAmount, options: { ledger_hash?: string; ledger_index?: LedgerIndex; limit?: number; taker?: string }) => Promise<{ buy: BookOffer[]; sell: BookOffer[] }> = getOrderbook

Type declaration

    • (takerPays: TakerAmount, takerGets: TakerAmount, options: { ledger_hash?: string; ledger_index?: LedgerIndex; limit?: number; taker?: string }): Promise<{ buy: BookOffer[]; sell: BookOffer[] }>
    • +

getOrderbook

getOrderbook: (takerPays: TakerAmount, takerGets: TakerAmount, options: { ledger_hash?: string; ledger_index?: LedgerIndex; limit?: number; taker?: string }) => Promise<{ buy: BookOffer[]; sell: BookOffer[] }> = getOrderbook

Type declaration

    • (takerPays: TakerAmount, takerGets: TakerAmount, options: { ledger_hash?: string; ledger_index?: LedgerIndex; limit?: number; taker?: string }): Promise<{ buy: BookOffer[]; sell: BookOffer[] }>

    • Fetch orderbook (buy/sell orders) between two accounts.

      Parameters

      • takerPays: TakerAmount

        Specification of which currency the account taking the @@ -50,7 +50,7 @@ the order book. Defaults to 20.

      • Optional taker?: string

        Filter orders by taker.

    Returns Promise<{ buy: BookOffer[]; sell: BookOffer[] }>

    An object containing buy and sell objects.

    -

getXrpBalance

getXrpBalance: (address: string, options: { ledger_hash?: string; ledger_index?: LedgerIndex }) => Promise<string> = getXrpBalance

Type declaration

    • (address: string, options: { ledger_hash?: string; ledger_index?: LedgerIndex }): Promise<string>
    • +

getXrpBalance

getXrpBalance: (address: string, options: { ledger_hash?: string; ledger_index?: LedgerIndex }) => Promise<string> = getXrpBalance

Type declaration

    • (address: string, options: { ledger_hash?: string; ledger_index?: LedgerIndex }): Promise<string>

    • Get the XRP balance for an account.

      example
      const client = new Client(wss://s.altnet.rippletest.net:51233)
      const balance = await client.getXrpBalance('rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn')
      console.log(balance)
      /// '200'
      @@ -65,7 +65,7 @@ a given ledger_hash.

      Retrieve the account balances at a given ledger_index.

Returns Promise<string>

The XRP balance of the account (as a string).

-

Core

autofill

autofill: <T>(transaction: T, signersCount?: number) => Promise<T> = autofill

Type declaration

    • <T>(transaction: T, signersCount?: number): Promise<T>
    • +

Core

autofill

autofill: <T>(transaction: T, signersCount?: number) => Promise<T> = autofill

Type declaration

    • <T>(transaction: T, signersCount?: number): Promise<T>

    • Autofills fields in a transaction. This will set Sequence, Fee, lastLedgerSequence according to the current state of the server this Client is connected to. It also converts all X-Addresses to classic addresses and @@ -76,7 +76,7 @@ flags interfaces into numbers.

      The expected number of signers for this transaction. Only used for multisigned transactions.

    Returns Promise<T>

    The autofilled transaction.

    -

submit

submit: (transaction: string | Transaction, opts?: { autofill?: boolean; failHard?: boolean; wallet?: Wallet }) => Promise<SubmitResponse> = submit

Type declaration

submit

submit: (transaction: string | Transaction, opts?: { autofill?: boolean; failHard?: boolean; wallet?: Wallet }) => Promise<SubmitResponse> = submit

Type declaration

    • Submits a signed/unsigned transaction. Steps performed on a transaction:

        @@ -96,7 +96,7 @@ Steps performed on a transaction:

    • Optional wallet?: Wallet

      A wallet to sign a transaction. It must be provided when submitting an unsigned transaction.

Returns Promise<SubmitResponse>

A promise that contains SubmitResponse.

-

submitAndWait

submitAndWait: (transaction: string | Transaction, opts?: { autofill?: boolean; failHard?: boolean; wallet?: Wallet }) => Promise<TxResponse> = submitAndWait

Type declaration

submitAndWait

submitAndWait: (transaction: string | Transaction, opts?: { autofill?: boolean; failHard?: boolean; wallet?: Wallet }) => Promise<TxResponse> = submitAndWait

Type declaration

Returns Promise<TxResponse>

A promise that contains TxResponse, that will return when the transaction has been validated.

-

Faucet

fundWallet

fundWallet: (wallet?: Wallet) => Promise<{ balance: number; wallet: Wallet }> = fundWallet

Type declaration

    • (wallet?: Wallet): Promise<{ balance: number; wallet: Wallet }>
    • +

Faucet

fundWallet

fundWallet: (wallet?: null | Wallet, options?: { faucetUrl?: string }) => Promise<{ balance: number; wallet: Wallet }> = fundWallet

Type declaration

    • (wallet?: null | Wallet, options?: { faucetUrl?: string }): Promise<{ balance: number; wallet: Wallet }>

    • Generates a random wallet with some amount of XRP (usually 1000 XRP).

      example
      const api = new xrpl.Client("wss://s.altnet.rippletest.net:51233")
      await api.connect()
      const { wallet, balance } = await api.fundWallet()
      throws

      When either Client isn't connected or unable to fund wallet address.

      -

      Parameters

      • Optional wallet: Wallet
        -

        An existing XRPL Wallet to fund, if undefined, a new Wallet will be created.

        -

      Returns Promise<{ balance: number; wallet: Wallet }>

      A Wallet on the Testnet or Devnet that contains some amount of XRP, +

      Parameters

      • Optional wallet: null | Wallet
        +

        An existing XRPL Wallet to fund. If undefined or null, a new Wallet will be created.

        +
      • Optional options: { faucetUrl?: string }
        +

        See below.

        +
        • Optional faucetUrl?: string
          +

          A custom URL for a faucet server. On devnet and +testnet, fundWallet will attempt to determine the correct server +automatically. In other environments, or if you would like to customize the +faucet URL in devnet or testnet, you should provide the URL using this +option.

          +

      Returns Promise<{ balance: number; wallet: Wallet }>

      A Wallet on the Testnet or Devnet that contains some amount of XRP, and that wallet's balance in XRP.

      -

Fee

Readonly feeCushion

feeCushion: number
+

Fee

Readonly feeCushion

feeCushion: number

Factor to multiply estimated fee by to provide a cushion in case the required fee rises during submission of a transaction. Defaults to 1.2.

-

Readonly maxFeeXRP

maxFeeXRP: string
+

Readonly maxFeeXRP

maxFeeXRP: string

Maximum transaction cost to allow, in decimal XRP. Must be a string-encoded number. Defaults to '2'.

-

Network

url

  • get url(): string

Network

url

  • get url(): string

connect

  • connect(): Promise<void>

connect

  • connect(): Promise<void>

  • Tells the Client instance to connect to its rippled server.

    Returns Promise<void>

    A promise that resolves with a void value when a connection is established.

    -

disconnect

  • disconnect(): Promise<void>

disconnect

  • disconnect(): Promise<void>

  • Tells the Client instance to disconnect from it's rippled server.

    Returns Promise<void>

    A promise that resolves with a void value when a connection is destroyed.

    -

isConnected

  • isConnected(): boolean

isConnected

  • isConnected(): boolean

request

request

Other

Readonly connection

connection: Connection

prepareTransaction

prepareTransaction: <T>(transaction: T, signersCount?: number) => Promise<T> = autofill

Type declaration

    • <T>(transaction: T, signersCount?: number): Promise<T>
    • +

Other

Readonly connection

connection: Connection

prepareTransaction

prepareTransaction: <T>(transaction: T, signersCount?: number) => Promise<T> = autofill

Type declaration

    • <T>(transaction: T, signersCount?: number): Promise<T>

    • Autofills fields in a transaction. This will set Sequence, Fee, lastLedgerSequence according to the current state of the server this Client is connected to. It also converts all X-Addresses to classic addresses and @@ -321,7 +341,7 @@ set by emitter.setMaxListeners(n) or defaults to Parameters

      Returns Function[]

off

  • off(eventName: string | symbol, listener: (...args: any[]) => void): Client

  • Alias for emitter.removeListener().

    since

    v10.0.0

    -

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Client

on

  • +

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Client

on

requestAll

requestAll

  • Makes multiple paged requests to the client to return a given number of resources. Multiple paged requests will be made until the limit number of resources is reached (if no limit is provided, a single request @@ -458,7 +478,7 @@ general use. Instead, use rippled's built-in pagination and make multiple requests as needed.

    category

    Network

    Parameters

    Returns Promise<AccountChannelsResponse[]>

    The array of all responses.

    -
  • +

  • Makes multiple paged requests to the client to return a given number of resources. Multiple paged requests will be made until the limit number of resources is reached (if no limit is provided, a single request @@ -470,7 +490,7 @@ general use. Instead, use rippled's built-in pagination and make multiple requests as needed.

    throws

    ValidationError if there is no collection key (either from a known command or for the unknown command).

    Parameters

    Returns Promise<AccountLinesResponse[]>

    The array of all responses.

    -
  • +

  • Makes multiple paged requests to the client to return a given number of resources. Multiple paged requests will be made until the limit number of resources is reached (if no limit is provided, a single request @@ -482,7 +502,7 @@ general use. Instead, use rippled's built-in pagination and make multiple requests as needed.

    throws

    ValidationError if there is no collection key (either from a known command or for the unknown command).

    Parameters

    Returns Promise<AccountObjectsResponse[]>

    The array of all responses.

    -
  • +

  • Makes multiple paged requests to the client to return a given number of resources. Multiple paged requests will be made until the limit number of resources is reached (if no limit is provided, a single request @@ -494,7 +514,7 @@ general use. Instead, use rippled's built-in pagination and make multiple requests as needed.

    throws

    ValidationError if there is no collection key (either from a known command or for the unknown command).

    Parameters

    Returns Promise<AccountOffersResponse[]>

    The array of all responses.

    -
  • +

  • Makes multiple paged requests to the client to return a given number of resources. Multiple paged requests will be made until the limit number of resources is reached (if no limit is provided, a single request @@ -506,7 +526,7 @@ general use. Instead, use rippled's built-in pagination and make multiple requests as needed.

    throws

    ValidationError if there is no collection key (either from a known command or for the unknown command).

    Parameters

    Returns Promise<AccountTxResponse[]>

    The array of all responses.

    -
  • +

  • Makes multiple paged requests to the client to return a given number of resources. Multiple paged requests will be made until the limit number of resources is reached (if no limit is provided, a single request @@ -518,7 +538,7 @@ general use. Instead, use rippled's built-in pagination and make multiple requests as needed.

    throws

    ValidationError if there is no collection key (either from a known command or for the unknown command).

    Parameters

    Returns Promise<BookOffersResponse[]>

    The array of all responses.

    -
  • +

  • Makes multiple paged requests to the client to return a given number of resources. Multiple paged requests will be made until the limit number of resources is reached (if no limit is provided, a single request @@ -530,7 +550,7 @@ general use. Instead, use rippled's built-in pagination and make multiple requests as needed.

    throws

    ValidationError if there is no collection key (either from a known command or for the unknown command).

    Parameters

    Returns Promise<LedgerDataResponse[]>

    The array of all responses.

    -

requestNextPage

requestNextPage

Static stackTraceLimit

stackTraceLimit: number

Methods

inspect

  • inspect(): string

toString

  • toString(): string

toString

  • toString(): string

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

Static stackTraceLimit

stackTraceLimit: number

Methods

inspect

  • inspect(): string

toString

  • toString(): string

toString

  • toString(): string

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

Static stackTraceLimit

stackTraceLimit: number

Methods

inspect

  • inspect(): string

toString

  • toString(): string

toString

  • toString(): string

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

Static stackTraceLimit

stackTraceLimit: number

Methods

inspect

  • inspect(): string

toString

  • toString(): string

toString

  • toString(): string

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

Static stackTraceLimit

stackTraceLimit: number

Methods

inspect

  • inspect(): string

toString

  • toString(): string

toString

  • toString(): string

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

Static stackTraceLimit

stackTraceLimit: number

Methods

inspect

  • inspect(): string

toString

  • toString(): string

toString

  • toString(): string

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

Static stackTraceLimit

stackTraceLimit: number

Methods

inspect

  • inspect(): string

toString

  • toString(): string

toString

  • toString(): string

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

Static stackTraceLimit

stackTraceLimit: number

Methods

inspect

  • inspect(): string

toString

  • toString(): string

toString

  • toString(): string

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

Static stackTraceLimit

stackTraceLimit: number

Methods

inspect

  • inspect(): string

toString

  • toString(): string

toString

  • toString(): string

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

Static stackTraceLimit

stackTraceLimit: number

Methods

inspect

  • inspect(): string

toString

  • toString(): string

toString

  • toString(): string

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void
  • diff --git a/docs/classes/Wallet.html b/docs/classes/Wallet.html index 79d35c4a..976c5b26 100644 --- a/docs/classes/Wallet.html +++ b/docs/classes/Wallet.html @@ -4,7 +4,7 @@ A wallet can be derived from either a seed, mnemonic, or entropy (array of rando It provides functionality to sign/verify transactions offline.

    example
    // Derive a wallet from a bip38 Mnemonic
    const wallet = Wallet.fromMnemonic(
      'jewel insect retreat jump claim horse second chef west gossip bone frown exotic embark laundry'
    )
    console.log(wallet)
    // Wallet {
    // publicKey: '02348F89E9A6A3615BA317F8474A3F51D66221562D3CA32BFA8D21348FF67012B2',
    // privateKey: '00A8F2E77FC0E05890C1B5088AFE0ECF9D96466A4419B897B1AB383E336E1735A2',
    // classicAddress: 'rwZiksrExmVkR64pf87Jor4cYbmff47SUm',
    // seed: undefined
    // }.

    // Derive a wallet from a base58 encoded seed.
    const seedWallet = Wallet.fromSeed('ssZkdwURFMBXenJPbrpE14b6noJSu')
    console.log(seedWallet)
    // Wallet {
    // publicKey: '02FE9932A9C4AA2AC9F0ED0F2B89302DE7C2C95F91D782DA3CF06E64E1C1216449',
    // privateKey: '00445D0A16DD05EFAF6D5AF45E6B8A6DE4170D93C0627021A0B8E705786CBCCFF7',
    // classicAddress: 'rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo',
    // seed: 'ssZkdwURFMBXenJPbrpE14b6noJSu'
    // }.

    // Sign a JSON Transaction
     const signed = seedWallet.signTransaction({
         TransactionType: 'Payment',
         Account: 'rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo'
         ...........
    }).

    console.log(signed)
    // '1200007321......B01BE1DFF3'.
    console.log(decode(signed))
    // {
    //   TransactionType: 'Payment',
    //   SigningPubKey: '02FE9932A9C4AA2AC9F0ED0F2B89302DE7C2C95F91D782DA3CF06E64E1C1216449',
    //   TxnSignature: '3045022100AAD......5B631ABD21171B61B07D304',
    //   Account: 'rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo'
    //   ...........
    // }
    -

Hierarchy

  • Wallet

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Wallet(publicKey: string, privateKey: string, opts?: { masterAddress?: string; seed?: string }): Wallet

Hierarchy

  • Wallet

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Wallet(publicKey: string, privateKey: string, opts?: { masterAddress?: string; seed?: string }): Wallet

  • Creates a new Wallet.

    Parameters

    • publicKey: string

      The public key for the account.

      @@ -16,7 +16,7 @@ It provides functionality to sign/verify transactions offline.

      Include if a Wallet uses a Regular Key Pair. It must be the master address of the account.

    • Optional seed?: string

      The seed used to derive the account keys.

      -

Returns Wallet

Properties

Readonly classicAddress

classicAddress: string

Readonly privateKey

privateKey: string

Readonly publicKey

publicKey: string

Optional Readonly seed

seed?: string

Static fromSecret

fromSecret: (seed: string, opts?: { algorithm?: ECDSA; masterAddress?: string }) => Wallet = Wallet.fromSeed

Type declaration

    • (seed: string, opts?: { algorithm?: ECDSA; masterAddress?: string }): Wallet
    • +

Returns Wallet

Properties

Readonly classicAddress

classicAddress: string

Readonly privateKey

privateKey: string

Readonly publicKey

publicKey: string

Optional Readonly seed

seed?: string

Static fromSecret

fromSecret: (seed: string, opts?: { algorithm?: ECDSA; masterAddress?: string }) => Wallet = Wallet.fromSeed

Type declaration

    • (seed: string, opts?: { algorithm?: ECDSA; masterAddress?: string }): Wallet

    • Derives a wallet from a seed.

      Parameters

      • seed: string

        A string used to generate a keypair (publicKey/privateKey) to derive a wallet.

        @@ -27,10 +27,10 @@ It provides functionality to sign/verify transactions offline.

      • Optional masterAddress?: string

        Include if a Wallet uses a Regular Key Pair. It must be the master address of the account.

    Returns Wallet

    A Wallet derived from a seed.

    -

Accessors

address

  • get address(): string

Accessors

address

  • get address(): string

Methods

Private checkTxSerialization

  • checkTxSerialization(serialized: string, tx: Transaction): void

Methods

Private checkTxSerialization

  • checkTxSerialization(serialized: string, tx: Transaction): void

  • Decode a serialized transaction, remove the fields that are added during the signing process, and verify that it matches the transaction prior to signing. This gives the user a sanity check to ensure that what they try to encode matches the message that will be recieved by rippled.

    @@ -40,14 +40,14 @@ the serialized Transaction desn't match the original transaction.

    A signed and serialized transaction.

  • tx: Transaction

    The transaction prior to signing.

    -

Returns void

getXAddress

  • getXAddress(tag?: number | false, isTestnet?: boolean): string

Returns void

getXAddress

  • getXAddress(tag?: number | false, isTestnet?: boolean): string

  • Gets an X-address in Testnet/Mainnet format.

    Parameters

    • tag: number | false = false

      A tag to be included within the X-address.

    • isTestnet: boolean = false

      A boolean to indicate if X-address should be in Testnet (true) or Mainnet (false) format.

    Returns string

    An X-address.

    -

sign

  • sign(transaction: Transaction, multisign?: string | boolean): { hash: string; tx_blob: string }

sign

  • sign(transaction: Transaction, multisign?: string | boolean): { hash: string; tx_blob: string }

  • Signs a transaction offline.

    throws

    ValidationError if the transaction is already signed or does not encode/decode to same result.

    Parameters

    • transaction: Transaction
      @@ -55,12 +55,12 @@ the serialized Transaction desn't match the original transaction.

    • Optional multisign: string | boolean

      Specify true/false to use multisign or actual address (classic/x-address) to make multisign tx request.

    Returns { hash: string; tx_blob: string }

    A signed transaction.

    -
    • hash: string
    • tx_blob: string

verifyTransaction

  • verifyTransaction(signedTransaction: string): boolean

verifyTransaction

  • verifyTransaction(signedTransaction: string): boolean

  • Verifies a signed transaction offline.

    Parameters

    • signedTransaction: string

      A signed transaction (hex string of signTransaction result) to be verified offline.

    Returns boolean

    Returns true if a signedTransaction is valid.

    -

Static Private deriveWallet

  • deriveWallet(seed: string, opts?: { algorithm?: ECDSA; masterAddress?: string }): Wallet

Static Private deriveWallet

  • deriveWallet(seed: string, opts?: { algorithm?: ECDSA; masterAddress?: string }): Wallet

  • Derive a Wallet from a seed.

    Parameters

    • seed: string

      The seed used to derive the wallet.

      @@ -71,7 +71,7 @@ the serialized Transaction desn't match the original transaction.

    • Optional masterAddress?: string

      Include if a Wallet uses a Regular Key Pair. It must be the master address of the account.

Returns Wallet

A Wallet derived from the seed.

-

Static fromEntropy

  • fromEntropy(entropy: Uint8Array | number[], opts?: { algorithm?: ECDSA; masterAddress?: string }): Wallet

Static fromEntropy

  • fromEntropy(entropy: Uint8Array | number[], opts?: { algorithm?: ECDSA; masterAddress?: string }): Wallet

  • Derives a wallet from an entropy (array of random numbers).

    Parameters

    • entropy: Uint8Array | number[]

      An array of random numbers to generate a seed used to derive a wallet.

      @@ -82,7 +82,7 @@ the serialized Transaction desn't match the original transaction.

    • Optional masterAddress?: string

      Include if a Wallet uses a Regular Key Pair. It must be the master address of the account.

Returns Wallet

A Wallet derived from an entropy.

-

Static fromMnemonic

  • fromMnemonic(mnemonic: string, opts?: { derivationPath?: string; masterAddress?: string }): Wallet

Static fromMnemonic

  • fromMnemonic(mnemonic: string, opts?: { derivationPath?: string; masterAddress?: string }): Wallet

  • Derives a wallet from a mnemonic.

    throws

    ValidationError if unable to derive private key from mnemonic input.

    Parameters

    • mnemonic: string
      @@ -94,7 +94,7 @@ the serialized Transaction desn't match the original transaction.

    • Optional masterAddress?: string

      Include if a Wallet uses a Regular Key Pair. It must be the master address of the account.

Returns Wallet

A Wallet derived from a mnemonic.

-

Static fromSeed

  • fromSeed(seed: string, opts?: { algorithm?: ECDSA; masterAddress?: string }): Wallet

Static fromSeed

  • fromSeed(seed: string, opts?: { algorithm?: ECDSA; masterAddress?: string }): Wallet

  • Derives a wallet from a seed.

    Parameters

    • seed: string

      A string used to generate a keypair (publicKey/privateKey) to derive a wallet.

      @@ -105,7 +105,7 @@ the serialized Transaction desn't match the original transaction.

    • Optional masterAddress?: string

      Include if a Wallet uses a Regular Key Pair. It must be the master address of the account.

Returns Wallet

A Wallet derived from a seed.

-

Static generate

  • generate(algorithm?: ECDSA): Wallet

Static generate

  • generate(algorithm?: ECDSA): Wallet

  • Generates a new Wallet using a generated seed.

    Parameters

    • algorithm: ECDSA = DEFAULT_ALGORITHM

      The digital signature algorithm to generate an address for.

      diff --git a/docs/classes/XRPLFaucetError.html b/docs/classes/XRPLFaucetError.html index 2ed089ad..78acc98a 100644 --- a/docs/classes/XRPLFaucetError.html +++ b/docs/classes/XRPLFaucetError.html @@ -2,21 +2,21 @@

      Error thrown when a client cannot generate a wallet from the testnet/devnet faucets, or when the client cannot infer the faucet URL (i.e. when the Client is connected to mainnet).

      -

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Optional Readonly data

data?: unknown

Readonly message

message: string

Readonly name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Type declaration

Properties

Optional Readonly data

data?: unknown

Readonly message

message: string

Readonly name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Methods

inspect

  • inspect(): string

Static stackTraceLimit

stackTraceLimit: number

Methods

inspect

  • inspect(): string

toString

  • toString(): string

toString

  • toString(): string

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

Static stackTraceLimit

stackTraceLimit: number

Methods

inspect

  • inspect(): string

toString

  • toString(): string

toString

  • toString(): string

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

Optional status

status?: string

type

type: string

Optional warning

warning?: "load"

Optional warnings

warnings?: Warning[]

Legend

  • Constructor
  • Property
  • Method
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Private property
  • Private method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/AccountCurrenciesRequest.html b/docs/interfaces/AccountCurrenciesRequest.html index d0c2aeca..ada92b28 100644 --- a/docs/interfaces/AccountCurrenciesRequest.html +++ b/docs/interfaces/AccountCurrenciesRequest.html @@ -2,20 +2,20 @@

The account_currencies command retrieves a list of currencies that an account can send or receive, based on its trust lines. Expects an AccountCurrenciesResponse.

-

Hierarchy

  • BaseRequest
    • AccountCurrenciesRequest

Index

Properties

Properties

account

account: string
+

Hierarchy

  • BaseRequest
    • AccountCurrenciesRequest

Index

Properties

Properties

account

account: string

A unique identifier for the account, most commonly the account's address.

-

Optional api_version

api_version?: number
+

Optional api_version

api_version?: number

The API version to use. If omitted, use version 1.

-

command

command: "account_currencies"

Optional id

id?: string | number
+

command

command: "account_currencies"

Optional id

id?: string | number

A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

-

Optional ledger_hash

ledger_hash?: string
+

Optional ledger_hash

ledger_hash?: string

A 20-byte hex string for the ledger version to use.

-

Optional ledger_index

ledger_index?: LedgerIndex
+

Optional ledger_index

ledger_index?: LedgerIndex

The ledger index of the ledger to use, or a shortcut string to choose a ledger automatically.

-

Optional strict

strict?: boolean
+

Optional strict

strict?: boolean

If true, then the account field only accepts a public key or XRP Ledger address. Otherwise, account can be a secret or passphrase (not recommended). The default is false.

diff --git a/docs/interfaces/AccountCurrenciesResponse.html b/docs/interfaces/AccountCurrenciesResponse.html index 77ef8ec7..9e96eecc 100644 --- a/docs/interfaces/AccountCurrenciesResponse.html +++ b/docs/interfaces/AccountCurrenciesResponse.html @@ -1,6 +1,6 @@ AccountCurrenciesResponse | xrpl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AccountCurrenciesResponse

The expected response from an AccountCurrenciesRequest.

-

Hierarchy

  • BaseResponse
    • AccountCurrenciesResponse

Index

Properties

Properties

Optional api_version

api_version?: number

Optional forwarded

forwarded?: boolean

id

id: string | number

result

result: { ledger_hash?: string; ledger_index: number; receive_currencies: string[]; send_currencies: string[]; validated: boolean }

Type declaration

  • Optional ledger_hash?: string
    +

Hierarchy

  • BaseResponse
    • AccountCurrenciesResponse

Index

Properties

Properties

Optional api_version

api_version?: number

Optional forwarded

forwarded?: boolean

id

id: string | number

result

result: { ledger_hash?: string; ledger_index: number; receive_currencies: string[]; send_currencies: string[]; validated: boolean }

Type declaration

  • Optional ledger_hash?: string

    The identifying hash of the ledger version used to retrieve this data, as hex.

  • ledger_index: number
    @@ -11,4 +11,4 @@ as hex.

    Array of Currency Codes for currencies that this account can send.

  • validated: boolean

    If true, this data comes from a validated ledger.

    -

Optional status

status?: string

type

type: string

Optional warning

warning?: "load"

Optional warnings

warnings?: Warning[]

Legend

  • Constructor
  • Property
  • Method
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Private property
  • Private method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional status

status?: string

type

type: string

Optional warning

warning?: "load"

Optional warnings

warnings?: Warning[]

Legend

  • Constructor
  • Property
  • Method
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Private property
  • Private method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/AccountDelete.html b/docs/interfaces/AccountDelete.html index eaccf9a6..a499bdb8 100644 --- a/docs/interfaces/AccountDelete.html +++ b/docs/interfaces/AccountDelete.html @@ -2,52 +2,52 @@

An AccountDelete transaction deletes an account and any objects it owns in the XRP Ledger, if possible, sending the account's remaining XRP to a specified destination account.

-

Hierarchy

  • BaseTransaction
    • AccountDelete

Index

Properties

Properties

Account

Account: string
+

Hierarchy

  • BaseTransaction
    • AccountDelete

Index

Properties

Properties

Account

Account: string

The unique address of the account that initiated the transaction.

-

Optional AccountTxnID

AccountTxnID?: string
+

Optional AccountTxnID

AccountTxnID?: string

Hash value identifying another transaction. If provided, this transaction is only valid if the sending account's previously-sent transaction matches the provided hash.

-

Destination

Destination: string
+

Destination

Destination: string

The address of an account to receive any leftover XRP after deleting the sending account. Must be a funded account in the ledger, and must not be. the sending account.

-

Optional DestinationTag

DestinationTag?: number
+

Optional DestinationTag

DestinationTag?: number

Arbitrary destination tag that identifies a hosted recipient or other. information for the recipient of the deleted account's leftover XRP.

-

Optional Fee

Fee?: string
+

Optional Fee

Fee?: string

Integer amount of XRP, in drops, to be destroyed as a cost for distributing this transaction to the network. Some transaction types have different minimum requirements.

-

Optional Flags

Flags?: number | GlobalFlags
+

Optional Flags

Flags?: number | GlobalFlags

Set of bit-flags for this transaction.

-

Optional LastLedgerSequence

LastLedgerSequence?: number
+

Optional LastLedgerSequence

LastLedgerSequence?: number

Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected.

-

Optional Memos

Memos?: Memo[]
+

Optional Memos

Memos?: Memo[]

Additional arbitrary information used to identify this transaction.

-

Optional Sequence

Sequence?: number
+

Optional Sequence

Sequence?: number

The sequence number of the account sending the transaction. A transaction is only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account. The special case 0 means the transaction is using a Ticket instead.

-

Optional Signers

Signers?: Signer[]
+

Optional Signers

Signers?: Signer[]

Array of objects that represent a multi-signature which authorizes this transaction.

-

Optional SigningPubKey

SigningPubKey?: string
+

Optional SigningPubKey

SigningPubKey?: string

Hex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in the Signers field instead.

-

Optional SourceTag

SourceTag?: number
+

Optional SourceTag

SourceTag?: number

Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made. Conventionally, a refund should specify the initial payment's SourceTag as the refund payment's DestinationTag.

-

Optional TicketSequence

TicketSequence?: number
+

Optional TicketSequence

TicketSequence?: number

The sequence number of the ticket to use in place of a Sequence number. If this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

-

TransactionType

TransactionType: "AccountDelete"

Optional TxnSignature

TxnSignature?: string
+

TransactionType

TransactionType: "AccountDelete"

Optional TxnSignature

TxnSignature?: string

The signature that verifies this transaction as originating from the account it says it is from.

Legend

  • Constructor
  • Property
  • Method
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Private property
  • Private method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/AccountInfoRequest.html b/docs/interfaces/AccountInfoRequest.html index 1b834326..36fe307a 100644 --- a/docs/interfaces/AccountInfoRequest.html +++ b/docs/interfaces/AccountInfoRequest.html @@ -2,26 +2,26 @@

The account_info command retrieves information about an account, its activity, and its XRP balance. All information retrieved is relative to a particular version of the ledger. Returns an AccountInfoResponse.

-

Hierarchy

  • BaseRequest
    • AccountInfoRequest

Index

Properties

Properties

account

account: string
+

Hierarchy

  • BaseRequest
    • AccountInfoRequest

Index

Properties

Properties

account

account: string

A unique identifier for the account, most commonly the account's address.

-

Optional api_version

api_version?: number
+

Optional api_version

api_version?: number

The API version to use. If omitted, use version 1.

-

command

command: "account_info"

Optional id

id?: string | number
+

command

command: "account_info"

Optional id

id?: string | number

A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

-

Optional ledger_hash

ledger_hash?: string
+

Optional ledger_hash

ledger_hash?: string

A 20-byte hex string for the ledger version to use.

-

Optional ledger_index

ledger_index?: LedgerIndex
+

Optional ledger_index

ledger_index?: LedgerIndex

The ledger index of the ledger to use, or a shortcut string to choose a ledger automatically.

-

Optional queue

queue?: boolean
+

Optional queue

queue?: boolean

Whether to get info about this account's queued transactions. Can only be used when querying for the data from the current open ledger. Not available from servers in Reporting Mode.

-

Optional signer_lists

signer_lists?: boolean
+

Optional signer_lists

signer_lists?: boolean

Request SignerList objects associated with this account.

-

Optional strict

strict?: boolean
+

Optional strict

strict?: boolean

If true, then the account field only accepts a public key or XRP Ledger address. Otherwise, account can be a secret or passphrase (not recommended). The default is false.

diff --git a/docs/interfaces/AccountInfoResponse.html b/docs/interfaces/AccountInfoResponse.html index 0ec2ffc6..92f41079 100644 --- a/docs/interfaces/AccountInfoResponse.html +++ b/docs/interfaces/AccountInfoResponse.html @@ -1,6 +1,6 @@ AccountInfoResponse | xrpl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AccountInfoResponse

Response expected from an AccountInfoRequest.

-

Hierarchy

  • BaseResponse
    • AccountInfoResponse

Index

Properties

Properties

Optional api_version

api_version?: number

Optional forwarded

forwarded?: boolean

id

id: string | number

result

result: { account_data: AccountRoot; ledger_current_index?: number; ledger_index?: number; queue_data?: QueueData; signer_lists?: SignerList[]; validated?: boolean }

Type declaration

Hierarchy

  • BaseResponse
    • AccountInfoResponse

Index

Properties

Properties

Optional api_version

api_version?: number

Optional forwarded

forwarded?: boolean

id

id: string | number

result

result: { account_data: AccountRoot; ledger_current_index?: number; ledger_index?: number; queue_data?: QueueData; signer_lists?: SignerList[]; validated?: boolean }

Type declaration

  • account_data: AccountRoot

    The AccountRoot ledger object with this account's information, as stored in the ledger.

  • Optional ledger_current_index?: number
    @@ -23,4 +23,4 @@ array must have exactly one member if it is present.

  • Optional validated?: boolean

    True if this data is from a validated ledger version; if omitted or set to false, this data is not final.

    -

Optional status

status?: string

type

type: string

Optional warning

warning?: "load"

Optional warnings

warnings?: Warning[]

Legend

  • Constructor
  • Property
  • Method
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Private property
  • Private method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional status

status?: string

type

type: string

Optional warning

warning?: "load"

Optional warnings

warnings?: Warning[]

Legend

  • Constructor
  • Property
  • Method
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Private property
  • Private method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/AccountLinesRequest.html b/docs/interfaces/AccountLinesRequest.html index a1d8904b..5a2d3c24 100644 --- a/docs/interfaces/AccountLinesRequest.html +++ b/docs/interfaces/AccountLinesRequest.html @@ -3,26 +3,26 @@ including balances in all non-XRP currencies and assets. All information retrieved is relative to a particular version of the ledger. Expects an AccountLinesResponse.

-

Hierarchy

  • BaseRequest
    • AccountLinesRequest

Index

Properties

Properties

account

account: string
+

Hierarchy

  • BaseRequest
    • AccountLinesRequest

Index

Properties

Properties

account

account: string

A unique identifier for the account, most commonly the account's Address.

-

Optional api_version

api_version?: number
+

Optional api_version

api_version?: number

The API version to use. If omitted, use version 1.

-

command

command: "account_lines"

Optional id

id?: string | number
+

command

command: "account_lines"

Optional id

id?: string | number

A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

-

Optional ledger_hash

ledger_hash?: string
+

Optional ledger_hash

ledger_hash?: string

A 20-byte hex string for the ledger version to use.

-

Optional ledger_index

ledger_index?: LedgerIndex
+

Optional ledger_index

ledger_index?: LedgerIndex

The ledger index of the ledger to use, or a shortcut string to choose a ledger automatically.

-

Optional limit

limit?: number
+

Optional limit

limit?: number

Limit the number of trust lines to retrieve. The server is not required to honor this value. Must be within the inclusive range 10 to 400.

-

Optional marker

marker?: unknown
+

Optional marker

marker?: unknown

Value from a previous paginated response. Resume retrieving data where that response left off.

-

Optional peer

peer?: string
+

Optional peer

peer?: string

The Address of a second account. If provided, show only lines of trust connecting the two accounts.

Legend

  • Constructor
  • Property
  • Method
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Private property
  • Private method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/AccountLinesResponse.html b/docs/interfaces/AccountLinesResponse.html index 76709804..b69af4dd 100644 --- a/docs/interfaces/AccountLinesResponse.html +++ b/docs/interfaces/AccountLinesResponse.html @@ -1,6 +1,6 @@ AccountLinesResponse | xrpl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AccountLinesResponse

Response expected from an AccountLinesRequest.

-

Hierarchy

  • BaseResponse
    • AccountLinesResponse

Index

Properties

Properties

Optional api_version

api_version?: number

Optional forwarded

forwarded?: boolean

id

id: string | number

result

result: { account: string; ledger_current_index?: number; ledger_hash?: string; ledger_index?: number; lines: Trustline[]; marker?: unknown }

Type declaration

  • account: string
    +

Hierarchy

  • BaseResponse
    • AccountLinesResponse

Index

Properties

Properties

Optional api_version

api_version?: number

Optional forwarded

forwarded?: boolean

id

id: string | number

result

result: { account: string; ledger_current_index?: number; ledger_hash?: string; ledger_index?: number; lines: Trustline[]; marker?: unknown }

Type declaration

  • account: string

    Unique Address of the account this request corresponds to. This is the "perspective account" for purpose of the trust lines.

  • Optional ledger_current_index?: number
    @@ -19,4 +19,4 @@ returns up to the limit at a time.

    Server-defined value indicating the response is paginated. Pass this to the next call to resume where this call left off. Omitted when there are No additional pages after this one.

    -

Optional status

status?: string

type

type: string

Optional warning

warning?: "load"

Optional warnings

warnings?: Warning[]

Legend

  • Constructor
  • Property
  • Method
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Private property
  • Private method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional status

status?: string

type

type: string

Optional warning

warning?: "load"

Optional warnings

warnings?: Warning[]

Legend

  • Constructor
  • Property
  • Method
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Private property
  • Private method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/AccountNFTsRequest.html b/docs/interfaces/AccountNFTsRequest.html index 40016ccc..b53f7b91 100644 --- a/docs/interfaces/AccountNFTsRequest.html +++ b/docs/interfaces/AccountNFTsRequest.html @@ -1,18 +1,18 @@ AccountNFTsRequest | xrpl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AccountNFTsRequest

The account_nfts method retrieves all of the NFTs currently owned by the specified account.

-

Hierarchy

  • BaseRequest
    • AccountNFTsRequest

Index

Properties

Properties

account

account: string
+

Hierarchy

  • BaseRequest
    • AccountNFTsRequest

Index

Properties

Properties

account

account: string

The unique identifier of an account, typically the account's address. The request returns NFTs owned by this account.

-

Optional api_version

api_version?: number
+

Optional api_version

api_version?: number

The API version to use. If omitted, use version 1.

-

command

command: "account_nfts"

Optional id

id?: string | number
+

command

command: "account_nfts"

Optional id

id?: string | number

A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

-

Optional limit

limit?: number
+

Optional limit

limit?: number

Limit the number of NFTokens to retrieve.

-

Optional marker

marker?: unknown
+

Optional marker

marker?: unknown

Value from a previous paginated response. Resume retrieving data where that response left off.

Legend

  • Constructor
  • Property
  • Method
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Private property
  • Private method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/AccountNFTsResponse.html b/docs/interfaces/AccountNFTsResponse.html index d9b4951c..6e674f4b 100644 --- a/docs/interfaces/AccountNFTsResponse.html +++ b/docs/interfaces/AccountNFTsResponse.html @@ -1,6 +1,6 @@ AccountNFTsResponse | xrpl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AccountNFTsResponse

Response expected from an AccountNFTsRequest.

-

Hierarchy

  • BaseResponse
    • AccountNFTsResponse

Index

Properties

Properties

Optional api_version

api_version?: number

Optional forwarded

forwarded?: boolean

id

id: string | number

result

result: { account: string; account_nfts: AccountNFToken[]; ledger_current_index: number; limit?: number; marker?: unknown; validated: boolean }

Type declaration

  • account: string
    +

Hierarchy

  • BaseResponse
    • AccountNFTsResponse

Index

Properties

Properties

Optional api_version

api_version?: number

Optional forwarded

forwarded?: boolean

id

id: string | number

result

result: { account: string; account_nfts: AccountNFToken[]; ledger_current_index: number; limit?: number; marker?: unknown; validated: boolean }

Type declaration

  • account: string

    The account requested.

  • account_nfts: AccountNFToken[]

    A list of NFTs owned by the specified account.

    @@ -15,4 +15,4 @@ the next call to resume where this call left off. Omitted when there are No additional pages after this one.

  • validated: boolean

    If true, this data comes from a validated ledger.

    -

Optional status

status?: string

type

type: string

Optional warning

warning?: "load"

Optional warnings

warnings?: Warning[]

Legend

  • Constructor
  • Property
  • Method
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Private property
  • Private method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional status

status?: string

type

type: string

Optional warning

warning?: "load"

Optional warnings

warnings?: Warning[]

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/AccountObjectsRequest.html b/docs/interfaces/AccountObjectsRequest.html index 786f1733..6918c152 100644 --- a/docs/interfaces/AccountObjectsRequest.html +++ b/docs/interfaces/AccountObjectsRequest.html @@ -3,29 +3,29 @@ owned by an account. For a higher-level view of an account's trust lines and balances, see the account_lines method instead. Expects a response in the form of an AccountObjectsResponse.

-

Hierarchy

Index

Properties

Properties

account

account: string
+

Hierarchy

  • BaseRequest
    • AccountObjectsRequest

Index

Properties

Properties

account

account: string

A unique identifier for the account, most commonly the account's address.

-

Optional api_version

api_version?: number
+

Optional api_version

api_version?: number

The API version to use. If omitted, use version 1.

-

command

command: "account_objects"

Optional deletion_blockers_only

deletion_blockers_only?: boolean
+

command

command: "account_objects"

Optional deletion_blockers_only

deletion_blockers_only?: boolean

If true, the response only includes objects that would block this account from being deleted. The default is false.

-

Optional id

id?: string | number
+

Optional id

id?: string | number

A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

-

Optional ledger_hash

ledger_hash?: string
+

Optional ledger_hash

ledger_hash?: string

A 20-byte hex string for the ledger version to use.

-

Optional ledger_index

ledger_index?: LedgerIndex
+

Optional ledger_index

ledger_index?: LedgerIndex

The ledger index of the ledger to use, or a shortcut string to choose a Ledger automatically.

-

Optional limit

limit?: number
+

Optional limit

limit?: number

The maximum number of objects to include in the results. Must be within the inclusive range 10 to 400 on non-admin connections. The default is 200.

-

Optional marker

marker?: unknown
+

Optional marker

marker?: unknown

Value from a previous paginated response. Resume retrieving data where that response left off.

-

Optional type

type?: AccountObjectType
+

Optional type

type?: AccountObjectType

If included, filter results to include only this type of ledger object. The valid types are: Check , DepositPreauth, Escrow, Offer, PayChannel, SignerList, Ticket, and RippleState (trust line).

diff --git a/docs/interfaces/AccountObjectsResponse.html b/docs/interfaces/AccountObjectsResponse.html index 2549d6c8..f7e7ddac 100644 --- a/docs/interfaces/AccountObjectsResponse.html +++ b/docs/interfaces/AccountObjectsResponse.html @@ -1,6 +1,6 @@ AccountObjectsResponse | xrpl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AccountObjectsResponse

Response expected from an AccountObjectsRequest.

-

Hierarchy

  • BaseResponse
    • AccountObjectsResponse

Index

Properties

Properties

Optional api_version

api_version?: number

Optional forwarded

forwarded?: boolean

id

id: string | number

result

result: { account: string; account_objects: AccountObject[]; ledger_current_index?: number; ledger_hash?: string; ledger_index?: number; limit?: number; marker?: string; validated?: boolean }

Type declaration

  • account: string
    +

Hierarchy

  • BaseResponse
    • AccountObjectsResponse

Index

Properties

Properties

Optional api_version

api_version?: number

Optional forwarded

forwarded?: boolean

id

id: string | number

result

result: { account: string; account_objects: AccountObject[]; ledger_current_index?: number; ledger_hash?: string; ledger_index?: number; limit?: number; marker?: string; validated?: boolean }

Type declaration

  • account: string

    Unique Address of the account this request corresponds to.

  • account_objects: AccountObject[]

    Array of objects owned by this account. Each object is in its raw @@ -24,4 +24,4 @@ no additional pages after this one.

    If included and set to true, the information in this response comes from a validated ledger version. Otherwise, the information is subject to change.

    -

Optional status

status?: string

type

type: string

Optional warning

warning?: "load"

Optional warnings

warnings?: Warning[]

Legend

  • Constructor
  • Property
  • Method
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Private property
  • Private method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional status

status?: string

type

type: string

Optional warning

warning?: "load"

Optional warnings

warnings?: Warning[]

Legend

  • Constructor
  • Property
  • Method
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Private property
  • Private method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/AccountOffersRequest.html b/docs/interfaces/AccountOffersRequest.html index 7633130b..24747f32 100644 --- a/docs/interfaces/AccountOffersRequest.html +++ b/docs/interfaces/AccountOffersRequest.html @@ -2,26 +2,26 @@

The account_offers method retrieves a list of offers made by a given account that are outstanding as of a particular ledger version. Expects a response in the form of a AccountOffersResponse.

-

Hierarchy

Index

Properties

Properties

account

account: string
+

Hierarchy

  • BaseRequest
    • AccountOffersRequest

Index

Properties

Properties

account

account: string

A unique identifier for the account, most commonly the account's Address.

-

Optional api_version

api_version?: number
+

Optional api_version

api_version?: number

The API version to use. If omitted, use version 1.

-

command

command: "account_offers"

Optional id

id?: string | number
+

command

command: "account_offers"

Optional id

id?: string | number

A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

-

Optional ledger_hash

ledger_hash?: string
+

Optional ledger_hash

ledger_hash?: string

A 20-byte hex string identifying the ledger version to use.

-

Optional ledger_index

ledger_index?: LedgerIndex
+

Optional ledger_index

ledger_index?: LedgerIndex

The ledger index of the ledger to use, or "current", "closed", or "validated" to select a ledger dynamically.

-

Optional limit

limit?: number
+

Optional limit

limit?: number

Limit the number of transactions to retrieve. The server is not required to honor this value. Must be within the inclusive range 10 to 400.

-

Optional marker

marker?: unknown
+

Optional marker

marker?: unknown

Value from a previous paginated response. Resume retrieving data where that response left off.

-

Optional strict

strict?: boolean
+

Optional strict

strict?: boolean

If true, then the account field only accepts a public key or XRP Ledger address. Otherwise, account can be a secret or passphrase (not recommended). The default is false.

diff --git a/docs/interfaces/AccountOffersResponse.html b/docs/interfaces/AccountOffersResponse.html index e71c6022..0102c256 100644 --- a/docs/interfaces/AccountOffersResponse.html +++ b/docs/interfaces/AccountOffersResponse.html @@ -1,6 +1,6 @@ AccountOffersResponse | xrpl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AccountOffersResponse

Response expected from an AccountOffersRequest.

-

Hierarchy

  • BaseResponse
    • AccountOffersResponse

Index

Properties

Properties

Optional api_version

api_version?: number

Optional forwarded

forwarded?: boolean

id

id: string | number

result

result: { account: string; ledger_current_index?: number; ledger_hash?: string; ledger_index?: number; marker?: unknown; offers?: AccountOffer[] }

Type declaration

  • account: string
    +

Hierarchy

  • BaseResponse
    • AccountOffersResponse

Index

Properties

Properties

Optional api_version

api_version?: number

Optional forwarded

forwarded?: boolean

id

id: string | number

result

result: { account: string; ledger_current_index?: number; ledger_hash?: string; ledger_index?: number; marker?: unknown; offers?: AccountOffer[] }

Type declaration

  • account: string

    Unique Address identifying the account that made the offers.

  • Optional ledger_current_index?: number

    The ledger index of the current in-progress ledger version, which was @@ -19,4 +19,4 @@ no pages of information after this one.

    Array of objects, where each object represents an offer made by this account that is outstanding as of the requested ledger version. If the number of offers is large, only returns up to limit at a time.

    -

Optional status

status?: string

type

type: string

Optional warning

warning?: "load"

Optional warnings

warnings?: Warning[]

Legend

  • Constructor
  • Property
  • Method
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Private property
  • Private method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional status

status?: string

type

type: string

Optional warning

warning?: "load"

Optional warnings

warnings?: Warning[]

Legend

  • Constructor
  • Property
  • Method
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Private property
  • Private method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/AccountSet.html b/docs/interfaces/AccountSet.html index 9c1fa40b..a90634bc 100644 --- a/docs/interfaces/AccountSet.html +++ b/docs/interfaces/AccountSet.html @@ -1,65 +1,65 @@ AccountSet | xrpl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AccountSet

An AccountSet transaction modifies the properties of an account in the XRP Ledger.

-

Hierarchy

  • BaseTransaction
    • AccountSet

Index

Properties

Properties

Account

Account: string
+

Hierarchy

  • BaseTransaction
    • AccountSet

Index

Properties

Properties

Account

Account: string

The unique address of the account that initiated the transaction.

-

Optional AccountTxnID

AccountTxnID?: string
+

Optional AccountTxnID

AccountTxnID?: string

Hash value identifying another transaction. If provided, this transaction is only valid if the sending account's previously-sent transaction matches the provided hash.

-

Optional ClearFlag

ClearFlag?: number
+

Optional ClearFlag

ClearFlag?: number

Unique identifier of a flag to disable for this account.

-

Optional Domain

Domain?: string
+

Optional Domain

Domain?: string

The domain that owns this account, as a string of hex representing the. ASCII for the domain in lowercase.

-

Optional EmailHash

EmailHash?: string
+

Optional EmailHash

EmailHash?: string

Hash of an email address to be used for generating an avatar image.

-

Optional Fee

Fee?: string
+

Optional Fee

Fee?: string

Integer amount of XRP, in drops, to be destroyed as a cost for distributing this transaction to the network. Some transaction types have different minimum requirements.

-

Optional Flags

Flags?: number | AccountSetFlagsInterface

Optional LastLedgerSequence

LastLedgerSequence?: number
+

Optional Flags

Flags?: number | AccountSetFlagsInterface

Optional LastLedgerSequence

LastLedgerSequence?: number

Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected.

-

Optional Memos

Memos?: Memo[]
+

Optional Memos

Memos?: Memo[]

Additional arbitrary information used to identify this transaction.

-

Optional MessageKey

MessageKey?: string
+

Optional MessageKey

MessageKey?: string

Public key for sending encrypted messages to this account.

-

Optional Minter

Minter?: string
+

Optional Minter

Minter?: string

Sets an alternate account that is allowed to mint NFTokens on this account's behalf using NFTokenMint's Issuer field.

-

Optional Sequence

Sequence?: number
+

Optional Sequence

Sequence?: number

The sequence number of the account sending the transaction. A transaction is only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account. The special case 0 means the transaction is using a Ticket instead.

-

Optional SetFlag

SetFlag?: AccountSetAsfFlags
+

Optional SetFlag

SetFlag?: AccountSetAsfFlags

Integer flag to enable for this account.

-

Optional Signers

Signers?: Signer[]
+

Optional Signers

Signers?: Signer[]

Array of objects that represent a multi-signature which authorizes this transaction.

-

Optional SigningPubKey

SigningPubKey?: string
+

Optional SigningPubKey

SigningPubKey?: string

Hex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in the Signers field instead.

-

Optional SourceTag

SourceTag?: number
+

Optional SourceTag

SourceTag?: number

Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made. Conventionally, a refund should specify the initial payment's SourceTag as the refund payment's DestinationTag.

-

Optional TickSize

TickSize?: number
+

Optional TickSize

TickSize?: number

Tick size to use for offers involving a currency issued by this address. The exchange rates of those offers is rounded to this many significant digits. Valid values are 3 to 15 inclusive, or 0 to disable.

-

Optional TicketSequence

TicketSequence?: number
+

Optional TicketSequence

TicketSequence?: number

The sequence number of the ticket to use in place of a Sequence number. If this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

-

TransactionType

TransactionType: "AccountSet"

Optional TransferRate

TransferRate?: number
+

TransactionType

TransactionType: "AccountSet"

Optional TransferRate

TransferRate?: number

The fee to charge when users transfer this account's issued currencies, represented as billionths of a unit. Cannot be more than 2000000000 or less than 1000000000, except for the special case 0 meaning no fee.

-

Optional TxnSignature

TxnSignature?: string
+

Optional TxnSignature

TxnSignature?: string

The signature that verifies this transaction as originating from the account it says it is from.

Legend

  • Constructor
  • Property
  • Method
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Private property
  • Private method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/AccountSetFlagsInterface.html b/docs/interfaces/AccountSetFlagsInterface.html index 64e0896c..170290aa 100644 --- a/docs/interfaces/AccountSetFlagsInterface.html +++ b/docs/interfaces/AccountSetFlagsInterface.html @@ -3,4 +3,4 @@ flags.

example
 const accountSetTx: AccountSet = {
   TransactionType: 'AccountSet',
   Account: 'rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn',
   Flags: {
     tfOptionalDestTag: true,
     tfRequireAuth: true
   },
 }

// Autofill the tx to see how flags actually look compared to the interface usage.
const autofilledTx = await client.autofill(accountSetTx)
console.log(autofilledTx)
// {
//  TransactionType: 'AccountSet',
//  Account: 'rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn',
//  Flags: 393216,
//  Sequence: 1,
//  Fee: '12',
//  LastLedgerSequence: 21971793
// }
-

Hierarchy

Index

Properties

Properties

Optional tfAllowXRP

tfAllowXRP?: boolean

Optional tfDisallowXRP

tfDisallowXRP?: boolean

Optional tfOptionalAuth

tfOptionalAuth?: boolean

Optional tfOptionalDestTag

tfOptionalDestTag?: boolean

Optional tfRequireAuth

tfRequireAuth?: boolean

Optional tfRequireDestTag

tfRequireDestTag?: boolean

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

Optional tfAllowXRP

tfAllowXRP?: boolean

Optional tfDisallowXRP

tfDisallowXRP?: boolean

Optional tfOptionalAuth

tfOptionalAuth?: boolean

Optional tfOptionalDestTag

tfOptionalDestTag?: boolean

Optional tfRequireAuth

tfRequireAuth?: boolean

Optional tfRequireDestTag

tfRequireDestTag?: boolean

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/AccountTxRequest.html b/docs/interfaces/AccountTxRequest.html index 6db6652c..c05c7948 100644 --- a/docs/interfaces/AccountTxRequest.html +++ b/docs/interfaces/AccountTxRequest.html @@ -1,36 +1,36 @@ AccountTxRequest | xrpl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AccountTxRequest

The account_tx method retrieves a list of transactions that involved the specified account. Expects a response in the form of a AccountTxResponse.

-

Hierarchy

  • BaseRequest
    • AccountTxRequest

Index

Properties

Properties

account

account: string
+

Hierarchy

  • BaseRequest
    • AccountTxRequest

Index

Properties

Properties

account

account: string

A unique identifier for the account, most commonly the account's address.

-

Optional api_version

api_version?: number
+

Optional api_version

api_version?: number

The API version to use. If omitted, use version 1.

-

Optional binary

binary?: boolean
+

Optional binary

binary?: boolean

If true, return transactions as hex strings instead of JSON. The default is false.

-

command

command: "account_tx"

Optional forward

forward?: boolean
+

command

command: "account_tx"

Optional forward

forward?: boolean

If true, returns values indexed with the oldest ledger first. Otherwise, the results are indexed with the newest ledger first.

-

Optional id

id?: string | number
+

Optional id

id?: string | number

A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

-

Optional ledger_hash

ledger_hash?: string
+

Optional ledger_hash

ledger_hash?: string

Use to look for transactions from a single ledger only.

-

Optional ledger_index

ledger_index?: LedgerIndex
+

Optional ledger_index

ledger_index?: LedgerIndex

Use to look for transactions from a single ledger only.

-

Optional ledger_index_max

ledger_index_max?: number
+

Optional ledger_index_max

ledger_index_max?: number

Use to specify the most recent ledger to include transactions from. A value of -1 instructs the server to use the most recent validated ledger version available.

-

Optional ledger_index_min

ledger_index_min?: number
+

Optional ledger_index_min

ledger_index_min?: number

Use to specify the earliest ledger to include transactions from. A value of -1 instructs the server to use the earliest validated ledger version available.

-

Optional limit

limit?: number
+

Optional limit

limit?: number

Default varies. Limit the number of transactions to retrieve. The server is not required to honor this value.

-

Optional marker

marker?: unknown
+

Optional marker

marker?: unknown

Value from a previous paginated response. Resume retrieving data where that response left off. This value is stable even if there is a change in the server's range of available ledgers.

diff --git a/docs/interfaces/AccountTxResponse.html b/docs/interfaces/AccountTxResponse.html index 9a345b5a..38cf17cb 100644 --- a/docs/interfaces/AccountTxResponse.html +++ b/docs/interfaces/AccountTxResponse.html @@ -1,6 +1,6 @@ AccountTxResponse | xrpl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AccountTxResponse

Expected response from an AccountTxRequest.

-

Hierarchy

  • BaseResponse
    • AccountTxResponse

Index

Properties

Properties

Optional api_version

api_version?: number

Optional forwarded

forwarded?: boolean

id

id: string | number

result

result: { account: string; ledger_index_max: number; ledger_index_min: number; limit: number; marker?: unknown; transactions: AccountTransaction[]; validated?: boolean }

Type declaration

  • account: string
    +

Hierarchy

  • BaseResponse
    • AccountTxResponse

Index

Properties

Properties

Optional api_version

api_version?: number

Optional forwarded

forwarded?: boolean

id

id: string | number

result

result: { account: string; ledger_index_max: number; ledger_index_min: number; limit: number; marker?: unknown; transactions: AccountTransaction[]; validated?: boolean }

Type declaration

  • account: string

    Unique Address identifying the related account.

  • ledger_index_max: number

    The ledger index of the most recent ledger actually searched for @@ -20,4 +20,4 @@ below.

    If included and set to true, the information in this response comes from a validated ledger version. Otherwise, the information is subject to change.

    -

Optional status

status?: string

type

type: string

Optional warning

warning?: "load"

Optional warnings

warnings?: Warning[]

Legend

  • Constructor
  • Property
  • Method
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Private property
  • Private method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional status

status?: string

type

type: string

Optional warning

warning?: "load"

Optional warnings

warnings?: Warning[]

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/BookOffer.html b/docs/interfaces/BookOffer.html index e0d21946..8cad50d9 100644 --- a/docs/interfaces/BookOffer.html +++ b/docs/interfaces/BookOffer.html @@ -1,44 +1,44 @@ -BookOffer | xrpl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BookOffer

Hierarchy

Index

Properties

Properties

Account

Account: string
+BookOffer | xrpl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BookOffer

Hierarchy

Index

Properties

Properties

Account

Account: string

The address of the account that placed this Offer.

-

BookDirectory

BookDirectory: string
+

BookDirectory

BookDirectory: string

The ID of the Offer Directory that links to this Offer.

-

BookNode

BookNode: string
+

BookNode

BookNode: string

A hint indicating which page of the Offer Directory links to this object, in case the directory consists of multiple pages.

-

Optional Expiration

Expiration?: number
+

Optional Expiration

Expiration?: number

The time this Offer expires, in seconds since the Ripple Epoch.

-

Flags

Flags: number
+

Flags

Flags: number

A bit-map of boolean flags enabled for this Offer.

-

LedgerEntryType

LedgerEntryType: "Offer"

OwnerNode

OwnerNode: string
+

LedgerEntryType

LedgerEntryType: "Offer"

OwnerNode

OwnerNode: string

A hint indicating which page of the Owner Directory links to this object, in case the directory consists of multiple pages.

-

PreviousTxnID

PreviousTxnID: string
+

PreviousTxnID

PreviousTxnID: string

The identifying hash of the transaction that most recently modified this object.

-

PreviousTxnLgrSeq

PreviousTxnLgrSeq: number
+

PreviousTxnLgrSeq

PreviousTxnLgrSeq: number

The index of the ledger that contains the transaction that most recently modified this object.

-

Sequence

Sequence: number
+

Sequence

Sequence: number

The Sequence value of the OfferCreate transaction that created this Offer object. Used in combination with the Account to identify this Offer.

-

TakerGets

TakerGets: Amount
+

TakerGets

TakerGets: Amount

The remaining amount and type of currency being provided by the Offer creator.

-

TakerPays

TakerPays: Amount
+

TakerPays

TakerPays: Amount

The remaining amount and type of currency requested by the Offer creator.

-

index

index: string

Optional owner_funds

owner_funds?: string
+

index

index: string

Optional owner_funds

owner_funds?: string

Amount of the TakerGets currency the side placing the offer has available to be traded. (XRP is represented as drops; any other currency is represented as a decimal value.) If a trader has multiple offers in the same book, only the highest-ranked offer includes this field.

-

Optional quality

quality?: string
+

Optional quality

quality?: string

The exchange rate, as the ratio taker_pays divided by taker_gets. For fairness, offers that have the same quality are automatically taken first-in, first-out.

-

Optional taker_gets_funded

taker_gets_funded?: Amount
+

Optional taker_gets_funded

taker_gets_funded?: Amount

The maximum amount of currency that the taker can get, given the funding status of the offer.

-

Optional taker_pays_funded

taker_pays_funded?: Amount
+

Optional taker_pays_funded

taker_pays_funded?: Amount

The maximum amount of currency that the taker would pay, given the funding status of the offer.

Legend

  • Constructor
  • Property
  • Method
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Private property
  • Private method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/BookOffersRequest.html b/docs/interfaces/BookOffersRequest.html index 2ee66329..b76fbbb3 100644 --- a/docs/interfaces/BookOffersRequest.html +++ b/docs/interfaces/BookOffersRequest.html @@ -1,29 +1,29 @@ BookOffersRequest | xrpl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BookOffersRequest

The book_offers method retrieves a list of offers, also known as the order. Book, between two currencies. Returns an BookOffersResponse.

-

Hierarchy

  • BaseRequest
    • BookOffersRequest

Index

Properties

Properties

Optional api_version

api_version?: number
+

Hierarchy

  • BaseRequest
    • BookOffersRequest

Index

Properties

Properties

Optional api_version

api_version?: number

The API version to use. If omitted, use version 1.

-

command

command: "book_offers"

Optional id

id?: string | number
+

command

command: "book_offers"

Optional id

id?: string | number

A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

-

Optional ledger_hash

ledger_hash?: string
+

Optional ledger_hash

ledger_hash?: string

A 20-byte hex string for the ledger version to use.

-

Optional ledger_index

ledger_index?: LedgerIndex
+

Optional ledger_index

ledger_index?: LedgerIndex

The ledger index of the ledger to use, or a shortcut string to choose a ledger automatically.

-

Optional limit

limit?: number
+

Optional limit

limit?: number

If provided, the server does not provide more than this many offers in the results. The total number of results returned may be fewer than the limit, because the server omits unfunded offers.

-

Optional taker

taker?: string
+

Optional taker

taker?: string

The Address of an account to use as a perspective. Unfunded offers placed by this account are always included in the response.

-

taker_gets

taker_gets: TakerAmount
+

taker_gets

taker_gets: TakerAmount

Specification of which currency the account taking the offer would receive, as an object with currency and issuer fields (omit issuer for XRP), like currency amounts.

-

taker_pays

taker_pays: TakerAmount
+

taker_pays

taker_pays: TakerAmount

Specification of which currency the account taking the offer would pay, as an object with currency and issuer fields (omit issuer for XRP), like currency amounts.

diff --git a/docs/interfaces/BookOffersResponse.html b/docs/interfaces/BookOffersResponse.html index 8c9355bb..6f7d05ed 100644 --- a/docs/interfaces/BookOffersResponse.html +++ b/docs/interfaces/BookOffersResponse.html @@ -1,6 +1,6 @@ BookOffersResponse | xrpl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BookOffersResponse

Expected response from a BookOffersRequest.

-

Hierarchy

  • BaseResponse
    • BookOffersResponse

Index

Properties

Properties

Optional api_version

api_version?: number

Optional forwarded

forwarded?: boolean

id

id: string | number

result

result: { ledger_current_index?: number; ledger_hash?: string; ledger_index?: number; offers: BookOffer[]; validated?: boolean }

Type declaration

  • Optional ledger_current_index?: number
    +

Hierarchy

  • BaseResponse
    • BookOffersResponse

Index

Properties

Properties

Optional api_version

api_version?: number

Optional forwarded

forwarded?: boolean

id

id: string | number

result

result: { ledger_current_index?: number; ledger_hash?: string; ledger_index?: number; offers: BookOffer[]; validated?: boolean }

Type declaration

  • Optional ledger_current_index?: number

    The ledger index of the current in-progress ledger version, which was used to retrieve this information.

  • Optional ledger_hash?: string
    @@ -11,4 +11,4 @@ this data, as requested.

    this data, as requested.

  • offers: BookOffer[]

    Array of offer objects, each of which has the fields of an Offer object.

    -
  • Optional validated?: boolean

Optional status

status?: string

type

type: string

Optional warning

warning?: "load"

Optional warnings

warnings?: Warning[]

Legend

  • Constructor
  • Property
  • Method
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Private property
  • Private method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +
  • Optional validated?: boolean

    • Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/ChannelVerifyRequest.html b/docs/interfaces/ChannelVerifyRequest.html index 3076a9d9..a0d7a160 100644 --- a/docs/interfaces/ChannelVerifyRequest.html +++ b/docs/interfaces/ChannelVerifyRequest.html @@ -2,20 +2,20 @@

    The channel_verify method checks the validity of a signature that can be used to redeem a specific amount of XRP from a payment channel. Expects a response in the form of a ChannelVerifyResponse.

    -

    Hierarchy

    Index

    Properties

    Properties

    amount

    amount: string
    +

    Hierarchy

    • BaseRequest
      • ChannelVerifyRequest

    Index

    Properties

    Properties

    amount

    amount: string

    The amount of XRP, in drops, the provided signature authorizes.

    -

    Optional api_version

    api_version?: number
    +

    Optional api_version

    api_version?: number

    The API version to use. If omitted, use version 1.

    -

    channel_id

    channel_id: string
    +

    channel_id

    channel_id: string

    The Channel ID of the channel that provides the XRP. This is a 64-character hexadecimal string.

    -

    command

    command: "channel_verify"

    Optional id

    id?: string | number
    +

    command

    command: "channel_verify"

    Optional id

    id?: string | number

    A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

    -

    public_key

    public_key: string
    +

    public_key

    public_key: string

    The public key of the channel and the key pair that was used to create the signature, in hexadecimal or the XRP Ledger's base58 format.

    -

    signature

    signature: string
    +

    signature

    signature: string

    The signature to verify, in hexadecimal.

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/ChannelVerifyResponse.html b/docs/interfaces/ChannelVerifyResponse.html index 7939f1f6..b9b9ae68 100644 --- a/docs/interfaces/ChannelVerifyResponse.html +++ b/docs/interfaces/ChannelVerifyResponse.html @@ -1,6 +1,6 @@ ChannelVerifyResponse | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ChannelVerifyResponse

    Response expected from an ChannelVerifyRequest.

    -

    Hierarchy

    • BaseResponse
      • ChannelVerifyResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { signature_verified: boolean }

    Type declaration

    • signature_verified: boolean
      +

    Hierarchy

    • BaseResponse
      • ChannelVerifyResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { signature_verified: boolean }

    Type declaration

    • signature_verified: boolean

      If true, the signature is valid for the stated amount, channel, and public key.

      -

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/CheckCancel.html b/docs/interfaces/CheckCancel.html index 36ffa8c0..f961c699 100644 --- a/docs/interfaces/CheckCancel.html +++ b/docs/interfaces/CheckCancel.html @@ -3,48 +3,48 @@ money. The source or the destination of the check can cancel a Check at any time using this transaction type. If the Check has expired, any address can cancel it.

    -

    Hierarchy

    Index

    Properties

    Properties

    Account

    Account: string
    +

    Hierarchy

    • BaseTransaction
      • CheckCancel

    Index

    Properties

    Properties

    Account

    Account: string

    The unique address of the account that initiated the transaction.

    -

    Optional AccountTxnID

    AccountTxnID?: string
    +

    Optional AccountTxnID

    AccountTxnID?: string

    Hash value identifying another transaction. If provided, this transaction is only valid if the sending account's previously-sent transaction matches the provided hash.

    -

    CheckID

    CheckID: string
    +

    CheckID

    CheckID: string

    The ID of the Check ledger object to cancel as a 64-character hexadecimal string.

    -

    Optional Fee

    Fee?: string
    +

    Optional Fee

    Fee?: string

    Integer amount of XRP, in drops, to be destroyed as a cost for distributing this transaction to the network. Some transaction types have different minimum requirements.

    -

    Optional Flags

    Flags?: number | GlobalFlags
    +

    Optional Flags

    Flags?: number | GlobalFlags

    Set of bit-flags for this transaction.

    -

    Optional LastLedgerSequence

    LastLedgerSequence?: number
    +

    Optional LastLedgerSequence

    LastLedgerSequence?: number

    Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected.

    -

    Optional Memos

    Memos?: Memo[]
    +

    Optional Memos

    Memos?: Memo[]

    Additional arbitrary information used to identify this transaction.

    -

    Optional Sequence

    Sequence?: number
    +

    Optional Sequence

    Sequence?: number

    The sequence number of the account sending the transaction. A transaction is only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account. The special case 0 means the transaction is using a Ticket instead.

    -

    Optional Signers

    Signers?: Signer[]
    +

    Optional Signers

    Signers?: Signer[]

    Array of objects that represent a multi-signature which authorizes this transaction.

    -

    Optional SigningPubKey

    SigningPubKey?: string
    +

    Optional SigningPubKey

    SigningPubKey?: string

    Hex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in the Signers field instead.

    -

    Optional SourceTag

    SourceTag?: number
    +

    Optional SourceTag

    SourceTag?: number

    Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made. Conventionally, a refund should specify the initial payment's SourceTag as the refund payment's DestinationTag.

    -

    Optional TicketSequence

    TicketSequence?: number
    +

    Optional TicketSequence

    TicketSequence?: number

    The sequence number of the ticket to use in place of a Sequence number. If this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    -

    TransactionType

    TransactionType: "CheckCancel"

    Optional TxnSignature

    TxnSignature?: string
    +

    TransactionType

    TransactionType: "CheckCancel"

    Optional TxnSignature

    TxnSignature?: string

    The signature that verifies this transaction as originating from the account it says it is from.

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/CheckCash.html b/docs/interfaces/CheckCash.html index b4a9413f..a4c6c984 100644 --- a/docs/interfaces/CheckCash.html +++ b/docs/interfaces/CheckCash.html @@ -2,56 +2,56 @@

    Attempts to redeem a Check object in the ledger to receive up to the amount authorized by the corresponding CheckCreate transaction. Only the Destination address of a Check can cash it with a CheckCash transaction.

    -

    Hierarchy

    Index

    Properties

    Properties

    Account

    Account: string
    +

    Hierarchy

    • BaseTransaction
      • CheckCash

    Index

    Properties

    Properties

    Account

    Account: string

    The unique address of the account that initiated the transaction.

    -

    Optional AccountTxnID

    AccountTxnID?: string
    +

    Optional AccountTxnID

    AccountTxnID?: string

    Hash value identifying another transaction. If provided, this transaction is only valid if the sending account's previously-sent transaction matches the provided hash.

    -

    Optional Amount

    Amount?: Amount
    +

    Optional Amount

    Amount?: Amount

    Redeem the Check for exactly this amount, if possible. The currency must match that of the SendMax of the corresponding CheckCreate transaction. You. must provide either this field or DeliverMin.

    -

    CheckID

    CheckID: string
    +

    CheckID

    CheckID: string

    The ID of the Check ledger object to cash as a 64-character hexadecimal string.

    -

    Optional DeliverMin

    DeliverMin?: Amount
    +

    Optional DeliverMin

    DeliverMin?: Amount

    Redeem the Check for at least this amount and for as much as possible. The currency must match that of the SendMax of the corresponding CheckCreate. transaction. You must provide either this field or Amount.

    -

    Optional Fee

    Fee?: string
    +

    Optional Fee

    Fee?: string

    Integer amount of XRP, in drops, to be destroyed as a cost for distributing this transaction to the network. Some transaction types have different minimum requirements.

    -

    Optional Flags

    Flags?: number | GlobalFlags
    +

    Optional Flags

    Flags?: number | GlobalFlags

    Set of bit-flags for this transaction.

    -

    Optional LastLedgerSequence

    LastLedgerSequence?: number
    +

    Optional LastLedgerSequence

    LastLedgerSequence?: number

    Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected.

    -

    Optional Memos

    Memos?: Memo[]
    +

    Optional Memos

    Memos?: Memo[]

    Additional arbitrary information used to identify this transaction.

    -

    Optional Sequence

    Sequence?: number
    +

    Optional Sequence

    Sequence?: number

    The sequence number of the account sending the transaction. A transaction is only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account. The special case 0 means the transaction is using a Ticket instead.

    -

    Optional Signers

    Signers?: Signer[]
    +

    Optional Signers

    Signers?: Signer[]

    Array of objects that represent a multi-signature which authorizes this transaction.

    -

    Optional SigningPubKey

    SigningPubKey?: string
    +

    Optional SigningPubKey

    SigningPubKey?: string

    Hex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in the Signers field instead.

    -

    Optional SourceTag

    SourceTag?: number
    +

    Optional SourceTag

    SourceTag?: number

    Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made. Conventionally, a refund should specify the initial payment's SourceTag as the refund payment's DestinationTag.

    -

    Optional TicketSequence

    TicketSequence?: number
    +

    Optional TicketSequence

    TicketSequence?: number

    The sequence number of the ticket to use in place of a Sequence number. If this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    -

    TransactionType

    TransactionType: "CheckCash"

    Optional TxnSignature

    TxnSignature?: string
    +

    TransactionType

    TransactionType: "CheckCash"

    Optional TxnSignature

    TxnSignature?: string

    The signature that verifies this transaction as originating from the account it says it is from.

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/CheckCreate.html b/docs/interfaces/CheckCreate.html index c57cfecd..e4304da6 100644 --- a/docs/interfaces/CheckCreate.html +++ b/docs/interfaces/CheckCreate.html @@ -2,62 +2,62 @@

    Create a Check object in the ledger, which is a deferred payment that can be cashed by its intended destination. The sender of this transaction is the sender of the Check.

    -

    Hierarchy

    Index

    Properties

    Properties

    Account

    Account: string
    +

    Hierarchy

    • BaseTransaction
      • CheckCreate

    Index

    Properties

    Properties

    Account

    Account: string

    The unique address of the account that initiated the transaction.

    -

    Optional AccountTxnID

    AccountTxnID?: string
    +

    Optional AccountTxnID

    AccountTxnID?: string

    Hash value identifying another transaction. If provided, this transaction is only valid if the sending account's previously-sent transaction matches the provided hash.

    -

    Destination

    Destination: string
    +

    Destination

    Destination: string

    The unique address of the account that can cash the Check.

    -

    Optional DestinationTag

    DestinationTag?: number
    +

    Optional DestinationTag

    DestinationTag?: number

    Arbitrary tag that identifies the reason for the Check, or a hosted. recipient to pay.

    -

    Optional Expiration

    Expiration?: number
    +

    Optional Expiration

    Expiration?: number

    Time after which the Check is no longer valid, in seconds since the Ripple. Epoch.

    -

    Optional Fee

    Fee?: string
    +

    Optional Fee

    Fee?: string

    Integer amount of XRP, in drops, to be destroyed as a cost for distributing this transaction to the network. Some transaction types have different minimum requirements.

    -

    Optional Flags

    Flags?: number | GlobalFlags
    +

    Optional Flags

    Flags?: number | GlobalFlags

    Set of bit-flags for this transaction.

    -

    Optional InvoiceID

    InvoiceID?: string
    +

    Optional InvoiceID

    InvoiceID?: string

    Arbitrary 256-bit hash representing a specific reason or identifier for. this Check.

    -

    Optional LastLedgerSequence

    LastLedgerSequence?: number
    +

    Optional LastLedgerSequence

    LastLedgerSequence?: number

    Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected.

    -

    Optional Memos

    Memos?: Memo[]
    +

    Optional Memos

    Memos?: Memo[]

    Additional arbitrary information used to identify this transaction.

    -

    SendMax

    SendMax: Amount
    +

    SendMax

    SendMax: Amount

    Maximum amount of source currency the Check is allowed to debit the sender, including transfer fees on non-XRP currencies. The Check can only credit the destination with the same currency (from the same issuer, for non-XRP currencies). For non-XRP amounts, the nested field names MUST be. lower-case.

    -

    Optional Sequence

    Sequence?: number
    +

    Optional Sequence

    Sequence?: number

    The sequence number of the account sending the transaction. A transaction is only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account. The special case 0 means the transaction is using a Ticket instead.

    -

    Optional Signers

    Signers?: Signer[]
    +

    Optional Signers

    Signers?: Signer[]

    Array of objects that represent a multi-signature which authorizes this transaction.

    -

    Optional SigningPubKey

    SigningPubKey?: string
    +

    Optional SigningPubKey

    SigningPubKey?: string

    Hex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in the Signers field instead.

    -

    Optional SourceTag

    SourceTag?: number
    +

    Optional SourceTag

    SourceTag?: number

    Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made. Conventionally, a refund should specify the initial payment's SourceTag as the refund payment's DestinationTag.

    -

    Optional TicketSequence

    TicketSequence?: number
    +

    Optional TicketSequence

    TicketSequence?: number

    The sequence number of the ticket to use in place of a Sequence number. If this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    -

    TransactionType

    TransactionType: "CheckCreate"

    Optional TxnSignature

    TxnSignature?: string
    +

    TransactionType

    TransactionType: "CheckCreate"

    Optional TxnSignature

    TxnSignature?: string

    The signature that verifies this transaction as originating from the account it says it is from.

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/ClientOptions.html b/docs/interfaces/ClientOptions.html index b6ecd7c2..d06a3fc9 100644 --- a/docs/interfaces/ClientOptions.html +++ b/docs/interfaces/ClientOptions.html @@ -1 +1 @@ -ClientOptions | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ClientOptions

    Hierarchy

    • ConnectionUserOptions
      • ClientOptions

    Index

    Properties

    Properties

    Optional authorization

    authorization?: string

    Optional certificate

    certificate?: string

    Optional connectionTimeout

    connectionTimeout?: number

    Optional feeCushion

    feeCushion?: number

    Optional key

    key?: string

    Optional maxFeeXRP

    maxFeeXRP?: string

    Optional passphrase

    passphrase?: string

    Optional proxy

    proxy?: string

    Optional proxyAuthorization

    proxyAuthorization?: string

    Optional timeout

    timeout?: number

    Optional trace

    trace?: boolean | ((id: string, message: string) => void)

    Optional trustedCertificates

    trustedCertificates?: string[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ClientOptions | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ClientOptions

    Hierarchy

    • ConnectionUserOptions
      • ClientOptions

    Index

    Properties

    Properties

    Optional authorization

    authorization?: string

    Optional certificate

    certificate?: string

    Optional connectionTimeout

    connectionTimeout?: number

    Optional feeCushion

    feeCushion?: number

    Optional key

    key?: string

    Optional maxFeeXRP

    maxFeeXRP?: string

    Optional passphrase

    passphrase?: string

    Optional proxy

    proxy?: string

    Optional proxyAuthorization

    proxyAuthorization?: string

    Optional timeout

    timeout?: number

    Optional trace

    trace?: boolean | ((id: string, message: string) => void)

    Optional trustedCertificates

    trustedCertificates?: string[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/ConsensusStream.html b/docs/interfaces/ConsensusStream.html index 228cae2e..a916d42e 100644 --- a/docs/interfaces/ConsensusStream.html +++ b/docs/interfaces/ConsensusStream.html @@ -2,7 +2,7 @@

    The consensus stream sends consensusPhase messages when the consensus process changes phase. The message contains the new phase of consensus the server is in.

    -

    Hierarchy

    Index

    Properties

    Properties

    consensus

    consensus: "open" | "establish" | "accepted"
    +

    Hierarchy

    • BaseStream
      • ConsensusStream

    Index

    Properties

    Properties

    consensus

    consensus: "open" | "establish" | "accepted"

    The new consensus phase the server is in. Possible values are open, establish, and accepted.

    -

    type

    type: "consensusPhase"

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    type

    type: "consensusPhase"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/DepositAuthorizedRequest.html b/docs/interfaces/DepositAuthorizedRequest.html index d1e2d183..70300280 100644 --- a/docs/interfaces/DepositAuthorizedRequest.html +++ b/docs/interfaces/DepositAuthorizedRequest.html @@ -1,19 +1,19 @@ DepositAuthorizedRequest | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface DepositAuthorizedRequest

    The deposit_authorized command indicates whether one account is authorized to send payments directly to another. Expects a response in the form of a DepositAuthorizedResponse.

    -

    Hierarchy

    • BaseRequest
      • DepositAuthorizedRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number
    +

    Hierarchy

    • BaseRequest
      • DepositAuthorizedRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    The API version to use. If omitted, use version 1.

    -

    command

    command: "deposit_authorized"

    destination_account

    destination_account: string
    +

    command

    command: "deposit_authorized"

    destination_account

    destination_account: string

    The recipient of a possible payment.

    -

    Optional id

    id?: string | number
    +

    Optional id

    id?: string | number

    A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

    -

    Optional ledger_hash

    ledger_hash?: string
    +

    Optional ledger_hash

    ledger_hash?: string

    A 20-byte hex string for the ledger version to use.

    -

    Optional ledger_index

    ledger_index?: LedgerIndex
    +

    Optional ledger_index

    ledger_index?: LedgerIndex

    The ledger index of the ledger to use, or a shortcut string to choose a ledger automatically.

    -

    source_account

    source_account: string
    +

    source_account

    source_account: string

    The sender of a possible payment.

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/DepositAuthorizedResponse.html b/docs/interfaces/DepositAuthorizedResponse.html index 24363a95..ea6a8e71 100644 --- a/docs/interfaces/DepositAuthorizedResponse.html +++ b/docs/interfaces/DepositAuthorizedResponse.html @@ -1,6 +1,6 @@ DepositAuthorizedResponse | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface DepositAuthorizedResponse

    Expected response from a DepositAuthorizedRequest.

    -

    Hierarchy

    • BaseResponse
      • DepositAuthorizedResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { deposit_authorized: boolean; destination_account: string; ledger_current_index?: number; ledger_hash?: string; ledger_index?: number; source_account: string; validated?: boolean }

    Type declaration

    • deposit_authorized: boolean
      +

    Hierarchy

    • BaseResponse
      • DepositAuthorizedResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { deposit_authorized: boolean; destination_account: string; ledger_current_index?: number; ledger_hash?: string; ledger_index?: number; source_account: string; validated?: boolean }

    Type declaration

    • deposit_authorized: boolean

      Whether the specified source account is authorized to send payments directly to the destination account. If true, either the destination account does not require Deposit Authorization or the source account is @@ -20,4 +20,4 @@ Response.

      The source account specified in the request.

    • Optional validated?: boolean

      If true, the information comes from a validated ledger version.

      -

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Generated using TypeDoc

    \ No newline at end of file +

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/DepositPreauth.html b/docs/interfaces/DepositPreauth.html index 259444e8..e2340311 100644 --- a/docs/interfaces/DepositPreauth.html +++ b/docs/interfaces/DepositPreauth.html @@ -2,50 +2,50 @@

    A DepositPreauth transaction gives another account pre-approval to deliver payments to the sender of this transaction. This is only useful if the sender of this transaction is using (or plans to use) Deposit Authorization.

    -

    Hierarchy

    Index

    Properties

    Properties

    Account

    Account: string
    +

    Hierarchy

    • BaseTransaction
      • DepositPreauth

    Index

    Properties

    Properties

    Account

    Account: string

    The unique address of the account that initiated the transaction.

    -

    Optional AccountTxnID

    AccountTxnID?: string
    +

    Optional AccountTxnID

    AccountTxnID?: string

    Hash value identifying another transaction. If provided, this transaction is only valid if the sending account's previously-sent transaction matches the provided hash.

    -

    Optional Authorize

    Authorize?: string
    +

    Optional Authorize

    Authorize?: string

    The XRP Ledger address of the sender to preauthorize.

    -

    Optional Fee

    Fee?: string
    +

    Optional Fee

    Fee?: string

    Integer amount of XRP, in drops, to be destroyed as a cost for distributing this transaction to the network. Some transaction types have different minimum requirements.

    -

    Optional Flags

    Flags?: number | GlobalFlags
    +

    Optional Flags

    Flags?: number | GlobalFlags

    Set of bit-flags for this transaction.

    -

    Optional LastLedgerSequence

    LastLedgerSequence?: number
    +

    Optional LastLedgerSequence

    LastLedgerSequence?: number

    Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected.

    -

    Optional Memos

    Memos?: Memo[]
    +

    Optional Memos

    Memos?: Memo[]

    Additional arbitrary information used to identify this transaction.

    -

    Optional Sequence

    Sequence?: number
    +

    Optional Sequence

    Sequence?: number

    The sequence number of the account sending the transaction. A transaction is only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account. The special case 0 means the transaction is using a Ticket instead.

    -

    Optional Signers

    Signers?: Signer[]
    +

    Optional Signers

    Signers?: Signer[]

    Array of objects that represent a multi-signature which authorizes this transaction.

    -

    Optional SigningPubKey

    SigningPubKey?: string
    +

    Optional SigningPubKey

    SigningPubKey?: string

    Hex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in the Signers field instead.

    -

    Optional SourceTag

    SourceTag?: number
    +

    Optional SourceTag

    SourceTag?: number

    Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made. Conventionally, a refund should specify the initial payment's SourceTag as the refund payment's DestinationTag.

    -

    Optional TicketSequence

    TicketSequence?: number
    +

    Optional TicketSequence

    TicketSequence?: number

    The sequence number of the ticket to use in place of a Sequence number. If this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    -

    TransactionType

    TransactionType: "DepositPreauth"

    Optional TxnSignature

    TxnSignature?: string
    +

    TransactionType

    TransactionType: "DepositPreauth"

    Optional TxnSignature

    TxnSignature?: string

    The signature that verifies this transaction as originating from the account it says it is from.

    -

    Optional Unauthorize

    Unauthorize?: string
    +

    Optional Unauthorize

    Unauthorize?: string

    The XRP Ledger address of a sender whose preauthorization should be. revoked.

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/ErrorResponse.html b/docs/interfaces/ErrorResponse.html index 50078fd9..e6994919 100644 --- a/docs/interfaces/ErrorResponse.html +++ b/docs/interfaces/ErrorResponse.html @@ -1,4 +1,4 @@ ErrorResponse | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ErrorResponse

    The shape of an error response from rippled. xrpl.js handles rejections by throwing, and allowing the user to handle in the catch block of a promise.

    -

    Hierarchy

    • ErrorResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    error

    error: string

    Optional error_code

    error_code?: string

    Optional error_message

    error_message?: string

    id

    id: string | number

    request

    request: Request

    status

    status: "error"

    type

    type: string

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Hierarchy

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    error

    error: string

    Optional error_code

    error_code?: string

    Optional error_message

    error_message?: string

    id

    id: string | number

    request

    request: Request

    status

    status: "error"

    type

    type: string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/EscrowCancel.html b/docs/interfaces/EscrowCancel.html index e9d649bb..427b483c 100644 --- a/docs/interfaces/EscrowCancel.html +++ b/docs/interfaces/EscrowCancel.html @@ -1,49 +1,49 @@ EscrowCancel | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface EscrowCancel

    Return escrowed XRP to the sender.

    -

    Hierarchy

    • BaseTransaction
      • EscrowCancel

    Index

    Properties

    Properties

    Account

    Account: string
    +

    Hierarchy

    • BaseTransaction
      • EscrowCancel

    Index

    Properties

    Properties

    Account

    Account: string

    The unique address of the account that initiated the transaction.

    -

    Optional AccountTxnID

    AccountTxnID?: string
    +

    Optional AccountTxnID

    AccountTxnID?: string

    Hash value identifying another transaction. If provided, this transaction is only valid if the sending account's previously-sent transaction matches the provided hash.

    -

    Optional Fee

    Fee?: string
    +

    Optional Fee

    Fee?: string

    Integer amount of XRP, in drops, to be destroyed as a cost for distributing this transaction to the network. Some transaction types have different minimum requirements.

    -

    Optional Flags

    Flags?: number | GlobalFlags
    +

    Optional Flags

    Flags?: number | GlobalFlags

    Set of bit-flags for this transaction.

    -

    Optional LastLedgerSequence

    LastLedgerSequence?: number
    +

    Optional LastLedgerSequence

    LastLedgerSequence?: number

    Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected.

    -

    Optional Memos

    Memos?: Memo[]
    +

    Optional Memos

    Memos?: Memo[]

    Additional arbitrary information used to identify this transaction.

    -

    OfferSequence

    OfferSequence: number
    +

    OfferSequence

    OfferSequence: number

    Transaction sequence (or Ticket number) of EscrowCreate transaction that. created the escrow to cancel.

    -

    Owner

    Owner: string
    +

    Owner

    Owner: string

    Address of the source account that funded the escrow payment.

    -

    Optional Sequence

    Sequence?: number
    +

    Optional Sequence

    Sequence?: number

    The sequence number of the account sending the transaction. A transaction is only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account. The special case 0 means the transaction is using a Ticket instead.

    -

    Optional Signers

    Signers?: Signer[]
    +

    Optional Signers

    Signers?: Signer[]

    Array of objects that represent a multi-signature which authorizes this transaction.

    -

    Optional SigningPubKey

    SigningPubKey?: string
    +

    Optional SigningPubKey

    SigningPubKey?: string

    Hex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in the Signers field instead.

    -

    Optional SourceTag

    SourceTag?: number
    +

    Optional SourceTag

    SourceTag?: number

    Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made. Conventionally, a refund should specify the initial payment's SourceTag as the refund payment's DestinationTag.

    -

    Optional TicketSequence

    TicketSequence?: number
    +

    Optional TicketSequence

    TicketSequence?: number

    The sequence number of the ticket to use in place of a Sequence number. If this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    -

    TransactionType

    TransactionType: "EscrowCancel"

    Optional TxnSignature

    TxnSignature?: string
    +

    TransactionType

    TransactionType: "EscrowCancel"

    Optional TxnSignature

    TxnSignature?: string

    The signature that verifies this transaction as originating from the account it says it is from.

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/EscrowCreate.html b/docs/interfaces/EscrowCreate.html index 3f68561a..bcba78b7 100644 --- a/docs/interfaces/EscrowCreate.html +++ b/docs/interfaces/EscrowCreate.html @@ -1,64 +1,64 @@ EscrowCreate | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface EscrowCreate

    Sequester XRP until the escrow process either finishes or is canceled.

    -

    Hierarchy

    • BaseTransaction
      • EscrowCreate

    Index

    Properties

    Properties

    Account

    Account: string
    +

    Hierarchy

    • BaseTransaction
      • EscrowCreate

    Index

    Properties

    Properties

    Account

    Account: string

    The unique address of the account that initiated the transaction.

    -

    Optional AccountTxnID

    AccountTxnID?: string
    +

    Optional AccountTxnID

    AccountTxnID?: string

    Hash value identifying another transaction. If provided, this transaction is only valid if the sending account's previously-sent transaction matches the provided hash.

    -

    Amount

    Amount: string
    +

    Amount

    Amount: string

    Amount of XRP, in drops, to deduct from the sender's balance and escrow. Once escrowed, the XRP can either go to the Destination address (after the. FinishAfter time) or returned to the sender (after the CancelAfter time).

    -

    Optional CancelAfter

    CancelAfter?: number
    +

    Optional CancelAfter

    CancelAfter?: number

    The time, in seconds since the Ripple Epoch, when this escrow expires. This value is immutable; the funds can only be returned the sender after. this time.

    -

    Optional Condition

    Condition?: string
    +

    Optional Condition

    Condition?: string

    Hex value representing a PREIMAGE-SHA-256 crypto-condition . The funds can. only be delivered to the recipient if this condition is fulfilled.

    -

    Destination

    Destination: string
    +

    Destination

    Destination: string

    Address to receive escrowed XRP.

    -

    Optional DestinationTag

    DestinationTag?: number
    +

    Optional DestinationTag

    DestinationTag?: number

    Arbitrary tag to further specify the destination for this escrowed. payment, such as a hosted recipient at the destination address.

    -

    Optional Fee

    Fee?: string
    +

    Optional Fee

    Fee?: string

    Integer amount of XRP, in drops, to be destroyed as a cost for distributing this transaction to the network. Some transaction types have different minimum requirements.

    -

    Optional FinishAfter

    FinishAfter?: number
    +

    Optional FinishAfter

    FinishAfter?: number

    The time, in seconds since the Ripple Epoch, when the escrowed XRP can be released to the recipient. This value is immutable; the funds cannot move. until this time is reached.

    -

    Optional Flags

    Flags?: number | GlobalFlags
    +

    Optional Flags

    Flags?: number | GlobalFlags

    Set of bit-flags for this transaction.

    -

    Optional LastLedgerSequence

    LastLedgerSequence?: number
    +

    Optional LastLedgerSequence

    LastLedgerSequence?: number

    Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected.

    -

    Optional Memos

    Memos?: Memo[]
    +

    Optional Memos

    Memos?: Memo[]

    Additional arbitrary information used to identify this transaction.

    -

    Optional Sequence

    Sequence?: number
    +

    Optional Sequence

    Sequence?: number

    The sequence number of the account sending the transaction. A transaction is only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account. The special case 0 means the transaction is using a Ticket instead.

    -

    Optional Signers

    Signers?: Signer[]
    +

    Optional Signers

    Signers?: Signer[]

    Array of objects that represent a multi-signature which authorizes this transaction.

    -

    Optional SigningPubKey

    SigningPubKey?: string
    +

    Optional SigningPubKey

    SigningPubKey?: string

    Hex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in the Signers field instead.

    -

    Optional SourceTag

    SourceTag?: number
    +

    Optional SourceTag

    SourceTag?: number

    Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made. Conventionally, a refund should specify the initial payment's SourceTag as the refund payment's DestinationTag.

    -

    Optional TicketSequence

    TicketSequence?: number
    +

    Optional TicketSequence

    TicketSequence?: number

    The sequence number of the ticket to use in place of a Sequence number. If this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    -

    TransactionType

    TransactionType: "EscrowCreate"

    Optional TxnSignature

    TxnSignature?: string
    +

    TransactionType

    TransactionType: "EscrowCreate"

    Optional TxnSignature

    TxnSignature?: string

    The signature that verifies this transaction as originating from the account it says it is from.

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/EscrowFinish.html b/docs/interfaces/EscrowFinish.html index e93c91d6..66a6cbe0 100644 --- a/docs/interfaces/EscrowFinish.html +++ b/docs/interfaces/EscrowFinish.html @@ -1,55 +1,55 @@ EscrowFinish | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface EscrowFinish

    Deliver XRP from a held payment to the recipient.

    -

    Hierarchy

    • BaseTransaction
      • EscrowFinish

    Index

    Properties

    Properties

    Account

    Account: string
    +

    Hierarchy

    • BaseTransaction
      • EscrowFinish

    Index

    Properties

    Properties

    Account

    Account: string

    The unique address of the account that initiated the transaction.

    -

    Optional AccountTxnID

    AccountTxnID?: string
    +

    Optional AccountTxnID

    AccountTxnID?: string

    Hash value identifying another transaction. If provided, this transaction is only valid if the sending account's previously-sent transaction matches the provided hash.

    -

    Optional Condition

    Condition?: string
    +

    Optional Condition

    Condition?: string

    Hex value matching the previously-supplied PREIMAGE-SHA-256. crypto-condition of the held payment.

    -

    Optional Fee

    Fee?: string
    +

    Optional Fee

    Fee?: string

    Integer amount of XRP, in drops, to be destroyed as a cost for distributing this transaction to the network. Some transaction types have different minimum requirements.

    -

    Optional Flags

    Flags?: number | GlobalFlags
    +

    Optional Flags

    Flags?: number | GlobalFlags

    Set of bit-flags for this transaction.

    -

    Optional Fulfillment

    Fulfillment?: string
    +

    Optional Fulfillment

    Fulfillment?: string

    Hex value of the PREIMAGE-SHA-256 crypto-condition fulfillment matching. the held payment's Condition.

    -

    Optional LastLedgerSequence

    LastLedgerSequence?: number
    +

    Optional LastLedgerSequence

    LastLedgerSequence?: number

    Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected.

    -

    Optional Memos

    Memos?: Memo[]
    +

    Optional Memos

    Memos?: Memo[]

    Additional arbitrary information used to identify this transaction.

    -

    OfferSequence

    OfferSequence: number
    +

    OfferSequence

    OfferSequence: number

    Transaction sequence of EscrowCreate transaction that created the held. payment to finish.

    -

    Owner

    Owner: string
    +

    Owner

    Owner: string

    Address of the source account that funded the held payment.

    -

    Optional Sequence

    Sequence?: number
    +

    Optional Sequence

    Sequence?: number

    The sequence number of the account sending the transaction. A transaction is only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account. The special case 0 means the transaction is using a Ticket instead.

    -

    Optional Signers

    Signers?: Signer[]
    +

    Optional Signers

    Signers?: Signer[]

    Array of objects that represent a multi-signature which authorizes this transaction.

    -

    Optional SigningPubKey

    SigningPubKey?: string
    +

    Optional SigningPubKey

    SigningPubKey?: string

    Hex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in the Signers field instead.

    -

    Optional SourceTag

    SourceTag?: number
    +

    Optional SourceTag

    SourceTag?: number

    Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made. Conventionally, a refund should specify the initial payment's SourceTag as the refund payment's DestinationTag.

    -

    Optional TicketSequence

    TicketSequence?: number
    +

    Optional TicketSequence

    TicketSequence?: number

    The sequence number of the ticket to use in place of a Sequence number. If this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    -

    TransactionType

    TransactionType: "EscrowFinish"

    Optional TxnSignature

    TxnSignature?: string
    +

    TransactionType

    TransactionType: "EscrowFinish"

    Optional TxnSignature

    TxnSignature?: string

    The signature that verifies this transaction as originating from the account it says it is from.

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/FeeRequest.html b/docs/interfaces/FeeRequest.html index 971ec716..0f66c497 100644 --- a/docs/interfaces/FeeRequest.html +++ b/docs/interfaces/FeeRequest.html @@ -4,9 +4,9 @@ for the transaction cost. This requires the FeeEscalation amendment to be enabled. Expects a response in the form of a FeeResponse.

    example
    const feeRequest: FeeRequest = {
     command: 'fee'
    }
    -

    Hierarchy

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number
    +

    Hierarchy

    • BaseRequest
      • FeeRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    The API version to use. If omitted, use version 1.

    -

    command

    command: "fee"

    Optional id

    id?: string | number
    +

    command

    command: "fee"

    Optional id

    id?: string | number

    A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

    diff --git a/docs/interfaces/FeeResponse.html b/docs/interfaces/FeeResponse.html index e10fdc32..c3d8a836 100644 --- a/docs/interfaces/FeeResponse.html +++ b/docs/interfaces/FeeResponse.html @@ -1,6 +1,6 @@ FeeResponse | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface FeeResponse

    Response expected from a FeeRequest.

    -

    Hierarchy

    • BaseResponse
      • FeeResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { current_ledger_size: string; current_queue_size: string; drops: { base_fee: string; median_fee: string; minimum_fee: string; open_ledger_fee: string }; expected_ledger_size: string; ledger_current_index: number; levels: { median_level: string; minimum_level: string; open_ledger_level: string; reference_level: string }; max_queue_size: string }

    Type declaration

    • current_ledger_size: string
      +

    Hierarchy

    • BaseResponse
      • FeeResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { current_ledger_size: string; current_queue_size: string; drops: { base_fee: string; median_fee: string; minimum_fee: string; open_ledger_fee: string }; expected_ledger_size: string; ledger_current_index: number; levels: { median_level: string; minimum_level: string; open_ledger_level: string; reference_level: string }; max_queue_size: string }

    Type declaration

    • current_ledger_size: string

      Number of transactions provisionally included in the in-progress ledger.

    • current_queue_size: string

      Number of transactions currently queued for the next ledger.

      @@ -38,4 +38,4 @@ levels.

  • max_queue_size: string

    The maximum number of transactions that the transaction queue can currently hold.

    -

    • Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/GatewayBalancesRequest.html b/docs/interfaces/GatewayBalancesRequest.html index 4cc57330..a5669388 100644 --- a/docs/interfaces/GatewayBalancesRequest.html +++ b/docs/interfaces/GatewayBalancesRequest.html @@ -4,23 +4,23 @@ account, optionally excluding amounts held by operational addresses. Expects a response in the form of a GatewayBalancesResponse.

    example
    const gatewayBalances: GatewayBalanceRequest = {
      "id": "example_gateway_balances_1",
      "command": "gateway_balances",
      "account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
      "strict": true,
      "hotwallet": ["rKm4uWpg9tfwbVSeATv4KxDe6mpE9yPkgJ","ra7JkEzrgeKHdzKgo4EUUVBnxggY4z37kt"],
      "ledger_index": "validated"
    }
    -

    Hierarchy

    Index

    Properties

    Properties

    account

    account: string
    +

    Hierarchy

    • BaseRequest
      • GatewayBalancesRequest

    Index

    Properties

    Properties

    account

    account: string

    The Address to check. This should be the issuing address.

    -

    Optional api_version

    api_version?: number
    +

    Optional api_version

    api_version?: number

    The API version to use. If omitted, use version 1.

    -

    command

    command: "gateway_balances"

    Optional hotwallet

    hotwallet?: string | string[]
    +

    command

    command: "gateway_balances"

    Optional hotwallet

    hotwallet?: string | string[]

    An operational address to exclude from the balances issued, or an array of Such addresses.

    -

    Optional id

    id?: string | number
    +

    Optional id

    id?: string | number

    A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

    -

    Optional ledger_hash

    ledger_hash?: string
    +

    Optional ledger_hash

    ledger_hash?: string

    A 20-byte hex string for the ledger version to use.

    -

    Optional ledger_index

    ledger_index?: LedgerIndex
    +

    Optional ledger_index

    ledger_index?: LedgerIndex

    The ledger index of the ledger version to use, or a shortcut string to choose a ledger automatically.

    -

    Optional strict

    strict?: boolean
    +

    Optional strict

    strict?: boolean

    If true, only accept an address or public key for the account parameter. Defaults to false.

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/GatewayBalancesResponse.html b/docs/interfaces/GatewayBalancesResponse.html index 9fa6f272..c7878707 100644 --- a/docs/interfaces/GatewayBalancesResponse.html +++ b/docs/interfaces/GatewayBalancesResponse.html @@ -1,6 +1,6 @@ GatewayBalancesResponse | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface GatewayBalancesResponse

    Expected response from a GatewayBalancesRequest.

    -

    Hierarchy

    • BaseResponse
      • GatewayBalancesResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { account: string; assets?: {}; balances?: {}; ledger_current_index?: number; ledger_hash?: string; ledger_index?: number; obligations?: {} }

    Type declaration

    • account: string
      +

    Hierarchy

    • BaseResponse
      • GatewayBalancesResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { account: string; assets?: {}; balances?: {}; ledger_current_index?: number; ledger_hash?: string; ledger_index?: number; obligations?: {} }

    Type declaration

    • account: string

      The address of the account that issued the balances.

    • Optional assets?: {}

      Total amounts held that are issued by others. In the recommended @@ -20,4 +20,4 @@ used to retrieve this information.

    • Optional obligations?: {}

      Total amounts issued to addresses not excluded, as a map of currencies to the total value issued.

      -
      • [currency: string]: string

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/LedgerClosedRequest.html b/docs/interfaces/LedgerClosedRequest.html index 0bef8e57..88f7e8de 100644 --- a/docs/interfaces/LedgerClosedRequest.html +++ b/docs/interfaces/LedgerClosedRequest.html @@ -6,9 +6,9 @@ closed ledger. Expects a response in the form of a

    Hierarchy

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number
    +

    Hierarchy

    • BaseRequest
      • LedgerClosedRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    The API version to use. If omitted, use version 1.

    -

    command

    command: "ledger_closed"

    Optional id

    id?: string | number
    +

    command

    command: "ledger_closed"

    Optional id

    id?: string | number

    A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

    diff --git a/docs/interfaces/LedgerClosedResponse.html b/docs/interfaces/LedgerClosedResponse.html index e8b97ed6..6cdc6a91 100644 --- a/docs/interfaces/LedgerClosedResponse.html +++ b/docs/interfaces/LedgerClosedResponse.html @@ -1,3 +1,3 @@ LedgerClosedResponse | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface LedgerClosedResponse

    The response expected from a LedgerClosedRequest.

    -

    Hierarchy

    • BaseResponse
      • LedgerClosedResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { ledger_hash: string; ledger_index: number }

    Type declaration

    • ledger_hash: string
    • ledger_index: number

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Hierarchy

    • BaseResponse
      • LedgerClosedResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { ledger_hash: string; ledger_index: number }

    Type declaration

    • ledger_hash: string
    • ledger_index: number

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/LedgerCurrentRequest.html b/docs/interfaces/LedgerCurrentRequest.html index 8d250c54..430a45e8 100644 --- a/docs/interfaces/LedgerCurrentRequest.html +++ b/docs/interfaces/LedgerCurrentRequest.html @@ -3,9 +3,9 @@ in-progress ledger. Expects a response in the form of a LedgerCurrentResponse.

    example
    const ledgerCurrent: LedgerCurrentRequest = {
      "command": "ledger_current"
    }
    -

    Hierarchy

    • BaseRequest
      • LedgerCurrentRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number
    +

    Hierarchy

    • BaseRequest
      • LedgerCurrentRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    The API version to use. If omitted, use version 1.

    -

    command

    command: "ledger_current"

    Optional id

    id?: string | number
    +

    command

    command: "ledger_current"

    Optional id

    id?: string | number

    A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

    diff --git a/docs/interfaces/LedgerCurrentResponse.html b/docs/interfaces/LedgerCurrentResponse.html index e19a980e..78e65cde 100644 --- a/docs/interfaces/LedgerCurrentResponse.html +++ b/docs/interfaces/LedgerCurrentResponse.html @@ -1,5 +1,5 @@ LedgerCurrentResponse | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface LedgerCurrentResponse

    Response expected from a LedgerCurrentRequest.

    -

    Hierarchy

    • BaseResponse
      • LedgerCurrentResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { ledger_current_index: number }

    Type declaration

    • ledger_current_index: number
      +

    Hierarchy

    • BaseResponse
      • LedgerCurrentResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { ledger_current_index: number }

    Type declaration

    • ledger_current_index: number

      The ledger index of this ledger version.

      -

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/LedgerDataRequest.html b/docs/interfaces/LedgerDataRequest.html index a2e815e8..f45640db 100644 --- a/docs/interfaces/LedgerDataRequest.html +++ b/docs/interfaces/LedgerDataRequest.html @@ -4,24 +4,24 @@ iterate through several calls to retrieve the entire contents of a single ledger version.

    example
    const ledgerData: LedgerDataRequest = {
      "id": 2,
      "ledger_hash": "842B57C1CC0613299A686D3E9F310EC0422C84D3911E5056389AA7E5808A93C8",
      "command": "ledger_data",
      "limit": 5,
      "binary": true
    }
    -

    Hierarchy

    • BaseRequest
      • LedgerDataRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number
    +

    Hierarchy

    • BaseRequest
      • LedgerDataRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    The API version to use. If omitted, use version 1.

    -

    Optional binary

    binary?: boolean
    +

    Optional binary

    binary?: boolean

    If set to true, return ledger objects as hashed hex strings instead of JSON.

    -

    command

    command: "ledger_data"

    Optional id

    id?: string | number
    +

    command

    command: "ledger_data"

    Optional id

    id?: string | number

    A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

    -

    Optional ledger_hash

    ledger_hash?: string
    +

    Optional ledger_hash

    ledger_hash?: string

    A 20-byte hex string for the ledger version to use.

    -

    Optional ledger_index

    ledger_index?: LedgerIndex
    +

    Optional ledger_index

    ledger_index?: LedgerIndex

    The ledger index of the ledger to use, or a shortcut string to choose a ledger automatically.

    -

    Optional limit

    limit?: number
    +

    Optional limit

    limit?: number

    Limit the number of ledger objects to retrieve. The server is not required to honor this value.

    -

    Optional marker

    marker?: unknown
    +

    Optional marker

    marker?: unknown

    Value from a previous paginated response. Resume retrieving data where that response left off.

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/LedgerDataResponse.html b/docs/interfaces/LedgerDataResponse.html index 6b4aa154..c7530a93 100644 --- a/docs/interfaces/LedgerDataResponse.html +++ b/docs/interfaces/LedgerDataResponse.html @@ -1,6 +1,6 @@ LedgerDataResponse | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface LedgerDataResponse

    The response expected from a LedgerDataRequest.

    -

    Hierarchy

    • BaseResponse
      • LedgerDataResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { ledger_hash: string; ledger_index: number; marker?: unknown; state: State[]; validated?: boolean }

    Type declaration

    • ledger_hash: string
      +

    Hierarchy

    • BaseResponse
      • LedgerDataResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { ledger_hash: string; ledger_index: number; marker?: unknown; state: State[]; validated?: boolean }

    Type declaration

    • ledger_hash: string

      Unique identifying hash of this ledger version.

    • ledger_index: number

      The ledger index of this ledger version.

      @@ -10,4 +10,4 @@ the next call to resume where this call left off.

    • state: State[]

      Array of JSON objects containing data from the ledger's state tree, as defined below.

      -
    • Optional validated?: boolean

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +
  • Optional validated?: boolean

    • Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/LedgerEntry.AccountRoot.html b/docs/interfaces/LedgerEntry.AccountRoot.html index 97f203f9..34dca0c7 100644 --- a/docs/interfaces/LedgerEntry.AccountRoot.html +++ b/docs/interfaces/LedgerEntry.AccountRoot.html @@ -1,48 +1,48 @@ AccountRoot | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface AccountRoot

    The AccountRoot object type describes a single account, its settings, and XRP balance.

    -

    Hierarchy

    • BaseLedgerEntry
      • AccountRoot

    Index

    Properties

    Properties

    Account

    Account: string
    +

    Hierarchy

    • BaseLedgerEntry
      • AccountRoot

    Index

    Properties

    Properties

    Account

    Account: string

    The identifying (classic) address of this account.

    -

    Optional AccountTxnID

    AccountTxnID?: string
    +

    Optional AccountTxnID

    AccountTxnID?: string

    The identifying hash of the transaction most recently sent by this account. This field must be enabled to use the AccountTxnID transaction field. To enable it, send an AccountSet transaction with the. asfAccountTxnID flag enabled.

    -

    Balance

    Balance: string
    +

    Balance

    Balance: string

    The account's current XRP balance in drops, represented as a string.

    -

    Optional Domain

    Domain?: string
    +

    Optional Domain

    Domain?: string

    A domain associated with this account. In JSON, this is the hexadecimal for the ASCII representation of the domain.

    -

    Optional EmailHash

    EmailHash?: string
    +

    Optional EmailHash

    EmailHash?: string

    The md5 hash of an email address.

    -

    Flags

    Flags: number
    +

    Flags

    Flags: number

    A bit-map of boolean flags enabled for this account.

    -

    LedgerEntryType

    LedgerEntryType: "AccountRoot"

    Optional MessageKey

    MessageKey?: string
    +

    LedgerEntryType

    LedgerEntryType: "AccountRoot"

    Optional MessageKey

    MessageKey?: string

    A public key that may be used to send encrypted messages to this account in JSON, uses hexadecimal.

    -

    OwnerCount

    OwnerCount: number
    +

    OwnerCount

    OwnerCount: number

    The number of objects this account owns in the ledger, which contributes to its owner reserve.

    -

    PreviousTxnID

    PreviousTxnID: string
    +

    PreviousTxnID

    PreviousTxnID: string

    The identifying hash of the transaction that most recently modified this object.

    -

    PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    +

    PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number

    The index of the ledger that contains the transaction that most recently modified this object.

    -

    Optional RegularKey

    RegularKey?: string
    +

    Optional RegularKey

    RegularKey?: string

    The address of a key pair that can be used to sign transactions for this account instead of the master key. Use a SetRegularKey transaction to change this value.

    -

    Sequence

    Sequence: number
    +

    Sequence

    Sequence: number

    The sequence number of the next valid transaction for this account.

    -

    Optional TickSize

    TickSize?: number
    +

    Optional TickSize

    TickSize?: number

    How many significant digits to use for exchange rates of Offers involving currencies issued by this address. Valid values are 3 to 15, inclusive.

    -

    Optional TicketCount

    TicketCount?: number
    +

    Optional TicketCount

    TicketCount?: number

    How many Tickets this account owns in the ledger. This is updated automatically to ensure that the account stays within the hard limit of 250. Tickets at a time.

    -

    Optional TransferRate

    TransferRate?: number
    +

    Optional TransferRate

    TransferRate?: number

    A transfer fee to charge other users for sending currency issued by this account to each other.

    -

    index

    index: string

    Generated using TypeDoc

    \ No newline at end of file +

    index

    index: string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/LedgerEntry.AccountRootFlagsInterface.html b/docs/interfaces/LedgerEntry.AccountRootFlagsInterface.html index e9c768ad..9624f80a 100644 --- a/docs/interfaces/LedgerEntry.AccountRootFlagsInterface.html +++ b/docs/interfaces/LedgerEntry.AccountRootFlagsInterface.html @@ -1,23 +1,23 @@ AccountRootFlagsInterface | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface AccountRootFlagsInterface

    A boolean map of AccountRootFlags for simplified code checking AccountRoot settings. For submitting settings flags to the ledger, use AccountRootFlags instead.

    -

    Hierarchy

    • AccountRootFlagsInterface

    Index

    Properties

    Properties

    Optional lsfDefaultRipple

    lsfDefaultRipple?: boolean
    +

    Hierarchy

    • AccountRootFlagsInterface

    Index

    Properties

    Properties

    Optional lsfDefaultRipple

    lsfDefaultRipple?: boolean

    Enable rippling on this addresses's trust lines by default. Required for issuing addresses; discouraged for others.

    -

    Optional lsfDepositAuth

    lsfDepositAuth?: boolean
    +

    Optional lsfDepositAuth

    lsfDepositAuth?: boolean

    This account can only receive funds from transactions it sends, and from preauthorized accounts. (It has DepositAuth enabled.)

    -

    Optional lsfDisableMaster

    lsfDisableMaster?: boolean
    +

    Optional lsfDisableMaster

    lsfDisableMaster?: boolean

    Disallows use of the master key to sign transactions for this account.

    -

    Optional lsfDisallowXRP

    lsfDisallowXRP?: boolean
    +

    Optional lsfDisallowXRP

    lsfDisallowXRP?: boolean

    Client applications should not send XRP to this account. Not enforced by rippled.

    -

    Optional lsfGlobalFreeze

    lsfGlobalFreeze?: boolean
    +

    Optional lsfGlobalFreeze

    lsfGlobalFreeze?: boolean

    All assets issued by this address are frozen.

    -

    Optional lsfNoFreeze

    lsfNoFreeze?: boolean
    +

    Optional lsfNoFreeze

    lsfNoFreeze?: boolean

    This address cannot freeze trust lines connected to it. Once enabled, cannot be disabled.

    -

    Optional lsfPasswordSpent

    lsfPasswordSpent?: boolean
    +

    Optional lsfPasswordSpent

    lsfPasswordSpent?: boolean

    The account has used its free SetRegularKey transaction.

    -

    Optional lsfRequireAuth

    lsfRequireAuth?: boolean
    +

    Optional lsfRequireAuth

    lsfRequireAuth?: boolean

    This account must individually approve other users for those users to hold this account's issued currencies.

    -

    Optional lsfRequireDestTag

    lsfRequireDestTag?: boolean
    +

    Optional lsfRequireDestTag

    lsfRequireDestTag?: boolean

    Requires incoming payments to specify a Destination Tag.

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/LedgerEntry.Amendments.html b/docs/interfaces/LedgerEntry.Amendments.html index f63b4149..5c5ab0f1 100644 --- a/docs/interfaces/LedgerEntry.Amendments.html +++ b/docs/interfaces/LedgerEntry.Amendments.html @@ -1,14 +1,14 @@ Amendments | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface Amendments

    The Amendments object type contains a list of Amendments that are currently active.

    -

    Hierarchy

    • BaseLedgerEntry
      • Amendments

    Index

    Properties

    Properties

    Optional Amendments

    Amendments?: string[]
    +

    Hierarchy

    • BaseLedgerEntry
      • Amendments

    Index

    Properties

    Properties

    Optional Amendments

    Amendments?: string[]

    Array of 256-bit amendment IDs for all currently-enabled amendments. If omitted, there are no enabled amendments.

    -

    Flags

    Flags: 0
    +

    Flags

    Flags: 0

    A bit-map of boolean flags. No flags are defined for the Amendments object type, so this value is always 0.

    -

    LedgerEntryType

    LedgerEntryType: "Amendments"

    Optional Majorities

    Majorities?: Majority[]
    +

    LedgerEntryType

    LedgerEntryType: "Amendments"

    Optional Majorities

    Majorities?: Majority[]

    Array of objects describing the status of amendments that have majority support but are not yet enabled. If omitted, there are no pending amendments with majority support.

    -

    index

    index: string

    Generated using TypeDoc

    \ No newline at end of file +

    index

    index: string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/LedgerEntry.Check.html b/docs/interfaces/LedgerEntry.Check.html index 3a938324..577f7bbe 100644 --- a/docs/interfaces/LedgerEntry.Check.html +++ b/docs/interfaces/LedgerEntry.Check.html @@ -1,41 +1,41 @@ Check | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface Check

    A Check object describes a check, similar to a paper personal check, which can be cashed by its destination to get money from its sender.

    -

    Hierarchy

    • BaseLedgerEntry
      • Check

    Index

    Properties

    Properties

    Account

    Account: string
    +

    Hierarchy

    • BaseLedgerEntry
      • Check

    Index

    Properties

    Properties

    Account

    Account: string

    The sender of the Check. Cashing the Check debits this address's balance.

    -

    Destination

    Destination: string
    +

    Destination

    Destination: string

    The intended recipient of the Check. Only this address can cash the Check, using a CheckCash transaction.

    -

    Optional DestinationNode

    DestinationNode?: string
    +

    Optional DestinationNode

    DestinationNode?: string

    A hint indicating which page of the destination's owner directory links to this object, in case the directory consists of multiple pages.

    -

    Optional DestinationTag

    DestinationTag?: number
    +

    Optional DestinationTag

    DestinationTag?: number

    An arbitrary tag to further specify the destination for this Check, such as a hosted recipient at the destination address.

    -

    Optional Expiration

    Expiration?: number
    +

    Optional Expiration

    Expiration?: number

    Indicates the time after which this Check is considered expired.

    -

    Flags

    Flags: 0
    +

    Flags

    Flags: 0

    A bit-map of boolean flags. No flags are defined for Checks, so this value is always 0.

    -

    Optional InvoiceID

    InvoiceID?: string
    +

    Optional InvoiceID

    InvoiceID?: string

    Arbitrary 256-bit hash provided by the sender as a specific reason or identifier for this Check.

    -

    LedgerEntryType

    LedgerEntryType: "Check"

    OwnerNode

    OwnerNode: string
    +

    LedgerEntryType

    LedgerEntryType: "Check"

    OwnerNode

    OwnerNode: string

    A hint indicating which page of the sender's owner directory links to this object, in case the directory consists of multiple pages.

    -

    PreviousTxnID

    PreviousTxnID: string
    +

    PreviousTxnID

    PreviousTxnID: string

    The identifying hash of the transaction that most recently modified this object.

    -

    PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    +

    PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number

    The index of the ledger that contains the transaction that most recently modified this object.

    -

    SendMax

    SendMax: Amount
    +

    SendMax

    SendMax: Amount

    The maximum amount of currency this Check can debit the sender. If the Check is successfully cashed, the destination is credited in the same currency for up to this amount.

    -

    Sequence

    Sequence: number
    +

    Sequence

    Sequence: number

    The sequence number of the CheckCreate transaction that created this check.

    -

    Optional SourceTag

    SourceTag?: number
    +

    Optional SourceTag

    SourceTag?: number

    An arbitrary tag to further specify the source for this Check, such as a hosted recipient at the sender's address.

    -

    index

    index: string

    Generated using TypeDoc

    \ No newline at end of file +

    index

    index: string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/LedgerEntry.DepositPreauth.html b/docs/interfaces/LedgerEntry.DepositPreauth.html index c165a325..7ad7b806 100644 --- a/docs/interfaces/LedgerEntry.DepositPreauth.html +++ b/docs/interfaces/LedgerEntry.DepositPreauth.html @@ -1,20 +1,20 @@ DepositPreauth | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface DepositPreauth

    A DepositPreauth object tracks a preauthorization from one account to another. DepositPreauth transactions create these objects.

    -

    Hierarchy

    • BaseLedgerEntry
      • DepositPreauth

    Index

    Properties

    Properties

    Account

    Account: string
    +

    Hierarchy

    • BaseLedgerEntry
      • DepositPreauth

    Index

    Properties

    Properties

    Account

    Account: string

    The account that granted the preauthorization.

    -

    Authorize

    Authorize: string
    +

    Authorize

    Authorize: string

    The account that received the preauthorization.

    -

    Flags

    Flags: 0
    +

    Flags

    Flags: 0

    A bit-map of boolean flags. No flags are defined for DepositPreauth objects, so this value is always 0.

    -

    LedgerEntryType

    LedgerEntryType: "DepositPreauth"

    OwnerNode

    OwnerNode: string
    +

    LedgerEntryType

    LedgerEntryType: "DepositPreauth"

    OwnerNode

    OwnerNode: string

    A hint indicating which page of the sender's owner directory links to this object, in case the directory consists of multiple pages.

    -

    PreviousTxnID

    PreviousTxnID: string
    +

    PreviousTxnID

    PreviousTxnID: string

    The identifying hash of the transaction that most recently modified this object.

    -

    PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    +

    PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number

    The index of the ledger that contains the transaction that most recently modified this object.

    -

    index

    index: string

    Generated using TypeDoc

    \ No newline at end of file +

    index

    index: string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/LedgerEntry.DirectoryNode.html b/docs/interfaces/LedgerEntry.DirectoryNode.html index bbb00b47..36815b2e 100644 --- a/docs/interfaces/LedgerEntry.DirectoryNode.html +++ b/docs/interfaces/LedgerEntry.DirectoryNode.html @@ -1,29 +1,29 @@ DirectoryNode | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface DirectoryNode

    The DirectoryNode object type provides a list of links to other objects in the ledger's state tree.

    -

    Hierarchy

    • BaseLedgerEntry
      • DirectoryNode

    Index

    Properties

    Properties

    Flags

    Flags: number
    +

    Hierarchy

    • BaseLedgerEntry
      • DirectoryNode

    Index

    Properties

    Properties

    Flags

    Flags: number

    A bit-map of boolean flags enabled for this directory. Currently, the protocol defines no flags for DirectoryNode objects.

    -

    Optional IndexNext

    IndexNext?: number
    +

    Optional IndexNext

    IndexNext?: number

    If this Directory consists of multiple pages, this ID links to the next object in the chain, wrapping around at the end.

    -

    Optional IndexPrevious

    IndexPrevious?: number
    +

    Optional IndexPrevious

    IndexPrevious?: number

    If this Directory consists of multiple pages, this ID links to the previous object in the chain, wrapping around at the beginning.

    -

    Indexes

    Indexes: string[]
    +

    Indexes

    Indexes: string[]

    The contents of this Directory: an array of IDs of other objects.

    -

    LedgerEntryType

    LedgerEntryType: "DirectoryNode"

    Optional Owner

    Owner?: string
    +

    LedgerEntryType

    LedgerEntryType: "DirectoryNode"

    Optional Owner

    Owner?: string

    The address of the account that owns the objects in this directory.

    -

    RootIndex

    RootIndex: string
    +

    RootIndex

    RootIndex: string

    The ID of root object for this directory.

    -

    Optional TakerGetsCurrency

    TakerGetsCurrency?: string
    +

    Optional TakerGetsCurrency

    TakerGetsCurrency?: string

    The currency code of the TakerGets amount from the offers in this directory.

    -

    Optional TakerGetsIssuer

    TakerGetsIssuer?: string
    +

    Optional TakerGetsIssuer

    TakerGetsIssuer?: string

    The issuer of the TakerGets amount from the offers in this directory.

    -

    Optional TakerPaysCurrency

    TakerPaysCurrency?: string
    +

    Optional TakerPaysCurrency

    TakerPaysCurrency?: string

    The currency code of the TakerPays amount from the offers in this directory.

    -

    Optional TakerPaysIssuer

    TakerPaysIssuer?: string
    +

    Optional TakerPaysIssuer

    TakerPaysIssuer?: string

    The issuer of the TakerPays amount from the offers in this directory.

    -

    index

    index: string

    Generated using TypeDoc

    \ No newline at end of file +

    index

    index: string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/LedgerEntry.Escrow.html b/docs/interfaces/LedgerEntry.Escrow.html index 4878dc55..0eb85abb 100644 --- a/docs/interfaces/LedgerEntry.Escrow.html +++ b/docs/interfaces/LedgerEntry.Escrow.html @@ -1,43 +1,43 @@ Escrow | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface Escrow

    The Escrow object type represents a held payment of XRP waiting to be executed or canceled.

    -

    Hierarchy

    • BaseLedgerEntry
      • Escrow

    Index

    Properties

    Properties

    Account

    Account: string
    +

    Hierarchy

    • BaseLedgerEntry
      • Escrow

    Index

    Properties

    Properties

    Account

    Account: string

    The address of the owner (sender) of this held payment. This is the account that provided the XRP, and gets it back if the held payment is canceled.

    -

    Amount

    Amount: string
    +

    Amount

    Amount: string

    The amount of XRP, in drops, to be delivered by the held payment.

    -

    Optional CancelAfter

    CancelAfter?: number
    +

    Optional CancelAfter

    CancelAfter?: number

    The time after which this Escrow is considered expired.

    -

    Optional Condition

    Condition?: string
    +

    Optional Condition

    Condition?: string

    A PREIMAGE-SHA-256 crypto-condition, as hexadecimal. If present, the EscrowFinish transaction must contain a fulfillment that satisfies this condition.

    -

    Destination

    Destination: string
    +

    Destination

    Destination: string

    The destination address where the XRP is paid if the held payment is successful.

    -

    Optional DestinationNode

    DestinationNode?: string
    +

    Optional DestinationNode

    DestinationNode?: string

    A hint indicating which page of the destination's owner directory links to this object, in case the directory consists of multiple pages.

    -

    Optional DestinationTag

    DestinationTag?: number
    +

    Optional DestinationTag

    DestinationTag?: number

    An arbitrary tag to further specify the destination for this held payment, such as a hosted recipient at the destination address.

    -

    Optional FinishAfter

    FinishAfter?: number
    +

    Optional FinishAfter

    FinishAfter?: number

    The time, in seconds, since the Ripple Epoch, after which this held payment can be finished. Any EscrowFinish transaction before this time fails.

    -

    Flags

    Flags: number
    +

    Flags

    Flags: number

    A bit-map of boolean flags. No flags are defined for the Escrow type, so this value is always 0.

    -

    LedgerEntryType

    LedgerEntryType: "Escrow"

    OwnerNode

    OwnerNode: string
    +

    LedgerEntryType

    LedgerEntryType: "Escrow"

    OwnerNode

    OwnerNode: string

    A hint indicating which page of the owner directory links to this object, in case the directory consists of multiple pages.

    -

    PreviousTxnID

    PreviousTxnID: string
    +

    PreviousTxnID

    PreviousTxnID: string

    The identifying hash of the transaction that most recently modified this object.

    -

    PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    +

    PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number

    The index of the ledger that contains the transaction that most recently modified this object.

    -

    Optional SourceTag

    SourceTag?: number
    +

    Optional SourceTag

    SourceTag?: number

    An arbitrary tag to further specify the source for this held payment, such as a hosted recipient at the owner's address.

    -

    index

    index: string

    Generated using TypeDoc

    \ No newline at end of file +

    index

    index: string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/LedgerEntry.FeeSettings.html b/docs/interfaces/LedgerEntry.FeeSettings.html index 2484c592..ca9f5b79 100644 --- a/docs/interfaces/LedgerEntry.FeeSettings.html +++ b/docs/interfaces/LedgerEntry.FeeSettings.html @@ -1,16 +1,16 @@ FeeSettings | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface FeeSettings

    The FeeSettings object type contains the current base transaction cost and reserve amounts as determined by fee voting.

    -

    Hierarchy

    • BaseLedgerEntry
      • FeeSettings

    Index

    Properties

    Properties

    BaseFee

    BaseFee: string
    +

    Hierarchy

    • BaseLedgerEntry
      • FeeSettings

    Index

    Properties

    Properties

    BaseFee

    BaseFee: string

    The transaction cost of the "reference transaction" in drops of XRP as hexadecimal.

    -

    Flags

    Flags: number
    +

    Flags

    Flags: number

    A bit-map of boolean flags for this object. No flags are defined for this type.

    -

    LedgerEntryType

    LedgerEntryType: "FeeSettings"

    ReferenceFeeUnits

    ReferenceFeeUnits: number
    +

    LedgerEntryType

    LedgerEntryType: "FeeSettings"

    ReferenceFeeUnits

    ReferenceFeeUnits: number

    The BaseFee translated into "fee units".

    -

    ReserveBase

    ReserveBase: number
    +

    ReserveBase

    ReserveBase: number

    The base reserve for an account in the XRP Ledger, as drops of XRP.

    -

    ReserveIncrement

    ReserveIncrement: number
    +

    ReserveIncrement

    ReserveIncrement: number

    The incremental owner reserve for owning objects, as drops of XRP.

    -

    index

    index: string

    Generated using TypeDoc

    \ No newline at end of file +

    index

    index: string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/LedgerEntry.Ledger.html b/docs/interfaces/LedgerEntry.Ledger.html index 750e098c..c5d2e06e 100644 --- a/docs/interfaces/LedgerEntry.Ledger.html +++ b/docs/interfaces/LedgerEntry.Ledger.html @@ -1,40 +1,40 @@ Ledger | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface Ledger

    A ledger is a block of transactions and shared state data. It has a unique header that describes its contents using cryptographic hashes.

    -

    Hierarchy

    • Ledger

    Index

    Properties

    Properties

    Optional accountState

    accountState?: LedgerEntry[]
    +

    Hierarchy

    • Ledger

    Index

    Properties

    Properties

    Optional accountState

    accountState?: LedgerEntry[]

    All the state information in this ledger.

    -

    account_hash

    account_hash: string
    +

    account_hash

    account_hash: string

    The SHA-512Half of this ledger's state tree information.

    -

    close_flags

    close_flags: number
    +

    close_flags

    close_flags: number

    A bit-map of flags relating to the closing of this ledger.

    -

    close_time

    close_time: number
    +

    close_time

    close_time: number

    The approximate time this ledger version closed, as the number of seconds since the Ripple Epoch of 2000-01-01 00:00:00. This value is rounded based on the close_time_resolution.

    -

    close_time_human

    close_time_human: string
    +

    close_time_human

    close_time_human: string

    The approximate time this ledger was closed, in human-readable format. Always uses the UTC time zone.

    -

    close_time_resolution

    close_time_resolution: number
    +

    close_time_resolution

    close_time_resolution: number

    An integer in the range [2,120] indicating the maximum number of seconds by which the close_time could be rounded.

    -

    closed

    closed: boolean
    +

    closed

    closed: boolean

    Whether or not this ledger has been closed.

    -

    ledger_hash

    ledger_hash: string
    +

    ledger_hash

    ledger_hash: string

    The SHA-512Half of this ledger version. This serves as a unique identifier for this ledger and all its contents.

    -

    ledger_index

    ledger_index: string
    +

    ledger_index

    ledger_index: string

    The ledger index of the ledger. Some API methods display this as a quoted integer; some display it as a native JSON number.

    -

    parent_close_time

    parent_close_time: number
    +

    parent_close_time

    parent_close_time: number

    The approximate time at which the previous ledger was closed.

    -

    parent_hash

    parent_hash: string
    +

    parent_hash

    parent_hash: string

    Unique identifying hash of the ledger that came immediately before this one.

    -

    total_coins

    total_coins: string
    +

    total_coins

    total_coins: string

    Total number of XRP drops in the network, as a quoted integer.

    -

    transaction_hash

    transaction_hash: string
    +

    transaction_hash

    transaction_hash: string

    Hash of the transaction information included in this ledger, as hex.

    -

    Optional transactions

    transactions?: ((AccountDelete & { metaData?: TransactionMetadata }) & (AccountSet & { metaData?: TransactionMetadata }) & (CheckCancel & { metaData?: TransactionMetadata }) & (CheckCash & { metaData?: TransactionMetadata }) & (CheckCreate & { metaData?: TransactionMetadata }) & (DepositPreauth & { metaData?: TransactionMetadata }) & (EscrowCancel & { metaData?: TransactionMetadata }) & (EscrowCreate & { metaData?: TransactionMetadata }) & (EscrowFinish & { metaData?: TransactionMetadata }) & (NFTokenAcceptOffer & { metaData?: TransactionMetadata }) & (NFTokenBurn & { metaData?: TransactionMetadata }) & (NFTokenCancelOffer & { metaData?: TransactionMetadata }) & (NFTokenCreateOffer & { metaData?: TransactionMetadata }) & (NFTokenMint & { metaData?: TransactionMetadata }) & (OfferCancel & { metaData?: TransactionMetadata }) & (OfferCreate & { metaData?: TransactionMetadata }) & (Payment & { metaData?: TransactionMetadata }) & (PaymentChannelClaim & { metaData?: TransactionMetadata }) & (PaymentChannelCreate & { metaData?: TransactionMetadata }) & (PaymentChannelFund & { metaData?: TransactionMetadata }) & (SetRegularKey & { metaData?: TransactionMetadata }) & (SignerListSet & { metaData?: TransactionMetadata }) & (TicketCreate & { metaData?: TransactionMetadata }) & (TrustSet & { metaData?: TransactionMetadata }))[]
    +

    Optional transactions

    transactions?: ((AccountDelete & { metaData?: TransactionMetadata }) & (AccountSet & { metaData?: TransactionMetadata }) & (CheckCancel & { metaData?: TransactionMetadata }) & (CheckCash & { metaData?: TransactionMetadata }) & (CheckCreate & { metaData?: TransactionMetadata }) & (DepositPreauth & { metaData?: TransactionMetadata }) & (EscrowCancel & { metaData?: TransactionMetadata }) & (EscrowCreate & { metaData?: TransactionMetadata }) & (EscrowFinish & { metaData?: TransactionMetadata }) & (NFTokenAcceptOffer & { metaData?: TransactionMetadata }) & (NFTokenBurn & { metaData?: TransactionMetadata }) & (NFTokenCancelOffer & { metaData?: TransactionMetadata }) & (NFTokenCreateOffer & { metaData?: TransactionMetadata }) & (NFTokenMint & { metaData?: TransactionMetadata }) & (OfferCancel & { metaData?: TransactionMetadata }) & (OfferCreate & { metaData?: TransactionMetadata }) & (Payment & { metaData?: TransactionMetadata }) & (PaymentChannelClaim & { metaData?: TransactionMetadata }) & (PaymentChannelCreate & { metaData?: TransactionMetadata }) & (PaymentChannelFund & { metaData?: TransactionMetadata }) & (SetRegularKey & { metaData?: TransactionMetadata }) & (SignerListSet & { metaData?: TransactionMetadata }) & (TicketCreate & { metaData?: TransactionMetadata }) & (TrustSet & { metaData?: TransactionMetadata }))[]

    Transactions applied in this ledger version. By default, members are the transactions' identifying Hash strings. If the request specified expand as true, members are full representations of the transactions instead, in diff --git a/docs/interfaces/LedgerEntry.LedgerHashes.html b/docs/interfaces/LedgerEntry.LedgerHashes.html index 44e2d979..7e26c1b1 100644 --- a/docs/interfaces/LedgerEntry.LedgerHashes.html +++ b/docs/interfaces/LedgerEntry.LedgerHashes.html @@ -2,12 +2,12 @@

    The LedgerHashes objects exist to make it possible to look up a previous ledger's hash with only the current ledger version and at most one lookup of a previous ledger version.

    -

    Hierarchy

    • BaseLedgerEntry
      • LedgerHashes

    Index

    Properties

    Properties

    Flags

    Flags: number
    +

    Hierarchy

    • BaseLedgerEntry
      • LedgerHashes

    Index

    Properties

    Properties

    Flags

    Flags: number

    A bit-map of boolean flags for this object. No flags are defined for this type.

    -

    Hashes

    Hashes: string[]
    +

    Hashes

    Hashes: string[]

    An array of up to 256 ledger hashes. The contents depend on which sub-type of LedgerHashes object this is.

    -

    Optional LastLedgerSequence

    LastLedgerSequence?: number
    +

    Optional LastLedgerSequence

    LastLedgerSequence?: number

    The Ledger Index of the last entry in this object's Hashes array.

    -

    LedgerEntryType

    LedgerEntryType: "LedgerHashes"

    index

    index: string

    Generated using TypeDoc

    \ No newline at end of file +

    LedgerEntryType

    LedgerEntryType: "LedgerHashes"

    index

    index: string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/LedgerEntry.NegativeUNL.html b/docs/interfaces/LedgerEntry.NegativeUNL.html index 6888929a..0be2b169 100644 --- a/docs/interfaces/LedgerEntry.NegativeUNL.html +++ b/docs/interfaces/LedgerEntry.NegativeUNL.html @@ -1,12 +1,12 @@ NegativeUNL | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface NegativeUNL

    The NegativeUNL object type contains the current status of the Negative UNL, a list of trusted validators currently believed to be offline.

    -

    Hierarchy

    • BaseLedgerEntry
      • NegativeUNL

    Index

    Properties

    Properties

    Optional DisabledValidators

    DisabledValidators?: DisabledValidator[]
    +

    Hierarchy

    • BaseLedgerEntry
      • NegativeUNL

    Index

    Properties

    Properties

    Optional DisabledValidators

    DisabledValidators?: DisabledValidator[]

    A list of trusted validators that are currently disabled.

    -

    LedgerEntryType

    LedgerEntryType: "NegativeUNL"

    Optional ValidatorToDisable

    ValidatorToDisable?: string
    +

    LedgerEntryType

    LedgerEntryType: "NegativeUNL"

    Optional ValidatorToDisable

    ValidatorToDisable?: string

    The public key of a trusted validator that is scheduled to be disabled in the next flag ledger.

    -

    Optional ValidatorToReEnable

    ValidatorToReEnable?: string
    +

    Optional ValidatorToReEnable

    ValidatorToReEnable?: string

    The public key of a trusted validator in the Negative UNL that is scheduled to be re-enabled in the next flag ledger.

    -

    index

    index: string

    Generated using TypeDoc

    \ No newline at end of file +

    index

    index: string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/LedgerEntry.Offer.html b/docs/interfaces/LedgerEntry.Offer.html index 4d08930a..32086b18 100644 --- a/docs/interfaces/LedgerEntry.Offer.html +++ b/docs/interfaces/LedgerEntry.Offer.html @@ -1,29 +1,29 @@ -Offer | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface Offer

    Hierarchy

    Index

    Properties

    Properties

    Account

    Account: string
    +Offer | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface Offer

    Hierarchy

    Index

    Properties

    Properties

    Account

    Account: string

    The address of the account that placed this Offer.

    -

    BookDirectory

    BookDirectory: string
    +

    BookDirectory

    BookDirectory: string

    The ID of the Offer Directory that links to this Offer.

    -

    BookNode

    BookNode: string
    +

    BookNode

    BookNode: string

    A hint indicating which page of the Offer Directory links to this object, in case the directory consists of multiple pages.

    -

    Optional Expiration

    Expiration?: number
    +

    Optional Expiration

    Expiration?: number

    The time this Offer expires, in seconds since the Ripple Epoch.

    -

    Flags

    Flags: number
    +

    Flags

    Flags: number

    A bit-map of boolean flags enabled for this Offer.

    -

    LedgerEntryType

    LedgerEntryType: "Offer"

    OwnerNode

    OwnerNode: string
    +

    LedgerEntryType

    LedgerEntryType: "Offer"

    OwnerNode

    OwnerNode: string

    A hint indicating which page of the Owner Directory links to this object, in case the directory consists of multiple pages.

    -

    PreviousTxnID

    PreviousTxnID: string
    +

    PreviousTxnID

    PreviousTxnID: string

    The identifying hash of the transaction that most recently modified this object.

    -

    PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    +

    PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number

    The index of the ledger that contains the transaction that most recently modified this object.

    -

    Sequence

    Sequence: number
    +

    Sequence

    Sequence: number

    The Sequence value of the OfferCreate transaction that created this Offer object. Used in combination with the Account to identify this Offer.

    -

    TakerGets

    TakerGets: Amount
    +

    TakerGets

    TakerGets: Amount

    The remaining amount and type of currency being provided by the Offer creator.

    -

    TakerPays

    TakerPays: Amount
    +

    TakerPays

    TakerPays: Amount

    The remaining amount and type of currency requested by the Offer creator.

    -

    index

    index: string

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    index

    index: string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/LedgerEntry.PayChannel.html b/docs/interfaces/LedgerEntry.PayChannel.html index 9a6f9676..ce29d274 100644 --- a/docs/interfaces/LedgerEntry.PayChannel.html +++ b/docs/interfaces/LedgerEntry.PayChannel.html @@ -4,67 +4,67 @@ enable small, rapid off-ledger payments of XRP that can be later reconciled with the consensus ledger. A payment channel holds a balance of XRP that can only be paid out to a specific destination address until the channel is closed.

    -

    Hierarchy

    Index

    Properties

    Properties

    Account

    Account: string
    +

    Hierarchy

    • BaseLedgerEntry
      • PayChannel

    Index

    Properties

    Properties

    Account

    Account: string

    The source address that owns this payment channel. This comes from the sending address of the transaction that created the channel.

    -

    Amount

    Amount: string
    +

    Amount

    Amount: string

    Total XRP, in drops, that has been allocated to this channel. This includes XRP that has been paid to the destination address. This is initially set by the transaction that created the channel and can be increased if the source address sends a PaymentChannelFund transaction.

    -

    Balance

    Balance: string
    +

    Balance

    Balance: string

    Total XRP, in drops, already paid out by the channel. The difference between this value and the Amount field is how much XRP can still be paid to the destination address with PaymentChannelClaim transactions. If the channel closes, the remaining difference is returned to the source address.

    -

    Optional CancelAfter

    CancelAfter?: number
    +

    Optional CancelAfter

    CancelAfter?: number

    The immutable expiration time for this payment channel, in seconds since the Ripple Epoch. This channel is expired if this value is present and smaller than the previous ledger's close_time field. This is optionally set by the transaction that created the channel, and cannot be changed.

    -

    Destination

    Destination: string
    +

    Destination

    Destination: string

    The destination address for this payment channel. While the payment channel is open, this address is the only one that can receive XRP from the channel. This comes from the Destination field of the transaction that created the channel.

    -

    Optional DestinationNode

    DestinationNode?: string
    +

    Optional DestinationNode

    DestinationNode?: string

    A hint indicating which page of the destination's owner directory links to this object, in case the directory consists of multiple pages.

    -

    Optional DestinationTag

    DestinationTag?: number
    +

    Optional DestinationTag

    DestinationTag?: number

    An arbitrary tag to further specify the destination for this payment channel, such as a hosted recipient at the destination address.

    -

    Optional Expiration

    Expiration?: number
    +

    Optional Expiration

    Expiration?: number

    The mutable expiration time for this payment channel, in seconds since the Ripple Epoch. The channel is expired if this value is present and smaller than the previous ledger's close_time field. See Setting Channel Expiration for more details.

    -

    Flags

    Flags: number
    +

    Flags

    Flags: number

    A bit-map of boolean flags enabled for this payment channel. Currently, the protocol defines no flags for PayChannel objects.

    -

    LedgerEntryType

    LedgerEntryType: "PayChannel"

    OwnerNode

    OwnerNode: string
    +

    LedgerEntryType

    LedgerEntryType: "PayChannel"

    OwnerNode

    OwnerNode: string

    A hint indicating which page of the source address's owner directory links to this object, in case the directory consists of multiple pages.

    -

    PreviousTxnID

    PreviousTxnID: string
    +

    PreviousTxnID

    PreviousTxnID: string

    The identifying hash of the transaction that most recently modified this object.

    -

    PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    +

    PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number

    The index of the ledger that contains the transaction that most recently modified this object.

    -

    PublicKey

    PublicKey: string
    +

    PublicKey

    PublicKey: string

    Public key, in hexadecimal, of the key pair that can be used to sign claims against this channel. This can be any valid secp256k1 or Ed25519 public key. This is set by the transaction that created the channel and must match the public key used in claims against the channel. The channel source address can also send XRP from this channel to the destination without signed claims.

    -

    SettleDelay

    SettleDelay: number
    +

    SettleDelay

    SettleDelay: number

    Number of seconds the source address must wait to close the channel if it still has any XRP in it. Smaller values mean that the destination address has less time to redeem any outstanding claims after the source address requests to close the channel. Can be any value that fits in a 32-bit unsigned integer (0 to 2^32-1). This is set by the transaction that creates the channel.

    -

    Optional SourceTag

    SourceTag?: number
    +

    Optional SourceTag

    SourceTag?: number

    An arbitrary tag to further specify the source for this payment channel useful for specifying a hosted recipient at the owner's address.

    -

    index

    index: string

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    index

    index: string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/LedgerEntry.RippleState.html b/docs/interfaces/LedgerEntry.RippleState.html index b0a93cf9..d9587b64 100644 --- a/docs/interfaces/LedgerEntry.RippleState.html +++ b/docs/interfaces/LedgerEntry.RippleState.html @@ -1,43 +1,43 @@ RippleState | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface RippleState

    The RippleState object type connects two accounts in a single currency.

    -

    Hierarchy

    • BaseLedgerEntry
      • RippleState

    Index

    Properties

    Properties

    Balance

    Balance: IssuedCurrencyAmount
    +

    Hierarchy

    • BaseLedgerEntry
      • RippleState

    Index

    Properties

    Properties

    Balance

    Balance: IssuedCurrencyAmount

    The balance of the trust line, from the perspective of the low account. A negative balance indicates that the low account has issued currency to the high account. The issuer is always the neutral value ACCOUNT_ONE.

    -

    Flags

    Flags: number
    +

    Flags

    Flags: number

    A bit-map of boolean options enabled for this object.

    -

    HighLimit

    HighLimit: IssuedCurrencyAmount
    +

    HighLimit

    HighLimit: IssuedCurrencyAmount

    The limit that the high account has set on the trust line. The issuer is the address of the high account that set this limit.

    -

    Optional HighNode

    HighNode?: string
    +

    Optional HighNode

    HighNode?: string

    A hint indicating which page of the high account's owner directory links to this object, in case the directory consists of multiple pages.

    -

    Optional HighQualityIn

    HighQualityIn?: number
    +

    Optional HighQualityIn

    HighQualityIn?: number

    The inbound quality set by the high account, as an integer in the implied ratio HighQualityIn:1,000,000,000. As a special case, the value 0 is equivalent to 1 billion, or face value.

    -

    Optional HighQualityOut

    HighQualityOut?: number
    +

    Optional HighQualityOut

    HighQualityOut?: number

    The outbound quality set by the high account, as an integer in the implied ratio HighQualityOut:1,000,000,000. As a special case, the value 0 is equivalent to 1 billion, or face value.

    -

    LedgerEntryType

    LedgerEntryType: "RippleState"

    LowLimit

    LowLimit: IssuedCurrencyAmount
    +

    LedgerEntryType

    LedgerEntryType: "RippleState"

    LowLimit

    LowLimit: IssuedCurrencyAmount

    The limit that the low account has set on the trust line. The issuer is the address of the low account that set this limit.

    -

    Optional LowNode

    LowNode?: string
    +

    Optional LowNode

    LowNode?: string

    A hint indicating which page of the low account's owner directory links to this object, in case the directory consists of multiple pages.

    -

    Optional LowQualityIn

    LowQualityIn?: number
    +

    Optional LowQualityIn

    LowQualityIn?: number

    The inbound quality set by the low account, as an integer in the implied ratio LowQualityIn:1,000,000,000. As a special case, the value 0 is equivalent to 1 billion, or face value.

    -

    Optional LowQualityOut

    LowQualityOut?: number
    +

    Optional LowQualityOut

    LowQualityOut?: number

    The outbound quality set by the low account, as an integer in the implied ratio LowQualityOut:1,000,000,000. As a special case, the value 0 is equivalent to 1 billion, or face value.

    -

    PreviousTxnID

    PreviousTxnID: string
    +

    PreviousTxnID

    PreviousTxnID: string

    The identifying hash of the transaction that most recently modified this object.

    -

    PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    +

    PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number

    The index of the ledger that contains the transaction that most recently modified this object.

    -

    index

    index: string

    Generated using TypeDoc

    \ No newline at end of file +

    index

    index: string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/LedgerEntry.SignerList.html b/docs/interfaces/LedgerEntry.SignerList.html index b51312c7..334e78dc 100644 --- a/docs/interfaces/LedgerEntry.SignerList.html +++ b/docs/interfaces/LedgerEntry.SignerList.html @@ -3,26 +3,26 @@ are authorized to sign a transaction in place of an individual account. You can create, replace, or remove a signer list using a SignerListSet transaction.

    -

    Hierarchy

    Index

    Properties

    Properties

    Flags

    Flags: number
    +

    Hierarchy

    • BaseLedgerEntry
      • SignerList

    Index

    Properties

    Properties

    Flags

    Flags: number

    A bit-map of Boolean flags enabled for this signer list. For more information, see SignerList Flags.

    -

    LedgerEntryType

    LedgerEntryType: "SignerList"

    OwnerNode

    OwnerNode: string
    +

    LedgerEntryType

    LedgerEntryType: "SignerList"

    OwnerNode

    OwnerNode: string

    A hint indicating which page of the owner directory links to this object, in case the directory consists of multiple pages.

    -

    PreviousTxnID

    PreviousTxnID: string
    +

    PreviousTxnID

    PreviousTxnID: string

    The identifying hash of the transaction that most recently modified this object.

    -

    PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    +

    PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number

    The index of the ledger that contains the transaction that most recently modified this object.

    -

    SignerEntries

    SignerEntries: SignerEntry[]
    +

    SignerEntries

    SignerEntries: SignerEntry[]

    An array of Signer Entry objects representing the parties who are part of this signer list.

    -

    SignerListID

    SignerListID: number
    +

    SignerListID

    SignerListID: number

    An ID for this signer list. Currently always set to 0. If a future amendment allows multiple signer lists for an account, this may change.

    -

    SignerQuorum

    SignerQuorum: number
    +

    SignerQuorum

    SignerQuorum: number

    A target number for signer weights. To produce a valid signature for the owner of this SignerList, the signers must provide valid signatures whose weights sum to this value or more.

    -

    index

    index: string

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    index

    index: string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/LedgerEntry.Ticket.html b/docs/interfaces/LedgerEntry.Ticket.html index 4da21fde..9ae08bd7 100644 --- a/docs/interfaces/LedgerEntry.Ticket.html +++ b/docs/interfaces/LedgerEntry.Ticket.html @@ -2,20 +2,20 @@

    The Ticket object type represents a Ticket, which tracks an account sequence number that has been set aside for future use. You can create new tickets with a TicketCreate transaction.

    -

    Hierarchy

    Index

    Properties

    Properties

    Account

    Account: string
    +

    Hierarchy

    • BaseLedgerEntry
      • Ticket

    Index

    Properties

    Properties

    Account

    Account: string

    The account that owns this Ticket.

    -

    Flags

    Flags: number
    +

    Flags

    Flags: number

    A bit-map of Boolean flags enabled for this Ticket. Currently, there are no flags defined for Tickets.

    -

    LedgerEntryType

    LedgerEntryType: "Ticket"

    OwnerNode

    OwnerNode: string
    +

    LedgerEntryType

    LedgerEntryType: "Ticket"

    OwnerNode

    OwnerNode: string

    A hint indicating which page of the owner directory links to this object, in case the directory consists of multiple pages.

    -

    PreviousTxnID

    PreviousTxnID: string
    +

    PreviousTxnID

    PreviousTxnID: string

    The identifying hash of the transaction that most recently modified this object.

    -

    PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    +

    PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number

    The index of the ledger that contains the transaction that most recently modified this object.

    -

    TicketSequence

    TicketSequence: number
    +

    TicketSequence

    TicketSequence: number

    The Sequence Number this Ticket sets aside.

    -

    index

    index: string

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    index

    index: string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/LedgerEntryRequest.html b/docs/interfaces/LedgerEntryRequest.html index 0c969f54..d828bd18 100644 --- a/docs/interfaces/LedgerEntryRequest.html +++ b/docs/interfaces/LedgerEntryRequest.html @@ -3,43 +3,43 @@ in its raw format. Expects a response in the form of a LedgerEntryResponse.

    example
    const ledgerEntry: LedgerEntryRequest = {
      command: "ledger_entry",
      ledger_index: 60102302,
      index: "7DB0788C020F02780A673DC74757F23823FA3014C1866E72CC4CD8B226CD6EF4"
    }
    -

    Hierarchy

    Index

    Properties

    Properties

    Optional account_root

    account_root?: string
    +

    Hierarchy

    • BaseRequest
      • LedgerEntryRequest

    Index

    Properties

    Properties

    Optional account_root

    account_root?: string

    Retrieve an AccountRoot object by its address. This is roughly equivalent to the an AccountInfoRequest.

    -

    Optional api_version

    api_version?: number
    +

    Optional api_version

    api_version?: number

    The API version to use. If omitted, use version 1.

    -

    Optional binary

    binary?: boolean
    +

    Optional binary

    binary?: boolean

    If true, return the requested ledger object's contents as a hex string in the XRP Ledger's binary format. Otherwise, return data in JSON format. The default is false.

    -

    Optional check

    check?: string
    +

    Optional check

    check?: string

    The object ID of a Check object to retrieve.

    -

    command

    command: "ledger_entry"

    Optional deposit_preauth

    deposit_preauth?: string | { authorized: string; owner: string }
    +

    command

    command: "ledger_entry"

    Optional deposit_preauth

    deposit_preauth?: string | { authorized: string; owner: string }

    Specify a DepositPreauth object to retrieve. If a string, must be the object ID of the DepositPreauth object, as hexadecimal. If an object, requires owner and authorized sub-fields.

    -

    Optional directory

    directory?: string | { dir_root?: string; owner?: string; sub_index?: number }
    +

    Optional directory

    directory?: string | { dir_root?: string; owner?: string; sub_index?: number }

    The DirectoryNode to retrieve. If a string, must be the object ID of the directory, as hexadecimal. If an object, requires either dir_root o Owner as a sub-field, plus optionally a sub_index sub-field.

    -

    Optional escrow

    escrow?: string | { owner: string; seq: number }
    +

    Optional escrow

    escrow?: string | { owner: string; seq: number }

    The Escrow object to retrieve. If a string, must be the object ID of the escrow, as hexadecimal. If an object, requires owner and seq sub-fields.

    -

    Optional id

    id?: string | number
    +

    Optional id

    id?: string | number

    A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

    -

    Optional index

    index?: string

    Optional ledger_hash

    ledger_hash?: string
    +

    Optional index

    index?: string

    Optional ledger_hash

    ledger_hash?: string

    A 20-byte hex string for the ledger version to use.

    -

    Optional ledger_index

    ledger_index?: LedgerIndex
    +

    Optional ledger_index

    ledger_index?: LedgerIndex

    The ledger index of the ledger to use, or a shortcut string.

    -

    Optional offer

    offer?: string | { account: string; seq: number }
    +

    Optional offer

    offer?: string | { account: string; seq: number }

    The Offer object to retrieve. If a string, interpret as the unique object ID to the Offer. If an object, requires the sub-fields account and seq to uniquely identify the offer.

    -

    Optional payment_channel

    payment_channel?: string
    +

    Optional payment_channel

    payment_channel?: string

    The object ID of a PayChannel object to retrieve.

    -

    Optional ripple_state

    ripple_state?: { accounts: string[]; currency: string }
    +

    Optional ripple_state

    ripple_state?: { accounts: string[]; currency: string }

    Object specifying the RippleState (trust line) object to retrieve. The accounts and currency sub-fields are required to uniquely specify the rippleState entry to retrieve.

    @@ -48,7 +48,7 @@ rippleState entry to retrieve.

    this RippleState object.

  • currency: string

    Currency Code of the RippleState object to retrieve.

    -

    • Optional ticket

    ticket?: string | { owner: string; ticket_sequence: number }
    +

    Optional ticket

    ticket?: string | { owner: string; ticket_sequence: number }

    The Ticket object to retrieve. If a string, must be the object ID of the Ticket, as hexadecimal. If an object, the owner and ticket_sequence sub-fields are required to uniquely specify the Ticket entry.

    diff --git a/docs/interfaces/LedgerEntryResponse.html b/docs/interfaces/LedgerEntryResponse.html index 185b3de7..5c18dea4 100644 --- a/docs/interfaces/LedgerEntryResponse.html +++ b/docs/interfaces/LedgerEntryResponse.html @@ -1,6 +1,6 @@ LedgerEntryResponse | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface LedgerEntryResponse

    Response expected from a LedgerEntryRequest.

    -

    Hierarchy

    • BaseResponse
      • LedgerEntryResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { index: string; ledger_current_index: number; node?: LedgerEntry; node_binary?: string; validated?: boolean }

    Type declaration

    • index: string
      +

    Hierarchy

    • BaseResponse
      • LedgerEntryResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { index: string; ledger_current_index: number; node?: LedgerEntry; node_binary?: string; validated?: boolean }

    Type declaration

    • index: string

      The unique ID of this ledger object.

    • ledger_current_index: number

      The ledger index of the ledger that was used when retrieving this data.

      @@ -9,4 +9,4 @@ ledger format.

    • Optional node_binary?: string

      The binary representation of the ledger object, as hexadecimal.

      -
    • Optional validated?: boolean

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +
  • Optional validated?: boolean

    • Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/LedgerRequest.html b/docs/interfaces/LedgerRequest.html index 5a405489..e8750ef6 100644 --- a/docs/interfaces/LedgerRequest.html +++ b/docs/interfaces/LedgerRequest.html @@ -3,39 +3,39 @@ of a LedgerResponse.

    example
    const ledger: LedgerRequest = {
     "id": 14,
     "command": "ledger",
     "ledger_index": "validated",
     "full": false,
     "accounts": false,
     "transactions": false,
     "expand": false,
     "owner_funds": false
    }
    -

    Hierarchy

    Index

    Properties

    Properties

    Optional accounts

    accounts?: boolean
    +

    Hierarchy

    • BaseRequest
      • LedgerRequest

    Index

    Properties

    Properties

    Optional accounts

    accounts?: boolean

    Admin required. If true, return information on accounts in the ledger. Ignored if you did not specify a ledger version. Defaults to false.

    -

    Optional api_version

    api_version?: number
    +

    Optional api_version

    api_version?: number

    The API version to use. If omitted, use version 1.

    -

    Optional binary

    binary?: boolean
    +

    Optional binary

    binary?: boolean

    If true, and transactions and expand are both also true, return transaction information in binary format (hexadecimal string) instead of JSON format.

    -

    command

    command: "ledger"

    Optional expand

    expand?: boolean
    +

    command

    command: "ledger"

    Optional expand

    expand?: boolean

    Provide full JSON-formatted information for transaction/account information instead of only hashes. Defaults to false. Ignored unless you request transactions, accounts, or both.

    -

    Optional full

    full?: boolean
    +

    Optional full

    full?: boolean

    Admin required If true, return full information on the entire ledger. Ignored if you did not specify a ledger version. Defaults to false.

    -

    Optional id

    id?: string | number
    +

    Optional id

    id?: string | number

    A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

    -

    Optional ledger_hash

    ledger_hash?: string
    +

    Optional ledger_hash

    ledger_hash?: string

    A 20-byte hex string for the ledger version to use.

    -

    Optional ledger_index

    ledger_index?: LedgerIndex
    +

    Optional ledger_index

    ledger_index?: LedgerIndex

    The ledger index of the ledger to use, or a shortcut string to choose a ledger automatically.

    -

    Optional owner_funds

    owner_funds?: boolean
    +

    Optional owner_funds

    owner_funds?: boolean

    If true, include owner_funds field in the metadata of OfferCreate transactions in the response. Defaults to false. Ignored unless transactions are included and expand is true.

    -

    Optional queue

    queue?: boolean
    +

    Optional queue

    queue?: boolean

    If true, and the command is requesting the current ledger, includes an array of queued transactions in the results.

    -

    Optional transactions

    transactions?: boolean
    +

    Optional transactions

    transactions?: boolean

    If true, return information on transactions in the specified ledger version. Defaults to false. Ignored if you did not specify a ledger version.

    diff --git a/docs/interfaces/LedgerResponse.html b/docs/interfaces/LedgerResponse.html index 332bc022..22ecaa74 100644 --- a/docs/interfaces/LedgerResponse.html +++ b/docs/interfaces/LedgerResponse.html @@ -1,6 +1,6 @@ LedgerResponse | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface LedgerResponse

    Response expected from a LedgerRequest.

    -

    Hierarchy

    • BaseResponse
      • LedgerResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { ledger: Ledger | BinaryLedger; ledger_hash: string; ledger_index: number; queue_data?: (string | LedgerQueueData)[]; validated?: boolean }

    Type declaration

    • ledger: Ledger | BinaryLedger
      +

    Hierarchy

    • BaseResponse
      • LedgerResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { ledger: Ledger | BinaryLedger; ledger_hash: string; ledger_index: number; queue_data?: (string | LedgerQueueData)[]; validated?: boolean }

    Type declaration

    • ledger: Ledger | BinaryLedger

      The complete header data of this Ledger.

    • ledger_hash: string

      Unique identifying hash of the entire ledger.

      @@ -14,4 +14,4 @@ this ledger's data is not final.

      the queue. If the request specified expand as true, members contain full representations of the transactions, in either JSON or binary depending on whether the request specified binary as true.

      -

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/LedgerStream.html b/docs/interfaces/LedgerStream.html index d9e37435..59a1b357 100644 --- a/docs/interfaces/LedgerStream.html +++ b/docs/interfaces/LedgerStream.html @@ -2,29 +2,29 @@

    The ledger stream only sends ledgerClosed messages when the consensus process declares a new validated ledger. The message identifies the ledger And provides some information about its contents.

    -

    Hierarchy

    Index

    Properties

    Properties

    fee_base

    fee_base: number
    +

    Hierarchy

    • BaseStream
      • LedgerStream

    Index

    Properties

    Properties

    fee_base

    fee_base: number

    The reference transaction cost as of this ledger version, in drops of XRP. If this ledger version includes a SetFee pseudo-transaction the new. Transaction cost applies starting with the following ledger version.

    -

    fee_ref

    fee_ref: number
    +

    fee_ref

    fee_ref: number

    The reference transaction cost in "fee units".

    -

    ledger_hash

    ledger_hash: string
    +

    ledger_hash

    ledger_hash: string

    The identifying hash of the ledger version that was closed.

    -

    ledger_index

    ledger_index: number
    +

    ledger_index

    ledger_index: number

    The ledger index of the ledger that was closed.

    -

    ledger_time

    ledger_time: number
    +

    ledger_time

    ledger_time: number

    The time this ledger was closed, in seconds since the Ripple Epoch.

    -

    reserve_base

    reserve_base: number
    +

    reserve_base

    reserve_base: number

    The minimum reserve, in drops of XRP, that is required for an account. If this ledger version includes a SetFee pseudo-transaction the new base reserve applies starting with the following ledger version.

    -

    reserve_inc

    reserve_inc: number
    +

    reserve_inc

    reserve_inc: number

    The owner reserve for each object an account owns in the ledger, in drops of XRP. If the ledger includes a SetFee pseudo-transaction the new owner reserve applies after this ledger.

    -

    txn_count

    txn_count: number
    +

    txn_count

    txn_count: number

    Number of new transactions included in this ledger version.

    -

    type

    type: "ledgerClosed"

    Optional validated_ledgers

    validated_ledgers?: string
    +

    type

    type: "ledgerClosed"

    Optional validated_ledgers

    validated_ledgers?: string

    Range of ledgers that the server has available. This may be a disjoint sequence such as 24900901-24900984,24901116-24901158. This field is not returned if the server is not connected to the network, or if it is diff --git a/docs/interfaces/ManifestRequest.html b/docs/interfaces/ManifestRequest.html index aaaa2dba..13e88a75 100644 --- a/docs/interfaces/ManifestRequest.html +++ b/docs/interfaces/ManifestRequest.html @@ -4,13 +4,13 @@ validator public key. The "manifest" is the public portion of that validator's configured token. Expects a response in the form of a ManifestResponse.

    example
    const manifest: ManifestRequest = {
     "command": "manifest",
     "public_key": "nHUFE9prPXPrHcG3SkwP1UzAQbSphqyQkQK9ATXLZsfkezhhda3p"
    }
    -

    Hierarchy

    • BaseRequest
      • ManifestRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number
    +

    Hierarchy

    • BaseRequest
      • ManifestRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    The API version to use. If omitted, use version 1.

    -

    command

    command: "manifest"

    Optional id

    id?: string | number
    +

    command

    command: "manifest"

    Optional id

    id?: string | number

    A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

    -

    public_key

    public_key: string
    +

    public_key

    public_key: string

    The base58-encoded public key of the validator to look up. This can be the master public key or ephemeral public key.

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/ManifestResponse.html b/docs/interfaces/ManifestResponse.html index abc54be4..00fb45b5 100644 --- a/docs/interfaces/ManifestResponse.html +++ b/docs/interfaces/ManifestResponse.html @@ -1,6 +1,6 @@ ManifestResponse | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ManifestResponse

    Response expected from a ManifestRequest.

    -

    Hierarchy

    • BaseResponse
      • ManifestResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { details?: { domain: string; ephemeral_key: string; master_key: string; seq: number }; manifest?: string; requested: string }

    Type declaration

    • Optional details?: { domain: string; ephemeral_key: string; master_key: string; seq: number }
      +

    Hierarchy

    • BaseResponse
      • ManifestResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { details?: { domain: string; ephemeral_key: string; master_key: string; seq: number }; manifest?: string; requested: string }

    Type declaration

    • Optional details?: { domain: string; ephemeral_key: string; master_key: string; seq: number }

      The data contained in this manifest. Omitted if the server does not have A manifest for the public_key from the request.

      • domain: string
      • ephemeral_key: string
      • master_key: string
      • seq: number
    • Optional manifest?: string
      @@ -9,4 +9,4 @@ binary before being base64-encoded. Omitted if the server does not have a manifest for the public_key from the request.

    • requested: string

      The public_key from the request.

      -

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/NFTBuyOffersRequest.html b/docs/interfaces/NFTBuyOffersRequest.html index c680d84a..01d4caaa 100644 --- a/docs/interfaces/NFTBuyOffersRequest.html +++ b/docs/interfaces/NFTBuyOffersRequest.html @@ -1,12 +1,12 @@ NFTBuyOffersRequest | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface NFTBuyOffersRequest

    The nft_buy_offers method retrieves all of buy offers for the specified NFToken.

    -

    Hierarchy

    • BaseRequest
      • NFTBuyOffersRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number
    +

    Hierarchy

    • BaseRequest
      • NFTBuyOffersRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    The API version to use. If omitted, use version 1.

    -

    command

    command: "nft_buy_offers"

    Optional id

    id?: string | number
    +

    command

    command: "nft_buy_offers"

    Optional id

    id?: string | number

    A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

    -

    tokenid

    tokenid: string
    +

    tokenid

    tokenid: string

    The unique identifier of an NFToken. The request returns buy offers for this NFToken.

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/NFTBuyOffersResponse.html b/docs/interfaces/NFTBuyOffersResponse.html index 198c17a6..dc0060c0 100644 --- a/docs/interfaces/NFTBuyOffersResponse.html +++ b/docs/interfaces/NFTBuyOffersResponse.html @@ -1,7 +1,7 @@ NFTBuyOffersResponse | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface NFTBuyOffersResponse

    Response expected from an NFTBuyOffersRequest.

    -

    Hierarchy

    • BaseResponse
      • NFTBuyOffersResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { offers: NFTOffer[]; tokenid: string }

    Type declaration

    • offers: NFTOffer[]
      +

    Hierarchy

    • BaseResponse
      • NFTBuyOffersResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { offers: NFTOffer[]; tokenid: string }

    Type declaration

    • offers: NFTOffer[]

      A list of buy offers for the specified NFToken.

    • tokenid: string

      The token ID of the NFToken to which these offers pertain.

      -

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/NFTSellOffersRequest.html b/docs/interfaces/NFTSellOffersRequest.html index 69bfe8d5..c14ce6e4 100644 --- a/docs/interfaces/NFTSellOffersRequest.html +++ b/docs/interfaces/NFTSellOffersRequest.html @@ -1,12 +1,12 @@ NFTSellOffersRequest | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface NFTSellOffersRequest

    The nft_sell_offers method retrieves all of sell offers for the specified NFToken.

    -

    Hierarchy

    • BaseRequest
      • NFTSellOffersRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number
    +

    Hierarchy

    • BaseRequest
      • NFTSellOffersRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    The API version to use. If omitted, use version 1.

    -

    command

    command: "nft_sell_offers"

    Optional id

    id?: string | number
    +

    command

    command: "nft_sell_offers"

    Optional id

    id?: string | number

    A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

    -

    tokenid

    tokenid: string
    +

    tokenid

    tokenid: string

    The unique identifier of an NFToken. The request returns sell offers for this NFToken.

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/NFTSellOffersResponse.html b/docs/interfaces/NFTSellOffersResponse.html index 1184db17..0f4aaad7 100644 --- a/docs/interfaces/NFTSellOffersResponse.html +++ b/docs/interfaces/NFTSellOffersResponse.html @@ -1,7 +1,7 @@ NFTSellOffersResponse | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface NFTSellOffersResponse

    Response expected from an NFTSellOffersRequest.

    -

    Hierarchy

    • BaseResponse
      • NFTSellOffersResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { offers: NFTOffer[]; tokenid: string }

    Type declaration

    • offers: NFTOffer[]
      +

    Hierarchy

    • BaseResponse
      • NFTSellOffersResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { offers: NFTOffer[]; tokenid: string }

    Type declaration

    • offers: NFTOffer[]

      A list of sell offers for the specified NFToken.

    • tokenid: string

      The token ID of the NFToken to which these offers pertain.

      -

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Generated using TypeDoc

    \ No newline at end of file +

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/NFTokenAcceptOffer.html b/docs/interfaces/NFTokenAcceptOffer.html index 967d7693..3ddd0a19 100644 --- a/docs/interfaces/NFTokenAcceptOffer.html +++ b/docs/interfaces/NFTokenAcceptOffer.html @@ -13,13 +13,13 @@ called brokered mode. buy_offer fields, but not both. To indicate brokered mode, use both the sell_offer and buy_offer fields. If you use neither sell_offer nor buy_offer, the transaction is invalid.

    -

    Hierarchy

    Index

    Properties

    Properties

    Account

    Account: string
    +

    Hierarchy

    • BaseTransaction
      • NFTokenAcceptOffer

    Index

    Properties

    Properties

    Account

    Account: string

    The unique address of the account that initiated the transaction.

    -

    Optional AccountTxnID

    AccountTxnID?: string
    +

    Optional AccountTxnID

    AccountTxnID?: string

    Hash value identifying another transaction. If provided, this transaction is only valid if the sending account's previously-sent transaction matches the provided hash.

    -

    Optional BrokerFee

    BrokerFee?: Amount
    +

    Optional BrokerFee

    BrokerFee?: Amount

    This field is only valid in brokered mode. It specifies the amount that the broker will keep as part of their fee for bringing the two offers together; the remaining amount will @@ -36,49 +36,49 @@ or custody funds.

    Note: in brokered mode, the offers referenced by BuyOffer and SellOffer must both specify the same TokenID; that is, both must be for the same NFToken.

    -

    Optional BuyOffer

    BuyOffer?: string
    +

    Optional BuyOffer

    BuyOffer?: string

    Identifies the NFTokenOffer that offers to buy the NFToken.

    In direct mode this field is optional, but either SellOffer or BuyOffer must be specified. In brokered mode, both SellOffer and BuyOffer must be specified.

    -

    Optional Fee

    Fee?: string
    +

    Optional Fee

    Fee?: string

    Integer amount of XRP, in drops, to be destroyed as a cost for distributing this transaction to the network. Some transaction types have different minimum requirements.

    -

    Optional Flags

    Flags?: number | GlobalFlags
    +

    Optional Flags

    Flags?: number | GlobalFlags

    Set of bit-flags for this transaction.

    -

    Optional LastLedgerSequence

    LastLedgerSequence?: number
    +

    Optional LastLedgerSequence

    LastLedgerSequence?: number

    Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected.

    -

    Optional Memos

    Memos?: Memo[]
    +

    Optional Memos

    Memos?: Memo[]

    Additional arbitrary information used to identify this transaction.

    -

    Optional SellOffer

    SellOffer?: string
    +

    Optional SellOffer

    SellOffer?: string

    Identifies the NFTokenOffer that offers to sell the NFToken.

    In direct mode this field is optional, but either SellOffer or BuyOffer must be specified. In brokered mode, both SellOffer and BuyOffer must be specified.

    -

    Optional Sequence

    Sequence?: number
    +

    Optional Sequence

    Sequence?: number

    The sequence number of the account sending the transaction. A transaction is only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account. The special case 0 means the transaction is using a Ticket instead.

    -

    Optional Signers

    Signers?: Signer[]
    +

    Optional Signers

    Signers?: Signer[]

    Array of objects that represent a multi-signature which authorizes this transaction.

    -

    Optional SigningPubKey

    SigningPubKey?: string
    +

    Optional SigningPubKey

    SigningPubKey?: string

    Hex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in the Signers field instead.

    -

    Optional SourceTag

    SourceTag?: number
    +

    Optional SourceTag

    SourceTag?: number

    Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made. Conventionally, a refund should specify the initial payment's SourceTag as the refund payment's DestinationTag.

    -

    Optional TicketSequence

    TicketSequence?: number
    +

    Optional TicketSequence

    TicketSequence?: number

    The sequence number of the ticket to use in place of a Sequence number. If this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    -

    TransactionType

    TransactionType: "NFTokenAcceptOffer"

    Optional TxnSignature

    TxnSignature?: string
    +

    TransactionType

    TransactionType: "NFTokenAcceptOffer"

    Optional TxnSignature

    TxnSignature?: string

    The signature that verifies this transaction as originating from the account it says it is from.

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/NFTokenBurn.html b/docs/interfaces/NFTokenBurn.html index f01cdf62..2899f001 100644 --- a/docs/interfaces/NFTokenBurn.html +++ b/docs/interfaces/NFTokenBurn.html @@ -6,50 +6,50 @@ the ledger ("burning" it).

    operation empties the NFTokenPage holding the NFToken or results in the consolidation, thus removing an NFTokenPage, the owner’s reserve requirement is reduced by one.

    -

    Hierarchy

    Index

    Properties

    Properties

    Account

    Account: string
    +

    Hierarchy

    • BaseTransaction
      • NFTokenBurn

    Index

    Properties

    Properties

    Account

    Account: string

    Indicates the AccountID that submitted this transaction. The account MUST be either the present owner of the token or, if the lsfBurnable flag is set in the NFToken, either the issuer account or an account authorized by the issuer, i.e. MintAccount.

    -

    Optional AccountTxnID

    AccountTxnID?: string
    +

    Optional AccountTxnID

    AccountTxnID?: string

    Hash value identifying another transaction. If provided, this transaction is only valid if the sending account's previously-sent transaction matches the provided hash.

    -

    Optional Fee

    Fee?: string
    +

    Optional Fee

    Fee?: string

    Integer amount of XRP, in drops, to be destroyed as a cost for distributing this transaction to the network. Some transaction types have different minimum requirements.

    -

    Optional Flags

    Flags?: number | GlobalFlags
    +

    Optional Flags

    Flags?: number | GlobalFlags

    Set of bit-flags for this transaction.

    -

    Optional LastLedgerSequence

    LastLedgerSequence?: number
    +

    Optional LastLedgerSequence

    LastLedgerSequence?: number

    Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected.

    -

    Optional Memos

    Memos?: Memo[]
    +

    Optional Memos

    Memos?: Memo[]

    Additional arbitrary information used to identify this transaction.

    -

    Optional Sequence

    Sequence?: number
    +

    Optional Sequence

    Sequence?: number

    The sequence number of the account sending the transaction. A transaction is only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account. The special case 0 means the transaction is using a Ticket instead.

    -

    Optional Signers

    Signers?: Signer[]
    +

    Optional Signers

    Signers?: Signer[]

    Array of objects that represent a multi-signature which authorizes this transaction.

    -

    Optional SigningPubKey

    SigningPubKey?: string
    +

    Optional SigningPubKey

    SigningPubKey?: string

    Hex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in the Signers field instead.

    -

    Optional SourceTag

    SourceTag?: number
    +

    Optional SourceTag

    SourceTag?: number

    Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made. Conventionally, a refund should specify the initial payment's SourceTag as the refund payment's DestinationTag.

    -

    Optional TicketSequence

    TicketSequence?: number
    +

    Optional TicketSequence

    TicketSequence?: number

    The sequence number of the ticket to use in place of a Sequence number. If this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    -

    TokenID

    TokenID: string
    +

    TokenID

    TokenID: string

    Identifies the NFToken object to be removed by the transaction.

    -

    TransactionType

    TransactionType: "NFTokenBurn"

    Optional TxnSignature

    TxnSignature?: string
    +

    TransactionType

    TransactionType: "NFTokenBurn"

    Optional TxnSignature

    TxnSignature?: string

    The signature that verifies this transaction as originating from the account it says it is from.

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/NFTokenCancelOffer.html b/docs/interfaces/NFTokenCancelOffer.html index 1320f09f..6c2570c0 100644 --- a/docs/interfaces/NFTokenCancelOffer.html +++ b/docs/interfaces/NFTokenCancelOffer.html @@ -6,52 +6,52 @@ reserve requirement.

    the NFTokenOffer, the account in the Recipient field of the NFTokenOffer (if present), or any account if the NFTokenOffer has an Expiration and the NFTokenOffer has already expired.

    -

    Hierarchy

    Index

    Properties

    Properties

    Account

    Account: string
    +

    Hierarchy

    • BaseTransaction
      • NFTokenCancelOffer

    Index

    Properties

    Properties

    Account

    Account: string

    The unique address of the account that initiated the transaction.

    -

    Optional AccountTxnID

    AccountTxnID?: string
    +

    Optional AccountTxnID

    AccountTxnID?: string

    Hash value identifying another transaction. If provided, this transaction is only valid if the sending account's previously-sent transaction matches the provided hash.

    -

    Optional Fee

    Fee?: string
    +

    Optional Fee

    Fee?: string

    Integer amount of XRP, in drops, to be destroyed as a cost for distributing this transaction to the network. Some transaction types have different minimum requirements.

    -

    Optional Flags

    Flags?: number | GlobalFlags
    +

    Optional Flags

    Flags?: number | GlobalFlags

    Set of bit-flags for this transaction.

    -

    Optional LastLedgerSequence

    LastLedgerSequence?: number
    +

    Optional LastLedgerSequence

    LastLedgerSequence?: number

    Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected.

    -

    Optional Memos

    Memos?: Memo[]
    +

    Optional Memos

    Memos?: Memo[]

    Additional arbitrary information used to identify this transaction.

    -

    Optional Sequence

    Sequence?: number
    +

    Optional Sequence

    Sequence?: number

    The sequence number of the account sending the transaction. A transaction is only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account. The special case 0 means the transaction is using a Ticket instead.

    -

    Optional Signers

    Signers?: Signer[]
    +

    Optional Signers

    Signers?: Signer[]

    Array of objects that represent a multi-signature which authorizes this transaction.

    -

    Optional SigningPubKey

    SigningPubKey?: string
    +

    Optional SigningPubKey

    SigningPubKey?: string

    Hex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in the Signers field instead.

    -

    Optional SourceTag

    SourceTag?: number
    +

    Optional SourceTag

    SourceTag?: number

    Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made. Conventionally, a refund should specify the initial payment's SourceTag as the refund payment's DestinationTag.

    -

    Optional TicketSequence

    TicketSequence?: number
    +

    Optional TicketSequence

    TicketSequence?: number

    The sequence number of the ticket to use in place of a Sequence number. If this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    -

    TokenOffers

    TokenOffers: string[]
    +

    TokenOffers

    TokenOffers: string[]

    An array of identifiers of NFTokenOffer objects that should be cancelled by this transaction.

    It is an error if an entry in this list points to an object that is not an NFTokenOffer object. It is not an error if an entry in this list points to an object that does not exist. This field is required.

    -

    TransactionType

    TransactionType: "NFTokenCancelOffer"

    Optional TxnSignature

    TxnSignature?: string
    +

    TransactionType

    TransactionType: "NFTokenCancelOffer"

    Optional TxnSignature

    TxnSignature?: string

    The signature that verifies this transaction as originating from the account it says it is from.

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/NFTokenCreateOffer.html b/docs/interfaces/NFTokenCreateOffer.html index 09318f1b..9b00546b 100644 --- a/docs/interfaces/NFTokenCreateOffer.html +++ b/docs/interfaces/NFTokenCreateOffer.html @@ -2,37 +2,37 @@

    The NFTokenCreateOffer transaction creates either an offer to buy an NFT the submitting account does not own, or an offer to sell an NFT the submitting account does own.

    -

    Hierarchy

    Index

    Properties

    Properties

    Account

    Account: string
    +

    Hierarchy

    • BaseTransaction
      • NFTokenCreateOffer

    Index

    Properties

    Properties

    Account

    Account: string

    The unique address of the account that initiated the transaction.

    -

    Optional AccountTxnID

    AccountTxnID?: string
    +

    Optional AccountTxnID

    AccountTxnID?: string

    Hash value identifying another transaction. If provided, this transaction is only valid if the sending account's previously-sent transaction matches the provided hash.

    -

    Amount

    Amount: Amount
    +

    Amount

    Amount: Amount

    Indicates the amount expected or offered for the Token.

    The amount must be non-zero, except when this is a sell offer and the asset is XRP. This would indicate that the current owner of the token is giving it away free, either to anyone at all, or to the account identified by the Destination field.

    -

    Optional Destination

    Destination?: string
    +

    Optional Destination

    Destination?: string

    If present, indicates that this offer may only be accepted by the specified account. Attempts by other accounts to accept this offer MUST fail.

    -

    Optional Expiration

    Expiration?: number
    +

    Optional Expiration

    Expiration?: number

    Indicates the time after which the offer will no longer be valid. The value is the number of seconds since the Ripple Epoch.

    -

    Optional Fee

    Fee?: string
    +

    Optional Fee

    Fee?: string

    Integer amount of XRP, in drops, to be destroyed as a cost for distributing this transaction to the network. Some transaction types have different minimum requirements.

    -

    Optional Flags

    Flags?: number | NFTokenCreateOfferFlagsInterface

    Optional LastLedgerSequence

    LastLedgerSequence?: number
    +

    Optional Flags

    Flags?: number | NFTokenCreateOfferFlagsInterface

    Optional LastLedgerSequence

    LastLedgerSequence?: number

    Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected.

    -

    Optional Memos

    Memos?: Memo[]
    +

    Optional Memos

    Memos?: Memo[]

    Additional arbitrary information used to identify this transaction.

    -

    Optional Owner

    Owner?: string
    +

    Optional Owner

    Owner?: string

    Indicates the AccountID of the account that owns the corresponding NFToken.

    If the offer is to buy a token, this field must be present @@ -42,30 +42,30 @@ buy a token one already holds is meaningless).

    present, as the owner is, implicitly, the same as Account (since an offer to sell a token one doesn't already hold is meaningless).

    -

    Optional Sequence

    Sequence?: number
    +

    Optional Sequence

    Sequence?: number

    The sequence number of the account sending the transaction. A transaction is only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account. The special case 0 means the transaction is using a Ticket instead.

    -

    Optional Signers

    Signers?: Signer[]
    +

    Optional Signers

    Signers?: Signer[]

    Array of objects that represent a multi-signature which authorizes this transaction.

    -

    Optional SigningPubKey

    SigningPubKey?: string
    +

    Optional SigningPubKey

    SigningPubKey?: string

    Hex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in the Signers field instead.

    -

    Optional SourceTag

    SourceTag?: number
    +

    Optional SourceTag

    SourceTag?: number

    Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made. Conventionally, a refund should specify the initial payment's SourceTag as the refund payment's DestinationTag.

    -

    Optional TicketSequence

    TicketSequence?: number
    +

    Optional TicketSequence

    TicketSequence?: number

    The sequence number of the ticket to use in place of a Sequence number. If this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    -

    TokenID

    TokenID: string
    +

    TokenID

    TokenID: string

    Identifies the TokenID of the NFToken object that the offer references.

    -

    TransactionType

    TransactionType: "NFTokenCreateOffer"

    Optional TxnSignature

    TxnSignature?: string
    +

    TransactionType

    TransactionType: "NFTokenCreateOffer"

    Optional TxnSignature

    TxnSignature?: string

    The signature that verifies this transaction as originating from the account it says it is from.

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/NFTokenCreateOfferFlagsInterface.html b/docs/interfaces/NFTokenCreateOfferFlagsInterface.html index 831d6f8c..fde5ade6 100644 --- a/docs/interfaces/NFTokenCreateOfferFlagsInterface.html +++ b/docs/interfaces/NFTokenCreateOfferFlagsInterface.html @@ -1,4 +1,4 @@ NFTokenCreateOfferFlagsInterface | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface NFTokenCreateOfferFlagsInterface

    Map of flags to boolean values representing NFTokenCreateOffer transaction flags.

    -

    Hierarchy

    • GlobalFlags
      • NFTokenCreateOfferFlagsInterface

    Index

    Properties

    Properties

    Optional tfSellToken

    tfSellToken?: boolean

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Hierarchy

    Index

    Properties

    Properties

    Optional tfSellToken

    tfSellToken?: boolean

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/NFTokenMint.html b/docs/interfaces/NFTokenMint.html index 6125a9a3..15bea25d 100644 --- a/docs/interfaces/NFTokenMint.html +++ b/docs/interfaces/NFTokenMint.html @@ -3,64 +3,64 @@ relevant NFTokenPage object of the minter. If the transaction is successful, the newly minted token will be owned by the minter account specified by the transaction.

    -

    Hierarchy

    Index

    Properties

    Properties

    Account

    Account: string
    +

    Hierarchy

    • BaseTransaction
      • NFTokenMint

    Index

    Properties

    Properties

    Account

    Account: string

    The unique address of the account that initiated the transaction.

    -

    Optional AccountTxnID

    AccountTxnID?: string
    +

    Optional AccountTxnID

    AccountTxnID?: string

    Hash value identifying another transaction. If provided, this transaction is only valid if the sending account's previously-sent transaction matches the provided hash.

    -

    Optional Fee

    Fee?: string
    +

    Optional Fee

    Fee?: string

    Integer amount of XRP, in drops, to be destroyed as a cost for distributing this transaction to the network. Some transaction types have different minimum requirements.

    -

    Optional Flags

    Flags?: number | NFTokenMintFlagsInterface

    Optional Issuer

    Issuer?: string
    +

    Optional Flags

    Flags?: number | NFTokenMintFlagsInterface

    Optional Issuer

    Issuer?: string

    Indicates the account that should be the issuer of this token. This value is optional and should only be specified if the account executing the transaction is not the Issuer of the NFToken object. If it is present, the MintAccount field in the AccountRoot of the Issuer field must match the Account, otherwise the transaction will fail.

    -

    Optional LastLedgerSequence

    LastLedgerSequence?: number
    +

    Optional LastLedgerSequence

    LastLedgerSequence?: number

    Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected.

    -

    Optional Memos

    Memos?: Memo[]
    +

    Optional Memos

    Memos?: Memo[]

    Additional arbitrary information used to identify this transaction.

    -

    Optional Sequence

    Sequence?: number
    +

    Optional Sequence

    Sequence?: number

    The sequence number of the account sending the transaction. A transaction is only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account. The special case 0 means the transaction is using a Ticket instead.

    -

    Optional Signers

    Signers?: Signer[]
    +

    Optional Signers

    Signers?: Signer[]

    Array of objects that represent a multi-signature which authorizes this transaction.

    -

    Optional SigningPubKey

    SigningPubKey?: string
    +

    Optional SigningPubKey

    SigningPubKey?: string

    Hex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in the Signers field instead.

    -

    Optional SourceTag

    SourceTag?: number
    +

    Optional SourceTag

    SourceTag?: number

    Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made. Conventionally, a refund should specify the initial payment's SourceTag as the refund payment's DestinationTag.

    -

    Optional TicketSequence

    TicketSequence?: number
    +

    Optional TicketSequence

    TicketSequence?: number

    The sequence number of the ticket to use in place of a Sequence number. If this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    -

    TokenTaxon

    TokenTaxon: number
    +

    TokenTaxon

    TokenTaxon: number

    Indicates the taxon associated with this token. The taxon is generally a value chosen by the minter of the token and a given taxon may be used for multiple tokens. The implementation reserves taxon identifiers greater than or equal to 2147483648 (0x80000000). If you have no use for this field, set it to 0.

    -

    TransactionType

    TransactionType: "NFTokenMint"

    Optional TransferFee

    TransferFee?: number
    +

    TransactionType

    TransactionType: "NFTokenMint"

    Optional TransferFee

    TransferFee?: number

    Specifies the fee charged by the issuer for secondary sales of the Token, if such sales are allowed. Valid values for this field are between 0 and 50000 inclusive, allowing transfer rates between 0.000% and 50.000% in increments of 0.001%. This field must NOT be present if the tfTransferable flag is not set.

    -

    Optional TxnSignature

    TxnSignature?: string
    +

    Optional TxnSignature

    TxnSignature?: string

    The signature that verifies this transaction as originating from the account it says it is from.

    -

    Optional URI

    URI?: string
    +

    Optional URI

    URI?: string

    URI that points to the data and/or metadata associated with the NFT. This field need not be an HTTP or HTTPS URL; it could be an IPFS URI, a magnet link, immediate data encoded as an RFC2379 "data" URL, or even an diff --git a/docs/interfaces/NFTokenMintFlagsInterface.html b/docs/interfaces/NFTokenMintFlagsInterface.html index fb5b903a..1f5e8c42 100644 --- a/docs/interfaces/NFTokenMintFlagsInterface.html +++ b/docs/interfaces/NFTokenMintFlagsInterface.html @@ -1,4 +1,4 @@ NFTokenMintFlagsInterface | xrpl

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface NFTokenMintFlagsInterface

    Map of flags to boolean values representing NFTokenMint transaction flags.

    -

    Hierarchy

    • GlobalFlags
      • NFTokenMintFlagsInterface

    Index

    Properties

    Properties

    Optional tfBurnable

    tfBurnable?: boolean

    Optional tfOnlyXRP

    tfOnlyXRP?: boolean

    Optional tfTransferable

    tfTransferable?: boolean

    Optional tfTrustLine

    tfTrustLine?: boolean

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Hierarchy

    • GlobalFlags
      • NFTokenMintFlagsInterface

    Index

    Properties

    Properties

    Optional tfBurnable

    tfBurnable?: boolean

    Optional tfOnlyXRP

    tfOnlyXRP?: boolean

    Optional tfTransferable

    tfTransferable?: boolean

    Optional tfTrustLine

    tfTrustLine?: boolean

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/NoRippleCheckRequest.html b/docs/interfaces/NoRippleCheckRequest.html index 6da8351f..2b1a48cb 100644 --- a/docs/interfaces/NoRippleCheckRequest.html +++ b/docs/interfaces/NoRippleCheckRequest.html @@ -5,28 +5,28 @@ lines, compared with the recommended settings. Expects a response in the form of an NoRippleCheckResponse.

    example
    const noRipple: NoRippleCheckRequest = {
      "id": 0,
      "command": "noripple_check",
      "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
       "role": "gateway",
      "ledger_index": "current",
      "limit": 2,
      "transactions": true
    }
    -

    Hierarchy

    • BaseRequest
      • NoRippleCheckRequest

    Index

    Properties

    Properties

    account

    account: string
    +

    Hierarchy

    • BaseRequest
      • NoRippleCheckRequest

    Index

    Properties

    Properties

    account

    account: string

    A unique identifier for the account, most commonly the account's address.

    -

    Optional api_version

    api_version?: number
    +

    Optional api_version

    api_version?: number

    The API version to use. If omitted, use version 1.

    -

    command

    command: "noripple_check"

    Optional id

    id?: string | number
    +

    command

    command: "noripple_check"

    Optional id

    id?: string | number

    A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

    -

    Optional ledger_hash

    ledger_hash?: string
    +

    Optional ledger_hash

    ledger_hash?: string

    A 20-byte hex string for the ledger version to use.

    -

    Optional ledger_index

    ledger_index?: LedgerIndex
    +

    Optional ledger_index

    ledger_index?: LedgerIndex

    The ledger index of the ledger to use, or a shortcut string to choose a ledger automatically.

    -

    Optional limit

    limit?: number
    +

    Optional limit

    limit?: number

    The maximum number of trust line problems to include in the results. Defaults to 300.

    -

    role

    role: "gateway" | "user"
    +

    role

    role: "gateway" | "user"

    Whether the address refers to a gateway or user. Recommendations depend on the role of the account. Issuers must have Default Ripple enabled and must disable No Ripple on all trust lines. Users should have Default Ripple disabled, and should enable No Ripple on all trust lines.

    -

    Optional transactions

    transactions?: boolean
    +

    Optional transactions

    transactions?: boolean

    If true, include an array of suggested transactions, as JSON objects, that you can sign and submit to fix the problems. Defaults to false.

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/NoRippleCheckResponse.html b/docs/interfaces/NoRippleCheckResponse.html index 70793909..9207052b 100644 --- a/docs/interfaces/NoRippleCheckResponse.html +++ b/docs/interfaces/NoRippleCheckResponse.html @@ -1,6 +1,6 @@ NoRippleCheckResponse | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface NoRippleCheckResponse

    Response expected by a NoRippleCheckRequest.

    -

    Hierarchy

    • BaseResponse
      • NoRippleCheckResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { ledger_current_index: number; problems: string[]; transactions: Transaction[] }

    Type declaration

    • ledger_current_index: number
      +

    Hierarchy

    • BaseResponse
      • NoRippleCheckResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { ledger_current_index: number; problems: string[]; transactions: Transaction[] }

    Type declaration

    • ledger_current_index: number

      The ledger index of the ledger used to calculate these results.

    • problems: string[]

      Array of strings with human-readable descriptions of the problems. @@ -13,4 +13,4 @@ objects, each of which is the JSON form of a transaction that should fix one of the described problems. The length of this array is the same as the problems array, and each entry is intended to fix the problem described at the same index into that array.

      -

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/OfferCancel.html b/docs/interfaces/OfferCancel.html index aaeb6494..26339a21 100644 --- a/docs/interfaces/OfferCancel.html +++ b/docs/interfaces/OfferCancel.html @@ -1,49 +1,49 @@ OfferCancel | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface OfferCancel

    An OfferCancel transaction removes an Offer object from the XRP Ledger.

    -

    Hierarchy

    • BaseTransaction
      • OfferCancel

    Index

    Properties

    Properties

    Account

    Account: string
    +

    Hierarchy

    • BaseTransaction
      • OfferCancel

    Index

    Properties

    Properties

    Account

    Account: string

    The unique address of the account that initiated the transaction.

    -

    Optional AccountTxnID

    AccountTxnID?: string
    +

    Optional AccountTxnID

    AccountTxnID?: string

    Hash value identifying another transaction. If provided, this transaction is only valid if the sending account's previously-sent transaction matches the provided hash.

    -

    Optional Fee

    Fee?: string
    +

    Optional Fee

    Fee?: string

    Integer amount of XRP, in drops, to be destroyed as a cost for distributing this transaction to the network. Some transaction types have different minimum requirements.

    -

    Optional Flags

    Flags?: number | GlobalFlags
    +

    Optional Flags

    Flags?: number | GlobalFlags

    Set of bit-flags for this transaction.

    -

    Optional LastLedgerSequence

    LastLedgerSequence?: number
    +

    Optional LastLedgerSequence

    LastLedgerSequence?: number

    Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected.

    -

    Optional Memos

    Memos?: Memo[]
    +

    Optional Memos

    Memos?: Memo[]

    Additional arbitrary information used to identify this transaction.

    -

    OfferSequence

    OfferSequence: number
    +

    OfferSequence

    OfferSequence: number

    The sequence number (or Ticket number) of a previous OfferCreate transaction. If specified, cancel any offer object in the ledger that was created by that transaction. It is not considered an error if the offer. specified does not exist.

    -

    Optional Sequence

    Sequence?: number
    +

    Optional Sequence

    Sequence?: number

    The sequence number of the account sending the transaction. A transaction is only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account. The special case 0 means the transaction is using a Ticket instead.

    -

    Optional Signers

    Signers?: Signer[]
    +

    Optional Signers

    Signers?: Signer[]

    Array of objects that represent a multi-signature which authorizes this transaction.

    -

    Optional SigningPubKey

    SigningPubKey?: string
    +

    Optional SigningPubKey

    SigningPubKey?: string

    Hex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in the Signers field instead.

    -

    Optional SourceTag

    SourceTag?: number
    +

    Optional SourceTag

    SourceTag?: number

    Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made. Conventionally, a refund should specify the initial payment's SourceTag as the refund payment's DestinationTag.

    -

    Optional TicketSequence

    TicketSequence?: number
    +

    Optional TicketSequence

    TicketSequence?: number

    The sequence number of the ticket to use in place of a Sequence number. If this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    -

    TransactionType

    TransactionType: "OfferCancel"

    Optional TxnSignature

    TxnSignature?: string
    +

    TransactionType

    TransactionType: "OfferCancel"

    Optional TxnSignature

    TxnSignature?: string

    The signature that verifies this transaction as originating from the account it says it is from.

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/OfferCreate.html b/docs/interfaces/OfferCreate.html index 4f0a81b0..7a224879 100644 --- a/docs/interfaces/OfferCreate.html +++ b/docs/interfaces/OfferCreate.html @@ -2,52 +2,52 @@

    An OfferCreate transaction is effectively a limit order . It defines an intent to exchange currencies, and creates an Offer object if not completely. Fulfilled when placed. Offers can be partially fulfilled.

    -

    Hierarchy

    Index

    Properties

    Properties

    Account

    Account: string
    +

    Hierarchy

    • BaseTransaction
      • OfferCreate

    Index

    Properties

    Properties

    Account

    Account: string

    The unique address of the account that initiated the transaction.

    -

    Optional AccountTxnID

    AccountTxnID?: string
    +

    Optional AccountTxnID

    AccountTxnID?: string

    Hash value identifying another transaction. If provided, this transaction is only valid if the sending account's previously-sent transaction matches the provided hash.

    -

    Optional Expiration

    Expiration?: number
    +

    Optional Expiration

    Expiration?: number

    Time after which the offer is no longer active, in seconds since the. Ripple Epoch.

    -

    Optional Fee

    Fee?: string
    +

    Optional Fee

    Fee?: string

    Integer amount of XRP, in drops, to be destroyed as a cost for distributing this transaction to the network. Some transaction types have different minimum requirements.

    -

    Optional Flags

    Flags?: number | OfferCreateFlagsInterface

    Optional LastLedgerSequence

    LastLedgerSequence?: number
    +

    Optional Flags

    Flags?: number | OfferCreateFlagsInterface

    Optional LastLedgerSequence

    LastLedgerSequence?: number

    Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected.

    -

    Optional Memos

    Memos?: Memo[]
    +

    Optional Memos

    Memos?: Memo[]

    Additional arbitrary information used to identify this transaction.

    -

    Optional OfferSequence

    OfferSequence?: number
    +

    Optional OfferSequence

    OfferSequence?: number

    An offer to delete first, specified in the same way as OfferCancel.

    -

    Optional Sequence

    Sequence?: number
    +

    Optional Sequence

    Sequence?: number

    The sequence number of the account sending the transaction. A transaction is only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account. The special case 0 means the transaction is using a Ticket instead.

    -

    Optional Signers

    Signers?: Signer[]
    +

    Optional Signers

    Signers?: Signer[]

    Array of objects that represent a multi-signature which authorizes this transaction.

    -

    Optional SigningPubKey

    SigningPubKey?: string
    +

    Optional SigningPubKey

    SigningPubKey?: string

    Hex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in the Signers field instead.

    -

    Optional SourceTag

    SourceTag?: number
    +

    Optional SourceTag

    SourceTag?: number

    Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made. Conventionally, a refund should specify the initial payment's SourceTag as the refund payment's DestinationTag.

    -

    TakerGets

    TakerGets: Amount
    +

    TakerGets

    TakerGets: Amount

    The amount and type of currency being provided by the offer creator.

    -

    TakerPays

    TakerPays: Amount
    +

    TakerPays

    TakerPays: Amount

    The amount and type of currency being requested by the offer creator.

    -

    Optional TicketSequence

    TicketSequence?: number
    +

    Optional TicketSequence

    TicketSequence?: number

    The sequence number of the ticket to use in place of a Sequence number. If this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    -

    TransactionType

    TransactionType: "OfferCreate"

    Optional TxnSignature

    TxnSignature?: string
    +

    TransactionType

    TransactionType: "OfferCreate"

    Optional TxnSignature

    TxnSignature?: string

    The signature that verifies this transaction as originating from the account it says it is from.

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/OfferCreateFlagsInterface.html b/docs/interfaces/OfferCreateFlagsInterface.html index 6c26623b..ce38f21e 100644 --- a/docs/interfaces/OfferCreateFlagsInterface.html +++ b/docs/interfaces/OfferCreateFlagsInterface.html @@ -3,4 +3,4 @@ flags.

    example
    const tx: OfferCreate = {
    Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
    TakerGets: '43000.51',
    TakerPays: '12928290425',
    TransactionType: 'OfferCreate',
    Flags: {
      tfPassive: true,
      tfFillOrKill: true,
     },
    }

    // Autofill the tx to see how flags actually look compared to the interface usage.
    const autofilledTx = await client.autofill(tx)
    console.log(autofilledTx)
    // {
    // Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
    // TakerGets: '43000.51',
    // TakerPays: '12928290425',
    // TransactionType: 'OfferCreate',
    // Flags: 327680,
    // Sequence: 21970384,
    // Fee: '12',
    // LastLedgerSequence: 21970404
    // }
    -

    Hierarchy

    Index

    Properties

    Properties

    Optional tfFillOrKill

    tfFillOrKill?: boolean

    Optional tfImmediateOrCancel

    tfImmediateOrCancel?: boolean

    Optional tfPassive

    tfPassive?: boolean

    Optional tfSell

    tfSell?: boolean

    Generated using TypeDoc

    \ No newline at end of file +

    Hierarchy

    Index

    Properties

    Properties

    Optional tfFillOrKill

    tfFillOrKill?: boolean

    Optional tfImmediateOrCancel

    tfImmediateOrCancel?: boolean

    Optional tfPassive

    tfPassive?: boolean

    Optional tfSell

    tfSell?: boolean

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/OrderBookStream.html b/docs/interfaces/OrderBookStream.html index 6b6beb39..f0ecbcb1 100644 --- a/docs/interfaces/OrderBookStream.html +++ b/docs/interfaces/OrderBookStream.html @@ -3,4 +3,4 @@ get back any transactions that affect those order books. Has the same format as a TransactionStream but the transaction can have a owner_funds field.

    -

    Hierarchy

    Index

    Properties

    Properties

    engine_result

    engine_result: string

    engine_result_code

    engine_result_code: number

    engine_result_message

    engine_result_message: string

    Optional ledger_current_index

    ledger_current_index?: number

    Optional ledger_hash

    ledger_hash?: string

    Optional ledger_index

    ledger_index?: number

    meta

    meta: TransactionMetadata

    status

    status: string

    transaction

    transaction: Transaction | ModifiedOfferCreateTransaction

    type

    type: "transaction"

    validated

    validated: boolean

    Generated using TypeDoc

    \ No newline at end of file +

    Hierarchy

    Index

    Properties

    Properties

    engine_result

    engine_result: string

    engine_result_code

    engine_result_code: number

    engine_result_message

    engine_result_message: string

    Optional ledger_current_index

    ledger_current_index?: number

    Optional ledger_hash

    ledger_hash?: string

    Optional ledger_index

    ledger_index?: number

    meta

    meta: TransactionMetadata

    status

    status: string

    transaction

    transaction: (AccountDelete & { date?: number; hash?: string }) & (AccountSet & { date?: number; hash?: string }) & (CheckCancel & { date?: number; hash?: string }) & (CheckCash & { date?: number; hash?: string }) & (CheckCreate & { date?: number; hash?: string }) & (DepositPreauth & { date?: number; hash?: string }) & (EscrowCancel & { date?: number; hash?: string }) & (EscrowCreate & { date?: number; hash?: string }) & (EscrowFinish & { date?: number; hash?: string }) & (NFTokenAcceptOffer & { date?: number; hash?: string }) & (NFTokenBurn & { date?: number; hash?: string }) & (NFTokenCancelOffer & { date?: number; hash?: string }) & (NFTokenCreateOffer & { date?: number; hash?: string }) & (NFTokenMint & { date?: number; hash?: string }) & (OfferCancel & { date?: number; hash?: string }) & (OfferCreate & { date?: number; hash?: string }) & (Payment & { date?: number; hash?: string }) & (PaymentChannelClaim & { date?: number; hash?: string }) & (PaymentChannelCreate & { date?: number; hash?: string }) & (PaymentChannelFund & { date?: number; hash?: string }) & (SetRegularKey & { date?: number; hash?: string }) & (SignerListSet & { date?: number; hash?: string }) & (TicketCreate & { date?: number; hash?: string }) & (TrustSet & { date?: number; hash?: string }) & (ModifiedOfferCreateTransaction & { date?: number; hash?: string })

    type

    type: "transaction"

    validated

    validated: boolean

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/PathFindCloseRequest.html b/docs/interfaces/PathFindCloseRequest.html index 0f36b1ba..0ae86e63 100644 --- a/docs/interfaces/PathFindCloseRequest.html +++ b/docs/interfaces/PathFindCloseRequest.html @@ -1,9 +1,9 @@ PathFindCloseRequest | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface PathFindCloseRequest

    Stop sending pathfinding information.

    -

    Hierarchy

    • BasePathFindRequest
      • PathFindCloseRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number
    +

    Hierarchy

    • BasePathFindRequest
      • PathFindCloseRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    The API version to use. If omitted, use version 1.

    -

    command

    command: "path_find"

    Optional id

    id?: string | number
    +

    command

    command: "path_find"

    Optional id

    id?: string | number

    A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

    -

    subcommand

    subcommand: "close"

    Generated using TypeDoc

    \ No newline at end of file +

    subcommand

    subcommand: "close"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/PathFindCreateRequest.html b/docs/interfaces/PathFindCreateRequest.html index e878c47b..4b6ce62d 100644 --- a/docs/interfaces/PathFindCreateRequest.html +++ b/docs/interfaces/PathFindCreateRequest.html @@ -1,23 +1,23 @@ PathFindCreateRequest | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface PathFindCreateRequest

    Start sending pathfinding information.

    -

    Hierarchy

    • BasePathFindRequest
      • PathFindCreateRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number
    +

    Hierarchy

    • BasePathFindRequest
      • PathFindCreateRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    The API version to use. If omitted, use version 1.

    -

    command

    command: "path_find"

    destination_account

    destination_account: string
    +

    command

    command: "path_find"

    destination_account

    destination_account: string

    Unique address of the account to find a path to.

    -

    destination_amount

    destination_amount: Amount
    +

    destination_amount

    destination_amount: Amount

    Currency Amount that the destination account would receive in a transaction.

    -

    Optional id

    id?: string | number
    +

    Optional id

    id?: string | number

    A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

    -

    Optional paths

    paths?: Path[]
    +

    Optional paths

    paths?: Path[]

    Array of arrays of objects, representing payment paths to check. You can use this to keep updated on changes to particular paths you already know about, or to check the overall cost to make a payment along a certain path.

    -

    Optional send_max

    send_max?: Amount
    +

    Optional send_max

    send_max?: Amount

    Currency amount that would be spent in the transaction.

    -

    source_account

    source_account: string
    +

    source_account

    source_account: string

    Unique address of the account to find a path from. In other words, the. Account that would be sending a payment.

    -

    subcommand

    subcommand: "create"

    Generated using TypeDoc

    \ No newline at end of file +

    subcommand

    subcommand: "create"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/PathFindResponse.html b/docs/interfaces/PathFindResponse.html index fec9967b..67f70d8a 100644 --- a/docs/interfaces/PathFindResponse.html +++ b/docs/interfaces/PathFindResponse.html @@ -1,6 +1,6 @@ PathFindResponse | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface PathFindResponse

    Response expected from a PathFindRequest.

    -

    Hierarchy

    • BaseResponse
      • PathFindResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { alternatives: PathOption[]; closed?: true; destination_account: string; destination_amount: Amount; full_reply: boolean; id?: string | number; source_account: string; status?: true }

    Type declaration

    • alternatives: PathOption[]
      +

    Hierarchy

    • BaseResponse
      • PathFindResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { alternatives: PathOption[]; closed?: true; destination_account: string; destination_amount: Amount; full_reply: boolean; id?: string | number; source_account: string; status?: true }

    Type declaration

    • alternatives: PathOption[]

      Array of objects with suggested paths to take, as described below. If empty, then no paths were found connecting the source and destination accounts.

      @@ -25,4 +25,4 @@ level.

    • Optional status?: true

      The value true indicates this reply is in response to a path_find status command.

      -

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Generated using TypeDoc

    \ No newline at end of file +

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/PathFindStatusRequest.html b/docs/interfaces/PathFindStatusRequest.html index b4bafb4c..653c6fb1 100644 --- a/docs/interfaces/PathFindStatusRequest.html +++ b/docs/interfaces/PathFindStatusRequest.html @@ -1,9 +1,9 @@ PathFindStatusRequest | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface PathFindStatusRequest

    Get the information of the currently-open pathfinding request.

    -

    Hierarchy

    • BasePathFindRequest
      • PathFindStatusRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number
    +

    Hierarchy

    • BasePathFindRequest
      • PathFindStatusRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    The API version to use. If omitted, use version 1.

    -

    command

    command: "path_find"

    Optional id

    id?: string | number
    +

    command

    command: "path_find"

    Optional id

    id?: string | number

    A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

    -

    subcommand

    subcommand: "status"

    Generated using TypeDoc

    \ No newline at end of file +

    subcommand

    subcommand: "status"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/PathFindStream.html b/docs/interfaces/PathFindStream.html index 24b66c44..ff626a48 100644 --- a/docs/interfaces/PathFindStream.html +++ b/docs/interfaces/PathFindStream.html @@ -2,23 +2,23 @@

    The path_find method searches for a path along which a transaction can possibly be made, and periodically sends updates when the path changes over time.

    -

    Hierarchy

    Index

    Properties

    Properties

    alternatives

    alternatives: [] | { paths_computed: Path[]; source_amount: Amount }
    +

    Hierarchy

    • BaseStream
      • PathFindStream

    Index

    Properties

    Properties

    alternatives

    alternatives: [] | { paths_computed: Path[]; source_amount: Amount }

    Array of objects with suggested paths to take. If empty, then no paths were found connecting the source and destination accounts.

    -

    destination_account

    destination_account: string
    +

    destination_account

    destination_account: string

    Unique address of the account that would receive a transaction.

    -

    destination_amount

    destination_amount: Amount
    +

    destination_amount

    destination_amount: Amount

    Currency Amount that the destination would receive in a transaction.

    -

    full_reply

    full_reply: boolean
    +

    full_reply

    full_reply: boolean

    If false, this is the result of an incomplete search. A later reply may have a better path. If true, then this is the best path found. (It is still theoretically possible that a better path could exist, but rippled won't find it.) Until you close the pathfinding request, rippled continues to send updates each time a new ledger closes.

    -

    id

    id: string | number
    +

    id

    id: string | number

    The ID provided in the WebSocket request is included again at this level.

    -

    Optional send_max

    send_max?: Amount
    +

    Optional send_max

    send_max?: Amount

    Currency Amount that would be spent in the transaction.

    -

    source_account

    source_account: string
    +

    source_account

    source_account: string

    Unique address that would send a transaction.

    -

    type

    type: "path_find"

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    type

    type: "path_find"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/Payment.html b/docs/interfaces/Payment.html index 8c55a8d4..5dca79b8 100644 --- a/docs/interfaces/Payment.html +++ b/docs/interfaces/Payment.html @@ -1,69 +1,69 @@ Payment | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface Payment

    A Payment transaction represents a transfer of value from one account to another.

    -

    Hierarchy

    • BaseTransaction
      • Payment

    Index

    Properties

    Properties

    Account

    Account: string
    +

    Hierarchy

    • BaseTransaction
      • Payment

    Index

    Properties

    Properties

    Account

    Account: string

    The unique address of the account that initiated the transaction.

    -

    Optional AccountTxnID

    AccountTxnID?: string
    +

    Optional AccountTxnID

    AccountTxnID?: string

    Hash value identifying another transaction. If provided, this transaction is only valid if the sending account's previously-sent transaction matches the provided hash.

    -

    Amount

    Amount: Amount
    +

    Amount

    Amount: Amount

    The amount of currency to deliver. For non-XRP amounts, the nested field names MUST be lower-case. If the tfPartialPayment flag is set, deliver up to this amount instead.

    -

    Optional DeliverMin

    DeliverMin?: Amount
    +

    Optional DeliverMin

    DeliverMin?: Amount

    Minimum amount of destination currency this transaction should deliver. Only valid if this is a partial payment. For non-XRP amounts, the nested field names are lower-case.

    -

    Destination

    Destination: string
    +

    Destination

    Destination: string

    The unique address of the account receiving the payment.

    -

    Optional DestinationTag

    DestinationTag?: number
    +

    Optional DestinationTag

    DestinationTag?: number

    Arbitrary tag that identifies the reason for the payment to the destination, or a hosted recipient to pay.

    -

    Optional Fee

    Fee?: string
    +

    Optional Fee

    Fee?: string

    Integer amount of XRP, in drops, to be destroyed as a cost for distributing this transaction to the network. Some transaction types have different minimum requirements.

    -

    Optional Flags

    Flags?: number | PaymentFlagsInterface

    Optional InvoiceID

    InvoiceID?: string
    +

    Optional Flags

    Flags?: number | PaymentFlagsInterface

    Optional InvoiceID

    InvoiceID?: string

    Arbitrary 256-bit hash representing a specific reason or identifier for this payment.

    -

    Optional LastLedgerSequence

    LastLedgerSequence?: number
    +

    Optional LastLedgerSequence

    LastLedgerSequence?: number

    Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected.

    -

    Optional Memos

    Memos?: Memo[]
    +

    Optional Memos

    Memos?: Memo[]

    Additional arbitrary information used to identify this transaction.

    -

    Optional Paths

    Paths?: Path[]
    +

    Optional Paths

    Paths?: Path[]

    Array of payment paths to be used for this transaction. Must be omitted for XRP-to-XRP transactions.

    -

    Optional SendMax

    SendMax?: Amount
    +

    Optional SendMax

    SendMax?: Amount

    Highest amount of source currency this transaction is allowed to cost, including transfer fees, exchange rates, and slippage . Does not include the XRP destroyed as a cost for submitting the transaction. For non-XRP amounts, the nested field names MUST be lower-case. Must be supplied for cross-currency/cross-issue payments. Must be omitted for XRP-to-XRP Payments.

    -

    Optional Sequence

    Sequence?: number
    +

    Optional Sequence

    Sequence?: number

    The sequence number of the account sending the transaction. A transaction is only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account. The special case 0 means the transaction is using a Ticket instead.

    -

    Optional Signers

    Signers?: Signer[]
    +

    Optional Signers

    Signers?: Signer[]

    Array of objects that represent a multi-signature which authorizes this transaction.

    -

    Optional SigningPubKey

    SigningPubKey?: string
    +

    Optional SigningPubKey

    SigningPubKey?: string

    Hex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in the Signers field instead.

    -

    Optional SourceTag

    SourceTag?: number
    +

    Optional SourceTag

    SourceTag?: number

    Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made. Conventionally, a refund should specify the initial payment's SourceTag as the refund payment's DestinationTag.

    -

    Optional TicketSequence

    TicketSequence?: number
    +

    Optional TicketSequence

    TicketSequence?: number

    The sequence number of the ticket to use in place of a Sequence number. If this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    -

    TransactionType

    TransactionType: "Payment"

    Optional TxnSignature

    TxnSignature?: string
    +

    TransactionType

    TransactionType: "Payment"

    Optional TxnSignature

    TxnSignature?: string

    The signature that verifies this transaction as originating from the account it says it is from.

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/PaymentChannelClaim.html b/docs/interfaces/PaymentChannelClaim.html index 2601dcdd..d50360f5 100644 --- a/docs/interfaces/PaymentChannelClaim.html +++ b/docs/interfaces/PaymentChannelClaim.html @@ -1,63 +1,63 @@ PaymentChannelClaim | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface PaymentChannelClaim

    Claim XRP from a payment channel, adjust the payment channel's expiration, or both.

    -

    Hierarchy

    • BaseTransaction
      • PaymentChannelClaim

    Index

    Properties

    Properties

    Account

    Account: string
    +

    Hierarchy

    • BaseTransaction
      • PaymentChannelClaim

    Index

    Properties

    Properties

    Account

    Account: string

    The unique address of the account that initiated the transaction.

    -

    Optional AccountTxnID

    AccountTxnID?: string
    +

    Optional AccountTxnID

    AccountTxnID?: string

    Hash value identifying another transaction. If provided, this transaction is only valid if the sending account's previously-sent transaction matches the provided hash.

    -

    Optional Amount

    Amount?: string
    +

    Optional Amount

    Amount?: string

    The amount of XRP, in drops, authorized by the Signature. This must match the amount in the signed message. This is the cumulative amount of XRP that can be dispensed by the channel, including XRP previously redeemed.

    -

    Optional Balance

    Balance?: string
    +

    Optional Balance

    Balance?: string

    Total amount of XRP, in drops, delivered by this channel after processing this claim. Required to deliver XRP. Must be more than the total amount delivered by the channel so far, but not greater than the Amount of the signed claim. Must be provided except when closing the channel.

    -

    Channel

    Channel: string
    +

    Channel

    Channel: string

    The unique ID of the channel as a 64-character hexadecimal string.

    -

    Optional Fee

    Fee?: string
    +

    Optional Fee

    Fee?: string

    Integer amount of XRP, in drops, to be destroyed as a cost for distributing this transaction to the network. Some transaction types have different minimum requirements.

    -

    Optional Flags

    Flags?: number | PaymentChannelClaimFlagsInterface

    Optional LastLedgerSequence

    LastLedgerSequence?: number
    +

    Optional Flags

    Flags?: number | PaymentChannelClaimFlagsInterface

    Optional LastLedgerSequence

    LastLedgerSequence?: number

    Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected.

    -

    Optional Memos

    Memos?: Memo[]
    +

    Optional Memos

    Memos?: Memo[]

    Additional arbitrary information used to identify this transaction.

    -

    Optional PublicKey

    PublicKey?: string
    +

    Optional PublicKey

    PublicKey?: string

    The public key used for the signature, as hexadecimal. This must match the PublicKey stored in the ledger for the channel. Required unless the sender of the transaction is the source address of the channel and the Signature field is omitted.

    -

    Optional Sequence

    Sequence?: number
    +

    Optional Sequence

    Sequence?: number

    The sequence number of the account sending the transaction. A transaction is only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account. The special case 0 means the transaction is using a Ticket instead.

    -

    Optional Signature

    Signature?: string
    +

    Optional Signature

    Signature?: string

    The signature of this claim, as hexadecimal. The signed message contains the channel ID and the amount of the claim. Required unless the sender of the transaction is the source address of the channel.

    -

    Optional Signers

    Signers?: Signer[]
    +

    Optional Signers

    Signers?: Signer[]

    Array of objects that represent a multi-signature which authorizes this transaction.

    -

    Optional SigningPubKey

    SigningPubKey?: string
    +

    Optional SigningPubKey

    SigningPubKey?: string

    Hex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in the Signers field instead.

    -

    Optional SourceTag

    SourceTag?: number
    +

    Optional SourceTag

    SourceTag?: number

    Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made. Conventionally, a refund should specify the initial payment's SourceTag as the refund payment's DestinationTag.

    -

    Optional TicketSequence

    TicketSequence?: number
    +

    Optional TicketSequence

    TicketSequence?: number

    The sequence number of the ticket to use in place of a Sequence number. If this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    -

    TransactionType

    TransactionType: "PaymentChannelClaim"

    Optional TxnSignature

    TxnSignature?: string
    +

    TransactionType

    TransactionType: "PaymentChannelClaim"

    Optional TxnSignature

    TxnSignature?: string

    The signature that verifies this transaction as originating from the account it says it is from.

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/PaymentChannelClaimFlagsInterface.html b/docs/interfaces/PaymentChannelClaimFlagsInterface.html index e62a3ca5..566126d9 100644 --- a/docs/interfaces/PaymentChannelClaimFlagsInterface.html +++ b/docs/interfaces/PaymentChannelClaimFlagsInterface.html @@ -3,7 +3,7 @@ transaction flags.

    example
    const paymentChannelClaim: PaymentChannelClaim = {
     Account: 'rMpxZpuy5RBSP47oK2hDWUtk3B5BNQHfGj,
     TransactionType: 'PaymentChannelClaim',
     Channel: hashes.hashPaymentChannel(
       'rMpxZpuy5RBSP47oK2hDWUtk3B5BNQHfGj',
       'rQGYqiyH5Ue9J96p4E6Qt6AvqxK4sDhnS5',
       21970712,
     ),
     Amount: '100',
     Flags: {
       tfClose: true
     }
    }

    // Autofill the tx to see how flags actually look compared to the interface usage.
    const autofilledTx = await client.autofill(paymentChannelClaim)
    console.log(autofilledTx)
    // {
    //  Account: 'rMpxZpuy5RBSP47oK2hDWUtk3B5BNQHfGj',
    //  TransactionType: 'PaymentChannelClaim',
    //  Channel: 'FC14BF9245D731DC1749EE0F070765E4EB4E993F8ECEE3D00F7E6E26D6EF98CF',
    //  Amount: '100',
    //  Flags: 131072,
    //  Sequence: 21970713,
    //  Fee: '12',
    //  LastLedgerSequence: 21970658
    // }
    -

    Hierarchy

    Index

    Properties

    Properties

    Optional tfClose

    tfClose?: boolean
    +

    Hierarchy

    • GlobalFlags
      • PaymentChannelClaimFlagsInterface

    Index

    Properties

    Properties

    Optional tfClose

    tfClose?: boolean

    Request to close the channel. Only the channel source and destination addresses can use this flag. This flag closes the channel immediately if it has no more XRP allocated to it after processing the current claim, or if @@ -15,7 +15,7 @@ SettleDelay time, unless the channel already has an earlier Expiration time.) If the destination address uses this flag when the channel still holds XRP, any XRP that remains after processing the claim is returned to the source address.

    -

    Optional tfRenew

    tfRenew?: boolean
    +

    Optional tfRenew

    tfRenew?: boolean

    Clear the channel's Expiration time. (Expiration is different from the channel's immutable CancelAfter time.) Only the source address of the payment channel can use this flag.

    diff --git a/docs/interfaces/PaymentChannelCreate.html b/docs/interfaces/PaymentChannelCreate.html index 6e45ecd2..e27bbd9c 100644 --- a/docs/interfaces/PaymentChannelCreate.html +++ b/docs/interfaces/PaymentChannelCreate.html @@ -1,69 +1,69 @@ PaymentChannelCreate | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface PaymentChannelCreate

    Create a unidirectional channel and fund it with XRP. The address sending this transaction becomes the "source address" of the payment channel.

    -

    Hierarchy

    • BaseTransaction
      • PaymentChannelCreate

    Index

    Properties

    Properties

    Account

    Account: string
    +

    Hierarchy

    • BaseTransaction
      • PaymentChannelCreate

    Index

    Properties

    Properties

    Account

    Account: string

    The unique address of the account that initiated the transaction.

    -

    Optional AccountTxnID

    AccountTxnID?: string
    +

    Optional AccountTxnID

    AccountTxnID?: string

    Hash value identifying another transaction. If provided, this transaction is only valid if the sending account's previously-sent transaction matches the provided hash.

    -

    Amount

    Amount: string
    +

    Amount

    Amount: string

    Amount of XRP, in drops, to deduct from the sender's balance and set aside in this channel. While the channel is open, the XRP can only go to the Destination address. When the channel closes, any unclaimed XRP is returned to the source address's balance.

    -

    Optional CancelAfter

    CancelAfter?: number
    +

    Optional CancelAfter

    CancelAfter?: number

    The time, in seconds since the Ripple Epoch, when this channel expires. Any transaction that would modify the channel after this time closes the channel without otherwise affecting it. This value is immutable; the channel can be closed earlier than this time but cannot remain open after this time.

    -

    Destination

    Destination: string
    +

    Destination

    Destination: string

    Address to receive XRP claims against this channel. This is also known as the "destination address" for the channel.

    -

    Optional DestinationTag

    DestinationTag?: number
    +

    Optional DestinationTag

    DestinationTag?: number

    Arbitrary tag to further specify the destination for this payment channel, such as a hosted recipient at the destination address.

    -

    Optional Fee

    Fee?: string
    +

    Optional Fee

    Fee?: string

    Integer amount of XRP, in drops, to be destroyed as a cost for distributing this transaction to the network. Some transaction types have different minimum requirements.

    -

    Optional Flags

    Flags?: number | GlobalFlags
    +

    Optional Flags

    Flags?: number | GlobalFlags

    Set of bit-flags for this transaction.

    -

    Optional LastLedgerSequence

    LastLedgerSequence?: number
    +

    Optional LastLedgerSequence

    LastLedgerSequence?: number

    Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected.

    -

    Optional Memos

    Memos?: Memo[]
    +

    Optional Memos

    Memos?: Memo[]

    Additional arbitrary information used to identify this transaction.

    -

    PublicKey

    PublicKey: string
    +

    PublicKey

    PublicKey: string

    The public key of the key pair the source will use to sign claims against this channel in hexadecimal. This can be any secp256k1 or ed25519 public key.

    -

    Optional Sequence

    Sequence?: number
    +

    Optional Sequence

    Sequence?: number

    The sequence number of the account sending the transaction. A transaction is only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account. The special case 0 means the transaction is using a Ticket instead.

    -

    SettleDelay

    SettleDelay: number
    +

    SettleDelay

    SettleDelay: number

    Amount of time the source address must wait before closing the channel if it has unclaimed XRP.

    -

    Optional Signers

    Signers?: Signer[]
    +

    Optional Signers

    Signers?: Signer[]

    Array of objects that represent a multi-signature which authorizes this transaction.

    -

    Optional SigningPubKey

    SigningPubKey?: string
    +

    Optional SigningPubKey

    SigningPubKey?: string

    Hex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in the Signers field instead.

    -

    Optional SourceTag

    SourceTag?: number
    +

    Optional SourceTag

    SourceTag?: number

    Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made. Conventionally, a refund should specify the initial payment's SourceTag as the refund payment's DestinationTag.

    -

    Optional TicketSequence

    TicketSequence?: number
    +

    Optional TicketSequence

    TicketSequence?: number

    The sequence number of the ticket to use in place of a Sequence number. If this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    -

    TransactionType

    TransactionType: "PaymentChannelCreate"

    Optional TxnSignature

    TxnSignature?: string
    +

    TransactionType

    TransactionType: "PaymentChannelCreate"

    Optional TxnSignature

    TxnSignature?: string

    The signature that verifies this transaction as originating from the account it says it is from.

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/PaymentChannelFund.html b/docs/interfaces/PaymentChannelFund.html index 5ba37337..f498f63c 100644 --- a/docs/interfaces/PaymentChannelFund.html +++ b/docs/interfaces/PaymentChannelFund.html @@ -2,19 +2,19 @@

    Add additional XRP to an open payment channel, and optionally update the expiration time of the channel. Only the source address of the channel can use this transaction.

    -

    Hierarchy

    • BaseTransaction
      • PaymentChannelFund

    Index

    Properties

    Properties

    Account

    Account: string
    +

    Hierarchy

    • BaseTransaction
      • PaymentChannelFund

    Index

    Properties

    Properties

    Account

    Account: string

    The unique address of the account that initiated the transaction.

    -

    Optional AccountTxnID

    AccountTxnID?: string
    +

    Optional AccountTxnID

    AccountTxnID?: string

    Hash value identifying another transaction. If provided, this transaction is only valid if the sending account's previously-sent transaction matches the provided hash.

    -

    Amount

    Amount: string
    +

    Amount

    Amount: string

    Amount of XRP in drops to add to the channel. Must be a positive amount of XRP.

    -

    Channel

    Channel: string
    +

    Channel

    Channel: string

    The unique ID of the channel to fund as a 64-character hexadecimal string.

    -

    Optional Expiration

    Expiration?: number
    +

    Optional Expiration

    Expiration?: number

    New Expiration time to set for the channel in seconds since the Ripple Epoch. This must be later than either the current time plus the SettleDelay of the channel, or the existing Expiration of the channel. After the @@ -23,39 +23,39 @@ channel without taking its normal action. Any unspent XRP is returned to the source address when the channel closes. (Expiration is separate from the channel's immutable CancelAfter time.) For more information, see the PayChannel ledger object type.

    -

    Optional Fee

    Fee?: string
    +

    Optional Fee

    Fee?: string

    Integer amount of XRP, in drops, to be destroyed as a cost for distributing this transaction to the network. Some transaction types have different minimum requirements.

    -

    Optional Flags

    Flags?: number | GlobalFlags
    +

    Optional Flags

    Flags?: number | GlobalFlags

    Set of bit-flags for this transaction.

    -

    Optional LastLedgerSequence

    LastLedgerSequence?: number
    +

    Optional LastLedgerSequence

    LastLedgerSequence?: number

    Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected.

    -

    Optional Memos

    Memos?: Memo[]
    +

    Optional Memos

    Memos?: Memo[]

    Additional arbitrary information used to identify this transaction.

    -

    Optional Sequence

    Sequence?: number
    +

    Optional Sequence

    Sequence?: number

    The sequence number of the account sending the transaction. A transaction is only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account. The special case 0 means the transaction is using a Ticket instead.

    -

    Optional Signers

    Signers?: Signer[]
    +

    Optional Signers

    Signers?: Signer[]

    Array of objects that represent a multi-signature which authorizes this transaction.

    -

    Optional SigningPubKey

    SigningPubKey?: string
    +

    Optional SigningPubKey

    SigningPubKey?: string

    Hex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in the Signers field instead.

    -

    Optional SourceTag

    SourceTag?: number
    +

    Optional SourceTag

    SourceTag?: number

    Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made. Conventionally, a refund should specify the initial payment's SourceTag as the refund payment's DestinationTag.

    -

    Optional TicketSequence

    TicketSequence?: number
    +

    Optional TicketSequence

    TicketSequence?: number

    The sequence number of the ticket to use in place of a Sequence number. If this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    -

    TransactionType

    TransactionType: "PaymentChannelFund"

    Optional TxnSignature

    TxnSignature?: string
    +

    TransactionType

    TransactionType: "PaymentChannelFund"

    Optional TxnSignature

    TxnSignature?: string

    The signature that verifies this transaction as originating from the account it says it is from.

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/PaymentFlagsInterface.html b/docs/interfaces/PaymentFlagsInterface.html index eb6cf793..2cd6b127 100644 --- a/docs/interfaces/PaymentFlagsInterface.html +++ b/docs/interfaces/PaymentFlagsInterface.html @@ -3,15 +3,15 @@ flags.

    example
    const partialPayment: Payment = {
     TransactionType: 'Payment',
     Account: 'rM9WCfJU6udpFkvKThRaFHDMsp7L8rpgN',
     Amount: {
       currency: 'FOO',
       value: '4000',
       issuer: 'rPzwM2JfCSDjhbesdTCqFjWWdK7eFtTwZz',
     },
     Destination: 'rPzwM2JfCSDjhbesdTCqFjWWdK7eFtTwZz',
     Flags: {
       tfPartialPayment: true
     }
    }

    // Autofill the tx to see how flags actually look compared to the interface usage.
    const autofilledTx = await client.autofill(partialPayment)
    console.log(autofilledTx)
    // {
    //  TransactionType: 'Payment',
    //  Account: 'rM9WCfJU6udpFkvKThRaFHDMsp7L8rpgN',
    //  Amount: {
    //   currency: 'FOO',
    //   value: '4000',
    //   issuer: 'rPzwM2JfCSDjhbesdTCqFjWWdK7eFtTwZz'
    //  },
    //  Destination: 'rPzwM2JfCSDjhbesdTCqFjWWdK7eFtTwZz',
    //  Flags: 131072,
    //  Sequence: 21970996,
    //  Fee: '12',
    //  LastLedgerSequence: 21971016
    // }
    -

    Hierarchy

    • GlobalFlags
      • PaymentFlagsInterface

    Index

    Properties

    Properties

    Optional tfLimitQuality

    tfLimitQuality?: boolean
    +

    Hierarchy

    • GlobalFlags
      • PaymentFlagsInterface

    Index

    Properties

    Properties

    Optional tfLimitQuality

    tfLimitQuality?: boolean

    Only take paths where all the conversions have an input:output ratio that is equal or better than the ratio of Amount:SendMax. See Limit Quality for details.

    -

    Optional tfNoDirectRipple

    tfNoDirectRipple?: boolean
    +

    Optional tfNoDirectRipple

    tfNoDirectRipple?: boolean

    Do not use the default path; only use paths included in the Paths field. This is intended to force the transaction to take arbitrage opportunities. Most clients do not need this.

    -

    Optional tfPartialPayment

    tfPartialPayment?: boolean
    +

    Optional tfPartialPayment

    tfPartialPayment?: boolean

    If the specified Amount cannot be sent without spending more than SendMax, reduce the received amount instead of failing outright. See Partial. Payments for more details.

    diff --git a/docs/interfaces/PeerStatusStream.html b/docs/interfaces/PeerStatusStream.html index c89bb2c6..2736a43d 100644 --- a/docs/interfaces/PeerStatusStream.html +++ b/docs/interfaces/PeerStatusStream.html @@ -2,17 +2,17 @@

    The admin-only peer_status stream reports a large amount of information on the activities of other rippled servers to which this server is connected, in particular their status in the consensus process.

    -

    Hierarchy

    • BaseStream
      • PeerStatusStream

    Index

    Properties

    Properties

    action

    action: "CLOSING_LEDGER" | "ACCEPTED_LEDGER" | "SWITCHED_LEDGER" | "LOST_SYNC"
    +

    Hierarchy

    • BaseStream
      • PeerStatusStream

    Index

    Properties

    Properties

    action

    action: "CLOSING_LEDGER" | "ACCEPTED_LEDGER" | "SWITCHED_LEDGER" | "LOST_SYNC"

    The type of event that prompted this message. See Peer Status Events for possible values.

    -

    date

    date: number
    +

    date

    date: number

    The time this event occurred, in seconds since the Ripple Epoch.

    -

    Optional ledger_hash

    ledger_hash?: string
    +

    Optional ledger_hash

    ledger_hash?: string

    The identifying Hash of a ledger version to which this message pertains.

    -

    Optional ledger_index

    ledger_index?: number
    +

    Optional ledger_index

    ledger_index?: number

    The Ledger Index of a ledger version to which this message pertains.

    -

    Optional ledger_index_max

    ledger_index_max?: number
    +

    Optional ledger_index_max

    ledger_index_max?: number

    The largest Ledger Index the peer has currently available.

    -

    Optional ledger_index_min

    ledger_index_min?: number
    +

    Optional ledger_index_min

    ledger_index_min?: number

    The smallest Ledger Index the peer has currently available.

    -

    type

    type: "peerStatusChange"

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    type

    type: "peerStatusChange"

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/PingRequest.html b/docs/interfaces/PingRequest.html index 0b2fbe1b..a2b47d5f 100644 --- a/docs/interfaces/PingRequest.html +++ b/docs/interfaces/PingRequest.html @@ -1,9 +1,9 @@ PingRequest | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface PingRequest

    The ping command returns an acknowledgement, so that clients can test the connection status and latency. Expects a response in the form of a PingResponse.

    -

    Hierarchy

    • BaseRequest
      • PingRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number
    +

    Hierarchy

    • BaseRequest
      • PingRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    The API version to use. If omitted, use version 1.

    -

    command

    command: "ping"

    Optional id

    id?: string | number
    +

    command

    command: "ping"

    Optional id

    id?: string | number

    A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

    diff --git a/docs/interfaces/PingResponse.html b/docs/interfaces/PingResponse.html index 3836784c..60e505fc 100644 --- a/docs/interfaces/PingResponse.html +++ b/docs/interfaces/PingResponse.html @@ -1,3 +1,3 @@ PingResponse | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface PingResponse

    Response expected from a PingRequest.

    -

    Hierarchy

    • BaseResponse
      • PingResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { role?: string; unlimited?: boolean }

    Type declaration

    • Optional role?: string
    • Optional unlimited?: boolean

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Hierarchy

    • BaseResponse
      • PingResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { role?: string; unlimited?: boolean }

    Type declaration

    • Optional role?: string
    • Optional unlimited?: boolean

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/RandomRequest.html b/docs/interfaces/RandomRequest.html index ca2bb840..1eef799b 100644 --- a/docs/interfaces/RandomRequest.html +++ b/docs/interfaces/RandomRequest.html @@ -2,9 +2,9 @@

    The random command provides a random number to be used as a source of entropy for random number generation by clients. Expects a response in the form of a RandomResponse.

    -

    Hierarchy

    • BaseRequest
      • RandomRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number
    +

    Hierarchy

    • BaseRequest
      • RandomRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    The API version to use. If omitted, use version 1.

    -

    command

    command: "random"

    Optional id

    id?: string | number
    +

    command

    command: "random"

    Optional id

    id?: string | number

    A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

    diff --git a/docs/interfaces/RandomResponse.html b/docs/interfaces/RandomResponse.html index d8b99ef4..b76c9d11 100644 --- a/docs/interfaces/RandomResponse.html +++ b/docs/interfaces/RandomResponse.html @@ -1,3 +1,3 @@ RandomResponse | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface RandomResponse

    Response expected from a RandomRequest.

    -

    Hierarchy

    • BaseResponse
      • RandomResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { random: string }

    Type declaration

    • random: string

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Hierarchy

    • BaseResponse
      • RandomResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { random: string }

    Type declaration

    • random: string

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/RipplePathFindRequest.html b/docs/interfaces/RipplePathFindRequest.html index 02e27b71..3c22c63d 100644 --- a/docs/interfaces/RipplePathFindRequest.html +++ b/docs/interfaces/RipplePathFindRequest.html @@ -2,28 +2,28 @@

    The ripple_path_find method is a simplified version of the path_find method that provides a single response with a payment path you can use right away. Expects a response in the form of a RipplePathFindResponse.

    -

    Hierarchy

    • BaseRequest
      • RipplePathFindRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number
    +

    Hierarchy

    • BaseRequest
      • RipplePathFindRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    The API version to use. If omitted, use version 1.

    -

    command

    command: "ripple_path_find"

    destination_account

    destination_account: string
    +

    command

    command: "ripple_path_find"

    destination_account

    destination_account: string

    Unique address of the account that would receive funds in a transaction.

    -

    destination_amount

    destination_amount: Amount
    +

    destination_amount

    destination_amount: Amount

    Currency Amount that the destination account would receive in a transaction.

    -

    Optional id

    id?: string | number
    +

    Optional id

    id?: string | number

    A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

    -

    Optional ledger_hash

    ledger_hash?: string
    +

    Optional ledger_hash

    ledger_hash?: string

    A 20-byte hex string for the ledger version to use.

    -

    Optional ledger_index

    ledger_index?: LedgerIndex
    +

    Optional ledger_index

    ledger_index?: LedgerIndex

    The ledger index of the ledger to use, or a shortcut string to choose a ledger automatically.

    -

    Optional send_max

    send_max?: Amount
    +

    Optional send_max

    send_max?: Amount

    Currency Amount that would be spent in the transaction. Cannot be used with source_currencies.

    -

    source_account

    source_account: string
    +

    source_account

    source_account: string

    Unique address of the account that would send funds in a transaction.

    -

    Optional source_currencies

    source_currencies?: SourceCurrencyAmount
    +

    Optional source_currencies

    source_currencies?: SourceCurrencyAmount

    Array of currencies that the source account might want to spend. Each entry in the array should be a JSON object with a mandatory currency field and optional issuer field, like how currency amounts are specified.

    diff --git a/docs/interfaces/RipplePathFindResponse.html b/docs/interfaces/RipplePathFindResponse.html index 7acbe5ee..7309ef57 100644 --- a/docs/interfaces/RipplePathFindResponse.html +++ b/docs/interfaces/RipplePathFindResponse.html @@ -1,6 +1,6 @@ RipplePathFindResponse | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface RipplePathFindResponse

    Response expected from a RipplePathFindRequest.

    -

    Hierarchy

    • BaseResponse
      • RipplePathFindResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { alternatives: PathOption[]; destination_account: string; destination_amount: Amount; destination_currencies: string[]; full_reply?: boolean; id?: string | number; ledger_current_index?: number; source_account: string; validated: boolean }

    Type declaration

    • alternatives: PathOption[]
      +

    Hierarchy

    • BaseResponse
      • RipplePathFindResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { alternatives: PathOption[]; destination_account: string; destination_amount: Amount; destination_currencies: string[]; full_reply?: boolean; id?: string | number; ledger_current_index?: number; source_account: string; validated: boolean }

    Type declaration

    • alternatives: PathOption[]

      Array of objects with possible paths to take, as described below. If empty, then there are no paths connecting the source and destination accounts.

      @@ -10,4 +10,4 @@ accounts.

      Array of strings representing the currencies that the destination accepts, as 3-letter codes like "USD" or as 40-character hex like "015841551A748AD2C1F76FF6ECB0CCCD00000000".

      -
    • Optional full_reply?: boolean
    • Optional id?: string | number
    • Optional ledger_current_index?: number
    • source_account: string
    • validated: boolean

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +
  • Optional full_reply?: boolean
  • Optional id?: string | number
  • Optional ledger_current_index?: number
  • source_account: string
  • validated: boolean

    • Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/ServerInfoRequest.html b/docs/interfaces/ServerInfoRequest.html index 501c620a..e2c9e8ee 100644 --- a/docs/interfaces/ServerInfoRequest.html +++ b/docs/interfaces/ServerInfoRequest.html @@ -2,9 +2,9 @@

    The server_info command asks the server for a human-readable version of various information about the rippled server being queried. Expects a response in the form of a ServerInfoResponse.

    -

    Hierarchy

    • BaseRequest
      • ServerInfoRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number
    +

    Hierarchy

    • BaseRequest
      • ServerInfoRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    The API version to use. If omitted, use version 1.

    -

    command

    command: "server_info"

    Optional id

    id?: string | number
    +

    command

    command: "server_info"

    Optional id

    id?: string | number

    A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

    diff --git a/docs/interfaces/ServerInfoResponse.html b/docs/interfaces/ServerInfoResponse.html index f6ff1d45..74a844bb 100644 --- a/docs/interfaces/ServerInfoResponse.html +++ b/docs/interfaces/ServerInfoResponse.html @@ -1,6 +1,6 @@ ServerInfoResponse | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ServerInfoResponse

    Response expected from a ServerInfoRequest.

    -

    Hierarchy

    • BaseResponse
      • ServerInfoResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { info: { amendment_blocked?: boolean; build_version: string; closed_ledger?: { age: number; base_fee_xrp: number; hash: string; reserve_base_xrp: number; reserve_inc_xrp: number; seq: number }; complete_ledgers: string; hostid: string; io_latency_ms: number; jq_trans_overflow: string; last_close: { converge_time_s: number; proposers: number }; load?: { job_types: JobType[]; threads: number }; load_factor?: number; load_factor_cluster?: number; load_factor_fee_escalation?: number; load_factor_fee_queue?: number; load_factor_local?: number; load_factor_net?: number; load_factor_server?: number; network_ledger?: "waiting"; peers: number; pubkey_node: string; pubkey_validator?: string; server_state: ServerState; server_state_duration_us: number; state_accounting: Record<ServerState, StateAccounting>; time: string; uptime: number; validated_ledger?: { age: number; base_fee_xrp: number; hash: string; reserve_base_xrp: number; reserve_inc_xrp: number; seq: number }; validation_quorum: number; validator_list_expires?: string } }

    Type declaration

    • info: { amendment_blocked?: boolean; build_version: string; closed_ledger?: { age: number; base_fee_xrp: number; hash: string; reserve_base_xrp: number; reserve_inc_xrp: number; seq: number }; complete_ledgers: string; hostid: string; io_latency_ms: number; jq_trans_overflow: string; last_close: { converge_time_s: number; proposers: number }; load?: { job_types: JobType[]; threads: number }; load_factor?: number; load_factor_cluster?: number; load_factor_fee_escalation?: number; load_factor_fee_queue?: number; load_factor_local?: number; load_factor_net?: number; load_factor_server?: number; network_ledger?: "waiting"; peers: number; pubkey_node: string; pubkey_validator?: string; server_state: ServerState; server_state_duration_us: number; state_accounting: Record<ServerState, StateAccounting>; time: string; uptime: number; validated_ledger?: { age: number; base_fee_xrp: number; hash: string; reserve_base_xrp: number; reserve_inc_xrp: number; seq: number }; validation_quorum: number; validator_list_expires?: string }
      • Optional amendment_blocked?: boolean
        +

    Hierarchy

    • BaseResponse
      • ServerInfoResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { info: { amendment_blocked?: boolean; build_version: string; closed_ledger?: { age: number; base_fee_xrp: number; hash: string; reserve_base_xrp: number; reserve_inc_xrp: number; seq: number }; complete_ledgers: string; hostid: string; io_latency_ms: number; jq_trans_overflow: string; last_close: { converge_time_s: number; proposers: number }; load?: { job_types: JobType[]; threads: number }; load_factor?: number; load_factor_cluster?: number; load_factor_fee_escalation?: number; load_factor_fee_queue?: number; load_factor_local?: number; load_factor_net?: number; load_factor_server?: number; network_ledger?: "waiting"; peers: number; pubkey_node: string; pubkey_validator?: string; server_state: ServerState; server_state_duration_us: number; state_accounting: Record<ServerState, StateAccounting>; time: string; uptime: number; validated_ledger?: { age: number; base_fee_xrp: number; hash: string; reserve_base_xrp: number; reserve_inc_xrp: number; seq: number }; validation_quorum: number; validator_list_expires?: string } }

    Type declaration

    • info: { amendment_blocked?: boolean; build_version: string; closed_ledger?: { age: number; base_fee_xrp: number; hash: string; reserve_base_xrp: number; reserve_inc_xrp: number; seq: number }; complete_ledgers: string; hostid: string; io_latency_ms: number; jq_trans_overflow: string; last_close: { converge_time_s: number; proposers: number }; load?: { job_types: JobType[]; threads: number }; load_factor?: number; load_factor_cluster?: number; load_factor_fee_escalation?: number; load_factor_fee_queue?: number; load_factor_local?: number; load_factor_net?: number; load_factor_server?: number; network_ledger?: "waiting"; peers: number; pubkey_node: string; pubkey_validator?: string; server_state: ServerState; server_state_duration_us: number; state_accounting: Record<ServerState, StateAccounting>; time: string; uptime: number; validated_ledger?: { age: number; base_fee_xrp: number; hash: string; reserve_base_xrp: number; reserve_inc_xrp: number; seq: number }; validation_quorum: number; validator_list_expires?: string }
      • Optional amendment_blocked?: boolean

        If true, this server is amendment blocked. If the server is not amendment blocked, the response omits this field.

      • build_version: string
        @@ -121,4 +121,4 @@ validations.

        list will expire, the string unknown if the server has yet to load a published validator list or the string never if the server uses a static validator list.

        -

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/ServerStateRequest.html b/docs/interfaces/ServerStateRequest.html index 9baa6645..23cecfa9 100644 --- a/docs/interfaces/ServerStateRequest.html +++ b/docs/interfaces/ServerStateRequest.html @@ -3,9 +3,9 @@ information about the rippled server's current state. The response is almost the same as the server_info method, but uses units that are easier to process instead of easier to read.

    -

    Hierarchy

    • BaseRequest
      • ServerStateRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number
    +

    Hierarchy

    • BaseRequest
      • ServerStateRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    The API version to use. If omitted, use version 1.

    -

    command

    command: "server_state"

    Optional id

    id?: string | number
    +

    command

    command: "server_state"

    Optional id

    id?: string | number

    A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

    diff --git a/docs/interfaces/ServerStateResponse.html b/docs/interfaces/ServerStateResponse.html index ba4a09c0..7f0452f7 100644 --- a/docs/interfaces/ServerStateResponse.html +++ b/docs/interfaces/ServerStateResponse.html @@ -1,3 +1,3 @@ ServerStateResponse | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ServerStateResponse

    Response expected from a ServerStateRequest.

    -

    Hierarchy

    • BaseResponse
      • ServerStateResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { state: { amendment_blocked?: boolean; build_version: string; closed_ledger?: { age: number; base_fee: number; hash: string; reserve_base: number; reserve_inc: number; seq: number }; complete_ledgers: string; io_latency_ms: number; jq_trans_overflow: string; last_close: { converge_time_s: number; proposers: number }; load?: { job_types: JobType[]; threads: number }; load_base: number; load_factor: number; load_factor_fee_escalation?: number; load_factor_fee_queue?: number; load_factor_fee_reference?: number; load_factor_server?: number; peers: number; pubkey_node: string; pubkey_validator?: string; server_state: ServerState; server_state_duration_us: number; state_accounting: Record<ServerState, StateAccounting>; time: string; uptime: number; validated_ledger?: { age: number; base_fee: number; hash: string; reserve_base: number; reserve_inc: number; seq: number }; validation_quorum: number; validator_list_expires?: string } }

    Type declaration

    • state: { amendment_blocked?: boolean; build_version: string; closed_ledger?: { age: number; base_fee: number; hash: string; reserve_base: number; reserve_inc: number; seq: number }; complete_ledgers: string; io_latency_ms: number; jq_trans_overflow: string; last_close: { converge_time_s: number; proposers: number }; load?: { job_types: JobType[]; threads: number }; load_base: number; load_factor: number; load_factor_fee_escalation?: number; load_factor_fee_queue?: number; load_factor_fee_reference?: number; load_factor_server?: number; peers: number; pubkey_node: string; pubkey_validator?: string; server_state: ServerState; server_state_duration_us: number; state_accounting: Record<ServerState, StateAccounting>; time: string; uptime: number; validated_ledger?: { age: number; base_fee: number; hash: string; reserve_base: number; reserve_inc: number; seq: number }; validation_quorum: number; validator_list_expires?: string }
      • Optional amendment_blocked?: boolean
      • build_version: string
      • Optional closed_ledger?: { age: number; base_fee: number; hash: string; reserve_base: number; reserve_inc: number; seq: number }
        • age: number
        • base_fee: number
        • hash: string
        • reserve_base: number
        • reserve_inc: number
        • seq: number
      • complete_ledgers: string
      • io_latency_ms: number
      • jq_trans_overflow: string
      • last_close: { converge_time_s: number; proposers: number }
        • converge_time_s: number
        • proposers: number
      • Optional load?: { job_types: JobType[]; threads: number }
        • job_types: JobType[]
        • threads: number
      • load_base: number
      • load_factor: number
      • Optional load_factor_fee_escalation?: number
      • Optional load_factor_fee_queue?: number
      • Optional load_factor_fee_reference?: number
      • Optional load_factor_server?: number
      • peers: number
      • pubkey_node: string
      • Optional pubkey_validator?: string
      • server_state: ServerState
      • server_state_duration_us: number
      • state_accounting: Record<ServerState, StateAccounting>
      • time: string
      • uptime: number
      • Optional validated_ledger?: { age: number; base_fee: number; hash: string; reserve_base: number; reserve_inc: number; seq: number }
        • age: number
        • base_fee: number
        • hash: string
        • reserve_base: number
        • reserve_inc: number
        • seq: number
      • validation_quorum: number
      • Optional validator_list_expires?: string

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Hierarchy

    • BaseResponse
      • ServerStateResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { state: { amendment_blocked?: boolean; build_version: string; closed_ledger?: { age: number; base_fee: number; hash: string; reserve_base: number; reserve_inc: number; seq: number }; complete_ledgers: string; io_latency_ms: number; jq_trans_overflow: string; last_close: { converge_time_s: number; proposers: number }; load?: { job_types: JobType[]; threads: number }; load_base: number; load_factor: number; load_factor_fee_escalation?: number; load_factor_fee_queue?: number; load_factor_fee_reference?: number; load_factor_server?: number; peers: number; pubkey_node: string; pubkey_validator?: string; server_state: ServerState; server_state_duration_us: number; state_accounting: Record<ServerState, StateAccounting>; time: string; uptime: number; validated_ledger?: { age: number; base_fee: number; hash: string; reserve_base: number; reserve_inc: number; seq: number }; validation_quorum: number; validator_list_expires?: string } }

    Type declaration

    • state: { amendment_blocked?: boolean; build_version: string; closed_ledger?: { age: number; base_fee: number; hash: string; reserve_base: number; reserve_inc: number; seq: number }; complete_ledgers: string; io_latency_ms: number; jq_trans_overflow: string; last_close: { converge_time_s: number; proposers: number }; load?: { job_types: JobType[]; threads: number }; load_base: number; load_factor: number; load_factor_fee_escalation?: number; load_factor_fee_queue?: number; load_factor_fee_reference?: number; load_factor_server?: number; peers: number; pubkey_node: string; pubkey_validator?: string; server_state: ServerState; server_state_duration_us: number; state_accounting: Record<ServerState, StateAccounting>; time: string; uptime: number; validated_ledger?: { age: number; base_fee: number; hash: string; reserve_base: number; reserve_inc: number; seq: number }; validation_quorum: number; validator_list_expires?: string }
      • Optional amendment_blocked?: boolean
      • build_version: string
      • Optional closed_ledger?: { age: number; base_fee: number; hash: string; reserve_base: number; reserve_inc: number; seq: number }
        • age: number
        • base_fee: number
        • hash: string
        • reserve_base: number
        • reserve_inc: number
        • seq: number
      • complete_ledgers: string
      • io_latency_ms: number
      • jq_trans_overflow: string
      • last_close: { converge_time_s: number; proposers: number }
        • converge_time_s: number
        • proposers: number
      • Optional load?: { job_types: JobType[]; threads: number }
        • job_types: JobType[]
        • threads: number
      • load_base: number
      • load_factor: number
      • Optional load_factor_fee_escalation?: number
      • Optional load_factor_fee_queue?: number
      • Optional load_factor_fee_reference?: number
      • Optional load_factor_server?: number
      • peers: number
      • pubkey_node: string
      • Optional pubkey_validator?: string
      • server_state: ServerState
      • server_state_duration_us: number
      • state_accounting: Record<ServerState, StateAccounting>
      • time: string
      • uptime: number
      • Optional validated_ledger?: { age: number; base_fee: number; hash: string; reserve_base: number; reserve_inc: number; seq: number }
        • age: number
        • base_fee: number
        • hash: string
        • reserve_base: number
        • reserve_inc: number
        • seq: number
      • validation_quorum: number
      • Optional validator_list_expires?: string

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/SetRegularKey.html b/docs/interfaces/SetRegularKey.html index 057f173a..b722b173 100644 --- a/docs/interfaces/SetRegularKey.html +++ b/docs/interfaces/SetRegularKey.html @@ -1,49 +1,49 @@ SetRegularKey | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface SetRegularKey

    A SetRegularKey transaction assigns, changes, or removes the regular key pair associated with an account.

    -

    Hierarchy

    • BaseTransaction
      • SetRegularKey

    Index

    Properties

    Properties

    Account

    Account: string
    +

    Hierarchy

    • BaseTransaction
      • SetRegularKey

    Index

    Properties

    Properties

    Account

    Account: string

    The unique address of the account that initiated the transaction.

    -

    Optional AccountTxnID

    AccountTxnID?: string
    +

    Optional AccountTxnID

    AccountTxnID?: string

    Hash value identifying another transaction. If provided, this transaction is only valid if the sending account's previously-sent transaction matches the provided hash.

    -

    Optional Fee

    Fee?: string
    +

    Optional Fee

    Fee?: string

    Integer amount of XRP, in drops, to be destroyed as a cost for distributing this transaction to the network. Some transaction types have different minimum requirements.

    -

    Optional Flags

    Flags?: number | GlobalFlags
    +

    Optional Flags

    Flags?: number | GlobalFlags

    Set of bit-flags for this transaction.

    -

    Optional LastLedgerSequence

    LastLedgerSequence?: number
    +

    Optional LastLedgerSequence

    LastLedgerSequence?: number

    Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected.

    -

    Optional Memos

    Memos?: Memo[]
    +

    Optional Memos

    Memos?: Memo[]

    Additional arbitrary information used to identify this transaction.

    -

    Optional RegularKey

    RegularKey?: string
    +

    Optional RegularKey

    RegularKey?: string

    A base-58-encoded Address that indicates the regular key pair to be assigned to the account. If omitted, removes any existing regular key pair. from the account. Must not match the master key pair for the address.

    -

    Optional Sequence

    Sequence?: number
    +

    Optional Sequence

    Sequence?: number

    The sequence number of the account sending the transaction. A transaction is only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account. The special case 0 means the transaction is using a Ticket instead.

    -

    Optional Signers

    Signers?: Signer[]
    +

    Optional Signers

    Signers?: Signer[]

    Array of objects that represent a multi-signature which authorizes this transaction.

    -

    Optional SigningPubKey

    SigningPubKey?: string
    +

    Optional SigningPubKey

    SigningPubKey?: string

    Hex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in the Signers field instead.

    -

    Optional SourceTag

    SourceTag?: number
    +

    Optional SourceTag

    SourceTag?: number

    Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made. Conventionally, a refund should specify the initial payment's SourceTag as the refund payment's DestinationTag.

    -

    Optional TicketSequence

    TicketSequence?: number
    +

    Optional TicketSequence

    TicketSequence?: number

    The sequence number of the ticket to use in place of a Sequence number. If this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    -

    TransactionType

    TransactionType: "SetRegularKey"

    Optional TxnSignature

    TxnSignature?: string
    +

    TransactionType

    TransactionType: "SetRegularKey"

    Optional TxnSignature

    TxnSignature?: string

    The signature that verifies this transaction as originating from the account it says it is from.

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/SignerListSet.html b/docs/interfaces/SignerListSet.html index 3c80cbcd..72547ce0 100644 --- a/docs/interfaces/SignerListSet.html +++ b/docs/interfaces/SignerListSet.html @@ -1,54 +1,54 @@ SignerListSet | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface SignerListSet

    The SignerListSet transaction creates, replaces, or removes a list of signers that can be used to multi-sign a transaction.

    -

    Hierarchy

    • BaseTransaction
      • SignerListSet

    Index

    Properties

    Properties

    Account

    Account: string
    +

    Hierarchy

    • BaseTransaction
      • SignerListSet

    Index

    Properties

    Properties

    Account

    Account: string

    The unique address of the account that initiated the transaction.

    -

    Optional AccountTxnID

    AccountTxnID?: string
    +

    Optional AccountTxnID

    AccountTxnID?: string

    Hash value identifying another transaction. If provided, this transaction is only valid if the sending account's previously-sent transaction matches the provided hash.

    -

    Optional Fee

    Fee?: string
    +

    Optional Fee

    Fee?: string

    Integer amount of XRP, in drops, to be destroyed as a cost for distributing this transaction to the network. Some transaction types have different minimum requirements.

    -

    Optional Flags

    Flags?: number | GlobalFlags
    +

    Optional Flags

    Flags?: number | GlobalFlags

    Set of bit-flags for this transaction.

    -

    Optional LastLedgerSequence

    LastLedgerSequence?: number
    +

    Optional LastLedgerSequence

    LastLedgerSequence?: number

    Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected.

    -

    Optional Memos

    Memos?: Memo[]
    +

    Optional Memos

    Memos?: Memo[]

    Additional arbitrary information used to identify this transaction.

    -

    Optional Sequence

    Sequence?: number
    +

    Optional Sequence

    Sequence?: number

    The sequence number of the account sending the transaction. A transaction is only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account. The special case 0 means the transaction is using a Ticket instead.

    -

    SignerEntries

    SignerEntries: SignerEntry[]
    +

    SignerEntries

    SignerEntries: SignerEntry[]

    Array of SignerEntry objects, indicating the addresses and weights of signers in this list. This signer list must have at least 1 member and no more than 8 members. No address may appear more than once in the list, nor may the Account submitting the transaction appear in the list.

    -

    SignerQuorum

    SignerQuorum: number
    +

    SignerQuorum

    SignerQuorum: number

    A target number for the signer weights. A multi-signature from this list is valid only if the sum weights of the signatures provided is greater than or equal to this value. To delete a signer list, use the value 0.

    -

    Optional Signers

    Signers?: Signer[]
    +

    Optional Signers

    Signers?: Signer[]

    Array of objects that represent a multi-signature which authorizes this transaction.

    -

    Optional SigningPubKey

    SigningPubKey?: string
    +

    Optional SigningPubKey

    SigningPubKey?: string

    Hex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in the Signers field instead.

    -

    Optional SourceTag

    SourceTag?: number
    +

    Optional SourceTag

    SourceTag?: number

    Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made. Conventionally, a refund should specify the initial payment's SourceTag as the refund payment's DestinationTag.

    -

    Optional TicketSequence

    TicketSequence?: number
    +

    Optional TicketSequence

    TicketSequence?: number

    The sequence number of the ticket to use in place of a Sequence number. If this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    -

    TransactionType

    TransactionType: "SignerListSet"

    Optional TxnSignature

    TxnSignature?: string
    +

    TransactionType

    TransactionType: "SignerListSet"

    Optional TxnSignature

    TxnSignature?: string

    The signature that verifies this transaction as originating from the account it says it is from.

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/SubmitMultisignedRequest.html b/docs/interfaces/SubmitMultisignedRequest.html index 745d2b1c..b68924d6 100644 --- a/docs/interfaces/SubmitMultisignedRequest.html +++ b/docs/interfaces/SubmitMultisignedRequest.html @@ -2,16 +2,16 @@

    The submit_multisigned command applies a multi-signed transaction and sends it to the network to be included in future ledgers. Expects a response in the form of a SubmitMultisignedRequest.

    -

    Hierarchy

    • BaseRequest
      • SubmitMultisignedRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number
    +

    Hierarchy

    • BaseRequest
      • SubmitMultisignedRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    The API version to use. If omitted, use version 1.

    -

    command

    command: "submit_multisigned"

    Optional fail_hard

    fail_hard?: boolean
    +

    command

    command: "submit_multisigned"

    Optional fail_hard

    fail_hard?: boolean

    If true, and the transaction fails locally, do not retry or relay the transaction to other servers.

    -

    Optional id

    id?: string | number
    +

    Optional id

    id?: string | number

    A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

    -

    tx_json

    tx_json: Transaction
    +

    tx_json

    tx_json: Transaction

    Transaction in JSON format with an array of Signers. To be successful, the weights of the signatures must be equal or higher than the quorum of the. SignerList.

    diff --git a/docs/interfaces/SubmitMultisignedResponse.html b/docs/interfaces/SubmitMultisignedResponse.html index 9ef03761..00dbbb42 100644 --- a/docs/interfaces/SubmitMultisignedResponse.html +++ b/docs/interfaces/SubmitMultisignedResponse.html @@ -1,6 +1,6 @@ SubmitMultisignedResponse | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface SubmitMultisignedResponse

    Response expected from a SubmitMultisignedRequest.

    -

    Hierarchy

    • BaseResponse
      • SubmitMultisignedResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { engine_result: string; engine_result_code: number; engine_result_message: string; tx_blob: string; tx_json: (AccountDelete & { hash?: string }) & (AccountSet & { hash?: string }) & (CheckCancel & { hash?: string }) & (CheckCash & { hash?: string }) & (CheckCreate & { hash?: string }) & (DepositPreauth & { hash?: string }) & (EscrowCancel & { hash?: string }) & (EscrowCreate & { hash?: string }) & (EscrowFinish & { hash?: string }) & (NFTokenAcceptOffer & { hash?: string }) & (NFTokenBurn & { hash?: string }) & (NFTokenCancelOffer & { hash?: string }) & (NFTokenCreateOffer & { hash?: string }) & (NFTokenMint & { hash?: string }) & (OfferCancel & { hash?: string }) & (OfferCreate & { hash?: string }) & (Payment & { hash?: string }) & (PaymentChannelClaim & { hash?: string }) & (PaymentChannelCreate & { hash?: string }) & (PaymentChannelFund & { hash?: string }) & (SetRegularKey & { hash?: string }) & (SignerListSet & { hash?: string }) & (TicketCreate & { hash?: string }) & (TrustSet & { hash?: string }) }

    Type declaration

    • engine_result: string
      +

    Hierarchy

    • BaseResponse
      • SubmitMultisignedResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { engine_result: string; engine_result_code: number; engine_result_message: string; tx_blob: string; tx_json: (AccountDelete & { hash?: string }) & (AccountSet & { hash?: string }) & (CheckCancel & { hash?: string }) & (CheckCash & { hash?: string }) & (CheckCreate & { hash?: string }) & (DepositPreauth & { hash?: string }) & (EscrowCancel & { hash?: string }) & (EscrowCreate & { hash?: string }) & (EscrowFinish & { hash?: string }) & (NFTokenAcceptOffer & { hash?: string }) & (NFTokenBurn & { hash?: string }) & (NFTokenCancelOffer & { hash?: string }) & (NFTokenCreateOffer & { hash?: string }) & (NFTokenMint & { hash?: string }) & (OfferCancel & { hash?: string }) & (OfferCreate & { hash?: string }) & (Payment & { hash?: string }) & (PaymentChannelClaim & { hash?: string }) & (PaymentChannelCreate & { hash?: string }) & (PaymentChannelFund & { hash?: string }) & (SetRegularKey & { hash?: string }) & (SignerListSet & { hash?: string }) & (TicketCreate & { hash?: string }) & (TrustSet & { hash?: string }) }

    Type declaration

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/SubmitRequest.html b/docs/interfaces/SubmitRequest.html index 5dbc59cc..3638f38c 100644 --- a/docs/interfaces/SubmitRequest.html +++ b/docs/interfaces/SubmitRequest.html @@ -2,15 +2,15 @@

    The submit method applies a transaction and sends it to the network to be confirmed and included in future ledgers. Expects a response in the form of a SubmitResponse.

    -

    Hierarchy

    • BaseRequest
      • SubmitRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number
    +

    Hierarchy

    • BaseRequest
      • SubmitRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    The API version to use. If omitted, use version 1.

    -

    command

    command: "submit"

    Optional fail_hard

    fail_hard?: boolean
    +

    command

    command: "submit"

    Optional fail_hard

    fail_hard?: boolean

    If true, and the transaction fails locally, do not retry or relay the transaction to other servers. The default is false.

    -

    Optional id

    id?: string | number
    +

    Optional id

    id?: string | number

    A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

    -

    tx_blob

    tx_blob: string
    +

    tx_blob

    tx_blob: string

    The complete transaction in hex string format.

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/SubmitResponse.html b/docs/interfaces/SubmitResponse.html index cb005d62..aa4f7ce5 100644 --- a/docs/interfaces/SubmitResponse.html +++ b/docs/interfaces/SubmitResponse.html @@ -1,6 +1,6 @@ SubmitResponse | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface SubmitResponse

    Response expected from a SubmitRequest.

    -

    Hierarchy

    • BaseResponse
      • SubmitResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { accepted: boolean; account_sequence_available: number; account_sequence_next: number; applied: boolean; broadcast: boolean; engine_result: string; engine_result_code: number; engine_result_message: string; kept: boolean; open_ledger_cost: string; queued: boolean; tx_blob: string; tx_json: (AccountDelete & { hash?: string }) & (AccountSet & { hash?: string }) & (CheckCancel & { hash?: string }) & (CheckCash & { hash?: string }) & (CheckCreate & { hash?: string }) & (DepositPreauth & { hash?: string }) & (EscrowCancel & { hash?: string }) & (EscrowCreate & { hash?: string }) & (EscrowFinish & { hash?: string }) & (NFTokenAcceptOffer & { hash?: string }) & (NFTokenBurn & { hash?: string }) & (NFTokenCancelOffer & { hash?: string }) & (NFTokenCreateOffer & { hash?: string }) & (NFTokenMint & { hash?: string }) & (OfferCancel & { hash?: string }) & (OfferCreate & { hash?: string }) & (Payment & { hash?: string }) & (PaymentChannelClaim & { hash?: string }) & (PaymentChannelCreate & { hash?: string }) & (PaymentChannelFund & { hash?: string }) & (SetRegularKey & { hash?: string }) & (SignerListSet & { hash?: string }) & (TicketCreate & { hash?: string }) & (TrustSet & { hash?: string }); validated_ledger_index: number }

    Type declaration

    • accepted: boolean
      +

    Hierarchy

    • BaseResponse
      • SubmitResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { accepted: boolean; account_sequence_available: number; account_sequence_next: number; applied: boolean; broadcast: boolean; engine_result: string; engine_result_code: number; engine_result_message: string; kept: boolean; open_ledger_cost: string; queued: boolean; tx_blob: string; tx_json: (AccountDelete & { hash?: string }) & (AccountSet & { hash?: string }) & (CheckCancel & { hash?: string }) & (CheckCash & { hash?: string }) & (CheckCreate & { hash?: string }) & (DepositPreauth & { hash?: string }) & (EscrowCancel & { hash?: string }) & (EscrowCreate & { hash?: string }) & (EscrowFinish & { hash?: string }) & (NFTokenAcceptOffer & { hash?: string }) & (NFTokenBurn & { hash?: string }) & (NFTokenCancelOffer & { hash?: string }) & (NFTokenCreateOffer & { hash?: string }) & (NFTokenMint & { hash?: string }) & (OfferCancel & { hash?: string }) & (OfferCreate & { hash?: string }) & (Payment & { hash?: string }) & (PaymentChannelClaim & { hash?: string }) & (PaymentChannelCreate & { hash?: string }) & (PaymentChannelFund & { hash?: string }) & (SetRegularKey & { hash?: string }) & (SignerListSet & { hash?: string }) & (TicketCreate & { hash?: string }) & (TrustSet & { hash?: string }); validated_ledger_index: number }

    Type declaration

    • accepted: boolean

      The value true indicates that the transaction was applied, queued, broadcast, or kept for later. The value false indicates that none of those happened, so the transaction cannot possibly succeed as long as you @@ -43,4 +43,4 @@ version.

      The ledger index of the newest validated ledger at the time of submission. This provides a lower bound on the ledger versions that the transaction can appear in as a result of this request.

      -

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/SubscribeRequest.html b/docs/interfaces/SubscribeRequest.html index 98c428d2..e1d591dc 100644 --- a/docs/interfaces/SubscribeRequest.html +++ b/docs/interfaces/SubscribeRequest.html @@ -2,29 +2,29 @@

    The subscribe method requests periodic notifications from the server when certain events happen. Expects a response in the form of a. SubscribeResponse.

    -

    Hierarchy

    • BaseRequest
      • SubscribeRequest

    Index

    Properties

    Properties

    Optional accounts

    accounts?: string[]
    +

    Hierarchy

    • BaseRequest
      • SubscribeRequest

    Index

    Properties

    Properties

    Optional accounts

    accounts?: string[]

    Array with the unique addresses of accounts to monitor for validated transactions. The addresses must be in the XRP Ledger's base58 format. The server sends a notification for any transaction that affects at least one of these accounts.

    -

    Optional accounts_proposed

    accounts_proposed?: string[]
    +

    Optional accounts_proposed

    accounts_proposed?: string[]

    Like accounts, but include transactions that are not yet finalized.

    -

    Optional api_version

    api_version?: number
    +

    Optional api_version

    api_version?: number

    The API version to use. If omitted, use version 1.

    -

    Optional books

    books?: Book[]
    +

    Optional books

    books?: Book[]

    Array of objects defining order books to monitor for updates, as detailed Below.

    -

    command

    command: "subscribe"

    Optional id

    id?: string | number
    +

    command

    command: "subscribe"

    Optional id

    id?: string | number

    A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

    -

    Optional streams

    streams?: StreamType[]
    +

    Optional streams

    streams?: StreamType[]

    Array of string names of generic streams to subscribe to.

    -

    Optional url

    url?: string
    +

    Optional url

    url?: string

    URL where the server sends a JSON-RPC callbacks for each event. Admin-only.

    -

    Optional url_password

    url_password?: string
    +

    Optional url_password

    url_password?: string

    Password to provide for basic authentication at the callback URL.

    -

    Optional url_username

    url_username?: string
    +

    Optional url_username

    url_username?: string

    Username to provide for basic authentication at the callback URL.

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/SubscribeResponse.html b/docs/interfaces/SubscribeResponse.html index 2c0a7989..6a7f60c9 100644 --- a/docs/interfaces/SubscribeResponse.html +++ b/docs/interfaces/SubscribeResponse.html @@ -1,3 +1,3 @@ SubscribeResponse | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface SubscribeResponse

    Response expected from a SubscribeRequest.

    -

    Hierarchy

    • BaseResponse
      • SubscribeResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: Record<string, never> | LedgerStreamResponse | BooksSnapshot

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Hierarchy

    • BaseResponse
      • SubscribeResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: Record<string, never> | LedgerStreamResponse | BooksSnapshot

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/TicketCreate.html b/docs/interfaces/TicketCreate.html index 7017b9e1..8b409225 100644 --- a/docs/interfaces/TicketCreate.html +++ b/docs/interfaces/TicketCreate.html @@ -1,49 +1,49 @@ TicketCreate | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface TicketCreate

    A TicketCreate transaction sets aside one or more sequence numbers as Tickets.

    -

    Hierarchy

    • BaseTransaction
      • TicketCreate

    Index

    Properties

    Properties

    Account

    Account: string
    +

    Hierarchy

    • BaseTransaction
      • TicketCreate

    Index

    Properties

    Properties

    Account

    Account: string

    The unique address of the account that initiated the transaction.

    -

    Optional AccountTxnID

    AccountTxnID?: string
    +

    Optional AccountTxnID

    AccountTxnID?: string

    Hash value identifying another transaction. If provided, this transaction is only valid if the sending account's previously-sent transaction matches the provided hash.

    -

    Optional Fee

    Fee?: string
    +

    Optional Fee

    Fee?: string

    Integer amount of XRP, in drops, to be destroyed as a cost for distributing this transaction to the network. Some transaction types have different minimum requirements.

    -

    Optional Flags

    Flags?: number | GlobalFlags
    +

    Optional Flags

    Flags?: number | GlobalFlags

    Set of bit-flags for this transaction.

    -

    Optional LastLedgerSequence

    LastLedgerSequence?: number
    +

    Optional LastLedgerSequence

    LastLedgerSequence?: number

    Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected.

    -

    Optional Memos

    Memos?: Memo[]
    +

    Optional Memos

    Memos?: Memo[]

    Additional arbitrary information used to identify this transaction.

    -

    Optional Sequence

    Sequence?: number
    +

    Optional Sequence

    Sequence?: number

    The sequence number of the account sending the transaction. A transaction is only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account. The special case 0 means the transaction is using a Ticket instead.

    -

    Optional Signers

    Signers?: Signer[]
    +

    Optional Signers

    Signers?: Signer[]

    Array of objects that represent a multi-signature which authorizes this transaction.

    -

    Optional SigningPubKey

    SigningPubKey?: string
    +

    Optional SigningPubKey

    SigningPubKey?: string

    Hex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in the Signers field instead.

    -

    Optional SourceTag

    SourceTag?: number
    +

    Optional SourceTag

    SourceTag?: number

    Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made. Conventionally, a refund should specify the initial payment's SourceTag as the refund payment's DestinationTag.

    -

    TicketCount

    TicketCount: number
    +

    TicketCount

    TicketCount: number

    How many Tickets to create. This must be a positive number and cannot cause the account to own more than 250 Tickets after executing this transaction.

    -

    Optional TicketSequence

    TicketSequence?: number
    +

    Optional TicketSequence

    TicketSequence?: number

    The sequence number of the ticket to use in place of a Sequence number. If this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    -

    TransactionType

    TransactionType: "TicketCreate"

    Optional TxnSignature

    TxnSignature?: string
    +

    TransactionType

    TransactionType: "TicketCreate"

    Optional TxnSignature

    TxnSignature?: string

    The signature that verifies this transaction as originating from the account it says it is from.

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/TransactionAndMetadata.html b/docs/interfaces/TransactionAndMetadata.html index aaddfc3f..ee65e283 100644 --- a/docs/interfaces/TransactionAndMetadata.html +++ b/docs/interfaces/TransactionAndMetadata.html @@ -1 +1 @@ -TransactionAndMetadata | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface TransactionAndMetadata

    Hierarchy

    • TransactionAndMetadata

    Index

    Properties

    Properties

    metadata

    metadata: TransactionMetadata

    transaction

    transaction: Transaction

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +TransactionAndMetadata | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface TransactionAndMetadata

    Hierarchy

    • TransactionAndMetadata

    Index

    Properties

    Properties

    metadata

    metadata: TransactionMetadata

    transaction

    transaction: Transaction

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/TransactionEntryRequest.html b/docs/interfaces/TransactionEntryRequest.html index b6891fe4..0201ba50 100644 --- a/docs/interfaces/TransactionEntryRequest.html +++ b/docs/interfaces/TransactionEntryRequest.html @@ -2,17 +2,17 @@

    The transaction_entry method retrieves information on a single transaction from a specific ledger version. Expects a response in the form of a TransactionEntryResponse.

    -

    Hierarchy

    • BaseRequest
      • TransactionEntryRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number
    +

    Hierarchy

    • BaseRequest
      • TransactionEntryRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    The API version to use. If omitted, use version 1.

    -

    command

    command: "transaction_entry"

    Optional id

    id?: string | number
    +

    command

    command: "transaction_entry"

    Optional id

    id?: string | number

    A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

    -

    Optional ledger_hash

    ledger_hash?: string
    +

    Optional ledger_hash

    ledger_hash?: string

    A 20-byte hex string for the ledger version to use.

    -

    Optional ledger_index

    ledger_index?: LedgerIndex
    +

    Optional ledger_index

    ledger_index?: LedgerIndex

    The ledger index of the ledger to use, or a shortcut string to choose a ledger automatically.

    -

    tx_hash

    tx_hash: string
    +

    tx_hash

    tx_hash: string

    Unique hash of the transaction you are looking up.

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/TransactionEntryResponse.html b/docs/interfaces/TransactionEntryResponse.html index 14dbfe93..9d28c50c 100644 --- a/docs/interfaces/TransactionEntryResponse.html +++ b/docs/interfaces/TransactionEntryResponse.html @@ -1,6 +1,6 @@ TransactionEntryResponse | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface TransactionEntryResponse

    Response expected from a TransactionEntryRequest.

    -

    Hierarchy

    • BaseResponse
      • TransactionEntryResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { ledger_hash: string; ledger_index: number; metadata: TransactionMetadata; tx_json: Transaction }

    Type declaration

    • ledger_hash: string
      +

    Hierarchy

    • BaseResponse
      • TransactionEntryResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: { ledger_hash: string; ledger_index: number; metadata: TransactionMetadata; tx_json: Transaction }

    Type declaration

    • ledger_hash: string

      The identifying hash of the ledger version the transaction was found in; this is the same as the one from the request.

    • ledger_index: number
      @@ -11,4 +11,4 @@ this is the same as the one from the request.

      transaction in detail.

    • tx_json: Transaction

      JSON representation of the Transaction object.

      -

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/TransactionMetadata.html b/docs/interfaces/TransactionMetadata.html index 88281bb6..517118bf 100644 --- a/docs/interfaces/TransactionMetadata.html +++ b/docs/interfaces/TransactionMetadata.html @@ -1 +1 @@ -TransactionMetadata | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface TransactionMetadata

    Hierarchy

    • TransactionMetadata

    Index

    Properties

    Properties

    AffectedNodes

    AffectedNodes: Node[]

    Optional DeliveredAmount

    DeliveredAmount?: Amount

    TransactionIndex

    TransactionIndex: number

    TransactionResult

    TransactionResult: string

    Optional delivered_amount

    delivered_amount?: Amount

    Generated using TypeDoc

    \ No newline at end of file +TransactionMetadata | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface TransactionMetadata

    Hierarchy

    • TransactionMetadata

    Index

    Properties

    Properties

    AffectedNodes

    AffectedNodes: Node[]

    Optional DeliveredAmount

    DeliveredAmount?: Amount

    TransactionIndex

    TransactionIndex: number

    TransactionResult

    TransactionResult: string

    Optional delivered_amount

    delivered_amount?: Amount

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/TransactionStream.html b/docs/interfaces/TransactionStream.html index a72d8021..af98f7f3 100644 --- a/docs/interfaces/TransactionStream.html +++ b/docs/interfaces/TransactionStream.html @@ -1,25 +1,25 @@ TransactionStream | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface TransactionStream

    Many subscriptions result in messages about transactions.

    -

    Hierarchy

    • BaseStream
      • TransactionStream

    Index

    Properties

    Properties

    engine_result

    engine_result: string
    +

    Hierarchy

    • BaseStream
      • TransactionStream

    Index

    Properties

    Properties

    engine_result

    engine_result: string

    String Transaction result code.

    -

    engine_result_code

    engine_result_code: number
    +

    engine_result_code

    engine_result_code: number

    Numeric transaction response code, if applicable.

    -

    engine_result_message

    engine_result_message: string
    +

    engine_result_message

    engine_result_message: string

    Human-readable explanation for the transaction response.

    -

    Optional ledger_current_index

    ledger_current_index?: number
    +

    Optional ledger_current_index

    ledger_current_index?: number

    The ledger index of the current in-progress ledger version for which this transaction is currently proposed.

    -

    Optional ledger_hash

    ledger_hash?: string
    +

    Optional ledger_hash

    ledger_hash?: string

    The identifying hash of the ledger version that includes this transaction.

    -

    Optional ledger_index

    ledger_index?: number
    +

    Optional ledger_index

    ledger_index?: number

    The ledger index of the ledger version that includes this transaction.

    -

    Optional meta

    meta?: TransactionMetadata
    +

    Optional meta

    meta?: TransactionMetadata

    The transaction metadata, which shows the exact outcome of the transaction in detail.

    -

    status

    status: string

    transaction

    transaction: Transaction
    +

    status

    status: string

    transaction

    transaction: (AccountDelete & { date?: number; hash?: string }) & (AccountSet & { date?: number; hash?: string }) & (CheckCancel & { date?: number; hash?: string }) & (CheckCash & { date?: number; hash?: string }) & (CheckCreate & { date?: number; hash?: string }) & (DepositPreauth & { date?: number; hash?: string }) & (EscrowCancel & { date?: number; hash?: string }) & (EscrowCreate & { date?: number; hash?: string }) & (EscrowFinish & { date?: number; hash?: string }) & (NFTokenAcceptOffer & { date?: number; hash?: string }) & (NFTokenBurn & { date?: number; hash?: string }) & (NFTokenCancelOffer & { date?: number; hash?: string }) & (NFTokenCreateOffer & { date?: number; hash?: string }) & (NFTokenMint & { date?: number; hash?: string }) & (OfferCancel & { date?: number; hash?: string }) & (OfferCreate & { date?: number; hash?: string }) & (Payment & { date?: number; hash?: string }) & (PaymentChannelClaim & { date?: number; hash?: string }) & (PaymentChannelCreate & { date?: number; hash?: string }) & (PaymentChannelFund & { date?: number; hash?: string }) & (SetRegularKey & { date?: number; hash?: string }) & (SignerListSet & { date?: number; hash?: string }) & (TicketCreate & { date?: number; hash?: string }) & (TrustSet & { date?: number; hash?: string })

    The definition of the transaction in JSON format.

    -

    type

    type: "transaction"

    Optional validated

    validated?: boolean
    +

    type

    type: "transaction"

    Optional validated

    validated?: boolean

    If true, this transaction is included in a validated ledger and its outcome is final. Responses from the transaction stream should always be validated.

    -

    Optional warnings

    warnings?: { id: number; message: string }[]

    Generated using TypeDoc

    \ No newline at end of file +

    Optional warnings

    warnings?: { id: number; message: string }[]

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/TrustSet.html b/docs/interfaces/TrustSet.html index 959ad264..f79c7078 100644 --- a/docs/interfaces/TrustSet.html +++ b/docs/interfaces/TrustSet.html @@ -1,53 +1,53 @@ TrustSet | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface TrustSet

    Create or modify a trust line linking two accounts.

    -

    Hierarchy

    • BaseTransaction
      • TrustSet

    Index

    Properties

    Properties

    Account

    Account: string
    +

    Hierarchy

    • BaseTransaction
      • TrustSet

    Index

    Properties

    Properties

    Account

    Account: string

    The unique address of the account that initiated the transaction.

    -

    Optional AccountTxnID

    AccountTxnID?: string
    +

    Optional AccountTxnID

    AccountTxnID?: string

    Hash value identifying another transaction. If provided, this transaction is only valid if the sending account's previously-sent transaction matches the provided hash.

    -

    Optional Fee

    Fee?: string
    +

    Optional Fee

    Fee?: string

    Integer amount of XRP, in drops, to be destroyed as a cost for distributing this transaction to the network. Some transaction types have different minimum requirements.

    -

    Optional Flags

    Flags?: number | TrustSetFlagsInterface

    Optional LastLedgerSequence

    LastLedgerSequence?: number
    +

    Optional Flags

    Flags?: number | TrustSetFlagsInterface

    Optional LastLedgerSequence

    LastLedgerSequence?: number

    Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected.

    -

    LimitAmount

    LimitAmount: Amount
    +

    LimitAmount

    LimitAmount: Amount

    Object defining the trust line to create or modify, in the format of a Currency Amount.

    -

    Optional Memos

    Memos?: Memo[]
    +

    Optional Memos

    Memos?: Memo[]

    Additional arbitrary information used to identify this transaction.

    -

    Optional QualityIn

    QualityIn?: number
    +

    Optional QualityIn

    QualityIn?: number

    Value incoming balances on this trust line at the ratio of this number per 1,000,000,000 units. A value of 0 is shorthand for treating balances at face value.

    -

    Optional QualityOut

    QualityOut?: number
    +

    Optional QualityOut

    QualityOut?: number

    Value outgoing balances on this trust line at the ratio of this number per 1,000,000,000 units. A value of 0 is shorthand for treating balances at face value.

    -

    Optional Sequence

    Sequence?: number
    +

    Optional Sequence

    Sequence?: number

    The sequence number of the account sending the transaction. A transaction is only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account. The special case 0 means the transaction is using a Ticket instead.

    -

    Optional Signers

    Signers?: Signer[]
    +

    Optional Signers

    Signers?: Signer[]

    Array of objects that represent a multi-signature which authorizes this transaction.

    -

    Optional SigningPubKey

    SigningPubKey?: string
    +

    Optional SigningPubKey

    SigningPubKey?: string

    Hex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in the Signers field instead.

    -

    Optional SourceTag

    SourceTag?: number
    +

    Optional SourceTag

    SourceTag?: number

    Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made. Conventionally, a refund should specify the initial payment's SourceTag as the refund payment's DestinationTag.

    -

    Optional TicketSequence

    TicketSequence?: number
    +

    Optional TicketSequence

    TicketSequence?: number

    The sequence number of the ticket to use in place of a Sequence number. If this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    -

    TransactionType

    TransactionType: "TrustSet"

    Optional TxnSignature

    TxnSignature?: string
    +

    TransactionType

    TransactionType: "TrustSet"

    Optional TxnSignature

    TxnSignature?: string

    The signature that verifies this transaction as originating from the account it says it is from.

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/TrustSetFlagsInterface.html b/docs/interfaces/TrustSetFlagsInterface.html index 415a4bad..c6a8846d 100644 --- a/docs/interfaces/TrustSetFlagsInterface.html +++ b/docs/interfaces/TrustSetFlagsInterface.html @@ -3,16 +3,16 @@ flags.

    example

    const trustSetTx: TrustSet = {
     TransactionType: 'TrustSet',
     Account: wallet2.getClassicAddress(),
     LimitAmount: {
       currency: 'FOO',
       issuer: wallet1.getClassicAddress(),
       value: '10000000000',
     },
     Flags: {
       tfSetNoRipple: true
     }
    }

    // Autofill the tx to see how flags actually look compared to the interface usage.
    const autofilledTx = await client.autofill(trustSetTx)
    console.log(autofilledTx)
    // {
    //  TransactionType: 'TrustSet',
    //  Account: 'r9dAdQQCBcGajVSeC9CqW3LCugjPDnAkEb',
    //  LimitAmount: {
    //   currency: 'FOO',
    //   issuer: 'rWZzUjo5xGiAoRBqzsndyzonXz47UV8u1',
    //   value: '10000000000'
    //  },
    //  Flags: 131072,
    //  Sequence: 21971483,
    //  Fee: '12',
    //  LastLedgerSequence: 21971503
    // }
    -

    Hierarchy

    Index

    Properties

    Properties

    Optional tfClearFreeze

    tfClearFreeze?: boolean
    +

    Hierarchy

    • GlobalFlags
      • TrustSetFlagsInterface

    Index

    Properties

    Properties

    Optional tfClearFreeze

    tfClearFreeze?: boolean

    Unfreeze the trust line.

    -

    Optional tfClearNoRipple

    tfClearNoRipple?: boolean
    +

    Optional tfClearNoRipple

    tfClearNoRipple?: boolean

    Disable the No Ripple flag, allowing rippling on this trust line.

    -

    Optional tfSetFreeze

    tfSetFreeze?: boolean
    +

    Optional tfSetFreeze

    tfSetFreeze?: boolean

    Freeze the trust line.

    -

    Optional tfSetNoRipple

    tfSetNoRipple?: boolean
    +

    Optional tfSetNoRipple

    tfSetNoRipple?: boolean

    Enable the No Ripple flag, which blocks rippling between two trust lines of the same currency if this flag is enabled on both.

    -

    Optional tfSetfAuth

    tfSetfAuth?: boolean
    +

    Optional tfSetfAuth

    tfSetfAuth?: boolean

    Authorize the other party to hold currency issued by this account. (No effect unless using the asfRequireAuth AccountSet flag.) Cannot be unset.

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/TxRequest.html b/docs/interfaces/TxRequest.html index 9984f77f..66260376 100644 --- a/docs/interfaces/TxRequest.html +++ b/docs/interfaces/TxRequest.html @@ -1,24 +1,24 @@ TxRequest | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface TxRequest

    The tx method retrieves information on a single transaction, by its identifying hash. Expects a response in the form of a TxResponse.

    -

    Hierarchy

    • BaseRequest
      • TxRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number
    +

    Hierarchy

    • BaseRequest
      • TxRequest

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    The API version to use. If omitted, use version 1.

    -

    Optional binary

    binary?: boolean
    +

    Optional binary

    binary?: boolean

    If true, return transaction data and metadata as binary serialized to hexadecimal strings. If false, return transaction data and metadata as. JSON. The default is false.

    -

    command

    command: "tx"

    Optional id

    id?: string | number
    +

    command

    command: "tx"

    Optional id

    id?: string | number

    A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

    -

    Optional max_ledger

    max_ledger?: number
    +

    Optional max_ledger

    max_ledger?: number

    Use this with min_ledger to specify a range of up to 1000 ledger indexes, ending with this ledger (inclusive). If the server cannot find the transaction, it confirms whether it was able to search all the ledgers in the requested range.

    -

    Optional min_ledger

    min_ledger?: number
    +

    Optional min_ledger

    min_ledger?: number

    Use this with max_ledger to specify a range of up to 1000 ledger indexes, starting with this ledger (inclusive). If the server cannot find the transaction, it confirms whether it was able to search all the ledgers in this range.

    -

    transaction

    transaction: string

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    transaction

    transaction: string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/TxResponse.html b/docs/interfaces/TxResponse.html index 55b78e71..b3c042da 100644 --- a/docs/interfaces/TxResponse.html +++ b/docs/interfaces/TxResponse.html @@ -1,8 +1,8 @@ TxResponse | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface TxResponse

    Response expected from a TxRequest.

    -

    Hierarchy

    • BaseResponse
      • TxResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: ({ hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & AccountDelete) & ({ hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & AccountSet) & ({ hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & CheckCancel) & ({ hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & CheckCash) & ({ hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & CheckCreate) & ({ hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & DepositPreauth) & ({ hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & EscrowCancel) & ({ hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & EscrowCreate) & ({ hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & EscrowFinish) & ({ hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & NFTokenAcceptOffer) & ({ hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & NFTokenBurn) & ({ hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & NFTokenCancelOffer) & ({ hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & NFTokenCreateOffer) & ({ hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & NFTokenMint) & ({ hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & OfferCancel) & ({ hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & OfferCreate) & ({ hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & Payment) & ({ hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & PaymentChannelClaim) & ({ hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & PaymentChannelCreate) & ({ hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & PaymentChannelFund) & ({ hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & SetRegularKey) & ({ hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & SignerListSet) & ({ hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & TicketCreate) & ({ hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & TrustSet)

    Optional searched_all

    searched_all?: boolean
    +

    Hierarchy

    • BaseResponse
      • TxResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: ({ date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & AccountDelete) & ({ date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & AccountSet) & ({ date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & CheckCancel) & ({ date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & CheckCash) & ({ date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & CheckCreate) & ({ date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & DepositPreauth) & ({ date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & EscrowCancel) & ({ date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & EscrowCreate) & ({ date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & EscrowFinish) & ({ date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & NFTokenAcceptOffer) & ({ date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & NFTokenBurn) & ({ date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & NFTokenCancelOffer) & ({ date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & NFTokenCreateOffer) & ({ date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & NFTokenMint) & ({ date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & OfferCancel) & ({ date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & OfferCreate) & ({ date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & Payment) & ({ date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & PaymentChannelClaim) & ({ date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & PaymentChannelCreate) & ({ date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & PaymentChannelFund) & ({ date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & SetRegularKey) & ({ date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & SignerListSet) & ({ date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & TicketCreate) & ({ date?: number; hash: string; ledger_index?: number; meta?: string | TransactionMetadata; validated?: boolean } & TrustSet)

    Optional searched_all

    searched_all?: boolean

    If true, the server was able to search all of the specified ledger versions, and the transaction was in none of them. If false, the server did not have all of the specified ledger versions available, so it is not sure. If one of them might contain the transaction.

    -

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Generated using TypeDoc

    \ No newline at end of file +

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/UnsubscribeRequest.html b/docs/interfaces/UnsubscribeRequest.html index 0ce87de7..7d1d778f 100644 --- a/docs/interfaces/UnsubscribeRequest.html +++ b/docs/interfaces/UnsubscribeRequest.html @@ -2,22 +2,22 @@

    The unsubscribe command tells the server to stop sending messages for a particular subscription or set of subscriptions. Expects a response in the form of an UnsubscribeResponse.

    -

    Hierarchy

    Index

    Properties

    Properties

    Optional accounts

    accounts?: string[]
    +

    Hierarchy

    • BaseRequest
      • UnsubscribeRequest

    Index

    Properties

    Properties

    Optional accounts

    accounts?: string[]

    Array of unique account addresses to stop receiving updates for, in the. XRP Ledger's base58 format.

    -

    Optional accounts_proposed

    accounts_proposed?: string[]
    +

    Optional accounts_proposed

    accounts_proposed?: string[]

    Like accounts, but for accounts_proposed subscriptions that included not-yet-validated transactions.

    -

    Optional api_version

    api_version?: number
    +

    Optional api_version

    api_version?: number

    The API version to use. If omitted, use version 1.

    -

    Optional books

    books?: Book[]
    +

    Optional books

    books?: Book[]

    Array of objects defining order books to unsubscribe from, as explained below.

    -

    command

    command: "unsubscribe"

    Optional id

    id?: string | number
    +

    command

    command: "unsubscribe"

    Optional id

    id?: string | number

    A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

    -

    Optional streams

    streams?: StreamType[]
    +

    Optional streams

    streams?: StreamType[]

    Array of string names of generic streams to unsubscribe from, including. Ledger, server, transactions, and transactions_proposed.

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/UnsubscribeResponse.html b/docs/interfaces/UnsubscribeResponse.html index 6a967b97..a8de1db2 100644 --- a/docs/interfaces/UnsubscribeResponse.html +++ b/docs/interfaces/UnsubscribeResponse.html @@ -1,3 +1,3 @@ UnsubscribeResponse | xrpl
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface UnsubscribeResponse

    Response expected from a UnsubscribeRequest.

    -

    Hierarchy

    • BaseResponse
      • UnsubscribeResponse

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: Record<string, never>

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Hierarchy

    Index

    Properties

    Properties

    Optional api_version

    api_version?: number

    Optional forwarded

    forwarded?: boolean

    id

    id: string | number

    result

    result: Record<string, never>

    Optional status

    status?: string

    type

    type: string

    Optional warning

    warning?: "load"

    Optional warnings

    warnings?: Warning[]

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/ValidationStream.html b/docs/interfaces/ValidationStream.html index 29e3b5b7..c58b5e6f 100644 --- a/docs/interfaces/ValidationStream.html +++ b/docs/interfaces/ValidationStream.html @@ -2,45 +2,45 @@

    The validations stream sends messages whenever it receives validation messages, also called validation votes, regardless of whether or not the validation message is from a trusted validator.

    -

    Hierarchy

    Index

    Properties

    Properties

    Optional amendments

    amendments?: string[]
    +

    Hierarchy

    • BaseStream
      • ValidationStream

    Index

    Properties

    Properties

    Optional amendments

    amendments?: string[]

    The value validationReceived indicates this is from the validations Stream.

    -

    Optional base_fee

    base_fee?: number
    +

    Optional base_fee

    base_fee?: number

    The amendments this server wants to be added to the protocol.

    -

    flags

    flags: number
    +

    flags

    flags: number

    The unscaled transaction cost (reference_fee value) this server wants to set by Fee voting.

    -

    full

    full: boolean
    +

    full

    full: boolean

    Bit-mask of flags added to this validation message. The flag 0x80000000 indicates that the validation signature is fully-canonical. The flag 0x00000001 indicates that this is a full validation; otherwise it's a partial validation. Partial validations are not meant to vote for any particular ledger. A partial validation indicates that the validator is still online but not keeping up with consensus.

    -

    ledger_hash

    ledger_hash: string
    +

    ledger_hash

    ledger_hash: string

    If true, this is a full validation. Otherwise, this is a partial validation. Partial validations are not meant to vote for any particular ledger. A partial validation indicates that the validator is still online but not keeping up with consensus.

    -

    ledger_index

    ledger_index: string
    +

    ledger_index

    ledger_index: string

    The ledger index of the proposed ledger.

    -

    Optional load_fee

    load_fee?: number
    +

    Optional load_fee

    load_fee?: number

    The local load-scaled transaction cost this validator is currently enforcing, in fee units.

    -

    Optional master_key

    master_key?: string
    +

    Optional master_key

    master_key?: string

    The validator's master public key, if the validator is using a validator token, in the XRP Ledger's base58 format.

    -

    Optional reserve_base

    reserve_base?: number
    +

    Optional reserve_base

    reserve_base?: number

    The minimum reserve requirement (account_reserve value) this validator wants to set by fee voting.

    -

    Optional reserve_inc

    reserve_inc?: number
    +

    Optional reserve_inc

    reserve_inc?: number

    The increment in the reserve requirement (owner_reserve value) this validator wants to set by fee voting.

    -

    signature

    signature: string
    +

    signature

    signature: string

    The signature that the validator used to sign its vote for this ledger.

    -

    signing_time

    signing_time: number
    +

    signing_time

    signing_time: number

    When this validation vote was signed, in seconds since the Ripple Epoch.

    -

    type

    type: "validationReceived"

    validation_public_key

    validation_public_key: string
    +

    type

    type: "validationReceived"

    validation_public_key

    validation_public_key: string

    The public key from the key-pair that the validator used to sign the message, in the XRP Ledger's base58 format. This identifies the validator sending the message and can also be used to verify the signature. If the diff --git a/docs/modules.html b/docs/modules.html index 7247f014..892c9564 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1,4 +1,4 @@ -xrpl

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    xrpl

    Index

    Clients

    Signing

    Transaction Models

    Transaction Flags

    Utilities

    Requests

    Responses

    Streams

    Errors

    Other

    Signing

    multisign

    • multisign(transactions: (string | Transaction)[]): string

    authorizeChannel

    • authorizeChannel(wallet: Wallet, channelId: string, amount: string): string

    • Creates a signature that can be used to redeem a specific amount of XRP from a payment channel.

      Parameters

      • wallet: Wallet

        The account that will sign for this payment channel.

        @@ -116,19 +116,19 @@ Index is unique.

      • amount: string

        The amount in drops to redeem.

      Returns string

      A signature that can be used to redeem a specific amount of XRP from a payment channel.

      -

    convertHexToString

    • convertHexToString(hex: string, encoding?: BufferEncoding): string

    convertHexToString

    • convertHexToString(hex: string, encoding?: BufferEncoding): string

    • Converts hex to its string equivalent. Useful to read the Domain field and some Memos.

      Parameters

      • hex: string

        The hex to convert to a string.

      • encoding: BufferEncoding = 'utf8'

        The encoding to use. Defaults to 'utf8' (UTF-8). 'ascii' is also allowed.

      Returns string

      The converted string.

      -

    convertStringToHex

    • convertStringToHex(string: string): string

    convertStringToHex

    • convertStringToHex(string: string): string

    • Converts a string to its hex equivalent. Useful for Memos.

      Parameters

      • string: string

        The string to convert to Hex.

      Returns string

      The Hex equivalent of the string.

      -

    decimalToQuality

    • decimalToQuality(decimal: string): number

    decimalToQuality

    • decimalToQuality(decimal: string): number

    • Converts a string decimal to the "billionths" format for use with QualityIn/ QualityOut

      throws

      ValidationError when the parameter is not convertible to @@ -136,14 +136,14 @@ QualityOut

      Parameters

      • decimal: string

        A string decimal (i.e. ".00034").

      Returns number

      A number in the "billionths" format.

      -

    decimalToTransferRate

    • decimalToTransferRate(decimal: string): number

    decimalToTransferRate

    • decimalToTransferRate(decimal: string): number

    • Converts a string decimal to "billionths" format for use with TransferRate.

      throws

      ValidationError when the parameter is not convertible to "billionths" format.

      Parameters

      • decimal: string

        A string decimal between 0 and 1.00

      Returns number

      A number in the "billionths" format.

      -

    deriveXAddress

    • deriveXAddress(options: { publicKey: string; tag: number | false; test: boolean }): string

    deriveXAddress

    • deriveXAddress(options: { publicKey: string; tag: number | false; test: boolean }): string

    • Derive an X-Address from a public key and a destination tag.

      Parameters

      • options: { publicKey: string; tag: number | false; test: boolean }

        Public key and destination tag to encode as an X-Address.

        @@ -154,19 +154,19 @@ QualityOut

      • test: boolean

        Whether this address is for use in Testnet.

    Returns string

    X-Address.

    -

    dropsToXrp

    • dropsToXrp(dropsToConvert: Value): string

    dropsToXrp

    • dropsToXrp(dropsToConvert: Value): string

    • Convert Drops to XRP.

      throws

      When drops amount is invalid.

      Parameters

      • dropsToConvert: Value

        Drops to convert to XRP. This can be a string, number, or BigNumber.

      Returns string

      Amount in XRP.

      -

    getBalanceChanges

    • getBalanceChanges(metadata: TransactionMetadata): { account: string; balances: { currency: string; issuer?: string; value: string }[] }[]

    getBalanceChanges

    • getBalanceChanges(metadata: TransactionMetadata): { account: string; balances: { currency: string; issuer?: string; value: string }[] }[]

    • Computes the complete list of every balance that changed in the ledger as a result of the given transaction.

      Parameters

      Returns { account: string; balances: { currency: string; issuer?: string; value: string }[] }[]

      Parsed balance changes.

      -

    hasNextPage

    • hasNextPage(response: Response): boolean

    hasNextPage

    • hasNextPage(response: Response): boolean

    • Returns true if there are more pages of data.

      When there are more results than contained in the response, the response includes a marker field.

      @@ -174,23 +174,23 @@ includes a marker field.

      Parameters

      • response: Response

        Response to check for more pages on.

      Returns boolean

      Whether the response has more pages of data.

      -

    isValidAddress

    • isValidAddress(address: string): boolean

    isValidAddress

    • isValidAddress(address: string): boolean

    • Validates that a given address is a valid X-Address or a valid classic address.

      Parameters

      • address: string

        Address to validate.

      Returns boolean

      True if address is a valid X-Address or classic address.

      -

    isValidSecret

    • isValidSecret(secret: string): boolean

    isValidSecret

    • isValidSecret(secret: string): boolean

    • Check if a secret is valid.

      Parameters

      • secret: string

        Secret to test for validity.

      Returns boolean

      True if secret can be derived into a keypair.

      -

    isoTimeToRippleTime

    • isoTimeToRippleTime(iso8601: string | Date): number

    isoTimeToRippleTime

    • isoTimeToRippleTime(iso8601: string | Date): number

    • Convert an ISO8601 timestmap to a ripple timestamp.

      Parameters

      • iso8601: string | Date

        International standard date format.

      Returns number

      Seconds since ripple epoch (1/1/2000 GMT).

      -

    percentToQuality

    • percentToQuality(percent: string): number

    percentToQuality

    • percentToQuality(percent: string): number

    • Converts a string percent to the "billionths" format for use with QualityIn/ QualityOut

      throws

      ValidationError when the percent parameter is not convertible to @@ -198,30 +198,30 @@ QualityOut

      Parameters

      • percent: string

        A string percent (i.e. ".034%").

      Returns number

      A number in the "billionths" format.

      -

    percentToTransferRate

    • percentToTransferRate(percent: string): number

    percentToTransferRate

    • percentToTransferRate(percent: string): number

    • Converts a string percent to "billionths" format for use with TransferRate.

      throws

      ValidationError when the percent parameter is not convertible to "billionths" format.

      Parameters

      • percent: string

        A string percent between 0% and 100%.

      Returns number

      A number in the "billionths" format.

      -

    qualityToDecimal

    • qualityToDecimal(quality: number): string

    qualityToDecimal

    • qualityToDecimal(quality: number): string

    • Converts a quality in "billionths" format to a decimal.

      throws

      ValidationError when quality is not convertible to decimal format.

      Parameters

      • quality: number

        Quality to convert to decimal.

      Returns string

      decimal representation of quality.

      -

    rippleTimeToISOTime

    • rippleTimeToISOTime(rippleTime: number): string

    rippleTimeToISOTime

    • rippleTimeToISOTime(rippleTime: number): string

    • Convert a ripple timestamp to an Iso8601 timestamp.

      Parameters

      • rippleTime: number

        Is the number of seconds since Ripple Epoch (1/1/2000 GMT).

      Returns string

      Iso8601 international standard date format.

      -

    rippleTimeToUnixTime

    • rippleTimeToUnixTime(rpepoch: number): number

    rippleTimeToUnixTime

    • rippleTimeToUnixTime(rpepoch: number): number

    signPaymentChannelClaim

    • signPaymentChannelClaim(channel: string, amount: string, privateKey: string): string

    signPaymentChannelClaim

    • signPaymentChannelClaim(channel: string, amount: string, privateKey: string): string

    • Sign a payment channel claim.

      Parameters

      • channel: string

        Channel identifier specified by the paymentChannelClaim.

        @@ -230,24 +230,24 @@ QualityOut

      • privateKey: string

        Private Key to sign paymentChannelClaim with.

      Returns string

      True if the channel is valid.

      -

    transferRateToDecimal

    • transferRateToDecimal(rate: number): string

    transferRateToDecimal

    • transferRateToDecimal(rate: number): string

    • Converts a transfer rate in "billionths" format to a decimal.

      throws

      ValidationError when it cannot convert from billionths format.

      Parameters

      • rate: number

        TransferRate to convert to decimal.

      Returns string

      decimal representation of transfer Rate.

      -

    unixTimeToRippleTime

    • unixTimeToRippleTime(timestamp: number): number

    unixTimeToRippleTime

    • unixTimeToRippleTime(timestamp: number): number

    validate

    • validate(transaction: Record<string, unknown>): void

    validate

    • validate(transaction: Record<string, unknown>): void

    • Verifies various Transaction Types. Encode/decode and individual type validation.

      throws

      ValidationError When the Transaction is malformed.

      Parameters

      • transaction: Record<string, unknown>

        A Transaction.

        -

      Returns void

    verifyPaymentChannelClaim

    • verifyPaymentChannelClaim(channel: string, amount: string, signature: string, publicKey: string): boolean

    Returns void

    verifyPaymentChannelClaim

    • verifyPaymentChannelClaim(channel: string, amount: string, signature: string, publicKey: string): boolean

    • Verify the signature of a payment channel claim.

      Parameters

      • channel: string

        Channel identifier specified by the paymentChannelClaim.

        @@ -258,55 +258,55 @@ Encode/decode and individual type validation.

      • publicKey: string

        Public key that signed the paymentChannelClaim.

      Returns boolean

      True if the channel is valid.

      -

    verifySignature

    verifySignature

    • Verifies that the given transaction has a valid signature based on public-key encryption.

      Parameters

      • tx: string | Transaction

        A transaction to verify the signature of. (Can be in object or encoded string format).

      Returns boolean

      Returns true if tx has a valid signature, and returns false otherwise.

      -

    xrpToDrops

    • xrpToDrops(xrpToConvert: Value): string

    xrpToDrops

    • xrpToDrops(xrpToConvert: Value): string

    • Convert an amount in XRP to an amount in drops.

      throws

      When amount in xrp is invalid.

      Parameters

      • xrpToConvert: Value

        Amount in XRP.

      Returns string

      Amount in drops.

      -

    Requests

    PathFindRequest

    PathFindRequest: PathFindCreateRequest | PathFindCloseRequest | PathFindStatusRequest
    +

    Requests

    PathFindRequest

    PathFindRequest: PathFindCreateRequest | PathFindCloseRequest | PathFindStatusRequest

    The path_find method searches for a path along which a transaction can possibly be made, and periodically sends updates when the path changes over time. For a simpler version that is supported by JSON-RPC, see the ripple_path_find method.

    -

    Request

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

    Responses

    Response

    Response: AccountChannelsResponse | AccountCurrenciesResponse | AccountInfoResponse | AccountLinesResponse | AccountNFTsResponse | AccountObjectsResponse | AccountOffersResponse | AccountTxResponse | GatewayBalancesResponse | NoRippleCheckResponse | LedgerResponse | LedgerClosedResponse | LedgerCurrentResponse | LedgerDataResponse | LedgerEntryResponse | SubmitResponse | SubmitMultisignedResponse | TransactionEntryResponse | TxResponse | BookOffersResponse | DepositAuthorizedResponse | PathFindResponse | RipplePathFindResponse | ChannelVerifyResponse | SubscribeResponse | UnsubscribeResponse | FeeResponse | ManifestResponse | ServerInfoResponse | ServerStateResponse | PingResponse | RandomResponse | NFTBuyOffersResponse | NFTSellOffersResponse

    Streams

    Stream

    Stream: LedgerStream | ValidationStream | TransactionStream | PathFindStream | PeerStatusStream | OrderBookStream | ConsensusStream

    Other

    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

    classicAddressToXAddress

    • classicAddressToXAddress(classicAddress: string, tag: number | false, test: boolean): string

    • Parameters

      • classicAddress: string
      • tag: number | false
      • test: boolean

      Returns string

    decode

    • decode(hex: string): Record<string, unknown>

    Request

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

    Responses

    Response

    Response: AccountChannelsResponse | AccountCurrenciesResponse | AccountInfoResponse | AccountLinesResponse | AccountNFTsResponse | AccountObjectsResponse | AccountOffersResponse | AccountTxResponse | GatewayBalancesResponse | NoRippleCheckResponse | LedgerResponse | LedgerClosedResponse | LedgerCurrentResponse | LedgerDataResponse | LedgerEntryResponse | SubmitResponse | SubmitMultisignedResponse | TransactionEntryResponse | TxResponse | BookOffersResponse | DepositAuthorizedResponse | PathFindResponse | RipplePathFindResponse | ChannelVerifyResponse | SubscribeResponse | UnsubscribeResponse | FeeResponse | ManifestResponse | ServerInfoResponse | ServerStateResponse | PingResponse | RandomResponse | NFTBuyOffersResponse | NFTSellOffersResponse

    Streams

    Stream

    Stream: LedgerStream | ValidationStream | TransactionStream | PathFindStream | PeerStatusStream | OrderBookStream | ConsensusStream

    Other

    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

    classicAddressToXAddress

    • classicAddressToXAddress(classicAddress: string, tag: number | false, test: boolean): string

    • Parameters

      • classicAddress: string
      • tag: number | false
      • test: boolean

      Returns string

    decode

    • decode(hex: string): Record<string, unknown>

    • Decodes a hex string into a transaction | ledger entry

      Parameters

      • hex: string

        hex string in the XRPL serialization format.

      Returns Record<string, unknown>

      The hex string decoded according to XRPL serialization format.

      -

    decodeAccountID

    • decodeAccountID(accountId: string): Buffer

    • Parameters

      • accountId: string

      Returns Buffer

    decodeAccountPublic

    • decodeAccountPublic(base58string: string): Buffer

    • Parameters

      • base58string: string

      Returns Buffer

    decodeNodePublic

    • decodeNodePublic(base58string: string): Buffer

    • Parameters

      • base58string: string

      Returns Buffer

    decodeSeed

    • decodeSeed(seed: string, opts?: { expectedLength: number; versionTypes: ["ed25519", "secp256k1"]; versions: (number | number[])[] }): { bytes: Buffer; type: string | null; version: number[] }

    • Parameters

      • seed: string
      • Optional opts: { expectedLength: number; versionTypes: ["ed25519", "secp256k1"]; versions: (number | number[])[] }
        • expectedLength: number
        • versionTypes: ["ed25519", "secp256k1"]
        • versions: (number | number[])[]

      Returns { bytes: Buffer; type: string | null; version: number[] }

      • bytes: Buffer
      • type: string | null
      • version: number[]

    decodeXAddress

    • decodeXAddress(xAddress: string): { accountId: Buffer; tag: number | false; test: boolean }

    • Parameters

      • xAddress: string

      Returns { accountId: Buffer; tag: number | false; test: boolean }

      • accountId: Buffer
      • tag: number | false
      • test: boolean

    encode

    decodeAccountID

    • decodeAccountID(accountId: string): Buffer

    • Parameters

      • accountId: string

      Returns Buffer

    decodeAccountPublic

    • decodeAccountPublic(base58string: string): Buffer

    • Parameters

      • base58string: string

      Returns Buffer

    decodeNodePublic

    • decodeNodePublic(base58string: string): Buffer

    • Parameters

      • base58string: string

      Returns Buffer

    decodeSeed

    • decodeSeed(seed: string, opts?: { expectedLength: number; versionTypes: ["ed25519", "secp256k1"]; versions: (number | number[])[] }): { bytes: Buffer; type: string | null; version: number[] }

    • Parameters

      • seed: string
      • Optional opts: { expectedLength: number; versionTypes: ["ed25519", "secp256k1"]; versions: (number | number[])[] }
        • expectedLength: number
        • versionTypes: ["ed25519", "secp256k1"]
        • versions: (number | number[])[]

      Returns { bytes: Buffer; type: string | null; version: number[] }

      • bytes: Buffer
      • type: string | null
      • version: number[]

    decodeXAddress

    • decodeXAddress(xAddress: string): { accountId: Buffer; tag: number | false; test: boolean }

    • Parameters

      • xAddress: string

      Returns { accountId: Buffer; tag: number | false; test: boolean }

      • accountId: Buffer
      • tag: number | false
      • test: boolean

    encode

    encodeAccountID

    • encodeAccountID(bytes: Buffer): string

    • Parameters

      • bytes: Buffer

      Returns string

    encodeAccountPublic

    • encodeAccountPublic(bytes: Buffer): string

    • Parameters

      • bytes: Buffer

      Returns string

    encodeForMultiSigning

    • encodeForMultiSigning(object: Transaction, signer: string): string

    encodeAccountID

    • encodeAccountID(bytes: Buffer): string

    • Parameters

      • bytes: Buffer

      Returns string

    encodeAccountPublic

    • encodeAccountPublic(bytes: Buffer): string

    • Parameters

      • bytes: Buffer

      Returns string

    encodeForMultiSigning

    • encodeForMultiSigning(object: Transaction, signer: string): string

    • Encodes a Transaction for multi-signing

      Parameters

      • object: Transaction

        Transaction in JSON format.

      • signer: string

        The address of the account signing this transaction

      Returns string

      A hex string representing the encoded object.

      -

    encodeForSigning

    encodeForSigning

    encodeForSigningClaim

    encodeForSigningClaim

    encodeNodePublic

    • encodeNodePublic(bytes: Buffer): string

    • Parameters

      • bytes: Buffer

      Returns string

    encodeSeed

    • encodeSeed(entropy: Buffer, type: "ed25519" | "secp256k1"): string

    • Parameters

      • entropy: Buffer
      • type: "ed25519" | "secp256k1"

      Returns string

    encodeXAddress

    • encodeXAddress(accountId: Buffer, tag: number | false, test: boolean): string

    • Parameters

      • accountId: Buffer
      • tag: number | false
      • test: boolean

      Returns string

    isValidClassicAddress

    • isValidClassicAddress(address: string): boolean

    • Parameters

      • address: string

      Returns boolean

    isValidXAddress

    • isValidXAddress(xAddress: string): boolean

    • Parameters

      • xAddress: string

      Returns boolean

    parseAccountRootFlags

    encodeNodePublic

    • encodeNodePublic(bytes: Buffer): string

    • Parameters

      • bytes: Buffer

      Returns string

    encodeSeed

    • encodeSeed(entropy: Buffer, type: "ed25519" | "secp256k1"): string

    • Parameters

      • entropy: Buffer
      • type: "ed25519" | "secp256k1"

      Returns string

    encodeXAddress

    • encodeXAddress(accountId: Buffer, tag: number | false, test: boolean): string

    • Parameters

      • accountId: Buffer
      • tag: number | false
      • test: boolean

      Returns string

    isValidClassicAddress

    • isValidClassicAddress(address: string): boolean

    • Parameters

      • address: string

      Returns boolean

    isValidXAddress

    • isValidXAddress(xAddress: string): boolean

    • Parameters

      • xAddress: string

      Returns boolean

    parseAccountRootFlags

    setTransactionFlagsToNumber

    setTransactionFlagsToNumber

    • Sets a transaction's flags to its numeric representation.

      Parameters

      • tx: Transaction

        A transaction to set its flags to its numeric representation.

        diff --git a/docs/modules/LedgerEntry.html b/docs/modules/LedgerEntry.html index 98c0868e..707c78bb 100644 --- a/docs/modules/LedgerEntry.html +++ b/docs/modules/LedgerEntry.html @@ -5,4 +5,4 @@ by the client less often, and in most scenarios, like when parsing a response, the client won't need to import the type. If it is required to use a Ledger Entry, import LedgerEntry, and access individual ledger entry types on the LedgerEntry namespace.

        -

    Index

    Ledger Entries

    Other

    Other

    LedgerEntry

    LedgerEntry: AccountRoot | Amendments | Check | LedgerEntry.DepositPreauth | DirectoryNode | Escrow | FeeSettings | LedgerHashes | NegativeUNL | Offer | PayChannel | RippleState | SignerList | Ticket

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Index

    Ledger Entries

    Other

    Other

    LedgerEntry

    LedgerEntry: AccountRoot | Amendments | Check | LedgerEntry.DepositPreauth | DirectoryNode | Escrow | FeeSettings | LedgerHashes | NegativeUNL | Offer | PayChannel | RippleState | SignerList | Ticket

    Legend

    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Private property
    • Private method
    • Static property
    • Static method
    • Property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/packages/xrpl/src/Wallet/fundWallet.ts b/packages/xrpl/src/Wallet/fundWallet.ts index ef1b8983..10c24cc1 100644 --- a/packages/xrpl/src/Wallet/fundWallet.ts +++ b/packages/xrpl/src/Wallet/fundWallet.ts @@ -39,14 +39,23 @@ const MAX_ATTEMPTS = 20 * ``` * * @param this - Client. - * @param wallet - An existing XRPL Wallet to fund, if undefined, a new Wallet will be created. + * @param wallet - An existing XRPL Wallet to fund. If undefined or null, a new Wallet will be created. + * @param options - See below. + * @param options.faucetHost - A custom host for a faucet server. On devnet and + * testnet, `fundWallet` will attempt to determine the correct server + * automatically. In other environments, or if you would like to customize the + * faucet host in devnet or testnet, you should provide the host using this + * option. * @returns A Wallet on the Testnet or Devnet that contains some amount of XRP, * and that wallet's balance in XRP. * @throws When either Client isn't connected or unable to fund wallet address. */ async function fundWallet( this: Client, - wallet?: Wallet, + wallet?: Wallet | null, + options?: { + faucetHost?: string + }, ): Promise<{ wallet: Wallet balance: number @@ -80,9 +89,15 @@ async function fundWallet( } // Options to pass to https.request - const options = getOptions(this, postBody) + const httpOptions = getHTTPOptions(this, postBody, options?.faucetHost) - return returnPromise(options, this, startingBalance, walletToFund, postBody) + return returnPromise( + httpOptions, + this, + startingBalance, + walletToFund, + postBody, + ) } // eslint-disable-next-line max-params -- Helper function created for organizational purposes @@ -124,9 +139,13 @@ async function returnPromise( }) } -function getOptions(client: Client, postBody: Uint8Array): RequestOptions { +function getHTTPOptions( + client: Client, + postBody: Uint8Array, + hostname?: string, +): RequestOptions { return { - hostname: getFaucetUrl(client), + hostname: hostname ?? getFaucetHost(client), port: 443, path: '/accounts', method: 'POST', @@ -275,13 +294,13 @@ async function getUpdatedBalance( } /** - * Get the faucet URL based on the Client connection. + * Get the faucet host based on the Client connection. * * @param client - Client. * @returns A {@link FaucetNetwork}. * @throws When the client url is not on altnet or devnet. */ -function getFaucetUrl(client: Client): FaucetNetwork | undefined { +function getFaucetHost(client: Client): FaucetNetwork | undefined { const connectionUrl = client.url // 'altnet' for Ripple Testnet server and 'testnet' for XRPL Labs Testnet server @@ -300,7 +319,7 @@ export default fundWallet const _private = { FaucetNetwork, - getFaucetUrl, + getFaucetHost, } export { _private } diff --git a/packages/xrpl/src/client/index.ts b/packages/xrpl/src/client/index.ts index 9e4f0a8f..ef64d8c5 100644 --- a/packages/xrpl/src/client/index.ts +++ b/packages/xrpl/src/client/index.ts @@ -16,6 +16,8 @@ import { AccountInfoResponse, AccountLinesRequest, AccountLinesResponse, + AccountNFTsRequest, + AccountNFTsResponse, AccountObjectsRequest, AccountObjectsResponse, AccountOffersRequest, @@ -82,6 +84,11 @@ import { SubscribeResponse, UnsubscribeRequest, UnsubscribeResponse, + // NFT methods + NFTBuyOffersRequest, + NFTBuyOffersResponse, + NFTSellOffersRequest, + NFTSellOffersResponse, } from '../models/methods' import { BaseRequest, BaseResponse } from '../models/methods/baseMethod' import { @@ -285,6 +292,7 @@ class Client extends EventEmitter { ): Promise public async request(r: AccountInfoRequest): Promise public async request(r: AccountLinesRequest): Promise + public async request(r: AccountNFTsRequest): Promise public async request( r: AccountObjectsRequest, ): Promise @@ -305,6 +313,8 @@ class Client extends EventEmitter { public async request(r: LedgerDataRequest): Promise public async request(r: LedgerEntryRequest): Promise public async request(r: ManifestRequest): Promise + public async request(r: NFTBuyOffersRequest): Promise + public async request(r: NFTSellOffersRequest): Promise public async request(r: NoRippleCheckRequest): Promise public async request(r: PathFindRequest): Promise public async request(r: PingRequest): Promise diff --git a/packages/xrpl/src/models/methods/accountNFTs.ts b/packages/xrpl/src/models/methods/accountNFTs.ts index 391da659..91c33d31 100644 --- a/packages/xrpl/src/models/methods/accountNFTs.ts +++ b/packages/xrpl/src/models/methods/accountNFTs.ts @@ -34,6 +34,7 @@ interface AccountNFToken { Issuer: string TokenID: string TokenTaxon: number + URI?: string nft_serial: number } diff --git a/packages/xrpl/test/integration/fundWallet.ts b/packages/xrpl/test/integration/fundWallet.ts index 32dca229..05282c1d 100644 --- a/packages/xrpl/test/integration/fundWallet.ts +++ b/packages/xrpl/test/integration/fundWallet.ts @@ -40,6 +40,7 @@ describe('fundWallet', function () { await api.disconnect() }) + it('submit generates a devnet wallet', async function () { const api = new Client('wss://s.devnet.rippletest.net:51233') @@ -67,4 +68,36 @@ describe('fundWallet', function () { await api.disconnect() }) + + it('can generate and fund wallets using a custom host', async function () { + const api = new Client('ws://xls20-sandbox.rippletest.net:51233') + + await api.connect() + const { wallet, balance } = await api.fundWallet(null, { + faucetHost: 'faucet-nft.ripple.com', + }) + + assert.notEqual(wallet, undefined) + assert(isValidClassicAddress(wallet.classicAddress)) + assert(isValidXAddress(wallet.getXAddress())) + + const info = await api.request({ + command: 'account_info', + account: wallet.classicAddress, + }) + + assert.equal(dropsToXrp(info.result.account_data.Balance), balance) + + const { balance: newBalance } = await api.fundWallet(wallet, { + faucetHost: 'faucet-nft.ripple.com', + }) + + const afterSent = await api.request({ + command: 'account_info', + account: wallet.classicAddress, + }) + assert.equal(dropsToXrp(afterSent.result.account_data.Balance), newBalance) + + await api.disconnect() + }) }) diff --git a/packages/xrpl/test/wallet/fundWallet.ts b/packages/xrpl/test/wallet/fundWallet.ts index e6a99edf..e7132062 100644 --- a/packages/xrpl/test/wallet/fundWallet.ts +++ b/packages/xrpl/test/wallet/fundWallet.ts @@ -3,35 +3,35 @@ import { assert } from 'chai' import { _private } from '../../src/Wallet/fundWallet' import { setupClient, teardownClient } from '../setupClient' -const { FaucetNetwork, getFaucetUrl } = _private +const { FaucetNetwork, getFaucetHost } = _private -describe('Get Faucet URL', function () { +describe('Get Faucet host ', function () { beforeEach(setupClient) afterEach(teardownClient) - it('returns the Devnet URL', function () { + it('returns the Devnet host', function () { const expectedFaucet = FaucetNetwork.Devnet this.client.connection.url = FaucetNetwork.Devnet - assert.strictEqual(getFaucetUrl(this.client), expectedFaucet) + assert.strictEqual(getFaucetHost(this.client), expectedFaucet) }) - it('returns the Testnet URL', function () { + it('returns the Testnet host', function () { const expectedFaucet = FaucetNetwork.Testnet this.client.connection.url = FaucetNetwork.Testnet - assert.strictEqual(getFaucetUrl(this.client), expectedFaucet) + assert.strictEqual(getFaucetHost(this.client), expectedFaucet) }) - it('returns the Testnet URL with the XRPL Labs server', function () { + it('returns the Testnet host with the XRPL Labs server', function () { const expectedFaucet = FaucetNetwork.Testnet this.client.connection.url = 'wss://testnet.xrpl-labs.com' - assert.strictEqual(getFaucetUrl(this.client), expectedFaucet) + assert.strictEqual(getFaucetHost(this.client), expectedFaucet) }) it('returns undefined if not a Testnet or Devnet server URL', function () { // Info: setupClient.setup creates a connection to 'localhost' - assert.throws(() => getFaucetUrl(this.client)) + assert.throws(() => getFaucetHost(this.client)) }) })