xrpl 2.12.0-beta.0 → 2.13.0

package/src/utils/getXChainClaimID.ts

@@ -0,0 +1,64 @@
+import { decode } from 'ripple-binary-codec'
+
+import {
+  CreatedNode,
+  isCreatedNode,
+  TransactionMetadata,
+} from '../models/transactions/metadata'
+
+/**
+ * Ensures that the metadata is in a deserialized format to parse.
+ *
+ * @param meta - the metadata from a `tx` method call. Can be in json format or binary format.
+ * @returns the metadata in a deserialized format.
+ */
+function ensureDecodedMeta(
+  meta: TransactionMetadata | string,
+): TransactionMetadata {
+  if (typeof meta === 'string') {
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- Meta is either metadata or serialized metadata.
+    return decode(meta) as unknown as TransactionMetadata
+  }
+  return meta
+}
+
+/**
+ * Gets the XChainClaimID value from the metadata of an `XChainCreateClaimID` transaction.
+ *
+ * @param meta - Metadata from the response to submitting and waiting for an XChainCreateClaimID transaction
+ *               or from a `tx` method call.
+ * @returns The XChainClaimID for the minted NFT.
+ * @throws if meta is not TransactionMetadata.
+ */
+export default function getXChainClaimID(
+  meta: TransactionMetadata | string | undefined,
+): string | undefined {
+  if (typeof meta !== 'string' && meta?.AffectedNodes === undefined) {
+    throw new TypeError(`Unable to parse the parameter given to getXChainClaimID.
+      'meta' must be the metadata from an XChainCreateClaimID transaction. Received ${JSON.stringify(
+        meta,
+      )} instead.`)
+  }
+
+  const decodedMeta = ensureDecodedMeta(meta)
+
+  if (!decodedMeta.TransactionResult) {
+    throw new TypeError(
+      'Cannot get XChainClaimID from un-validated transaction',
+    )
+  }
+
+  if (decodedMeta.TransactionResult !== 'tesSUCCESS') {
+    return undefined
+  }
+
+  const createdNode = decodedMeta.AffectedNodes.find(
+    (node) =>
+      isCreatedNode(node) &&
+      node.CreatedNode.LedgerEntryType === 'XChainOwnedClaimID',
+  )
+
+  // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- necessary here
+  return (createdNode as CreatedNode).CreatedNode.NewFields
+    .XChainClaimID as string
+}

package/src/utils/hashes/hashLedger.ts

@@ -10,6 +10,7 @@ import { ValidationError, XrplError } from '../../errors'
 import type { Ledger } from '../../models/ledger'
 import { LedgerEntry } from '../../models/ledger'
 import { Transaction, TransactionMetadata } from '../../models/transactions'
+import { PseudoTransaction } from '../../models/transactions/transaction'
 
 import HashPrefix from './HashPrefix'
 import sha512Half from './sha512Half'
@@ -124,7 +125,9 @@ export function hashLedgerHeader(ledgerHeader: Ledger): string {
  * @category Utilities
  */
 export function hashTxTree(
-  transactions: Array<Transaction & { metaData?: TransactionMetadata }>,
+  transactions: Array<
+    (Transaction | PseudoTransaction) & { metaData?: TransactionMetadata }
+  >,
 ): string {
   const shamap = new SHAMap()
   for (const txJSON of transactions) {

package/src/utils/index.ts

@@ -25,6 +25,7 @@ import { Transaction } from '../models/transactions/transaction'
 import { deriveKeypair, deriveAddress, deriveXAddress } from './derive'
 import getBalanceChanges from './getBalanceChanges'
 import getNFTokenID from './getNFTokenID'
+import getXChainClaimID from './getXChainClaimID'
 import {
   hashSignedTx,
   hashTx,
@@ -220,4 +221,5 @@ export {
   encodeForSigningClaim,
   getNFTokenID,
   parseNFTokenID,
+  getXChainClaimID,
 }

package/src/utils/signPaymentChannelClaim.ts

@@ -7,19 +7,19 @@ import { xrpToDrops } from './xrpConversion'
  * Sign a payment channel claim.
  *
  * @param channel - Channel identifier specified by the paymentChannelClaim.
- * @param amount - Amount specified by the paymentChannelClaim.
+ * @param xrpAmount - XRP Amount specified by the paymentChannelClaim.
  * @param privateKey - Private Key to sign paymentChannelClaim with.
  * @returns True if the channel is valid.
  * @category Utilities
  */
 function signPaymentChannelClaim(
   channel: string,
-  amount: string,
+  xrpAmount: string,
   privateKey: string,
 ): string {
   const signingData = encodeForSigningClaim({
     channel,
-    amount: xrpToDrops(amount),
+    amount: xrpToDrops(xrpAmount),
   })
   return sign(signingData, privateKey)
 }

package/src/utils/verifyPaymentChannelClaim.ts

@@ -7,7 +7,7 @@ import { xrpToDrops } from './xrpConversion'
  * Verify the signature of a payment channel claim.
  *
  * @param channel - Channel identifier specified by the paymentChannelClaim.
- * @param amount - Amount specified by the paymentChannelClaim.
+ * @param xrpAmount - XRP Amount specified by the paymentChannelClaim.
  * @param signature - Signature produced from signing paymentChannelClaim.
  * @param publicKey - Public key that signed the paymentChannelClaim.
  * @returns True if the channel is valid.
@@ -16,13 +16,13 @@ import { xrpToDrops } from './xrpConversion'
 // eslint-disable-next-line max-params -- Needs 4 params
 function verifyPaymentChannelClaim(
   channel: string,
-  amount: string,
+  xrpAmount: string,
   signature: string,
   publicKey: string,
 ): boolean {
   const signingData = encodeForSigningClaim({
     channel,
-    amount: xrpToDrops(amount),
+    amount: xrpToDrops(xrpAmount),
   })
   return verify(signingData, signature, publicKey)
 }