Publish

- @transia/xrpl@2.7.3-alpha.5

package-lock.json

@@ -17188,7 +17188,7 @@
     },
     "packages/xrpl": {
       "name": "@transia/xrpl",
-      "version": "2.7.3-alpha.2",
+      "version": "2.7.3-alpha.3",
       "license": "ISC",
       "dependencies": {
         "@transia/ripple-address-codec": "^4.2.8-alpha.0",

packages/xrpl/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@transia/xrpl",
-  "version": "2.7.3-alpha.2",
+  "version": "2.7.3-alpha.5",
   "license": "ISC",
   "description": "A TypeScript/JavaScript API for interacting with the XRP Ledger in Node.js and the browser",
   "files": [

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

@@ -195,3 +195,13 @@ export interface NFTOffer {
   destination?: string
   expiration?: number
 }
+
+/**
+ * This information is added to emitted Transactions.
+ */
+export interface EmitDetails {
+  EmitBurden: number
+  EmitGeneration: number
+  EmitHookHash: string
+  EmitParentTxnID: string
+}

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

@@ -0,0 +1,53 @@
+import { Amount } from '../common'
+
+import BaseLedgerEntry from './BaseLedgerEntry'
+
+/**
+ * The HookState object type contains the
+ *
+ * @category Ledger Entries
+ */
+export default interface HookState 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
+}

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

@@ -21,6 +21,7 @@ import PayChannel from './PayChannel'
 import RippleState, { RippleStateFlags } from './RippleState'
 import SignerList, { SignerListFlags } from './SignerList'
 import Ticket from './Ticket'
+import URIToken from './URIToken'
 
 export {
   AccountRoot,
@@ -48,4 +49,5 @@ export {
   SignerList,
   SignerListFlags,
   Ticket,
+  URIToken,
 }

packages/xrpl/src/models/methods/accountObjects.ts

@@ -8,6 +8,7 @@ import {
   RippleState,
   SignerList,
   Ticket,
+  URIToken,
 } from '../ledger'
 
 import { BaseRequest, BaseResponse } from './baseMethod'
@@ -22,6 +23,7 @@ type AccountObjectType =
   | 'signer_list'
   | 'state'
   | 'ticket'
+  | 'uritoken'
 
 /**
  * The account_objects command returns the raw ledger format for all objects
@@ -78,6 +80,7 @@ type AccountObject =
   | SignerList
   | RippleState
   | Ticket
+  | URIToken
 
 /**
  * Response expected from an {@link AccountObjectsRequest}.

packages/xrpl/src/models/methods/ledgerEntry.ts

@@ -79,6 +79,11 @@ export interface LedgerEntryRequest extends BaseRequest {
       }
     | 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
    * escrow, as hexadecimal. If an object, requires owner and seq sub-fields.
@@ -92,6 +97,36 @@ export interface LedgerEntryRequest extends BaseRequest {
       }
     | 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 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`
@@ -137,40 +172,20 @@ export interface LedgerEntryRequest extends BaseRequest {
         ticket_sequence: number
       }
     | string
-  /**
-   * The object ID of a transaction emitted by the ledger entry.
-   */
-  emitted_txn?: string
 
   /**
-   * The hash of the Hook object to retrieve.
+   * The URIToken object to retrieve. If a string, must be the object ID of the
+   * URIToken, as hexadecimal. If an object, the `issuer` and `uri`
+   * sub-fields are required to uniquely specify the URIToken entry.
    */
-  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?:
+  uri_token?:
     | {
-        /** The account of the Hook object. */
-        account: string
+        /** The issuer of the URIToken object. */
+        issuer: string
+        /** The URIToken uri string (ascii). */
+        uri: 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
-  }
 }
 
 /**

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

@@ -10,6 +10,7 @@ import {
   IssuedCurrencyAmount,
   Memo,
   Signer,
+  EmitDetails,
 } from '../common'
 import { onlyHasFields } from '../utils'
 
@@ -173,6 +174,10 @@ export interface BaseTransaction {
    * The hook parameters of the transaction.
    */
   HookParameters?: HookParameter[]
+  /**
+   * The hook parameters of the transaction.
+   */
+  EmitDetails?: EmitDetails
 }
 
 /**

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

@@ -41,7 +41,7 @@ export interface SetHook extends BaseTransaction {
   Flags?: number | SetHookFlagsInterface
 }
 
-const MAX_HOOKS = 4
+const MAX_HOOKS = 10
 const HEX_REGEX = /^[0-9A-Fa-f]{64}$/u
 
 /**

packages/xrpl/src/utils/hashes/hashLedger.ts

@@ -83,7 +83,7 @@ export function hashSignedTx(tx: Transaction | string): string {
     txObject = tx
   }
 
-  if (txObject.TxnSignature === undefined && txObject.Signers === undefined) {
+  if (!txObject.EmitDetails && txObject.TxnSignature === undefined && txObject.Signers === undefined) {
     throw new ValidationError('The transaction must be signed to hash it.')
   }
 

packages/xrpl/src/utils/hashes/index.ts

@@ -6,6 +6,8 @@
 import { decodeAccountID } from '@transia/ripple-address-codec'
 import BigNumber from 'bignumber.js'
 
+import { convertStringToHex } from '../stringConversion'
+
 import hashLedger, {
   hashLedgerHeader,
   hashSignedTx,
@@ -184,4 +186,18 @@ 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 }

packages/xrpl/src/utils/hashes/ledgerSpaces.ts

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

packages/xrpl/src/utils/index.ts

@@ -39,6 +39,7 @@ import {
   hashLedgerHeader,
   hashEscrow,
   hashPaymentChannel,
+  hashURIToken,
 } from './hashes'
 import { calculateHookOn, hexHookParameters, TTS } from './hooks'
 import parseNFTokenID from './parseNFTokenID'
@@ -173,6 +174,7 @@ const hashes = {
   hashLedgerHeader,
   hashEscrow,
   hashPaymentChannel,
+  hashURIToken,
 }
 
 export {

packages/xrpl/test/models/setHook.test.ts

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

packages/xrpl/test/utils/hashes.test.ts

@@ -15,6 +15,7 @@ import {
   hashAccountRoot,
   hashOfferId,
   hashSignerListId,
+  hashURIToken,
 } from '../../src/utils/hashes'
 import fixtures from '../fixtures/rippled'
 import { assertResultMatch } from '../testUtils'
@@ -143,6 +144,16 @@ describe('Hashes', function () {
     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 () {
     const expected_hash =
       '458101D51051230B1D56E9ACAFAA34451BF65FA000F95DF6F0FF5B3A62D83FC2'