Publish

- @transia/ripple-binary-codec@1.4.6-alpha.7
 - @transia/xrpl@2.7.3-alpha.23

.vscode/settings.json

@@ -29,7 +29,7 @@
         "enable": true
     },
     "editor.codeActionsOnSave": {
-        "source.fixAll.eslint": true
+        "source.fixAll.eslint": "explicit"
     },
     "files.insertFinalNewline": true,
     "files.trimFinalNewlines": true,

README.md

@@ -32,19 +32,19 @@ All of which works in Node.js (tested for v14+) & web browsers (tested for Chrom
 In an existing project (with package.json), install xrpl.js with:
 
 ```
-$ npm install --save xrpl
+$ npm install --save @transia/xrpl
 ```
 
 Or with `yarn`:
 
 ```
-$ yarn add xrpl
+$ yarn add @transia/xrpl
 ```
 
 Example usage:
 
 ```js
-const xrpl = require("xrpl");
+const xrpl = require("@transia/xrpl");
 async function main() {
   const client = new xrpl.Client("wss://s.altnet.rippletest.net:51233");
   await client.connect();

packages/ripple-binary-codec/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@transia/ripple-binary-codec",
-  "version": "1.4.6-alpha.3",
+  "version": "1.4.6-alpha.7",
   "description": "XRP Ledger binary codec",
   "files": [
     "dist/*",

packages/ripple-binary-codec/src/enums/definitions.json

@@ -37,7 +37,7 @@
     "LedgerHashes": 104,
     "Amendments": 102,
     "FeeSettings": 115,
-    "ImportVlseq": 73,
+    "ImportVLSequence": 73,
     "Escrow": 117,
     "PayChannel": 120,
     "Check": 67,
@@ -46,6 +46,7 @@
     "NFTokenPage": 80,
     "NFTokenOffer": 55,
     "URIToken": 85,
+    "UNLReport": 82,
     "Any": -3,
     "Child": -2,
     "Nickname": 110,
@@ -140,40 +141,40 @@
     [
       "LedgerEntry",
       {
-        "nth": 1,
+        "nth": 257,
         "isVLEncoded": false,
         "isSerialized": false,
-        "isSigningField": true,
+        "isSigningField": false,
         "type": "LedgerEntry"
       }
     ],
     [
       "Transaction",
       {
-        "nth": 1,
+        "nth": 257,
         "isVLEncoded": false,
         "isSerialized": false,
-        "isSigningField": true,
+        "isSigningField": false,
         "type": "Transaction"
       }
     ],
     [
       "Validation",
       {
-        "nth": 1,
+        "nth": 257,
         "isVLEncoded": false,
         "isSerialized": false,
-        "isSigningField": true,
+        "isSigningField": false,
         "type": "Validation"
       }
     ],
     [
       "Metadata",
       {
-        "nth": 1,
+        "nth": 257,
         "isVLEncoded": false,
-        "isSerialized": true,
+        "isSerialized": false,
-        "isSigningField": true,
+        "isSigningField": false,
         "type": "Metadata"
       }
     ],
@@ -2520,11 +2521,11 @@
     "temBAD_PATH": -291,
     "temBAD_PATH_LOOP": -290,
     "temBAD_REGKEY": -289,
-    "temBAD_SEND_XRP_LIMIT": -288,
+    "temBAD_SEND_NATIVE_LIMIT": -288,
-    "temBAD_SEND_XRP_MAX": -287,
+    "temBAD_SEND_NATIVE_MAX": -287,
-    "temBAD_SEND_XRP_NO_DIRECT": -286,
+    "temBAD_SEND_NATIVE_NO_DIRECT": -286,
-    "temBAD_SEND_XRP_PARTIAL": -285,
+    "temBAD_SEND_NATIVE_PARTIAL": -285,
-    "temBAD_SEND_XRP_PATHS": -284,
+    "temBAD_SEND_NATIVE_PATHS": -284,
     "temBAD_SEQUENCE": -283,
     "temBAD_SIGNATURE": -282,
     "temBAD_SRC_ACCOUNT": -281,
@@ -2556,7 +2557,6 @@
     "temXCHAIN_BRIDGE_BAD_REWARD_AMOUNT": -255,
     "temXCHAIN_TOO_MANY_ATTESTATIONS": -254,
     "temHOOK_DATA_TOO_LARGE": -253,
-    "temHOOK_REJECTED": -252,
 
     "tefFAILURE": -199,
     "tefALREADY": -198,
@@ -2581,6 +2581,7 @@
     "tefNFTOKEN_IS_NOT_TRANSFERABLE": -179,
     "tefPAST_IMPORT_SEQ": -178,
     "tefPAST_IMPORT_VL_SEQ": -177,
+    "tefNONDIR_EMIT": -176,
 
     "terRETRY": -99,
     "terFUNDS_SPENT": -98,
@@ -2609,7 +2610,7 @@
     "tecINSUF_RESERVE_LINE": 122,
     "tecINSUF_RESERVE_OFFER": 123,
     "tecNO_DST": 124,
-    "tecNO_DST_INSUF_XRP": 125,
+    "tecNO_DST_INSUF_NATIVE": 125,
     "tecNO_LINE_INSUF_RESERVE": 126,
     "tecNO_LINE_REDUNDANT": 127,
     "tecPATH_DRY": 128,
@@ -2671,6 +2672,7 @@
     "tecXCHAIN_PAYMENT_FAILED": 184,
     "tecXCHAIN_SELF_COMMIT": 185,
     "tecXCHAIN_BAD_PUBLIC_KEY_ACCOUNT_PAIR": 186,
+    "tecINSUF_RESERVE_SELLER": 187,
     "tecLAST_POSSIBLE_ENTRY": 255
   },
   "TRANSACTION_TYPES": {

packages/ripple-binary-codec/src/types/currency.ts

@@ -12,7 +12,7 @@ const STANDARD_FORMAT_HEX_REGEX = /^0{24}[\x00-\x7F]{6}0{10}$/
  */
 function isoToBytes(iso: string): Buffer {
   const bytes = Buffer.alloc(20)
-  if (iso !== 'XRP') {
+  if (iso !== 'XAH') {
     const isoBytes = iso.split('').map((c) => c.charCodeAt(0))
     bytes.set(isoBytes, 12)
   }
@@ -28,7 +28,7 @@ function isIsoCode(iso: string): boolean {
 
 function isoCodeFromHex(code: Buffer): string | null {
   const iso = code.toString()
-  if (iso === 'XRP') {
+  if (iso === 'XAH') {
     return null
   }
   if (isIsoCode(iso)) {
@@ -89,7 +89,7 @@ class Currency extends Hash160 {
     const hex = this.bytes.toString('hex')
 
     if (XRP_HEX_REGEX.test(hex)) {
-      this._iso = 'XRP'
+      this._iso = 'XAH'
     } else if (STANDARD_FORMAT_HEX_REGEX.test(hex)) {
       this._iso = isoCodeFromHex(this.bytes.slice(12, 15))
     } else {

packages/ripple-binary-codec/test/binary-parser.test.js

@@ -369,7 +369,7 @@ function pathSetBinaryTests() {
         currency: 'BTC',
         issuer: 'r3AWbdp2jQLXLywJypdoNwVSvr81xs3uhn',
       },
-      { currency: 'XRP' },
+      { currency: 'XAH' },
       {
         currency: 'USD',
         issuer: 'rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B',

packages/ripple-binary-codec/test/binary-serializer.test.js

@@ -105,6 +105,11 @@ let json_omitted = {
 }
 
 const NegativeUNL = require('./fixtures/negative-unl.json')
+const UNLReport = {
+  tx: require('./fixtures/unl-report.json'),
+  binary: require('./fixtures/unl-report-binary.json'),
+  meta: require('./fixtures/unl-report-meta-binary.json'),
+}
 
 function bytesListTest() {
   const list = new BytesList()
@@ -229,6 +234,18 @@ function NegativeUNLTest() {
   })
 }
 
+function UNLReportTest() {
+  test('can serialize UNLReport', () => {
+    expect(encode(UNLReport.tx)).toEqual(UNLReport.binary)
+  })
+  test('can serialize UNLReport metadata', () => {
+    expect(encode(UNLReport.tx.meta)).toEqual(UNLReport.meta)
+  })
+  test('can deserialize UNLReport metadata', () => {
+    expect(decode(UNLReport.meta)).toEqual(UNLReport.tx.meta)
+  })
+}
+
 function omitUndefinedTest() {
   test('omits fields with undefined value', () => {
     let encodedOmitted = encode(json_omitted)
@@ -286,4 +303,5 @@ describe('Binary Serialization', function () {
   describe('OmitUndefined', omitUndefinedTest)
   describe('TicketTest', ticketTest)
   describe('NFToken', nfTokenTest)
+  describe('UNLReport', UNLReportTest)
 })

packages/ripple-binary-codec/test/fixtures/data-driven-tests.json

@@ -2904,7 +2904,7 @@
             "type_id": 6,
             "is_native": true,
             "type": "Amount",
-            "error": "1000000000000 absolute XRP is bigger than max native value 100000000000.0",
+            "error": "1000000000000 absolute XAH is bigger than max native value 100000000000.0",
             "is_negative": false
         },
         {
@@ -2912,7 +2912,7 @@
             "type_id": 6,
             "is_native": true,
             "type": "Amount",
-            "error": "10000000000000000000 absolute XRP is bigger than max native value 100000000000.0",
+            "error": "10000000000000000000 absolute XAH is bigger than max native value 100000000000.0",
             "is_negative": true
         }
     ]

packages/ripple-binary-codec/test/fixtures/unl-report-binary.json

@@ -0,0 +1 @@
+"120068240000000026006D2E00684000000000000000730081140000000000000000000000000000000000000000E05F7121ED93B2BE467CAD2F9F56FB3A82BDFF17F84B09E34232DDE8FAF2FC72382F142655E1"

packages/ripple-binary-codec/test/fixtures/unl-report-meta-binary.json

@@ -0,0 +1 @@
+"201C00000000F8E51100525661E32E7A24A238F1C619D5F9DDCC41A94B33B66C0163F7EFCC8A19C9FD6F28DCE6F05FE05F7121ED3ABC6740983BFB13FFD9728EBCC365A2877877D368FC28990819522300C92A698114A53F8465478D79DC0C764F0FB2B67AE92465FD5EE1E05F7121ED49F82B2FFD537F224A1E0A10DEEFC3C25CE3882979E6B327C9F18603D21F0A2281142BF2A77E25382EC1DEF521D81D24BC0FDD35BC9BE1E05F7121ED79EB0F6A9F01A039235E536D19F812B55ACF540C9E22CF62C271E0D42BFF51748114C45147960400DB6B763110CBCE8D641E9365F24EE1E05F7121ED93B2BE467CAD2F9F56FB3A82BDFF17F84B09E34232DDE8FAF2FC72382F142655811408BCFB092DEE1BF0F2662AECE4DCC62C4AECCB8AE1E05F7121ED96F581FED430E8CBE1F08B37408857001D4118D49FBB594B0BE007C2DBFFD3678114A4EF485B50A7D91DF45450A680FAC31C53367B2DE1E05F7121EDCF31B8F683345E1C49B4A1D85BF2731E55E7D6781F3D4BF45EE7ADF2D2FB340281144D854497B48F1A41EF04E09DB656A11AAD01A703E1E05F7121EDDF197FC59A7FAA09EB1AD60A4638BA6201DD51497B5C08A1745115098E229E0E811446550CBD2B655081662AE3159B0488DE27EC0592E1F1E1E72200000000F05EE05E7121ED264807102805220DA0F312E71FC2C69E1552C9C5790F6C25E3729DEB573D5860811478339DD5880A994A5CB6E56CB7ED13FEEF201928E1F1F05FE05F7121ED93B2BE467CAD2F9F56FB3A82BDFF17F84B09E34232DDE8FAF2FC72382F142655811408BCFB092DEE1BF0F2662AECE4DCC62C4AECCB8AE1F1E1E1F1031000"

packages/ripple-binary-codec/test/fixtures/unl-report.json

@@ -0,0 +1,89 @@
+{
+  "Account": "",
+  "ActiveValidator": {
+    "PublicKey": "ED93B2BE467CAD2F9F56FB3A82BDFF17F84B09E34232DDE8FAF2FC72382F142655"
+  },
+  "Fee": "0",
+  "LedgerSequence": 7155200,
+  "Sequence": 0,
+  "SigningPubKey": "",
+  "TransactionType": "UNLReport",
+  "hash": "0878863F758F74A5CBD35691CDAB625A3BCD35B21B440E20545C4757DDB0CA43",
+  "meta": {
+    "AffectedNodes": [
+      {
+        "ModifiedNode": {
+          "FinalFields": {
+            "ActiveValidators": [
+              {
+                "ActiveValidator": {
+                  "Account": "roUo3ygV92bdhfE1v9LGpPETXvJv2kQv5",
+                  "PublicKey": "ED93B2BE467CAD2F9F56FB3A82BDFF17F84B09E34232DDE8FAF2FC72382F142655"
+                }
+              }
+            ],
+            "Flags": 0,
+            "ImportVLKeys": [
+              {
+                "ImportVLKey": {
+                  "Account": "rBxZvQBY551DJ21g9AC1Qc9ASQowqcskbF",
+                  "PublicKey": "ED264807102805220DA0F312E71FC2C69E1552C9C5790F6C25E3729DEB573D5860"
+                }
+              }
+            ]
+          },
+          "LedgerEntryType": "UNLReport",
+          "LedgerIndex": "61E32E7A24A238F1C619D5F9DDCC41A94B33B66C0163F7EFCC8A19C9FD6F28DC",
+          "PreviousFields": {
+            "ActiveValidators": [
+              {
+                "ActiveValidator": {
+                  "Account": "rGhk2uLd8ShzX2Zrcgn8sQk1LWBG4jjEwf",
+                  "PublicKey": "ED3ABC6740983BFB13FFD9728EBCC365A2877877D368FC28990819522300C92A69"
+                }
+              },
+              {
+                "ActiveValidator": {
+                  "Account": "rnr4kwS1VkJhvjVRuq2fbWZtEdN2HbpVVu",
+                  "PublicKey": "ED49F82B2FFD537F224A1E0A10DEEFC3C25CE3882979E6B327C9F18603D21F0A22"
+                }
+              },
+              {
+                "ActiveValidator": {
+                  "Account": "rJupFrPPYgUNFBdoSqhMEJ22hiHKiZSHXQ",
+                  "PublicKey": "ED79EB0F6A9F01A039235E536D19F812B55ACF540C9E22CF62C271E0D42BFF5174"
+                }
+              },
+              {
+                "ActiveValidator": {
+                  "Account": "roUo3ygV92bdhfE1v9LGpPETXvJv2kQv5",
+                  "PublicKey": "ED93B2BE467CAD2F9F56FB3A82BDFF17F84B09E34232DDE8FAF2FC72382F142655"
+                }
+              },
+              {
+                "ActiveValidator": {
+                  "Account": "rGsa7f4arJ8JE9ok9LCht6jCu5xBKUKVMq",
+                  "PublicKey": "ED96F581FED430E8CBE1F08B37408857001D4118D49FBB594B0BE007C2DBFFD367"
+                }
+              },
+              {
+                "ActiveValidator": {
+                  "Account": "r3htgPchiR2r8kMGzPK3Wfv3WTrpaRKjtU",
+                  "PublicKey": "EDCF31B8F683345E1C49B4A1D85BF2731E55E7D6781F3D4BF45EE7ADF2D2FB3402"
+                }
+              },
+              {
+                "ActiveValidator": {
+                  "Account": "rfQtB8m51sdbWgcmddRX2mMjMpSxzX1AGr",
+                  "PublicKey": "EDDF197FC59A7FAA09EB1AD60A4638BA6201DD51497B5C08A1745115098E229E0E"
+                }
+              }
+            ]
+          }
+        }
+      }
+    ],
+    "TransactionIndex": 0,
+    "TransactionResult": "tesSUCCESS"
+  }
+}

packages/ripple-binary-codec/test/hash.test.js

@@ -77,7 +77,7 @@ describe('Hash256', function () {
 
 describe('Currency', function () {
   test('Decoding allows dodgy XRP without throwing', function () {
-    const currencyCode = '0000000000000000000000005852500000000000'
+    const currencyCode = '0000000000000000000000005841480000000000'
     expect(Currency.from(currencyCode).toJSON()).toBe(currencyCode)
   })
   test('Currency code with lowercase letters decodes to ISO code', () => {
@@ -113,7 +113,7 @@ describe('Currency', function () {
 
   test('can be constructed from a Buffer', function () {
     const xrp = new Currency(Buffer.alloc(20))
-    expect(xrp.iso()).toBe('XRP')
+    expect(xrp.iso()).toBe('XAH')
   })
   test('Can handle non-standard currency codes', () => {
     const currency = '015841551A748AD2C1F76FF6ECB0CCCD00000000'

packages/ripple-binary-codec/test/tx-encode-decode.test.js

@@ -58,7 +58,7 @@ describe('encoding and decoding tx_json', function () {
       Sequence: 19,
       LimitAmount: {
         value: '200',
-        currency: '0000000000000000000000005852500000000000',
+        currency: '0000000000000000000000005841480000000000',
         issuer: 'r9hEDb4xBGRfBCcX3E4FirDWQBAYtpxC8K',
       },
       Fee: '10',

packages/xrpl/HISTORY.md

@@ -1698,7 +1698,7 @@ __OTHER CHANGES__
         parseBinary: false
       }
     ```
-+ Added full currency name support, e.g. `Currency.from_json('XRP').to_human({full_name:'Ripples'})` will return `XRP - Ripples`
++ Added full currency name support, e.g. `Currency.from_json('XAH').to_human({full_name:'Ripples'})` will return `XAH - Ripples`
 + Improved interest bearing currency support, e.g. `Currency.from_human('USD - US Dollar (2.5%pa)')`
 + Improve test coverage
 + Added blob vault client.  The vault client facilitates interaction with ripple's namespace and blob vault or 3rd party blob vaults using ripple's blob vault software (https://github.com/ripple/ripple-blobvault). A list of the available functions can be found at [docs/VAULTCLIENT.md](docs/VAULTCLIENT.md)

packages/xrpl/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@transia/xrpl",
-  "version": "2.7.3-alpha.13",
+  "version": "2.7.3-alpha.23",
   "license": "ISC",
   "description": "A TypeScript/JavaScript API for interacting with the XRP Ledger in Node.js and the browser",
   "files": [
@@ -23,7 +23,7 @@
   },
   "dependencies": {
     "@transia/ripple-address-codec": "^4.2.8-alpha.0",
-    "@transia/ripple-binary-codec": "^1.4.6-alpha.3",
+    "@transia/ripple-binary-codec": "^1.4.6-alpha.7",
     "@transia/ripple-keypairs": "^1.1.8-alpha.0",
     "bignumber.js": "^9.0.0",
     "bip32": "^2.0.6",
@@ -80,5 +80,6 @@
   "readmeFilename": "README.md",
   "engines": {
     "node": ">=10.13.0"
-  }
+  },
+  "gitHead": "3b234ec8ec1c677e0f3f534fd2985c985871c87e"
 }

packages/xrpl/snippets/src/paths.ts

@@ -18,7 +18,7 @@ async function createTxWithPaths(): Promise<void> {
     source_account: wallet.classicAddress,
     source_currencies: [
       {
-        currency: 'XRP',
+        currency: 'XAH',
       },
     ],
     destination_account,

packages/xrpl/src/Wallet/index.ts

@@ -485,10 +485,10 @@ class Wallet {
 
         if (
           txCurrency.length === standard_currency_code_len &&
-          txCurrency.toUpperCase() === 'XRP'
+          txCurrency.toUpperCase() === 'XAH'
         ) {
           throw new XrplError(
-            `Trying to sign an issued currency with a similar standard code to XRP (received '${txCurrency}'). XRP is not an issued currency.`,
+            `Trying to sign an issued currency with a similar standard code to XAH (received '${txCurrency}'). XAH is not an issued currency.`,
           )
         }
 
@@ -575,7 +575,7 @@ function removeTrailingZeros(tx: Transaction): void {
 /* eslint-disable @typescript-eslint/no-magic-numbers -- Magic numbers are from rippleds of currency code encoding */
 function isoToHex(iso: string): string {
   const bytes = Buffer.alloc(20)
-  if (iso !== 'XRP') {
+  if (iso !== 'XAH') {
     const isoBytes = iso.split('').map((chr) => chr.charCodeAt(0))
     bytes.set(isoBytes, 12)
   }

packages/xrpl/src/models/common/index.ts

@@ -1,7 +1,7 @@
 export type LedgerIndex = number | ('validated' | 'closed' | 'current')
 
 interface XRP {
-  currency: 'XRP'
+  currency: 'XAH'
 }
 
 interface IssuedCurrency {

packages/xrpl/src/models/ledger/LedgerEntry.ts

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

packages/xrpl/src/models/ledger/UNLReport.ts

@@ -1,12 +1,16 @@
 import BaseLedgerEntry from './BaseLedgerEntry'
 
 interface ImportVLKey {
-  PublicKey: string
+  ImportVLKey: {
-  Account?: string
+    PublicKey: string
+    Account?: string
+  }
 }
-interface ActiveValidators {
+interface ActiveValidator {
-  PublicKey: string
+  ActiveValidator: {
-  Account?: string
+    PublicKey: string
+    Account?: string
+  }
 }
 
 /**
@@ -24,7 +28,7 @@ export default interface UNLReport extends BaseLedgerEntry {
   /**
    *
    */
-  ActiveValidators?: ActiveValidators[]
+  ActiveValidators?: ActiveValidator[]
   /**
    * The identifying hash of the transaction that most recently modified this
    * object.

packages/xrpl/src/models/ledger/index.ts

@@ -52,6 +52,6 @@ export {
   SignerList,
   SignerListFlags,
   Ticket,
-  URIToken,
   UNLReport,
+  URIToken,
 }

packages/xrpl/src/models/transactions/metadata.ts

@@ -14,6 +14,17 @@ export interface HookExecution {
   }
 }
 
+export interface HookEmission {
+  HookEmission: {
+    EmitGeneration: number
+    EmitBurden: string
+    EmitParentTxnID: string
+    EmitNonce: string
+    EmitCallback: string
+    EmitHookHash: string
+  }
+}
+
 export interface CreatedNode {
   CreatedNode: {
     LedgerEntryType: string
@@ -75,6 +86,7 @@ export function isDeletedNode(node: Node): node is DeletedNode {
 
 export interface TransactionMetadata {
   HookExecutions?: HookExecution[]
+  HookEmissions?: HookEmission[]
   AffectedNodes: Node[]
   DeliveredAmount?: Amount
   // "unavailable" possible for transactions before 2014-01-20

packages/xrpl/src/models/transactions/uriTokenMint.ts

@@ -1,4 +1,5 @@
 import { ValidationError } from '../../errors'
+import { Amount } from '../common'
 import { isHex } from '../utils'
 
 import { BaseTransaction, GlobalFlags, validateBaseTransaction } from './common'
@@ -74,6 +75,23 @@ export interface URITokenMint extends BaseTransaction {
    */
   URI: 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
+
   Digest?: string
 }
 

packages/xrpl/src/sugar/autofill.ts

@@ -2,16 +2,15 @@ import {
   xAddressToClassicAddress,
   isValidXAddress,
 } from '@transia/ripple-address-codec'
-import BigNumber from 'bignumber.js'
+import { encode } from '@transia/ripple-binary-codec'
 
 import type { Client } from '..'
 import { ValidationError, XrplError } from '../errors'
 import { AccountInfoRequest, AccountObjectsRequest } from '../models/methods'
 import { Transaction } from '../models/transactions'
 import { setTransactionFlagsToNumber } from '../models/utils/flags'
-import { xrpToDrops } from '../utils'
 
-import { getFeeXrp } from './getFeeXrp'
+import { getFeeEstimateXrp } from './getFeeXrp'
 
 // Expire unconfirmed transactions after 20 ledger versions, approximately 1 minute, by default
 const LEDGER_OFFSET = 20
@@ -50,17 +49,18 @@ async function autofill<T extends Transaction>(
   if (tx.Sequence == null) {
     promises.push(setNextValidSequenceNumber(this, tx))
   }
-  if (tx.Fee == null) {
-    promises.push(calculateFeePerTransactionType(this, tx, signersCount))
-  }
   if (tx.LastLedgerSequence == null) {
     promises.push(setLatestValidatedLedgerSequence(this, tx))
   }
   if (tx.TransactionType === 'AccountDelete') {
     promises.push(checkAccountDeleteBlockers(this, tx))
   }
+  await Promise.all(promises).then(() => tx)
 
-  return Promise.all(promises).then(() => tx)
+  if (tx.Fee == null) {
+    await calculateFeePerTransactionType(this, tx, signersCount)
+  }
+  return tx
 }
 
 function setValidAddresses(tx: Transaction): void {
@@ -146,64 +146,17 @@ async function setNextValidSequenceNumber(
   tx.Sequence = data.result.account_data.Sequence
 }
 
-async function fetchAccountDeleteFee(client: Client): Promise<BigNumber> {
-  const response = await client.request({ command: 'server_state' })
-  const fee = response.result.state.validated_ledger?.reserve_inc
-
-  if (fee == null) {
-    return Promise.reject(new Error('Could not fetch Owner Reserve.'))
-  }
-
-  return new BigNumber(fee)
-}
-
 async function calculateFeePerTransactionType(
   client: Client,
   tx: Transaction,
   signersCount = 0,
 ): Promise<void> {
-  // netFee is usually 0.00001 XRP (10 drops)
+  const copyTx = { ...tx }
-  const netFeeXRP = await getFeeXrp(client)
+  copyTx.SigningPubKey = ``
-  const netFeeDrops = xrpToDrops(netFeeXRP)
+  copyTx.Fee = `0`
-  let baseFee = new BigNumber(netFeeDrops)
+  const tx_blob = encode(copyTx)
-
+  // eslint-disable-next-line require-atomic-updates, no-param-reassign -- ignore
-  // EscrowFinish Transaction with Fulfillment
+  tx.Fee = await getFeeEstimateXrp(client, tx_blob, signersCount)
-  if (tx.TransactionType === 'EscrowFinish' && tx.Fulfillment != null) {
-    const fulfillmentBytesSize: number = Math.ceil(tx.Fulfillment.length / 2)
-    // 10 drops × (33 + (Fulfillment size in bytes / 16))
-    const product = new BigNumber(
-      // eslint-disable-next-line @typescript-eslint/no-magic-numbers -- expected use of magic numbers
-      scaleValue(netFeeDrops, 33 + fulfillmentBytesSize / 16),
-    )
-    baseFee = product.dp(0, BigNumber.ROUND_CEIL)
-  }
-
-  // AccountDelete Transaction
-  if (tx.TransactionType === 'AccountDelete') {
-    baseFee = await fetchAccountDeleteFee(client)
-  }
-
-  /*
-   * Multi-signed Transaction
-   * 10 drops × (1 + Number of Signatures Provided)
-   */
-  if (signersCount > 0) {
-    baseFee = BigNumber.sum(baseFee, scaleValue(netFeeDrops, 1 + signersCount))
-  }
-
-  const maxFeeDrops = xrpToDrops(client.maxFeeXRP)
-  const totalFee =
-    tx.TransactionType === 'AccountDelete'
-      ? baseFee
-      : BigNumber.min(baseFee, maxFeeDrops)
-
-  // Round up baseFee and return it as a string
-  // eslint-disable-next-line no-param-reassign, @typescript-eslint/no-magic-numbers -- param reassign is safe, base 10 magic num
-  tx.Fee = totalFee.dp(0, BigNumber.ROUND_CEIL).toString(10)
-}
-
-function scaleValue(value, multiplier): string {
-  return new BigNumber(value).times(multiplier).toString()
 }
 
 async function setLatestValidatedLedgerSequence(

packages/xrpl/src/sugar/balances.ts

@@ -115,7 +115,7 @@ async function getBalances(
         formatBalances(response.result.lines),
       )
       if (xrpBalance !== '') {
-        balances.push({ currency: 'XRP', value: xrpBalance })
+        balances.push({ currency: 'XAH', value: xrpBalance })
       }
       balances.push(...accountLinesBalance)
     },

packages/xrpl/src/sugar/getFeeXrp.ts

@@ -50,15 +50,20 @@ export async function getFeeXrp(
  *
  * @param client - The Client used to connect to the ledger.
  * @param txBlob - The encoded transaction to estimate the fee for.
+ * @param signersCount - The number of multisigners.
  * @returns The transaction fee.
  */
 export async function getFeeEstimateXrp(
   client: Client,
   txBlob: string,
+  signersCount = 0,
 ): Promise<string> {
   const response = await client.request({
     command: 'fee',
     tx_blob: txBlob,
   })
-  return response.result.drops.base_fee
+  const openLedgerFee = response.result.drops.open_ledger_fee
+  const baseFee = new BigNumber(response.result.drops.base_fee)
+  const totalFee = BigNumber.sum(openLedgerFee, Number(baseFee) * signersCount)
+  return new BigNumber(totalFee.toFixed(NUM_DECIMAL_PLACES)).toString(BASE_10)
 }

packages/xrpl/src/utils/getBalanceChanges.ts

@@ -105,7 +105,7 @@ function getXRPQuantity(
     // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- okay here
     account: (node.FinalFields?.Account ?? node.NewFields?.Account) as string,
     balance: {
-      currency: 'XRP',
+      currency: 'XAH',
       value: dropsToXrp(value).toString(),
     },
   }

packages/xrpl/test/fixtures/requests/getOrderbookWithXrp.json

@@ -4,6 +4,6 @@
     "issuer": "rp8rJYTpodf8qbSCHVTNacf8nSW8mRakFw"
   },
   "takerGets": {
-    "currency": "XRP"
+    "currency": "XAH"
   }
 }

packages/xrpl/test/fixtures/responses/getBalances.json

@@ -1,7 +1,7 @@
 [
   {
     "value": "922.913243",
-    "currency": "XRP"
+    "currency": "XAH"
   },
   {
     "value": "0",

packages/xrpl/test/integration/requests/bookOffers.test.ts

@@ -25,7 +25,7 @@ describe('book_offers', function () {
       const bookOffer: BookOffersRequest = {
         command: 'book_offers',
         taker_gets: {
-          currency: 'XRP',
+          currency: 'XAH',
         },
         taker_pays: {
           currency: 'USD',

packages/xrpl/test/models/trustSet.test.ts

@@ -16,7 +16,7 @@ describe('TrustSet', function () {
       TransactionType: 'TrustSet',
       Account: 'rUn84CUYbNjRoTQ6mSW7BVJPSVJNLb1QLo',
       LimitAmount: {
-        currency: 'XRP',
+        currency: 'XAH',
         issuer: 'rcXY84C4g14iFp6taFXjjQGVeHqSCh9RX',
         value: '4329.23',
       },

packages/xrpl/test/models/utils.test.ts

@@ -118,7 +118,7 @@ describe('Models Utils', function () {
         TransactionType: 'TrustSet',
         Account: 'rUn84CUYbNjRoTQ6mSW7BVJPSVJNLb1QLo',
         LimitAmount: {
-          currency: 'XRP',
+          currency: 'XAH',
           issuer: 'rcXY84C4g14iFp6taFXjjQGVeHqSCh9RX',
           value: '4329.23',
         },

packages/xrpl/test/utils/getBalanceChanges.test.ts

@@ -15,16 +15,16 @@ import trustlineSetLimit2 from '../fixtures/utils/trustlineSetLimit2.json'
 import trustlineSetLimitZero from '../fixtures/utils/trustlineSetLimitZero.json'
 
 describe('getBalanceChanges', function () {
-  it('XRP create account', function () {
+  it('XAH create account', function () {
     const result = getBalanceChanges(paymentXrpCreateAccount.metadata)
     const expected = [
       {
         account: 'rLDYrujdKUfVx28T9vRDAbyJ7G2WVXKo4K',
-        balances: [{ currency: 'XRP', value: '100' }],
+        balances: [{ currency: 'XAH', value: '100' }],
       },
       {
         account: 'rKmBGxocj9Abgy25J51Mk1iqFzW9aVF9Tc',
-        balances: [{ currency: 'XRP', value: '-100.012' }],
+        balances: [{ currency: 'XAH', value: '-100.012' }],
       },
     ]
     assert.deepStrictEqual(result, expected)
@@ -43,7 +43,7 @@ describe('getBalanceChanges', function () {
           },
           {
             value: '-0.012',
-            currency: 'XRP',
+            currency: 'XAH',
           },
         ],
       },
@@ -114,7 +114,7 @@ describe('getBalanceChanges', function () {
           },
           {
             value: '-0.012',
-            currency: 'XRP',
+            currency: 'XAH',
           },
         ],
       },
@@ -136,7 +136,7 @@ describe('getBalanceChanges', function () {
           },
           {
             value: '-0.012',
-            currency: 'XRP',
+            currency: 'XAH',
           },
         ],
       },
@@ -177,7 +177,7 @@ describe('getBalanceChanges', function () {
         balances: [
           {
             value: '-0.012',
-            currency: 'XRP',
+            currency: 'XAH',
           },
         ],
       },
@@ -197,7 +197,7 @@ describe('getBalanceChanges', function () {
             value: '10',
           },
           {
-            currency: 'XRP',
+            currency: 'XAH',
             value: '-0.012',
           },
         ],
@@ -224,7 +224,7 @@ describe('getBalanceChanges', function () {
         balances: [
           {
             value: '-0.012',
-            currency: 'XRP',
+            currency: 'XAH',
           },
         ],
       },
@@ -239,7 +239,7 @@ describe('getBalanceChanges', function () {
         account: 'rsApBGKJmMfExxZBrGnzxEXyq7TMhMRg4e',
         balances: [
           {
-            currency: 'XRP',
+            currency: 'XAH',
             value: '-0.00001',
           },
         ],
@@ -286,7 +286,7 @@ describe('getBalanceChanges', function () {
           },
           {
             value: '-0.012',
-            currency: 'XRP',
+            currency: 'XAH',
           },
         ],
       },
@@ -316,7 +316,7 @@ describe('getBalanceChanges', function () {
             value: '-100',
           },
           {
-            currency: 'XRP',
+            currency: 'XAH',
             value: '-0.00001',
           },
         ],
@@ -347,7 +347,7 @@ describe('getBalanceChanges', function () {
             value: '-200',
           },
           {
-            currency: 'XRP',
+            currency: 'XAH',
             value: '-0.00001',
           },
         ],
@@ -383,7 +383,7 @@ describe('getBalanceChanges', function () {
             value: '-100',
           },
           {
-            currency: 'XRP',
+            currency: 'XAH',
             value: '-0.00001',
           },
           {

packages/xrpl/test/wallet/index.test.ts

@@ -757,13 +757,13 @@ describe('Wallet', function () {
     it('sign throws when a payment contains an issued currency like XRP', async function () {
       const payment: Payment = { ...issuedCurrencyPayment }
       payment.Amount = {
-        currency: 'xrp',
+        currency: 'xah',
         issuer: 'rnURbz5HLbvqEq69b1B4TX6cUTNMmcrBqi',
         value: '123.40',
       }
       assert.throws(() => {
         wallet.sign(payment)
-      }, /^Trying to sign an issued currency with a similar standard code to XRP \(received 'xrp'\)\. XRP is not an issued currency\./u)
+      }, /^Trying to sign an issued currency with a similar standard code to XAH \(received 'xah'\)\. XAH is not an issued currency\./u)
     })
 
     it('sign does NOT throw when a payment contains an issued currency like xrp in hex string format', async function () {