mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-12-06 17:27:59 +00:00
Compare commits
64 Commits
xrpl@3.1.0
...
v4.1.0
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
11e724253b | ||
|
|
f34d1a7a63 | ||
|
|
7bf6fecc71 | ||
|
|
303c2b983c | ||
|
|
448164da70 | ||
|
|
9f72c8d384 | ||
|
|
e42d418662 | ||
|
|
305f2c48bf | ||
|
|
b7dfcbf075 | ||
|
|
b04efe8c9e | ||
|
|
e3188b83ed | ||
|
|
f4011b58e7 | ||
|
|
00614753ff | ||
|
|
b3a76bd9c0 | ||
|
|
24e9ad7c12 | ||
|
|
c2dd2edbcc | ||
|
|
c9207337aa | ||
|
|
a6852dd588 | ||
|
|
3a604ce69a | ||
|
|
663b80f1d0 | ||
|
|
92eb809397 | ||
|
|
799cd65386 | ||
|
|
29d145138b | ||
|
|
496f774154 | ||
|
|
0395c14392 | ||
|
|
2a77e2cd91 | ||
|
|
619c9ae13a | ||
|
|
8beb1292b5 | ||
|
|
649bf7d277 | ||
|
|
e0d368791b | ||
|
|
be9b48b071 | ||
|
|
55892c8b89 | ||
|
|
b1b4995047 | ||
|
|
a726a5a4f9 | ||
|
|
8992d3914e | ||
|
|
c2e01b3d10 | ||
|
|
8bfe5b42b8 | ||
|
|
385a56a1f7 | ||
|
|
f3960c3ccc | ||
|
|
a46e86f17e | ||
|
|
8f5d210806 | ||
|
|
17c91cdd3a | ||
|
|
74a41832ce | ||
|
|
275c95752b | ||
|
|
3bc3c2029b | ||
|
|
c9ef96e0a2 | ||
|
|
00f1a6bcdd | ||
|
|
3858a09e1f | ||
|
|
3aaf526107 | ||
|
|
1460cf5026 | ||
|
|
7e733c4446 | ||
|
|
735ac2eb07 | ||
|
|
c79a5db8f2 | ||
|
|
8e2aba3b78 | ||
|
|
39fed49654 | ||
|
|
a0678857a1 | ||
|
|
38e2091fd2 | ||
|
|
a528d6632a | ||
|
|
ab081e7db9 | ||
|
|
493c56c0fa | ||
|
|
c73b2c5a86 | ||
|
|
02e2b0e48e | ||
|
|
d3b03a536d | ||
|
|
036f1f9850 |
@@ -178,3 +178,13 @@ PriceOracle
|
||||
fixEmptyDID
|
||||
fixXChainRewardRounding
|
||||
fixPreviousTxnID
|
||||
fixAMMv1_1
|
||||
# 2.3.0 Amendments
|
||||
fixAMMv1_2
|
||||
Credentials
|
||||
NFTokenMintOffer
|
||||
MPTokensV1
|
||||
fixNFTokenPageLinks
|
||||
fixInnerObjTemplate2
|
||||
fixEnforceNFTokenTrustline
|
||||
fixReducedOffersV2
|
||||
|
||||
30
.coderabbit.yaml
Normal file
30
.coderabbit.yaml
Normal file
@@ -0,0 +1,30 @@
|
||||
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
|
||||
language: "en-US"
|
||||
reviews:
|
||||
# Set the profile for reviews. Assertive profile yields more feedback, that may be considered nitpicky.
|
||||
profile: "chill"
|
||||
# Approve the review once CodeRabbit's comments are resolved. Note: In GitLab, all discussions must be resolved.
|
||||
request_changes_workflow: false
|
||||
# Generate a high level summary of the changes in the PR/MR description.
|
||||
high_level_summary: false
|
||||
# Generate a poem in the walkthrough comment.
|
||||
poem: true
|
||||
# Post review details on each review. Additionally, post a review status when a review is skipped in certain cases.
|
||||
review_status: true
|
||||
# Generate walkthrough in a markdown collapsible section.
|
||||
collapse_walkthrough: false
|
||||
# Generate sequence diagrams in the walkthrough.
|
||||
sequence_diagrams: false
|
||||
# Abort the in-progress review if the pull request is closed or merged.
|
||||
abort_on_close: true
|
||||
auto_review:
|
||||
# Automatic Review | Automatic code review
|
||||
enabled: true
|
||||
# Review draft PRs/MRs.
|
||||
drafts: false
|
||||
# Ignore reviewing if the title of the pull request contains any of these keywords (case-insensitive).
|
||||
ignore_title_keywords:
|
||||
- build(
|
||||
chat:
|
||||
# Enable the bot to reply automatically without requiring the user to tag it.
|
||||
auto_reply: true
|
||||
58
.github/workflows/codeql-analysis.yml
vendored
58
.github/workflows/codeql-analysis.yml
vendored
@@ -12,13 +12,11 @@
|
||||
name: "CodeQL"
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ main, 1.x ]
|
||||
pull_request:
|
||||
# The branches below must be a subset of the branches above
|
||||
branches: [ main ]
|
||||
branches: [main]
|
||||
schedule:
|
||||
- cron: '44 5 * * 6'
|
||||
- cron: "44 5 * * 6"
|
||||
|
||||
jobs:
|
||||
analyze:
|
||||
@@ -28,40 +26,40 @@ jobs:
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
language: [ 'javascript' ]
|
||||
language: ["javascript"]
|
||||
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
|
||||
# Learn more:
|
||||
# https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v3
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
|
||||
# Initializes the CodeQL tools for scanning.
|
||||
- name: Initialize CodeQL
|
||||
uses: github/codeql-action/init@v2
|
||||
with:
|
||||
languages: ${{ matrix.language }}
|
||||
# If you wish to specify custom queries, you can do so here or in a config file.
|
||||
# By default, queries listed here will override any specified in a config file.
|
||||
# Prefix the list here with "+" to use these queries and those in the config file.
|
||||
# queries: ./path/to/local/query, your-org/your-repo/queries@main
|
||||
# Initializes the CodeQL tools for scanning.
|
||||
- name: Initialize CodeQL
|
||||
uses: github/codeql-action/init@v3
|
||||
with:
|
||||
languages: ${{ matrix.language }}
|
||||
# If you wish to specify custom queries, you can do so here or in a config file.
|
||||
# By default, queries listed here will override any specified in a config file.
|
||||
# Prefix the list here with "+" to use these queries and those in the config file.
|
||||
# queries: ./path/to/local/query, your-org/your-repo/queries@main
|
||||
|
||||
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
|
||||
# If this step fails, then you should remove it and run the build manually (see below)
|
||||
- name: Autobuild
|
||||
uses: github/codeql-action/autobuild@v2
|
||||
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
|
||||
# If this step fails, then you should remove it and run the build manually (see below)
|
||||
- name: Autobuild
|
||||
uses: github/codeql-action/autobuild@v3
|
||||
|
||||
# ℹ️ Command-line programs to run using the OS shell.
|
||||
# 📚 https://git.io/JvXDl
|
||||
# ℹ️ Command-line programs to run using the OS shell.
|
||||
# 📚 https://git.io/JvXDl
|
||||
|
||||
# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
|
||||
# and modify them (or add more) to build your code if your project
|
||||
# uses a compiled language
|
||||
# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
|
||||
# and modify them (or add more) to build your code if your project
|
||||
# uses a compiled language
|
||||
|
||||
#- run: |
|
||||
# make bootstrap
|
||||
# make release
|
||||
#- run: |
|
||||
# make bootstrap
|
||||
# make release
|
||||
|
||||
- name: Perform CodeQL Analysis
|
||||
uses: github/codeql-action/analyze@v2
|
||||
- name: Perform CodeQL Analysis
|
||||
uses: github/codeql-action/analyze@v3
|
||||
|
||||
71
.github/workflows/nodejs.yml
vendored
71
.github/workflows/nodejs.yml
vendored
@@ -4,7 +4,7 @@
|
||||
name: Node.js CI
|
||||
|
||||
env:
|
||||
RIPPLED_DOCKER_IMAGE: rippleci/rippled:2.2.0-b3
|
||||
RIPPLED_DOCKER_IMAGE: rippleci/rippled:2.3.0-rc1
|
||||
|
||||
on:
|
||||
push:
|
||||
@@ -19,22 +19,22 @@ jobs:
|
||||
|
||||
strategy:
|
||||
matrix:
|
||||
node-version: [16.x]
|
||||
node-version: [18.x]
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- uses: actions/checkout@v4
|
||||
- name: Use Node.js ${{ matrix.node-version }}
|
||||
uses: actions/setup-node@v3
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: ${{ matrix.node-version }}
|
||||
|
||||
- name: Setup npm version 9
|
||||
- name: Setup npm version 10
|
||||
run: |
|
||||
npm i -g npm@9 --registry=https://registry.npmjs.org
|
||||
npm i -g npm@10 --registry=https://registry.npmjs.org
|
||||
|
||||
- name: Cache node modules
|
||||
id: cache-nodemodules
|
||||
uses: actions/cache@v3
|
||||
uses: actions/cache@v4
|
||||
env:
|
||||
cache-name: cache-node-modules
|
||||
with:
|
||||
@@ -45,7 +45,6 @@ jobs:
|
||||
key: ${{ runner.os }}-deps-${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-deps-${{ matrix.node-version }}-
|
||||
${{ runner.os }}-deps-
|
||||
|
||||
- name: Install Dependencies
|
||||
if: steps.cache-nodemodules.outputs.cache-hit != 'true'
|
||||
@@ -60,22 +59,22 @@ jobs:
|
||||
|
||||
strategy:
|
||||
matrix:
|
||||
node-version: [16.x, 18.x, 20.x]
|
||||
node-version: [18.x, 20.x, 22.x]
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- uses: actions/checkout@v4
|
||||
- name: Use Node.js ${{ matrix.node-version }}
|
||||
uses: actions/setup-node@v3
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: ${{ matrix.node-version }}
|
||||
|
||||
- name: Setup npm version 9
|
||||
- name: Setup npm version 10
|
||||
run: |
|
||||
npm i -g npm@9 --registry=https://registry.npmjs.org
|
||||
npm i -g npm@10 --registry=https://registry.npmjs.org
|
||||
|
||||
- name: Cache node modules
|
||||
id: cache-nodemodules
|
||||
uses: actions/cache@v3
|
||||
uses: actions/cache@v4
|
||||
env:
|
||||
cache-name: cache-node-modules
|
||||
with:
|
||||
@@ -86,7 +85,6 @@ jobs:
|
||||
key: ${{ runner.os }}-deps-${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-deps-${{ matrix.node-version }}-
|
||||
${{ runner.os }}-deps-
|
||||
|
||||
- name: Install Dependencies
|
||||
if: steps.cache-nodemodules.outputs.cache-hit != 'true'
|
||||
@@ -101,27 +99,27 @@ jobs:
|
||||
|
||||
strategy:
|
||||
matrix:
|
||||
node-version: [16.x, 18.x, 20.x]
|
||||
node-version: [18.x, 20.x, 22.x]
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Run docker in background
|
||||
run: |
|
||||
docker run --detach --rm --name rippled-service -p 6006:6006 --volume "${{ github.workspace }}/.ci-config/":"/opt/ripple/etc/" --health-cmd="wget localhost:6006 || exit 1" --health-interval=5s --health-retries=10 --health-timeout=2s --env GITHUB_ACTIONS=true --env CI=true ${{ env.RIPPLED_DOCKER_IMAGE }} /opt/ripple/bin/rippled -a --conf /opt/ripple/etc/rippled.cfg
|
||||
docker run --detach --rm -p 6006:6006 --volume "${{ github.workspace }}/.ci-config/":"/etc/opt/ripple/" --name rippled-service --health-cmd="rippled server_info || exit 1" --health-interval=5s --health-retries=10 --health-timeout=2s --env GITHUB_ACTIONS=true --env CI=true --entrypoint bash ${{ env.RIPPLED_DOCKER_IMAGE }} -c "rippled -a"
|
||||
|
||||
- name: Use Node.js ${{ matrix.node-version }}
|
||||
uses: actions/setup-node@v3
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: ${{ matrix.node-version }}
|
||||
|
||||
- name: Setup npm version 9
|
||||
- name: Setup npm version 10
|
||||
run: |
|
||||
npm i -g npm@9 --registry=https://registry.npmjs.org
|
||||
npm i -g npm@10 --registry=https://registry.npmjs.org
|
||||
|
||||
- name: Cache node modules
|
||||
id: cache-nodemodules
|
||||
uses: actions/cache@v3
|
||||
uses: actions/cache@v4
|
||||
env:
|
||||
cache-name: cache-node-modules
|
||||
with:
|
||||
@@ -132,7 +130,6 @@ jobs:
|
||||
key: ${{ runner.os }}-deps-${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-deps-${{ matrix.node-version }}-
|
||||
${{ runner.os }}-deps-
|
||||
|
||||
- name: Install Dependencies
|
||||
if: steps.cache-nodemodules.outputs.cache-hit != 'true'
|
||||
@@ -153,27 +150,27 @@ jobs:
|
||||
|
||||
strategy:
|
||||
matrix:
|
||||
node-version: [16.x]
|
||||
node-version: [18.x]
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Use Node.js ${{ matrix.node-version }}
|
||||
uses: actions/setup-node@v3
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: ${{ matrix.node-version }}
|
||||
|
||||
- name: Run docker in background
|
||||
run: |
|
||||
docker run --detach --rm --name rippled-service -p 6006:6006 --volume "${{ github.workspace }}/.ci-config/":"/opt/ripple/etc/" --health-cmd="wget localhost:6006 || exit 1" --health-interval=5s --health-retries=10 --health-timeout=2s --env GITHUB_ACTIONS=true --env CI=true ${{ env.RIPPLED_DOCKER_IMAGE }} /opt/ripple/bin/rippled -a --conf /opt/ripple/etc/rippled.cfg
|
||||
docker run --detach --rm -p 6006:6006 --volume "${{ github.workspace }}/.ci-config/":"/etc/opt/ripple/" --name rippled-service --health-cmd="rippled server_info || exit 1" --health-interval=5s --health-retries=10 --health-timeout=2s --env GITHUB_ACTIONS=true --env CI=true --entrypoint bash ${{ env.RIPPLED_DOCKER_IMAGE }} -c "rippled -a"
|
||||
|
||||
- name: Setup npm version 9
|
||||
- name: Setup npm version 10
|
||||
run: |
|
||||
npm i -g npm@9 --registry=https://registry.npmjs.org
|
||||
npm i -g npm@10 --registry=https://registry.npmjs.org
|
||||
|
||||
- name: Cache node modules
|
||||
id: cache-nodemodules
|
||||
uses: actions/cache@v3
|
||||
uses: actions/cache@v4
|
||||
env:
|
||||
cache-name: cache-node-modules
|
||||
with:
|
||||
@@ -184,7 +181,6 @@ jobs:
|
||||
key: ${{ runner.os }}-deps-${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-deps-${{ matrix.node-version }}-
|
||||
${{ runner.os }}-deps-
|
||||
|
||||
- name: Install Dependencies
|
||||
if: steps.cache-nodemodules.outputs.cache-hit != 'true'
|
||||
@@ -205,22 +201,22 @@ jobs:
|
||||
|
||||
strategy:
|
||||
matrix:
|
||||
node-version: [16.x, 18.x, 20.x]
|
||||
node-version: [18.x, 20.x, 22.x]
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- uses: actions/checkout@v4
|
||||
- name: Use Node.js ${{ matrix.node-version }}
|
||||
uses: actions/setup-node@v3
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: ${{ matrix.node-version }}
|
||||
|
||||
- name: Setup npm version 9
|
||||
- name: Setup npm version 10
|
||||
run: |
|
||||
npm i -g npm@9 --registry=https://registry.npmjs.org
|
||||
npm i -g npm@10 --registry=https://registry.npmjs.org
|
||||
|
||||
- name: Cache node modules
|
||||
id: cache-nodemodules
|
||||
uses: actions/cache@v3
|
||||
uses: actions/cache@v4
|
||||
env:
|
||||
cache-name: cache-node-modules
|
||||
with:
|
||||
@@ -231,7 +227,6 @@ jobs:
|
||||
key: ${{ runner.os }}-deps-${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-deps-${{ matrix.node-version }}-
|
||||
${{ runner.os }}-deps-
|
||||
|
||||
- name: Install Dependencies
|
||||
if: steps.cache-nodemodules.outputs.cache-hit != 'true'
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
|
||||
### Requirements
|
||||
|
||||
We use Node v16 for development - that is the version that our linters require.
|
||||
We use Node v18 for development - that is the version that our linters require.
|
||||
You must also use `npm` v7. You can check your `npm` version with:
|
||||
|
||||
```bash
|
||||
@@ -64,18 +64,20 @@ 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:/opt/ripple/etc/ --platform linux/amd64 rippleci/rippled:2.0.0-b4 /opt/ripple/bin/rippled -a --conf /opt/ripple/etc/rippled.cfg
|
||||
docker run -p 6006:6006 --rm -it --name rippled_standalone --volume $PWD/.ci-config:/etc/opt/ripple/ --entrypoint bash rippleci/rippled:2.3.0-rc1 -c 'rippled -a'
|
||||
npm run build
|
||||
npm run test:integration
|
||||
```
|
||||
|
||||
Breaking down the command:
|
||||
* `docker run -p 6006:6006` starts a Docker container with an open port for admin WebSocket requests.
|
||||
* `--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 `./`.
|
||||
`--rm` tells docker to close the container after processes are done running.
|
||||
* `-it` allows you to interact with the container.
|
||||
`--name rippled_standalone` is an instance name for clarity
|
||||
* `--volume $PWD/.ci-config:/etc/opt/ripple/` identifies the `rippled.cfg` and `validators.txt` to import. It must be an absolute path, so we use `$PWD` instead of `./`.
|
||||
* `rippleci/rippled` is an image that is regularly updated with the latest `rippled` releases
|
||||
* `/opt/ripple/bin/rippled -a --conf /opt/ripple/etc/rippled.cfg` starts `rippled` in standalone mode
|
||||
* `--entrypoint bash rippleci/rippled:2.3.0-rc1` manually overrides the entrypoint (for versions of rippled >= 2.3.0)
|
||||
* `-c 'rippled -a'` provides the bash command to start `rippled` in standalone mode from the manual entrypoint
|
||||
|
||||
### Browser Tests
|
||||
|
||||
@@ -90,7 +92,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 --interactive -t --volume $PWD/.ci-config:/opt/ripple/etc/ --platform linux/amd64 rippleci/rippled:2.2.0-b3 /opt/ripple/bin/rippled -a --conf /opt/ripple/etc/rippled.cfg
|
||||
docker run -p 6006:6006 --rm -it --name rippled_standalone --volume $PWD/.ci-config:/etc/opt/ripple/ --entrypoint bash rippleci/rippled:2.3.0-rc1 -c 'rippled -a'
|
||||
npm run test:browser
|
||||
```
|
||||
|
||||
@@ -104,6 +106,8 @@ The 4 packages currently here are:
|
||||
2. ripple-binary-codec - A library for serializing and deserializing transactions for the ledger.
|
||||
3. ripple-keypairs - A library for generating and using cryptographic keypairs.
|
||||
4. ripple-address-codec - A library for encoding and decoding XRP Ledger addresses and seeds.
|
||||
5. isomorphic - A collection of isomorphic implementations of crypto and utility functions.
|
||||
6. secret-numbers - Generate XRPL Accounts with a number-based secret: 8 chunks of 6 digits.
|
||||
|
||||
Each package has it's own README which dives deeper into what it's main purpose is, and the core functionality it offers.
|
||||
They also run tests independently as they were originally in separate repositories.
|
||||
@@ -128,13 +132,13 @@ For every file in `src`, we try to have a corresponding file in `test` with unit
|
||||
|
||||
The goal is to maintain above 80% code coverage, and generally any new feature or bug fix should be accompanied by unit tests, and integration tests if applicable.
|
||||
|
||||
For an example of a unit test, check out the [autofill tests here](./packages/xrpl/test/client/autofill.ts).
|
||||
For an example of a unit test, check out the [autofill tests here](./packages/xrpl/test/client/autofill.test.ts).
|
||||
|
||||
If your code connects to the ledger (ex. Adding a new transaction type) it's handy to write integration tests to ensure that you can successfully interact with the ledger. Integration tests are generally run against a docker instance of rippled which contains the latest updates. Since standalone mode allows us to manually close ledgers, this allows us to run integration tests at a much faster rate than if we had to wait 4-5 seconds per transaction for the ledger to validate the transaction. [See above](#running-tests) for how to start up the docker container to run integration tests.
|
||||
|
||||
All integration tests should be written in the `test/integration` folder, with new `Requests` and `Transactions` tests being in their respective folders.
|
||||
|
||||
For an example of how to write an integration test for `xrpl.js`, you can look at the [Payment integration test](./packages/xrpl/test/integration/transactions/payment.ts).
|
||||
For an example of how to write an integration test for `xrpl.js`, you can look at the [Payment integration test](./packages/xrpl/test/integration/transactions/payment.test.ts).
|
||||
|
||||
## Generate reference docs
|
||||
|
||||
|
||||
@@ -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 v16+) & web browsers (tested for Chrome).
|
||||
All of which works in Node.js (tested for v18+) & web browsers (tested for Chrome).
|
||||
|
||||
# Quickstart
|
||||
|
||||
### Requirements
|
||||
|
||||
+ **[Node.js v16](https://nodejs.org/)** is recommended. We also support v18 and v20. Other versions may work but are not frequently tested.
|
||||
+ **[Node.js v18](https://nodejs.org/)** is recommended. We also support v20 and v22. Other versions may work but are not frequently tested.
|
||||
|
||||
### Installing xrpl.js
|
||||
|
||||
@@ -56,7 +56,7 @@ async function main() {
|
||||
});
|
||||
console.log(response);
|
||||
|
||||
client.disconnect();
|
||||
await client.disconnect();
|
||||
}
|
||||
main();
|
||||
```
|
||||
|
||||
17452
package-lock.json
generated
17452
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
@@ -25,7 +25,7 @@
|
||||
"@types/chai": "^4.2.21",
|
||||
"@types/jest": "^29.2.2",
|
||||
"@types/lodash": "^4.14.136",
|
||||
"@types/node": "^16.18.38",
|
||||
"@types/node": "^18.19.29",
|
||||
"@types/ws": "^8.2.0",
|
||||
"@typescript-eslint/eslint-plugin": "^5.28.0",
|
||||
"@typescript-eslint/parser": "^5.28.0",
|
||||
@@ -64,7 +64,7 @@
|
||||
"./packages/*"
|
||||
],
|
||||
"engines": {
|
||||
"node": ">=16.0.0",
|
||||
"npm": ">=7.10.0 < 10.0.0"
|
||||
"node": ">=18.0.0",
|
||||
"npm": ">=7.10.0"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -33,7 +33,7 @@
|
||||
"ws": "^8.13.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/node": "^16.18.38",
|
||||
"@types/node": "^18.18.38",
|
||||
"@types/ws": "^8.5.6"
|
||||
},
|
||||
"repository": {
|
||||
@@ -43,6 +43,6 @@
|
||||
"license": "ISC",
|
||||
"prettier": "@xrplf/prettier-config",
|
||||
"engines": {
|
||||
"node": ">=16.0.0"
|
||||
"node": ">=18.0.0"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -34,6 +34,6 @@
|
||||
},
|
||||
"prettier": "@xrplf/prettier-config",
|
||||
"engines": {
|
||||
"node": ">= 16"
|
||||
"node": ">= 18"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2,6 +2,11 @@
|
||||
|
||||
## Unreleased
|
||||
|
||||
## 2.2.0 (2024-12-23)
|
||||
|
||||
### Added
|
||||
* Support for the Multi-Purpose Token amendment (XLS-33)
|
||||
|
||||
## 2.1.0 (2024-06-03)
|
||||
|
||||
### Added
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "ripple-binary-codec",
|
||||
"version": "2.1.0",
|
||||
"version": "2.2.0",
|
||||
"description": "XRP Ledger binary codec",
|
||||
"files": [
|
||||
"dist/*",
|
||||
@@ -41,6 +41,6 @@
|
||||
"readmeFilename": "README.md",
|
||||
"prettier": "@xrplf/prettier-config",
|
||||
"engines": {
|
||||
"node": ">= 16"
|
||||
"node": ">= 18"
|
||||
}
|
||||
}
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -6,6 +6,7 @@ import { JsonObject, SerializedType } from './serialized-type'
|
||||
import BigNumber from 'bignumber.js'
|
||||
import { bytesToHex, concat, hexToBytes } from '@xrplf/isomorphic/utils'
|
||||
import { readUInt32BE, writeUInt32BE } from '../utils'
|
||||
import { Hash192 } from './hash-192'
|
||||
|
||||
/**
|
||||
* Constants for validating amounts
|
||||
@@ -16,6 +17,7 @@ const MAX_IOU_PRECISION = 16
|
||||
const MAX_DROPS = new BigNumber('1e17')
|
||||
const MIN_XRP = new BigNumber('1e-6')
|
||||
const mask = BigInt(0x00000000ffffffff)
|
||||
const mptMask = BigInt(0x8000000000000000)
|
||||
|
||||
/**
|
||||
* BigNumber configuration for Amount IOUs
|
||||
@@ -27,20 +29,28 @@ BigNumber.config({
|
||||
],
|
||||
})
|
||||
|
||||
/**
|
||||
* Interface for JSON objects that represent amounts
|
||||
*/
|
||||
interface AmountObject extends JsonObject {
|
||||
interface AmountObjectIOU extends JsonObject {
|
||||
value: string
|
||||
currency: string
|
||||
issuer: string
|
||||
}
|
||||
|
||||
interface AmountObjectMPT extends JsonObject {
|
||||
value: string
|
||||
mpt_issuance_id: string
|
||||
}
|
||||
|
||||
/**
|
||||
* Type guard for AmountObject
|
||||
* Interface for JSON objects that represent amounts
|
||||
*/
|
||||
function isAmountObject(arg): arg is AmountObject {
|
||||
type AmountObject = AmountObjectIOU | AmountObjectMPT
|
||||
|
||||
/**
|
||||
* Type guard for AmountObjectIOU
|
||||
*/
|
||||
function isAmountObjectIOU(arg): arg is AmountObjectIOU {
|
||||
const keys = Object.keys(arg).sort()
|
||||
|
||||
return (
|
||||
keys.length === 3 &&
|
||||
keys[0] === 'currency' &&
|
||||
@@ -49,6 +59,17 @@ function isAmountObject(arg): arg is AmountObject {
|
||||
)
|
||||
}
|
||||
|
||||
/**
|
||||
* Type guard for AmountObjectMPT
|
||||
*/
|
||||
function isAmountObjectMPT(arg): arg is AmountObjectMPT {
|
||||
const keys = Object.keys(arg).sort()
|
||||
|
||||
return (
|
||||
keys.length === 2 && keys[0] === 'mpt_issuance_id' && keys[1] === 'value'
|
||||
)
|
||||
}
|
||||
|
||||
/**
|
||||
* Class for serializing/Deserializing Amounts
|
||||
*/
|
||||
@@ -60,7 +81,7 @@ class Amount extends SerializedType {
|
||||
}
|
||||
|
||||
/**
|
||||
* Construct an amount from an IOU or string amount
|
||||
* Construct an amount from an IOU, MPT or string amount
|
||||
*
|
||||
* @param value An Amount, object representing an IOU, or a string
|
||||
* representing an integer amount
|
||||
@@ -88,7 +109,7 @@ class Amount extends SerializedType {
|
||||
return new Amount(amount)
|
||||
}
|
||||
|
||||
if (isAmountObject(value)) {
|
||||
if (isAmountObjectIOU(value)) {
|
||||
const number = new BigNumber(value.value)
|
||||
Amount.assertIouIsValid(number)
|
||||
|
||||
@@ -124,6 +145,24 @@ class Amount extends SerializedType {
|
||||
return new Amount(concat([amount, currency, issuer]))
|
||||
}
|
||||
|
||||
if (isAmountObjectMPT(value)) {
|
||||
Amount.assertMptIsValid(value.value)
|
||||
|
||||
let leadingByte = new Uint8Array(1)
|
||||
leadingByte[0] |= 0x60
|
||||
|
||||
const num = BigInt(value.value)
|
||||
|
||||
const intBuf = [new Uint8Array(4), new Uint8Array(4)]
|
||||
writeUInt32BE(intBuf[0], Number(num >> BigInt(32)), 0)
|
||||
writeUInt32BE(intBuf[1], Number(num & BigInt(mask)), 0)
|
||||
|
||||
amount = concat(intBuf)
|
||||
|
||||
const mptIssuanceID = Hash192.from(value.mpt_issuance_id).toBytes()
|
||||
return new Amount(concat([leadingByte, amount, mptIssuanceID]))
|
||||
}
|
||||
|
||||
throw new Error('Invalid type to construct an Amount')
|
||||
}
|
||||
|
||||
@@ -134,8 +173,12 @@ class Amount extends SerializedType {
|
||||
* @returns An Amount object
|
||||
*/
|
||||
static fromParser(parser: BinaryParser): Amount {
|
||||
const isXRP = parser.peek() & 0x80
|
||||
const numBytes = isXRP ? 48 : 8
|
||||
const isIOU = parser.peek() & 0x80
|
||||
if (isIOU) return new Amount(parser.read(48))
|
||||
|
||||
// the amount can be either MPT or XRP at this point
|
||||
const isMPT = parser.peek() & 0x20
|
||||
const numBytes = isMPT ? 33 : 8
|
||||
return new Amount(parser.read(numBytes))
|
||||
}
|
||||
|
||||
@@ -156,7 +199,9 @@ class Amount extends SerializedType {
|
||||
const num = (msb << BigInt(32)) | lsb
|
||||
|
||||
return `${sign}${num.toString()}`
|
||||
} else {
|
||||
}
|
||||
|
||||
if (this.isIOU()) {
|
||||
const parser = new BinaryParser(this.toString())
|
||||
const mantissa = parser.read(8)
|
||||
const currency = Currency.fromParser(parser) as Currency
|
||||
@@ -182,6 +227,27 @@ class Amount extends SerializedType {
|
||||
issuer: issuer.toJSON(),
|
||||
}
|
||||
}
|
||||
|
||||
if (this.isMPT()) {
|
||||
const parser = new BinaryParser(this.toString())
|
||||
const leadingByte = parser.read(1)
|
||||
const amount = parser.read(8)
|
||||
const mptID = Hash192.fromParser(parser) as Hash192
|
||||
|
||||
const isPositive = leadingByte[0] & 0x40
|
||||
const sign = isPositive ? '' : '-'
|
||||
|
||||
const msb = BigInt(readUInt32BE(amount.slice(0, 4), 0))
|
||||
const lsb = BigInt(readUInt32BE(amount.slice(4), 0))
|
||||
const num = (msb << BigInt(32)) | lsb
|
||||
|
||||
return {
|
||||
value: `${sign}${num.toString()}`,
|
||||
mpt_issuance_id: mptID.toString(),
|
||||
}
|
||||
}
|
||||
|
||||
throw new Error('Invalid amount to construct JSON')
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -224,6 +290,29 @@ class Amount extends SerializedType {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Validate MPT.value amount
|
||||
*
|
||||
* @param decimal BigNumber object representing MPT.value
|
||||
* @returns void, but will throw if invalid amount
|
||||
*/
|
||||
private static assertMptIsValid(amount: string): void {
|
||||
if (amount.indexOf('.') !== -1) {
|
||||
throw new Error(`${amount.toString()} is an illegal amount`)
|
||||
}
|
||||
|
||||
const decimal = new BigNumber(amount)
|
||||
if (!decimal.isZero()) {
|
||||
if (decimal < BigNumber(0)) {
|
||||
throw new Error(`${amount.toString()} is an illegal amount`)
|
||||
}
|
||||
|
||||
if (Number(BigInt(amount) & BigInt(mptMask)) != 0) {
|
||||
throw new Error(`${amount.toString()} is an illegal amount`)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Ensure that the value after being multiplied by the exponent does not
|
||||
* contain a decimal.
|
||||
@@ -248,7 +337,25 @@ class Amount extends SerializedType {
|
||||
* @returns true if Native (XRP)
|
||||
*/
|
||||
private isNative(): boolean {
|
||||
return (this.bytes[0] & 0x80) === 0
|
||||
return (this.bytes[0] & 0x80) === 0 && (this.bytes[0] & 0x20) === 0
|
||||
}
|
||||
|
||||
/**
|
||||
* Test if this amount is in units of MPT
|
||||
*
|
||||
* @returns true if MPT
|
||||
*/
|
||||
private isMPT(): boolean {
|
||||
return (this.bytes[0] & 0x80) === 0 && (this.bytes[0] & 0x20) !== 0
|
||||
}
|
||||
|
||||
/**
|
||||
* Test if this amount is in units of IOU
|
||||
*
|
||||
* @returns true if IOU
|
||||
*/
|
||||
private isIOU(): boolean {
|
||||
return (this.bytes[0] & 0x80) !== 0
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
19
packages/ripple-binary-codec/src/types/hash-192.ts
Normal file
19
packages/ripple-binary-codec/src/types/hash-192.ts
Normal file
@@ -0,0 +1,19 @@
|
||||
import { Hash } from './hash'
|
||||
|
||||
/**
|
||||
* Hash with a width of 192 bits
|
||||
*/
|
||||
class Hash192 extends Hash {
|
||||
static readonly width = 24
|
||||
static readonly ZERO_192: Hash192 = new Hash192(new Uint8Array(Hash192.width))
|
||||
|
||||
constructor(bytes?: Uint8Array) {
|
||||
if (bytes && bytes.byteLength === 0) {
|
||||
bytes = Hash192.ZERO_192.bytes
|
||||
}
|
||||
|
||||
super(bytes ?? Hash192.ZERO_192.bytes)
|
||||
}
|
||||
}
|
||||
|
||||
export { Hash192 }
|
||||
@@ -4,6 +4,7 @@ import { Blob } from './blob'
|
||||
import { Currency } from './currency'
|
||||
import { Hash128 } from './hash-128'
|
||||
import { Hash160 } from './hash-160'
|
||||
import { Hash192 } from './hash-192'
|
||||
import { Hash256 } from './hash-256'
|
||||
import { Issue } from './issue'
|
||||
import { PathSet } from './path-set'
|
||||
@@ -25,6 +26,7 @@ const coreTypes: Record<string, typeof SerializedType> = {
|
||||
Currency,
|
||||
Hash128,
|
||||
Hash160,
|
||||
Hash192,
|
||||
Hash256,
|
||||
Issue,
|
||||
PathSet,
|
||||
@@ -51,6 +53,7 @@ export {
|
||||
Currency,
|
||||
Hash128,
|
||||
Hash160,
|
||||
Hash192,
|
||||
Hash256,
|
||||
PathSet,
|
||||
STArray,
|
||||
|
||||
@@ -67,7 +67,7 @@ class SerializedType {
|
||||
* Can be customized for sidechains and amendments.
|
||||
* @returns any type, if not overloaded returns hexString representation of bytes
|
||||
*/
|
||||
toJSON(_definitions?: XrplDefinitionsBase): JSON {
|
||||
toJSON(_definitions?: XrplDefinitionsBase, _fieldName?: string): JSON {
|
||||
return this.toHex()
|
||||
}
|
||||
|
||||
|
||||
@@ -10,6 +10,7 @@ import { BinaryParser } from '../serdes/binary-parser'
|
||||
import { BinarySerializer, BytesList } from '../serdes/binary-serializer'
|
||||
|
||||
import { STArray } from './st-array'
|
||||
import { UInt64 } from './uint-64'
|
||||
|
||||
const OBJECT_END_MARKER_BYTE = Uint8Array.from([0xe1])
|
||||
const OBJECT_END_MARKER = 'ObjectEndMarker'
|
||||
@@ -137,6 +138,8 @@ class STObject extends SerializedType {
|
||||
? this.from(xAddressDecoded[field.name], undefined, definitions)
|
||||
: field.type.name === 'STArray'
|
||||
? STArray.from(xAddressDecoded[field.name], definitions)
|
||||
: field.type.name === 'UInt64'
|
||||
? UInt64.from(xAddressDecoded[field.name], field.name)
|
||||
: field.associatedType.from(xAddressDecoded[field.name])
|
||||
|
||||
if (associatedValue == undefined) {
|
||||
@@ -182,7 +185,7 @@ class STObject extends SerializedType {
|
||||
|
||||
accumulator[field.name] = objectParser
|
||||
.readFieldValue(field)
|
||||
.toJSON(definitions)
|
||||
.toJSON(definitions, field.name)
|
||||
}
|
||||
|
||||
return accumulator
|
||||
|
||||
@@ -2,10 +2,20 @@ import { UInt } from './uint'
|
||||
import { BinaryParser } from '../serdes/binary-parser'
|
||||
import { bytesToHex, concat, hexToBytes } from '@xrplf/isomorphic/utils'
|
||||
import { readUInt32BE, writeUInt32BE } from '../utils'
|
||||
import { DEFAULT_DEFINITIONS, XrplDefinitionsBase } from '../enums'
|
||||
|
||||
const HEX_REGEX = /^[a-fA-F0-9]{1,16}$/
|
||||
const BASE10_REGEX = /^[0-9]{1,20}$/
|
||||
const mask = BigInt(0x00000000ffffffff)
|
||||
|
||||
function useBase10(fieldName: string): boolean {
|
||||
return (
|
||||
fieldName === 'MaximumAmount' ||
|
||||
fieldName === 'OutstandingAmount' ||
|
||||
fieldName === 'MPTAmount'
|
||||
)
|
||||
}
|
||||
|
||||
/**
|
||||
* Derived UInt class for serializing/deserializing 64 bit UInt
|
||||
*/
|
||||
@@ -29,7 +39,10 @@ class UInt64 extends UInt {
|
||||
* @param val A UInt64, hex-string, bigInt, or number
|
||||
* @returns A UInt64 object
|
||||
*/
|
||||
static from<T extends UInt64 | string | bigint | number>(val: T): UInt64 {
|
||||
static from<T extends UInt64 | string | bigint | number>(
|
||||
val: T,
|
||||
fieldName = '',
|
||||
): UInt64 {
|
||||
if (val instanceof UInt64) {
|
||||
return val
|
||||
}
|
||||
@@ -51,11 +64,18 @@ class UInt64 extends UInt {
|
||||
}
|
||||
|
||||
if (typeof val === 'string') {
|
||||
if (!HEX_REGEX.test(val)) {
|
||||
if (useBase10(fieldName)) {
|
||||
if (!BASE10_REGEX.test(val)) {
|
||||
throw new Error(`${fieldName} ${val} is not a valid base 10 string`)
|
||||
}
|
||||
val = BigInt(val).toString(16) as T
|
||||
}
|
||||
|
||||
if (typeof val === 'string' && !HEX_REGEX.test(val)) {
|
||||
throw new Error(`${val} is not a valid hex-string`)
|
||||
}
|
||||
|
||||
const strBuf = val.padStart(16, '0')
|
||||
const strBuf = (val as string).padStart(16, '0')
|
||||
buf = hexToBytes(strBuf)
|
||||
return new UInt64(buf)
|
||||
}
|
||||
@@ -76,8 +96,16 @@ class UInt64 extends UInt {
|
||||
*
|
||||
* @returns a hex-string
|
||||
*/
|
||||
toJSON(): string {
|
||||
return bytesToHex(this.bytes)
|
||||
toJSON(
|
||||
_definitions: XrplDefinitionsBase = DEFAULT_DEFINITIONS,
|
||||
fieldName = '',
|
||||
): string {
|
||||
const hexString = bytesToHex(this.bytes)
|
||||
if (useBase10(fieldName)) {
|
||||
return BigInt('0x' + hexString).toString(10)
|
||||
}
|
||||
|
||||
return hexString
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
import { coreTypes } from '../src/types'
|
||||
import fixtures from './fixtures/data-driven-tests.json'
|
||||
|
||||
import { makeParser } from '../src/binary'
|
||||
const { Amount } = coreTypes
|
||||
|
||||
function amountErrorTests() {
|
||||
@@ -25,6 +27,16 @@ describe('Amount', function () {
|
||||
it('can be parsed from', function () {
|
||||
expect(Amount.from('1000000') instanceof Amount).toBe(true)
|
||||
expect(Amount.from('1000000').toJSON()).toEqual('1000000')
|
||||
|
||||
// it not valid to have negative XRP. But we test it anyways
|
||||
// to ensure logic correctness for toJSON of the Amount class
|
||||
{
|
||||
const parser = makeParser('0000000000000001')
|
||||
const value = parser.readType(Amount)
|
||||
const json = value.toJSON()
|
||||
expect(json).toEqual('-1')
|
||||
}
|
||||
|
||||
const fixture = {
|
||||
value: '1',
|
||||
issuer: '0000000000000000000000000000000000000000',
|
||||
@@ -38,5 +50,35 @@ describe('Amount', function () {
|
||||
}
|
||||
expect(amt.toJSON()).toEqual(rewritten)
|
||||
})
|
||||
|
||||
it('can be parsed from MPT', function () {
|
||||
let fixture = {
|
||||
value: '100',
|
||||
mpt_issuance_id: '00002403C84A0A28E0190E208E982C352BBD5006600555CF',
|
||||
}
|
||||
let amt = Amount.from(fixture)
|
||||
expect(amt.toJSON()).toEqual(fixture)
|
||||
|
||||
fixture = {
|
||||
value: '9223372036854775807',
|
||||
mpt_issuance_id: '00002403C84A0A28E0190E208E982C352BBD5006600555CF',
|
||||
}
|
||||
amt = Amount.from(fixture)
|
||||
expect(amt.toJSON()).toEqual(fixture)
|
||||
|
||||
// it not valid to have negative MPT. But we test it anyways
|
||||
// to ensure logic correctness for toJSON of the Amount class
|
||||
{
|
||||
const parser = makeParser(
|
||||
'20000000000000006400002403C84A0A28E0190E208E982C352BBD5006600555CF',
|
||||
)
|
||||
const value = parser.readType(Amount)
|
||||
const json = value.toJSON()
|
||||
expect(json).toEqual({
|
||||
mpt_issuance_id: '00002403C84A0A28E0190E208E982C352BBD5006600555CF',
|
||||
value: '-100',
|
||||
})
|
||||
}
|
||||
})
|
||||
amountErrorTests()
|
||||
})
|
||||
|
||||
@@ -22,6 +22,7 @@ function assertEqualAmountJSON(actual, expected) {
|
||||
}
|
||||
expect(actual.currency).toEqual(expected.currency)
|
||||
expect(actual.issuer).toEqual(expected.issuer)
|
||||
expect(actual.mpt_issuance_id).toEqual(expected.mpt_issuance_id)
|
||||
expect(
|
||||
actual.value === expected.value ||
|
||||
new BigNumber(actual.value).eq(new BigNumber(expected.value)),
|
||||
@@ -207,12 +208,12 @@ function amountParsingTests() {
|
||||
return
|
||||
}
|
||||
const parser = makeParser(f.expected_hex)
|
||||
const testName = `values_tests[${i}] parses ${f.expected_hex.slice(
|
||||
const hexToJsonTestName = `values_tests[${i}] parses ${f.expected_hex.slice(
|
||||
0,
|
||||
16,
|
||||
)}...
|
||||
as ${JSON.stringify(f.test_json)}`
|
||||
it(testName, () => {
|
||||
it(hexToJsonTestName, () => {
|
||||
const value = parser.readType(Amount)
|
||||
// May not actually be in canonical form. The fixtures are to be used
|
||||
// also for json -> binary;
|
||||
@@ -223,6 +224,15 @@ function amountParsingTests() {
|
||||
expect((exponent.e ?? 0) - 15).toEqual(f?.exponent)
|
||||
}
|
||||
})
|
||||
|
||||
const jsonToHexTestName = `values_tests[${i}] parses ${JSON.stringify(
|
||||
f.test_json,
|
||||
)}...
|
||||
as ${f.expected_hex.slice(0, 16)}`
|
||||
it(jsonToHexTestName, () => {
|
||||
const amt = Amount.from(f.test_json)
|
||||
expect(amt.toHex()).toEqual(f.expected_hex)
|
||||
})
|
||||
})
|
||||
}
|
||||
|
||||
|
||||
@@ -2499,7 +2499,7 @@
|
||||
"type_id": 6,
|
||||
"is_native": true,
|
||||
"type": "Amount",
|
||||
"expected_hex": "0000000000000001",
|
||||
"error": "Value is negative",
|
||||
"is_negative": true
|
||||
},
|
||||
{
|
||||
@@ -2914,6 +2914,170 @@
|
||||
"type": "Amount",
|
||||
"error": "10000000000000000000 absolute XRP is bigger than max native value 100000000000.0",
|
||||
"is_negative": true
|
||||
},
|
||||
{
|
||||
"test_json": {
|
||||
"mpt_issuance_id": "00002403C84A0A28E0190E208E982C352BBD5006600555CF",
|
||||
"value": "9223372036854775808"
|
||||
},
|
||||
"type": "Amount",
|
||||
"error": "Value is too large"
|
||||
},
|
||||
{
|
||||
"test_json": {
|
||||
"mpt_issuance_id": "00002403C84A0A28E0190E208E982C352BBD5006600555CF",
|
||||
"value": "18446744073709551615"
|
||||
},
|
||||
"type": "Amount",
|
||||
"error": "Value is too large"
|
||||
},
|
||||
{
|
||||
"test_json": {
|
||||
"mpt_issuance_id": "00002403C84A0A28E0190E208E982C352BBD5006600555CF",
|
||||
"value": "-1"
|
||||
},
|
||||
"type": "Amount",
|
||||
"error": "Value is negative"
|
||||
},
|
||||
{
|
||||
"test_json": {
|
||||
"mpt_issuance_id": "00002403C84A0A28E0190E208E982C352BBD5006600555CF",
|
||||
"value": "10.1"
|
||||
},
|
||||
"type": "Amount",
|
||||
"error": "Value has decimal point"
|
||||
},
|
||||
{
|
||||
"test_json": {
|
||||
"mpt_issuance_id": "10",
|
||||
"value": "10"
|
||||
},
|
||||
"type": "Amount",
|
||||
"error": "mpt_issuance_id has invalid hash length"
|
||||
},
|
||||
{
|
||||
"test_json": {
|
||||
"mpt_issuance_id": "00002403C84A0A28E0190E208E982C352BBD5006600555CF",
|
||||
"value": "10",
|
||||
"issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji"
|
||||
},
|
||||
"type": "Amount",
|
||||
"error": "Issuer not valid for MPT"
|
||||
},
|
||||
{
|
||||
"test_json": {
|
||||
"mpt_issuance_id": "00002403C84A0A28E0190E208E982C352BBD5006600555CF",
|
||||
"value": "10",
|
||||
"currency": "USD"
|
||||
},
|
||||
"type": "Amount",
|
||||
"error": "Currency not valid for MPT"
|
||||
},
|
||||
{
|
||||
"test_json": {
|
||||
"mpt_issuance_id": "00002403C84A0A28E0190E208E982C352BBD5006600555CF",
|
||||
"value": "a"
|
||||
},
|
||||
"type": "Amount",
|
||||
"error": "Value has incorrect hex format"
|
||||
},
|
||||
{
|
||||
"test_json": {
|
||||
"mpt_issuance_id": "00002403C84A0A28E0190E208E982C352BBD5006600555CF",
|
||||
"value": "0xy"
|
||||
},
|
||||
"type": "Amount",
|
||||
"error": "Value has bad hex character"
|
||||
},
|
||||
{
|
||||
"test_json": {
|
||||
"mpt_issuance_id": "00002403C84A0A28E0190E208E982C352BBD5006600555CF",
|
||||
"value": "/"
|
||||
},
|
||||
"type": "Amount",
|
||||
"error": "Value has bad character"
|
||||
},
|
||||
{
|
||||
"test_json": {
|
||||
"mpt_issuance_id": "00002403C84A0A28E0190E208E982C352BBD5006600555CF",
|
||||
"value": "0x8000000000000000"
|
||||
},
|
||||
"type": "Amount",
|
||||
"error": "Hex value out of range"
|
||||
},
|
||||
{
|
||||
"test_json": {
|
||||
"mpt_issuance_id": "00002403C84A0A28E0190E208E982C352BBD5006600555CF",
|
||||
"value": "0xFFFFFFFFFFFFFFFF"
|
||||
},
|
||||
"type": "Amount",
|
||||
"error": "Hex value out of range"
|
||||
},
|
||||
{
|
||||
"test_json": {
|
||||
"mpt_issuance_id":"00002403C84A0A28E0190E208E982C352BBD5006600555CF",
|
||||
"value": "9223372036854775807"
|
||||
},
|
||||
"type_id": 6,
|
||||
"is_native": false,
|
||||
"type": "Amount",
|
||||
"expected_hex": "607FFFFFFFFFFFFFFF00002403C84A0A28E0190E208E982C352BBD5006600555CF",
|
||||
"is_negative": false
|
||||
},
|
||||
{
|
||||
"test_json": {
|
||||
"mpt_issuance_id":"00002403C84A0A28E0190E208E982C352BBD5006600555CF",
|
||||
"value": "0"
|
||||
},
|
||||
"type_id": 6,
|
||||
"is_native": false,
|
||||
"type": "Amount",
|
||||
"expected_hex": "60000000000000000000002403C84A0A28E0190E208E982C352BBD5006600555CF",
|
||||
"is_negative": false
|
||||
},
|
||||
{
|
||||
"test_json": {
|
||||
"mpt_issuance_id":"00002403C84A0A28E0190E208E982C352BBD5006600555CF",
|
||||
"value": "-0"
|
||||
},
|
||||
"type_id": 6,
|
||||
"is_native": false,
|
||||
"type": "Amount",
|
||||
"expected_hex": "60000000000000000000002403C84A0A28E0190E208E982C352BBD5006600555CF",
|
||||
"is_negative": false
|
||||
},
|
||||
{
|
||||
"test_json": {
|
||||
"mpt_issuance_id":"00002403C84A0A28E0190E208E982C352BBD5006600555CF",
|
||||
"value": "100"
|
||||
},
|
||||
"type_id": 6,
|
||||
"is_native": false,
|
||||
"type": "Amount",
|
||||
"expected_hex": "60000000000000006400002403C84A0A28E0190E208E982C352BBD5006600555CF",
|
||||
"is_negative": false
|
||||
},
|
||||
{
|
||||
"test_json": {
|
||||
"mpt_issuance_id":"00002403C84A0A28E0190E208E982C352BBD5006600555CF",
|
||||
"value": "0xa"
|
||||
},
|
||||
"type_id": 6,
|
||||
"is_native": false,
|
||||
"type": "Amount",
|
||||
"expected_hex": "60000000000000000A00002403C84A0A28E0190E208E982C352BBD5006600555CF",
|
||||
"is_negative": false
|
||||
},
|
||||
{
|
||||
"test_json": {
|
||||
"mpt_issuance_id":"00002403C84A0A28E0190E208E982C352BBD5006600555CF",
|
||||
"value": "0x7FFFFFFFFFFFFFFF"
|
||||
},
|
||||
"type_id": 6,
|
||||
"is_native": false,
|
||||
"type": "Amount",
|
||||
"expected_hex": "607FFFFFFFFFFFFFFF00002403C84A0A28E0190E208E982C352BBD5006600555CF",
|
||||
"is_negative": false
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@@ -1,4 +1,11 @@
|
||||
import { Hash128, Hash160, Hash256, AccountID, Currency } from '../src/types'
|
||||
import {
|
||||
Hash128,
|
||||
Hash160,
|
||||
Hash192,
|
||||
Hash256,
|
||||
AccountID,
|
||||
Currency,
|
||||
} from '../src/types'
|
||||
|
||||
describe('Hash128', function () {
|
||||
it('has a static width member', function () {
|
||||
@@ -51,6 +58,33 @@ describe('Hash160', function () {
|
||||
})
|
||||
})
|
||||
|
||||
describe('Hash192', function () {
|
||||
it('has a static width member', function () {
|
||||
expect(Hash192.width).toBe(24)
|
||||
})
|
||||
it('has a ZERO_192 member', function () {
|
||||
expect(Hash192.ZERO_192.toJSON()).toBe(
|
||||
'000000000000000000000000000000000000000000000000',
|
||||
)
|
||||
})
|
||||
it('can be compared against another', function () {
|
||||
const h1 = Hash192.from('100000000000000000000000000000000000000000000000')
|
||||
const h2 = Hash192.from('200000000000000000000000000000000000000000000000')
|
||||
const h3 = Hash192.from('000000000000000000000000000000000000000000000003')
|
||||
expect(h1.lt(h2)).toBe(true)
|
||||
expect(h3.lt(h2)).toBe(true)
|
||||
})
|
||||
|
||||
it('throws when constructed from invalid hash length', () => {
|
||||
expect(() =>
|
||||
Hash192.from('10000000000000000000000000000000000000000000000'),
|
||||
).toThrow(new Error('Invalid Hash length 23'))
|
||||
expect(() =>
|
||||
Hash192.from('10000000000000000000000000000000000000000000000000'),
|
||||
).toThrow(new Error('Invalid Hash length 25'))
|
||||
})
|
||||
})
|
||||
|
||||
describe('Hash256', function () {
|
||||
it('has a static width member', function () {
|
||||
expect(Hash256.width).toBe(32)
|
||||
|
||||
@@ -73,7 +73,9 @@ describe('Signing data', function () {
|
||||
const customPaymentDefinitions = JSON.parse(
|
||||
JSON.stringify(normalDefinitions),
|
||||
)
|
||||
customPaymentDefinitions.TRANSACTION_TYPES.Payment = 31
|
||||
|
||||
// custom number would need to updated in case it has been used by an existing transaction type
|
||||
customPaymentDefinitions.TRANSACTION_TYPES.Payment = 200
|
||||
|
||||
const newDefs = new XrplDefinitions(customPaymentDefinitions)
|
||||
const actual = encodeForSigning(tx_json, newDefs)
|
||||
@@ -82,7 +84,7 @@ describe('Signing data', function () {
|
||||
'53545800', // signingPrefix
|
||||
// TransactionType
|
||||
'12',
|
||||
'001F',
|
||||
'00C8',
|
||||
// Flags
|
||||
'22',
|
||||
'80000000',
|
||||
@@ -176,7 +178,9 @@ describe('Signing data', function () {
|
||||
const customPaymentDefinitions = JSON.parse(
|
||||
JSON.stringify(normalDefinitions),
|
||||
)
|
||||
customPaymentDefinitions.TRANSACTION_TYPES.Payment = 31
|
||||
|
||||
// custom number would need to updated in case it has been used by an existing transaction type
|
||||
customPaymentDefinitions.TRANSACTION_TYPES.Payment = 200
|
||||
|
||||
const newDefs = new XrplDefinitions(customPaymentDefinitions)
|
||||
const signingAccount = 'rJZdUusLDtY9NEsGea7ijqhVrXv98rYBYN'
|
||||
@@ -187,7 +191,7 @@ describe('Signing data', function () {
|
||||
'534D5400', // signingPrefix
|
||||
// TransactionType
|
||||
'12',
|
||||
'001F',
|
||||
'00C8',
|
||||
// Flags
|
||||
'22',
|
||||
'80000000',
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import { UInt8, UInt64 } from '../src/types'
|
||||
import { encode } from '../src'
|
||||
import { encode, decode } from '../src'
|
||||
|
||||
const binary =
|
||||
'11007222000300003700000000000000003800000000000000006280000000000000000000000000000000000000005553440000000000000000000000000000000000000000000000000166D5438D7EA4C680000000000000000000000000005553440000000000AE123A8556F3CF91154711376AFB0F894F832B3D67D5438D7EA4C680000000000000000000000000005553440000000000F51DFC2A09D62CBBA1DFBDD4691DAC96AD98B90F'
|
||||
@@ -96,6 +96,40 @@ const jsonEntry2 = {
|
||||
index: '0000041EFD027808D3F78C8352F97E324CB816318E00B977C74ECDDC7CD975B2',
|
||||
}
|
||||
|
||||
const mptIssuanceEntryBinary =
|
||||
'11007E220000006224000002DF25000002E434000000000000000030187FFFFFFFFFFFFFFF30190000000000000064552E78C1FFBDDAEE077253CEB12CFEA83689AA0899F94762190A357208DADC76FE701EC1EC7B226E616D65223A2255532054726561737572792042696C6C20546F6B656E222C2273796D626F6C223A225553544254222C22646563696D616C73223A322C22746F74616C537570706C79223A313030303030302C22697373756572223A225553205472656173757279222C22697373756544617465223A22323032342D30332D3235222C226D6174757269747944617465223A22323032352D30332D3235222C226661636556616C7565223A2231303030222C22696E74657265737452617465223A22322E35222C22696E7465726573744672657175656E6379223A22517561727465726C79222C22636F6C6C61746572616C223A22555320476F7665726E6D656E74222C226A7572697364696374696F6E223A22556E6974656420537461746573222C22726567756C61746F7279436F6D706C69616E6365223A2253454320526567756C6174696F6E73222C22736563757269747954797065223A2254726561737572792042696C6C222C2265787465726E616C5F75726C223A2268747470733A2F2F6578616D706C652E636F6D2F742D62696C6C2D746F6B656E2D6D657461646174612E6A736F6E227D8414A4D893CFBC4DC6AE877EB585F90A3B47528B958D051003'
|
||||
|
||||
const mptIssuanceEntryJson = {
|
||||
AssetScale: 3,
|
||||
Flags: 98,
|
||||
Issuer: 'rGpdGXDV2RFPeLEfWS9RFo5Nh9cpVDToZa',
|
||||
LedgerEntryType: 'MPTokenIssuance',
|
||||
MPTokenMetadata:
|
||||
'7B226E616D65223A2255532054726561737572792042696C6C20546F6B656E222C2273796D626F6C223A225553544254222C22646563696D616C73223A322C22746F74616C537570706C79223A313030303030302C22697373756572223A225553205472656173757279222C22697373756544617465223A22323032342D30332D3235222C226D6174757269747944617465223A22323032352D30332D3235222C226661636556616C7565223A2231303030222C22696E74657265737452617465223A22322E35222C22696E7465726573744672657175656E6379223A22517561727465726C79222C22636F6C6C61746572616C223A22555320476F7665726E6D656E74222C226A7572697364696374696F6E223A22556E6974656420537461746573222C22726567756C61746F7279436F6D706C69616E6365223A2253454320526567756C6174696F6E73222C22736563757269747954797065223A2254726561737572792042696C6C222C2265787465726E616C5F75726C223A2268747470733A2F2F6578616D706C652E636F6D2F742D62696C6C2D746F6B656E2D6D657461646174612E6A736F6E227D',
|
||||
MaximumAmount: '9223372036854775807',
|
||||
OutstandingAmount: '100',
|
||||
OwnerNode: '0000000000000000',
|
||||
PreviousTxnID:
|
||||
'2E78C1FFBDDAEE077253CEB12CFEA83689AA0899F94762190A357208DADC76FE',
|
||||
PreviousTxnLgrSeq: 740,
|
||||
Sequence: 735,
|
||||
}
|
||||
|
||||
const mptokenEntryJson = {
|
||||
Account: 'raDQsd1s8rqGjL476g59a9vVNi1rSwrC44',
|
||||
Flags: 0,
|
||||
LedgerEntryType: 'MPToken',
|
||||
MPTAmount: '100',
|
||||
MPTokenIssuanceID: '000002DF71CAE59C9B7E56587FFF74D4EA5830D9BE3CE0CC',
|
||||
OwnerNode: '0000000000000000',
|
||||
PreviousTxnID:
|
||||
'222EF3C7E82D8A44984A66E2B8E357CB536EC2547359CCF70E56E14BC4C284C8',
|
||||
PreviousTxnLgrSeq: 741,
|
||||
}
|
||||
|
||||
const mptokenEntryBinary =
|
||||
'11007F220000000025000002E5340000000000000000301A000000000000006455222EF3C7E82D8A44984A66E2B8E357CB536EC2547359CCF70E56E14BC4C284C881143930DB9A74C26D96CB58ADFFD7E8BB78BCFE62340115000002DF71CAE59C9B7E56587FFF74D4EA5830D9BE3CE0CC'
|
||||
|
||||
it('compareToTests[0]', () => {
|
||||
expect(UInt8.from(124).compareTo(UInt64.from(124))).toBe(0)
|
||||
})
|
||||
@@ -144,3 +178,20 @@ it('valueOf tests', () => {
|
||||
|
||||
expect(val.valueOf() | 0x2).toBe(3)
|
||||
})
|
||||
|
||||
it('UInt64 is parsed as base 10 for MPT amounts', () => {
|
||||
expect(encode(mptIssuanceEntryJson)).toEqual(mptIssuanceEntryBinary)
|
||||
expect(decode(mptIssuanceEntryBinary)).toEqual(mptIssuanceEntryJson)
|
||||
|
||||
expect(encode(mptokenEntryJson)).toEqual(mptokenEntryBinary)
|
||||
expect(decode(mptokenEntryBinary)).toEqual(mptokenEntryJson)
|
||||
|
||||
const decodedIssuance = decode(mptIssuanceEntryBinary)
|
||||
expect(typeof decodedIssuance.MaximumAmount).toBe('string')
|
||||
expect(decodedIssuance.MaximumAmount).toBe('9223372036854775807')
|
||||
expect(decodedIssuance.OutstandingAmount).toBe('100')
|
||||
|
||||
const decodedToken = decode(mptokenEntryBinary)
|
||||
expect(typeof decodedToken.MPTAmount).toBe('string')
|
||||
expect(decodedToken.MPTAmount).toBe('100')
|
||||
})
|
||||
|
||||
@@ -36,6 +36,6 @@
|
||||
"license": "ISC",
|
||||
"prettier": "@xrplf/prettier-config",
|
||||
"engines": {
|
||||
"node": ">= 16"
|
||||
"node": ">= 18"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2,12 +2,42 @@
|
||||
|
||||
Subscribe to [the **xrpl-announce** mailing list](https://groups.google.com/g/xrpl-announce) for release announcements. We recommend that xrpl.js (ripple-lib) users stay up-to-date with the latest stable release.
|
||||
|
||||
## Unreleased
|
||||
## Unreleased Changes
|
||||
|
||||
## 4.1.0 (2024-12-23)
|
||||
|
||||
### Added
|
||||
* Added new MPT transaction definitions (XLS-33)
|
||||
* New `MPTAmount` type support for `Payment` and `Clawback` transactions
|
||||
* `parseTransactionFlags` as a utility function in the xrpl package to streamline transactions flags-to-map conversion
|
||||
* Support for XLS-70d (Credentials)
|
||||
|
||||
### Fixed
|
||||
* `TransactionStream` model supports APIv2
|
||||
* `TransactionStream` model includes `close_time_iso` field
|
||||
* `Ledger` model includes `close_time_iso` field
|
||||
|
||||
## 4.0.0 (2024-07-15)
|
||||
|
||||
### BREAKING CHANGES
|
||||
* Use rippled api_version v2 as default while maintaining support for v1.
|
||||
|
||||
### Added
|
||||
* Add `nfts_by_issuer` clio-only API definition
|
||||
* Add `include_deleted` to ledgerEntry request and `deleted_ledger_index` to ledgerEntry response
|
||||
* Support for the `fixPreviousTxnID` amendment.
|
||||
* Support for the user version of the `feature` RPC.
|
||||
* Add `hash` field to `ledger` command response
|
||||
|
||||
### Removed
|
||||
* Remove references to the Hooks testnet faucet in the xrpl.js code repository.
|
||||
|
||||
## 3.1.0 (2024-06-03)
|
||||
|
||||
### BREAKING CHANGES
|
||||
* Small fix in the API to use a new flag name `tfNoDirectRipple` instead of the existing flag name `tfNoRippleDirect`
|
||||
* Node.js has been upgraded to a minimum version of 18
|
||||
* `fetch` now relies on the native javascript environment in browsers and Node.js
|
||||
|
||||
### Added
|
||||
* Support for the Price Oracles amendment (XLS-47).
|
||||
@@ -22,6 +52,7 @@ Subscribe to [the **xrpl-announce** mailing list](https://groups.google.com/g/xr
|
||||
## 3.0.0 (2024-02-01)
|
||||
|
||||
### BREAKING CHANGES
|
||||
* The default signing algorithm in the `Wallet` was changed from secp256k1 to ed25519
|
||||
* Bump typescript to 5.x
|
||||
* Remove Node 14 support
|
||||
* Remove `crypto` polyfills, `create-hash`, `elliptic`, `hash.js`, and their many dependencies in favor of `@noble/hashes` and `@nobel/curves`
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "xrpl",
|
||||
"version": "3.1.0",
|
||||
"version": "4.1.0",
|
||||
"license": "ISC",
|
||||
"description": "A TypeScript/JavaScript API for interacting with the XRP Ledger in Node.js and the browser",
|
||||
"files": [
|
||||
@@ -27,14 +27,13 @@
|
||||
"@xrplf/isomorphic": "^1.0.1",
|
||||
"@xrplf/secret-numbers": "^1.0.0",
|
||||
"bignumber.js": "^9.0.0",
|
||||
"cross-fetch": "^4.0.0",
|
||||
"eventemitter3": "^5.0.1",
|
||||
"ripple-address-codec": "^5.0.0",
|
||||
"ripple-binary-codec": "^2.1.0",
|
||||
"ripple-binary-codec": "^2.2.0",
|
||||
"ripple-keypairs": "^2.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/node": "^16.18.38",
|
||||
"@types/node": "^18.18.38",
|
||||
"eventemitter3": "^5.0.1",
|
||||
"https-proxy-agent": "^7.0.1",
|
||||
"karma": "^6.4.1",
|
||||
@@ -42,9 +41,9 @@
|
||||
"karma-jasmine": "^5.1.0",
|
||||
"karma-webpack": "^5.0.0",
|
||||
"lodash": "^4.17.4",
|
||||
"react": "^18.2.0",
|
||||
"react": "^19.0.0",
|
||||
"run-s": "^0.0.0",
|
||||
"typedoc": "0.25.0",
|
||||
"typedoc": "0.26.11",
|
||||
"ws": "^8.14.2"
|
||||
},
|
||||
"resolutions": {
|
||||
@@ -87,6 +86,6 @@
|
||||
"xrpl"
|
||||
],
|
||||
"engines": {
|
||||
"node": ">=16.0.0"
|
||||
"node": ">=18.0.0"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,170 +0,0 @@
|
||||
/* eslint-disable max-depth -- needed for attestation checking */
|
||||
/* eslint-disable @typescript-eslint/consistent-type-assertions -- needed here */
|
||||
/* eslint-disable no-await-in-loop -- needed here */
|
||||
import {
|
||||
AccountObjectsRequest,
|
||||
LedgerEntry,
|
||||
Client,
|
||||
XChainAccountCreateCommit,
|
||||
XChainBridge,
|
||||
XChainCommit,
|
||||
XChainCreateClaimID,
|
||||
xrpToDrops,
|
||||
Wallet,
|
||||
getXChainClaimID,
|
||||
} from '../../src'
|
||||
|
||||
async function sleep(sec: number): Promise<void> {
|
||||
return new Promise((resolve) => {
|
||||
setTimeout(resolve, sec * 1000)
|
||||
})
|
||||
}
|
||||
|
||||
const lockingClient = new Client('wss://s.devnet.rippletest.net:51233')
|
||||
const issuingClient = new Client(
|
||||
'wss://sidechain-net2.devnet.rippletest.net:51233',
|
||||
)
|
||||
const MAX_LEDGERS_WAITED = 5
|
||||
const LEDGER_CLOSE_TIME = 4
|
||||
|
||||
void bridgeTransfer()
|
||||
|
||||
async function bridgeTransfer(): Promise<void> {
|
||||
await lockingClient.connect()
|
||||
await issuingClient.connect()
|
||||
const lockingChainDoor = 'rnQAXXWoFNN6PEqwqsdTngCtFPCrmfuqFJ'
|
||||
|
||||
const accountObjectsRequest: AccountObjectsRequest = {
|
||||
command: 'account_objects',
|
||||
account: lockingChainDoor,
|
||||
type: 'bridge',
|
||||
}
|
||||
const lockingAccountObjects = (
|
||||
await lockingClient.request(accountObjectsRequest)
|
||||
).result.account_objects
|
||||
// There will only be one here - a door account can only have one bridge per currency
|
||||
const bridgeData = lockingAccountObjects.filter(
|
||||
(obj) =>
|
||||
obj.LedgerEntryType === 'Bridge' &&
|
||||
obj.XChainBridge.LockingChainIssue.currency === 'XRP',
|
||||
)[0] as LedgerEntry.Bridge
|
||||
const bridge: XChainBridge = bridgeData.XChainBridge
|
||||
console.log(bridge)
|
||||
|
||||
console.log('Creating wallet on the locking chain via the faucet...')
|
||||
const { wallet: wallet1 } = await lockingClient.fundWallet()
|
||||
console.log(wallet1)
|
||||
const wallet2 = Wallet.generate()
|
||||
|
||||
console.log(
|
||||
`Creating ${wallet2.classicAddress} on the issuing chain via the bridge...`,
|
||||
)
|
||||
|
||||
const fundTx: XChainAccountCreateCommit = {
|
||||
TransactionType: 'XChainAccountCreateCommit',
|
||||
Account: wallet1.classicAddress,
|
||||
XChainBridge: bridge,
|
||||
SignatureReward: bridgeData.SignatureReward,
|
||||
Destination: wallet2.classicAddress,
|
||||
Amount: (
|
||||
parseInt(bridgeData.MinAccountCreateAmount as string, 10) * 2
|
||||
).toString(),
|
||||
}
|
||||
const fundResponse = await lockingClient.submitAndWait(fundTx, {
|
||||
wallet: wallet1,
|
||||
})
|
||||
console.log(fundResponse)
|
||||
|
||||
console.log(
|
||||
'Waiting for the attestation to go through... (usually 8-12 seconds)',
|
||||
)
|
||||
let ledgersWaited = 0
|
||||
let initialBalance = 0
|
||||
while (ledgersWaited < MAX_LEDGERS_WAITED) {
|
||||
await sleep(LEDGER_CLOSE_TIME)
|
||||
try {
|
||||
initialBalance = await issuingClient.getXrpBalance(wallet2.classicAddress)
|
||||
console.log(
|
||||
`Wallet ${wallet2.classicAddress} has been funded with a balance of ${initialBalance} XRP`,
|
||||
)
|
||||
break
|
||||
} catch (_error) {
|
||||
ledgersWaited += 1
|
||||
if (ledgersWaited === MAX_LEDGERS_WAITED) {
|
||||
// This error should never be hit if the bridge is running
|
||||
throw Error('Destination account creation via the bridge failed.')
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
console.log(
|
||||
`Transferring funds from ${wallet1.classicAddress} on the locking chain to ` +
|
||||
`${wallet2.classicAddress} on the issuing_chain...`,
|
||||
)
|
||||
|
||||
// Fetch the claim ID for the transfer
|
||||
console.log('Step 1: Fetching the claim ID for the transfer...')
|
||||
const claimIdTx: XChainCreateClaimID = {
|
||||
TransactionType: 'XChainCreateClaimID',
|
||||
Account: wallet2.classicAddress,
|
||||
XChainBridge: bridge,
|
||||
SignatureReward: bridgeData.SignatureReward,
|
||||
OtherChainSource: wallet1.classicAddress,
|
||||
}
|
||||
const claimIdResult = await issuingClient.submitAndWait(claimIdTx, {
|
||||
wallet: wallet2,
|
||||
})
|
||||
console.log(claimIdResult)
|
||||
|
||||
// Extract new claim ID from metadata
|
||||
const xchainClaimId = getXChainClaimID(claimIdResult.result.meta)
|
||||
if (xchainClaimId == null) {
|
||||
// This shouldn't trigger assuming the transaction succeeded
|
||||
throw Error('Could not extract XChainClaimID')
|
||||
}
|
||||
|
||||
console.log(`Claim ID for the transfer: ${xchainClaimId}`)
|
||||
|
||||
console.log(
|
||||
'Step 2: Locking the funds on the locking chain with an XChainCommit transaction...',
|
||||
)
|
||||
const commitTx: XChainCommit = {
|
||||
TransactionType: 'XChainCommit',
|
||||
Account: wallet1.classicAddress,
|
||||
Amount: xrpToDrops(1),
|
||||
XChainBridge: bridge,
|
||||
XChainClaimID: xchainClaimId,
|
||||
OtherChainDestination: wallet2.classicAddress,
|
||||
}
|
||||
const commitResult = await lockingClient.submitAndWait(commitTx, {
|
||||
wallet: wallet1,
|
||||
})
|
||||
console.log(commitResult)
|
||||
|
||||
console.log(
|
||||
'Waiting for the attestation to go through... (usually 8-12 seconds)',
|
||||
)
|
||||
ledgersWaited = 0
|
||||
while (ledgersWaited < MAX_LEDGERS_WAITED) {
|
||||
await sleep(LEDGER_CLOSE_TIME)
|
||||
const currentBalance = await issuingClient.getXrpBalance(
|
||||
wallet2.classicAddress,
|
||||
)
|
||||
console.log(initialBalance, currentBalance)
|
||||
if (currentBalance > initialBalance) {
|
||||
console.log('Transfer is complete')
|
||||
console.log(
|
||||
`New balance of ${wallet2.classicAddress} is ${currentBalance} XRP`,
|
||||
)
|
||||
break
|
||||
}
|
||||
|
||||
ledgersWaited += 1
|
||||
if (ledgersWaited === MAX_LEDGERS_WAITED) {
|
||||
throw Error('Bridge transfer failed.')
|
||||
}
|
||||
}
|
||||
|
||||
await lockingClient.disconnect()
|
||||
await issuingClient.disconnect()
|
||||
}
|
||||
@@ -56,7 +56,7 @@ async function claimPayChannel(): Promise<void> {
|
||||
Channel: hashes.hashPaymentChannel(
|
||||
wallet1.classicAddress,
|
||||
wallet2.classicAddress,
|
||||
paymentChannelResponse.result.Sequence ?? 0,
|
||||
paymentChannelResponse.result.tx_json.Sequence ?? 0,
|
||||
),
|
||||
Amount: '100',
|
||||
}
|
||||
|
||||
@@ -1,5 +1,11 @@
|
||||
import { Client, Payment } from '../../src'
|
||||
|
||||
// Prerequisites for this snippet. Please verify these conditions after a reset of the
|
||||
// test network:
|
||||
// - destination_account must have a trust line with the destination_amount.issuer
|
||||
// - There must be appropriate DEX Offers or XRP/TST AMM for the cross-currency exchange
|
||||
|
||||
// PathFind RPC requires the use of a Websocket client only
|
||||
const client = new Client('wss://s.altnet.rippletest.net:51233')
|
||||
|
||||
async function createTxWithPaths(): Promise<void> {
|
||||
@@ -8,22 +14,17 @@ async function createTxWithPaths(): Promise<void> {
|
||||
const { wallet } = await client.fundWallet(null, {
|
||||
usageContext: 'code snippets',
|
||||
})
|
||||
const destination_account = 'rKT4JX4cCof6LcDYRz8o3rGRu7qxzZ2Zwj'
|
||||
const destination_account = 'rJPeZVPty1bXXbDR9oKscg2irqABr7sP3t'
|
||||
const destination_amount = {
|
||||
value: '0.001',
|
||||
currency: 'USD',
|
||||
issuer: 'rVnYNK9yuxBz4uP8zC8LEFokM2nqH3poc',
|
||||
currency: 'TST',
|
||||
issuer: 'rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd',
|
||||
}
|
||||
|
||||
const resp = await client.request({
|
||||
// TOOD: Replace with path_find - https://github.com/XRPLF/xrpl.js/issues/2385
|
||||
command: 'ripple_path_find',
|
||||
command: 'path_find',
|
||||
subcommand: 'create',
|
||||
source_account: wallet.classicAddress,
|
||||
source_currencies: [
|
||||
{
|
||||
currency: 'XRP',
|
||||
},
|
||||
],
|
||||
destination_account,
|
||||
destination_amount,
|
||||
})
|
||||
|
||||
@@ -63,7 +63,7 @@ async function sendEscrow(): Promise<void> {
|
||||
TransactionType: 'EscrowFinish',
|
||||
Account: wallet1.classicAddress,
|
||||
Owner: wallet1.classicAddress,
|
||||
OfferSequence: Number(createEscrowResponse.result.Sequence),
|
||||
OfferSequence: Number(createEscrowResponse.result.tx_json.Sequence),
|
||||
}
|
||||
|
||||
await client.submit(finishTx, {
|
||||
|
||||
@@ -14,13 +14,11 @@ export interface FaucetWallet {
|
||||
export enum FaucetNetwork {
|
||||
Testnet = 'faucet.altnet.rippletest.net',
|
||||
Devnet = 'faucet.devnet.rippletest.net',
|
||||
HooksV3Testnet = 'hooks-testnet-v3.xrpl-labs.com',
|
||||
}
|
||||
|
||||
export const FaucetNetworkPaths: Record<string, string> = {
|
||||
[FaucetNetwork.Testnet]: '/accounts',
|
||||
[FaucetNetwork.Devnet]: '/accounts',
|
||||
[FaucetNetwork.HooksV3Testnet]: '/accounts',
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -33,10 +31,6 @@ export const FaucetNetworkPaths: Record<string, string> = {
|
||||
export function getFaucetHost(client: Client): FaucetNetwork | undefined {
|
||||
const connectionUrl = client.url
|
||||
|
||||
if (connectionUrl.includes('hooks-testnet-v3')) {
|
||||
return FaucetNetwork.HooksV3Testnet
|
||||
}
|
||||
|
||||
// 'altnet' for Ripple Testnet server and 'testnet' for XRPL Labs Testnet server
|
||||
if (connectionUrl.includes('altnet') || connectionUrl.includes('testnet')) {
|
||||
return FaucetNetwork.Testnet
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
import fetch from 'cross-fetch'
|
||||
import { isValidClassicAddress } from 'ripple-address-codec'
|
||||
|
||||
import type { Client } from '../client'
|
||||
|
||||
@@ -4,6 +4,7 @@ import {
|
||||
TimeoutError,
|
||||
XrplError,
|
||||
} from '../errors'
|
||||
import type { APIVersion } from '../models'
|
||||
import { Response, RequestResponseMap } from '../models/methods'
|
||||
import { BaseRequest, ErrorResponse } from '../models/methods/baseMethod'
|
||||
|
||||
@@ -35,10 +36,10 @@ export default class RequestManager {
|
||||
* @param timer - The timer associated with the promise.
|
||||
* @returns A promise that resolves to the specified generic type.
|
||||
*/
|
||||
public async addPromise<R extends BaseRequest, T = RequestResponseMap<R>>(
|
||||
newId: string | number,
|
||||
timer: ReturnType<typeof setTimeout>,
|
||||
): Promise<T> {
|
||||
public async addPromise<
|
||||
R extends BaseRequest,
|
||||
T = RequestResponseMap<R, APIVersion>,
|
||||
>(newId: string | number, timer: ReturnType<typeof setTimeout>): Promise<T> {
|
||||
return new Promise<T>((resolve, reject) => {
|
||||
this.promisesAwaitingResponse.set(newId, {
|
||||
resolve,
|
||||
@@ -55,7 +56,10 @@ export default class RequestManager {
|
||||
* @param response - Response to return.
|
||||
* @throws Error if no existing promise with the given ID.
|
||||
*/
|
||||
public resolve(id: string | number, response: Response): void {
|
||||
public resolve(
|
||||
id: string | number,
|
||||
response: Partial<Response<APIVersion>>,
|
||||
): void {
|
||||
const promise = this.promisesAwaitingResponse.get(id)
|
||||
if (promise == null) {
|
||||
throw new XrplError(`No existing promise with id ${id}`, {
|
||||
@@ -111,10 +115,10 @@ export default class RequestManager {
|
||||
* @returns Request ID, new request form, and the promise for resolving the request.
|
||||
* @throws XrplError if request with the same ID is already pending.
|
||||
*/
|
||||
public createRequest<R extends BaseRequest, T = RequestResponseMap<R>>(
|
||||
request: R,
|
||||
timeout: number,
|
||||
): [string | number, string, Promise<T>] {
|
||||
public createRequest<
|
||||
R extends BaseRequest,
|
||||
T = RequestResponseMap<R, APIVersion>,
|
||||
>(request: R, timeout: number): [string | number, string, Promise<T>] {
|
||||
let newId: string | number
|
||||
if (request.id == null) {
|
||||
newId = this.nextId
|
||||
@@ -171,7 +175,9 @@ export default class RequestManager {
|
||||
* @param response - The response to handle.
|
||||
* @throws ResponseFormatError if the response format is invalid, RippledError if rippled returns an error.
|
||||
*/
|
||||
public handleResponse(response: Partial<Response | ErrorResponse>): void {
|
||||
public handleResponse(
|
||||
response: Partial<Response<APIVersion> | ErrorResponse>,
|
||||
): void {
|
||||
if (
|
||||
response.id == null ||
|
||||
!(typeof response.id === 'string' || typeof response.id === 'number')
|
||||
@@ -205,8 +211,7 @@ export default class RequestManager {
|
||||
}
|
||||
// status no longer needed because error is thrown if status is not "success"
|
||||
delete response.status
|
||||
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- Must be a valid Response here
|
||||
this.resolve(response.id, response as unknown as Response)
|
||||
this.resolve(response.id, response)
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -11,7 +11,7 @@ import {
|
||||
ConnectionError,
|
||||
XrplError,
|
||||
} from '../errors'
|
||||
import type { RequestResponseMap } from '../models'
|
||||
import type { APIVersion, RequestResponseMap } from '../models'
|
||||
import { BaseRequest } from '../models/methods/baseMethod'
|
||||
|
||||
import ConnectionManager from './ConnectionManager'
|
||||
@@ -267,6 +267,7 @@ export class Connection extends EventEmitter {
|
||||
|
||||
/**
|
||||
* Disconnect the websocket, then connect again.
|
||||
*
|
||||
*/
|
||||
public async reconnect(): Promise<void> {
|
||||
/*
|
||||
@@ -287,10 +288,10 @@ export class Connection extends EventEmitter {
|
||||
* @returns The response from the rippled server.
|
||||
* @throws NotConnectedError if the Connection isn't connected to a server.
|
||||
*/
|
||||
public async request<R extends BaseRequest, T = RequestResponseMap<R>>(
|
||||
request: R,
|
||||
timeout?: number,
|
||||
): Promise<T> {
|
||||
public async request<
|
||||
R extends BaseRequest,
|
||||
T = RequestResponseMap<R, APIVersion>,
|
||||
>(request: R, timeout?: number): Promise<T> {
|
||||
if (!this.shouldBeConnected || this.ws == null) {
|
||||
throw new NotConnectedError(JSON.stringify(request), request)
|
||||
}
|
||||
@@ -468,6 +469,7 @@ export class Connection extends EventEmitter {
|
||||
|
||||
/**
|
||||
* Starts a heartbeat to check the connection with the server.
|
||||
*
|
||||
*/
|
||||
private startHeartbeatInterval(): void {
|
||||
this.clearHeartbeatInterval()
|
||||
|
||||
@@ -9,7 +9,12 @@ import {
|
||||
ValidationError,
|
||||
XrplError,
|
||||
} from '../errors'
|
||||
import type { LedgerIndex, Balance } from '../models/common'
|
||||
import {
|
||||
APIVersion,
|
||||
LedgerIndex,
|
||||
Balance,
|
||||
DEFAULT_API_VERSION,
|
||||
} from '../models/common'
|
||||
import {
|
||||
Request,
|
||||
// account methods
|
||||
@@ -213,6 +218,12 @@ class Client extends EventEmitter<EventTypes> {
|
||||
*/
|
||||
public buildVersion: string | undefined
|
||||
|
||||
/**
|
||||
* API Version used by the server this client is connected to
|
||||
*
|
||||
*/
|
||||
public apiVersion: APIVersion = DEFAULT_API_VERSION
|
||||
|
||||
/**
|
||||
* Creates a new Client with a websocket connection to a rippled server.
|
||||
*
|
||||
@@ -226,7 +237,7 @@ class Client extends EventEmitter<EventTypes> {
|
||||
* const client = new Client('wss://s.altnet.rippletest.net:51233')
|
||||
* ```
|
||||
*/
|
||||
// eslint-disable-next-line max-lines-per-function -- okay because we have to set up all the connection handlers
|
||||
/* eslint-disable max-lines-per-function -- the constructor requires more lines to implement the logic */
|
||||
public constructor(server: string, options: ClientOptions = {}) {
|
||||
super()
|
||||
if (typeof server !== 'string' || !/wss?(?:\+unix)?:\/\//u.exec(server)) {
|
||||
@@ -290,6 +301,7 @@ class Client extends EventEmitter<EventTypes> {
|
||||
this.emit('path_find', path)
|
||||
})
|
||||
}
|
||||
/* eslint-enable max-lines-per-function */
|
||||
|
||||
/**
|
||||
* Get the url that the client is connected to.
|
||||
@@ -306,7 +318,6 @@ class Client extends EventEmitter<EventTypes> {
|
||||
* additional request body parameters.
|
||||
*
|
||||
* @category Network
|
||||
*
|
||||
* @param req - Request to send to the server.
|
||||
* @returns The response from the server.
|
||||
*
|
||||
@@ -319,16 +330,20 @@ class Client extends EventEmitter<EventTypes> {
|
||||
* console.log(response)
|
||||
* ```
|
||||
*/
|
||||
public async request<R extends Request, T = RequestResponseMap<R>>(
|
||||
req: R,
|
||||
): Promise<T> {
|
||||
const response = await this.connection.request<R, T>({
|
||||
public async request<
|
||||
R extends Request,
|
||||
V extends APIVersion = typeof DEFAULT_API_VERSION,
|
||||
T = RequestResponseMap<R, V>,
|
||||
>(req: R): Promise<T> {
|
||||
const request = {
|
||||
...req,
|
||||
account: req.account
|
||||
? // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- Must be string
|
||||
ensureClassicAddress(req.account as string)
|
||||
: undefined,
|
||||
})
|
||||
account:
|
||||
typeof req.account === 'string'
|
||||
? ensureClassicAddress(req.account)
|
||||
: undefined,
|
||||
api_version: req.api_version ?? this.apiVersion,
|
||||
}
|
||||
const response = await this.connection.request<R, T>(request)
|
||||
|
||||
// mutates `response` to add warnings
|
||||
handlePartialPayment(req.command, response)
|
||||
@@ -437,9 +452,10 @@ class Client extends EventEmitter<EventTypes> {
|
||||
* const allResponses = await client.requestAll({ command: 'transaction_data' });
|
||||
* console.log(allResponses);
|
||||
*/
|
||||
|
||||
public async requestAll<
|
||||
T extends MarkerRequest,
|
||||
U = RequestAllResponseMap<T>,
|
||||
U = RequestAllResponseMap<T, APIVersion>,
|
||||
>(request: T, collect?: string): Promise<U[]> {
|
||||
/*
|
||||
* The data under collection is keyed based on the command. Fail if command
|
||||
@@ -467,7 +483,7 @@ class Client extends EventEmitter<EventTypes> {
|
||||
// eslint-disable-next-line no-await-in-loop -- Necessary for this, it really has to wait
|
||||
const singleResponse = await this.connection.request(repeatProps)
|
||||
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- Should be true
|
||||
const singleResult = (singleResponse as MarkerResponse).result
|
||||
const singleResult = (singleResponse as MarkerResponse<APIVersion>).result
|
||||
if (!(collectKey in singleResult)) {
|
||||
throw new XrplError(`${collectKey} not in result`)
|
||||
}
|
||||
@@ -638,7 +654,10 @@ class Client extends EventEmitter<EventTypes> {
|
||||
* @param signersCount - The expected number of signers for this transaction.
|
||||
* Only used for multisigned transactions.
|
||||
* @returns The autofilled transaction.
|
||||
* @throws ValidationError If Amount and DeliverMax fields are not identical in a Payment Transaction
|
||||
*/
|
||||
|
||||
// eslint-disable-next-line complexity -- handling Payment transaction API v2 requires more logic
|
||||
public async autofill<T extends SubmittableTransaction>(
|
||||
transaction: T,
|
||||
signersCount?: number,
|
||||
@@ -646,7 +665,6 @@ class Client extends EventEmitter<EventTypes> {
|
||||
const tx = { ...transaction }
|
||||
|
||||
setValidAddresses(tx)
|
||||
|
||||
setTransactionFlagsToNumber(tx)
|
||||
|
||||
const promises: Array<Promise<void>> = []
|
||||
@@ -666,6 +684,34 @@ class Client extends EventEmitter<EventTypes> {
|
||||
promises.push(checkAccountDeleteBlockers(this, tx))
|
||||
}
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/ban-ts-comment -- ignore type-assertions on the DeliverMax property
|
||||
// @ts-expect-error -- DeliverMax property exists only at the RPC level, not at the protocol level
|
||||
if (tx.TransactionType === 'Payment' && tx.DeliverMax != null) {
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- This is a valid null check for Amount
|
||||
if (tx.Amount == null) {
|
||||
// If only DeliverMax is provided, use it to populate the Amount field
|
||||
// eslint-disable-next-line @typescript-eslint/ban-ts-comment -- ignore type-assertions on the DeliverMax property
|
||||
// @ts-expect-error -- DeliverMax property exists only at the RPC level, not at the protocol level
|
||||
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment -- DeliverMax is a known RPC-level property
|
||||
tx.Amount = tx.DeliverMax
|
||||
}
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/ban-ts-comment -- ignore type-assertions on the DeliverMax property
|
||||
// @ts-expect-error -- DeliverMax property exists only at the RPC level, not at the protocol level
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- This is a valid null check for Amount
|
||||
if (tx.Amount != null && tx.Amount !== tx.DeliverMax) {
|
||||
return Promise.reject(
|
||||
new ValidationError(
|
||||
'PaymentTransaction: Amount and DeliverMax fields must be identical when both are provided',
|
||||
),
|
||||
)
|
||||
}
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/ban-ts-comment -- ignore type-assertions on the DeliverMax property
|
||||
// @ts-expect-error -- DeliverMax property exists only at the RPC level, not at the protocol level
|
||||
delete tx.DeliverMax
|
||||
}
|
||||
|
||||
return Promise.all(promises).then(() => tx)
|
||||
}
|
||||
|
||||
@@ -909,7 +955,7 @@ class Client extends EventEmitter<EventTypes> {
|
||||
* @param options.limit - Limit number of balances to return.
|
||||
* @returns An array of XRP/non-XRP balances for the given account.
|
||||
*/
|
||||
// eslint-disable-next-line max-lines-per-function -- Longer definition is required for end users to see the definition.
|
||||
/* eslint-disable max-lines-per-function -- getBalances requires more lines to implement logic */
|
||||
public async getBalances(
|
||||
address: string,
|
||||
options: {
|
||||
@@ -957,6 +1003,7 @@ class Client extends EventEmitter<EventTypes> {
|
||||
)
|
||||
return balances.slice(0, options.limit)
|
||||
}
|
||||
/* eslint-enable max-lines-per-function */
|
||||
|
||||
/**
|
||||
* Fetch orderbook (buy/sell orders) between two currency pairs. This checks both sides of the orderbook
|
||||
|
||||
@@ -2,21 +2,37 @@ import BigNumber from 'bignumber.js'
|
||||
import { decode } from 'ripple-binary-codec'
|
||||
|
||||
import type {
|
||||
AccountTxResponse,
|
||||
TransactionEntryResponse,
|
||||
TransactionStream,
|
||||
TransactionV1Stream,
|
||||
TxResponse,
|
||||
} from '..'
|
||||
import type { Amount } from '../models/common'
|
||||
import type { RequestResponseMap } from '../models/methods'
|
||||
import type {
|
||||
Amount,
|
||||
IssuedCurrency,
|
||||
APIVersion,
|
||||
DEFAULT_API_VERSION,
|
||||
MPTAmount,
|
||||
} from '../models/common'
|
||||
import type {
|
||||
AccountTxTransaction,
|
||||
RequestResponseMap,
|
||||
} from '../models/methods'
|
||||
import { AccountTxVersionResponseMap } from '../models/methods/accountTx'
|
||||
import { BaseRequest, BaseResponse } from '../models/methods/baseMethod'
|
||||
import { PaymentFlags, Transaction } from '../models/transactions'
|
||||
import { PaymentFlags, Transaction, isMPTAmount } from '../models/transactions'
|
||||
import type { TransactionMetadata } from '../models/transactions/metadata'
|
||||
import { isFlagEnabled } from '../models/utils'
|
||||
|
||||
const WARN_PARTIAL_PAYMENT_CODE = 2001
|
||||
|
||||
function amountsEqual(amt1: Amount, amt2: Amount): boolean {
|
||||
/* eslint-disable complexity -- check different token types */
|
||||
/* eslint-disable @typescript-eslint/consistent-type-assertions -- known currency type */
|
||||
function amountsEqual(
|
||||
amt1: Amount | MPTAmount,
|
||||
amt2: Amount | MPTAmount,
|
||||
): boolean {
|
||||
// Compare XRP
|
||||
if (typeof amt1 === 'string' && typeof amt2 === 'string') {
|
||||
return amt1 === amt2
|
||||
}
|
||||
@@ -25,15 +41,32 @@ function amountsEqual(amt1: Amount, amt2: Amount): boolean {
|
||||
return false
|
||||
}
|
||||
|
||||
// Compare MPTs
|
||||
if (isMPTAmount(amt1) && isMPTAmount(amt2)) {
|
||||
const aValue = new BigNumber(amt1.value)
|
||||
const bValue = new BigNumber(amt2.value)
|
||||
|
||||
return (
|
||||
amt1.mpt_issuance_id === amt2.mpt_issuance_id && aValue.isEqualTo(bValue)
|
||||
)
|
||||
}
|
||||
|
||||
if (isMPTAmount(amt1) || isMPTAmount(amt2)) {
|
||||
return false
|
||||
}
|
||||
|
||||
// Compare issued currency (IOU)
|
||||
const aValue = new BigNumber(amt1.value)
|
||||
const bValue = new BigNumber(amt2.value)
|
||||
|
||||
return (
|
||||
amt1.currency === amt2.currency &&
|
||||
amt1.issuer === amt2.issuer &&
|
||||
(amt1 as IssuedCurrency).currency === (amt2 as IssuedCurrency).currency &&
|
||||
(amt1 as IssuedCurrency).issuer === (amt2 as IssuedCurrency).issuer &&
|
||||
aValue.isEqualTo(bValue)
|
||||
)
|
||||
}
|
||||
/* eslint-enable complexity */
|
||||
/* eslint-enable @typescript-eslint/consistent-type-assertions */
|
||||
|
||||
function isPartialPayment(
|
||||
tx?: Transaction,
|
||||
@@ -63,7 +96,10 @@ function isPartialPayment(
|
||||
}
|
||||
|
||||
const delivered = meta.delivered_amount
|
||||
const amount = tx.Amount
|
||||
// eslint-disable-next-line @typescript-eslint/ban-ts-comment -- DeliverMax is a valid field on Payment response
|
||||
// @ts-expect-error -- DeliverMax is a valid field on Payment response
|
||||
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment -- DeliverMax is a valid field on Payment response
|
||||
const amount = tx.DeliverMax
|
||||
|
||||
if (delivered === undefined) {
|
||||
return false
|
||||
@@ -73,23 +109,36 @@ function isPartialPayment(
|
||||
}
|
||||
|
||||
function txHasPartialPayment(response: TxResponse): boolean {
|
||||
return isPartialPayment(response.result, response.result.meta)
|
||||
return isPartialPayment(response.result.tx_json, response.result.meta)
|
||||
}
|
||||
|
||||
function txEntryHasPartialPayment(response: TransactionEntryResponse): boolean {
|
||||
return isPartialPayment(response.result.tx_json, response.result.metadata)
|
||||
}
|
||||
|
||||
function accountTxHasPartialPayment(response: AccountTxResponse): boolean {
|
||||
function accountTxHasPartialPayment<
|
||||
Version extends APIVersion = typeof DEFAULT_API_VERSION,
|
||||
>(response: AccountTxVersionResponseMap<Version>): boolean {
|
||||
const { transactions } = response.result
|
||||
const foo = transactions.some((tx) => isPartialPayment(tx.tx, tx.meta))
|
||||
const foo = transactions.some((tx) => {
|
||||
// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access -- required to check API version model
|
||||
if (tx.tx_json != null) {
|
||||
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- use API v2 model
|
||||
const transaction = tx as AccountTxTransaction
|
||||
return isPartialPayment(transaction.tx_json, transaction.meta)
|
||||
}
|
||||
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- use API v1 model
|
||||
const transaction = tx as AccountTxTransaction<1>
|
||||
return isPartialPayment(transaction.tx, transaction.meta)
|
||||
})
|
||||
return foo
|
||||
}
|
||||
|
||||
function hasPartialPayment<R extends BaseRequest, T = RequestResponseMap<R>>(
|
||||
command: string,
|
||||
response: T,
|
||||
): boolean {
|
||||
function hasPartialPayment<
|
||||
R extends BaseRequest,
|
||||
V extends APIVersion = typeof DEFAULT_API_VERSION,
|
||||
T = RequestResponseMap<R, V>,
|
||||
>(command: string, response: T): boolean {
|
||||
/* eslint-disable @typescript-eslint/consistent-type-assertions -- Request type is known at runtime from command */
|
||||
switch (command) {
|
||||
case 'tx':
|
||||
@@ -97,7 +146,9 @@ function hasPartialPayment<R extends BaseRequest, T = RequestResponseMap<R>>(
|
||||
case 'transaction_entry':
|
||||
return txEntryHasPartialPayment(response as TransactionEntryResponse)
|
||||
case 'account_tx':
|
||||
return accountTxHasPartialPayment(response as AccountTxResponse)
|
||||
return accountTxHasPartialPayment(
|
||||
response as AccountTxVersionResponseMap<V>,
|
||||
)
|
||||
default:
|
||||
return false
|
||||
}
|
||||
@@ -112,7 +163,7 @@ function hasPartialPayment<R extends BaseRequest, T = RequestResponseMap<R>>(
|
||||
*/
|
||||
export function handlePartialPayment<
|
||||
R extends BaseRequest,
|
||||
T = RequestResponseMap<R>,
|
||||
T = RequestResponseMap<R, APIVersion>,
|
||||
>(command: string, response: T): void {
|
||||
if (hasPartialPayment(command, response)) {
|
||||
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- We are checking dynamically and safely.
|
||||
@@ -138,10 +189,10 @@ export function handlePartialPayment<
|
||||
* @param log - The method used for logging by the connection (to report the partial payment).
|
||||
*/
|
||||
export function handleStreamPartialPayment(
|
||||
stream: TransactionStream,
|
||||
stream: TransactionStream | TransactionV1Stream,
|
||||
log: (id: string, message: string) => void,
|
||||
): void {
|
||||
if (isPartialPayment(stream.transaction, stream.meta)) {
|
||||
if (isPartialPayment(stream.tx_json ?? stream.transaction, stream.meta)) {
|
||||
const warnings = stream.warnings ?? []
|
||||
|
||||
const warning = {
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
export const RIPPLED_API_V1 = 1
|
||||
export const RIPPLED_API_V2 = 2
|
||||
export const DEFAULT_API_VERSION = RIPPLED_API_V2
|
||||
export type APIVersion = typeof RIPPLED_API_V1 | typeof RIPPLED_API_V2
|
||||
export type LedgerIndex = number | ('validated' | 'closed' | 'current')
|
||||
|
||||
export interface XRP {
|
||||
@@ -16,6 +20,11 @@ export interface IssuedCurrencyAmount extends IssuedCurrency {
|
||||
value: string
|
||||
}
|
||||
|
||||
export interface MPTAmount {
|
||||
mpt_issuance_id: string
|
||||
value: string
|
||||
}
|
||||
|
||||
export type Amount = IssuedCurrencyAmount | string
|
||||
|
||||
export interface Balance {
|
||||
@@ -104,6 +113,10 @@ export interface ResponseOnlyTxInfo {
|
||||
* The sequence number of the ledger that included this transaction.
|
||||
*/
|
||||
ledger_index?: number
|
||||
/**
|
||||
* The hash of the ledger included this transaction.
|
||||
*/
|
||||
ledger_hash?: string
|
||||
/**
|
||||
* @deprecated Alias for ledger_index.
|
||||
*/
|
||||
@@ -149,6 +162,16 @@ export interface AuthAccount {
|
||||
}
|
||||
}
|
||||
|
||||
export interface AuthorizeCredential {
|
||||
Credential: {
|
||||
/** The issuer of the credential. */
|
||||
Issuer: string
|
||||
|
||||
/** A hex-encoded value to identify the type of credential from the issuer. */
|
||||
CredentialType: string
|
||||
}
|
||||
}
|
||||
|
||||
export interface XChainBridge {
|
||||
LockingChainDoor: string
|
||||
LockingChainIssue: Currency
|
||||
|
||||
@@ -10,6 +10,7 @@ export * as LedgerEntry from './ledger'
|
||||
export {
|
||||
setTransactionFlagsToNumber,
|
||||
parseAccountRootFlags,
|
||||
parseTransactionFlags,
|
||||
} from './utils/flags'
|
||||
export * from './methods'
|
||||
export * from './transactions'
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import { AuthAccount, Currency, IssuedCurrencyAmount } from '../common'
|
||||
|
||||
import { BaseLedgerEntry, MissingPreviousTxnID } from './BaseLedgerEntry'
|
||||
import { BaseLedgerEntry, HasOptionalPreviousTxnID } from './BaseLedgerEntry'
|
||||
|
||||
export interface VoteSlot {
|
||||
VoteEntry: {
|
||||
@@ -15,7 +15,7 @@ export interface VoteSlot {
|
||||
*
|
||||
* @category Ledger Entries
|
||||
*/
|
||||
export default interface AMM extends BaseLedgerEntry, MissingPreviousTxnID {
|
||||
export default interface AMM extends BaseLedgerEntry, HasOptionalPreviousTxnID {
|
||||
LedgerEntryType: 'AMM'
|
||||
/**
|
||||
* The address of the special account that holds this AMM's assets.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { BaseLedgerEntry, MissingPreviousTxnID } from './BaseLedgerEntry'
|
||||
import { BaseLedgerEntry, HasOptionalPreviousTxnID } from './BaseLedgerEntry'
|
||||
|
||||
/**
|
||||
* The unique id for the Amendments object https://xrpl.org/amendments-object.html#amendments-id-format
|
||||
@@ -26,7 +26,7 @@ export interface Majority {
|
||||
*/
|
||||
export default interface Amendments
|
||||
extends BaseLedgerEntry,
|
||||
MissingPreviousTxnID {
|
||||
HasOptionalPreviousTxnID {
|
||||
LedgerEntryType: 'Amendments'
|
||||
/**
|
||||
* Array of 256-bit amendment IDs for all currently-enabled amendments. If
|
||||
|
||||
@@ -15,13 +15,17 @@ export interface HasPreviousTxnID {
|
||||
PreviousTxnLgrSeq: number
|
||||
}
|
||||
|
||||
export interface MissingPreviousTxnID {
|
||||
export interface HasOptionalPreviousTxnID {
|
||||
/**
|
||||
* This field is missing on this object but is present on most other returned objects.
|
||||
* The identifying hash of the transaction that most recently modified this
|
||||
* object. This field was added in the `fixPreviousTxnID` amendment, so it
|
||||
* may not be present in every object.
|
||||
*/
|
||||
PreviousTxnID: never
|
||||
PreviousTxnID?: string
|
||||
/**
|
||||
* This field is missing on this object but is present on most other returned objects.
|
||||
* The index of the ledger that contains the transaction that most recently
|
||||
* modified this object. This field was added in the `fixPreviousTxnID`
|
||||
* amendment, so it may not be present in every object.
|
||||
*/
|
||||
PreviousTxnLgrSeq: never
|
||||
PreviousTxnLgrSeq?: number
|
||||
}
|
||||
|
||||
47
packages/xrpl/src/models/ledger/Credential.ts
Normal file
47
packages/xrpl/src/models/ledger/Credential.ts
Normal file
@@ -0,0 +1,47 @@
|
||||
import { GlobalFlags } from '../transactions/common'
|
||||
|
||||
import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
|
||||
|
||||
export interface CredentialFlags extends GlobalFlags {
|
||||
lsfAccepted?: boolean
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* A Credential object describes a credential, similar to a passport, which is an issuable identity verifier
|
||||
* that can be used as a prerequisite for other transactions
|
||||
*
|
||||
* @category Ledger Entries
|
||||
*/
|
||||
export default interface Credential extends BaseLedgerEntry, HasPreviousTxnID {
|
||||
LedgerEntryType: 'Credential'
|
||||
/**
|
||||
* A bit-map of boolean flags
|
||||
*/
|
||||
Flags: number | CredentialFlags
|
||||
|
||||
/** The account that the credential is for. */
|
||||
Subject: string
|
||||
|
||||
/** The issuer of the credential. */
|
||||
Issuer: string
|
||||
|
||||
/** A hex-encoded value to identify the type of credential from the issuer. */
|
||||
CredentialType: string
|
||||
|
||||
/** A hint indicating which page of the subject's owner directory links to this object,
|
||||
* in case the directory consists of multiple pages.
|
||||
*/
|
||||
SubjectNode: string
|
||||
|
||||
/** A hint indicating which page of the issuer's owner directory links to this object,
|
||||
* in case the directory consists of multiple pages.
|
||||
*/
|
||||
IssuerNode: string
|
||||
|
||||
/** Credential expiration. */
|
||||
Expiration?: number
|
||||
|
||||
/** Additional data about the credential (such as a link to the VC document). */
|
||||
URI?: string
|
||||
}
|
||||
@@ -1,3 +1,5 @@
|
||||
import { AuthorizeCredential } from '../common'
|
||||
|
||||
import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
|
||||
|
||||
/**
|
||||
@@ -12,8 +14,6 @@ export default interface DepositPreauth
|
||||
LedgerEntryType: 'DepositPreauth'
|
||||
/** The account that granted the preauthorization. */
|
||||
Account: string
|
||||
/** The account that received the preauthorization. */
|
||||
Authorize: string
|
||||
/**
|
||||
* A bit-map of boolean flags. No flags are defined for DepositPreauth
|
||||
* objects, so this value is always 0.
|
||||
@@ -24,4 +24,8 @@ export default interface DepositPreauth
|
||||
* object, in case the directory consists of multiple pages.
|
||||
*/
|
||||
OwnerNode: string
|
||||
/** The account that received the preauthorization. */
|
||||
Authorize?: string
|
||||
/** The credential(s) that received the preauthorization. */
|
||||
AuthorizeCredentials?: AuthorizeCredential[]
|
||||
}
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { BaseLedgerEntry, MissingPreviousTxnID } from './BaseLedgerEntry'
|
||||
import { BaseLedgerEntry, HasOptionalPreviousTxnID } from './BaseLedgerEntry'
|
||||
|
||||
/**
|
||||
* The DirectoryNode object type provides a list of links to other objects in
|
||||
@@ -8,7 +8,7 @@ import { BaseLedgerEntry, MissingPreviousTxnID } from './BaseLedgerEntry'
|
||||
*/
|
||||
export default interface DirectoryNode
|
||||
extends BaseLedgerEntry,
|
||||
MissingPreviousTxnID {
|
||||
HasOptionalPreviousTxnID {
|
||||
LedgerEntryType: 'DirectoryNode'
|
||||
/**
|
||||
* A bit-map of boolean flags enabled for this directory. Currently, the
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { BaseLedgerEntry, MissingPreviousTxnID } from './BaseLedgerEntry'
|
||||
import { BaseLedgerEntry, HasOptionalPreviousTxnID } from './BaseLedgerEntry'
|
||||
|
||||
/**
|
||||
* The unique id for the FeeSettings object https://xrpl.org/feesettings.html#feesettings-id-format
|
||||
@@ -26,7 +26,9 @@ export interface FeeSettingsPostAmendmentFields {
|
||||
ReserveIncrementDrops: string
|
||||
}
|
||||
|
||||
export interface FeeSettingsBase extends BaseLedgerEntry, MissingPreviousTxnID {
|
||||
export interface FeeSettingsBase
|
||||
extends BaseLedgerEntry,
|
||||
HasOptionalPreviousTxnID {
|
||||
LedgerEntryType: 'FeeSettings'
|
||||
/**
|
||||
* A bit-map of boolean flags for this object. No flags are defined for this type.
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
import { APIVersion, DEFAULT_API_VERSION, RIPPLED_API_V1 } from '../common'
|
||||
import { Transaction, TransactionMetadata } from '../transactions'
|
||||
|
||||
import { LedgerEntry } from './LedgerEntry'
|
||||
|
||||
/**
|
||||
* A ledger is a block of transactions and shared state data. It has a unique
|
||||
* header that describes its contents using cryptographic hashes.
|
||||
* Common properties for ledger entries.
|
||||
*
|
||||
* @category Ledger Entries
|
||||
*/
|
||||
export default interface Ledger {
|
||||
interface BaseLedger {
|
||||
/** The SHA-512Half of this ledger's state tree information. */
|
||||
account_hash: string
|
||||
/** All the state information in this ledger. Admin only. */
|
||||
@@ -31,6 +31,11 @@ export default interface Ledger {
|
||||
* by which the close_time could be rounded.
|
||||
*/
|
||||
close_time_resolution: number
|
||||
/**
|
||||
* The approximate time this ledger was closed, in date time string format.
|
||||
* Always uses the UTC time zone.
|
||||
*/
|
||||
close_time_iso: string
|
||||
/** Whether or not this ledger has been closed. */
|
||||
closed: boolean
|
||||
/**
|
||||
@@ -38,11 +43,6 @@ export default interface Ledger {
|
||||
* for this ledger and all its contents.
|
||||
*/
|
||||
ledger_hash: string
|
||||
/**
|
||||
* The ledger index of the ledger. Some API methods display this as a quoted
|
||||
* integer; some display it as a native JSON number.
|
||||
*/
|
||||
ledger_index: string
|
||||
/** The approximate time at which the previous ledger was closed. */
|
||||
parent_close_time: number
|
||||
/**
|
||||
@@ -61,5 +61,47 @@ export default interface Ledger {
|
||||
* either JSON or binary depending on whether the request specified binary
|
||||
* as true.
|
||||
*/
|
||||
transactions?: Array<Transaction & { metaData?: TransactionMetadata }>
|
||||
transactions?: Array<
|
||||
Transaction & {
|
||||
hash: string
|
||||
metaData?: TransactionMetadata
|
||||
}
|
||||
>
|
||||
}
|
||||
|
||||
/**
|
||||
* A ledger is a block of transactions and shared state data. It has a unique
|
||||
* header that describes its contents using cryptographic hashes.
|
||||
*
|
||||
* @category Ledger Entries
|
||||
*/
|
||||
export interface Ledger extends BaseLedger {
|
||||
/**
|
||||
* The ledger index of the ledger. Represented as a number.
|
||||
*/
|
||||
ledger_index: number
|
||||
}
|
||||
|
||||
/**
|
||||
* A ledger is a block of transactions and shared state data. It has a unique
|
||||
* header that describes its contents using cryptographic hashes. This is used
|
||||
* in api_version 1.
|
||||
*
|
||||
* @category Ledger Entries
|
||||
*/
|
||||
export interface LedgerV1 extends BaseLedger {
|
||||
/**
|
||||
* The ledger index of the ledger. Some API methods display this as a quoted
|
||||
* integer; some display it as a number.
|
||||
*/
|
||||
ledger_index: string
|
||||
}
|
||||
|
||||
/**
|
||||
* Type to map between the API version and the Ledger type.
|
||||
*
|
||||
* @category Responses
|
||||
*/
|
||||
export type LedgerVersionMap<
|
||||
Version extends APIVersion = typeof DEFAULT_API_VERSION,
|
||||
> = Version extends typeof RIPPLED_API_V1 ? LedgerV1 : Ledger
|
||||
|
||||
@@ -3,6 +3,7 @@ import Amendments from './Amendments'
|
||||
import AMM from './AMM'
|
||||
import Bridge from './Bridge'
|
||||
import Check from './Check'
|
||||
import Credential from './Credential'
|
||||
import DepositPreauth from './DepositPreauth'
|
||||
import DirectoryNode from './DirectoryNode'
|
||||
import Escrow from './Escrow'
|
||||
@@ -24,6 +25,7 @@ type LedgerEntry =
|
||||
| AMM
|
||||
| Bridge
|
||||
| Check
|
||||
| Credential
|
||||
| DepositPreauth
|
||||
| DirectoryNode
|
||||
| Escrow
|
||||
@@ -45,12 +47,15 @@ type LedgerEntryFilter =
|
||||
| 'amm'
|
||||
| 'bridge'
|
||||
| 'check'
|
||||
| 'credential'
|
||||
| 'deposit_preauth'
|
||||
| 'did'
|
||||
| 'directory'
|
||||
| 'escrow'
|
||||
| 'fee'
|
||||
| 'hashes'
|
||||
| 'mpt_issuance'
|
||||
| 'mptoken'
|
||||
| 'nft_offer'
|
||||
| 'nft_page'
|
||||
| 'offer'
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { BaseLedgerEntry, MissingPreviousTxnID } from './BaseLedgerEntry'
|
||||
import { BaseLedgerEntry } from './BaseLedgerEntry'
|
||||
|
||||
/**
|
||||
* The LedgerHashes objects exist to make it possible to look up a previous
|
||||
@@ -7,9 +7,7 @@ import { BaseLedgerEntry, MissingPreviousTxnID } from './BaseLedgerEntry'
|
||||
*
|
||||
* @category Ledger Entries
|
||||
*/
|
||||
export default interface LedgerHashes
|
||||
extends BaseLedgerEntry,
|
||||
MissingPreviousTxnID {
|
||||
export default interface LedgerHashes extends BaseLedgerEntry {
|
||||
LedgerEntryType: 'LedgerHashes'
|
||||
/** The Ledger Index of the last entry in this object's Hashes array. */
|
||||
LastLedgerSequence?: number
|
||||
|
||||
11
packages/xrpl/src/models/ledger/MPToken.ts
Normal file
11
packages/xrpl/src/models/ledger/MPToken.ts
Normal file
@@ -0,0 +1,11 @@
|
||||
import { MPTAmount } from '../common'
|
||||
|
||||
import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
|
||||
|
||||
export interface MPToken extends BaseLedgerEntry, HasPreviousTxnID {
|
||||
LedgerEntryType: 'MPToken'
|
||||
MPTokenIssuanceID: string
|
||||
MPTAmount?: MPTAmount
|
||||
Flags: number
|
||||
OwnerNode?: string
|
||||
}
|
||||
13
packages/xrpl/src/models/ledger/MPTokenIssuance.ts
Normal file
13
packages/xrpl/src/models/ledger/MPTokenIssuance.ts
Normal file
@@ -0,0 +1,13 @@
|
||||
import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
|
||||
|
||||
export interface MPTokenIssuance extends BaseLedgerEntry, HasPreviousTxnID {
|
||||
LedgerEntryType: 'MPTokenIssuance'
|
||||
Flags: number
|
||||
Issuer: string
|
||||
AssetScale?: number
|
||||
MaximumAmount?: string
|
||||
OutstandingAmount: string
|
||||
TransferFee?: number
|
||||
MPTokenMetadata?: string
|
||||
OwnerNode?: string
|
||||
}
|
||||
@@ -1,4 +1,4 @@
|
||||
import { BaseLedgerEntry, MissingPreviousTxnID } from './BaseLedgerEntry'
|
||||
import { BaseLedgerEntry, HasOptionalPreviousTxnID } from './BaseLedgerEntry'
|
||||
|
||||
/**
|
||||
* The unique id for the nUNL object https://xrpl.org/negativeunl.html#negativeunl-id-format
|
||||
@@ -14,7 +14,7 @@ export const NEGATIVE_UNL_ID =
|
||||
*/
|
||||
export default interface NegativeUNL
|
||||
extends BaseLedgerEntry,
|
||||
MissingPreviousTxnID {
|
||||
HasOptionalPreviousTxnID {
|
||||
LedgerEntryType: 'NegativeUNL'
|
||||
/**
|
||||
* A list of trusted validators that are currently disabled.
|
||||
|
||||
@@ -6,6 +6,7 @@ import Amendments, { Majority, AMENDMENTS_ID } from './Amendments'
|
||||
import AMM, { VoteSlot } from './AMM'
|
||||
import Bridge from './Bridge'
|
||||
import Check from './Check'
|
||||
import Credential from './Credential'
|
||||
import DepositPreauth from './DepositPreauth'
|
||||
import DID from './DID'
|
||||
import DirectoryNode from './DirectoryNode'
|
||||
@@ -15,9 +16,11 @@ import FeeSettings, {
|
||||
FeeSettingsPostAmendmentFields,
|
||||
FEE_SETTINGS_ID,
|
||||
} from './FeeSettings'
|
||||
import Ledger from './Ledger'
|
||||
import { Ledger, LedgerV1 } from './Ledger'
|
||||
import { LedgerEntry, LedgerEntryFilter } from './LedgerEntry'
|
||||
import LedgerHashes from './LedgerHashes'
|
||||
import { MPToken } from './MPToken'
|
||||
import { MPTokenIssuance } from './MPTokenIssuance'
|
||||
import NegativeUNL, { NEGATIVE_UNL_ID } from './NegativeUNL'
|
||||
import { NFTokenOffer } from './NFTokenOffer'
|
||||
import { NFToken, NFTokenPage } from './NFTokenPage'
|
||||
@@ -39,6 +42,7 @@ export {
|
||||
AMM,
|
||||
Bridge,
|
||||
Check,
|
||||
Credential,
|
||||
DepositPreauth,
|
||||
DirectoryNode,
|
||||
DID,
|
||||
@@ -48,12 +52,15 @@ export {
|
||||
FeeSettingsPreAmendmentFields,
|
||||
FeeSettingsPostAmendmentFields,
|
||||
Ledger,
|
||||
LedgerV1,
|
||||
LedgerEntryFilter,
|
||||
LedgerEntry,
|
||||
LedgerHashes,
|
||||
Majority,
|
||||
NEGATIVE_UNL_ID,
|
||||
NegativeUNL,
|
||||
MPTokenIssuance,
|
||||
MPToken,
|
||||
NFTokenOffer,
|
||||
NFTokenPage,
|
||||
NFToken,
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
import { APIVersion, DEFAULT_API_VERSION, RIPPLED_API_V1 } from '../common'
|
||||
import { AccountRoot, SignerList } from '../ledger'
|
||||
|
||||
import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
|
||||
@@ -133,23 +134,13 @@ export interface AccountInfoAccountFlags {
|
||||
allowTrustLineClawback: boolean
|
||||
}
|
||||
|
||||
/**
|
||||
* Response expected from an {@link AccountInfoRequest}.
|
||||
*
|
||||
* @category Responses
|
||||
*/
|
||||
export interface AccountInfoResponse extends BaseResponse {
|
||||
interface BaseAccountInfoResponse extends BaseResponse {
|
||||
result: {
|
||||
/**
|
||||
* The AccountRoot ledger object with this account's information, as stored
|
||||
* in the ledger.
|
||||
* If requested, also includes Array of SignerList ledger objects
|
||||
* associated with this account for Multi-Signing. Since an account can own
|
||||
* at most one SignerList, this array must have exactly one member if it is
|
||||
* present.
|
||||
*/
|
||||
account_data: AccountRoot & { signer_lists?: SignerList[] }
|
||||
|
||||
account_data: AccountRoot
|
||||
/**
|
||||
* A map of account flags parsed out. This will only be available for rippled nodes 1.11.0 and higher.
|
||||
*/
|
||||
@@ -180,3 +171,58 @@ export interface AccountInfoResponse extends BaseResponse {
|
||||
validated?: boolean
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Response expected from a {@link AccountInfoRequest}.
|
||||
*
|
||||
* @category Responses
|
||||
*/
|
||||
export interface AccountInfoResponse extends BaseAccountInfoResponse {
|
||||
result: BaseAccountInfoResponse['result'] & {
|
||||
/**
|
||||
* If requested, array of SignerList ledger objects associated with this account for Multi-Signing.
|
||||
* Since an account can own at most one SignerList, this array must have exactly one
|
||||
* member if it is present.
|
||||
*/
|
||||
signer_lists?: SignerList[]
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Response expected from a {@link AccountInfoRequest} using API version 1.
|
||||
*
|
||||
* @category ResponsesV1
|
||||
*/
|
||||
export interface AccountInfoV1Response extends BaseAccountInfoResponse {
|
||||
result: BaseAccountInfoResponse['result'] & {
|
||||
/**
|
||||
* The AccountRoot ledger object with this account's information, as stored
|
||||
* in the ledger.
|
||||
* If requested, also includes Array of SignerList ledger objects
|
||||
* associated with this account for Multi-Signing. Since an account can own
|
||||
* at most one SignerList, this array must have exactly one member if it is
|
||||
* present.
|
||||
*/
|
||||
account_data: BaseAccountInfoResponse['result']['account_data'] & {
|
||||
/**
|
||||
* Array of SignerList ledger objects associated with this account for Multi-Signing.
|
||||
* Since an account can own at most one SignerList, this array must have exactly one
|
||||
* member if it is present.
|
||||
* Quirk: In API version 1, this field is nested under account_data. For this method,
|
||||
* Clio implements the API version 2 behavior where is field is not nested under account_data.
|
||||
*/
|
||||
signer_lists?: SignerList[]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Type to map between the API version and the response type.
|
||||
*
|
||||
* @category Responses
|
||||
*/
|
||||
export type AccountInfoVersionResponseMap<
|
||||
Version extends APIVersion = typeof DEFAULT_API_VERSION,
|
||||
> = Version extends typeof RIPPLED_API_V1
|
||||
? AccountInfoV1Response
|
||||
: AccountInfoResponse
|
||||
|
||||
@@ -1,4 +1,10 @@
|
||||
import { ResponseOnlyTxInfo } from '../common'
|
||||
import {
|
||||
APIVersion,
|
||||
DEFAULT_API_VERSION,
|
||||
RIPPLED_API_V1,
|
||||
RIPPLED_API_V2,
|
||||
ResponseOnlyTxInfo,
|
||||
} from '../common'
|
||||
import { Transaction, TransactionMetadata } from '../transactions'
|
||||
|
||||
import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
|
||||
@@ -49,7 +55,9 @@ export interface AccountTxRequest extends BaseRequest, LookupByLedgerRequest {
|
||||
marker?: unknown
|
||||
}
|
||||
|
||||
export interface AccountTxTransaction {
|
||||
export interface AccountTxTransaction<
|
||||
Version extends APIVersion = typeof DEFAULT_API_VERSION,
|
||||
> {
|
||||
/** The ledger index of the ledger version that included this transaction. */
|
||||
ledger_index: number
|
||||
/**
|
||||
@@ -58,7 +66,15 @@ export interface AccountTxTransaction {
|
||||
*/
|
||||
meta: string | TransactionMetadata
|
||||
/** JSON object defining the transaction. */
|
||||
tx?: Transaction & ResponseOnlyTxInfo
|
||||
tx_json?: Version extends typeof RIPPLED_API_V2
|
||||
? Transaction & ResponseOnlyTxInfo
|
||||
: never
|
||||
/** JSON object defining the transaction in rippled API v1. */
|
||||
tx?: Version extends typeof RIPPLED_API_V1
|
||||
? Transaction & ResponseOnlyTxInfo
|
||||
: never
|
||||
/** The hash of the transaction. */
|
||||
hash?: Version extends typeof RIPPLED_API_V2 ? string : never
|
||||
/** Unique hashed String representing the transaction. */
|
||||
tx_blob?: string
|
||||
/**
|
||||
@@ -69,11 +85,11 @@ export interface AccountTxTransaction {
|
||||
}
|
||||
|
||||
/**
|
||||
* Expected response from an {@link AccountTxRequest}.
|
||||
*
|
||||
* @category Responses
|
||||
* Base interface for account transaction responses.
|
||||
*/
|
||||
export interface AccountTxResponse extends BaseResponse {
|
||||
interface AccountTxResponseBase<
|
||||
Version extends APIVersion = typeof DEFAULT_API_VERSION,
|
||||
> extends BaseResponse {
|
||||
result: {
|
||||
/** Unique Address identifying the related account. */
|
||||
account: string
|
||||
@@ -98,7 +114,7 @@ export interface AccountTxResponse extends BaseResponse {
|
||||
* Array of transactions matching the request's criteria, as explained
|
||||
* below.
|
||||
*/
|
||||
transactions: AccountTxTransaction[]
|
||||
transactions: Array<AccountTxTransaction<Version>>
|
||||
/**
|
||||
* If included and set to true, the information in this response comes from
|
||||
* a validated ledger version. Otherwise, the information is subject to
|
||||
@@ -107,3 +123,28 @@ export interface AccountTxResponse extends BaseResponse {
|
||||
validated?: boolean
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Expected response from an {@link AccountTxRequest}.
|
||||
*
|
||||
* @category Responses
|
||||
*/
|
||||
export type AccountTxResponse = AccountTxResponseBase
|
||||
|
||||
/**
|
||||
* Expected response from an {@link AccountTxRequest} with `api_version` set to 1.
|
||||
*
|
||||
* @category ResponsesV1
|
||||
*/
|
||||
export type AccountTxV1Response = AccountTxResponseBase<typeof RIPPLED_API_V1>
|
||||
|
||||
/**
|
||||
* Type to map between the API version and the response type.
|
||||
*
|
||||
* @category Responses
|
||||
*/
|
||||
export type AccountTxVersionResponseMap<
|
||||
Version extends APIVersion = typeof DEFAULT_API_VERSION,
|
||||
> = Version extends typeof RIPPLED_API_V1
|
||||
? AccountTxV1Response
|
||||
: AccountTxResponse
|
||||
|
||||
@@ -15,6 +15,12 @@ export interface DepositAuthorizedRequest
|
||||
source_account: string
|
||||
/** The recipient of a possible payment. */
|
||||
destination_account: string
|
||||
/**
|
||||
* The object IDs of Credential objects. If this field is included, then the
|
||||
* credential will be taken into account when analyzing whether the sender can send
|
||||
* funds to the destination.
|
||||
*/
|
||||
credentials?: string[]
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -52,5 +58,9 @@ export interface DepositAuthorizedResponse extends BaseResponse {
|
||||
source_account: string
|
||||
/** If true, the information comes from a validated ledger version. */
|
||||
validated?: boolean
|
||||
/** The object IDs of `Credential` objects. If this field is included,
|
||||
* then the credential will be taken into account when analyzing whether
|
||||
* the sender can send funds to the destination. */
|
||||
credentials?: string[]
|
||||
}
|
||||
}
|
||||
|
||||
68
packages/xrpl/src/models/methods/feature.ts
Normal file
68
packages/xrpl/src/models/methods/feature.ts
Normal file
@@ -0,0 +1,68 @@
|
||||
import { BaseRequest, BaseResponse } from './baseMethod'
|
||||
|
||||
export interface FeatureAllRequest extends BaseRequest {
|
||||
command: 'feature'
|
||||
|
||||
feature?: never
|
||||
}
|
||||
|
||||
export interface FeatureOneRequest extends BaseRequest {
|
||||
command: 'feature'
|
||||
|
||||
feature: string
|
||||
}
|
||||
|
||||
/**
|
||||
* The `feature` command returns information about amendments this server knows about, including whether they are enabled.
|
||||
* Returns an {@link FeatureResponse}.
|
||||
*
|
||||
* @category Requests
|
||||
*/
|
||||
export type FeatureRequest = FeatureAllRequest | FeatureOneRequest
|
||||
|
||||
export interface FeatureAllResponse extends BaseResponse {
|
||||
result: {
|
||||
features: Record<
|
||||
string,
|
||||
{
|
||||
/*
|
||||
* Whether this amendment is currently enabled in the latest ledger.
|
||||
*/
|
||||
enabled: boolean
|
||||
|
||||
/*
|
||||
* The human-readable name for this amendment, if known.
|
||||
*/
|
||||
name: string
|
||||
|
||||
supported: boolean
|
||||
}
|
||||
>
|
||||
}
|
||||
}
|
||||
|
||||
export interface FeatureOneResponse extends BaseResponse {
|
||||
result: Record<
|
||||
string,
|
||||
{
|
||||
/*
|
||||
* Whether this amendment is currently enabled in the latest ledger.
|
||||
*/
|
||||
enabled: boolean
|
||||
|
||||
/*
|
||||
* The human-readable name for this amendment, if known.
|
||||
*/
|
||||
name: string
|
||||
|
||||
supported: boolean
|
||||
}
|
||||
>
|
||||
}
|
||||
|
||||
/**
|
||||
* Response expected from an {@link FeatureRequest}.
|
||||
*
|
||||
* @category Responses
|
||||
*/
|
||||
export type FeatureResponse = FeatureAllResponse | FeatureOneResponse
|
||||
@@ -1,5 +1,7 @@
|
||||
/* eslint-disable no-inline-comments -- Necessary for important note */
|
||||
/* eslint-disable max-lines -- There is a lot to export */
|
||||
import type { APIVersion, DEFAULT_API_VERSION } from '../common'
|
||||
|
||||
import {
|
||||
AccountChannelsRequest,
|
||||
AccountChannelsResponse,
|
||||
@@ -13,6 +15,8 @@ import {
|
||||
AccountInfoAccountFlags,
|
||||
AccountInfoRequest,
|
||||
AccountInfoResponse,
|
||||
AccountInfoV1Response,
|
||||
AccountInfoVersionResponseMap,
|
||||
AccountQueueData,
|
||||
AccountQueueTransaction,
|
||||
} from './accountInfo'
|
||||
@@ -40,6 +44,8 @@ import {
|
||||
import {
|
||||
AccountTxRequest,
|
||||
AccountTxResponse,
|
||||
AccountTxV1Response,
|
||||
AccountTxVersionResponseMap,
|
||||
AccountTxTransaction,
|
||||
} from './accountTx'
|
||||
import { AMMInfoRequest, AMMInfoResponse } from './ammInfo'
|
||||
@@ -60,6 +66,14 @@ import {
|
||||
DepositAuthorizedRequest,
|
||||
DepositAuthorizedResponse,
|
||||
} from './depositAuthorized'
|
||||
import {
|
||||
FeatureAllRequest,
|
||||
FeatureAllResponse,
|
||||
FeatureOneRequest,
|
||||
FeatureOneResponse,
|
||||
FeatureRequest,
|
||||
FeatureResponse,
|
||||
} from './feature'
|
||||
import { FeeRequest, FeeResponse } from './fee'
|
||||
import {
|
||||
GatewayBalance,
|
||||
@@ -76,11 +90,13 @@ import {
|
||||
LedgerQueueData,
|
||||
LedgerRequest,
|
||||
LedgerResponse,
|
||||
LedgerV1Response,
|
||||
LedgerRequestExpandedTransactionsOnly,
|
||||
LedgerResponseExpanded,
|
||||
LedgerRequestExpandedAccountsAndTransactions,
|
||||
LedgerRequestExpandedAccountsOnly,
|
||||
LedgerRequestExpandedTransactionsBinary,
|
||||
LedgerVersionResponseMap,
|
||||
} from './ledger'
|
||||
import { LedgerClosedRequest, LedgerClosedResponse } from './ledgerClosed'
|
||||
import { LedgerCurrentRequest, LedgerCurrentResponse } from './ledgerCurrent'
|
||||
@@ -100,6 +116,7 @@ import {
|
||||
NFTHistoryTransaction,
|
||||
} from './nftHistory'
|
||||
import { NFTInfoRequest, NFTInfoResponse } from './nftInfo'
|
||||
import { NFTsByIssuerRequest, NFTsByIssuerResponse } from './nftsByIssuer'
|
||||
import { NFTSellOffersRequest, NFTSellOffersResponse } from './nftSellOffers'
|
||||
import { NoRippleCheckRequest, NoRippleCheckResponse } from './norippleCheck'
|
||||
import {
|
||||
@@ -135,6 +152,8 @@ import { SubmitRequest, SubmitResponse } from './submit'
|
||||
import {
|
||||
SubmitMultisignedRequest,
|
||||
SubmitMultisignedResponse,
|
||||
SubmitMultisignedV1Response,
|
||||
SubmitMultisignedVersionResponseMap,
|
||||
} from './submitMultisigned'
|
||||
import {
|
||||
BooksSnapshot,
|
||||
@@ -149,13 +168,14 @@ import {
|
||||
SubscribeRequest,
|
||||
SubscribeResponse,
|
||||
TransactionStream,
|
||||
TransactionV1Stream,
|
||||
ValidationStream,
|
||||
} from './subscribe'
|
||||
import {
|
||||
TransactionEntryRequest,
|
||||
TransactionEntryResponse,
|
||||
} from './transactionEntry'
|
||||
import { TxRequest, TxResponse } from './tx'
|
||||
import { TxRequest, TxResponse, TxV1Response, TxVersionResponseMap } from './tx'
|
||||
import {
|
||||
UnsubscribeBook,
|
||||
UnsubscribeRequest,
|
||||
@@ -203,6 +223,7 @@ type Request =
|
||||
| ServerDefinitionsRequest
|
||||
| ServerInfoRequest
|
||||
| ServerStateRequest
|
||||
| FeatureRequest
|
||||
// utility methods
|
||||
| PingRequest
|
||||
| RandomRequest
|
||||
@@ -212,6 +233,7 @@ type Request =
|
||||
// clio only methods
|
||||
| NFTInfoRequest
|
||||
| NFTHistoryRequest
|
||||
| NFTsByIssuerRequest
|
||||
// AMM methods
|
||||
| AMMInfoRequest
|
||||
// Price Oracle methods
|
||||
@@ -220,27 +242,27 @@ type Request =
|
||||
/**
|
||||
* @category Responses
|
||||
*/
|
||||
type Response =
|
||||
type Response<Version extends APIVersion = typeof DEFAULT_API_VERSION> =
|
||||
// account methods
|
||||
| AccountChannelsResponse
|
||||
| AccountCurrenciesResponse
|
||||
| AccountInfoResponse
|
||||
| AccountInfoVersionResponseMap<Version>
|
||||
| AccountLinesResponse
|
||||
| AccountNFTsResponse
|
||||
| AccountObjectsResponse
|
||||
| AccountOffersResponse
|
||||
| AccountTxResponse
|
||||
| AccountTxVersionResponseMap<Version>
|
||||
| GatewayBalancesResponse
|
||||
| NoRippleCheckResponse
|
||||
// ledger methods
|
||||
| LedgerResponse
|
||||
| LedgerVersionResponseMap<Version>
|
||||
| LedgerClosedResponse
|
||||
| LedgerCurrentResponse
|
||||
| LedgerDataResponse
|
||||
| LedgerEntryResponse
|
||||
// transaction methods
|
||||
| SubmitResponse
|
||||
| SubmitMultisignedResponse
|
||||
| SubmitMultisignedVersionResponseMap<Version>
|
||||
| TransactionEntryResponse
|
||||
| TxResponse
|
||||
// path and order book methods
|
||||
@@ -259,6 +281,7 @@ type Response =
|
||||
| ServerDefinitionsResponse
|
||||
| ServerInfoResponse
|
||||
| ServerStateResponse
|
||||
| FeatureResponse
|
||||
// utility methods
|
||||
| PingResponse
|
||||
| RandomResponse
|
||||
@@ -268,17 +291,21 @@ type Response =
|
||||
// clio only methods
|
||||
| NFTInfoResponse
|
||||
| NFTHistoryResponse
|
||||
| NFTsByIssuerResponse
|
||||
// AMM methods
|
||||
| AMMInfoResponse
|
||||
// Price Oracle methods
|
||||
| GetAggregatePriceResponse
|
||||
|
||||
export type RequestResponseMap<T> = T extends AccountChannelsRequest
|
||||
export type RequestResponseMap<
|
||||
T,
|
||||
Version extends APIVersion = typeof DEFAULT_API_VERSION,
|
||||
> = T extends AccountChannelsRequest
|
||||
? AccountChannelsResponse
|
||||
: T extends AccountCurrenciesRequest
|
||||
? AccountCurrenciesResponse
|
||||
: T extends AccountInfoRequest
|
||||
? AccountInfoResponse
|
||||
? AccountInfoVersionResponseMap<Version>
|
||||
: T extends AccountLinesRequest
|
||||
? AccountLinesResponse
|
||||
: T extends AccountNFTsRequest
|
||||
@@ -288,7 +315,7 @@ export type RequestResponseMap<T> = T extends AccountChannelsRequest
|
||||
: T extends AccountOffersRequest
|
||||
? AccountOffersResponse
|
||||
: T extends AccountTxRequest
|
||||
? AccountTxResponse
|
||||
? AccountTxVersionResponseMap<Version>
|
||||
: T extends AMMInfoRequest
|
||||
? AMMInfoResponse
|
||||
: T extends GatewayBalancesRequest
|
||||
@@ -354,15 +381,15 @@ export type RequestResponseMap<T> = T extends AccountChannelsRequest
|
||||
// then we'd get the wrong response type, LedgerResponse, instead of
|
||||
// LedgerResponseExpanded.
|
||||
T extends LedgerRequestExpandedTransactionsBinary
|
||||
? LedgerResponse
|
||||
? LedgerVersionResponseMap<Version>
|
||||
: T extends LedgerRequestExpandedAccountsAndTransactions
|
||||
? LedgerResponseExpanded
|
||||
? LedgerResponseExpanded<Version>
|
||||
: T extends LedgerRequestExpandedTransactionsOnly
|
||||
? LedgerResponseExpanded
|
||||
? LedgerResponseExpanded<Version>
|
||||
: T extends LedgerRequestExpandedAccountsOnly
|
||||
? LedgerResponseExpanded
|
||||
? LedgerResponseExpanded<Version>
|
||||
: T extends LedgerRequest
|
||||
? LedgerResponse
|
||||
? LedgerVersionResponseMap<Version>
|
||||
: T extends LedgerClosedRequest
|
||||
? LedgerClosedResponse
|
||||
: T extends LedgerCurrentRequest
|
||||
@@ -374,11 +401,11 @@ export type RequestResponseMap<T> = T extends AccountChannelsRequest
|
||||
: T extends SubmitRequest
|
||||
? SubmitResponse
|
||||
: T extends SubmitMultisignedRequest
|
||||
? SubmitMultisignedResponse
|
||||
? SubmitMultisignedVersionResponseMap<Version>
|
||||
: T extends TransactionEntryRequest
|
||||
? TransactionEntryResponse
|
||||
: T extends TxRequest
|
||||
? TxResponse
|
||||
? TxVersionResponseMap<Version>
|
||||
: T extends BookOffersRequest
|
||||
? BookOffersResponse
|
||||
: T extends DepositAuthorizedRequest
|
||||
@@ -403,6 +430,10 @@ export type RequestResponseMap<T> = T extends AccountChannelsRequest
|
||||
? ServerStateResponse
|
||||
: T extends ServerDefinitionsRequest
|
||||
? ServerDefinitionsResponse
|
||||
: T extends FeatureAllRequest
|
||||
? FeatureAllResponse
|
||||
: T extends FeatureOneRequest
|
||||
? FeatureOneResponse
|
||||
: T extends PingRequest
|
||||
? PingResponse
|
||||
: T extends RandomRequest
|
||||
@@ -413,22 +444,29 @@ export type RequestResponseMap<T> = T extends AccountChannelsRequest
|
||||
? NFTSellOffersResponse
|
||||
: T extends NFTInfoRequest
|
||||
? NFTInfoResponse
|
||||
: T extends NFTsByIssuerRequest
|
||||
? NFTsByIssuerResponse
|
||||
: T extends NFTHistoryRequest
|
||||
? NFTHistoryResponse
|
||||
: Response
|
||||
: Response<Version>
|
||||
|
||||
export type MarkerRequest = Request & {
|
||||
limit?: number
|
||||
marker?: unknown
|
||||
}
|
||||
|
||||
export type MarkerResponse = Response & {
|
||||
export type MarkerResponse<
|
||||
Version extends APIVersion = typeof DEFAULT_API_VERSION,
|
||||
> = Response<Version> & {
|
||||
result: {
|
||||
marker?: unknown
|
||||
}
|
||||
}
|
||||
|
||||
export type RequestAllResponseMap<T> = T extends AccountChannelsRequest
|
||||
export type RequestAllResponseMap<
|
||||
T,
|
||||
Version extends APIVersion = typeof DEFAULT_API_VERSION,
|
||||
> = T extends AccountChannelsRequest
|
||||
? AccountChannelsResponse
|
||||
: T extends AccountLinesRequest
|
||||
? AccountLinesResponse
|
||||
@@ -437,14 +475,12 @@ export type RequestAllResponseMap<T> = T extends AccountChannelsRequest
|
||||
: T extends AccountOffersRequest
|
||||
? AccountOffersResponse
|
||||
: T extends AccountTxRequest
|
||||
? AccountTxResponse
|
||||
? AccountTxVersionResponseMap<Version>
|
||||
: T extends LedgerDataRequest
|
||||
? LedgerDataResponse
|
||||
: T extends AccountTxRequest
|
||||
? AccountTxResponse
|
||||
: T extends BookOffersRequest
|
||||
? BookOffersResponse
|
||||
: MarkerResponse
|
||||
: MarkerResponse<Version>
|
||||
|
||||
export {
|
||||
// Allow users to define their own requests and responses. This is useful for releasing experimental versions
|
||||
@@ -462,6 +498,7 @@ export {
|
||||
AccountInfoAccountFlags,
|
||||
AccountInfoRequest,
|
||||
AccountInfoResponse,
|
||||
AccountInfoV1Response,
|
||||
AccountQueueData,
|
||||
AccountQueueTransaction,
|
||||
AccountLinesRequest,
|
||||
@@ -479,6 +516,7 @@ export {
|
||||
AccountOffersResponse,
|
||||
AccountTxRequest,
|
||||
AccountTxResponse,
|
||||
AccountTxV1Response,
|
||||
AccountTxTransaction,
|
||||
GatewayBalance,
|
||||
GatewayBalancesRequest,
|
||||
@@ -490,6 +528,7 @@ export {
|
||||
// ledger methods
|
||||
LedgerRequest,
|
||||
LedgerResponse,
|
||||
LedgerV1Response,
|
||||
LedgerQueueData,
|
||||
LedgerBinary,
|
||||
LedgerModifiedOfferCreateTransaction,
|
||||
@@ -509,10 +548,12 @@ export {
|
||||
SubmitResponse,
|
||||
SubmitMultisignedRequest,
|
||||
SubmitMultisignedResponse,
|
||||
SubmitMultisignedV1Response,
|
||||
TransactionEntryRequest,
|
||||
TransactionEntryResponse,
|
||||
TxRequest,
|
||||
TxResponse,
|
||||
TxV1Response,
|
||||
// path and order book methods with types
|
||||
BookOffersRequest,
|
||||
BookOffer,
|
||||
@@ -543,6 +584,7 @@ export {
|
||||
LedgerStreamResponse,
|
||||
ValidationStream,
|
||||
TransactionStream,
|
||||
TransactionV1Stream,
|
||||
PathFindStream,
|
||||
PeerStatusStream,
|
||||
OrderBookStream,
|
||||
@@ -565,6 +607,8 @@ export {
|
||||
ServerState,
|
||||
StateAccountingFinal,
|
||||
StateAccounting,
|
||||
FeatureRequest,
|
||||
FeatureResponse,
|
||||
// utility methods
|
||||
PingRequest,
|
||||
PingResponse,
|
||||
@@ -582,6 +626,8 @@ export {
|
||||
NFTHistoryRequest,
|
||||
NFTHistoryResponse,
|
||||
NFTHistoryTransaction,
|
||||
NFTsByIssuerRequest,
|
||||
NFTsByIssuerResponse,
|
||||
// AMM methods
|
||||
AMMInfoRequest,
|
||||
AMMInfoResponse,
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
import { Ledger } from '../ledger'
|
||||
import { APIVersion, DEFAULT_API_VERSION, RIPPLED_API_V1 } from '../common'
|
||||
import { Ledger, LedgerV1, LedgerVersionMap } from '../ledger/Ledger'
|
||||
import { LedgerEntryFilter } from '../ledger/LedgerEntry'
|
||||
import { Transaction, TransactionAndMetadata } from '../transactions'
|
||||
import { TransactionMetadata } from '../transactions/metadata'
|
||||
@@ -207,6 +208,12 @@ export interface LedgerBinary
|
||||
transactions?: string[]
|
||||
}
|
||||
|
||||
export interface LedgerBinaryV1
|
||||
extends Omit<Omit<LedgerV1, 'transactions'>, 'accountState'> {
|
||||
accountState?: string[]
|
||||
transactions?: string[]
|
||||
}
|
||||
|
||||
interface LedgerResponseBase {
|
||||
/** Unique identifying hash of the entire ledger. */
|
||||
ledger_hash: string
|
||||
@@ -231,6 +238,11 @@ interface LedgerResponseResult extends LedgerResponseBase {
|
||||
ledger: LedgerBinary
|
||||
}
|
||||
|
||||
interface LedgerV1ResponseResult extends LedgerResponseBase {
|
||||
/** The complete header data of this {@link Ledger}. */
|
||||
ledger: LedgerBinaryV1
|
||||
}
|
||||
|
||||
/**
|
||||
* Response expected from a {@link LedgerRequest}.
|
||||
* This is the default request response, triggered when `expand` and `binary` are both false.
|
||||
@@ -241,9 +253,31 @@ export interface LedgerResponse extends BaseResponse {
|
||||
result: LedgerResponseResult
|
||||
}
|
||||
|
||||
interface LedgerResponseExpandedResult extends LedgerResponseBase {
|
||||
/**
|
||||
* Response expected from a {@link LedgerRequest}.
|
||||
* This is the default request response, triggered when `expand` and `binary` are both false.
|
||||
* This is the response for API version 1.
|
||||
*
|
||||
* @category ResponsesV1
|
||||
*/
|
||||
export interface LedgerV1Response extends BaseResponse {
|
||||
result: LedgerV1ResponseResult
|
||||
}
|
||||
|
||||
/**
|
||||
* Type to map between the API version and the response type.
|
||||
*
|
||||
* @category Responses
|
||||
*/
|
||||
export type LedgerVersionResponseMap<
|
||||
Version extends APIVersion = typeof DEFAULT_API_VERSION,
|
||||
> = Version extends typeof RIPPLED_API_V1 ? LedgerV1Response : LedgerResponse
|
||||
|
||||
interface LedgerResponseExpandedResult<
|
||||
Version extends APIVersion = typeof DEFAULT_API_VERSION,
|
||||
> extends LedgerResponseBase {
|
||||
/** The complete header data of this {@link Ledger}. */
|
||||
ledger: Ledger
|
||||
ledger: LedgerVersionMap<Version>
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -254,6 +288,8 @@ interface LedgerResponseExpandedResult extends LedgerResponseBase {
|
||||
*
|
||||
* @category Responses
|
||||
*/
|
||||
export interface LedgerResponseExpanded extends BaseResponse {
|
||||
result: LedgerResponseExpandedResult
|
||||
export interface LedgerResponseExpanded<
|
||||
Version extends APIVersion = typeof DEFAULT_API_VERSION,
|
||||
> extends BaseResponse {
|
||||
result: LedgerResponseExpandedResult<Version>
|
||||
}
|
||||
|
||||
@@ -21,6 +21,22 @@ import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
|
||||
*/
|
||||
export interface LedgerEntryRequest extends BaseRequest, LookupByLedgerRequest {
|
||||
command: 'ledger_entry'
|
||||
|
||||
/**
|
||||
* Retrieve a MPTokenIssuance object from the ledger.
|
||||
*/
|
||||
mpt_issuance?: string
|
||||
|
||||
/**
|
||||
* Retrieve a MPToken object from the ledger.
|
||||
*/
|
||||
mptoken?:
|
||||
| {
|
||||
mpt_issuance_id: string
|
||||
account: string
|
||||
}
|
||||
| string
|
||||
|
||||
/**
|
||||
* Retrieve an Automated Market Maker (AMM) object from the ledger.
|
||||
* This is similar to amm_info method, but the ledger_entry version returns only the ledger entry as stored.
|
||||
@@ -35,7 +51,14 @@ export interface LedgerEntryRequest extends BaseRequest, LookupByLedgerRequest {
|
||||
issuer?: string
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* (Optional) If set to true and the queried object has been deleted,
|
||||
* return its complete data prior to its deletion.
|
||||
* If set to false or not provided and the queried object has been deleted,
|
||||
* return objectNotFound (current behavior).
|
||||
* This parameter is supported only by Clio servers
|
||||
*/
|
||||
include_deleted?: boolean
|
||||
/**
|
||||
* If true, return the requested ledger object's contents as a hex string in
|
||||
* the XRP Ledger's binary format. Otherwise, return data in JSON format. The
|
||||
@@ -60,6 +83,23 @@ export interface LedgerEntryRequest extends BaseRequest, LookupByLedgerRequest {
|
||||
/** The object ID of a Check object to retrieve. */
|
||||
check?: string
|
||||
|
||||
/* Specify the Credential to retrieve. If a string, must be the ledger entry ID of
|
||||
* the entry, as hexadecimal. If an object, requires subject, issuer, and
|
||||
* credential_type sub-fields.
|
||||
*/
|
||||
credential?:
|
||||
| {
|
||||
/** The account that is the subject of the credential. */
|
||||
subject: string
|
||||
|
||||
/** The account that issued the credential. */
|
||||
issuer: string
|
||||
|
||||
/** The type of the credential, as issued. */
|
||||
credentialType: string
|
||||
}
|
||||
| string
|
||||
|
||||
/**
|
||||
* Specify a DepositPreauth object to retrieve. If a string, must be the
|
||||
* object ID of the DepositPreauth object, as hexadecimal. If an object,
|
||||
@@ -204,5 +244,9 @@ export interface LedgerEntryResponse<T = LedgerEntry> extends BaseResponse {
|
||||
/** The binary representation of the ledger object, as hexadecimal. */
|
||||
node_binary?: string
|
||||
validated?: boolean
|
||||
/**
|
||||
* (Optional) Indicates the ledger index at which the object was deleted.
|
||||
*/
|
||||
deleted_ledger_index?: number
|
||||
}
|
||||
}
|
||||
|
||||
68
packages/xrpl/src/models/methods/nftsByIssuer.ts
Normal file
68
packages/xrpl/src/models/methods/nftsByIssuer.ts
Normal file
@@ -0,0 +1,68 @@
|
||||
import { NFToken } from '../common'
|
||||
|
||||
import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
|
||||
|
||||
/**
|
||||
* The nfts_by_issuer method returns a list of NFTokens issued by the account.
|
||||
* The order of the NFTs is not associated with the date the NFTs were minted.
|
||||
* Expects a response in the form of a {@link
|
||||
* NFTsByIssuerResponse}.
|
||||
*
|
||||
* @category Requests
|
||||
*/
|
||||
export interface NFTsByIssuerRequest
|
||||
extends BaseRequest,
|
||||
LookupByLedgerRequest {
|
||||
command: 'nfts_by_issuer'
|
||||
/**
|
||||
* A unique identifier for the account, most commonly the account's address
|
||||
*/
|
||||
issuer: string
|
||||
/**
|
||||
* Value from a previous paginated response. Resume retrieving data where
|
||||
* that response left off. This value is stable even if there is a change in
|
||||
* the server's range of available ledgers.
|
||||
*/
|
||||
marker?: unknown
|
||||
/**
|
||||
* Filter NFTs issued by this issuer that have this taxon.
|
||||
*/
|
||||
nft_taxon?: number
|
||||
/**
|
||||
* Default varies. Limit the number of transactions to retrieve. The server
|
||||
* is not required to honor this value.
|
||||
*/
|
||||
limit?: number
|
||||
}
|
||||
|
||||
/**
|
||||
* Expected response from an {@link NFTsByIssuerRequest}.
|
||||
*
|
||||
* @category Responses
|
||||
*/
|
||||
export interface NFTsByIssuerResponse extends BaseResponse {
|
||||
result: {
|
||||
/**
|
||||
* The unique identifier for the account, most commonly the account's address
|
||||
*/
|
||||
issuer: string
|
||||
/**
|
||||
* A list of NFTs issued by the account.
|
||||
* The order of the NFTs is not associated with the date the NFTs were minted.
|
||||
*/
|
||||
nfts: NFToken[]
|
||||
/**
|
||||
* Server-defined value indicating the response is paginated. Pass this
|
||||
* to the next call to resume where this call left off.
|
||||
*/
|
||||
marker?: unknown
|
||||
/**
|
||||
* The limit value used in the request.
|
||||
*/
|
||||
limit?: number
|
||||
/**
|
||||
* Use to filter NFTs issued by this issuer that have this taxon.
|
||||
*/
|
||||
nft_taxon?: number
|
||||
}
|
||||
}
|
||||
@@ -1,3 +1,4 @@
|
||||
import { APIVersion, DEFAULT_API_VERSION, RIPPLED_API_V1 } from '../common'
|
||||
import { Transaction } from '../transactions'
|
||||
|
||||
import { BaseRequest, BaseResponse } from './baseMethod'
|
||||
@@ -24,28 +25,59 @@ export interface SubmitMultisignedRequest extends BaseRequest {
|
||||
fail_hard?: boolean
|
||||
}
|
||||
|
||||
/**
|
||||
* Common properties for multisigned transaction responses.
|
||||
*
|
||||
* @category Responses
|
||||
*/
|
||||
interface BaseSubmitMultisignedResult {
|
||||
/**
|
||||
* Code indicating the preliminary result of the transaction, for example.
|
||||
* `tesSUCCESS`.
|
||||
*/
|
||||
engine_result: string
|
||||
/**
|
||||
* Numeric code indicating the preliminary result of the transaction,
|
||||
* directly correlated to `engine_result`.
|
||||
*/
|
||||
engine_result_code: number
|
||||
/** Human-readable explanation of the preliminary transaction result. */
|
||||
engine_result_message: string
|
||||
/** The complete transaction in hex string format. */
|
||||
tx_blob: string
|
||||
/** The complete transaction in JSON format. */
|
||||
tx_json: Transaction
|
||||
}
|
||||
|
||||
/**
|
||||
* Response expected from a {@link SubmitMultisignedRequest}.
|
||||
*
|
||||
* @category Responses
|
||||
*/
|
||||
export interface SubmitMultisignedResponse extends BaseResponse {
|
||||
result: {
|
||||
/**
|
||||
* Code indicating the preliminary result of the transaction, for example.
|
||||
* `tesSUCCESS` .
|
||||
*/
|
||||
engine_result: string
|
||||
/**
|
||||
* Numeric code indicating the preliminary result of the transaction,
|
||||
* directly correlated to `engine_result`.
|
||||
*/
|
||||
engine_result_code: number
|
||||
/** Human-readable explanation of the preliminary transaction result. */
|
||||
engine_result_message: string
|
||||
/** The complete transaction in hex string format. */
|
||||
tx_blob: string
|
||||
/** The complete transaction in JSON format. */
|
||||
result: BaseSubmitMultisignedResult & {
|
||||
hash?: string
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Response expected from a {@link SubmitMultisignedRequest} using api_version 1.
|
||||
*
|
||||
* @category ResponsesV1
|
||||
*/
|
||||
export interface SubmitMultisignedV1Response extends BaseResponse {
|
||||
result: BaseSubmitMultisignedResult & {
|
||||
tx_json: Transaction & { hash?: string }
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Type to map between the API version and the response type.
|
||||
*
|
||||
* @category Responses
|
||||
*/
|
||||
export type SubmitMultisignedVersionResponseMap<
|
||||
Version extends APIVersion = typeof DEFAULT_API_VERSION,
|
||||
> = Version extends typeof RIPPLED_API_V1
|
||||
? SubmitMultisignedV1Response
|
||||
: SubmitMultisignedResponse
|
||||
|
||||
@@ -4,6 +4,10 @@ import type {
|
||||
Path,
|
||||
StreamType,
|
||||
ResponseOnlyTxInfo,
|
||||
APIVersion,
|
||||
DEFAULT_API_VERSION,
|
||||
RIPPLED_API_V1,
|
||||
RIPPLED_API_V2,
|
||||
} from '../common'
|
||||
import { Offer } from '../ledger'
|
||||
import { OfferCreate, Transaction } from '../transactions'
|
||||
@@ -262,9 +266,16 @@ export interface ValidationStream extends BaseStream {
|
||||
*
|
||||
* @category Streams
|
||||
*/
|
||||
export interface TransactionStream extends BaseStream {
|
||||
interface TransactionStreamBase<
|
||||
Version extends APIVersion = typeof DEFAULT_API_VERSION,
|
||||
> extends BaseStream {
|
||||
status: string
|
||||
type: 'transaction'
|
||||
/**
|
||||
* The approximate time this ledger was closed, in date time string format.
|
||||
* Always uses the UTC time zone.
|
||||
*/
|
||||
close_time_iso: string
|
||||
/** String Transaction result code. */
|
||||
engine_result: string
|
||||
/** Numeric transaction response code, if applicable. */
|
||||
@@ -285,8 +296,14 @@ export interface TransactionStream extends BaseStream {
|
||||
* in detail.
|
||||
*/
|
||||
meta?: TransactionMetadata
|
||||
/** The definition of the transaction in JSON format. */
|
||||
transaction: Transaction & ResponseOnlyTxInfo
|
||||
/** JSON object defining the transaction. */
|
||||
tx_json?: Version extends typeof RIPPLED_API_V2
|
||||
? Transaction & ResponseOnlyTxInfo
|
||||
: never
|
||||
/** JSON object defining the transaction in rippled API v1. */
|
||||
transaction?: Version extends typeof RIPPLED_API_V1
|
||||
? Transaction & ResponseOnlyTxInfo
|
||||
: never
|
||||
/**
|
||||
* If true, this transaction is included in a validated ledger and its
|
||||
* outcome is final. Responses from the transaction stream should always be
|
||||
@@ -296,6 +313,20 @@ export interface TransactionStream extends BaseStream {
|
||||
warnings?: Array<{ id: number; message: string }>
|
||||
}
|
||||
|
||||
/**
|
||||
* Expected response from an {@link AccountTxRequest}.
|
||||
*
|
||||
* @category Streams
|
||||
*/
|
||||
export type TransactionStream = TransactionStreamBase
|
||||
|
||||
/**
|
||||
* Expected response from an {@link AccountTxRequest} with `api_version` set to 1.
|
||||
*
|
||||
* @category Streams
|
||||
*/
|
||||
export type TransactionV1Stream = TransactionStreamBase<typeof RIPPLED_API_V1>
|
||||
|
||||
/**
|
||||
* The admin-only `peer_status` stream reports a large amount of information on
|
||||
* the activities of other rippled servers to which this server is connected, in
|
||||
|
||||
@@ -1,3 +1,9 @@
|
||||
import {
|
||||
APIVersion,
|
||||
DEFAULT_API_VERSION,
|
||||
RIPPLED_API_V1,
|
||||
RIPPLED_API_V2,
|
||||
} from '../common'
|
||||
import { Transaction, TransactionMetadata } from '../transactions'
|
||||
import { BaseTransaction } from '../transactions/common'
|
||||
|
||||
@@ -41,6 +47,47 @@ export interface TxRequest extends BaseRequest {
|
||||
max_ledger?: number
|
||||
}
|
||||
|
||||
/**
|
||||
* Common properties of transaction responses.
|
||||
*
|
||||
* @category Responses
|
||||
*/
|
||||
interface BaseTxResult<
|
||||
Version extends APIVersion = typeof DEFAULT_API_VERSION,
|
||||
T extends BaseTransaction = Transaction,
|
||||
> {
|
||||
/** The SHA-512 hash of the transaction. */
|
||||
hash: string
|
||||
/**
|
||||
* The Concise Transaction Identifier of the transaction (16-byte hex string)
|
||||
*/
|
||||
ctid?: string
|
||||
/** The ledger index of the ledger that includes this transaction. */
|
||||
ledger_index?: number
|
||||
/** Unique hashed string Transaction metadata blob, which describes the results of the transaction.
|
||||
* Can be undefined if a transaction has not been validated yet. This field is omitted if binary
|
||||
* binary format is not requested. */
|
||||
meta_blob?: Version extends typeof RIPPLED_API_V2
|
||||
? TransactionMetadata<T> | string
|
||||
: never
|
||||
/** Transaction metadata, which describes the results of the transaction.
|
||||
* Can be undefined if a transaction has not been validated yet. */
|
||||
meta?: TransactionMetadata<T> | string
|
||||
/**
|
||||
* If true, this data comes from a validated ledger version; if omitted or.
|
||||
* Set to false, this data is not final.
|
||||
*/
|
||||
validated?: boolean
|
||||
/**
|
||||
* The time the transaction was closed, in seconds since the Ripple Epoch.
|
||||
*/
|
||||
close_time_iso?: string
|
||||
/**
|
||||
* This number measures the number of seconds since the "Ripple Epoch" of January 1, 2000 (00:00 UTC)
|
||||
*/
|
||||
date?: number
|
||||
}
|
||||
|
||||
/**
|
||||
* Response expected from a {@link TxRequest}.
|
||||
*
|
||||
@@ -48,28 +95,7 @@ export interface TxRequest extends BaseRequest {
|
||||
*/
|
||||
export interface TxResponse<T extends BaseTransaction = Transaction>
|
||||
extends BaseResponse {
|
||||
result: {
|
||||
/** The SHA-512 hash of the transaction. */
|
||||
hash: string
|
||||
/**
|
||||
* The Concise Transaction Identifier of the transaction (16-byte hex string)
|
||||
*/
|
||||
ctid?: string
|
||||
/** The ledger index of the ledger that includes this transaction. */
|
||||
ledger_index?: number
|
||||
/** Transaction metadata, which describes the results of the transaction.
|
||||
* Can be undefined if a transaction has not been validated yet. */
|
||||
meta?: TransactionMetadata<T> | string
|
||||
/**
|
||||
* If true, this data comes from a validated ledger version; if omitted or.
|
||||
* Set to false, this data is not final.
|
||||
*/
|
||||
validated?: boolean
|
||||
/**
|
||||
* This number measures the number of seconds since the "Ripple Epoch" of January 1, 2000 (00:00 UTC)
|
||||
*/
|
||||
date?: number
|
||||
} & T
|
||||
result: BaseTxResult<typeof RIPPLED_API_V2, T> & { tx_json: T }
|
||||
/**
|
||||
* If true, the server was able to search all of the specified ledger
|
||||
* versions, and the transaction was in none of them. If false, the server did
|
||||
@@ -78,3 +104,29 @@ export interface TxResponse<T extends BaseTransaction = Transaction>
|
||||
*/
|
||||
searched_all?: boolean
|
||||
}
|
||||
|
||||
/**
|
||||
* Response expected from a {@link TxRequest} using API version 1.
|
||||
*
|
||||
* @category ResponsesV1
|
||||
*/
|
||||
export interface TxV1Response<T extends BaseTransaction = Transaction>
|
||||
extends BaseResponse {
|
||||
result: BaseTxResult<typeof RIPPLED_API_V1, T> & T
|
||||
/**
|
||||
* If true, the server was able to search all of the specified ledger
|
||||
* versions, and the transaction was in none of them. If false, the server did
|
||||
* not have all of the specified ledger versions available, so it is not sure.
|
||||
* If one of them might contain the transaction.
|
||||
*/
|
||||
searched_all?: boolean
|
||||
}
|
||||
|
||||
/**
|
||||
* Type to map between the API version and the response type.
|
||||
*
|
||||
* @category Responses
|
||||
*/
|
||||
export type TxVersionResponseMap<
|
||||
Version extends APIVersion = typeof DEFAULT_API_VERSION,
|
||||
> = Version extends typeof RIPPLED_API_V1 ? TxV1Response : TxResponse
|
||||
|
||||
44
packages/xrpl/src/models/transactions/CredentialAccept.ts
Normal file
44
packages/xrpl/src/models/transactions/CredentialAccept.ts
Normal file
@@ -0,0 +1,44 @@
|
||||
import {
|
||||
BaseTransaction,
|
||||
isString,
|
||||
validateBaseTransaction,
|
||||
validateCredentialType,
|
||||
validateRequiredField,
|
||||
} from './common'
|
||||
|
||||
/**
|
||||
* Accepts a credential issued to the Account (i.e. the Account is the Subject of the Credential object).
|
||||
* Credentials are represented in hex. Whilst they are allowed a maximum length of 64
|
||||
* bytes, every byte requires 2 hex characters for representation.
|
||||
* The credential is not considered valid until it has been transferred/accepted.
|
||||
*
|
||||
* @category Transaction Models
|
||||
* */
|
||||
export interface CredentialAccept extends BaseTransaction {
|
||||
TransactionType: 'CredentialAccept'
|
||||
|
||||
/** The subject of the credential. */
|
||||
Account: string
|
||||
|
||||
/** The issuer of the credential. */
|
||||
Issuer: string
|
||||
|
||||
/** A hex-encoded value to identify the type of credential from the issuer. */
|
||||
CredentialType: string
|
||||
}
|
||||
|
||||
/**
|
||||
* Verify the form and type of a CredentialAccept at runtime.
|
||||
*
|
||||
* @param tx - A CredentialAccept Transaction.
|
||||
* @throws When the CredentialAccept is Malformed.
|
||||
*/
|
||||
export function validateCredentialAccept(tx: Record<string, unknown>): void {
|
||||
validateBaseTransaction(tx)
|
||||
|
||||
validateRequiredField(tx, 'Account', isString)
|
||||
|
||||
validateRequiredField(tx, 'Issuer', isString)
|
||||
|
||||
validateCredentialType(tx)
|
||||
}
|
||||
81
packages/xrpl/src/models/transactions/CredentialCreate.ts
Normal file
81
packages/xrpl/src/models/transactions/CredentialCreate.ts
Normal file
@@ -0,0 +1,81 @@
|
||||
import { HEX_REGEX } from '@xrplf/isomorphic/utils'
|
||||
|
||||
import { ValidationError } from '../../errors'
|
||||
|
||||
import {
|
||||
BaseTransaction,
|
||||
isNumber,
|
||||
isString,
|
||||
validateBaseTransaction,
|
||||
validateCredentialType,
|
||||
validateOptionalField,
|
||||
validateRequiredField,
|
||||
} from './common'
|
||||
|
||||
const MAX_URI_LENGTH = 256
|
||||
|
||||
/**
|
||||
* Creates a Credential object. It must be sent by the issuer.
|
||||
*
|
||||
* @category Transaction Models
|
||||
* */
|
||||
export interface CredentialCreate extends BaseTransaction {
|
||||
TransactionType: 'CredentialCreate'
|
||||
|
||||
/** The issuer of the credential. */
|
||||
Account: string
|
||||
|
||||
/** The subject of the credential. */
|
||||
Subject: string
|
||||
|
||||
/** A hex-encoded value to identify the type of credential from the issuer. */
|
||||
CredentialType: string
|
||||
|
||||
/** Credential expiration. */
|
||||
Expiration?: number
|
||||
|
||||
/** Additional data about the credential (such as a link to the VC document). */
|
||||
URI?: string
|
||||
}
|
||||
|
||||
/**
|
||||
* Verify the form and type of a CredentialCreate at runtime.
|
||||
*
|
||||
* @param tx - A CredentialCreate Transaction.
|
||||
* @throws When the CredentialCreate is Malformed.
|
||||
*/
|
||||
export function validateCredentialCreate(tx: Record<string, unknown>): void {
|
||||
validateBaseTransaction(tx)
|
||||
|
||||
validateRequiredField(tx, 'Account', isString)
|
||||
|
||||
validateRequiredField(tx, 'Subject', isString)
|
||||
|
||||
validateCredentialType(tx)
|
||||
|
||||
validateOptionalField(tx, 'Expiration', isNumber)
|
||||
|
||||
validateURI(tx.URI)
|
||||
}
|
||||
|
||||
function validateURI(URI: unknown): void {
|
||||
if (URI === undefined) {
|
||||
return
|
||||
}
|
||||
|
||||
if (typeof URI !== 'string') {
|
||||
throw new ValidationError('CredentialCreate: invalid field URI')
|
||||
}
|
||||
|
||||
if (URI.length === 0) {
|
||||
throw new ValidationError('CredentialCreate: URI cannot be an empty string')
|
||||
} else if (URI.length > MAX_URI_LENGTH) {
|
||||
throw new ValidationError(
|
||||
`CredentialCreate: URI length must be <= ${MAX_URI_LENGTH}`,
|
||||
)
|
||||
}
|
||||
|
||||
if (!HEX_REGEX.test(URI)) {
|
||||
throw new ValidationError('CredentialCreate: URI must be encoded in hex')
|
||||
}
|
||||
}
|
||||
55
packages/xrpl/src/models/transactions/CredentialDelete.ts
Normal file
55
packages/xrpl/src/models/transactions/CredentialDelete.ts
Normal file
@@ -0,0 +1,55 @@
|
||||
import { ValidationError } from '../../errors'
|
||||
|
||||
import {
|
||||
BaseTransaction,
|
||||
isString,
|
||||
validateBaseTransaction,
|
||||
validateCredentialType,
|
||||
validateOptionalField,
|
||||
validateRequiredField,
|
||||
} from './common'
|
||||
|
||||
/**
|
||||
* Deletes a Credential object.
|
||||
*
|
||||
* @category Transaction Models
|
||||
* */
|
||||
export interface CredentialDelete extends BaseTransaction {
|
||||
TransactionType: 'CredentialDelete'
|
||||
|
||||
/** The transaction submitter. */
|
||||
Account: string
|
||||
|
||||
/** A hex-encoded value to identify the type of credential from the issuer. */
|
||||
CredentialType: string
|
||||
|
||||
/** The person that the credential is for. If omitted, Account is assumed to be the subject. */
|
||||
Subject?: string
|
||||
|
||||
/** The issuer of the credential. If omitted, Account is assumed to be the issuer. */
|
||||
Issuer?: string
|
||||
}
|
||||
|
||||
/**
|
||||
* Verify the form and type of a CredentialDelete at runtime.
|
||||
*
|
||||
* @param tx - A CredentialDelete Transaction.
|
||||
* @throws When the CredentialDelete is Malformed.
|
||||
*/
|
||||
export function validateCredentialDelete(tx: Record<string, unknown>): void {
|
||||
validateBaseTransaction(tx)
|
||||
|
||||
if (!tx.Subject && !tx.Issuer) {
|
||||
throw new ValidationError(
|
||||
'CredentialDelete: either `Issuer` or `Subject` must be provided',
|
||||
)
|
||||
}
|
||||
|
||||
validateRequiredField(tx, 'Account', isString)
|
||||
|
||||
validateCredentialType(tx)
|
||||
|
||||
validateOptionalField(tx, 'Subject', isString)
|
||||
|
||||
validateOptionalField(tx, 'Issuer', isString)
|
||||
}
|
||||
67
packages/xrpl/src/models/transactions/MPTokenAuthorize.ts
Normal file
67
packages/xrpl/src/models/transactions/MPTokenAuthorize.ts
Normal file
@@ -0,0 +1,67 @@
|
||||
import {
|
||||
BaseTransaction,
|
||||
isString,
|
||||
validateBaseTransaction,
|
||||
validateRequiredField,
|
||||
Account,
|
||||
validateOptionalField,
|
||||
isAccount,
|
||||
GlobalFlags,
|
||||
} from './common'
|
||||
|
||||
/**
|
||||
* Transaction Flags for an MPTokenAuthorize Transaction.
|
||||
*
|
||||
* @category Transaction Flags
|
||||
*/
|
||||
export enum MPTokenAuthorizeFlags {
|
||||
/**
|
||||
* If set and transaction is submitted by a holder, it indicates that the holder no
|
||||
* longer wants to hold the MPToken, which will be deleted as a result. If the the holder's
|
||||
* MPToken has non-zero balance while trying to set this flag, the transaction will fail. On
|
||||
* the other hand, if set and transaction is submitted by an issuer, it would mean that the
|
||||
* issuer wants to unauthorize the holder (only applicable for allow-listing),
|
||||
* which would unset the lsfMPTAuthorized flag on the MPToken.
|
||||
*/
|
||||
tfMPTUnauthorize = 0x00000001,
|
||||
}
|
||||
|
||||
/**
|
||||
* Map of flags to boolean values representing {@link MPTokenAuthorize} transaction
|
||||
* flags.
|
||||
*
|
||||
* @category Transaction Flags
|
||||
*/
|
||||
export interface MPTokenAuthorizeFlagsInterface extends GlobalFlags {
|
||||
tfMPTUnauthorize?: boolean
|
||||
}
|
||||
|
||||
/**
|
||||
* The MPTokenAuthorize transaction is used to globally lock/unlock a MPTokenIssuance,
|
||||
* or lock/unlock an individual's MPToken.
|
||||
*/
|
||||
export interface MPTokenAuthorize extends BaseTransaction {
|
||||
TransactionType: 'MPTokenAuthorize'
|
||||
/**
|
||||
* Identifies the MPTokenIssuance
|
||||
*/
|
||||
MPTokenIssuanceID: string
|
||||
/**
|
||||
* An optional XRPL Address of an individual token holder balance to lock/unlock.
|
||||
* If omitted, this transaction will apply to all any accounts holding MPTs.
|
||||
*/
|
||||
Holder?: Account
|
||||
Flags?: number | MPTokenAuthorizeFlagsInterface
|
||||
}
|
||||
|
||||
/**
|
||||
* Verify the form and type of an MPTokenAuthorize at runtime.
|
||||
*
|
||||
* @param tx - An MPTokenAuthorize Transaction.
|
||||
* @throws When the MPTokenAuthorize is Malformed.
|
||||
*/
|
||||
export function validateMPTokenAuthorize(tx: Record<string, unknown>): void {
|
||||
validateBaseTransaction(tx)
|
||||
validateRequiredField(tx, 'MPTokenIssuanceID', isString)
|
||||
validateOptionalField(tx, 'Holder', isAccount)
|
||||
}
|
||||
179
packages/xrpl/src/models/transactions/MPTokenIssuanceCreate.ts
Normal file
179
packages/xrpl/src/models/transactions/MPTokenIssuanceCreate.ts
Normal file
@@ -0,0 +1,179 @@
|
||||
import { ValidationError } from '../../errors'
|
||||
import { isHex, INTEGER_SANITY_CHECK, isFlagEnabled } from '../utils'
|
||||
|
||||
import {
|
||||
BaseTransaction,
|
||||
GlobalFlags,
|
||||
validateBaseTransaction,
|
||||
validateOptionalField,
|
||||
isString,
|
||||
isNumber,
|
||||
} from './common'
|
||||
import type { TransactionMetadataBase } from './metadata'
|
||||
|
||||
// 2^63 - 1
|
||||
const MAX_AMT = '9223372036854775807'
|
||||
const MAX_TRANSFER_FEE = 50000
|
||||
|
||||
/**
|
||||
* Transaction Flags for an MPTokenIssuanceCreate Transaction.
|
||||
*
|
||||
* @category Transaction Flags
|
||||
*/
|
||||
export enum MPTokenIssuanceCreateFlags {
|
||||
/**
|
||||
* If set, indicates that the MPT can be locked both individually and globally.
|
||||
* If not set, the MPT cannot be locked in any way.
|
||||
*/
|
||||
tfMPTCanLock = 0x00000002,
|
||||
/**
|
||||
* If set, indicates that individual holders must be authorized.
|
||||
* This enables issuers to limit who can hold their assets.
|
||||
*/
|
||||
tfMPTRequireAuth = 0x00000004,
|
||||
/**
|
||||
* If set, indicates that individual holders can place their balances into an escrow.
|
||||
*/
|
||||
tfMPTCanEscrow = 0x00000008,
|
||||
/**
|
||||
* If set, indicates that individual holders can trade their balances
|
||||
* using the XRP Ledger DEX or AMM.
|
||||
*/
|
||||
tfMPTCanTrade = 0x00000010,
|
||||
/**
|
||||
* If set, indicates that tokens may be transferred to other accounts
|
||||
* that are not the issuer.
|
||||
*/
|
||||
tfMPTCanTransfer = 0x00000020,
|
||||
/**
|
||||
* If set, indicates that the issuer may use the Clawback transaction
|
||||
* to clawback value from individual holders.
|
||||
*/
|
||||
tfMPTCanClawback = 0x00000040,
|
||||
}
|
||||
|
||||
/**
|
||||
* Map of flags to boolean values representing {@link MPTokenIssuanceCreate} transaction
|
||||
* flags.
|
||||
*
|
||||
* @category Transaction Flags
|
||||
*/
|
||||
export interface MPTokenIssuanceCreateFlagsInterface extends GlobalFlags {
|
||||
tfMPTCanLock?: boolean
|
||||
tfMPTRequireAuth?: boolean
|
||||
tfMPTCanEscrow?: boolean
|
||||
tfMPTCanTrade?: boolean
|
||||
tfMPTCanTransfer?: boolean
|
||||
tfMPTCanClawback?: boolean
|
||||
}
|
||||
|
||||
/**
|
||||
* The MPTokenIssuanceCreate transaction creates a MPTokenIssuance object
|
||||
* and adds it to the relevant directory node of the creator account.
|
||||
* This transaction is the only opportunity an issuer has to specify any token fields
|
||||
* that are defined as immutable (e.g., MPT Flags). If the transaction is successful,
|
||||
* the newly created token will be owned by the account (the creator account) which
|
||||
* executed the transaction.
|
||||
*/
|
||||
export interface MPTokenIssuanceCreate extends BaseTransaction {
|
||||
TransactionType: 'MPTokenIssuanceCreate'
|
||||
/**
|
||||
* An asset scale is the difference, in orders of magnitude, between a standard unit and
|
||||
* a corresponding fractional unit. More formally, the asset scale is a non-negative integer
|
||||
* (0, 1, 2, …) such that one standard unit equals 10^(-scale) of a corresponding
|
||||
* fractional unit. If the fractional unit equals the standard unit, then the asset scale is 0.
|
||||
* Note that this value is optional, and will default to 0 if not supplied.
|
||||
*/
|
||||
AssetScale?: number
|
||||
/**
|
||||
* Specifies the maximum asset amount of this token that should ever be issued.
|
||||
* It is a non-negative integer string that can store a range of up to 63 bits. If not set, the max
|
||||
* amount will default to the largest unsigned 63-bit integer (0x7FFFFFFFFFFFFFFF or 9223372036854775807)
|
||||
*
|
||||
* Example:
|
||||
* ```
|
||||
* MaximumAmount: '9223372036854775807'
|
||||
* ```
|
||||
*/
|
||||
MaximumAmount?: string
|
||||
/**
|
||||
* Specifies the fee to charged by the issuer for secondary sales of the Token,
|
||||
* if such sales are allowed. Valid values for this field are between 0 and 50,000 inclusive,
|
||||
* allowing transfer rates of between 0.000% and 50.000% in increments of 0.001.
|
||||
* The field must NOT be present if the `tfMPTCanTransfer` flag is not set.
|
||||
*/
|
||||
TransferFee?: number
|
||||
/**
|
||||
* Arbitrary metadata about this issuance, in hex format.
|
||||
*/
|
||||
MPTokenMetadata?: string | null
|
||||
Flags?: number | MPTokenIssuanceCreateFlagsInterface
|
||||
}
|
||||
|
||||
export interface MPTokenIssuanceCreateMetadata extends TransactionMetadataBase {
|
||||
mpt_issuance_id?: string
|
||||
}
|
||||
|
||||
/* eslint-disable max-lines-per-function -- Not needed to reduce function */
|
||||
/**
|
||||
* Verify the form and type of an MPTokenIssuanceCreate at runtime.
|
||||
*
|
||||
* @param tx - An MPTokenIssuanceCreate Transaction.
|
||||
* @throws When the MPTokenIssuanceCreate is Malformed.
|
||||
*/
|
||||
export function validateMPTokenIssuanceCreate(
|
||||
tx: Record<string, unknown>,
|
||||
): void {
|
||||
validateBaseTransaction(tx)
|
||||
validateOptionalField(tx, 'MaximumAmount', isString)
|
||||
validateOptionalField(tx, 'MPTokenMetadata', isString)
|
||||
validateOptionalField(tx, 'TransferFee', isNumber)
|
||||
validateOptionalField(tx, 'AssetScale', isNumber)
|
||||
|
||||
if (typeof tx.MPTokenMetadata === 'string' && tx.MPTokenMetadata === '') {
|
||||
throw new ValidationError(
|
||||
'MPTokenIssuanceCreate: MPTokenMetadata must not be empty string',
|
||||
)
|
||||
}
|
||||
|
||||
if (typeof tx.MPTokenMetadata === 'string' && !isHex(tx.MPTokenMetadata)) {
|
||||
throw new ValidationError(
|
||||
'MPTokenIssuanceCreate: MPTokenMetadata must be in hex format',
|
||||
)
|
||||
}
|
||||
|
||||
if (typeof tx.MaximumAmount === 'string') {
|
||||
if (!INTEGER_SANITY_CHECK.exec(tx.MaximumAmount)) {
|
||||
throw new ValidationError('MPTokenIssuanceCreate: Invalid MaximumAmount')
|
||||
} else if (
|
||||
BigInt(tx.MaximumAmount) > BigInt(MAX_AMT) ||
|
||||
BigInt(tx.MaximumAmount) < BigInt(`0`)
|
||||
) {
|
||||
throw new ValidationError(
|
||||
'MPTokenIssuanceCreate: MaximumAmount out of range',
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
if (typeof tx.TransferFee === 'number') {
|
||||
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- Not necessary
|
||||
const flags = tx.Flags as number | MPTokenIssuanceCreateFlagsInterface
|
||||
const isTfMPTCanTransfer =
|
||||
typeof flags === 'number'
|
||||
? isFlagEnabled(flags, MPTokenIssuanceCreateFlags.tfMPTCanTransfer)
|
||||
: flags.tfMPTCanTransfer ?? false
|
||||
|
||||
if (tx.TransferFee < 0 || tx.TransferFee > MAX_TRANSFER_FEE) {
|
||||
throw new ValidationError(
|
||||
`MPTokenIssuanceCreate: TransferFee must be between 0 and ${MAX_TRANSFER_FEE}`,
|
||||
)
|
||||
}
|
||||
|
||||
if (tx.TransferFee && !isTfMPTCanTransfer) {
|
||||
throw new ValidationError(
|
||||
'MPTokenIssuanceCreate: TransferFee cannot be provided without enabling tfMPTCanTransfer flag',
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
/* eslint-enable max-lines-per-function */
|
||||
@@ -0,0 +1,34 @@
|
||||
import {
|
||||
BaseTransaction,
|
||||
isString,
|
||||
validateBaseTransaction,
|
||||
validateRequiredField,
|
||||
} from './common'
|
||||
|
||||
/**
|
||||
* The MPTokenIssuanceDestroy transaction is used to remove an MPTokenIssuance object
|
||||
* from the directory node in which it is being held, effectively removing the token
|
||||
* from the ledger. If this operation succeeds, the corresponding
|
||||
* MPTokenIssuance is removed and the owner’s reserve requirement is reduced by one.
|
||||
* This operation must fail if there are any holders who have non-zero balances.
|
||||
*/
|
||||
export interface MPTokenIssuanceDestroy extends BaseTransaction {
|
||||
TransactionType: 'MPTokenIssuanceDestroy'
|
||||
/**
|
||||
* Identifies the MPTokenIssuance object to be removed by the transaction.
|
||||
*/
|
||||
MPTokenIssuanceID: string
|
||||
}
|
||||
|
||||
/**
|
||||
* Verify the form and type of an MPTokenIssuanceDestroy at runtime.
|
||||
*
|
||||
* @param tx - An MPTokenIssuanceDestroy Transaction.
|
||||
* @throws When the MPTokenIssuanceDestroy is Malformed.
|
||||
*/
|
||||
export function validateMPTokenIssuanceDestroy(
|
||||
tx: Record<string, unknown>,
|
||||
): void {
|
||||
validateBaseTransaction(tx)
|
||||
validateRequiredField(tx, 'MPTokenIssuanceID', isString)
|
||||
}
|
||||
86
packages/xrpl/src/models/transactions/MPTokenIssuanceSet.ts
Normal file
86
packages/xrpl/src/models/transactions/MPTokenIssuanceSet.ts
Normal file
@@ -0,0 +1,86 @@
|
||||
import { ValidationError } from '../../errors'
|
||||
import { isFlagEnabled } from '../utils'
|
||||
|
||||
import {
|
||||
BaseTransaction,
|
||||
isString,
|
||||
validateBaseTransaction,
|
||||
validateRequiredField,
|
||||
Account,
|
||||
validateOptionalField,
|
||||
isAccount,
|
||||
GlobalFlags,
|
||||
} from './common'
|
||||
|
||||
/**
|
||||
* Transaction Flags for an MPTokenIssuanceSet Transaction.
|
||||
*
|
||||
* @category Transaction Flags
|
||||
*/
|
||||
export enum MPTokenIssuanceSetFlags {
|
||||
/**
|
||||
* If set, indicates that issuer locks the MPT
|
||||
*/
|
||||
tfMPTLock = 0x00000001,
|
||||
/**
|
||||
* If set, indicates that issuer unlocks the MPT
|
||||
*/
|
||||
tfMPTUnlock = 0x00000002,
|
||||
}
|
||||
|
||||
/**
|
||||
* Map of flags to boolean values representing {@link MPTokenIssuanceSet} transaction
|
||||
* flags.
|
||||
*
|
||||
* @category Transaction Flags
|
||||
*/
|
||||
export interface MPTokenIssuanceSetFlagsInterface extends GlobalFlags {
|
||||
tfMPTLock?: boolean
|
||||
tfMPTUnlock?: boolean
|
||||
}
|
||||
|
||||
/**
|
||||
* The MPTokenIssuanceSet transaction is used to globally lock/unlock a MPTokenIssuance,
|
||||
* or lock/unlock an individual's MPToken.
|
||||
*/
|
||||
export interface MPTokenIssuanceSet extends BaseTransaction {
|
||||
TransactionType: 'MPTokenIssuanceSet'
|
||||
/**
|
||||
* Identifies the MPTokenIssuance
|
||||
*/
|
||||
MPTokenIssuanceID: string
|
||||
/**
|
||||
* An optional XRPL Address of an individual token holder balance to lock/unlock.
|
||||
* If omitted, this transaction will apply to all any accounts holding MPTs.
|
||||
*/
|
||||
Holder?: Account
|
||||
Flags?: number | MPTokenIssuanceSetFlagsInterface
|
||||
}
|
||||
|
||||
/**
|
||||
* Verify the form and type of an MPTokenIssuanceSet at runtime.
|
||||
*
|
||||
* @param tx - An MPTokenIssuanceSet Transaction.
|
||||
* @throws When the MPTokenIssuanceSet is Malformed.
|
||||
*/
|
||||
export function validateMPTokenIssuanceSet(tx: Record<string, unknown>): void {
|
||||
validateBaseTransaction(tx)
|
||||
validateRequiredField(tx, 'MPTokenIssuanceID', isString)
|
||||
validateOptionalField(tx, 'Holder', isAccount)
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- Not necessary
|
||||
const flags = tx.Flags as number | MPTokenIssuanceSetFlagsInterface
|
||||
const isTfMPTLock =
|
||||
typeof flags === 'number'
|
||||
? isFlagEnabled(flags, MPTokenIssuanceSetFlags.tfMPTLock)
|
||||
: flags.tfMPTLock ?? false
|
||||
|
||||
const isTfMPTUnlock =
|
||||
typeof flags === 'number'
|
||||
? isFlagEnabled(flags, MPTokenIssuanceSetFlags.tfMPTUnlock)
|
||||
: flags.tfMPTUnlock ?? false
|
||||
|
||||
if (isTfMPTLock && isTfMPTUnlock) {
|
||||
throw new ValidationError('MPTokenIssuanceSet: flag conflict')
|
||||
}
|
||||
}
|
||||
@@ -4,6 +4,7 @@ import {
|
||||
isAccount,
|
||||
isNumber,
|
||||
validateBaseTransaction,
|
||||
validateCredentialsList,
|
||||
validateOptionalField,
|
||||
validateRequiredField,
|
||||
} from './common'
|
||||
@@ -28,6 +29,12 @@ export interface AccountDelete extends BaseTransaction {
|
||||
* information for the recipient of the deleted account's leftover XRP.
|
||||
*/
|
||||
DestinationTag?: number
|
||||
/**
|
||||
* Credentials associated with sender of this transaction. The credentials included
|
||||
* must not be expired. The list must not be empty when specified and cannot contain
|
||||
* more than 8 credentials.
|
||||
*/
|
||||
CredentialIDs?: string[]
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -41,4 +48,11 @@ export function validateAccountDelete(tx: Record<string, unknown>): void {
|
||||
|
||||
validateRequiredField(tx, 'Destination', isAccount)
|
||||
validateOptionalField(tx, 'DestinationTag', isNumber)
|
||||
|
||||
validateCredentialsList(
|
||||
tx.CredentialIDs,
|
||||
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- known from base check
|
||||
tx.TransactionType as string,
|
||||
true,
|
||||
)
|
||||
}
|
||||
|
||||
@@ -1,10 +1,13 @@
|
||||
import { ValidationError } from '../../errors'
|
||||
import { IssuedCurrencyAmount } from '../common'
|
||||
import { IssuedCurrencyAmount, MPTAmount } from '../common'
|
||||
|
||||
import {
|
||||
BaseTransaction,
|
||||
validateBaseTransaction,
|
||||
isIssuedCurrency,
|
||||
isMPTAmount,
|
||||
isAccount,
|
||||
validateOptionalField,
|
||||
} from './common'
|
||||
|
||||
/**
|
||||
@@ -15,15 +18,20 @@ export interface Clawback extends BaseTransaction {
|
||||
TransactionType: 'Clawback'
|
||||
/**
|
||||
* Indicates the AccountID that submitted this transaction. The account MUST
|
||||
* be the issuer of the currency.
|
||||
* be the issuer of the currency or MPT.
|
||||
*/
|
||||
Account: string
|
||||
/**
|
||||
* The amount of currency to deliver, and it must be non-XRP. The nested field
|
||||
* names MUST be lower-case. The `issuer` field MUST be the holder's address,
|
||||
* The amount of currency or MPT to clawback, and it must be non-XRP. The nested field
|
||||
* names MUST be lower-case. If the amount is IOU, the `issuer` field MUST be the holder's address,
|
||||
* whom to be clawed back.
|
||||
*/
|
||||
Amount: IssuedCurrencyAmount
|
||||
Amount: IssuedCurrencyAmount | MPTAmount
|
||||
/**
|
||||
* Indicates the AccountID that the issuer wants to clawback. This field is only valid for clawing back
|
||||
* MPTs.
|
||||
*/
|
||||
Holder?: string
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -34,16 +42,29 @@ export interface Clawback extends BaseTransaction {
|
||||
*/
|
||||
export function validateClawback(tx: Record<string, unknown>): void {
|
||||
validateBaseTransaction(tx)
|
||||
validateOptionalField(tx, 'Holder', isAccount)
|
||||
|
||||
if (tx.Amount == null) {
|
||||
throw new ValidationError('Clawback: missing field Amount')
|
||||
}
|
||||
|
||||
if (!isIssuedCurrency(tx.Amount)) {
|
||||
if (!isIssuedCurrency(tx.Amount) && !isMPTAmount(tx.Amount)) {
|
||||
throw new ValidationError('Clawback: invalid Amount')
|
||||
}
|
||||
|
||||
if (isIssuedCurrency(tx.Amount) && tx.Account === tx.Amount.issuer) {
|
||||
throw new ValidationError('Clawback: invalid holder Account')
|
||||
}
|
||||
|
||||
if (isMPTAmount(tx.Amount) && tx.Account === tx.Holder) {
|
||||
throw new ValidationError('Clawback: invalid holder Account')
|
||||
}
|
||||
|
||||
if (isIssuedCurrency(tx.Amount) && tx.Holder) {
|
||||
throw new ValidationError('Clawback: cannot have Holder for currency')
|
||||
}
|
||||
|
||||
if (isMPTAmount(tx.Amount) && !tx.Holder) {
|
||||
throw new ValidationError('Clawback: missing Holder')
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,18 +1,25 @@
|
||||
/* eslint-disable max-lines -- common utility file */
|
||||
import { HEX_REGEX } from '@xrplf/isomorphic/utils'
|
||||
import { isValidClassicAddress, isValidXAddress } from 'ripple-address-codec'
|
||||
import { TRANSACTION_TYPES } from 'ripple-binary-codec'
|
||||
|
||||
import { ValidationError } from '../../errors'
|
||||
import {
|
||||
Amount,
|
||||
AuthorizeCredential,
|
||||
Currency,
|
||||
IssuedCurrencyAmount,
|
||||
Memo,
|
||||
Signer,
|
||||
XChainBridge,
|
||||
MPTAmount,
|
||||
} from '../common'
|
||||
import { onlyHasFields } from '../utils'
|
||||
|
||||
const MEMO_SIZE = 3
|
||||
const MAX_CREDENTIALS_LIST_LENGTH = 8
|
||||
const MAX_CREDENTIAL_BYTE_LENGTH = 64
|
||||
const MAX_CREDENTIAL_TYPE_LENGTH = MAX_CREDENTIAL_BYTE_LENGTH * 2
|
||||
|
||||
function isMemo(obj: { Memo?: unknown }): boolean {
|
||||
if (obj.Memo == null) {
|
||||
@@ -59,6 +66,8 @@ const XRP_CURRENCY_SIZE = 1
|
||||
const ISSUE_SIZE = 2
|
||||
const ISSUED_CURRENCY_SIZE = 3
|
||||
const XCHAIN_BRIDGE_SIZE = 4
|
||||
const MPTOKEN_SIZE = 2
|
||||
const AUTHORIZE_CREDENTIAL_SIZE = 1
|
||||
|
||||
function isRecord(value: unknown): value is Record<string, unknown> {
|
||||
return value !== null && typeof value === 'object'
|
||||
@@ -119,6 +128,37 @@ export function isIssuedCurrency(
|
||||
)
|
||||
}
|
||||
|
||||
/**
|
||||
* Verify the form and type of an AuthorizeCredential at runtime
|
||||
*
|
||||
* @param input - The input to check the form and type of
|
||||
* @returns Whether the AuthorizeCredential is properly formed
|
||||
*/
|
||||
function isAuthorizeCredential(input: unknown): input is AuthorizeCredential {
|
||||
return (
|
||||
isRecord(input) &&
|
||||
isRecord(input.Credential) &&
|
||||
Object.keys(input).length === AUTHORIZE_CREDENTIAL_SIZE &&
|
||||
typeof input.Credential.CredentialType === 'string' &&
|
||||
typeof input.Credential.Issuer === 'string'
|
||||
)
|
||||
}
|
||||
|
||||
/**
|
||||
* Verify the form and type of an MPT at runtime.
|
||||
*
|
||||
* @param input - The input to check the form and type of.
|
||||
* @returns Whether the MPTAmount is properly formed.
|
||||
*/
|
||||
export function isMPTAmount(input: unknown): input is MPTAmount {
|
||||
return (
|
||||
isRecord(input) &&
|
||||
Object.keys(input).length === MPTOKEN_SIZE &&
|
||||
typeof input.value === 'string' &&
|
||||
typeof input.mpt_issuance_id === 'string'
|
||||
)
|
||||
}
|
||||
|
||||
/**
|
||||
* Must be a valid account address
|
||||
*/
|
||||
@@ -144,7 +184,11 @@ export function isAccount(account: unknown): account is Account {
|
||||
* @returns Whether the Amount is properly formed.
|
||||
*/
|
||||
export function isAmount(amount: unknown): amount is Amount {
|
||||
return typeof amount === 'string' || isIssuedCurrency(amount)
|
||||
return (
|
||||
typeof amount === 'string' ||
|
||||
isIssuedCurrency(amount) ||
|
||||
isMPTAmount(amount)
|
||||
)
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -366,3 +410,97 @@ export function parseAmountValue(amount: unknown): number {
|
||||
}
|
||||
return parseFloat(amount.value)
|
||||
}
|
||||
|
||||
/**
|
||||
* Verify the form and type of a CredentialType at runtime.
|
||||
*
|
||||
* @param tx A CredentialType Transaction.
|
||||
* @throws when the CredentialType is malformed.
|
||||
*/
|
||||
export function validateCredentialType(tx: Record<string, unknown>): void {
|
||||
if (typeof tx.TransactionType !== 'string') {
|
||||
throw new ValidationError('Invalid TransactionType')
|
||||
}
|
||||
if (tx.CredentialType === undefined) {
|
||||
throw new ValidationError(
|
||||
`${tx.TransactionType}: missing field CredentialType`,
|
||||
)
|
||||
}
|
||||
|
||||
if (!isString(tx.CredentialType)) {
|
||||
throw new ValidationError(
|
||||
`${tx.TransactionType}: CredentialType must be a string`,
|
||||
)
|
||||
}
|
||||
if (tx.CredentialType.length === 0) {
|
||||
throw new ValidationError(
|
||||
`${tx.TransactionType}: CredentialType cannot be an empty string`,
|
||||
)
|
||||
} else if (tx.CredentialType.length > MAX_CREDENTIAL_TYPE_LENGTH) {
|
||||
throw new ValidationError(
|
||||
`${tx.TransactionType}: CredentialType length cannot be > ${MAX_CREDENTIAL_TYPE_LENGTH}`,
|
||||
)
|
||||
}
|
||||
|
||||
if (!HEX_REGEX.test(tx.CredentialType)) {
|
||||
throw new ValidationError(
|
||||
`${tx.TransactionType}: CredentialType must be encoded in hex`,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Check a CredentialAuthorize array for parameter errors
|
||||
*
|
||||
* @param credentials An array of credential IDs to check for errors
|
||||
* @param transactionType The transaction type to include in error messages
|
||||
* @param isStringID Toggle for if array contains IDs instead of AuthorizeCredential objects
|
||||
* @throws Validation Error if the formatting is incorrect
|
||||
*/
|
||||
// eslint-disable-next-line max-lines-per-function -- separating logic further will add unnecessary complexity
|
||||
export function validateCredentialsList(
|
||||
credentials: unknown,
|
||||
transactionType: string,
|
||||
isStringID: boolean,
|
||||
): void {
|
||||
if (credentials == null) {
|
||||
return
|
||||
}
|
||||
if (!Array.isArray(credentials)) {
|
||||
throw new ValidationError(
|
||||
`${transactionType}: Credentials must be an array`,
|
||||
)
|
||||
}
|
||||
if (credentials.length > MAX_CREDENTIALS_LIST_LENGTH) {
|
||||
throw new ValidationError(
|
||||
`${transactionType}: Credentials length cannot exceed ${MAX_CREDENTIALS_LIST_LENGTH} elements`,
|
||||
)
|
||||
} else if (credentials.length === 0) {
|
||||
throw new ValidationError(
|
||||
`${transactionType}: Credentials cannot be an empty array`,
|
||||
)
|
||||
}
|
||||
credentials.forEach((credential) => {
|
||||
if (isStringID) {
|
||||
if (!isString(credential)) {
|
||||
throw new ValidationError(
|
||||
`${transactionType}: Invalid Credentials ID list format`,
|
||||
)
|
||||
}
|
||||
} else if (!isAuthorizeCredential(credential)) {
|
||||
throw new ValidationError(
|
||||
`${transactionType}: Invalid Credentials format`,
|
||||
)
|
||||
}
|
||||
})
|
||||
if (containsDuplicates(credentials)) {
|
||||
throw new ValidationError(
|
||||
`${transactionType}: Credentials cannot contain duplicate elements`,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
function containsDuplicates(objectList: object[]): boolean {
|
||||
const objSet = new Set(objectList.map((obj) => JSON.stringify(obj)))
|
||||
return objSet.size !== objectList.length
|
||||
}
|
||||
|
||||
@@ -1,6 +1,11 @@
|
||||
import { ValidationError } from '../../errors'
|
||||
import { AuthorizeCredential } from '../common'
|
||||
|
||||
import { BaseTransaction, validateBaseTransaction } from './common'
|
||||
import {
|
||||
BaseTransaction,
|
||||
validateBaseTransaction,
|
||||
validateCredentialsList,
|
||||
} from './common'
|
||||
|
||||
/**
|
||||
* A DepositPreauth transaction gives another account pre-approval to deliver
|
||||
@@ -18,6 +23,16 @@ export interface DepositPreauth extends BaseTransaction {
|
||||
* revoked.
|
||||
*/
|
||||
Unauthorize?: string
|
||||
|
||||
/**
|
||||
* The credential(s) to preauthorize.
|
||||
*/
|
||||
AuthorizeCredentials?: AuthorizeCredential[]
|
||||
|
||||
/**
|
||||
* The credential(s) whose preauthorization should be revoked.
|
||||
*/
|
||||
UnauthorizeCredentials?: AuthorizeCredential[]
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -29,17 +44,7 @@ export interface DepositPreauth extends BaseTransaction {
|
||||
export function validateDepositPreauth(tx: Record<string, unknown>): void {
|
||||
validateBaseTransaction(tx)
|
||||
|
||||
if (tx.Authorize !== undefined && tx.Unauthorize !== undefined) {
|
||||
throw new ValidationError(
|
||||
"DepositPreauth: can't provide both Authorize and Unauthorize fields",
|
||||
)
|
||||
}
|
||||
|
||||
if (tx.Authorize === undefined && tx.Unauthorize === undefined) {
|
||||
throw new ValidationError(
|
||||
'DepositPreauth: must provide either Authorize or Unauthorize field',
|
||||
)
|
||||
}
|
||||
validateSingleAuthorizationFieldProvided(tx)
|
||||
|
||||
if (tx.Authorize !== undefined) {
|
||||
if (typeof tx.Authorize !== 'string') {
|
||||
@@ -51,9 +56,7 @@ export function validateDepositPreauth(tx: Record<string, unknown>): void {
|
||||
"DepositPreauth: Account can't preauthorize its own address",
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
if (tx.Unauthorize !== undefined) {
|
||||
} else if (tx.Unauthorize !== undefined) {
|
||||
if (typeof tx.Unauthorize !== 'string') {
|
||||
throw new ValidationError('DepositPreauth: Unauthorize must be a string')
|
||||
}
|
||||
@@ -63,5 +66,38 @@ export function validateDepositPreauth(tx: Record<string, unknown>): void {
|
||||
"DepositPreauth: Account can't unauthorize its own address",
|
||||
)
|
||||
}
|
||||
} else if (tx.AuthorizeCredentials !== undefined) {
|
||||
validateCredentialsList(
|
||||
tx.AuthorizeCredentials,
|
||||
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- confirmed in base transaction check
|
||||
tx.TransactionType as string,
|
||||
false,
|
||||
)
|
||||
} else if (tx.UnauthorizeCredentials !== undefined) {
|
||||
validateCredentialsList(
|
||||
tx.UnauthorizeCredentials,
|
||||
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- confirmed in base transaction check
|
||||
tx.TransactionType as string,
|
||||
false,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
// Boolean logic to ensure exactly one of 4 inputs was provided
|
||||
function validateSingleAuthorizationFieldProvided(
|
||||
tx: Record<string, unknown>,
|
||||
): void {
|
||||
const fields = [
|
||||
'Authorize',
|
||||
'Unauthorize',
|
||||
'AuthorizeCredentials',
|
||||
'UnauthorizeCredentials',
|
||||
]
|
||||
const countProvided = fields.filter((key) => tx[key] !== undefined).length
|
||||
|
||||
if (countProvided !== 1) {
|
||||
throw new ValidationError(
|
||||
'DepositPreauth: Requires exactly one field of the following: Authorize, Unauthorize, AuthorizeCredentials, UnauthorizeCredentials.',
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -5,6 +5,7 @@ import {
|
||||
BaseTransaction,
|
||||
isAccount,
|
||||
validateBaseTransaction,
|
||||
validateCredentialsList,
|
||||
validateRequiredField,
|
||||
} from './common'
|
||||
|
||||
@@ -32,6 +33,10 @@ export interface EscrowFinish extends BaseTransaction {
|
||||
* the held payment's Condition.
|
||||
*/
|
||||
Fulfillment?: string
|
||||
/** Credentials associated with the sender of this transaction.
|
||||
* The credentials included must not be expired.
|
||||
*/
|
||||
CredentialIDs?: string[]
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -45,6 +50,13 @@ export function validateEscrowFinish(tx: Record<string, unknown>): void {
|
||||
|
||||
validateRequiredField(tx, 'Owner', isAccount)
|
||||
|
||||
validateCredentialsList(
|
||||
tx.CredentialIDs,
|
||||
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- known from base check
|
||||
tx.TransactionType as string,
|
||||
true,
|
||||
)
|
||||
|
||||
if (tx.OfferSequence == null) {
|
||||
throw new ValidationError('EscrowFinish: missing field OfferSequence')
|
||||
}
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
export { BaseTransaction } from './common'
|
||||
export { BaseTransaction, isMPTAmount } from './common'
|
||||
export {
|
||||
validate,
|
||||
PseudoTransaction,
|
||||
@@ -32,6 +32,9 @@ export { CheckCancel } from './checkCancel'
|
||||
export { CheckCash } from './checkCash'
|
||||
export { CheckCreate } from './checkCreate'
|
||||
export { Clawback } from './clawback'
|
||||
export { CredentialAccept } from './CredentialAccept'
|
||||
export { CredentialCreate } from './CredentialCreate'
|
||||
export { CredentialDelete } from './CredentialDelete'
|
||||
export { DIDDelete } from './DIDDelete'
|
||||
export { DIDSet } from './DIDSet'
|
||||
export { DepositPreauth } from './depositPreauth'
|
||||
@@ -39,6 +42,22 @@ export { EscrowCancel } from './escrowCancel'
|
||||
export { EscrowCreate } from './escrowCreate'
|
||||
export { EscrowFinish } from './escrowFinish'
|
||||
export { EnableAmendment, EnableAmendmentFlags } from './enableAmendment'
|
||||
export {
|
||||
MPTokenAuthorize,
|
||||
MPTokenAuthorizeFlags,
|
||||
MPTokenAuthorizeFlagsInterface,
|
||||
} from './MPTokenAuthorize'
|
||||
export {
|
||||
MPTokenIssuanceCreate,
|
||||
MPTokenIssuanceCreateFlags,
|
||||
MPTokenIssuanceCreateFlagsInterface,
|
||||
} from './MPTokenIssuanceCreate'
|
||||
export { MPTokenIssuanceDestroy } from './MPTokenIssuanceDestroy'
|
||||
export {
|
||||
MPTokenIssuanceSet,
|
||||
MPTokenIssuanceSetFlags,
|
||||
MPTokenIssuanceSetFlagsInterface,
|
||||
} from './MPTokenIssuanceSet'
|
||||
export { NFTokenAcceptOffer } from './NFTokenAcceptOffer'
|
||||
export { NFTokenBurn } from './NFTokenBurn'
|
||||
export { NFTokenCancelOffer } from './NFTokenCancelOffer'
|
||||
|
||||
@@ -1,6 +1,10 @@
|
||||
import { Amount } from '../common'
|
||||
import { Amount, MPTAmount } from '../common'
|
||||
|
||||
import { BaseTransaction } from './common'
|
||||
import {
|
||||
MPTokenIssuanceCreate,
|
||||
MPTokenIssuanceCreateMetadata,
|
||||
} from './MPTokenIssuanceCreate'
|
||||
import {
|
||||
NFTokenAcceptOffer,
|
||||
NFTokenAcceptOfferMetadata,
|
||||
@@ -79,9 +83,9 @@ export function isDeletedNode(node: Node): node is DeletedNode {
|
||||
|
||||
export interface TransactionMetadataBase {
|
||||
AffectedNodes: Node[]
|
||||
DeliveredAmount?: Amount
|
||||
DeliveredAmount?: Amount | MPTAmount
|
||||
// "unavailable" possible for transactions before 2014-01-20
|
||||
delivered_amount?: Amount | 'unavailable'
|
||||
delivered_amount?: Amount | MPTAmount | 'unavailable'
|
||||
TransactionIndex: number
|
||||
TransactionResult: string
|
||||
}
|
||||
@@ -97,4 +101,6 @@ export type TransactionMetadata<T extends BaseTransaction = Transaction> =
|
||||
? NFTokenAcceptOfferMetadata
|
||||
: T extends NFTokenCancelOffer
|
||||
? NFTokenCancelOfferMetadata
|
||||
: T extends MPTokenIssuanceCreate
|
||||
? MPTokenIssuanceCreateMetadata
|
||||
: TransactionMetadataBase
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import { ValidationError } from '../../errors'
|
||||
import { Amount, Path } from '../common'
|
||||
import { Amount, Path, MPTAmount } from '../common'
|
||||
import { isFlagEnabled } from '../utils'
|
||||
|
||||
import {
|
||||
@@ -12,6 +12,7 @@ import {
|
||||
validateOptionalField,
|
||||
isNumber,
|
||||
Account,
|
||||
validateCredentialsList,
|
||||
} from './common'
|
||||
import type { TransactionMetadataBase } from './metadata'
|
||||
|
||||
@@ -116,7 +117,7 @@ export interface Payment extends BaseTransaction {
|
||||
* names MUST be lower-case. If the tfPartialPayment flag is set, deliver up
|
||||
* to this amount instead.
|
||||
*/
|
||||
Amount: Amount
|
||||
Amount: Amount | MPTAmount
|
||||
/** The unique address of the account receiving the payment. */
|
||||
Destination: Account
|
||||
/**
|
||||
@@ -142,19 +143,24 @@ export interface Payment extends BaseTransaction {
|
||||
* cross-currency/cross-issue payments. Must be omitted for XRP-to-XRP
|
||||
* Payments.
|
||||
*/
|
||||
SendMax?: Amount
|
||||
SendMax?: Amount | MPTAmount
|
||||
/**
|
||||
* Minimum amount of destination currency this transaction should deliver.
|
||||
* Only valid if this is a partial payment. For non-XRP amounts, the nested
|
||||
* field names are lower-case.
|
||||
*/
|
||||
DeliverMin?: Amount
|
||||
DeliverMin?: Amount | MPTAmount
|
||||
/**
|
||||
* Credentials associated with the sender of this transaction.
|
||||
* The credentials included must not be expired.
|
||||
*/
|
||||
CredentialIDs?: string[]
|
||||
Flags?: number | PaymentFlagsInterface
|
||||
}
|
||||
|
||||
export interface PaymentMetadata extends TransactionMetadataBase {
|
||||
DeliveredAmount?: Amount
|
||||
delivered_amount?: Amount | 'unavailable'
|
||||
DeliveredAmount?: Amount | MPTAmount
|
||||
delivered_amount?: Amount | MPTAmount | 'unavailable'
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -177,6 +183,13 @@ export function validatePayment(tx: Record<string, unknown>): void {
|
||||
validateRequiredField(tx, 'Destination', isAccount)
|
||||
validateOptionalField(tx, 'DestinationTag', isNumber)
|
||||
|
||||
validateCredentialsList(
|
||||
tx.CredentialIDs,
|
||||
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- known from base check
|
||||
tx.TransactionType as string,
|
||||
true,
|
||||
)
|
||||
|
||||
if (tx.InvoiceID !== undefined && typeof tx.InvoiceID !== 'string') {
|
||||
throw new ValidationError('PaymentTransaction: InvoiceID must be a string')
|
||||
}
|
||||
|
||||
@@ -1,6 +1,11 @@
|
||||
import { ValidationError } from '../../errors'
|
||||
|
||||
import { BaseTransaction, GlobalFlags, validateBaseTransaction } from './common'
|
||||
import {
|
||||
BaseTransaction,
|
||||
GlobalFlags,
|
||||
validateBaseTransaction,
|
||||
validateCredentialsList,
|
||||
} from './common'
|
||||
|
||||
/**
|
||||
* Enum representing values for PaymentChannelClaim transaction flags.
|
||||
@@ -127,6 +132,11 @@ export interface PaymentChannelClaim extends BaseTransaction {
|
||||
* field is omitted.
|
||||
*/
|
||||
PublicKey?: string
|
||||
/**
|
||||
* Credentials associated with the sender of this transaction.
|
||||
* The credentials included must not be expired.
|
||||
*/
|
||||
CredentialIDs?: string[]
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -138,6 +148,13 @@ export interface PaymentChannelClaim extends BaseTransaction {
|
||||
export function validatePaymentChannelClaim(tx: Record<string, unknown>): void {
|
||||
validateBaseTransaction(tx)
|
||||
|
||||
validateCredentialsList(
|
||||
tx.CredentialIDs,
|
||||
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- known from base check
|
||||
tx.TransactionType as string,
|
||||
true,
|
||||
)
|
||||
|
||||
if (tx.Channel === undefined) {
|
||||
throw new ValidationError('PaymentChannelClaim: missing Channel')
|
||||
}
|
||||
|
||||
@@ -19,6 +19,9 @@ import { CheckCash, validateCheckCash } from './checkCash'
|
||||
import { CheckCreate, validateCheckCreate } from './checkCreate'
|
||||
import { Clawback, validateClawback } from './clawback'
|
||||
import { BaseTransaction, isIssuedCurrency } from './common'
|
||||
import { CredentialAccept, validateCredentialAccept } from './CredentialAccept'
|
||||
import { CredentialCreate, validateCredentialCreate } from './CredentialCreate'
|
||||
import { CredentialDelete, validateCredentialDelete } from './CredentialDelete'
|
||||
import { DepositPreauth, validateDepositPreauth } from './depositPreauth'
|
||||
import { DIDDelete, validateDIDDelete } from './DIDDelete'
|
||||
import { DIDSet, validateDIDSet } from './DIDSet'
|
||||
@@ -27,6 +30,19 @@ import { EscrowCancel, validateEscrowCancel } from './escrowCancel'
|
||||
import { EscrowCreate, validateEscrowCreate } from './escrowCreate'
|
||||
import { EscrowFinish, validateEscrowFinish } from './escrowFinish'
|
||||
import { TransactionMetadata } from './metadata'
|
||||
import { MPTokenAuthorize, validateMPTokenAuthorize } from './MPTokenAuthorize'
|
||||
import {
|
||||
MPTokenIssuanceCreate,
|
||||
validateMPTokenIssuanceCreate,
|
||||
} from './MPTokenIssuanceCreate'
|
||||
import {
|
||||
MPTokenIssuanceDestroy,
|
||||
validateMPTokenIssuanceDestroy,
|
||||
} from './MPTokenIssuanceDestroy'
|
||||
import {
|
||||
MPTokenIssuanceSet,
|
||||
validateMPTokenIssuanceSet,
|
||||
} from './MPTokenIssuanceSet'
|
||||
import {
|
||||
NFTokenAcceptOffer,
|
||||
validateNFTokenAcceptOffer,
|
||||
@@ -109,12 +125,19 @@ export type SubmittableTransaction =
|
||||
| CheckCash
|
||||
| CheckCreate
|
||||
| Clawback
|
||||
| CredentialAccept
|
||||
| CredentialCreate
|
||||
| CredentialDelete
|
||||
| DIDDelete
|
||||
| DIDSet
|
||||
| DepositPreauth
|
||||
| EscrowCancel
|
||||
| EscrowCreate
|
||||
| EscrowFinish
|
||||
| MPTokenAuthorize
|
||||
| MPTokenIssuanceCreate
|
||||
| MPTokenIssuanceDestroy
|
||||
| MPTokenIssuanceSet
|
||||
| NFTokenAcceptOffer
|
||||
| NFTokenBurn
|
||||
| NFTokenCancelOffer
|
||||
@@ -282,6 +305,18 @@ export function validate(transaction: Record<string, unknown>): void {
|
||||
validateClawback(tx)
|
||||
break
|
||||
|
||||
case 'CredentialAccept':
|
||||
validateCredentialAccept(tx)
|
||||
break
|
||||
|
||||
case 'CredentialCreate':
|
||||
validateCredentialCreate(tx)
|
||||
break
|
||||
|
||||
case 'CredentialDelete':
|
||||
validateCredentialDelete(tx)
|
||||
break
|
||||
|
||||
case 'DIDDelete':
|
||||
validateDIDDelete(tx)
|
||||
break
|
||||
@@ -306,6 +341,22 @@ export function validate(transaction: Record<string, unknown>): void {
|
||||
validateEscrowFinish(tx)
|
||||
break
|
||||
|
||||
case 'MPTokenAuthorize':
|
||||
validateMPTokenAuthorize(tx)
|
||||
break
|
||||
|
||||
case 'MPTokenIssuanceCreate':
|
||||
validateMPTokenIssuanceCreate(tx)
|
||||
break
|
||||
|
||||
case 'MPTokenIssuanceDestroy':
|
||||
validateMPTokenIssuanceDestroy(tx)
|
||||
break
|
||||
|
||||
case 'MPTokenIssuanceSet':
|
||||
validateMPTokenIssuanceSet(tx)
|
||||
break
|
||||
|
||||
case 'NFTokenAcceptOffer':
|
||||
validateNFTokenAcceptOffer(tx)
|
||||
break
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
/* eslint-disable no-param-reassign -- param reassign is safe */
|
||||
/* eslint-disable no-bitwise -- flags require bitwise operations */
|
||||
|
||||
import { ValidationError } from '../../errors'
|
||||
import {
|
||||
AccountRootFlagsInterface,
|
||||
@@ -10,6 +9,9 @@ import { AccountSetTfFlags } from '../transactions/accountSet'
|
||||
import { AMMDepositFlags } from '../transactions/AMMDeposit'
|
||||
import { AMMWithdrawFlags } from '../transactions/AMMWithdraw'
|
||||
import { GlobalFlags } from '../transactions/common'
|
||||
import { MPTokenAuthorizeFlags } from '../transactions/MPTokenAuthorize'
|
||||
import { MPTokenIssuanceCreateFlags } from '../transactions/MPTokenIssuanceCreate'
|
||||
import { MPTokenIssuanceSetFlags } from '../transactions/MPTokenIssuanceSet'
|
||||
import { NFTokenCreateOfferFlags } from '../transactions/NFTokenCreateOffer'
|
||||
import { NFTokenMintFlags } from '../transactions/NFTokenMint'
|
||||
import { OfferCreateFlags } from '../transactions/offerCreate'
|
||||
@@ -49,6 +51,9 @@ const txToFlag = {
|
||||
AccountSet: AccountSetTfFlags,
|
||||
AMMDeposit: AMMDepositFlags,
|
||||
AMMWithdraw: AMMWithdrawFlags,
|
||||
MPTokenAuthorize: MPTokenAuthorizeFlags,
|
||||
MPTokenIssuanceCreate: MPTokenIssuanceCreateFlags,
|
||||
MPTokenIssuanceSet: MPTokenIssuanceSetFlags,
|
||||
NFTokenCreateOffer: NFTokenCreateOfferFlags,
|
||||
NFTokenMint: NFTokenMintFlags,
|
||||
OfferCreate: OfferCreateFlags,
|
||||
@@ -90,3 +95,30 @@ function convertFlagsToNumber(flags: GlobalFlags, flagEnum: any): number {
|
||||
return flags[flag] ? resultFlags | flagEnum[flag] : resultFlags
|
||||
}, 0)
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert a Transaction flags property into a map for easy interpretation.
|
||||
*
|
||||
* @param tx - A transaction to parse flags for.
|
||||
* @returns A map with all flags as booleans.
|
||||
*/
|
||||
export function parseTransactionFlags(tx: Transaction): object {
|
||||
setTransactionFlagsToNumber(tx)
|
||||
if (typeof tx.Flags !== 'number' || !tx.Flags || tx.Flags === 0) {
|
||||
return {}
|
||||
}
|
||||
|
||||
const flags = tx.Flags
|
||||
const flagsMap = {}
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment -- safe member access
|
||||
const flagEnum = txToFlag[tx.TransactionType]
|
||||
Object.values(flagEnum).forEach((flag) => {
|
||||
// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access -- safe member access
|
||||
if (typeof flag === 'string' && isFlagEnabled(flags, flagEnum[flag])) {
|
||||
flagsMap[flag] = true
|
||||
}
|
||||
})
|
||||
|
||||
return flagsMap
|
||||
}
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
const HEX_REGEX = /^[0-9A-Fa-f]+$/u
|
||||
export const INTEGER_SANITY_CHECK = /^[0-9]+$/u
|
||||
|
||||
/**
|
||||
* Verify that all fields of an object are in fields.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
import BigNumber from 'bignumber.js'
|
||||
import { xAddressToClassicAddress, isValidXAddress } from 'ripple-address-codec'
|
||||
|
||||
import type { Client } from '..'
|
||||
import { type Client } from '..'
|
||||
import { ValidationError, XrplError } from '../errors'
|
||||
import { AccountInfoRequest, AccountObjectsRequest } from '../models/methods'
|
||||
import { Transaction } from '../models/transactions'
|
||||
@@ -17,7 +17,6 @@ const LEDGER_OFFSET = 20
|
||||
// Mainnet and testnet are exceptions. More context: https://github.com/XRPLF/rippled/pull/4370
|
||||
const RESTRICTED_NETWORKS = 1024
|
||||
const REQUIRED_NETWORKID_VERSION = '1.11.0'
|
||||
const HOOKS_TESTNET_ID = 21338
|
||||
|
||||
/**
|
||||
* Determines whether the source rippled version is not later than the target rippled version.
|
||||
@@ -87,8 +86,7 @@ function isNotLaterRippledVersion(source: string, target: string): boolean {
|
||||
|
||||
/**
|
||||
* Determine if the transaction required a networkID to be valid.
|
||||
* Transaction needs networkID if later than restricted ID and either the network is hooks testnet
|
||||
* or build version is >= 1.11.0
|
||||
* Transaction needs networkID if later than restricted ID and build version is >= 1.11.0
|
||||
*
|
||||
* @param client -- The connected client.
|
||||
* @returns True if required networkID, false otherwise.
|
||||
@@ -99,12 +97,8 @@ export function txNeedsNetworkID(client: Client): boolean {
|
||||
client.networkID > RESTRICTED_NETWORKS
|
||||
) {
|
||||
if (
|
||||
(client.buildVersion &&
|
||||
isNotLaterRippledVersion(
|
||||
REQUIRED_NETWORKID_VERSION,
|
||||
client.buildVersion,
|
||||
)) ||
|
||||
client.networkID === HOOKS_TESTNET_ID
|
||||
client.buildVersion &&
|
||||
isNotLaterRippledVersion(REQUIRED_NETWORKID_VERSION, client.buildVersion)
|
||||
) {
|
||||
return true
|
||||
}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import BigNumber from 'bignumber.js'
|
||||
|
||||
import type { Client } from '..'
|
||||
import { type Client } from '..'
|
||||
import { XrplError } from '../errors'
|
||||
|
||||
const NUM_DECIMAL_PLACES = 6
|
||||
@@ -20,8 +20,11 @@ export default async function getFeeXrp(
|
||||
): Promise<string> {
|
||||
const feeCushion = cushion ?? client.feeCushion
|
||||
|
||||
const serverInfo = (await client.request({ command: 'server_info' })).result
|
||||
.info
|
||||
const serverInfo = (
|
||||
await client.request({
|
||||
command: 'server_info',
|
||||
})
|
||||
).result.info
|
||||
|
||||
const baseFee = serverInfo.validated_ledger?.base_fee_xrp
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@ import type {
|
||||
} from '..'
|
||||
import { ValidationError, XrplError } from '../errors'
|
||||
import { Signer } from '../models/common'
|
||||
import { TxRequest, TxResponse } from '../models/methods'
|
||||
import { TxResponse } from '../models/methods'
|
||||
import { BaseTransaction } from '../models/transactions/common'
|
||||
|
||||
/** Approximate time for a ledger to close, in milliseconds */
|
||||
@@ -129,7 +129,7 @@ export async function waitForFinalTransactionOutcome<
|
||||
}
|
||||
|
||||
const txResponse = await client
|
||||
.request<TxRequest, TxResponse<T>>({
|
||||
.request({
|
||||
command: 'tx',
|
||||
transaction: txHash,
|
||||
})
|
||||
@@ -153,7 +153,9 @@ export async function waitForFinalTransactionOutcome<
|
||||
})
|
||||
|
||||
if (txResponse.result.validated) {
|
||||
return txResponse
|
||||
// TODO: resolve the type assertion below
|
||||
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- we know that txResponse is of type TxResponse
|
||||
return txResponse as TxResponse<T>
|
||||
}
|
||||
|
||||
return waitForFinalTransactionOutcome<T>(
|
||||
|
||||
@@ -8,8 +8,9 @@ import BigNumber from 'bignumber.js'
|
||||
import { decode, encode } from 'ripple-binary-codec'
|
||||
|
||||
import { ValidationError, XrplError } from '../../errors'
|
||||
import type { Ledger } from '../../models/ledger'
|
||||
import { APIVersion } from '../../models'
|
||||
import { LedgerEntry } from '../../models/ledger'
|
||||
import { LedgerVersionMap } from '../../models/ledger/Ledger'
|
||||
import { Transaction, TransactionMetadata } from '../../models/transactions'
|
||||
|
||||
import HashPrefix from './HashPrefix'
|
||||
@@ -99,7 +100,9 @@ export function hashSignedTx(tx: Transaction | string): string {
|
||||
* @returns The hash of the ledger.
|
||||
* @category Utilities
|
||||
*/
|
||||
export function hashLedgerHeader(ledgerHeader: Ledger): string {
|
||||
export function hashLedgerHeader(
|
||||
ledgerHeader: LedgerVersionMap<APIVersion>,
|
||||
): string {
|
||||
const prefix = HashPrefix.LEDGER.toString(HEX).toUpperCase()
|
||||
|
||||
const ledger =
|
||||
@@ -158,7 +161,7 @@ export function hashStateTree(entries: LedgerEntry[]): string {
|
||||
}
|
||||
|
||||
function computeTransactionHash(
|
||||
ledger: Ledger,
|
||||
ledger: LedgerVersionMap<APIVersion>,
|
||||
options: HashLedgerHeaderOptions,
|
||||
): string {
|
||||
const { transaction_hash } = ledger
|
||||
@@ -188,7 +191,7 @@ function computeTransactionHash(
|
||||
}
|
||||
|
||||
function computeStateHash(
|
||||
ledger: Ledger,
|
||||
ledger: LedgerVersionMap<APIVersion>,
|
||||
options: HashLedgerHeaderOptions,
|
||||
): string {
|
||||
const { account_hash } = ledger
|
||||
@@ -222,7 +225,7 @@ function computeStateHash(
|
||||
* @category Utilities
|
||||
*/
|
||||
function hashLedger(
|
||||
ledger: Ledger,
|
||||
ledger: LedgerVersionMap<APIVersion>,
|
||||
options: {
|
||||
computeTreeHashes?: boolean
|
||||
} = {},
|
||||
|
||||
@@ -23,6 +23,7 @@ import {
|
||||
} from 'ripple-binary-codec'
|
||||
import { verify as verifyKeypairSignature } from 'ripple-keypairs'
|
||||
|
||||
import type { APIVersion } from '../models'
|
||||
import { LedgerEntry } from '../models/ledger'
|
||||
import { Response } from '../models/methods'
|
||||
import { PaymentChannelClaim } from '../models/transactions/paymentChannelClaim'
|
||||
@@ -157,7 +158,7 @@ function isValidAddress(address: string): boolean {
|
||||
* @returns Whether the response has more pages of data.
|
||||
* @category Utilities
|
||||
*/
|
||||
function hasNextPage(response: Response): boolean {
|
||||
function hasNextPage(response: Response<APIVersion>): boolean {
|
||||
// eslint-disable-next-line @typescript-eslint/dot-notation -- only checking if it exists
|
||||
return Boolean(response.result['marker'])
|
||||
}
|
||||
|
||||
@@ -7,6 +7,7 @@ import {
|
||||
Payment,
|
||||
Transaction,
|
||||
} from '../../src'
|
||||
import { ValidationError } from '../../src/errors'
|
||||
import rippled from '../fixtures/rippled'
|
||||
import {
|
||||
setupClient,
|
||||
@@ -19,10 +20,11 @@ const NetworkID = 1025
|
||||
const Fee = '10'
|
||||
const Sequence = 1432
|
||||
const LastLedgerSequence = 2908734
|
||||
const HOOKS_TESTNET_ID = 21338
|
||||
|
||||
describe('client.autofill', function () {
|
||||
let testContext: XrplTestContext
|
||||
const AMOUNT = '1234'
|
||||
let paymentTx: Payment
|
||||
|
||||
async function setupMockRippledVersionAndID(
|
||||
buildVersion: string,
|
||||
@@ -41,10 +43,68 @@ describe('client.autofill', function () {
|
||||
await testContext.client.connect()
|
||||
}
|
||||
|
||||
beforeEach(async () => {
|
||||
beforeAll(async () => {
|
||||
testContext = await setupClient()
|
||||
})
|
||||
afterEach(async () => teardownClient(testContext))
|
||||
afterAll(async () => teardownClient(testContext))
|
||||
|
||||
beforeEach(async () => {
|
||||
paymentTx = {
|
||||
TransactionType: 'Payment',
|
||||
Account: 'rUn84CUYbNjRoTQ6mSW7BVJPSVJNLb1QLo',
|
||||
Amount: AMOUNT,
|
||||
Destination: 'rfkE1aSy9G8Upk4JssnwBxhEv5p4mn2KTy',
|
||||
DestinationTag: 1,
|
||||
Fee: '12',
|
||||
Flags: 2147483648,
|
||||
LastLedgerSequence: 65953073,
|
||||
Sequence: 65923914,
|
||||
SigningPubKey:
|
||||
'02F9E33F16DF9507705EC954E3F94EB5F10D1FC4A354606DBE6297DBB1096FE654',
|
||||
TxnSignature:
|
||||
'3045022100E3FAE0EDEC3D6A8FF6D81BC9CF8288A61B7EEDE8071E90FF9314CB4621058D10022043545CF631706D700CEE65A1DB83EFDD185413808292D9D90F14D87D3DC2D8CB',
|
||||
InvoiceID:
|
||||
'6F1DFD1D0FE8A32E40E1F2C05CF1C15545BAB56B617F9C6C2D63A6B704BEF59B',
|
||||
Paths: [
|
||||
[{ currency: 'BTC', issuer: 'r9vbV3EHvXWjSkeQ6CAcYVPGeq7TuiXY2X' }],
|
||||
],
|
||||
SendMax: '100000000',
|
||||
}
|
||||
})
|
||||
|
||||
it('Validate Payment transaction API v2: Payment Transaction: Specify Only Amount field', async function () {
|
||||
const txResult = await testContext.client.autofill(paymentTx)
|
||||
|
||||
assert.strictEqual(txResult.Amount, AMOUNT)
|
||||
})
|
||||
|
||||
it('Validate Payment transaction API v2: Payment Transaction: Specify Only DeliverMax field', async function () {
|
||||
// @ts-expect-error -- DeliverMax is a non-protocol, RPC level field in Payment transactions
|
||||
paymentTx.DeliverMax = paymentTx.Amount
|
||||
// @ts-expect-error -- DeliverMax is a non-protocol, RPC level field in Payment transactions
|
||||
delete paymentTx.Amount
|
||||
const txResult = await testContext.client.autofill(paymentTx)
|
||||
|
||||
assert.strictEqual(txResult.Amount, AMOUNT)
|
||||
})
|
||||
|
||||
it('Validate Payment transaction API v2: Payment Transaction: identical DeliverMax and Amount fields', async function () {
|
||||
// @ts-expect-error -- DeliverMax is a non-protocol, RPC level field in Payment transactions
|
||||
paymentTx.DeliverMax = paymentTx.Amount
|
||||
|
||||
const txResult = await testContext.client.autofill(paymentTx)
|
||||
|
||||
assert.strictEqual(txResult.Amount, AMOUNT)
|
||||
assert.strictEqual('DeliverMax' in txResult, false)
|
||||
})
|
||||
|
||||
it('Validate Payment transaction API v2: Payment Transaction: differing DeliverMax and Amount fields', async function () {
|
||||
// @ts-expect-error -- DeliverMax is a non-protocol, RPC level field in Payment transactions
|
||||
paymentTx.DeliverMax = '6789'
|
||||
paymentTx.Amount = '1234'
|
||||
|
||||
await assertRejects(testContext.client.autofill(paymentTx), ValidationError)
|
||||
})
|
||||
|
||||
it('should not autofill if fields are present', async function () {
|
||||
const tx: Transaction = {
|
||||
@@ -141,26 +201,6 @@ describe('client.autofill', function () {
|
||||
assert.strictEqual(txResult.NetworkID, undefined)
|
||||
})
|
||||
|
||||
// Hooks Testnet requires networkID in transaction regardless of version.
|
||||
// More context: https://github.com/XRPLF/rippled/pull/4370
|
||||
it('overrides network ID for hooks testnet', async function () {
|
||||
await setupMockRippledVersionAndID('1.10.1', HOOKS_TESTNET_ID)
|
||||
const tx: Payment = {
|
||||
TransactionType: 'Payment',
|
||||
Account: 'XVLhHMPHU98es4dbozjVtdWzVrDjtV18pX8yuPT7y4xaEHi',
|
||||
Amount: '1234',
|
||||
Destination: 'X7AcgcsBL6XDcUb289X4mJ8djcdyKaB5hJDWMArnXr61cqZ',
|
||||
Fee,
|
||||
Sequence,
|
||||
LastLedgerSequence,
|
||||
}
|
||||
testContext.mockRippled!.addResponse('ledger', rippled.ledger.normal)
|
||||
|
||||
const txResult = await testContext.client.autofill(tx)
|
||||
|
||||
assert.strictEqual(txResult.NetworkID, HOOKS_TESTNET_ID)
|
||||
})
|
||||
|
||||
it('converts Account & Destination X-address to their classic address', async function () {
|
||||
const tx: Payment = {
|
||||
TransactionType: 'Payment',
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
/* eslint-disable @typescript-eslint/no-explicit-any -- required for formatting transactions */
|
||||
import { expect } from 'chai'
|
||||
import cloneDeep from 'lodash/cloneDeep'
|
||||
|
||||
@@ -24,7 +23,7 @@ describe('client handling of tfPartialPayments', function () {
|
||||
testContext.mockRippled!.addResponse('tx', rippled.tx.Payment)
|
||||
const resp = await testContext.client.request({
|
||||
command: 'tx',
|
||||
transaction: rippled.tx.Payment.result.hash,
|
||||
transaction: rippled.tx.Payment.result.tx_json.hash,
|
||||
})
|
||||
|
||||
expect(resp.warnings).to.equal(undefined)
|
||||
@@ -35,7 +34,7 @@ describe('client handling of tfPartialPayments', function () {
|
||||
testContext.mockRippled!.addResponse('tx', mockResponse)
|
||||
const resp = await testContext.client.request({
|
||||
command: 'tx',
|
||||
transaction: mockResponse.result.hash,
|
||||
transaction: mockResponse.result.tx_json.hash,
|
||||
})
|
||||
|
||||
expect(resp.warnings).to.deep.equal([
|
||||
@@ -51,7 +50,7 @@ describe('client handling of tfPartialPayments', function () {
|
||||
testContext.mockRippled!.addResponse('tx', mockResponse)
|
||||
const resp = await testContext.client.request({
|
||||
command: 'tx',
|
||||
transaction: mockResponse.result.hash,
|
||||
transaction: mockResponse.result.tx_json.hash,
|
||||
})
|
||||
|
||||
expect(resp.warnings).to.deep.equal([
|
||||
@@ -82,8 +81,10 @@ describe('client handling of tfPartialPayments', function () {
|
||||
}
|
||||
const mockResponse = rippled.account_tx.normal
|
||||
mockResponse.result.transactions.push({
|
||||
tx: partial.result,
|
||||
tx_json: partial.result.tx_json,
|
||||
meta: partial.result.meta,
|
||||
validated: true,
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- we are mocking the response
|
||||
} as any)
|
||||
|
||||
testContext.mockRippled!.addResponse('account_tx', mockResponse)
|
||||
@@ -105,8 +106,10 @@ describe('client handling of tfPartialPayments', function () {
|
||||
const partial = { ...rippled.tx.Payment, result: partialPaymentXRP }
|
||||
const mockResponse = rippled.account_tx.normal
|
||||
mockResponse.result.transactions.push({
|
||||
tx: partial.result,
|
||||
tx_json: partial.result.tx_json,
|
||||
meta: partial.result.meta,
|
||||
validated: true,
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- we are mocking the response
|
||||
} as any)
|
||||
|
||||
testContext.mockRippled!.addResponse('account_tx', mockResponse)
|
||||
@@ -138,7 +141,7 @@ describe('client handling of tfPartialPayments', function () {
|
||||
|
||||
it('transaction_entry with XRP tfPartialPayment', async function () {
|
||||
const mockResponse = cloneDeep(rippled.transaction_entry)
|
||||
mockResponse.result.tx_json.Amount = '1000'
|
||||
mockResponse.result.tx_json.DeliverMax = '1000'
|
||||
testContext.mockRippled!.addResponse('transaction_entry', mockResponse)
|
||||
const resp = await testContext.client.request({
|
||||
command: 'transaction_entry',
|
||||
|
||||
@@ -5,6 +5,7 @@
|
||||
"close_flags": 0,
|
||||
"ledger_index": "15202439",
|
||||
"close_time_human": "2015-Aug-12 01:01:10.000000000 UTC",
|
||||
"close_time_iso": "2015-08-12T01:01.10Z",
|
||||
"close_time_resolution": 10,
|
||||
"closed": true,
|
||||
"hash": "F4D865D83EB88C1A1911B9E90641919A1314F36E1B099F8E95FE3B7C77BE3349",
|
||||
|
||||
@@ -91,7 +91,7 @@
|
||||
"TransactionIndex": 12,
|
||||
"TransactionResult": "tesSUCCESS"
|
||||
},
|
||||
"tx": {
|
||||
"tx_json": {
|
||||
"Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
|
||||
"Destination": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
|
||||
"DestinationTag": 13,
|
||||
@@ -169,7 +169,7 @@
|
||||
"TransactionIndex": 59,
|
||||
"TransactionResult": "tesSUCCESS"
|
||||
},
|
||||
"tx": {
|
||||
"tx_json": {
|
||||
"Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
|
||||
"Authorize": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
|
||||
"Fee": "10",
|
||||
|
||||
@@ -1,18 +1,20 @@
|
||||
{
|
||||
"Account": "rGFuMiw48HdbnrUbkRYuitXTmfrDBNTCnX",
|
||||
"Amount": {
|
||||
"currency": "USD",
|
||||
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"value": "10"
|
||||
"tx_json": {
|
||||
"Account": "rGFuMiw48HdbnrUbkRYuitXTmfrDBNTCnX",
|
||||
"DeliverMax": {
|
||||
"currency": "USD",
|
||||
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
|
||||
"value": "10"
|
||||
},
|
||||
"Destination": "rNNuQMuExCiEjeZ4h9JJnj5PSWypdMXDj4",
|
||||
"Fee": "10000",
|
||||
"Flags": 131072,
|
||||
"Sequence": 23295,
|
||||
"SigningPubKey": "02B205F4B92351AC0EEB04254B636F4C49EF922CFA3CAAD03C6477DA1E04E94B53",
|
||||
"TransactionType": "Payment",
|
||||
"TxnSignature": "3045022100FAF247A836D601DE74A515B2AADE31186D8B0DA9C23DE489E09753F5CF4BB81F0220477C5B5BC3AC89F2347744F9E00CCA62267E198489D747578162C4C7D156211D",
|
||||
"hash": "A0A074D10355223CBE2520A42F93A52E3CC8B4D692570EB4841084F9BBB39F7A"
|
||||
},
|
||||
"Destination": "rNNuQMuExCiEjeZ4h9JJnj5PSWypdMXDj4",
|
||||
"Fee": "10000",
|
||||
"Flags": 131072,
|
||||
"Sequence": 23295,
|
||||
"SigningPubKey": "02B205F4B92351AC0EEB04254B636F4C49EF922CFA3CAAD03C6477DA1E04E94B53",
|
||||
"TransactionType": "Payment",
|
||||
"TxnSignature": "3045022100FAF247A836D601DE74A515B2AADE31186D8B0DA9C23DE489E09753F5CF4BB81F0220477C5B5BC3AC89F2347744F9E00CCA62267E198489D747578162C4C7D156211D",
|
||||
"hash": "A0A074D10355223CBE2520A42F93A52E3CC8B4D692570EB4841084F9BBB39F7A",
|
||||
"meta": {
|
||||
"AffectedNodes": [
|
||||
{
|
||||
|
||||
@@ -1,14 +1,16 @@
|
||||
{
|
||||
"Account": "rGFuMiw48HdbnrUbkRYuitXTmfrDBNTCnX",
|
||||
"Amount": "2000000",
|
||||
"Destination": "rNNuQMuExCiEjeZ4h9JJnj5PSWypdMXDj4",
|
||||
"Fee": "10000",
|
||||
"Flags": 131072,
|
||||
"Sequence": 23295,
|
||||
"SigningPubKey": "02B205F4B92351AC0EEB04254B636F4C49EF922CFA3CAAD03C6477DA1E04E94B53",
|
||||
"TransactionType": "Payment",
|
||||
"TxnSignature": "3045022100FAF247A836D601DE74A515B2AADE31186D8B0DA9C23DE489E09753F5CF4BB81F0220477C5B5BC3AC89F2347744F9E00CCA62267E198489D747578162C4C7D156211D",
|
||||
"hash": "A0A074D10355223CBE2520A42F93A52E3CC8B4D692570EB4841084F9BBB39F7A",
|
||||
"tx_json": {
|
||||
"Account": "rGFuMiw48HdbnrUbkRYuitXTmfrDBNTCnX",
|
||||
"DeliverMax": "2000000",
|
||||
"Destination": "rNNuQMuExCiEjeZ4h9JJnj5PSWypdMXDj4",
|
||||
"Fee": "10000",
|
||||
"Flags": 131072,
|
||||
"Sequence": 23295,
|
||||
"SigningPubKey": "02B205F4B92351AC0EEB04254B636F4C49EF922CFA3CAAD03C6477DA1E04E94B53",
|
||||
"TransactionType": "Payment",
|
||||
"TxnSignature": "3045022100FAF247A836D601DE74A515B2AADE31186D8B0DA9C23DE489E09753F5CF4BB81F0220477C5B5BC3AC89F2347744F9E00CCA62267E198489D747578162C4C7D156211D",
|
||||
"hash": "A0A074D10355223CBE2520A42F93A52E3CC8B4D692570EB4841084F9BBB39F7A"
|
||||
},
|
||||
"meta": {
|
||||
"AffectedNodes": [
|
||||
{
|
||||
|
||||
@@ -50,7 +50,7 @@
|
||||
},
|
||||
"tx_json": {
|
||||
"Account": "rLSn6Z3T8uCxbcd1oxwfGQN1Fdn5CyGujK",
|
||||
"Amount": "104169972",
|
||||
"DeliverMax": "104169972",
|
||||
"Destination": "rEb8TK3gBgk5auZkwc6sHnwrGVJH8DuaLh",
|
||||
"DestinationTag": 109735445,
|
||||
"Fee": "6000",
|
||||
|
||||
@@ -3,41 +3,43 @@
|
||||
"status": "success",
|
||||
"type": "response",
|
||||
"result": {
|
||||
"Account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
|
||||
"Amount": {
|
||||
"currency": "USD",
|
||||
"issuer": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM",
|
||||
"value": "0.001"
|
||||
"tx_json": {
|
||||
"Account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
|
||||
"DeliverMax": {
|
||||
"currency": "USD",
|
||||
"issuer": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM",
|
||||
"value": "0.001"
|
||||
},
|
||||
"Destination": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM",
|
||||
"Fee": "10",
|
||||
"Flags": 0,
|
||||
"Paths": [
|
||||
[
|
||||
{
|
||||
"currency": "USD",
|
||||
"issuer": "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo",
|
||||
"type": 48,
|
||||
"type_hex": "0000000000000030"
|
||||
},
|
||||
{
|
||||
"account": "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo",
|
||||
"currency": "USD",
|
||||
"issuer": "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo",
|
||||
"type": 49,
|
||||
"type_hex": "0000000000000031"
|
||||
}
|
||||
]
|
||||
],
|
||||
"SendMax": "1112209",
|
||||
"Sequence": 4,
|
||||
"SigningPubKey": "02BC8C02199949B15C005B997E7C8594574E9B02BA2D0628902E0532989976CF9D",
|
||||
"TransactionType": "Payment",
|
||||
"TxnSignature": "304502204EE3E9D1B01D8959B08450FCA9E22025AF503DEF310E34A93863A85CAB3C0BC5022100B61F5B567F77026E8DEED89EED0B7CAF0E6C96C228A2A65216F0DC2D04D52083",
|
||||
"date": 416447810,
|
||||
"inLedger": 348860,
|
||||
"ledger_index": 348860,
|
||||
"hash": "F4AB442A6D4CBB935D66E1DA7309A5FC71C7143ED4049053EC14E3875B0CF9BF"
|
||||
},
|
||||
"Destination": "rMH4UxPrbuMa1spCBR98hLLyNJp4d8p4tM",
|
||||
"Fee": "10",
|
||||
"Flags": 0,
|
||||
"Paths": [
|
||||
[
|
||||
{
|
||||
"currency": "USD",
|
||||
"issuer": "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo",
|
||||
"type": 48,
|
||||
"type_hex": "0000000000000030"
|
||||
},
|
||||
{
|
||||
"account": "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo",
|
||||
"currency": "USD",
|
||||
"issuer": "rpZc4mVfWUif9CRoHRKKcmhu1nx2xktxBo",
|
||||
"type": 49,
|
||||
"type_hex": "0000000000000031"
|
||||
}
|
||||
]
|
||||
],
|
||||
"SendMax": "1112209",
|
||||
"Sequence": 4,
|
||||
"SigningPubKey": "02BC8C02199949B15C005B997E7C8594574E9B02BA2D0628902E0532989976CF9D",
|
||||
"TransactionType": "Payment",
|
||||
"TxnSignature": "304502204EE3E9D1B01D8959B08450FCA9E22025AF503DEF310E34A93863A85CAB3C0BC5022100B61F5B567F77026E8DEED89EED0B7CAF0E6C96C228A2A65216F0DC2D04D52083",
|
||||
"date": 416447810,
|
||||
"hash": "F4AB442A6D4CBB935D66E1DA7309A5FC71C7143ED4049053EC14E3875B0CF9BF",
|
||||
"inLedger": 348860,
|
||||
"ledger_index": 348860,
|
||||
"meta": {
|
||||
"AffectedNodes": [
|
||||
{
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
To run integration tests:
|
||||
1. Run rippled in standalone node, either in a docker container (preferred) or by installing rippled.
|
||||
* Go to the top-level of the `xrpl.js` repo, just above the `packages` folder.
|
||||
* With docker, run `docker run -p 6006:6006 --interactive -t --volume $PWD/.ci-config:/config/ xrpllabsofficial/1.12.0-b1 -a --start`
|
||||
* With docker, run `docker run -p 6006:6006 --rm -it --name rippled_standalone --volume $PWD/.ci-config:/etc/opt/ripple/ --entrypoint bash rippleci/rippled:2.3.0-rc1 -c 'rippled -a'`
|
||||
* Or [download and build rippled](https://xrpl.org/install-rippled.html) and run `./rippled -a --start`
|
||||
* If you'd like to use the latest rippled amendments, you should modify your `rippled.cfg` file to enable amendments in the `[amendments]` section. You can view `.ci-config/rippled.cfg` in the top level folder as an example of this.
|
||||
2. Run `npm run test:integration` or `npm run test:browser`
|
||||
|
||||
@@ -83,40 +83,6 @@ describe('fundWallet', function () {
|
||||
// )
|
||||
// })
|
||||
|
||||
it(
|
||||
'can generate wallet on hooks v3 testnet',
|
||||
async function () {
|
||||
const api = new Client('wss://hooks-testnet-v3.xrpl-labs.com')
|
||||
|
||||
await api.connect()
|
||||
|
||||
const { wallet, balance } = await api.fundWallet(null, {
|
||||
usageContext: 'integration-test',
|
||||
})
|
||||
|
||||
assert.notStrictEqual(wallet, undefined)
|
||||
assert(isValidClassicAddress(wallet.classicAddress))
|
||||
assert(isValidXAddress(wallet.getXAddress()))
|
||||
|
||||
const info = await api.request({
|
||||
command: 'account_info',
|
||||
account: wallet.classicAddress,
|
||||
})
|
||||
|
||||
assert.equal(dropsToXrp(info.result.account_data.Balance), balance)
|
||||
assert.equal(balance, 1000)
|
||||
|
||||
/*
|
||||
* No test for fund given wallet because the hooks v3 testnet faucet
|
||||
* requires 10 seconds between requests. Would significantly slow down
|
||||
* the test suite.
|
||||
*/
|
||||
|
||||
await api.disconnect()
|
||||
},
|
||||
TIMEOUT,
|
||||
)
|
||||
|
||||
it(
|
||||
'submit funds wallet with custom amount',
|
||||
async function () {
|
||||
|
||||
@@ -80,4 +80,105 @@ describe('account_info', function () {
|
||||
},
|
||||
TIMEOUT,
|
||||
)
|
||||
|
||||
it(
|
||||
'uses api_version 1',
|
||||
async () => {
|
||||
const request: AccountInfoRequest = {
|
||||
command: 'account_info',
|
||||
account: testContext.wallet.classicAddress,
|
||||
strict: true,
|
||||
ledger_index: 'validated',
|
||||
api_version: 1,
|
||||
}
|
||||
const response = await testContext.client.request(request)
|
||||
const expected = {
|
||||
id: 0,
|
||||
result: {
|
||||
account_data: {
|
||||
Account: testContext.wallet.classicAddress,
|
||||
Balance: '400000000',
|
||||
Flags: 0,
|
||||
LedgerEntryType: 'AccountRoot',
|
||||
OwnerCount: 0,
|
||||
PreviousTxnID:
|
||||
'19A8211695785A3A02C1C287D93C2B049E83A9CD609825E721052D63FF4F0EC8',
|
||||
PreviousTxnLgrSeq: 582,
|
||||
Sequence: 283,
|
||||
index:
|
||||
'BD4815E6EB304136E6044F778FB68D4E464CC8DFC59B8F6CC93D90A3709AE194',
|
||||
},
|
||||
ledger_hash:
|
||||
'F0DEEC46A7185BBB535517EE38CF2025973022D5B0532B36407F492521FDB0C6',
|
||||
ledger_index: 582,
|
||||
validated: true,
|
||||
},
|
||||
type: 'response',
|
||||
}
|
||||
assert.equal(response.type, expected.type)
|
||||
assert.equal(response.result.validated, expected.result.validated)
|
||||
assert.equal(typeof response.result.ledger_index, 'number')
|
||||
assert.equal(typeof response.result.account_data.PreviousTxnID, 'string')
|
||||
assert.equal(typeof response.result.account_data.index, 'string')
|
||||
assert.equal(
|
||||
typeof response.result.account_data.PreviousTxnLgrSeq,
|
||||
'number',
|
||||
)
|
||||
assert.equal(typeof response.result.account_data.Sequence, 'number')
|
||||
assert.deepEqual(
|
||||
omit(response.result.account_data, [
|
||||
'PreviousTxnID',
|
||||
'PreviousTxnLgrSeq',
|
||||
'Sequence',
|
||||
'index',
|
||||
]),
|
||||
omit(expected.result.account_data, [
|
||||
'PreviousTxnID',
|
||||
'PreviousTxnLgrSeq',
|
||||
'Sequence',
|
||||
'index',
|
||||
]),
|
||||
)
|
||||
},
|
||||
TIMEOUT,
|
||||
)
|
||||
|
||||
it(
|
||||
'signer_list using api_version 1',
|
||||
async () => {
|
||||
const request: AccountInfoRequest = {
|
||||
command: 'account_info',
|
||||
account: testContext.wallet.classicAddress,
|
||||
strict: true,
|
||||
ledger_index: 'validated',
|
||||
signer_lists: true,
|
||||
api_version: 1,
|
||||
}
|
||||
const response = await testContext.client.request<AccountInfoRequest, 1>(
|
||||
request,
|
||||
)
|
||||
expect(response.result.account_data.signer_lists).toEqual([])
|
||||
// @ts-expect-error -- signer_lists is expected to be undefined
|
||||
expect(response.result.signer_lists).toBeUndefined()
|
||||
},
|
||||
TIMEOUT,
|
||||
)
|
||||
|
||||
it(
|
||||
'signer_list using api_version 2',
|
||||
async () => {
|
||||
const request: AccountInfoRequest = {
|
||||
command: 'account_info',
|
||||
account: testContext.wallet.classicAddress,
|
||||
strict: true,
|
||||
ledger_index: 'validated',
|
||||
signer_lists: true,
|
||||
}
|
||||
const response = await testContext.client.request(request)
|
||||
// @ts-expect-error -- signer_lists is expected to be undefined
|
||||
expect(response.result.account_data.signer_lists).toBeUndefined()
|
||||
expect(response.result.signer_lists).toEqual([])
|
||||
},
|
||||
TIMEOUT,
|
||||
)
|
||||
})
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user