feat(core): added a new inspector for extracting transaction metadata

input-output-hk · Sep 21, 2022 · d7e1402 · d7e1402
1 parent a9289f3
commit d7e1402
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/packages/core/src/util/txInspector.ts b/packages/core/src/util/txInspector.ts
@@ -6,6 +6,7 @@ import {
   CertificateType,
   Ed25519KeyHash,
   Lovelace,
+  Metadatum,
   PolicyId,
   RewardAccount,
   Script,
@@ -33,6 +34,7 @@ type TxInspector<T extends Inspectors> = (tx: TxAlonzo) => {
 export type SendReceiveValueInspection = Value;
 export type DelegationInspection = StakeDelegationCertificate[];
 export type StakeKeyRegistrationInspection = StakeAddressCertificate[];
+
 export type WithdrawalInspection = Lovelace;
 export interface SentInspection {
   inputs: TxIn[];
@@ -50,6 +52,8 @@ export interface MintedAsset {
 
 export type AssetsMintedInspection = MintedAsset[];
 
+export type MetadataInspection = Metadatum;
+
 // Inspector types
 interface SentInspectorArgs {
   addresses?: Address[];
@@ -69,6 +73,7 @@ export type SignedCertificatesInspector = (
   certificateTypes?: CertificateType[]
 ) => Inspector<SignedCertificatesInspection>;
 export type AssetsMintedInspector = Inspector<AssetsMintedInspection>;
+export type MetadataInspector = Inspector<MetadataInspection>;
 
 /**
  * Inspects a transaction for values (coins + assets) in inputs
@@ -291,6 +296,13 @@ export const assetsMintedInspector: AssetsMintedInspector = mintInspector((quant
  */
 export const assetsBurnedInspector: AssetsMintedInspector = mintInspector((quantity: bigint) => quantity < 0);
 
+/**
+ * Inspects a transaction for its metadata.
+ *
+ * @param {TxAlonzo} tx transaction to inspect.
+ */
+export const metadataInspector: MetadataInspector = (tx) => tx.auxiliaryData?.body?.blob ?? new Map();
+
 /**
  * Returns a function to convert lower level transaction data to a higher level object, using the provided inspectors.
  *

diff --git a/packages/core/test/util/txInspector.test.ts b/packages/core/test/util/txInspector.test.ts
@@ -31,6 +31,7 @@ import {
   assetsMintedInspector,
   createTxInspector,
   delegationInspector,
+  metadataInspector,
   sentInspector,
   signedCertificatesInspector,
   stakeKeyDeregistrationInspector,
@@ -526,4 +527,14 @@ describe('txInspector', () => {
       expect(burned[0].script).toBeUndefined();
     });
   });
+
+  describe('metadata inspector', () => {
+    it('inspects a transaction with metadata and produces an inspection with the metadatum', () => {
+      const tx = buildMockTx();
+      const inspectTx = createTxInspector({ metadata: metadataInspector });
+      const { metadata } = inspectTx(tx);
+
+      expect(metadata).toEqual(txMetadatum);
+    });
+  });
 });