diff --git a/.ci-config/rippled.cfg b/.ci-config/rippled.cfg index ab4418963a..41b6a97f53 100644 --- a/.ci-config/rippled.cfg +++ b/.ci-config/rippled.cfg @@ -164,3 +164,6 @@ F1ED6B4A411D8B872E65B9DCB4C8B100375B0DD3D62D07192E011D6D7F339013 fixTrustLinesTo 2E2FB9CF8A44EB80F4694D38AADAE9B8B7ADAFD2F092E10068E61C98C4F092B0 fixUniversalNumber 75A7E01C505DD5A179DFE3E000A9B6F1EDDEB55A12F95579A23E15B15DC8BE5A ImmediateOfferKilled 93E516234E35E08CA689FA33A6D38E103881F8DCB53023F728C307AA89D515A7 XRPFees +# 1.12.0-b1 Amendments +56B241D7A43D40354D02A9DC4C8DF5C7A1F930D92A9035C4E12291B3CA3E1C2B featureClawback +27CD95EE8E1E5A537FF2F89B6CEB7C622E78E9374EBD7DCBEDFAE21CD6F16E0A fixReducedOffersV1 diff --git a/.github/workflows/nodejs.yml b/.github/workflows/nodejs.yml index a2e57cdb40..070f796098 100644 --- a/.github/workflows/nodejs.yml +++ b/.github/workflows/nodejs.yml @@ -57,7 +57,7 @@ jobs: strategy: matrix: - node-version: [14.x, 16.x, 18.x, 20.x] + node-version: [16.x, 18.x, 20.x] steps: - uses: actions/checkout@v3 @@ -98,14 +98,14 @@ jobs: strategy: matrix: - node-version: [14.x, 16.x, 18.x, 20.x] + node-version: [16.x, 18.x, 20.x] steps: - uses: actions/checkout@v3 - name: Run docker in background run: | - docker run --detach --rm --name rippled-service -p 6006:6006 --volume "${{ github.workspace }}/.ci-config/":"/config/" --health-cmd="wget localhost:6006 || exit 1" --health-interval=5s --health-retries=10 --health-timeout=2s --env "ENV_ARGS=-a --start" --env GITHUB_ACTIONS=true --env CI=true xrpllabsofficial/xrpld:latest + docker run --detach --rm --name rippled-service -p 6006:6006 --volume "${{ github.workspace }}/.ci-config/":"/config/" --health-cmd="wget localhost:6006 || exit 1" --health-interval=5s --health-retries=10 --health-timeout=2s --env "ENV_ARGS=-a --start" --env GITHUB_ACTIONS=true --env CI=true xrpllabsofficial/xrpld:1.12.0-b1 - name: Use Node.js ${{ matrix.node-version }} uses: actions/setup-node@v3 @@ -162,7 +162,7 @@ jobs: - name: Run docker in background run: | - docker run --detach --rm --name rippled-service -p 6006:6006 --volume "${{ github.workspace }}/.ci-config/":"/config/" --health-cmd="wget localhost:6006 || exit 1" --health-interval=5s --health-retries=10 --health-timeout=2s --env "ENV_ARGS=-a --start" --env GITHUB_ACTIONS=true --env CI=true xrpllabsofficial/xrpld:latest + docker run --detach --rm --name rippled-service -p 6006:6006 --volume "${{ github.workspace }}/.ci-config/":"/config/" --health-cmd="wget localhost:6006 || exit 1" --health-interval=5s --health-retries=10 --health-timeout=2s --env "ENV_ARGS=-a --start" --env GITHUB_ACTIONS=true --env CI=true xrpllabsofficial/xrpld:1.12.0-b1 - name: Setup npm version 9 run: | @@ -202,7 +202,7 @@ jobs: strategy: matrix: - node-version: [14.x, 16.x, 18.x, 20.x] + node-version: [16.x, 18.x, 20.x] steps: - uses: actions/checkout@v3 diff --git a/.nvmrc b/.nvmrc index 958b5a36e1..6f7f377bf5 100644 --- a/.nvmrc +++ b/.nvmrc @@ -1 +1 @@ -v14 +v16 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 24c60464b9..28a4c444d0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -47,7 +47,7 @@ npm run lint ## Running Tests -For integration and browser tests, we use a `rippled` node in standalone mode to test xrpl.js code against. To set this up, you can either configure and run `rippled` locally, or set up the Docker container `xrpllabsofficial/xrpld:latest` by [following these instructions](#integration-tests). The latter will require you to [install Docker](https://docs.docker.com/get-docker/). +For integration and browser tests, we use a `rippled` node in standalone mode to test xrpl.js code against. To set this up, you can either configure and run `rippled` locally, or set up the Docker container `xrpllabsofficial/1.12.0-b1` by [following these instructions](#integration-tests). The latter will require you to [install Docker](https://docs.docker.com/get-docker/). ### Unit Tests @@ -64,7 +64,7 @@ From the top-level xrpl.js folder (one level above `packages`), run the followin ```bash npm install # sets up the rippled standalone Docker container - you can skip this step if you already have it set up -docker run -p 6006:6006 --interactive -t --volume $PWD/.ci-config:/config/ xrpllabsofficial/xrpld:latest -a --start +docker run -p 6006:6006 --interactive -t --volume $PWD/.ci-config:/config/ xrpllabsofficial/1.12.0-b1 -a --start npm run build npm run test:integration ``` @@ -74,7 +74,7 @@ Breaking down the command: * `--interactive` allows you to interact with the container. * `-t` starts a terminal in the container for you to send commands to. * `--volume $PWD/.ci-config:/config/` identifies the `rippled.cfg` and `validators.txt` to import. It must be an absolute path, so we use `$PWD` instead of `./`. -* `xrpllabsofficial/xrpld:latest` is an image that is regularly updated with the latest `rippled` releases and can be found here: https://github.com/WietseWind/docker-rippled +* `xrpllabsofficial/1.12.0-b1` is an image that is regularly updated with the latest `rippled` releases and can be found here: https://github.com/WietseWind/docker-rippled * `-a` starts `rippled` in standalone mode * `--start` signals to start `rippled` with the specified amendments in `rippled.cfg` enabled immediately instead of voting for 2 weeks on them. @@ -91,7 +91,7 @@ This should be run from the `xrpl.js` top level folder (one above the `packages` ```bash npm run build # sets up the rippled standalone Docker container - you can skip this step if you already have it set up -docker run -p 6006:6006 -it -v $PWD/.ci-config:/config/ xrpllabsofficial/xrpld:latest -a --start +docker run -p 6006:6006 -it -v $PWD/.ci-config:/config/ xrpllabsofficial/1.12.0-b1 -a --start npm run test:browser ``` diff --git a/README.md b/README.md index 34f3f0e278..ecf1f544d7 100644 --- a/README.md +++ b/README.md @@ -19,13 +19,13 @@ See the full reference documentation for all classes, methods, and utilities. 4. Subscribing to changes in the ledger ([Ex. ledger, transactions, & more...](https://xrpl.org/subscribe.html)) 5. Parsing ledger data into more convenient formats ([`xrpToDrops`](https://js.xrpl.org/functions/xrpToDrops.html) and [`rippleTimeToISOTime`](https://js.xrpl.org/functions/rippleTimeToISOTime.html)) -All of which works in Node.js (tested for v14+) & web browsers (tested for Chrome). +All of which works in Node.js (tested for v16+) & web browsers (tested for Chrome). # Quickstart ### Requirements -+ **[Node.js v16](https://nodejs.org/)** is recommended. We also support v14, v18 and v20. Other versions may work but are not frequently tested. ++ **[Node.js v16](https://nodejs.org/)** is recommended. We also support v18 and v20. Other versions may work but are not frequently tested. ### Installing xrpl.js diff --git a/docs/classes/BroadcastClient.html b/docs/classes/BroadcastClient.html index ea4df8c67b..bf2ce89628 100644 --- a/docs/classes/BroadcastClient.html +++ b/docs/classes/BroadcastClient.html @@ -39,7 +39,7 @@

Hierarchy

