Publish

- @transia/xrpl@2.7.3-alpha.21

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.4",
+  "version": "1.4.6-alpha.6",
   "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,

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/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/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.16",
+  "version": "2.7.3-alpha.21",
   "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.4",
+    "@transia/ripple-binary-codec": "^1.4.6-alpha.6",
     "@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/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,6 +2,7 @@ import {
   xAddressToClassicAddress,
   isValidXAddress,
 } from '@transia/ripple-address-codec'
+import { encode } from '@transia/ripple-binary-codec'
 import BigNumber from 'bignumber.js'
 
 import type { Client } from '..'
@@ -11,7 +12,7 @@ import { Transaction } from '../models/transactions'
 import { setTransactionFlagsToNumber } from '../models/utils/flags'
 import { xrpToDrops } from '../utils'
 
-import { getFeeXrp } from './getFeeXrp'
+import { getFeeEstimateXrp, getFeeXrp } from './getFeeXrp'
 
 // Expire unconfirmed transactions after 20 ledger versions, approximately 1 minute, by default
 const LEDGER_OFFSET = 20
@@ -60,7 +61,13 @@ async function autofill<T extends Transaction>(
     promises.push(checkAccountDeleteBlockers(this, tx))
   }
 
-  return Promise.all(promises).then(() => tx)
+  await Promise.all(promises).then(() => tx)
+  const copyTx = { ...tx }
+  copyTx.SigningPubKey = ``
+  const tx_blob = encode(copyTx)
+  // eslint-disable-next-line require-atomic-updates -- ignore
+  tx.Fee = await getFeeEstimateXrp(this, tx_blob)
+  return tx
 }
 
 function setValidAddresses(tx: Transaction): void {

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

@@ -60,5 +60,5 @@ export async function getFeeEstimateXrp(
     command: 'fee',
     tx_blob: txBlob,
   })
-  return response.result.drops.base_fee
+  return response.result.drops.open_ledger_fee
 }

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 () {