Compare commits

..

6 Commits

Author SHA1 Message Date
Mayukha Vadari
596a2df4f8 Merge branch 'main' into sidechain-2.5 2023-02-21 13:48:54 -05:00
Jackson Mills
3d0bec7e89 Add support for disallowIncoming flags (#2221)
* Add support for disallowIncoming flags

* Fix broken tests

* Update packages/xrpl/src/models/ledger/AccountRoot.ts

* Update packages/xrpl/src/models/ledger/AccountRoot.ts

* Update HISTORY.md
2023-02-21 10:22:47 -08:00
Mayukha Vadari
fa8fa7cef9 Merge branch 'main' into sidechain-2.5 2023-02-21 13:15:36 -05:00
Mayukha Vadari
28ad836c13 fix isIssue typing 2023-02-21 13:15:16 -05:00
dependabot[bot]
fde954640f build(deps-dev): bump prettier from 2.8.3 to 2.8.4 (#2210) 2023-02-16 22:08:03 +00:00
Mayukha Vadari
b2dcce75b0 docs: update release instructions with beta details (#2213)
* Update release instructions with beta details

* add tag details

* add version info
2023-02-16 16:07:46 -05:00
46 changed files with 205 additions and 2064 deletions

View File

@@ -177,32 +177,33 @@ npm uninstall abbrev -w xrpl
NOW WE ARE READY TO PUBLISH! No new code changes happen manually now.
2. Checkout `main` and `git pull`.
3. Create a new branch to capture updates that take place during this process. `git checkout -b <BRANCH_NAME>`
2. Checkout `main` (or your beta branch) and `git pull`.
3. Create a new branch (`git checkout -b <BRANCH_NAME>`) to capture updates that take place during this process.
4. Update `HISTORY.md` to reflect release changes.
5. Run `npm run docgen` if the docs were modified in this release to update them.
5. Run `npm run docgen` if the docs were modified in this release to update them (skip this step for a beta).
6. Run `npm run build` to triple check the build still works
7. Run `npx lerna version --no-git-tag-version` - This creates a draft PR and release tags for the new version.
8. For each changed package, pick what the new version should be. Lerna will bump the versions, commit version bumps to `main`, and create a new git tag for each published package.
9. Run `npm i` to update the package-lock with the updated versions
10. Create a new PR from this branch into `main` and merge it.
11. Checkout `main` and `git pull`
12. Run `npx lerna publish from-package --yes` - This will actually publish the packages.
13. If it asks for it, enter your [npmjs.com](https://npmjs.com) OTP (one-time password) to complete publication.
14. Create a new branch to capture the updated packages from the release (`git checkout -b <BRANCH_NAME>`)
15. Make a PR to merge those changes into `main`
7. Run `npx lerna version --no-git-tag-version` - This creates a draft PR and bumps the versions of the packages.
* For each changed package, pick what the new version should be. Lerna will bump the versions, commit version bumps to `main`, and create a new git tag for each published package.
* If publishing a beta, make sure that the versions are all of the form `a.b.c-beta.d`, where `a`, `b`, and `c` are identical to the last normal release except for one, which has been incremented by 1.
8. Run `npm i` to update the package-lock with the updated versions
9. Create a new PR from this branch into `main` and merge it (you can directly merge into the beta branch for a beta).
10. Checkout `main` and `git pull` (you can skip this step for a beta since you already have the latest version of the beta branch).
11. Run `npx lerna publish from-package --yes` - This will actually publish the packages.
* NOTE: if you're releasing a beta, run `npx lerna publish from-package --dist-tag beta --yes` instead.
* If it asks for it, enter your [npmjs.com](https://npmjs.com) OTP (one-time password) to complete publication.
12. Create a new branch (`git checkout -b <BRANCH_NAME>`)to capture the updated packages from the release. Merge those changes into `main`. (You can skip this step on a beta release).
NOW YOU HAVE PUBLISHED! But you're not done; we have to notify people!
16. Pull the most recent changes to main locally.
17. Run `git tag <tagname> -m <tagname>`, where `<tagname>` is the new package and version (e.g. `xrpl@2.1.1`), for each version released.
18. Run `git push --follow-tags`, to push the tags to Github.
19. On Github, click the "releases" link on the right-hand side of the page.
20. Click "Draft a new release"
21. Click "Choose a tag", and choose a tag that you just created.
22. Edit the name of the release to match the tag (IE \<package\>@\<version\>) and edit the description as you see fit.
23. Repeat steps 19-21 for each release.
24. Send an email to [xrpl-announce](https://groups.google.com/g/xrpl-announce).
13. Pull the most recent changes to main locally.
14. Run `git tag <tagname> -m <tagname>`, where `<tagname>` is the new package and version (e.g. `xrpl@2.1.1`), for each version released.
15. Run `git push --follow-tags`, to push the tags to Github.
16. On Github, click the "releases" link on the right-hand side of the page.
17. Click "Draft a new release"
18. Click "Choose a tag", and choose a tag that you just created.
19. Edit the name of the release to match the tag (IE \<package\>@\<version\>) and edit the description as you see fit.
20. Repeat steps 17-19 for each release.
21. Send an email to [xrpl-announce](https://groups.google.com/g/xrpl-announce).
## Mailing Lists

20
package-lock.json generated
View File

@@ -13447,9 +13447,9 @@
}
},
"node_modules/prettier": {
"version": "2.8.3",
"resolved": "https://registry.npmjs.org/prettier/-/prettier-2.8.3.tgz",
"integrity": "sha512-tJ/oJ4amDihPoufT5sM0Z1SKEuKay8LfVAMlbbhnnkvt6BUserZylqo2PN+p9KeljLr0OHa2rXHU1T8reeoTrw==",
"version": "2.8.4",
"resolved": "https://registry.npmjs.org/prettier/-/prettier-2.8.4.tgz",
"integrity": "sha512-vIS4Rlc2FNh0BySk3Wkd6xmwxB0FpOndW5fisM5H8hsZSxU2VWVB5CWIkIjWvrHjIhxk2g3bfMKM87zNTrZddw==",
"dev": true,
"bin": {
"prettier": "bin-prettier.js"
@@ -17135,7 +17135,7 @@
}
},
"packages/ripple-binary-codec": {
"version": "1.5.0-beta.3",
"version": "1.5.0-beta.0",
"integrity": "sha512-XMRCbFXyG+dGp3x7tMs9IwA+FVWPPaGjdHYW2+g4Q/WQJqFp5MRED+jjOBOUafmrW4TUsOn1PEEdbB4ozWbDBw==",
"license": "ISC",
"dependencies": {
@@ -17173,7 +17173,7 @@
}
},
"packages/xrpl": {
"version": "2.7.0-beta.1",
"version": "2.6.0",
"license": "ISC",
"dependencies": {
"bignumber.js": "^9.0.0",
@@ -17182,7 +17182,7 @@
"https-proxy-agent": "^5.0.0",
"lodash": "^4.17.4",
"ripple-address-codec": "^4.2.4",
"ripple-binary-codec": "^1.5.0-beta.3",
"ripple-binary-codec": "^1.5.0-beta.0",
"ripple-keypairs": "^1.1.4",
"ws": "^8.2.2"
},
@@ -27842,9 +27842,9 @@
"dev": true
},
"prettier": {
"version": "2.8.3",
"resolved": "https://registry.npmjs.org/prettier/-/prettier-2.8.3.tgz",
"integrity": "sha512-tJ/oJ4amDihPoufT5sM0Z1SKEuKay8LfVAMlbbhnnkvt6BUserZylqo2PN+p9KeljLr0OHa2rXHU1T8reeoTrw==",
"version": "2.8.4",
"resolved": "https://registry.npmjs.org/prettier/-/prettier-2.8.4.tgz",
"integrity": "sha512-vIS4Rlc2FNh0BySk3Wkd6xmwxB0FpOndW5fisM5H8hsZSxU2VWVB5CWIkIjWvrHjIhxk2g3bfMKM87zNTrZddw==",
"dev": true
},
"prettier-linter-helpers": {
@@ -30602,7 +30602,7 @@
"node-polyfill-webpack-plugin": "^2.0.1",
"react": "^18.2.0",
"ripple-address-codec": "^4.2.4",
"ripple-binary-codec": "^1.5.0-beta.3",
"ripple-binary-codec": "^1.5.0-beta.0",
"ripple-keypairs": "^1.1.4",
"typedoc": "^0.23.24",
"ws": "^8.2.2"

View File

@@ -1,6 +1,6 @@
{
"name": "ripple-binary-codec",
"version": "1.5.0-beta.3",
"version": "1.5.0-beta.0",
"description": "XRP Ledger binary codec",
"files": [
"dist/*",

View File

@@ -11,7 +11,6 @@ import { STObject } from './types/st-object'
import { JsonObject } from './types/serialized-type'
import { Buffer } from 'buffer/'
import bigInt = require('big-integer')
import { AmountObject } from './types/amount'
/**
* Construct a BinaryParser
@@ -96,7 +95,7 @@ function signingData(
*/
interface ClaimObject extends JsonObject {
channel: string
amount: AmountObject
amount: string | number
}
/**
@@ -106,19 +105,16 @@ interface ClaimObject extends JsonObject {
* @returns the serialized object with appropriate prefix
*/
function signingClaimData(claim: ClaimObject): Buffer {
const num = bigInt(String(claim.amount))
const prefix = HashPrefix.paymentChannelClaim
const channel = coreTypes.Hash256.from(claim.channel).toBytes()
const amount = coreTypes.UInt64.from(num).toBytes()
const bytesList = new BytesList()
bytesList.put(prefix)
bytesList.put(channel)
if (typeof claim.amount === 'string') {
const num = bigInt(String(claim.amount))
const amount = coreTypes.UInt64.from(num).toBytes()
bytesList.put(amount)
} else {
const amount = coreTypes.Amount.from(claim.amount).toBytes()
bytesList.put(amount)
}
bytesList.put(amount)
return bytesList.toBytes()
}

View File

@@ -49,7 +49,6 @@
"NegativeUNL": 78,
"NFTokenPage": 80,
"NFTokenOffer": 55,
"AMM": 121,
"Any": -3,
"Child": -2,
"Nickname": 110,
@@ -287,16 +286,6 @@
"type": "UInt16"
}
],
[
"TradingFee",
{
"nth": 5,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "UInt16"
}
],
[
"Version",
{
@@ -787,36 +776,6 @@
"type": "UInt32"
}
],
[
"VoteWeight",
{
"nth": 47,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "UInt32"
}
],
[
"DiscountedFee",
{
"nth": 48,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "UInt32"
}
],
[
"LockCount",
{
"nth": 49,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "UInt32"
}
],
[
"IndexNext",
{
@@ -1197,16 +1156,6 @@
"type": "Hash256"
}
],
[
"AMMID",
{
"nth": 14,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "Hash256"
}
],
[
"BookDirectory",
{
@@ -1477,36 +1426,6 @@
"type": "Amount"
}
],
[
"Amount2",
{
"nth": 11,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "Amount"
}
],
[
"BidMin",
{
"nth": 12,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "Amount"
}
],
[
"BidMax",
{
"nth": 13,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "Amount"
}
],
[
"MinimumOffer",
{
@@ -1547,56 +1466,6 @@
"type": "Amount"
}
],
[
"LPTokenOut",
{
"nth": 20,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "Amount"
}
],
[
"LPTokenIn",
{
"nth": 21,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "Amount"
}
],
[
"EPrice",
{
"nth": 22,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "Amount"
}
],
[
"Price",
{
"nth": 23,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "Amount"
}
],
[
"LPTokenBalance",
{
"nth": 24,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "Amount"
}
],
[
"SignatureReward",
{
@@ -1617,16 +1486,6 @@
"type": "Amount"
}
],
[
"LockedBalance",
{
"nth": 31,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "Amount"
}
],
[
"PublicKey",
{
@@ -1957,16 +1816,6 @@
"type": "AccountID"
}
],
[
"AMMAccount",
{
"nth": 11,
"isVLEncoded": true,
"isSerialized": true,
"isSigningField": true,
"type": "AccountID"
}
],
[
"HookAccount",
{
@@ -2107,26 +1956,6 @@
"type": "Issue"
}
],
[
"Asset",
{
"nth": 3,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "Issue"
}
],
[
"Asset2",
{
"nth": 4,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "Issue"
}
],
[
"XChainBridge",
{
@@ -2347,36 +2176,6 @@
"type": "STObject"
}
],
[
"VoteEntry",
{
"nth": 25,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "STObject"
}
],
[
"AuctionSlot",
{
"nth": 27,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "STObject"
}
],
[
"AuthAccount",
{
"nth": 28,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "STObject"
}
],
[
"XChainClaimProofSig",
{
@@ -2507,16 +2306,6 @@
"type": "STArray"
}
],
[
"VoteSlots",
{
"nth": 14,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "STArray"
}
],
[
"Majorities",
{
@@ -2606,16 +2395,6 @@
"isSigningField": true,
"type": "STArray"
}
],
[
"AuthAccounts",
{
"nth": 26,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "STArray"
}
]
],
"TRANSACTION_RESULTS": {
@@ -2671,7 +2450,8 @@
"temUNKNOWN": -264,
"temSEQ_AND_TICKET": -263,
"temBAD_NFTOKEN_TRANSFER_FEE": -262,
"temAMM_BAD_TOKENS": -261,
"temBAD_AMM_OPTIONS": -261,
"temBAD_AMM_TOKENS": -260,
"temEQUAL_DOOR_ACCOUNTS": -259,
"temBAD_XCHAIN_PROOF": -258,
"temSIDECHAIN_BAD_ISSUES": -257,
@@ -2714,7 +2494,6 @@
"terNO_RIPPLE": -90,
"terQUEUED": -89,
"terPRE_TICKET": -88,
"terNO_AMM": -87,
"tesSUCCESS": 0,
@@ -2764,13 +2543,15 @@
"tecINSUFFICIENT_FUNDS": 159,
"tecOBJECT_NOT_FOUND": 160,
"tecINSUFFICIENT_PAYMENT": 161,
"tecAMM_UNFUNDED": 162,
"tecUNFUNDED_AMM": 162,
"tecAMM_BALANCE": 163,
"tecAMM_FAILED_DEPOSIT": 164,
"tecAMM_FAILED_WITHDRAW": 165,
"tecAMM_INVALID_TOKENS": 166,
"tecAMM_FAILED_BID": 167,
"tecAMM_FAILED_VOTE": 168,
"tecAMM_EXISTS": 167,
"tecAMM_FAILED_BID": 168,
"tecAMM_DIRECT_PAYMENT": 169,
"tecAMM_FAILED_VOTE": 170,
"tecBAD_XCHAIN_TRANSFER_ISSUE": 171,
"tecXCHAIN_NO_CLAIM_ID": 172,
"tecXCHAIN_BAD_CLAIM_ID": 173,
@@ -2786,8 +2567,7 @@
"tecXCHAIN_ACCOUNT_CREATE_TOO_MANY": 183,
"tecXCHAIN_PAYMENT_FAILED": 184,
"tecXCHAIN_SELF_COMMIT": 185,
"tecXCHAIN_BAD_PUBLIC_KEY_ACCOUNT_PAIR": 186,
"tecPRECISION_LOSS": 187
"tecXCHAIN_BAD_PUBLIC_KEY_ACCOUNT_PAIR": 186
},
"TRANSACTION_TYPES": {
"Invalid": -1,
@@ -2819,11 +2599,6 @@
"NFTokenCreateOffer": 27,
"NFTokenCancelOffer": 28,
"NFTokenAcceptOffer": 29,
"AMMCreate": 35,
"AMMDeposit": 36,
"AMMWithdraw": 37,
"AMMVote": 38,
"AMMBid": 39,
"XChainCreateBridge": 40,
"XChainCreateClaimID": 41,
"XChainCommit": 42,

View File

@@ -4634,213 +4634,6 @@
},
"XChainClaimID": "0000000000000001"
}
},
{
"binary": "12002315000A220000000024000000026140000000000027106840000000000000016BD5838D7EA4C680000000000000000000000000004554480000000000FBEF9A3A2B814E807745FA3D9C32FFD155FA2E8C7321ED8A00C1D29E762266576408B08D583B987673550655F930635678B436D5CDF7D07440913E39EC2BA0E5BC4C5DF1222B1AE9E76758F2B8FFEF1F056076147BB0ADC8117CD0296360DA08B3D48BE9EFC8693C03A253E0D9F166C19CA8D936F9E61A1100811462D4D845D20B4F09CFEA8BB4C01063D99FC9673E",
"json": {
"Account": "rwr2UWxNwoBdysPSiDDraTQjAQKZEeZAcV",
"TransactionType": "AMMCreate",
"TxnSignature": "913E39EC2BA0E5BC4C5DF1222B1AE9E76758F2B8FFEF1F056076147BB0ADC8117CD0296360DA08B3D48BE9EFC8693C03A253E0D9F166C19CA8D936F9E61A1100",
"Amount": "10000",
"Amount2": {
"currency": "ETH",
"issuer": "rPyfep3gcLzkosKC9XiE77Y8DZWG6iWDT9",
"value": "10000"
},
"TradingFee": 10,
"Fee": "1",
"Flags": 0,
"Sequence": 2,
"SigningPubKey": "ED8A00C1D29E762266576408B08D583B987673550655F930635678B436D5CDF7D0"
}
},
{
"binary": "120024220001000024000000026840000000000000016014D5438D7EA4C68000B3813FCAB4EE68B3D0D735D6849465A9113EE048B3813FCAB4EE68B3D0D735D6849465A9113EE0487321ED8A00C1D29E762266576408B08D583B987673550655F930635678B436D5CDF7D074409EEE8CF88C668B955E7EEAB1B4A1B059EDF4F51B7F1546810F87E3E48B09237F015C651E37FB40A979E00EA21361D4E18D7A33DB7DD23070CEEAB2648AB3BB0D811462D4D845D20B4F09CFEA8BB4C01063D99FC9673E0318000000000000000000000000000000000000000004180000000000000000000000004554480000000000FBEF9A3A2B814E807745FA3D9C32FFD155FA2E8C",
"json": {
"Account": "rwr2UWxNwoBdysPSiDDraTQjAQKZEeZAcV",
"TransactionType": "AMMDeposit",
"TxnSignature": "9EEE8CF88C668B955E7EEAB1B4A1B059EDF4F51B7F1546810F87E3E48B09237F015C651E37FB40A979E00EA21361D4E18D7A33DB7DD23070CEEAB2648AB3BB0D",
"Asset": {"currency": "XRP"},
"Asset2": {"currency": "ETH", "issuer": "rPyfep3gcLzkosKC9XiE77Y8DZWG6iWDT9"},
"LPTokenOut": {"currency": "B3813FCAB4EE68B3D0D735D6849465A9113EE048", "issuer": "rH438jEAzTs5PYtV6CHZqpDpwCKQmPW9Cg", "value": "1000"},
"Fee": "1",
"Flags": 65536,
"Sequence": 2,
"SigningPubKey": "ED8A00C1D29E762266576408B08D583B987673550655F930635678B436D5CDF7D0"
}
},
{
"binary": "120024220008000024000000026140000000000003E86840000000000000017321ED8A00C1D29E762266576408B08D583B987673550655F930635678B436D5CDF7D07440BD18A6E2B10B451F61CFADC32B59A0243702DC5DAAE556D51CB9C79981D40C78101FFA9DE6163CFBDF6E7578DF02F2AE3B8A5AB60697E0746D65064D91E8F90A811462D4D845D20B4F09CFEA8BB4C01063D99FC9673E0318000000000000000000000000000000000000000004180000000000000000000000004554480000000000FBEF9A3A2B814E807745FA3D9C32FFD155FA2E8C",
"json": {
"Account": "rwr2UWxNwoBdysPSiDDraTQjAQKZEeZAcV",
"TransactionType": "AMMDeposit",
"Asset": {"currency": "XRP"},
"Asset2": {"currency": "ETH", "issuer": "rPyfep3gcLzkosKC9XiE77Y8DZWG6iWDT9"},
"Amount": "1000",
"Fee": "1",
"Flags": 524288,
"Sequence": 2,
"SigningPubKey": "ED8A00C1D29E762266576408B08D583B987673550655F930635678B436D5CDF7D0",
"TxnSignature": "BD18A6E2B10B451F61CFADC32B59A0243702DC5DAAE556D51CB9C79981D40C78101FFA9DE6163CFBDF6E7578DF02F2AE3B8A5AB60697E0746D65064D91E8F90A"
}
},
{
"binary": "120024220010000024000000026140000000000003E86840000000000000016BD511C37937E080000000000000000000000000004554480000000000FBEF9A3A2B814E807745FA3D9C32FFD155FA2E8C7321ED8A00C1D29E762266576408B08D583B987673550655F930635678B436D5CDF7D07440E0B1AE32A0F731BF0CEF0D019295BD7F35B22F11A5962F65FA99EE4D38993B14B53DB11C15E36D756E282812E9015D38A6F225940A157693F43F9B795C59950F811462D4D845D20B4F09CFEA8BB4C01063D99FC9673E0318000000000000000000000000000000000000000004180000000000000000000000004554480000000000FBEF9A3A2B814E807745FA3D9C32FFD155FA2E8C",
"json": {
"Account": "rwr2UWxNwoBdysPSiDDraTQjAQKZEeZAcV",
"TransactionType": "AMMDeposit",
"Asset": {"currency": "XRP"},
"Asset2": {"currency": "ETH", "issuer": "rPyfep3gcLzkosKC9XiE77Y8DZWG6iWDT9"},
"Amount": "1000",
"Amount2": {"currency": "ETH", "issuer": "rPyfep3gcLzkosKC9XiE77Y8DZWG6iWDT9", "value": "500"},
"Fee": "1",
"Flags": 1048576,
"Sequence": 2,
"SigningPubKey": "ED8A00C1D29E762266576408B08D583B987673550655F930635678B436D5CDF7D0",
"TxnSignature": "E0B1AE32A0F731BF0CEF0D019295BD7F35B22F11A5962F65FA99EE4D38993B14B53DB11C15E36D756E282812E9015D38A6F225940A157693F43F9B795C59950F"
}
},
{
"binary": "120024220020000024000000026140000000000003E86840000000000000016014D5438D7EA4C68000B3813FCAB4EE68B3D0D735D6849465A9113EE048B3813FCAB4EE68B3D0D735D6849465A9113EE0487321ED8A00C1D29E762266576408B08D583B987673550655F930635678B436D5CDF7D07440452BC59F9EE12C224EC983EFDF580F20C4A50E897105FD1FB13520D9753CFB02BD210599181574DF6AD0DB6A42C1EA48D9E48FC3D11B9008E4C76FBB163D5B00811462D4D845D20B4F09CFEA8BB4C01063D99FC9673E0318000000000000000000000000000000000000000004180000000000000000000000004554480000000000FBEF9A3A2B814E807745FA3D9C32FFD155FA2E8C",
"json": {
"Account": "rwr2UWxNwoBdysPSiDDraTQjAQKZEeZAcV",
"TransactionType": "AMMDeposit",
"Asset": {"currency": "XRP"},
"Asset2": {"currency": "ETH", "issuer": "rPyfep3gcLzkosKC9XiE77Y8DZWG6iWDT9"},
"Amount": "1000",
"LPTokenOut": {"currency": "B3813FCAB4EE68B3D0D735D6849465A9113EE048", "issuer": "rH438jEAzTs5PYtV6CHZqpDpwCKQmPW9Cg", "value": "1000"},
"Fee": "1",
"Flags": 2097152,
"Sequence": 2,
"SigningPubKey": "ED8A00C1D29E762266576408B08D583B987673550655F930635678B436D5CDF7D0",
"TxnSignature": "452BC59F9EE12C224EC983EFDF580F20C4A50E897105FD1FB13520D9753CFB02BD210599181574DF6AD0DB6A42C1EA48D9E48FC3D11B9008E4C76FBB163D5B00"
}
},
{
"binary": "120024220040000024000000026140000000000003E8684000000000000001601640000000000000197321ED8A00C1D29E762266576408B08D583B987673550655F930635678B436D5CDF7D07440DD6685DC586FAA6AD2D50D785900122EB147D4AC09A55D7080267A9B38180F87CEC44B823359FC3F0AC0104D47B53FFC6B80415664C3C4582672420A0100F70C811462D4D845D20B4F09CFEA8BB4C01063D99FC9673E0318000000000000000000000000000000000000000004180000000000000000000000004554480000000000FBEF9A3A2B814E807745FA3D9C32FFD155FA2E8C",
"json": {
"Account": "rwr2UWxNwoBdysPSiDDraTQjAQKZEeZAcV",
"TransactionType": "AMMDeposit",
"Asset": {"currency": "XRP"},
"Asset2": {"currency": "ETH", "issuer": "rPyfep3gcLzkosKC9XiE77Y8DZWG6iWDT9"},
"Amount": "1000",
"EPrice": "25",
"Fee": "1",
"Flags": 4194304,
"Sequence": 2,
"SigningPubKey": "ED8A00C1D29E762266576408B08D583B987673550655F930635678B436D5CDF7D0",
"TxnSignature": "DD6685DC586FAA6AD2D50D785900122EB147D4AC09A55D7080267A9B38180F87CEC44B823359FC3F0AC0104D47B53FFC6B80415664C3C4582672420A0100F70C"
}
},
{
"binary": "120025220001000024000000026840000000000000016015D5438D7EA4C68000B3813FCAB4EE68B3D0D735D6849465A9113EE048B3813FCAB4EE68B3D0D735D6849465A9113EE0487321ED8A00C1D29E762266576408B08D583B987673550655F930635678B436D5CDF7D0744066944797E9F03808C9A00AAEFF786AD74FEB2E64B51A9601E89ABA820AAA15927C2E961A9CCA22C4B0D2A2B55E342BD6E297BD765B6F4D3FDCA578A3416BB505811462D4D845D20B4F09CFEA8BB4C01063D99FC9673E0318000000000000000000000000000000000000000004180000000000000000000000004554480000000000FBEF9A3A2B814E807745FA3D9C32FFD155FA2E8C",
"json": {
"Account": "rwr2UWxNwoBdysPSiDDraTQjAQKZEeZAcV",
"TransactionType": "AMMWithdraw",
"Asset": {"currency": "XRP"},
"Asset2": {"currency": "ETH", "issuer": "rPyfep3gcLzkosKC9XiE77Y8DZWG6iWDT9"},
"LPTokenIn": {"currency": "B3813FCAB4EE68B3D0D735D6849465A9113EE048", "issuer": "rH438jEAzTs5PYtV6CHZqpDpwCKQmPW9Cg", "value": "1000"},
"Fee": "1",
"Flags": 65536,
"Sequence": 2,
"SigningPubKey": "ED8A00C1D29E762266576408B08D583B987673550655F930635678B436D5CDF7D0",
"TxnSignature": "66944797E9F03808C9A00AAEFF786AD74FEB2E64B51A9601E89ABA820AAA15927C2E961A9CCA22C4B0D2A2B55E342BD6E297BD765B6F4D3FDCA578A3416BB505"
}
},
{
"binary": "120025220008000024000000026140000000000003E86840000000000000017321ED8A00C1D29E762266576408B08D583B987673550655F930635678B436D5CDF7D07440E30397CE7E99B13D35FFB5C66725B17F4F103675E10293C7B1D63C1BE3FA81B884BD3FBD31B52F6B811F99C5FBB5102D170EC379C268DF80DABF04E7F2DD4F0C811462D4D845D20B4F09CFEA8BB4C01063D99FC9673E0318000000000000000000000000000000000000000004180000000000000000000000004554480000000000FBEF9A3A2B814E807745FA3D9C32FFD155FA2E8C",
"json": {
"Account": "rwr2UWxNwoBdysPSiDDraTQjAQKZEeZAcV",
"TransactionType": "AMMWithdraw",
"Asset": {"currency": "XRP"},
"Asset2": {"currency": "ETH", "issuer": "rPyfep3gcLzkosKC9XiE77Y8DZWG6iWDT9"},
"Amount": "1000",
"Fee": "1",
"Flags": 524288,
"Sequence": 2,
"SigningPubKey": "ED8A00C1D29E762266576408B08D583B987673550655F930635678B436D5CDF7D0",
"TxnSignature": "E30397CE7E99B13D35FFB5C66725B17F4F103675E10293C7B1D63C1BE3FA81B884BD3FBD31B52F6B811F99C5FBB5102D170EC379C268DF80DABF04E7F2DD4F0C"
}
},
{
"binary": "120025220010000024000000026140000000000003E86840000000000000016BD511C37937E080000000000000000000000000004554480000000000FBEF9A3A2B814E807745FA3D9C32FFD155FA2E8C7321ED8A00C1D29E762266576408B08D583B987673550655F930635678B436D5CDF7D07440C0818312B269A4EF16C1C7EBBB74EFD1852A288BB214A714B8BE3B5F4B2F9CFDFF4F66C931B8434244A8016035B9EC9493B7CF5E0ACF4570A88DF808D79E4300811462D4D845D20B4F09CFEA8BB4C01063D99FC9673E0318000000000000000000000000000000000000000004180000000000000000000000004554480000000000FBEF9A3A2B814E807745FA3D9C32FFD155FA2E8C",
"json": {
"Account": "rwr2UWxNwoBdysPSiDDraTQjAQKZEeZAcV",
"TransactionType": "AMMWithdraw",
"Asset": {"currency": "XRP"},
"Asset2": {"currency": "ETH", "issuer": "rPyfep3gcLzkosKC9XiE77Y8DZWG6iWDT9"},
"Amount": "1000",
"Amount2": {"currency": "ETH", "issuer": "rPyfep3gcLzkosKC9XiE77Y8DZWG6iWDT9", "value": "500"},
"Fee": "1",
"Flags": 1048576,
"Sequence": 2,
"SigningPubKey": "ED8A00C1D29E762266576408B08D583B987673550655F930635678B436D5CDF7D0",
"TxnSignature": "C0818312B269A4EF16C1C7EBBB74EFD1852A288BB214A714B8BE3B5F4B2F9CFDFF4F66C931B8434244A8016035B9EC9493B7CF5E0ACF4570A88DF808D79E4300"
}
},
{
"binary": "120025220020000024000000026140000000000003E86840000000000000016015D5438D7EA4C68000B3813FCAB4EE68B3D0D735D6849465A9113EE048B3813FCAB4EE68B3D0D735D6849465A9113EE0487321ED8A00C1D29E762266576408B08D583B987673550655F930635678B436D5CDF7D0744073552B3DC7AE99DDF4E4FF0D60E6D0BE4688E3474D363603FA25DA6AD8BBA8F0E4E3EA82ADB2B57F5B9A6C379969E00095546DDA0E74FF3D0F0689351C2F8C06811462D4D845D20B4F09CFEA8BB4C01063D99FC9673E0318000000000000000000000000000000000000000004180000000000000000000000004554480000000000FBEF9A3A2B814E807745FA3D9C32FFD155FA2E8C",
"json": {
"Account": "rwr2UWxNwoBdysPSiDDraTQjAQKZEeZAcV",
"TransactionType": "AMMWithdraw",
"Asset": {"currency": "XRP"},
"Asset2": {"currency": "ETH", "issuer": "rPyfep3gcLzkosKC9XiE77Y8DZWG6iWDT9"},
"Amount": "1000",
"LPTokenIn": {"currency": "B3813FCAB4EE68B3D0D735D6849465A9113EE048", "issuer": "rH438jEAzTs5PYtV6CHZqpDpwCKQmPW9Cg", "value": "1000"},
"Fee": "1",
"Flags": 2097152,
"Sequence": 2,
"SigningPubKey": "ED8A00C1D29E762266576408B08D583B987673550655F930635678B436D5CDF7D0",
"TxnSignature": "73552B3DC7AE99DDF4E4FF0D60E6D0BE4688E3474D363603FA25DA6AD8BBA8F0E4E3EA82ADB2B57F5B9A6C379969E00095546DDA0E74FF3D0F0689351C2F8C06"
}
},
{
"binary": "120025220040000024000000026140000000000003E8684000000000000001601640000000000000197321ED8A00C1D29E762266576408B08D583B987673550655F930635678B436D5CDF7D0744023BAFE5BFE58E7BF0B02B5875983D007C10796C8E62A190BF688EBE5D8A104DAD2DE7EDE995FE2E494883FD8140F38E22E3376A2F49C50EFCAA00C7499A4690E811462D4D845D20B4F09CFEA8BB4C01063D99FC9673E0318000000000000000000000000000000000000000004180000000000000000000000004554480000000000FBEF9A3A2B814E807745FA3D9C32FFD155FA2E8C",
"json": {
"Account": "rwr2UWxNwoBdysPSiDDraTQjAQKZEeZAcV",
"TransactionType": "AMMWithdraw",
"Asset": {"currency": "XRP"},
"Asset2": {"currency": "ETH", "issuer": "rPyfep3gcLzkosKC9XiE77Y8DZWG6iWDT9"},
"Amount": "1000",
"EPrice": "25",
"Fee": "1",
"Flags": 4194304,
"Sequence": 2,
"SigningPubKey": "ED8A00C1D29E762266576408B08D583B987673550655F930635678B436D5CDF7D0",
"TxnSignature": "23BAFE5BFE58E7BF0B02B5875983D007C10796C8E62A190BF688EBE5D8A104DAD2DE7EDE995FE2E494883FD8140F38E22E3376A2F49C50EFCAA00C7499A4690E"
}
},
{
"binary": "120027220000000024000000026840000000000000016CD4C8E1BC9BF04000B3813FCAB4EE68B3D0D735D6849465A9113EE048B3813FCAB4EE68B3D0D735D6849465A9113EE0486DD4CC6F3B40B6C000B3813FCAB4EE68B3D0D735D6849465A9113EE048B3813FCAB4EE68B3D0D735D6849465A9113EE0487321ED8A00C1D29E762266576408B08D583B987673550655F930635678B436D5CDF7D074406B2A1548E6DC14681356C27CCBE7072CAB2AD8C72D0D7A045916FB0E0DBE6BF71A429CC519E9200172829D3EEF79100899D3A8710C1C3C1A2B664FD64086AD0A811462D4D845D20B4F09CFEA8BB4C01063D99FC9673EF01AE01C81149A91957F8F16BC57F3F200CD8C98375BF1791586E1F10318000000000000000000000000000000000000000004180000000000000000000000004554480000000000FBEF9A3A2B814E807745FA3D9C32FFD155FA2E8C",
"json": {
"Account": "rwr2UWxNwoBdysPSiDDraTQjAQKZEeZAcV",
"TransactionType": "AMMBid",
"Asset": {"currency": "XRP"},
"Asset2": {"currency": "ETH", "issuer": "rPyfep3gcLzkosKC9XiE77Y8DZWG6iWDT9"},
"AuthAccounts": [{"AuthAccount": {"Account": "rEaHTti4HZsMBpxTAF4ncWxkcdqDh1h6P7"}}],
"BidMax": {"currency": "B3813FCAB4EE68B3D0D735D6849465A9113EE048", "issuer": "rH438jEAzTs5PYtV6CHZqpDpwCKQmPW9Cg", "value": "35"},
"BidMin": {"currency": "B3813FCAB4EE68B3D0D735D6849465A9113EE048", "issuer": "rH438jEAzTs5PYtV6CHZqpDpwCKQmPW9Cg", "value": "25"},
"Fee": "1",
"Flags": 0,
"Sequence": 2,
"SigningPubKey": "ED8A00C1D29E762266576408B08D583B987673550655F930635678B436D5CDF7D0",
"TxnSignature": "6B2A1548E6DC14681356C27CCBE7072CAB2AD8C72D0D7A045916FB0E0DBE6BF71A429CC519E9200172829D3EEF79100899D3A8710C1C3C1A2B664FD64086AD0A"
}
},
{
"binary": "1200261500EA220000000024000000026840000000000000017321ED8A00C1D29E762266576408B08D583B987673550655F930635678B436D5CDF7D0744072767CF9A0F5E9C9DA6BBB6E84905B0ECDF122D3E2D730843EFD377521E8E73664AD809D0A54E8C75CD1735ACB64E310BB49FDED10913FA150B8C006D4ACEC00811462D4D845D20B4F09CFEA8BB4C01063D99FC9673E0318000000000000000000000000000000000000000004180000000000000000000000004554480000000000FBEF9A3A2B814E807745FA3D9C32FFD155FA2E8C",
"json": {
"Account": "rwr2UWxNwoBdysPSiDDraTQjAQKZEeZAcV",
"TransactionType": "AMMVote",
"Asset": {"currency": "XRP"},
"Asset2": {"currency": "ETH", "issuer": "rPyfep3gcLzkosKC9XiE77Y8DZWG6iWDT9"},
"TradingFee": 234,
"Fee": "1",
"Flags": 0,
"Sequence": 2,
"SigningPubKey": "ED8A00C1D29E762266576408B08D583B987673550655F930635678B436D5CDF7D0",
"TxnSignature": "72767CF9A0F5E9C9DA6BBB6E84905B0ECDF122D3E2D730843EFD377521E8E73664AD809D0A54E8C75CD1735ACB64E310BB49FDED10913FA150B8C006D4ACEC00"
}
}
],
"ledgerData": [{

View File

@@ -120,7 +120,7 @@ describe('Signing data', function () {
].join(''),
)
})
test('can create native claim blob', function () {
test('can create claim blob', function () {
const channel =
'43904CBFCDCEC530B4037871F86EE90BF799DF8D2E0EA564BC8A3F332E4F5FB1'
const amount = '1000'
@@ -137,27 +137,4 @@ describe('Signing data', function () {
].join(''),
)
})
test('can create ic claim blob', function () {
const channel =
'43904CBFCDCEC530B4037871F86EE90BF799DF8D2E0EA564BC8A3F332E4F5FB1'
const amount = {
issuer: 'rJZdUusLDtY9NEsGea7ijqhVrXv98rYBYN',
currency: 'USD',
value: '10',
}
const json = { channel, amount }
const actual = encodeForSigningClaim(json)
expect(actual).toBe(
[
// hash prefix
'434C4D00',
// channel ID
'43904CBFCDCEC530B4037871F86EE90BF799DF8D2E0EA564BC8A3F332E4F5FB1',
// amount as a uint64
'D4C38D7EA4C680000000000000000000000000005553440000000000C0A5ABEF',
// amount as a uint64
'242802EFED4B041E8F2D4A8CC86AE3D1',
].join(''),
)
})
})

View File

@@ -26,6 +26,7 @@ Wallet.fromMmnemonic()
### Added
* Optional custom amount field to `fundWallet`.
* Support for `disallowIncoming` account set flags (e.g. `asfDisallowIncomingTrustline`)
* Support for the cross-chain bridge feature.
### Changed
@@ -48,9 +49,6 @@ Wallet.fromMmnemonic()
* `Wallet.fromMnemonic` detects when an invalid encoding is provided, and throws an error
* Made unexpected errors in `submitAndWait` more verbose to make them easier to debug.
### Added
* Support for Automated Market Maker (AMM) transactions and requests as defined in XLS-30.
## 2.3.1 (2022-06-27)
### Fixed
* Signing tx with standard currency codes with lowercase and allowed symbols causing an error on decode.

View File

@@ -1,6 +1,6 @@
{
"name": "xrpl",
"version": "2.7.0-beta.1",
"version": "2.6.0",
"license": "ISC",
"description": "A TypeScript/JavaScript API for interacting with the XRP Ledger in Node.js and the browser",
"files": [
@@ -28,7 +28,7 @@
"https-proxy-agent": "^5.0.0",
"lodash": "^4.17.4",
"ripple-address-codec": "^4.2.4",
"ripple-binary-codec": "^1.5.0-beta.3",
"ripple-binary-codec": "^1.5.0-beta.0",
"ripple-keypairs": "^1.1.4",
"ws": "^8.2.2"
},

View File

@@ -25,9 +25,6 @@ import {
AccountOffersResponse,
AccountTxRequest,
AccountTxResponse,
// AMM methods
AMMInfoRequest,
AMMInfoResponse,
GatewayBalancesRequest,
GatewayBalancesResponse,
NoRippleCheckRequest,
@@ -302,7 +299,6 @@ class Client extends EventEmitter {
): Promise<AccountObjectsResponse>
public async request(r: AccountOffersRequest): Promise<AccountOffersResponse>
public async request(r: AccountTxRequest): Promise<AccountTxResponse>
public async request(r: AMMInfoRequest): Promise<AMMInfoResponse>
public async request(r: BookOffersRequest): Promise<BookOffersResponse>
public async request(r: ChannelVerifyRequest): Promise<ChannelVerifyResponse>
public async request(

View File

@@ -116,6 +116,22 @@ export interface AccountRootFlagsInterface {
* (It has DepositAuth enabled.)
*/
lsfDepositAuth?: boolean
/**
* Disallow incoming NFTOffers from other accounts.
*/
lsfDisallowIncomingNFTOffer?: boolean
/**
* Disallow incoming Checks from other accounts.
*/
lsfDisallowIncomingCheck?: boolean
/**
* Disallow incoming PayChannels from other accounts.
*/
lsfDisallowIncomingPayChan?: boolean
/**
* Disallow incoming Trustlines from other accounts.
*/
lsfDisallowIncomingTrustline?: boolean
}
export enum AccountRootFlags {
@@ -156,4 +172,20 @@ export enum AccountRootFlags {
* (It has DepositAuth enabled.)
*/
lsfDepositAuth = 0x01000000,
/**
* Disallow incoming NFTOffers from other accounts.
*/
lsfDisallowIncomingNFTOffer = 0x04000000,
/**
* Disallow incoming Checks from other accounts.
*/
lsfDisallowIncomingCheck = 0x08000000,
/**
* Disallow incoming PayChannels from other accounts.
*/
lsfDisallowIncomingPayChan = 0x10000000,
/**
* Disallow incoming Trustlines from other accounts.
*/
lsfDisallowIncomingTrustline = 0x20000000,
}

View File

@@ -1,9 +1,7 @@
import { Amount } from '../common'
import BaseLedgerEntry from './BaseLedgerEntry'
/**
* The Escrow object type represents a held payment waiting to be
* The Escrow object type represents a held payment of XRP waiting to be
* executed or canceled.
*
* @category Ledger Entries
@@ -12,17 +10,17 @@ export default interface Escrow extends BaseLedgerEntry {
LedgerEntryType: 'Escrow'
/**
* The address of the owner (sender) of this held payment. This is the
* account that provided the amounts, and gets it back if the held payment is
* account that provided the XRP, and gets it back if the held payment is
* canceled.
*/
Account: string
/**
* The destination address where the amounts are paid if the held payment is
* The destination address where the XRP is paid if the held payment is
* successful.
*/
Destination: string
/** The amount to be delivered by the held payment. */
Amount: Amount
/** The amount of XRP, in drops, to be delivered by the held payment. */
Amount: string
/**
* A PREIMAGE-SHA-256 crypto-condition, as hexadecimal. If present, the
* EscrowFinish transaction must contain a fulfillment that satisfies this
@@ -73,9 +71,4 @@ export default interface Escrow extends BaseLedgerEntry {
* modified this object.
*/
PreviousTxnLgrSeq: number
/**
* The fee to charge when users finish an escrow, initially set on the
* creation of an escrow contract, and updated on subsequent finish transactions
*/
TransferRate?: number
}

View File

@@ -1,11 +1,9 @@
import { Amount } from '../common'
import BaseLedgerEntry from './BaseLedgerEntry'
/**
* The PayChannel object type represents a payment channel. Payment channels
* enable small, rapid off-ledger payments that can be later reconciled
* with the consensus ledger. A payment channel holds a balance that can
* enable small, rapid off-ledger payments of XRP that can be later reconciled
* with the consensus ledger. A payment channel holds a balance of XRP that can
* only be paid out to a specific destination address until the channel is
* closed.
*
@@ -20,37 +18,37 @@ export default interface PayChannel extends BaseLedgerEntry {
Account: string
/**
* The destination address for this payment channel. While the payment
* channel is open, this address is the only one that can receive amounts from the
* channel is open, this address is the only one that can receive XRP from the
* channel. This comes from the Destination field of the transaction that
* created the channel.
*/
Destination: string
/**
* Total amount that has been allocated to this channel. This includes amounts
* that have been paid to the destination address. This is initially set by the
* transaction that created the channel and can be increased if the source
* address sends a PaymentChannelFund transaction.
* Total XRP, in drops, that has been allocated to this channel. This
* includes XRP that has been paid to the destination address. This is
* initially set by the transaction that created the channel and can be
* increased if the source address sends a PaymentChannelFund transaction.
*/
Amount: Amount
Amount: string
/**
* Total amount already paid out by the channel. The difference between this value
* and the Amount field is how much can still be paid to the destination address
* with PaymentChannelClaim transactions. If the channel closes, the remaining
* difference is returned to the source address.
* Total XRP, in drops, already paid out by the channel. The difference
* between this value and the Amount field is how much XRP can still be paid
* to the destination address with PaymentChannelClaim transactions. If the
* channel closes, the remaining difference is returned to the source address.
*/
Balance: Amount
Balance: string
/**
* Public key, in hexadecimal, of the key pair that can be used to sign
* claims against this channel. This can be any valid secp256k1 or Ed25519
* public key. This is set by the transaction that created the channel and
* must match the public key used in claims against the channel. The channel
* source address can also send amounts from this channel to the destination
* source address can also send XRP from this channel to the destination
* without signed claims.
*/
PublicKey: string
/**
* Number of seconds the source address must wait to close the channel if
* it still has any amount in it. Smaller values mean that the destination
* it still has any XRP in it. Smaller values mean that the destination
* address has less time to redeem any outstanding claims after the source
* address requests to close the channel. Can be any value that fits in a
* 32-bit unsigned integer (0 to 2^32-1). This is set by the transaction that
@@ -106,10 +104,4 @@ export default interface PayChannel extends BaseLedgerEntry {
* this object, in case the directory consists of multiple pages.
*/
DestinationNode?: string
/**
* The fee to charge when users make claims on a payment channel, initially
* set on the creation of a payment channel and updated on subsequent funding
* or claim transactions.
*/
TransferRate?: number
}

View File

@@ -1,10 +1,10 @@
import { Amount, LedgerIndex } from '../common'
import { LedgerIndex } from '../common'
import { BaseRequest, BaseResponse } from './baseMethod'
interface Channel {
account: string
amount: Amount
amount: string
balance: string
channel_id: string
destination_account: string
@@ -15,7 +15,6 @@ interface Channel {
cancel_after?: number
source_tab?: number
destination_tag?: number
transfer_rate?: number
}
/**

View File

@@ -1,4 +1,4 @@
import { Amount, LedgerIndex } from '../common'
import { LedgerIndex } from '../common'
import { BaseRequest, BaseResponse } from './baseMethod'
@@ -64,14 +64,6 @@ export interface Trustline {
* false.
*/
freeze_peer?: boolean
/**
* The total amount of FT, in drops/Amount locked in payment channels or escrow.
*/
locked_balance?: Amount
/**
* The total number of lock balances on a RippleState ledger object.
*/
lock_count?: number
}
/**

View File

@@ -1,147 +0,0 @@
import { Amount, IssuedCurrency, IssuedCurrencyAmount } from '../common'
import { BaseRequest, BaseResponse } from './baseMethod'
/**
* The `amm_info` command retrieves information about an AMM instance.
* Returns an {@link AMMInfoResponse}.
*
* @category Requests
*/
export interface AMMInfoRequest extends BaseRequest {
command: 'amm_info'
/**
* Specifies one of the pool assets (XRP or token) of the AMM instance.
* Both asset and asset2 must be defined to specify an AMM instance.
*/
asset?: IssuedCurrency
/**
* Specifies the other pool asset of the AMM instance.
* Both asset and asset2 must be defined to specify an AMM instance.
*/
asset2?: IssuedCurrency
}
interface AuthAccount {
account: string
}
interface VoteEntry {
account: string
trading_fee: number
vote_weight: number
}
/**
* Response expected from an {@link AMMInfoRequest}.
*
* @category Responses
*/
export interface AMMInfoResponse extends BaseResponse {
result: {
amm: {
/**
* The account that tracks the balance of LPTokens between the AMM instance via Trustline.
*/
amm_account: string
/**
* One of the pool assets (XRP or token) of the AMM instance.
*/
amount: Amount
/**
* The other pool asset of the AMM instance.
*/
amount2: Amount
/**
* (Omitted for XRP) If true, the amount currency is currently frozen for asset.
*/
asset_frozen: boolean
/**
* (Omitted for XRP) If true, the amount currency is currently frozen for asset2.
*/
asset2_frozen: boolean
/**
* Details of the current owner of the auction slot.
*/
auction_slot?: {
/**
* The current owner of this auction slot.
*/
account: string
/**
* A list of at most 4 additional accounts that are authorized to trade at the discounted fee for this AMM instance.
*/
auth_accounts: AuthAccount[]
/**
* The trading fee to be charged to the auction owner, in the same format as TradingFee.
* By default this is 0, meaning that the auction owner can trade at no fee instead of the standard fee for this AMM.
*/
discounted_fee: number
/**
* The time when this slot expires, in seconds since the Ripple Epoch.
*/
expiration: string
/**
* The amount the auction owner paid to win this slot, in LPTokens.
*/
price: Amount
/**
* Total slot time of 24-hours is divided into 20 equal time intervals.
*/
time_interval: number
}
/**
* The total outstanding balance of liquidity provider tokens from this AMM instance.
* The holders of these tokens can vote on the AMM's trading fee in proportion to their holdings,
* or redeem the tokens for a share of the AMM's assets which grows with the trading fees collected.
*/
lp_token: IssuedCurrencyAmount
/**
* Specifies the fee, in basis point, to be charged to the traders for the trades
* executed against the AMM instance. Trading fee is a percentage of the trading volume.
* Valid values for this field are between 0 and 1000 inclusive.
* A value of 1 is equivalent to 1/10 bps or 0.001%, allowing trading fee
* between 0% and 1%. This field is required.
*/
trading_fee: number
/**
* Keeps a track of up to eight active votes for the instance.
*/
vote_slots?: VoteEntry[]
}
/**
* The identifying hash of the ledger that was used to generate this
* response.
*/
ledger_hash?: string
/**
* The ledger index of the ledger version that was used to generate this
* response.
*/
ledger_index?: number
/**
* If included and set to true, the information in this response comes from
* a validated ledger version. Otherwise, the information is subject to
* change.
*/
validated?: boolean
}
}

View File

@@ -9,7 +9,7 @@ import { BaseRequest, BaseResponse } from './baseMethod'
*/
export interface ChannelVerifyRequest extends BaseRequest {
command: 'channel_verify'
/** The amount the provided signature authorizes. */
/** The amount of XRP, in drops, the provided signature authorizes. */
amount: string
/**
* The Channel ID of the channel that provides the XRP. This is a

View File

@@ -16,7 +16,6 @@ import {
AccountOffersResponse,
} from './accountOffers'
import { AccountTxRequest, AccountTxResponse } from './accountTx'
import { AMMInfoRequest, AMMInfoResponse } from './ammInfo'
import { ErrorResponse } from './baseMethod'
import { BookOffersRequest, BookOffer, BookOffersResponse } from './bookOffers'
import { ChannelVerifyRequest, ChannelVerifyResponse } from './channelVerify'
@@ -88,7 +87,6 @@ type Request =
| AccountObjectsRequest
| AccountOffersRequest
| AccountTxRequest
| AMMInfoRequest
| GatewayBalancesRequest
| NoRippleCheckRequest
// ledger methods
@@ -139,7 +137,6 @@ type Response =
| AccountObjectsResponse
| AccountOffersResponse
| AccountTxResponse
| AMMInfoResponse
| GatewayBalancesResponse
| NoRippleCheckResponse
// ledger methods
@@ -198,8 +195,6 @@ export {
AccountOffersResponse,
AccountTxRequest,
AccountTxResponse,
AMMInfoRequest,
AMMInfoResponse,
GatewayBalancesRequest,
GatewayBalancesResponse,
NoRippleCheckRequest,

View File

@@ -1,106 +0,0 @@
/* eslint-disable complexity -- required for validateAMMBid */
import { ValidationError } from '../../errors'
import { Amount, IssuedCurrency } from '../common'
import {
BaseTransaction,
isAmount,
isIssue,
validateBaseTransaction,
} from './common'
const MAX_AUTH_ACCOUNTS = 4
interface AuthAccount {
AuthAccount: {
Account: string
}
}
/**
* AMMBid is used for submitting a vote for the trading fee of an AMM Instance.
*
* Any XRPL account that holds LPToken for an AMM instance may submit this
* transaction to vote for the trading fee for that instance.
*/
export interface AMMBid extends BaseTransaction {
TransactionType: 'AMMBid'
/**
* Specifies one of the pool assets (XRP or token) of the AMM instance.
*/
Asset: IssuedCurrency
/**
* Specifies the other pool asset of the AMM instance.
*/
Asset2: IssuedCurrency
/**
* This field represents the minimum price that the bidder wants to pay for the slot.
* It is specified in units of LPToken. If specified let BidMin be X and let
* the slot-price computed by price scheduling algorithm be Y, then bidder always pays
* the max(X, Y).
*/
BidMin?: Amount
/**
* This field represents the maximum price that the bidder wants to pay for the slot.
* It is specified in units of LPToken.
*/
BidMax?: Amount
/**
* This field represents an array of XRPL account IDs that are authorized to trade
* at the discounted fee against the AMM instance.
* A maximum of four accounts can be provided.
*/
AuthAccounts?: AuthAccount[]
}
/**
* Verify the form and type of an AMMBid at runtime.
*
* @param tx - An AMMBid Transaction.
* @throws When the AMMBid is Malformed.
*/
export function validateAMMBid(tx: Record<string, unknown>): void {
validateBaseTransaction(tx)
if (tx.Asset == null) {
throw new ValidationError('AMMBid: missing field Asset')
}
if (!isIssue(tx.Asset)) {
throw new ValidationError('AMMBid: Asset must be an Issue')
}
if (tx.Asset2 == null) {
throw new ValidationError('AMMBid: missing field Asset2')
}
if (!isIssue(tx.Asset2)) {
throw new ValidationError('AMMBid: Asset2 must be an Issue')
}
if (tx.BidMin != null && !isAmount(tx.BidMin)) {
throw new ValidationError('AMMBid: BidMin must be an Amount')
}
if (tx.BidMax != null && !isAmount(tx.BidMax)) {
throw new ValidationError('AMMBid: BidMax must be an Amount')
}
if (tx.AuthAccounts != null) {
if (!Array.isArray(tx.AuthAccounts)) {
throw new ValidationError(
`AMMBid: AuthAccounts must be an AuthAccount array`,
)
}
if (tx.AuthAccounts.length > MAX_AUTH_ACCOUNTS) {
throw new ValidationError(
`AMMBid: AuthAccounts length must not be greater than ${MAX_AUTH_ACCOUNTS}`,
)
}
}
}

View File

@@ -1,76 +0,0 @@
import { ValidationError } from '../../errors'
import { Amount } from '../common'
import { BaseTransaction, isAmount, validateBaseTransaction } from './common'
export const AMM_MAX_TRADING_FEE = 1000
/**
* AMMCreate is used to create AccountRoot and the corresponding
* AMM ledger entries.
*
* This allows for the creation of only one AMM instance per unique asset pair.
*/
export interface AMMCreate extends BaseTransaction {
TransactionType: 'AMMCreate'
/**
* Specifies one of the pool assets (XRP or token) of the AMM instance.
*/
Amount: Amount
/**
* Specifies the other pool asset of the AMM instance.
*/
Amount2: Amount
/**
* Specifies the fee, in basis point, to be charged
* to the traders for the trades executed against the AMM instance.
* Trading fee is a percentage of the trading volume.
* Valid values for this field are between 0 and 1000 inclusive.
* A value of 1 is equivalent to 1/10 bps or 0.001%, allowing trading fee
* between 0% and 1%.
*/
TradingFee: number
}
/**
* Verify the form and type of an AMMCreate at runtime.
*
* @param tx - An AMMCreate Transaction.
* @throws When the AMMCreate is Malformed.
*/
export function validateAMMCreate(tx: Record<string, unknown>): void {
validateBaseTransaction(tx)
if (tx.Amount == null) {
throw new ValidationError('AMMCreate: missing field Amount')
}
if (!isAmount(tx.Amount)) {
throw new ValidationError('AMMCreate: Amount must be an Amount')
}
if (tx.Amount2 == null) {
throw new ValidationError('AMMCreate: missing field Amount2')
}
if (!isAmount(tx.Amount2)) {
throw new ValidationError('AMMCreate: Amount2 must be an Amount')
}
if (tx.TradingFee == null) {
throw new ValidationError('AMMCreate: missing field TradingFee')
}
if (typeof tx.TradingFee !== 'number') {
throw new ValidationError('AMMCreate: TradingFee must be a number')
}
if (tx.TradingFee < 0 || tx.TradingFee > AMM_MAX_TRADING_FEE) {
throw new ValidationError(
`AMMCreate: TradingFee must be between 0 and ${AMM_MAX_TRADING_FEE}`,
)
}
}

View File

@@ -1,135 +0,0 @@
/* eslint-disable complexity -- required for validateAMMDeposit */
import { ValidationError } from '../../errors'
import { Amount, IssuedCurrency, IssuedCurrencyAmount } from '../common'
import {
BaseTransaction,
GlobalFlags,
isAmount,
isIssue,
isIssuedCurrency,
validateBaseTransaction,
} from './common'
/**
* Enum representing values for AMMDeposit Transaction Flags.
*
* @category Transaction Flags
*/
export enum AMMDepositFlags {
tfLPToken = 0x00010000,
tfSingleAsset = 0x00080000,
tfTwoAsset = 0x00100000,
tfOneAssetLPToken = 0x00200000,
tfLimitLPToken = 0x00400000,
}
export interface AMMDepositFlagsInterface extends GlobalFlags {
tfLPToken?: boolean
tfSingleAsset?: boolean
tfTwoAsset?: boolean
tfOneAssetLPToken?: boolean
tfLimitLPToken?: boolean
}
/**
* AMMDeposit is the deposit transaction used to add liquidity to the AMM instance pool,
* thus obtaining some share of the instance's pools in the form of LPTokenOut.
*
* The following are the recommended valid combinations:
* - LPTokenOut
* - Amount
* - Amount and Amount2
* - Amount and LPTokenOut
* - Amount and EPrice
*/
export interface AMMDeposit extends BaseTransaction {
TransactionType: 'AMMDeposit'
/**
* Specifies one of the pool assets (XRP or token) of the AMM instance.
*/
Asset: IssuedCurrency
/**
* Specifies the other pool asset of the AMM instance.
*/
Asset2: IssuedCurrency
/**
* Specifies the amount of shares of the AMM instance pools that the trader
* wants to redeem or trade in.
*/
LPTokenOut?: IssuedCurrencyAmount
/**
* Specifies one of the pool assets (XRP or token) of the AMM instance to
* deposit more of its value.
*/
Amount?: Amount
/**
* Specifies the other pool asset of the AMM instance to deposit more of
* its value.
*/
Amount2?: Amount
/**
* Specifies the maximum effective-price that LPTokenOut can be traded out.
*/
EPrice?: Amount
}
/**
* Verify the form and type of an AMMDeposit at runtime.
*
* @param tx - An AMMDeposit Transaction.
* @throws When the AMMDeposit is Malformed.
*/
export function validateAMMDeposit(tx: Record<string, unknown>): void {
validateBaseTransaction(tx)
if (tx.Asset == null) {
throw new ValidationError('AMMDeposit: missing field Asset')
}
if (!isIssue(tx.Asset)) {
throw new ValidationError('AMMDeposit: Asset must be an Issue')
}
if (tx.Asset2 == null) {
throw new ValidationError('AMMDeposit: missing field Asset2')
}
if (!isIssue(tx.Asset2)) {
throw new ValidationError('AMMDeposit: Asset2 must be an Issue')
}
if (tx.Amount2 != null && tx.Amount == null) {
throw new ValidationError('AMMDeposit: must set Amount with Amount2')
} else if (tx.EPrice != null && tx.Amount == null) {
throw new ValidationError('AMMDeposit: must set Amount with EPrice')
} else if (tx.LPTokenOut == null && tx.Amount == null) {
throw new ValidationError(
'AMMDeposit: must set at least LPTokenOut or Amount',
)
}
if (tx.LPTokenOut != null && !isIssuedCurrency(tx.LPTokenOut)) {
throw new ValidationError(
'AMMDeposit: LPTokenOut must be an IssuedCurrencyAmount',
)
}
if (tx.Amount != null && !isAmount(tx.Amount)) {
throw new ValidationError('AMMDeposit: Amount must be an Amount')
}
if (tx.Amount2 != null && !isAmount(tx.Amount2)) {
throw new ValidationError('AMMDeposit: Amount2 must be an Amount')
}
if (tx.EPrice != null && !isAmount(tx.EPrice)) {
throw new ValidationError('AMMDeposit: EPrice must be an Amount')
}
}

View File

@@ -1,73 +0,0 @@
import { ValidationError } from '../../errors'
import { IssuedCurrency } from '../common'
import { AMM_MAX_TRADING_FEE } from './AMMCreate'
import { BaseTransaction, isIssue, validateBaseTransaction } from './common'
/**
* AMMVote is used for submitting a vote for the trading fee of an AMM Instance.
*
* Any XRPL account that holds LPToken for an AMM instance may submit this
* transaction to vote for the trading fee for that instance.
*/
export interface AMMVote extends BaseTransaction {
TransactionType: 'AMMVote'
/**
* Specifies one of the pool assets (XRP or token) of the AMM instance.
*/
Asset: IssuedCurrency
/**
* Specifies the other pool asset of the AMM instance.
*/
Asset2: IssuedCurrency
/**
* Specifies the fee, in basis point.
* Valid values for this field are between 0 and 1000 inclusive.
* A value of 1 is equivalent to 1/10 bps or 0.001%, allowing trading fee
* between 0% and 1%. This field is required.
*/
TradingFee: number
}
/**
* Verify the form and type of an AMMVote at runtime.
*
* @param tx - An AMMVote Transaction.
* @throws When the AMMVote is Malformed.
*/
export function validateAMMVote(tx: Record<string, unknown>): void {
validateBaseTransaction(tx)
if (tx.Asset == null) {
throw new ValidationError('AMMVote: missing field Asset')
}
if (!isIssue(tx.Asset)) {
throw new ValidationError('AMMVote: Asset must be an Issue')
}
if (tx.Asset2 == null) {
throw new ValidationError('AMMVote: missing field Asset2')
}
if (!isIssue(tx.Asset2)) {
throw new ValidationError('AMMVote: Asset2 must be an Issue')
}
if (tx.TradingFee == null) {
throw new ValidationError('AMMVote: missing field TradingFee')
}
if (typeof tx.TradingFee !== 'number') {
throw new ValidationError('AMMVote: TradingFee must be a number')
}
if (tx.TradingFee < 0 || tx.TradingFee > AMM_MAX_TRADING_FEE) {
throw new ValidationError(
`AMMVote: TradingFee must be between 0 and ${AMM_MAX_TRADING_FEE}`,
)
}
}

View File

@@ -1,137 +0,0 @@
/* eslint-disable complexity -- required for validateAMMWithdraw */
import { ValidationError } from '../../errors'
import { Amount, IssuedCurrency, IssuedCurrencyAmount } from '../common'
import {
BaseTransaction,
GlobalFlags,
isAmount,
isIssue,
isIssuedCurrency,
validateBaseTransaction,
} from './common'
/**
* Enum representing values for AMMWithdrawFlags Transaction Flags.
*
* @category Transaction Flags
*/
export enum AMMWithdrawFlags {
tfLPToken = 0x00010000,
tfWithdrawAll = 0x00020000,
tfOneAssetWithdrawAll = 0x00040000,
tfSingleAsset = 0x00080000,
tfTwoAsset = 0x00100000,
tfOneAssetLPToken = 0x00200000,
tfLimitLPToken = 0x00400000,
}
export interface AMMWithdrawFlagsInterface extends GlobalFlags {
tfLPToken?: boolean
tfWithdrawAll?: boolean
tfOneAssetWithdrawAll?: boolean
tfSingleAsset?: boolean
tfTwoAsset?: boolean
tfOneAssetLPToken?: boolean
tfLimitLPToken?: boolean
}
/**
* AMMWithdraw is the withdraw transaction used to remove liquidity from the AMM
* instance pool, thus redeeming some share of the pools that one owns in the form
* of LPTokenIn.
*
* The following are the recommended valid combinations:
* - LPTokenIn
* - Amount
* - Amount and Amount2
* - Amount and LPTokenIn
* - Amount and EPrice
*/
export interface AMMWithdraw extends BaseTransaction {
TransactionType: 'AMMWithdraw'
/**
* Specifies one of the pool assets (XRP or token) of the AMM instance.
*/
Asset: IssuedCurrency
/**
* Specifies the other pool asset of the AMM instance.
*/
Asset2: IssuedCurrency
/**
* Specifies the amount of shares of the AMM instance pools that the trader
* wants to redeem or trade in.
*/
LPTokenIn?: IssuedCurrencyAmount
/**
* Specifies one of the pools assets that the trader wants to remove.
* If the asset is XRP, then the Amount is a string specifying the number of drops.
* Otherwise it is an IssuedCurrencyAmount object.
*/
Amount?: Amount
/**
* Specifies the other pool asset that the trader wants to remove.
*/
Amount2?: Amount
/**
* Specifies the effective-price of the token out after successful execution of
* the transaction.
*/
EPrice?: Amount
}
/**
* Verify the form and type of an AMMWithdraw at runtime.
*
* @param tx - An AMMWithdraw Transaction.
* @throws When the AMMWithdraw is Malformed.
*/
export function validateAMMWithdraw(tx: Record<string, unknown>): void {
validateBaseTransaction(tx)
if (tx.Asset == null) {
throw new ValidationError('AMMWithdraw: missing field Asset')
}
if (!isIssue(tx.Asset)) {
throw new ValidationError('AMMWithdraw: Asset must be an Issue')
}
if (tx.Asset2 == null) {
throw new ValidationError('AMMWithdraw: missing field Asset2')
}
if (!isIssue(tx.Asset2)) {
throw new ValidationError('AMMWithdraw: Asset2 must be an Issue')
}
if (tx.Amount2 != null && tx.Amount == null) {
throw new ValidationError('AMMWithdraw: must set Amount with Amount2')
} else if (tx.EPrice != null && tx.Amount == null) {
throw new ValidationError('AMMWithdraw: must set Amount with EPrice')
}
if (tx.LPTokenIn != null && !isIssuedCurrency(tx.LPTokenIn)) {
throw new ValidationError(
'AMMWithdraw: LPTokenIn must be an IssuedCurrencyAmount',
)
}
if (tx.Amount != null && !isAmount(tx.Amount)) {
throw new ValidationError('AMMWithdraw: Amount must be an Amount')
}
if (tx.Amount2 != null && !isAmount(tx.Amount2)) {
throw new ValidationError('AMMWithdraw: Amount2 must be an Amount')
}
if (tx.EPrice != null && !isAmount(tx.EPrice)) {
throw new ValidationError('AMMWithdraw: EPrice must be an Amount')
}
}

View File

@@ -44,6 +44,15 @@ export enum AccountSetAsfFlags {
* Allow another account to mint and burn tokens on behalf of this account.
*/
asfAuthorizedNFTokenMinter = 10,
/** asf 11 is reserved for Hooks amendment */
/** Disallow other accounts from creating incoming NFTOffers */
asfDisallowIncomingNFTOffer = 12,
/** Disallow other accounts from creating incoming Checks */
asfDisallowIncomingCheck = 13,
/** Disallow other accounts from creating incoming PayChannels */
asfDisallowIncomingPayChan = 14,
/** Disallow other accounts from creating incoming Trustlines */
asfDisallowIncomingTrustline = 15,
}
/**

View File

@@ -6,7 +6,7 @@ import { TRANSACTION_TYPES } from 'ripple-binary-codec'
import { ValidationError } from '../../errors'
import {
Amount,
IssuedCurrency,
Currency,
IssuedCurrencyAmount,
Memo,
Signer,
@@ -72,7 +72,7 @@ function isRecord(value: unknown): value is Record<string, unknown> {
* @param input - The input to check the form and type of.
* @returns Whether the IssuedCurrency is properly formed.
*/
export function isIssue(input: unknown): input is IssuedCurrency {
export function isCurrency(input: unknown): input is Currency {
return (
isRecord(input) &&
((Object.keys(input).length === ISSUE_SIZE &&
@@ -122,9 +122,9 @@ export function isXChainBridge(input: unknown): input is XChainBridge {
isRecord(input) &&
Object.keys(input).length === XCHAIN_BRIDGE_SIZE &&
typeof input.LockingChainDoor === 'string' &&
isIssue(input.LockingChainIssue) &&
isCurrency(input.LockingChainIssue) &&
typeof input.IssuingChainDoor === 'string' &&
isIssue(input.IssuingChainIssue)
isCurrency(input.IssuingChainIssue)
)
}

View File

@@ -3,7 +3,7 @@ import { ValidationError } from '../../errors'
import { BaseTransaction, validateBaseTransaction } from './common'
/**
* Return escrowed amount to the sender.
* Return escrowed XRP to the sender.
*
* @category Transaction Models
*/

View File

@@ -1,23 +1,22 @@
/* eslint-disable complexity -- Necessary for validateEscrowCreate */
import { ValidationError } from '../../errors'
import { Amount } from '../common'
import { BaseTransaction, isAmount, validateBaseTransaction } from './common'
import { BaseTransaction, validateBaseTransaction } from './common'
/**
* Sequester amount until the escrow process either finishes or is canceled.
* Sequester XRP until the escrow process either finishes or is canceled.
*
* @category Transaction Models
*/
export interface EscrowCreate extends BaseTransaction {
TransactionType: 'EscrowCreate'
/**
* Amount to deduct from the sender's balance and escrow. Once escrowed, the
* amount can either go to the Destination address (after the FinishAfter time)
* or returned to the sender (after the CancelAfter time).
* Amount of XRP, in drops, to deduct from the sender's balance and escrow.
* Once escrowed, the XRP can either go to the Destination address (after the.
* FinishAfter time) or returned to the sender (after the CancelAfter time).
*/
Amount: Amount
/** Address to receive escrowed amount. */
Amount: string
/** Address to receive escrowed XRP. */
Destination: string
/**
* The time, in seconds since the Ripple Epoch, when this escrow expires.
@@ -26,7 +25,7 @@ export interface EscrowCreate extends BaseTransaction {
*/
CancelAfter?: number
/**
* The time, in seconds since the Ripple Epoch, when the escrowed amount can be
* The time, in seconds since the Ripple Epoch, when the escrowed XRP can be
* released to the recipient. This value is immutable; the funds cannot move.
* until this time is reached.
*/
@@ -56,8 +55,8 @@ export function validateEscrowCreate(tx: Record<string, unknown>): void {
throw new ValidationError('EscrowCreate: missing field Amount')
}
if (typeof tx.Amount !== 'string' && !isAmount(tx.Amount)) {
throw new ValidationError('EscrowCreate: Amount must be an Amount')
if (typeof tx.Amount !== 'string') {
throw new ValidationError('EscrowCreate: Amount must be a string')
}
if (tx.Destination === undefined) {

View File

@@ -3,7 +3,7 @@ import { ValidationError } from '../../errors'
import { BaseTransaction, validateBaseTransaction } from './common'
/**
* Deliver amount from a held payment to the recipient.
* Deliver XRP from a held payment to the recipient.
*
* @category Transaction Models
*/

View File

@@ -7,19 +7,6 @@ export {
AccountSet,
} from './accountSet'
export { AccountDelete } from './accountDelete'
export { AMMBid } from './AMMBid'
export {
AMMDepositFlags,
AMMDepositFlagsInterface,
AMMDeposit,
} from './AMMDeposit'
export { AMMCreate } from './AMMCreate'
export { AMMVote } from './AMMVote'
export {
AMMWithdrawFlags,
AMMWithdrawFlagsInterface,
AMMWithdraw,
} from './AMMWithdraw'
export { CheckCancel } from './checkCancel'
export { CheckCash } from './checkCash'
export { CheckCreate } from './checkCreate'

View File

@@ -1,13 +1,7 @@
/* eslint-disable complexity -- Necessary for validatePaymentChannelClaim */
import { ValidationError } from '../../errors'
import { Amount } from '../common'
import {
BaseTransaction,
GlobalFlags,
validateBaseTransaction,
isAmount,
} from './common'
import { BaseTransaction, GlobalFlags, validateBaseTransaction } from './common'
/**
* Enum representing values for PaymentChannelClaim transaction flags.
@@ -24,15 +18,15 @@ export enum PaymentChannelClaimFlags {
/**
* Request to close the channel. Only the channel source and destination
* addresses can use this flag. This flag closes the channel immediately if it
* has no more funds allocated to it after processing the current claim, or if
* has no more XRP allocated to it after processing the current claim, or if
* the destination address uses it. If the source address uses this flag when
* the channel still holds an amount, this schedules the channel to close after
* the channel still holds XRP, this schedules the channel to close after
* SettleDelay seconds have passed. (Specifically, this sets the Expiration of
* the channel to the close time of the previous ledger plus the channel's
* SettleDelay time, unless the channel already has an earlier Expiration
* time.) If the destination address uses this flag when the channel still
* holds an amount, any amount that remains after processing the claim is
* returned to the source address.
* holds XRP, any XRP that remains after processing the claim is returned to
* the source address.
*/
tfClose = 0x00020000,
}
@@ -84,21 +78,21 @@ export interface PaymentChannelClaimFlagsInterface extends GlobalFlags {
/**
* Request to close the channel. Only the channel source and destination
* addresses can use this flag. This flag closes the channel immediately if it
* has no more funds allocated to it after processing the current claim, or if
* has no more XRP allocated to it after processing the current claim, or if
* the destination address uses it. If the source address uses this flag when
* the channel still holds an amount, this schedules the channel to close after
* the channel still holds XRP, this schedules the channel to close after
* SettleDelay seconds have passed. (Specifically, this sets the Expiration of
* the channel to the close time of the previous ledger plus the channel's
* SettleDelay time, unless the channel already has an earlier Expiration
* time.) If the destination address uses this flag when the channel still
* holds an amount, any amount that remains after processing the claim is
* returned to the source address.
* holds XRP, any XRP that remains after processing the claim is returned to
* the source address.
*/
tfClose?: boolean
}
/**
* Claim amount from a payment channel, adjust the payment channel's expiration,
* Claim XRP from a payment channel, adjust the payment channel's expiration,
* or both.
*
* @category Transaction Models
@@ -109,18 +103,18 @@ export interface PaymentChannelClaim extends BaseTransaction {
/** The unique ID of the channel as a 64-character hexadecimal string. */
Channel: string
/**
* Total amount delivered by this channel after processing this claim. Required
* to deliver amount. Must be more than the total amount delivered by the channel
* so far, but not greater than the Amount of the signed claim. Must be provided
* except when closing the channel.
* Total amount of XRP, in drops, delivered by this channel after processing
* this claim. Required to deliver XRP. Must be more than the total amount
* delivered by the channel so far, but not greater than the Amount of the
* signed claim. Must be provided except when closing the channel.
*/
Balance?: Amount
Balance?: string
/**
* The amount authorized by the Signature. This must match the amount in the
* signed message. This is the cumulative amount that can be dispensed by the
* channel, including amounts previously redeemed. Required unless closing the channel.
* The amount of XRP, in drops, authorized by the Signature. This must match
* the amount in the signed message. This is the cumulative amount of XRP that
* can be dispensed by the channel, including XRP previously redeemed.
*/
Amount?: Amount
Amount?: string
/**
* The signature of this claim, as hexadecimal. The signed message contains
* the channel ID and the amount of the claim. Required unless the sender of
@@ -153,12 +147,12 @@ export function validatePaymentChannelClaim(tx: Record<string, unknown>): void {
throw new ValidationError('PaymentChannelClaim: Channel must be a string')
}
if (tx.Balance !== undefined && !isAmount(tx.Balance)) {
throw new ValidationError('PaymentChannelClaim: Balance must be an Amount')
if (tx.Balance !== undefined && typeof tx.Balance !== 'string') {
throw new ValidationError('PaymentChannelClaim: Balance must be a string')
}
if (tx.Amount !== undefined && !isAmount(tx.Amount)) {
throw new ValidationError('PaymentChannelClaim: Amount must be an Amount')
if (tx.Amount !== undefined && typeof tx.Amount !== 'string') {
throw new ValidationError('PaymentChannelClaim: Amount must be a string')
}
if (tx.Signature !== undefined && typeof tx.Signature !== 'string') {

View File

@@ -1,11 +1,10 @@
/* eslint-disable complexity -- Necessary for validatePaymentChannelCreate */
import { ValidationError } from '../../errors'
import { Amount } from '../common'
import { BaseTransaction, validateBaseTransaction, isAmount } from './common'
import { BaseTransaction, validateBaseTransaction } from './common'
/**
* Create a unidirectional channel and fund it. The address sending
* Create a unidirectional channel and fund it with XRP. The address sending
* this transaction becomes the "source address" of the payment channel.
*
* @category Transaction Models
@@ -13,20 +12,20 @@ import { BaseTransaction, validateBaseTransaction, isAmount } from './common'
export interface PaymentChannelCreate extends BaseTransaction {
TransactionType: 'PaymentChannelCreate'
/**
* Amount to deduct from the sender's balance and set aside in this channel.
* While the channel is open, the amount can only go to the Destination
* address. When the channel closes, any unclaimed amount is returned to
* the source address's balance.
* Amount of XRP, in drops, to deduct from the sender's balance and set aside
* in this channel. While the channel is open, the XRP can only go to the
* Destination address. When the channel closes, any unclaimed XRP is returned
* to the source address's balance.
*/
Amount: Amount
Amount: string
/**
* Address to receive claims against this channel. This is also known as
* Address to receive XRP claims against this channel. This is also known as
* the "destination address" for the channel.
*/
Destination: string
/**
* Amount of time the source address must wait before closing the channel if
* it has unclaimed amount.
* it has unclaimed XRP.
*/
SettleDelay: number
/**
@@ -66,8 +65,8 @@ export function validatePaymentChannelCreate(
throw new ValidationError('PaymentChannelCreate: missing Amount')
}
if (typeof tx.Amount !== 'string' && !isAmount(tx.Amount)) {
throw new ValidationError('PaymentChannelCreate: Amount must be an Amount')
if (typeof tx.Amount !== 'string') {
throw new ValidationError('PaymentChannelCreate: Amount must be a string')
}
if (tx.Destination === undefined) {

View File

@@ -1,10 +1,9 @@
import { ValidationError } from '../../errors'
import { Amount } from '../common'
import { BaseTransaction, validateBaseTransaction, isAmount } from './common'
import { BaseTransaction, validateBaseTransaction } from './common'
/**
* Add additional amount to an open payment channel, and optionally update the
* Add additional XRP to an open payment channel, and optionally update the
* expiration time of the channel. Only the source address of the channel can
* use this transaction.
*
@@ -18,15 +17,16 @@ export interface PaymentChannelFund extends BaseTransaction {
*/
Channel: string
/**
* Amount to add to the channel. Must be a positive amount
* Amount of XRP in drops to add to the channel. Must be a positive amount
* of XRP.
*/
Amount: Amount
Amount: string
/**
* New Expiration time to set for the channel in seconds since the Ripple
* Epoch. This must be later than either the current time plus the SettleDelay
* of the channel, or the existing Expiration of the channel. After the
* Expiration time, any transaction that would access the channel closes the
* channel without taking its normal action. Any unspent amount is returned to
* channel without taking its normal action. Any unspent XRP is returned to
* the source address when the channel closes. (Expiration is separate from
* the channel's immutable CancelAfter time.) For more information, see the
* PayChannel ledger object type.
@@ -55,8 +55,8 @@ export function validatePaymentChannelFund(tx: Record<string, unknown>): void {
throw new ValidationError('PaymentChannelFund: missing Amount')
}
if (typeof tx.Amount !== 'string' && !isAmount(tx.Amount)) {
throw new ValidationError('PaymentChannelFund: Amount must be an Amount')
if (typeof tx.Amount !== 'string') {
throw new ValidationError('PaymentChannelFund: Amount must be a string')
}
if (tx.Expiration !== undefined && typeof tx.Expiration !== 'number') {

View File

@@ -1,4 +1,3 @@
/* eslint-disable max-lines -- necessary to support all transactions */
/* eslint-disable complexity -- verifies 19 tx types hence a lot of checks needed */
/* eslint-disable max-lines-per-function -- need to work with a lot of Tx verifications */
@@ -11,11 +10,6 @@ import { setTransactionFlagsToNumber } from '../utils/flags'
import { AccountDelete, validateAccountDelete } from './accountDelete'
import { AccountSet, validateAccountSet } from './accountSet'
import { AMMBid, validateAMMBid } from './AMMBid'
import { AMMCreate, validateAMMCreate } from './AMMCreate'
import { AMMDeposit, validateAMMDeposit } from './AMMDeposit'
import { AMMVote, validateAMMVote } from './AMMVote'
import { AMMWithdraw, validateAMMWithdraw } from './AMMWithdraw'
import { CheckCancel, validateCheckCancel } from './checkCancel'
import { CheckCash, validateCheckCash } from './checkCash'
import { CheckCreate, validateCheckCreate } from './checkCreate'
@@ -90,11 +84,6 @@ import {
export type Transaction =
| AccountDelete
| AccountSet
| AMMBid
| AMMDeposit
| AMMCreate
| AMMVote
| AMMWithdraw
| CheckCancel
| CheckCash
| CheckCreate
@@ -161,26 +150,6 @@ export function validate(transaction: Record<string, unknown>): void {
validateAccountSet(tx)
break
case 'AMMBid':
validateAMMBid(tx)
break
case 'AMMDeposit':
validateAMMDeposit(tx)
break
case 'AMMCreate':
validateAMMCreate(tx)
break
case 'AMMVote':
validateAMMVote(tx)
break
case 'AMMWithdraw':
validateAMMWithdraw(tx)
break
case 'CheckCancel':
validateCheckCancel(tx)
break

View File

@@ -7,8 +7,6 @@ import {
AccountRootFlags,
} from '../ledger/AccountRoot'
import { AccountSetTfFlags } from '../transactions/accountSet'
import { AMMDepositFlags } from '../transactions/AMMDeposit'
import { AMMWithdrawFlags } from '../transactions/AMMWithdraw'
import { GlobalFlags } from '../transactions/common'
import { OfferCreateFlags } from '../transactions/offerCreate'
import { PaymentFlags } from '../transactions/payment'
@@ -44,7 +42,6 @@ export function parseAccountRootFlags(
*
* @param tx - A transaction to set its flags to its numeric representation.
*/
// eslint-disable-next-line complexity -- necessary
export function setTransactionFlagsToNumber(tx: Transaction): void {
if (tx.Flags == null) {
tx.Flags = 0
@@ -58,12 +55,6 @@ export function setTransactionFlagsToNumber(tx: Transaction): void {
case 'AccountSet':
tx.Flags = convertFlagsToNumber(tx.Flags, AccountSetTfFlags)
return
case 'AMMDeposit':
tx.Flags = convertFlagsToNumber(tx.Flags, AMMDepositFlags)
return
case 'AMMWithdraw':
tx.Flags = convertFlagsToNumber(tx.Flags, AMMWithdrawFlags)
return
case 'OfferCreate':
tx.Flags = convertFlagsToNumber(tx.Flags, OfferCreateFlags)
return

View File

@@ -140,7 +140,7 @@ async function setNextValidSequenceNumber(
tx.Sequence = data.result.account_data.Sequence
}
async function fetchOwnerReserveFee(client: Client): Promise<BigNumber> {
async function fetchAccountDeleteFee(client: Client): Promise<BigNumber> {
const response = await client.request({ command: 'server_state' })
const fee = response.result.state.validated_ledger?.reserve_inc
@@ -172,11 +172,9 @@ async function calculateFeePerTransactionType(
baseFee = product.dp(0, BigNumber.ROUND_CEIL)
}
if (
tx.TransactionType === 'AccountDelete' ||
tx.TransactionType === 'AMMCreate'
) {
baseFee = await fetchOwnerReserveFee(client)
// AccountDelete Transaction
if (tx.TransactionType === 'AccountDelete') {
baseFee = await fetchAccountDeleteFee(client)
}
/*

View File

@@ -1,123 +0,0 @@
import { assert } from 'chai'
import { validate, ValidationError } from '../../src'
/**
* AMMBid Transaction Verification Testing.
*
* Providing runtime verification testing for each specific transaction type.
*/
describe('AMMBid', function () {
let bid
beforeEach(function () {
bid = {
TransactionType: 'AMMBid',
Account: 'rWYkbWkCeg8dP6rXALnjgZSjjLyih5NXm',
Asset: {
currency: 'XRP',
},
Asset2: {
currency: 'ETH',
issuer: 'rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd',
},
BidMin: '5',
BidMax: '10',
AuthAccounts: [
{
AuthAccount: {
Account: 'rNZdsTBP5tH1M6GHC6bTreHAp6ouP8iZSh',
},
},
{
AuthAccount: {
Account: 'rfpFv97Dwu89FTyUwPjtpZBbuZxTqqgTmH',
},
},
{
AuthAccount: {
Account: 'rzzYHPGb8Pa64oqxCzmuffm122bitq3Vb',
},
},
{
AuthAccount: {
Account: 'rhwxHxaHok86fe4LykBom1jSJ3RYQJs1h4',
},
},
],
Sequence: 1337,
} as any
})
it(`verifies valid AMMBid`, function () {
assert.doesNotThrow(() => validate(bid))
})
it(`throws w/ missing field Asset`, function () {
delete bid.Asset
assert.throws(
() => validate(bid),
ValidationError,
'AMMBid: missing field Asset',
)
})
it(`throws w/ Asset must be an Issue`, function () {
bid.Asset = 1234
assert.throws(
() => validate(bid),
ValidationError,
'AMMBid: Asset must be an Issue',
)
})
it(`throws w/ missing field Asset2`, function () {
delete bid.Asset2
assert.throws(
() => validate(bid),
ValidationError,
'AMMBid: missing field Asset2',
)
})
it(`throws w/ Asset2 must be an Issue`, function () {
bid.Asset2 = 1234
assert.throws(
() => validate(bid),
ValidationError,
'AMMBid: Asset2 must be an Issue',
)
})
it(`throws w/ BidMin must be an Amount`, function () {
bid.BidMin = 5
assert.throws(
() => validate(bid),
ValidationError,
'AMMBid: BidMin must be an Amount',
)
})
it(`throws w/ BidMax must be an Amount`, function () {
bid.BidMax = 10
assert.throws(
() => validate(bid),
ValidationError,
'AMMBid: BidMax must be an Amount',
)
})
it(`throws w/ AuthAccounts length must not be greater than 4`, function () {
bid.AuthAccounts.push({
AuthAccount: {
Account: 'r3X6noRsvaLapAKCG78zAtWcbhB3sggS1s',
},
})
assert.throws(
() => validate(bid),
ValidationError,
'AMMBid: AuthAccounts length must not be greater than 4',
)
})
})

View File

@@ -1,103 +0,0 @@
import { assert } from 'chai'
import { validate, ValidationError } from '../../src'
/**
* AMMCreate Transaction Verification Testing.
*
* Providing runtime verification testing for each specific transaction type.
*/
describe('AMMCreate', function () {
let ammCreate
beforeEach(function () {
ammCreate = {
TransactionType: 'AMMCreate',
Account: 'rWYkbWkCeg8dP6rXALnjgZSjjLyih5NXm',
Amount: '1000',
Amount2: {
currency: 'USD',
issuer: 'rPyfep3gcLzkosKC9XiE77Y8DZWG6iWDT9',
value: '1000',
},
TradingFee: 12,
Sequence: 1337,
} as any
})
it(`verifies valid AMMCreate`, function () {
assert.doesNotThrow(() => validate(ammCreate))
})
it(`throws w/ missing Amount`, function () {
delete ammCreate.Amount
assert.throws(
() => validate(ammCreate),
ValidationError,
'AMMCreate: missing field Amount',
)
})
it(`throws w/ Amount must be an Amount`, function () {
ammCreate.Amount = 1000
assert.throws(
() => validate(ammCreate),
ValidationError,
'AMMCreate: Amount must be an Amount',
)
})
it(`throws w/ missing Amount2`, function () {
delete ammCreate.Amount2
assert.throws(
() => validate(ammCreate),
ValidationError,
'AMMCreate: missing field Amount2',
)
})
it(`throws w/ Amount2 must be an Amount`, function () {
ammCreate.Amount2 = 1000
assert.throws(
() => validate(ammCreate),
ValidationError,
'AMMCreate: Amount2 must be an Amount',
)
})
it(`throws w/ missing TradingFee`, function () {
delete ammCreate.TradingFee
assert.throws(
() => validate(ammCreate),
ValidationError,
'AMMCreate: missing field TradingFee',
)
})
it(`throws w/ TradingFee must be a number`, function () {
ammCreate.TradingFee = '12'
assert.throws(
() => validate(ammCreate),
ValidationError,
'AMMCreate: TradingFee must be a number',
)
})
it(`throws when TradingFee is greater than 1000`, function () {
ammCreate.TradingFee = 1001
assert.throws(
() => validate(ammCreate),
ValidationError,
`AMMCreate: TradingFee must be between 0 and 1000`,
)
})
it(`throws when TradingFee is a negative number`, function () {
ammCreate.TradingFee = -1
assert.throws(
() => validate(ammCreate),
ValidationError,
`AMMCreate: TradingFee must be between 0 and 1000`,
)
})
})

View File

@@ -1,175 +0,0 @@
/* eslint-disable no-bitwise -- bitwise necessary for enabling flags */
import { assert } from 'chai'
import { AMMDepositFlags, validate, ValidationError } from '../../src'
/**
* AMMDeposit Transaction Verification Testing.
*
* Providing runtime verification testing for each specific transaction type.
*/
describe('AMMDeposit', function () {
const LPTokenOut = {
currency: 'B3813FCAB4EE68B3D0D735D6849465A9113EE048',
issuer: 'rH438jEAzTs5PYtV6CHZqpDpwCKQmPW9Cg',
value: '1000',
}
let deposit
beforeEach(function () {
deposit = {
TransactionType: 'AMMDeposit',
Account: 'rWYkbWkCeg8dP6rXALnjgZSjjLyih5NXm',
Asset: {
currency: 'XRP',
},
Asset2: {
currency: 'ETH',
issuer: 'rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd',
},
Sequence: 1337,
Flags: 0,
} as any
})
it(`verifies valid AMMDeposit with LPTokenOut`, function () {
deposit.LPTokenOut = LPTokenOut
deposit.Flags |= AMMDepositFlags.tfLPToken
assert.doesNotThrow(() => validate(deposit))
})
it(`verifies valid AMMDeposit with Amount`, function () {
deposit.Amount = '1000'
deposit.Flags |= AMMDepositFlags.tfSingleAsset
assert.doesNotThrow(() => validate(deposit))
})
it(`verifies valid AMMDeposit with Amount and Amount2`, function () {
deposit.Amount = '1000'
deposit.Amount2 = {
currency: 'ETH',
issuer: 'rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd',
value: '2.5',
}
deposit.Flags |= AMMDepositFlags.tfTwoAsset
assert.doesNotThrow(() => validate(deposit))
})
it(`verifies valid AMMDeposit with Amount and LPTokenOut`, function () {
deposit.Amount = '1000'
deposit.LPTokenOut = LPTokenOut
deposit.Flags |= AMMDepositFlags.tfOneAssetLPToken
assert.doesNotThrow(() => validate(deposit))
})
it(`verifies valid AMMDeposit with Amount and EPrice`, function () {
deposit.Amount = '1000'
deposit.EPrice = '25'
deposit.Flags |= AMMDepositFlags.tfLimitLPToken
assert.doesNotThrow(() => validate(deposit))
})
it(`throws w/ missing field Asset`, function () {
delete deposit.Asset
assert.throws(
() => validate(deposit),
ValidationError,
'AMMDeposit: missing field Asset',
)
})
it(`throws w/ Asset must be an Issue`, function () {
deposit.Asset = 1234
assert.throws(
() => validate(deposit),
ValidationError,
'AMMDeposit: Asset must be an Issue',
)
})
it(`throws w/ missing field Asset2`, function () {
delete deposit.Asset2
assert.throws(
() => validate(deposit),
ValidationError,
'AMMDeposit: missing field Asset2',
)
})
it(`throws w/ Asset2 must be an Issue`, function () {
deposit.Asset2 = 1234
assert.throws(
() => validate(deposit),
ValidationError,
'AMMDeposit: Asset2 must be an Issue',
)
})
it(`throws w/ must set at least LPTokenOut or Amount`, function () {
assert.throws(
() => validate(deposit),
ValidationError,
'AMMDeposit: must set at least LPTokenOut or Amount',
)
})
it(`throws w/ must set Amount with Amount2`, function () {
deposit.Amount2 = {
currency: 'ETH',
issuer: 'rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd',
value: '2.5',
}
assert.throws(
() => validate(deposit),
ValidationError,
'AMMDeposit: must set Amount with Amount2',
)
})
it(`throws w/ must set Amount with EPrice`, function () {
deposit.EPrice = '25'
assert.throws(
() => validate(deposit),
ValidationError,
'AMMDeposit: must set Amount with EPrice',
)
})
it(`throws w/ LPTokenOut must be an IssuedCurrencyAmount`, function () {
deposit.LPTokenOut = 1234
assert.throws(
() => validate(deposit),
ValidationError,
'AMMDeposit: LPTokenOut must be an IssuedCurrencyAmount',
)
})
it(`throws w/ Amount must be an Amount`, function () {
deposit.Amount = 1234
assert.throws(
() => validate(deposit),
ValidationError,
'AMMDeposit: Amount must be an Amount',
)
})
it(`throws w/ Amount2 must be an Amount`, function () {
deposit.Amount = '1000'
deposit.Amount2 = 1234
assert.throws(
() => validate(deposit),
ValidationError,
'AMMDeposit: Amount2 must be an Amount',
)
})
it(`throws w/ EPrice must be an Amount`, function () {
deposit.Amount = '1000'
deposit.EPrice = 1234
assert.throws(
() => validate(deposit),
ValidationError,
'AMMDeposit: EPrice must be an Amount',
)
})
})

View File

@@ -1,104 +0,0 @@
import { assert } from 'chai'
import { validate, ValidationError } from '../../src'
/**
* AMMVote Transaction Verification Testing.
*
* Providing runtime verification testing for each specific transaction type.
*/
describe('AMMVote', function () {
let vote
beforeEach(function () {
vote = {
TransactionType: 'AMMVote',
Account: 'rWYkbWkCeg8dP6rXALnjgZSjjLyih5NXm',
Asset: {
currency: 'XRP',
},
Asset2: {
currency: 'ETH',
issuer: 'rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd',
},
TradingFee: 25,
Sequence: 1337,
} as any
})
it(`verifies valid AMMVote`, function () {
assert.doesNotThrow(() => validate(vote))
})
it(`throws w/ missing field Asset`, function () {
delete vote.Asset
assert.throws(
() => validate(vote),
ValidationError,
'AMMVote: missing field Asset',
)
})
it(`throws w/ Asset must be an Issue`, function () {
vote.Asset = 1234
assert.throws(
() => validate(vote),
ValidationError,
'AMMVote: Asset must be an Issue',
)
})
it(`throws w/ missing field Asset2`, function () {
delete vote.Asset2
assert.throws(
() => validate(vote),
ValidationError,
'AMMVote: missing field Asset2',
)
})
it(`throws w/ Asset2 must be an Issue`, function () {
vote.Asset2 = 1234
assert.throws(
() => validate(vote),
ValidationError,
'AMMVote: Asset2 must be an Issue',
)
})
it(`throws w/ missing field TradingFee`, function () {
delete vote.TradingFee
assert.throws(
() => validate(vote),
ValidationError,
'AMMVote: missing field TradingFee',
)
})
it(`throws w/ TradingFee must be a number`, function () {
vote.TradingFee = '25'
assert.throws(
() => validate(vote),
ValidationError,
'AMMVote: TradingFee must be a number',
)
})
it(`throws when TradingFee is greater than AMM_MAX_TRADING_FEE`, function () {
vote.TradingFee = 1001
assert.throws(
() => validate(vote),
ValidationError,
'AMMVote: TradingFee must be between 0 and 1000',
)
})
it(`throws when TradingFee is a negative number`, function () {
vote.TradingFee = -1
assert.throws(
() => validate(vote),
ValidationError,
'AMMVote: TradingFee must be between 0 and 1000',
)
})
})

View File

@@ -1,178 +0,0 @@
/* eslint-disable no-bitwise -- bitwise necessary for enabling flags */
import { assert } from 'chai'
import { AMMWithdrawFlags, validate, ValidationError } from '../../src'
/**
* AMMWithdraw Transaction Verification Testing.
*
* Providing runtime verification testing for each specific transaction type.
*/
describe('AMMWithdraw', function () {
const LPTokenIn = {
currency: 'B3813FCAB4EE68B3D0D735D6849465A9113EE048',
issuer: 'rH438jEAzTs5PYtV6CHZqpDpwCKQmPW9Cg',
value: '1000',
}
let withdraw
beforeEach(function () {
withdraw = {
TransactionType: 'AMMWithdraw',
Account: 'rWYkbWkCeg8dP6rXALnjgZSjjLyih5NXm',
Asset: {
currency: 'XRP',
},
Asset2: {
currency: 'ETH',
issuer: 'rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd',
},
Sequence: 1337,
Flags: 0,
} as any
})
it(`verifies valid AMMWithdraw with LPTokenIn`, function () {
withdraw.LPTokenIn = LPTokenIn
withdraw.Flags |= AMMWithdrawFlags.tfLPToken
assert.doesNotThrow(() => validate(withdraw))
})
it(`verifies valid AMMWithdraw with Amount`, function () {
withdraw.Amount = '1000'
withdraw.Flags |= AMMWithdrawFlags.tfSingleAsset
assert.doesNotThrow(() => validate(withdraw))
})
it(`verifies valid AMMWithdraw with Amount and Amount2`, function () {
withdraw.Amount = '1000'
withdraw.Amount2 = {
currency: 'ETH',
issuer: 'rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd',
value: '2.5',
}
withdraw.Flags |= AMMWithdrawFlags.tfTwoAsset
assert.doesNotThrow(() => validate(withdraw))
})
it(`verifies valid AMMWithdraw with Amount and LPTokenIn`, function () {
withdraw.Amount = '1000'
withdraw.LPTokenIn = LPTokenIn
withdraw.Flags |= AMMWithdrawFlags.tfOneAssetLPToken
assert.doesNotThrow(() => validate(withdraw))
})
it(`verifies valid AMMWithdraw with Amount and EPrice`, function () {
withdraw.Amount = '1000'
withdraw.EPrice = '25'
withdraw.Flags |= AMMWithdrawFlags.tfLimitLPToken
assert.doesNotThrow(() => validate(withdraw))
})
it(`verifies valid AMMWithdraw one asset withdraw all`, function () {
withdraw.Amount = '1000'
withdraw.Flags |= AMMWithdrawFlags.tfOneAssetWithdrawAll
assert.doesNotThrow(() => validate(withdraw))
})
it(`verifies valid AMMWithdraw withdraw all`, function () {
withdraw.Flags |= AMMWithdrawFlags.tfWithdrawAll
assert.doesNotThrow(() => validate(withdraw))
})
it(`throws w/ missing field Asset`, function () {
delete withdraw.Asset
assert.throws(
() => validate(withdraw),
ValidationError,
'AMMWithdraw: missing field Asset',
)
})
it(`throws w/ Asset must be an Issue`, function () {
withdraw.Asset = 1234
assert.throws(
() => validate(withdraw),
ValidationError,
'AMMWithdraw: Asset must be an Issue',
)
})
it(`throws w/ missing field Asset2`, function () {
delete withdraw.Asset2
assert.throws(
() => validate(withdraw),
ValidationError,
'AMMWithdraw: missing field Asset2',
)
})
it(`throws w/ Asset2 must be an Issue`, function () {
withdraw.Asset2 = 1234
assert.throws(
() => validate(withdraw),
ValidationError,
'AMMWithdraw: Asset2 must be an Issue',
)
})
it(`throws w/ must set Amount with Amount2`, function () {
withdraw.Amount2 = {
currency: 'ETH',
issuer: 'rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd',
value: '2.5',
}
assert.throws(
() => validate(withdraw),
ValidationError,
'AMMWithdraw: must set Amount with Amount2',
)
})
it(`throws w/ must set Amount with EPrice`, function () {
withdraw.EPrice = '25'
assert.throws(
() => validate(withdraw),
ValidationError,
'AMMWithdraw: must set Amount with EPrice',
)
})
it(`throws w/ LPTokenIn must be an IssuedCurrencyAmount`, function () {
withdraw.LPTokenIn = 1234
assert.throws(
() => validate(withdraw),
ValidationError,
'AMMWithdraw: LPTokenIn must be an IssuedCurrencyAmount',
)
})
it(`throws w/ Amount must be an Amount`, function () {
withdraw.Amount = 1234
assert.throws(
() => validate(withdraw),
ValidationError,
'AMMWithdraw: Amount must be an Amount',
)
})
it(`throws w/ Amount2 must be an Amount`, function () {
withdraw.Amount = '1000'
withdraw.Amount2 = 1234
assert.throws(
() => validate(withdraw),
ValidationError,
'AMMWithdraw: Amount2 must be an Amount',
)
})
it(`throws w/ EPrice must be an Amount`, function () {
withdraw.Amount = '1000'
withdraw.EPrice = 1234
assert.throws(
() => validate(withdraw),
ValidationError,
'AMMWithdraw: EPrice must be an Amount',
)
})
})

View File

@@ -30,7 +30,7 @@ describe('AccountSet', function () {
})
it(`throws w/ invalid SetFlag (out of range)`, function () {
account.SetFlag = 12
account.SetFlag = 20
assert.throws(
() => validateAccountSet(account),
@@ -60,7 +60,7 @@ describe('AccountSet', function () {
})
it(`throws w/ invalid ClearFlag`, function () {
account.ClearFlag = 12
account.ClearFlag = 20
assert.throws(
() => validateAccountSet(account),

View File

@@ -82,12 +82,12 @@ describe('EscrowCreate', function () {
assert.throws(
() => validateEscrowCreate(escrow),
ValidationError,
'EscrowCreate: Amount must be an Amount',
'EscrowCreate: Amount must be a string',
)
assert.throws(
() => validate(escrow),
ValidationError,
'EscrowCreate: Amount must be an Amount',
'EscrowCreate: Amount must be a string',
)
})

View File

@@ -77,12 +77,12 @@ describe('PaymentChannelClaim', function () {
assert.throws(
() => validatePaymentChannelClaim(channel),
ValidationError,
'PaymentChannelClaim: Balance must be an Amount',
'PaymentChannelClaim: Balance must be a string',
)
assert.throws(
() => validate(channel),
ValidationError,
'PaymentChannelClaim: Balance must be an Amount',
'PaymentChannelClaim: Balance must be a string',
)
})
@@ -92,12 +92,12 @@ describe('PaymentChannelClaim', function () {
assert.throws(
() => validatePaymentChannelClaim(channel),
ValidationError,
'PaymentChannelClaim: Amount must be an Amount',
'PaymentChannelClaim: Amount must be a string',
)
assert.throws(
() => validate(channel),
ValidationError,
'PaymentChannelClaim: Amount must be an Amount',
'PaymentChannelClaim: Amount must be a string',
)
})

View File

@@ -106,12 +106,12 @@ describe('PaymentChannelCreate', function () {
assert.throws(
() => validatePaymentChannelCreate(channel),
ValidationError,
'PaymentChannelCreate: Amount must be an Amount',
'PaymentChannelCreate: Amount must be a string',
)
assert.throws(
() => validate(channel),
ValidationError,
'PaymentChannelCreate: Amount must be an Amount',
'PaymentChannelCreate: Amount must be a string',
)
})

View File

@@ -70,12 +70,12 @@ describe('PaymentChannelFund', function () {
assert.throws(
() => validatePaymentChannelFund(channel),
ValidationError,
'PaymentChannelFund: Amount must be an Amount',
'PaymentChannelFund: Amount must be a string',
)
assert.throws(
() => validate(channel),
ValidationError,
'PaymentChannelFund: Amount must be an Amount',
'PaymentChannelFund: Amount must be a string',
)
})

View File

@@ -151,6 +151,7 @@ describe('Models Utils', function () {
assert.strictEqual(tx.Flags, 0)
})
// eslint-disable-next-line complexity -- Simpler to list them all out at once.
it('parseAccountRootFlags all enabled', function () {
const accountRootFlags =
AccountRootFlags.lsfDefaultRipple |
@@ -161,7 +162,11 @@ describe('Models Utils', function () {
AccountRootFlags.lsfNoFreeze |
AccountRootFlags.lsfPasswordSpent |
AccountRootFlags.lsfRequireAuth |
AccountRootFlags.lsfRequireDestTag
AccountRootFlags.lsfRequireDestTag |
AccountRootFlags.lsfDisallowIncomingNFTOffer |
AccountRootFlags.lsfDisallowIncomingCheck |
AccountRootFlags.lsfDisallowIncomingPayChan |
AccountRootFlags.lsfDisallowIncomingTrustline
const parsed = parseAccountRootFlags(accountRootFlags)
@@ -174,7 +179,11 @@ describe('Models Utils', function () {
parsed.lsfNoFreeze &&
parsed.lsfPasswordSpent &&
parsed.lsfRequireAuth &&
parsed.lsfRequireDestTag,
parsed.lsfRequireDestTag &&
parsed.lsfDisallowIncomingNFTOffer &&
parsed.lsfDisallowIncomingCheck &&
parsed.lsfDisallowIncomingPayChan &&
parsed.lsfDisallowIncomingTrustline,
)
})
@@ -190,6 +199,10 @@ describe('Models Utils', function () {
assert.isUndefined(parsed.lsfPasswordSpent)
assert.isUndefined(parsed.lsfRequireAuth)
assert.isUndefined(parsed.lsfRequireDestTag)
assert.isUndefined(parsed.lsfDisallowIncomingNFTOffer)
assert.isUndefined(parsed.lsfDisallowIncomingCheck)
assert.isUndefined(parsed.lsfDisallowIncomingPayChan)
assert.isUndefined(parsed.lsfDisallowIncomingTrustline)
})
})
})