+
  • Defined in packages/xrpl/src/client/BroadcastClient.ts:18
    • @@ -136,7 +136,7 @@
    options: Returns BroadcastClient
    +
  • Defined in packages/xrpl/src/client/BroadcastClient.ts:28

    • Abstraction

    @@ -170,7 +170,7 @@
    Optional Returns Promise<{
        currency: string;
        issuer?: string;
        value: string;
    }[]>
    +
  • Defined in packages/xrpl/src/client/index.ts:690

    • getLedgerIndex

    getLedgerIndex: ((this) => Promise<number>) = getLedgerIndex
    @@ -189,7 +189,7 @@
    this: Returns Promise<number>
    +
  • Defined in packages/xrpl/src/client/index.ts:700

    • getOrderbook

    getOrderbook: ((this, currency1, currency2, options?) => Promise<{
        buy: BookOffer[];
        sell: BookOffer[];
    }>) = getOrderbook
    @@ -223,7 +223,7 @@
    Optional Returns Promise<{
        buy: BookOffer[];
        sell: BookOffer[];
    }>
    +
  • Defined in packages/xrpl/src/client/index.ts:695

    • getXrpBalance

    getXrpBalance: ((this, address, options?) => Promise<string>) = getXrpBalance
    @@ -251,7 +251,7 @@
    Optional Returns Promise<string>
    +
  • Defined in packages/xrpl/src/client/index.ts:685

    • Core

    @@ -281,7 +281,7 @@
    Optional Returns Promise<T>
    +
  • Defined in packages/xrpl/src/client/index.ts:666

    • submit

    submit: ((this, transaction, opts?) => Promise<SubmitResponse>) = submit
    @@ -311,7 +311,7 @@
    Optional Returns Promise<SubmitResponse>
    +
  • Defined in packages/xrpl/src/client/index.ts:671

    • submitAndWait

    submitAndWait: (<T>(this, transaction, opts?) => Promise<TxResponse<T>>) = submitAndWait
    @@ -346,7 +346,7 @@
    Optional Returns Promise<TxResponse<T>>
    +
  • Defined in packages/xrpl/src/client/index.ts:675

    • Faucet

    @@ -380,7 +380,7 @@
    Optional Returns Promise<{
        balance: number;
        wallet: Wallet;
    }>
    +
  • Defined in packages/xrpl/src/client/index.ts:705

    • Fee

    @@ -391,7 +391,7 @@

    Readonly

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

    • Readonly maxFeeXRP

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

    Readonly

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

    • Network

    @@ -414,7 +414,7 @@

    Returns string

    Inherited from Client.url

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

    • connect

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

    • disconnect

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

    • isConnected

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

    • on

  • Event handler for subscription streams.

    @@ -518,7 +518,7 @@

    Returns

    Inherited from Client.on

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

  • Event handler for subscription streams.

    @@ -547,7 +547,7 @@

    Returns

    Inherited from Client.on

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

  • Event handler for subscription streams.

    @@ -576,7 +576,7 @@

    Returns

    Inherited from Client.on

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

  • Event handler for subscription streams.

    @@ -605,7 +605,7 @@

    Returns

    Inherited from Client.on

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

  • Event handler for subscription streams.

    @@ -634,7 +634,7 @@

    Returns

    Inherited from Client.on

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

  • Event handler for subscription streams.

    @@ -663,7 +663,7 @@

    Returns

    Inherited from Client.on

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

  • Event handler for subscription streams.

    @@ -692,7 +692,7 @@

    Returns

    Inherited from Client.on

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

  • Event handler for subscription streams.

    @@ -721,7 +721,7 @@

    Returns

    Inherited from Client.on

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

  • Event handler for subscription streams.

    @@ -750,7 +750,7 @@

    Returns

    Inherited from Client.on

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

    • request

  • Makes a request to the client with the given command and @@ -779,7 +779,7 @@

    Returns Promise<

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

  • Makes a request to the client with the given command and @@ -794,7 +794,7 @@

    Returns Promise<

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

  • Makes a request to the client with the given command and @@ -809,7 +809,7 @@

    Returns Promise<

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

  • Makes a request to the client with the given command and @@ -824,7 +824,7 @@

    Returns Promise<

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

  • Makes a request to the client with the given command and @@ -839,7 +839,7 @@

    Returns Promise<

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

  • Makes a request to the client with the given command and @@ -854,7 +854,7 @@

    Returns Promise<

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

  • Makes a request to the client with the given command and @@ -869,7 +869,7 @@

    Returns Promise<

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

  • Makes a request to the client with the given command and @@ -884,7 +884,7 @@

    Returns Promise<

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

  • Makes a request to the client with the given command and @@ -899,7 +899,7 @@

    Returns Promise<

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

  • Makes a request to the client with the given command and @@ -914,7 +914,7 @@

    Returns Promise<

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

  • Makes a request to the client with the given command and @@ -929,7 +929,7 @@

    Returns Promise<

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

  • Makes a request to the client with the given command and @@ -944,7 +944,7 @@

    Returns Promise<

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

  • Makes a request to the client with the given command and @@ -959,7 +959,7 @@

    Returns Promise<

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

  • Makes a request to the client with the given command and @@ -974,7 +974,7 @@

    Returns Promise<

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

  • Makes a request to the client with the given command and @@ -989,7 +989,7 @@

    Returns Promise<

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

  • Makes a request to the client with the given command and @@ -1004,7 +1004,7 @@

    Returns Promise<

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

  • Makes a request to the client with the given command and @@ -1019,7 +1019,7 @@

    Returns Promise<

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

  • Makes a request to the client with the given command and @@ -1034,7 +1034,7 @@

    Returns Promise<

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

  • Makes a request to the client with the given command and @@ -1049,7 +1049,7 @@

    Returns Promise<

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

  • Makes a request to the client with the given command and @@ -1064,7 +1064,7 @@

    Returns Promise<

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

  • Makes a request to the client with the given command and @@ -1079,7 +1079,7 @@

    Returns Promise<

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

  • Makes a request to the client with the given command and @@ -1094,7 +1094,7 @@

    Returns Promise<

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

  • Makes a request to the client with the given command and @@ -1109,7 +1109,7 @@

    Returns Promise<

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

  • Makes a request to the client with the given command and @@ -1124,7 +1124,7 @@

    Returns Promise<

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

  • Makes a request to the client with the given command and @@ -1139,7 +1139,7 @@

    Returns Promise<

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

  • Makes a request to the client with the given command and @@ -1154,7 +1154,7 @@

    Returns Promise<

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

  • Makes a request to the client with the given command and @@ -1169,7 +1169,7 @@

    Returns Promise<

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

  • Makes a request to the client with the given command and @@ -1184,7 +1184,7 @@

    Returns Promise<

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

  • Makes a request to the client with the given command and @@ -1199,7 +1199,7 @@

    Returns Promise<

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

  • Makes a request to the client with the given command and @@ -1214,7 +1214,7 @@

    Returns Promise<

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

  • Makes a request to the client with the given command and @@ -1229,7 +1229,7 @@

    Returns Promise<

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

  • Makes a request to the client with the given command and @@ -1244,7 +1244,7 @@

    Returns Promise<

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

  • Makes a request to the client with the given command and @@ -1259,7 +1259,7 @@

    Returns Promise<

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

  • Makes a request to the client with the given command and @@ -1274,7 +1274,7 @@

    Returns Promise<

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

  • Makes a request to the client with the given command and @@ -1289,7 +1289,7 @@

    Returns Promise<

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

  • Makes a request to the client with the given command and @@ -1311,7 +1311,7 @@

    Returns Promise<

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

    • requestAll

  • Makes multiple paged requests to the client to return a given number of @@ -1349,7 +1349,7 @@

    Returns Promise<

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

  • Makes multiple paged requests to the client to return a given number of @@ -1373,7 +1373,7 @@

    Returns Promise<

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

  • Makes multiple paged requests to the client to return a given number of @@ -1397,7 +1397,7 @@

    Returns Promise<

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

  • Makes multiple paged requests to the client to return a given number of @@ -1421,7 +1421,7 @@

    Returns Promise<

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

  • Makes multiple paged requests to the client to return a given number of @@ -1445,7 +1445,7 @@

    Returns Promise<

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

  • Makes multiple paged requests to the client to return a given number of @@ -1469,7 +1469,7 @@

    Returns Promise<

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

    • requestNextPage

  • Requests the next page of data.

    @@ -1505,7 +1505,7 @@

    Returns Promise<

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

  • Requests the next page of data.

    @@ -1525,7 +1525,7 @@

    Returns Promise<

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

  • Requests the next page of data.

    @@ -1545,7 +1545,7 @@

    Returns Promise<

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

  • Requests the next page of data.

    @@ -1565,7 +1565,7 @@

    Returns Promise<

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

  • Requests the next page of data.

    @@ -1585,7 +1585,7 @@

    Returns Promise<

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

    • Other

    @@ -1595,18 +1595,18 @@

    buildVersion

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

    • Private Readonly clients

    clients: Client[]
    +
  • Defined in packages/xrpl/src/client/BroadcastClient.ts:19

    • Readonly connection

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

    • networkID

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

    networkID

    Inherited from Client.networkID

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

    • prepareTransaction

    prepareTransaction: (<T>(this, transaction, signersCount?) => Promise<T>) = autofill
    @@ -1645,7 +1645,7 @@
    Optional Returns Promise<T>
    +
  • Defined in packages/xrpl/src/client/index.ts:680

    • Static Readonly captureRejectionSymbol

    captureRejectionSymbol: typeof captureRejectionSymbol
    +
  • Defined in packages/xrpl/src/client/BroadcastClient.ts:66

    • getServerInfo

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

    • listenerCount

    +
  • Defined in packages/xrpl/src/client/index.ts:186
    • @@ -128,7 +128,7 @@
    options: Returns Client
    +
  • Defined in packages/xrpl/src/client/index.ts:228

    • Abstraction

    @@ -161,7 +161,7 @@
    Optional Optional peer?: string

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

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

    • getLedgerIndex

    getLedgerIndex: ((this) => Promise<number>) = getLedgerIndex
    @@ -179,7 +179,7 @@

    Parameters

    this: Client

    Returns Promise<number>

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

    • getOrderbook

    getOrderbook: ((this, currency1, currency2, options?) => Promise<{
        buy: BookOffer[];
        sell: BookOffer[];
    }>) = getOrderbook
    @@ -212,7 +212,7 @@
    Optional Optional taker?: null | string

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

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

    • getXrpBalance

    getXrpBalance: ((this, address, options?) => Promise<string>) = getXrpBalance
    @@ -239,7 +239,7 @@
    Optional Optional ledger_index?: LedgerIndex

    Returns Promise<string>

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

    • Core

    @@ -268,7 +268,7 @@
    transaction: Optional signersCount: number

    Returns Promise<T>

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

    • submit

    submit: ((this, transaction, opts?) => Promise<SubmitResponse>) = submit
    @@ -297,7 +297,7 @@
    Optional Optional wallet?: Wallet

    Returns Promise<SubmitResponse>

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

    • submitAndWait

    submitAndWait: (<T>(this, transaction, opts?) => Promise<TxResponse<T>>) = submitAndWait
    @@ -331,7 +331,7 @@
    Optional Optional wallet?: Wallet

    Returns Promise<TxResponse<T>>

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

    • Faucet

    @@ -364,7 +364,7 @@
    Optional Optional usageContext?: string

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

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

    • Fee

    @@ -374,7 +374,7 @@

    Readonly

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

    • Readonly maxFeeXRP

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

    Readonly

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

    • Network

    @@ -395,7 +395,7 @@

    urlReturns string

    The URL of the server this client is connected to.

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

    • connect

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

    • disconnect

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

    • isConnected

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

    • on

  • Event handler for subscription streams.

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

    Returns

    Overrides EventEmitter.on

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

  • Event handler for subscription streams.

    @@ -525,7 +525,7 @@

    Returns

    Overrides EventEmitter.on

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

  • Event handler for subscription streams.

    @@ -554,7 +554,7 @@

    Returns

    Overrides EventEmitter.on

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

  • Event handler for subscription streams.

    @@ -583,7 +583,7 @@

    Returns

    Overrides EventEmitter.on

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

  • Event handler for subscription streams.

    @@ -612,7 +612,7 @@

    Returns

    Overrides EventEmitter.on

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

  • Event handler for subscription streams.

    @@ -641,7 +641,7 @@

    Returns

    Overrides EventEmitter.on

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

  • Event handler for subscription streams.

    @@ -670,7 +670,7 @@

    Returns

    Overrides EventEmitter.on

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

  • Event handler for subscription streams.

    @@ -699,7 +699,7 @@

    Returns

    Overrides EventEmitter.on

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

  • Event handler for subscription streams.

    @@ -728,7 +728,7 @@

    Returns

    Overrides EventEmitter.on

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

    • request

    Returns Promise<AccountChannelsResponse>

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

  • Makes a request to the client with the given command and @@ -755,7 +755,7 @@

    r: Returns Promise<AccountCurrenciesResponse>

    The response from the server.

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

  • Makes a request to the client with the given command and @@ -769,7 +769,7 @@

    r: Returns Promise<AccountInfoResponse>

    The response from the server.

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

  • Makes a request to the client with the given command and @@ -783,7 +783,7 @@

    r: Returns Promise<AccountLinesResponse>

    The response from the server.

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

  • Makes a request to the client with the given command and @@ -797,7 +797,7 @@

    r: Returns Promise<AccountNFTsResponse>

    The response from the server.

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

  • Makes a request to the client with the given command and @@ -811,7 +811,7 @@

    r: Returns Promise<AccountObjectsResponse>

    The response from the server.

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

  • Makes a request to the client with the given command and @@ -825,7 +825,7 @@

    r: Returns Promise<AccountOffersResponse>

    The response from the server.

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

  • Makes a request to the client with the given command and @@ -839,7 +839,7 @@

    r: Returns Promise<AccountTxResponse>

    The response from the server.

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

  • Makes a request to the client with the given command and @@ -853,7 +853,7 @@

    r: Returns Promise<BookOffersResponse>

    The response from the server.

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

  • Makes a request to the client with the given command and @@ -867,7 +867,7 @@

    r: Returns Promise<ChannelVerifyResponse>

    The response from the server.

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

  • Makes a request to the client with the given command and @@ -881,7 +881,7 @@

    r: Returns Promise<DepositAuthorizedResponse>

    The response from the server.

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

  • Makes a request to the client with the given command and @@ -895,7 +895,7 @@

    r: Returns Promise<FeeResponse>

    The response from the server.

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

  • Makes a request to the client with the given command and @@ -909,7 +909,7 @@

    r: Returns Promise<GatewayBalancesResponse>

    The response from the server.

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

  • Makes a request to the client with the given command and @@ -923,7 +923,7 @@

    r: Returns Promise<LedgerResponse>

    The response from the server.

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

  • Makes a request to the client with the given command and @@ -937,7 +937,7 @@

    r: Returns Promise<LedgerClosedResponse>

    The response from the server.

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

  • Makes a request to the client with the given command and @@ -951,7 +951,7 @@

    r: Returns Promise<LedgerCurrentResponse>

    The response from the server.

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

  • Makes a request to the client with the given command and @@ -965,7 +965,7 @@

    r: Returns Promise<LedgerDataResponse>

    The response from the server.

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

  • Makes a request to the client with the given command and @@ -979,7 +979,7 @@

    r: Returns Promise<LedgerEntryResponse>

    The response from the server.

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

  • Makes a request to the client with the given command and @@ -993,7 +993,7 @@

    r: Returns Promise<ManifestResponse>

    The response from the server.

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

  • Makes a request to the client with the given command and @@ -1007,7 +1007,7 @@

    r: Returns Promise<NFTBuyOffersResponse>

    The response from the server.

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

  • Makes a request to the client with the given command and @@ -1021,7 +1021,7 @@

    r: Returns Promise<NFTSellOffersResponse>

    The response from the server.

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

  • Makes a request to the client with the given command and @@ -1035,7 +1035,7 @@

    r: Returns Promise<NFTInfoResponse>

    The response from the server.

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

  • Makes a request to the client with the given command and @@ -1049,7 +1049,7 @@

    r: Returns Promise<NFTHistoryResponse>

    The response from the server.

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

  • Makes a request to the client with the given command and @@ -1063,7 +1063,7 @@

    r: Returns Promise<NoRippleCheckResponse>

    The response from the server.

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

  • Makes a request to the client with the given command and @@ -1077,7 +1077,7 @@

    r: Returns Promise<PathFindResponse>

    The response from the server.

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

  • Makes a request to the client with the given command and @@ -1091,7 +1091,7 @@

    r: Returns Promise<PingResponse>

    The response from the server.

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

  • Makes a request to the client with the given command and @@ -1105,7 +1105,7 @@

    r: Returns Promise<RandomResponse>

    The response from the server.

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

  • Makes a request to the client with the given command and @@ -1119,7 +1119,7 @@

    r: Returns Promise<RipplePathFindResponse>

    The response from the server.

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

  • Makes a request to the client with the given command and @@ -1133,7 +1133,7 @@

    r: Returns Promise<ServerInfoResponse>

    The response from the server.

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

  • Makes a request to the client with the given command and @@ -1147,7 +1147,7 @@

    r: Returns Promise<ServerStateResponse>

    The response from the server.

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

  • Makes a request to the client with the given command and @@ -1161,7 +1161,7 @@

    r: Returns Promise<SubmitResponse>

    The response from the server.

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

  • Makes a request to the client with the given command and @@ -1175,7 +1175,7 @@

    r: Returns Promise<SubmitMultisignedResponse>

    The response from the server.

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

  • Makes a request to the client with the given command and @@ -1189,7 +1189,7 @@

    r: Returns Promise<SubscribeResponse>

    The response from the server.

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

  • Makes a request to the client with the given command and @@ -1203,7 +1203,7 @@

    r: Returns Promise<UnsubscribeResponse>

    The response from the server.

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

  • Makes a request to the client with the given command and @@ -1217,7 +1217,7 @@

    r: Returns Promise<TransactionEntryResponse>

    The response from the server.

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

  • Makes a request to the client with the given command and @@ -1231,7 +1231,7 @@

    r: Returns Promise<TxResponse<Transaction>>

    The response from the server.

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

  • Makes a request to the client with the given command and @@ -1252,7 +1252,7 @@

    r: Returns Promise<T>

    The response from the server.

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

    • requestAll

    Returns Promise<AccountChannelsResponse[]>

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

  • Makes multiple paged requests to the client to return a given number of @@ -1288,7 +1288,7 @@

    req: Returns Promise<AccountLinesResponse[]>

    The array of all responses.

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

  • Makes multiple paged requests to the client to return a given number of @@ -1311,7 +1311,7 @@

    req: Returns Promise<AccountObjectsResponse[]>

    The array of all responses.

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

  • Makes multiple paged requests to the client to return a given number of @@ -1334,7 +1334,7 @@

    req: Returns Promise<AccountOffersResponse[]>

    The array of all responses.

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

  • Makes multiple paged requests to the client to return a given number of @@ -1357,7 +1357,7 @@

    req: Returns Promise<AccountTxResponse[]>

    The array of all responses.

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

  • Makes multiple paged requests to the client to return a given number of @@ -1380,7 +1380,7 @@

    req: Returns Promise<BookOffersResponse[]>

    The array of all responses.

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

  • Makes multiple paged requests to the client to return a given number of @@ -1403,7 +1403,7 @@

    req: Returns Promise<LedgerDataResponse[]>

    The array of all responses.

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

    • requestNextPage

    Returns Promise<AccountChannelsResponse>

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

  • Requests the next page of data.

    @@ -1437,7 +1437,7 @@
    resp: Returns Promise<AccountLinesResponse>

    The response with the next page of data.

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

  • Requests the next page of data.

    @@ -1456,7 +1456,7 @@
    resp: Returns Promise<AccountObjectsResponse>

    The response with the next page of data.

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

  • Requests the next page of data.

    @@ -1475,7 +1475,7 @@
    resp: Returns Promise<AccountOffersResponse>

    The response with the next page of data.

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

  • Requests the next page of data.

    @@ -1494,7 +1494,7 @@
    resp: Returns Promise<AccountTxResponse>

    The response with the next page of data.

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

  • Requests the next page of data.

    @@ -1513,7 +1513,7 @@
    resp: Returns Promise<LedgerDataResponse>

    The response with the next page of data.

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

    • Other

    @@ -1522,19 +1522,19 @@

    buildVersion

    Rippled Version used by the server this client is connected to

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

    • Readonly connection

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

    • networkID

    networkID: undefined | number

    Network ID of the server this client is connected to

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

    • prepareTransaction

    prepareTransaction: (<T>(this, transaction, signersCount?) => Promise<T>) = autofill
    @@ -1564,7 +1564,7 @@
    transaction: Optional signersCount: number

    Returns Promise<T>

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

    • Static Readonly captureRejectionSymbol

    captureRejectionSymbol: typeof captureRejectionSymbol
    +
  • Defined in packages/xrpl/src/client/index.ts:586

    • listenerCount

    +
  • Defined in packages/xrpl/src/errors.ts:78
    • @@ -85,7 +85,7 @@
    Optional Returns ConnectionError
    +
  • Defined in packages/xrpl/src/errors.ts:21

    • Properties

    @@ -93,19 +93,19 @@

    Optionaldata?: unknown

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

    • Readonly message

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

    • Readonly name

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

    • Optional stack

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

    • toString

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

    • Static captureStackTrace

    +
  • Defined in packages/xrpl/src/errors.ts:92
    • @@ -79,7 +79,7 @@
    Optional Returns DisconnectedError
    +
  • Defined in packages/xrpl/src/errors.ts:21

    • Properties

    @@ -87,19 +87,19 @@

    Optionaldata?: unknown

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

    • Readonly message

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

    • Readonly name

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

    • Optional stack

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

    • toString

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

    • Static captureStackTrace

    +
  • Defined in packages/xrpl/src/errors.ts:85
    • @@ -79,7 +79,7 @@
    Optional Returns NotConnectedError
    +
  • Defined in packages/xrpl/src/errors.ts:21

    • Properties

    @@ -87,19 +87,19 @@

    Optionaldata?: unknown

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

    • Readonly message

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

    • Readonly name

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

    • Optional stack

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

    • toString

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

    • Static captureStackTrace

    +
  • Defined in packages/xrpl/src/errors.ts:137
    • @@ -76,7 +76,7 @@
    message: Returns NotFoundError
    +
  • Defined in packages/xrpl/src/errors.ts:143

    • Properties

    @@ -84,19 +84,19 @@

    Optionaldata?: unknown

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

    • Readonly message

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

    • Readonly name

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

    • Optional stack

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

    • toString

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

    • Static captureStackTrace

    +
  • Defined in packages/xrpl/src/errors.ts:113
    • @@ -79,7 +79,7 @@
    Optional Returns ResponseFormatError
    +
  • Defined in packages/xrpl/src/errors.ts:21

    • Properties

    @@ -87,19 +87,19 @@

    Optionaldata?: unknown

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

    • Readonly message

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

    • Readonly name

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

    • Optional stack

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

    • toString

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

    • Static captureStackTrace

    +
  • Defined in packages/xrpl/src/errors.ts:64
    • @@ -79,7 +79,7 @@
    Optional Returns RippledError
    +
  • Defined in packages/xrpl/src/errors.ts:21

    • Properties

    @@ -87,19 +87,19 @@

    Optionaldata?: unknown

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

    • Readonly message

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

    • Readonly name

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

    • Optional stack

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

    • toString

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

    • Static captureStackTrace

    +
  • Defined in packages/xrpl/src/errors.ts:99
    • @@ -79,7 +79,7 @@
    Optional Returns RippledNotInitializedError
    +
  • Defined in packages/xrpl/src/errors.ts:21

    • Properties

    @@ -87,19 +87,19 @@

    Optionaldata?: unknown

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

    • Readonly message

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

    • Readonly name

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

    • Optional stack

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

    • toString

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

    • Static captureStackTrace

    +
  • Defined in packages/xrpl/src/errors.ts:106
    • @@ -79,7 +79,7 @@
    Optional Returns TimeoutError
    +
  • Defined in packages/xrpl/src/errors.ts:21

    • Properties

    @@ -87,19 +87,19 @@

    Optionaldata?: unknown

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

    • Readonly message

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

    • Readonly name

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

    • Optional stack

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

    • toString

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

    • Static captureStackTrace

    +
  • Defined in packages/xrpl/src/errors.ts:71
    • @@ -79,7 +79,7 @@
    Optional Returns UnexpectedError
    +
  • Defined in packages/xrpl/src/errors.ts:21

    • Properties

    @@ -87,19 +87,19 @@

    Optionaldata?: unknown

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

    • Readonly message

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

    • Readonly name

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

    • Optional stack

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

    • toString

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

    • Static captureStackTrace

    +
  • Defined in packages/xrpl/src/errors.ts:120
    • @@ -79,7 +79,7 @@
    Optional Returns ValidationError
    +
  • Defined in packages/xrpl/src/errors.ts:21

    • Properties

    @@ -87,19 +87,19 @@

    Optionaldata?: unknown

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

    • Readonly message

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

    • Readonly name

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

    • Optional stack

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

    • toString

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

    • Static captureStackTrace

    +
  • Defined in packages/xrpl/src/Wallet/index.ts:79
    • @@ -103,29 +103,29 @@
    Optional Returns Wallet
    +
  • Defined in packages/xrpl/src/Wallet/index.ts:94

    • Properties

    Readonly classicAddress

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

    • Readonly privateKey

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

    • Readonly publicKey

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

    • Optional Readonly seed

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

    • Static fromSecret

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

    A Wallet derived from a secret (AKA a seed).

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

    • Accessors

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

    addressReturns string

    The wallet's classic address.

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

    • Methods

    @@ -196,7 +196,7 @@
    isTestnet: Returns string

    An X-address.

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

    • sign

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

    • verifyTransaction

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

    • Static Private deriveWallet

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

    • Static fromEntropy

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

    • Static fromMnemonic

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

    • Static Private fromRFC1751Mnemonic

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

    • Static fromSeed

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

    • Static generate

    +
  • Defined in packages/xrpl/src/Wallet/index.ts:135
    • @@ -741,6 +741,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -754,8 +757,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -793,7 +794,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/classes/XRPLFaucetError.html b/docs/classes/XRPLFaucetError.html index 2edb43bd33..81bd2645b0 100644 --- a/docs/classes/XRPLFaucetError.html +++ b/docs/classes/XRPLFaucetError.html @@ -33,7 +33,7 @@

    Hierarchy

    • XRPLFaucetError
    +
  • Defined in packages/xrpl/src/errors.ts:129
    • @@ -81,7 +81,7 @@
    Optional Returns XRPLFaucetError
    +
  • Defined in packages/xrpl/src/errors.ts:21

    • Properties

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

    Optionaldata?: unknown

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

    • Readonly message

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

    • Readonly name

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

    • Optional stack

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

    • toString

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

    • Static captureStackTrace

    +
  • Defined in packages/xrpl/src/errors.ts:10
    • @@ -87,26 +87,26 @@
    Optional Returns XrplError
    +
  • Defined in packages/xrpl/src/errors.ts:21

    • Properties

    Optional Readonly data

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

    • Readonly message

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

    • Readonly name

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

    • Optional stack

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

    • toString

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

    • Static captureStackTrace

    Enum for AccountSet Flags.

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:14
    • @@ -57,28 +57,28 @@

    asfAccountTxnID

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

    • asfAuthorizedNFTokenMinter

    asfAuthorizedNFTokenMinter: 10

    Allow another account to mint and burn tokens on behalf of this account.

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

    • asfDefaultRipple

    asfDefaultRipple: 8

    Enable rippling on this account's trust lines by default.

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

    • asfDepositAuth

    asfDepositAuth: 9

    Enable Deposit Authorization on this account.

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

    • asfDisableMaster

    asfDisableMaster: 4
    @@ -87,49 +87,49 @@

    asfDisableMaster

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

    • asfDisallowIncomingCheck

    asfDisallowIncomingCheck: 13

    Disallow other accounts from creating incoming Checks

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

    • asfDisallowIncomingNFTokenOffer

    asfDisallowIncomingNFTokenOffer: 12

    Disallow other accounts from creating incoming NFTOffers

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

    • asfDisallowIncomingPayChan

    asfDisallowIncomingPayChan: 14

    Disallow other accounts from creating incoming PayChannels

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

    • asfDisallowIncomingTrustline

    asfDisallowIncomingTrustline: 15

    Disallow other accounts from creating incoming Trustlines

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

    • asfDisallowXRP

    asfDisallowXRP: 3

    XRP should not be sent to this account.

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

    • asfGlobalFreeze

    asfGlobalFreeze: 7

    Freeze all assets issued by this account.

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

    • asfNoFreeze

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

    asfNoFreeze

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

    • asfRequireAuth

    asfRequireAuth: 2
    @@ -145,14 +145,14 @@

    asfRequireAuth

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

    • asfRequireDest

    asfRequireDest: 1

    Require a destination tag to send transactions to this account.

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:16
    • @@ -429,6 +429,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -442,8 +445,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -481,7 +482,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/enums/AccountSetTfFlags.html b/docs/enums/AccountSetTfFlags.html index 3da4ac6e39..0124848d6b 100644 --- a/docs/enums/AccountSetTfFlags.html +++ b/docs/enums/AccountSetTfFlags.html @@ -25,7 +25,7 @@

    Enumeration AccountSetTfFlags

    Enum for AccountSet Transaction Flags.

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:66
    • @@ -48,42 +48,42 @@

    tfAllowXRP

    The same as ClearFlag: asfDisallowXRP.

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

    • tfDisallowXRP

    tfDisallowXRP: 1048576

    The same as SetFlag: asfDisallowXRP.

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

    • tfOptionalAuth

    tfOptionalAuth: 524288

    The same as ClearFlag: asfRequireAuth.

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

    • tfOptionalDestTag

    tfOptionalDestTag: 131072

    The same as ClearFlag: asfRequireDest.

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

    • tfRequireAuth

    tfRequireAuth: 262144

    The same as SetFlag: asfRequireAuth.

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

    • tfRequireDestTag

    tfRequireDestTag: 65536

    The same as SetFlag: asfRequireDest.

    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:68
    • @@ -352,6 +352,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -365,8 +368,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -404,7 +405,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/enums/ECDSA.html b/docs/enums/ECDSA.html index 7e63deb004..b768bea016 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
    • @@ -309,6 +309,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -322,8 +325,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -361,7 +362,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/enums/EnableAmendmentFlags.html b/docs/enums/EnableAmendmentFlags.html index 70ae4da5e5..b0464e476c 100644 --- a/docs/enums/EnableAmendmentFlags.html +++ b/docs/enums/EnableAmendmentFlags.html @@ -25,7 +25,7 @@

    Enumeration EnableAmendmentFlags

    Transaction Flags for an EnableAmendment Transaction.

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

    tfGotMajority

    Support for this amendment increased to at least 80% of trusted validators starting with this ledger version.

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

    • tfLostMajority

    tfLostMajority: 131072

    Support for this amendment decreased to less than 80% of trusted validators starting with this ledger version.

    +
  • Defined in packages/xrpl/src/models/transactions/enableAmendment.ts:12
    • @@ -316,6 +316,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -329,8 +332,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -368,7 +369,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/enums/LedgerEntry.AccountRootFlags.html b/docs/enums/LedgerEntry.AccountRootFlags.html index 8a5b80d0af..eab0cf8601 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:147
    • @@ -53,7 +53,7 @@

    lsfDefaultRipple

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

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

    • lsfDepositAuth

    lsfDepositAuth: 16777216
    @@ -61,84 +61,84 @@

    lsfDepositAuth

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

    • lsfDisableMaster

    lsfDisableMaster: 1048576

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

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

    • lsfDisallowIncomingCheck

    lsfDisallowIncomingCheck: 134217728

    Disallow incoming Checks from other accounts.

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

    • lsfDisallowIncomingNFTokenOffer

    lsfDisallowIncomingNFTokenOffer: 67108864

    Disallow incoming NFTOffers from other accounts.

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

    • lsfDisallowIncomingPayChan

    lsfDisallowIncomingPayChan: 268435456

    Disallow incoming PayChannels from other accounts.

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

    • lsfDisallowIncomingTrustline

    lsfDisallowIncomingTrustline: 536870912

    Disallow incoming Trustlines from other accounts.

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

    • lsfDisallowXRP

    lsfDisallowXRP: 524288

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

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

    • lsfGlobalFreeze

    lsfGlobalFreeze: 4194304

    All assets issued by this address are frozen.

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

    • lsfNoFreeze

    lsfNoFreeze: 2097152

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

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

    • lsfPasswordSpent

    lsfPasswordSpent: 65536

    The account has used its free SetRegularKey transaction.

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

    • lsfRequireAuth

    lsfRequireAuth: 262144

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

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

    • lsfRequireDestTag

    lsfRequireDestTag: 131072

    Requires incoming payments to specify a Destination Tag.

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:155
    • @@ -414,6 +414,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -427,8 +430,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -466,7 +467,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/enums/LedgerEntry.OfferFlags.html b/docs/enums/LedgerEntry.OfferFlags.html index 90ea1cc982..d3218a9d2c 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:49
    • @@ -40,12 +40,12 @@

    Enumeration Members

    lsfPassive

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

    • lsfSell

    lsfSell: 131072
    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:51
    • @@ -310,6 +310,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -323,8 +326,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -362,7 +363,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/enums/LedgerEntry.RippleStateFlags.html b/docs/enums/LedgerEntry.RippleStateFlags.html index 3c2572b104..71bd3a6521 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:76
    • @@ -46,42 +46,42 @@

    Enumeration Members

    lsfHighAuth

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

    • lsfHighFreeze

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

    • lsfHighNoRipple

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

    • lsfHighReserve

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

    • lsfLowAuth

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

    • lsfLowFreeze

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

    • lsfLowNoRipple

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

    • lsfLowReserve

    lsfLowReserve: 65536
    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:78
    • @@ -352,6 +352,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -365,8 +368,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -404,7 +405,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/enums/LedgerEntry.SignerListFlags.html b/docs/enums/LedgerEntry.SignerListFlags.html index 8d5354c87d..b3710deafa 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:53
    • @@ -39,7 +39,7 @@

    Enumeration Members

    lsfOneOwnerCount

    lsfOneOwnerCount: 65536
    +
  • Defined in packages/xrpl/src/models/ledger/SignerList.ts:55
    • @@ -303,6 +303,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -316,8 +319,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -355,7 +356,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/enums/NFTokenCreateOfferFlags.html b/docs/enums/NFTokenCreateOfferFlags.html index 8087ca0ce4..6035293ece 100644 --- a/docs/enums/NFTokenCreateOfferFlags.html +++ b/docs/enums/NFTokenCreateOfferFlags.html @@ -25,7 +25,7 @@

    Enumeration NFTokenCreateOfferFlags

    Transaction Flags for an NFTokenCreateOffer Transaction.

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

    tfSellNFToken

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:23
    • @@ -308,6 +308,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -321,8 +324,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -360,7 +361,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/enums/NFTokenMintFlags.html b/docs/enums/NFTokenMintFlags.html index e787a1c736..75a10e456d 100644 --- a/docs/enums/NFTokenMintFlags.html +++ b/docs/enums/NFTokenMintFlags.html @@ -25,7 +25,7 @@

    Enumeration NFTokenMintFlags

    Transaction Flags for an NFTokenMint Transaction.

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:11
    • @@ -48,14 +48,14 @@

    tfBurnable

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

    • tfOnlyXRP

    tfOnlyXRP: 2

    If set, indicates that the token may only be offered or sold for XRP.

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

    • tfTransferable

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

    tfTransferable

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

    • tfTrustLine

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

    tfTrustLine

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:26
    • @@ -339,6 +339,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -352,8 +355,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -391,7 +392,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/enums/OfferCreateFlags.html b/docs/enums/OfferCreateFlags.html index d0e7d023fe..b75ce7fa6e 100644 --- a/docs/enums/OfferCreateFlags.html +++ b/docs/enums/OfferCreateFlags.html @@ -25,7 +25,7 @@

    Enumeration OfferCreateFlags

    Transaction Flags for an OfferCreate Transaction.

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

    tfFillOrKill

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

    • tfImmediateOrCancel

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

    tfImmediateOrCancel

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

    • tfPassive

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

    tfPassive

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

    • tfSell

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

    tfSell

    +
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:45
    • @@ -346,6 +346,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -359,8 +362,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -398,7 +399,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/enums/PaymentChannelClaimFlags.html b/docs/enums/PaymentChannelClaimFlags.html index 82425753a9..69353d90ff 100644 --- a/docs/enums/PaymentChannelClaimFlags.html +++ b/docs/enums/PaymentChannelClaimFlags.html @@ -25,7 +25,7 @@

    Enumeration PaymentChannelClaimFlags

    Enum representing values for PaymentChannelClaim transaction flags.

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

    tfClose

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

    • tfRenew

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

    tfRenew

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:17
    • @@ -328,6 +328,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -341,8 +344,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -380,7 +381,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/enums/PaymentFlags.html b/docs/enums/PaymentFlags.html index 354e74d0d8..87f2cec896 100644 --- a/docs/enums/PaymentFlags.html +++ b/docs/enums/PaymentFlags.html @@ -25,7 +25,7 @@

    Enumeration PaymentFlags

    Enum representing values for Payment Transaction Flags.

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

    tfLimitQuality

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

    • tfNoDirectRipple

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

    tfNoDirectRipple

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

    • tfPartialPayment

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

    tfPartialPayment

    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:30
    • @@ -331,6 +331,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -344,8 +347,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -383,7 +384,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/enums/TrustSetFlags.html b/docs/enums/TrustSetFlags.html index 27bce6ebf4..486832a4e7 100644 --- a/docs/enums/TrustSetFlags.html +++ b/docs/enums/TrustSetFlags.html @@ -25,7 +25,7 @@

    Enumeration TrustSetFlags

    Enum representing values of TrustSet transaction flags.

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

    tfClearFreeze

    Unfreeze the trust line.

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

    • tfClearNoRipple

    tfClearNoRipple: 262144

    Disable the No Ripple flag, allowing rippling on this trust line.

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

    • tfSetFreeze

    tfSetFreeze: 1048576

    Freeze the trust line.

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

    • tfSetNoRipple

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

    tfSetNoRipple

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

    • tfSetfAuth

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

    tfSetfAuth

    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:21
    • @@ -345,6 +345,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -358,8 +361,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -397,7 +398,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/functions/authorizeChannel.html b/docs/functions/authorizeChannel.html index 2774f47060..f16b5cc963 100644 --- a/docs/functions/authorizeChannel.html +++ b/docs/functions/authorizeChannel.html @@ -45,7 +45,7 @@

    amount: Returns string

    A signature that can be used to redeem a specific amount of XRP from a payment channel.

    +
  • Defined in packages/xrpl/src/Wallet/signer.ts:74
    • @@ -304,6 +304,9 @@

    Theme

    +
  • Defined in packages/xrpl/src/utils/stringConversion.ts:20
    • @@ -300,6 +300,9 @@

    Theme

    +
  • Defined in packages/xrpl/src/utils/quality.ts:79
    • @@ -300,6 +300,9 @@

    Theme

    +
  • Defined in packages/xrpl/src/utils/index.ts:125
    • @@ -296,6 +296,9 @@

    Theme

      - +

    • Parameters

      @@ -39,12 +39,12 @@
      expectedLengthversionTypes: ["ed25519", "secp256k1"]
    • versions: (number | number[])[]
    -

    Returns {
        bytes: Buffer;
        type: "ed25519" | "secp256k1" | null;
        version: number[];
    }

    +

    Returns {
        bytes: Buffer;
        type: string | null;
        version: number[];
    }

    • bytes: Buffer
    • -
      type: "ed25519" | "secp256k1" | null
      • +
      type: string | null
    • version: number[]
    +
  • Defined in packages/xrpl/src/utils/derive.ts:14
    • @@ -309,6 +309,9 @@

    Theme

    +
  • Defined in packages/xrpl/src/utils/index.ts:84
    • @@ -296,6 +296,9 @@

    Theme

    +
  • Defined in packages/xrpl/src/utils/index.ts:94
    • @@ -296,6 +296,9 @@

    Theme

    +
  • Defined in packages/xrpl/src/utils/getNFTokenID.ts:36
    • @@ -298,6 +298,9 @@

    Theme

    +
  • Defined in packages/xrpl/src/models/transactions/metadata.ts:38
    • @@ -296,6 +296,9 @@

    Theme

    +
  • Defined in packages/xrpl/src/models/transactions/metadata.ts:48
    • @@ -296,6 +296,9 @@

    Theme

    +
  • Defined in packages/xrpl/src/Wallet/rfc1751.ts:60
    • @@ -296,6 +296,9 @@

    Theme

    +
  • Defined in packages/xrpl/src/models/utils/flags.ts:34
    • @@ -296,6 +296,9 @@

    Theme

    +
  • Defined in packages/xrpl/src/utils/quality.ts:167
    • @@ -300,6 +300,9 @@

    Theme

    +
  • Defined in packages/xrpl/src/utils/quality.ts:111
    • @@ -298,6 +298,9 @@

    Theme

    +
  • Defined in packages/xrpl/src/utils/timeConversion.ts:32
    • @@ -296,6 +296,9 @@

    Theme

    +
  • Defined in packages/xrpl/src/models/utils/flags.ts:53
    • @@ -295,6 +295,9 @@

    Theme

    +
  • Defined in packages/xrpl/src/utils/quality.ts:137
    • @@ -298,6 +298,9 @@

    Theme

    +
  • Defined in packages/xrpl/src/models/transactions/transaction.ts:99
    • @@ -298,6 +298,9 @@

    Theme

    -
    -
    -
      -
    • Preparing search index...
      • -
    • The search index is not available
    xrpl
    -
    -
    -
    -
    - -

    Function verifyKeypairSignature

    -
    -
      - -
    • -
      -

      Parameters

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

      Returns boolean

    -
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file diff --git a/docs/functions/verifyPaymentChannelClaim.html b/docs/functions/verifyPaymentChannelClaim.html index 0c51c8e4b8..778c9f3bbb 100644 --- a/docs/functions/verifyPaymentChannelClaim.html +++ b/docs/functions/verifyPaymentChannelClaim.html @@ -49,7 +49,7 @@
    publicKey: Returns boolean

    True if the channel is valid.

    +
  • Defined in packages/xrpl/src/utils/verifyPaymentChannelClaim.ts:17
    • @@ -308,6 +308,9 @@

    Theme

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

    • Optional id

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

    Optional

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

    • Optional ledger_hash

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

    Optional

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

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -114,7 +114,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/accountChannels.ts:47

    • Optional marker

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

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountChannels.ts:52
    • @@ -402,6 +402,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -415,8 +418,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -454,7 +455,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/AccountChannelsResponse.html b/docs/interfaces/AccountChannelsResponse.html index b8178a3347..fc6b012f30 100644 --- a/docs/interfaces/AccountChannelsResponse.html +++ b/docs/interfaces/AccountChannelsResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • AccountChannelsResponse
    +
  • Defined in packages/xrpl/src/models/methods/accountChannels.ts:60
    • @@ -55,19 +55,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;
    }
    @@ -110,31 +110,31 @@
    Optional

    Overrides BaseResponse.result

    +
  • 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
    • @@ -405,6 +405,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -418,8 +421,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -457,7 +458,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/AccountCurrenciesRequest.html b/docs/interfaces/AccountCurrenciesRequest.html index 07c04a2011..d297c9b563 100644 --- a/docs/interfaces/AccountCurrenciesRequest.html +++ b/docs/interfaces/AccountCurrenciesRequest.html @@ -34,7 +34,7 @@

    Hierarchy

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

    account

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

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

    • Optional api_version

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

    Optional

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

    • command

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

    command

    Overrides BaseRequest.command

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

    • Optional id

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

    Optional

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

    • Optional ledger_hash

    ledger_hash?: string
    @@ -92,7 +92,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 strict

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

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountCurrencies.ts:21
    • @@ -379,6 +379,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -392,8 +395,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -431,7 +432,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/AccountCurrenciesResponse.html b/docs/interfaces/AccountCurrenciesResponse.html index 6c3835b512..581e203ddb 100644 --- a/docs/interfaces/AccountCurrenciesResponse.html +++ b/docs/interfaces/AccountCurrenciesResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • AccountCurrenciesResponse
    +
  • Defined in packages/xrpl/src/models/methods/accountCurrencies.ts:29
    • @@ -55,19 +55,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;
    }
    @@ -97,31 +97,31 @@
    validated

    Overrides BaseResponse.result

    +
  • 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
    • @@ -392,6 +392,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -405,8 +408,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -444,7 +445,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/AccountDelete.html b/docs/interfaces/AccountDelete.html index 4e47ef6c7b..fb368d858d 100644 --- a/docs/interfaces/AccountDelete.html +++ b/docs/interfaces/AccountDelete.html @@ -33,7 +33,7 @@

    Hierarchy

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

    Account

    Inherited from BaseTransaction.Account

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

    • Optional AccountTxnID

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

    Optional

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

    • Destination

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

    Destination

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

    • Optional DestinationTag

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

    Optional

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

    • Optional Fee

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

    Optional

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

    • Optional Flags

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

    Optional

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

    • Optional LastLedgerSequence

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

    Optional

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

    • Optional Memos

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

    Optional

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

    • Optional NetworkID

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

    Optional

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

    • Optional Sequence

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

    Optional

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

    • Optional Signers

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

    Optional

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

    • Optional SigningPubKey

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

    Optional

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

    • Optional SourceTag

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

    Optional

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

    • Optional TicketSequence

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

    Optional

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

    • TransactionType

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

    TransactionType

    Overrides BaseTransaction.TransactionType

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

    • Optional TxnSignature

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

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:159
    • @@ -485,6 +485,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -498,8 +501,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -537,7 +538,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/AccountInfoAccountFlags.html b/docs/interfaces/AccountInfoAccountFlags.html index ecd852fc92..1ced04ac16 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
    • @@ -56,7 +56,7 @@

    defaultRipple

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

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

    • depositAuth

    depositAuth: boolean
    @@ -64,84 +64,84 @@

    depositAuth

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

    • disableMasterKey

    disableMasterKey: boolean

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

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

    • Optional disallowIncomingCheck

    disallowIncomingCheck?: boolean

    Disallow incoming Checks from other accounts.

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

    • Optional disallowIncomingNFTokenOffer

    disallowIncomingNFTokenOffer?: boolean

    Disallow incoming NFTOffers from other accounts. Part of the DisallowIncoming amendment.

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

    • Optional disallowIncomingPayChan

    disallowIncomingPayChan?: boolean

    Disallow incoming PayChannels from other accounts. Part of the DisallowIncoming amendment.

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

    • Optional disallowIncomingTrustline

    disallowIncomingTrustline?: boolean

    Disallow incoming Trustlines from other accounts. Part of the DisallowIncoming amendment.

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

    • disallowIncomingXRP

    disallowIncomingXRP: boolean

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

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

    • globalFreeze

    globalFreeze: boolean

    All assets issued by this address are frozen.

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

    • noFreeze

    noFreeze: boolean

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

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

    • passwordSpent

    passwordSpent: boolean

    The account has used its free SetRegularKey transaction.

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

    • requireAuthorization

    requireAuthorization: boolean

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

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

    • requireDestinationTag

    requireDestinationTag: boolean

    Requires incoming payments to specify a Destination Tag.

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:129
    • @@ -417,6 +417,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -430,8 +433,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -469,7 +470,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/AccountInfoRequest.html b/docs/interfaces/AccountInfoRequest.html index 8f44c95e62..c223a66050 100644 --- a/docs/interfaces/AccountInfoRequest.html +++ b/docs/interfaces/AccountInfoRequest.html @@ -34,7 +34,7 @@

    Hierarchy

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

    account

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

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

    • Optional api_version

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

    Optional

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

    • command

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

    command

    Overrides BaseRequest.command

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

    • Optional id

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

    Optional

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

    • Optional ledger_hash

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

    Optional

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

    • Optional ledger_index

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

    Optional

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

    • Optional queue

    queue?: boolean
    @@ -111,14 +111,14 @@

    Optional

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

    • Optional signer_lists

    signer_lists?: boolean

    Request SignerList objects associated with this account.

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

    • Optional strict

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

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:31
    • @@ -399,6 +399,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -412,8 +415,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -451,7 +452,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/AccountInfoResponse.html b/docs/interfaces/AccountInfoResponse.html index a50a421fe6..f01a6c8338 100644 --- a/docs/interfaces/AccountInfoResponse.html +++ b/docs/interfaces/AccountInfoResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • AccountInfoResponse
    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:137
    • @@ -55,19 +55,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;
    }
    @@ -113,31 +113,31 @@
    Optional

    Overrides BaseResponse.result

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

    • 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
    • @@ -408,6 +408,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -421,8 +424,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -460,7 +461,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/AccountLinesRequest.html b/docs/interfaces/AccountLinesRequest.html index 34504b8456..08510b17f1 100644 --- a/docs/interfaces/AccountLinesRequest.html +++ b/docs/interfaces/AccountLinesRequest.html @@ -35,7 +35,7 @@

    Hierarchy

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

    account

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

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

    • Optional api_version

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

    Optional

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

    • command

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

    command

    Overrides BaseRequest.command

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

    • Optional id

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

    Optional

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

    • Optional ledger_hash

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

    Optional

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

    • Optional ledger_index

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

    Optional

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

    • Optional limit

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

    Optional

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

    • Optional marker

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

    Optional

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

    • Optional peer

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

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountLines.ts:85
    • @@ -399,6 +399,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -412,8 +415,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -451,7 +452,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/AccountLinesResponse.html b/docs/interfaces/AccountLinesResponse.html index 7de85eb87f..fc1ab6c00e 100644 --- a/docs/interfaces/AccountLinesResponse.html +++ b/docs/interfaces/AccountLinesResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • AccountLinesResponse
    +
  • Defined in packages/xrpl/src/models/methods/accountLines.ts:103
    • @@ -55,19 +55,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;
    }
    @@ -107,31 +107,31 @@
    Optional

    Overrides BaseResponse.result

    +
  • 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
    • @@ -402,6 +402,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -415,8 +418,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -454,7 +455,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/AccountLinesTrustline.html b/docs/interfaces/AccountLinesTrustline.html index 88b71b0583..ad433c46ec 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
    • @@ -56,14 +56,14 @@

    account

    The unique Address of the counterparty to this trust line.

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

    • Optional authorized

    authorized?: boolean

    If true, this account has authorized this trust line. The default is false.

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

    • balance

    balance: string
    @@ -72,21 +72,21 @@

    balance

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

    • currency

    currency: string

    A Currency Code identifying what currency this trust line can hold.

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

    • Optional freeze

    freeze?: boolean

    If true, this account has frozen this trust line. The default is false.

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

    • Optional freeze_peer

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

    Optional

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

    • limit

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

    limit

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

    • limit_peer

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

    limit_peer

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

    • Optional no_ripple

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

    Optional

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

    • Optional no_ripple_peer

    no_ripple_peer?: boolean
    @@ -132,14 +132,14 @@

    Optional

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

    • Optional peer_authorized

    peer_authorized?: boolean

    If true, the peer account has authorized this trust line. The default is false.

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

    • quality_in

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

    quality_in

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

    • quality_out

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

    quality_out

    +
  • Defined in packages/xrpl/src/models/methods/accountLines.ts:37
    • @@ -435,6 +435,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -448,8 +451,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -487,7 +488,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/AccountNFToken.html b/docs/interfaces/AccountNFToken.html index d074c14c01..e25a541b8e 100644 --- a/docs/interfaces/AccountNFToken.html +++ b/docs/interfaces/AccountNFToken.html @@ -29,7 +29,7 @@

    Hierarchy

    • AccountNFToken
    +
  • Defined in packages/xrpl/src/models/methods/accountNFTs.ts:32
    • @@ -50,32 +50,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
    • @@ -344,6 +344,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -357,8 +360,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -396,7 +397,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/AccountNFTsRequest.html b/docs/interfaces/AccountNFTsRequest.html index c0eeed5de1..e51911c766 100644 --- a/docs/interfaces/AccountNFTsRequest.html +++ b/docs/interfaces/AccountNFTsRequest.html @@ -33,7 +33,7 @@

    Hierarchy

    • AccountNFTsRequest
    +
  • Defined in packages/xrpl/src/models/methods/accountNFTs.ts:9
    • @@ -59,7 +59,7 @@

    account

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

    • Optional api_version

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

    Optional

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

    • command

    command: "account_nfts"
    @@ -75,7 +75,7 @@

    command

    Overrides BaseRequest.command

    +
  • Defined in packages/xrpl/src/models/methods/accountNFTs.ts:10

    • Optional id

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

    Optional

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

    • Optional ledger_hash

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

    Optional

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

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -101,14 +101,14 @@

    Optional

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

    • Optional limit

    limit?: number

    Limit the number of NFTokens to retrieve.

    +
  • Defined in packages/xrpl/src/models/methods/accountNFTs.ts:19

    • Optional marker

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

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountNFTs.ts:24
    • @@ -387,6 +387,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -400,8 +403,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -439,7 +440,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/AccountNFTsResponse.html b/docs/interfaces/AccountNFTsResponse.html index 2e9298d65c..dce82ebfcf 100644 --- a/docs/interfaces/AccountNFTsResponse.html +++ b/docs/interfaces/AccountNFTsResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • AccountNFTsResponse
    +
  • Defined in packages/xrpl/src/models/methods/accountNFTs.ts:46
    • @@ -55,19 +55,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;
    }
    @@ -103,31 +103,31 @@
    validated

    Overrides BaseResponse.result

    +
  • 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
    • @@ -398,6 +398,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -411,8 +414,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -450,7 +451,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/AccountObjectsRequest.html b/docs/interfaces/AccountObjectsRequest.html index ca92a0f465..af8996354f 100644 --- a/docs/interfaces/AccountObjectsRequest.html +++ b/docs/interfaces/AccountObjectsRequest.html @@ -35,7 +35,7 @@

    Hierarchy

    • AccountObjectsRequest
    +
  • Defined in packages/xrpl/src/models/methods/accountObjects.ts:33
    • @@ -62,7 +62,7 @@

    account

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

    +
  • Defined in packages/xrpl/src/models/methods/accountObjects.ts:38

    • Optional api_version

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

    Optional

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

    • command

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

    command

    Overrides BaseRequest.command

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

    • Optional deletion_blockers_only

    deletion_blockers_only?: boolean
    @@ -86,7 +86,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountObjects.ts:49

    • Optional id

    id?: string | number
    @@ -96,7 +96,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
    @@ -112,7 +112,7 @@

    Optional

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

    • Optional limit

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

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountObjects.ts:54

    • Optional marker

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

    Optional

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

    • Optional type

    type?: AccountObjectType
    @@ -137,7 +137,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountObjects.ts:44
    • @@ -410,6 +410,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -423,8 +426,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -462,7 +463,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/AccountObjectsResponse.html b/docs/interfaces/AccountObjectsResponse.html index 2daf503424..cc23d1683c 100644 --- a/docs/interfaces/AccountObjectsResponse.html +++ b/docs/interfaces/AccountObjectsResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • AccountObjectsResponse
    +
  • Defined in packages/xrpl/src/models/methods/accountObjects.ts:81
    • @@ -55,19 +55,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;
    }
    @@ -116,31 +116,31 @@
    Optional

    Overrides BaseResponse.result

    +
  • Defined in packages/xrpl/src/models/methods/accountObjects.ts:82

    • 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
    • @@ -411,6 +411,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -424,8 +427,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -463,7 +464,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/AccountOffer.html b/docs/interfaces/AccountOffer.html index 6ca3d1df12..7a9eb7ca6e 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
    • @@ -50,14 +50,14 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:60

    • flags

    flags: number

    Options set for this offer entry as bit-flags.

    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:38

    • quality

    quality: string
    @@ -67,28 +67,28 @@

    quality

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

    • seq

    seq: number

    Sequence number of the transaction that created this entry.

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

    • taker_gets

    taker_gets: Amount

    The amount the account placing this Offer receives.

    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:44

    • taker_pays

    taker_pays: Amount

    The amount the account placing this Offer pays.

    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:48
    • @@ -357,6 +357,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -370,8 +373,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -409,7 +410,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/AccountOffersRequest.html b/docs/interfaces/AccountOffersRequest.html index abf7cc60ba..3931eab7e7 100644 --- a/docs/interfaces/AccountOffersRequest.html +++ b/docs/interfaces/AccountOffersRequest.html @@ -34,7 +34,7 @@

    Hierarchy

    • AccountOffersRequest
    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:12
    • @@ -60,7 +60,7 @@

    account

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

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

    • Optional api_version

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

    Optional

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

    • command

    command: "account_offers"
    @@ -76,7 +76,7 @@

    command

    Overrides BaseRequest.command

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

    • Optional id

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

    Optional

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

    • Optional ledger_hash

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

    Optional

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

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -102,7 +102,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/accountOffers.ts:22

    • Optional marker

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

    Optional

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

    • Optional strict

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

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:33
    • @@ -399,6 +399,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -412,8 +415,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -451,7 +452,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/AccountOffersResponse.html b/docs/interfaces/AccountOffersResponse.html index 355b298392..f7d7070695 100644 --- a/docs/interfaces/AccountOffersResponse.html +++ b/docs/interfaces/AccountOffersResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • AccountOffersResponse
    +
  • Defined in packages/xrpl/src/models/methods/accountOffers.ts:68
    • @@ -55,19 +55,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[];
    }
    @@ -107,31 +107,31 @@
    Optional

    Overrides BaseResponse.result

    +
  • 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
    • @@ -402,6 +402,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -415,8 +418,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -454,7 +455,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/AccountQueueData.html b/docs/interfaces/AccountQueueData.html index a92f26e4c9..7df23033e6 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
    • @@ -52,21 +52,21 @@

    Optional

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

    • Optional highest_sequence

    highest_sequence?: number

    The highest Sequence Number among transactions queued by this address.

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

    • Optional lowest_sequence

    lowest_sequence?: number

    The lowest Sequence Number among transactions queued by this address.

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

    • Optional max_spend_drops_total

    max_spend_drops_total?: string
    @@ -74,21 +74,21 @@

    Optional

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

    • Optional transactions

    transactions?: AccountQueueTransaction[]

    Information about each queued transaction from this address.

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

    • txn_count

    txn_count: number

    Number of queued transactions from this address.

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:55
    • @@ -357,6 +357,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -370,8 +373,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -409,7 +410,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/AccountQueueTransaction.html b/docs/interfaces/AccountQueueTransaction.html index 7fe9fe88ab..50dbffa4db 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
    • @@ -49,14 +49,14 @@

    auth_change

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

    • fee

    fee: string

    The Transaction Cost of this transaction, in drops of XRP.

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

    • fee_level

    fee_level: string
    @@ -64,21 +64,21 @@

    fee_level

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

    • max_spend_drops

    max_spend_drops: string

    The maximum amount of XRP, in drops, this transaction could send or destroy.

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

    • seq

    seq: number

    The Sequence Number of this transaction.

    +
  • Defined in packages/xrpl/src/models/methods/accountInfo.ts:50
    • @@ -346,6 +346,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -359,8 +362,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -398,7 +399,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/AccountSet.html b/docs/interfaces/AccountSet.html index 9cdb7ef1cc..ad6cfa6848 100644 --- a/docs/interfaces/AccountSet.html +++ b/docs/interfaces/AccountSet.html @@ -32,7 +32,7 @@

    Hierarchy

    • AccountSet
    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:126
    • @@ -72,7 +72,7 @@

    Account

    Inherited from BaseTransaction.Account

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

    • Optional AccountTxnID

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

    Optional

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

    • Optional ClearFlag

    ClearFlag?: number

    Unique identifier of a flag to disable for this account.

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

    • Optional Domain

    Domain?: string
    @@ -97,14 +97,14 @@

    Optional

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

    • Optional EmailHash

    EmailHash?: string

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

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

    • Optional Fee

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

    Optional

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

    • Optional Flags

    Flags?: number | AccountSetFlagsInterface
    @@ -122,7 +122,7 @@

    Optional

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

    • Optional LastLedgerSequence

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

    Optional

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

    • Optional Memos

    Memos?: Memo[]
    @@ -140,14 +140,14 @@

    Optional

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

    • Optional MessageKey

    MessageKey?: string

    Public key for sending encrypted messages to this account.

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

    • Optional NFTokenMinter

    NFTokenMinter?: string
    @@ -155,7 +155,7 @@

    OptionalIssuer field.

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

    • Optional NetworkID

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

    Optional

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

    • Optional Sequence

    Sequence?: number
    @@ -174,14 +174,14 @@

    Optional

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

    • Optional SetFlag

    SetFlag?: AccountSetAsfFlags

    Integer flag to enable for this account.

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

    • Optional Signers

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

    Optional

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

    • Optional SigningPubKey

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

    Optional

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

    • Optional SourceTag

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

    Optional

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

    • Optional TickSize

    TickSize?: number
    @@ -220,7 +220,7 @@

    Optional

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

    • Optional TicketSequence

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

    Optional

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

    • TransactionType

    TransactionType: "AccountSet"
    @@ -238,7 +238,7 @@

    TransactionType

    Overrides BaseTransaction.TransactionType

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

    • Optional TransferRate

    TransferRate?: number
    @@ -247,7 +247,7 @@

    Optional

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

    • Optional TxnSignature

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

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:159
    • @@ -541,6 +541,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -554,8 +557,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -593,7 +594,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/AccountSetFlagsInterface.html b/docs/interfaces/AccountSetFlagsInterface.html index f2db244b03..c6c228506c 100644 --- a/docs/interfaces/AccountSetFlagsInterface.html +++ b/docs/interfaces/AccountSetFlagsInterface.html @@ -33,7 +33,7 @@

    Hierarchy

    • AccountSetFlagsInterface
    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:111
    • @@ -54,32 +54,32 @@

    Properties

    Optional tfAllowXRP

    tfAllowXRP?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:117

    • Optional tfDisallowXRP

    tfDisallowXRP?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:116

    • Optional tfOptionalAuth

    tfOptionalAuth?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:115

    • Optional tfOptionalDestTag

    tfOptionalDestTag?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:113

    • Optional tfRequireAuth

    tfRequireAuth?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:114

    • Optional tfRequireDestTag

    tfRequireDestTag?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/accountSet.ts:112
    • @@ -348,6 +348,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -361,8 +364,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -400,7 +401,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/AccountTxRequest.html b/docs/interfaces/AccountTxRequest.html index 1b64807a96..488eba2baa 100644 --- a/docs/interfaces/AccountTxRequest.html +++ b/docs/interfaces/AccountTxRequest.html @@ -33,7 +33,7 @@

    Hierarchy

    • AccountTxRequest
    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:13
    • @@ -62,7 +62,7 @@

    account

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

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

    • Optional api_version

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

    Optional

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

    • Optional binary

    binary?: boolean
    @@ -78,7 +78,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:33

    • command

    command: "account_tx"
    @@ -86,7 +86,7 @@

    command

    Overrides BaseRequest.command

    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:14

    • Optional forward

    forward?: boolean
    @@ -94,7 +94,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:38

    • 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
    @@ -112,7 +112,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 ledger_index_max

    ledger_index_max?: number
    @@ -129,7 +129,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:28

    • Optional ledger_index_min

    ledger_index_min?: number
    @@ -138,7 +138,7 @@

    Optional

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

    • Optional limit

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

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:43

    • Optional marker

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

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:49
    • @@ -430,6 +430,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -443,8 +446,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -482,7 +483,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/AccountTxResponse.html b/docs/interfaces/AccountTxResponse.html index f6015ec970..0670d2786d 100644 --- a/docs/interfaces/AccountTxResponse.html +++ b/docs/interfaces/AccountTxResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • AccountTxResponse
    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:76
    • @@ -55,19 +55,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;
    }
    @@ -110,31 +110,31 @@
    Optional

    Overrides BaseResponse.result

    +
  • 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
    • @@ -405,6 +405,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -418,8 +421,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -457,7 +458,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/AccountTxTransaction.html b/docs/interfaces/AccountTxTransaction.html index c1364e27cb..af057dec4b 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
    • @@ -48,7 +48,7 @@

    ledger_index

    The ledger index of the ledger version that included this transaction.

    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:54

    • meta

    meta: string | TransactionMetadata
    @@ -56,21 +56,21 @@

    meta

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

    • Optional tx

    tx?: Object

    JSON object defining the transaction.

    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:61

    • Optional tx_blob

    tx_blob?: string

    Unique hashed String representing the transaction.

    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:63

    • validated

    validated: boolean
    @@ -78,7 +78,7 @@

    validated

    +
  • Defined in packages/xrpl/src/models/methods/accountTx.ts:68
    • @@ -346,6 +346,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -359,8 +362,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -398,7 +399,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/Balance.html b/docs/interfaces/Balance.html index 4d3078e86a..654601002c 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:20
    • @@ -44,17 +44,17 @@

    Properties

    currency

    currency: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:21

    • Optional issuer

    issuer?: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:22

    • value

    value: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:23
    • @@ -320,6 +320,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -333,8 +336,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -372,7 +373,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/BaseRequest.html b/docs/interfaces/BaseRequest.html index 0d25acaecb..55c62625ef 100644 --- a/docs/interfaces/BaseRequest.html +++ b/docs/interfaces/BaseRequest.html @@ -65,7 +65,7 @@

    Hierarchy

    Indexable

    [x: string]: unknown
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:5
    • @@ -85,14 +85,14 @@

    Optional

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

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

    • command

    command: string

    The name of the API method.

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

    • Optional id

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

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12
    • @@ -367,6 +367,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -380,8 +383,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -419,7 +420,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/BaseResponse.html b/docs/interfaces/BaseResponse.html index 50fc4510ac..4941a1dc01 100644 --- a/docs/interfaces/BaseResponse.html +++ b/docs/interfaces/BaseResponse.html @@ -63,7 +63,7 @@

    Hierarchy

  • NFTInfoResponse
  • NFTHistoryResponse
    • +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:32
    • @@ -86,42 +86,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
    • @@ -392,6 +392,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -405,8 +408,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -444,7 +445,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/BaseTransaction.html b/docs/interfaces/BaseTransaction.html index 14b1bd330f..12ab996e39 100644 --- a/docs/interfaces/BaseTransaction.html +++ b/docs/interfaces/BaseTransaction.html @@ -57,7 +57,7 @@

    Hierarchy

  • TicketCreate
  • TrustSet
    • +
  • Defined in packages/xrpl/src/models/transactions/common.ts:93
    • @@ -88,7 +88,7 @@

    Account

    The unique address of the transaction sender.

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

    • Optional AccountTxnID

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

    Optional

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

    • Optional Fee

    Fee?: string
    @@ -106,14 +106,14 @@

    Optional

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

    • Optional Flags

    Flags?: number | GlobalFlags

    Set of bit-flags for this transaction.

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

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -122,21 +122,21 @@

    Optional

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

    • Optional Memos

    Memos?: Memo[]

    Additional arbitrary information used to identify this transaction.

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

    • Optional NetworkID

    NetworkID?: number

    The network id of the transaction.

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

    • Optional Sequence

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

    Optional

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

    • Optional Signers

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

    Optional

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

    • Optional SigningPubKey

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

    Optional

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

    • Optional SourceTag

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

    Optional

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

    • Optional TicketSequence

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

    Optional

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

    • TransactionType

    TransactionType: string
    @@ -189,7 +189,7 @@

    TransactionType

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

    • Optional TxnSignature

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

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:159
    • @@ -474,6 +474,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -487,8 +490,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -526,7 +527,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/BookOffer.html b/docs/interfaces/BookOffer.html index 1279f4144c..02a59dea2f 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
    • @@ -63,7 +63,7 @@

    Account

    Inherited from Offer.Account

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:10

    • BookDirectory

    BookDirectory: string
    @@ -71,7 +71,7 @@

    BookDirectory

    Inherited from Offer.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:46

    • Flags

    Flags: number
    @@ -96,13 +96,13 @@

    Flags

    Inherited from Offer.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
    @@ -111,7 +111,7 @@

    OwnerNode

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:34

    • PreviousTxnID

    PreviousTxnID: string
    @@ -120,7 +120,7 @@

    PreviousTxnID

    Inherited from Offer.PreviousTxnID

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:39

    • PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    @@ -129,7 +129,7 @@

    PreviousTxnLgrSeq

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:44

    • Sequence

    Sequence: number
    @@ -138,7 +138,7 @@

    Sequence

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:15

    • TakerGets

    TakerGets: Amount
    @@ -147,7 +147,7 @@

    TakerGets

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:22

    • TakerPays

    TakerPays: Amount
    @@ -155,13 +155,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
    @@ -171,7 +171,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:51

    • Optional quality

    quality?: string
    @@ -180,7 +180,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:67

    • Optional taker_gets_funded

    taker_gets_funded?: Amount
    @@ -188,7 +188,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:56

    • Optional taker_pays_funded

    taker_pays_funded?: Amount
    @@ -196,7 +196,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:61
    • @@ -476,6 +476,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -489,8 +492,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -528,7 +529,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/BookOfferCurrency.html b/docs/interfaces/BookOfferCurrency.html index b2170f6936..ee8168f711 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
    • @@ -313,6 +313,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -326,8 +329,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -365,7 +366,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/BookOffersRequest.html b/docs/interfaces/BookOffersRequest.html index f7d5ef16c7..02cd1647a4 100644 --- a/docs/interfaces/BookOffersRequest.html +++ b/docs/interfaces/BookOffersRequest.html @@ -33,7 +33,7 @@

    Hierarchy

    • BookOffersRequest
    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:17
    • @@ -60,7 +60,7 @@

    Optional

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

    • command

    command: "book_offers"
    @@ -68,7 +68,7 @@

    command

    Overrides BaseRequest.command

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

    • 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
    @@ -86,7 +86,7 @@

    Optional

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

    • Optional ledger_index

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

    Optional

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

    • Optional limit

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

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:24

    • Optional taker

    taker?: string
    @@ -111,7 +111,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:29

    • taker_gets

    taker_gets: BookOfferCurrency
    @@ -120,7 +120,7 @@

    taker_gets

    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:35

    • taker_pays

    taker_pays: BookOfferCurrency
    @@ -129,7 +129,7 @@

    taker_pays

    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:41
    • @@ -401,6 +401,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -414,8 +417,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -453,7 +454,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/BookOffersResponse.html b/docs/interfaces/BookOffersResponse.html index 36c7d24a41..892dae85a3 100644 --- a/docs/interfaces/BookOffersResponse.html +++ b/docs/interfaces/BookOffersResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • BookOffersResponse
    +
  • Defined in packages/xrpl/src/models/methods/bookOffers.ts:75
    • @@ -55,19 +55,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;
    }
    @@ -97,31 +97,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
    • @@ -392,6 +392,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -405,8 +408,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -444,7 +445,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/Channel.html b/docs/interfaces/Channel.html index 102528adf8..02bc5cdc59 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
    • @@ -383,6 +383,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -396,8 +399,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -435,7 +436,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/ChannelVerifyRequest.html b/docs/interfaces/ChannelVerifyRequest.html index bb06b479ac..e8efbe15e9 100644 --- a/docs/interfaces/ChannelVerifyRequest.html +++ b/docs/interfaces/ChannelVerifyRequest.html @@ -33,7 +33,7 @@

    Hierarchy

    • ChannelVerifyRequest
    +
  • Defined in packages/xrpl/src/models/methods/channelVerify.ts:10
    • @@ -57,7 +57,7 @@

    amount

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

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

    • Optional api_version

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

    Optional

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

    • channel_id

    channel_id: string
    @@ -73,7 +73,7 @@

    channel_id

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

    • command

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

    command

    Overrides BaseRequest.command

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

    • Optional id

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

    Optional

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

    • public_key

    public_key: string
    @@ -99,14 +99,14 @@

    public_key

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

    • signature

    signature: string

    The signature to verify, in hexadecimal.

    +
  • Defined in packages/xrpl/src/models/methods/channelVerify.ts:25
    • @@ -376,6 +376,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -389,8 +392,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -428,7 +429,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/ChannelVerifyResponse.html b/docs/interfaces/ChannelVerifyResponse.html index d83875ff0d..d7e3c015c1 100644 --- a/docs/interfaces/ChannelVerifyResponse.html +++ b/docs/interfaces/ChannelVerifyResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • ChannelVerifyResponse
    +
  • Defined in packages/xrpl/src/models/methods/channelVerify.ts:33
    • @@ -55,19 +55,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;
    }
    @@ -81,31 +81,31 @@
    signature_verified

    Overrides BaseResponse.result

    +
  • 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
    • @@ -376,6 +376,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -389,8 +392,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -428,7 +429,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/CheckCancel.html b/docs/interfaces/CheckCancel.html index 5d08d298cf..a6855615a6 100644 --- a/docs/interfaces/CheckCancel.html +++ b/docs/interfaces/CheckCancel.html @@ -34,7 +34,7 @@

    Hierarchy

    • CheckCancel
    +
  • Defined in packages/xrpl/src/models/transactions/checkCancel.ts:13
    • @@ -67,7 +67,7 @@

    Account

    Inherited from BaseTransaction.Account

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

    • Optional AccountTxnID

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

    Optional

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

    • CheckID

    CheckID: string
    @@ -85,7 +85,7 @@

    CheckID

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

    • Optional Fee

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

    Optional

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

    • Optional Flags

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

    Optional

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

    • Optional LastLedgerSequence

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

    Optional

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

    • Optional Memos

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

    Optional

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

    • Optional NetworkID

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

    Optional

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

    • Optional Sequence

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

    Optional

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

    • Optional Signers

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

    Optional

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

    • Optional SigningPubKey

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

    Optional

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

    • Optional SourceTag

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

    Optional

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

    • Optional TicketSequence

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

    Optional

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

    • TransactionType

    TransactionType: "CheckCancel"
    @@ -188,7 +188,7 @@

    TransactionType

    Overrides BaseTransaction.TransactionType

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

    • Optional TxnSignature

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

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:159
    • @@ -475,6 +475,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -488,8 +491,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -527,7 +528,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/CheckCash.html b/docs/interfaces/CheckCash.html index ea5ab72994..9110ec2bd1 100644 --- a/docs/interfaces/CheckCash.html +++ b/docs/interfaces/CheckCash.html @@ -33,7 +33,7 @@

    Hierarchy

    • CheckCash
    +
  • Defined in packages/xrpl/src/models/transactions/checkCash.ts:14
    • @@ -68,7 +68,7 @@

    Account

    Inherited from BaseTransaction.Account

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

    • Optional AccountTxnID

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

    Optional

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

    • Optional Amount

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

    Optional

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

    • CheckID

    CheckID: string
    @@ -95,7 +95,7 @@

    CheckID

    +
  • Defined in packages/xrpl/src/models/transactions/checkCash.ts:20

    • Optional DeliverMin

    DeliverMin?: Amount
    @@ -104,7 +104,7 @@

    Optional

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

    • Optional Fee

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

    Optional

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

    • Optional Flags

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

    Optional

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

    • Optional LastLedgerSequence

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

    Optional

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

    • Optional Memos

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

    Optional

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

    • Optional NetworkID

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

    Optional

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

    • Optional Sequence

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

    Optional

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

    • Optional Signers

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

    Optional

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

    • Optional SigningPubKey

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

    Optional

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

    • Optional SourceTag

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

    Optional

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

    • Optional TicketSequence

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

    Optional

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

    • TransactionType

    TransactionType: "CheckCash"
    @@ -207,7 +207,7 @@

    TransactionType

    Overrides BaseTransaction.TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/checkCash.ts:15

    • Optional TxnSignature

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

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:159
    • @@ -496,6 +496,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -509,8 +512,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -548,7 +549,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/CheckCreate.html b/docs/interfaces/CheckCreate.html index dd363662ad..c9376550d1 100644 --- a/docs/interfaces/CheckCreate.html +++ b/docs/interfaces/CheckCreate.html @@ -33,7 +33,7 @@

    Hierarchy

    • CheckCreate
    +
  • Defined in packages/xrpl/src/models/transactions/checkCreate.ts:18
    • @@ -70,7 +70,7 @@

    Account

    Inherited from BaseTransaction.Account

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

    • Optional AccountTxnID

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

    Optional

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

    • Destination

    Destination: string

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

    +
  • Defined in packages/xrpl/src/models/transactions/checkCreate.ts:21

    • Optional DestinationTag

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

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/checkCreate.ts:34

    • Optional Expiration

    Expiration?: number
    @@ -103,7 +103,7 @@

    Optional

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

    • Optional Fee

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

    Optional

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

    • Optional Flags

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

    Optional

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

    • Optional InvoiceID

    InvoiceID?: string
    @@ -129,7 +129,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/checkCreate.ts:44

    • Optional LastLedgerSequence

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

    Optional

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

    • Optional Memos

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

    Optional

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

    • Optional NetworkID

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

    Optional

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

    • SendMax

    SendMax: Amount
    @@ -166,7 +166,7 @@

    SendMax

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

    • Optional Sequence

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

    Optional

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

    • Optional Signers

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

    Optional

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

    • Optional SigningPubKey

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

    Optional

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

    • Optional SourceTag

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

    Optional

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

    • Optional TicketSequence

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

    Optional

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

    • TransactionType

    TransactionType: "CheckCreate"
    @@ -225,7 +225,7 @@

    TransactionType

    Overrides BaseTransaction.TransactionType

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

    • Optional TxnSignature

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

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:159
    • @@ -516,6 +516,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -529,8 +532,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -568,7 +569,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/ClientOptions.html b/docs/interfaces/ClientOptions.html index af0f4da4c9..059b119661 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:122
    • @@ -57,24 +57,24 @@

    Optionalauthorization?: string

    +
  • Defined in packages/xrpl/src/client/connection.ts:31

    • Optional certificate

    certificate?: string
    +
  • Defined in packages/xrpl/src/client/connection.ts:35

    • Optional connectionTimeout

    connectionTimeout?: number
    +
  • Defined in packages/xrpl/src/client/connection.ts:38

    • Optional feeCushion

    feeCushion?: number
    +
  • Defined in packages/xrpl/src/client/index.ts:123

    • Optional headers

    headers?: {
        [key: string]: string;
    }
    @@ -85,54 +85,54 @@

    Type declaration

    [key: string]: string
    +
  • Defined in packages/xrpl/src/client/connection.ts:39

    • Optional key

    key?: string
    +
  • Defined in packages/xrpl/src/client/connection.ts:33

    • Optional maxFeeXRP

    maxFeeXRP?: string
    +
  • Defined in packages/xrpl/src/client/index.ts:124

    • Optional passphrase

    passphrase?: string
    +
  • Defined in packages/xrpl/src/client/connection.ts:34

    • Optional proxy

    proxy?: string
    +
  • Defined in packages/xrpl/src/client/index.ts:125

    • Optional proxyAuthorization

    proxyAuthorization?: string
    +
  • Defined in packages/xrpl/src/client/connection.ts:30

    • Optional timeout

    timeout?: number
    +
  • Defined in packages/xrpl/src/client/index.ts:126

    • Optional trace

    trace?: boolean | ((id, message) => void)
    +
  • Defined in packages/xrpl/src/client/connection.ts:28

    • Optional trustedCertificates

    trustedCertificates?: string[]
    +
  • Defined in packages/xrpl/src/client/connection.ts:32
    • @@ -408,6 +408,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -421,8 +424,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -460,7 +461,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/ConsensusStream.html b/docs/interfaces/ConsensusStream.html index 3bfa6ccaf1..051287f42d 100644 --- a/docs/interfaces/ConsensusStream.html +++ b/docs/interfaces/ConsensusStream.html @@ -33,7 +33,7 @@

    Hierarchy

    • ConsensusStream
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:377
    • @@ -53,13 +53,13 @@

    consensus

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:383

    • type

    type: "consensusPhase"
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:378
    • @@ -324,6 +324,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -337,8 +340,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -376,7 +377,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/CreatedNode.html b/docs/interfaces/CreatedNode.html index d8fac28d0b..af9264b6e3 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:3
    • @@ -54,7 +54,7 @@
    NewFields
    [field: string]: unknown
    +
  • Defined in packages/xrpl/src/models/transactions/metadata.ts:4
    • @@ -318,6 +318,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -331,8 +334,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -370,7 +371,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/DeletedNode.html b/docs/interfaces/DeletedNode.html index 9ced0221a8..075918c9c1 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:22
    • @@ -54,7 +54,7 @@
    LedgerEntryType
    LedgerIndex: string
    +
  • Defined in packages/xrpl/src/models/transactions/metadata.ts:23
    • @@ -318,6 +318,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -331,8 +334,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -370,7 +371,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/DepositAuthorizedRequest.html b/docs/interfaces/DepositAuthorizedRequest.html index 73e0ee7039..4d775b4350 100644 --- a/docs/interfaces/DepositAuthorizedRequest.html +++ b/docs/interfaces/DepositAuthorizedRequest.html @@ -33,7 +33,7 @@

    Hierarchy

    • DepositAuthorizedRequest
    +
  • Defined in packages/xrpl/src/models/methods/depositAuthorized.ts:10
    • @@ -58,7 +58,7 @@

    Optional

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

    • command

    command: "deposit_authorized"
    @@ -66,14 +66,14 @@

    command

    Overrides BaseRequest.command

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

    • destination_account

    destination_account: string

    The recipient of a possible payment.

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

    • Optional id

    id?: string | number
    @@ -83,7 +83,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
    @@ -99,14 +99,14 @@

    Optional

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

    • source_account

    source_account: string

    The sender of a possible payment.

    +
  • Defined in packages/xrpl/src/models/methods/depositAuthorized.ts:15
    • @@ -376,6 +376,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -389,8 +392,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -428,7 +429,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/DepositAuthorizedResponse.html b/docs/interfaces/DepositAuthorizedResponse.html index 05af3fbbd0..c538be3da7 100644 --- a/docs/interfaces/DepositAuthorizedResponse.html +++ b/docs/interfaces/DepositAuthorizedResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • DepositAuthorizedResponse
    +
  • Defined in packages/xrpl/src/models/methods/depositAuthorized.ts:25
    • @@ -55,19 +55,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;
    }
    @@ -110,31 +110,31 @@
    Optional

    Overrides BaseResponse.result

    +
  • 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
    • @@ -405,6 +405,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -418,8 +421,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -457,7 +458,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/DepositPreauth.html b/docs/interfaces/DepositPreauth.html index 5f792f350d..3c94d93325 100644 --- a/docs/interfaces/DepositPreauth.html +++ b/docs/interfaces/DepositPreauth.html @@ -33,7 +33,7 @@

    Hierarchy

    • DepositPreauth
    +
  • Defined in packages/xrpl/src/models/transactions/depositPreauth.ts:13
    • @@ -67,7 +67,7 @@

    Account

    Inherited from BaseTransaction.Account

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

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -77,14 +77,14 @@

    Optional

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

    • Optional Authorize

    Authorize?: string

    The XRP Ledger address of the sender to preauthorize.

    +
  • Defined in packages/xrpl/src/models/transactions/depositPreauth.ts:16

    • Optional Fee

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

    Optional

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

    • Optional Flags

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

    Optional

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

    • Optional LastLedgerSequence

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

    Optional

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

    • Optional Memos

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

    Optional

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

    • Optional NetworkID

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

    Optional

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

    • Optional Sequence

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

    Optional

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

    • Optional Signers

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

    Optional

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

    • Optional SigningPubKey

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

    Optional

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

    • Optional SourceTag

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

    Optional

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

    • Optional TicketSequence

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

    Optional

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

    • TransactionType

    TransactionType: "DepositPreauth"
    @@ -187,7 +187,7 @@

    TransactionType

    Overrides BaseTransaction.TransactionType

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

    • Optional TxnSignature

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

    Optional

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

    • Optional Unauthorize

    Unauthorize?: string
    @@ -204,7 +204,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/depositPreauth.ts:21
    • @@ -483,6 +483,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -496,8 +499,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -535,7 +536,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/EnableAmendment.html b/docs/interfaces/EnableAmendment.html index 3c49a83d5d..d07da6edcd 100644 --- a/docs/interfaces/EnableAmendment.html +++ b/docs/interfaces/EnableAmendment.html @@ -31,7 +31,7 @@

    Hierarchy

    • EnableAmendment
    +
  • Defined in packages/xrpl/src/models/transactions/enableAmendment.ts:20
    • @@ -65,7 +65,7 @@

    Account

    Inherited from BaseTransaction.Account

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

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -75,14 +75,14 @@

    Optional

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

    • Amendment

    Amendment: string

    A unique identifier for the amendment.

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

    • Optional Fee

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

    Optional

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

    • Optional Flags

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

    Optional

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

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -110,14 +110,14 @@

    Optional

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

    • LedgerSequence

    LedgerSequence: number

    The ledger index where this pseudo-transaction appears.

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

    • Optional Memos

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

    Optional

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

    • Optional NetworkID

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

    Optional

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

    • Optional Sequence

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

    Optional

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

    • Optional Signers

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

    Optional

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

    • Optional SigningPubKey

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

    Optional

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

    • Optional SourceTag

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

    Optional

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

    • Optional TicketSequence

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

    Optional

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

    • TransactionType

    TransactionType: "EnableAmendment"
    @@ -192,7 +192,7 @@

    TransactionType

    Overrides BaseTransaction.TransactionType

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

    • Optional TxnSignature

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

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:159
    • @@ -480,6 +480,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -493,8 +496,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -532,7 +533,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/ErrorResponse.html b/docs/interfaces/ErrorResponse.html index 420a89ac13..c981b99df3 100644 --- a/docs/interfaces/ErrorResponse.html +++ b/docs/interfaces/ErrorResponse.html @@ -30,7 +30,7 @@

    Hierarchy

    • ErrorResponse
    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:49
    • @@ -53,42 +53,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
    • @@ -359,6 +359,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -372,8 +375,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -411,7 +412,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/EscrowCancel.html b/docs/interfaces/EscrowCancel.html index 6fdc86fa72..91499f81b1 100644 --- a/docs/interfaces/EscrowCancel.html +++ b/docs/interfaces/EscrowCancel.html @@ -31,7 +31,7 @@

    Hierarchy

    • EscrowCancel
    +
  • Defined in packages/xrpl/src/models/transactions/escrowCancel.ts:10
    • @@ -65,7 +65,7 @@

    Account

    Inherited from BaseTransaction.Account

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

    • Optional AccountTxnID

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

    Optional

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

    • Optional Fee

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

    Optional

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

    • Optional Flags

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

    Optional

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

    • Optional LastLedgerSequence

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

    Optional

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

    • Optional Memos

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

    Optional

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

    • Optional NetworkID

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

    Optional

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

    • OfferSequence

    OfferSequence: number
    @@ -127,14 +127,14 @@

    OfferSequence

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

    • Owner

    Owner: string

    Address of the source account that funded the escrow payment.

    +
  • Defined in packages/xrpl/src/models/transactions/escrowCancel.ts:13

    • Optional Sequence

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

    Optional

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

    • Optional Signers

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

    Optional

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

    • Optional SigningPubKey

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

    Optional

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

    • Optional SourceTag

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

    Optional

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

    • Optional TicketSequence

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

    Optional

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

    • TransactionType

    TransactionType: "EscrowCancel"
    @@ -193,7 +193,7 @@

    TransactionType

    Overrides BaseTransaction.TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/escrowCancel.ts:11

    • Optional TxnSignature

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

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:159
    • @@ -481,6 +481,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -494,8 +497,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -533,7 +534,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/EscrowCreate.html b/docs/interfaces/EscrowCreate.html index 8614d77360..3c018b9c55 100644 --- a/docs/interfaces/EscrowCreate.html +++ b/docs/interfaces/EscrowCreate.html @@ -31,7 +31,7 @@

    Hierarchy

    • EscrowCreate
    +
  • Defined in packages/xrpl/src/models/transactions/escrowCreate.ts:11
    • @@ -69,7 +69,7 @@

    Account

    Inherited from BaseTransaction.Account

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

    • Optional AccountTxnID

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

    Optional

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

    • Amount

    Amount: string
    @@ -88,7 +88,7 @@

    Amount

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

    • Optional CancelAfter

    CancelAfter?: number
    @@ -97,7 +97,7 @@

    Optional

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

    • Optional Condition

    Condition?: string
    @@ -105,14 +105,14 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/escrowCreate.ts:37

    • Destination

    Destination: string

    Address to receive escrowed XRP.

    +
  • Defined in packages/xrpl/src/models/transactions/escrowCreate.ts:20

    • Optional DestinationTag

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

    Optional

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

    • Optional Fee

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

    Optional

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

    • Optional FinishAfter

    FinishAfter?: number
    @@ -139,7 +139,7 @@

    Optional

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

    • Optional Flags

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

    Optional

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

    • Optional LastLedgerSequence

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

    Optional

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

    • Optional Memos

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

    Optional

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

    • Optional NetworkID

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

    Optional

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

    • Optional Sequence

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

    Optional

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

    • Optional Signers

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

    Optional

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

    • Optional SigningPubKey

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

    Optional

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

    • Optional SourceTag

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

    Optional

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

    • Optional TicketSequence

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

    Optional

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

    • TransactionType

    TransactionType: "EscrowCreate"
    @@ -232,7 +232,7 @@

    TransactionType

    Overrides BaseTransaction.TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/escrowCreate.ts:12

    • Optional TxnSignature

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

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:159
    • @@ -524,6 +524,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -537,8 +540,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -576,7 +577,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/EscrowFinish.html b/docs/interfaces/EscrowFinish.html index 2a5e8ccf16..6e965e887f 100644 --- a/docs/interfaces/EscrowFinish.html +++ b/docs/interfaces/EscrowFinish.html @@ -31,7 +31,7 @@

    Hierarchy

    • EscrowFinish
    +
  • Defined in packages/xrpl/src/models/transactions/escrowFinish.ts:10
    • @@ -67,7 +67,7 @@

    Account

    Inherited from BaseTransaction.Account

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

    • Optional AccountTxnID

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

    Optional

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

    • Optional Condition

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

    Optional

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

    • Optional Fee

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

    Optional

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

    • Optional Flags

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

    Optional

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

    • Optional Fulfillment

    Fulfillment?: string
    @@ -111,7 +111,7 @@

    Optional

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

    • Optional LastLedgerSequence

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

    Optional

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

    • Optional Memos

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

    Optional

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

    • Optional NetworkID

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

    Optional

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

    • OfferSequence

    OfferSequence: number
    @@ -145,14 +145,14 @@

    OfferSequence

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

    • Owner

    Owner: string

    Address of the source account that funded the held payment.

    +
  • Defined in packages/xrpl/src/models/transactions/escrowFinish.ts:13

    • Optional Sequence

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

    Optional

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

    • Optional Signers

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

    Optional

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

    • Optional SigningPubKey

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

    Optional

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

    • Optional SourceTag

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

    Optional

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

    • Optional TicketSequence

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

    Optional

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

    • TransactionType

    TransactionType: "EscrowFinish"
    @@ -211,7 +211,7 @@

    TransactionType

    Overrides BaseTransaction.TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/escrowFinish.ts:11

    • Optional TxnSignature

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

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:159
    • @@ -501,6 +501,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -514,8 +517,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -553,7 +554,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/FeeRequest.html b/docs/interfaces/FeeRequest.html index 9e6e8a6c59..9b3fd95c8b 100644 --- a/docs/interfaces/FeeRequest.html +++ b/docs/interfaces/FeeRequest.html @@ -36,7 +36,7 @@

    Hierarchy

    • FeeRequest
    +
  • Defined in packages/xrpl/src/models/methods/fee.ts:17
    • @@ -57,7 +57,7 @@

    Optional

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

    • command

    command: "fee"
    @@ -65,7 +65,7 @@

    command

    Overrides BaseRequest.command

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

    • Optional id

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

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12
    • @@ -341,6 +341,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -354,8 +357,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -393,7 +394,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/FeeResponse.html b/docs/interfaces/FeeResponse.html index b18343f522..6b2bf6f529 100644 --- a/docs/interfaces/FeeResponse.html +++ b/docs/interfaces/FeeResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • FeeResponse
    +
  • Defined in packages/xrpl/src/models/methods/fee.ts:26
    • @@ -55,19 +55,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;
    }
    @@ -146,31 +146,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
    • @@ -441,6 +441,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -454,8 +457,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -493,7 +494,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/GatewayBalance.html b/docs/interfaces/GatewayBalance.html index a5c64e2be1..6147551d95 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
    • @@ -313,6 +313,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -326,8 +329,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -365,7 +366,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/GatewayBalancesRequest.html b/docs/interfaces/GatewayBalancesRequest.html index a5dd04b878..5d013492f4 100644 --- a/docs/interfaces/GatewayBalancesRequest.html +++ b/docs/interfaces/GatewayBalancesRequest.html @@ -37,7 +37,7 @@

    Hierarchy

    • GatewayBalancesRequest
    +
  • Defined in packages/xrpl/src/models/methods/gatewayBalances.ts:22
    • @@ -62,7 +62,7 @@

    account

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

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

    • Optional api_version

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

    Optional

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

    • command

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

    command

    Overrides BaseRequest.command

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

    • Optional hotwallet

    hotwallet?: string | string[]
    @@ -86,7 +86,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/gatewayBalances.ts:37

    • Optional id

    id?: string | number
    @@ -96,7 +96,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
    @@ -112,7 +112,7 @@

    Optional

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

    • Optional strict

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

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/gatewayBalances.ts:32
    • @@ -391,6 +391,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -404,8 +407,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -443,7 +444,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/GatewayBalancesResponse.html b/docs/interfaces/GatewayBalancesResponse.html index 32c5bdbbc1..40fddee686 100644 --- a/docs/interfaces/GatewayBalancesResponse.html +++ b/docs/interfaces/GatewayBalancesResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • GatewayBalancesResponse
    +
  • Defined in packages/xrpl/src/models/methods/gatewayBalances.ts:50
    • @@ -55,19 +55,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;
        };
    }
    @@ -119,31 +119,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
    • @@ -414,6 +414,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -427,8 +430,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -466,7 +467,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/IssuedCurrency.html b/docs/interfaces/IssuedCurrency.html index d5af69db22..bd1ed57baa 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:7
    • @@ -45,12 +45,12 @@

    Properties

    currency

    currency: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:8

    • issuer

    issuer: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:9
    • @@ -315,6 +315,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -328,8 +331,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -367,7 +368,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/IssuedCurrencyAmount.html b/docs/interfaces/IssuedCurrencyAmount.html index 008d5fc527..241a6603f6 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:14
    • @@ -47,18 +47,18 @@

    currencycurrency: string

    +
  • Defined in packages/xrpl/src/models/common/index.ts:8

    • issuer

    issuer: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:9

    • value

    value: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:15
    • @@ -324,6 +324,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -337,8 +340,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -376,7 +377,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/JobType.html b/docs/interfaces/JobType.html index a68d4aedaf..108991d03a 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
    • @@ -334,6 +334,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -347,8 +350,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -386,7 +387,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerBinary.html b/docs/interfaces/LedgerBinary.html index b555738fea..7982e1447c 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:93
    • @@ -57,7 +57,7 @@

    Properties

    Optional accountState

    accountState?: string[]
    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:95

    • account_hash

    account_hash: string
    @@ -65,7 +65,7 @@

    account_hash

    Inherited from Omit.account_hash

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:13

    • close_flags

    close_flags: number
    @@ -73,7 +73,7 @@

    close_flags

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:17

    • close_time

    close_time: number
    @@ -83,7 +83,7 @@

    close_time

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:23

    • close_time_human

    close_time_human: string
    @@ -92,7 +92,7 @@

    close_time_human

    Inherited from Omit.close_time_human

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:28

    • close_time_resolution

    close_time_resolution: number
    @@ -101,7 +101,7 @@

    close_time_resolution

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:33

    • closed

    closed: boolean
    @@ -109,7 +109,7 @@

    closed

    Inherited from Omit.closed

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:35

    • ledger_hash

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

    ledger_hash

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:40

    • ledger_index

    ledger_index: string
    @@ -127,7 +127,7 @@

    ledger_index

    Inherited from Omit.ledger_index

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:45

    • parent_close_time

    parent_close_time: number
    @@ -135,7 +135,7 @@

    parent_close_time

    Inherited from Omit.parent_close_time

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:47

    • parent_hash

    parent_hash: string
    @@ -144,7 +144,7 @@

    parent_hash

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:52

    • total_coins

    total_coins: string
    @@ -152,7 +152,7 @@

    total_coins

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:54

    • transaction_hash

    transaction_hash: string
    @@ -160,12 +160,12 @@

    transaction_hash

    Inherited from Omit.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:96
    • @@ -442,6 +442,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -455,8 +458,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -494,7 +495,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerClosedRequest.html b/docs/interfaces/LedgerClosedRequest.html index af17c72dfa..8cc7b0e135 100644 --- a/docs/interfaces/LedgerClosedRequest.html +++ b/docs/interfaces/LedgerClosedRequest.html @@ -38,7 +38,7 @@

    Hierarchy

    • LedgerClosedRequest
    +
  • Defined in packages/xrpl/src/models/methods/ledgerClosed.ts:18
    • @@ -59,7 +59,7 @@

    Optional

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

    • command

    command: "ledger_closed"
    @@ -67,7 +67,7 @@

    command

    Overrides BaseRequest.command

    +
  • Defined in packages/xrpl/src/models/methods/ledgerClosed.ts:19

    • Optional id

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

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12
    • @@ -343,6 +343,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -356,8 +359,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -395,7 +396,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerClosedResponse.html b/docs/interfaces/LedgerClosedResponse.html index 3b97b71c0a..891aa8d0c9 100644 --- a/docs/interfaces/LedgerClosedResponse.html +++ b/docs/interfaces/LedgerClosedResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • LedgerClosedResponse
    +
  • Defined in packages/xrpl/src/models/methods/ledgerClosed.ts:27
    • @@ -55,19 +55,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;
    }
    @@ -80,31 +80,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
    • @@ -375,6 +375,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -388,8 +391,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -427,7 +428,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerCurrentRequest.html b/docs/interfaces/LedgerCurrentRequest.html index 109a739494..3360d682b5 100644 --- a/docs/interfaces/LedgerCurrentRequest.html +++ b/docs/interfaces/LedgerCurrentRequest.html @@ -35,7 +35,7 @@

    Hierarchy

    • LedgerCurrentRequest
    +
  • Defined in packages/xrpl/src/models/methods/ledgerCurrent.ts:17
    • @@ -56,7 +56,7 @@

    Optional

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

    • command

    command: "ledger_current"
    @@ -64,7 +64,7 @@

    command

    Overrides BaseRequest.command

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

    • Optional id

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

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12
    • @@ -340,6 +340,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -353,8 +356,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -392,7 +393,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerCurrentResponse.html b/docs/interfaces/LedgerCurrentResponse.html index f0c4e2b019..81c982385e 100644 --- a/docs/interfaces/LedgerCurrentResponse.html +++ b/docs/interfaces/LedgerCurrentResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • LedgerCurrentResponse
    +
  • Defined in packages/xrpl/src/models/methods/ledgerCurrent.ts:26
    • @@ -55,19 +55,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;
    }
    @@ -80,31 +80,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
    • @@ -375,6 +375,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -388,8 +391,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -427,7 +428,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerDataBinaryLedgerEntry.html b/docs/interfaces/LedgerDataBinaryLedgerEntry.html index dc58b5617c..79e2c8de2d 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:46
    • @@ -42,7 +42,7 @@

    Properties

    data

    data: string
    +
  • Defined in packages/xrpl/src/models/methods/ledgerData.ts:47
    • @@ -306,6 +306,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -319,8 +322,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -358,7 +359,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerDataRequest.html b/docs/interfaces/LedgerDataRequest.html index 7bc6bfd6d3..5b031d39d2 100644 --- a/docs/interfaces/LedgerDataRequest.html +++ b/docs/interfaces/LedgerDataRequest.html @@ -37,7 +37,7 @@

    Hierarchy

    • LedgerDataRequest
    +
  • Defined in packages/xrpl/src/models/methods/ledgerData.ts:23
    • @@ -63,7 +63,7 @@

    Optional

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

    • Optional binary

    binary?: boolean
    @@ -71,7 +71,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ledgerData.ts:29

    • command

    command: "ledger_data"
    @@ -79,7 +79,7 @@

    command

    Overrides BaseRequest.command

    +
  • Defined in packages/xrpl/src/models/methods/ledgerData.ts:24

    • 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
    @@ -97,7 +97,7 @@

    Optional

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

    • Optional ledger_index

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

    Optional

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

    • Optional limit

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

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ledgerData.ts:34

    • Optional marker

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

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ledgerData.ts:39
    • @@ -392,6 +392,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -405,8 +408,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -444,7 +445,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerDataResponse.html b/docs/interfaces/LedgerDataResponse.html index d54c2e9598..88d9aa6b9d 100644 --- a/docs/interfaces/LedgerDataResponse.html +++ b/docs/interfaces/LedgerDataResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • LedgerDataResponse
    +
  • Defined in packages/xrpl/src/models/methods/ledgerData.ts:60
    • @@ -55,19 +55,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;
    }
    @@ -96,31 +96,31 @@
    stateOptional validated?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/ledgerData.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
    • @@ -391,6 +391,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -404,8 +407,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -443,7 +444,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerEntry.AccountRoot.html b/docs/interfaces/LedgerEntry.AccountRoot.html index 18b502b2bd..7e06413032 100644 --- a/docs/interfaces/LedgerEntry.AccountRoot.html +++ b/docs/interfaces/LedgerEntry.AccountRoot.html @@ -33,7 +33,7 @@

    Hierarchy

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

    Account

    The identifying (classic) address of this account.

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

    • Optional AccountTxnID

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

    OptionalasfAccountTxnID flag enabled.

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

    • Balance

    Balance: string

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

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

    • Optional BurnedNFTokens

    BurnedNFTokens?: number

    Total NFTokens this account's issued that have been burned. This number is always equal or less than MintedNFTokens.

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

    • Optional Domain

    Domain?: string
    @@ -104,33 +104,33 @@

    Optional

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

    • Optional EmailHash

    EmailHash?: string

    The md5 hash of an email address.

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

    • FirstNFTSequence

    FirstNFTSequence: number

    The sequence that the account first minted an NFToken

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

    • Flags

    Flags: number

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

    +
  • 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
    @@ -138,21 +138,21 @@

    Optional

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

    • Optional MintedNFTokens

    MintedNFTokens?: number

    Total NFTokens have been minted by and on behalf of this account.

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

    • Optional NFTokenMinter

    NFTokenMinter?: string

    Another account that can mint NFTokens on behalf of this account.

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

    • OwnerCount

    OwnerCount: number
    @@ -160,7 +160,7 @@

    OwnerCount

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

    • PreviousTxnID

    PreviousTxnID: string
    @@ -168,7 +168,7 @@

    PreviousTxnID

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

    • PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    @@ -176,7 +176,7 @@

    PreviousTxnLgrSeq

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

    • Optional RegularKey

    RegularKey?: string
    @@ -185,14 +185,14 @@

    Optional

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

    • Sequence

    Sequence: number

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

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

    • Optional TickSize

    TickSize?: number
    @@ -200,7 +200,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:69

    • Optional TicketCount

    TicketCount?: number
    @@ -209,7 +209,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:64

    • Optional TransferRate

    TransferRate?: number
    @@ -217,20 +217,20 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:74

    • Optional WalletLocator

    WalletLocator?: string

    An arbitrary 256-bit value that users can set.

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:76

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • @@ -515,6 +515,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -528,8 +531,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -567,7 +568,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerEntry.AccountRootFlagsInterface.html b/docs/interfaces/LedgerEntry.AccountRootFlagsInterface.html index 304e3e5928..10bafa004a 100644 --- a/docs/interfaces/LedgerEntry.AccountRootFlagsInterface.html +++ b/docs/interfaces/LedgerEntry.AccountRootFlagsInterface.html @@ -31,7 +31,7 @@

    Hierarchy

    • AccountRootFlagsInterface
    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:91
    • @@ -61,7 +61,7 @@

    Optional

    Enable rippling on this address's trust lines by default. Required for issuing addresses; discouraged for others.

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:123

    • Optional lsfDepositAuth

    lsfDepositAuth?: boolean
    @@ -69,84 +69,84 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:128

    • Optional lsfDisableMaster

    lsfDisableMaster?: boolean

    Disallows use of the master key to sign transactions for this account.

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:111

    • Optional lsfDisallowIncomingCheck

    lsfDisallowIncomingCheck?: boolean

    Disallow incoming Checks from other accounts.

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:136

    • Optional lsfDisallowIncomingNFTokenOffer

    lsfDisallowIncomingNFTokenOffer?: boolean

    Disallow incoming NFTOffers from other accounts.

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:132

    • Optional lsfDisallowIncomingPayChan

    lsfDisallowIncomingPayChan?: boolean

    Disallow incoming PayChannels from other accounts.

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:140

    • Optional lsfDisallowIncomingTrustline

    lsfDisallowIncomingTrustline?: boolean

    Disallow incoming Trustlines from other accounts.

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:144

    • Optional lsfDisallowXRP

    lsfDisallowXRP?: boolean

    Client applications should not send XRP to this account. Not enforced by rippled.

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:107

    • Optional lsfGlobalFreeze

    lsfGlobalFreeze?: boolean

    All assets issued by this address are frozen.

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:119

    • Optional lsfNoFreeze

    lsfNoFreeze?: boolean

    This address cannot freeze trust lines connected to it. Once enabled, cannot be disabled.

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:115

    • Optional lsfPasswordSpent

    lsfPasswordSpent?: boolean

    The account has used its free SetRegularKey transaction.

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:95

    • Optional lsfRequireAuth

    lsfRequireAuth?: boolean

    This account must individually approve other users for those users to hold this account's issued currencies.

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:103

    • Optional lsfRequireDestTag

    lsfRequireDestTag?: boolean

    Requires incoming payments to specify a Destination Tag.

    +
  • Defined in packages/xrpl/src/models/ledger/AccountRoot.ts:99
    • @@ -422,6 +422,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -435,8 +438,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -474,7 +475,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerEntry.Amendments.html b/docs/interfaces/LedgerEntry.Amendments.html index 2fd087924e..7f5e9acb47 100644 --- a/docs/interfaces/LedgerEntry.Amendments.html +++ b/docs/interfaces/LedgerEntry.Amendments.html @@ -33,7 +33,7 @@

    Hierarchy

    • Amendments
    +
  • Defined in packages/xrpl/src/models/ledger/Amendments.ts:27
    • @@ -56,7 +56,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/Amendments.ts:33

    • Flags

    Flags: 0
    @@ -64,12 +64,12 @@

    Flags

    +
  • Defined in packages/xrpl/src/models/ledger/Amendments.ts:44

    • LedgerEntryType

    LedgerEntryType: "Amendments"
    +
  • Defined in packages/xrpl/src/models/ledger/Amendments.ts:28

    • Optional Majorities

    Majorities?: Majority[]
    @@ -78,13 +78,13 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/Amendments.ts:39

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • @@ -352,6 +352,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -365,8 +368,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -404,7 +405,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerEntry.Check.html b/docs/interfaces/LedgerEntry.Check.html index e642818a2d..66cb61cf3c 100644 --- a/docs/interfaces/LedgerEntry.Check.html +++ b/docs/interfaces/LedgerEntry.Check.html @@ -33,7 +33,7 @@

    Hierarchy

    • Check
    +
  • Defined in packages/xrpl/src/models/ledger/Check.ts:11
    • @@ -65,7 +65,7 @@

    Account

    The sender of the Check. Cashing the Check debits this address's balance.

    +
  • Defined in packages/xrpl/src/models/ledger/Check.ts:14

    • Destination

    Destination: string
    @@ -73,7 +73,7 @@

    Destination

    +
  • Defined in packages/xrpl/src/models/ledger/Check.ts:19

    • Optional DestinationNode

    DestinationNode?: string
    @@ -81,7 +81,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/Check.ts:52

    • Optional DestinationTag

    DestinationTag?: number
    @@ -89,14 +89,14 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/Check.ts:57

    • Optional Expiration

    Expiration?: number

    Indicates the time after which this Check is considered expired.

    +
  • Defined in packages/xrpl/src/models/ledger/Check.ts:59

    • Flags

    Flags: 0
    @@ -104,7 +104,7 @@

    Flags

    +
  • Defined in packages/xrpl/src/models/ledger/Check.ts:24

    • Optional InvoiceID

    InvoiceID?: string
    @@ -112,12 +112,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
    @@ -125,7 +125,7 @@

    OwnerNode

    +
  • Defined in packages/xrpl/src/models/ledger/Check.ts:29

    • PreviousTxnID

    PreviousTxnID: string
    @@ -133,7 +133,7 @@

    PreviousTxnID

    +
  • Defined in packages/xrpl/src/models/ledger/Check.ts:34

    • PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    @@ -141,7 +141,7 @@

    PreviousTxnLgrSeq

    +
  • Defined in packages/xrpl/src/models/ledger/Check.ts:39

    • SendMax

    SendMax: Amount
    @@ -150,14 +150,14 @@

    SendMax

    +
  • Defined in packages/xrpl/src/models/ledger/Check.ts:45

    • Sequence

    Sequence: number

    The sequence number of the CheckCreate transaction that created this check.

    +
  • Defined in packages/xrpl/src/models/ledger/Check.ts:47

    • Optional SourceTag

    SourceTag?: number
    @@ -165,13 +165,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
    • @@ -449,6 +449,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -462,8 +465,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -501,7 +502,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerEntry.DepositPreauth.html b/docs/interfaces/LedgerEntry.DepositPreauth.html index e87cbf3eca..ca1249f025 100644 --- a/docs/interfaces/LedgerEntry.DepositPreauth.html +++ b/docs/interfaces/LedgerEntry.DepositPreauth.html @@ -33,7 +33,7 @@

    Hierarchy

    • DepositPreauth
    +
  • Defined in packages/xrpl/src/models/ledger/DepositPreauth.ts:9
    • @@ -58,14 +58,14 @@

    Account

    The account that granted the preauthorization.

    +
  • Defined in packages/xrpl/src/models/ledger/DepositPreauth.ts:12

    • Authorize

    Authorize: string

    The account that received the preauthorization.

    +
  • Defined in packages/xrpl/src/models/ledger/DepositPreauth.ts:14

    • Flags

    Flags: 0
    @@ -73,12 +73,12 @@

    Flags

    +
  • Defined in packages/xrpl/src/models/ledger/DepositPreauth.ts:19

    • LedgerEntryType

    LedgerEntryType: "DepositPreauth"
    +
  • Defined in packages/xrpl/src/models/ledger/DepositPreauth.ts:10

    • OwnerNode

    OwnerNode: string
    @@ -86,7 +86,7 @@

    OwnerNode

    +
  • Defined in packages/xrpl/src/models/ledger/DepositPreauth.ts:24

    • PreviousTxnID

    PreviousTxnID: string
    @@ -94,7 +94,7 @@

    PreviousTxnID

    +
  • Defined in packages/xrpl/src/models/ledger/DepositPreauth.ts:29

    • PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    @@ -102,13 +102,13 @@

    PreviousTxnLgrSeq

    +
  • Defined in packages/xrpl/src/models/ledger/DepositPreauth.ts:34

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • @@ -379,6 +379,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -392,8 +395,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -431,7 +432,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerEntry.DirectoryNode.html b/docs/interfaces/LedgerEntry.DirectoryNode.html index 5c1bd418da..e7387c4396 100644 --- a/docs/interfaces/LedgerEntry.DirectoryNode.html +++ b/docs/interfaces/LedgerEntry.DirectoryNode.html @@ -33,7 +33,7 @@

    Hierarchy

    • DirectoryNode
    +
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:9
    • @@ -63,7 +63,7 @@

    Flags

    +
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:15

    • Optional IndexNext

    IndexNext?: number
    @@ -71,7 +71,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:24

    • Optional IndexPrevious

    IndexPrevious?: number
    @@ -79,33 +79,33 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:29

    • Indexes

    Indexes: string[]

    The contents of this Directory: an array of IDs of other objects.

    +
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:19

    • LedgerEntryType

    LedgerEntryType: "DirectoryNode"
    +
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:10

    • Optional Owner

    Owner?: string

    The address of the account that owns the objects in this directory.

    +
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:31

    • RootIndex

    RootIndex: string

    The ID of root object for this directory.

    +
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:17

    • Optional TakerGetsCurrency

    TakerGetsCurrency?: string
    @@ -113,14 +113,14 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:43

    • Optional TakerGetsIssuer

    TakerGetsIssuer?: string

    The issuer of the TakerGets amount from the offers in this directory.

    +
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:45

    • Optional TakerPaysCurrency

    TakerPaysCurrency?: string
    @@ -128,20 +128,20 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:36

    • Optional TakerPaysIssuer

    TakerPaysIssuer?: string

    The issuer of the TakerPays amount from the offers in this directory.

    +
  • Defined in packages/xrpl/src/models/ledger/DirectoryNode.ts:38

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • @@ -416,6 +416,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -429,8 +432,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -468,7 +469,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerEntry.Escrow.html b/docs/interfaces/LedgerEntry.Escrow.html index 1fabd06131..9a6a241c33 100644 --- a/docs/interfaces/LedgerEntry.Escrow.html +++ b/docs/interfaces/LedgerEntry.Escrow.html @@ -33,7 +33,7 @@

    Hierarchy

    • Escrow
    +
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:9
    • @@ -67,21 +67,21 @@

    Account

    +
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:16

    • Amount

    Amount: string

    The amount of XRP, in drops, to be delivered by the held payment.

    +
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:23

    • Optional CancelAfter

    CancelAfter?: number

    The time after which this Escrow is considered expired.

    +
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:33

    • Optional Condition

    Condition?: string
    @@ -90,7 +90,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:29

    • Destination

    Destination: string
    @@ -98,7 +98,7 @@

    Destination

    +
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:21

    • Optional DestinationNode

    DestinationNode?: string
    @@ -106,7 +106,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:63

    • Optional DestinationTag

    DestinationTag?: number
    @@ -114,7 +114,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:53

    • Optional FinishAfter

    FinishAfter?: number
    @@ -122,7 +122,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:38

    • Flags

    Flags: number
    @@ -130,12 +130,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
    @@ -143,7 +143,7 @@

    OwnerNode

    +
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:58

    • PreviousTxnID

    PreviousTxnID: string
    @@ -151,7 +151,7 @@

    PreviousTxnID

    +
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:68

    • PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    @@ -159,7 +159,7 @@

    PreviousTxnLgrSeq

    +
  • Defined in packages/xrpl/src/models/ledger/Escrow.ts:73

    • Optional SourceTag

    SourceTag?: number
    @@ -167,13 +167,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
    • @@ -451,6 +451,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -464,8 +467,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -503,7 +504,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerEntry.FeeSettings.html b/docs/interfaces/LedgerEntry.FeeSettings.html index be202a490d..a7e284723c 100644 --- a/docs/interfaces/LedgerEntry.FeeSettings.html +++ b/docs/interfaces/LedgerEntry.FeeSettings.html @@ -36,7 +36,7 @@

    Hierarchy

    • FeeSettings
    +
  • Defined in packages/xrpl/src/models/ledger/FeeSettings.ts:49
    • @@ -56,17 +56,17 @@

    Flags

    A bit-map of boolean flags for this object. No flags are defined for this type.

    +
  • Defined in packages/xrpl/src/models/ledger/FeeSettings.ts:34

    • LedgerEntryType

    LedgerEntryType: "FeeSettings"
    +
  • Defined in packages/xrpl/src/models/ledger/FeeSettings.ts:30

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • @@ -332,6 +332,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -345,8 +348,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -384,7 +385,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerEntry.FeeSettingsPostAmendmentFields.html b/docs/interfaces/LedgerEntry.FeeSettingsPostAmendmentFields.html index 7893c2c74c..7af631cbd2 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
    • @@ -47,21 +47,21 @@

    BaseFeeDrops

    The transaction cost of the "reference transaction" in drops of XRP as hexadecimal.

    +
  • Defined in packages/xrpl/src/models/ledger/FeeSettings.ts:22

    • ReserveBaseDrops

    ReserveBaseDrops: string

    The base reserve for an account in the XRP Ledger, as drops of XRP.

    +
  • Defined in packages/xrpl/src/models/ledger/FeeSettings.ts:24

    • ReserveIncrementDrops

    ReserveIncrementDrops: string

    The incremental owner reserve for owning objects, as drops of XRP.

    +
  • Defined in packages/xrpl/src/models/ledger/FeeSettings.ts:26
    • @@ -327,6 +327,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -340,8 +343,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -379,7 +380,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerEntry.FeeSettingsPreAmendmentFields.html b/docs/interfaces/LedgerEntry.FeeSettingsPreAmendmentFields.html index 9e141224e0..f6d3ac1dc8 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
    • @@ -48,28 +48,28 @@

    BaseFee

    The transaction cost of the "reference transaction" in drops of XRP as hexadecimal.

    +
  • Defined in packages/xrpl/src/models/ledger/FeeSettings.ts:11

    • ReferenceFeeUnits

    ReferenceFeeUnits: number

    The BaseFee translated into "fee units".

    +
  • Defined in packages/xrpl/src/models/ledger/FeeSettings.ts:13

    • ReserveBase

    ReserveBase: number

    The base reserve for an account in the XRP Ledger, as drops of XRP.

    +
  • Defined in packages/xrpl/src/models/ledger/FeeSettings.ts:15

    • ReserveIncrement

    ReserveIncrement: number

    The incremental owner reserve for owning objects, as drops of XRP.

    +
  • Defined in packages/xrpl/src/models/ledger/FeeSettings.ts:17
    • @@ -336,6 +336,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -349,8 +352,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -388,7 +389,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerEntry.Ledger.html b/docs/interfaces/LedgerEntry.Ledger.html index dee0003694..39e776fba6 100644 --- a/docs/interfaces/LedgerEntry.Ledger.html +++ b/docs/interfaces/LedgerEntry.Ledger.html @@ -31,7 +31,7 @@

    Hierarchy

    • Ledger
    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:11
    • @@ -62,21 +62,21 @@

    Optional

    All the state information in this ledger.

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:15

    • account_hash

    account_hash: string

    The SHA-512Half of this ledger's state tree information.

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:13

    • close_flags

    close_flags: number

    A bit-map of flags relating to the closing of this ledger.

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:17

    • close_time

    close_time: number
    @@ -85,7 +85,7 @@

    close_time

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:23

    • close_time_human

    close_time_human: string
    @@ -93,7 +93,7 @@

    close_time_human

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:28

    • close_time_resolution

    close_time_resolution: number
    @@ -101,14 +101,14 @@

    close_time_resolution

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:33

    • closed

    closed: boolean

    Whether or not this ledger has been closed.

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:35

    • ledger_hash

    ledger_hash: string
    @@ -116,7 +116,7 @@

    ledger_hash

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:40

    • ledger_index

    ledger_index: string
    @@ -124,14 +124,14 @@

    ledger_index

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:45

    • parent_close_time

    parent_close_time: number

    The approximate time at which the previous ledger was closed.

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:47

    • parent_hash

    parent_hash: string
    @@ -139,21 +139,21 @@

    parent_hash

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:52

    • total_coins

    total_coins: string

    Total number of XRP drops in the network, as a quoted integer.

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:54

    • transaction_hash

    transaction_hash: string

    Hash of the transaction information included in this ledger, as hex.

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:56

    • Optional transactions

    transactions?: Object[]
    @@ -164,7 +164,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/Ledger.ts:64
    • @@ -441,6 +441,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -454,8 +457,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -493,7 +494,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerEntry.LedgerHashes.html b/docs/interfaces/LedgerEntry.LedgerHashes.html index 173ee52206..6b43bd3889 100644 --- a/docs/interfaces/LedgerEntry.LedgerHashes.html +++ b/docs/interfaces/LedgerEntry.LedgerHashes.html @@ -34,7 +34,7 @@

    Hierarchy

    • LedgerHashes
    +
  • Defined in packages/xrpl/src/models/ledger/LedgerHashes.ts:10
    • @@ -57,7 +57,7 @@

    Flags

    +
  • Defined in packages/xrpl/src/models/ledger/LedgerHashes.ts:23

    • Hashes

    Hashes: string[]
    @@ -65,25 +65,25 @@

    Hashes

    +
  • Defined in packages/xrpl/src/models/ledger/LedgerHashes.ts:18

    • Optional LastLedgerSequence

    LastLedgerSequence?: number

    The Ledger Index of the last entry in this object's Hashes array.

    +
  • Defined in packages/xrpl/src/models/ledger/LedgerHashes.ts:13

    • LedgerEntryType

    LedgerEntryType: "LedgerHashes"
    +
  • Defined in packages/xrpl/src/models/ledger/LedgerHashes.ts:11

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • @@ -351,6 +351,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -364,8 +367,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -403,7 +404,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerEntry.Majority.html b/docs/interfaces/LedgerEntry.Majority.html index 36c4615d87..ed64048f14 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
    • @@ -55,7 +55,7 @@
    CloseTime
    +
  • Defined in packages/xrpl/src/models/ledger/Amendments.ts:10
    • @@ -319,6 +319,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -332,8 +335,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -371,7 +372,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerEntry.NFToken.html b/docs/interfaces/LedgerEntry.NFToken.html index 4072409c6a..b9530cacc9 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
    • @@ -320,6 +320,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -333,8 +336,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -372,7 +373,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerEntry.NFTokenOffer.html b/docs/interfaces/LedgerEntry.NFTokenOffer.html index 6aa9479b46..1547b7a5c1 100644 --- a/docs/interfaces/LedgerEntry.NFTokenOffer.html +++ b/docs/interfaces/LedgerEntry.NFTokenOffer.html @@ -29,7 +29,7 @@

    Hierarchy

    • NFTokenOffer
    +
  • Defined in packages/xrpl/src/models/ledger/NFTokenOffer.ts:5
    • @@ -55,58 +55,58 @@

    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
    +
  • Defined in packages/xrpl/src/models/ledger/NFTokenOffer.ts:14

    • PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    +
  • Defined in packages/xrpl/src/models/ledger/NFTokenOffer.ts:15

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • @@ -380,6 +380,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -393,8 +396,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -432,7 +433,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerEntry.NFTokenPage.html b/docs/interfaces/LedgerEntry.NFTokenPage.html index a954465d4c..73ac8d6c52 100644 --- a/docs/interfaces/LedgerEntry.NFTokenPage.html +++ b/docs/interfaces/LedgerEntry.NFTokenPage.html @@ -29,7 +29,7 @@

    Hierarchy

    • NFTokenPage
    +
  • Defined in packages/xrpl/src/models/ledger/NFTokenPage.ts:13
    • @@ -51,38 +51,38 @@

    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

    • Optional PreviousTxnID

    PreviousTxnID?: string
    +
  • Defined in packages/xrpl/src/models/ledger/NFTokenPage.ts:18

    • Optional PreviousTxnLgrSeq

    PreviousTxnLgrSeq?: number
    +
  • Defined in packages/xrpl/src/models/ledger/NFTokenPage.ts:19

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • @@ -352,6 +352,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -365,8 +368,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -404,7 +405,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerEntry.NegativeUNL.html b/docs/interfaces/LedgerEntry.NegativeUNL.html index 6528e0411b..06e3d82228 100644 --- a/docs/interfaces/LedgerEntry.NegativeUNL.html +++ b/docs/interfaces/LedgerEntry.NegativeUNL.html @@ -33,7 +33,7 @@

    Hierarchy

    • NegativeUNL
    +
  • Defined in packages/xrpl/src/models/ledger/NegativeUNL.ts:15
    • @@ -55,12 +55,12 @@

    Optional

    A list of trusted validators that are currently disabled.

    +
  • Defined in packages/xrpl/src/models/ledger/NegativeUNL.ts:20

    • LedgerEntryType

    LedgerEntryType: "NegativeUNL"
    +
  • Defined in packages/xrpl/src/models/ledger/NegativeUNL.ts:16

    • Optional ValidatorToDisable

    ValidatorToDisable?: string
    @@ -68,7 +68,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/NegativeUNL.ts:28

    • Optional ValidatorToReEnable

    ValidatorToReEnable?: string
    @@ -76,13 +76,13 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/NegativeUNL.ts:33

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • @@ -350,6 +350,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -363,8 +366,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -402,7 +403,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerEntry.Offer.html b/docs/interfaces/LedgerEntry.Offer.html index 9f2752973d..2beac0b88d 100644 --- a/docs/interfaces/LedgerEntry.Offer.html +++ b/docs/interfaces/LedgerEntry.Offer.html @@ -31,7 +31,7 @@

    Hierarchy

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:5
    • @@ -61,14 +61,14 @@

    Account

    The address of the account that placed this Offer.

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:10

    • BookDirectory

    BookDirectory: string

    The ID of the Offer Directory that links to this Offer.

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:24

    • BookNode

    BookNode: string
    @@ -76,26 +76,26 @@

    BookNode

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:29

    • Optional Expiration

    Expiration?: number

    The time this Offer expires, in seconds since the Ripple Epoch.

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:46

    • Flags

    Flags: number

    A bit-map of boolean flags enabled for this Offer.

    +
  • 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
    @@ -103,7 +103,7 @@

    OwnerNode

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:34

    • PreviousTxnID

    PreviousTxnID: string
    @@ -111,7 +111,7 @@

    PreviousTxnID

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:39

    • PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    @@ -119,7 +119,7 @@

    PreviousTxnLgrSeq

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:44

    • Sequence

    Sequence: number
    @@ -127,7 +127,7 @@

    Sequence

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:15

    • TakerGets

    TakerGets: Amount
    @@ -135,20 +135,20 @@

    TakerGets

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:22

    • TakerPays

    TakerPays: Amount

    The remaining amount and type of currency requested by the Offer creator.

    +
  • Defined in packages/xrpl/src/models/ledger/Offer.ts:17

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • @@ -424,6 +424,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -437,8 +440,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -476,7 +477,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerEntry.PayChannel.html b/docs/interfaces/LedgerEntry.PayChannel.html index 48b007fc2e..fcd43c3c97 100644 --- a/docs/interfaces/LedgerEntry.PayChannel.html +++ b/docs/interfaces/LedgerEntry.PayChannel.html @@ -36,7 +36,7 @@

    Hierarchy

    • PayChannel
    +
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:12
    • @@ -71,7 +71,7 @@

    Account

    +
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:18

    • Amount

    Amount: string
    @@ -81,7 +81,7 @@

    Amount

    +
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:32

    • Balance

    Balance: string
    @@ -91,7 +91,7 @@

    Balance

    +
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:39

    • Optional CancelAfter

    CancelAfter?: number
    @@ -101,7 +101,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:91

    • Destination

    Destination: string
    @@ -111,7 +111,7 @@

    Destination

    +
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:25

    • Optional DestinationNode

    DestinationNode?: string
    @@ -119,7 +119,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:106

    • Optional DestinationTag

    DestinationTag?: number
    @@ -127,7 +127,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:101

    • Optional Expiration

    Expiration?: number
    @@ -137,7 +137,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:84

    • Flags

    Flags: number
    @@ -145,12 +145,12 @@

    Flags

    +
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:77

    • LedgerEntryType

    LedgerEntryType: "PayChannel"
    +
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:13

    • OwnerNode

    OwnerNode: string
    @@ -158,7 +158,7 @@

    OwnerNode

    +
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:62

    • PreviousTxnID

    PreviousTxnID: string
    @@ -166,7 +166,7 @@

    PreviousTxnID

    +
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:67

    • PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    @@ -174,7 +174,7 @@

    PreviousTxnLgrSeq

    +
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:72

    • PublicKey

    PublicKey: string
    @@ -186,7 +186,7 @@

    PublicKey

    +
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:48

    • SettleDelay

    SettleDelay: number
    @@ -198,7 +198,7 @@

    SettleDelay

    +
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:57

    • Optional SourceTag

    SourceTag?: number
    @@ -206,13 +206,13 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/PayChannel.ts:96

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • @@ -492,6 +492,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -505,8 +508,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -544,7 +545,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerEntry.RippleState.html b/docs/interfaces/LedgerEntry.RippleState.html index a7e7e408ac..0a543da72f 100644 --- a/docs/interfaces/LedgerEntry.RippleState.html +++ b/docs/interfaces/LedgerEntry.RippleState.html @@ -32,7 +32,7 @@

    Hierarchy

    • RippleState
    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:10
    • @@ -65,14 +65,14 @@

    Balance

    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:19

    • Flags

    Flags: number

    A bit-map of boolean options enabled for this object.

    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:13

    • HighLimit

    HighLimit: IssuedCurrencyAmount
    @@ -80,7 +80,7 @@

    HighLimit

    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:29

    • Optional HighNode

    HighNode?: string
    @@ -88,7 +88,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:49

    • Optional HighQualityIn

    HighQualityIn?: number
    @@ -97,7 +97,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:67

    • Optional HighQualityOut

    HighQualityOut?: number
    @@ -106,12 +106,12 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:73

    • LedgerEntryType

    LedgerEntryType: "RippleState"
    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:11

    • LowLimit

    LowLimit: IssuedCurrencyAmount
    @@ -119,7 +119,7 @@

    LowLimit

    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:24

    • Optional LowNode

    LowNode?: string
    @@ -127,7 +127,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:44

    • Optional LowQualityIn

    LowQualityIn?: number
    @@ -136,7 +136,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:55

    • Optional LowQualityOut

    LowQualityOut?: number
    @@ -145,7 +145,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:61

    • PreviousTxnID

    PreviousTxnID: string
    @@ -153,7 +153,7 @@

    PreviousTxnID

    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:34

    • PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    @@ -161,13 +161,13 @@

    PreviousTxnLgrSeq

    +
  • Defined in packages/xrpl/src/models/ledger/RippleState.ts:39

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • @@ -444,6 +444,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -457,8 +460,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -496,7 +497,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerEntry.SignerList.html b/docs/interfaces/LedgerEntry.SignerList.html index 060ebf8155..1c04bd526d 100644 --- a/docs/interfaces/LedgerEntry.SignerList.html +++ b/docs/interfaces/LedgerEntry.SignerList.html @@ -35,7 +35,7 @@

    Hierarchy

    • SignerList
    +
  • Defined in packages/xrpl/src/models/ledger/SignerList.ts:13
    • @@ -62,12 +62,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
    @@ -75,7 +75,7 @@

    OwnerNode

    +
  • Defined in packages/xrpl/src/models/ledger/SignerList.ts:34

    • PreviousTxnID

    PreviousTxnID: string
    @@ -83,7 +83,7 @@

    PreviousTxnID

    +
  • Defined in packages/xrpl/src/models/ledger/SignerList.ts:24

    • PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    @@ -91,7 +91,7 @@

    PreviousTxnLgrSeq

    +
  • Defined in packages/xrpl/src/models/ledger/SignerList.ts:29

    • SignerEntries

    SignerEntries: SignerEntry[]
    @@ -99,7 +99,7 @@

    SignerEntries

    +
  • Defined in packages/xrpl/src/models/ledger/SignerList.ts:39

    • SignerListID

    SignerListID: number
    @@ -107,7 +107,7 @@

    SignerListID

    +
  • Defined in packages/xrpl/src/models/ledger/SignerList.ts:44

    • SignerQuorum

    SignerQuorum: number
    @@ -116,13 +116,13 @@

    SignerQuorum

    +
  • Defined in packages/xrpl/src/models/ledger/SignerList.ts:50

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • @@ -394,6 +394,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -407,8 +410,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -446,7 +447,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerEntry.Ticket.html b/docs/interfaces/LedgerEntry.Ticket.html index 8804d19537..12ba805372 100644 --- a/docs/interfaces/LedgerEntry.Ticket.html +++ b/docs/interfaces/LedgerEntry.Ticket.html @@ -34,7 +34,7 @@

    Hierarchy

    • Ticket
    +
  • Defined in packages/xrpl/src/models/ledger/Ticket.ts:10
    • @@ -59,7 +59,7 @@

    Account

    The account that owns this Ticket.

    +
  • Defined in packages/xrpl/src/models/ledger/Ticket.ts:13

    • Flags

    Flags: number
    @@ -67,12 +67,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
    @@ -80,7 +80,7 @@

    OwnerNode

    +
  • Defined in packages/xrpl/src/models/ledger/Ticket.ts:23

    • PreviousTxnID

    PreviousTxnID: string
    @@ -88,7 +88,7 @@

    PreviousTxnID

    +
  • Defined in packages/xrpl/src/models/ledger/Ticket.ts:28

    • PreviousTxnLgrSeq

    PreviousTxnLgrSeq: number
    @@ -96,20 +96,20 @@

    PreviousTxnLgrSeq

    +
  • Defined in packages/xrpl/src/models/ledger/Ticket.ts:33

    • TicketSequence

    TicketSequence: number

    The Sequence Number this Ticket sets aside.

    +
  • Defined in packages/xrpl/src/models/ledger/Ticket.ts:35

    • index

    index: string
    +
  • Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2
    • @@ -380,6 +380,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -393,8 +396,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -432,7 +433,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerEntryRequest.html b/docs/interfaces/LedgerEntryRequest.html index d6700089df..504bb6540d 100644 --- a/docs/interfaces/LedgerEntryRequest.html +++ b/docs/interfaces/LedgerEntryRequest.html @@ -36,7 +36,7 @@

    Hierarchy

    • LedgerEntryRequest
    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:21
    • @@ -71,7 +71,7 @@

    OptionalAccountInfoRequest.

    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:42

    • Optional api_version

    api_version?: number
    @@ -79,7 +79,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • Optional binary

    binary?: boolean
    @@ -88,14 +88,14 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:28

    • Optional check

    check?: string

    The object ID of a Check object to retrieve.

    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:45

    • command

    command: "ledger_entry"
    @@ -103,7 +103,7 @@

    command

    Overrides BaseRequest.command

    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:22

    • Optional deposit_preauth

    deposit_preauth?: string | {
        authorized: string;
        owner: string;
    }
    @@ -112,7 +112,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:52

    • Optional directory

    directory?: string | {
        dir_root?: string;
        owner?: string;
        sub_index?: number;
    }
    @@ -121,7 +121,7 @@

    Optionalsub_index sub-field.

    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:66

    • Optional escrow

    escrow?: string | {
        owner: string;
        seq: number;
    }
    @@ -129,7 +129,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:81

    • Optional id

    id?: string | number
    @@ -139,12 +139,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:36

    • Optional ledger_hash

    ledger_hash?: string
    @@ -152,7 +152,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:21

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -160,14 +160,14 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:23

    • Optional nft_page

    nft_page?: string

    Must be the object ID of the NFToken page, as hexadecimal

    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:139

    • Optional offer

    offer?: string | {
        account: string;
        seq: number;
    }
    @@ -176,14 +176,14 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:95

    • Optional payment_channel

    payment_channel?: string

    The object ID of a PayChannel object to retrieve.

    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:105

    • Optional ripple_state

    ripple_state?: {
        accounts: string[];
        currency: string;
    }
    @@ -204,7 +204,7 @@
    currency

    Currency Code of the RippleState object to retrieve.

    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:112

    • Optional ticket

    ticket?: string | {
        owner: string;
        ticket_sequence: number;
    }
    @@ -213,7 +213,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:127
    • @@ -493,6 +493,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -506,8 +509,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -545,7 +546,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerEntryResponse.html b/docs/interfaces/LedgerEntryResponse.html index cb52bd1c38..ffb3602e84 100644 --- a/docs/interfaces/LedgerEntryResponse.html +++ b/docs/interfaces/LedgerEntryResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • LedgerEntryResponse
    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:147
    • @@ -55,19 +55,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?: LedgerEntry;
        node_binary?: string;
        validated?: boolean;
    }
    @@ -95,31 +95,31 @@
    Optional Optional validated?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/ledgerEntry.ts:148

    • 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
    • @@ -390,6 +390,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -403,8 +406,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -442,7 +443,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerModifiedOfferCreateTransaction.html b/docs/interfaces/LedgerModifiedOfferCreateTransaction.html index 4ab030621c..ce02518125 100644 --- a/docs/interfaces/LedgerModifiedOfferCreateTransaction.html +++ b/docs/interfaces/LedgerModifiedOfferCreateTransaction.html @@ -29,7 +29,7 @@

    Hierarchy

    • LedgerModifiedOfferCreateTransaction
    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:73
    • @@ -46,12 +46,12 @@

    Properties

    metadata

    metadata: TransactionMetadata & {
        owner_funds: string;
    }
    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:75

    • transaction

    transaction: Transaction
    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:74
    • @@ -316,6 +316,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -329,8 +332,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -368,7 +369,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerQueueData.html b/docs/interfaces/LedgerQueueData.html index 0060d43633..c11bc26936 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:78
    • @@ -50,47 +50,47 @@

    Properties

    account

    account: string
    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:79

    • Optional auth_change

    auth_change?: boolean
    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:87

    • Optional fee

    fee?: string
    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:88

    • Optional fee_level

    fee_level?: string
    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:89

    • Optional last_result

    last_result?: string
    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:86

    • Optional max_spend_drops

    max_spend_drops?: string
    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:90

    • preflight_result

    preflight_result: string
    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:85

    • retries_remaining

    retries_remaining: number
    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:84

    • tx

    tx: TransactionAndMetadata | LedgerModifiedOfferCreateTransaction | {
        tx_blob: string;
    }
    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:80
    • @@ -362,6 +362,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -375,8 +378,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -414,7 +415,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerRequest.html b/docs/interfaces/LedgerRequest.html index 87b80111f2..47083b6021 100644 --- a/docs/interfaces/LedgerRequest.html +++ b/docs/interfaces/LedgerRequest.html @@ -36,7 +36,7 @@

    Hierarchy

    • LedgerRequest
    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:27
    • @@ -66,7 +66,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:38

    • Optional api_version

    api_version?: number
    @@ -74,7 +74,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • Optional binary

    binary?: boolean
    @@ -83,7 +83,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:62

    • command

    command: "ledger"
    @@ -91,7 +91,7 @@

    command

    Overrides BaseRequest.command

    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:28

    • Optional expand

    expand?: boolean
    @@ -100,7 +100,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:50

    • Optional full

    full?: boolean
    @@ -108,7 +108,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:33

    • Optional id

    id?: string | number
    @@ -118,7 +118,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional ledger_hash

    ledger_hash?: string
    @@ -126,7 +126,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:21

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -134,7 +134,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:23

    • Optional owner_funds

    owner_funds?: boolean
    @@ -143,7 +143,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:56

    • Optional queue

    queue?: boolean
    @@ -151,7 +151,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:67

    • Optional transactions

    transactions?: boolean
    @@ -160,7 +160,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:44
    • @@ -435,6 +435,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -448,8 +451,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -487,7 +488,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerResponse.html b/docs/interfaces/LedgerResponse.html index 812b9adb35..813456a919 100644 --- a/docs/interfaces/LedgerResponse.html +++ b/docs/interfaces/LedgerResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • LedgerResponse
    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:104
    • @@ -55,19 +55,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: Ledger | LedgerBinary;
        ledger_hash: string;
        ledger_index: number;
        queue_data?: (string | LedgerQueueData)[];
        validated?: boolean;
    }
    @@ -100,31 +100,31 @@
    Optional

    Overrides BaseResponse.result

    +
  • Defined in packages/xrpl/src/models/methods/ledger.ts:105

    • 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
    • @@ -395,6 +395,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -408,8 +411,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -447,7 +448,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerStream.html b/docs/interfaces/LedgerStream.html index e5631eec7d..d381f69fe8 100644 --- a/docs/interfaces/LedgerStream.html +++ b/docs/interfaces/LedgerStream.html @@ -33,7 +33,7 @@

    Hierarchy

    • LedgerStream
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:97
    • @@ -62,35 +62,35 @@

    fee_base

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:104

    • Optional fee_ref

    fee_ref?: number

    The reference transaction cost in "fee units". This is not returned after the SetFees amendment is enabled.

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:106

    • ledger_hash

    ledger_hash: string

    The identifying hash of the ledger version that was closed.

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:108

    • ledger_index

    ledger_index: number

    The ledger index of the ledger that was closed.

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:110

    • ledger_time

    ledger_time: number

    The time this ledger was closed, in seconds since the Ripple Epoch.

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:112

    • reserve_base

    reserve_base: number
    @@ -99,7 +99,7 @@

    reserve_base

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:118

    • reserve_inc

    reserve_inc: number
    @@ -108,20 +108,20 @@

    reserve_inc

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:124

    • txn_count

    txn_count: number

    Number of new transactions included in this ledger version.

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:126

    • type

    type: "ledgerClosed"
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:98

    • Optional validated_ledgers

    validated_ledgers?: string
    @@ -131,7 +131,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:133
    • @@ -404,6 +404,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -417,8 +420,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -456,7 +457,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/LedgerStreamResponse.html b/docs/interfaces/LedgerStreamResponse.html index 1ee1b0e913..de8b7df2c6 100644 --- a/docs/interfaces/LedgerStreamResponse.html +++ b/docs/interfaces/LedgerStreamResponse.html @@ -29,7 +29,7 @@

    Hierarchy

    • LedgerStreamResponse
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:139
    • @@ -56,35 +56,35 @@

    fee_base

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:145

    • Optional fee_ref

    fee_ref?: number

    The reference transaction cost in "fee units". This is not returned after the SetFees amendment is enabled.

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:147

    • ledger_hash

    ledger_hash: string

    The identifying hash of the ledger version that was closed.

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:149

    • ledger_index

    ledger_index: number

    The ledger index of the ledger that was closed.

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:151

    • ledger_time

    ledger_time: number

    The time this ledger was closed, in seconds since the Ripple Epoch.

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:153

    • reserve_base

    reserve_base: number
    @@ -93,7 +93,7 @@

    reserve_base

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:159

    • reserve_inc

    reserve_inc: number
    @@ -102,7 +102,7 @@

    reserve_inc

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:165

    • Optional validated_ledgers

    validated_ledgers?: string
    @@ -112,7 +112,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:172
    • @@ -383,6 +383,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -396,8 +399,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -435,7 +436,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/ManifestRequest.html b/docs/interfaces/ManifestRequest.html index f5f471d5e3..f50eea9fcc 100644 --- a/docs/interfaces/ManifestRequest.html +++ b/docs/interfaces/ManifestRequest.html @@ -36,7 +36,7 @@

    Hierarchy

    • ManifestRequest
    +
  • Defined in packages/xrpl/src/models/methods/manifest.ts:19
    • @@ -58,7 +58,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "manifest"
    @@ -66,7 +66,7 @@

    command

    Overrides BaseRequest.command

    +
  • Defined in packages/xrpl/src/models/methods/manifest.ts:20

    • Optional id

    id?: string | number
    @@ -76,7 +76,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • public_key

    public_key: string
    @@ -84,7 +84,7 @@

    public_key

    +
  • Defined in packages/xrpl/src/models/methods/manifest.ts:25
    • @@ -351,6 +351,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -364,8 +367,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -403,7 +404,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/ManifestResponse.html b/docs/interfaces/ManifestResponse.html index 456c3f5637..7727ceb1d9 100644 --- a/docs/interfaces/ManifestResponse.html +++ b/docs/interfaces/ManifestResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • ManifestResponse
    +
  • Defined in packages/xrpl/src/models/methods/manifest.ts:33
    • @@ -55,19 +55,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;
    }
    @@ -100,31 +100,31 @@
    requested

    Overrides BaseResponse.result

    +
  • 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
    • @@ -395,6 +395,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -408,8 +411,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -447,7 +448,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/Memo.html b/docs/interfaces/Memo.html index a14ce6b6f6..0b50a4bd7c 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:34
    • @@ -51,7 +51,7 @@
    Optional
    Optional MemoType?: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:35
    • @@ -315,6 +315,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -328,8 +331,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -367,7 +368,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/ModifiedNode.html b/docs/interfaces/ModifiedNode.html index 6afea13f9f..565e3c80b4 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:11
    • @@ -63,7 +63,7 @@
    Optional
    Optional PreviousTxnLgrSeq?: number
    +
  • Defined in packages/xrpl/src/models/transactions/metadata.ts:12
    • @@ -327,6 +327,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -340,8 +343,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -379,7 +380,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/NFTBuyOffersRequest.html b/docs/interfaces/NFTBuyOffersRequest.html index 8eaeec3e56..57acfcde6f 100644 --- a/docs/interfaces/NFTBuyOffersRequest.html +++ b/docs/interfaces/NFTBuyOffersRequest.html @@ -33,7 +33,7 @@

    Hierarchy

    • NFTBuyOffersRequest
    +
  • Defined in packages/xrpl/src/models/methods/nftBuyOffers.ts:11
    • @@ -57,7 +57,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "nft_buy_offers"
    @@ -65,7 +65,7 @@

    command

    Overrides BaseRequest.command

    +
  • Defined in packages/xrpl/src/models/methods/nftBuyOffers.ts:14

    • Optional id

    id?: string | number
    @@ -75,7 +75,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional ledger_hash

    ledger_hash?: string
    @@ -83,7 +83,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:21

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -91,14 +91,14 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:23

    • nft_id

    nft_id: string

    The unique identifier of an NFToken. The request returns buy offers for this NFToken.

    +
  • Defined in packages/xrpl/src/models/methods/nftBuyOffers.ts:18
    • @@ -367,6 +367,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -380,8 +383,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -419,7 +420,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/NFTBuyOffersResponse.html b/docs/interfaces/NFTBuyOffersResponse.html index 161e69d9c0..a945ce06e9 100644 --- a/docs/interfaces/NFTBuyOffersResponse.html +++ b/docs/interfaces/NFTBuyOffersResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • NFTBuyOffersResponse
    +
  • Defined in packages/xrpl/src/models/methods/nftBuyOffers.ts:26
    • @@ -55,19 +55,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[];
    }
    @@ -84,31 +84,31 @@
    offers

    Overrides BaseResponse.result

    +
  • 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
    • @@ -379,6 +379,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -392,8 +395,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -431,7 +432,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/NFTHistoryRequest.html b/docs/interfaces/NFTHistoryRequest.html index 4027eca387..be268a4324 100644 --- a/docs/interfaces/NFTHistoryRequest.html +++ b/docs/interfaces/NFTHistoryRequest.html @@ -33,7 +33,7 @@

    Hierarchy

    • NFTHistoryRequest
    +
  • Defined in packages/xrpl/src/models/methods/nftHistory.ts:13
    • @@ -63,7 +63,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • Optional binary

    binary?: boolean
    @@ -71,7 +71,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/nftHistory.ts:35

    • command

    command: "nft_history"
    @@ -79,7 +79,7 @@

    command

    Overrides BaseRequest.command

    +
  • Defined in packages/xrpl/src/models/methods/nftHistory.ts:14

    • Optional forward

    forward?: boolean
    @@ -87,7 +87,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/nftHistory.ts:40

    • Optional id

    id?: string | number
    @@ -97,7 +97,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional ledger_hash

    ledger_hash?: string
    @@ -105,7 +105,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 ledger_index_max

    ledger_index_max?: number
    @@ -122,7 +122,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/nftHistory.ts:30

    • Optional ledger_index_min

    ledger_index_min?: number
    @@ -131,7 +131,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/nftHistory.ts:24

    • Optional limit

    limit?: number
    @@ -139,7 +139,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/nftHistory.ts:45

    • Optional marker

    marker?: unknown
    @@ -148,14 +148,14 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/nftHistory.ts:51

    • nft_id

    nft_id: string

    The unique identifier of an NFToken.

    +
  • Defined in packages/xrpl/src/models/methods/nftHistory.ts:18
    • @@ -430,6 +430,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -443,8 +446,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -482,7 +483,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/NFTHistoryResponse.html b/docs/interfaces/NFTHistoryResponse.html index ba546987e5..e5c1d1bb0b 100644 --- a/docs/interfaces/NFTHistoryResponse.html +++ b/docs/interfaces/NFTHistoryResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • NFTHistoryResponse
    +
  • Defined in packages/xrpl/src/models/methods/nftHistory.ts:78
    • @@ -55,19 +55,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;
    }
    @@ -110,31 +110,31 @@
    Optional

    Overrides BaseResponse.result

    +
  • 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
    • @@ -405,6 +405,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -418,8 +421,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -457,7 +458,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/NFTHistoryTransaction.html b/docs/interfaces/NFTHistoryTransaction.html index 5095e5db30..9fb3848150 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
    • @@ -48,7 +48,7 @@

    ledger_index

    The ledger index of the ledger version that included this transaction.

    +
  • Defined in packages/xrpl/src/models/methods/nftHistory.ts:56

    • meta

    meta: string | TransactionMetadata
    @@ -56,21 +56,21 @@

    meta

    +
  • Defined in packages/xrpl/src/models/methods/nftHistory.ts:61

    • Optional tx

    tx?: Object

    JSON object defining the transaction.

    +
  • Defined in packages/xrpl/src/models/methods/nftHistory.ts:63

    • Optional tx_blob

    tx_blob?: string

    Unique hashed String representing the transaction.

    +
  • Defined in packages/xrpl/src/models/methods/nftHistory.ts:65

    • validated

    validated: boolean
    @@ -78,7 +78,7 @@

    validated

    +
  • Defined in packages/xrpl/src/models/methods/nftHistory.ts:70
    • @@ -346,6 +346,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -359,8 +362,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -398,7 +399,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/NFTInfoRequest.html b/docs/interfaces/NFTInfoRequest.html index 5638834bc3..a1ca75bb9c 100644 --- a/docs/interfaces/NFTInfoRequest.html +++ b/docs/interfaces/NFTInfoRequest.html @@ -32,7 +32,7 @@

    Hierarchy

    • NFTInfoRequest
    +
  • Defined in packages/xrpl/src/models/methods/nftInfo.ts:10
    • @@ -56,7 +56,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "nft_info"
    @@ -64,7 +64,7 @@

    command

    Overrides BaseRequest.command

    +
  • Defined in packages/xrpl/src/models/methods/nftInfo.ts:11

    • Optional id

    id?: string | number
    @@ -74,7 +74,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional ledger_hash

    ledger_hash?: string
    @@ -82,7 +82,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:21

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -90,14 +90,14 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:23

    • nft_id

    nft_id: string

    The unique identifier of an NFToken.

    +
  • Defined in packages/xrpl/src/models/methods/nftInfo.ts:15
    • @@ -366,6 +366,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -379,8 +382,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -418,7 +419,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/NFTInfoResponse.html b/docs/interfaces/NFTInfoResponse.html index 1ee66a559b..5df117799b 100644 --- a/docs/interfaces/NFTInfoResponse.html +++ b/docs/interfaces/NFTInfoResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • NFTInfoResponse
    +
  • Defined in packages/xrpl/src/models/methods/nftInfo.ts:23
    • @@ -55,49 +55,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
    • @@ -368,6 +368,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -381,8 +384,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -420,7 +421,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/NFTOffer.html b/docs/interfaces/NFTOffer.html index 2c55a09412..b38a1d7b26 100644 --- a/docs/interfaces/NFTOffer.html +++ b/docs/interfaces/NFTOffer.html @@ -30,7 +30,7 @@

    Hierarchy

    • NFTOffer
    +
  • Defined in packages/xrpl/src/models/common/index.ts:118
    • @@ -51,32 +51,32 @@

    Properties

    amount

    amount: Amount
    +
  • Defined in packages/xrpl/src/models/common/index.ts:119

    • Optional destination

    destination?: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:123

    • Optional expiration

    expiration?: number
    +
  • Defined in packages/xrpl/src/models/common/index.ts:124

    • flags

    flags: number
    +
  • Defined in packages/xrpl/src/models/common/index.ts:120

    • nft_offer_index

    nft_offer_index: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:121

    • owner

    owner: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:122
    • @@ -345,6 +345,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -358,8 +361,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -397,7 +398,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/NFTSellOffersRequest.html b/docs/interfaces/NFTSellOffersRequest.html index a7f8b9e3cf..2330fe7efe 100644 --- a/docs/interfaces/NFTSellOffersRequest.html +++ b/docs/interfaces/NFTSellOffersRequest.html @@ -33,7 +33,7 @@

    Hierarchy

    • NFTSellOffersRequest
    +
  • Defined in packages/xrpl/src/models/methods/nftSellOffers.ts:11
    • @@ -57,7 +57,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "nft_sell_offers"
    @@ -65,7 +65,7 @@

    command

    Overrides BaseRequest.command

    +
  • Defined in packages/xrpl/src/models/methods/nftSellOffers.ts:14

    • Optional id

    id?: string | number
    @@ -75,7 +75,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional ledger_hash

    ledger_hash?: string
    @@ -83,7 +83,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:21

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -91,14 +91,14 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:23

    • nft_id

    nft_id: string

    The unique identifier of an NFToken. The request returns sell offers for this NFToken.

    +
  • Defined in packages/xrpl/src/models/methods/nftSellOffers.ts:18
    • @@ -367,6 +367,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -380,8 +383,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -419,7 +420,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/NFTSellOffersResponse.html b/docs/interfaces/NFTSellOffersResponse.html index 50b4844bff..b343e1848a 100644 --- a/docs/interfaces/NFTSellOffersResponse.html +++ b/docs/interfaces/NFTSellOffersResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • NFTSellOffersResponse
    +
  • Defined in packages/xrpl/src/models/methods/nftSellOffers.ts:26
    • @@ -55,19 +55,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[];
    }
    @@ -84,31 +84,31 @@
    offers

    Overrides BaseResponse.result

    +
  • 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
    • @@ -379,6 +379,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -392,8 +395,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -431,7 +432,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/NFToken.html b/docs/interfaces/NFToken.html index cee9231c53..4aaacc1ae7 100644 --- a/docs/interfaces/NFToken.html +++ b/docs/interfaces/NFToken.html @@ -29,7 +29,7 @@

    Hierarchy

    • NFToken
    +
  • Defined in packages/xrpl/src/models/common/index.ts:132
    • @@ -54,52 +54,52 @@

    Properties

    flags

    flags: number
    +
  • Defined in packages/xrpl/src/models/common/index.ts:137

    • is_burned

    is_burned: boolean
    +
  • Defined in packages/xrpl/src/models/common/index.ts:136

    • issuer

    issuer: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:139

    • ledger_index

    ledger_index: number
    +
  • Defined in packages/xrpl/src/models/common/index.ts:134

    • nft_id

    nft_id: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:133

    • nft_serial

    nft_serial: number
    +
  • Defined in packages/xrpl/src/models/common/index.ts:141

    • nft_taxon

    nft_taxon: number
    +
  • Defined in packages/xrpl/src/models/common/index.ts:140

    • owner

    owner: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:135

    • transfer_fee

    transfer_fee: number
    +
  • Defined in packages/xrpl/src/models/common/index.ts:138

    • uri

    uri: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:142
    • @@ -372,6 +372,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -385,8 +388,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -424,7 +425,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/NFTokenAcceptOffer.html b/docs/interfaces/NFTokenAcceptOffer.html index c6bcdb13ab..a24fcb5989 100644 --- a/docs/interfaces/NFTokenAcceptOffer.html +++ b/docs/interfaces/NFTokenAcceptOffer.html @@ -44,7 +44,7 @@

    Hierarchy

    • NFTokenAcceptOffer
    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenAcceptOffer.ts:26
    • @@ -79,7 +79,7 @@

    Account

    Inherited from BaseTransaction.Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:95

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -89,7 +89,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:119

    • Optional Fee

    Fee?: string
    @@ -99,7 +99,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:106

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -107,7 +107,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:121

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -117,7 +117,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:127

    • Optional Memos

    Memos?: Memo[]
    @@ -125,7 +125,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:131

    • Optional NFTokenBrokerFee

    NFTokenBrokerFee?: Amount
    @@ -147,7 +147,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenAcceptOffer.ts:64

    • Optional NFTokenBuyOffer

    NFTokenBuyOffer?: string
    @@ -157,7 +157,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenAcceptOffer.ts:43

    • Optional NFTokenSellOffer

    NFTokenSellOffer?: string
    @@ -167,7 +167,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenAcceptOffer.ts:35

    • Optional NetworkID

    NetworkID?: number
    @@ -175,7 +175,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:163

    • Optional Sequence

    Sequence?: number
    @@ -186,7 +186,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:113

    • Optional Signers

    Signers?: Signer[]
    @@ -195,7 +195,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:136

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -205,7 +205,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:149

    • Optional SourceTag

    SourceTag?: number
    @@ -216,7 +216,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:143

    • Optional TicketSequence

    TicketSequence?: number
    @@ -225,7 +225,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:154

    • TransactionType

    TransactionType: "NFTokenAcceptOffer"
    @@ -234,7 +234,7 @@

    TransactionType

    Overrides BaseTransaction.TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenAcceptOffer.ts:27

    • Optional TxnSignature

    TxnSignature?: string
    @@ -243,7 +243,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:159
    • @@ -523,6 +523,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -536,8 +539,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -575,7 +576,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/NFTokenBurn.html b/docs/interfaces/NFTokenBurn.html index 792cc97982..54442ffb64 100644 --- a/docs/interfaces/NFTokenBurn.html +++ b/docs/interfaces/NFTokenBurn.html @@ -37,7 +37,7 @@

    Hierarchy

    • NFTokenBurn
    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenBurn.ts:15
    • @@ -74,7 +74,7 @@

    Account

    Overrides BaseTransaction.Account

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenBurn.ts:23

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -84,7 +84,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:119

    • Optional Fee

    Fee?: string
    @@ -94,7 +94,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:106

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -102,7 +102,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:121

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -112,7 +112,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:127

    • Optional Memos

    Memos?: Memo[]
    @@ -120,14 +120,14 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:131

    • NFTokenID

    NFTokenID: string

    Identifies the NFToken object to be removed by the transaction.

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenBurn.ts:27

    • Optional NetworkID

    NetworkID?: number
    @@ -135,7 +135,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:163

    • Optional Owner

    Owner?: string
    @@ -144,7 +144,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenBurn.ts:33

    • Optional Sequence

    Sequence?: number
    @@ -155,7 +155,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:113

    • Optional Signers

    Signers?: Signer[]
    @@ -164,7 +164,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:136

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -174,7 +174,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:149

    • Optional SourceTag

    SourceTag?: number
    @@ -185,7 +185,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:143

    • Optional TicketSequence

    TicketSequence?: number
    @@ -194,7 +194,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:154

    • TransactionType

    TransactionType: "NFTokenBurn"
    @@ -203,7 +203,7 @@

    TransactionType

    Overrides BaseTransaction.TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenBurn.ts:16

    • Optional TxnSignature

    TxnSignature?: string
    @@ -212,7 +212,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:159
    • @@ -491,6 +491,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -504,8 +507,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -543,7 +544,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/NFTokenCancelOffer.html b/docs/interfaces/NFTokenCancelOffer.html index 90bae13728..df8f54b173 100644 --- a/docs/interfaces/NFTokenCancelOffer.html +++ b/docs/interfaces/NFTokenCancelOffer.html @@ -37,7 +37,7 @@

    Hierarchy

    • NFTokenCancelOffer
    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenCancelOffer.ts:15
    • @@ -70,7 +70,7 @@

    Account

    Inherited from BaseTransaction.Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:95

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -80,7 +80,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:119

    • Optional Fee

    Fee?: string
    @@ -90,7 +90,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:106

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -98,7 +98,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:121

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -108,7 +108,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:127

    • Optional Memos

    Memos?: Memo[]
    @@ -116,7 +116,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:131

    • NFTokenOffers

    NFTokenOffers: string[]
    @@ -128,7 +128,7 @@

    NFTokenOffers

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenCancelOffer.ts:26

    • Optional NetworkID

    NetworkID?: number
    @@ -136,7 +136,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:163

    • Optional Sequence

    Sequence?: number
    @@ -147,7 +147,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:113

    • Optional Signers

    Signers?: Signer[]
    @@ -156,7 +156,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:136

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -166,7 +166,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:149

    • Optional SourceTag

    SourceTag?: number
    @@ -177,7 +177,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:143

    • Optional TicketSequence

    TicketSequence?: number
    @@ -186,7 +186,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:154

    • TransactionType

    TransactionType: "NFTokenCancelOffer"
    @@ -195,7 +195,7 @@

    TransactionType

    Overrides BaseTransaction.TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenCancelOffer.ts:16

    • Optional TxnSignature

    TxnSignature?: string
    @@ -204,7 +204,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:159
    • @@ -482,6 +482,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -495,8 +498,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -534,7 +535,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/NFTokenCreateOffer.html b/docs/interfaces/NFTokenCreateOffer.html index 6a357d5aee..a3aefc8403 100644 --- a/docs/interfaces/NFTokenCreateOffer.html +++ b/docs/interfaces/NFTokenCreateOffer.html @@ -33,7 +33,7 @@

    Hierarchy

    • NFTokenCreateOffer
    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:41
    • @@ -70,7 +70,7 @@

    Account

    Inherited from BaseTransaction.Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:95

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -80,7 +80,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:119

    • Amount

    Amount: Amount
    @@ -91,7 +91,7 @@

    Amount

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:56

    • Optional Destination

    Destination?: string
    @@ -100,7 +100,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:82

    • Optional Expiration

    Expiration?: number
    @@ -109,7 +109,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:76

    • Optional Fee

    Fee?: string
    @@ -119,7 +119,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:106

    • Optional Flags

    Flags?: number | NFTokenCreateOfferFlagsInterface
    @@ -127,7 +127,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:83

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -137,7 +137,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:127

    • Optional Memos

    Memos?: Memo[]
    @@ -145,7 +145,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:131

    • NFTokenID

    NFTokenID: string
    @@ -153,7 +153,7 @@

    NFTokenID

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:47

    • Optional NetworkID

    NetworkID?: number
    @@ -161,7 +161,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:163

    • Optional Owner

    Owner?: string
    @@ -176,7 +176,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:70

    • Optional Sequence

    Sequence?: number
    @@ -187,7 +187,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:113

    • Optional Signers

    Signers?: Signer[]
    @@ -196,7 +196,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:136

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -206,7 +206,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:149

    • Optional SourceTag

    SourceTag?: number
    @@ -217,7 +217,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:143

    • Optional TicketSequence

    TicketSequence?: number
    @@ -226,7 +226,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:154

    • TransactionType

    TransactionType: "NFTokenCreateOffer"
    @@ -235,7 +235,7 @@

    TransactionType

    Overrides BaseTransaction.TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:42

    • Optional TxnSignature

    TxnSignature?: string
    @@ -244,7 +244,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:159
    • @@ -526,6 +526,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -539,8 +542,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -578,7 +579,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/NFTokenCreateOfferFlagsInterface.html b/docs/interfaces/NFTokenCreateOfferFlagsInterface.html index cceb4cb427..17e0f1740d 100644 --- a/docs/interfaces/NFTokenCreateOfferFlagsInterface.html +++ b/docs/interfaces/NFTokenCreateOfferFlagsInterface.html @@ -32,7 +32,7 @@

    Hierarchy

    • NFTokenCreateOfferFlagsInterface
    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:32
    • @@ -48,7 +48,7 @@

    Properties

    Optional tfSellNFToken

    tfSellNFToken?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:33
    • @@ -312,6 +312,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -325,8 +328,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -364,7 +365,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/NFTokenMint.html b/docs/interfaces/NFTokenMint.html index e6d0c1907b..2c77f332ee 100644 --- a/docs/interfaces/NFTokenMint.html +++ b/docs/interfaces/NFTokenMint.html @@ -34,7 +34,7 @@

    Hierarchy

    • NFTokenMint
    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:54
    • @@ -70,7 +70,7 @@

    Account

    Inherited from BaseTransaction.Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:95

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -80,7 +80,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:119

    • Optional Fee

    Fee?: string
    @@ -90,7 +90,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:106

    • Optional Flags

    Flags?: number | NFTokenMintFlagsInterface
    @@ -98,7 +98,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:94

    • Optional Issuer

    Issuer?: string
    @@ -109,7 +109,7 @@

    OptionalAccount, otherwise the transaction will fail.

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:71

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -119,7 +119,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:127

    • Optional Memos

    Memos?: Memo[]
    @@ -127,7 +127,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:131

    • NFTokenTaxon

    NFTokenTaxon: number
    @@ -138,7 +138,7 @@

    NFTokenTaxon

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:63

    • Optional NetworkID

    NetworkID?: number
    @@ -146,7 +146,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:163

    • Optional Sequence

    Sequence?: number
    @@ -157,7 +157,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:113

    • Optional Signers

    Signers?: Signer[]
    @@ -166,7 +166,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:136

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -176,7 +176,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:149

    • Optional SourceTag

    SourceTag?: number
    @@ -187,7 +187,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:143

    • Optional TicketSequence

    TicketSequence?: number
    @@ -196,7 +196,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:154

    • TransactionType

    TransactionType: "NFTokenMint"
    @@ -205,7 +205,7 @@

    TransactionType

    Overrides BaseTransaction.TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:55

    • Optional TransferFee

    TransferFee?: number
    @@ -216,7 +216,7 @@

    OptionaltfTransferable flag is not set.

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:79

    • Optional TxnSignature

    TxnSignature?: string
    @@ -225,7 +225,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:159

    • Optional URI

    URI?: null | string
    @@ -240,7 +240,7 @@

    Optionalundefined value if you do not use it.

    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:93
    • @@ -521,6 +521,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -534,8 +537,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -573,7 +574,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/NFTokenMintFlagsInterface.html b/docs/interfaces/NFTokenMintFlagsInterface.html index 3071c34d7d..06262e8981 100644 --- a/docs/interfaces/NFTokenMintFlagsInterface.html +++ b/docs/interfaces/NFTokenMintFlagsInterface.html @@ -32,7 +32,7 @@

    Hierarchy

    • NFTokenMintFlagsInterface
    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:41
    • @@ -51,22 +51,22 @@

    Properties

    Optional tfBurnable

    tfBurnable?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:42

    • Optional tfOnlyXRP

    tfOnlyXRP?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:43

    • Optional tfTransferable

    tfTransferable?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:45

    • Optional tfTrustLine

    tfTrustLine?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/NFTokenMint.ts:44
    • @@ -333,6 +333,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -346,8 +349,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -385,7 +386,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/NoRippleCheckRequest.html b/docs/interfaces/NoRippleCheckRequest.html index 4a3d6835cb..c2a70952ec 100644 --- a/docs/interfaces/NoRippleCheckRequest.html +++ b/docs/interfaces/NoRippleCheckRequest.html @@ -37,7 +37,7 @@

    Hierarchy

    • NoRippleCheckRequest
    +
  • Defined in packages/xrpl/src/models/methods/norippleCheck.ts:27
    • @@ -63,7 +63,7 @@

    account

    A unique identifier for the account, most commonly the account's address.

    +
  • Defined in packages/xrpl/src/models/methods/norippleCheck.ts:30

    • Optional api_version

    api_version?: number
    @@ -71,7 +71,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "noripple_check"
    @@ -79,7 +79,7 @@

    command

    Overrides BaseRequest.command

    +
  • Defined in packages/xrpl/src/models/methods/norippleCheck.ts:28

    • Optional id

    id?: string | number
    @@ -89,14 +89,14 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional ledger_hash

    ledger_hash?: string

    A 20-byte hex string for the ledger version to use.

    +
  • Defined in packages/xrpl/src/models/methods/norippleCheck.ts:49

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -104,7 +104,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/norippleCheck.ts:54

    • Optional limit

    limit?: number
    @@ -112,7 +112,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/norippleCheck.ts:47

    • role

    role: "user" | "gateway"
    @@ -122,7 +122,7 @@

    role

    +
  • Defined in packages/xrpl/src/models/methods/norippleCheck.ts:37

    • Optional transactions

    transactions?: boolean
    @@ -130,7 +130,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/norippleCheck.ts:42
    • @@ -402,6 +402,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -415,8 +418,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -454,7 +455,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/NoRippleCheckResponse.html b/docs/interfaces/NoRippleCheckResponse.html index bf50287dd8..387ae54423 100644 --- a/docs/interfaces/NoRippleCheckResponse.html +++ b/docs/interfaces/NoRippleCheckResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • NoRippleCheckResponse
    +
  • Defined in packages/xrpl/src/models/methods/norippleCheck.ts:62
    • @@ -55,19 +55,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[];
    }
    @@ -95,31 +95,31 @@
    transactions

    Overrides BaseResponse.result

    +
  • 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
    • @@ -390,6 +390,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -403,8 +406,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -442,7 +443,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/OfferCancel.html b/docs/interfaces/OfferCancel.html index 6adbe24883..ff511114e1 100644 --- a/docs/interfaces/OfferCancel.html +++ b/docs/interfaces/OfferCancel.html @@ -31,7 +31,7 @@

    Hierarchy

    • OfferCancel
    +
  • Defined in packages/xrpl/src/models/transactions/offerCancel.ts:10
    • @@ -64,7 +64,7 @@

    Account

    Inherited from BaseTransaction.Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:95

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -74,7 +74,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:119

    • Optional Fee

    Fee?: string
    @@ -84,7 +84,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:106

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -92,7 +92,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:121

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -102,7 +102,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:127

    • Optional Memos

    Memos?: Memo[]
    @@ -110,7 +110,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:131

    • Optional NetworkID

    NetworkID?: number
    @@ -118,7 +118,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:163

    • OfferSequence

    OfferSequence: number
    @@ -128,7 +128,7 @@

    OfferSequence

    +
  • Defined in packages/xrpl/src/models/transactions/offerCancel.ts:18

    • Optional Sequence

    Sequence?: number
    @@ -139,7 +139,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:113

    • Optional Signers

    Signers?: Signer[]
    @@ -148,7 +148,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:136

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -158,7 +158,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:149

    • Optional SourceTag

    SourceTag?: number
    @@ -169,7 +169,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:143

    • Optional TicketSequence

    TicketSequence?: number
    @@ -178,7 +178,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:154

    • TransactionType

    TransactionType: "OfferCancel"
    @@ -187,7 +187,7 @@

    TransactionType

    Overrides BaseTransaction.TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/offerCancel.ts:11

    • Optional TxnSignature

    TxnSignature?: string
    @@ -196,7 +196,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:159
    • @@ -474,6 +474,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -487,8 +490,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -526,7 +527,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/OfferCreate.html b/docs/interfaces/OfferCreate.html index 216ace795b..97840a3118 100644 --- a/docs/interfaces/OfferCreate.html +++ b/docs/interfaces/OfferCreate.html @@ -33,7 +33,7 @@

    Hierarchy

    • OfferCreate
    +
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:96
    • @@ -69,7 +69,7 @@

    Account

    Inherited from BaseTransaction.Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:95

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -79,7 +79,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:119

    • Optional Expiration

    Expiration?: number
    @@ -87,7 +87,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:103

    • Optional Fee

    Fee?: string
    @@ -97,7 +97,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:106

    • Optional Flags

    Flags?: number | OfferCreateFlagsInterface
    @@ -105,7 +105,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:98

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -115,7 +115,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:127

    • Optional Memos

    Memos?: Memo[]
    @@ -123,7 +123,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:131

    • Optional NetworkID

    NetworkID?: number
    @@ -131,14 +131,14 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:163

    • Optional OfferSequence

    OfferSequence?: number

    An offer to delete first, specified in the same way as OfferCancel.

    +
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:105

    • Optional Sequence

    Sequence?: number
    @@ -149,7 +149,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:113

    • Optional Signers

    Signers?: Signer[]
    @@ -158,7 +158,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:136

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -168,7 +168,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:149

    • Optional SourceTag

    SourceTag?: number
    @@ -179,21 +179,21 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:143

    • TakerGets

    TakerGets: Amount

    The amount and type of currency being provided by the offer creator.

    +
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:107

    • TakerPays

    TakerPays: Amount

    The amount and type of currency being requested by the offer creator.

    +
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:109

    • Optional TicketSequence

    TicketSequence?: number
    @@ -202,7 +202,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:154

    • TransactionType

    TransactionType: "OfferCreate"
    @@ -211,7 +211,7 @@

    TransactionType

    Overrides BaseTransaction.TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:97

    • Optional TxnSignature

    TxnSignature?: string
    @@ -220,7 +220,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:159
    • @@ -501,6 +501,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -514,8 +517,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -553,7 +554,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/OfferCreateFlagsInterface.html b/docs/interfaces/OfferCreateFlagsInterface.html index 00e2d00f67..8295b20980 100644 --- a/docs/interfaces/OfferCreateFlagsInterface.html +++ b/docs/interfaces/OfferCreateFlagsInterface.html @@ -35,7 +35,7 @@

    Hierarchy

    • OfferCreateFlagsInterface
    +
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:82
    • @@ -54,22 +54,22 @@

    Properties

    Optional tfFillOrKill

    tfFillOrKill?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:85

    • Optional tfImmediateOrCancel

    tfImmediateOrCancel?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:84

    • Optional tfPassive

    tfPassive?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:83

    • Optional tfSell

    tfSell?: boolean
    +
  • Defined in packages/xrpl/src/models/transactions/offerCreate.ts:86
    • @@ -336,6 +336,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -349,8 +352,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -388,7 +389,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/OrderBookStream.html b/docs/interfaces/OrderBookStream.html index 109f7f9178..bc42a5c1cb 100644 --- a/docs/interfaces/OrderBookStream.html +++ b/docs/interfaces/OrderBookStream.html @@ -34,7 +34,7 @@

    Hierarchy

    • OrderBookStream
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:346
    • @@ -60,58 +60,58 @@

    Properties

    engine_result

    engine_result: string
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:349

    • engine_result_code

    engine_result_code: number
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:350

    • engine_result_message

    engine_result_message: string
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:351

    • Optional ledger_current_index

    ledger_current_index?: number
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:352

    • Optional ledger_hash

    ledger_hash?: string
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:353

    • Optional ledger_index

    ledger_index?: number
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:354

    • meta

    meta: TransactionMetadata
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:355

    • status

    status: string
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:347

    • transaction

    transaction: Object
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:356

    • type

    type: "transaction"
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:348

    • validated

    validated: boolean
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:367
    • @@ -385,6 +385,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -398,8 +401,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -437,7 +438,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/PathFindCloseRequest.html b/docs/interfaces/PathFindCloseRequest.html index 0d58bffba2..9c8dc8b078 100644 --- a/docs/interfaces/PathFindCloseRequest.html +++ b/docs/interfaces/PathFindCloseRequest.html @@ -31,7 +31,7 @@

    Hierarchy

    • PathFindCloseRequest
    +
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:36
    • @@ -53,13 +53,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
    @@ -69,13 +69,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
    • @@ -342,6 +342,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -355,8 +358,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -394,7 +395,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/PathFindCreateRequest.html b/docs/interfaces/PathFindCreateRequest.html index a73d9251fd..29faaa3012 100644 --- a/docs/interfaces/PathFindCreateRequest.html +++ b/docs/interfaces/PathFindCreateRequest.html @@ -31,7 +31,7 @@

    Hierarchy

    • PathFindCreateRequest
    +
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:11
    • @@ -58,20 +58,20 @@

    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

    Unique address of the account to find a path to.

    +
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:19

    • destination_amount

    destination_amount: Amount
    @@ -79,7 +79,7 @@

    destination_amount

    +
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:24

    • Optional id

    id?: string | number
    @@ -89,7 +89,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional paths

    paths?: Path[]
    @@ -98,14 +98,14 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:32

    • Optional send_max

    send_max?: Amount

    Currency amount that would be spent in the transaction.

    +
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:26

    • source_account

    source_account: string
    @@ -113,13 +113,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
    • @@ -391,6 +391,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -404,8 +407,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -443,7 +444,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/PathFindPathOption.html b/docs/interfaces/PathFindPathOption.html index f2b593993d..2e5fce1a31 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
    • @@ -47,14 +47,14 @@

    Optionalsend_max field is set, this field will be set.

    +
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:70

    • paths_computed

    paths_computed: Path[]

    Array of arrays of objects defining payment paths.

    +
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:60

    • source_amount

    source_amount: Amount
    @@ -62,7 +62,7 @@

    source_amount

    +
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:65
    • @@ -328,6 +328,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -341,8 +344,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -380,7 +381,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/PathFindResponse.html b/docs/interfaces/PathFindResponse.html index 395e3f5b5a..ebb3c50c55 100644 --- a/docs/interfaces/PathFindResponse.html +++ b/docs/interfaces/PathFindResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • PathFindResponse
    +
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:78
    • @@ -55,19 +55,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;
    }
    @@ -117,31 +117,31 @@
    Optional

    Overrides BaseResponse.result

    +
  • 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
    • @@ -412,6 +412,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -425,8 +428,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -464,7 +465,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/PathFindStatusRequest.html b/docs/interfaces/PathFindStatusRequest.html index 858bf907e9..05f49cf848 100644 --- a/docs/interfaces/PathFindStatusRequest.html +++ b/docs/interfaces/PathFindStatusRequest.html @@ -31,7 +31,7 @@

    Hierarchy

    • PathFindStatusRequest
    +
  • Defined in packages/xrpl/src/models/methods/pathFind.ts:41
    • @@ -53,13 +53,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
    @@ -69,13 +69,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
    • @@ -342,6 +342,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -355,8 +358,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -394,7 +395,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/PathFindStream.html b/docs/interfaces/PathFindStream.html index 2b78939345..ebd2019449 100644 --- a/docs/interfaces/PathFindStream.html +++ b/docs/interfaces/PathFindStream.html @@ -33,7 +33,7 @@

    Hierarchy

    • PathFindStream
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:393
    • @@ -59,21 +59,21 @@

    alternatives

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:417

    • destination_account

    destination_account: string

    Unique address of the account that would receive a transaction.

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:398

    • destination_amount

    destination_amount: Amount

    Currency Amount that the destination would receive in a transaction.

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:400

    • full_reply

    full_reply: boolean
    @@ -84,34 +84,34 @@

    full_reply

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:408

    • id

    id: string | number

    The ID provided in the WebSocket request is included again at this level.

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:410

    • Optional send_max

    send_max?: Amount

    Currency Amount that would be spent in the transaction.

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:412

    • source_account

    source_account: string

    Unique address that would send a transaction.

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:396

    • type

    type: "path_find"
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:394
    • @@ -382,6 +382,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -395,8 +398,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -434,7 +435,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/PathStep.html b/docs/interfaces/PathStep.html index 5dcfd30ca8..d9614ec015 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:52
    • @@ -44,17 +44,17 @@

    Properties

    Optional account

    account?: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:53

    • Optional currency

    currency?: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:54

    • Optional issuer

    issuer?: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:55
    • @@ -320,6 +320,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -333,8 +336,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -372,7 +373,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/Payment.html b/docs/interfaces/Payment.html index 0e86ea854f..bb1a3ace9c 100644 --- a/docs/interfaces/Payment.html +++ b/docs/interfaces/Payment.html @@ -32,7 +32,7 @@

    Hierarchy

    • Payment
    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:107
    • @@ -71,7 +71,7 @@

    Account

    Inherited from BaseTransaction.Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:95

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -81,7 +81,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:119

    • Amount

    Amount: Amount
    @@ -90,7 +90,7 @@

    Amount

    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:114

    • Optional DeliverMin

    DeliverMin?: Amount
    @@ -99,14 +99,14 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:146

    • Destination

    Destination: string

    The unique address of the account receiving the payment.

    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:116

    • Optional DestinationTag

    DestinationTag?: number
    @@ -114,7 +114,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:121

    • Optional Fee

    Fee?: string
    @@ -124,7 +124,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:106

    • Optional Flags

    Flags?: number | PaymentFlagsInterface
    @@ -132,7 +132,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:147

    • Optional InvoiceID

    InvoiceID?: string
    @@ -140,7 +140,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:126

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -150,7 +150,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:127

    • Optional Memos

    Memos?: Memo[]
    @@ -158,7 +158,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:131

    • Optional NetworkID

    NetworkID?: number
    @@ -166,7 +166,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:163

    • Optional Paths

    Paths?: Path[]
    @@ -174,7 +174,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:131

    • Optional SendMax

    SendMax?: Amount
    @@ -186,7 +186,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:140

    • Optional Sequence

    Sequence?: number
    @@ -197,7 +197,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:113

    • Optional Signers

    Signers?: Signer[]
    @@ -206,7 +206,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:136

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -216,7 +216,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:149

    • Optional SourceTag

    SourceTag?: number
    @@ -227,7 +227,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:143

    • Optional TicketSequence

    TicketSequence?: number
    @@ -236,7 +236,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:154

    • TransactionType

    TransactionType: "Payment"
    @@ -245,7 +245,7 @@

    TransactionType

    Overrides BaseTransaction.TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:108

    • Optional TxnSignature

    TxnSignature?: string
    @@ -254,7 +254,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:159
    • @@ -538,6 +538,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -551,8 +554,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -590,7 +591,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/PaymentChannelClaim.html b/docs/interfaces/PaymentChannelClaim.html index 7a07d24927..de81a795a3 100644 --- a/docs/interfaces/PaymentChannelClaim.html +++ b/docs/interfaces/PaymentChannelClaim.html @@ -32,7 +32,7 @@

    Hierarchy

    • PaymentChannelClaim
    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:100
    • @@ -69,7 +69,7 @@

    Account

    Inherited from BaseTransaction.Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:95

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -79,7 +79,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:119

    • Optional Amount

    Amount?: string
    @@ -88,7 +88,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:117

    • Optional Balance

    Balance?: string
    @@ -98,14 +98,14 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:111

    • Channel

    Channel: string

    The unique ID of the channel as a 64-character hexadecimal string.

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:104

    • Optional Fee

    Fee?: string
    @@ -115,7 +115,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:106

    • Optional Flags

    Flags?: number | PaymentChannelClaimFlagsInterface
    @@ -123,7 +123,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:102

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -133,7 +133,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:127

    • Optional Memos

    Memos?: Memo[]
    @@ -141,7 +141,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:131

    • Optional NetworkID

    NetworkID?: number
    @@ -149,7 +149,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:163

    • Optional PublicKey

    PublicKey?: string
    @@ -159,7 +159,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:130

    • Optional Sequence

    Sequence?: number
    @@ -170,7 +170,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:113

    • Optional Signature

    Signature?: string
    @@ -179,7 +179,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:123

    • Optional Signers

    Signers?: Signer[]
    @@ -188,7 +188,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:136

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -198,7 +198,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:149

    • Optional SourceTag

    SourceTag?: number
    @@ -209,7 +209,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:143

    • Optional TicketSequence

    TicketSequence?: number
    @@ -218,7 +218,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:154

    • TransactionType

    TransactionType: "PaymentChannelClaim"
    @@ -227,7 +227,7 @@

    TransactionType

    Overrides BaseTransaction.TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:101

    • Optional TxnSignature

    TxnSignature?: string
    @@ -236,7 +236,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:159
    • @@ -518,6 +518,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -531,8 +534,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -570,7 +571,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/PaymentChannelClaimFlagsInterface.html b/docs/interfaces/PaymentChannelClaimFlagsInterface.html index 86732a17ed..f97b017e18 100644 --- a/docs/interfaces/PaymentChannelClaimFlagsInterface.html +++ b/docs/interfaces/PaymentChannelClaimFlagsInterface.html @@ -35,7 +35,7 @@

    Hierarchy

    • PaymentChannelClaimFlagsInterface
    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:71
    • @@ -64,7 +64,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:91

    • Optional tfRenew

    tfRenew?: boolean
    @@ -73,7 +73,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelClaim.ts:77
    • @@ -338,6 +338,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -351,8 +354,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -390,7 +391,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/PaymentChannelCreate.html b/docs/interfaces/PaymentChannelCreate.html index 8ce4a98619..37ba54e7cf 100644 --- a/docs/interfaces/PaymentChannelCreate.html +++ b/docs/interfaces/PaymentChannelCreate.html @@ -32,7 +32,7 @@

    Hierarchy

    • PaymentChannelCreate
    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelCreate.ts:12
    • @@ -70,7 +70,7 @@

    Account

    Inherited from BaseTransaction.Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:95

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -80,7 +80,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:119

    • Amount

    Amount: string
    @@ -90,7 +90,7 @@

    Amount

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelCreate.ts:20

    • Optional CancelAfter

    CancelAfter?: number
    @@ -101,7 +101,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelCreate.ts:44

    • Destination

    Destination: string
    @@ -109,7 +109,7 @@

    Destination

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelCreate.ts:25

    • Optional DestinationTag

    DestinationTag?: number
    @@ -117,7 +117,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelCreate.ts:49

    • Optional Fee

    Fee?: string
    @@ -127,7 +127,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:106

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -135,7 +135,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:121

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -145,7 +145,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:127

    • Optional Memos

    Memos?: Memo[]
    @@ -153,7 +153,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:131

    • Optional NetworkID

    NetworkID?: number
    @@ -161,7 +161,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:163

    • PublicKey

    PublicKey: string
    @@ -170,7 +170,7 @@

    PublicKey

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelCreate.ts:36

    • Optional Sequence

    Sequence?: number
    @@ -181,7 +181,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:113

    • SettleDelay

    SettleDelay: number
    @@ -189,7 +189,7 @@

    SettleDelay

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelCreate.ts:30

    • Optional Signers

    Signers?: Signer[]
    @@ -198,7 +198,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:136

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -208,7 +208,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:149

    • Optional SourceTag

    SourceTag?: number
    @@ -219,7 +219,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:143

    • Optional TicketSequence

    TicketSequence?: number
    @@ -228,7 +228,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:154

    • TransactionType

    TransactionType: "PaymentChannelCreate"
    @@ -237,7 +237,7 @@

    TransactionType

    Overrides BaseTransaction.TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelCreate.ts:13

    • Optional TxnSignature

    TxnSignature?: string
    @@ -246,7 +246,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:159
    • @@ -529,6 +529,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -542,8 +545,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -581,7 +582,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/PaymentChannelFund.html b/docs/interfaces/PaymentChannelFund.html index a34c90d4fd..c22e7f6903 100644 --- a/docs/interfaces/PaymentChannelFund.html +++ b/docs/interfaces/PaymentChannelFund.html @@ -33,7 +33,7 @@

    Hierarchy

    • PaymentChannelFund
    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelFund.ts:12
    • @@ -68,7 +68,7 @@

    Account

    Inherited from BaseTransaction.Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:95

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -78,7 +78,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:119

    • Amount

    Amount: string
    @@ -86,7 +86,7 @@

    Amount

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelFund.ts:23

    • Channel

    Channel: string
    @@ -94,7 +94,7 @@

    Channel

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelFund.ts:18

    • Optional Expiration

    Expiration?: number
    @@ -108,7 +108,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelFund.ts:34

    • Optional Fee

    Fee?: string
    @@ -118,7 +118,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:106

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -126,7 +126,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:121

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -136,7 +136,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:127

    • Optional Memos

    Memos?: Memo[]
    @@ -144,7 +144,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:131

    • Optional NetworkID

    NetworkID?: number
    @@ -152,7 +152,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:163

    • Optional Sequence

    Sequence?: number
    @@ -163,7 +163,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:113

    • Optional Signers

    Signers?: Signer[]
    @@ -172,7 +172,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:136

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -182,7 +182,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:149

    • Optional SourceTag

    SourceTag?: number
    @@ -193,7 +193,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:143

    • Optional TicketSequence

    TicketSequence?: number
    @@ -202,7 +202,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:154

    • TransactionType

    TransactionType: "PaymentChannelFund"
    @@ -211,7 +211,7 @@

    TransactionType

    Overrides BaseTransaction.TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/paymentChannelFund.ts:13

    • Optional TxnSignature

    TxnSignature?: string
    @@ -220,7 +220,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:159
    • @@ -500,6 +500,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -513,8 +516,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -552,7 +553,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/PaymentFlagsInterface.html b/docs/interfaces/PaymentFlagsInterface.html index 9c2b8c2fe2..d0d819dc57 100644 --- a/docs/interfaces/PaymentFlagsInterface.html +++ b/docs/interfaces/PaymentFlagsInterface.html @@ -35,7 +35,7 @@

    Hierarchy

    • PaymentFlagsInterface
    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:80
    • @@ -57,7 +57,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:98

    • Optional tfNoDirectRipple

    tfNoDirectRipple?: boolean
    @@ -66,7 +66,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:86

    • Optional tfPartialPayment

    tfPartialPayment?: boolean
    @@ -75,7 +75,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/payment.ts:92
    • @@ -341,6 +341,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -354,8 +357,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -393,7 +394,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/PeerStatusStream.html b/docs/interfaces/PeerStatusStream.html index 3cc39d30ae..4e7b5f32a4 100644 --- a/docs/interfaces/PeerStatusStream.html +++ b/docs/interfaces/PeerStatusStream.html @@ -33,7 +33,7 @@

    Hierarchy

    • PeerStatusStream
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:305
    • @@ -58,48 +58,48 @@

    action

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:311

    • date

    date: number

    The time this event occurred, in seconds since the Ripple Epoch.

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:313

    • Optional ledger_hash

    ledger_hash?: string

    The identifying Hash of a ledger version to which this message pertains.

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:315

    • Optional ledger_index

    ledger_index?: number

    The Ledger Index of a ledger version to which this message pertains.

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:317

    • Optional ledger_index_max

    ledger_index_max?: number

    The largest Ledger Index the peer has currently available.

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:319

    • Optional ledger_index_min

    ledger_index_min?: number

    The smallest Ledger Index the peer has currently available.

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:321

    • type

    type: "peerStatusChange"
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:306
    • @@ -369,6 +369,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -382,8 +385,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -421,7 +422,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/PingRequest.html b/docs/interfaces/PingRequest.html index 9e8d87a2de..1cf35895b4 100644 --- a/docs/interfaces/PingRequest.html +++ b/docs/interfaces/PingRequest.html @@ -32,7 +32,7 @@

    Hierarchy

    • PingRequest
    +
  • Defined in packages/xrpl/src/models/methods/ping.ts:10
    • @@ -53,7 +53,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "ping"
    @@ -61,7 +61,7 @@

    command

    Overrides BaseRequest.command

    +
  • Defined in packages/xrpl/src/models/methods/ping.ts:11

    • Optional id

    id?: string | number
    @@ -71,7 +71,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12
    • @@ -337,6 +337,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -350,8 +353,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -389,7 +390,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/PingResponse.html b/docs/interfaces/PingResponse.html index 9fa7060ade..b95f05bd76 100644 --- a/docs/interfaces/PingResponse.html +++ b/docs/interfaces/PingResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • PingResponse
    +
  • Defined in packages/xrpl/src/models/methods/ping.ts:19
    • @@ -55,19 +55,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;
    }
    @@ -80,31 +80,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
    • @@ -375,6 +375,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -388,8 +391,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -427,7 +428,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/RandomRequest.html b/docs/interfaces/RandomRequest.html index 0f7ab1d43a..776bec4088 100644 --- a/docs/interfaces/RandomRequest.html +++ b/docs/interfaces/RandomRequest.html @@ -33,7 +33,7 @@

    Hierarchy

    • RandomRequest
    +
  • Defined in packages/xrpl/src/models/methods/random.ts:10
    • @@ -54,7 +54,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "random"
    @@ -62,7 +62,7 @@

    command

    Overrides BaseRequest.command

    +
  • Defined in packages/xrpl/src/models/methods/random.ts:11

    • Optional id

    id?: string | number
    @@ -72,7 +72,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12
    • @@ -338,6 +338,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -351,8 +354,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -390,7 +391,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/RandomResponse.html b/docs/interfaces/RandomResponse.html index 98f7b3936b..84eb7e34df 100644 --- a/docs/interfaces/RandomResponse.html +++ b/docs/interfaces/RandomResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • RandomResponse
    +
  • Defined in packages/xrpl/src/models/methods/random.ts:19
    • @@ -55,19 +55,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;
    }
    @@ -78,31 +78,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
    • @@ -373,6 +373,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -386,8 +389,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -425,7 +426,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/ResponseOnlyTxInfo.html b/docs/interfaces/ResponseOnlyTxInfo.html index c8b5763772..2602d90be0 100644 --- a/docs/interfaces/ResponseOnlyTxInfo.html +++ b/docs/interfaces/ResponseOnlyTxInfo.html @@ -31,7 +31,7 @@

    Hierarchy

    • ResponseOnlyTxInfo
    +
  • Defined in packages/xrpl/src/models/common/index.ts:93
    • @@ -52,14 +52,14 @@

    Optional

    The date/time when this transaction was included in a validated ledger.

    +
  • Defined in packages/xrpl/src/models/common/index.ts:97

    • Optional hash

    hash?: string

    An identifying hash value unique to this transaction, as a hex string.

    +
  • Defined in packages/xrpl/src/models/common/index.ts:101

    • Optional inLedger

    inLedger?: number
    @@ -67,14 +67,14 @@

    OptionalDeprecated

    Alias for ledger_index.

    +
  • Defined in packages/xrpl/src/models/common/index.ts:109

    • Optional ledger_index

    ledger_index?: number

    The sequence number of the ledger that included this transaction.

    +
  • Defined in packages/xrpl/src/models/common/index.ts:105
    • @@ -341,6 +341,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -354,8 +357,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -393,7 +394,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/ResponseWarning.html b/docs/interfaces/ResponseWarning.html index 166b6138ca..57a3890efa 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
    • @@ -325,6 +325,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -338,8 +341,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -377,7 +378,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/RipplePathFindPathOption.html b/docs/interfaces/RipplePathFindPathOption.html index 74e9abe7f4..d165b0d174 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
    • @@ -45,7 +45,7 @@

    paths_computed

    Array of arrays of objects defining payment paths.

    +
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:45

    • source_amount

    source_amount: Amount
    @@ -53,7 +53,7 @@

    source_amount

    +
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:50
    • @@ -318,6 +318,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -331,8 +334,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -370,7 +371,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/RipplePathFindRequest.html b/docs/interfaces/RipplePathFindRequest.html index 4bc016e89a..eebc4e81c7 100644 --- a/docs/interfaces/RipplePathFindRequest.html +++ b/docs/interfaces/RipplePathFindRequest.html @@ -34,7 +34,7 @@

    Hierarchy

    • RipplePathFindRequest
    +
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:17
    • @@ -62,7 +62,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "ripple_path_find"
    @@ -70,14 +70,14 @@

    command

    Overrides BaseRequest.command

    +
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:20

    • destination_account

    destination_account: string

    Unique address of the account that would receive funds in a transaction.

    +
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:24

    • destination_amount

    destination_amount: Amount
    @@ -85,7 +85,7 @@

    destination_amount

    +
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:29

    • 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
    @@ -103,7 +103,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:21

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -111,7 +111,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:23

    • Optional send_max

    send_max?: Amount
    @@ -119,14 +119,14 @@

    Optionalsource_currencies.

    +
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:34

    • source_account

    source_account: string

    Unique address of the account that would send funds in a transaction.

    +
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:22

    • Optional source_currencies

    source_currencies?: SourceCurrencyAmount[]
    @@ -135,7 +135,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:40
    • @@ -408,6 +408,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -421,8 +424,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -460,7 +461,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/RipplePathFindResponse.html b/docs/interfaces/RipplePathFindResponse.html index 117aba53a8..497f67b44e 100644 --- a/docs/interfaces/RipplePathFindResponse.html +++ b/docs/interfaces/RipplePathFindResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • RipplePathFindResponse
    +
  • Defined in packages/xrpl/src/models/methods/ripplePathFind.ts:58
    • @@ -55,19 +55,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;
    }
    @@ -104,31 +104,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
    • @@ -399,6 +399,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -412,8 +415,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -451,7 +452,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/ServerInfoRequest.html b/docs/interfaces/ServerInfoRequest.html index dd4e1421ba..d08854d259 100644 --- a/docs/interfaces/ServerInfoRequest.html +++ b/docs/interfaces/ServerInfoRequest.html @@ -33,7 +33,7 @@

    Hierarchy

    • ServerInfoRequest
    +
  • Defined in packages/xrpl/src/models/methods/serverInfo.ts:10
    • @@ -54,7 +54,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "server_info"
    @@ -62,7 +62,7 @@

    command

    Overrides BaseRequest.command

    +
  • Defined in packages/xrpl/src/models/methods/serverInfo.ts:11

    • Optional id

    id?: string | number
    @@ -72,7 +72,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12
    • @@ -338,6 +338,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -351,8 +354,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -390,7 +391,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/ServerInfoResponse.html b/docs/interfaces/ServerInfoResponse.html index 12b11faff0..094e1a2cd1 100644 --- a/docs/interfaces/ServerInfoResponse.html +++ b/docs/interfaces/ServerInfoResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • ServerInfoResponse
    +
  • Defined in packages/xrpl/src/models/methods/serverInfo.ts:49
    • @@ -55,19 +55,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;
            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;
        };
    }
    @@ -313,31 +313,31 @@
    Optional

    Overrides BaseResponse.result

    +
  • Defined in packages/xrpl/src/models/methods/serverInfo.ts:50

    • 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
    • @@ -608,6 +608,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -621,8 +624,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -660,7 +661,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/ServerStateRequest.html b/docs/interfaces/ServerStateRequest.html index 0535ae7da3..842b997a00 100644 --- a/docs/interfaces/ServerStateRequest.html +++ b/docs/interfaces/ServerStateRequest.html @@ -34,7 +34,7 @@

    Hierarchy

    • ServerStateRequest
    +
  • Defined in packages/xrpl/src/models/methods/serverState.ts:12
    • @@ -55,7 +55,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "server_state"
    @@ -63,7 +63,7 @@

    command

    Overrides BaseRequest.command

    +
  • Defined in packages/xrpl/src/models/methods/serverState.ts:13

    • Optional id

    id?: string | number
    @@ -73,7 +73,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12
    • @@ -339,6 +339,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -352,8 +355,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -391,7 +392,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/ServerStateResponse.html b/docs/interfaces/ServerStateResponse.html index 129a5ec44a..c70ced4080 100644 --- a/docs/interfaces/ServerStateResponse.html +++ b/docs/interfaces/ServerStateResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • ServerStateResponse
    +
  • Defined in packages/xrpl/src/models/methods/serverState.ts:21
    • @@ -55,19 +55,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;
        };
    }
    @@ -171,31 +171,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
    • @@ -466,6 +466,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -479,8 +482,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -518,7 +519,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/SetFeePostAmendment.html b/docs/interfaces/SetFeePostAmendment.html index 9a534f594e..c19043d0e1 100644 --- a/docs/interfaces/SetFeePostAmendment.html +++ b/docs/interfaces/SetFeePostAmendment.html @@ -31,7 +31,7 @@

    Hierarchy

    • SetFeePostAmendment
    +
  • Defined in packages/xrpl/src/models/transactions/setFee.ts:22
    • @@ -66,7 +66,7 @@

    Account

    Inherited from BaseTransaction.Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:95

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -76,14 +76,14 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:119

    • BaseFeeDrops

    BaseFeeDrops: string

    The charge, in drops of XRP, for the reference transaction. (This is the transaction cost before scaling for load.)

    +
  • Defined in packages/xrpl/src/models/transactions/setFee.ts:26

    • Optional Fee

    Fee?: string
    @@ -93,7 +93,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:106

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -101,7 +101,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:121

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -111,7 +111,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:127

    • Optional Memos

    Memos?: Memo[]
    @@ -119,7 +119,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:131

    • Optional NetworkID

    NetworkID?: number
    @@ -127,21 +127,21 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:163

    • ReserveBaseDrops

    ReserveBaseDrops: string

    The base reserve, in drops

    +
  • Defined in packages/xrpl/src/models/transactions/setFee.ts:30

    • ReserveIncrementDrops

    ReserveIncrementDrops: string

    The incremental reserve, in drops

    +
  • Defined in packages/xrpl/src/models/transactions/setFee.ts:34

    • Optional Sequence

    Sequence?: number
    @@ -152,7 +152,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:113

    • Optional Signers

    Signers?: Signer[]
    @@ -161,7 +161,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:136

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -171,7 +171,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:149

    • Optional SourceTag

    SourceTag?: number
    @@ -182,7 +182,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:143

    • Optional TicketSequence

    TicketSequence?: number
    @@ -191,7 +191,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:154

    • TransactionType

    TransactionType: string
    @@ -200,7 +200,7 @@

    TransactionType

    Inherited from BaseTransaction.TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:100

    • Optional TxnSignature

    TxnSignature?: string
    @@ -209,7 +209,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:159
    • @@ -489,6 +489,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -502,8 +505,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -541,7 +542,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/SetFeePreAmendment.html b/docs/interfaces/SetFeePreAmendment.html index fe58b8a65b..39094d4d2b 100644 --- a/docs/interfaces/SetFeePreAmendment.html +++ b/docs/interfaces/SetFeePreAmendment.html @@ -31,7 +31,7 @@

    Hierarchy

    • SetFeePreAmendment
    +
  • Defined in packages/xrpl/src/models/transactions/setFee.ts:3
    • @@ -67,7 +67,7 @@

    Account

    Inherited from BaseTransaction.Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:95

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -77,14 +77,14 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:119

    • BaseFee

    BaseFee: string

    The charge, in drops of XRP, for the reference transaction, as hex. (This is the transaction cost before scaling for load.)

    +
  • Defined in packages/xrpl/src/models/transactions/setFee.ts:7

    • Optional Fee

    Fee?: string
    @@ -94,7 +94,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:106

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -102,7 +102,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:121

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -112,7 +112,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:127

    • Optional Memos

    Memos?: Memo[]
    @@ -120,7 +120,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:131

    • Optional NetworkID

    NetworkID?: number
    @@ -128,28 +128,28 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:163

    • ReferenceFeeUnits

    ReferenceFeeUnits: number

    The cost, in fee units, of the reference transaction

    +
  • Defined in packages/xrpl/src/models/transactions/setFee.ts:11

    • ReserveBase

    ReserveBase: number

    The base reserve, in drops

    +
  • Defined in packages/xrpl/src/models/transactions/setFee.ts:15

    • ReserveIncrement

    ReserveIncrement: number

    The incremental reserve, in drops

    +
  • Defined in packages/xrpl/src/models/transactions/setFee.ts:19

    • Optional Sequence

    Sequence?: number
    @@ -160,7 +160,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:113

    • Optional Signers

    Signers?: Signer[]
    @@ -169,7 +169,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:136

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -179,7 +179,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:149

    • Optional SourceTag

    SourceTag?: number
    @@ -190,7 +190,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:143

    • Optional TicketSequence

    TicketSequence?: number
    @@ -199,7 +199,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:154

    • TransactionType

    TransactionType: string
    @@ -208,7 +208,7 @@

    TransactionType

    Inherited from BaseTransaction.TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:100

    • Optional TxnSignature

    TxnSignature?: string
    @@ -217,7 +217,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:159
    • @@ -498,6 +498,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -511,8 +514,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -550,7 +551,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/SetRegularKey.html b/docs/interfaces/SetRegularKey.html index d1b7838827..1a966a825f 100644 --- a/docs/interfaces/SetRegularKey.html +++ b/docs/interfaces/SetRegularKey.html @@ -32,7 +32,7 @@

    Hierarchy

    • SetRegularKey
    +
  • Defined in packages/xrpl/src/models/transactions/setRegularKey.ts:11
    • @@ -65,7 +65,7 @@

    Account

    Inherited from BaseTransaction.Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:95

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -75,7 +75,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:119

    • Optional Fee

    Fee?: string
    @@ -85,7 +85,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:106

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -93,7 +93,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:121

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -103,7 +103,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:127

    • Optional Memos

    Memos?: Memo[]
    @@ -111,7 +111,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:131

    • Optional NetworkID

    NetworkID?: number
    @@ -119,7 +119,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:163

    • Optional RegularKey

    RegularKey?: string
    @@ -128,7 +128,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/setRegularKey.ts:18

    • Optional Sequence

    Sequence?: number
    @@ -139,7 +139,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:113

    • Optional Signers

    Signers?: Signer[]
    @@ -148,7 +148,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:136

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -158,7 +158,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:149

    • Optional SourceTag

    SourceTag?: number
    @@ -169,7 +169,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:143

    • Optional TicketSequence

    TicketSequence?: number
    @@ -178,7 +178,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:154

    • TransactionType

    TransactionType: "SetRegularKey"
    @@ -187,7 +187,7 @@

    TransactionType

    Overrides BaseTransaction.TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/setRegularKey.ts:12

    • Optional TxnSignature

    TxnSignature?: string
    @@ -196,7 +196,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:159
    • @@ -474,6 +474,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -487,8 +490,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -526,7 +527,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/Signer.html b/docs/interfaces/Signer.html index d4293a3dd5..dcb7155fea 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:26
    • @@ -51,7 +51,7 @@
    SigningPubKey
    TxnSignature: string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:27
    • @@ -315,6 +315,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -328,8 +331,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -367,7 +368,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/SignerEntry.html b/docs/interfaces/SignerEntry.html index 60fc101bd5..140d05f088 100644 --- a/docs/interfaces/SignerEntry.html +++ b/docs/interfaces/SignerEntry.html @@ -29,7 +29,7 @@

    Hierarchy

    • SignerEntry
    +
  • Defined in packages/xrpl/src/models/common/index.ts:63
    • @@ -67,7 +67,7 @@
    Optional
    +
  • Defined in packages/xrpl/src/models/common/index.ts:67
    • @@ -331,6 +331,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -344,8 +347,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -383,7 +384,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/SignerListSet.html b/docs/interfaces/SignerListSet.html index a390b2c7e2..574068ed0b 100644 --- a/docs/interfaces/SignerListSet.html +++ b/docs/interfaces/SignerListSet.html @@ -32,7 +32,7 @@

    Hierarchy

    • SignerListSet
    +
  • Defined in packages/xrpl/src/models/transactions/signerListSet.ts:12
    • @@ -66,7 +66,7 @@

    Account

    Inherited from BaseTransaction.Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:95

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -76,7 +76,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:119

    • Optional Fee

    Fee?: string
    @@ -86,7 +86,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:106

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -94,7 +94,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:121

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -104,7 +104,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:127

    • Optional Memos

    Memos?: Memo[]
    @@ -112,7 +112,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:131

    • Optional NetworkID

    NetworkID?: number
    @@ -120,7 +120,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:163

    • Optional Sequence

    Sequence?: number
    @@ -131,7 +131,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:113

    • Optional SignerEntries

    SignerEntries?: SignerEntry[]
    @@ -141,7 +141,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/signerListSet.ts:26

    • SignerQuorum

    SignerQuorum: number
    @@ -150,7 +150,7 @@

    SignerQuorum

    +
  • Defined in packages/xrpl/src/models/transactions/signerListSet.ts:19

    • Optional Signers

    Signers?: Signer[]
    @@ -159,7 +159,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:136

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -169,7 +169,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:149

    • Optional SourceTag

    SourceTag?: number
    @@ -180,7 +180,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:143

    • Optional TicketSequence

    TicketSequence?: number
    @@ -189,7 +189,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:154

    • TransactionType

    TransactionType: "SignerListSet"
    @@ -198,7 +198,7 @@

    TransactionType

    Overrides BaseTransaction.TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/signerListSet.ts:13

    • Optional TxnSignature

    TxnSignature?: string
    @@ -207,7 +207,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:159
    • @@ -486,6 +486,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -499,8 +502,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -538,7 +539,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/SourceCurrencyAmount.html b/docs/interfaces/SourceCurrencyAmount.html index 83fe4a960b..271dc2dfbe 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
    • @@ -313,6 +313,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -326,8 +329,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -365,7 +366,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/StateAccounting.html b/docs/interfaces/StateAccounting.html index 8ebbafe151..93cda6b057 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
    • @@ -313,6 +313,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -326,8 +329,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -365,7 +366,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/SubmitMultisignedRequest.html b/docs/interfaces/SubmitMultisignedRequest.html index 0aab0b70f8..769ec786c6 100644 --- a/docs/interfaces/SubmitMultisignedRequest.html +++ b/docs/interfaces/SubmitMultisignedRequest.html @@ -33,7 +33,7 @@

    Hierarchy

    • SubmitMultisignedRequest
    +
  • Defined in packages/xrpl/src/models/methods/submitMultisigned.ts:12
    • @@ -56,7 +56,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "submit_multisigned"
    @@ -64,7 +64,7 @@

    command

    Overrides BaseRequest.command

    +
  • Defined in packages/xrpl/src/models/methods/submitMultisigned.ts:13

    • Optional fail_hard

    fail_hard?: boolean
    @@ -72,7 +72,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/submitMultisigned.ts:24

    • Optional id

    id?: string | number
    @@ -82,7 +82,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • tx_json

    tx_json: Transaction
    @@ -91,7 +91,7 @@

    tx_jsonType/SignerList.

    +
  • Defined in packages/xrpl/src/models/methods/submitMultisigned.ts:19
    • @@ -359,6 +359,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -372,8 +375,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -411,7 +412,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/SubmitMultisignedResponse.html b/docs/interfaces/SubmitMultisignedResponse.html index 495c20a983..884c218028 100644 --- a/docs/interfaces/SubmitMultisignedResponse.html +++ b/docs/interfaces/SubmitMultisignedResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • SubmitMultisignedResponse
    +
  • Defined in packages/xrpl/src/models/methods/submitMultisigned.ts:32
    • @@ -55,19 +55,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;
    }
    @@ -98,31 +98,31 @@
    tx_json

    Overrides BaseResponse.result

    +
  • 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
    • @@ -393,6 +393,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -406,8 +409,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -445,7 +446,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/SubmitRequest.html b/docs/interfaces/SubmitRequest.html index ae1667b77f..620d07e903 100644 --- a/docs/interfaces/SubmitRequest.html +++ b/docs/interfaces/SubmitRequest.html @@ -33,7 +33,7 @@

    Hierarchy

    • SubmitRequest
    +
  • Defined in packages/xrpl/src/models/methods/submit.ts:12
    • @@ -56,7 +56,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "submit"
    @@ -64,7 +64,7 @@

    command

    Overrides BaseRequest.command

    +
  • Defined in packages/xrpl/src/models/methods/submit.ts:13

    • Optional fail_hard

    fail_hard?: boolean
    @@ -72,7 +72,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/submit.ts:20

    • Optional id

    id?: string | number
    @@ -82,14 +82,14 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • tx_blob

    tx_blob: string

    The complete transaction in hex string format.

    +
  • Defined in packages/xrpl/src/models/methods/submit.ts:15
    • @@ -357,6 +357,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -370,8 +373,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -409,7 +410,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/SubmitResponse.html b/docs/interfaces/SubmitResponse.html index c26ef86e33..49f335e50f 100644 --- a/docs/interfaces/SubmitResponse.html +++ b/docs/interfaces/SubmitResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • SubmitResponse
    +
  • Defined in packages/xrpl/src/models/methods/submit.ts:28
    • @@ -55,19 +55,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;
    }
    @@ -147,31 +147,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
    • @@ -442,6 +442,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -455,8 +458,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -494,7 +495,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/SubscribeBook.html b/docs/interfaces/SubscribeBook.html index 2d4fcca890..44ab8f3d97 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:14
    • @@ -48,7 +48,7 @@

    Optional

    If true, return both sides of the order book. The default is false.

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:36

    • Optional snapshot

    snapshot?: boolean
    @@ -56,7 +56,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:34

    • taker

    taker: string
    @@ -64,7 +64,7 @@

    taker

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:29

    • taker_gets

    taker_gets: Currency
    @@ -72,7 +72,7 @@

    taker_gets

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:19

    • taker_pays

    taker_pays: Currency
    @@ -80,7 +80,7 @@

    taker_pays

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:24
    • @@ -348,6 +348,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -361,8 +364,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -400,7 +401,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/SubscribeRequest.html b/docs/interfaces/SubscribeRequest.html index f4ddd63644..6dc9c78a05 100644 --- a/docs/interfaces/SubscribeRequest.html +++ b/docs/interfaces/SubscribeRequest.html @@ -33,7 +33,7 @@

    Hierarchy

    • SubscribeRequest
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:46
    • @@ -63,14 +63,14 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:56

    • Optional accounts_proposed

    accounts_proposed?: string[]

    Like accounts, but include transactions that are not yet finalized.

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:58

    • Optional api_version

    api_version?: number
    @@ -78,7 +78,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • Optional books

    books?: SubscribeBook[]
    @@ -86,7 +86,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:63

    • command

    command: "subscribe"
    @@ -94,7 +94,7 @@

    command

    Overrides BaseRequest.command

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:47

    • Optional id

    id?: string | number
    @@ -104,14 +104,14 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional streams

    streams?: StreamType[]

    Array of string names of generic streams to subscribe to.

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:49

    • Optional url

    url?: string
    @@ -119,21 +119,21 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:68

    • Optional url_password

    url_password?: string

    Password to provide for basic authentication at the callback URL.

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:72

    • Optional url_username

    url_username?: string

    Username to provide for basic authentication at the callback URL.

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:70
    • @@ -406,6 +406,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -419,8 +422,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -458,7 +459,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/SubscribeResponse.html b/docs/interfaces/SubscribeResponse.html index 421ad95c34..de04eb268c 100644 --- a/docs/interfaces/SubscribeResponse.html +++ b/docs/interfaces/SubscribeResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • SubscribeResponse
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:82
    • @@ -55,49 +55,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:83

    • 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
    • @@ -368,6 +368,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -381,8 +384,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -420,7 +421,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/TicketCreate.html b/docs/interfaces/TicketCreate.html index 3e0811e033..4358452ab2 100644 --- a/docs/interfaces/TicketCreate.html +++ b/docs/interfaces/TicketCreate.html @@ -32,7 +32,7 @@

    Hierarchy

    • TicketCreate
    +
  • Defined in packages/xrpl/src/models/transactions/ticketCreate.ts:11
    • @@ -65,7 +65,7 @@

    Account

    Inherited from BaseTransaction.Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:95

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -75,7 +75,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:119

    • Optional Fee

    Fee?: string
    @@ -85,7 +85,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:106

    • Optional Flags

    Flags?: number | GlobalFlags
    @@ -93,7 +93,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:121

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -103,7 +103,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:127

    • Optional Memos

    Memos?: Memo[]
    @@ -111,7 +111,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:131

    • Optional NetworkID

    NetworkID?: number
    @@ -119,7 +119,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:163

    • Optional Sequence

    Sequence?: number
    @@ -130,7 +130,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:113

    • Optional Signers

    Signers?: Signer[]
    @@ -139,7 +139,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:136

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -149,7 +149,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:149

    • Optional SourceTag

    SourceTag?: number
    @@ -160,7 +160,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:143

    • TicketCount

    TicketCount: number
    @@ -169,7 +169,7 @@

    TicketCount

    +
  • Defined in packages/xrpl/src/models/transactions/ticketCreate.ts:18

    • Optional TicketSequence

    TicketSequence?: number
    @@ -178,7 +178,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:154

    • TransactionType

    TransactionType: "TicketCreate"
    @@ -187,7 +187,7 @@

    TransactionType

    Overrides BaseTransaction.TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/ticketCreate.ts:12

    • Optional TxnSignature

    TxnSignature?: string
    @@ -196,7 +196,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:159
    • @@ -474,6 +474,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -487,8 +490,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -526,7 +527,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/TransactionAndMetadata.html b/docs/interfaces/TransactionAndMetadata.html index 9454500b62..8fb55b6486 100644 --- a/docs/interfaces/TransactionAndMetadata.html +++ b/docs/interfaces/TransactionAndMetadata.html @@ -26,7 +26,7 @@

    Hierarchy

    • TransactionAndMetadata
    +
  • Defined in packages/xrpl/src/models/transactions/transaction.ts:86
    • @@ -43,12 +43,12 @@

    Properties

    metadata

    metadata: TransactionMetadata
    +
  • Defined in packages/xrpl/src/models/transactions/transaction.ts:88

    • transaction

    transaction: Transaction
    +
  • Defined in packages/xrpl/src/models/transactions/transaction.ts:87
    • @@ -313,6 +313,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -326,8 +329,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -365,7 +366,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/TransactionEntryRequest.html b/docs/interfaces/TransactionEntryRequest.html index 138a6b67dd..25c196535d 100644 --- a/docs/interfaces/TransactionEntryRequest.html +++ b/docs/interfaces/TransactionEntryRequest.html @@ -34,7 +34,7 @@

    Hierarchy

    • TransactionEntryRequest
    +
  • Defined in packages/xrpl/src/models/methods/transactionEntry.ts:13
    • @@ -58,7 +58,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • command

    command: "transaction_entry"
    @@ -66,7 +66,7 @@

    command

    Overrides BaseRequest.command

    +
  • Defined in packages/xrpl/src/models/methods/transactionEntry.ts:16

    • Optional id

    id?: string | number
    @@ -76,7 +76,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional ledger_hash

    ledger_hash?: string
    @@ -84,7 +84,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:21

    • Optional ledger_index

    ledger_index?: LedgerIndex
    @@ -92,14 +92,14 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:23

    • tx_hash

    tx_hash: string

    Unique hash of the transaction you are looking up.

    +
  • Defined in packages/xrpl/src/models/methods/transactionEntry.ts:19
    • @@ -368,6 +368,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -381,8 +384,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -420,7 +421,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/TransactionEntryResponse.html b/docs/interfaces/TransactionEntryResponse.html index c4e45402bf..e88b00c292 100644 --- a/docs/interfaces/TransactionEntryResponse.html +++ b/docs/interfaces/TransactionEntryResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • TransactionEntryResponse
    +
  • Defined in packages/xrpl/src/models/methods/transactionEntry.ts:27
    • @@ -55,19 +55,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;
    }
    @@ -95,31 +95,31 @@
    tx_json

    Overrides BaseResponse.result

    +
  • 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
    • @@ -390,6 +390,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -403,8 +406,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -442,7 +443,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/TransactionMetadata.html b/docs/interfaces/TransactionMetadata.html index 77f1f37207..adfee69069 100644 --- a/docs/interfaces/TransactionMetadata.html +++ b/docs/interfaces/TransactionMetadata.html @@ -26,7 +26,7 @@

    Hierarchy

    • TransactionMetadata
    +
  • Defined in packages/xrpl/src/models/transactions/metadata.ts:62
    • @@ -46,27 +46,27 @@

    Properties

    AffectedNodes

    AffectedNodes: Node[]
    +
  • Defined in packages/xrpl/src/models/transactions/metadata.ts:63

    • Optional DeliveredAmount

    DeliveredAmount?: Amount
    +
  • Defined in packages/xrpl/src/models/transactions/metadata.ts:64

    • TransactionIndex

    TransactionIndex: number
    +
  • Defined in packages/xrpl/src/models/transactions/metadata.ts:67

    • TransactionResult

    TransactionResult: string
    +
  • Defined in packages/xrpl/src/models/transactions/metadata.ts:68

    • Optional delivered_amount

    delivered_amount?: Amount
    +
  • Defined in packages/xrpl/src/models/transactions/metadata.ts:66
    • @@ -334,6 +334,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -347,8 +350,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -386,7 +387,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/TransactionStream.html b/docs/interfaces/TransactionStream.html index a325483896..48b03724d1 100644 --- a/docs/interfaces/TransactionStream.html +++ b/docs/interfaces/TransactionStream.html @@ -31,7 +31,7 @@

    Hierarchy

    • TransactionStream
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:264
    • @@ -60,21 +60,21 @@

    engine_result

    String Transaction result code.

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:268

    • engine_result_code

    engine_result_code: number

    Numeric transaction response code, if applicable.

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:270

    • engine_result_message

    engine_result_message: string

    Human-readable explanation for the transaction response.

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:272

    • Optional ledger_current_index

    ledger_current_index?: number
    @@ -82,21 +82,21 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:277

    • Optional ledger_hash

    ledger_hash?: string

    The identifying hash of the ledger version that includes this transaction.

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:279

    • Optional ledger_index

    ledger_index?: number

    The ledger index of the ledger version that includes this transaction.

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:281

    • Optional meta

    meta?: TransactionMetadata
    @@ -104,25 +104,25 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:286

    • status

    status: string
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:265

    • transaction

    transaction: Object

    The definition of the transaction in JSON format.

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:288

    • type

    type: "transaction"
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:266

    • Optional validated

    validated?: boolean
    @@ -131,12 +131,12 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:294

    • Optional warnings

    warnings?: {
        id: number;
        message: string;
    }[]
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:295
    • @@ -411,6 +411,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -424,8 +427,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -463,7 +464,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/TrustSet.html b/docs/interfaces/TrustSet.html index d919cff9b3..b436eb85ba 100644 --- a/docs/interfaces/TrustSet.html +++ b/docs/interfaces/TrustSet.html @@ -31,7 +31,7 @@

    Hierarchy

    • TrustSet
    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:99
    • @@ -66,7 +66,7 @@

    Account

    Inherited from BaseTransaction.Account

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:95

    • Optional AccountTxnID

    AccountTxnID?: string
    @@ -76,7 +76,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:119

    • Optional Fee

    Fee?: string
    @@ -86,7 +86,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:106

    • Optional Flags

    Flags?: number | TrustSetFlagsInterface
    @@ -94,7 +94,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:118

    • Optional LastLedgerSequence

    LastLedgerSequence?: number
    @@ -104,7 +104,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:127

    • LimitAmount

    LimitAmount: IssuedCurrencyAmount
    @@ -112,7 +112,7 @@

    LimitAmount

    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:105

    • Optional Memos

    Memos?: Memo[]
    @@ -120,7 +120,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:131

    • Optional NetworkID

    NetworkID?: number
    @@ -128,7 +128,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:163

    • Optional QualityIn

    QualityIn?: number
    @@ -137,7 +137,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:111

    • Optional QualityOut

    QualityOut?: number
    @@ -146,7 +146,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:117

    • Optional Sequence

    Sequence?: number
    @@ -157,7 +157,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:113

    • Optional Signers

    Signers?: Signer[]
    @@ -166,7 +166,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:136

    • Optional SigningPubKey

    SigningPubKey?: string
    @@ -176,7 +176,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:149

    • Optional SourceTag

    SourceTag?: number
    @@ -187,7 +187,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:143

    • Optional TicketSequence

    TicketSequence?: number
    @@ -196,7 +196,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:154

    • TransactionType

    TransactionType: "TrustSet"
    @@ -205,7 +205,7 @@

    TransactionType

    Overrides BaseTransaction.TransactionType

    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:100

    • Optional TxnSignature

    TxnSignature?: string
    @@ -214,7 +214,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/common.ts:159
    • @@ -494,6 +494,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -507,8 +510,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -546,7 +547,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/TrustSetFlagsInterface.html b/docs/interfaces/TrustSetFlagsInterface.html index 3a44070903..888860f9c1 100644 --- a/docs/interfaces/TrustSetFlagsInterface.html +++ b/docs/interfaces/TrustSetFlagsInterface.html @@ -35,7 +35,7 @@

    Hierarchy

    • TrustSetFlagsInterface
    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:75
    • @@ -57,21 +57,21 @@

    Optional

    Unfreeze the trust line.

    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:91

    • Optional tfClearNoRipple

    tfClearNoRipple?: boolean

    Disable the No Ripple flag, allowing rippling on this trust line.

    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:87

    • Optional tfSetFreeze

    tfSetFreeze?: boolean

    Freeze the trust line.

    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:89

    • Optional tfSetNoRipple

    tfSetNoRipple?: boolean
    @@ -79,7 +79,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:85

    • Optional tfSetfAuth

    tfSetfAuth?: boolean
    @@ -87,7 +87,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/transactions/trustSet.ts:80
    • @@ -355,6 +355,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -368,8 +371,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -407,7 +408,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/TxRequest.html b/docs/interfaces/TxRequest.html index 0154b71973..701e5c5aa3 100644 --- a/docs/interfaces/TxRequest.html +++ b/docs/interfaces/TxRequest.html @@ -32,7 +32,7 @@

    Hierarchy

    • TxRequest
    +
  • Defined in packages/xrpl/src/models/methods/tx.ts:12
    • @@ -57,7 +57,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • Optional binary

    binary?: boolean
    @@ -66,7 +66,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/tx.ts:20

    • command

    command: "tx"
    @@ -74,7 +74,7 @@

    command

    Overrides BaseRequest.command

    +
  • Defined in packages/xrpl/src/models/methods/tx.ts:13

    • Optional id

    id?: string | number
    @@ -84,7 +84,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional max_ledger

    max_ledger?: number
    @@ -94,7 +94,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/tx.ts:34

    • Optional min_ledger

    min_ledger?: number
    @@ -104,12 +104,12 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/tx.ts:27

    • transaction

    transaction: string
    +
  • Defined in packages/xrpl/src/models/methods/tx.ts:14
    • @@ -379,6 +379,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -392,8 +395,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -431,7 +432,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/TxResponse.html b/docs/interfaces/TxResponse.html index f459f8a40f..c3502e8377 100644 --- a/docs/interfaces/TxResponse.html +++ b/docs/interfaces/TxResponse.html @@ -36,7 +36,7 @@

    Hierarchy

    • TxResponse
    +
  • Defined in packages/xrpl/src/models/methods/tx.ts:42
    • @@ -61,25 +61,25 @@

    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: {
        date?: number;
        hash: string;
        ledger_index?: number;
        meta?: string | TransactionMetadata;
        validated?: boolean;
    } & T
    +
  • Defined in packages/xrpl/src/models/methods/tx.ts:44

    • Optional searched_all

    searched_all?: boolean
    @@ -89,31 +89,31 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/tx.ts:68

    • 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
    • @@ -385,6 +385,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -398,8 +401,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -437,7 +438,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/UNLModify.html b/docs/interfaces/UNLModify.html index 3000e782e6..d111054c25 100644 --- a/docs/interfaces/UNLModify.html +++ b/docs/interfaces/UNLModify.html @@ -29,7 +29,7 @@

    Hierarchy

    • UNLModify
    +
  • Defined in packages/xrpl/src/models/transactions/UNLModify.ts:6
    • @@ -51,12 +51,12 @@

    LedgerSequence

    +
  • Defined in packages/xrpl/src/models/transactions/UNLModify.ts:12

    • TransactionType

    TransactionType: "UNLModify"
    +
  • Defined in packages/xrpl/src/models/transactions/UNLModify.ts:7

    • UNLModifyDisabling

    UNLModifyDisabling: 0 | 1
    @@ -64,14 +64,14 @@

    UNLModifyDisabling

    +
  • Defined in packages/xrpl/src/models/transactions/UNLModify.ts:17

    • UNLModifyValidator

    UNLModifyValidator: string

    The validator to add or remove, as identified by its master public key.

    +
  • Defined in packages/xrpl/src/models/transactions/UNLModify.ts:19
    • @@ -338,6 +338,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -351,8 +354,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -390,7 +391,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/UnsubscribeBook.html b/docs/interfaces/UnsubscribeBook.html index 26348a6141..e8097c4bd2 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
    • @@ -320,6 +320,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -333,8 +336,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -372,7 +373,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/UnsubscribeRequest.html b/docs/interfaces/UnsubscribeRequest.html index 6dacc71550..c57980055b 100644 --- a/docs/interfaces/UnsubscribeRequest.html +++ b/docs/interfaces/UnsubscribeRequest.html @@ -33,7 +33,7 @@

    Hierarchy

    • UnsubscribeRequest
    +
  • Defined in packages/xrpl/src/models/methods/unsubscribe.ts:18
    • @@ -58,7 +58,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/unsubscribe.ts:29

    • Optional accounts_proposed

    accounts_proposed?: string[]
    @@ -66,7 +66,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/unsubscribe.ts:34

    • Optional api_version

    api_version?: number
    @@ -74,7 +74,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

    • Optional books

    books?: UnsubscribeBook[]
    @@ -82,7 +82,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/unsubscribe.ts:39

    • command

    command: "unsubscribe"
    @@ -90,7 +90,7 @@

    command

    Overrides BaseRequest.command

    +
  • Defined in packages/xrpl/src/models/methods/unsubscribe.ts:19

    • Optional id

    id?: string | number
    @@ -100,7 +100,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

    • Optional streams

    streams?: StreamType[]
    @@ -108,7 +108,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/unsubscribe.ts:24
    • @@ -378,6 +378,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -391,8 +394,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -430,7 +431,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/UnsubscribeResponse.html b/docs/interfaces/UnsubscribeResponse.html index 6d031234da..e8e00edfc3 100644 --- a/docs/interfaces/UnsubscribeResponse.html +++ b/docs/interfaces/UnsubscribeResponse.html @@ -31,7 +31,7 @@

    Hierarchy

    • UnsubscribeResponse
    +
  • Defined in packages/xrpl/src/models/methods/unsubscribe.ts:47
    • @@ -55,49 +55,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
    • @@ -368,6 +368,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -381,8 +384,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -420,7 +421,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/ValidationStream.html b/docs/interfaces/ValidationStream.html index c77d5d87a3..e2ac31bb2d 100644 --- a/docs/interfaces/ValidationStream.html +++ b/docs/interfaces/ValidationStream.html @@ -33,7 +33,7 @@

    Hierarchy

    • ValidationStream
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:182
    • @@ -67,14 +67,14 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:188

    • Optional base_fee

    base_fee?: number

    The amendments this server wants to be added to the protocol.

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:190

    • Optional cookie

    cookie?: string
    @@ -84,14 +84,14 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:198

    • Optional data

    data?: string

    The contents of the validation message in its canonical binary form

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:202

    • flags

    flags: number
    @@ -99,7 +99,7 @@

    flags

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:207

    • full

    full: boolean
    @@ -111,7 +111,7 @@

    full

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:216

    • ledger_hash

    ledger_hash: string
    @@ -121,14 +121,14 @@

    ledger_hash

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:223

    • ledger_index

    ledger_index: string

    The ledger index of the proposed ledger.

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:225

    • Optional load_fee

    load_fee?: number
    @@ -136,7 +136,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:230

    • Optional master_key

    master_key?: string
    @@ -144,7 +144,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:235

    • Optional reserve_base

    reserve_base?: number
    @@ -152,7 +152,7 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:240

    • Optional reserve_inc

    reserve_inc?: number
    @@ -160,27 +160,27 @@

    Optional

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:245

    • signature

    signature: string

    The signature that the validator used to sign its vote for this ledger.

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:247

    • signing_time

    signing_time: number

    When this validation vote was signed, in seconds since the Ripple Epoch.

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:249

    • type

    type: "validationReceived"
    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:183

    • validation_public_key

    validation_public_key: string
    @@ -190,7 +190,7 @@

    validation_public_key

    +
  • Defined in packages/xrpl/src/models/methods/subscribe.ts:256
    • @@ -469,6 +469,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -482,8 +485,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -521,7 +522,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/interfaces/XRP.html b/docs/interfaces/XRP.html index a024dbab18..0e7747d8e7 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
    • @@ -42,7 +42,7 @@

    Properties

    currency

    currency: "XRP"
    +
  • Defined in packages/xrpl/src/models/common/index.ts:4
    • @@ -306,6 +306,9 @@

    Stream
  • StreamType
  • Transaction
    • +
  • deriveAddress
    • +
  • deriveKeypair
    • +
  • verifyKeypairSignature
  • hashes
  • authorizeChannel
  • classicAddressToXAddress
    • @@ -319,8 +322,6 @@

    decodeNodePublic
  • decodeSeed
  • decodeXAddress
    • -
  • deriveAddress
    • -
  • deriveKeypair
  • deriveXAddress
  • dropsToXrp
  • encode
    • @@ -358,7 +359,6 @@

    transferRateToDecimal
  • unixTimeToRippleTime
  • validate
    • -
  • verifyKeypairSignature
  • verifyPaymentChannelClaim
  • verifySignature
  • xAddressToClassicAddress
    • diff --git a/docs/modules.html b/docs/modules.html index aa91ef2bcf..6b8c968892 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -20,7 +20,9 @@

    xrpl

    -

    Index

    +
    + +

    Clients

    BroadcastClient @@ -280,6 +282,9 @@

    Other

    ServerState StateAccountingFinal StreamType +deriveAddress +deriveKeypair +verifyKeypairSignature classicAddressToXAddress decode decodeAccountID @@ -287,8 +292,6 @@

    Other

    decodeNodePublic decodeSeed decodeXAddress -deriveAddress -deriveKeypair encode encodeAccountID encodeAccountPublic @@ -309,7 +312,6 @@

    Other

    parseNFTokenID rfc1751MnemonicToKey setTransactionFlagsToNumber -verifyKeypairSignature xAddressToClassicAddress
    @@ -317,7 +319,74 @@

    Pseudo Transaction Models

    EnableAmendment UNLModify SetFee -
    +
    +
    +

    Other

    +
    +

    deriveAddress

    +
    deriveAddress: ((publicKey) => string)
    +
    +

    Type declaration

    +
      +
    • +
        +
      • (publicKey): string
        • +
      • +
        +

        Parameters

        +
          +
        • +
          publicKey: any
        +

        Returns string

    +
    +

    deriveKeypair

    +
    deriveKeypair: ((seed, options?) => {
        privateKey: string;
        publicKey: string;
    })
    +
    +

    Type declaration

    +
      +
    • +
        +
      • (seed, options?): {
            privateKey: string;
            publicKey: string;
        }
        • +
      • +
        +

        Parameters

        +
          +
        • +
          seed: string
          • +
        • +
          Optional options: object
        +

        Returns {
            privateKey: string;
            publicKey: string;
        }

        +
          +
        • +
          privateKey: string
          • +
        • +
          publicKey: string
    +
    +

    verifyKeypairSignature

    +
    verifyKeypairSignature: ((messageHex, signature, publicKey) => boolean)
    +
    +

    Type declaration

    +
      +
    • +
        +
      • (messageHex, signature, publicKey): boolean
        • +
      • +
        +

        Parameters

        +
          +
        • +
          messageHex: any
          • +
        • +
          signature: any
          • +
        • +
          publicKey: any
        +

        Returns boolean

    @@ -332,7 +401,14 @@

    Member Visibility

    • -

    Theme

    +

    Theme

    +
    +

    On This Page

     +
    +
    PayChannel, a SignerList, a Ticket, or a RippleState.

    +
  • Defined in packages/xrpl/src/models/methods/accountObjects.ts:66
    • @@ -285,6 +285,9 @@

    Theme

    Amount: IssuedCurrencyAmount | string
    +
  • Defined in packages/xrpl/src/models/common/index.ts:18
    • @@ -282,6 +282,9 @@

    Theme

    Currency: IssuedCurrency | XRP
    +
  • Defined in packages/xrpl/src/models/common/index.ts:12
    • @@ -282,6 +282,9 @@

    Theme

    LedgerDataLedgerState: {
        index: string;
    } & (LedgerDataBinaryLedgerEntry | LedgerDataLabeledLedgerEntry)
    +
  • Defined in packages/xrpl/src/models/methods/ledgerData.ts:50
    • @@ -282,6 +282,9 @@

    Theme

    LedgerIndex: number | "validated" | "closed" | "current"
    +
  • Defined in packages/xrpl/src/models/common/index.ts:1
    • @@ -282,6 +282,9 @@

    Theme

    Path: PathStep[]
    +
  • Defined in packages/xrpl/src/models/common/index.ts:58
    • @@ -282,6 +282,9 @@

    Theme

    Request: AccountChannelsRequest | AccountCurrenciesRequest | AccountInfoRequest | AccountLinesRequest | AccountNFTsRequest | AccountObjectsRequest | AccountOffersRequest | AccountTxRequest | GatewayBalancesRequest | NoRippleCheckRequest | LedgerRequest | LedgerClosedRequest | LedgerCurrentRequest | LedgerDataRequest | LedgerEntryRequest | SubmitRequest | SubmitMultisignedRequest | TransactionEntryRequest | TxRequest | BookOffersRequest | DepositAuthorizedRequest | PathFindRequest | RipplePathFindRequest | ChannelVerifyRequest | SubscribeRequest | UnsubscribeRequest | FeeRequest | ManifestRequest | ServerInfoRequest | ServerStateRequest | PingRequest | RandomRequest | NFTBuyOffersRequest | NFTSellOffersRequest | NFTInfoRequest | NFTHistoryRequest
    +
  • Defined in packages/xrpl/src/models/methods/index.ts:152
    • @@ -282,6 +282,9 @@

    Theme

    ServerState: "disconnected" | "connected" | "syncing" | "tracking" | "full" | "validating" | "proposing"
    +
  • Defined in packages/xrpl/src/models/methods/serverInfo.ts:14
    • @@ -282,6 +282,9 @@

    Theme

    StateAccountingFinal: Record<Exclude<ServerState, "validating" | "proposing">, StateAccounting>
    +
  • Defined in packages/xrpl/src/models/methods/serverInfo.ts:39
    • @@ -282,6 +282,9 @@

    Theme

    StreamType: "consensus" | "ledger" | "manifests" | "peer_status" | "transactions" | "transactions_proposed" | "server" | "validations"
    +
  • Defined in packages/xrpl/src/models/common/index.ts:42
    • @@ -282,6 +282,9 @@

    Theme

    +
  • Defined in packages/xrpl/src/models/ledger/Amendments.ts:6
    • @@ -285,6 +285,9 @@

    Theme

    +
  • Defined in packages/xrpl/src/models/ledger/NegativeUNL.ts:6
    • @@ -285,6 +285,9 @@

    Theme