Compare commits

..

9 Commits

Author SHA1 Message Date
Denis Angell
b054430406 Publish
- @transia/ripple-address-codec@4.2.7
 - @transia/ripple-binary-codec@1.4.5
 - @transia/ripple-keypairs@1.1.7
 - @transia/xrpl@2.7.2
2023-03-28 18:16:46 +00:00
Denis Angell
c29f512345 update readme links 2023-03-28 18:15:31 +00:00
Denis Angell
d86cd8d813 add public access 2023-03-28 17:51:21 +00:00
Denis Angell
40d9c2b1a1 update git head 2023-03-28 17:45:11 +00:00
Denis Angell
6c25d08019 Publish
- @transia/ripple-address-codec@4.2.6
 - @transia/ripple-binary-codec@1.4.4
 - @transia/ripple-keypairs@1.1.6
 - @transia/xrpl@2.7.1
2023-03-28 17:40:48 +00:00
Denis Angell
6f72189c13 update repo name 2023-03-28 17:39:37 +00:00
Denis Angell
5429930c0d update tests 2023-03-27 21:52:49 +00:00
Denis Angell
f82872fe9f add network id (req for sethook) 2023-03-27 21:48:58 +00:00
Denis Angell
8d16592abb add uritoken (req for hook on calc) 2023-03-27 21:48:43 +00:00
89 changed files with 2497 additions and 3500 deletions

View File

@@ -39,7 +39,7 @@ jobs:
# Initializes the CodeQL tools for scanning. # Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL - name: Initialize CodeQL
uses: github/codeql-action/init@v2 uses: github/codeql-action/init@v1
with: with:
languages: ${{ matrix.language }} languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file. # If you wish to specify custom queries, you can do so here or in a config file.
@@ -50,7 +50,7 @@ jobs:
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java). # 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) # If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild - name: Autobuild
uses: github/codeql-action/autobuild@v2 uses: github/codeql-action/autobuild@v1
# Command-line programs to run using the OS shell. # Command-line programs to run using the OS shell.
# 📚 https://git.io/JvXDl # 📚 https://git.io/JvXDl
@@ -64,4 +64,4 @@ jobs:
# make release # make release
- name: Perform CodeQL Analysis - name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v2 uses: github/codeql-action/analyze@v1

4234
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -13,10 +13,10 @@
"update:confirm": "npx npm-check-updates --configFileName .ncurc.json -u" "update:confirm": "npx npm-check-updates --configFileName .ncurc.json -u"
}, },
"dependencies": { "dependencies": {
"@transia/ripple-address-codec": "file:packages/ripple-address-codec", "ripple-address-codec": "file:packages/ripple-address-codec",
"@transia/ripple-binary-codec": "file:packages/ripple-binary-codec", "ripple-binary-codec": "file:packages/ripple-binary-codec",
"@transia/ripple-keypairs": "file:packages/ripple-keypairs", "ripple-keypairs": "file:packages/ripple-keypairs",
"@transia/xrpl": "file:packages/xrpl" "xrpl": "file:packages/xrpl"
}, },
"devDependencies": { "devDependencies": {
"@types/brorand": "^1.0.30", "@types/brorand": "^1.0.30",

View File

@@ -1,12 +1,12 @@
{ {
"name": "ripple-address-codec", "name": "ripple-address-codec",
"version": "4.2.8-alpha.0", "version": "4.2.7",
"lockfileVersion": 2, "lockfileVersion": 2,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "ripple-address-codec", "name": "ripple-address-codec",
"version": "4.2.8-alpha.0", "version": "4.2.7",
"license": "ISC", "license": "ISC",
"dependencies": { "dependencies": {
"base-x": "^3.0.9", "base-x": "^3.0.9",

View File

@@ -1,6 +1,6 @@
{ {
"name": "@transia/ripple-address-codec", "name": "@transia/ripple-address-codec",
"version": "4.2.8-alpha.0", "version": "4.2.7",
"description": "encodes/decodes base58 encoded XRP Ledger identifiers", "description": "encodes/decodes base58 encoded XRP Ledger identifiers",
"files": [ "files": [
"dist/*", "dist/*",
@@ -15,7 +15,7 @@
}, },
"repository": { "repository": {
"type": "git", "type": "git",
"url": "git@github.com/Transia-RnD/xrpl.js/tree/beta" "url": "git@github.com:Transia-RnD/xrpl.js.git"
}, },
"prepublish": "tsc -b", "prepublish": "tsc -b",
"prepublishOnly": "tslint -b ./ && jest", "prepublishOnly": "tslint -b ./ && jest",
@@ -28,5 +28,9 @@
"prettier": "@xrplf/prettier-config", "prettier": "@xrplf/prettier-config",
"engines": { "engines": {
"node": ">= 10" "node": ">= 10"
},
"gitHead": "40d9c2b1a158ab480df7e8b1c7dc2ed3b88afc75",
"publishConfig": {
"access": "public"
} }
} }

View File

@@ -1,6 +1,6 @@
{ {
"name": "@transia/ripple-binary-codec", "name": "@transia/ripple-binary-codec",
"version": "1.4.6-alpha.3", "version": "1.4.5",
"description": "XRP Ledger binary codec", "description": "XRP Ledger binary codec",
"files": [ "files": [
"dist/*", "dist/*",
@@ -12,12 +12,12 @@
"test": "test" "test": "test"
}, },
"dependencies": { "dependencies": {
"@transia/ripple-address-codec": "^4.2.8-alpha.0",
"assert": "^2.0.0", "assert": "^2.0.0",
"big-integer": "^1.6.48", "big-integer": "^1.6.48",
"buffer": "5.6.0", "buffer": "5.6.0",
"create-hash": "^1.2.0", "create-hash": "^1.2.0",
"decimal.js": "^10.2.0" "decimal.js": "^10.2.0",
"ripple-address-codec": "^4.2.5"
}, },
"scripts": { "scripts": {
"build": "tsc -b && copyfiles ./src/enums/definitions.json ./dist/enums/", "build": "tsc -b && copyfiles ./src/enums/definitions.json ./dist/enums/",
@@ -28,16 +28,20 @@
}, },
"repository": { "repository": {
"type": "git", "type": "git",
"url": "git@github.com/Transia-RnD/xrpl.js/tree/beta" "url": "git@github.com:Transia-RnD/xrpl.js.git"
}, },
"bugs": { "bugs": {
"url": "https://github.com/XRPLF/xrpl.js/issues" "url": "https://github.com/Transia-RnD/xrpl.js/issues"
}, },
"homepage": "https://github.com/XRPLF/xrpl.js/tree/main/packages/ripple-binary-codec#readme", "homepage": "https://github.com/Transia-RnD/xrpl.js/tree/main/packages/ripple-binary-codec#readme",
"license": "ISC", "license": "ISC",
"readmeFilename": "README.md", "readmeFilename": "README.md",
"prettier": "@xrplf/prettier-config", "prettier": "@xrplf/prettier-config",
"engines": { "engines": {
"node": ">= 10" "node": ">= 10"
},
"gitHead": "6c25d08019d06534525a4a2bf41bf0e135a79849",
"publishConfig": {
"access": "public"
} }
} }

View File

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

View File

@@ -37,7 +37,6 @@
"LedgerHashes": 104, "LedgerHashes": 104,
"Amendments": 102, "Amendments": 102,
"FeeSettings": 115, "FeeSettings": 115,
"ImportVlseq": 73,
"Escrow": 117, "Escrow": 117,
"PayChannel": 120, "PayChannel": 120,
"Check": 67, "Check": 67,
@@ -780,67 +779,7 @@
[ [
"LockCount", "LockCount",
{ {
"nth": 49, "nth": 47,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "UInt32"
}
],
[
"FirstNFTokenSequence",
{
"nth": 50,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "UInt32"
}
],
[
"XahauActivationLgrSeq",
{
"nth": 96,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "UInt32"
}
],
[
"ImportSequence",
{
"nth": 97,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "UInt32"
}
],
[
"RewardTime",
{
"nth": 98,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "UInt32"
}
],
[
"RewardLgrFirst",
{
"nth": 99,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "UInt32"
}
],
[
"RewardLgrLast",
{
"nth": 100,
"isVLEncoded": false, "isVLEncoded": false,
"isSerialized": true, "isSerialized": true,
"isSigningField": true, "isSigningField": true,
@@ -1007,36 +946,6 @@
"type": "UInt64" "type": "UInt64"
} }
], ],
[
"AccountIndex",
{
"nth": 98,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "UInt64"
}
],
[
"AccountCount",
{
"nth": 99,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "UInt64"
}
],
[
"RewardAccumulator",
{
"nth": 100,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "UInt64"
}
],
[ [
"EmailHash", "EmailHash",
{ {
@@ -1427,36 +1336,6 @@
"type": "Hash256" "type": "Hash256"
} }
], ],
[
"GovernanceFlags",
{
"nth": 99,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "Hash256"
}
],
[
"GovernanceMarks",
{
"nth": 98,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "Hash256"
}
],
[
"EmittedTxnID",
{
"nth": 97,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "Hash256"
}
],
[ [
"Amount", "Amount",
{ {
@@ -1617,36 +1496,6 @@
"type": "Amount" "type": "Amount"
} }
], ],
[
"BaseFeeDrops",
{
"nth": 22,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "Amount"
}
],
[
"ReserveBaseDrops",
{
"nth": 23,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "Amount"
}
],
[
"ReserveIncrementDrops",
{
"nth": 24,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "Amount"
}
],
[ [
"PublicKey", "PublicKey",
{ {
@@ -2267,46 +2116,6 @@
"type": "STObject" "type": "STObject"
} }
], ],
[
"GenesisMint",
{
"nth": 96,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "STObject"
}
],
[
"ActiveValidator",
{
"nth": 95,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "STObject"
}
],
[
"ImportVLKey",
{
"nth": 94,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "STObject"
}
],
[
"HookEmission",
{
"nth": 93,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "STObject"
}
],
[ [
"Signers", "Signers",
{ {
@@ -2446,46 +2255,6 @@
"isSigningField": true, "isSigningField": true,
"type": "STArray" "type": "STArray"
} }
],
[
"GenesisMints",
{
"nth": 96,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "STArray"
}
],
[
"ActiveValidators",
{
"nth": 95,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "STArray"
}
],
[
"ImportVLKeys",
{
"nth": 94,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "STArray"
}
],
[
"HookEmissions",
{
"nth": 93,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "STArray"
}
] ]
], ],
"TRANSACTION_RESULTS": { "TRANSACTION_RESULTS": {
@@ -2506,8 +2275,6 @@
"telREQUIRES_NETWORK_ID": -385, "telREQUIRES_NETWORK_ID": -385,
"telNETWORK_ID_MAKES_TX_NON_CANONICAL": -384, "telNETWORK_ID_MAKES_TX_NON_CANONICAL": -384,
"telNON_LOCAL_EMITTED_TXN": -383, "telNON_LOCAL_EMITTED_TXN": -383,
"telIMPORT_VL_KEY_NOT_RECOGNISED": -382,
"telCAN_NOT_QUEUE_IMPORT": -381,
"temMALFORMED": -299, "temMALFORMED": -299,
"temBAD_AMOUNT": -298, "temBAD_AMOUNT": -298,
@@ -2548,10 +2315,10 @@
"temSEQ_AND_TICKET": -263, "temSEQ_AND_TICKET": -263,
"temBAD_NFTOKEN_TRANSFER_FEE": -262, "temBAD_NFTOKEN_TRANSFER_FEE": -262,
"temAMM_BAD_TOKENS": -261, "temAMM_BAD_TOKENS": -261,
"temXCHAIN_EQUAL_DOOR_ACCOUNTS": -260, "temEQUAL_DOOR_ACCOUNTS": -260,
"temXCHAIN_BAD_PROOF": -259, "temBAD_XCHAIN_PROOF": -259,
"temXCHAIN_BRIDGE_BAD_ISSUES": -258, "temSIDECHAIN_BAD_ISSUES": -258,
"temXCHAIN_BRIDGE_NONDOOR_OWNER": -257, "temSIDECHAIN_NONDOOR_OWNER": -257,
"temXCHAIN_BRIDGE_BAD_MIN_ACCOUNT_CREATE_AMOUNT": -256, "temXCHAIN_BRIDGE_BAD_MIN_ACCOUNT_CREATE_AMOUNT": -256,
"temXCHAIN_BRIDGE_BAD_REWARD_AMOUNT": -255, "temXCHAIN_BRIDGE_BAD_REWARD_AMOUNT": -255,
"temXCHAIN_TOO_MANY_ATTESTATIONS": -254, "temXCHAIN_TOO_MANY_ATTESTATIONS": -254,
@@ -2579,8 +2346,6 @@
"tefTOO_BIG": -181, "tefTOO_BIG": -181,
"tefNO_TICKET": -180, "tefNO_TICKET": -180,
"tefNFTOKEN_IS_NOT_TRANSFERABLE": -179, "tefNFTOKEN_IS_NOT_TRANSFERABLE": -179,
"tefPAST_IMPORT_SEQ": -178,
"tefPAST_IMPORT_VL_SEQ": -177,
"terRETRY": -99, "terRETRY": -99,
"terFUNDS_SPENT": -98, "terFUNDS_SPENT": -98,
@@ -2594,8 +2359,7 @@
"terNO_RIPPLE": -90, "terNO_RIPPLE": -90,
"terQUEUED": -89, "terQUEUED": -89,
"terPRE_TICKET": -88, "terPRE_TICKET": -88,
"terNO_AMM": -87, "terNO_HOOK": -87,
"terNO_HOOK": -86,
"tesSUCCESS": 0, "tesSUCCESS": 0,
@@ -2670,8 +2434,7 @@
"tecXCHAIN_ACCOUNT_CREATE_TOO_MANY": 183, "tecXCHAIN_ACCOUNT_CREATE_TOO_MANY": 183,
"tecXCHAIN_PAYMENT_FAILED": 184, "tecXCHAIN_PAYMENT_FAILED": 184,
"tecXCHAIN_SELF_COMMIT": 185, "tecXCHAIN_SELF_COMMIT": 185,
"tecXCHAIN_BAD_PUBLIC_KEY_ACCOUNT_PAIR": 186, "tecXCHAIN_BAD_PUBLIC_KEY_ACCOUNT_PAIR": 186
"tecLAST_POSSIBLE_ENTRY": 255
}, },
"TRANSACTION_TYPES": { "TRANSACTION_TYPES": {
"Invalid": -1, "Invalid": -1,
@@ -2708,14 +2471,10 @@
"URITokenBuy": 47, "URITokenBuy": 47,
"URITokenCreateSellOffer": 48, "URITokenCreateSellOffer": 48,
"URITokenCancelSellOffer": 49, "URITokenCancelSellOffer": 49,
"GenesisMint": 96,
"Import": 97,
"ClaimReward": 98,
"Invoke": 99, "Invoke": 99,
"EnableAmendment": 100, "EnableAmendment": 100,
"SetFee": 101, "SetFee": 101,
"UNLModify": 102, "UNLModify": 102,
"EmitFailure": 103, "EmitFailure": 103
"UNLReport": 104
} }
} }

View File

@@ -3,7 +3,7 @@ import {
encodeAccountID, encodeAccountID,
isValidXAddress, isValidXAddress,
xAddressToClassicAddress, xAddressToClassicAddress,
} from '@transia/ripple-address-codec' } from 'ripple-address-codec'
import { Hash160 } from './hash-160' import { Hash160 } from './hash-160'
import { Buffer } from 'buffer/' import { Buffer } from 'buffer/'

View File

@@ -5,10 +5,7 @@ import {
XrplDefinitionsBase, XrplDefinitionsBase,
} from '../enums' } from '../enums'
import { SerializedType, JsonObject } from './serialized-type' import { SerializedType, JsonObject } from './serialized-type'
import { import { xAddressToClassicAddress, isValidXAddress } from 'ripple-address-codec'
xAddressToClassicAddress,
isValidXAddress,
} from '@transia/ripple-address-codec'
import { BinaryParser } from '../serdes/binary-parser' import { BinaryParser } from '../serdes/binary-parser'
import { BinarySerializer, BytesList } from '../serdes/binary-serializer' import { BinarySerializer, BytesList } from '../serdes/binary-serializer'
import { Buffer } from 'buffer/' import { Buffer } from 'buffer/'

