diff --git a/docs/classes/Client.html b/docs/classes/Client.html index b3932be3a9..571cb9a286 100644 --- a/docs/classes/Client.html +++ b/docs/classes/Client.html @@ -32,7 +32,7 @@

Hierarchy

+
  • Defined in packages/xrpl/src/client/index.ts:167
    • @@ -120,7 +120,7 @@

    Example

    import<
    +
  • Defined in packages/xrpl/src/client/index.ts:215

    • Abstraction

    @@ -172,7 +172,7 @@

    Example

    const
    +
  • Defined in packages/xrpl/src/client/index.ts:902

    • getLedgerIndex

    +
  • Defined in packages/xrpl/src/client/index.ts:1028

    • getOrderbook

    +
  • Defined in packages/xrpl/src/client/index.ts:970

    • getXrpBalance

    +
  • Defined in packages/xrpl/src/client/index.ts:836

    • Core

    @@ -319,7 +319,7 @@

    Example

    const
    +
  • Defined in packages/xrpl/src/client/index.ts:631

    • submit

    +
  • Defined in packages/xrpl/src/client/index.ts:695

    • submitAndWait

      @@ -435,7 +435,7 @@

      Throws

      Timeout errors: If the transaction takes longer than the speci ledger, the promise returned by submitAndWait() will be rejected with an error.

    +
  • Defined in packages/xrpl/src/client/index.ts:767

    • Faucet

    @@ -485,7 +485,7 @@

    Example

    Example 1: Fund a randomly generated wallet

    Throws

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

    +
  • Defined in packages/xrpl/src/client/index.ts:1101

    • Fee

    @@ -496,7 +496,7 @@

    Readonly

    +
  • Defined in packages/xrpl/src/client/index.ts:179

    • Readonly maxFeeXRP

    maxFeeXRP: string
    @@ -505,7 +505,7 @@

    Readonly

    +
  • Defined in packages/xrpl/src/client/index.ts:187

    • Network

    @@ -519,7 +519,7 @@

    Returns string

    +
  • Defined in packages/xrpl/src/client/index.ts:285

    • connect

    +
  • Defined in packages/xrpl/src/client/index.ts:530

    • disconnect

    +
  • Defined in packages/xrpl/src/client/index.ts:557

    • isConnected

    +
  • Defined in packages/xrpl/src/client/index.ts:582

    • on

    +
  • Defined in packages/xrpl/src/client/index.ts:387

    • request

    +
  • Defined in packages/xrpl/src/client/index.ts:307

    • requestAll

    +
  • Defined in packages/xrpl/src/client/index.ts:425

    • requestNextPage

    +
  • Defined in packages/xrpl/src/client/index.ts:348

    • Other

    @@ -729,12 +729,12 @@

    buildVersion

    +
  • Defined in packages/xrpl/src/client/index.ts:199

    • Readonly connection

    connection: Connection
    +
  • Defined in packages/xrpl/src/client/index.ts:171

    • networkID

    networkID: undefined | number
    @@ -742,7 +742,7 @@

    networkID

    +
  • Defined in packages/xrpl/src/client/index.ts:193

    • Static prefixed

    prefixed: string | boolean
    +
  • Defined in packages/xrpl/src/client/index.ts:489

    • listenerCount

    +
  • Defined in packages/xrpl/src/client/index.ts:808

    • removeAllListeners

      diff --git a/docs/classes/ConnectionError.html b/docs/classes/ConnectionError.html index 39404964bb..46d6862979 100644 --- a/docs/classes/ConnectionError.html +++ b/docs/classes/ConnectionError.html @@ -38,7 +38,7 @@

      Hierarchy

    • TimeoutError
    • ResponseFormatError
    +
  • Defined in packages/xrpl/src/errors.ts:76
    • @@ -87,7 +87,7 @@

    Returns

    +
  • Defined in packages/xrpl/src/errors.ts:19

    • Properties

    @@ -95,19 +95,19 @@

    Optionaldata?: unknown

    +
  • Defined in packages/xrpl/src/errors.ts:11

    • Readonly message

    message: string
    +
  • Defined in packages/xrpl/src/errors.ts:10

    • Readonly name

    name: string
    +
  • Defined in packages/xrpl/src/errors.ts:9

    • Optional stack

    stack?: string
    +
  • Defined in packages/xrpl/src/errors.ts:52

    • toString

    +
  • Defined in packages/xrpl/src/errors.ts:36

    • Static captureStackTrace

      diff --git a/docs/classes/DisconnectedError.html b/docs/classes/DisconnectedError.html index 5867ce80f9..6574b17506 100644 --- a/docs/classes/DisconnectedError.html +++ b/docs/classes/DisconnectedError.html @@ -32,7 +32,7 @@

      Hierarchy

      • DisconnectedError
    +
  • Defined in packages/xrpl/src/errors.ts:90
    • @@ -81,7 +81,7 @@

    Returns

    +
  • Defined in packages/xrpl/src/errors.ts:19

    • Properties

    @@ -89,19 +89,19 @@

    Optionaldata?: unknown

    +
  • Defined in packages/xrpl/src/errors.ts:11

    • Readonly message

    message: string
    +
  • Defined in packages/xrpl/src/errors.ts:10

    • Readonly name

    name: string
    +
  • Defined in packages/xrpl/src/errors.ts:9

    • Optional stack

    stack?: string
    +
  • Defined in packages/xrpl/src/errors.ts:52

    • toString

    +
  • Defined in packages/xrpl/src/errors.ts:36

    • Static captureStackTrace

      diff --git a/docs/classes/NotConnectedError.html b/docs/classes/NotConnectedError.html index ef17ddcd16..45c24e7b10 100644 --- a/docs/classes/NotConnectedError.html +++ b/docs/classes/NotConnectedError.html @@ -32,7 +32,7 @@

      Hierarchy

      • NotConnectedError
    +
  • Defined in packages/xrpl/src/errors.ts:83
    • @@ -81,7 +81,7 @@

    Returns

    +
  • Defined in packages/xrpl/src/errors.ts:19

    • Properties

    @@ -89,19 +89,19 @@

    Optionaldata?: unknown

    +
  • Defined in packages/xrpl/src/errors.ts:11

    • Readonly message

    message: string
    +
  • Defined in packages/xrpl/src/errors.ts:10

    • Readonly name

    name: string
    +
  • Defined in packages/xrpl/src/errors.ts:9

    • Optional stack

    stack?: string
    +
  • Defined in packages/xrpl/src/errors.ts:52

    • toString

    +
  • Defined in packages/xrpl/src/errors.ts:36

    • Static captureStackTrace

      diff --git a/docs/classes/NotFoundError.html b/docs/classes/NotFoundError.html index 1e9a356ccb..87b4f6754c 100644 --- a/docs/classes/NotFoundError.html +++ b/docs/classes/NotFoundError.html @@ -33,7 +33,7 @@

      Hierarchy

      • NotFoundError
    +
  • Defined in packages/xrpl/src/errors.ts:135
    • @@ -78,7 +78,7 @@

    Returns

    +
  • Defined in packages/xrpl/src/errors.ts:141

    • Properties

    @@ -86,19 +86,19 @@

    Optionaldata?: unknown

    +
  • Defined in packages/xrpl/src/errors.ts:11

    • Readonly message

    message: string
    +
  • Defined in packages/xrpl/src/errors.ts:10

    • Readonly name

    name: string
    +
  • Defined in packages/xrpl/src/errors.ts:9

    • Optional stack

    stack?: string
    +
  • Defined in packages/xrpl/src/errors.ts:52

    • toString

    +
  • Defined in packages/xrpl/src/errors.ts:36

    • Static captureStackTrace

      diff --git a/docs/classes/ResponseFormatError.html b/docs/classes/ResponseFormatError.html index be999abca5..cc03488bb4 100644 --- a/docs/classes/ResponseFormatError.html +++ b/docs/classes/ResponseFormatError.html @@ -32,7 +32,7 @@

      Hierarchy

      • ResponseFormatError
    +
  • Defined in packages/xrpl/src/errors.ts:111
    • @@ -81,7 +81,7 @@

    Returns

    +
  • Defined in packages/xrpl/src/errors.ts:19

    • Properties

    @@ -89,19 +89,19 @@

    Optionaldata?: unknown

    +
  • Defined in packages/xrpl/src/errors.ts:11

    • Readonly message

    message: string
    +
  • Defined in packages/xrpl/src/errors.ts:10

    • Readonly name

    name: string
    +
  • Defined in packages/xrpl/src/errors.ts:9

    • Optional stack

    stack?: string
    +
  • Defined in packages/xrpl/src/errors.ts:52

    • toString

    +
  • Defined in packages/xrpl/src/errors.ts:36

    • Static captureStackTrace

      diff --git a/docs/classes/RippledError.html b/docs/classes/RippledError.html index 9ff26379e9..02107d3288 100644 --- a/docs/classes/RippledError.html +++ b/docs/classes/RippledError.html @@ -32,7 +32,7 @@

      Hierarchy

      • RippledError
    +
  • Defined in packages/xrpl/src/errors.ts:62
    • @@ -81,7 +81,7 @@

    Returns

    +
  • Defined in packages/xrpl/src/errors.ts:19

    • Properties

    @@ -89,19 +89,19 @@

    Optionaldata?: unknown

    +
  • Defined in packages/xrpl/src/errors.ts:11

    • Readonly message

    message: string
    +
  • Defined in packages/xrpl/src/errors.ts:10

    • Readonly name

    name: string
    +
  • Defined in packages/xrpl/src/errors.ts:9

    • Optional stack

    stack?: string
    +
  • Defined in packages/xrpl/src/errors.ts:52

    • toString

    +
  • Defined in packages/xrpl/src/errors.ts:36

    • Static captureStackTrace

      diff --git a/docs/classes/RippledNotInitializedError.html b/docs/classes/RippledNotInitializedError.html index 16a55bbccc..b974a5e525 100644 --- a/docs/classes/RippledNotInitializedError.html +++ b/docs/classes/RippledNotInitializedError.html @@ -32,7 +32,7 @@

      Hierarchy

      • RippledNotInitializedError
    +
  • Defined in packages/xrpl/src/errors.ts:97
    • @@ -81,7 +81,7 @@

    Returns

    +
  • Defined in packages/xrpl/src/errors.ts:19

    • Properties

    @@ -89,19 +89,19 @@

    Optionaldata?: unknown

    +
  • Defined in packages/xrpl/src/errors.ts:11

    • Readonly message

    message: string
    +
  • Defined in packages/xrpl/src/errors.ts:10

    • Readonly name

    name: string
    +
  • Defined in packages/xrpl/src/errors.ts:9

    • Optional stack

    stack?: string
    +
  • Defined in packages/xrpl/src/errors.ts:52

    • toString

    +
  • Defined in packages/xrpl/src/errors.ts:36

    • Static captureStackTrace

      diff --git a/docs/classes/TimeoutError.html b/docs/classes/TimeoutError.html index 4d17607d1b..edb9adc9df 100644 --- a/docs/classes/TimeoutError.html +++ b/docs/classes/TimeoutError.html @@ -32,7 +32,7 @@

      Hierarchy

      • TimeoutError
    +
  • Defined in packages/xrpl/src/errors.ts:104
    • @@ -81,7 +81,7 @@

    Returns

    +
  • Defined in packages/xrpl/src/errors.ts:19

    • Properties

    @@ -89,19 +89,19 @@

    Optionaldata?: unknown

    +
  • Defined in packages/xrpl/src/errors.ts:11

    • Readonly message

    message: string
    +
  • Defined in packages/xrpl/src/errors.ts:10

    • Readonly name

    name: string
    +
  • Defined in packages/xrpl/src/errors.ts:9

    • Optional stack

    stack?: string
    +
  • Defined in packages/xrpl/src/errors.ts:52

    • toString

    +
  • Defined in packages/xrpl/src/errors.ts:36

    • Static captureStackTrace

      diff --git a/docs/classes/UnexpectedError.html b/docs/classes/UnexpectedError.html index cafbfc2e79..8adf265995 100644 --- a/docs/classes/UnexpectedError.html +++ b/docs/classes/UnexpectedError.html @@ -32,7 +32,7 @@

      Hierarchy

      • UnexpectedError
    +
  • Defined in packages/xrpl/src/errors.ts:69
    • @@ -81,7 +81,7 @@

    Returns

    +
  • Defined in packages/xrpl/src/errors.ts:19

    • Properties

    @@ -89,19 +89,19 @@

    Optionaldata?: unknown

    +
  • Defined in packages/xrpl/src/errors.ts:11

    • Readonly message

    message: string
    +
  • Defined in packages/xrpl/src/errors.ts:10

    • Readonly name

    name: string
    +
  • Defined in packages/xrpl/src/errors.ts:9

    • Optional stack

    stack?: string
    +
  • Defined in packages/xrpl/src/errors.ts:52

    • toString

    +
  • Defined in packages/xrpl/src/errors.ts:36

    • Static captureStackTrace

      diff --git a/docs/classes/ValidationError.html b/docs/classes/ValidationError.html index ee71f28962..60bc31c544 100644 --- a/docs/classes/ValidationError.html +++ b/docs/classes/ValidationError.html @@ -32,7 +32,7 @@

      Hierarchy

      • ValidationError
    +
  • Defined in packages/xrpl/src/errors.ts:118
    • @@ -81,7 +81,7 @@

    Returns

    +
  • Defined in packages/xrpl/src/errors.ts:19

    • Properties

    @@ -89,19 +89,19 @@

    Optionaldata?: unknown

    +
  • Defined in packages/xrpl/src/errors.ts:11

    • Readonly message

    message: string
    +
  • Defined in packages/xrpl/src/errors.ts:10

    • Readonly name

    name: string
    +
  • Defined in packages/xrpl/src/errors.ts:9

    • Optional stack

    stack?: string
    +
  • Defined in packages/xrpl/src/errors.ts:52

    • toString

    +
  • Defined in packages/xrpl/src/errors.ts:36

    • Static captureStackTrace

      diff --git a/docs/classes/Wallet.html b/docs/classes/Wallet.html index 20f2fb7a64..fcaa90e6d3 100644 --- a/docs/classes/Wallet.html +++ b/docs/classes/Wallet.html @@ -35,7 +35,7 @@

      Hierarchy

      • Wallet
    +
  • Defined in packages/xrpl/src/Wallet/index.ts:91
    • @@ -107,29 +107,29 @@
    Optional Returns Wallet
    +
  • Defined in packages/xrpl/src/Wallet/index.ts:106

    • Properties

    Readonly classicAddress

    classicAddress: string
    +
  • Defined in packages/xrpl/src/Wallet/index.ts:94

    • Readonly privateKey

    privateKey: string
    +
  • Defined in packages/xrpl/src/Wallet/index.ts:93

    • Readonly publicKey

    publicKey: string
    +
  • Defined in packages/xrpl/src/Wallet/index.ts:92

    • Optional Readonly seed

    seed?: string
    +
  • Defined in packages/xrpl/src/Wallet/index.ts:95

    • Static fromSecret

    fromSecret: ((seed, opts?) => Wallet) = Wallet.fromSeed
    @@ -166,7 +166,7 @@

    Returns

    +
  • Defined in packages/xrpl/src/Wallet/index.ts:184

    • Accessors

    @@ -180,7 +180,7 @@

    Returns string

    +
  • Defined in packages/xrpl/src/Wallet/index.ts:127

    • Methods

    @@ -205,7 +205,7 @@

    Returns string

    +
  • Defined in packages/xrpl/src/Wallet/index.ts:458

    • sign

      @@ -256,7 +256,7 @@

      Throws

      ValidationError if the transaction is already signed or does n

      Throws

      XrplError if the issued currency being signed is XRP ignoring case.

    +
  • Defined in packages/xrpl/src/Wallet/index.ts:375

    • verifyTransaction

    +
  • Defined in packages/xrpl/src/Wallet/index.ts:447

    • Static Private deriveWallet

    +
  • Defined in packages/xrpl/src/Wallet/index.ts:304

    • Static fromEntropy

    +
  • Defined in packages/xrpl/src/Wallet/index.ts:195

    • Static fromMnemonic

    +
  • Defined in packages/xrpl/src/Wallet/index.ts:231

    • Static Private fromRFC1751Mnemonic

    +
  • Defined in packages/xrpl/src/Wallet/index.ts:276

    • Static fromSeed

    +
  • Defined in packages/xrpl/src/Wallet/index.ts:164

    • Static generate

    +
  • Defined in packages/xrpl/src/Wallet/index.ts:147
    • diff --git a/docs/classes/XRPLFaucetError.html b/docs/classes/XRPLFaucetError.html index a9405ac41a..0abd3d5255 100644 --- a/docs/classes/XRPLFaucetError.html +++ b/docs/classes/XRPLFaucetError.html @@ -34,7 +34,7 @@

    Hierarchy

    • XRPLFaucetError
    +
  • Defined in packages/xrpl/src/errors.ts:127
    • @@ -83,7 +83,7 @@

    Returns

    +
  • Defined in packages/xrpl/src/errors.ts:19

    • Properties

    @@ -91,19 +91,19 @@

    Optionaldata?: unknown

    +
  • Defined in packages/xrpl/src/errors.ts:11

    • Readonly message

    message: string
    +
  • Defined in packages/xrpl/src/errors.ts:10

    • Readonly name

    name: string
    +
  • Defined in packages/xrpl/src/errors.ts:9

    • Optional stack

    stack?: string
    +
  • Defined in packages/xrpl/src/errors.ts:52

    • toString

    +
  • Defined in packages/xrpl/src/errors.ts:36

    • Static captureStackTrace

      diff --git a/docs/classes/XrplError.html b/docs/classes/XrplError.html index 48ce143bb2..665a95f9c7 100644 --- a/docs/classes/XrplError.html +++ b/docs/classes/XrplError.html @@ -40,7 +40,7 @@

      Hierarchy

    • NotFoundError
    • XRPLFaucetError
    +
  • Defined in packages/xrpl/src/errors.ts:8
    • @@ -89,26 +89,26 @@

    Returns

    +
  • Defined in packages/xrpl/src/errors.ts:19

    • Properties

    Optional Readonly data

    data?: unknown
    +
  • Defined in packages/xrpl/src/errors.ts:11

    • Readonly message

    message: string
    +
  • Defined in packages/xrpl/src/errors.ts:10

    • Readonly name

    name: string
    +
  • Defined in packages/xrpl/src/errors.ts:9

    • Optional stack

    stack?: string
    +
  • Defined in packages/xrpl/src/errors.ts:52

    • toString

    +
  • Defined in packages/xrpl/src/errors.ts:36

    • Static captureStackTrace

      diff --git a/docs/enums/AMMDepositFlags.html b/docs/enums/AMMDepositFlags.html index 52545b909b..9bc6d6fe0e 100644 --- a/docs/enums/AMMDepositFlags.html +++ b/docs/enums/AMMDepositFlags.html @@ -26,7 +26,7 @@

      Enumeration AMMDepositFlags

    +
  • Defined in packages/xrpl/src/models/transactions/AMMDeposit.ts:18
    • @@ -46,27 +46,27 @@

    Enumeration Members

    tfLPToken

    tfLPToken: 65536
    +
  • Defined in packages/xrpl/src/models/transactions/AMMDeposit.ts:19

    • tfLimitLPToken

    tfLimitLPToken: 4194304
    +
  • Defined in packages/xrpl/src/models/transactions/AMMDeposit.ts:23

    • tfOneAssetLPToken

    tfOneAssetLPToken: 2097152
    +
  • Defined in packages/xrpl/src/models/transactions/AMMDeposit.ts:22

    • tfSingleAsset

    tfSingleAsset: 524288
    +
  • Defined in packages/xrpl/src/models/transactions/AMMDeposit.ts:20

    • tfTwoAsset

    tfTwoAsset: 1048576
    +
  • Defined in packages/xrpl/src/models/transactions/AMMDeposit.ts:21
    • diff --git a/docs/enums/AMMWithdrawFlags.html b/docs/enums/AMMWithdrawFlags.html index cb4f8df8d4..9dcc29dfe1 100644 --- a/docs/enums/AMMWithdrawFlags.html +++ b/docs/enums/AMMWithdrawFlags.html @@ -26,7 +26,7 @@

    Enumeration AMMWithdrawFlags

    +
  • Defined in packages/xrpl/src/models/transactions/AMMWithdraw.ts:18
    • @@ -48,37 +48,37 @@

    Enumeration Members

    tfLPToken

    tfLPToken: 65536
    +
  • Defined in packages/xrpl/src/models/transactions/AMMWithdraw.ts:19

    • tfLimitLPToken

    tfLimitLPToken: 4194304
    +
  • Defined in packages/xrpl/src/models/transactions/AMMWithdraw.ts:25

    • tfOneAssetLPToken

    tfOneAssetLPToken: 2097152
    +
  • Defined in packages/xrpl/src/models/transactions/AMMWithdraw.ts:24

    • tfOneAssetWithdrawAll

    tfOneAssetWithdrawAll: 262144
    +
  • Defined in packages/xrpl/src/models/transactions/AMMWithdraw.ts:21

    • tfSingleAsset

    tfSingleAsset: 524288
    +
  • Defined in packages/xrpl/src/models/transactions/AMMWithdraw.ts:22

    • tfTwoAsset

    tfTwoAsset: 1048576
    +
  • Defined in packages/xrpl/src/models/transactions/AMMWithdraw.ts:23

    • tfWithdrawAll

    tfWithdrawAll: 131072
    +
  • Defined in packages/xrpl/src/models/transactions/AMMWithdraw.ts:20
    • diff --git a/docs/enums/AccountSetAsfFlags.html b/docs/enums/AccountSetAsfFlags.html index 0b2433ba71..452c741ed7 100644 --- a/docs/enums/AccountSetAsfFlags.html +++ b/docs/enums/AccountSetAsfFlags.html @@ -26,7 +26,7 @@

    Enumeration AccountSetAsfFlags

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:16
    • @@ -60,7 +60,7 @@

    asfAccountTxnID

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:36

    • asfAllowTrustLineClawback

    asfAllowTrustLineClawback: 16
    @@ -68,7 +68,7 @@

    asfAllowTrustLineClawb

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:62

    • asfAuthorizedNFTokenMinter

    asfAuthorizedNFTokenMinter: 10
    @@ -76,7 +76,7 @@

    asfAuthorizedNFTokenMinter<

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:51

    • asfDefaultRipple

    asfDefaultRipple: 8
    @@ -84,7 +84,7 @@

    asfDefaultRipple

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:45

    • asfDepositAuth

    asfDepositAuth: 9
    @@ -92,7 +92,7 @@

    asfDepositAuth

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:47

    • asfDisableMaster

    asfDisableMaster: 4
    @@ -102,7 +102,7 @@

    asfDisableMaster

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:31

    • asfDisallowIncomingCheck

    asfDisallowIncomingCheck: 13
    @@ -110,7 +110,7 @@

    asfDisallowIncomingCheck

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:56

    • asfDisallowIncomingNFTokenOffer

    asfDisallowIncomingNFTokenOffer: 12
    @@ -118,7 +118,7 @@

    asfDisallowIncomingNFTokenOf

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:54

    • asfDisallowIncomingPayChan

    asfDisallowIncomingPayChan: 14
    @@ -126,7 +126,7 @@

    asfDisallowIncomingPay

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:58

    • asfDisallowIncomingTrustline

    asfDisallowIncomingTrustline: 15
    @@ -134,7 +134,7 @@

    asfDisallowIncomingTrustline

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:60

    • asfDisallowXRP

    asfDisallowXRP: 3
    @@ -142,7 +142,7 @@

    asfDisallowXRP

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:25

    • asfGlobalFreeze

    asfGlobalFreeze: 7
    @@ -150,7 +150,7 @@

    asfGlobalFreeze

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:43

    • asfNoFreeze

    asfNoFreeze: 6
    @@ -159,7 +159,7 @@

    asfNoFreeze

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:41

    • asfRequireAuth

    asfRequireAuth: 2
    @@ -168,7 +168,7 @@

    asfRequireAuth

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:23

    • asfRequireDest

    asfRequireDest: 1
    @@ -176,7 +176,7 @@

    asfRequireDest

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:18
    • diff --git a/docs/enums/AccountSetTfFlags.html b/docs/enums/AccountSetTfFlags.html index 4b12abdab2..6e2190554a 100644 --- a/docs/enums/AccountSetTfFlags.html +++ b/docs/enums/AccountSetTfFlags.html @@ -26,7 +26,7 @@

    Enumeration AccountSetTfFlags

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:70
    • @@ -50,7 +50,7 @@

    tfAllowXRP

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:82

    • tfDisallowXRP

    tfDisallowXRP: 1048576
    @@ -58,7 +58,7 @@

    tfDisallowXRP

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:80

    • tfOptionalAuth

    tfOptionalAuth: 524288
    @@ -66,7 +66,7 @@

    tfOptionalAuth

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:78

    • tfOptionalDestTag

    tfOptionalDestTag: 131072
    @@ -74,7 +74,7 @@

    tfOptionalDestTag

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:74

    • tfRequireAuth

    tfRequireAuth: 262144
    @@ -82,7 +82,7 @@

    tfRequireAuth

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:76

    • tfRequireDestTag

    tfRequireDestTag: 65536
    @@ -90,7 +90,7 @@

    tfRequireDestTag

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:72
    • diff --git a/docs/enums/ECDSA.html b/docs/enums/ECDSA.html index 4bd42d496a..1cbb20c030 100644 --- a/docs/enums/ECDSA.html +++ b/docs/enums/ECDSA.html @@ -22,7 +22,7 @@
  • ECDSA

    • Enumeration ECDSA

    +
  • Defined in packages/xrpl/src/ECDSA.ts:1
    • @@ -39,12 +39,12 @@

    Enumeration Members

    ed25519

    ed25519: "ed25519"
    +
  • Defined in packages/xrpl/src/ECDSA.ts:2

    • secp256k1

    secp256k1: "ecdsa-secp256k1"
    +
  • Defined in packages/xrpl/src/ECDSA.ts:3
    • diff --git a/docs/enums/EnableAmendmentFlags.html b/docs/enums/EnableAmendmentFlags.html index 0855247ec6..c9ff9a12c9 100644 --- a/docs/enums/EnableAmendmentFlags.html +++ b/docs/enums/EnableAmendmentFlags.html @@ -26,7 +26,7 @@

    Enumeration EnableAmendmentFlags

    +
  • Defined in packages/xrpl/src/models/transactions/enableAmendment.ts:8
    • @@ -46,7 +46,7 @@

    tfGotMajority

    +
  • Defined in packages/xrpl/src/models/transactions/enableAmendment.ts:10

    • tfLostMajority

    tfLostMajority: 131072
    @@ -54,7 +54,7 @@

    tfLostMajority

    +
  • Defined in packages/xrpl/src/models/transactions/enableAmendment.ts:12
    • diff --git a/docs/enums/LedgerEntry.AccountRootFlags.html b/docs/enums/LedgerEntry.AccountRootFlags.html index 0016a983b4..c328f3e6ab 100644 --- a/docs/enums/LedgerEntry.AccountRootFlags.html +++ b/docs/enums/LedgerEntry.AccountRootFlags.html @@ -23,7 +23,7 @@
  • AccountRootFlags

    • Enumeration AccountRootFlags

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:151
    • @@ -56,7 +56,7 @@

    lsfAMM

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:192

    • lsfAllowTrustLineClawback

    lsfAllowTrustLineClawback: 2147483648
    @@ -64,7 +64,7 @@

    lsfAllowTrustLineClawb

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:212

    • lsfDefaultRipple

    lsfDefaultRipple: 8388608
    @@ -72,7 +72,7 @@

    lsfDefaultRipple

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:183

    • lsfDepositAuth

    lsfDepositAuth: 16777216
    @@ -81,7 +81,7 @@

    lsfDepositAuth

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:188

    • lsfDisableMaster

    lsfDisableMaster: 1048576
    @@ -89,7 +89,7 @@

    lsfDisableMaster

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:171

    • lsfDisallowIncomingCheck

    lsfDisallowIncomingCheck: 134217728
    @@ -97,7 +97,7 @@

    lsfDisallowIncomingCheck

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:200

    • lsfDisallowIncomingNFTokenOffer

    lsfDisallowIncomingNFTokenOffer: 67108864
    @@ -105,7 +105,7 @@

    lsfDisallowIncomingNFTokenOf

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:196

    • lsfDisallowIncomingPayChan

    lsfDisallowIncomingPayChan: 268435456
    @@ -113,7 +113,7 @@

    lsfDisallowIncomingPay

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:204

    • lsfDisallowIncomingTrustline

    lsfDisallowIncomingTrustline: 536870912
    @@ -121,7 +121,7 @@

    lsfDisallowIncomingTrustline

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:208

    • lsfDisallowXRP

    lsfDisallowXRP: 524288
    @@ -129,7 +129,7 @@

    lsfDisallowXRP

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:167

    • lsfGlobalFreeze

    lsfGlobalFreeze: 4194304
    @@ -137,7 +137,7 @@

    lsfGlobalFreeze

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:179

    • lsfNoFreeze

    lsfNoFreeze: 2097152
    @@ -145,7 +145,7 @@

    lsfNoFreeze

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:175

    • lsfPasswordSpent

    lsfPasswordSpent: 65536
    @@ -153,7 +153,7 @@

    lsfPasswordSpent

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:155

    • lsfRequireAuth

    lsfRequireAuth: 262144
    @@ -161,7 +161,7 @@

    lsfRequireAuth

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:163

    • lsfRequireDestTag

    lsfRequireDestTag: 131072
    @@ -169,7 +169,7 @@

    lsfRequireDestTag

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:159
    • diff --git a/docs/enums/LedgerEntry.OfferFlags.html b/docs/enums/LedgerEntry.OfferFlags.html index 395a53da4e..5977657358 100644 --- a/docs/enums/LedgerEntry.OfferFlags.html +++ b/docs/enums/LedgerEntry.OfferFlags.html @@ -23,7 +23,7 @@
  • OfferFlags

    • Enumeration OfferFlags

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:39
    • @@ -40,12 +40,12 @@

    Enumeration Members

    lsfPassive

    lsfPassive: 65536
    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:40

    • lsfSell

    lsfSell: 131072
    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:41
    • diff --git a/docs/enums/LedgerEntry.RippleStateFlags.html b/docs/enums/LedgerEntry.RippleStateFlags.html index adab12ebaa..683e5fa610 100644 --- a/docs/enums/LedgerEntry.RippleStateFlags.html +++ b/docs/enums/LedgerEntry.RippleStateFlags.html @@ -23,7 +23,7 @@
  • RippleStateFlags

    • Enumeration RippleStateFlags

    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:66
    • @@ -46,42 +46,42 @@

    Enumeration Members

    lsfHighAuth

    lsfHighAuth: 524288
    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:71

    • lsfHighFreeze

    lsfHighFreeze: 8388608
    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:77

    • lsfHighNoRipple

    lsfHighNoRipple: 2097152
    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:73

    • lsfHighReserve

    lsfHighReserve: 131072
    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:69

    • lsfLowAuth

    lsfLowAuth: 262144
    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:70

    • lsfLowFreeze

    lsfLowFreeze: 4194304
    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:75

    • lsfLowNoRipple

    lsfLowNoRipple: 1048576
    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:72

    • lsfLowReserve

    lsfLowReserve: 65536
    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:68
    • diff --git a/docs/enums/LedgerEntry.SignerListFlags.html b/docs/enums/LedgerEntry.SignerListFlags.html index 08720f2ed5..9d25a9f052 100644 --- a/docs/enums/LedgerEntry.SignerListFlags.html +++ b/docs/enums/LedgerEntry.SignerListFlags.html @@ -23,7 +23,7 @@
  • SignerListFlags

    • Enumeration SignerListFlags

    +
  • Defined in packages/xrpl/src/models/ledger/SignerList.ts:43
    • @@ -39,7 +39,7 @@

    Enumeration Members

    lsfOneOwnerCount

    lsfOneOwnerCount: 65536
    +
  • Defined in packages/xrpl/src/models/ledger/SignerList.ts:45
    • diff --git a/docs/enums/NFTokenCreateOfferFlags.html b/docs/enums/NFTokenCreateOfferFlags.html index 525556e728..0a62b71df5 100644 --- a/docs/enums/NFTokenCreateOfferFlags.html +++ b/docs/enums/NFTokenCreateOfferFlags.html @@ -26,7 +26,7 @@

    Enumeration NFTokenCreateOfferFlags

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:22
    • @@ -46,7 +46,7 @@

    tfSellNFToken

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:27
    • diff --git a/docs/enums/NFTokenMintFlags.html b/docs/enums/NFTokenMintFlags.html index 8e5a61a686..54a14d4d49 100644 --- a/docs/enums/NFTokenMintFlags.html +++ b/docs/enums/NFTokenMintFlags.html @@ -26,7 +26,7 @@

    Enumeration NFTokenMintFlags

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:19
    • @@ -50,7 +50,7 @@

    tfBurnable

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:25

    • tfOnlyXRP

    tfOnlyXRP: 2
    @@ -58,7 +58,7 @@

    tfOnlyXRP

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:29

    • tfTransferable

    tfTransferable: 8
    @@ -68,7 +68,7 @@

    tfTransferable

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:40

    • tfTrustLine

    tfTrustLine: 4
    @@ -77,7 +77,7 @@

    tfTrustLine

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:34
    • diff --git a/docs/enums/OfferCreateFlags.html b/docs/enums/OfferCreateFlags.html index 4aee0ac0e7..431d338b95 100644 --- a/docs/enums/OfferCreateFlags.html +++ b/docs/enums/OfferCreateFlags.html @@ -26,7 +26,7 @@

    Enumeration OfferCreateFlags

    +
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:16
    • @@ -53,7 +53,7 @@

    tfFillOrKill

    +
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:39

    • tfImmediateOrCancel

    tfImmediateOrCancel: 131072
    @@ -65,7 +65,7 @@

    tfImmediateOrCancel

    +
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:30

    • tfPassive

    tfPassive: 65536
    @@ -75,7 +75,7 @@

    tfPassive

    +
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:22

    • tfSell

    tfSell: 524288
    @@ -84,7 +84,7 @@

    tfSell

    +
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:44
    • diff --git a/docs/enums/PaymentChannelClaimFlags.html b/docs/enums/PaymentChannelClaimFlags.html index 18d0372718..842c295ad0 100644 --- a/docs/enums/PaymentChannelClaimFlags.html +++ b/docs/enums/PaymentChannelClaimFlags.html @@ -26,7 +26,7 @@

    Enumeration PaymentChannelClaimFlags

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:10
    • @@ -56,7 +56,7 @@

    tfClose

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:30

    • tfRenew

    tfRenew: 65536
    @@ -66,7 +66,7 @@

    tfRenew

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:16
    • diff --git a/docs/enums/PaymentFlags.html b/docs/enums/PaymentFlags.html index c5bb5fde5d..19767c79ce 100644 --- a/docs/enums/PaymentFlags.html +++ b/docs/enums/PaymentFlags.html @@ -26,7 +26,7 @@

    Enumeration PaymentFlags

    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:23
    • @@ -49,7 +49,7 @@

    tfLimitQuality

    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:41

    • tfNoDirectRipple

    tfNoDirectRipple: 65536
    @@ -59,7 +59,7 @@

    tfNoDirectRipple

    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:29

    • tfPartialPayment

    tfPartialPayment: 131072
    @@ -69,7 +69,7 @@

    tfPartialPayment

    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:35
    • diff --git a/docs/enums/TrustSetFlags.html b/docs/enums/TrustSetFlags.html index 2e3fa5f4bd..2fc33ea7c1 100644 --- a/docs/enums/TrustSetFlags.html +++ b/docs/enums/TrustSetFlags.html @@ -26,7 +26,7 @@

    Enumeration TrustSetFlags

    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:16
    • @@ -49,7 +49,7 @@

    tfClearFreeze

    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:32

    • tfClearNoRipple

    tfClearNoRipple: 262144
    @@ -57,7 +57,7 @@

    tfClearNoRipple

    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:28

    • tfSetFreeze

    tfSetFreeze: 1048576
    @@ -65,7 +65,7 @@

    tfSetFreeze

    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:30

    • tfSetNoRipple

    tfSetNoRipple: 131072
    @@ -74,7 +74,7 @@

    tfSetNoRipple

    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:26

    • tfSetfAuth

    tfSetfAuth: 65536
    @@ -83,7 +83,7 @@

    tfSetfAuth

    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:21
    • diff --git a/docs/enums/XChainModifyBridgeFlags.html b/docs/enums/XChainModifyBridgeFlags.html index 2699e30546..1d8745faee 100644 --- a/docs/enums/XChainModifyBridgeFlags.html +++ b/docs/enums/XChainModifyBridgeFlags.html @@ -26,7 +26,7 @@

    Enumeration XChainModifyBridgeFlags

    +
  • Defined in packages/xrpl/src/models/transactions/XChainModifyBridge.ts:18
    • @@ -45,7 +45,7 @@

    tfClearAccountCreateAm

    +
  • Defined in packages/xrpl/src/models/transactions/XChainModifyBridge.ts:20
    • diff --git a/docs/functions/convertHexToString.html b/docs/functions/convertHexToString.html index 760f909e8b..642dc78472 100644 --- a/docs/functions/convertHexToString.html +++ b/docs/functions/convertHexToString.html @@ -44,7 +44,7 @@

    Returns stringDeprecated

    use @xrplf/isomorphic/utils's hexToString

    +
  • Defined in packages/xrpl/src/utils/stringConversion.ts:28
    • diff --git a/docs/functions/convertStringToHex.html b/docs/functions/convertStringToHex.html index 792bbb6332..3d5da765ec 100644 --- a/docs/functions/convertStringToHex.html +++ b/docs/functions/convertStringToHex.html @@ -40,7 +40,7 @@

    Returns stringDeprecated

    use @xrplf/isomorphic/utils's stringToHex

    +
  • Defined in packages/xrpl/src/utils/stringConversion.ts:13
    • diff --git a/docs/functions/decimalToQuality.html b/docs/functions/decimalToQuality.html index 7049b4f274..5dd8d04cb5 100644 --- a/docs/functions/decimalToQuality.html +++ b/docs/functions/decimalToQuality.html @@ -42,7 +42,7 @@

    Throws

    ValidationError when the parameter is not convertible to "billionths" format.

    +
  • Defined in packages/xrpl/src/utils/quality.ts:79
    • diff --git a/docs/functions/decimalToTransferRate.html b/docs/functions/decimalToTransferRate.html index 71711f5d96..e3e10c793f 100644 --- a/docs/functions/decimalToTransferRate.html +++ b/docs/functions/decimalToTransferRate.html @@ -41,7 +41,7 @@

    Throws

    ValidationError when the parameter is not convertible to "billionths" format.

    +
  • Defined in packages/xrpl/src/utils/quality.ts:32
    • diff --git a/docs/functions/decode.html b/docs/functions/decode.html index 4025ca6bd1..d3e81d5d6f 100644 --- a/docs/functions/decode.html +++ b/docs/functions/decode.html @@ -38,7 +38,7 @@

    Returns Record

    +
  • Defined in packages/xrpl/src/utils/index.ts:132
    • diff --git a/docs/functions/deriveXAddress.html b/docs/functions/deriveXAddress.html index dc9aae73ff..cb4171a305 100644 --- a/docs/functions/deriveXAddress.html +++ b/docs/functions/deriveXAddress.html @@ -54,7 +54,7 @@

    Returns string

    +
  • Defined in packages/xrpl/src/utils/derive.ts:14
    • diff --git a/docs/functions/dropsToXrp.html b/docs/functions/dropsToXrp.html index 816315d3f4..daba9222bf 100644 --- a/docs/functions/dropsToXrp.html +++ b/docs/functions/dropsToXrp.html @@ -40,7 +40,7 @@

    Returns numberThrows

    When drops amount is invalid.

    +
  • Defined in packages/xrpl/src/utils/xrpConversion.ts:18
    • diff --git a/docs/functions/encode.html b/docs/functions/encode.html index 3581de0810..a07d312d1b 100644 --- a/docs/functions/encode.html +++ b/docs/functions/encode.html @@ -38,7 +38,7 @@

    Returns string

    +
  • Defined in packages/xrpl/src/utils/index.ts:91
    • diff --git a/docs/functions/encodeForMultiSigning.html b/docs/functions/encodeForMultiSigning.html index 73660d1732..9d01b75de3 100644 --- a/docs/functions/encodeForMultiSigning.html +++ b/docs/functions/encodeForMultiSigning.html @@ -42,7 +42,7 @@

    Returns string

    +
  • Defined in packages/xrpl/src/utils/index.ts:122
    • diff --git a/docs/functions/encodeForSigning.html b/docs/functions/encodeForSigning.html index d7ac072f1d..a42d60250a 100644 --- a/docs/functions/encodeForSigning.html +++ b/docs/functions/encodeForSigning.html @@ -38,7 +38,7 @@

    Returns string

    +
  • Defined in packages/xrpl/src/utils/index.ts:101
    • diff --git a/docs/functions/encodeForSigningClaim.html b/docs/functions/encodeForSigningClaim.html index 5e6aff6ebb..4c0a4a535c 100644 --- a/docs/functions/encodeForSigningClaim.html +++ b/docs/functions/encodeForSigningClaim.html @@ -38,7 +38,7 @@

    Returns string

    +
  • Defined in packages/xrpl/src/utils/index.ts:111
    • diff --git a/docs/functions/getBalanceChanges.html b/docs/functions/getBalanceChanges.html index fc6d3abcfe..be86549d51 100644 --- a/docs/functions/getBalanceChanges.html +++ b/docs/functions/getBalanceChanges.html @@ -39,7 +39,7 @@

    Returns {

    +
  • Defined in packages/xrpl/src/utils/getBalanceChanges.ts:161
    • diff --git a/docs/functions/getNFTokenID.html b/docs/functions/getNFTokenID.html index 174a6de61d..7531da9154 100644 --- a/docs/functions/getNFTokenID.html +++ b/docs/functions/getNFTokenID.html @@ -40,7 +40,7 @@

    Returns stringThrows

    if meta is not TransactionMetadata.

    +
  • Defined in packages/xrpl/src/utils/getNFTokenID.ts:36
    • diff --git a/docs/functions/getXChainClaimID.html b/docs/functions/getXChainClaimID.html index 26d1c460b3..d242228cbb 100644 --- a/docs/functions/getXChainClaimID.html +++ b/docs/functions/getXChainClaimID.html @@ -41,7 +41,7 @@

    Returns stringThrows

    if meta is not TransactionMetadata.

    +
  • Defined in packages/xrpl/src/utils/getXChainClaimID.ts:33
    • diff --git a/docs/functions/hasNextPage.html b/docs/functions/hasNextPage.html index c431388747..4bbe082dd2 100644 --- a/docs/functions/hasNextPage.html +++ b/docs/functions/hasNextPage.html @@ -41,7 +41,7 @@

    Returns boolean

    +
  • Defined in packages/xrpl/src/utils/index.ts:160
    • diff --git a/docs/functions/isCreatedNode.html b/docs/functions/isCreatedNode.html index 86fc203866..2d65dd11fc 100644 --- a/docs/functions/isCreatedNode.html +++ b/docs/functions/isCreatedNode.html @@ -38,7 +38,7 @@

    Returns node

    +
  • Defined in packages/xrpl/src/models/transactions/metadata.ts:55
    • diff --git a/docs/functions/isDeletedNode.html b/docs/functions/isDeletedNode.html index 54b9e8869d..b7fc52d530 100644 --- a/docs/functions/isDeletedNode.html +++ b/docs/functions/isDeletedNode.html @@ -38,7 +38,7 @@

    Returns node

    +
  • Defined in packages/xrpl/src/models/transactions/metadata.ts:75
    • diff --git a/docs/functions/isModifiedNode.html b/docs/functions/isModifiedNode.html index f47c71f153..89a4acec31 100644 --- a/docs/functions/isModifiedNode.html +++ b/docs/functions/isModifiedNode.html @@ -38,7 +38,7 @@

    Returns node

    +
  • Defined in packages/xrpl/src/models/transactions/metadata.ts:65
    • diff --git a/docs/functions/isValidAddress.html b/docs/functions/isValidAddress.html index d3112848bc..8db3c15735 100644 --- a/docs/functions/isValidAddress.html +++ b/docs/functions/isValidAddress.html @@ -39,7 +39,7 @@

    Returns boolean

    +
  • Defined in packages/xrpl/src/utils/index.ts:144
    • diff --git a/docs/functions/isValidSecret.html b/docs/functions/isValidSecret.html index db80329074..fe1284f894 100644 --- a/docs/functions/isValidSecret.html +++ b/docs/functions/isValidSecret.html @@ -38,7 +38,7 @@

    Returns boolean

    +
  • Defined in packages/xrpl/src/utils/index.ts:76
    • diff --git a/docs/functions/isoTimeToRippleTime.html b/docs/functions/isoTimeToRippleTime.html index cd1b51621c..1b6c9488e6 100644 --- a/docs/functions/isoTimeToRippleTime.html +++ b/docs/functions/isoTimeToRippleTime.html @@ -38,7 +38,7 @@

    Returns number

    +
  • Defined in packages/xrpl/src/utils/timeConversion.ts:43
    • diff --git a/docs/functions/keyToRFC1751Mnemonic.html b/docs/functions/keyToRFC1751Mnemonic.html index ac1deabab3..d421aa08cb 100644 --- a/docs/functions/keyToRFC1751Mnemonic.html +++ b/docs/functions/keyToRFC1751Mnemonic.html @@ -38,7 +38,7 @@

    Returns string

    +
  • Defined in packages/xrpl/src/Wallet/rfc1751.ts:62
    • diff --git a/docs/functions/multisign.html b/docs/functions/multisign.html index e7ba337fb9..54a62806fb 100644 --- a/docs/functions/multisign.html +++ b/docs/functions/multisign.html @@ -46,7 +46,7 @@

    Throws

    ValidationError if:

    +
  • Defined in packages/xrpl/src/Wallet/signer.ts:23
    • diff --git a/docs/functions/parseAccountRootFlags.html b/docs/functions/parseAccountRootFlags.html index 4bf54f5a5f..905dfaa402 100644 --- a/docs/functions/parseAccountRootFlags.html +++ b/docs/functions/parseAccountRootFlags.html @@ -38,7 +38,7 @@

    Returns

    +
  • Defined in packages/xrpl/src/models/utils/flags.ts:30
    • diff --git a/docs/functions/parseNFTokenID.html b/docs/functions/parseNFTokenID.html index 61eb211bc8..fcb4f48b4e 100644 --- a/docs/functions/parseNFTokenID.html +++ b/docs/functions/parseNFTokenID.html @@ -63,7 +63,7 @@
    TransferFee
    +
  • Defined in packages/xrpl/src/utils/parseNFTokenID.ts:65
    • diff --git a/docs/functions/percentToQuality.html b/docs/functions/percentToQuality.html index 13d7741da7..51a5af7162 100644 --- a/docs/functions/percentToQuality.html +++ b/docs/functions/percentToQuality.html @@ -42,7 +42,7 @@

    Throws

    ValidationError when the percent parameter is not convertible "billionths" format.

    +
  • Defined in packages/xrpl/src/utils/quality.ts:167
    • diff --git a/docs/functions/percentToTransferRate.html b/docs/functions/percentToTransferRate.html index 5df99676c9..6e89490c62 100644 --- a/docs/functions/percentToTransferRate.html +++ b/docs/functions/percentToTransferRate.html @@ -41,7 +41,7 @@

    Throws

    ValidationError when the percent parameter is not convertible "billionths" format.

    +
  • Defined in packages/xrpl/src/utils/quality.ts:65
    • diff --git a/docs/functions/qualityToDecimal.html b/docs/functions/qualityToDecimal.html index 20bcbe5fcb..254c66233b 100644 --- a/docs/functions/qualityToDecimal.html +++ b/docs/functions/qualityToDecimal.html @@ -40,7 +40,7 @@

    Returns stringThrows

    ValidationError when quality is not convertible to decimal format.

    +
  • Defined in packages/xrpl/src/utils/quality.ts:111
    • diff --git a/docs/functions/rfc1751MnemonicToKey.html b/docs/functions/rfc1751MnemonicToKey.html index f17f1ea743..9267b4f9a0 100644 --- a/docs/functions/rfc1751MnemonicToKey.html +++ b/docs/functions/rfc1751MnemonicToKey.html @@ -40,7 +40,7 @@

    Returns Uint8Arr

    Throws

    Error if the parity after decoding does not match.

    +
  • Defined in packages/xrpl/src/Wallet/rfc1751.ts:102
    • diff --git a/docs/functions/rippleTimeToISOTime.html b/docs/functions/rippleTimeToISOTime.html index 7ce2606621..8d1bf237df 100644 --- a/docs/functions/rippleTimeToISOTime.html +++ b/docs/functions/rippleTimeToISOTime.html @@ -38,7 +38,7 @@

    Returns string

    +
  • Defined in packages/xrpl/src/utils/timeConversion.ts:32
    • diff --git a/docs/functions/rippleTimeToUnixTime.html b/docs/functions/rippleTimeToUnixTime.html index 5ffc3a9c5e..9b0b856c93 100644 --- a/docs/functions/rippleTimeToUnixTime.html +++ b/docs/functions/rippleTimeToUnixTime.html @@ -38,7 +38,7 @@

    Returns number

    +
  • Defined in packages/xrpl/src/utils/timeConversion.ts:10
    • diff --git a/docs/functions/setTransactionFlagsToNumber.html b/docs/functions/setTransactionFlagsToNumber.html index bbf008cb9f..93233f9089 100644 --- a/docs/functions/setTransactionFlagsToNumber.html +++ b/docs/functions/setTransactionFlagsToNumber.html @@ -37,7 +37,7 @@
    tx: Returns void
    +
  • Defined in packages/xrpl/src/models/utils/flags.ts:66
    • diff --git a/docs/functions/signPaymentChannelClaim.html b/docs/functions/signPaymentChannelClaim.html index 90b83dc510..d304ac2d0d 100644 --- a/docs/functions/signPaymentChannelClaim.html +++ b/docs/functions/signPaymentChannelClaim.html @@ -46,7 +46,7 @@

    Returns string

    +
  • Defined in packages/xrpl/src/utils/signPaymentChannelClaim.ts:15
    • diff --git a/docs/functions/transferRateToDecimal.html b/docs/functions/transferRateToDecimal.html index 92e7fdbf85..cdef366231 100644 --- a/docs/functions/transferRateToDecimal.html +++ b/docs/functions/transferRateToDecimal.html @@ -40,7 +40,7 @@

    Returns stringThrows

    ValidationError when it cannot convert from billionths format.

    +
  • Defined in packages/xrpl/src/utils/quality.ts:137
    • diff --git a/docs/functions/unixTimeToRippleTime.html b/docs/functions/unixTimeToRippleTime.html index 1a96c0a8f4..ec51245885 100644 --- a/docs/functions/unixTimeToRippleTime.html +++ b/docs/functions/unixTimeToRippleTime.html @@ -38,7 +38,7 @@

    Returns number

    +
  • Defined in packages/xrpl/src/utils/timeConversion.ts:21
    • diff --git a/docs/functions/validate.html b/docs/functions/validate.html index 13bb912c06..d5117b5d7a 100644 --- a/docs/functions/validate.html +++ b/docs/functions/validate.html @@ -40,7 +40,7 @@

    Returns voidThrows

    ValidationError When the Transaction is malformed.

    +
  • Defined in packages/xrpl/src/models/transactions/transaction.ts:172
    • diff --git a/docs/functions/verifyPaymentChannelClaim.html b/docs/functions/verifyPaymentChannelClaim.html index 80eb05d561..1ea4e8440b 100644 --- a/docs/functions/verifyPaymentChannelClaim.html +++ b/docs/functions/verifyPaymentChannelClaim.html @@ -50,7 +50,7 @@

    Returns boolean

    +
  • Defined in packages/xrpl/src/utils/verifyPaymentChannelClaim.ts:17
    • diff --git a/docs/functions/verifySignature.html b/docs/functions/verifySignature.html index f34ed88264..77a166f3e6 100644 --- a/docs/functions/verifySignature.html +++ b/docs/functions/verifySignature.html @@ -46,7 +46,7 @@

    Throws

    Error when transaction is missing TxnSignature

    Throws

    Error when publicKey is not provided and transaction is missing SigningPubKey

    +
  • Defined in packages/xrpl/src/Wallet/signer.ts:68
    • diff --git a/docs/functions/walletFromSecretNumbers.html b/docs/functions/walletFromSecretNumbers.html index a4d2ce1041..063dd7b571 100644 --- a/docs/functions/walletFromSecretNumbers.html +++ b/docs/functions/walletFromSecretNumbers.html @@ -58,7 +58,7 @@

    Returns

    +
  • Defined in packages/xrpl/src/Wallet/walletFromSecretNumbers.ts:20
    • diff --git a/docs/functions/xrpToDrops.html b/docs/functions/xrpToDrops.html index 3a99bc4c82..eadaba46bf 100644 --- a/docs/functions/xrpToDrops.html +++ b/docs/functions/xrpToDrops.html @@ -40,7 +40,7 @@

    Returns stringThrows

    When amount in xrp is invalid.

    +
  • Defined in packages/xrpl/src/utils/xrpConversion.ts:64
    • diff --git a/docs/interfaces/AMMBid.html b/docs/interfaces/AMMBid.html index 7105422ae9..4c9ca2416e 100644 --- a/docs/interfaces/AMMBid.html +++ b/docs/interfaces/AMMBid.html @@ -36,7 +36,7 @@

    Hierarchy

    • AMMBid
    +
  • Defined in packages/xrpl/src/models/transactions/AMMBid.ts:21
    • @@ -74,7 +74,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -85,7 +85,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Asset

    Asset: Currency
    @@ -93,7 +93,7 @@

    Asset

    +
  • Defined in packages/xrpl/src/models/transactions/AMMBid.ts:27

    • Asset2

    Asset2: Currency
    @@ -101,7 +101,7 @@

    Asset2

    +
  • Defined in packages/xrpl/src/models/transactions/AMMBid.ts:32

    • Optional AuthAccounts

    AuthAccounts?: AuthAccount[]
    @@ -110,7 +110,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/AMMBid.ts:52

    • Optional BidMax

    BidMax?: IssuedCurrencyAmount
    @@ -120,7 +120,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/AMMBid.ts:46

    • Optional BidMin

    BidMin?: IssuedCurrencyAmount
    @@ -130,7 +130,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/AMMBid.ts:39

    • Optional Fee

    Fee?: string
    @@ -141,7 +141,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -150,7 +150,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -161,7 +161,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -170,7 +170,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -179,7 +179,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional Sequence

    Sequence?: number
    @@ -191,7 +191,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -201,7 +201,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -212,7 +212,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -224,7 +224,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -234,7 +234,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "AMMBid"
    @@ -244,7 +244,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/AMMBid.ts:22

    • Optional TxnSignature

    TxnSignature?: string
    @@ -254,7 +254,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289
    • diff --git a/docs/interfaces/AMMCreate.html b/docs/interfaces/AMMCreate.html index 8767069025..f15f381f7c 100644 --- a/docs/interfaces/AMMCreate.html +++ b/docs/interfaces/AMMCreate.html @@ -40,7 +40,7 @@

    Hierarchy

    • AMMCreate
    +
  • Defined in packages/xrpl/src/models/transactions/AMMCreate.ts:21
    • @@ -76,7 +76,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -87,7 +87,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Amount

    Amount: Amount
    @@ -95,7 +95,7 @@

    Amount

    +
  • Defined in packages/xrpl/src/models/transactions/AMMCreate.ts:27

    • Amount2

    Amount2: Amount
    @@ -103,7 +103,7 @@

    Amount2

    +
  • Defined in packages/xrpl/src/models/transactions/AMMCreate.ts:32

    • Optional Fee

    Fee?: string
    @@ -114,7 +114,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -123,7 +123,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -134,7 +134,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -143,7 +143,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -152,7 +152,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional Sequence

    Sequence?: number
    @@ -164,7 +164,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -174,7 +174,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -185,7 +185,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -197,7 +197,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -207,7 +207,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TradingFee

    TradingFee: number
    @@ -217,7 +217,7 @@

    TradingFee

    +
  • Defined in packages/xrpl/src/models/transactions/AMMCreate.ts:39

    • TransactionType

    TransactionType: "AMMCreate"
    @@ -227,7 +227,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/AMMCreate.ts:22

    • Optional TxnSignature

    TxnSignature?: string
    @@ -237,7 +237,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289
    • diff --git a/docs/interfaces/AMMDelete.html b/docs/interfaces/AMMDelete.html index f40c4e0787..56c7c2006f 100644 --- a/docs/interfaces/AMMDelete.html +++ b/docs/interfaces/AMMDelete.html @@ -39,7 +39,7 @@

    Hierarchy

    • AMMDelete
    +
  • Defined in packages/xrpl/src/models/transactions/AMMDelete.ts:17
    • @@ -74,7 +74,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -85,7 +85,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Asset

    Asset: Currency
    @@ -93,7 +93,7 @@

    Asset

    +
  • Defined in packages/xrpl/src/models/transactions/AMMDelete.ts:23

    • Asset2

    Asset2: Currency
    @@ -101,7 +101,7 @@

    Asset2

    +
  • Defined in packages/xrpl/src/models/transactions/AMMDelete.ts:28

    • Optional Fee

    Fee?: string
    @@ -112,7 +112,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -121,7 +121,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -132,7 +132,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -141,7 +141,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -150,7 +150,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional Sequence

    Sequence?: number
    @@ -162,7 +162,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -172,7 +172,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -183,7 +183,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -195,7 +195,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -205,7 +205,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "AMMDelete"
    @@ -215,7 +215,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/AMMDelete.ts:18

    • Optional TxnSignature

    TxnSignature?: string
    @@ -225,7 +225,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289
    • diff --git a/docs/interfaces/AMMDeposit.html b/docs/interfaces/AMMDeposit.html index d176b84972..9ba4c3f8fe 100644 --- a/docs/interfaces/AMMDeposit.html +++ b/docs/interfaces/AMMDeposit.html @@ -35,7 +35,7 @@

    Hierarchy

    • AMMDeposit
    +
  • Defined in packages/xrpl/src/models/transactions/AMMDeposit.ts:41
    • @@ -74,7 +74,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -85,7 +85,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Optional Amount

    Amount?: Amount
    @@ -94,7 +94,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/AMMDeposit.ts:58

    • Optional Amount2

    Amount2?: Amount
    @@ -103,7 +103,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/AMMDeposit.ts:64

    • Asset

    Asset: Currency
    @@ -111,7 +111,7 @@

    Asset

    +
  • Defined in packages/xrpl/src/models/transactions/AMMDeposit.ts:47

    • Asset2

    Asset2: Currency
    @@ -119,7 +119,7 @@

    Asset2

    +
  • Defined in packages/xrpl/src/models/transactions/AMMDeposit.ts:52

    • Optional EPrice

    EPrice?: Amount
    @@ -127,7 +127,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/AMMDeposit.ts:69

    • Optional Fee

    Fee?: string
    @@ -138,7 +138,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -147,7 +147,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LPTokenOut

    LPTokenOut?: IssuedCurrencyAmount
    @@ -155,7 +155,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/AMMDeposit.ts:74

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -166,7 +166,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -175,7 +175,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -184,7 +184,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional Sequence

    Sequence?: number
    @@ -196,7 +196,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -206,7 +206,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -217,7 +217,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -229,7 +229,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -239,7 +239,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "AMMDeposit"
    @@ -249,7 +249,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/AMMDeposit.ts:42

    • Optional TxnSignature

    TxnSignature?: string
    @@ -259,7 +259,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289
    • diff --git a/docs/interfaces/AMMDepositFlagsInterface.html b/docs/interfaces/AMMDepositFlagsInterface.html index 2f277d5a21..3edf142fac 100644 --- a/docs/interfaces/AMMDepositFlagsInterface.html +++ b/docs/interfaces/AMMDepositFlagsInterface.html @@ -28,7 +28,7 @@

    Hierarchy

    • AMMDepositFlagsInterface
    +
  • Defined in packages/xrpl/src/models/transactions/AMMDeposit.ts:26
    • @@ -48,27 +48,27 @@

    Properties

    Optional tfLPToken

    tfLPToken?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/AMMDeposit.ts:27

    • Optional tfLimitLPToken

    tfLimitLPToken?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/AMMDeposit.ts:31

    • Optional tfOneAssetLPToken

    tfOneAssetLPToken?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/AMMDeposit.ts:30

    • Optional tfSingleAsset

    tfSingleAsset?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/AMMDeposit.ts:28

    • Optional tfTwoAsset

    tfTwoAsset?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/AMMDeposit.ts:29
    • diff --git a/docs/interfaces/AMMInfoRequest.html b/docs/interfaces/AMMInfoRequest.html index 0a457c0299..17bdaab118 100644 --- a/docs/interfaces/AMMInfoRequest.html +++ b/docs/interfaces/AMMInfoRequest.html @@ -33,7 +33,7 @@

    Hierarchy

    • AMMInfoRequest
    +
  • Defined in packages/xrpl/src/models/methods/ammInfo.ts:11
    • @@ -57,7 +57,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ammInfo.ts:17

    • Optional api_version

    api_version?: number
    @@ -66,7 +66,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • Optional asset

    asset?: Currency
    @@ -74,7 +74,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ammInfo.ts:22

    • Optional asset2

    asset2?: Currency
    @@ -82,7 +82,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ammInfo.ts:27

    • command

    command: "amm_info"
    @@ -91,7 +91,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/ammInfo.ts:12

    • Optional id

    id?: string | number
    @@ -102,7 +102,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12
    • diff --git a/docs/interfaces/AMMInfoResponse.html b/docs/interfaces/AMMInfoResponse.html index ec78f10426..54f5d25b15 100644 --- a/docs/interfaces/AMMInfoResponse.html +++ b/docs/interfaces/AMMInfoResponse.html @@ -32,7 +32,7 @@

    Hierarchy

    • AMMInfoResponse
    +
  • Defined in packages/xrpl/src/models/methods/ammInfo.ts:35
    • @@ -56,19 +56,19 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • result

    result: {
        amm: {
            account: string;
            amount: Amount;
            amount2: Amount;
            asset2_frozen?: boolean;
            asset_frozen?: boolean;
            auction_slot?: {
                account: string;
                auth_accounts: {
                    account: string;
                }[];
                discounted_fee: number;
                expiration: string;
                price: IssuedCurrencyAmount;
                time_interval: number;
            };
            lp_token: IssuedCurrencyAmount;
            trading_fee: number;
            vote_slots?: {
                account: string;
                trading_fee: number;
                vote_weight: number;
            }[];
        };
        ledger_hash?: string;
        ledger_index?: number;
        validated?: boolean;
    }
    @@ -186,31 +186,31 @@
    Optional
    +
  • Defined in packages/xrpl/src/models/methods/ammInfo.ts:36

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/AMMVote.html b/docs/interfaces/AMMVote.html index 6fb76b15b8..33f891753b 100644 --- a/docs/interfaces/AMMVote.html +++ b/docs/interfaces/AMMVote.html @@ -34,7 +34,7 @@

    Hierarchy

    • AMMVote
    +
  • Defined in packages/xrpl/src/models/transactions/AMMVote.ts:13
    • @@ -70,7 +70,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -81,7 +81,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Asset

    Asset: Currency
    @@ -89,7 +89,7 @@

    Asset

    +
  • Defined in packages/xrpl/src/models/transactions/AMMVote.ts:19

    • Asset2

    Asset2: Currency
    @@ -97,7 +97,7 @@

    Asset2

    +
  • Defined in packages/xrpl/src/models/transactions/AMMVote.ts:24

    • Optional Fee

    Fee?: string
    @@ -108,7 +108,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -117,7 +117,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -128,7 +128,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -137,7 +137,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -146,7 +146,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional Sequence

    Sequence?: number
    @@ -158,7 +158,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -168,7 +168,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -179,7 +179,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -191,7 +191,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -201,7 +201,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TradingFee

    TradingFee: number
    @@ -210,7 +210,7 @@

    TradingFee

    +
  • Defined in packages/xrpl/src/models/transactions/AMMVote.ts:30

    • TransactionType

    TransactionType: "AMMVote"
    @@ -220,7 +220,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/AMMVote.ts:14

    • Optional TxnSignature

    TxnSignature?: string
    @@ -230,7 +230,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289
    • diff --git a/docs/interfaces/AMMWithdraw.html b/docs/interfaces/AMMWithdraw.html index d92a3662a1..f47fd0ff1b 100644 --- a/docs/interfaces/AMMWithdraw.html +++ b/docs/interfaces/AMMWithdraw.html @@ -32,7 +32,7 @@

    Hierarchy

    • AMMWithdraw
    +
  • Defined in packages/xrpl/src/models/transactions/AMMWithdraw.ts:41
    • @@ -71,7 +71,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -82,7 +82,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Optional Amount

    Amount?: Amount
    @@ -91,7 +91,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/AMMWithdraw.ts:58

    • Optional Amount2

    Amount2?: Amount
    @@ -100,7 +100,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/AMMWithdraw.ts:64

    • Asset

    Asset: Currency
    @@ -108,7 +108,7 @@

    Asset

    +
  • Defined in packages/xrpl/src/models/transactions/AMMWithdraw.ts:47

    • Asset2

    Asset2: Currency
    @@ -116,7 +116,7 @@

    Asset2

    +
  • Defined in packages/xrpl/src/models/transactions/AMMWithdraw.ts:52

    • Optional EPrice

    EPrice?: Amount
    @@ -124,7 +124,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/AMMWithdraw.ts:69

    • Optional Fee

    Fee?: string
    @@ -135,7 +135,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -144,7 +144,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LPTokenIn

    LPTokenIn?: IssuedCurrencyAmount
    @@ -152,7 +152,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/AMMWithdraw.ts:74

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -163,7 +163,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -172,7 +172,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -181,7 +181,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional Sequence

    Sequence?: number
    @@ -193,7 +193,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -203,7 +203,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -214,7 +214,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -226,7 +226,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -236,7 +236,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "AMMWithdraw"
    @@ -246,7 +246,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/AMMWithdraw.ts:42

    • Optional TxnSignature

    TxnSignature?: string
    @@ -256,7 +256,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289
    • diff --git a/docs/interfaces/AMMWithdrawFlagsInterface.html b/docs/interfaces/AMMWithdrawFlagsInterface.html index 51560f1283..073111d446 100644 --- a/docs/interfaces/AMMWithdrawFlagsInterface.html +++ b/docs/interfaces/AMMWithdrawFlagsInterface.html @@ -28,7 +28,7 @@

    Hierarchy

    • AMMWithdrawFlagsInterface
    +
  • Defined in packages/xrpl/src/models/transactions/AMMWithdraw.ts:28
    • @@ -50,37 +50,37 @@

    Properties

    Optional tfLPToken

    tfLPToken?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/AMMWithdraw.ts:29

    • Optional tfLimitLPToken

    tfLimitLPToken?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/AMMWithdraw.ts:35

    • Optional tfOneAssetLPToken

    tfOneAssetLPToken?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/AMMWithdraw.ts:34

    • Optional tfOneAssetWithdrawAll

    tfOneAssetWithdrawAll?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/AMMWithdraw.ts:31

    • Optional tfSingleAsset

    tfSingleAsset?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/AMMWithdraw.ts:32

    • Optional tfTwoAsset

    tfTwoAsset?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/AMMWithdraw.ts:33

    • Optional tfWithdrawAll

    tfWithdrawAll?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/AMMWithdraw.ts:30
    • diff --git a/docs/interfaces/AccountChannelsRequest.html b/docs/interfaces/AccountChannelsRequest.html index bc79fe1f63..1655810686 100644 --- a/docs/interfaces/AccountChannelsRequest.html +++ b/docs/interfaces/AccountChannelsRequest.html @@ -37,7 +37,7 @@

    Hierarchy

    • AccountChannelsRequest
    +
  • Defined in packages/xrpl/src/models/methods/accountChannels.ts:27
    • @@ -65,7 +65,7 @@

    account

    +
  • Defined in packages/xrpl/src/models/methods/accountChannels.ts:36

    • Optional api_version

    api_version?: number
    @@ -74,7 +74,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "account_channels"
    @@ -83,7 +83,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/accountChannels.ts:30

    • Optional destination_account

    destination_account?: string
    @@ -93,7 +93,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountChannels.ts:42

    • Optional id

    id?: string | number
    @@ -104,7 +104,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional ledger_hash

    ledger_hash?: string
    @@ -113,7 +113,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:21

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -122,7 +122,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:23

    • Optional limit

    limit?: number
    @@ -131,7 +131,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountChannels.ts:47

    • Optional marker

    marker?: unknown
    @@ -140,7 +140,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountChannels.ts:52
    • diff --git a/docs/interfaces/AccountChannelsResponse.html b/docs/interfaces/AccountChannelsResponse.html index b21ddf0732..642e7630d0 100644 --- a/docs/interfaces/AccountChannelsResponse.html +++ b/docs/interfaces/AccountChannelsResponse.html @@ -32,7 +32,7 @@

    Hierarchy

    • AccountChannelsResponse
    +
  • Defined in packages/xrpl/src/models/methods/accountChannels.ts:60
    • @@ -56,19 +56,19 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • result

    result: {
        account: string;
        channels: Channel[];
        ledger_hash: string;
        ledger_index: number;
        limit?: number;
        marker?: unknown;
        validated?: boolean;
    }
    @@ -118,31 +118,31 @@
    Optional
    +
  • Defined in packages/xrpl/src/models/methods/accountChannels.ts:61

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/AccountCurrenciesRequest.html b/docs/interfaces/AccountCurrenciesRequest.html index 8f48d0f7b8..d33f69b619 100644 --- a/docs/interfaces/AccountCurrenciesRequest.html +++ b/docs/interfaces/AccountCurrenciesRequest.html @@ -35,7 +35,7 @@

    Hierarchy

    • AccountCurrenciesRequest
    +
  • Defined in packages/xrpl/src/models/methods/accountCurrencies.ts:10
    • @@ -60,7 +60,7 @@

    account

    +
  • Defined in packages/xrpl/src/models/methods/accountCurrencies.ts:15

    • Optional api_version

    api_version?: number
    @@ -69,7 +69,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "account_currencies"
    @@ -78,7 +78,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/accountCurrencies.ts:13

    • Optional id

    id?: string | number
    @@ -89,7 +89,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional ledger_hash

    ledger_hash?: string
    @@ -98,7 +98,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:21

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -107,7 +107,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:23

    • Optional strict

    strict?: boolean
    @@ -117,7 +117,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountCurrencies.ts:21
    • diff --git a/docs/interfaces/AccountCurrenciesResponse.html b/docs/interfaces/AccountCurrenciesResponse.html index 4c3e6be0fe..1a13f50105 100644 --- a/docs/interfaces/AccountCurrenciesResponse.html +++ b/docs/interfaces/AccountCurrenciesResponse.html @@ -32,7 +32,7 @@

    Hierarchy

    • AccountCurrenciesResponse
    +
  • Defined in packages/xrpl/src/models/methods/accountCurrencies.ts:29
    • @@ -56,19 +56,19 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • result

    result: {
        ledger_hash?: string;
        ledger_index: number;
        receive_currencies: string[];
        send_currencies: string[];
        validated: boolean;
    }
    @@ -103,31 +103,31 @@
    validated
    +
  • Defined in packages/xrpl/src/models/methods/accountCurrencies.ts:30

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/AccountDelete.html b/docs/interfaces/AccountDelete.html index 18f9d51193..0756e22ea0 100644 --- a/docs/interfaces/AccountDelete.html +++ b/docs/interfaces/AccountDelete.html @@ -34,7 +34,7 @@

    Hierarchy

    • AccountDelete
    +
  • Defined in packages/xrpl/src/models/transactions/accountDelete.ts:18
    • @@ -69,7 +69,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -80,7 +80,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Destination

    Destination: string
    @@ -90,7 +90,7 @@

    Destination

    +
  • Defined in packages/xrpl/src/models/transactions/accountDelete.ts:25

    • Optional DestinationTag

    DestinationTag?: number
    @@ -99,7 +99,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/accountDelete.ts:30

    • Optional Fee

    Fee?: string
    @@ -110,7 +110,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -119,7 +119,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -130,7 +130,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -139,7 +139,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -148,7 +148,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional Sequence

    Sequence?: number
    @@ -160,7 +160,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -170,7 +170,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -181,7 +181,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -193,7 +193,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -203,7 +203,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "AccountDelete"
    @@ -213,7 +213,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/accountDelete.ts:19

    • Optional TxnSignature

    TxnSignature?: string
    @@ -223,7 +223,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289
    • diff --git a/docs/interfaces/AccountInfoAccountFlags.html b/docs/interfaces/AccountInfoAccountFlags.html index 62a4d40747..c7eedb5158 100644 --- a/docs/interfaces/AccountInfoAccountFlags.html +++ b/docs/interfaces/AccountInfoAccountFlags.html @@ -26,7 +26,7 @@

    Hierarchy

    • AccountInfoAccountFlags
    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:76
    • @@ -58,7 +58,7 @@

    allowTrustLineClawback

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:133

    • defaultRipple

    defaultRipple: boolean
    @@ -66,7 +66,7 @@

    defaultRipple

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:80

    • depositAuth

    depositAuth: boolean
    @@ -75,7 +75,7 @@

    depositAuth

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:85

    • disableMasterKey

    disableMasterKey: boolean
    @@ -83,7 +83,7 @@

    disableMasterKey

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:89

    • Optional disallowIncomingCheck

    disallowIncomingCheck?: boolean
    @@ -91,7 +91,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:93

    • Optional disallowIncomingNFTokenOffer

    disallowIncomingNFTokenOffer?: boolean
    @@ -99,7 +99,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:97

    • Optional disallowIncomingPayChan

    disallowIncomingPayChan?: boolean
    @@ -107,7 +107,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:101

    • Optional disallowIncomingTrustline

    disallowIncomingTrustline?: boolean
    @@ -115,7 +115,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:105

    • disallowIncomingXRP

    disallowIncomingXRP: boolean
    @@ -123,7 +123,7 @@

    disallowIncomingXRP

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:109

    • globalFreeze

    globalFreeze: boolean
    @@ -131,7 +131,7 @@

    globalFreeze

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:113

    • noFreeze

    noFreeze: boolean
    @@ -139,7 +139,7 @@

    noFreeze

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:117

    • passwordSpent

    passwordSpent: boolean
    @@ -147,7 +147,7 @@

    passwordSpent

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:121

    • requireAuthorization

    requireAuthorization: boolean
    @@ -155,7 +155,7 @@

    requireAuthorization

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:125

    • requireDestinationTag

    requireDestinationTag: boolean
    @@ -163,7 +163,7 @@

    requireDestinationTag

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:129
    • diff --git a/docs/interfaces/AccountInfoRequest.html b/docs/interfaces/AccountInfoRequest.html index e656b8b8f9..84bd44946b 100644 --- a/docs/interfaces/AccountInfoRequest.html +++ b/docs/interfaces/AccountInfoRequest.html @@ -35,7 +35,7 @@

    Hierarchy

    • AccountInfoRequest
    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:12
    • @@ -62,7 +62,7 @@

    account

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:15

    • Optional api_version

    api_version?: number
    @@ -71,7 +71,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "account_info"
    @@ -80,7 +80,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:13

    • Optional id

    id?: string | number
    @@ -91,7 +91,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional ledger_hash

    ledger_hash?: string
    @@ -100,7 +100,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:21

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -109,7 +109,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:23

    • Optional queue

    queue?: boolean
    @@ -119,7 +119,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:21

    • Optional signer_lists

    signer_lists?: boolean
    @@ -127,7 +127,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:25

    • Optional strict

    strict?: boolean
    @@ -137,7 +137,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:31
    • diff --git a/docs/interfaces/AccountInfoResponse.html b/docs/interfaces/AccountInfoResponse.html index 7a55530c83..1e146c04a8 100644 --- a/docs/interfaces/AccountInfoResponse.html +++ b/docs/interfaces/AccountInfoResponse.html @@ -32,7 +32,7 @@

    Hierarchy

    • AccountInfoResponse
    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:141
    • @@ -56,19 +56,19 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • result

    result: {
        account_data: AccountRoot & {
            signer_lists?: SignerList[];
        };
        account_flags?: AccountInfoAccountFlags;
        ledger_current_index?: number;
        ledger_index?: number;
        queue_data?: AccountQueueData;
        validated?: boolean;
    }
    @@ -120,31 +120,31 @@
    Optional
    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:142

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/AccountLinesRequest.html b/docs/interfaces/AccountLinesRequest.html index 058c0b2a43..19deaea724 100644 --- a/docs/interfaces/AccountLinesRequest.html +++ b/docs/interfaces/AccountLinesRequest.html @@ -36,7 +36,7 @@

    Hierarchy

    • AccountLinesRequest
    +
  • Defined in packages/xrpl/src/models/methods/accountLines.ts:75
    • @@ -63,7 +63,7 @@

    account

    +
  • Defined in packages/xrpl/src/models/methods/accountLines.ts:80

    • Optional api_version

    api_version?: number
    @@ -72,7 +72,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "account_lines"
    @@ -81,7 +81,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/accountLines.ts:78

    • Optional id

    id?: string | number
    @@ -92,7 +92,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional ledger_hash

    ledger_hash?: string
    @@ -101,7 +101,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:21

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -110,7 +110,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:23

    • Optional limit

    limit?: number
    @@ -119,7 +119,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountLines.ts:90

    • Optional marker

    marker?: unknown
    @@ -128,7 +128,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountLines.ts:95

    • Optional peer

    peer?: string
    @@ -137,7 +137,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountLines.ts:85
    • diff --git a/docs/interfaces/AccountLinesResponse.html b/docs/interfaces/AccountLinesResponse.html index 87774bc476..8a0c306588 100644 --- a/docs/interfaces/AccountLinesResponse.html +++ b/docs/interfaces/AccountLinesResponse.html @@ -32,7 +32,7 @@

    Hierarchy

    • AccountLinesResponse
    +
  • Defined in packages/xrpl/src/models/methods/accountLines.ts:103
    • @@ -56,19 +56,19 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • result

    result: {
        account: string;
        ledger_current_index?: number;
        ledger_hash?: string;
        ledger_index?: number;
        lines: AccountLinesTrustline[];
        marker?: unknown;
    }
    @@ -114,31 +114,31 @@
    Optional
    +
  • Defined in packages/xrpl/src/models/methods/accountLines.ts:104

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/AccountLinesTrustline.html b/docs/interfaces/AccountLinesTrustline.html index 5fe5855419..13ea940003 100644 --- a/docs/interfaces/AccountLinesTrustline.html +++ b/docs/interfaces/AccountLinesTrustline.html @@ -26,7 +26,7 @@

    Hierarchy

    • AccountLinesTrustline
    +
  • Defined in packages/xrpl/src/models/methods/accountLines.ts:3
    • @@ -57,7 +57,7 @@

    account

    +
  • Defined in packages/xrpl/src/models/methods/accountLines.ts:5

    • Optional authorized

    authorized?: boolean
    @@ -65,7 +65,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountLines.ts:55

    • balance

    balance: string
    @@ -75,7 +75,7 @@

    balance

    +
  • Defined in packages/xrpl/src/models/methods/accountLines.ts:11

    • currency

    currency: string
    @@ -83,7 +83,7 @@

    currency

    +
  • Defined in packages/xrpl/src/models/methods/accountLines.ts:13

    • Optional freeze

    freeze?: boolean
    @@ -91,7 +91,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountLines.ts:59

    • Optional freeze_peer

    freeze_peer?: boolean
    @@ -100,7 +100,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountLines.ts:64

    • limit

    limit: string
    @@ -109,7 +109,7 @@

    limit

    +
  • Defined in packages/xrpl/src/models/methods/accountLines.ts:18

    • limit_peer

    limit_peer: string
    @@ -118,7 +118,7 @@

    limit_peer

    +
  • Defined in packages/xrpl/src/models/methods/accountLines.ts:23

    • Optional no_ripple

    no_ripple?: boolean
    @@ -130,7 +130,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountLines.ts:45

    • Optional no_ripple_peer

    no_ripple_peer?: boolean
    @@ -142,7 +142,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountLines.ts:53

    • Optional peer_authorized

    peer_authorized?: boolean
    @@ -150,7 +150,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountLines.ts:57

    • quality_in

    quality_in: number
    @@ -161,7 +161,7 @@

    quality_in

    +
  • Defined in packages/xrpl/src/models/methods/accountLines.ts:30

    • quality_out

    quality_out: number
    @@ -172,7 +172,7 @@

    quality_out

    +
  • Defined in packages/xrpl/src/models/methods/accountLines.ts:37
    • diff --git a/docs/interfaces/AccountNFToken.html b/docs/interfaces/AccountNFToken.html index e408baba69..9d77e5e77c 100644 --- a/docs/interfaces/AccountNFToken.html +++ b/docs/interfaces/AccountNFToken.html @@ -30,7 +30,7 @@

    Hierarchy

    • AccountNFToken
    +
  • Defined in packages/xrpl/src/models/methods/accountNFTs.ts:32
    • @@ -51,32 +51,32 @@

    Properties

    Flags

    Flags: number
    +
  • Defined in packages/xrpl/src/models/methods/accountNFTs.ts:33

    • Issuer

    Issuer: string
    +
  • Defined in packages/xrpl/src/models/methods/accountNFTs.ts:34

    • NFTokenID

    NFTokenID: string
    +
  • Defined in packages/xrpl/src/models/methods/accountNFTs.ts:35

    • NFTokenTaxon

    NFTokenTaxon: number
    +
  • Defined in packages/xrpl/src/models/methods/accountNFTs.ts:36

    • Optional URI

    URI?: string
    +
  • Defined in packages/xrpl/src/models/methods/accountNFTs.ts:37

    • nft_serial

    nft_serial: number
    +
  • Defined in packages/xrpl/src/models/methods/accountNFTs.ts:38
    • diff --git a/docs/interfaces/AccountNFTsRequest.html b/docs/interfaces/AccountNFTsRequest.html index 970ba13e08..52bf1680c9 100644 --- a/docs/interfaces/AccountNFTsRequest.html +++ b/docs/interfaces/AccountNFTsRequest.html @@ -34,7 +34,7 @@

    Hierarchy

    • AccountNFTsRequest
    +
  • Defined in packages/xrpl/src/models/methods/accountNFTs.ts:9
    • @@ -61,7 +61,7 @@

    account

    +
  • Defined in packages/xrpl/src/models/methods/accountNFTs.ts:15

    • Optional api_version

    api_version?: number
    @@ -70,7 +70,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "account_nfts"
    @@ -79,7 +79,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/accountNFTs.ts:10

    • Optional id

    id?: string | number
    @@ -90,7 +90,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional ledger_hash

    ledger_hash?: string
    @@ -99,7 +99,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:21

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -108,7 +108,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:23

    • Optional limit

    limit?: number
    @@ -116,7 +116,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountNFTs.ts:19

    • Optional marker

    marker?: unknown
    @@ -125,7 +125,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountNFTs.ts:24
    • diff --git a/docs/interfaces/AccountNFTsResponse.html b/docs/interfaces/AccountNFTsResponse.html index e6e0a39692..a82f27f5dc 100644 --- a/docs/interfaces/AccountNFTsResponse.html +++ b/docs/interfaces/AccountNFTsResponse.html @@ -32,7 +32,7 @@

    Hierarchy

    • AccountNFTsResponse
    +
  • Defined in packages/xrpl/src/models/methods/accountNFTs.ts:46
    • @@ -56,19 +56,19 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • result

    result: {
        account: string;
        account_nfts: AccountNFToken[];
        ledger_current_index: number;
        limit?: number;
        marker?: unknown;
        validated: boolean;
    }
    @@ -110,31 +110,31 @@
    validated
    +
  • Defined in packages/xrpl/src/models/methods/accountNFTs.ts:47

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/AccountObjectsRequest.html b/docs/interfaces/AccountObjectsRequest.html index abdb0096d8..39f30f8308 100644 --- a/docs/interfaces/AccountObjectsRequest.html +++ b/docs/interfaces/AccountObjectsRequest.html @@ -36,7 +36,7 @@

    Hierarchy

    • AccountObjectsRequest
    +
  • Defined in packages/xrpl/src/models/methods/accountObjects.ts:18
    • @@ -64,7 +64,7 @@

    account

    +
  • Defined in packages/xrpl/src/models/methods/accountObjects.ts:23

    • Optional api_version

    api_version?: number
    @@ -73,7 +73,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "account_objects"
    @@ -82,7 +82,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/accountObjects.ts:21

    • Optional deletion_blockers_only

    deletion_blockers_only?: boolean
    @@ -91,7 +91,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountObjects.ts:32

    • Optional id

    id?: string | number
    @@ -102,7 +102,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional ledger_hash

    ledger_hash?: string
    @@ -111,7 +111,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:21

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -120,7 +120,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:23

    • Optional limit

    limit?: number
    @@ -129,7 +129,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountObjects.ts:37

    • Optional marker

    marker?: unknown
    @@ -138,7 +138,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountObjects.ts:42

    • Optional type

    type?: AccountObjectType
    @@ -146,7 +146,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountObjects.ts:27
    • diff --git a/docs/interfaces/AccountObjectsResponse.html b/docs/interfaces/AccountObjectsResponse.html index 8fac0f6b75..233d1eafe7 100644 --- a/docs/interfaces/AccountObjectsResponse.html +++ b/docs/interfaces/AccountObjectsResponse.html @@ -32,7 +32,7 @@

    Hierarchy

    • AccountObjectsResponse
    +
  • Defined in packages/xrpl/src/models/methods/accountObjects.ts:59
    • @@ -56,19 +56,19 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • result

    result: {
        account: string;
        account_objects: AccountObject[];
        ledger_current_index?: number;
        ledger_hash?: string;
        ledger_index?: number;
        limit?: number;
        marker?: string;
        validated?: boolean;
    }
    @@ -125,31 +125,31 @@
    Optional
    +
  • Defined in packages/xrpl/src/models/methods/accountObjects.ts:60

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/AccountOffer.html b/docs/interfaces/AccountOffer.html index a3b8eacdd3..0dfe75b67d 100644 --- a/docs/interfaces/AccountOffer.html +++ b/docs/interfaces/AccountOffer.html @@ -26,7 +26,7 @@

    Hierarchy

    • AccountOffer
    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:36
    • @@ -51,7 +51,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:60

    • flags

    flags: number
    @@ -59,7 +59,7 @@

    flags

    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:38

    • quality

    quality: string
    @@ -70,7 +70,7 @@

    quality

    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:55

    • seq

    seq: number
    @@ -78,7 +78,7 @@

    seq

    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:40

    • taker_gets

    taker_gets: Amount
    @@ -86,7 +86,7 @@

    taker_gets

    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:44

    • taker_pays

    taker_pays: Amount
    @@ -94,7 +94,7 @@

    taker_pays

    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:48
    • diff --git a/docs/interfaces/AccountOffersRequest.html b/docs/interfaces/AccountOffersRequest.html index b00a8be783..8b209b969d 100644 --- a/docs/interfaces/AccountOffersRequest.html +++ b/docs/interfaces/AccountOffersRequest.html @@ -35,7 +35,7 @@

    Hierarchy

    • AccountOffersRequest
    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:12
    • @@ -62,7 +62,7 @@

    account

    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:17

    • Optional api_version

    api_version?: number
    @@ -71,7 +71,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "account_offers"
    @@ -80,7 +80,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:15

    • Optional id

    id?: string | number
    @@ -91,7 +91,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional ledger_hash

    ledger_hash?: string
    @@ -100,7 +100,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:21

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -109,7 +109,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:23

    • Optional limit

    limit?: number
    @@ -118,7 +118,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:22

    • Optional marker

    marker?: unknown
    @@ -127,7 +127,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:27

    • Optional strict

    strict?: boolean
    @@ -137,7 +137,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:33
    • diff --git a/docs/interfaces/AccountOffersResponse.html b/docs/interfaces/AccountOffersResponse.html index 05067b431e..41a75740ca 100644 --- a/docs/interfaces/AccountOffersResponse.html +++ b/docs/interfaces/AccountOffersResponse.html @@ -32,7 +32,7 @@

    Hierarchy

    • AccountOffersResponse
    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:68
    • @@ -56,19 +56,19 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • result

    result: {
        account: string;
        ledger_current_index?: number;
        ledger_hash?: string;
        ledger_index?: number;
        marker?: unknown;
        offers?: AccountOffer[];
    }
    @@ -114,31 +114,31 @@
    Optional
    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:69

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/AccountQueueData.html b/docs/interfaces/AccountQueueData.html index a524141f7d..e46cd415ef 100644 --- a/docs/interfaces/AccountQueueData.html +++ b/docs/interfaces/AccountQueueData.html @@ -26,7 +26,7 @@

    Hierarchy

    • AccountQueueData
    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:53
    • @@ -53,7 +53,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:62

    • Optional highest_sequence

    highest_sequence?: number
    @@ -61,7 +61,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:66

    • Optional lowest_sequence

    lowest_sequence?: number
    @@ -69,7 +69,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:64

    • Optional max_spend_drops_total

    max_spend_drops_total?: string
    @@ -78,7 +78,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:71

    • Optional transactions

    transactions?: AccountQueueTransaction[]
    @@ -86,7 +86,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:73

    • txn_count

    txn_count: number
    @@ -94,7 +94,7 @@

    txn_count

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:55
    • diff --git a/docs/interfaces/AccountQueueTransaction.html b/docs/interfaces/AccountQueueTransaction.html index b80cd1d4ae..11a2de3a19 100644 --- a/docs/interfaces/AccountQueueTransaction.html +++ b/docs/interfaces/AccountQueueTransaction.html @@ -26,7 +26,7 @@

    Hierarchy

    • AccountQueueTransaction
    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:34
    • @@ -50,7 +50,7 @@

    auth_change

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:39

    • fee

    fee: string
    @@ -58,7 +58,7 @@

    fee

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:41

    • fee_level

    fee_level: string
    @@ -67,7 +67,7 @@

    fee_level

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:46

    • max_spend_drops

    max_spend_drops: string
    @@ -75,7 +75,7 @@

    max_spend_drops

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:48

    • seq

    seq: number
    @@ -83,7 +83,7 @@

    seq

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:50
    • diff --git a/docs/interfaces/AccountSet.html b/docs/interfaces/AccountSet.html index 0255e53b5e..fc32d9d996 100644 --- a/docs/interfaces/AccountSet.html +++ b/docs/interfaces/AccountSet.html @@ -33,7 +33,7 @@

    Hierarchy

    • AccountSet
    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:130
    • @@ -74,7 +74,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -85,7 +85,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Optional ClearFlag

    ClearFlag?: number
    @@ -93,7 +93,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:134

    • Optional Domain

    Domain?: string
    @@ -102,7 +102,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:139

    • Optional EmailHash

    EmailHash?: string
    @@ -110,7 +110,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:141

    • Optional Fee

    Fee?: string
    @@ -121,7 +121,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | AccountSetFlagsInterface
    @@ -130,7 +130,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:132

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -141,7 +141,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -150,7 +150,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional MessageKey

    MessageKey?: string
    @@ -158,7 +158,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:143

    • Optional NFTokenMinter

    NFTokenMinter?: string
    @@ -167,7 +167,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:162

    • Optional NetworkID

    NetworkID?: number
    @@ -176,7 +176,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional Sequence

    Sequence?: number
    @@ -188,7 +188,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional SetFlag

    SetFlag?: AccountSetAsfFlags
    @@ -196,7 +196,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:145

    • Optional Signers

    Signers?: Signer[]
    @@ -206,7 +206,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -217,7 +217,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -229,7 +229,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TickSize

    TickSize?: number
    @@ -239,7 +239,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:157

    • Optional TicketSequence

    TicketSequence?: number
    @@ -249,7 +249,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "AccountSet"
    @@ -259,7 +259,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:131

    • Optional TransferRate

    TransferRate?: number
    @@ -269,7 +269,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:151

    • Optional TxnSignature

    TxnSignature?: string
    @@ -279,7 +279,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289
    • diff --git a/docs/interfaces/AccountSetFlagsInterface.html b/docs/interfaces/AccountSetFlagsInterface.html index 8d65d9e219..edc8b8f06c 100644 --- a/docs/interfaces/AccountSetFlagsInterface.html +++ b/docs/interfaces/AccountSetFlagsInterface.html @@ -34,7 +34,7 @@

    Hierarchy

    • AccountSetFlagsInterface
    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:115
    • @@ -55,32 +55,32 @@

    Properties

    Optional tfAllowXRP

    tfAllowXRP?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:121

    • Optional tfDisallowXRP

    tfDisallowXRP?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:120

    • Optional tfOptionalAuth

    tfOptionalAuth?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:119

    • Optional tfOptionalDestTag

    tfOptionalDestTag?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:117

    • Optional tfRequireAuth

    tfRequireAuth?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:118

    • Optional tfRequireDestTag

    tfRequireDestTag?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:116
    • diff --git a/docs/interfaces/AccountTxRequest.html b/docs/interfaces/AccountTxRequest.html index 8b1cf0e601..4c9e0fbb6d 100644 --- a/docs/interfaces/AccountTxRequest.html +++ b/docs/interfaces/AccountTxRequest.html @@ -34,7 +34,7 @@

    Hierarchy

    • AccountTxRequest
    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:13
    • @@ -64,7 +64,7 @@

    account

    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:16

    • Optional api_version

    api_version?: number
    @@ -73,7 +73,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • Optional binary

    binary?: boolean
    @@ -82,7 +82,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:33

    • command

    command: "account_tx"
    @@ -91,7 +91,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:14

    • Optional forward

    forward?: boolean
    @@ -100,7 +100,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:38

    • Optional id

    id?: string | number
    @@ -111,7 +111,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional ledger_hash

    ledger_hash?: string
    @@ -120,7 +120,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:21

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -129,7 +129,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:23

    • Optional ledger_index_max

    ledger_index_max?: number
    @@ -139,7 +139,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:28

    • Optional ledger_index_min

    ledger_index_min?: number
    @@ -149,7 +149,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:22

    • Optional limit

    limit?: number
    @@ -158,7 +158,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:43

    • Optional marker

    marker?: unknown
    @@ -168,7 +168,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:49
    • diff --git a/docs/interfaces/AccountTxResponse.html b/docs/interfaces/AccountTxResponse.html index e9678189a5..a659528e14 100644 --- a/docs/interfaces/AccountTxResponse.html +++ b/docs/interfaces/AccountTxResponse.html @@ -32,7 +32,7 @@

    Hierarchy

    • AccountTxResponse
    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:76
    • @@ -56,19 +56,19 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • result

    result: {
        account: string;
        ledger_index_max: number;
        ledger_index_min: number;
        limit: number;
        marker?: unknown;
        transactions: AccountTxTransaction[];
        validated?: boolean;
    }
    @@ -118,31 +118,31 @@
    Optional
    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:77

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/AccountTxTransaction.html b/docs/interfaces/AccountTxTransaction.html index 4bb9fd752e..b0e860752e 100644 --- a/docs/interfaces/AccountTxTransaction.html +++ b/docs/interfaces/AccountTxTransaction.html @@ -26,7 +26,7 @@

    Hierarchy

    • AccountTxTransaction
    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:52
    • @@ -49,7 +49,7 @@

    ledger_index

    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:54

    • meta

    meta: string | TransactionMetadata
    @@ -58,7 +58,7 @@

    meta

    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:59

    • Optional tx

    tx?: Object
    @@ -66,7 +66,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:61

    • Optional tx_blob

    tx_blob?: string
    @@ -74,7 +74,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:63

    • validated

    validated: boolean
    @@ -83,7 +83,7 @@

    validated

    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:68
    • diff --git a/docs/interfaces/AuthAccount.html b/docs/interfaces/AuthAccount.html index 3d05c3fb0f..83dd7dcf68 100644 --- a/docs/interfaces/AuthAccount.html +++ b/docs/interfaces/AuthAccount.html @@ -26,7 +26,7 @@

    Hierarchy

    • AuthAccount
    +
  • Defined in packages/xrpl/src/models/common/index.ts:146
    • @@ -47,7 +47,7 @@

    Type declaration

  • Account: string
    • +
  • Defined in packages/xrpl/src/models/common/index.ts:147
    • diff --git a/docs/interfaces/Balance.html b/docs/interfaces/Balance.html index 10b18efea8..5707a54b61 100644 --- a/docs/interfaces/Balance.html +++ b/docs/interfaces/Balance.html @@ -26,7 +26,7 @@

    Hierarchy

    • Balance
    +
  • Defined in packages/xrpl/src/models/common/index.ts:21
    • @@ -44,17 +44,17 @@

    Properties

    currency

    currency: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:22

    • Optional issuer

    issuer?: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:23

    • value

    value: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:24
    • diff --git a/docs/interfaces/BaseRequest.html b/docs/interfaces/BaseRequest.html index c30bde6b92..953721e40a 100644 --- a/docs/interfaces/BaseRequest.html +++ b/docs/interfaces/BaseRequest.html @@ -67,7 +67,7 @@

    Hierarchy

    Indexable

    [x: string]: unknown
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:5
    • @@ -88,7 +88,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: string
    @@ -96,7 +96,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:14

    • Optional id

    id?: string | number
    @@ -106,7 +106,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12
    • diff --git a/docs/interfaces/BaseResponse.html b/docs/interfaces/BaseResponse.html index 899a478358..b5ec401830 100644 --- a/docs/interfaces/BaseResponse.html +++ b/docs/interfaces/BaseResponse.html @@ -65,7 +65,7 @@

    Hierarchy

  • NFTHistoryResponse
  • AMMInfoResponse
    • +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:32
    • @@ -88,42 +88,42 @@

    Properties

    Optional api_version

    api_version?: number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • result

    result: unknown
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:36

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/BaseTransaction.html b/docs/interfaces/BaseTransaction.html index a31f81dd0b..fcf14fbb71 100644 --- a/docs/interfaces/BaseTransaction.html +++ b/docs/interfaces/BaseTransaction.html @@ -76,7 +76,7 @@

    Hierarchy

  • XChainAccountCreateCommit
  • XChainModifyBridge
    • +
  • Defined in packages/xrpl/src/models/transactions/common.ts:223
    • @@ -108,7 +108,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -118,7 +118,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Optional Fee

    Fee?: string
    @@ -128,7 +128,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -136,7 +136,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -146,7 +146,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -154,7 +154,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -162,7 +162,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional Sequence

    Sequence?: number
    @@ -173,7 +173,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -182,7 +182,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -192,7 +192,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -203,7 +203,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -212,7 +212,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: string
    @@ -221,7 +221,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:230

    • Optional TxnSignature

    TxnSignature?: string
    @@ -230,7 +230,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289
    • diff --git a/docs/interfaces/BookOffer.html b/docs/interfaces/BookOffer.html index c0ff1e3eca..cc2e6dab7a 100644 --- a/docs/interfaces/BookOffer.html +++ b/docs/interfaces/BookOffer.html @@ -28,7 +28,7 @@

    Hierarchy

    • BookOffer
    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:44
    • @@ -64,7 +64,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:10

    • BookDirectory

    BookDirectory: string
    @@ -73,7 +73,7 @@

    BookDirectory

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:24

    • BookNode

    BookNode: string
    @@ -83,7 +83,7 @@

    BookNode

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:29

    • Optional Expiration

    Expiration?: number
    @@ -92,7 +92,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:36

    • Flags

    Flags: number
    @@ -101,13 +101,13 @@

    Flags

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:8

    • LedgerEntryType

    LedgerEntryType: "Offer"
    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:6

    • OwnerNode

    OwnerNode: string
    @@ -117,7 +117,7 @@

    OwnerNode

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:34

    • PreviousTxnID

    PreviousTxnID: string
    @@ -127,7 +127,7 @@

    PreviousTxnID

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:10

    • PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    @@ -137,7 +137,7 @@

    PreviousTxnLgrSeq

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:15

    • Sequence

    Sequence: number
    @@ -147,7 +147,7 @@

    Sequence

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:15

    • TakerGets

    TakerGets: Amount
    @@ -157,7 +157,7 @@

    TakerGets

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:22

    • TakerPays

    TakerPays: Amount
    @@ -166,13 +166,13 @@

    TakerPays

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:17

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2

    • Optional owner_funds

    owner_funds?: string
    @@ -183,7 +183,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:51

    • Optional quality

    quality?: string
    @@ -193,7 +193,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:67

    • Optional taker_gets_funded

    taker_gets_funded?: Amount
    @@ -202,7 +202,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:56

    • Optional taker_pays_funded

    taker_pays_funded?: Amount
    @@ -211,7 +211,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:61
    • diff --git a/docs/interfaces/BookOfferCurrency.html b/docs/interfaces/BookOfferCurrency.html index 460c1402e0..5a839048b6 100644 --- a/docs/interfaces/BookOfferCurrency.html +++ b/docs/interfaces/BookOfferCurrency.html @@ -26,7 +26,7 @@

    Hierarchy

    • BookOfferCurrency
    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:6
    • @@ -43,12 +43,12 @@

    Properties

    currency

    currency: string
    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:7

    • Optional issuer

    issuer?: string
    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:8
    • diff --git a/docs/interfaces/BookOffersRequest.html b/docs/interfaces/BookOffersRequest.html index 596c57ccb3..840302ae47 100644 --- a/docs/interfaces/BookOffersRequest.html +++ b/docs/interfaces/BookOffersRequest.html @@ -34,7 +34,7 @@

    Hierarchy

    • BookOffersRequest
    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:17
    • @@ -62,7 +62,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "book_offers"
    @@ -71,7 +71,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:18

    • Optional id

    id?: string | number
    @@ -82,7 +82,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional ledger_hash

    ledger_hash?: string
    @@ -91,7 +91,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:21

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -100,7 +100,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:23

    • Optional limit

    limit?: number
    @@ -110,7 +110,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:24

    • Optional taker

    taker?: string
    @@ -119,7 +119,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:29

    • taker_gets

    taker_gets: BookOfferCurrency
    @@ -129,7 +129,7 @@

    taker_gets

    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:35

    • taker_pays

    taker_pays: BookOfferCurrency
    @@ -139,7 +139,7 @@

    taker_pays

    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:41
    • diff --git a/docs/interfaces/BookOffersResponse.html b/docs/interfaces/BookOffersResponse.html index e567d30cc5..f8fc576b15 100644 --- a/docs/interfaces/BookOffersResponse.html +++ b/docs/interfaces/BookOffersResponse.html @@ -32,7 +32,7 @@

    Hierarchy

    • BookOffersResponse
    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:75
    • @@ -56,19 +56,19 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • result

    result: {
        ledger_current_index?: number;
        ledger_hash?: string;
        ledger_index?: number;
        offers: BookOffer[];
        validated?: boolean;
    }
    @@ -102,31 +102,31 @@
    offersOptional validated?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:76

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/Channel.html b/docs/interfaces/Channel.html index f6b7bb00b7..dc2a9340d5 100644 --- a/docs/interfaces/Channel.html +++ b/docs/interfaces/Channel.html @@ -26,7 +26,7 @@

    Hierarchy

    • Channel
    +
  • Defined in packages/xrpl/src/models/methods/accountChannels.ts:3
    • @@ -53,62 +53,62 @@

    Properties

    account

    account: string
    +
  • Defined in packages/xrpl/src/models/methods/accountChannels.ts:4

    • amount

    amount: string
    +
  • Defined in packages/xrpl/src/models/methods/accountChannels.ts:5

    • balance

    balance: string
    +
  • Defined in packages/xrpl/src/models/methods/accountChannels.ts:6

    • Optional cancel_after

    cancel_after?: number
    +
  • Defined in packages/xrpl/src/models/methods/accountChannels.ts:13

    • channel_id

    channel_id: string
    +
  • Defined in packages/xrpl/src/models/methods/accountChannels.ts:7

    • destination_account

    destination_account: string
    +
  • Defined in packages/xrpl/src/models/methods/accountChannels.ts:8

    • Optional destination_tag

    destination_tag?: number
    +
  • Defined in packages/xrpl/src/models/methods/accountChannels.ts:15

    • Optional expiration

    expiration?: number
    +
  • Defined in packages/xrpl/src/models/methods/accountChannels.ts:12

    • Optional public_key

    public_key?: string
    +
  • Defined in packages/xrpl/src/models/methods/accountChannels.ts:10

    • Optional public_key_hex

    public_key_hex?: string
    +
  • Defined in packages/xrpl/src/models/methods/accountChannels.ts:11

    • settle_delay

    settle_delay: number
    +
  • Defined in packages/xrpl/src/models/methods/accountChannels.ts:9

    • Optional source_tab

    source_tab?: number
    +
  • Defined in packages/xrpl/src/models/methods/accountChannels.ts:14
    • diff --git a/docs/interfaces/ChannelVerifyRequest.html b/docs/interfaces/ChannelVerifyRequest.html index d42454a370..d044a99ca1 100644 --- a/docs/interfaces/ChannelVerifyRequest.html +++ b/docs/interfaces/ChannelVerifyRequest.html @@ -34,7 +34,7 @@

    Hierarchy

    • ChannelVerifyRequest
    +
  • Defined in packages/xrpl/src/models/methods/channelVerify.ts:10
    • @@ -59,7 +59,7 @@

    amount

    +
  • Defined in packages/xrpl/src/models/methods/channelVerify.ts:13

    • Optional api_version

    api_version?: number
    @@ -68,7 +68,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • channel_id

    channel_id: string
    @@ -77,7 +77,7 @@

    channel_id

    +
  • Defined in packages/xrpl/src/models/methods/channelVerify.ts:18

    • command

    command: "channel_verify"
    @@ -86,7 +86,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/channelVerify.ts:11

    • Optional id

    id?: string | number
    @@ -97,7 +97,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • public_key

    public_key: string
    @@ -106,7 +106,7 @@

    public_key

    +
  • Defined in packages/xrpl/src/models/methods/channelVerify.ts:23

    • signature

    signature: string
    @@ -114,7 +114,7 @@

    signature

    +
  • Defined in packages/xrpl/src/models/methods/channelVerify.ts:25
    • diff --git a/docs/interfaces/ChannelVerifyResponse.html b/docs/interfaces/ChannelVerifyResponse.html index 232fc7d5e3..7051ede29d 100644 --- a/docs/interfaces/ChannelVerifyResponse.html +++ b/docs/interfaces/ChannelVerifyResponse.html @@ -32,7 +32,7 @@

    Hierarchy

    • ChannelVerifyResponse
    +
  • Defined in packages/xrpl/src/models/methods/channelVerify.ts:33
    • @@ -56,19 +56,19 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • result

    result: {
        signature_verified: boolean;
    }
    @@ -83,31 +83,31 @@
    signature_verified
    +
  • Defined in packages/xrpl/src/models/methods/channelVerify.ts:34

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/CheckCancel.html b/docs/interfaces/CheckCancel.html index 052b78240c..92a97ae8fc 100644 --- a/docs/interfaces/CheckCancel.html +++ b/docs/interfaces/CheckCancel.html @@ -35,7 +35,7 @@

    Hierarchy

    • CheckCancel
    +
  • Defined in packages/xrpl/src/models/transactions/checkCancel.ts:13
    • @@ -69,7 +69,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -80,7 +80,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • CheckID

    CheckID: string
    @@ -89,7 +89,7 @@

    CheckID

    +
  • Defined in packages/xrpl/src/models/transactions/checkCancel.ts:19

    • Optional Fee

    Fee?: string
    @@ -100,7 +100,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -109,7 +109,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -120,7 +120,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -129,7 +129,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -138,7 +138,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional Sequence

    Sequence?: number
    @@ -150,7 +150,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -160,7 +160,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -171,7 +171,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -183,7 +183,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -193,7 +193,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "CheckCancel"
    @@ -203,7 +203,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/checkCancel.ts:14

    • Optional TxnSignature

    TxnSignature?: string
    @@ -213,7 +213,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289
    • diff --git a/docs/interfaces/CheckCash.html b/docs/interfaces/CheckCash.html index 781537fcf6..cee83e87ac 100644 --- a/docs/interfaces/CheckCash.html +++ b/docs/interfaces/CheckCash.html @@ -34,7 +34,7 @@

    Hierarchy

    • CheckCash
    +
  • Defined in packages/xrpl/src/models/transactions/checkCash.ts:13
    • @@ -70,7 +70,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -81,7 +81,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Optional Amount

    Amount?: Amount
    @@ -91,7 +91,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/checkCash.ts:25

    • CheckID

    CheckID: string
    @@ -100,7 +100,7 @@

    CheckID

    +
  • Defined in packages/xrpl/src/models/transactions/checkCash.ts:19

    • Optional DeliverMin

    DeliverMin?: Amount
    @@ -110,7 +110,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/checkCash.ts:31

    • Optional Fee

    Fee?: string
    @@ -121,7 +121,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -130,7 +130,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -141,7 +141,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -150,7 +150,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -159,7 +159,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional Sequence

    Sequence?: number
    @@ -171,7 +171,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -181,7 +181,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -192,7 +192,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -204,7 +204,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -214,7 +214,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "CheckCash"
    @@ -224,7 +224,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/checkCash.ts:14

    • Optional TxnSignature

    TxnSignature?: string
    @@ -234,7 +234,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289
    • diff --git a/docs/interfaces/CheckCreate.html b/docs/interfaces/CheckCreate.html index 152e17ca9e..bcb6212b2a 100644 --- a/docs/interfaces/CheckCreate.html +++ b/docs/interfaces/CheckCreate.html @@ -34,7 +34,7 @@

    Hierarchy

    • CheckCreate
    +
  • Defined in packages/xrpl/src/models/transactions/checkCreate.ts:22
    • @@ -72,7 +72,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -83,7 +83,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Destination

    Destination: string
    @@ -91,7 +91,7 @@

    Destination

    +
  • Defined in packages/xrpl/src/models/transactions/checkCreate.ts:25

    • Optional DestinationTag

    DestinationTag?: number
    @@ -100,7 +100,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/checkCreate.ts:38

    • Optional Expiration

    Expiration?: number
    @@ -109,7 +109,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/checkCreate.ts:43

    • Optional Fee

    Fee?: string
    @@ -120,7 +120,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -129,7 +129,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional InvoiceID

    InvoiceID?: string
    @@ -138,7 +138,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/checkCreate.ts:48

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -149,7 +149,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -158,7 +158,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -167,7 +167,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • SendMax

    SendMax: Amount
    @@ -179,7 +179,7 @@

    SendMax

    +
  • Defined in packages/xrpl/src/models/transactions/checkCreate.ts:33

    • Optional Sequence

    Sequence?: number
    @@ -191,7 +191,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -201,7 +201,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -212,7 +212,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -224,7 +224,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -234,7 +234,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "CheckCreate"
    @@ -244,7 +244,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/checkCreate.ts:23

    • Optional TxnSignature

    TxnSignature?: string
    @@ -254,7 +254,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289
    • diff --git a/docs/interfaces/Clawback.html b/docs/interfaces/Clawback.html index eaa1a10b54..fdfca2bdf0 100644 --- a/docs/interfaces/Clawback.html +++ b/docs/interfaces/Clawback.html @@ -33,7 +33,7 @@

    Hierarchy

    • Clawback
    +
  • Defined in packages/xrpl/src/models/transactions/clawback.ts:14
    • @@ -68,7 +68,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/clawback.ts:20

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -79,7 +79,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Amount

    Amount: IssuedCurrencyAmount
    @@ -89,7 +89,7 @@

    Amount

    +
  • Defined in packages/xrpl/src/models/transactions/clawback.ts:26

    • Optional Fee

    Fee?: string
    @@ -100,7 +100,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -109,7 +109,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -120,7 +120,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -129,7 +129,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -138,7 +138,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional Sequence

    Sequence?: number
    @@ -150,7 +150,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -160,7 +160,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -171,7 +171,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -183,7 +183,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -193,7 +193,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "Clawback"
    @@ -203,7 +203,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/clawback.ts:15

    • Optional TxnSignature

    TxnSignature?: string
    @@ -213,7 +213,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289
    • diff --git a/docs/interfaces/ClientOptions.html b/docs/interfaces/ClientOptions.html index 2297801970..0bea24918f 100644 --- a/docs/interfaces/ClientOptions.html +++ b/docs/interfaces/ClientOptions.html @@ -28,7 +28,7 @@

    Hierarchy

    • ClientOptions
    +
  • Defined in packages/xrpl/src/client/index.ts:90
    • @@ -52,24 +52,24 @@

    Optionalagent?: Agent

    +
  • Defined in packages/xrpl/src/client/connection.ts:31

    • Optional authorization

    authorization?: string
    +
  • Defined in packages/xrpl/src/client/connection.ts:32

    • Optional connectionTimeout

    connectionTimeout?: number
    +
  • Defined in packages/xrpl/src/client/connection.ts:33

    • Optional feeCushion

    feeCushion?: number
    +
  • Defined in packages/xrpl/src/client/index.ts:91

    • Optional headers

    headers?: {
        [key: string]: string;
    }
    @@ -80,18 +80,18 @@

    Type declaration

    [key: string]: string
    +
  • Defined in packages/xrpl/src/client/connection.ts:30

    • Optional maxFeeXRP

    maxFeeXRP?: string
    +
  • Defined in packages/xrpl/src/client/index.ts:92

    • Optional timeout

    timeout?: number
    +
  • Defined in packages/xrpl/src/client/index.ts:93

    • Optional trace

    trace?: boolean | ((id, message) => void)
    @@ -112,7 +112,7 @@
    message: Returns void
    +
  • Defined in packages/xrpl/src/client/connection.ts:29
    • diff --git a/docs/interfaces/ConsensusStream.html b/docs/interfaces/ConsensusStream.html index ca7dda7585..2b5ae11c50 100644 --- a/docs/interfaces/ConsensusStream.html +++ b/docs/interfaces/ConsensusStream.html @@ -34,7 +34,7 @@

    Hierarchy

    • ConsensusStream
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:378
    • @@ -55,13 +55,13 @@

    consensus

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:384

    • type

    type: "consensusPhase"
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:379
    • diff --git a/docs/interfaces/CreatedNode.html b/docs/interfaces/CreatedNode.html index d35d7f709a..09ac56a173 100644 --- a/docs/interfaces/CreatedNode.html +++ b/docs/interfaces/CreatedNode.html @@ -26,7 +26,7 @@

    Hierarchy

    • CreatedNode
    +
  • Defined in packages/xrpl/src/models/transactions/metadata.ts:20
    • @@ -54,7 +54,7 @@
    NewFields
    [field: string]: unknown
    +
  • Defined in packages/xrpl/src/models/transactions/metadata.ts:21
    • diff --git a/docs/interfaces/DIDDelete.html b/docs/interfaces/DIDDelete.html index d28efb99a8..bd3b2b81ce 100644 --- a/docs/interfaces/DIDDelete.html +++ b/docs/interfaces/DIDDelete.html @@ -28,7 +28,7 @@

    Hierarchy

    • DIDDelete
    +
  • Defined in packages/xrpl/src/models/transactions/DIDDelete.ts:8
    • @@ -61,7 +61,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -72,7 +72,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Optional Fee

    Fee?: string
    @@ -83,7 +83,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -92,7 +92,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -103,7 +103,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -112,7 +112,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -121,7 +121,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional Sequence

    Sequence?: number
    @@ -133,7 +133,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -143,7 +143,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -154,7 +154,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -166,7 +166,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -176,7 +176,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "DIDDelete"
    @@ -186,7 +186,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/DIDDelete.ts:9

    • Optional TxnSignature

    TxnSignature?: string
    @@ -196,7 +196,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289
    • diff --git a/docs/interfaces/DIDSet.html b/docs/interfaces/DIDSet.html index 1197729315..28c748f16c 100644 --- a/docs/interfaces/DIDSet.html +++ b/docs/interfaces/DIDSet.html @@ -28,7 +28,7 @@

    Hierarchy

    • DIDSet
    +
  • Defined in packages/xrpl/src/models/transactions/DIDSet.ts:15
    • @@ -64,7 +64,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -75,17 +75,17 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Optional DIDDocument

    DIDDocument?: string
    +
  • Defined in packages/xrpl/src/models/transactions/DIDSet.ts:20

    • Optional Data

    Data?: string
    +
  • Defined in packages/xrpl/src/models/transactions/DIDSet.ts:18

    • Optional Fee

    Fee?: string
    @@ -96,7 +96,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -105,7 +105,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -116,7 +116,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -125,7 +125,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -134,7 +134,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional Sequence

    Sequence?: number
    @@ -146,7 +146,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -156,7 +156,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -167,7 +167,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -179,7 +179,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -189,7 +189,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "DIDSet"
    @@ -199,7 +199,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/DIDSet.ts:16

    • Optional TxnSignature

    TxnSignature?: string
    @@ -209,12 +209,12 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289

    • Optional URI

    URI?: string
    +
  • Defined in packages/xrpl/src/models/transactions/DIDSet.ts:22
    • diff --git a/docs/interfaces/DeletedNode.html b/docs/interfaces/DeletedNode.html index d903dfd386..763292a3fc 100644 --- a/docs/interfaces/DeletedNode.html +++ b/docs/interfaces/DeletedNode.html @@ -26,7 +26,7 @@

    Hierarchy

    • DeletedNode
    +
  • Defined in packages/xrpl/src/models/transactions/metadata.ts:39
    • @@ -54,7 +54,7 @@
    LedgerEntryType
    LedgerIndex: string
    +
  • Defined in packages/xrpl/src/models/transactions/metadata.ts:40
    • diff --git a/docs/interfaces/DepositAuthorizedRequest.html b/docs/interfaces/DepositAuthorizedRequest.html index 1152ff5fcc..0c3bc3799d 100644 --- a/docs/interfaces/DepositAuthorizedRequest.html +++ b/docs/interfaces/DepositAuthorizedRequest.html @@ -34,7 +34,7 @@

    Hierarchy

    • DepositAuthorizedRequest
    +
  • Defined in packages/xrpl/src/models/methods/depositAuthorized.ts:10
    • @@ -60,7 +60,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "deposit_authorized"
    @@ -69,7 +69,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/depositAuthorized.ts:13

    • destination_account

    destination_account: string
    @@ -77,7 +77,7 @@

    destination_account

    +
  • Defined in packages/xrpl/src/models/methods/depositAuthorized.ts:17

    • Optional id

    id?: string | number
    @@ -88,7 +88,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional ledger_hash

    ledger_hash?: string
    @@ -97,7 +97,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:21

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -106,7 +106,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:23

    • source_account

    source_account: string
    @@ -114,7 +114,7 @@

    source_account

    +
  • Defined in packages/xrpl/src/models/methods/depositAuthorized.ts:15
    • diff --git a/docs/interfaces/DepositAuthorizedResponse.html b/docs/interfaces/DepositAuthorizedResponse.html index 93ec9c93bf..672a717440 100644 --- a/docs/interfaces/DepositAuthorizedResponse.html +++ b/docs/interfaces/DepositAuthorizedResponse.html @@ -32,7 +32,7 @@

    Hierarchy

    • DepositAuthorizedResponse
    +
  • Defined in packages/xrpl/src/models/methods/depositAuthorized.ts:25
    • @@ -56,19 +56,19 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • result

    result: {
        deposit_authorized: boolean;
        destination_account: string;
        ledger_current_index?: number;
        ledger_hash?: string;
        ledger_index?: number;
        source_account: string;
        validated?: boolean;
    }
    @@ -118,31 +118,31 @@
    Optional
    +
  • Defined in packages/xrpl/src/models/methods/depositAuthorized.ts:26

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/DepositPreauth.html b/docs/interfaces/DepositPreauth.html index bb5826aa7e..fba690c170 100644 --- a/docs/interfaces/DepositPreauth.html +++ b/docs/interfaces/DepositPreauth.html @@ -34,7 +34,7 @@

    Hierarchy

    • DepositPreauth
    +
  • Defined in packages/xrpl/src/models/transactions/depositPreauth.ts:12
    • @@ -69,7 +69,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -80,7 +80,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Optional Authorize

    Authorize?: string
    @@ -88,7 +88,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/depositPreauth.ts:15

    • Optional Fee

    Fee?: string
    @@ -99,7 +99,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -108,7 +108,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -119,7 +119,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -128,7 +128,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -137,7 +137,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional Sequence

    Sequence?: number
    @@ -149,7 +149,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -159,7 +159,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -170,7 +170,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -182,7 +182,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -192,7 +192,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "DepositPreauth"
    @@ -202,7 +202,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/depositPreauth.ts:13

    • Optional TxnSignature

    TxnSignature?: string
    @@ -212,7 +212,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289

    • Optional Unauthorize

    Unauthorize?: string
    @@ -221,7 +221,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/depositPreauth.ts:20
    • diff --git a/docs/interfaces/EnableAmendment.html b/docs/interfaces/EnableAmendment.html index 1377400f09..fab8ec3be1 100644 --- a/docs/interfaces/EnableAmendment.html +++ b/docs/interfaces/EnableAmendment.html @@ -32,7 +32,7 @@

    Hierarchy

    • EnableAmendment
    +
  • Defined in packages/xrpl/src/models/transactions/enableAmendment.ts:20
    • @@ -67,7 +67,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -78,7 +78,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Amendment

    Amendment: string
    @@ -86,7 +86,7 @@

    Amendment

    +
  • Defined in packages/xrpl/src/models/transactions/enableAmendment.ts:23

    • Optional Fee

    Fee?: string
    @@ -97,7 +97,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -106,7 +106,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -117,7 +117,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • LedgerSequence

    LedgerSequence: number
    @@ -125,7 +125,7 @@

    LedgerSequence

    +
  • Defined in packages/xrpl/src/models/transactions/enableAmendment.ts:25

    • Optional Memos

    Memos?: Memo[]
    @@ -134,7 +134,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -143,7 +143,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional Sequence

    Sequence?: number
    @@ -155,7 +155,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -165,7 +165,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -176,7 +176,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -188,7 +188,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -198,7 +198,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "EnableAmendment"
    @@ -208,7 +208,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/enableAmendment.ts:21

    • Optional TxnSignature

    TxnSignature?: string
    @@ -218,7 +218,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289
    • diff --git a/docs/interfaces/ErrorResponse.html b/docs/interfaces/ErrorResponse.html index 1a36b09dc7..cd9821116b 100644 --- a/docs/interfaces/ErrorResponse.html +++ b/docs/interfaces/ErrorResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • ErrorResponse
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:49
    • @@ -54,42 +54,42 @@

    Properties

    Optional api_version

    api_version?: number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:57

    • error

    error: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:53

    • Optional error_code

    error_code?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:54

    • Optional error_message

    error_message?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:55

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:50

    • request

    request: Request
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:56

    • status

    status: "error"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:51

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:52
    • diff --git a/docs/interfaces/EscrowCancel.html b/docs/interfaces/EscrowCancel.html index 9dc7aba447..56b4a9c562 100644 --- a/docs/interfaces/EscrowCancel.html +++ b/docs/interfaces/EscrowCancel.html @@ -32,7 +32,7 @@

    Hierarchy

    • EscrowCancel
    +
  • Defined in packages/xrpl/src/models/transactions/escrowCancel.ts:16
    • @@ -67,7 +67,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -78,7 +78,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Optional Fee

    Fee?: string
    @@ -89,7 +89,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -98,7 +98,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -109,7 +109,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -118,7 +118,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -127,7 +127,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • OfferSequence

    OfferSequence: string | number
    @@ -136,7 +136,7 @@

    OfferSequence

    +
  • Defined in packages/xrpl/src/models/transactions/escrowCancel.ts:24

    • Owner

    Owner: string
    @@ -144,7 +144,7 @@

    Owner

    +
  • Defined in packages/xrpl/src/models/transactions/escrowCancel.ts:19

    • Optional Sequence

    Sequence?: number
    @@ -156,7 +156,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -166,7 +166,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -177,7 +177,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -189,7 +189,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -199,7 +199,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "EscrowCancel"
    @@ -209,7 +209,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/escrowCancel.ts:17

    • Optional TxnSignature

    TxnSignature?: string
    @@ -219,7 +219,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289
    • diff --git a/docs/interfaces/EscrowCreate.html b/docs/interfaces/EscrowCreate.html index 151198ea4c..c2afa06a8a 100644 --- a/docs/interfaces/EscrowCreate.html +++ b/docs/interfaces/EscrowCreate.html @@ -32,7 +32,7 @@

    Hierarchy

    • EscrowCreate
    +
  • Defined in packages/xrpl/src/models/transactions/escrowCreate.ts:18
    • @@ -71,7 +71,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -82,7 +82,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Amount

    Amount: string
    @@ -92,7 +92,7 @@

    Amount

    +
  • Defined in packages/xrpl/src/models/transactions/escrowCreate.ts:25

    • Optional CancelAfter

    CancelAfter?: number
    @@ -102,7 +102,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/escrowCreate.ts:33

    • Optional Condition

    Condition?: string
    @@ -111,7 +111,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/escrowCreate.ts:44

    • Destination

    Destination: string
    @@ -119,7 +119,7 @@

    Destination

    +
  • Defined in packages/xrpl/src/models/transactions/escrowCreate.ts:27

    • Optional DestinationTag

    DestinationTag?: number
    @@ -128,7 +128,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/escrowCreate.ts:49

    • Optional Fee

    Fee?: string
    @@ -139,7 +139,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional FinishAfter

    FinishAfter?: number
    @@ -149,7 +149,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/escrowCreate.ts:39

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -158,7 +158,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -169,7 +169,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -178,7 +178,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -187,7 +187,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional Sequence

    Sequence?: number
    @@ -199,7 +199,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -209,7 +209,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -220,7 +220,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -232,7 +232,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -242,7 +242,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "EscrowCreate"
    @@ -252,7 +252,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/escrowCreate.ts:19

    • Optional TxnSignature

    TxnSignature?: string
    @@ -262,7 +262,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289
    • diff --git a/docs/interfaces/EscrowFinish.html b/docs/interfaces/EscrowFinish.html index 98ebad3a14..9737c68db1 100644 --- a/docs/interfaces/EscrowFinish.html +++ b/docs/interfaces/EscrowFinish.html @@ -32,7 +32,7 @@

    Hierarchy

    • EscrowFinish
    +
  • Defined in packages/xrpl/src/models/transactions/escrowFinish.ts:16
    • @@ -69,7 +69,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -80,7 +80,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Optional Condition

    Condition?: string
    @@ -89,7 +89,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/escrowFinish.ts:29

    • Optional Fee

    Fee?: string
    @@ -100,7 +100,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -109,7 +109,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional Fulfillment

    Fulfillment?: string
    @@ -118,7 +118,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/escrowFinish.ts:34

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -129,7 +129,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -138,7 +138,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -147,7 +147,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • OfferSequence

    OfferSequence: string | number
    @@ -156,7 +156,7 @@

    OfferSequence

    +
  • Defined in packages/xrpl/src/models/transactions/escrowFinish.ts:24

    • Owner

    Owner: string
    @@ -164,7 +164,7 @@

    Owner

    +
  • Defined in packages/xrpl/src/models/transactions/escrowFinish.ts:19

    • Optional Sequence

    Sequence?: number
    @@ -176,7 +176,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -186,7 +186,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -197,7 +197,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -209,7 +209,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -219,7 +219,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "EscrowFinish"
    @@ -229,7 +229,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/escrowFinish.ts:17

    • Optional TxnSignature

    TxnSignature?: string
    @@ -239,7 +239,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289
    • diff --git a/docs/interfaces/FeeRequest.html b/docs/interfaces/FeeRequest.html index 51a54751f4..af5aa467ad 100644 --- a/docs/interfaces/FeeRequest.html +++ b/docs/interfaces/FeeRequest.html @@ -37,7 +37,7 @@

    Hierarchy

    • FeeRequest
    +
  • Defined in packages/xrpl/src/models/methods/fee.ts:17
    • @@ -59,7 +59,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "fee"
    @@ -68,7 +68,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/fee.ts:18

    • Optional id

    id?: string | number
    @@ -79,7 +79,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12
    • diff --git a/docs/interfaces/FeeResponse.html b/docs/interfaces/FeeResponse.html index 6c1a1080ee..47a7c3810c 100644 --- a/docs/interfaces/FeeResponse.html +++ b/docs/interfaces/FeeResponse.html @@ -32,7 +32,7 @@

    Hierarchy

    • FeeResponse
    +
  • Defined in packages/xrpl/src/models/methods/fee.ts:26
    • @@ -56,19 +56,19 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • 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;
    }
    @@ -160,31 +160,31 @@
    max_queue_size
    +
  • Defined in packages/xrpl/src/models/methods/fee.ts:27

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/FundingOptions.html b/docs/interfaces/FundingOptions.html index 59560426c2..0fa9664168 100644 --- a/docs/interfaces/FundingOptions.html +++ b/docs/interfaces/FundingOptions.html @@ -26,7 +26,7 @@

    Hierarchy

    • FundingOptions
    +
  • Defined in packages/xrpl/src/Wallet/fundWallet.ts:20
    • @@ -48,7 +48,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/Wallet/fundWallet.ts:24

    • Optional faucetHost

    faucetHost?: string
    @@ -58,7 +58,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/Wallet/fundWallet.ts:30

    • Optional faucetPath

    faucetPath?: string
    @@ -72,7 +72,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/Wallet/fundWallet.ts:40

    • Optional usageContext

    usageContext?: string
    @@ -81,7 +81,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/Wallet/fundWallet.ts:45
    • diff --git a/docs/interfaces/GatewayBalance.html b/docs/interfaces/GatewayBalance.html index 6ef37fdd95..4b2d6900ae 100644 --- a/docs/interfaces/GatewayBalance.html +++ b/docs/interfaces/GatewayBalance.html @@ -26,7 +26,7 @@

    Hierarchy

    • GatewayBalance
    +
  • Defined in packages/xrpl/src/models/methods/gatewayBalances.ts:40
    • @@ -43,12 +43,12 @@

    Properties

    currency

    currency: string
    +
  • Defined in packages/xrpl/src/models/methods/gatewayBalances.ts:41

    • value

    value: string
    +
  • Defined in packages/xrpl/src/models/methods/gatewayBalances.ts:42
    • diff --git a/docs/interfaces/GatewayBalancesRequest.html b/docs/interfaces/GatewayBalancesRequest.html index 3ee7e9c434..bbbb18788d 100644 --- a/docs/interfaces/GatewayBalancesRequest.html +++ b/docs/interfaces/GatewayBalancesRequest.html @@ -38,7 +38,7 @@

    Hierarchy

    • GatewayBalancesRequest
    +
  • Defined in packages/xrpl/src/models/methods/gatewayBalances.ts:22
    • @@ -64,7 +64,7 @@

    account

    +
  • Defined in packages/xrpl/src/models/methods/gatewayBalances.ts:27

    • Optional api_version

    api_version?: number
    @@ -73,7 +73,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "gateway_balances"
    @@ -82,7 +82,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/gatewayBalances.ts:25

    • Optional hotwallet

    hotwallet?: string | string[]
    @@ -91,7 +91,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/gatewayBalances.ts:37

    • Optional id

    id?: string | number
    @@ -102,7 +102,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional ledger_hash

    ledger_hash?: string
    @@ -111,7 +111,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:21

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -120,7 +120,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:23

    • Optional strict

    strict?: boolean
    @@ -129,7 +129,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/gatewayBalances.ts:32
    • diff --git a/docs/interfaces/GatewayBalancesResponse.html b/docs/interfaces/GatewayBalancesResponse.html index 3d83474a9c..2ecc28880b 100644 --- a/docs/interfaces/GatewayBalancesResponse.html +++ b/docs/interfaces/GatewayBalancesResponse.html @@ -32,7 +32,7 @@

    Hierarchy

    • GatewayBalancesResponse
    +
  • Defined in packages/xrpl/src/models/methods/gatewayBalances.ts:50
    • @@ -56,19 +56,19 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • result

    result: {
        account: string;
        assets?: {
            [address: string]: GatewayBalance[];
        };
        balances?: {
            [address: string]: GatewayBalance[];
        };
        ledger_current_index?: number;
        ledger_hash?: string;
        ledger_index?: number;
        obligations?: {
            [currency: string]: string;
        };
    }
    @@ -127,31 +127,31 @@
    Optional [currency: string]: string
    +
  • Defined in packages/xrpl/src/models/methods/gatewayBalances.ts:51

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/IssuedCurrency.html b/docs/interfaces/IssuedCurrency.html index 29e8ded157..1952326d44 100644 --- a/docs/interfaces/IssuedCurrency.html +++ b/docs/interfaces/IssuedCurrency.html @@ -28,7 +28,7 @@

    Hierarchy

    +
  • Defined in packages/xrpl/src/models/common/index.ts:8
    • @@ -45,12 +45,12 @@

    Properties

    currency

    currency: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:9

    • issuer

    issuer: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:10
    • diff --git a/docs/interfaces/IssuedCurrencyAmount.html b/docs/interfaces/IssuedCurrencyAmount.html index 0646f0168b..5d99955265 100644 --- a/docs/interfaces/IssuedCurrencyAmount.html +++ b/docs/interfaces/IssuedCurrencyAmount.html @@ -28,7 +28,7 @@

    Hierarchy

    • IssuedCurrencyAmount
    +
  • Defined in packages/xrpl/src/models/common/index.ts:15
    • @@ -47,18 +47,18 @@

    currencycurrency: string

    +
  • Defined in packages/xrpl/src/models/common/index.ts:9

    • issuer

    issuer: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:10

    • value

    value: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:16
    • diff --git a/docs/interfaces/JobType.html b/docs/interfaces/JobType.html index c4df279e5a..35a40557ee 100644 --- a/docs/interfaces/JobType.html +++ b/docs/interfaces/JobType.html @@ -26,7 +26,7 @@

    Hierarchy

    • JobType
    +
  • Defined in packages/xrpl/src/models/methods/serverInfo.ts:28
    • @@ -46,27 +46,27 @@

    Properties

    Optional avg_time

    avg_time?: number
    +
  • Defined in packages/xrpl/src/models/methods/serverInfo.ts:32

    • Optional in_progress

    in_progress?: number
    +
  • Defined in packages/xrpl/src/models/methods/serverInfo.ts:33

    • job_type

    job_type: string
    +
  • Defined in packages/xrpl/src/models/methods/serverInfo.ts:29

    • Optional peak_time

    peak_time?: number
    +
  • Defined in packages/xrpl/src/models/methods/serverInfo.ts:31

    • per_second

    per_second: number
    +
  • Defined in packages/xrpl/src/models/methods/serverInfo.ts:30
    • diff --git a/docs/interfaces/LedgerBinary.html b/docs/interfaces/LedgerBinary.html index a9e90ef235..45f71e3b18 100644 --- a/docs/interfaces/LedgerBinary.html +++ b/docs/interfaces/LedgerBinary.html @@ -28,7 +28,7 @@

    Hierarchy

    • LedgerBinary
    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:204
    • @@ -57,7 +57,7 @@

    Properties

    Optional accountState

    accountState?: string[]
    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:206

    • account_hash

    account_hash: string
    @@ -66,7 +66,7 @@

    account_hash

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:13

    • close_flags

    close_flags: number
    @@ -75,7 +75,7 @@

    close_flags

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:17

    • close_time

    close_time: number
    @@ -86,7 +86,7 @@

    close_time

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:23

    • close_time_human

    close_time_human: string
    @@ -96,7 +96,7 @@

    close_time_human

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:28

    • close_time_resolution

    close_time_resolution: number
    @@ -106,7 +106,7 @@

    close_time_resolution

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:33

    • closed

    closed: boolean
    @@ -115,7 +115,7 @@

    closed

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:35

    • ledger_hash

    ledger_hash: string
    @@ -125,7 +125,7 @@

    ledger_hash

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:40

    • ledger_index

    ledger_index: string
    @@ -135,7 +135,7 @@

    ledger_index

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:45

    • parent_close_time

    parent_close_time: number
    @@ -144,7 +144,7 @@

    parent_close_time

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:47

    • parent_hash

    parent_hash: string
    @@ -154,7 +154,7 @@

    parent_hash

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:52

    • total_coins

    total_coins: string
    @@ -163,7 +163,7 @@

    total_coins

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:54

    • transaction_hash

    transaction_hash: string
    @@ -172,12 +172,12 @@

    transaction_hash

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:56

    • Optional transactions

    transactions?: string[]
    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:207
    • diff --git a/docs/interfaces/LedgerClosedRequest.html b/docs/interfaces/LedgerClosedRequest.html index fa7652a5e1..2388098888 100644 --- a/docs/interfaces/LedgerClosedRequest.html +++ b/docs/interfaces/LedgerClosedRequest.html @@ -39,7 +39,7 @@

    Hierarchy

    • LedgerClosedRequest
    +
  • Defined in packages/xrpl/src/models/methods/ledgerClosed.ts:18
    • @@ -61,7 +61,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "ledger_closed"
    @@ -70,7 +70,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/ledgerClosed.ts:19

    • Optional id

    id?: string | number
    @@ -81,7 +81,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12
    • diff --git a/docs/interfaces/LedgerClosedResponse.html b/docs/interfaces/LedgerClosedResponse.html index 433c508b0c..1f17fbf55d 100644 --- a/docs/interfaces/LedgerClosedResponse.html +++ b/docs/interfaces/LedgerClosedResponse.html @@ -32,7 +32,7 @@

    Hierarchy

    • LedgerClosedResponse
    +
  • Defined in packages/xrpl/src/models/methods/ledgerClosed.ts:27
    • @@ -56,19 +56,19 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • result

    result: {
        ledger_hash: string;
        ledger_index: number;
    }
    @@ -81,31 +81,31 @@
    ledger_hashledger_index: number
    +
  • Defined in packages/xrpl/src/models/methods/ledgerClosed.ts:28

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/LedgerCurrentRequest.html b/docs/interfaces/LedgerCurrentRequest.html index 8014bb53b3..a69b489274 100644 --- a/docs/interfaces/LedgerCurrentRequest.html +++ b/docs/interfaces/LedgerCurrentRequest.html @@ -36,7 +36,7 @@

    Hierarchy

    • LedgerCurrentRequest
    +
  • Defined in packages/xrpl/src/models/methods/ledgerCurrent.ts:17
    • @@ -58,7 +58,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "ledger_current"
    @@ -67,7 +67,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/ledgerCurrent.ts:18

    • Optional id

    id?: string | number
    @@ -78,7 +78,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12
    • diff --git a/docs/interfaces/LedgerCurrentResponse.html b/docs/interfaces/LedgerCurrentResponse.html index 5e5835e279..9506b6e56d 100644 --- a/docs/interfaces/LedgerCurrentResponse.html +++ b/docs/interfaces/LedgerCurrentResponse.html @@ -32,7 +32,7 @@

    Hierarchy

    • LedgerCurrentResponse
    +
  • Defined in packages/xrpl/src/models/methods/ledgerCurrent.ts:26
    • @@ -56,19 +56,19 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • result

    result: {
        ledger_current_index: number;
    }
    @@ -82,31 +82,31 @@
    ledger_current_index
    +
  • Defined in packages/xrpl/src/models/methods/ledgerCurrent.ts:27

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/LedgerDataBinaryLedgerEntry.html b/docs/interfaces/LedgerDataBinaryLedgerEntry.html index f898bba1b9..453fe1da80 100644 --- a/docs/interfaces/LedgerDataBinaryLedgerEntry.html +++ b/docs/interfaces/LedgerDataBinaryLedgerEntry.html @@ -26,7 +26,7 @@

    Hierarchy

    • LedgerDataBinaryLedgerEntry
    +
  • Defined in packages/xrpl/src/models/methods/ledgerData.ts:50
    • @@ -42,7 +42,7 @@

    Properties

    data

    data: string
    +
  • Defined in packages/xrpl/src/models/methods/ledgerData.ts:51
    • diff --git a/docs/interfaces/LedgerDataRequest.html b/docs/interfaces/LedgerDataRequest.html index 954149be2c..7d15f6fdef 100644 --- a/docs/interfaces/LedgerDataRequest.html +++ b/docs/interfaces/LedgerDataRequest.html @@ -38,7 +38,7 @@

    Hierarchy

    • LedgerDataRequest
    +
  • Defined in packages/xrpl/src/models/methods/ledgerData.ts:23
    • @@ -66,7 +66,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • Optional binary

    binary?: boolean
    @@ -75,7 +75,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ledgerData.ts:29

    • command

    command: "ledger_data"
    @@ -84,7 +84,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/ledgerData.ts:24

    • Optional id

    id?: string | number
    @@ -95,7 +95,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional ledger_hash

    ledger_hash?: string
    @@ -104,7 +104,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:21

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -113,7 +113,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:23

    • Optional limit

    limit?: number
    @@ -122,7 +122,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ledgerData.ts:34

    • Optional marker

    marker?: unknown
    @@ -131,7 +131,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ledgerData.ts:39

    • Optional type

    type?: LedgerEntryFilter
    @@ -139,7 +139,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ledgerData.ts:43
    • diff --git a/docs/interfaces/LedgerDataResponse.html b/docs/interfaces/LedgerDataResponse.html index ea21337953..6d8c0c1f7f 100644 --- a/docs/interfaces/LedgerDataResponse.html +++ b/docs/interfaces/LedgerDataResponse.html @@ -32,7 +32,7 @@

    Hierarchy

    • LedgerDataResponse
    +
  • Defined in packages/xrpl/src/models/methods/ledgerData.ts:64
    • @@ -56,19 +56,19 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • result

    result: {
        ledger_hash: string;
        ledger_index: number;
        marker?: unknown;
        state: LedgerDataLedgerState[];
        validated?: boolean;
    }
    @@ -101,31 +101,31 @@
    stateOptional validated?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/ledgerData.ts:65

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/LedgerEntry.AMM.html b/docs/interfaces/LedgerEntry.AMM.html index 36d2c55591..dcdff7a1bf 100644 --- a/docs/interfaces/LedgerEntry.AMM.html +++ b/docs/interfaces/LedgerEntry.AMM.html @@ -34,7 +34,7 @@

    Hierarchy

    • AMM
    +
  • Defined in packages/xrpl/src/models/ledger/AMM.ts:18
    • @@ -64,7 +64,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/ledger/AMM.ts:23

    • Asset

    Asset: Currency
    @@ -72,7 +72,7 @@

    Asset

    +
  • Defined in packages/xrpl/src/models/ledger/AMM.ts:27

    • Asset2

    Asset2: Currency
    @@ -80,7 +80,7 @@

    Asset2

    +
  • Defined in packages/xrpl/src/models/ledger/AMM.ts:31

    • Optional AuctionSlot

    AuctionSlot?: {
        Account: string;
        AuthAccounts?: AuthAccount[];
        DiscountedFee: number;
        Expiration: number;
        Price: IssuedCurrencyAmount;
    }
    @@ -117,7 +117,7 @@
    Price
    +
  • Defined in packages/xrpl/src/models/ledger/AMM.ts:35

    • Flags

    Flags: 0
    @@ -126,22 +126,22 @@

    Flags

    +
  • Defined in packages/xrpl/src/models/ledger/AMM.ts:77

    • LPTokenBalance

    -
    LPTokenBalance: Currency
    +
    LPTokenBalance: IssuedCurrencyAmount

    The total outstanding balance of liquidity provider tokens from this AMM instance. The holders of these tokens can vote on the AMM's trading fee in proportion to their holdings, or redeem the tokens for a share of the AMM's assets which grows with the trading fees collected.

    +
  • Defined in packages/xrpl/src/models/ledger/AMM.ts:63

    • LedgerEntryType

    LedgerEntryType: "AMM"
    +
  • Defined in packages/xrpl/src/models/ledger/AMM.ts:19

    • PreviousTxnID

    PreviousTxnID: never
    @@ -150,7 +150,7 @@

    PreviousTxnID

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:22

    • PreviousTxnLgrSeq

    PreviousTxnLgrSeq: never
    @@ -159,7 +159,7 @@

    PreviousTxnLgrSeq

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:26

    • TradingFee

    TradingFee: number
    @@ -168,7 +168,7 @@

    TradingFee

    +
  • Defined in packages/xrpl/src/models/ledger/AMM.ts:68

    • Optional VoteSlots

    VoteSlots?: VoteSlot[]
    @@ -176,13 +176,13 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/AMM.ts:72

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • diff --git a/docs/interfaces/LedgerEntry.AccountRoot.html b/docs/interfaces/LedgerEntry.AccountRoot.html index 7e94643d74..19ed938af7 100644 --- a/docs/interfaces/LedgerEntry.AccountRoot.html +++ b/docs/interfaces/LedgerEntry.AccountRoot.html @@ -35,7 +35,7 @@

    Hierarchy

    • AccountRoot
    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:9
    • @@ -78,7 +78,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:36

    • Account

    Account: string
    @@ -86,7 +86,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:12

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -97,7 +97,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:30

    • Balance

    Balance: string
    @@ -105,7 +105,7 @@

    Balance

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:14

    • Optional BurnedNFTokens

    BurnedNFTokens?: number
    @@ -113,7 +113,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:74

    • Optional Domain

    Domain?: string
    @@ -122,7 +122,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:41

    • Optional EmailHash

    EmailHash?: string
    @@ -130,7 +130,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:43

    • FirstNFTSequence

    FirstNFTSequence: number
    @@ -138,7 +138,7 @@

    FirstNFTSequence

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:76

    • Flags

    Flags: number
    @@ -146,12 +146,12 @@

    Flags

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:16

    • LedgerEntryType

    LedgerEntryType: "AccountRoot"
    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:10

    • Optional MessageKey

    MessageKey?: string
    @@ -160,7 +160,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:48

    • Optional MintedNFTokens

    MintedNFTokens?: number
    @@ -168,7 +168,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:78

    • Optional NFTokenMinter

    NFTokenMinter?: string
    @@ -176,7 +176,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:80

    • OwnerCount

    OwnerCount: number
    @@ -185,7 +185,7 @@

    OwnerCount

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:21

    • PreviousTxnID

    PreviousTxnID: string
    @@ -195,7 +195,7 @@

    PreviousTxnID

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:10

    • PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    @@ -205,7 +205,7 @@

    PreviousTxnLgrSeq

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:15

    • Optional RegularKey

    RegularKey?: string
    @@ -215,7 +215,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:54

    • Sequence

    Sequence: number
    @@ -223,7 +223,7 @@

    Sequence

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:23

    • Optional TickSize

    TickSize?: number
    @@ -232,7 +232,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:65

    • Optional TicketCount

    TicketCount?: number
    @@ -242,7 +242,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:60

    • Optional TransferRate

    TransferRate?: number
    @@ -251,7 +251,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:70

    • Optional WalletLocator

    WalletLocator?: string
    @@ -259,13 +259,13 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:72

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • diff --git a/docs/interfaces/LedgerEntry.AccountRootFlagsInterface.html b/docs/interfaces/LedgerEntry.AccountRootFlagsInterface.html index 5e0b2821f6..506b09c13d 100644 --- a/docs/interfaces/LedgerEntry.AccountRootFlagsInterface.html +++ b/docs/interfaces/LedgerEntry.AccountRootFlagsInterface.html @@ -32,7 +32,7 @@

    Hierarchy

    • AccountRootFlagsInterface
    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:87
    • @@ -65,7 +65,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:128

    • Optional lsfAllowTrustLineClawback

    lsfAllowTrustLineClawback?: boolean
    @@ -73,7 +73,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:148

    • Optional lsfDefaultRipple

    lsfDefaultRipple?: boolean
    @@ -81,7 +81,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:119

    • Optional lsfDepositAuth

    lsfDepositAuth?: boolean
    @@ -90,7 +90,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:124

    • Optional lsfDisableMaster

    lsfDisableMaster?: boolean
    @@ -98,7 +98,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:107

    • Optional lsfDisallowIncomingCheck

    lsfDisallowIncomingCheck?: boolean
    @@ -106,7 +106,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:136

    • Optional lsfDisallowIncomingNFTokenOffer

    lsfDisallowIncomingNFTokenOffer?: boolean
    @@ -114,7 +114,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:132

    • Optional lsfDisallowIncomingPayChan

    lsfDisallowIncomingPayChan?: boolean
    @@ -122,7 +122,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:140

    • Optional lsfDisallowIncomingTrustline

    lsfDisallowIncomingTrustline?: boolean
    @@ -130,7 +130,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:144

    • Optional lsfDisallowXRP

    lsfDisallowXRP?: boolean
    @@ -138,7 +138,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:103

    • Optional lsfGlobalFreeze

    lsfGlobalFreeze?: boolean
    @@ -146,7 +146,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:115

    • Optional lsfNoFreeze

    lsfNoFreeze?: boolean
    @@ -154,7 +154,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:111

    • Optional lsfPasswordSpent

    lsfPasswordSpent?: boolean
    @@ -162,7 +162,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:91

    • Optional lsfRequireAuth

    lsfRequireAuth?: boolean
    @@ -170,7 +170,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:99

    • Optional lsfRequireDestTag

    lsfRequireDestTag?: boolean
    @@ -178,7 +178,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:95
    • diff --git a/docs/interfaces/LedgerEntry.Amendments.html b/docs/interfaces/LedgerEntry.Amendments.html index 53e9f3471a..0e899d64e6 100644 --- a/docs/interfaces/LedgerEntry.Amendments.html +++ b/docs/interfaces/LedgerEntry.Amendments.html @@ -35,7 +35,7 @@

    Hierarchy

    • Amendments
    +
  • Defined in packages/xrpl/src/models/ledger/Amendments.ts:27
    • @@ -61,7 +61,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/Amendments.ts:35

    • Flags

    Flags: 0
    @@ -70,12 +70,12 @@

    Flags

    +
  • Defined in packages/xrpl/src/models/ledger/Amendments.ts:46

    • LedgerEntryType

    LedgerEntryType: "Amendments"
    +
  • Defined in packages/xrpl/src/models/ledger/Amendments.ts:30

    • Optional Majorities

    Majorities?: Majority[]
    @@ -85,7 +85,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/Amendments.ts:41

    • PreviousTxnID

    PreviousTxnID: never
    @@ -94,7 +94,7 @@

    PreviousTxnID

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:22

    • PreviousTxnLgrSeq

    PreviousTxnLgrSeq: never
    @@ -103,13 +103,13 @@

    PreviousTxnLgrSeq

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:26

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • diff --git a/docs/interfaces/LedgerEntry.Bridge.html b/docs/interfaces/LedgerEntry.Bridge.html index e4eee82e4a..adec34b633 100644 --- a/docs/interfaces/LedgerEntry.Bridge.html +++ b/docs/interfaces/LedgerEntry.Bridge.html @@ -36,7 +36,7 @@

    Hierarchy

    • Bridge
    +
  • Defined in packages/xrpl/src/models/ledger/Bridge.ts:12
    • @@ -67,7 +67,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/ledger/Bridge.ts:16

    • Flags

    Flags: 0
    @@ -76,12 +76,12 @@

    Flags

    +
  • Defined in packages/xrpl/src/models/ledger/Bridge.ts:65

    • LedgerEntryType

    LedgerEntryType: "Bridge"
    +
  • Defined in packages/xrpl/src/models/ledger/Bridge.ts:13

    • Optional MinAccountCreateAmount

    MinAccountCreateAmount?: string
    @@ -91,7 +91,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/Bridge.ts:59

    • OwnerNode

    OwnerNode: string
    @@ -100,7 +100,7 @@

    OwnerNode

    +
  • Defined in packages/xrpl/src/models/ledger/Bridge.ts:71

    • PreviousTxnID

    PreviousTxnID: string
    @@ -110,7 +110,7 @@

    PreviousTxnID

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:10

    • PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    @@ -120,7 +120,7 @@

    PreviousTxnLgrSeq

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:15

    • SignatureReward

    SignatureReward: Amount
    @@ -130,7 +130,7 @@

    SignatureReward

    +
  • Defined in packages/xrpl/src/models/ledger/Bridge.ts:23

    • XChainAccountClaimCount

    XChainAccountClaimCount: string
    @@ -145,7 +145,7 @@

    XChainAccountClaimCount

    +
  • Defined in packages/xrpl/src/models/ledger/Bridge.ts:52

    • XChainAccountCreateCount

    XChainAccountCreateCount: string
    @@ -155,7 +155,7 @@

    XChainAccountCreateCount

    +
  • Defined in packages/xrpl/src/models/ledger/Bridge.ts:40

    • XChainBridge

    XChainBridge: XChainBridge
    @@ -163,7 +163,7 @@

    XChainBridge

    +
  • Defined in packages/xrpl/src/models/ledger/Bridge.ts:28

    • XChainClaimID

    XChainClaimID: string
    @@ -171,13 +171,13 @@

    XChainClaimID

    +
  • Defined in packages/xrpl/src/models/ledger/Bridge.ts:33

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • diff --git a/docs/interfaces/LedgerEntry.Check.html b/docs/interfaces/LedgerEntry.Check.html index 74f7aa2753..da0474d0ca 100644 --- a/docs/interfaces/LedgerEntry.Check.html +++ b/docs/interfaces/LedgerEntry.Check.html @@ -35,7 +35,7 @@

    Hierarchy

    • Check
    +
  • Defined in packages/xrpl/src/models/ledger/Check.ts:11
    • @@ -68,7 +68,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/ledger/Check.ts:14

    • Destination

    Destination: string
    @@ -77,7 +77,7 @@

    Destination

    +
  • Defined in packages/xrpl/src/models/ledger/Check.ts:19

    • Optional DestinationNode

    DestinationNode?: string
    @@ -86,7 +86,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/Check.ts:52

    • Optional DestinationTag

    DestinationTag?: number
    @@ -95,7 +95,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/Check.ts:57

    • Optional Expiration

    Expiration?: number
    @@ -103,7 +103,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/Check.ts:59

    • Flags

    Flags: 0
    @@ -112,7 +112,7 @@

    Flags

    +
  • Defined in packages/xrpl/src/models/ledger/Check.ts:24

    • Optional InvoiceID

    InvoiceID?: string
    @@ -121,12 +121,12 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/Check.ts:64

    • LedgerEntryType

    LedgerEntryType: "Check"
    +
  • Defined in packages/xrpl/src/models/ledger/Check.ts:12

    • OwnerNode

    OwnerNode: string
    @@ -135,7 +135,7 @@

    OwnerNode

    +
  • Defined in packages/xrpl/src/models/ledger/Check.ts:29

    • PreviousTxnID

    PreviousTxnID: string
    @@ -145,7 +145,7 @@

    PreviousTxnID

    +
  • Defined in packages/xrpl/src/models/ledger/Check.ts:34

    • PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    @@ -155,7 +155,7 @@

    PreviousTxnLgrSeq

    +
  • Defined in packages/xrpl/src/models/ledger/Check.ts:39

    • SendMax

    SendMax: Amount
    @@ -165,7 +165,7 @@

    SendMax

    +
  • Defined in packages/xrpl/src/models/ledger/Check.ts:45

    • Sequence

    Sequence: number
    @@ -173,7 +173,7 @@

    Sequence

    +
  • Defined in packages/xrpl/src/models/ledger/Check.ts:47

    • Optional SourceTag

    SourceTag?: number
    @@ -182,13 +182,13 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/Check.ts:69

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • diff --git a/docs/interfaces/LedgerEntry.DID.html b/docs/interfaces/LedgerEntry.DID.html index 801c52d18c..c8ad91364a 100644 --- a/docs/interfaces/LedgerEntry.DID.html +++ b/docs/interfaces/LedgerEntry.DID.html @@ -30,7 +30,7 @@

    Hierarchy

    • DID
    +
  • Defined in packages/xrpl/src/models/ledger/DID.ts:8
    • @@ -55,32 +55,32 @@

    Properties

    Account

    Account: string
    +
  • Defined in packages/xrpl/src/models/ledger/DID.ts:11

    • DIDDocument

    DIDDocument: string
    +
  • Defined in packages/xrpl/src/models/ledger/DID.ts:15

    • Data

    Data: string
    +
  • Defined in packages/xrpl/src/models/ledger/DID.ts:13

    • Flags

    Flags: 0
    +
  • Defined in packages/xrpl/src/models/ledger/DID.ts:19

    • LedgerEntryType

    LedgerEntryType: "DID"
    +
  • Defined in packages/xrpl/src/models/ledger/DID.ts:9

    • OwnerNode

    OwnerNode: string
    +
  • Defined in packages/xrpl/src/models/ledger/DID.ts:21

    • PreviousTxnID

    PreviousTxnID: string
    @@ -90,7 +90,7 @@

    PreviousTxnID

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:10

    • PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    @@ -100,18 +100,18 @@

    PreviousTxnLgrSeq

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:15

    • URI

    URI: string
    +
  • Defined in packages/xrpl/src/models/ledger/DID.ts:17

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • diff --git a/docs/interfaces/LedgerEntry.DepositPreauth.html b/docs/interfaces/LedgerEntry.DepositPreauth.html index 48e3ae1167..b4095b1835 100644 --- a/docs/interfaces/LedgerEntry.DepositPreauth.html +++ b/docs/interfaces/LedgerEntry.DepositPreauth.html @@ -35,7 +35,7 @@

    Hierarchy

    • DepositPreauth
    +
  • Defined in packages/xrpl/src/models/ledger/DepositPreauth.ts:9
    • @@ -61,7 +61,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/ledger/DepositPreauth.ts:14

    • Authorize

    Authorize: string
    @@ -69,7 +69,7 @@

    Authorize

    +
  • Defined in packages/xrpl/src/models/ledger/DepositPreauth.ts:16

    • Flags

    Flags: 0
    @@ -78,12 +78,12 @@

    Flags

    +
  • Defined in packages/xrpl/src/models/ledger/DepositPreauth.ts:21

    • LedgerEntryType

    LedgerEntryType: "DepositPreauth"
    +
  • Defined in packages/xrpl/src/models/ledger/DepositPreauth.ts:12

    • OwnerNode

    OwnerNode: string
    @@ -92,7 +92,7 @@

    OwnerNode

    +
  • Defined in packages/xrpl/src/models/ledger/DepositPreauth.ts:26

    • PreviousTxnID

    PreviousTxnID: string
    @@ -102,7 +102,7 @@

    PreviousTxnID

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:10

    • PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    @@ -112,13 +112,13 @@

    PreviousTxnLgrSeq

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:15

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • diff --git a/docs/interfaces/LedgerEntry.DirectoryNode.html b/docs/interfaces/LedgerEntry.DirectoryNode.html index 8cc2e5c446..5dc1e95e81 100644 --- a/docs/interfaces/LedgerEntry.DirectoryNode.html +++ b/docs/interfaces/LedgerEntry.DirectoryNode.html @@ -35,7 +35,7 @@

    Hierarchy

    • DirectoryNode
    +
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:9
    • @@ -68,7 +68,7 @@

    Flags

    +
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:17

    • Optional IndexNext

    IndexNext?: number
    @@ -77,7 +77,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:26

    • Optional IndexPrevious

    IndexPrevious?: number
    @@ -86,7 +86,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:31

    • Indexes

    Indexes: string[]
    @@ -94,12 +94,12 @@

    Indexes

    +
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:21

    • LedgerEntryType

    LedgerEntryType: "DirectoryNode"
    +
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:12

    • Optional Owner

    Owner?: string
    @@ -107,7 +107,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:33

    • PreviousTxnID

    PreviousTxnID: never
    @@ -116,7 +116,7 @@

    PreviousTxnID

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:22

    • PreviousTxnLgrSeq

    PreviousTxnLgrSeq: never
    @@ -125,7 +125,7 @@

    PreviousTxnLgrSeq

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:26

    • RootIndex

    RootIndex: string
    @@ -133,7 +133,7 @@

    RootIndex

    +
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:19

    • Optional TakerGetsCurrency

    TakerGetsCurrency?: string
    @@ -142,7 +142,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:45

    • Optional TakerGetsIssuer

    TakerGetsIssuer?: string
    @@ -150,7 +150,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:47

    • Optional TakerPaysCurrency

    TakerPaysCurrency?: string
    @@ -159,7 +159,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:38

    • Optional TakerPaysIssuer

    TakerPaysIssuer?: string
    @@ -167,13 +167,13 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:40

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • diff --git a/docs/interfaces/LedgerEntry.Escrow.html b/docs/interfaces/LedgerEntry.Escrow.html index 90f6b33f08..616e58e2b8 100644 --- a/docs/interfaces/LedgerEntry.Escrow.html +++ b/docs/interfaces/LedgerEntry.Escrow.html @@ -35,7 +35,7 @@

    Hierarchy

    • Escrow
    +
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:9
    • @@ -70,7 +70,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:16

    • Amount

    Amount: string
    @@ -78,7 +78,7 @@

    Amount

    +
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:23

    • Optional CancelAfter

    CancelAfter?: number
    @@ -86,7 +86,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:33

    • Optional Condition

    Condition?: string
    @@ -96,7 +96,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:29

    • Destination

    Destination: string
    @@ -105,7 +105,7 @@

    Destination

    +
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:21

    • Optional DestinationNode

    DestinationNode?: string
    @@ -114,7 +114,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:63

    • Optional DestinationTag

    DestinationTag?: number
    @@ -123,7 +123,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:53

    • Optional FinishAfter

    FinishAfter?: number
    @@ -132,7 +132,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:38

    • Flags

    Flags: number
    @@ -141,12 +141,12 @@

    Flags

    +
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:43

    • LedgerEntryType

    LedgerEntryType: "Escrow"
    +
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:10

    • OwnerNode

    OwnerNode: string
    @@ -155,7 +155,7 @@

    OwnerNode

    +
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:58

    • PreviousTxnID

    PreviousTxnID: string
    @@ -165,7 +165,7 @@

    PreviousTxnID

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:10

    • PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    @@ -175,7 +175,7 @@

    PreviousTxnLgrSeq

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:15

    • Optional SourceTag

    SourceTag?: number
    @@ -184,13 +184,13 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:48

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • diff --git a/docs/interfaces/LedgerEntry.FeeSettings.html b/docs/interfaces/LedgerEntry.FeeSettings.html index 19b49da969..d31552f027 100644 --- a/docs/interfaces/LedgerEntry.FeeSettings.html +++ b/docs/interfaces/LedgerEntry.FeeSettings.html @@ -37,7 +37,7 @@

    Hierarchy

    • FeeSettings
    +
  • Defined in packages/xrpl/src/models/ledger/FeeSettings.ts:49
    • @@ -60,12 +60,12 @@

    Flags

    +
  • Defined in packages/xrpl/src/models/ledger/FeeSettings.ts:34

    • LedgerEntryType

    LedgerEntryType: "FeeSettings"
    +
  • Defined in packages/xrpl/src/models/ledger/FeeSettings.ts:30

    • PreviousTxnID

    PreviousTxnID: never
    @@ -73,7 +73,7 @@

    PreviousTxnID

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:22

    • PreviousTxnLgrSeq

    PreviousTxnLgrSeq: never
    @@ -81,12 +81,12 @@

    PreviousTxnLgrSeq

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:26

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • diff --git a/docs/interfaces/LedgerEntry.FeeSettingsPostAmendmentFields.html b/docs/interfaces/LedgerEntry.FeeSettingsPostAmendmentFields.html index 76c87f8a6d..6f409c30e3 100644 --- a/docs/interfaces/LedgerEntry.FeeSettingsPostAmendmentFields.html +++ b/docs/interfaces/LedgerEntry.FeeSettingsPostAmendmentFields.html @@ -27,7 +27,7 @@

    Hierarchy

    • FeeSettingsPostAmendmentFields
    +
  • Defined in packages/xrpl/src/models/ledger/FeeSettings.ts:20
    • @@ -48,7 +48,7 @@

    BaseFeeDrops

    +
  • Defined in packages/xrpl/src/models/ledger/FeeSettings.ts:22

    • ReserveBaseDrops

    ReserveBaseDrops: string
    @@ -56,7 +56,7 @@

    ReserveBaseDrops

    +
  • Defined in packages/xrpl/src/models/ledger/FeeSettings.ts:24

    • ReserveIncrementDrops

    ReserveIncrementDrops: string
    @@ -64,7 +64,7 @@

    ReserveIncrementDrops

    +
  • Defined in packages/xrpl/src/models/ledger/FeeSettings.ts:26
    • diff --git a/docs/interfaces/LedgerEntry.FeeSettingsPreAmendmentFields.html b/docs/interfaces/LedgerEntry.FeeSettingsPreAmendmentFields.html index e6a4180dcc..ed57665e9b 100644 --- a/docs/interfaces/LedgerEntry.FeeSettingsPreAmendmentFields.html +++ b/docs/interfaces/LedgerEntry.FeeSettingsPreAmendmentFields.html @@ -27,7 +27,7 @@

    Hierarchy

    • FeeSettingsPreAmendmentFields
    +
  • Defined in packages/xrpl/src/models/ledger/FeeSettings.ts:9
    • @@ -49,7 +49,7 @@

    BaseFee

    +
  • Defined in packages/xrpl/src/models/ledger/FeeSettings.ts:11

    • ReferenceFeeUnits

    ReferenceFeeUnits: number
    @@ -57,7 +57,7 @@

    ReferenceFeeUnits

    +
  • Defined in packages/xrpl/src/models/ledger/FeeSettings.ts:13

    • ReserveBase

    ReserveBase: number
    @@ -65,7 +65,7 @@

    ReserveBase

    +
  • Defined in packages/xrpl/src/models/ledger/FeeSettings.ts:15

    • ReserveIncrement

    ReserveIncrement: number
    @@ -73,7 +73,7 @@

    ReserveIncrement

    +
  • Defined in packages/xrpl/src/models/ledger/FeeSettings.ts:17
    • diff --git a/docs/interfaces/LedgerEntry.Ledger.html b/docs/interfaces/LedgerEntry.Ledger.html index ad8b8a0007..ad7fd4e808 100644 --- a/docs/interfaces/LedgerEntry.Ledger.html +++ b/docs/interfaces/LedgerEntry.Ledger.html @@ -32,7 +32,7 @@

    Hierarchy

    • Ledger
    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:11
    • @@ -64,7 +64,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:15

    • account_hash

    account_hash: string
    @@ -72,7 +72,7 @@

    account_hash

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:13

    • close_flags

    close_flags: number
    @@ -80,7 +80,7 @@

    close_flags

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:17

    • close_time

    close_time: number
    @@ -90,7 +90,7 @@

    close_time

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:23

    • close_time_human

    close_time_human: string
    @@ -99,7 +99,7 @@

    close_time_human

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:28

    • close_time_resolution

    close_time_resolution: number
    @@ -108,7 +108,7 @@

    close_time_resolution

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:33

    • closed

    closed: boolean
    @@ -116,7 +116,7 @@

    closed

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:35

    • ledger_hash

    ledger_hash: string
    @@ -125,7 +125,7 @@

    ledger_hash

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:40

    • ledger_index

    ledger_index: string
    @@ -134,7 +134,7 @@

    ledger_index

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:45

    • parent_close_time

    parent_close_time: number
    @@ -142,7 +142,7 @@

    parent_close_time

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:47

    • parent_hash

    parent_hash: string
    @@ -151,7 +151,7 @@

    parent_hash

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:52

    • total_coins

    total_coins: string
    @@ -159,7 +159,7 @@

    total_coins

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:54

    • transaction_hash

    transaction_hash: string
    @@ -167,7 +167,7 @@

    transaction_hash

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:56

    • Optional transactions

    transactions?: Object[]
    @@ -179,7 +179,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:64
    • diff --git a/docs/interfaces/LedgerEntry.LedgerHashes.html b/docs/interfaces/LedgerEntry.LedgerHashes.html index 95320ba6ff..1da66816bd 100644 --- a/docs/interfaces/LedgerEntry.LedgerHashes.html +++ b/docs/interfaces/LedgerEntry.LedgerHashes.html @@ -36,7 +36,7 @@

    Hierarchy

    • LedgerHashes
    +
  • Defined in packages/xrpl/src/models/ledger/LedgerHashes.ts:10
    • @@ -62,7 +62,7 @@

    Flags

    +
  • Defined in packages/xrpl/src/models/ledger/LedgerHashes.ts:25

    • Hashes

    Hashes: string[]
    @@ -71,7 +71,7 @@

    Hashes

    +
  • Defined in packages/xrpl/src/models/ledger/LedgerHashes.ts:20

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -79,12 +79,12 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/LedgerHashes.ts:15

    • LedgerEntryType

    LedgerEntryType: "LedgerHashes"
    +
  • Defined in packages/xrpl/src/models/ledger/LedgerHashes.ts:13

    • PreviousTxnID

    PreviousTxnID: never
    @@ -93,7 +93,7 @@

    PreviousTxnID

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:22

    • PreviousTxnLgrSeq

    PreviousTxnLgrSeq: never
    @@ -102,13 +102,13 @@

    PreviousTxnLgrSeq

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:26

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • diff --git a/docs/interfaces/LedgerEntry.Majority.html b/docs/interfaces/LedgerEntry.Majority.html index 72fafba6bf..0fad4bd33d 100644 --- a/docs/interfaces/LedgerEntry.Majority.html +++ b/docs/interfaces/LedgerEntry.Majority.html @@ -27,7 +27,7 @@

    Hierarchy

    • Majority
    +
  • Defined in packages/xrpl/src/models/ledger/Amendments.ts:9
    • @@ -57,7 +57,7 @@
    CloseTime
    +
  • Defined in packages/xrpl/src/models/ledger/Amendments.ts:10
    • diff --git a/docs/interfaces/LedgerEntry.NFToken.html b/docs/interfaces/LedgerEntry.NFToken.html index 0834dcab5d..dc48c8cb78 100644 --- a/docs/interfaces/LedgerEntry.NFToken.html +++ b/docs/interfaces/LedgerEntry.NFToken.html @@ -27,7 +27,7 @@

    Hierarchy

    • NFToken
    +
  • Defined in packages/xrpl/src/models/ledger/NFTokenPage.ts:3
    • @@ -56,7 +56,7 @@
    NFTokenTaxon
    Optional URI?: string
    +
  • Defined in packages/xrpl/src/models/ledger/NFTokenPage.ts:4
    • diff --git a/docs/interfaces/LedgerEntry.NFTokenOffer.html b/docs/interfaces/LedgerEntry.NFTokenOffer.html index c4864ba07d..8a33c98f04 100644 --- a/docs/interfaces/LedgerEntry.NFTokenOffer.html +++ b/docs/interfaces/LedgerEntry.NFTokenOffer.html @@ -30,7 +30,7 @@

    Hierarchy

    • NFTokenOffer
    +
  • Defined in packages/xrpl/src/models/ledger/NFTokenOffer.ts:5
    • @@ -56,42 +56,42 @@

    Properties

    Amount

    Amount: Amount
    +
  • Defined in packages/xrpl/src/models/ledger/NFTokenOffer.ts:7

    • Optional Destination

    Destination?: string
    +
  • Defined in packages/xrpl/src/models/ledger/NFTokenOffer.ts:8

    • Expiration

    Expiration: number
    +
  • Defined in packages/xrpl/src/models/ledger/NFTokenOffer.ts:9

    • Flags

    Flags: number
    +
  • Defined in packages/xrpl/src/models/ledger/NFTokenOffer.ts:10

    • LedgerEntryType

    LedgerEntryType: "NFTokenOffer"
    +
  • Defined in packages/xrpl/src/models/ledger/NFTokenOffer.ts:6

    • Optional NFTokenOfferNode

    NFTokenOfferNode?: string
    +
  • Defined in packages/xrpl/src/models/ledger/NFTokenOffer.ts:11

    • Owner

    Owner: string
    +
  • Defined in packages/xrpl/src/models/ledger/NFTokenOffer.ts:12

    • Optional OwnerNode

    OwnerNode?: string
    +
  • Defined in packages/xrpl/src/models/ledger/NFTokenOffer.ts:13

    • PreviousTxnID

    PreviousTxnID: string
    @@ -101,7 +101,7 @@

    PreviousTxnID

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:10

    • PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    @@ -111,13 +111,13 @@

    PreviousTxnLgrSeq

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:15

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • diff --git a/docs/interfaces/LedgerEntry.NFTokenPage.html b/docs/interfaces/LedgerEntry.NFTokenPage.html index 27fa9a07dd..f8b59829f6 100644 --- a/docs/interfaces/LedgerEntry.NFTokenPage.html +++ b/docs/interfaces/LedgerEntry.NFTokenPage.html @@ -30,7 +30,7 @@

    Hierarchy

    • NFTokenPage
    +
  • Defined in packages/xrpl/src/models/ledger/NFTokenPage.ts:13
    • @@ -52,22 +52,22 @@

    Properties

    LedgerEntryType

    LedgerEntryType: "NFTokenPage"
    +
  • Defined in packages/xrpl/src/models/ledger/NFTokenPage.ts:14

    • NFTokens

    NFTokens: LedgerEntry.NFToken[]
    +
  • Defined in packages/xrpl/src/models/ledger/NFTokenPage.ts:16

    • Optional NextPageMin

    NextPageMin?: string
    +
  • Defined in packages/xrpl/src/models/ledger/NFTokenPage.ts:15

    • Optional PreviousPageMin

    PreviousPageMin?: string
    +
  • Defined in packages/xrpl/src/models/ledger/NFTokenPage.ts:17

    • PreviousTxnID

    PreviousTxnID: string
    @@ -77,7 +77,7 @@

    PreviousTxnID

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:10

    • PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    @@ -87,13 +87,13 @@

    PreviousTxnLgrSeq

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:15

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • diff --git a/docs/interfaces/LedgerEntry.NegativeUNL.html b/docs/interfaces/LedgerEntry.NegativeUNL.html index 5848abeaaf..51f6d3d50a 100644 --- a/docs/interfaces/LedgerEntry.NegativeUNL.html +++ b/docs/interfaces/LedgerEntry.NegativeUNL.html @@ -35,7 +35,7 @@

    Hierarchy

    • NegativeUNL
    +
  • Defined in packages/xrpl/src/models/ledger/NegativeUNL.ts:15
    • @@ -67,12 +67,12 @@
    FirstLedgerSequencePublicKey: string
    +
  • Defined in packages/xrpl/src/models/ledger/NegativeUNL.ts:22

    • LedgerEntryType

    LedgerEntryType: "NegativeUNL"
    +
  • Defined in packages/xrpl/src/models/ledger/NegativeUNL.ts:18

    • PreviousTxnID

    PreviousTxnID: never
    @@ -81,7 +81,7 @@

    PreviousTxnID

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:22

    • PreviousTxnLgrSeq

    PreviousTxnLgrSeq: never
    @@ -90,7 +90,7 @@

    PreviousTxnLgrSeq

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:26

    • Optional ValidatorToDisable

    ValidatorToDisable?: string
    @@ -99,7 +99,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/NegativeUNL.ts:30

    • Optional ValidatorToReEnable

    ValidatorToReEnable?: string
    @@ -108,13 +108,13 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/NegativeUNL.ts:35

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • diff --git a/docs/interfaces/LedgerEntry.Offer.html b/docs/interfaces/LedgerEntry.Offer.html index 748407c2f1..2931ca4f8e 100644 --- a/docs/interfaces/LedgerEntry.Offer.html +++ b/docs/interfaces/LedgerEntry.Offer.html @@ -32,7 +32,7 @@

    Hierarchy

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:5
    • @@ -63,7 +63,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:10

    • BookDirectory

    BookDirectory: string
    @@ -71,7 +71,7 @@

    BookDirectory

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:24

    • BookNode

    BookNode: string
    @@ -80,7 +80,7 @@

    BookNode

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:29

    • Optional Expiration

    Expiration?: number
    @@ -88,7 +88,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:36

    • Flags

    Flags: number
    @@ -96,12 +96,12 @@

    Flags

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:8

    • LedgerEntryType

    LedgerEntryType: "Offer"
    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:6

    • OwnerNode

    OwnerNode: string
    @@ -110,7 +110,7 @@

    OwnerNode

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:34

    • PreviousTxnID

    PreviousTxnID: string
    @@ -120,7 +120,7 @@

    PreviousTxnID

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:10

    • PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    @@ -130,7 +130,7 @@

    PreviousTxnLgrSeq

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:15

    • Sequence

    Sequence: number
    @@ -139,7 +139,7 @@

    Sequence

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:15

    • TakerGets

    TakerGets: Amount
    @@ -148,7 +148,7 @@

    TakerGets

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:22

    • TakerPays

    TakerPays: Amount
    @@ -156,13 +156,13 @@

    TakerPays

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:17

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • diff --git a/docs/interfaces/LedgerEntry.PayChannel.html b/docs/interfaces/LedgerEntry.PayChannel.html index 0a0cd0e085..82554f6190 100644 --- a/docs/interfaces/LedgerEntry.PayChannel.html +++ b/docs/interfaces/LedgerEntry.PayChannel.html @@ -38,7 +38,7 @@

    Hierarchy

    • PayChannel
    +
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:12
    • @@ -74,7 +74,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:18

    • Amount

    Amount: string
    @@ -85,7 +85,7 @@

    Amount

    +
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:32

    • Balance

    Balance: string
    @@ -96,7 +96,7 @@

    Balance

    +
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:39

    • Optional CancelAfter

    CancelAfter?: number
    @@ -107,7 +107,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:81

    • Destination

    Destination: string
    @@ -118,7 +118,7 @@

    Destination

    +
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:25

    • Optional DestinationNode

    DestinationNode?: string
    @@ -127,7 +127,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:96

    • Optional DestinationTag

    DestinationTag?: number
    @@ -136,7 +136,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:91

    • Optional Expiration

    Expiration?: number
    @@ -147,7 +147,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:74

    • Flags

    Flags: number
    @@ -156,12 +156,12 @@

    Flags

    +
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:67

    • LedgerEntryType

    LedgerEntryType: "PayChannel"
    +
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:13

    • OwnerNode

    OwnerNode: string
    @@ -170,7 +170,7 @@

    OwnerNode

    +
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:62

    • PreviousTxnID

    PreviousTxnID: string
    @@ -180,7 +180,7 @@

    PreviousTxnID

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:10

    • PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    @@ -190,7 +190,7 @@

    PreviousTxnLgrSeq

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:15

    • PublicKey

    PublicKey: string
    @@ -203,7 +203,7 @@

    PublicKey

    +
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:48

    • SettleDelay

    SettleDelay: number
    @@ -216,7 +216,7 @@

    SettleDelay

    +
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:57

    • Optional SourceTag

    SourceTag?: number
    @@ -225,13 +225,13 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:86

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • diff --git a/docs/interfaces/LedgerEntry.RippleState.html b/docs/interfaces/LedgerEntry.RippleState.html index 34edfc9dda..5a072aaec5 100644 --- a/docs/interfaces/LedgerEntry.RippleState.html +++ b/docs/interfaces/LedgerEntry.RippleState.html @@ -34,7 +34,7 @@

    Hierarchy

    • RippleState
    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:10
    • @@ -68,7 +68,7 @@

    Balance

    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:19

    • Flags

    Flags: number
    @@ -76,7 +76,7 @@

    Flags

    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:13

    • HighLimit

    HighLimit: IssuedCurrencyAmount
    @@ -85,7 +85,7 @@

    HighLimit

    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:29

    • Optional HighNode

    HighNode?: string
    @@ -94,7 +94,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:39

    • Optional HighQualityIn

    HighQualityIn?: number
    @@ -104,7 +104,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:57

    • Optional HighQualityOut

    HighQualityOut?: number
    @@ -114,12 +114,12 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:63

    • LedgerEntryType

    LedgerEntryType: "RippleState"
    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:11

    • LowLimit

    LowLimit: IssuedCurrencyAmount
    @@ -128,7 +128,7 @@

    LowLimit

    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:24

    • Optional LowNode

    LowNode?: string
    @@ -137,7 +137,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:34

    • Optional LowQualityIn

    LowQualityIn?: number
    @@ -147,7 +147,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:45

    • Optional LowQualityOut

    LowQualityOut?: number
    @@ -157,7 +157,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:51

    • PreviousTxnID

    PreviousTxnID: string
    @@ -167,7 +167,7 @@

    PreviousTxnID

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:10

    • PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    @@ -177,13 +177,13 @@

    PreviousTxnLgrSeq

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:15

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • diff --git a/docs/interfaces/LedgerEntry.SignerList.html b/docs/interfaces/LedgerEntry.SignerList.html index 3130e544f8..3e1ad9904c 100644 --- a/docs/interfaces/LedgerEntry.SignerList.html +++ b/docs/interfaces/LedgerEntry.SignerList.html @@ -37,7 +37,7 @@

    Hierarchy

    • SignerList
    +
  • Defined in packages/xrpl/src/models/ledger/SignerList.ts:13
    • @@ -65,12 +65,12 @@

    Flags

    +
  • Defined in packages/xrpl/src/models/ledger/SignerList.ts:19

    • LedgerEntryType

    LedgerEntryType: "SignerList"
    +
  • Defined in packages/xrpl/src/models/ledger/SignerList.ts:14

    • OwnerNode

    OwnerNode: string
    @@ -79,7 +79,7 @@

    OwnerNode

    +
  • Defined in packages/xrpl/src/models/ledger/SignerList.ts:24

    • PreviousTxnID

    PreviousTxnID: string
    @@ -89,7 +89,7 @@

    PreviousTxnID

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:10

    • PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    @@ -99,7 +99,7 @@

    PreviousTxnLgrSeq

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:15

    • SignerEntries

    SignerEntries: SignerEntry[]
    @@ -108,7 +108,7 @@

    SignerEntries

    +
  • Defined in packages/xrpl/src/models/ledger/SignerList.ts:29

    • SignerListID

    SignerListID: number
    @@ -117,7 +117,7 @@

    SignerListID

    +
  • Defined in packages/xrpl/src/models/ledger/SignerList.ts:34

    • SignerQuorum

    SignerQuorum: number
    @@ -127,13 +127,13 @@

    SignerQuorum

    +
  • Defined in packages/xrpl/src/models/ledger/SignerList.ts:40

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • diff --git a/docs/interfaces/LedgerEntry.Ticket.html b/docs/interfaces/LedgerEntry.Ticket.html index 956807b20a..25b629b914 100644 --- a/docs/interfaces/LedgerEntry.Ticket.html +++ b/docs/interfaces/LedgerEntry.Ticket.html @@ -36,7 +36,7 @@

    Hierarchy

    • Ticket
    +
  • Defined in packages/xrpl/src/models/ledger/Ticket.ts:10
    • @@ -62,7 +62,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/ledger/Ticket.ts:13

    • Flags

    Flags: number
    @@ -71,12 +71,12 @@

    Flags

    +
  • Defined in packages/xrpl/src/models/ledger/Ticket.ts:18

    • LedgerEntryType

    LedgerEntryType: "Ticket"
    +
  • Defined in packages/xrpl/src/models/ledger/Ticket.ts:11

    • OwnerNode

    OwnerNode: string
    @@ -85,7 +85,7 @@

    OwnerNode

    +
  • Defined in packages/xrpl/src/models/ledger/Ticket.ts:23

    • PreviousTxnID

    PreviousTxnID: string
    @@ -95,7 +95,7 @@

    PreviousTxnID

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:10

    • PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    @@ -105,7 +105,7 @@

    PreviousTxnLgrSeq

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:15

    • TicketSequence

    TicketSequence: number
    @@ -113,13 +113,13 @@

    TicketSequence

    +
  • Defined in packages/xrpl/src/models/ledger/Ticket.ts:25

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • diff --git a/docs/interfaces/LedgerEntry.VoteSlot.html b/docs/interfaces/LedgerEntry.VoteSlot.html index ad8b8a28d1..5fca7a062f 100644 --- a/docs/interfaces/LedgerEntry.VoteSlot.html +++ b/docs/interfaces/LedgerEntry.VoteSlot.html @@ -27,7 +27,7 @@

    Hierarchy

    • VoteSlot
    +
  • Defined in packages/xrpl/src/models/ledger/AMM.ts:5
    • @@ -52,7 +52,7 @@
    TradingFee
    VoteWeight: number
    +
  • Defined in packages/xrpl/src/models/ledger/AMM.ts:6
    • diff --git a/docs/interfaces/LedgerEntry.XChainOwnedClaimID.html b/docs/interfaces/LedgerEntry.XChainOwnedClaimID.html index 42dd567791..00b0e7b1e9 100644 --- a/docs/interfaces/LedgerEntry.XChainOwnedClaimID.html +++ b/docs/interfaces/LedgerEntry.XChainOwnedClaimID.html @@ -36,7 +36,7 @@

    Hierarchy

    • XChainOwnedClaimID
    +
  • Defined in packages/xrpl/src/models/ledger/XChainOwnedClaimID.ts:14
    • @@ -66,7 +66,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/ledger/XChainOwnedClaimID.ts:20

    • Flags

    Flags: 0
    @@ -75,12 +75,12 @@

    Flags

    +
  • Defined in packages/xrpl/src/models/ledger/XChainOwnedClaimID.ts:75

    • LedgerEntryType

    LedgerEntryType: "XChainOwnedClaimID"
    +
  • Defined in packages/xrpl/src/models/ledger/XChainOwnedClaimID.ts:17

    • OtherChainSource

    OtherChainSource: string
    @@ -93,7 +93,7 @@

    OtherChainSource

    +
  • Defined in packages/xrpl/src/models/ledger/XChainOwnedClaimID.ts:40

    • OwnerNode

    OwnerNode: string
    @@ -102,7 +102,7 @@

    OwnerNode

    +
  • Defined in packages/xrpl/src/models/ledger/XChainOwnedClaimID.ts:80

    • PreviousTxnID

    PreviousTxnID: string
    @@ -112,7 +112,7 @@

    PreviousTxnID

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:10

    • PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    @@ -122,7 +122,7 @@

    PreviousTxnLgrSeq

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:15

    • SignatureReward

    SignatureReward: string
    @@ -131,7 +131,7 @@

    SignatureReward

    +
  • Defined in packages/xrpl/src/models/ledger/XChainOwnedClaimID.ts:69

    • XChainBridge

    XChainBridge: XChainBridge
    @@ -139,7 +139,7 @@

    XChainBridge

    +
  • Defined in packages/xrpl/src/models/ledger/XChainOwnedClaimID.ts:25

    • XChainClaimAttestations

    XChainClaimAttestations: {
        XChainClaimProofSig: {
            Amount: Amount;
            AttestationRewardAccount: string;
            AttestationSignerAccount: string;
            Destination?: string;
            PublicKey: string;
            WasLockingChainSend: 0 | 1;
        };
    }[]
    @@ -168,7 +168,7 @@
    PublicKeyWasLockingChainSend: 0 | 1
    +
  • Defined in packages/xrpl/src/models/ledger/XChainOwnedClaimID.ts:48

    • XChainClaimID

    XChainClaimID: string
    @@ -176,13 +176,13 @@

    XChainClaimID

    +
  • Defined in packages/xrpl/src/models/ledger/XChainOwnedClaimID.ts:30

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • diff --git a/docs/interfaces/LedgerEntry.XChainOwnedCreateAccountClaimID.html b/docs/interfaces/LedgerEntry.XChainOwnedCreateAccountClaimID.html index fe80afc13a..e8d210b17c 100644 --- a/docs/interfaces/LedgerEntry.XChainOwnedCreateAccountClaimID.html +++ b/docs/interfaces/LedgerEntry.XChainOwnedCreateAccountClaimID.html @@ -35,7 +35,7 @@

    Hierarchy

    • XChainOwnedCreateAccountClaimID
    +
  • Defined in packages/xrpl/src/models/ledger/XChainOwnedCreateAccountClaimID.ts:11
    • @@ -63,7 +63,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/ledger/XChainOwnedCreateAccountClaimID.ts:17

    • Flags

    Flags: 0
    @@ -72,12 +72,12 @@

    Flags

    +
  • Defined in packages/xrpl/src/models/ledger/XChainOwnedCreateAccountClaimID.ts:59

    • LedgerEntryType

    LedgerEntryType: "XChainOwnedCreateAccountClaimID"
    +
  • Defined in packages/xrpl/src/models/ledger/XChainOwnedCreateAccountClaimID.ts:14

    • OwnerNode

    OwnerNode: string
    @@ -86,7 +86,7 @@

    OwnerNode

    +
  • Defined in packages/xrpl/src/models/ledger/XChainOwnedCreateAccountClaimID.ts:64

    • PreviousTxnID

    PreviousTxnID: string
    @@ -96,7 +96,7 @@

    PreviousTxnID

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:10

    • PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    @@ -106,7 +106,7 @@

    PreviousTxnLgrSeq

    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:15

    • XChainAccountCreateCount

    XChainAccountCreateCount: number
    @@ -116,7 +116,7 @@

    XChainAccountCreateCount

    +
  • Defined in packages/xrpl/src/models/ledger/XChainOwnedCreateAccountClaimID.ts:29

    • XChainBridge

    XChainBridge: XChainBridge
    @@ -124,7 +124,7 @@

    XChainBridge

    +
  • Defined in packages/xrpl/src/models/ledger/XChainOwnedCreateAccountClaimID.ts:22

    • XChainCreateAccountAttestations

    XChainCreateAccountAttestations: {
        XChainCreateAccountProofSig: {
            Amount: string;
            AttestationRewardAccount: string;
            AttestationSignerAccount: string;
            Destination: string;
            PublicKey: string;
            WasLockingChainSend: 0 | 1;
        };
    }[]
    @@ -154,13 +154,13 @@
    PublicKeyWasLockingChainSend: 0 | 1
    +
  • Defined in packages/xrpl/src/models/ledger/XChainOwnedCreateAccountClaimID.ts:38

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • diff --git a/docs/interfaces/LedgerEntryRequest.html b/docs/interfaces/LedgerEntryRequest.html index e01f431d51..742272c282 100644 --- a/docs/interfaces/LedgerEntryRequest.html +++ b/docs/interfaces/LedgerEntryRequest.html @@ -37,7 +37,7 @@

    Hierarchy

    • LedgerEntryRequest
    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:22
    • @@ -79,7 +79,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:58

    • Optional amm

    amm?: {
        asset: {
            currency: string;
            issuer?: string;
        };
        asset2: {
            currency: string;
            issuer?: string;
        };
    }
    @@ -105,7 +105,7 @@
    currencyOptional issuer?: string
    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:28

    • Optional api_version

    api_version?: number
    @@ -114,7 +114,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • Optional binary

    binary?: boolean
    @@ -124,17 +124,17 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:44

    • Optional bridge

    bridge?: XChainBridge
    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:165

    • Optional bridge_account

    bridge_account?: string
    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:163

    • Optional check

    check?: string
    @@ -142,7 +142,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:61

    • command

    command: "ledger_entry"
    @@ -151,7 +151,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:23

    • Optional deposit_preauth

    deposit_preauth?: string | {
        authorized: string;
        owner: string;
    }
    @@ -174,7 +174,7 @@
    owner
    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:68

    • Optional did

    did?: string
    @@ -183,7 +183,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:81

    • Optional directory

    directory?: string | {
        dir_root?: string;
        owner?: string;
        sub_index?: number;
    }
    @@ -211,7 +211,7 @@
    Optional
    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:88

    • Optional escrow

    escrow?: string | {
        owner: string;
        seq: number;
    }
    @@ -233,7 +233,7 @@
    seq
    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:103

    • Optional id

    id?: string | number
    @@ -244,12 +244,12 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional index

    index?: string
    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:52

    • Optional ledger_hash

    ledger_hash?: string
    @@ -258,7 +258,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:21

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -267,7 +267,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:23

    • Optional nft_page

    nft_page?: string
    @@ -275,7 +275,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:161

    • Optional offer

    offer?: string | {
        account: string;
        seq: number;
    }
    @@ -298,7 +298,7 @@
    seq
    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:117

    • Optional payment_channel

    payment_channel?: string
    @@ -306,7 +306,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:127

    • Optional ripple_state

    ripple_state?: {
        accounts: string[];
        currency: string;
    }
    @@ -330,7 +330,7 @@
    currency
    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:134

    • Optional ticket

    ticket?: string | {
        owner: string;
        ticket_sequence: number;
    }
    @@ -353,7 +353,7 @@
    ticket_sequence
    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:149

    • Optional xchain_owned_claim_id

    xchain_owned_claim_id?: string | {
        issuing_chain_door: string;
        issuing_chain_issue: Currency;
        locking_chain_door: string;
        locking_chain_issue: Currency;
        xchain_owned_claim_id: string | number;
    }
    @@ -371,7 +371,7 @@
    locking_chain_issue
    xchain_owned_claim_id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:167

    • Optional xchain_owned_create_account_claim_id

    xchain_owned_create_account_claim_id?: string | {
        issuing_chain_door: string;
        issuing_chain_issue: Currency;
        locking_chain_door: string;
        locking_chain_issue: Currency;
        xchain_owned_create_account_claim_id: string | number;
    }
    @@ -389,7 +389,7 @@
    locking_chain_issue
    xchain_owned_create_account_claim_id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:177
    • diff --git a/docs/interfaces/LedgerEntryResponse.html b/docs/interfaces/LedgerEntryResponse.html index 45cab2b0f7..8e1f31ea7b 100644 --- a/docs/interfaces/LedgerEntryResponse.html +++ b/docs/interfaces/LedgerEntryResponse.html @@ -37,7 +37,7 @@

    Hierarchy

    • LedgerEntryResponse
    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:193
    • @@ -61,19 +61,19 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • result

    result: {
        index: string;
        ledger_current_index: number;
        node?: T;
        node_binary?: string;
        validated?: boolean;
    }
    @@ -105,31 +105,31 @@
    Optional Optional validated?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:194

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/LedgerModifiedOfferCreateTransaction.html b/docs/interfaces/LedgerModifiedOfferCreateTransaction.html index 2f028e346e..4b1dd2c9c7 100644 --- a/docs/interfaces/LedgerModifiedOfferCreateTransaction.html +++ b/docs/interfaces/LedgerModifiedOfferCreateTransaction.html @@ -30,7 +30,7 @@

    Hierarchy

    • LedgerModifiedOfferCreateTransaction
    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:184
    • @@ -47,12 +47,12 @@

    Properties

    metadata

    metadata: Object
    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:186

    • transaction

    transaction: Transaction
    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:185
    • diff --git a/docs/interfaces/LedgerQueueData.html b/docs/interfaces/LedgerQueueData.html index 85b7ffd00e..60d70bfb91 100644 --- a/docs/interfaces/LedgerQueueData.html +++ b/docs/interfaces/LedgerQueueData.html @@ -26,7 +26,7 @@

    Hierarchy

    • LedgerQueueData
    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:189
    • @@ -50,42 +50,42 @@

    Properties

    account

    account: string
    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:190

    • Optional auth_change

    auth_change?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:198

    • Optional fee

    fee?: string
    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:199

    • Optional fee_level

    fee_level?: string
    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:200

    • Optional last_result

    last_result?: string
    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:197

    • Optional max_spend_drops

    max_spend_drops?: string
    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:201

    • preflight_result

    preflight_result: string
    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:196

    • retries_remaining

    retries_remaining: number
    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:195

    • tx

    tx: LedgerModifiedOfferCreateTransaction | TransactionAndMetadata<Transaction> | {
        tx_blob: string;
    }
    @@ -95,7 +95,7 @@

    Type declaration

  • tx_blob: string
    • +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:191
    • diff --git a/docs/interfaces/LedgerRequest.html b/docs/interfaces/LedgerRequest.html index 817d91a5cb..89fb78c940 100644 --- a/docs/interfaces/LedgerRequest.html +++ b/docs/interfaces/LedgerRequest.html @@ -37,7 +37,7 @@

    Hierarchy

    • LedgerRequest
    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:28
    • @@ -69,7 +69,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:39

    • Optional api_version

    api_version?: number
    @@ -78,7 +78,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • Optional binary

    binary?: boolean
    @@ -88,7 +88,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:63

    • command

    command: "ledger"
    @@ -97,7 +97,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:29

    • Optional expand

    expand?: boolean
    @@ -107,7 +107,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:51

    • Optional full

    full?: boolean
    @@ -116,7 +116,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:34

    • Optional id

    id?: string | number
    @@ -127,7 +127,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional ledger_hash

    ledger_hash?: string
    @@ -136,7 +136,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:21

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -145,7 +145,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:23

    • Optional owner_funds

    owner_funds?: boolean
    @@ -155,7 +155,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:57

    • Optional queue

    queue?: boolean
    @@ -164,7 +164,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:68

    • Optional transactions

    transactions?: boolean
    @@ -174,7 +174,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:45

    • Optional type

    type?: LedgerEntryFilter
    @@ -182,7 +182,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:72
    • diff --git a/docs/interfaces/LedgerResponse.html b/docs/interfaces/LedgerResponse.html index 895e7a4096..b80b2d678d 100644 --- a/docs/interfaces/LedgerResponse.html +++ b/docs/interfaces/LedgerResponse.html @@ -33,7 +33,7 @@

    Hierarchy

    • LedgerResponse
    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:240
    • @@ -57,49 +57,49 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • result

    result: LedgerResponseResult
    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:241

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/LedgerStream.html b/docs/interfaces/LedgerStream.html index 31aa60947e..6f199d38dd 100644 --- a/docs/interfaces/LedgerStream.html +++ b/docs/interfaces/LedgerStream.html @@ -34,7 +34,7 @@

    Hierarchy

    • LedgerStream
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:98
    • @@ -64,7 +64,7 @@

    fee_base

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:105

    • Optional fee_ref

    fee_ref?: number
    @@ -72,7 +72,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:107

    • ledger_hash

    ledger_hash: string
    @@ -80,7 +80,7 @@

    ledger_hash

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:109

    • ledger_index

    ledger_index: number
    @@ -88,7 +88,7 @@

    ledger_index

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:111

    • ledger_time

    ledger_time: number
    @@ -96,7 +96,7 @@

    ledger_time

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:113

    • reserve_base

    reserve_base: number
    @@ -106,7 +106,7 @@

    reserve_base

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:119

    • reserve_inc

    reserve_inc: number
    @@ -116,7 +116,7 @@

    reserve_inc

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:125

    • txn_count

    txn_count: number
    @@ -124,13 +124,13 @@

    txn_count

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:127

    • type

    type: "ledgerClosed"
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:99

    • Optional validated_ledgers

    validated_ledgers?: string
    @@ -141,7 +141,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:134
    • diff --git a/docs/interfaces/LedgerStreamResponse.html b/docs/interfaces/LedgerStreamResponse.html index 4cfe31295d..d9825633b3 100644 --- a/docs/interfaces/LedgerStreamResponse.html +++ b/docs/interfaces/LedgerStreamResponse.html @@ -30,7 +30,7 @@

    Hierarchy

    • LedgerStreamResponse
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:140
    • @@ -58,7 +58,7 @@

    fee_base

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:146

    • Optional fee_ref

    fee_ref?: number
    @@ -66,7 +66,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:148

    • ledger_hash

    ledger_hash: string
    @@ -74,7 +74,7 @@

    ledger_hash

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:150

    • ledger_index

    ledger_index: number
    @@ -82,7 +82,7 @@

    ledger_index

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:152

    • ledger_time

    ledger_time: number
    @@ -90,7 +90,7 @@

    ledger_time

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:154

    • reserve_base

    reserve_base: number
    @@ -100,7 +100,7 @@

    reserve_base

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:160

    • reserve_inc

    reserve_inc: number
    @@ -110,7 +110,7 @@

    reserve_inc

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:166

    • Optional validated_ledgers

    validated_ledgers?: string
    @@ -121,7 +121,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:173
    • diff --git a/docs/interfaces/ManifestRequest.html b/docs/interfaces/ManifestRequest.html index 94978e9f4c..2b6a04f73a 100644 --- a/docs/interfaces/ManifestRequest.html +++ b/docs/interfaces/ManifestRequest.html @@ -37,7 +37,7 @@

    Hierarchy

    • ManifestRequest
    +
  • Defined in packages/xrpl/src/models/methods/manifest.ts:19
    • @@ -60,7 +60,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "manifest"
    @@ -69,7 +69,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/manifest.ts:20

    • Optional id

    id?: string | number
    @@ -80,7 +80,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • public_key

    public_key: string
    @@ -89,7 +89,7 @@

    public_key

    +
  • Defined in packages/xrpl/src/models/methods/manifest.ts:25
    • diff --git a/docs/interfaces/ManifestResponse.html b/docs/interfaces/ManifestResponse.html index bebb0bba1a..c27965996e 100644 --- a/docs/interfaces/ManifestResponse.html +++ b/docs/interfaces/ManifestResponse.html @@ -32,7 +32,7 @@

    Hierarchy

    • ManifestResponse
    +
  • Defined in packages/xrpl/src/models/methods/manifest.ts:33
    • @@ -56,19 +56,19 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • result

    result: {
        details?: {
            domain: string;
            ephemeral_key: string;
            master_key: string;
            seq: number;
        };
        manifest?: string;
        requested: string;
    }
    @@ -104,31 +104,31 @@
    requested
    +
  • Defined in packages/xrpl/src/models/methods/manifest.ts:34

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/Memo.html b/docs/interfaces/Memo.html index 22be54fc7e..9178dc2712 100644 --- a/docs/interfaces/Memo.html +++ b/docs/interfaces/Memo.html @@ -26,7 +26,7 @@

    Hierarchy

    • Memo
    +
  • Defined in packages/xrpl/src/models/common/index.ts:35
    • @@ -51,7 +51,7 @@
    Optional
    Optional MemoType?: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:36
    • diff --git a/docs/interfaces/ModifiedNode.html b/docs/interfaces/ModifiedNode.html index 850815ab68..78b618a59a 100644 --- a/docs/interfaces/ModifiedNode.html +++ b/docs/interfaces/ModifiedNode.html @@ -26,7 +26,7 @@

    Hierarchy

    • ModifiedNode
    +
  • Defined in packages/xrpl/src/models/transactions/metadata.ts:28
    • @@ -63,7 +63,7 @@
    Optional
    Optional PreviousTxnLgrSeq?: number
    +
  • Defined in packages/xrpl/src/models/transactions/metadata.ts:29
    • diff --git a/docs/interfaces/NFTBuyOffersRequest.html b/docs/interfaces/NFTBuyOffersRequest.html index 3f8a375a35..a4ca294ff2 100644 --- a/docs/interfaces/NFTBuyOffersRequest.html +++ b/docs/interfaces/NFTBuyOffersRequest.html @@ -34,7 +34,7 @@

    Hierarchy

    • NFTBuyOffersRequest
    +
  • Defined in packages/xrpl/src/models/methods/nftBuyOffers.ts:11
    • @@ -59,7 +59,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "nft_buy_offers"
    @@ -68,7 +68,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/nftBuyOffers.ts:14

    • Optional id

    id?: string | number
    @@ -79,7 +79,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional ledger_hash

    ledger_hash?: string
    @@ -88,7 +88,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:21

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -97,7 +97,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:23

    • nft_id

    nft_id: string
    @@ -105,7 +105,7 @@

    nft_id

    +
  • Defined in packages/xrpl/src/models/methods/nftBuyOffers.ts:18
    • diff --git a/docs/interfaces/NFTBuyOffersResponse.html b/docs/interfaces/NFTBuyOffersResponse.html index cb74b42905..aa755a3122 100644 --- a/docs/interfaces/NFTBuyOffersResponse.html +++ b/docs/interfaces/NFTBuyOffersResponse.html @@ -32,7 +32,7 @@

    Hierarchy

    • NFTBuyOffersResponse
    +
  • Defined in packages/xrpl/src/models/methods/nftBuyOffers.ts:26
    • @@ -56,19 +56,19 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • result

    result: {
        nft_id: string;
        offers: NFTOffer[];
    }
    @@ -87,31 +87,31 @@
    offers
    +
  • Defined in packages/xrpl/src/models/methods/nftBuyOffers.ts:27

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/NFTHistoryRequest.html b/docs/interfaces/NFTHistoryRequest.html index 2cdce4ea20..2a3f3804a5 100644 --- a/docs/interfaces/NFTHistoryRequest.html +++ b/docs/interfaces/NFTHistoryRequest.html @@ -34,7 +34,7 @@

    Hierarchy

    • NFTHistoryRequest
    +
  • Defined in packages/xrpl/src/models/methods/nftHistory.ts:13
    • @@ -65,7 +65,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • Optional binary

    binary?: boolean
    @@ -74,7 +74,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/nftHistory.ts:35

    • command

    command: "nft_history"
    @@ -83,7 +83,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/nftHistory.ts:14

    • Optional forward

    forward?: boolean
    @@ -92,7 +92,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/nftHistory.ts:40

    • Optional id

    id?: string | number
    @@ -103,7 +103,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional ledger_hash

    ledger_hash?: string
    @@ -112,7 +112,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:21

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -121,7 +121,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:23

    • Optional ledger_index_max

    ledger_index_max?: number
    @@ -131,7 +131,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/nftHistory.ts:30

    • Optional ledger_index_min

    ledger_index_min?: number
    @@ -141,7 +141,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/nftHistory.ts:24

    • Optional limit

    limit?: number
    @@ -150,7 +150,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/nftHistory.ts:45

    • Optional marker

    marker?: unknown
    @@ -160,7 +160,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/nftHistory.ts:51

    • nft_id

    nft_id: string
    @@ -168,7 +168,7 @@

    nft_id

    +
  • Defined in packages/xrpl/src/models/methods/nftHistory.ts:18
    • diff --git a/docs/interfaces/NFTHistoryResponse.html b/docs/interfaces/NFTHistoryResponse.html index 8751219cee..9e9fb8e3c6 100644 --- a/docs/interfaces/NFTHistoryResponse.html +++ b/docs/interfaces/NFTHistoryResponse.html @@ -32,7 +32,7 @@

    Hierarchy

    • NFTHistoryResponse
    +
  • Defined in packages/xrpl/src/models/methods/nftHistory.ts:78
    • @@ -56,19 +56,19 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • result

    result: {
        ledger_index_max: number;
        ledger_index_min: number;
        limit?: number;
        marker?: unknown;
        nft_id: string;
        transactions: NFTHistoryTransaction[];
        validated?: boolean;
    }
    @@ -118,31 +118,31 @@
    Optional
    +
  • Defined in packages/xrpl/src/models/methods/nftHistory.ts:79

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/NFTHistoryTransaction.html b/docs/interfaces/NFTHistoryTransaction.html index 94068fc781..52b7bab047 100644 --- a/docs/interfaces/NFTHistoryTransaction.html +++ b/docs/interfaces/NFTHistoryTransaction.html @@ -26,7 +26,7 @@

    Hierarchy

    • NFTHistoryTransaction
    +
  • Defined in packages/xrpl/src/models/methods/nftHistory.ts:54
    • @@ -49,7 +49,7 @@

    ledger_index

    +
  • Defined in packages/xrpl/src/models/methods/nftHistory.ts:56

    • meta

    meta: string | TransactionMetadata
    @@ -58,7 +58,7 @@

    meta

    +
  • Defined in packages/xrpl/src/models/methods/nftHistory.ts:61

    • Optional tx

    tx?: Object
    @@ -66,7 +66,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/nftHistory.ts:63

    • Optional tx_blob

    tx_blob?: string
    @@ -74,7 +74,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/nftHistory.ts:65

    • validated

    validated: boolean
    @@ -83,7 +83,7 @@

    validated

    +
  • Defined in packages/xrpl/src/models/methods/nftHistory.ts:70
    • diff --git a/docs/interfaces/NFTInfoRequest.html b/docs/interfaces/NFTInfoRequest.html index 6186860b7a..5017ddf1e7 100644 --- a/docs/interfaces/NFTInfoRequest.html +++ b/docs/interfaces/NFTInfoRequest.html @@ -33,7 +33,7 @@

    Hierarchy

    • NFTInfoRequest
    +
  • Defined in packages/xrpl/src/models/methods/nftInfo.ts:10
    • @@ -58,7 +58,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "nft_info"
    @@ -67,7 +67,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/nftInfo.ts:11

    • Optional id

    id?: string | number
    @@ -78,7 +78,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional ledger_hash

    ledger_hash?: string
    @@ -87,7 +87,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:21

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -96,7 +96,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:23

    • nft_id

    nft_id: string
    @@ -104,7 +104,7 @@

    nft_id

    +
  • Defined in packages/xrpl/src/models/methods/nftInfo.ts:15
    • diff --git a/docs/interfaces/NFTInfoResponse.html b/docs/interfaces/NFTInfoResponse.html index 46d748d806..a8bbc6221c 100644 --- a/docs/interfaces/NFTInfoResponse.html +++ b/docs/interfaces/NFTInfoResponse.html @@ -32,7 +32,7 @@

    Hierarchy

    • NFTInfoResponse
    +
  • Defined in packages/xrpl/src/models/methods/nftInfo.ts:23
    • @@ -56,49 +56,49 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • result

    result: NFToken
    +
  • Defined in packages/xrpl/src/models/methods/nftInfo.ts:24

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/NFTOffer.html b/docs/interfaces/NFTOffer.html index 30abf418a7..8e30959f70 100644 --- a/docs/interfaces/NFTOffer.html +++ b/docs/interfaces/NFTOffer.html @@ -31,7 +31,7 @@

    Hierarchy

    • NFTOffer
    +
  • Defined in packages/xrpl/src/models/common/index.ts:119
    • @@ -52,32 +52,32 @@

    Properties

    amount

    amount: Amount
    +
  • Defined in packages/xrpl/src/models/common/index.ts:120

    • Optional destination

    destination?: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:124

    • Optional expiration

    expiration?: number
    +
  • Defined in packages/xrpl/src/models/common/index.ts:125

    • flags

    flags: number
    +
  • Defined in packages/xrpl/src/models/common/index.ts:121

    • nft_offer_index

    nft_offer_index: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:122

    • owner

    owner: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:123
    • diff --git a/docs/interfaces/NFTSellOffersRequest.html b/docs/interfaces/NFTSellOffersRequest.html index d118e569c7..4ef9eafb04 100644 --- a/docs/interfaces/NFTSellOffersRequest.html +++ b/docs/interfaces/NFTSellOffersRequest.html @@ -34,7 +34,7 @@

    Hierarchy

    • NFTSellOffersRequest
    +
  • Defined in packages/xrpl/src/models/methods/nftSellOffers.ts:11
    • @@ -59,7 +59,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "nft_sell_offers"
    @@ -68,7 +68,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/nftSellOffers.ts:14

    • Optional id

    id?: string | number
    @@ -79,7 +79,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional ledger_hash

    ledger_hash?: string
    @@ -88,7 +88,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:21

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -97,7 +97,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:23

    • nft_id

    nft_id: string
    @@ -105,7 +105,7 @@

    nft_id

    +
  • Defined in packages/xrpl/src/models/methods/nftSellOffers.ts:18
    • diff --git a/docs/interfaces/NFTSellOffersResponse.html b/docs/interfaces/NFTSellOffersResponse.html index b3c6757a13..efe0a6bb03 100644 --- a/docs/interfaces/NFTSellOffersResponse.html +++ b/docs/interfaces/NFTSellOffersResponse.html @@ -32,7 +32,7 @@

    Hierarchy

    • NFTSellOffersResponse
    +
  • Defined in packages/xrpl/src/models/methods/nftSellOffers.ts:26
    • @@ -56,19 +56,19 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • result

    result: {
        nft_id: string;
        offers: NFTOffer[];
    }
    @@ -87,31 +87,31 @@
    offers
    +
  • Defined in packages/xrpl/src/models/methods/nftSellOffers.ts:27

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/NFToken.html b/docs/interfaces/NFToken.html index 96377e8784..35aab1f3c6 100644 --- a/docs/interfaces/NFToken.html +++ b/docs/interfaces/NFToken.html @@ -30,7 +30,7 @@

    Hierarchy

    • NFToken
    +
  • Defined in packages/xrpl/src/models/common/index.ts:133
    • @@ -55,52 +55,52 @@

    Properties

    flags

    flags: number
    +
  • Defined in packages/xrpl/src/models/common/index.ts:138

    • is_burned

    is_burned: boolean
    +
  • Defined in packages/xrpl/src/models/common/index.ts:137

    • issuer

    issuer: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:140

    • ledger_index

    ledger_index: number
    +
  • Defined in packages/xrpl/src/models/common/index.ts:135

    • nft_id

    nft_id: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:134

    • nft_serial

    nft_serial: number
    +
  • Defined in packages/xrpl/src/models/common/index.ts:142

    • nft_taxon

    nft_taxon: number
    +
  • Defined in packages/xrpl/src/models/common/index.ts:141

    • owner

    owner: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:136

    • transfer_fee

    transfer_fee: number
    +
  • Defined in packages/xrpl/src/models/common/index.ts:139

    • uri

    uri: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:143
    • diff --git a/docs/interfaces/NFTokenAcceptOffer.html b/docs/interfaces/NFTokenAcceptOffer.html index 755e6feb56..8193352b2c 100644 --- a/docs/interfaces/NFTokenAcceptOffer.html +++ b/docs/interfaces/NFTokenAcceptOffer.html @@ -45,7 +45,7 @@

    Hierarchy

    • NFTokenAcceptOffer
    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenAcceptOffer.ts:27
    • @@ -81,7 +81,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -92,7 +92,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Optional Fee

    Fee?: string
    @@ -103,7 +103,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -112,7 +112,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -123,7 +123,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -132,7 +132,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NFTokenBrokerFee

    NFTokenBrokerFee?: Amount
    @@ -155,7 +155,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenAcceptOffer.ts:65

    • Optional NFTokenBuyOffer

    NFTokenBuyOffer?: string
    @@ -166,7 +166,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenAcceptOffer.ts:44

    • Optional NFTokenSellOffer

    NFTokenSellOffer?: string
    @@ -177,7 +177,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenAcceptOffer.ts:36

    • Optional NetworkID

    NetworkID?: number
    @@ -186,7 +186,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional Sequence

    Sequence?: number
    @@ -198,7 +198,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -208,7 +208,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -219,7 +219,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -231,7 +231,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -241,7 +241,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "NFTokenAcceptOffer"
    @@ -251,7 +251,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenAcceptOffer.ts:28

    • Optional TxnSignature

    TxnSignature?: string
    @@ -261,7 +261,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289
    • diff --git a/docs/interfaces/NFTokenBurn.html b/docs/interfaces/NFTokenBurn.html index aaeab32f7b..d07e0f720a 100644 --- a/docs/interfaces/NFTokenBurn.html +++ b/docs/interfaces/NFTokenBurn.html @@ -38,7 +38,7 @@

    Hierarchy

    • NFTokenBurn
    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenBurn.ts:21
    • @@ -76,7 +76,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenBurn.ts:29

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -87,7 +87,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Optional Fee

    Fee?: string
    @@ -98,7 +98,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -107,7 +107,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -118,7 +118,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -127,7 +127,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • NFTokenID

    NFTokenID: string
    @@ -135,7 +135,7 @@

    NFTokenID

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenBurn.ts:33

    • Optional NetworkID

    NetworkID?: number
    @@ -144,7 +144,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional Owner

    Owner?: string
    @@ -154,7 +154,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenBurn.ts:39

    • Optional Sequence

    Sequence?: number
    @@ -166,7 +166,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -176,7 +176,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -187,7 +187,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -199,7 +199,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -209,7 +209,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "NFTokenBurn"
    @@ -219,7 +219,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenBurn.ts:22

    • Optional TxnSignature

    TxnSignature?: string
    @@ -229,7 +229,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289
    • diff --git a/docs/interfaces/NFTokenCancelOffer.html b/docs/interfaces/NFTokenCancelOffer.html index dc1237fb92..833755c4b6 100644 --- a/docs/interfaces/NFTokenCancelOffer.html +++ b/docs/interfaces/NFTokenCancelOffer.html @@ -38,7 +38,7 @@

    Hierarchy

    • NFTokenCancelOffer
    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenCancelOffer.ts:16
    • @@ -72,7 +72,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -83,7 +83,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Optional Fee

    Fee?: string
    @@ -94,7 +94,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -103,7 +103,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -114,7 +114,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -123,7 +123,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • NFTokenOffers

    NFTokenOffers: string[]
    @@ -136,7 +136,7 @@

    NFTokenOffers

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenCancelOffer.ts:27

    • Optional NetworkID

    NetworkID?: number
    @@ -145,7 +145,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional Sequence

    Sequence?: number
    @@ -157,7 +157,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -167,7 +167,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -178,7 +178,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -190,7 +190,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -200,7 +200,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "NFTokenCancelOffer"
    @@ -210,7 +210,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenCancelOffer.ts:17

    • Optional TxnSignature

    TxnSignature?: string
    @@ -220,7 +220,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289
    • diff --git a/docs/interfaces/NFTokenCreateOffer.html b/docs/interfaces/NFTokenCreateOffer.html index 9605aed763..fbffd6fbaa 100644 --- a/docs/interfaces/NFTokenCreateOffer.html +++ b/docs/interfaces/NFTokenCreateOffer.html @@ -34,7 +34,7 @@

    Hierarchy

    • NFTokenCreateOffer
    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:45
    • @@ -72,7 +72,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -83,7 +83,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Amount

    Amount: Amount
    @@ -95,7 +95,7 @@

    Amount

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:60

    • Optional Destination

    Destination?: string
    @@ -105,7 +105,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:86

    • Optional Expiration

    Expiration?: number
    @@ -115,7 +115,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:80

    • Optional Fee

    Fee?: string
    @@ -126,7 +126,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | NFTokenCreateOfferFlagsInterface
    @@ -135,7 +135,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:87

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -146,7 +146,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -155,7 +155,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • NFTokenID

    NFTokenID: string
    @@ -164,7 +164,7 @@

    NFTokenID

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:51

    • Optional NetworkID

    NetworkID?: number
    @@ -173,7 +173,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional Owner

    Owner?: string
    @@ -189,7 +189,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:74

    • Optional Sequence

    Sequence?: number
    @@ -201,7 +201,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -211,7 +211,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -222,7 +222,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -234,7 +234,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -244,7 +244,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "NFTokenCreateOffer"
    @@ -254,7 +254,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:46

    • Optional TxnSignature

    TxnSignature?: string
    @@ -264,7 +264,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289
    • diff --git a/docs/interfaces/NFTokenCreateOfferFlagsInterface.html b/docs/interfaces/NFTokenCreateOfferFlagsInterface.html index 6f782e247c..6cc17af9a0 100644 --- a/docs/interfaces/NFTokenCreateOfferFlagsInterface.html +++ b/docs/interfaces/NFTokenCreateOfferFlagsInterface.html @@ -33,7 +33,7 @@

    Hierarchy

    • NFTokenCreateOfferFlagsInterface
    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:36
    • @@ -49,7 +49,7 @@

    Properties

    Optional tfSellNFToken

    tfSellNFToken?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:37
    • diff --git a/docs/interfaces/NFTokenMint.html b/docs/interfaces/NFTokenMint.html index 0d7fa22470..e12177c09e 100644 --- a/docs/interfaces/NFTokenMint.html +++ b/docs/interfaces/NFTokenMint.html @@ -35,7 +35,7 @@

    Hierarchy

    • NFTokenMint
    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:62
    • @@ -72,7 +72,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -83,7 +83,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Optional Fee

    Fee?: string
    @@ -94,7 +94,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | NFTokenMintFlagsInterface
    @@ -103,7 +103,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:102

    • Optional Issuer

    Issuer?: string
    @@ -115,7 +115,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:79

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -126,7 +126,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -135,7 +135,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • NFTokenTaxon

    NFTokenTaxon: number
    @@ -147,7 +147,7 @@

    NFTokenTaxon

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:71

    • Optional NetworkID

    NetworkID?: number
    @@ -156,7 +156,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional Sequence

    Sequence?: number
    @@ -168,7 +168,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -178,7 +178,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -189,7 +189,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -201,7 +201,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -211,7 +211,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "NFTokenMint"
    @@ -221,7 +221,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:63

    • Optional TransferFee

    TransferFee?: number
    @@ -233,7 +233,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:87

    • Optional TxnSignature

    TxnSignature?: string
    @@ -243,7 +243,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289

    • Optional URI

    URI?: null | string
    @@ -259,7 +259,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:101
    • diff --git a/docs/interfaces/NFTokenMintFlagsInterface.html b/docs/interfaces/NFTokenMintFlagsInterface.html index 0a487ff8c2..3f1aba3718 100644 --- a/docs/interfaces/NFTokenMintFlagsInterface.html +++ b/docs/interfaces/NFTokenMintFlagsInterface.html @@ -33,7 +33,7 @@

    Hierarchy

    • NFTokenMintFlagsInterface
    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:49
    • @@ -52,22 +52,22 @@

    Properties

    Optional tfBurnable

    tfBurnable?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:50

    • Optional tfOnlyXRP

    tfOnlyXRP?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:51

    • Optional tfTransferable

    tfTransferable?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:53

    • Optional tfTrustLine

    tfTrustLine?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:52
    • diff --git a/docs/interfaces/NoRippleCheckRequest.html b/docs/interfaces/NoRippleCheckRequest.html index 22cb697db8..2437e1ba4b 100644 --- a/docs/interfaces/NoRippleCheckRequest.html +++ b/docs/interfaces/NoRippleCheckRequest.html @@ -38,7 +38,7 @@

    Hierarchy

    • NoRippleCheckRequest
    +
  • Defined in packages/xrpl/src/models/methods/norippleCheck.ts:27
    • @@ -65,7 +65,7 @@

    account

    +
  • Defined in packages/xrpl/src/models/methods/norippleCheck.ts:30

    • Optional api_version

    api_version?: number
    @@ -74,7 +74,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "noripple_check"
    @@ -83,7 +83,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/norippleCheck.ts:28

    • Optional id

    id?: string | number
    @@ -94,7 +94,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional ledger_hash

    ledger_hash?: string
    @@ -102,7 +102,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/norippleCheck.ts:49

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -111,7 +111,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/norippleCheck.ts:54

    • Optional limit

    limit?: number
    @@ -120,7 +120,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/norippleCheck.ts:47

    • role

    role: "user" | "gateway"
    @@ -131,7 +131,7 @@

    role

    +
  • Defined in packages/xrpl/src/models/methods/norippleCheck.ts:37

    • Optional transactions

    transactions?: boolean
    @@ -140,7 +140,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/norippleCheck.ts:42
    • diff --git a/docs/interfaces/NoRippleCheckResponse.html b/docs/interfaces/NoRippleCheckResponse.html index c6c797e91b..c6a1ede8fd 100644 --- a/docs/interfaces/NoRippleCheckResponse.html +++ b/docs/interfaces/NoRippleCheckResponse.html @@ -32,7 +32,7 @@

    Hierarchy

    • NoRippleCheckResponse
    +
  • Defined in packages/xrpl/src/models/methods/norippleCheck.ts:62
    • @@ -56,19 +56,19 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • result

    result: {
        ledger_current_index: number;
        problems: string[];
        transactions: Object[];
    }
    @@ -99,31 +99,31 @@
    transactions
    +
  • Defined in packages/xrpl/src/models/methods/norippleCheck.ts:63

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/OfferCancel.html b/docs/interfaces/OfferCancel.html index 74a39d2bd2..a160b01946 100644 --- a/docs/interfaces/OfferCancel.html +++ b/docs/interfaces/OfferCancel.html @@ -32,7 +32,7 @@

    Hierarchy

    • OfferCancel
    +
  • Defined in packages/xrpl/src/models/transactions/offerCancel.ts:10
    • @@ -66,7 +66,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -77,7 +77,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Optional Fee

    Fee?: string
    @@ -88,7 +88,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -97,7 +97,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -108,7 +108,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -117,7 +117,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -126,7 +126,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • OfferSequence

    OfferSequence: number
    @@ -137,7 +137,7 @@

    OfferSequence

    +
  • Defined in packages/xrpl/src/models/transactions/offerCancel.ts:18

    • Optional Sequence

    Sequence?: number
    @@ -149,7 +149,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -159,7 +159,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -170,7 +170,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -182,7 +182,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -192,7 +192,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "OfferCancel"
    @@ -202,7 +202,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/offerCancel.ts:11

    • Optional TxnSignature

    TxnSignature?: string
    @@ -212,7 +212,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289
    • diff --git a/docs/interfaces/OfferCreate.html b/docs/interfaces/OfferCreate.html index 235549566f..9dc251e8fb 100644 --- a/docs/interfaces/OfferCreate.html +++ b/docs/interfaces/OfferCreate.html @@ -34,7 +34,7 @@

    Hierarchy

    • OfferCreate
    +
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:95
    • @@ -71,7 +71,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -82,7 +82,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Optional Expiration

    Expiration?: number
    @@ -91,7 +91,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:102

    • Optional Fee

    Fee?: string
    @@ -102,7 +102,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | OfferCreateFlagsInterface
    @@ -111,7 +111,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:97

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -122,7 +122,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -131,7 +131,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -140,7 +140,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional OfferSequence

    OfferSequence?: number
    @@ -148,7 +148,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:104

    • Optional Sequence

    Sequence?: number
    @@ -160,7 +160,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -170,7 +170,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -181,7 +181,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -193,7 +193,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • TakerGets

    TakerGets: Amount
    @@ -201,7 +201,7 @@

    TakerGets

    +
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:106

    • TakerPays

    TakerPays: Amount
    @@ -209,7 +209,7 @@

    TakerPays

    +
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:108

    • Optional TicketSequence

    TicketSequence?: number
    @@ -219,7 +219,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "OfferCreate"
    @@ -229,7 +229,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:96

    • Optional TxnSignature

    TxnSignature?: string
    @@ -239,7 +239,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289
    • diff --git a/docs/interfaces/OfferCreateFlagsInterface.html b/docs/interfaces/OfferCreateFlagsInterface.html index 464b79e058..eb2029aa2b 100644 --- a/docs/interfaces/OfferCreateFlagsInterface.html +++ b/docs/interfaces/OfferCreateFlagsInterface.html @@ -36,7 +36,7 @@

    Hierarchy

    • OfferCreateFlagsInterface
    +
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:81
    • @@ -55,22 +55,22 @@

    Properties

    Optional tfFillOrKill

    tfFillOrKill?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:84

    • Optional tfImmediateOrCancel

    tfImmediateOrCancel?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:83

    • Optional tfPassive

    tfPassive?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:82

    • Optional tfSell

    tfSell?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:85
    • diff --git a/docs/interfaces/OrderBookStream.html b/docs/interfaces/OrderBookStream.html index 46723c5182..92c1e38309 100644 --- a/docs/interfaces/OrderBookStream.html +++ b/docs/interfaces/OrderBookStream.html @@ -35,7 +35,7 @@

    Hierarchy

    • OrderBookStream
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:347
    • @@ -61,58 +61,58 @@

    Properties

    engine_result

    engine_result: string
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:350

    • engine_result_code

    engine_result_code: number
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:351

    • engine_result_message

    engine_result_message: string
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:352

    • Optional ledger_current_index

    ledger_current_index?: number
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:353

    • Optional ledger_hash

    ledger_hash?: string
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:354

    • Optional ledger_index

    ledger_index?: number
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:355

    • meta

    meta: TransactionMetadata
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:356

    • status

    status: string
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:348

    • transaction

    transaction: Object
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:357

    • type

    type: "transaction"
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:349

    • validated

    validated: boolean
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:368
    • diff --git a/docs/interfaces/PathFindCloseRequest.html b/docs/interfaces/PathFindCloseRequest.html index 567254ab21..6e1d8b0a79 100644 --- a/docs/interfaces/PathFindCloseRequest.html +++ b/docs/interfaces/PathFindCloseRequest.html @@ -32,7 +32,7 @@

    Hierarchy

    • PathFindCloseRequest
    +
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:36
    • @@ -55,13 +55,13 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "path_find"
    +
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:6

    • Optional id

    id?: string | number
    @@ -72,13 +72,13 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • subcommand

    subcommand: "close"
    +
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:37
    • diff --git a/docs/interfaces/PathFindCreateRequest.html b/docs/interfaces/PathFindCreateRequest.html index 30ebf47835..3d00c619cf 100644 --- a/docs/interfaces/PathFindCreateRequest.html +++ b/docs/interfaces/PathFindCreateRequest.html @@ -32,7 +32,7 @@

    Hierarchy

    • PathFindCreateRequest
    +
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:11
    • @@ -60,13 +60,13 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "path_find"
    +
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:6

    • destination_account

    destination_account: string
    @@ -74,7 +74,7 @@

    destination_account

    +
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:19

    • destination_amount

    destination_amount: Amount
    @@ -83,7 +83,7 @@

    destination_amount

    +
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:24

    • Optional id

    id?: string | number
    @@ -94,7 +94,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional paths

    paths?: Path[]
    @@ -104,7 +104,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:32

    • Optional send_max

    send_max?: Amount
    @@ -112,7 +112,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:26

    • source_account

    source_account: string
    @@ -121,13 +121,13 @@

    source_account

    +
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:17

    • subcommand

    subcommand: "create"
    +
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:12
    • diff --git a/docs/interfaces/PathFindPathOption.html b/docs/interfaces/PathFindPathOption.html index 7a250f985f..6e845c7c74 100644 --- a/docs/interfaces/PathFindPathOption.html +++ b/docs/interfaces/PathFindPathOption.html @@ -26,7 +26,7 @@

    Hierarchy

    • PathFindPathOption
    +
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:58
    • @@ -48,7 +48,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:70

    • paths_computed

    paths_computed: Path[]
    @@ -56,7 +56,7 @@

    paths_computed

    +
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:60

    • source_amount

    source_amount: Amount
    @@ -65,7 +65,7 @@

    source_amount

    +
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:65
    • diff --git a/docs/interfaces/PathFindResponse.html b/docs/interfaces/PathFindResponse.html index 8584ec8b9b..fa64ecf681 100644 --- a/docs/interfaces/PathFindResponse.html +++ b/docs/interfaces/PathFindResponse.html @@ -32,7 +32,7 @@

    Hierarchy

    • PathFindResponse
    +
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:78
    • @@ -56,19 +56,19 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • result

    result: {
        alternatives: PathFindPathOption[];
        closed?: true;
        destination_account: string;
        destination_amount: Amount;
        full_reply: boolean;
        id?: string | number;
        source_account: string;
        status?: true;
    }
    @@ -126,31 +126,31 @@
    Optional
    +
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:79

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/PathFindStatusRequest.html b/docs/interfaces/PathFindStatusRequest.html index 7bd26491fa..70cea66792 100644 --- a/docs/interfaces/PathFindStatusRequest.html +++ b/docs/interfaces/PathFindStatusRequest.html @@ -32,7 +32,7 @@

    Hierarchy

    • PathFindStatusRequest
    +
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:41
    • @@ -55,13 +55,13 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "path_find"
    +
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:6

    • Optional id

    id?: string | number
    @@ -72,13 +72,13 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • subcommand

    subcommand: "status"
    +
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:42
    • diff --git a/docs/interfaces/PathFindStream.html b/docs/interfaces/PathFindStream.html index 885d9ce71e..0ecb574169 100644 --- a/docs/interfaces/PathFindStream.html +++ b/docs/interfaces/PathFindStream.html @@ -34,7 +34,7 @@

    Hierarchy

    • PathFindStream
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:394
    • @@ -68,7 +68,7 @@
    paths_computedsource_amount: Amount
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:418

    • destination_account

    destination_account: string
    @@ -76,7 +76,7 @@

    destination_account

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:399

    • destination_amount

    destination_amount: Amount
    @@ -84,7 +84,7 @@

    destination_amount

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:401

    • full_reply

    full_reply: boolean
    @@ -96,7 +96,7 @@

    full_reply

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:409

    • id

    id: string | number
    @@ -104,7 +104,7 @@

    id

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:411

    • Optional send_max

    send_max?: Amount
    @@ -112,7 +112,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:413

    • source_account

    source_account: string
    @@ -120,13 +120,13 @@

    source_account

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:397

    • type

    type: "path_find"
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:395
    • diff --git a/docs/interfaces/PathStep.html b/docs/interfaces/PathStep.html index e8de531b70..7111ca6755 100644 --- a/docs/interfaces/PathStep.html +++ b/docs/interfaces/PathStep.html @@ -26,7 +26,7 @@

    Hierarchy

    • PathStep
    +
  • Defined in packages/xrpl/src/models/common/index.ts:53
    • @@ -44,17 +44,17 @@

    Properties

    Optional account

    account?: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:54

    • Optional currency

    currency?: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:55

    • Optional issuer

    issuer?: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:56
    • diff --git a/docs/interfaces/Payment.html b/docs/interfaces/Payment.html index a09a87b362..7fc56fa113 100644 --- a/docs/interfaces/Payment.html +++ b/docs/interfaces/Payment.html @@ -33,7 +33,7 @@

    Hierarchy

    • Payment
    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:112
    • @@ -73,7 +73,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -84,7 +84,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Amount

    Amount: Amount
    @@ -94,7 +94,7 @@

    Amount

    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:119

    • Optional DeliverMin

    DeliverMin?: Amount
    @@ -104,7 +104,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:151

    • Destination

    Destination: string
    @@ -112,7 +112,7 @@

    Destination

    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:121

    • Optional DestinationTag

    DestinationTag?: number
    @@ -121,7 +121,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:126

    • Optional Fee

    Fee?: string
    @@ -132,7 +132,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | PaymentFlagsInterface
    @@ -141,7 +141,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:152

    • Optional InvoiceID

    InvoiceID?: string
    @@ -150,7 +150,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:131

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -161,7 +161,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -170,7 +170,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -179,7 +179,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional Paths

    Paths?: Path[]
    @@ -188,7 +188,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:136

    • Optional SendMax

    SendMax?: Amount
    @@ -201,7 +201,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:145

    • Optional Sequence

    Sequence?: number
    @@ -213,7 +213,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -223,7 +223,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -234,7 +234,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -246,7 +246,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -256,7 +256,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "Payment"
    @@ -266,7 +266,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:113

    • Optional TxnSignature

    TxnSignature?: string
    @@ -276,7 +276,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289
    • diff --git a/docs/interfaces/PaymentChannelClaim.html b/docs/interfaces/PaymentChannelClaim.html index 18efdb723b..077020201e 100644 --- a/docs/interfaces/PaymentChannelClaim.html +++ b/docs/interfaces/PaymentChannelClaim.html @@ -33,7 +33,7 @@

    Hierarchy

    • PaymentChannelClaim
    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:99
    • @@ -71,7 +71,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -82,7 +82,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Optional Amount

    Amount?: string
    @@ -92,7 +92,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:116

    • Optional Balance

    Balance?: string
    @@ -103,7 +103,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:110

    • Channel

    Channel: string
    @@ -111,7 +111,7 @@

    Channel

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:103

    • Optional Fee

    Fee?: string
    @@ -122,7 +122,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | PaymentChannelClaimFlagsInterface
    @@ -131,7 +131,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:101

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -142,7 +142,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -151,7 +151,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -160,7 +160,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional PublicKey

    PublicKey?: string
    @@ -171,7 +171,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:129

    • Optional Sequence

    Sequence?: number
    @@ -183,7 +183,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signature

    Signature?: string
    @@ -193,7 +193,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:122

    • Optional Signers

    Signers?: Signer[]
    @@ -203,7 +203,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -214,7 +214,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -226,7 +226,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -236,7 +236,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "PaymentChannelClaim"
    @@ -246,7 +246,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:100

    • Optional TxnSignature

    TxnSignature?: string
    @@ -256,7 +256,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289
    • diff --git a/docs/interfaces/PaymentChannelClaimFlagsInterface.html b/docs/interfaces/PaymentChannelClaimFlagsInterface.html index ada67d25cd..4263b85003 100644 --- a/docs/interfaces/PaymentChannelClaimFlagsInterface.html +++ b/docs/interfaces/PaymentChannelClaimFlagsInterface.html @@ -36,7 +36,7 @@

    Hierarchy

    • PaymentChannelClaimFlagsInterface
    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:70
    • @@ -66,7 +66,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:90

    • Optional tfRenew

    tfRenew?: boolean
    @@ -76,7 +76,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:76
    • diff --git a/docs/interfaces/PaymentChannelCreate.html b/docs/interfaces/PaymentChannelCreate.html index 105c1d0870..9c2c2176d8 100644 --- a/docs/interfaces/PaymentChannelCreate.html +++ b/docs/interfaces/PaymentChannelCreate.html @@ -33,7 +33,7 @@

    Hierarchy

    • PaymentChannelCreate
    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelCreate.ts:19
    • @@ -72,7 +72,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -83,7 +83,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Amount

    Amount: string
    @@ -94,7 +94,7 @@

    Amount

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelCreate.ts:27

    • Optional CancelAfter

    CancelAfter?: number
    @@ -106,7 +106,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelCreate.ts:51

    • Destination

    Destination: string
    @@ -115,7 +115,7 @@

    Destination

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelCreate.ts:32

    • Optional DestinationTag

    DestinationTag?: number
    @@ -124,7 +124,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelCreate.ts:56

    • Optional Fee

    Fee?: string
    @@ -135,7 +135,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -144,7 +144,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -155,7 +155,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -164,7 +164,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -173,7 +173,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • PublicKey

    PublicKey: string
    @@ -183,7 +183,7 @@

    PublicKey

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelCreate.ts:43

    • Optional Sequence

    Sequence?: number
    @@ -195,7 +195,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • SettleDelay

    SettleDelay: number
    @@ -204,7 +204,7 @@

    SettleDelay

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelCreate.ts:37

    • Optional Signers

    Signers?: Signer[]
    @@ -214,7 +214,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -225,7 +225,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -237,7 +237,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -247,7 +247,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "PaymentChannelCreate"
    @@ -257,7 +257,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelCreate.ts:20

    • Optional TxnSignature

    TxnSignature?: string
    @@ -267,7 +267,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289
    • diff --git a/docs/interfaces/PaymentChannelFund.html b/docs/interfaces/PaymentChannelFund.html index bc200e823e..b88dd2cc67 100644 --- a/docs/interfaces/PaymentChannelFund.html +++ b/docs/interfaces/PaymentChannelFund.html @@ -34,7 +34,7 @@

    Hierarchy

    • PaymentChannelFund
    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelFund.ts:12
    • @@ -70,7 +70,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -81,7 +81,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Amount

    Amount: string
    @@ -90,7 +90,7 @@

    Amount

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelFund.ts:23

    • Channel

    Channel: string
    @@ -99,7 +99,7 @@

    Channel

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelFund.ts:18

    • Optional Expiration

    Expiration?: number
    @@ -114,7 +114,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelFund.ts:34

    • Optional Fee

    Fee?: string
    @@ -125,7 +125,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -134,7 +134,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -145,7 +145,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -154,7 +154,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -163,7 +163,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional Sequence

    Sequence?: number
    @@ -175,7 +175,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -185,7 +185,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -196,7 +196,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -208,7 +208,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -218,7 +218,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "PaymentChannelFund"
    @@ -228,7 +228,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelFund.ts:13

    • Optional TxnSignature

    TxnSignature?: string
    @@ -238,7 +238,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289
    • diff --git a/docs/interfaces/PaymentFlagsInterface.html b/docs/interfaces/PaymentFlagsInterface.html index 50d5b99cae..db63bd0104 100644 --- a/docs/interfaces/PaymentFlagsInterface.html +++ b/docs/interfaces/PaymentFlagsInterface.html @@ -36,7 +36,7 @@

    Hierarchy

    • PaymentFlagsInterface
    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:85
    • @@ -59,7 +59,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:103

    • Optional tfNoDirectRipple

    tfNoDirectRipple?: boolean
    @@ -69,7 +69,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:91

    • Optional tfPartialPayment

    tfPartialPayment?: boolean
    @@ -79,7 +79,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:97
    • diff --git a/docs/interfaces/PeerStatusStream.html b/docs/interfaces/PeerStatusStream.html index 8ca0ec976c..d9febd6610 100644 --- a/docs/interfaces/PeerStatusStream.html +++ b/docs/interfaces/PeerStatusStream.html @@ -34,7 +34,7 @@

    Hierarchy

    • PeerStatusStream
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:306
    • @@ -60,7 +60,7 @@

    action

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:312

    • date

    date: number
    @@ -68,7 +68,7 @@

    date

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:314

    • Optional ledger_hash

    ledger_hash?: string
    @@ -76,7 +76,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:316

    • Optional ledger_index

    ledger_index?: number
    @@ -84,7 +84,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:318

    • Optional ledger_index_max

    ledger_index_max?: number
    @@ -92,7 +92,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:320

    • Optional ledger_index_min

    ledger_index_min?: number
    @@ -100,13 +100,13 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:322

    • type

    type: "peerStatusChange"
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:307
    • diff --git a/docs/interfaces/PingRequest.html b/docs/interfaces/PingRequest.html index 2b3c228fcf..cbf615d71e 100644 --- a/docs/interfaces/PingRequest.html +++ b/docs/interfaces/PingRequest.html @@ -33,7 +33,7 @@

    Hierarchy

    • PingRequest
    +
  • Defined in packages/xrpl/src/models/methods/ping.ts:10
    • @@ -55,7 +55,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "ping"
    @@ -64,7 +64,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/ping.ts:11

    • Optional id

    id?: string | number
    @@ -75,7 +75,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12
    • diff --git a/docs/interfaces/PingResponse.html b/docs/interfaces/PingResponse.html index 2d25e9576a..fafc2bb068 100644 --- a/docs/interfaces/PingResponse.html +++ b/docs/interfaces/PingResponse.html @@ -32,7 +32,7 @@

    Hierarchy

    • PingResponse
    +
  • Defined in packages/xrpl/src/models/methods/ping.ts:19
    • @@ -56,19 +56,19 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • result

    result: {
        role?: string;
        unlimited?: boolean;
    }
    @@ -81,31 +81,31 @@
    Optional Optional unlimited?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/ping.ts:20

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/RandomRequest.html b/docs/interfaces/RandomRequest.html index f28e3f5f3c..e62c25c373 100644 --- a/docs/interfaces/RandomRequest.html +++ b/docs/interfaces/RandomRequest.html @@ -34,7 +34,7 @@

    Hierarchy

    • RandomRequest
    +
  • Defined in packages/xrpl/src/models/methods/random.ts:10
    • @@ -56,7 +56,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "random"
    @@ -65,7 +65,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/random.ts:11

    • Optional id

    id?: string | number
    @@ -76,7 +76,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12
    • diff --git a/docs/interfaces/RandomResponse.html b/docs/interfaces/RandomResponse.html index 185c2630e2..4fade95d98 100644 --- a/docs/interfaces/RandomResponse.html +++ b/docs/interfaces/RandomResponse.html @@ -32,7 +32,7 @@

    Hierarchy

    • RandomResponse
    +
  • Defined in packages/xrpl/src/models/methods/random.ts:19
    • @@ -56,19 +56,19 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • result

    result: {
        random: string;
    }
    @@ -79,31 +79,31 @@

    Type declaration

    random: string
    +
  • Defined in packages/xrpl/src/models/methods/random.ts:20

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/ResponseOnlyTxInfo.html b/docs/interfaces/ResponseOnlyTxInfo.html index 514c10e42f..4b19a42a37 100644 --- a/docs/interfaces/ResponseOnlyTxInfo.html +++ b/docs/interfaces/ResponseOnlyTxInfo.html @@ -32,7 +32,7 @@

    Hierarchy

    • ResponseOnlyTxInfo
    +
  • Defined in packages/xrpl/src/models/common/index.ts:94
    • @@ -54,7 +54,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/common/index.ts:98

    • Optional hash

    hash?: string
    @@ -62,7 +62,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/common/index.ts:102

    • Optional inLedger

    inLedger?: number
    @@ -70,7 +70,7 @@

    OptionalDeprecated

    Alias for ledger_index.

    +
  • Defined in packages/xrpl/src/models/common/index.ts:110

    • Optional ledger_index

    ledger_index?: number
    @@ -78,7 +78,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/common/index.ts:106
    • diff --git a/docs/interfaces/ResponseWarning.html b/docs/interfaces/ResponseWarning.html index 9128b2f52e..ae70726ad9 100644 --- a/docs/interfaces/ResponseWarning.html +++ b/docs/interfaces/ResponseWarning.html @@ -26,7 +26,7 @@

    Hierarchy

    • ResponseWarning
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:26
    • @@ -49,17 +49,17 @@

    Type declaration

  • [key: string]: string
    • +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:29

    • id

    id: number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:27

    • message

    message: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:28
    • diff --git a/docs/interfaces/RipplePathFindPathOption.html b/docs/interfaces/RipplePathFindPathOption.html index b8db5fa7dd..07e1ecb5ad 100644 --- a/docs/interfaces/RipplePathFindPathOption.html +++ b/docs/interfaces/RipplePathFindPathOption.html @@ -26,7 +26,7 @@

    Hierarchy

    • RipplePathFindPathOption
    +
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:43
    • @@ -46,7 +46,7 @@

    paths_computed

    +
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:45

    • source_amount

    source_amount: Amount
    @@ -55,7 +55,7 @@

    source_amount

    +
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:50
    • diff --git a/docs/interfaces/RipplePathFindRequest.html b/docs/interfaces/RipplePathFindRequest.html index 39a53ab683..6e3677d28b 100644 --- a/docs/interfaces/RipplePathFindRequest.html +++ b/docs/interfaces/RipplePathFindRequest.html @@ -35,7 +35,7 @@

    Hierarchy

    • RipplePathFindRequest
    +
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:17
    • @@ -64,7 +64,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "ripple_path_find"
    @@ -73,7 +73,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:20

    • destination_account

    destination_account: string
    @@ -81,7 +81,7 @@

    destination_account

    +
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:24

    • destination_amount

    destination_amount: Amount
    @@ -90,7 +90,7 @@

    destination_amount

    +
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:29

    • Optional id

    id?: string | number
    @@ -101,7 +101,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional ledger_hash

    ledger_hash?: string
    @@ -110,7 +110,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:21

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -119,7 +119,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:23

    • Optional send_max

    send_max?: Amount
    @@ -128,7 +128,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:34

    • source_account

    source_account: string
    @@ -136,7 +136,7 @@

    source_account

    +
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:22

    • Optional source_currencies

    source_currencies?: SourceCurrencyAmount[]
    @@ -146,7 +146,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:40
    • diff --git a/docs/interfaces/RipplePathFindResponse.html b/docs/interfaces/RipplePathFindResponse.html index 953d4a807d..759cb92a6e 100644 --- a/docs/interfaces/RipplePathFindResponse.html +++ b/docs/interfaces/RipplePathFindResponse.html @@ -32,7 +32,7 @@

    Hierarchy

    • RipplePathFindResponse
    +
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:58
    • @@ -56,19 +56,19 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • result

    result: {
        alternatives: RipplePathFindPathOption[];
        destination_account: string;
        destination_amount: Amount;
        destination_currencies: string[];
        full_reply?: boolean;
        id?: string | number;
        ledger_current_index?: number;
        source_account: string;
        validated: boolean;
    }
    @@ -108,31 +108,31 @@
    source_accountvalidated: boolean
    +
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:59

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/ServerDefinitionsRequest.html b/docs/interfaces/ServerDefinitionsRequest.html index cff9b79450..134f016097 100644 --- a/docs/interfaces/ServerDefinitionsRequest.html +++ b/docs/interfaces/ServerDefinitionsRequest.html @@ -34,7 +34,7 @@

    Hierarchy

    • ServerDefinitionsRequest
    +
  • Defined in packages/xrpl/src/models/methods/serverDefinitions.ts:10
    • @@ -57,7 +57,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "server_definitions"
    @@ -66,7 +66,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/serverDefinitions.ts:11

    • Optional hash

    hash?: string
    @@ -74,7 +74,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/serverDefinitions.ts:15

    • Optional id

    id?: string | number
    @@ -85,7 +85,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12
    • diff --git a/docs/interfaces/ServerDefinitionsResponse.html b/docs/interfaces/ServerDefinitionsResponse.html index 6c64fbb562..1fff77f4b1 100644 --- a/docs/interfaces/ServerDefinitionsResponse.html +++ b/docs/interfaces/ServerDefinitionsResponse.html @@ -32,7 +32,7 @@

    Hierarchy

    • ServerDefinitionsResponse
    +
  • Defined in packages/xrpl/src/models/methods/serverDefinitions.ts:23
    • @@ -56,49 +56,49 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • result

    result: Object
    +
  • Defined in packages/xrpl/src/models/methods/serverDefinitions.ts:24

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/ServerInfoRequest.html b/docs/interfaces/ServerInfoRequest.html index 803dcb058d..a4009452f0 100644 --- a/docs/interfaces/ServerInfoRequest.html +++ b/docs/interfaces/ServerInfoRequest.html @@ -34,7 +34,7 @@

    Hierarchy

    • ServerInfoRequest
    +
  • Defined in packages/xrpl/src/models/methods/serverInfo.ts:10
    • @@ -56,7 +56,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "server_info"
    @@ -65,7 +65,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/serverInfo.ts:11

    • Optional id

    id?: string | number
    @@ -76,7 +76,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12
    • diff --git a/docs/interfaces/ServerInfoResponse.html b/docs/interfaces/ServerInfoResponse.html index 345d918d4c..62e478209d 100644 --- a/docs/interfaces/ServerInfoResponse.html +++ b/docs/interfaces/ServerInfoResponse.html @@ -32,7 +32,7 @@

    Hierarchy

    • ServerInfoResponse
    +
  • Defined in packages/xrpl/src/models/methods/serverInfo.ts:65
    • @@ -56,19 +56,19 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • 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_id?: number;
            network_ledger?: "waiting";
            peer_disconnects?: string;
            peer_disconnects_resources?: string;
            peers: number;
            ports: ServerPort[];
            pubkey_node: string;
            pubkey_validator?: string;
            server_state: ServerState;
            server_state_duration_us: string;
            state_accounting: StateAccountingFinal;
            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?: {
                count: number;
                expiration: string;
                status: "active" | "expired" | "unknown";
            };
            validator_list_expires?: string;
        };
    }
    @@ -360,31 +360,31 @@
    Optional
    +
  • Defined in packages/xrpl/src/models/methods/serverInfo.ts:66

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/ServerStateRequest.html b/docs/interfaces/ServerStateRequest.html index a6c1be324a..38778c30d0 100644 --- a/docs/interfaces/ServerStateRequest.html +++ b/docs/interfaces/ServerStateRequest.html @@ -35,7 +35,7 @@

    Hierarchy

    • ServerStateRequest
    +
  • Defined in packages/xrpl/src/models/methods/serverState.ts:12
    • @@ -57,7 +57,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "server_state"
    @@ -66,7 +66,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/serverState.ts:13

    • Optional id

    id?: string | number
    @@ -77,7 +77,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12
    • diff --git a/docs/interfaces/ServerStateResponse.html b/docs/interfaces/ServerStateResponse.html index 12ad3a6af9..38c0d538f7 100644 --- a/docs/interfaces/ServerStateResponse.html +++ b/docs/interfaces/ServerStateResponse.html @@ -32,7 +32,7 @@

    Hierarchy

    • ServerStateResponse
    +
  • Defined in packages/xrpl/src/models/methods/serverState.ts:21
    • @@ -56,19 +56,19 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • 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: 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;
            peer_disconnects?: string;
            peer_disconnects_resources?: string;
            peers: number;
            pubkey_node: string;
            pubkey_validator?: string;
            server_state: ServerState;
            server_state_duration_us: string;
            state_accounting: StateAccountingFinal;
            time: string;
            uptime: number;
            validated_ledger?: {
                age?: number;
                base_fee: number;
                close_time: number;
                hash: string;
                reserve_base: number;
                reserve_inc: number;
                seq: number;
            };
            validation_quorum: number;
            validator_list_expires?: number;
        };
    }
    @@ -172,31 +172,31 @@
    validation_quorumOptional validator_list_expires?: number
    +
  • Defined in packages/xrpl/src/models/methods/serverState.ts:22

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/SetFeePostAmendment.html b/docs/interfaces/SetFeePostAmendment.html index f067bd54be..df9b3e765b 100644 --- a/docs/interfaces/SetFeePostAmendment.html +++ b/docs/interfaces/SetFeePostAmendment.html @@ -32,7 +32,7 @@

    Hierarchy

    • SetFeePostAmendment
    +
  • Defined in packages/xrpl/src/models/transactions/setFee.ts:22
    • @@ -68,7 +68,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -79,7 +79,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • BaseFeeDrops

    BaseFeeDrops: string
    @@ -87,7 +87,7 @@

    BaseFeeDrops

    +
  • Defined in packages/xrpl/src/models/transactions/setFee.ts:26

    • Optional Fee

    Fee?: string
    @@ -98,7 +98,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -107,7 +107,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -118,7 +118,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -127,7 +127,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -136,7 +136,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • ReserveBaseDrops

    ReserveBaseDrops: string
    @@ -144,7 +144,7 @@

    ReserveBaseDrops

    +
  • Defined in packages/xrpl/src/models/transactions/setFee.ts:30

    • ReserveIncrementDrops

    ReserveIncrementDrops: string
    @@ -152,7 +152,7 @@

    ReserveIncrementDrops

    +
  • Defined in packages/xrpl/src/models/transactions/setFee.ts:34

    • Optional Sequence

    Sequence?: number
    @@ -164,7 +164,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -174,7 +174,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -185,7 +185,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -197,7 +197,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -207,7 +207,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: string
    @@ -217,7 +217,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:230

    • Optional TxnSignature

    TxnSignature?: string
    @@ -227,7 +227,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289
    • diff --git a/docs/interfaces/SetFeePreAmendment.html b/docs/interfaces/SetFeePreAmendment.html index 9aeade71ec..10c40e4f92 100644 --- a/docs/interfaces/SetFeePreAmendment.html +++ b/docs/interfaces/SetFeePreAmendment.html @@ -32,7 +32,7 @@

    Hierarchy

    • SetFeePreAmendment
    +
  • Defined in packages/xrpl/src/models/transactions/setFee.ts:3
    • @@ -69,7 +69,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -80,7 +80,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • BaseFee

    BaseFee: string
    @@ -88,7 +88,7 @@

    BaseFee

    +
  • Defined in packages/xrpl/src/models/transactions/setFee.ts:7

    • Optional Fee

    Fee?: string
    @@ -99,7 +99,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -108,7 +108,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -119,7 +119,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -128,7 +128,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -137,7 +137,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • ReferenceFeeUnits

    ReferenceFeeUnits: number
    @@ -145,7 +145,7 @@

    ReferenceFeeUnits

    +
  • Defined in packages/xrpl/src/models/transactions/setFee.ts:11

    • ReserveBase

    ReserveBase: number
    @@ -153,7 +153,7 @@

    ReserveBase

    +
  • Defined in packages/xrpl/src/models/transactions/setFee.ts:15

    • ReserveIncrement

    ReserveIncrement: number
    @@ -161,7 +161,7 @@

    ReserveIncrement

    +
  • Defined in packages/xrpl/src/models/transactions/setFee.ts:19

    • Optional Sequence

    Sequence?: number
    @@ -173,7 +173,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -183,7 +183,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -194,7 +194,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -206,7 +206,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -216,7 +216,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: string
    @@ -226,7 +226,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:230

    • Optional TxnSignature

    TxnSignature?: string
    @@ -236,7 +236,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289
    • diff --git a/docs/interfaces/SetRegularKey.html b/docs/interfaces/SetRegularKey.html index b4b63e7974..87afefe32d 100644 --- a/docs/interfaces/SetRegularKey.html +++ b/docs/interfaces/SetRegularKey.html @@ -33,7 +33,7 @@

    Hierarchy

    • SetRegularKey
    +
  • Defined in packages/xrpl/src/models/transactions/setRegularKey.ts:11
    • @@ -67,7 +67,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -78,7 +78,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Optional Fee

    Fee?: string
    @@ -89,7 +89,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -98,7 +98,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -109,7 +109,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -118,7 +118,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -127,7 +127,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional RegularKey

    RegularKey?: string
    @@ -137,7 +137,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/setRegularKey.ts:18

    • Optional Sequence

    Sequence?: number
    @@ -149,7 +149,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -159,7 +159,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -170,7 +170,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -182,7 +182,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -192,7 +192,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "SetRegularKey"
    @@ -202,7 +202,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/setRegularKey.ts:12

    • Optional TxnSignature

    TxnSignature?: string
    @@ -212,7 +212,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289
    • diff --git a/docs/interfaces/Signer.html b/docs/interfaces/Signer.html index 78c53b8c13..7abc93bf3e 100644 --- a/docs/interfaces/Signer.html +++ b/docs/interfaces/Signer.html @@ -26,7 +26,7 @@

    Hierarchy

    • Signer
    +
  • Defined in packages/xrpl/src/models/common/index.ts:27
    • @@ -51,7 +51,7 @@
    SigningPubKey
    TxnSignature: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:28
    • diff --git a/docs/interfaces/SignerEntry.html b/docs/interfaces/SignerEntry.html index 62325fd02b..3d30a9e7a6 100644 --- a/docs/interfaces/SignerEntry.html +++ b/docs/interfaces/SignerEntry.html @@ -30,7 +30,7 @@

    Hierarchy

    • SignerEntry
    +
  • Defined in packages/xrpl/src/models/common/index.ts:64
    • @@ -72,7 +72,7 @@
    Optional
    +
  • Defined in packages/xrpl/src/models/common/index.ts:68
    • diff --git a/docs/interfaces/SignerListSet.html b/docs/interfaces/SignerListSet.html index 29bf895d33..2879b7fd6d 100644 --- a/docs/interfaces/SignerListSet.html +++ b/docs/interfaces/SignerListSet.html @@ -33,7 +33,7 @@

    Hierarchy

    • SignerListSet
    +
  • Defined in packages/xrpl/src/models/transactions/signerListSet.ts:12
    • @@ -68,7 +68,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -79,7 +79,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Optional Fee

    Fee?: string
    @@ -90,7 +90,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -99,7 +99,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -110,7 +110,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -119,7 +119,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -128,7 +128,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional Sequence

    Sequence?: number
    @@ -140,7 +140,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional SignerEntries

    SignerEntries?: SignerEntry[]
    @@ -151,7 +151,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/signerListSet.ts:26

    • SignerQuorum

    SignerQuorum: number
    @@ -161,7 +161,7 @@

    SignerQuorum

    +
  • Defined in packages/xrpl/src/models/transactions/signerListSet.ts:19

    • Optional Signers

    Signers?: Signer[]
    @@ -171,7 +171,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -182,7 +182,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -194,7 +194,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -204,7 +204,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "SignerListSet"
    @@ -214,7 +214,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/signerListSet.ts:13

    • Optional TxnSignature

    TxnSignature?: string
    @@ -224,7 +224,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289
    • diff --git a/docs/interfaces/SourceCurrencyAmount.html b/docs/interfaces/SourceCurrencyAmount.html index e30a7226d5..5e30aad2e4 100644 --- a/docs/interfaces/SourceCurrencyAmount.html +++ b/docs/interfaces/SourceCurrencyAmount.html @@ -26,7 +26,7 @@

    Hierarchy

    • SourceCurrencyAmount
    +
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:5
    • @@ -43,12 +43,12 @@

    Properties

    currency

    currency: string
    +
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:6

    • Optional issuer

    issuer?: string
    +
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:7
    • diff --git a/docs/interfaces/StateAccounting.html b/docs/interfaces/StateAccounting.html index 7e98ceba15..4a247e387d 100644 --- a/docs/interfaces/StateAccounting.html +++ b/docs/interfaces/StateAccounting.html @@ -26,7 +26,7 @@

    Hierarchy

    • StateAccounting
    +
  • Defined in packages/xrpl/src/models/methods/serverInfo.ts:23
    • @@ -43,12 +43,12 @@

    Properties

    duration_us

    duration_us: string
    +
  • Defined in packages/xrpl/src/models/methods/serverInfo.ts:24

    • transitions

    transitions: string
    +
  • Defined in packages/xrpl/src/models/methods/serverInfo.ts:25
    • diff --git a/docs/interfaces/SubmitMultisignedRequest.html b/docs/interfaces/SubmitMultisignedRequest.html index cd5f2e3df3..2f62c99a2a 100644 --- a/docs/interfaces/SubmitMultisignedRequest.html +++ b/docs/interfaces/SubmitMultisignedRequest.html @@ -34,7 +34,7 @@

    Hierarchy

    • SubmitMultisignedRequest
    +
  • Defined in packages/xrpl/src/models/methods/submitMultisigned.ts:12
    • @@ -58,7 +58,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "submit_multisigned"
    @@ -67,7 +67,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/submitMultisigned.ts:13

    • Optional fail_hard

    fail_hard?: boolean
    @@ -76,7 +76,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/submitMultisigned.ts:24

    • Optional id

    id?: string | number
    @@ -87,7 +87,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • tx_json

    tx_json: Transaction
    @@ -97,7 +97,7 @@

    tx_json

    +
  • Defined in packages/xrpl/src/models/methods/submitMultisigned.ts:19
    • diff --git a/docs/interfaces/SubmitMultisignedResponse.html b/docs/interfaces/SubmitMultisignedResponse.html index 09be8f39a1..d8a4ac099f 100644 --- a/docs/interfaces/SubmitMultisignedResponse.html +++ b/docs/interfaces/SubmitMultisignedResponse.html @@ -32,7 +32,7 @@

    Hierarchy

    • SubmitMultisignedResponse
    +
  • Defined in packages/xrpl/src/models/methods/submitMultisigned.ts:32
    • @@ -56,19 +56,19 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • result

    result: {
        engine_result: string;
        engine_result_code: number;
        engine_result_message: string;
        tx_blob: string;
        tx_json: Object;
    }
    @@ -104,31 +104,31 @@
    tx_json
    +
  • Defined in packages/xrpl/src/models/methods/submitMultisigned.ts:33

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/SubmitRequest.html b/docs/interfaces/SubmitRequest.html index a8da18fc27..5028ed1722 100644 --- a/docs/interfaces/SubmitRequest.html +++ b/docs/interfaces/SubmitRequest.html @@ -34,7 +34,7 @@

    Hierarchy

    • SubmitRequest
    +
  • Defined in packages/xrpl/src/models/methods/submit.ts:12
    • @@ -58,7 +58,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "submit"
    @@ -67,7 +67,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/submit.ts:13

    • Optional fail_hard

    fail_hard?: boolean
    @@ -76,7 +76,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/submit.ts:20

    • Optional id

    id?: string | number
    @@ -87,7 +87,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • tx_blob

    tx_blob: string
    @@ -95,7 +95,7 @@

    tx_blob

    +
  • Defined in packages/xrpl/src/models/methods/submit.ts:15
    • diff --git a/docs/interfaces/SubmitResponse.html b/docs/interfaces/SubmitResponse.html index 176dc84f72..0bcda76037 100644 --- a/docs/interfaces/SubmitResponse.html +++ b/docs/interfaces/SubmitResponse.html @@ -32,7 +32,7 @@

    Hierarchy

    • SubmitResponse
    +
  • Defined in packages/xrpl/src/models/methods/submit.ts:28
    • @@ -56,19 +56,19 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • 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: Object;
        validated_ledger_index: number;
    }
    @@ -162,31 +162,31 @@
    validated_ledger_index
    +
  • Defined in packages/xrpl/src/models/methods/submit.ts:29

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/SubscribeBook.html b/docs/interfaces/SubscribeBook.html index 7a58993225..7e801558bc 100644 --- a/docs/interfaces/SubscribeBook.html +++ b/docs/interfaces/SubscribeBook.html @@ -26,7 +26,7 @@

    Hierarchy

    • SubscribeBook
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:15
    • @@ -49,7 +49,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:37

    • Optional snapshot

    snapshot?: boolean
    @@ -58,7 +58,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:35

    • taker

    taker: string
    @@ -67,7 +67,7 @@

    taker

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:30

    • taker_gets

    taker_gets: Currency
    @@ -76,7 +76,7 @@

    taker_gets

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:20

    • taker_pays

    taker_pays: Currency
    @@ -85,7 +85,7 @@

    taker_pays

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:25
    • diff --git a/docs/interfaces/SubscribeRequest.html b/docs/interfaces/SubscribeRequest.html index ceff5c3b22..f5666b77dc 100644 --- a/docs/interfaces/SubscribeRequest.html +++ b/docs/interfaces/SubscribeRequest.html @@ -34,7 +34,7 @@

    Hierarchy

    • SubscribeRequest
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:47
    • @@ -65,7 +65,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:57

    • Optional accounts_proposed

    accounts_proposed?: string[]
    @@ -73,7 +73,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:59

    • Optional api_version

    api_version?: number
    @@ -82,7 +82,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • Optional books

    books?: SubscribeBook[]
    @@ -91,7 +91,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:64

    • command

    command: "subscribe"
    @@ -100,7 +100,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:48

    • Optional id

    id?: string | number
    @@ -111,7 +111,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional streams

    streams?: StreamType[]
    @@ -119,7 +119,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:50

    • Optional url

    url?: string
    @@ -128,7 +128,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:69

    • Optional url_password

    url_password?: string
    @@ -136,7 +136,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:73

    • Optional url_username

    url_username?: string
    @@ -144,7 +144,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:71
    • diff --git a/docs/interfaces/SubscribeResponse.html b/docs/interfaces/SubscribeResponse.html index 17af2b71d3..ea525e45e1 100644 --- a/docs/interfaces/SubscribeResponse.html +++ b/docs/interfaces/SubscribeResponse.html @@ -32,7 +32,7 @@

    Hierarchy

    • SubscribeResponse
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:83
    • @@ -56,49 +56,49 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • result

    result: Record<string, never> | LedgerStreamResponse | BooksSnapshot
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:84

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/TicketCreate.html b/docs/interfaces/TicketCreate.html index 25a888f74f..bea84ddf1e 100644 --- a/docs/interfaces/TicketCreate.html +++ b/docs/interfaces/TicketCreate.html @@ -33,7 +33,7 @@

    Hierarchy

    • TicketCreate
    +
  • Defined in packages/xrpl/src/models/transactions/ticketCreate.ts:11
    • @@ -67,7 +67,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -78,7 +78,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Optional Fee

    Fee?: string
    @@ -89,7 +89,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -98,7 +98,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -109,7 +109,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -118,7 +118,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -127,7 +127,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional Sequence

    Sequence?: number
    @@ -139,7 +139,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -149,7 +149,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -160,7 +160,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -172,7 +172,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • TicketCount

    TicketCount: number
    @@ -182,7 +182,7 @@

    TicketCount

    +
  • Defined in packages/xrpl/src/models/transactions/ticketCreate.ts:18

    • Optional TicketSequence

    TicketSequence?: number
    @@ -192,7 +192,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "TicketCreate"
    @@ -202,7 +202,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/ticketCreate.ts:12

    • Optional TxnSignature

    TxnSignature?: string
    @@ -212,7 +212,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289
    • diff --git a/docs/interfaces/TransactionAndMetadata.html b/docs/interfaces/TransactionAndMetadata.html index 8fca93be81..ddb1baf945 100644 --- a/docs/interfaces/TransactionAndMetadata.html +++ b/docs/interfaces/TransactionAndMetadata.html @@ -31,7 +31,7 @@

    Hierarchy

    • TransactionAndMetadata
    +
  • Defined in packages/xrpl/src/models/transactions/transaction.ts:157
    • @@ -48,12 +48,12 @@

    Properties

    metadata

    metadata: TransactionMetadata<T>
    +
  • Defined in packages/xrpl/src/models/transactions/transaction.ts:161

    • transaction

    transaction: T
    +
  • Defined in packages/xrpl/src/models/transactions/transaction.ts:160
    • diff --git a/docs/interfaces/TransactionEntryRequest.html b/docs/interfaces/TransactionEntryRequest.html index 660d492d91..64c5fee9fb 100644 --- a/docs/interfaces/TransactionEntryRequest.html +++ b/docs/interfaces/TransactionEntryRequest.html @@ -35,7 +35,7 @@

    Hierarchy

    • TransactionEntryRequest
    +
  • Defined in packages/xrpl/src/models/methods/transactionEntry.ts:13
    • @@ -60,7 +60,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "transaction_entry"
    @@ -69,7 +69,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/transactionEntry.ts:16

    • Optional id

    id?: string | number
    @@ -80,7 +80,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional ledger_hash

    ledger_hash?: string
    @@ -89,7 +89,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:21

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -98,7 +98,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:23

    • tx_hash

    tx_hash: string
    @@ -106,7 +106,7 @@

    tx_hash

    +
  • Defined in packages/xrpl/src/models/methods/transactionEntry.ts:19
    • diff --git a/docs/interfaces/TransactionEntryResponse.html b/docs/interfaces/TransactionEntryResponse.html index 10066deee9..54d50b9d80 100644 --- a/docs/interfaces/TransactionEntryResponse.html +++ b/docs/interfaces/TransactionEntryResponse.html @@ -32,7 +32,7 @@

    Hierarchy

    • TransactionEntryResponse
    +
  • Defined in packages/xrpl/src/models/methods/transactionEntry.ts:27
    • @@ -56,19 +56,19 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • result

    result: {
        ledger_hash: string;
        ledger_index: number;
        metadata: TransactionMetadata;
        tx_json: Object;
    }
    @@ -100,31 +100,31 @@
    tx_json
    +
  • Defined in packages/xrpl/src/models/methods/transactionEntry.ts:28

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/TransactionMetadataBase.html b/docs/interfaces/TransactionMetadataBase.html index 034f27edf5..a257eeb278 100644 --- a/docs/interfaces/TransactionMetadataBase.html +++ b/docs/interfaces/TransactionMetadataBase.html @@ -26,7 +26,7 @@

    Hierarchy

    • TransactionMetadataBase
    +
  • Defined in packages/xrpl/src/models/transactions/metadata.ts:79
    • @@ -46,27 +46,27 @@

    Properties

    AffectedNodes

    AffectedNodes: Node[]
    +
  • Defined in packages/xrpl/src/models/transactions/metadata.ts:80

    • Optional DeliveredAmount

    DeliveredAmount?: Amount
    +
  • Defined in packages/xrpl/src/models/transactions/metadata.ts:81

    • TransactionIndex

    TransactionIndex: number
    +
  • Defined in packages/xrpl/src/models/transactions/metadata.ts:84

    • TransactionResult

    TransactionResult: string
    +
  • Defined in packages/xrpl/src/models/transactions/metadata.ts:85

    • Optional delivered_amount

    delivered_amount?: Amount
    +
  • Defined in packages/xrpl/src/models/transactions/metadata.ts:83
    • diff --git a/docs/interfaces/TransactionStream.html b/docs/interfaces/TransactionStream.html index 8add5799e9..88043b8a17 100644 --- a/docs/interfaces/TransactionStream.html +++ b/docs/interfaces/TransactionStream.html @@ -32,7 +32,7 @@

    Hierarchy

    • TransactionStream
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:265
    • @@ -62,7 +62,7 @@

    engine_result

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:269

    • engine_result_code

    engine_result_code: number
    @@ -70,7 +70,7 @@

    engine_result_code

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:271

    • engine_result_message

    engine_result_message: string
    @@ -78,7 +78,7 @@

    engine_result_message

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:273

    • Optional ledger_current_index

    ledger_current_index?: number
    @@ -87,7 +87,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:278

    • Optional ledger_hash

    ledger_hash?: string
    @@ -95,7 +95,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:280

    • Optional ledger_index

    ledger_index?: number
    @@ -103,7 +103,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:282

    • Optional meta

    meta?: TransactionMetadata
    @@ -112,12 +112,12 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:287

    • status

    status: string
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:266

    • transaction

    transaction: Object
    @@ -125,13 +125,13 @@

    transaction

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:289

    • type

    type: "transaction"
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:267

    • Optional validated

    validated?: boolean
    @@ -141,7 +141,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:295

    • Optional warnings

    warnings?: {
        id: number;
        message: string;
    }[]
    @@ -153,7 +153,7 @@
    id
  • message: string
    • +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:296
    • diff --git a/docs/interfaces/TrustSet.html b/docs/interfaces/TrustSet.html index bc62c63cf8..a02e7fb2fe 100644 --- a/docs/interfaces/TrustSet.html +++ b/docs/interfaces/TrustSet.html @@ -32,7 +32,7 @@

    Hierarchy

    • TrustSet
    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:99
    • @@ -68,7 +68,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -79,7 +79,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Optional Fee

    Fee?: string
    @@ -90,7 +90,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | TrustSetFlagsInterface
    @@ -99,7 +99,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:118

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -110,7 +110,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • LimitAmount

    LimitAmount: IssuedCurrencyAmount
    @@ -119,7 +119,7 @@

    LimitAmount

    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:105

    • Optional Memos

    Memos?: Memo[]
    @@ -128,7 +128,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -137,7 +137,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional QualityIn

    QualityIn?: number
    @@ -147,7 +147,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:111

    • Optional QualityOut

    QualityOut?: number
    @@ -157,7 +157,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:117

    • Optional Sequence

    Sequence?: number
    @@ -169,7 +169,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -179,7 +179,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -190,7 +190,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -202,7 +202,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -212,7 +212,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "TrustSet"
    @@ -222,7 +222,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:100

    • Optional TxnSignature

    TxnSignature?: string
    @@ -232,7 +232,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289
    • diff --git a/docs/interfaces/TrustSetFlagsInterface.html b/docs/interfaces/TrustSetFlagsInterface.html index f1cb0f6e24..c2a3b1f18c 100644 --- a/docs/interfaces/TrustSetFlagsInterface.html +++ b/docs/interfaces/TrustSetFlagsInterface.html @@ -36,7 +36,7 @@

    Hierarchy

    • TrustSetFlagsInterface
    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:75
    • @@ -59,7 +59,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:91

    • Optional tfClearNoRipple

    tfClearNoRipple?: boolean
    @@ -67,7 +67,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:87

    • Optional tfSetFreeze

    tfSetFreeze?: boolean
    @@ -75,7 +75,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:89

    • Optional tfSetNoRipple

    tfSetNoRipple?: boolean
    @@ -84,7 +84,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:85

    • Optional tfSetfAuth

    tfSetfAuth?: boolean
    @@ -93,7 +93,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:80
    • diff --git a/docs/interfaces/TxRequest.html b/docs/interfaces/TxRequest.html index ec693c20a6..c914206e65 100644 --- a/docs/interfaces/TxRequest.html +++ b/docs/interfaces/TxRequest.html @@ -33,7 +33,7 @@

    Hierarchy

    • TxRequest
    +
  • Defined in packages/xrpl/src/models/methods/tx.ts:12
    • @@ -60,7 +60,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • Optional binary

    binary?: boolean
    @@ -70,7 +70,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/tx.ts:27

    • command

    command: "tx"
    @@ -79,7 +79,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/tx.ts:13

    • Optional ctid

    ctid?: string
    @@ -87,7 +87,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/tx.ts:21

    • Optional id

    id?: string | number
    @@ -98,7 +98,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional max_ledger

    max_ledger?: number
    @@ -109,7 +109,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/tx.ts:41

    • Optional min_ledger

    min_ledger?: number
    @@ -120,7 +120,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/tx.ts:34

    • Optional transaction

    transaction?: string
    @@ -128,7 +128,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/tx.ts:17
    • diff --git a/docs/interfaces/TxResponse.html b/docs/interfaces/TxResponse.html index 8efbd4aaef..c6b3d57d03 100644 --- a/docs/interfaces/TxResponse.html +++ b/docs/interfaces/TxResponse.html @@ -37,7 +37,7 @@

    Hierarchy

    • TxResponse
    +
  • Defined in packages/xrpl/src/models/methods/tx.ts:49
    • @@ -62,19 +62,19 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • result

    result: {
        ctid?: string;
        date?: number;
        hash: string;
        ledger_index?: number;
        meta?: string | TransactionMetadata<T>;
        validated?: boolean;
    } & T
    @@ -115,7 +115,7 @@
    Optional
    +
  • Defined in packages/xrpl/src/models/methods/tx.ts:51

    • Optional searched_all

    searched_all?: boolean
    @@ -126,31 +126,31 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/tx.ts:79

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/UNLModify.html b/docs/interfaces/UNLModify.html index f6affc146c..8e4a2e40ed 100644 --- a/docs/interfaces/UNLModify.html +++ b/docs/interfaces/UNLModify.html @@ -32,7 +32,7 @@

    Hierarchy

    • UNLModify
    +
  • Defined in packages/xrpl/src/models/transactions/UNLModify.ts:8
    • @@ -68,7 +68,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -79,7 +79,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Optional Fee

    Fee?: string
    @@ -90,7 +90,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -99,7 +99,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -110,7 +110,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • LedgerSequence

    LedgerSequence: number
    @@ -119,7 +119,7 @@

    LedgerSequence

    +
  • Defined in packages/xrpl/src/models/transactions/UNLModify.ts:14

    • Optional Memos

    Memos?: Memo[]
    @@ -128,7 +128,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -137,7 +137,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional Sequence

    Sequence?: number
    @@ -149,7 +149,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -159,7 +159,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -170,7 +170,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -182,7 +182,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -192,7 +192,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "UNLModify"
    @@ -202,7 +202,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/UNLModify.ts:9

    • Optional TxnSignature

    TxnSignature?: string
    @@ -212,7 +212,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289

    • UNLModifyDisabling

    UNLModifyDisabling: 0 | 1
    @@ -221,7 +221,7 @@

    UNLModifyDisabling

    +
  • Defined in packages/xrpl/src/models/transactions/UNLModify.ts:19

    • UNLModifyValidator

    UNLModifyValidator: string
    @@ -229,7 +229,7 @@

    UNLModifyValidator

    +
  • Defined in packages/xrpl/src/models/transactions/UNLModify.ts:21
    • diff --git a/docs/interfaces/UnsubscribeBook.html b/docs/interfaces/UnsubscribeBook.html index ac9cdd9c10..8222551580 100644 --- a/docs/interfaces/UnsubscribeBook.html +++ b/docs/interfaces/UnsubscribeBook.html @@ -26,7 +26,7 @@

    Hierarchy

    • UnsubscribeBook
    +
  • Defined in packages/xrpl/src/models/methods/unsubscribe.ts:5
    • @@ -44,17 +44,17 @@

    Properties

    Optional both

    both?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/unsubscribe.ts:8

    • taker_gets

    taker_gets: Currency
    +
  • Defined in packages/xrpl/src/models/methods/unsubscribe.ts:6

    • taker_pays

    taker_pays: Currency
    +
  • Defined in packages/xrpl/src/models/methods/unsubscribe.ts:7
    • diff --git a/docs/interfaces/UnsubscribeRequest.html b/docs/interfaces/UnsubscribeRequest.html index 7547d92aee..b600033f97 100644 --- a/docs/interfaces/UnsubscribeRequest.html +++ b/docs/interfaces/UnsubscribeRequest.html @@ -34,7 +34,7 @@

    Hierarchy

    • UnsubscribeRequest
    +
  • Defined in packages/xrpl/src/models/methods/unsubscribe.ts:18
    • @@ -60,7 +60,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/unsubscribe.ts:29

    • Optional accounts_proposed

    accounts_proposed?: string[]
    @@ -69,7 +69,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/unsubscribe.ts:34

    • Optional api_version

    api_version?: number
    @@ -78,7 +78,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • Optional books

    books?: UnsubscribeBook[]
    @@ -87,7 +87,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/unsubscribe.ts:39

    • command

    command: "unsubscribe"
    @@ -96,7 +96,7 @@

    command

    +
  • Defined in packages/xrpl/src/models/methods/unsubscribe.ts:19

    • Optional id

    id?: string | number
    @@ -107,7 +107,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional streams

    streams?: StreamType[]
    @@ -116,7 +116,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/unsubscribe.ts:24
    • diff --git a/docs/interfaces/UnsubscribeResponse.html b/docs/interfaces/UnsubscribeResponse.html index 395cdfeff0..1f3cd54c73 100644 --- a/docs/interfaces/UnsubscribeResponse.html +++ b/docs/interfaces/UnsubscribeResponse.html @@ -32,7 +32,7 @@

    Hierarchy

    • UnsubscribeResponse
    +
  • Defined in packages/xrpl/src/models/methods/unsubscribe.ts:47
    • @@ -56,49 +56,49 @@

    Optionalapi_version?: number

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:40

    • Optional forwarded

    forwarded?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:39

    • id

    id: string | number
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:33

    • result

    result: Record<string, never>
    +
  • Defined in packages/xrpl/src/models/methods/unsubscribe.ts:48

    • Optional status

    status?: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:34

    • type

    type: string
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:35

    • Optional warning

    warning?: "load"
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:37

    • Optional warnings

    warnings?: ResponseWarning[]
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:38
    • diff --git a/docs/interfaces/ValidationStream.html b/docs/interfaces/ValidationStream.html index 24f540e86c..6e10fc26ac 100644 --- a/docs/interfaces/ValidationStream.html +++ b/docs/interfaces/ValidationStream.html @@ -34,7 +34,7 @@

    Hierarchy

    • ValidationStream
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:183
    • @@ -69,7 +69,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:189

    • Optional base_fee

    base_fee?: number
    @@ -77,7 +77,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:191

    • Optional cookie

    cookie?: string
    @@ -88,7 +88,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:199

    • Optional data

    data?: string
    @@ -96,7 +96,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:203

    • flags

    flags: number
    @@ -105,7 +105,7 @@

    flags

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:208

    • full

    full: boolean
    @@ -118,7 +118,7 @@

    full

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:217

    • ledger_hash

    ledger_hash: string
    @@ -129,7 +129,7 @@

    ledger_hash

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:224

    • ledger_index

    ledger_index: string
    @@ -137,7 +137,7 @@

    ledger_index

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:226

    • Optional load_fee

    load_fee?: number
    @@ -146,7 +146,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:231

    • Optional master_key

    master_key?: string
    @@ -155,7 +155,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:236

    • Optional reserve_base

    reserve_base?: number
    @@ -164,7 +164,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:241

    • Optional reserve_inc

    reserve_inc?: number
    @@ -173,7 +173,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:246

    • signature

    signature: string
    @@ -181,7 +181,7 @@

    signature

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:248

    • signing_time

    signing_time: number
    @@ -189,13 +189,13 @@

    signing_time

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:250

    • type

    type: "validationReceived"
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:184

    • validation_public_key

    validation_public_key: string
    @@ -206,7 +206,7 @@

    validation_public_key

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:257
    • diff --git a/docs/interfaces/XChainAccountCreateCommit.html b/docs/interfaces/XChainAccountCreateCommit.html index d5c4efe1d6..1a5ecdc8ff 100644 --- a/docs/interfaces/XChainAccountCreateCommit.html +++ b/docs/interfaces/XChainAccountCreateCommit.html @@ -38,7 +38,7 @@

    Hierarchy

    • XChainAccountCreateCommit
    +
  • Defined in packages/xrpl/src/models/transactions/XChainAccountCreateCommit.ts:25
    • @@ -75,7 +75,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -86,7 +86,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Amount

    Amount: Amount
    @@ -95,7 +95,7 @@

    Amount

    +
  • Defined in packages/xrpl/src/models/transactions/XChainAccountCreateCommit.ts:48

    • Destination

    Destination: string
    @@ -103,7 +103,7 @@

    Destination

    +
  • Defined in packages/xrpl/src/models/transactions/XChainAccountCreateCommit.ts:42

    • Optional Fee

    Fee?: string
    @@ -114,7 +114,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -123,7 +123,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -134,7 +134,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -143,7 +143,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -152,7 +152,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional Sequence

    Sequence?: number
    @@ -164,7 +164,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • SignatureReward

    SignatureReward: Amount
    @@ -173,7 +173,7 @@

    SignatureReward

    +
  • Defined in packages/xrpl/src/models/transactions/XChainAccountCreateCommit.ts:37

    • Optional Signers

    Signers?: Signer[]
    @@ -183,7 +183,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -194,7 +194,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -206,7 +206,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -216,7 +216,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "XChainAccountCreateCommit"
    @@ -226,7 +226,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/XChainAccountCreateCommit.ts:26

    • Optional TxnSignature

    TxnSignature?: string
    @@ -236,7 +236,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289

    • XChainBridge

    XChainBridge: XChainBridge
    @@ -244,7 +244,7 @@

    XChainBridge

    +
  • Defined in packages/xrpl/src/models/transactions/XChainAccountCreateCommit.ts:31
    • diff --git a/docs/interfaces/XChainAddAccountCreateAttestation.html b/docs/interfaces/XChainAddAccountCreateAttestation.html index 85df73fcc8..e36055fe54 100644 --- a/docs/interfaces/XChainAddAccountCreateAttestation.html +++ b/docs/interfaces/XChainAddAccountCreateAttestation.html @@ -34,7 +34,7 @@

    Hierarchy

    • XChainAddAccountCreateAttestation
    +
  • Defined in packages/xrpl/src/models/transactions/XChainAddAccountCreateAttestation.ts:22
    • @@ -78,7 +78,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -89,7 +89,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Amount

    Amount: Amount
    @@ -98,7 +98,7 @@

    Amount

    +
  • Defined in packages/xrpl/src/models/transactions/XChainAddAccountCreateAttestation.ts:29

    • AttestationRewardAccount

    AttestationRewardAccount: string
    @@ -106,7 +106,7 @@

    AttestationRewardAccount

    +
  • Defined in packages/xrpl/src/models/transactions/XChainAddAccountCreateAttestation.ts:34

    • AttestationSignerAccount

    AttestationSignerAccount: string
    @@ -114,7 +114,7 @@

    AttestationSignerAccount

    +
  • Defined in packages/xrpl/src/models/transactions/XChainAddAccountCreateAttestation.ts:39

    • Destination

    Destination: string
    @@ -122,7 +122,7 @@

    Destination

    +
  • Defined in packages/xrpl/src/models/transactions/XChainAddAccountCreateAttestation.ts:44

    • Optional Fee

    Fee?: string
    @@ -133,7 +133,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -142,7 +142,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -153,7 +153,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -162,7 +162,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -171,7 +171,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • OtherChainSource

    OtherChainSource: string
    @@ -180,7 +180,7 @@

    OtherChainSource

    +
  • Defined in packages/xrpl/src/models/transactions/XChainAddAccountCreateAttestation.ts:50

    • PublicKey

    PublicKey: string
    @@ -188,7 +188,7 @@

    PublicKey

    +
  • Defined in packages/xrpl/src/models/transactions/XChainAddAccountCreateAttestation.ts:55

    • Optional Sequence

    Sequence?: number
    @@ -200,7 +200,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Signature

    Signature: string
    @@ -208,7 +208,7 @@

    Signature

    +
  • Defined in packages/xrpl/src/models/transactions/XChainAddAccountCreateAttestation.ts:60

    • SignatureReward

    SignatureReward: Amount
    @@ -216,7 +216,7 @@

    SignatureReward

    +
  • Defined in packages/xrpl/src/models/transactions/XChainAddAccountCreateAttestation.ts:65

    • Optional Signers

    Signers?: Signer[]
    @@ -226,7 +226,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -237,7 +237,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -249,7 +249,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -259,7 +259,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "XChainAddAccountCreateAttestation"
    @@ -269,7 +269,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/XChainAddAccountCreateAttestation.ts:23

    • Optional TxnSignature

    TxnSignature?: string
    @@ -279,7 +279,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289

    • WasLockingChainSend

    WasLockingChainSend: 0 | 1
    @@ -287,7 +287,7 @@

    WasLockingChainSend

    +
  • Defined in packages/xrpl/src/models/transactions/XChainAddAccountCreateAttestation.ts:70

    • XChainAccountCreateCount

    XChainAccountCreateCount: string | number
    @@ -295,7 +295,7 @@

    XChainAccountCreateCount

    +
  • Defined in packages/xrpl/src/models/transactions/XChainAddAccountCreateAttestation.ts:75

    • XChainBridge

    XChainBridge: XChainBridge
    @@ -303,7 +303,7 @@

    XChainBridge

    +
  • Defined in packages/xrpl/src/models/transactions/XChainAddAccountCreateAttestation.ts:80
    • diff --git a/docs/interfaces/XChainAddClaimAttestation.html b/docs/interfaces/XChainAddClaimAttestation.html index 96867631ff..67502526b9 100644 --- a/docs/interfaces/XChainAddClaimAttestation.html +++ b/docs/interfaces/XChainAddClaimAttestation.html @@ -33,7 +33,7 @@

    Hierarchy

    • XChainAddClaimAttestation
    +
  • Defined in packages/xrpl/src/models/transactions/XChainAddClaimAttestation.ts:22
    • @@ -76,7 +76,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -87,7 +87,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Amount

    Amount: Amount
    @@ -95,7 +95,7 @@

    Amount

    +
  • Defined in packages/xrpl/src/models/transactions/XChainAddClaimAttestation.ts:28

    • AttestationRewardAccount

    AttestationRewardAccount: string
    @@ -103,7 +103,7 @@

    AttestationRewardAccount

    +
  • Defined in packages/xrpl/src/models/transactions/XChainAddClaimAttestation.ts:33

    • AttestationSignerAccount

    AttestationSignerAccount: string
    @@ -111,7 +111,7 @@

    AttestationSignerAccount

    +
  • Defined in packages/xrpl/src/models/transactions/XChainAddClaimAttestation.ts:38

    • Optional Destination

    Destination?: string
    @@ -120,7 +120,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/XChainAddClaimAttestation.ts:44

    • Optional Fee

    Fee?: string
    @@ -131,7 +131,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -140,7 +140,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -151,7 +151,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -160,7 +160,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -169,7 +169,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • OtherChainSource

    OtherChainSource: string
    @@ -178,7 +178,7 @@

    OtherChainSource

    +
  • Defined in packages/xrpl/src/models/transactions/XChainAddClaimAttestation.ts:50

    • PublicKey

    PublicKey: string
    @@ -186,7 +186,7 @@

    PublicKey

    +
  • Defined in packages/xrpl/src/models/transactions/XChainAddClaimAttestation.ts:55

    • Optional Sequence

    Sequence?: number
    @@ -198,7 +198,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Signature

    Signature: string
    @@ -206,7 +206,7 @@

    Signature

    +
  • Defined in packages/xrpl/src/models/transactions/XChainAddClaimAttestation.ts:60

    • Optional Signers

    Signers?: Signer[]
    @@ -216,7 +216,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -227,7 +227,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -239,7 +239,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -249,7 +249,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "XChainAddClaimAttestation"
    @@ -259,7 +259,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/XChainAddClaimAttestation.ts:23

    • Optional TxnSignature

    TxnSignature?: string
    @@ -269,7 +269,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289

    • WasLockingChainSend

    WasLockingChainSend: 0 | 1
    @@ -277,7 +277,7 @@

    WasLockingChainSend

    +
  • Defined in packages/xrpl/src/models/transactions/XChainAddClaimAttestation.ts:65

    • XChainBridge

    XChainBridge: XChainBridge
    @@ -285,7 +285,7 @@

    XChainBridge

    +
  • Defined in packages/xrpl/src/models/transactions/XChainAddClaimAttestation.ts:70

    • XChainClaimID

    XChainClaimID: string | number
    @@ -294,7 +294,7 @@

    XChainClaimID

    +
  • Defined in packages/xrpl/src/models/transactions/XChainAddClaimAttestation.ts:76
    • diff --git a/docs/interfaces/XChainBridge.html b/docs/interfaces/XChainBridge.html index 3e91236b2e..210ea3444b 100644 --- a/docs/interfaces/XChainBridge.html +++ b/docs/interfaces/XChainBridge.html @@ -26,7 +26,7 @@

    Hierarchy

    • XChainBridge
    +
  • Defined in packages/xrpl/src/models/common/index.ts:152
    • @@ -45,22 +45,22 @@

    Properties

    IssuingChainDoor

    IssuingChainDoor: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:155

    • IssuingChainIssue

    IssuingChainIssue: Currency
    +
  • Defined in packages/xrpl/src/models/common/index.ts:156

    • LockingChainDoor

    LockingChainDoor: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:153

    • LockingChainIssue

    LockingChainIssue: Currency
    +
  • Defined in packages/xrpl/src/models/common/index.ts:154
    • diff --git a/docs/interfaces/XChainClaim.html b/docs/interfaces/XChainClaim.html index d1227cabff..0e2d535e29 100644 --- a/docs/interfaces/XChainClaim.html +++ b/docs/interfaces/XChainClaim.html @@ -34,7 +34,7 @@

    Hierarchy

    • XChainClaim
    +
  • Defined in packages/xrpl/src/models/transactions/XChainClaim.ts:23
    • @@ -72,7 +72,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -83,7 +83,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Amount

    Amount: Amount
    @@ -92,7 +92,7 @@

    Amount

    +
  • Defined in packages/xrpl/src/models/transactions/XChainClaim.ts:54

    • Destination

    Destination: string
    @@ -103,7 +103,7 @@

    Destination

    +
  • Defined in packages/xrpl/src/models/transactions/XChainClaim.ts:43

    • Optional DestinationTag

    DestinationTag?: number
    @@ -111,7 +111,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/XChainClaim.ts:48

    • Optional Fee

    Fee?: string
    @@ -122,7 +122,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -131,7 +131,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -142,7 +142,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -151,7 +151,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -160,7 +160,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional Sequence

    Sequence?: number
    @@ -172,7 +172,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -182,7 +182,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -193,7 +193,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -205,7 +205,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -215,7 +215,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "XChainClaim"
    @@ -225,7 +225,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/XChainClaim.ts:24

    • Optional TxnSignature

    TxnSignature?: string
    @@ -235,7 +235,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289

    • XChainBridge

    XChainBridge: XChainBridge
    @@ -243,7 +243,7 @@

    XChainBridge

    +
  • Defined in packages/xrpl/src/models/transactions/XChainClaim.ts:29

    • XChainClaimID

    XChainClaimID: string | number
    @@ -252,7 +252,7 @@

    XChainClaimID

    +
  • Defined in packages/xrpl/src/models/transactions/XChainClaim.ts:35
    • diff --git a/docs/interfaces/XChainCommit.html b/docs/interfaces/XChainCommit.html index fc0b58978d..9ea16a70cf 100644 --- a/docs/interfaces/XChainCommit.html +++ b/docs/interfaces/XChainCommit.html @@ -35,7 +35,7 @@

    Hierarchy

    • XChainCommit
    +
  • Defined in packages/xrpl/src/models/transactions/XChainCommit.ts:24
    • @@ -72,7 +72,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -83,7 +83,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Amount

    Amount: Amount
    @@ -93,7 +93,7 @@

    Amount

    +
  • Defined in packages/xrpl/src/models/transactions/XChainCommit.ts:53

    • Optional Fee

    Fee?: string
    @@ -104,7 +104,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -113,7 +113,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -124,7 +124,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -133,7 +133,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -142,7 +142,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional OtherChainDestination

    OtherChainDestination?: string
    @@ -153,7 +153,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/XChainCommit.ts:46

    • Optional Sequence

    Sequence?: number
    @@ -165,7 +165,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional Signers

    Signers?: Signer[]
    @@ -175,7 +175,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -186,7 +186,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -198,7 +198,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -208,7 +208,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "XChainCommit"
    @@ -218,7 +218,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/XChainCommit.ts:25

    • Optional TxnSignature

    TxnSignature?: string
    @@ -228,7 +228,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289

    • XChainBridge

    XChainBridge: XChainBridge
    @@ -236,7 +236,7 @@

    XChainBridge

    +
  • Defined in packages/xrpl/src/models/transactions/XChainCommit.ts:30

    • XChainClaimID

    XChainClaimID: string | number
    @@ -247,7 +247,7 @@

    XChainClaimID

    +
  • Defined in packages/xrpl/src/models/transactions/XChainCommit.ts:38
    • diff --git a/docs/interfaces/XChainCreateBridge.html b/docs/interfaces/XChainCreateBridge.html index a59767f597..77aeb5bd18 100644 --- a/docs/interfaces/XChainCreateBridge.html +++ b/docs/interfaces/XChainCreateBridge.html @@ -35,7 +35,7 @@

    Hierarchy

    • XChainCreateBridge
    +
  • Defined in packages/xrpl/src/models/transactions/XChainCreateBridge.ts:20
    • @@ -71,7 +71,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -82,7 +82,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Optional Fee

    Fee?: string
    @@ -93,7 +93,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -102,7 +102,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -113,7 +113,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -122,7 +122,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional MinAccountCreateAmount

    MinAccountCreateAmount?: Amount
    @@ -132,7 +132,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/XChainCreateBridge.ts:39

    • Optional NetworkID

    NetworkID?: number
    @@ -141,7 +141,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional Sequence

    Sequence?: number
    @@ -153,7 +153,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • SignatureReward

    SignatureReward: Amount
    @@ -162,7 +162,7 @@

    SignatureReward

    +
  • Defined in packages/xrpl/src/models/transactions/XChainCreateBridge.ts:32

    • Optional Signers

    Signers?: Signer[]
    @@ -172,7 +172,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -183,7 +183,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -195,7 +195,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -205,7 +205,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "XChainCreateBridge"
    @@ -215,7 +215,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/XChainCreateBridge.ts:21

    • Optional TxnSignature

    TxnSignature?: string
    @@ -225,7 +225,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289

    • XChainBridge

    XChainBridge: XChainBridge
    @@ -233,7 +233,7 @@

    XChainBridge

    +
  • Defined in packages/xrpl/src/models/transactions/XChainCreateBridge.ts:26
    • diff --git a/docs/interfaces/XChainCreateClaimID.html b/docs/interfaces/XChainCreateClaimID.html index 7d697f151d..e55a111fbc 100644 --- a/docs/interfaces/XChainCreateClaimID.html +++ b/docs/interfaces/XChainCreateClaimID.html @@ -34,7 +34,7 @@

    Hierarchy

    • XChainCreateClaimID
    +
  • Defined in packages/xrpl/src/models/transactions/XChainCreateClaimID.ts:20
    • @@ -70,7 +70,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -81,7 +81,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Optional Fee

    Fee?: string
    @@ -92,7 +92,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -101,7 +101,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:251

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -112,7 +112,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -121,7 +121,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional NetworkID

    NetworkID?: number
    @@ -130,7 +130,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • OtherChainSource

    OtherChainSource: string
    @@ -138,7 +138,7 @@

    OtherChainSource

    +
  • Defined in packages/xrpl/src/models/transactions/XChainCreateClaimID.ts:37

    • Optional Sequence

    Sequence?: number
    @@ -150,7 +150,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • SignatureReward

    SignatureReward: Amount
    @@ -159,7 +159,7 @@

    SignatureReward

    +
  • Defined in packages/xrpl/src/models/transactions/XChainCreateClaimID.ts:32

    • Optional Signers

    Signers?: Signer[]
    @@ -169,7 +169,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -180,7 +180,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -192,7 +192,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -202,7 +202,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "XChainCreateClaimID"
    @@ -212,7 +212,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/XChainCreateClaimID.ts:21

    • Optional TxnSignature

    TxnSignature?: string
    @@ -222,7 +222,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289

    • XChainBridge

    XChainBridge: XChainBridge
    @@ -230,7 +230,7 @@

    XChainBridge

    +
  • Defined in packages/xrpl/src/models/transactions/XChainCreateClaimID.ts:26
    • diff --git a/docs/interfaces/XChainModifyBridge.html b/docs/interfaces/XChainModifyBridge.html index fc8b16a245..421296c25f 100644 --- a/docs/interfaces/XChainModifyBridge.html +++ b/docs/interfaces/XChainModifyBridge.html @@ -33,7 +33,7 @@

    Hierarchy

    • XChainModifyBridge
    +
  • Defined in packages/xrpl/src/models/transactions/XChainModifyBridge.ts:40
    • @@ -69,7 +69,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:225

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -80,7 +80,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:249

    • Optional Fee

    Fee?: string
    @@ -91,7 +91,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:236

    • Optional Flags

    Flags?: number | XChainModifyBridgeFlagsInterface
    @@ -100,7 +100,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/XChainModifyBridge.ts:60

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -111,7 +111,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:257

    • Optional Memos

    Memos?: Memo[]
    @@ -120,7 +120,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:261

    • Optional MinAccountCreateAmount

    MinAccountCreateAmount?: Amount
    @@ -130,7 +130,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/XChainModifyBridge.ts:58

    • Optional NetworkID

    NetworkID?: number
    @@ -139,7 +139,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:293

    • Optional Sequence

    Sequence?: number
    @@ -151,7 +151,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:243

    • Optional SignatureReward

    SignatureReward?: Amount
    @@ -159,7 +159,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/XChainModifyBridge.ts:51

    • Optional Signers

    Signers?: Signer[]
    @@ -169,7 +169,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:266

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -180,7 +180,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:279

    • Optional SourceTag

    SourceTag?: number
    @@ -192,7 +192,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:273

    • Optional TicketSequence

    TicketSequence?: number
    @@ -202,7 +202,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:284

    • TransactionType

    TransactionType: "XChainModifyBridge"
    @@ -212,7 +212,7 @@

    TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/XChainModifyBridge.ts:41

    • Optional TxnSignature

    TxnSignature?: string
    @@ -222,7 +222,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:289

    • XChainBridge

    XChainBridge: XChainBridge
    @@ -230,7 +230,7 @@

    XChainBridge

    +
  • Defined in packages/xrpl/src/models/transactions/XChainModifyBridge.ts:46
    • diff --git a/docs/interfaces/XChainModifyBridgeFlagsInterface.html b/docs/interfaces/XChainModifyBridgeFlagsInterface.html index 46ca2897d7..6f41b82486 100644 --- a/docs/interfaces/XChainModifyBridgeFlagsInterface.html +++ b/docs/interfaces/XChainModifyBridgeFlagsInterface.html @@ -33,7 +33,7 @@

    Hierarchy

    • XChainModifyBridgeFlagsInterface
    +
  • Defined in packages/xrpl/src/models/transactions/XChainModifyBridge.ts:29
    • @@ -52,7 +52,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/XChainModifyBridge.ts:31
    • diff --git a/docs/interfaces/XRP.html b/docs/interfaces/XRP.html index bfff9f582d..8d7ab06338 100644 --- a/docs/interfaces/XRP.html +++ b/docs/interfaces/XRP.html @@ -26,7 +26,7 @@

    Hierarchy

    • XRP
    +
  • Defined in packages/xrpl/src/models/common/index.ts:3
    • @@ -43,12 +43,12 @@

    Properties

    currency

    currency: "XRP"
    +
  • Defined in packages/xrpl/src/models/common/index.ts:4

    • Optional issuer

    issuer?: undefined
    +
  • Defined in packages/xrpl/src/models/common/index.ts:5
    • diff --git a/docs/modules/LedgerEntry.html b/docs/modules/LedgerEntry.html index 122620e9b3..6ef28423f0 100644 --- a/docs/modules/LedgerEntry.html +++ b/docs/modules/LedgerEntry.html @@ -31,7 +31,7 @@

    Namespace LedgerEntry

    +
  • Defined in packages/xrpl/src/models/ledger/index.ts:1

    • Index

    diff --git a/docs/types/AccountObject.html b/docs/types/AccountObject.html index a72a7b39a7..75ca7da55a 100644 --- a/docs/types/AccountObject.html +++ b/docs/types/AccountObject.html @@ -27,7 +27,7 @@

    Type alias AccountObject

    +
  • Defined in packages/xrpl/src/models/methods/accountObjects.ts:49
    • diff --git a/docs/types/AccountObjectType.html b/docs/types/AccountObjectType.html index 7a84591d26..04cce0b4b0 100644 --- a/docs/types/AccountObjectType.html +++ b/docs/types/AccountObjectType.html @@ -23,7 +23,7 @@

    Type alias AccountObjectType

    AccountObjectType: Exclude<LedgerEntryFilter, "amendments" | "fee" | "hashes">
    +
  • Defined in packages/xrpl/src/models/methods/accountObjects.ts:6
    • diff --git a/docs/types/Amount.html b/docs/types/Amount.html index 0d05199b4d..7519035e85 100644 --- a/docs/types/Amount.html +++ b/docs/types/Amount.html @@ -23,7 +23,7 @@

    Type alias Amount

    Amount: IssuedCurrencyAmount | string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:19
    • diff --git a/docs/types/BooksSnapshot.html b/docs/types/BooksSnapshot.html index 24dc1c020e..f412c644d0 100644 --- a/docs/types/BooksSnapshot.html +++ b/docs/types/BooksSnapshot.html @@ -23,7 +23,7 @@

    Type alias BooksSnapshot

    BooksSnapshot: Offer[]
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:76
    • diff --git a/docs/types/Currency.html b/docs/types/Currency.html index 15287e9a44..c8a1e829d7 100644 --- a/docs/types/Currency.html +++ b/docs/types/Currency.html @@ -23,7 +23,7 @@

    Type alias Currency

    Currency: IssuedCurrency | XRP
    +
  • Defined in packages/xrpl/src/models/common/index.ts:13
    • diff --git a/docs/types/LedgerDataLabeledLedgerEntry.html b/docs/types/LedgerDataLabeledLedgerEntry.html index 3a816c50b7..ab2dd89fa5 100644 --- a/docs/types/LedgerDataLabeledLedgerEntry.html +++ b/docs/types/LedgerDataLabeledLedgerEntry.html @@ -28,7 +28,7 @@

    Type declaration

  • ledgerEntryType: string
    • +
  • Defined in packages/xrpl/src/models/methods/ledgerData.ts:46
    • diff --git a/docs/types/LedgerDataLedgerState.html b/docs/types/LedgerDataLedgerState.html index 8c666c6f09..5926b7c1f2 100644 --- a/docs/types/LedgerDataLedgerState.html +++ b/docs/types/LedgerDataLedgerState.html @@ -28,7 +28,7 @@

    Type declaration

  • index: string
    • +
  • Defined in packages/xrpl/src/models/methods/ledgerData.ts:54
    • diff --git a/docs/types/LedgerEntry.LedgerEntry.html b/docs/types/LedgerEntry.LedgerEntry.html index 7eae81d8a0..4bff36392a 100644 --- a/docs/types/LedgerEntry.LedgerEntry.html +++ b/docs/types/LedgerEntry.LedgerEntry.html @@ -24,7 +24,7 @@

    Type alias LedgerEntry

    LedgerEntry: AccountRoot | Amendments | AMM | Bridge | Check | LedgerEntry.DepositPreauth | DirectoryNode | Escrow | FeeSettings | LedgerHashes | NegativeUNL | Offer | PayChannel | RippleState | SignerList | Ticket | XChainOwnedClaimID | XChainOwnedCreateAccountClaimID
    +
  • Defined in packages/xrpl/src/models/ledger/LedgerEntry.ts:20
    • diff --git a/docs/types/LedgerEntry.LedgerEntryFilter.html b/docs/types/LedgerEntry.LedgerEntryFilter.html index 1864516869..6b68301e34 100644 --- a/docs/types/LedgerEntry.LedgerEntryFilter.html +++ b/docs/types/LedgerEntry.LedgerEntryFilter.html @@ -24,7 +24,7 @@

    Type alias LedgerEntryFilter

    LedgerEntryFilter: "account" | "amendments" | "amm" | "bridge" | "check" | "deposit_preauth" | "did" | "directory" | "escrow" | "fee" | "hashes" | "nft_offer" | "nft_page" | "offer" | "payment_channel" | "signer_list" | "state" | "ticket" | "xchain_owned_create_account_claim_id" | "xchain_owned_claim_id"
    +
  • Defined in packages/xrpl/src/models/ledger/LedgerEntry.ts:40
    • diff --git a/docs/types/LedgerIndex.html b/docs/types/LedgerIndex.html index 93c9180920..3d0d06c152 100644 --- a/docs/types/LedgerIndex.html +++ b/docs/types/LedgerIndex.html @@ -23,7 +23,7 @@

    Type alias LedgerIndex

    LedgerIndex: number | "validated" | "closed" | "current"
    +
  • Defined in packages/xrpl/src/models/common/index.ts:1
    • diff --git a/docs/types/MarkerRequest.html b/docs/types/MarkerRequest.html index 14574dd7e4..d0bdbab85b 100644 --- a/docs/types/MarkerRequest.html +++ b/docs/types/MarkerRequest.html @@ -30,7 +30,7 @@
    Optional
    Optional marker?: unknown
    +
  • Defined in packages/xrpl/src/models/methods/index.ts:410
    • diff --git a/docs/types/MarkerResponse.html b/docs/types/MarkerResponse.html index b55206ec63..b01f74280e 100644 --- a/docs/types/MarkerResponse.html +++ b/docs/types/MarkerResponse.html @@ -31,7 +31,7 @@
    result
    Optional marker?: unknown
    +
  • Defined in packages/xrpl/src/models/methods/index.ts:415
    • diff --git a/docs/types/Node.html b/docs/types/Node.html index a9e44df962..fd02005bb5 100644 --- a/docs/types/Node.html +++ b/docs/types/Node.html @@ -23,7 +23,7 @@

    Type alias Node

    Node: CreatedNode | ModifiedNode | DeletedNode
    +
  • Defined in packages/xrpl/src/models/transactions/metadata.ts:47
    • diff --git a/docs/types/Path.html b/docs/types/Path.html index 7bb103e378..a025770c21 100644 --- a/docs/types/Path.html +++ b/docs/types/Path.html @@ -23,7 +23,7 @@

    Type alias Path

    Path: PathStep[]
    +
  • Defined in packages/xrpl/src/models/common/index.ts:59
    • diff --git a/docs/types/PathFindRequest.html b/docs/types/PathFindRequest.html index e306fb59a1..9c6b4ad7f8 100644 --- a/docs/types/PathFindRequest.html +++ b/docs/types/PathFindRequest.html @@ -29,7 +29,7 @@

    Type alias PathFindRequest

    +
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:53
    • diff --git a/docs/types/PseudoTransaction.html b/docs/types/PseudoTransaction.html index 87db26aad6..0de9dc14db 100644 --- a/docs/types/PseudoTransaction.html +++ b/docs/types/PseudoTransaction.html @@ -26,7 +26,7 @@

    Type alias PseudoTransaction

    +
  • Defined in packages/xrpl/src/models/transactions/transaction.ts:145
    • diff --git a/docs/types/Request.html b/docs/types/Request.html index 1fccb0bcc6..95ed628880 100644 --- a/docs/types/Request.html +++ b/docs/types/Request.html @@ -24,7 +24,7 @@

    Type alias 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 | ServerDefinitionsRequest | ServerInfoRequest | ServerStateRequest | PingRequest | RandomRequest | NFTBuyOffersRequest | NFTSellOffersRequest | NFTInfoRequest | NFTHistoryRequest | AMMInfoRequest
    +
  • Defined in packages/xrpl/src/models/methods/index.ts:163
    • diff --git a/docs/types/RequestAllResponseMap.html b/docs/types/RequestAllResponseMap.html index 9914ca8c89..19e2fc80a1 100644 --- a/docs/types/RequestAllResponseMap.html +++ b/docs/types/RequestAllResponseMap.html @@ -28,7 +28,7 @@

    Type Parameters

  • T

    • +
  • Defined in packages/xrpl/src/models/methods/index.ts:421
    • diff --git a/docs/types/RequestResponseMap.html b/docs/types/RequestResponseMap.html index 1f2c4048c6..342b087a00 100644 --- a/docs/types/RequestResponseMap.html +++ b/docs/types/RequestResponseMap.html @@ -28,7 +28,7 @@

    Type Parameters

  • T

    • +
  • Defined in packages/xrpl/src/models/methods/index.ts:268
    • diff --git a/docs/types/Response.html b/docs/types/Response.html index 419d8dce85..c8e44561f0 100644 --- a/docs/types/Response.html +++ b/docs/types/Response.html @@ -24,7 +24,7 @@

    Type alias 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 | ServerDefinitionsResponse | ServerInfoResponse | ServerStateResponse | PingResponse | RandomResponse | NFTBuyOffersResponse | NFTSellOffersResponse | NFTInfoResponse | NFTHistoryResponse | AMMInfoResponse
    +
  • Defined in packages/xrpl/src/models/methods/index.ts:217
    • diff --git a/docs/types/ServerState.html b/docs/types/ServerState.html index 1f5c976291..9bd4e3e02c 100644 --- a/docs/types/ServerState.html +++ b/docs/types/ServerState.html @@ -23,7 +23,7 @@

    Type alias ServerState

    ServerState: "disconnected" | "connected" | "syncing" | "tracking" | "full" | "validating" | "proposing"
    +
  • Defined in packages/xrpl/src/models/methods/serverInfo.ts:14
    • diff --git a/docs/types/SetFee.html b/docs/types/SetFee.html index 61dfec61fc..d7de855b63 100644 --- a/docs/types/SetFee.html +++ b/docs/types/SetFee.html @@ -36,7 +36,7 @@

    Type declaration

    TransactionType: "SetFee"
    +
  • Defined in packages/xrpl/src/models/transactions/setFee.ts:46
    • diff --git a/docs/types/StateAccountingFinal.html b/docs/types/StateAccountingFinal.html index 9f216c9f6a..6de618b58f 100644 --- a/docs/types/StateAccountingFinal.html +++ b/docs/types/StateAccountingFinal.html @@ -23,7 +23,7 @@

    Type alias StateAccountingFinal

    StateAccountingFinal: Record<Exclude<ServerState, "validating" | "proposing">, StateAccounting>
    +
  • Defined in packages/xrpl/src/models/methods/serverInfo.ts:55
    • diff --git a/docs/types/Stream.html b/docs/types/Stream.html index 6fa15dea4a..8001834c62 100644 --- a/docs/types/Stream.html +++ b/docs/types/Stream.html @@ -24,7 +24,7 @@

    Type alias Stream

    Stream: LedgerStream | ValidationStream | TransactionStream | PathFindStream | PeerStatusStream | OrderBookStream | ConsensusStream
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:429
    • diff --git a/docs/types/StreamType.html b/docs/types/StreamType.html index 6455d95132..12f510a028 100644 --- a/docs/types/StreamType.html +++ b/docs/types/StreamType.html @@ -23,7 +23,7 @@

    Type alias StreamType

    StreamType: "consensus" | "ledger" | "manifests" | "peer_status" | "transactions" | "transactions_proposed" | "server" | "validations"
    +
  • Defined in packages/xrpl/src/models/common/index.ts:43
    • diff --git a/docs/types/SubmittableTransaction.html b/docs/types/SubmittableTransaction.html index 5240a02dd7..3c03ed45d5 100644 --- a/docs/types/SubmittableTransaction.html +++ b/docs/types/SubmittableTransaction.html @@ -26,7 +26,7 @@

    Type alias SubmittableTransaction

    +
  • Defined in packages/xrpl/src/models/transactions/transaction.ts:97
    • diff --git a/docs/types/Transaction.html b/docs/types/Transaction.html index ebbb126a7b..9ef0107ee1 100644 --- a/docs/types/Transaction.html +++ b/docs/types/Transaction.html @@ -26,7 +26,7 @@

    Type alias Transaction

    +
  • Defined in packages/xrpl/src/models/transactions/transaction.ts:152
    • diff --git a/docs/types/TransactionMetadata.html b/docs/types/TransactionMetadata.html index 316bd0007c..e332e621d8 100644 --- a/docs/types/TransactionMetadata.html +++ b/docs/types/TransactionMetadata.html @@ -28,7 +28,7 @@

    Type Parameters

  • T extends BaseTransaction = Transaction

    • +
  • Defined in packages/xrpl/src/models/transactions/metadata.ts:88
    • diff --git a/docs/variables/LedgerEntry.AMENDMENTS_ID.html b/docs/variables/LedgerEntry.AMENDMENTS_ID.html index a96ab2229c..b7787342e7 100644 --- a/docs/variables/LedgerEntry.AMENDMENTS_ID.html +++ b/docs/variables/LedgerEntry.AMENDMENTS_ID.html @@ -27,7 +27,7 @@

    Variable AMENDMENTS_IDConst

    <
    +
  • Defined in packages/xrpl/src/models/ledger/Amendments.ts:6
    • diff --git a/docs/variables/LedgerEntry.FEE_SETTINGS_ID.html b/docs/variables/LedgerEntry.FEE_SETTINGS_ID.html index 0a8bff00af..9a629fc495 100644 --- a/docs/variables/LedgerEntry.FEE_SETTINGS_ID.html +++ b/docs/variables/LedgerEntry.FEE_SETTINGS_ID.html @@ -27,7 +27,7 @@

    Variable FEE_SETTINGS_IDConst

    +
  • Defined in packages/xrpl/src/models/ledger/FeeSettings.ts:6
    • diff --git a/docs/variables/LedgerEntry.NEGATIVE_UNL_ID.html b/docs/variables/LedgerEntry.NEGATIVE_UNL_ID.html index e9f8129d80..9e51a47a4f 100644 --- a/docs/variables/LedgerEntry.NEGATIVE_UNL_ID.html +++ b/docs/variables/LedgerEntry.NEGATIVE_UNL_ID.html @@ -27,7 +27,7 @@

    Variable NEGATIVE_UNL_IDConst

    +
  • Defined in packages/xrpl/src/models/ledger/NegativeUNL.ts:6
    • diff --git a/docs/variables/hashes.html b/docs/variables/hashes.html index 5957fa73de..14cdf4c092 100644 --- a/docs/variables/hashes.html +++ b/docs/variables/hashes.html @@ -311,7 +311,7 @@

    Returns string

    +
  • Defined in packages/xrpl/src/utils/index.ts:168
    • diff --git a/package-lock.json b/package-lock.json index 4763ce72c6..b73a164962 100644 --- a/package-lock.json +++ b/package-lock.json @@ -15257,7 +15257,7 @@ }, "packages/isomorphic": { "name": "@xrplf/isomorphic", - "version": "1.0.0-beta.1", + "version": "1.0.0", "license": "ISC", "dependencies": { "@noble/hashes": "^1.0.0", @@ -15293,35 +15293,35 @@ } }, "packages/ripple-address-codec": { - "version": "5.0.0-beta.1", + "version": "5.0.0", "license": "ISC", "dependencies": { "@scure/base": "^1.1.3", - "@xrplf/isomorphic": "^1.0.0-beta.1" + "@xrplf/isomorphic": "^1.0.0" }, "engines": { "node": ">= 16" } }, "packages/ripple-binary-codec": { - "version": "2.0.0-beta.1", + "version": "2.0.0", "license": "ISC", "dependencies": { - "@xrplf/isomorphic": "^1.0.0-beta.1", + "@xrplf/isomorphic": "^1.0.0", "bignumber.js": "^9.0.0", - "ripple-address-codec": "^5.0.0-beta.1" + "ripple-address-codec": "^5.0.0" }, "engines": { "node": ">= 16" } }, "packages/ripple-keypairs": { - "version": "2.0.0-beta.1", + "version": "2.0.0", "license": "ISC", "dependencies": { "@noble/curves": "^1.0.0", - "@xrplf/isomorphic": "^1.0.0-beta.1", - "ripple-address-codec": "^5.0.0-beta.1" + "@xrplf/isomorphic": "^1.0.0", + "ripple-address-codec": "^5.0.0" }, "engines": { "node": ">= 16" @@ -15329,27 +15329,27 @@ }, "packages/secret-numbers": { "name": "@xrplf/secret-numbers", - "version": "1.0.0-beta.1", + "version": "1.0.0", "license": "ISC", "dependencies": { - "@xrplf/isomorphic": "^1.0.0-beta.1", - "ripple-keypairs": "^2.0.0-beta.1" + "@xrplf/isomorphic": "^1.0.0", + "ripple-keypairs": "^2.0.0" } }, "packages/xrpl": { - "version": "3.0.0-beta.1", + "version": "3.0.0", "license": "ISC", "dependencies": { "@scure/bip32": "^1.3.1", "@scure/bip39": "^1.2.1", - "@xrplf/isomorphic": "^1.0.0-beta.1", - "@xrplf/secret-numbers": "^1.0.0-beta.1", + "@xrplf/isomorphic": "^1.0.0", + "@xrplf/secret-numbers": "^1.0.0", "bignumber.js": "^9.0.0", "cross-fetch": "^4.0.0", "eventemitter3": "^5.0.1", - "ripple-address-codec": "^5.0.0-beta.1", - "ripple-binary-codec": "^2.0.0-beta.1", - "ripple-keypairs": "^2.0.0-beta.1" + "ripple-address-codec": "^5.0.0", + "ripple-binary-codec": "^2.0.0", + "ripple-keypairs": "^2.0.0" }, "devDependencies": { "@types/node": "^16.18.38", @@ -18251,8 +18251,8 @@ "@xrplf/secret-numbers": { "version": "file:packages/secret-numbers", "requires": { - "@xrplf/isomorphic": "^1.0.0-beta.1", - "ripple-keypairs": "^2.0.0-beta.1" + "@xrplf/isomorphic": "^1.0.0", + "ripple-keypairs": "^2.0.0" } }, "@xtuc/ieee754": { @@ -25357,23 +25357,23 @@ "version": "file:packages/ripple-address-codec", "requires": { "@scure/base": "^1.1.3", - "@xrplf/isomorphic": "^1.0.0-beta.1" + "@xrplf/isomorphic": "^1.0.0" } }, "ripple-binary-codec": { "version": "file:packages/ripple-binary-codec", "requires": { - "@xrplf/isomorphic": "^1.0.0-beta.1", + "@xrplf/isomorphic": "^1.0.0", "bignumber.js": "^9.0.0", - "ripple-address-codec": "^5.0.0-beta.1" + "ripple-address-codec": "^5.0.0" } }, "ripple-keypairs": { "version": "file:packages/ripple-keypairs", "requires": { "@noble/curves": "^1.0.0", - "@xrplf/isomorphic": "^1.0.0-beta.1", - "ripple-address-codec": "^5.0.0-beta.1" + "@xrplf/isomorphic": "^1.0.0", + "ripple-address-codec": "^5.0.0" } }, "run-async": { @@ -27178,8 +27178,8 @@ "@scure/bip32": "^1.3.1", "@scure/bip39": "^1.2.1", "@types/node": "^16.18.38", - "@xrplf/isomorphic": "^1.0.0-beta.1", - "@xrplf/secret-numbers": "^1.0.0-beta.1", + "@xrplf/isomorphic": "^1.0.0", + "@xrplf/secret-numbers": "^1.0.0", "bignumber.js": "^9.0.0", "cross-fetch": "^4.0.0", "eventemitter3": "^5.0.1", @@ -27190,9 +27190,9 @@ "karma-webpack": "^5.0.0", "lodash": "^4.17.4", "react": "^18.2.0", - "ripple-address-codec": "^5.0.0-beta.1", - "ripple-binary-codec": "^2.0.0-beta.1", - "ripple-keypairs": "^2.0.0-beta.1", + "ripple-address-codec": "^5.0.0", + "ripple-binary-codec": "^2.0.0", + "ripple-keypairs": "^2.0.0", "run-s": "^0.0.0", "typedoc": "0.25.0", "ws": "^8.14.2" diff --git a/packages/isomorphic/HISTORY.md b/packages/isomorphic/HISTORY.md index 729120b26b..d758b1e411 100644 --- a/packages/isomorphic/HISTORY.md +++ b/packages/isomorphic/HISTORY.md @@ -1,21 +1,34 @@ # @xrplf/isomorphic Release History -## Unreleased +## 1.0.0 (2024-02-01) + +Initial release providing isomorphic and tree-shakable implementations of: + +* ripemd160 +* sha256 +* sha512 +* bytesToHash +* hashToBytes +* hexToString +* stringToHex +* randomBytes +* stringToHex +* ws ## 1.0.0 Beta 1 (2023-11-30) ## Added -- hexToString -- stringToHex +* hexToString +* stringToHex ## 1.0.0 Beta 0 (2023-10-19) Initial release providing isomorphic and tree-shakable implementations of: -- ripemd160 -- sha256 -- sha512 -- bytesToHash -- hashToBytes -- randomBytes -- ws +* ripemd160 +* sha256 +* sha512 +* bytesToHash +* hashToBytes +* randomBytes +* ws_ diff --git a/packages/isomorphic/package.json b/packages/isomorphic/package.json index b52a9b365a..208d88041c 100644 --- a/packages/isomorphic/package.json +++ b/packages/isomorphic/package.json @@ -1,6 +1,6 @@ { "name": "@xrplf/isomorphic", - "version": "1.0.0-beta.1", + "version": "1.0.0", "description": "A collection of isomorphic and tree-shakeable crypto hashes and utils for xrpl.js", "keywords": [ "crypto", diff --git a/packages/ripple-address-codec/HISTORY.md b/packages/ripple-address-codec/HISTORY.md index 5b693e82a6..ce2ca0267e 100644 --- a/packages/ripple-address-codec/HISTORY.md +++ b/packages/ripple-address-codec/HISTORY.md @@ -2,6 +2,19 @@ ## Unreleased +## 5.0.0 (2024-02-01) + +### BREAKING CHANGES +* Bump typescript to 5.x +* Remove Node 14 support +* Remove `assert` dependency. If you were catching `AssertionError` you need to change to `Error`. +* Remove `create-hash` in favor of `@noble/hashes` +* `Buffer` has been replaced with `UInt8Array` for both params and return values. `Buffer` may continue to work with params since they extend `UInt8Arrays`. + +### Non-Breaking Changes +* Eliminates 4 runtime dependencies: `base-x`, `base64-js`, `buffer`, and `ieee754`. +* Execute test in a browser in addition to node + ## 5.0.0 Beta 1 (2023-11-30) ### Breaking Changes diff --git a/packages/ripple-address-codec/package.json b/packages/ripple-address-codec/package.json index c68b247a82..3ae51fb98c 100644 --- a/packages/ripple-address-codec/package.json +++ b/packages/ripple-address-codec/package.json @@ -1,6 +1,6 @@ { "name": "ripple-address-codec", - "version": "5.0.0-beta.1", + "version": "5.0.0", "description": "encodes/decodes base58 encoded XRP Ledger identifiers", "files": [ "dist/*", @@ -11,7 +11,7 @@ "license": "ISC", "dependencies": { "@scure/base": "^1.1.3", - "@xrplf/isomorphic": "^1.0.0-beta.1" + "@xrplf/isomorphic": "^1.0.0" }, "keywords": [ "ripple", diff --git a/packages/ripple-binary-codec/HISTORY.md b/packages/ripple-binary-codec/HISTORY.md index aee2bf8979..6ba00b82c1 100644 --- a/packages/ripple-binary-codec/HISTORY.md +++ b/packages/ripple-binary-codec/HISTORY.md @@ -2,6 +2,23 @@ ## Unreleased +## 2.0.0 (2024-02-01) + +### BREAKING CHANGES +* Bump typescript to 5.x +* Remove Node 14 support +* Remove decimal.js and big-integer. Use `BigNumber` from `bignumber.js` instead of `Decimal` and the native `BigInt` instead of `bigInt`. +* Remove `assert` dependency. If you were catching `AssertionError` you need to change to `Error`. +* Remove `create-hash` in favor of `@noble/hashes` +* `Buffer` has been replaced with `UInt8Array` for both params and return values. `Buffer` may continue to work with params since they extend `UInt8Arrays`. + +### Non-Breaking Changes +* Update type definitions which causing errors in tests that the code already supported + * `makeParser` to accept a `Buffer` in addition to `string` + * `SerializedType` constructor allows not passing in a byte array + * `Comparable` is now a generic type so that it allows `compareTo` methods to take more that the type itself. +* Eliminates 4 runtime dependencies: `base-x`, `base64-js`, `buffer`, and `ieee754`. + ## 2.0.0 Beta 1 (2023-11-30) ### Breaking Changes diff --git a/packages/ripple-binary-codec/package.json b/packages/ripple-binary-codec/package.json index 080dc8be6c..ebc59834fa 100644 --- a/packages/ripple-binary-codec/package.json +++ b/packages/ripple-binary-codec/package.json @@ -1,6 +1,6 @@ { "name": "ripple-binary-codec", - "version": "2.0.0-beta.1", + "version": "2.0.0", "description": "XRP Ledger binary codec", "files": [ "dist/*", @@ -11,9 +11,9 @@ "test": "test" }, "dependencies": { - "@xrplf/isomorphic": "^1.0.0-beta.1", + "@xrplf/isomorphic": "^1.0.0", "bignumber.js": "^9.0.0", - "ripple-address-codec": "^5.0.0-beta.1" + "ripple-address-codec": "^5.0.0" }, "scripts": { "build": "tsc --build tsconfig.build.json && copyfiles ./src/enums/definitions.json ./dist/enums/", diff --git a/packages/ripple-keypairs/HISTORY.md b/packages/ripple-keypairs/HISTORY.md index 791e67dadf..6a20d8af5f 100644 --- a/packages/ripple-keypairs/HISTORY.md +++ b/packages/ripple-keypairs/HISTORY.md @@ -2,6 +2,23 @@ ## Unreleased +## 2.0.0 (2024-02-01) + +### BREAKING CHANGES +* Bump typescript to 5.x +* Remove Node 14 support +* Remove `assert` dependency. If you were catching `AssertionError` you need to change to `Error`. +* Fix `deriveKeypair` ignoring manual decoding algorithm. (Specifying algorithm=`ed25519` in `opts` now works on secrets like `sNa1...`) +* Remove `crypto` polyfills, `create-hash`, `elliptic`, `hash.js`, and their many dependencies in favor of `@noble/hashes` and `@nobel/curves` +* Remove `bytesToHex` and `hexToBytes`. They can now be found in `@xrplf/isomorphic/utils` +* `verifyTransaction` will throw an error if there is no signature +* Improved key algorithm detection. It will now throw Errors with helpful messages +* `Buffer` has been replaced with `UInt8Array` for both params and return values. `Buffer` may continue to work with params since they extend `UInt8Arrays`. + +### Non-Breaking Changes +* Remove `brorand` as a dependency and use `@xrplf/isomorphic` instead. +* Eliminates 4 runtime dependencies: `base-x`, `base64-js`, `buffer`, and `ieee754`. + ## 2.0.0 Beta 1 (2023-11-30) ### Breaking Changes diff --git a/packages/ripple-keypairs/package.json b/packages/ripple-keypairs/package.json index 5b9ca17546..f66e1287bd 100644 --- a/packages/ripple-keypairs/package.json +++ b/packages/ripple-keypairs/package.json @@ -1,6 +1,6 @@ { "name": "ripple-keypairs", - "version": "2.0.0-beta.1", + "version": "2.0.0", "description": "Cryptographic key pairs for the XRP Ledger", "scripts": { "build": "tsc --build tsconfig.build.json", @@ -20,8 +20,8 @@ }, "dependencies": { "@noble/curves": "^1.0.0", - "@xrplf/isomorphic": "^1.0.0-beta.1", - "ripple-address-codec": "^5.0.0-beta.1" + "@xrplf/isomorphic": "^1.0.0", + "ripple-address-codec": "^5.0.0" }, "keywords": [ "ripple", diff --git a/packages/secret-numbers/HISTORY.md b/packages/secret-numbers/HISTORY.md index 6462235c56..366bfbfc51 100644 --- a/packages/secret-numbers/HISTORY.md +++ b/packages/secret-numbers/HISTORY.md @@ -4,6 +4,22 @@ Subscribe to [the **xrpl-announce** mailing list](https://groups.google.com/g/xr ## Unreleased +## 1.0.0 (2024-02-01) + +### BREAKING CHANGES: +* `xrpl-secret-numbers` is now `@xrplf/secret-numbers`. +* The bundled file produced changed from `dist/browerified.js` to `build/xrplf-secret-numbers-latest.js`. +* Bundle variable is `xrplf_secret_numbers` instead of using browserify's loader. +* * Moved all methods that were on `Utils` are now individually exported. +* `Buffer` has been replaced with `UInt8Array` for both params and return values. `Buffer` may continue to work with params since they extend `UInt8Arrays`. + +### Non-Breaking Changes +* Add `xrpl-secret-numbers` by @WietseWind to the mono repo. +* `unpkg` and `jsdelivr` support was simplified. +* Unit tests run in a browser and node. +* Remove `brorand` as a dependency and use `@xrplf/isomorphic` instead. +* Eliminates 4 runtime dependencies: `base-x`, `base64-js`, `buffer`, and `ieee754`. + ## 1.0.0 Beta 1 (2023-11-30) ### BREAKING CHANGES: diff --git a/packages/secret-numbers/package.json b/packages/secret-numbers/package.json index 19ba5bd750..4eb6c0cfd6 100644 --- a/packages/secret-numbers/package.json +++ b/packages/secret-numbers/package.json @@ -1,6 +1,6 @@ { "name": "@xrplf/secret-numbers", - "version": "1.0.0-beta.1", + "version": "1.0.0", "description": "Generate XRPL Accounts with a number-based secret: 8 chunks of 6 digits", "main": "dist/index.js", "unpkg": "build/xrplf-secret-numbers-latest-min.js", @@ -29,8 +29,8 @@ "test": "test" }, "dependencies": { - "@xrplf/isomorphic": "^1.0.0-beta.1", - "ripple-keypairs": "^2.0.0-beta.1" + "@xrplf/isomorphic": "^1.0.0", + "ripple-keypairs": "^2.0.0" }, "prettier": "@xrplf/prettier-config", "repository": { diff --git a/packages/xrpl/HISTORY.md b/packages/xrpl/HISTORY.md index 7a0f237eae..6384c47679 100644 --- a/packages/xrpl/HISTORY.md +++ b/packages/xrpl/HISTORY.md @@ -4,6 +4,55 @@ Subscribe to [the **xrpl-announce** mailing list](https://groups.google.com/g/xr ## Unreleased +## 3.0.0 (2024-02-01) + +### BREAKING CHANGES +* Bump typescript to 5.x +* Remove Node 14 support +* Remove `crypto` polyfills, `create-hash`, `elliptic`, `hash.js`, and their many dependencies in favor of `@noble/hashes` and `@nobel/curves` +* Remove `bip32` and `bip39` in favor of `@scure/bip32` and `@scure/bip39` +* Remove `assert` dependency. If you were catching `AssertionError` you need to change to `Error` +* Configuring a proxy: + * Instead of passing various parameters on the `ConnectionsOptions` you know specify the `agent` parameter. This object can use be created by libraries such as `https-proxy-agent` or any that implements the `http.Agent`. + * This was changed to both support the latest `https-proxy-agent` and to remove the need to include the package in bundlers. Tests will still be done using `https-proxy-agent` and only tested in a node environment which was the only way it was previously supported anyway +* Remove `BroadcastClient` which was deprecated +* Uses `@xrplf/secret-numbers` instead of `xrpl-secret-numbers` +* Improve key algorithm detection. It will now throw Errors with helpful messages +* Move `authorizeChannel` from `wallet/signer` to `wallet/authorizeChannel` to solve a circular dependency issue. +* When using a bundler you must remove the mapping of `ws` to `WSWrapper`. ex. `ws: 'xrpl/dist/npm/client/WSWrapper'`. See [../UNIQUE_STEPS](Unique Steps) for the new, much smaller, configs. +* `Transaction` type has been redefined to include all transactions and `SubmittableTransaction` was created to define the old value. The following functions which only handle transactions to be submitted now use `SubmittableTransaction`: + * `Client.autofill` + * `Client.submit` + * `Client.submitAndWait` + * `Client.prepareTransaction` + * `getSignedTx` + * `isAccountDelete` +* `dropsToXRP` and `Client.getXrpBalance` now return a `number` instead of a `string` +* `Buffer` has been replaced with `UInt8Array` for both params and return values. `Buffer` may continue to work with params since they extend `UInt8Arrays`. + +### Bundling Changes +Bundler configurations are much more simplified. See [../UNIQUE_STEPS](Unique Steps) for the new, much smaller, configs. +* removed the following polyfills: + * `buffer` + * `assert` + * `crypto-browserify` + * `https-browserify` + * `os-browserify` + * `process` + * `stream-browserify` + * `stream-http` + * `url` + * `util` - previously added automatically by `webpack` + * `events` - previously added automatically by `webpack` but manual for `vite`** +* Removed mappings for: + * `ws` to `WsWrapper` + * Excluding `https-proxy-agent` + +### Non-Breaking Changes +* Deprecated: + * `convertHexToString` in favor of `@xrplf/isomorphic/utils`'s `hexToString` + * `convertStringToHex` in favor of `@xrplf/isomorphic/utils`'s `stringToHex` + ## 3.0.0 Beta 1 (2023-11-30) ### Breaking Changes @@ -24,6 +73,15 @@ Subscribe to [the **xrpl-announce** mailing list](https://groups.google.com/g/xr * Deprecated: * `convertHexToString` in favor of `@xrplf/isomorphic/utils`'s `hexToString` * `convertStringToHex` in favor of `@xrplf/isomorphic/utils`'s `stringToHex` +* Remove `lodash` as a dependency +* Remove many polyfills that were only used for testing in the browser +* Remove `util` from bundle by switching `inspect` to `JSON.stringify` +* Add type for metadata for specific transactions(`Payment`, `NFTokenMint`, `NFTokenCreateOffer`, `NFTokenAcceptOffer`, `NFTokenCancelOffer`) + +### Fixed +* Fixed Wallet.generate() ignoring the `algorithm` parameter (Only a problem once binary-codec fix for `derive_keypair` is added) +* Fixed Wallet.fromSeed() ignoring the `algorithm` parameter +* Added pseudo-transaction support to hash functions and response types ## 3.0.0 Beta 0 (2023-10-19) diff --git a/packages/xrpl/package.json b/packages/xrpl/package.json index 9a5d32b85d..5b466a7971 100644 --- a/packages/xrpl/package.json +++ b/packages/xrpl/package.json @@ -1,6 +1,6 @@ { "name": "xrpl", - "version": "3.0.0-beta.1", + "version": "3.0.0", "license": "ISC", "description": "A TypeScript/JavaScript API for interacting with the XRP Ledger in Node.js and the browser", "files": [ @@ -24,14 +24,14 @@ "dependencies": { "@scure/bip32": "^1.3.1", "@scure/bip39": "^1.2.1", - "@xrplf/isomorphic": "^1.0.0-beta.1", - "@xrplf/secret-numbers": "^1.0.0-beta.1", + "@xrplf/isomorphic": "^1.0.0", + "@xrplf/secret-numbers": "^1.0.0", "bignumber.js": "^9.0.0", "cross-fetch": "^4.0.0", "eventemitter3": "^5.0.1", - "ripple-address-codec": "^5.0.0-beta.1", - "ripple-binary-codec": "^2.0.0-beta.1", - "ripple-keypairs": "^2.0.0-beta.1" + "ripple-address-codec": "^5.0.0", + "ripple-binary-codec": "^2.0.0", + "ripple-keypairs": "^2.0.0" }, "devDependencies": { "@types/node": "^16.18.38",