View File

@@ -1,7 +1,7 @@
const { coreTypes } = require('../src/types') const { coreTypes } = require('../src/types')
const Decimal = require('decimal.js') const Decimal = require('decimal.js')
const { encodeAccountID } = require('@transia/ripple-address-codec') const { encodeAccountID } = require('ripple-address-codec')
const { binary } = require('../src/coretypes') const { binary } = require('../src/coretypes')
const { Amount, Hash160 } = coreTypes const { Amount, Hash160 } = coreTypes
const { makeParser, readJSON } = binary const { makeParser, readJSON } = binary

View File

@@ -44,7 +44,7 @@ describe('encode and decode using new types as a parameter', function () {
definitions.FIELDS.push([ definitions.FIELDS.push([
'NewFieldDefinition', 'NewFieldDefinition',
{ {
nth: 101, nth: 100,
isVLEncoded: false, isVLEncoded: false,
isSerialized: true, isSerialized: true,
isSigningField: true, isSigningField: true,

View File

@@ -170,7 +170,59 @@ describe('Signing data', function () {
].join(''), ].join(''),
) )
}) })
test('can create native claim blob', function () {
test('can create multi signing blobs with custom definitions', function () {
const customPaymentDefinitions = JSON.parse(
JSON.stringify(normalDefinitions),
)
customPaymentDefinitions.TRANSACTION_TYPES.Payment = 31
const newDefs = new XrplDefinitions(customPaymentDefinitions)
const signingAccount = 'rJZdUusLDtY9NEsGea7ijqhVrXv98rYBYN'
const signingJson = { ...tx_json, SigningPubKey: '' }
const actual = encodeForMultisigning(signingJson, signingAccount, newDefs)
expect(actual).toBe(
[
'534D5400', // signingPrefix
// TransactionType
'12',
'001F',
// Flags
'22',
'80000000',
// Sequence
'24',
'00000001',
// Amount
'61',
// native amount
'40000000000003E8',
// Fee
'68',
// native amount
'400000000000000A',
// SigningPubKey
'73',
// VLLength
'00',
// '',
// Account
'81',
// VLLength
'14',
'5B812C9D57731E27A2DA8B1830195F88EF32A3B6',
// Destination
'83',
// VLLength
'14',
'B5F762798A53D543A014CAF8B297CFF8F2F937E8',
// signingAccount suffix
'C0A5ABEF242802EFED4B041E8F2D4A8CC86AE3D1',
].join(''),
)
})
test('can create claim blob', function () {
const channel = const channel =
'43904CBFCDCEC530B4037871F86EE90BF799DF8D2E0EA564BC8A3F332E4F5FB1' '43904CBFCDCEC530B4037871F86EE90BF799DF8D2E0EA564BC8A3F332E4F5FB1'
const amount = '1000' const amount = '1000'
@@ -187,27 +239,4 @@ describe('Signing data', function () {
].join(''), ].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

@@ -1,6 +1,6 @@
{ {
"name": "@transia/ripple-keypairs", "name": "@transia/ripple-keypairs",
"version": "1.1.8-alpha.0", "version": "1.1.7",
"description": "Cryptographic key pairs for the XRP Ledger", "description": "Cryptographic key pairs for the XRP Ledger",
"scripts": { "scripts": {
"build": "tsc -b", "build": "tsc -b",
@@ -17,19 +17,23 @@
"test": "test" "test": "test"
}, },
"dependencies": { "dependencies": {
"@transia/ripple-address-codec": "^4.2.8-alpha.0",
"bn.js": "^5.1.1", "bn.js": "^5.1.1",
"brorand": "^1.0.5", "brorand": "^1.0.5",
"elliptic": "^6.5.4", "elliptic": "^6.5.4",
"hash.js": "^1.0.3" "hash.js": "^1.0.3",
"ripple-address-codec": "^4.2.5"
}, },
"repository": { "repository": {
"type": "git", "type": "git",
"url": "git@github.com/Transia-RnD/xrpl.js/tree/beta" "url": "git@github.com:Transia-RnD/xrpl.js.git"
}, },
"license": "ISC", "license": "ISC",
"prettier": "@xrplf/prettier-config", "prettier": "@xrplf/prettier-config",
"engines": { "engines": {
"node": ">= 10" "node": ">= 10"
},
"gitHead": "40d9c2b1a158ab480df7e8b1c7dc2ed3b88afc75",
"publishConfig": {
"access": "public"
} }
} }

View File

@@ -3,7 +3,7 @@ import brorand = require('brorand')
import * as hashjs from 'hash.js' import * as hashjs from 'hash.js'
import * as elliptic from 'elliptic' import * as elliptic from 'elliptic'
import * as addressCodec from '@transia/ripple-address-codec' import * as addressCodec from 'ripple-address-codec'
import { derivePrivateKey, accountPublicFromPublicGenerator } from './secp256k1' import { derivePrivateKey, accountPublicFromPublicGenerator } from './secp256k1'
import * as utils from './utils' import * as utils from './utils'

View File

@@ -1,5 +1,5 @@
import assert from 'assert' import assert from 'assert'
import * as api from '@transia/ripple-address-codec' import * as api from 'ripple-address-codec'
function toHex(bytes) { function toHex(bytes) {
return Buffer.from(bytes).toString('hex').toUpperCase() return Buffer.from(bytes).toString('hex').toUpperCase()

View File

@@ -1,5 +1,5 @@
import assert from 'assert' import assert from 'assert'
import * as api from '@transia/ripple-address-codec' import * as api from 'ripple-address-codec'
function toHex(bytes: Buffer) { function toHex(bytes: Buffer) {
return Buffer.from(bytes).toString('hex').toUpperCase() return Buffer.from(bytes).toString('hex').toUpperCase()

View File

@@ -1,6 +1,6 @@
{ {
"name": "@transia/xrpl", "name": "@transia/xrpl",
"version": "2.7.3-alpha.15", "version": "2.7.2",
"license": "ISC", "license": "ISC",
"description": "A TypeScript/JavaScript API for interacting with the XRP Ledger in Node.js and the browser", "description": "A TypeScript/JavaScript API for interacting with the XRP Ledger in Node.js and the browser",
"files": [ "files": [
@@ -22,14 +22,14 @@
"https-proxy-agent": false "https-proxy-agent": false
}, },
"dependencies": { "dependencies": {
"@transia/ripple-address-codec": "^4.2.8-alpha.0",
"@transia/ripple-binary-codec": "^1.4.6-alpha.3",
"@transia/ripple-keypairs": "^1.1.8-alpha.0",
"bignumber.js": "^9.0.0", "bignumber.js": "^9.0.0",
"bip32": "^2.0.6", "bip32": "^2.0.6",
"bip39": "^3.0.4", "bip39": "^3.0.4",
"https-proxy-agent": "^5.0.0", "https-proxy-agent": "^5.0.0",
"lodash": "^4.17.4", "lodash": "^4.17.4",
"ripple-address-codec": "^4.2.5",
"ripple-binary-codec": "^1.4.3",
"ripple-keypairs": "^1.1.5",
"ws": "^8.2.2" "ws": "^8.2.2"
}, },
"devDependencies": { "devDependencies": {
@@ -75,10 +75,14 @@
"prettier": "@xrplf/prettier-config", "prettier": "@xrplf/prettier-config",
"repository": { "repository": {
"type": "git", "type": "git",
"url": "git@github.com/Transia-RnD/xrpl.js/tree/beta" "url": "git@github.com:Transia-RnD/xrpl.js.git"
}, },
"readmeFilename": "README.md", "readmeFilename": "README.md",
"engines": { "engines": {
"node": ">=10.13.0" "node": ">=10.13.0"
},
"gitHead": "40d9c2b1a158ab480df7e8b1c7dc2ed3b88afc75",
"publishConfig": {
"access": "public"
} }
} }

View File

@@ -1,7 +1,7 @@
import { IncomingMessage } from 'http' import { IncomingMessage } from 'http'
import { request as httpsRequest, RequestOptions } from 'https' import { request as httpsRequest, RequestOptions } from 'https'
import { isValidClassicAddress } from '@transia/ripple-address-codec' import { isValidClassicAddress } from 'ripple-address-codec'
import type { Client } from '../client' import type { Client } from '../client'
import { RippledError, XRPLFaucetError } from '../errors' import { RippledError, XRPLFaucetError } from '../errors'

View File

@@ -1,28 +1,28 @@
/* eslint-disable max-lines -- There are lots of equivalent constructors which make sense to have here. */ /* eslint-disable max-lines -- There are lots of equivalent constructors which make sense to have here. */
import BigNumber from 'bignumber.js'
import { fromSeed } from 'bip32'
import { mnemonicToSeedSync, validateMnemonic } from 'bip39'
import isEqual from 'lodash/isEqual'
import omitBy from 'lodash/omitBy'
import { import {
classicAddressToXAddress, classicAddressToXAddress,
isValidXAddress, isValidXAddress,
xAddressToClassicAddress, xAddressToClassicAddress,
encodeSeed, encodeSeed,
} from '@transia/ripple-address-codec' } from 'ripple-address-codec'
import { import {
decode, decode,
encodeForSigning, encodeForSigning,
encodeForMultisigning, encodeForMultisigning,
encode, encode,
} from '@transia/ripple-binary-codec' } from 'ripple-binary-codec'
import { import {
deriveAddress, deriveAddress,
deriveKeypair, deriveKeypair,
generateSeed, generateSeed,
verify, verify,
sign, sign,
} from '@transia/ripple-keypairs' } from 'ripple-keypairs'
import BigNumber from 'bignumber.js'
import { fromSeed } from 'bip32'
import { mnemonicToSeedSync, validateMnemonic } from 'bip39'
import isEqual from 'lodash/isEqual'
import omitBy from 'lodash/omitBy'
import ECDSA from '../ECDSA' import ECDSA from '../ECDSA'
import { ValidationError, XrplError } from '../errors' import { ValidationError, XrplError } from '../errors'

View File

@@ -1,13 +1,13 @@
import { decodeAccountID } from '@transia/ripple-address-codec' import { BigNumber } from 'bignumber.js'
import { flatMap } from 'lodash'
import { decodeAccountID } from 'ripple-address-codec'
import { import {
decode, decode,
encode, encode,
encodeForSigning, encodeForSigning,
encodeForSigningClaim, encodeForSigningClaim,
} from '@transia/ripple-binary-codec' } from 'ripple-binary-codec'
import { sign as signWithKeypair, verify } from '@transia/ripple-keypairs' import { sign as signWithKeypair, verify } from 'ripple-keypairs'
import { BigNumber } from 'bignumber.js'
import { flatMap } from 'lodash'
import { ValidationError } from '../errors' import { ValidationError } from '../errors'
import { Signer } from '../models/common' import { Signer } from '../models/common'

View File

@@ -101,7 +101,6 @@ import {
getXrpBalance, getXrpBalance,
submit, submit,
submitAndWait, submitAndWait,
getNetworkID,
} from '../sugar' } from '../sugar'
import fundWallet from '../Wallet/fundWallet' import fundWallet from '../Wallet/fundWallet'
@@ -201,13 +200,6 @@ class Client extends EventEmitter {
*/ */
public readonly maxFeeXRP: string public readonly maxFeeXRP: string
/**
* Network ID of the server this sdk is connected to
*
* @category Fee
*/
public networkID: number
/** /**
* Creates a new Client with a websocket connection to a rippled server. * Creates a new Client with a websocket connection to a rippled server.
* *
@@ -226,7 +218,6 @@ class Client extends EventEmitter {
this.feeCushion = options.feeCushion ?? DEFAULT_FEE_CUSHION this.feeCushion = options.feeCushion ?? DEFAULT_FEE_CUSHION
this.maxFeeXRP = options.maxFeeXRP ?? DEFAULT_MAX_FEE_XRP this.maxFeeXRP = options.maxFeeXRP ?? DEFAULT_MAX_FEE_XRP
this.networkID = 1
this.connection = new Connection(server, options) this.connection = new Connection(server, options)
@@ -643,11 +634,6 @@ class Client extends EventEmitter {
*/ */
public getLedgerIndex = getLedgerIndex public getLedgerIndex = getLedgerIndex
/**
* @category Abstraction
*/
public getNetworkID = getNetworkID
/** /**
* @category Faucet * @category Faucet
*/ */

View File

@@ -1,5 +1,5 @@
import { decode } from '@transia/ripple-binary-codec'
import BigNumber from 'bignumber.js' import BigNumber from 'bignumber.js'
import { decode } from 'ripple-binary-codec'
import type { import type {
AccountTxResponse, AccountTxResponse,

View File

@@ -97,15 +97,14 @@ export interface Hook {
* The object that describes the hook in Hooks. * The object that describes the hook in Hooks.
*/ */
Hook: { Hook: {
HookHash?: string
/** /**
* The code that is executed when the hook is triggered. * The code that is executed when the hook is triggered.
*/ */
CreateCode?: string CreateCode: string
/** /**
* The flags that are set on the hook. * The flags that are set on the hook.
*/ */
Flags?: number Flags: number
/** /**
* The transactions that triggers the hook. Represented as a 256Hash * The transactions that triggers the hook. Represented as a 256Hash
*/ */
@@ -195,13 +194,3 @@ export interface NFTOffer {
destination?: string destination?: string
expiration?: number expiration?: number
} }
/**
* This information is added to emitted Transactions.
*/
export interface EmitDetails {
EmitBurden: number
EmitGeneration: number
EmitHookHash: string
EmitParentTxnID: string
}

View File

@@ -72,10 +72,6 @@ export default interface AccountRoot extends BaseLedgerEntry {
* account to each other. * account to each other.
*/ */
TransferRate?: number TransferRate?: number
ImportSequence?: string
GovernanceFlags?: string
GovernanceMarks?: string
AccountIndex?: number
} }
/** /**

View File

@@ -1,9 +1,7 @@
import { Amount } from '../common'
import BaseLedgerEntry from './BaseLedgerEntry' 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. * executed or canceled.
* *
* @category Ledger Entries * @category Ledger Entries
@@ -12,17 +10,17 @@ export default interface Escrow extends BaseLedgerEntry {
LedgerEntryType: 'Escrow' LedgerEntryType: 'Escrow'
/** /**
* The address of the owner (sender) of this held payment. This is the * 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. * canceled.
*/ */
Account: string 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. * successful.
*/ */
Destination: string Destination: string
/** The amount to be delivered by the held payment. */ /** The amount of XRP, in drops, to be delivered by the held payment. */
Amount: Amount Amount: string
/** /**
* A PREIMAGE-SHA-256 crypto-condition, as hexadecimal. If present, the * A PREIMAGE-SHA-256 crypto-condition, as hexadecimal. If present, the
* EscrowFinish transaction must contain a fulfillment that satisfies this * EscrowFinish transaction must contain a fulfillment that satisfies this
@@ -73,9 +71,4 @@ export default interface Escrow extends BaseLedgerEntry {
* modified this object. * modified this object.
*/ */
PreviousTxnLgrSeq: number 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

@@ -24,6 +24,4 @@ export default interface FeeSettings extends BaseLedgerEntry {
* type. * type.
*/ */
Flags: number Flags: number
XahauActivationLgrSeq?: number
AccountCount?: number
} }

View File

@@ -1,19 +0,0 @@
import BaseLedgerEntry from './BaseLedgerEntry'
/**
*
*
*
* @category Ledger Entries
*/
export default interface ImportVLSequence extends BaseLedgerEntry {
LedgerEntryType: 'ImportVLSequence'
/**
*
*/
PublicKey: string
/**
*
*/
ImportSequence: string
}

View File

@@ -9,7 +9,6 @@ import FeeSettings from './FeeSettings'
import Hook from './Hook' import Hook from './Hook'
import HookDefinition from './HookDefinition' import HookDefinition from './HookDefinition'
import HookState from './HookState' import HookState from './HookState'
import ImportVLSequence from './ImportVLSequence'
import LedgerHashes from './LedgerHashes' import LedgerHashes from './LedgerHashes'
import NegativeUNL from './NegativeUNL' import NegativeUNL from './NegativeUNL'
import Offer from './Offer' import Offer from './Offer'
@@ -17,8 +16,6 @@ import PayChannel from './PayChannel'
import RippleState from './RippleState' import RippleState from './RippleState'
import SignerList from './SignerList' import SignerList from './SignerList'
import Ticket from './Ticket' import Ticket from './Ticket'
import UNLReport from './UNLReport'
import URIToken from './URIToken'
type LedgerEntry = type LedgerEntry =
| AccountRoot | AccountRoot
@@ -32,7 +29,6 @@ type LedgerEntry =
| Hook | Hook
| HookDefinition | HookDefinition
| HookState | HookState
| ImportVLSequence
| LedgerHashes | LedgerHashes
| NegativeUNL | NegativeUNL
| Offer | Offer
@@ -40,7 +36,5 @@ type LedgerEntry =
| RippleState | RippleState
| SignerList | SignerList
| Ticket | Ticket
| UNLReport
| URIToken
export default LedgerEntry export default LedgerEntry

View File

@@ -1,11 +1,9 @@
import { Amount } from '../common'
import BaseLedgerEntry from './BaseLedgerEntry' import BaseLedgerEntry from './BaseLedgerEntry'
/** /**
* The PayChannel object type represents a payment channel. Payment channels * The PayChannel object type represents a payment channel. Payment channels
* enable small, rapid off-ledger payments that can be later reconciled * enable small, rapid off-ledger payments of XRP that can be later reconciled
* with the consensus ledger. A payment channel holds a balance that can * 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 * only be paid out to a specific destination address until the channel is
* closed. * closed.
* *
@@ -20,37 +18,37 @@ export default interface PayChannel extends BaseLedgerEntry {
Account: string Account: string
/** /**
* The destination address for this payment channel. While the payment * 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 * channel. This comes from the Destination field of the transaction that
* created the channel. * created the channel.
*/ */
Destination: string Destination: string
/** /**
* Total amount that has been allocated to this channel. This includes amounts * Total XRP, in drops, that has been allocated to this channel. This
* that have been paid to the destination address. This is initially set by the * includes XRP that has been paid to the destination address. This is
* transaction that created the channel and can be increased if the source * initially set by the transaction that created the channel and can be
* address sends a PaymentChannelFund transaction. * 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 * Total XRP, in drops, already paid out by the channel. The difference
* and the Amount field is how much can still be paid to the destination address * between this value and the Amount field is how much XRP can still be paid
* with PaymentChannelClaim transactions. If the channel closes, the remaining * to the destination address with PaymentChannelClaim transactions. If the
* difference is returned to the source address. * 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 * 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 * 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 * 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 * 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. * without signed claims.
*/ */
PublicKey: string PublicKey: string
/** /**
* Number of seconds the source address must wait to close the channel if * 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 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 * 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 * 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. * this object, in case the directory consists of multiple pages.
*/ */
DestinationNode?: string 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,42 +0,0 @@
import BaseLedgerEntry from './BaseLedgerEntry'
interface ImportVLKey {
ImportVLKey: {
PublicKey: string
Account?: string
}
}
interface ActiveValidator {
ActiveValidator: {
PublicKey: string
Account?: string
}
}
/**
*
*
*
* @category Ledger Entries
*/
export default interface UNLReport extends BaseLedgerEntry {
LedgerEntryType: 'UNLReport'
/**
*
*/
ImportVLKeys?: ImportVLKey[]
/**
*
*/
ActiveValidators?: ActiveValidator[]
/**
* The identifying hash of the transaction that most recently modified this
* object.
*/
PreviousTxnID: string
/**
* The index of the ledger that contains the transaction that most recently
* modified this object.
*/
PreviousTxnLgrSeq: number
}

View File

@@ -1,53 +0,0 @@
import { Amount } from '../common'
import BaseLedgerEntry from './BaseLedgerEntry'
/**
* The URIToken object type contains the
*
* @category Ledger Entries
*/
export default interface URIToken extends BaseLedgerEntry {
LedgerEntryType: 'URIToken'
/**
*/
Owner: string
/**
* A hint indicating which page of the sender's owner directory links to this
* object, in case the directory consists of multiple pages.
*/
OwnerNode: string
/**
*/
Issuer: string
/**
*/
URI: string
/**
*/
Digest: string
/**
*/
Amount: Amount
/**
*/
Destination: string
/**
* The identifying hash of the transaction that most recently modified this
* object.
*/
PreviousTxnID: string
/**
* The index of the ledger that contains the transaction that most recently
* modified this object.
*/
PreviousTxnLgrSeq: number
}

View File

@@ -12,7 +12,6 @@ import FeeSettings from './FeeSettings'
import Hook from './Hook' import Hook from './Hook'
import HookDefinition from './HookDefinition' import HookDefinition from './HookDefinition'
import HookState from './HookState' import HookState from './HookState'
import ImportVLSequence from './ImportVLSequence'
import Ledger from './Ledger' import Ledger from './Ledger'
import LedgerEntry from './LedgerEntry' import LedgerEntry from './LedgerEntry'
import LedgerHashes from './LedgerHashes' import LedgerHashes from './LedgerHashes'
@@ -22,8 +21,6 @@ import PayChannel from './PayChannel'
import RippleState, { RippleStateFlags } from './RippleState' import RippleState, { RippleStateFlags } from './RippleState'
import SignerList, { SignerListFlags } from './SignerList' import SignerList, { SignerListFlags } from './SignerList'
import Ticket from './Ticket' import Ticket from './Ticket'
import UNLReport from './UNLReport'
import URIToken from './URIToken'
export { export {
AccountRoot, AccountRoot,
@@ -39,7 +36,6 @@ export {
Hook, Hook,
HookDefinition, HookDefinition,
HookState, HookState,
ImportVLSequence,
Ledger, Ledger,
LedgerEntry, LedgerEntry,
LedgerHashes, LedgerHashes,
@@ -52,6 +48,4 @@ export {
SignerList, SignerList,
SignerListFlags, SignerListFlags,
Ticket, Ticket,
UNLReport,
URIToken,
} }

View File

@@ -1,10 +1,10 @@
import { Amount, LedgerIndex } from '../common' import { LedgerIndex } from '../common'
import { BaseRequest, BaseResponse } from './baseMethod' import { BaseRequest, BaseResponse } from './baseMethod'
interface Channel { interface Channel {
account: string account: string
amount: Amount amount: string
balance: string balance: string
channel_id: string channel_id: string
destination_account: string destination_account: string
@@ -15,7 +15,6 @@ interface Channel {
cancel_after?: number cancel_after?: number
source_tab?: number source_tab?: number
destination_tag?: 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' import { BaseRequest, BaseResponse } from './baseMethod'
@@ -64,14 +64,6 @@ export interface Trustline {
* false. * false.
*/ */
freeze_peer?: boolean 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

@@ -3,13 +3,11 @@ import {
Check, Check,
DepositPreauth, DepositPreauth,
Escrow, Escrow,
Hook,
Offer, Offer,
PayChannel, PayChannel,
RippleState, RippleState,
SignerList, SignerList,
Ticket, Ticket,
URIToken,
} from '../ledger' } from '../ledger'
import { BaseRequest, BaseResponse } from './baseMethod' import { BaseRequest, BaseResponse } from './baseMethod'
@@ -18,14 +16,12 @@ type AccountObjectType =
| 'check' | 'check'
| 'deposit_preauth' | 'deposit_preauth'
| 'escrow' | 'escrow'
| 'hook'
| 'nft_offer' | 'nft_offer'
| 'offer' | 'offer'
| 'payment_channel' | 'payment_channel'
| 'signer_list' | 'signer_list'
| 'state' | 'state'
| 'ticket' | 'ticket'
| 'uritoken'
/** /**
* The account_objects command returns the raw ledger format for all objects * The account_objects command returns the raw ledger format for all objects
@@ -77,13 +73,11 @@ type AccountObject =
| Check | Check
| DepositPreauth | DepositPreauth
| Escrow | Escrow
| Hook
| Offer | Offer
| PayChannel | PayChannel
| SignerList | SignerList
| RippleState | RippleState
| Ticket | Ticket
| URIToken
/** /**
* Response expected from an {@link AccountObjectsRequest}. * Response expected from an {@link AccountObjectsRequest}.

View File

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

View File

@@ -79,11 +79,6 @@ export interface LedgerEntryRequest extends BaseRequest {
} }
| string | string
/**
* The object ID of a transaction emitted by the ledger entry.
*/
emitted_txn?: string
/** /**
* The Escrow object to retrieve. If a string, must be the object ID of the * The Escrow object to retrieve. If a string, must be the object ID of the
* escrow, as hexadecimal. If an object, requires owner and seq sub-fields. * escrow, as hexadecimal. If an object, requires owner and seq sub-fields.
@@ -97,47 +92,6 @@ export interface LedgerEntryRequest extends BaseRequest {
} }
| string | string
/**
* The hash of the Hook object to retrieve.
*/
hook_definition?: string
/**
* The Hook object to retrieve. If a string, must be the object ID of the Hook.
* If an object, requires `account` sub-field.
*/
hook?:
| {
/** The account of the Hook object. */
account: string
}
| string
/**
* Object specifying the HookState object to retrieve. Requires the sub-fields
* `account`, `key`, and `namespace_id` to uniquely specify the HookState entry
* to retrieve.
*/
hook_state?: {
/** The account of the Hook object. */
account: string
/** The key of the state. */
key: string
/** The namespace of the state. */
namespace_id: string
}
/**
* The Import VL Sequence object to retrieve. If a string, must be the object ID of the VLSequence.
* If an object, requires `public_key` sub-field.
*/
import_vlseq?:
| {
/** The public_key of the Import VL Sequence object. */
public_key: string
}
| string
/** /**
* The Offer object to retrieve. If a string, interpret as the unique object * The Offer object to retrieve. If a string, interpret as the unique object
* ID to the Offer. If an object, requires the sub-fields `account` and `seq` * ID to the Offer. If an object, requires the sub-fields `account` and `seq`
@@ -183,20 +137,40 @@ export interface LedgerEntryRequest extends BaseRequest {
ticket_sequence: number ticket_sequence: number
} }
| string | string
/**
* The object ID of a transaction emitted by the ledger entry.
*/
emitted_txn?: string
/** /**
* The URIToken object to retrieve. If a string, must be the object ID of the * The hash of the Hook object to retrieve.
* URIToken, as hexadecimal. If an object, the `issuer` and `uri`
* sub-fields are required to uniquely specify the URIToken entry.
*/ */
uri_token?: hook_definition?: string
/**
* The Hook object to retrieve. If a string, must be the object ID of the Hook.
* If an object, requires `account` sub-field.
*/
hook?:
| { | {
/** The issuer of the URIToken object. */ /** The account of the Hook object. */
issuer: string account: string
/** The URIToken uri string (ascii). */
uri: string
} }
| string | string
/**
* Object specifying the HookState object to retrieve. Requires the sub-fields
* `account`, `key`, and `namespace_id` to uniquely specify the HookState entry
* to retrieve.
*/
hook_state?: {
/** The account of the Hook object. */
account: string
/** The key of the state. */
key: string
/** The namespace of the state. */
namespace_id: string
}
} }
/** /**

View File

@@ -136,10 +136,6 @@ export interface ServerInfoResponse extends BaseResponse {
* overall network's load factor. * overall network's load factor.
*/ */
load_factor?: number load_factor?: number
/**
* The network id of the server.
*/
network_id?: number
/** /**
* Current multiplier to the transaction cost based on * Current multiplier to the transaction cost based on
* load to this server. * load to this server.

View File

@@ -1,6 +1,6 @@
/* eslint-disable complexity -- Necessary for validateAccountSet */ /* eslint-disable complexity -- Necessary for validateAccountSet */
import { isValidClassicAddress } from '@transia/ripple-address-codec' import { isValidClassicAddress } from 'ripple-address-codec'
import { ValidationError } from '../../errors' import { ValidationError } from '../../errors'
@@ -48,7 +48,6 @@ export enum AccountSetAsfFlags {
*/ */
asfAuthorizedNFTokenMinter = 10, asfAuthorizedNFTokenMinter = 10,
/** asf 11 is reserved for Hooks amendment */ /** asf 11 is reserved for Hooks amendment */
asfTshCollect = 11,
/** Disallow other accounts from creating incoming NFTOffers */ /** Disallow other accounts from creating incoming NFTOffers */
asfDisallowIncomingNFTokenOffer = 12, asfDisallowIncomingNFTokenOffer = 12,
/** Disallow other accounts from creating incoming Checks */ /** Disallow other accounts from creating incoming Checks */

View File

@@ -1,28 +0,0 @@
import { ValidationError } from '../../errors'
import { BaseTransaction, validateBaseTransaction } from './common'
/**
* ClaimReward is a transaction model that allows an account to claim rewards.
*
* @category Transaction Models
*/
export interface ClaimReward extends BaseTransaction {
TransactionType: 'ClaimReward'
/** The unique address of the issuer where the reward.c hook is installed. */
Issuer?: string
}
/**
* Verify the form and type of an ClaimReward at runtime.
*
* @param tx - An ClaimReward Transaction.
* @throws When the ClaimReward is Malformed.
*/
export function validateClaimReward(tx: Record<string, unknown>): void {
validateBaseTransaction(tx)
if (tx.Issuer !== undefined && typeof tx.Issuer !== 'string') {
throw new ValidationError('ClaimReward: invalid Issuer')
}
}

View File

@@ -1,17 +1,10 @@
/* eslint-disable max-lines-per-function -- Necessary for validateBaseTransaction */ /* eslint-disable max-lines-per-function -- Necessary for validateBaseTransaction */
/* eslint-disable complexity -- Necessary for validateBaseTransaction */ /* eslint-disable complexity -- Necessary for validateBaseTransaction */
/* eslint-disable max-statements -- Necessary for validateBaseTransaction */ /* eslint-disable max-statements -- Necessary for validateBaseTransaction */
import { TRANSACTION_TYPES } from '@transia/ripple-binary-codec' import { TRANSACTION_TYPES } from 'ripple-binary-codec'
import { ValidationError } from '../../errors' import { ValidationError } from '../../errors'
import { import { Amount, IssuedCurrencyAmount, Memo, Signer } from '../common'
Amount,
HookParameter,
IssuedCurrencyAmount,
Memo,
Signer,
EmitDetails,
} from '../common'
import { onlyHasFields } from '../utils' import { onlyHasFields } from '../utils'
const MEMO_SIZE = 3 const MEMO_SIZE = 3
@@ -166,18 +159,8 @@ export interface BaseTransaction {
* account it says it is from. * account it says it is from.
*/ */
TxnSignature?: string TxnSignature?: string
/**
* The network id of the transaction.
*/
NetworkID?: number NetworkID?: number
/**
* The hook parameters of the transaction.
*/
HookParameters?: HookParameter[]
/**
* The hook parameters of the transaction.
*/
EmitDetails?: EmitDetails
} }
/** /**
@@ -271,9 +254,6 @@ export function validateBaseTransaction(common: Record<string, unknown>): void {
) { ) {
throw new ValidationError('BaseTransaction: invalid TxnSignature') throw new ValidationError('BaseTransaction: invalid TxnSignature')
} }
if (common.NetworkID !== undefined && typeof common.NetworkID !== 'number') {
throw new ValidationError('BaseTransaction: invalid NetworkID')
}
} }
/** /**

View File

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

View File

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

View File

@@ -3,7 +3,7 @@ import { ValidationError } from '../../errors'
import { BaseTransaction, validateBaseTransaction } from './common' 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 * @category Transaction Models
*/ */

View File

@@ -1,38 +0,0 @@
import { ValidationError } from '../../errors'
import { BaseTransaction, validateBaseTransaction } from './common'
/**
*
*
* @category Transaction Models
*/
export interface Import extends BaseTransaction {
TransactionType: 'Import'
/**
*
*/
Issuer?: string
/**
* Hex value representing a VL Blob.
*/
Blob?: string
}
/**
* Verify the form and type of an Import at runtime.
*
* @param tx - An Import Transaction.
* @throws When the Import is Malformed.
*/
export function validateImport(tx: Record<string, unknown>): void {
validateBaseTransaction(tx)
if (tx.Issuer !== undefined && typeof tx.Issuer !== 'string') {
throw new ValidationError('Import: Issuer must be a string')
}
if (tx.Account === tx.Issuer) {
throw new ValidationError('Import: Issuer and Account must not be equal')
}
}

View File

@@ -10,12 +10,10 @@ export { AccountDelete } from './accountDelete'
export { CheckCancel } from './checkCancel' export { CheckCancel } from './checkCancel'
export { CheckCash } from './checkCash' export { CheckCash } from './checkCash'
export { CheckCreate } from './checkCreate' export { CheckCreate } from './checkCreate'
export { ClaimReward } from './claimReward'
export { DepositPreauth } from './depositPreauth' export { DepositPreauth } from './depositPreauth'
export { EscrowCancel } from './escrowCancel' export { EscrowCancel } from './escrowCancel'
export { EscrowCreate } from './escrowCreate' export { EscrowCreate } from './escrowCreate'
export { EscrowFinish } from './escrowFinish' export { EscrowFinish } from './escrowFinish'
export { Import } from './import'
export { Invoke } from './invoke' export { Invoke } from './invoke'
export { NFTokenAcceptOffer } from './NFTokenAcceptOffer' export { NFTokenAcceptOffer } from './NFTokenAcceptOffer'
export { NFTokenBurn } from './NFTokenBurn' export { NFTokenBurn } from './NFTokenBurn'
@@ -45,16 +43,7 @@ export {
export { PaymentChannelCreate } from './paymentChannelCreate' export { PaymentChannelCreate } from './paymentChannelCreate'
export { PaymentChannelFund } from './paymentChannelFund' export { PaymentChannelFund } from './paymentChannelFund'
export { SetRegularKey } from './setRegularKey' export { SetRegularKey } from './setRegularKey'
export { SetHookFlagsInterface, SetHookFlags, SetHook } from './setHook' export { SetHook } from './setHook'
export { SignerListSet } from './signerListSet' export { SignerListSet } from './signerListSet'
export { TicketCreate } from './ticketCreate' export { TicketCreate } from './ticketCreate'
export { TrustSetFlagsInterface, TrustSetFlags, TrustSet } from './trustSet' export { TrustSetFlagsInterface, TrustSetFlags, TrustSet } from './trustSet'
export {
URITokenMintFlagsInterface,
URITokenMintFlags,
URITokenMint,
} from './uriTokenMint'
export { URITokenBurn } from './uriTokenBurn'
export { URITokenCreateSellOffer } from './uriTokenCreateSellOffer'
export { URITokenBuy } from './uriTokenBuy'
export { URITokenCancelSellOffer } from './uriTokenCancelSellOffer'

View File

@@ -13,10 +13,6 @@ export interface Invoke extends BaseTransaction {
* If present, invokes the Hook on the Destination account. * If present, invokes the Hook on the Destination account.
*/ */
Destination?: string Destination?: string
/**
* Hex value representing a VL Blob.
*/
Blob?: string
} }
/** /**

View File

@@ -1,19 +1,5 @@
import { Amount } from '../common' import { Amount } from '../common'
export interface HookExecution {
HookExecution: {
HookAccount: string
HookEmitCount: number
HookExecutionIndex: number
HookHash: string
HookInstructionCount: string
HookResult: number
HookReturnCode: string
HookReturnString: string
HookStateChangeCount: number
}
}
export interface CreatedNode { export interface CreatedNode {
CreatedNode: { CreatedNode: {
LedgerEntryType: string LedgerEntryType: string
@@ -74,7 +60,6 @@ export function isDeletedNode(node: Node): node is DeletedNode {
} }
export interface TransactionMetadata { export interface TransactionMetadata {
HookExecutions?: HookExecution[]
AffectedNodes: Node[] AffectedNodes: Node[]
DeliveredAmount?: Amount DeliveredAmount?: Amount
// "unavailable" possible for transactions before 2014-01-20 // "unavailable" possible for transactions before 2014-01-20

View File

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

View File

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

View File

@@ -1,10 +1,9 @@
import { ValidationError } from '../../errors' 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 * expiration time of the channel. Only the source address of the channel can
* use this transaction. * use this transaction.
* *
@@ -18,15 +17,16 @@ export interface PaymentChannelFund extends BaseTransaction {
*/ */
Channel: string 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 * 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 * 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 * of the channel, or the existing Expiration of the channel. After the
* Expiration time, any transaction that would access the channel closes 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 source address when the channel closes. (Expiration is separate from
* the channel's immutable CancelAfter time.) For more information, see the * the channel's immutable CancelAfter time.) For more information, see the
* PayChannel ledger object type. * PayChannel ledger object type.
@@ -55,8 +55,8 @@ export function validatePaymentChannelFund(tx: Record<string, unknown>): void {
throw new ValidationError('PaymentChannelFund: missing Amount') throw new ValidationError('PaymentChannelFund: missing Amount')
} }
if (typeof tx.Amount !== 'string' && !isAmount(tx.Amount)) { if (typeof tx.Amount !== 'string') {
throw new ValidationError('PaymentChannelFund: Amount must be an Amount') throw new ValidationError('PaymentChannelFund: Amount must be a string')
} }
if (tx.Expiration !== undefined && typeof tx.Expiration !== 'number') { if (tx.Expiration !== undefined && typeof tx.Expiration !== 'number') {

View File

@@ -1,30 +1,7 @@
import { ValidationError } from '../../errors' import { ValidationError } from '../../errors'
import { Hook } from '../common' import { Hook } from '../common'
import { BaseTransaction, GlobalFlags, validateBaseTransaction } from './common' import { BaseTransaction, validateBaseTransaction } from './common'
/**
* Enum representing values for Set Hook Transaction Flags.
*
* @category Transaction Flags
*/
export enum SetHookFlags {
/**
*/
hsfOverride = 0x00000001,
/**
*/
hsfNSDelete = 0x0000002,
/**
*/
hsfCollect = 0x00000004,
}
export interface SetHookFlagsInterface extends GlobalFlags {
hsfOverride?: boolean
hsfNSDelete?: boolean
hsfCollect?: boolean
}
/** /**
* *
@@ -37,11 +14,9 @@ export interface SetHook extends BaseTransaction {
* *
*/ */
Hooks: Hook[] Hooks: Hook[]
Flags?: number | SetHookFlagsInterface
} }
const MAX_HOOKS = 10 const MAX_HOOKS = 4
const HEX_REGEX = /^[0-9A-Fa-f]{64}$/u const HEX_REGEX = /^[0-9A-Fa-f]{64}$/u
/** /**

View File

@@ -23,7 +23,7 @@ export interface SignerListSet extends BaseTransaction {
* more than 32 members. No address may appear more than once in the list, nor * more than 32 members. No address may appear more than once in the list, nor
* may the Account submitting the transaction appear in the list. * may the Account submitting the transaction appear in the list.
*/ */
SignerEntries?: SignerEntry[] SignerEntries: SignerEntry[]
} }
const MAX_SIGNERS = 32 const MAX_SIGNERS = 32
@@ -36,7 +36,6 @@ const HEX_WALLET_LOCATOR_REGEX = /^[0-9A-Fa-f]{64}$/u
* @param tx - An SignerListSet Transaction. * @param tx - An SignerListSet Transaction.
* @throws When the SignerListSet is Malformed. * @throws When the SignerListSet is Malformed.
*/ */
// eslint-disable-next-line complexity -- validation can be complex
export function validateSignerListSet(tx: Record<string, unknown>): void { export function validateSignerListSet(tx: Record<string, unknown>): void {
validateBaseTransaction(tx) validateBaseTransaction(tx)
@@ -48,10 +47,6 @@ export function validateSignerListSet(tx: Record<string, unknown>): void {
throw new ValidationError('SignerListSet: invalid SignerQuorum') throw new ValidationError('SignerListSet: invalid SignerQuorum')
} }
if (tx.SignerQuorum === 0) {
return
}
if (tx.SignerEntries === undefined) { if (tx.SignerEntries === undefined) {
throw new ValidationError('SignerListSet: missing field SignerEntries') throw new ValidationError('SignerListSet: missing field SignerEntries')
} }

View File

@@ -9,13 +9,10 @@ import { AccountSet, validateAccountSet } from './accountSet'
import { CheckCancel, validateCheckCancel } from './checkCancel' import { CheckCancel, validateCheckCancel } from './checkCancel'
import { CheckCash, validateCheckCash } from './checkCash' import { CheckCash, validateCheckCash } from './checkCash'
import { CheckCreate, validateCheckCreate } from './checkCreate' import { CheckCreate, validateCheckCreate } from './checkCreate'
import { ClaimReward, validateClaimReward } from './claimReward'
import { DepositPreauth, validateDepositPreauth } from './depositPreauth' import { DepositPreauth, validateDepositPreauth } from './depositPreauth'
import { EscrowCancel, validateEscrowCancel } from './escrowCancel' import { EscrowCancel, validateEscrowCancel } from './escrowCancel'
import { EscrowCreate, validateEscrowCreate } from './escrowCreate' import { EscrowCreate, validateEscrowCreate } from './escrowCreate'
import { EscrowFinish, validateEscrowFinish } from './escrowFinish' import { EscrowFinish, validateEscrowFinish } from './escrowFinish'
import { Import, validateImport } from './import'
import { Invoke, validateInvoke } from './invoke'
import { TransactionMetadata } from './metadata' import { TransactionMetadata } from './metadata'
import { import {
NFTokenAcceptOffer, NFTokenAcceptOffer,
@@ -51,17 +48,6 @@ import { SetRegularKey, validateSetRegularKey } from './setRegularKey'
import { SignerListSet, validateSignerListSet } from './signerListSet' import { SignerListSet, validateSignerListSet } from './signerListSet'
import { TicketCreate, validateTicketCreate } from './ticketCreate' import { TicketCreate, validateTicketCreate } from './ticketCreate'
import { TrustSet, validateTrustSet } from './trustSet' import { TrustSet, validateTrustSet } from './trustSet'
import { URITokenBurn, validateURITokenBurn } from './uriTokenBurn'
import { URITokenBuy, validateURITokenBuy } from './uriTokenBuy'
import {
URITokenCancelSellOffer,
validateURITokenCancelSellOffer,
} from './uriTokenCancelSellOffer'
import {
URITokenCreateSellOffer,
validateURITokenCreateSellOffer,
} from './uriTokenCreateSellOffer'
import { URITokenMint, validateURITokenMint } from './uriTokenMint'
/** /**
* @category Transaction Models * @category Transaction Models
@@ -72,13 +58,10 @@ export type Transaction =
| CheckCancel | CheckCancel
| CheckCash | CheckCash
| CheckCreate | CheckCreate
| ClaimReward
| DepositPreauth | DepositPreauth
| EscrowCancel | EscrowCancel
| EscrowCreate | EscrowCreate
| EscrowFinish | EscrowFinish
| Import
| Invoke
| NFTokenAcceptOffer | NFTokenAcceptOffer
| NFTokenBurn | NFTokenBurn
| NFTokenCancelOffer | NFTokenCancelOffer
@@ -95,11 +78,6 @@ export type Transaction =
| SignerListSet | SignerListSet
| TicketCreate | TicketCreate
| TrustSet | TrustSet
| URITokenBurn
| URITokenBuy
| URITokenCancelSellOffer
| URITokenMint
| URITokenCreateSellOffer
/** /**
* @category Transaction Models * @category Transaction Models
@@ -148,10 +126,6 @@ export function validate(transaction: Record<string, unknown>): void {
validateCheckCreate(tx) validateCheckCreate(tx)
break break
case 'ClaimReward':
validateClaimReward(tx)
break
case 'DepositPreauth': case 'DepositPreauth':
validateDepositPreauth(tx) validateDepositPreauth(tx)
break break
@@ -168,14 +142,6 @@ export function validate(transaction: Record<string, unknown>): void {
validateEscrowFinish(tx) validateEscrowFinish(tx)
break break
case 'Import':
validateImport(tx)
break
case 'Invoke':
validateInvoke(tx)
break
case 'NFTokenAcceptOffer': case 'NFTokenAcceptOffer':
validateNFTokenAcceptOffer(tx) validateNFTokenAcceptOffer(tx)
break break
@@ -240,26 +206,6 @@ export function validate(transaction: Record<string, unknown>): void {
validateTrustSet(tx) validateTrustSet(tx)
break break
case 'URITokenMint':
validateURITokenMint(tx)
break
case 'URITokenBurn':
validateURITokenBurn(tx)
break
case 'URITokenCreateSellOffer':
validateURITokenCreateSellOffer(tx)
break
case 'URITokenBuy':
validateURITokenBuy(tx)
break
case 'URITokenCancelSellOffer':
validateURITokenCancelSellOffer(tx)
break
default: default:
throw new ValidationError( throw new ValidationError(
`Invalid field TransactionType: ${tx.TransactionType}`, `Invalid field TransactionType: ${tx.TransactionType}`,

View File

@@ -1,60 +0,0 @@
import { ValidationError } from '../../errors'
import { BaseTransaction, validateBaseTransaction } from './common'
/**
* Map of flags to boolean values representing {@link URITokenBurn} transaction
* flags.
*
* @category Transaction Flags
*
* @example
* ```typescript
* const tx: URITokenBurn = {
* Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
* URITokenID: '7AFCE32EBA8BD310CC2D00BE10B76E2183337EA20444D4580E4DBDB396C101FB',
* TransactionType: 'URITokenBurn',
* }
*
* // Autofill the tx to see how flags actually look compared to the interface usage.
* const autofilledTx = await client.autofill(tx)
* console.log(autofilledTx)
* // {
* // Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
* // URITokenID: '7AFCE32EBA8BD310CC2D00BE10B76E2183337EA20444D4580E4DBDB396C101FB',
* // TransactionType: 'URITokenBurn',
* // Sequence: 21970384,
* // Fee: '12',
* // LastLedgerSequence: 21970404
* // }
* ```
*/
/**
* An URITokenBurn transaction is effectively a limit order . It defines an
* intent to exchange currencies, and creates an Offer object if not completely.
* Fulfilled when placed. Offers can be partially fulfilled.
*
* @category Transaction Models
*/
export interface URITokenBurn extends BaseTransaction {
TransactionType: 'URITokenBurn'
/**
* Identifies the URIToken object to be removed by the transaction.
*/
URITokenID: string
}
/**
* Verify the form and type of an URITokenBurn at runtime.
*
* @param tx - An URITokenBurn Transaction.
* @throws When the URITokenBurn is Malformed.
*/
export function validateURITokenBurn(tx: Record<string, unknown>): void {
validateBaseTransaction(tx)
if (tx.URITokenID == null) {
throw new ValidationError('NFTokenBurn: missing field URITokenID')
}
}

View File

@@ -1,83 +0,0 @@
import { ValidationError } from '../../errors'
import { Amount } from '../common'
import { BaseTransaction, isAmount, validateBaseTransaction } from './common'
/**
* Map of flags to boolean values representing {@link URITokenBuy} transaction
* flags.
*
* @category Transaction Flags
*
* @example
* ```typescript
* const tx: URITokenBuy = {
* Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
* URITokenID: '7AFCE32EBA8BD310CC2D00BE10B76E2183337EA20444D4580E4DBDB396C101FB',
* Amount: '1000000',
* TransactionType: 'URITokenBuy',
* }
*
* // Autofill the tx to see how flags actually look compared to the interface usage.
* const autofilledTx = await client.autofill(tx)
* console.log(autofilledTx)
* // {
* // Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
* // URITokenID: '7AFCE32EBA8BD310CC2D00BE10B76E2183337EA20444D4580E4DBDB396C101FB',
* // Amount: '1000000',
* // TransactionType: 'URITokenBuy',
* // Sequence: 21970384,
* // Fee: '12',
* // LastLedgerSequence: 21970404
* // }
* ```
*/
/**
* An URITokenBuy transaction is effectively a limit order . It defines an
* intent to exchange currencies, and creates an Offer object if not completely.
* Fulfilled when placed. Offers can be partially fulfilled.
*
* @category Transaction Models
*/
export interface URITokenBuy extends BaseTransaction {
TransactionType: 'URITokenBuy'
/**
* Identifies the URITokenID of the NFToken object that the
* offer references.
*/
URITokenID: string
/**
* Indicates the amount expected or offered for the Token.
*
* The amount must be non-zero, except when this is a sell
* offer and the asset is XRP. This would indicate that the current
* owner of the token is giving it away free, either to anyone at all,
* or to the account identified by the Destination field.
*/
Amount: Amount
}
/**
* Verify the form and type of an URITokenBuy at runtime.
*
* @param tx - An URITokenBuy Transaction.
* @throws When the URITokenBuy is Malformed.
*/
export function validateURITokenBuy(tx: Record<string, unknown>): void {
validateBaseTransaction(tx)
if (tx.Account === tx.Destination) {
throw new ValidationError(
'URITokenBuy: Destination and Account must not be equal',
)
}
if (tx.URITokenID == null) {
throw new ValidationError('URITokenBuy: missing field URITokenID')
}
if (!isAmount(tx.Amount)) {
throw new ValidationError('URITokenBuy: invalid Amount')
}
}

View File

@@ -1,65 +0,0 @@
import { ValidationError } from '../../errors'
import { BaseTransaction, validateBaseTransaction } from './common'
/**
* Map of flags to boolean values representing {@link URITokenCancelSellOffer} transaction
* flags.
*
* @category Transaction Flags
*
* @example
* ```typescript
* const tx: URITokenCancelSellOffer = {
* Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
* URITokenID: '7AFCE32EBA8BD310CC2D00BE10B76E2183337EA20444D4580E4DBDB396C101FB',
* TransactionType: 'URITokenCancelSellOffer',
* }
*
* // Autofill the tx to see how flags actually look compared to the interface usage.
* const autofilledTx = await client.autofill(tx)
* console.log(autofilledTx)
* // {
* // Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
* // URITokenID: '7AFCE32EBA8BD310CC2D00BE10B76E2183337EA20444D4580E4DBDB396C101FB',
* // TransactionType: 'URITokenCancelSellOffer',
* // Sequence: 21970384,
* // Fee: '12',
* // LastLedgerSequence: 21970404
* // }
* ```
*/
/**
* An URITokenCancelSellOffer transaction is effectively a limit order . It defines an
* intent to exchange currencies, and creates an Offer object if not completely.
* Fulfilled when placed. Offers can be partially fulfilled.
*
* @category Transaction Models
*/
export interface URITokenCancelSellOffer extends BaseTransaction {
TransactionType: 'URITokenCancelSellOffer'
/**
* Identifies the URITokenID of the NFToken object that the
* offer references.
*/
URITokenID: string
}
/**
* Verify the form and type of an URITokenCancelSellOffer at runtime.
*
* @param tx - An URITokenCancelSellOffer Transaction.
* @throws When the URITokenCancelSellOffer is Malformed.
*/
export function validateURITokenCancelSellOffer(
tx: Record<string, unknown>,
): void {
validateBaseTransaction(tx)
if (tx.URITokenID == null) {
throw new ValidationError(
'URITokenCancelSellOffer: missing field URITokenID',
)
}
}

View File

@@ -1,93 +0,0 @@
import { ValidationError } from '../../errors'
import { Amount } from '../common'
import { BaseTransaction, isAmount, validateBaseTransaction } from './common'
/**
* Map of flags to boolean values representing {@link URITokenCreateSellOffer} transaction
* flags.
*
* @category Transaction Flags
*
* @example
* ```typescript
* const tx: URITokenCreateSellOffer = {
* Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
* URITokenID: '7AFCE32EBA8BD310CC2D00BE10B76E2183337EA20444D4580E4DBDB396C101FB',
* Amount: '1000000',
* TransactionType: 'URITokenCreateSellOffer',
* }
*
* // Autofill the tx to see how flags actually look compared to the interface usage.
* const autofilledTx = await client.autofill(tx)
* console.log(autofilledTx)
* // {
* // Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
* // URITokenID: '7AFCE32EBA8BD310CC2D00BE10B76E2183337EA20444D4580E4DBDB396C101FB',
* // Amount: '1000000',
* // TransactionType: 'URITokenCreateSellOffer',
* // Sequence: 21970384,
* // Fee: '12',
* // LastLedgerSequence: 21970404
* // }
* ```
*/
/**
* An URITokenCreateSellOffer transaction is effectively a limit order . It defines an
* intent to exchange currencies, and creates an Offer object if not completely.
* Fulfilled when placed. Offers can be partially fulfilled.
*
* @category Transaction Models
*/
export interface URITokenCreateSellOffer extends BaseTransaction {
TransactionType: 'URITokenCreateSellOffer'
/**
* Identifies the URITokenID of the NFToken object that the
* offer references.
*/
URITokenID: string
/**
* Indicates the amount expected or offered for the Token.
*
* The amount must be non-zero, except when this is a sell
* offer and the asset is XRP. This would indicate that the current
* owner of the token is giving it away free, either to anyone at all,
* or to the account identified by the Destination field.
*/
Amount: Amount
/**
* If present, indicates that this offer may only be
* accepted by the specified account. Attempts by other
* accounts to accept this offer MUST fail.
*/
Destination?: string
}
/**
* Verify the form and type of an URITokenCreateSellOffer at runtime.
*
* @param tx - An URITokenCreateSellOffer Transaction.
* @throws When the URITokenCreateSellOffer is Malformed.
*/
export function validateURITokenCreateSellOffer(
tx: Record<string, unknown>,
): void {
validateBaseTransaction(tx)
if (tx.Account === tx.Destination) {
throw new ValidationError(
'URITokenCreateSellOffer: Destination and Account must not be equal',
)
}
if (tx.URITokenID == null) {
throw new ValidationError(
'URITokenCreateSellOffer: missing field URITokenID',
)
}
if (!isAmount(tx.Amount)) {
throw new ValidationError('URITokenCreateSellOffer: invalid Amount')
}
}

View File

@@ -1,92 +0,0 @@
import { ValidationError } from '../../errors'
import { isHex } from '../utils'
import { BaseTransaction, GlobalFlags, validateBaseTransaction } from './common'
/**
* Transaction Flags for an URITokenMint Transaction.
*
* @category Transaction Flags
*/
export enum URITokenMintFlags {
/**
* If set, indicates that the minted token may be burned by the issuer even
* if the issuer does not currently hold the token. The current holder of
* the token may always burn it.
*/
tfBurnable = 0x00000001,
}
/**
* Map of flags to boolean values representing {@link URITokenMint} transaction
* flags.
*
* @category Transaction Flags
*
* @example
* ```typescript
* const tx: URITokenMint = {
* Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
* URI: '697066733A2F2F434944',
* TransactionType: 'URITokenMint',
* Flags: {
* tfBurnable: true,
* },
* }
*
* // Autofill the tx to see how flags actually look compared to the interface usage.
* const autofilledTx = await client.autofill(tx)
* console.log(autofilledTx)
* // {
* // Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
* // URI: '697066733A2F2F434944',
* // TransactionType: 'URITokenMint',
* // Flags: 0,
* // Sequence: 21970384,
* // Fee: '12',
* // LastLedgerSequence: 21970404
* // }
* ```
*/
export interface URITokenMintFlagsInterface extends GlobalFlags {
tfBurnable?: boolean
}
/**
* An URITokenMint transaction is effectively a limit order . It defines an
* intent to exchange currencies, and creates an Offer object if not completely.
* Fulfilled when placed. Offers can be partially fulfilled.
*
* @category Transaction Models
*/
export interface URITokenMint extends BaseTransaction {
TransactionType: 'URITokenMint'
Flags?: number | URITokenMintFlagsInterface
/**
* URI that points to the data and/or metadata associated with the NFT.
* This field need not be an HTTP or HTTPS URL; it could be an IPFS URI, a
* magnet link, immediate data encoded as an RFC2379 "data" URL, or even an
* opaque issuer-specific encoding. The URI is NOT checked for validity, but
* the field is limited to a maximum length of 256 bytes.
*
* This field must be hex-encoded. You can use `convertStringToHex` to
* convert this field to the proper encoding.
*/
URI: string
Digest?: string
}
/**
* Verify the form and type of an URITokenMint at runtime.
*
* @param tx - An URITokenMint Transaction.
* @throws When the URITokenMint is Malformed.
*/
export function validateURITokenMint(tx: Record<string, unknown>): void {
validateBaseTransaction(tx)
if (typeof tx.URI === 'string' && !isHex(tx.URI)) {
throw new ValidationError('URITokenMint: URI must be in hex format')
}
}

View File

@@ -2,7 +2,6 @@
/* eslint-disable no-bitwise -- flags require bitwise operations */ /* eslint-disable no-bitwise -- flags require bitwise operations */
import { ValidationError } from '../../errors' import { ValidationError } from '../../errors'
import { Hook } from '../common'
import { import {
AccountRootFlagsInterface, AccountRootFlagsInterface,
AccountRootFlags, AccountRootFlags,
@@ -21,7 +20,6 @@ import {
PaymentChannelClaimFlagsInterface, PaymentChannelClaimFlagsInterface,
PaymentChannelClaimFlags, PaymentChannelClaimFlags,
} from '../transactions/paymentChannelClaim' } from '../transactions/paymentChannelClaim'
import { SetHookFlagsInterface, SetHookFlags } from '../transactions/setHook'
import type { Transaction } from '../transactions/transaction' import type { Transaction } from '../transactions/transaction'
import { TrustSetFlagsInterface, TrustSetFlags } from '../transactions/trustSet' import { TrustSetFlagsInterface, TrustSetFlags } from '../transactions/trustSet'
@@ -77,15 +75,6 @@ export function setTransactionFlagsToNumber(tx: Transaction): void {
case 'TrustSet': case 'TrustSet':
tx.Flags = convertTrustSetFlagsToNumber(tx.Flags) tx.Flags = convertTrustSetFlagsToNumber(tx.Flags)
return return
case 'SetHook':
tx.Flags = convertSetHookFlagsToNumber(tx.Flags)
tx.Hooks.forEach((hook: Hook) => {
hook.Hook.Flags = convertSetHookFlagsToNumber(
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- idk
hook.Hook.Flags as SetHookFlagsInterface,
)
})
return
default: default:
tx.Flags = 0 tx.Flags = 0
} }
@@ -119,10 +108,6 @@ function convertTrustSetFlagsToNumber(flags: TrustSetFlagsInterface): number {
return reduceFlags(flags, TrustSetFlags) return reduceFlags(flags, TrustSetFlags)
} }
function convertSetHookFlagsToNumber(flags: SetHookFlagsInterface): number {
return reduceFlags(flags, SetHookFlags)
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- added ValidationError check for flagEnum // eslint-disable-next-line @typescript-eslint/no-explicit-any -- added ValidationError check for flagEnum
function reduceFlags(flags: GlobalFlags, flagEnum: any): number { function reduceFlags(flags: GlobalFlags, flagEnum: any): number {
return Object.keys(flags).reduce((resultFlags, flag) => { return Object.keys(flags).reduce((resultFlags, flag) => {

View File

@@ -1,8 +1,5 @@
import {
xAddressToClassicAddress,
isValidXAddress,
} from '@transia/ripple-address-codec'
import BigNumber from 'bignumber.js' 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 { ValidationError, XrplError } from '../errors'
@@ -15,7 +12,6 @@ import { getFeeXrp } from './getFeeXrp'
// Expire unconfirmed transactions after 20 ledger versions, approximately 1 minute, by default // Expire unconfirmed transactions after 20 ledger versions, approximately 1 minute, by default
const LEDGER_OFFSET = 20 const LEDGER_OFFSET = 20
const RESTRICTED_NETWORKS = 1024
interface ClassicAccountAndTag { interface ClassicAccountAndTag {
classicAccount: string classicAccount: string
tag: number | false | undefined tag: number | false | undefined
@@ -43,10 +39,8 @@ async function autofill<T extends Transaction>(
setValidAddresses(tx) setValidAddresses(tx)
setTransactionFlagsToNumber(tx) setTransactionFlagsToNumber(tx)
const promises: Array<Promise<void>> = [] const promises: Array<Promise<void>> = []
if (this.networkID > RESTRICTED_NETWORKS && tx.NetworkID == null) {
tx.NetworkID = this.networkID
}
if (tx.Sequence == null) { if (tx.Sequence == null) {
promises.push(setNextValidSequenceNumber(this, tx)) promises.push(setNextValidSequenceNumber(this, tx))
} }

View File

@@ -1,15 +0,0 @@
import type { Client } from '..'
// import { XrplError } from '../errors'
/**
* Returns the network ID of the rippled server.
*
* @param this - The Client used to connect to the ledger.
* @returns The network id.
*/
export default async function getNetworkID(this: Client): Promise<number> {
const response = await this.request({
command: 'server_info',
})
return response.result.info.network_id ?? 1
}

View File

@@ -7,8 +7,6 @@ export { default as getLedgerIndex } from './getLedgerIndex'
export { default as getOrderbook } from './getOrderbook' export { default as getOrderbook } from './getOrderbook'
export { getFeeXrp, getFeeEstimateXrp } from './getFeeXrp' export { getFeeXrp, getFeeEstimateXrp } from './getFeeXrp'
export { default as getNetworkID } from './getNetworkID'
export * from './submit' export * from './submit'
export * from './utils' export * from './utils'

View File

@@ -1,4 +1,4 @@
import { decode, encode } from '@transia/ripple-binary-codec' import { decode, encode } from 'ripple-binary-codec'
import type { Client, SubmitRequest, SubmitResponse, Wallet } from '..' import type { Client, SubmitRequest, SubmitResponse, Wallet } from '..'
import { ValidationError, XrplError } from '../errors' import { ValidationError, XrplError } from '../errors'

View File

@@ -1,7 +1,4 @@
import { import { xAddressToClassicAddress, isValidXAddress } from 'ripple-address-codec'
xAddressToClassicAddress,
isValidXAddress,
} from '@transia/ripple-address-codec'
/** /**
* If an address is an X-Address, converts it to a classic address. * If an address is an X-Address, converts it to a classic address.

View File

@@ -1,5 +1,5 @@
import { classicAddressToXAddress } from '@transia/ripple-address-codec' import { classicAddressToXAddress } from 'ripple-address-codec'
import { deriveKeypair, deriveAddress } from '@transia/ripple-keypairs' import { deriveKeypair, deriveAddress } from 'ripple-keypairs'
/** /**
* Derive an X-Address from a public key and a destination tag. * Derive an X-Address from a public key and a destination tag.

View File

@@ -3,8 +3,8 @@
/* eslint-disable no-bitwise -- this file mimics behavior in rippled. It uses /* eslint-disable no-bitwise -- this file mimics behavior in rippled. It uses
bitwise operators for and-ing numbers with a mask and bit shifting. */ bitwise operators for and-ing numbers with a mask and bit shifting. */
import { decode, encode } from '@transia/ripple-binary-codec'
import BigNumber from 'bignumber.js' import BigNumber from 'bignumber.js'
import { decode, encode } from 'ripple-binary-codec'
import { ValidationError, XrplError } from '../../errors' import { ValidationError, XrplError } from '../../errors'
import type { Ledger } from '../../models/ledger' import type { Ledger } from '../../models/ledger'
@@ -83,11 +83,7 @@ export function hashSignedTx(tx: Transaction | string): string {
txObject = tx txObject = tx
} }
if ( if (txObject.TxnSignature === undefined && txObject.Signers === undefined) {
!txObject.EmitDetails &&
txObject.TxnSignature === undefined &&
txObject.Signers === undefined
) {
throw new ValidationError('The transaction must be signed to hash it.') throw new ValidationError('The transaction must be signed to hash it.')
} }

View File

@@ -3,10 +3,8 @@
/* eslint-disable no-bitwise -- this file mimics behavior in rippled. It uses /* eslint-disable no-bitwise -- this file mimics behavior in rippled. It uses
bitwise operators for and-ing numbers with a mask and bit shifting. */ bitwise operators for and-ing numbers with a mask and bit shifting. */
import { decodeAccountID } from '@transia/ripple-address-codec'
import BigNumber from 'bignumber.js' import BigNumber from 'bignumber.js'
import { decodeAccountID } from 'ripple-address-codec'
import { convertStringToHex } from '../stringConversion'
import hashLedger, { import hashLedger, {
hashLedgerHeader, hashLedgerHeader,
@@ -186,18 +184,4 @@ export function hashPaymentChannel(
) )
} }
/**
* Compute the Hash of an URIToken LedgerEntry.
*
* @param issuer - Address of the issuer of the URIToken.
* @param uri - string uri of the URIToken (not the hex).
* @returns The hash of the URIToken LedgerEntry.
* @category Utilities
*/
export function hashURIToken(issuer: string, uri: string): string {
return sha512Half(
ledgerSpaceHex('uriToken') + addressToHex(issuer) + convertStringToHex(uri),
)
}
export { hashLedgerHeader, hashSignedTx, hashLedger, hashStateTree, hashTxTree } export { hashLedgerHeader, hashSignedTx, hashLedger, hashStateTree, hashTxTree }

View File

@@ -28,7 +28,6 @@ const ledgerSpaces = {
signerList: 'S', signerList: 'S',
paychan: 'x', paychan: 'x',
check: 'C', check: 'C',
uriToken: 'U',
depositPreauth: 'p', depositPreauth: 'p',
} }

View File

@@ -4,11 +4,9 @@
* This module contains the transaction types and the function to calculate the hook on * This module contains the transaction types and the function to calculate the hook on
*/ */
import { // eslint-disable-next-line @typescript-eslint/no-require-imports -- Required
TRANSACTION_TYPES, import createHash = require('create-hash')
TRANSACTION_TYPE_MAP, import { TRANSACTION_TYPES, TRANSACTION_TYPE_MAP } from 'ripple-binary-codec'
} from '@transia/ripple-binary-codec'
// import createHash = require('create-hash')
import { XrplError } from '../errors' import { XrplError } from '../errors'
import { HookParameter } from '../models/common' import { HookParameter } from '../models/common'
@@ -44,7 +42,7 @@ export function calculateHookOn(arr: Array<keyof TTS>): string {
`invalid transaction type '${String(nth)}' in HookOn array`, `invalid transaction type '${String(nth)}' in HookOn array`,
) )
} }
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment -- Required
const tts: Record<string, number> = TRANSACTION_TYPE_MAP const tts: Record<string, number> = TRANSACTION_TYPE_MAP
let value = BigInt(hash) let value = BigInt(hash)
// eslint-disable-next-line no-bitwise -- Required // eslint-disable-next-line no-bitwise -- Required
@@ -58,12 +56,32 @@ export function calculateHookOn(arr: Array<keyof TTS>): string {
return hash.toUpperCase() return hash.toUpperCase()
} }
function isHex(value: string): boolean { /**
return /^[0-9A-F]+$/iu.test(value) * Calculate the sha256 of a string
*
* @param string - the string to calculate the sha256
* @returns the sha256
*/
export async function sha256(string: string): Promise<string> {
const hash = createHash('sha256')
hash.update(string)
const hashBuffer = hash.digest()
const hashArray = Array.from(new Uint8Array(hashBuffer))
const hashHex = hashArray
// eslint-disable-next-line @typescript-eslint/no-magic-numbers -- Required
.map((bytes) => bytes.toString(16).padStart(2, '0'))
.join('')
return hashHex
} }
function hexValue(value: string): string { /**
return Buffer.from(value, 'utf8').toString('hex').toUpperCase() * Calculate the hex of a namespace
*
* @param namespace - the namespace to calculate the hex
* @returns the hex
*/
export async function hexNamespace(namespace: string): Promise<string> {
return (await sha256(namespace)).toUpperCase()
} }
/** /**
@@ -75,21 +93,20 @@ function hexValue(value: string): string {
export function hexHookParameters(data: HookParameter[]): HookParameter[] { export function hexHookParameters(data: HookParameter[]): HookParameter[] {
const hookParameters: HookParameter[] = [] const hookParameters: HookParameter[] = []
for (const parameter of data) { for (const parameter of data) {
let hookPName = parameter.HookParameter.HookParameterName
let hookPValue = parameter.HookParameter.HookParameterValue
if (!isHex(hookPName)) {
hookPName = hexValue(hookPName)
}
if (!isHex(hookPValue)) {
hookPValue = hexValue(hookPValue)
}
hookParameters.push({ hookParameters.push({
HookParameter: { HookParameter: {
HookParameterName: hookPName, HookParameterName: Buffer.from(
HookParameterValue: hookPValue, parameter.HookParameter.HookParameterName,
'utf8',
)
.toString('hex')
.toUpperCase(),
HookParameterValue: Buffer.from(
parameter.HookParameter.HookParameterValue,
'utf8',
)
.toString('hex')
.toUpperCase(),
}, },
}) })
} }

View File

@@ -13,9 +13,9 @@ import {
isValidClassicAddress, isValidClassicAddress,
isValidXAddress, isValidXAddress,
xAddressToClassicAddress, xAddressToClassicAddress,
} from '@transia/ripple-address-codec' } from 'ripple-address-codec'
import * as rbc from '@transia/ripple-binary-codec' import * as rbc from 'ripple-binary-codec'
import { verify as verifyKeypairSignature } from '@transia/ripple-keypairs' import { verify as verifyKeypairSignature } from 'ripple-keypairs'
import { LedgerEntry } from '../models/ledger' import { LedgerEntry } from '../models/ledger'
import { Response } from '../models/methods' import { Response } from '../models/methods'
@@ -39,9 +39,8 @@ import {
hashLedgerHeader, hashLedgerHeader,
hashEscrow, hashEscrow,
hashPaymentChannel, hashPaymentChannel,
hashURIToken,
} from './hashes' } from './hashes'
import { calculateHookOn, hexHookParameters, TTS } from './hooks' import { calculateHookOn, hexNamespace, hexHookParameters, TTS } from './hooks'
import parseNFTokenID from './parseNFTokenID' import parseNFTokenID from './parseNFTokenID'
import { import {
percentToTransferRate, percentToTransferRate,
@@ -174,7 +173,6 @@ const hashes = {
hashLedgerHeader, hashLedgerHeader,
hashEscrow, hashEscrow,
hashPaymentChannel, hashPaymentChannel,
hashURIToken,
} }
export { export {
@@ -226,6 +224,7 @@ export {
createCrossChainPayment, createCrossChainPayment,
parseNFTokenID, parseNFTokenID,
calculateHookOn, calculateHookOn,
hexNamespace,
hexHookParameters, hexHookParameters,
TTS, TTS,
} }

View File

@@ -1,6 +1,6 @@
/* eslint-disable @typescript-eslint/no-magic-numbers -- Doing hex string parsing. */ /* eslint-disable @typescript-eslint/no-magic-numbers -- Doing hex string parsing. */
import { encodeAccountID } from '@transia/ripple-address-codec'
import BigNumber from 'bignumber.js' import BigNumber from 'bignumber.js'
import { encodeAccountID } from 'ripple-address-codec'
import { XrplError } from '../errors' import { XrplError } from '../errors'

View File

@@ -1,5 +1,5 @@
import { encodeForSigningClaim } from '@transia/ripple-binary-codec' import { encodeForSigningClaim } from 'ripple-binary-codec'
import { sign } from '@transia/ripple-keypairs' import { sign } from 'ripple-keypairs'
import { xrpToDrops } from './xrpConversion' import { xrpToDrops } from './xrpConversion'

View File

@@ -1,5 +1,5 @@
import { encodeForSigningClaim } from '@transia/ripple-binary-codec' import { encodeForSigningClaim } from 'ripple-binary-codec'
import { verify } from '@transia/ripple-keypairs' import { verify } from 'ripple-keypairs'
import { xrpToDrops } from './xrpConversion' import { xrpToDrops } from './xrpConversion'

View File

@@ -1,5 +1,5 @@
import { decode } from '@transia/ripple-binary-codec'
import { assert } from 'chai' import { assert } from 'chai'
import { decode } from 'ripple-binary-codec'
import { import {
AccountSet, AccountSet,

View File

@@ -1,5 +1,5 @@
import { decode } from '@transia/ripple-binary-codec'
import { assert } from 'chai' import { assert } from 'chai'
import { decode } from 'ripple-binary-codec'
import { import {
AccountSet, AccountSet,

View File

@@ -1,6 +1,6 @@
import { Client } from '@transia/xrpl'
import { assert } from 'chai' import { assert } from 'chai'
import _ from 'lodash' import _ from 'lodash'
import { Client } from 'xrpl'
import { import {
convertStringToHex, convertStringToHex,

View File

@@ -18,9 +18,8 @@ describe('SignerListSet', function () {
}) })
afterEach(async () => teardownClient(testContext)) afterEach(async () => teardownClient(testContext))
// Add signerlist
it( it(
'add', 'base',
async () => { async () => {
const tx: SignerListSet = { const tx: SignerListSet = {
TransactionType: 'SignerListSet', TransactionType: 'SignerListSet',
@@ -45,18 +44,4 @@ describe('SignerListSet', function () {
}, },
TIMEOUT, TIMEOUT,
) )
// Remove signerlist
it(
'remove',
async () => {
const tx: SignerListSet = {
TransactionType: 'SignerListSet',
Account: testContext.wallet.classicAddress,
SignerQuorum: 0,
}
await testTransaction(testContext.client, tx, testContext.wallet)
},
TIMEOUT,
)
}) })

View File

@@ -1,7 +1,7 @@
import { decode } from '@transia/ripple-binary-codec'
import { assert } from 'chai' import { assert } from 'chai'
import omit from 'lodash/omit' import omit from 'lodash/omit'
import throttle from 'lodash/throttle' import throttle from 'lodash/throttle'
import { decode } from 'ripple-binary-codec'
import { import {
Client, Client,

View File

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

View File

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

View File

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

View File

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

View File

@@ -69,7 +69,7 @@ describe('SetHook', function () {
) )
}) })
it(`throws w/ maximum of 10 members allowed in Hooks`, function () { it(`throws w/ maximum of 4 members allowed in Hooks`, function () {
setHookTx.Hooks = [] setHookTx.Hooks = []
const hook = { const hook = {
Hook: { Hook: {
@@ -88,14 +88,8 @@ describe('SetHook', function () {
setHookTx.Hooks.push(hook) setHookTx.Hooks.push(hook)
setHookTx.Hooks.push(hook) setHookTx.Hooks.push(hook)
setHookTx.Hooks.push(hook) setHookTx.Hooks.push(hook)
setHookTx.Hooks.push(hook)
setHookTx.Hooks.push(hook)
setHookTx.Hooks.push(hook)
setHookTx.Hooks.push(hook)
setHookTx.Hooks.push(hook)
setHookTx.Hooks.push(hook)
const errorMessage = 'SetHook: maximum of 10 hooks allowed in Hooks' const errorMessage = 'SetHook: maximum of 4 hooks allowed in Hooks'
assert.throws( assert.throws(
() => validateSetHook(setHookTx), () => validateSetHook(setHookTx),
ValidationError, ValidationError,

View File

@@ -1,8 +1,8 @@
import fs from 'fs' import fs from 'fs'
import path from 'path' import path from 'path'
import { encode } from '@transia/ripple-binary-codec'
import { assert } from 'chai' import { assert } from 'chai'
import { encode } from 'ripple-binary-codec'
import { OfferCreate, Transaction, ValidationError } from '../../src' import { OfferCreate, Transaction, ValidationError } from '../../src'
import { import {
@@ -15,7 +15,6 @@ import {
hashAccountRoot, hashAccountRoot,
hashOfferId, hashOfferId,
hashSignerListId, hashSignerListId,
hashURIToken,
} from '../../src/utils/hashes' } from '../../src/utils/hashes'
import fixtures from '../fixtures/rippled' import fixtures from '../fixtures/rippled'
import { assertResultMatch } from '../testUtils' import { assertResultMatch } from '../testUtils'
@@ -144,16 +143,6 @@ describe('Hashes', function () {
assert.equal(actualEntryHash, expectedEntryHash) assert.equal(actualEntryHash, expectedEntryHash)
}) })
it('calcURITokenEntryHash', function () {
const issuer = 'rDx69ebzbowuqztksVDmZXjizTd12BVr4x'
const uri = 'ipfs://cid'
const expectedEntryHash =
'AFC4233E5C4094952DEF5483DC41488C8744D1268F897C0CB25DE66399591399'
const actualEntryHash = hashURIToken(issuer, uri)
assert.equal(actualEntryHash, expectedEntryHash)
})
it('Hash a signed transaction correctly', function () { it('Hash a signed transaction correctly', function () {
const expected_hash = const expected_hash =
'458101D51051230B1D56E9ACAFAA34451BF65FA000F95DF6F0FF5B3A62D83FC2' '458101D51051230B1D56E9ACAFAA34451BF65FA000F95DF6F0FF5B3A62D83FC2'

View File

@@ -1,6 +1,11 @@
import { assert } from 'chai' import { assert } from 'chai'
import { calculateHookOn, hexHookParameters, TTS } from '../../src' import {
calculateHookOn,
hexNamespace,
hexHookParameters,
TTS,
} from '../../src'
describe('test hook on', function () { describe('test hook on', function () {
it('invalid', function () { it('invalid', function () {
@@ -26,6 +31,16 @@ describe('test hook on', function () {
}) })
}) })
describe('test hook namespace', function () {
it('basic', async function () {
const result = await hexNamespace('starter')
assert.equal(
result,
'4FF9961269BF7630D32E15276569C94470174A5DA79FA567C0F62251AA9A36B9',
)
})
})
describe('test hook parameters', function () { describe('test hook parameters', function () {
it('basic', async function () { it('basic', async function () {
const parameters = [ const parameters = [

View File

@@ -1,5 +1,5 @@
import { decode } from '@transia/ripple-binary-codec'
import { assert } from 'chai' import { assert } from 'chai'
import { decode } from 'ripple-binary-codec'
import { NFTokenMint, Payment, Transaction } from '../../src' import { NFTokenMint, Payment, Transaction } from '../../src'
import ECDSA from '../../src/ECDSA' import ECDSA from '../../src/ECDSA'

View File

@@ -1,5 +1,5 @@
import { decode, encode } from '@transia/ripple-binary-codec'
import { assert } from 'chai' import { assert } from 'chai'
import { decode, encode } from 'ripple-binary-codec'
import { Transaction, ValidationError } from '../../src' import { Transaction, ValidationError } from '../../src'
import Wallet from '../../src/Wallet' import Wallet from '../../src/Wallet'