feat(projection): extend withHandles mappers to extract subhandle data

VanessaPC · VanessaPC · commit a13b73b2b89f · 2023-12-13T09:02:47.000Z
diff --git a/packages/projection/src/operators/Mappers/withHandles.ts b/packages/projection/src/operators/Mappers/withHandles.ts
@@ -1,6 +1,7 @@
 import { Asset, Cardano, Handle } from '@cardano-sdk/core';
 import { CIP67Asset, CIP67Assets, WithCIP67 } from './withCIP67';
 import { FilterByPolicyIds } from './types';
+import { HexBlob } from '@cardano-sdk/util';
 import { Logger } from 'ts-log';
 import { ProjectionOperator } from '../../types';
 import { assetNameToUTF8Handle } from './util';
@@ -19,6 +20,7 @@ export interface HandleOwnership {
   assetId: Cardano.AssetId;
   policyId: Cardano.PolicyId;
   datum?: Cardano.PlutusData;
+  parentHandle?: Handle;
 }
 
 export interface WithHandles {
@@ -27,7 +29,10 @@ export interface WithHandles {
 
 const assetIdToUTF8Handle = (assetId: Cardano.AssetId, cip67Asset: CIP67Asset | undefined) => {
   if (cip67Asset) {
-    if (cip67Asset.decoded.label === Asset.AssetNameLabelNum.UserNFT) {
+    if (
+      cip67Asset.decoded.label === Asset.AssetNameLabelNum.UserNFT ||
+      cip67Asset.decoded.label === Asset.AssetNameLabelNum.VirtualHandle
+    ) {
       return Cardano.AssetName.toUTF8(cip67Asset.decoded.content);
     }
     // Ignore all but UserNFT cip67 assets
@@ -36,6 +41,36 @@ const assetIdToUTF8Handle = (assetId: Cardano.AssetId, cip67Asset: CIP67Asset |
   return assetNameToUTF8Handle(Cardano.AssetId.getAssetName(assetId));
 };
 
+const getHandleMetadata = (handleDataFields: Cardano.PlutusList, logger: Logger) => {
+  const data = handleDataFields.items[2];
+
+  if (Cardano.util.isPlutusMap(data)) {
+    return Cardano.util.tryConvertPlutusMapToUtf8Record(data, logger);
+  }
+};
+
+const getVirtualSubhandleOwnerAddress = (datum: HandleOwnership['datum'], logger: Logger) => {
+  if (datum && Cardano.util.isConstrPlutusData(datum)) {
+    const resolvedAddressEntry = getHandleMetadata(datum.fields, logger);
+
+    if (
+      resolvedAddressEntry?.resolved_addresses &&
+      Cardano.util.isPlutusMap(resolvedAddressEntry?.resolved_addresses)
+    ) {
+      const decodedResolvedAddresses = Cardano.util.tryConvertPlutusMapToUtf8Record(
+        resolvedAddressEntry.resolved_addresses,
+        logger
+      );
+
+      if (Cardano.util.isPlutusBoundedBytes(decodedResolvedAddresses.ada)) {
+        return Cardano.PaymentAddress(
+          Cardano.Address.fromBytes(HexBlob.fromBytes(decodedResolvedAddresses.ada)).toBech32()
+        );
+      }
+    }
+  }
+};
+
 const tryCreateHandleOwnership = (
   assetId: Cardano.AssetId,
   policyIds: Cardano.PolicyId[],
@@ -47,14 +82,26 @@ const tryCreateHandleOwnership = (
   if (!policyIds.includes(policyId)) return;
   try {
     const cip67Asset = cip67Assets.byAssetId[assetId];
+
     const handle = assetIdToUTF8Handle(assetId, cip67Asset);
+    const subhandleProps: Partial<HandleOwnership> = {};
     if (handle) {
+      if (handle.includes('@')) {
+        subhandleProps.parentHandle = handle.split('@')[1];
+
+        if (cip67Asset?.decoded.label === Asset.AssetNameLabelNum.VirtualHandle) {
+          const virtualSubhandleOwnerAddress = getVirtualSubhandleOwnerAddress(txOut?.datum, logger);
+          subhandleProps.latestOwnerAddress = virtualSubhandleOwnerAddress || null;
+        }
+      }
+
       return {
         assetId,
         datum: txOut?.datum,
         handle,
         latestOwnerAddress: txOut?.address || null,
-        policyId
+        policyId,
+        ...subhandleProps
       };
     }
   } catch (error: unknown) {
@@ -117,6 +164,7 @@ export const withHandles =
           }),
           {} as Record<string, HandleOwnership>
         );
+
         return {
           ...evt,
           handles: [...Object.values(handleMap)]
diff --git a/packages/projection/test/operators/Mappers/handleUtil.ts b/packages/projection/test/operators/Mappers/handleUtil.ts
@@ -17,6 +17,8 @@ export const maryAddress = Cardano.PaymentAddress(
 export const bobHandleOne = 'bob.handle.one';
 export const bobHandleTwo = 'bob.handle.two';
 export const maryHandleOne = 'mary.handle.one';
+export const virtualHandle = 'virtual@handl';
+export const NFTHandle = 'sub@handl';
 export const handleOutputs = {
   maryHandleToBob: {
     address: bobAddress,
@@ -75,6 +77,14 @@ export const referenceTokenAssetName = Asset.AssetNameLabel.encode(
   handleAssetName(maryHandleOne),
   Asset.AssetNameLabelNum.ReferenceNFT
 );
+export const virtualHandleAssetName = Asset.AssetNameLabel.encode(
+  handleAssetName(virtualHandle),
+  Asset.AssetNameLabelNum.VirtualHandle
+);
+export const subhandleAssetName = Asset.AssetNameLabel.encode(
+  handleAssetName(NFTHandle),
+  Asset.AssetNameLabelNum.UserNFT
+);
 export const scriptAddress = bobAddress;
 export const handleDatum = Serialization.PlutusData.fromCbor(
   HexBlob(
@@ -83,6 +93,18 @@ export const handleDatum = Serialization.PlutusData.fromCbor(
   )
 ).toCore();
 
+export const virtualSubhandleDatum = Serialization.PlutusData.fromCbor(
+  HexBlob(
+    'd8799faf446e616d654d247669727475616c40686e646c45696d6167655838697066733a2f2f7a623272686b52636a5471546e5a387462704635485a474e4c4e355473324554633558477039576264614b415134335472496d65646961547970654a696d6167652f6a706567426f6700496f675f6e756d6265720046726172697479456261736963466c656e6774680c4a63686172616374657273476c657474657273516e756d657269635f6d6f64696669657273404a7375625f7261726974794562617369634a7375625f6c656e677468074e7375625f63686172616374657273476c657474657273557375625f6e756d657269635f6d6f64696669657273404b68616e646c655f74797065517669727475616c5f73756268616e646c654776657273696f6e0101a94e7374616e646172645f696d6167655838697066733a2f2f7a623272686b52636a5471546e5a387462704635485a474e4c4e355473324554633558477039576264614b41513433547246706f7274616c404864657369676e65724047736f6369616c73404676656e646f72404764656661756c7400536c6173745f7570646174655f616464726573735839007ad324c4fb08709dd997f6b2ba7980d5007103a2aa3f7a7eb8b44bc6f1a8e379127b811583070faf74db00d880d45027fe6171b1b69bd9ca4c76616c6964617465645f6279581c4da965a049dfd15ed1ee19fba6e2974a0b79fc416dd1796a1f97f5e1527265736f6c7665645f616464726573736573a1436164615839007ad324c4fb08709dd997f6b2ba7980d5007103a2aa3f7a7eb8b44bc6f1a8e379127b811583070faf74db00d880d45027fe6171b1b69bd9caff'
+  )
+).toCore();
+
+export const NFTSubhandleDatum = Serialization.PlutusData.fromCbor(
+  HexBlob(
+    'd8799faa446e616d65492473756240686e646c45696d6167655838697066733a2f2f7a6232726862426e7a6e4e48716748624a58786d71596a47714663377947314a444e6741664d3534726472455032776366496d65646961547970654a696d6167652f6a706567426f6700496f675f6e756d6265720046726172697479456261736963466c656e677468084a63686172616374657273476c657474657273516e756d657269635f6d6f64696669657273404776657273696f6e0101af4e7374616e646172645f696d6167655838697066733a2f2f7a6232726862426e7a6e4e48716748624a58786d71596a47714663377947314a444e6741664d353472647245503277636646706f7274616c404864657369676e65724047736f6369616c73404676656e646f72404764656661756c7400536c6173745f7570646174655f61646472657373583900f541f0822d4794e6d1ddc3c0d5e932585bfcce2d869b1c2ee05b1dc7c37bace64b57b50a044bbafa593811a6f49c9d8d8c0b187932e2df404c76616c6964617465645f6279581c4da965a049dfd15ed1ee19fba6e2974a0b79fc416dd1796a1f97f5e14a696d6167655f68617368584034333831373362613630333931353466646232643137383763363765633636333863393462643331633835336630643964356166343365626462313864623934537374616e646172645f696d6167655f686173685840343338313733626136303339313534666462326431373837633637656336363338633934626433316338353366306439643561663433656264623138646239344b7376675f76657273696f6e45322e302e314c6167726565645f7465726d7340546d6967726174655f7369675f72657175697265640045747269616c00446e73667700ff'
+  )
+).toCore();
+
 export const userNftOutput: Cardano.TxOut = {
   address: maryAddress,
   value: {
@@ -99,3 +121,25 @@ export const referenceNftOutput: Cardano.TxOut = {
     coins: 123n
   }
 };
+
+export const virtualSubHandleOutput: Cardano.TxOut = {
+  address: Cardano.PaymentAddress(
+    'addr_test1qqthrsf7x40ppfpq8ky53t6c694uu2eg6hu2q2p4kzepsyd8hqtvlesvrpvln3srklcvhu2r9z22fdhaxvh2m2pg3nuq3w2zfn'
+  ),
+  datum: virtualSubhandleDatum,
+  value: {
+    assets: new Map([[Cardano.AssetId.fromParts(handlePolicyId, virtualHandleAssetName), 1n]]),
+    coins: 123n
+  }
+};
+
+export const NFTSubHandleOutput: Cardano.TxOut = {
+  address: Cardano.PaymentAddress(
+    'addr_test1qqthrsf7x40ppfpq8ky53t6c694uu2eg6hu2q2p4kzepsyd8hqtvlesvrpvln3srklcvhu2r9z22fdhaxvh2m2pg3nuq3w2zfn'
+  ),
+  datum: NFTSubhandleDatum,
+  value: {
+    assets: new Map([[Cardano.AssetId.fromParts(handlePolicyId, subhandleAssetName), 1n]]),
+    coins: 123n
+  }
+};
diff --git a/packages/projection/test/operators/Mappers/withHandles.test.ts b/packages/projection/test/operators/Mappers/withHandles.test.ts
@@ -2,6 +2,7 @@ import { Asset, Cardano } from '@cardano-sdk/core';
 import { Buffer } from 'buffer';
 import { Mappers, ProjectionEvent } from '../../../src';
 import {
+  NFTSubHandleOutput,
   assetIdFromHandle,
   bobAddress,
   bobHandleOne,
@@ -11,14 +12,32 @@ import {
   maryAddress,
   maryHandleOne,
   referenceNftOutput,
-  userNftOutput
+  subhandleAssetName,
+  userNftOutput,
+  virtualHandleAssetName,
+  virtualSubHandleOutput
 } from './handleUtil';
 import { firstValueFrom, of } from 'rxjs';
 import { logger, mockProviders } from '@cardano-sdk/util-dev';
-import { withCIP67, withHandles, withUtxo } from '../../../src/operators/Mappers';
+import { withCIP67, withHandles, withMint, withUtxo } from '../../../src/operators/Mappers';
 
 type In = Mappers.WithMint & Mappers.WithCIP67 & Mappers.WithNftMetadata;
 
+const project = (tx: Cardano.OnChainTx) =>
+  firstValueFrom(
+    of({
+      block: {
+        body: [tx],
+        header: mockProviders.ledgerTip
+      }
+    } as ProjectionEvent).pipe(
+      withUtxo(),
+      withMint(),
+      withCIP67(),
+      withHandles({ policyIds: [handlePolicyId] }, logger)
+    )
+  );
+
 describe('withHandles', () => {
   it('sets "datum" property on the handle if utxo has datum', async () => {
     const datum = Buffer.from('123abc', 'hex');
@@ -246,17 +265,6 @@ describe('withHandles', () => {
   });
 
   describe('cip68', () => {
-    // eslint-disable-next-line unicorn/consistent-function-scoping
-    const project = (tx: Cardano.OnChainTx) =>
-      firstValueFrom(
-        of({
-          block: {
-            body: [tx],
-            header: mockProviders.ledgerTip
-          }
-        } as ProjectionEvent).pipe(withUtxo(), withCIP67(), withHandles({ policyIds: [handlePolicyId] }, logger))
-      );
-
     it('does not change ownership when only reference token is present', async () => {
       const { handles } = await project({
         body: { outputs: [referenceNftOutput] },
@@ -288,4 +296,61 @@ describe('withHandles', () => {
       expect(handles[0].latestOwnerAddress).toBe(maryAddress);
     });
   });
+
+  describe('subhandles', () => {
+    it('adds parentHandle data for virtual subhandles', async () => {
+      const { handles } = await project({
+        body: { outputs: [virtualSubHandleOutput] },
+        inputSource: Cardano.InputSource.inputs
+      } as Cardano.OnChainTx);
+
+      expect(handles).toHaveLength(1);
+
+      expect(handles[0].latestOwnerAddress).toBe(
+        'addr_test1qpadxfxylvy8p8wejlmt9wnesr2squgr524r77n7hz6yh3h34r3hjynmsy2cxpc04a6dkqxcsr29qfl7v9cmrd5mm89qqh563f'
+      );
+      expect(handles[0].parentHandle).toBe('handl');
+      expect(handles[0].handle).toBe('virtual@handl');
+    });
+
+    it('adds parentHandle data for NFT subhandles', async () => {
+      const { handles } = await project({
+        body: { outputs: [NFTSubHandleOutput] },
+        inputSource: Cardano.InputSource.inputs
+      } as Cardano.OnChainTx);
+
+      expect(handles).toHaveLength(1);
+
+      expect(handles[0].parentHandle).toBe('handl');
+      expect(handles[0].handle).toBe('sub@handl');
+    });
+
+    it('includes a handle with "null" address, when transaction burns a subhandle', async () => {
+      const { handles } = await project({
+        body: {
+          mint: new Map([[Cardano.AssetId.fromParts(handlePolicyId, subhandleAssetName), -1n]]),
+          outputs: [] as Cardano.TxOut[]
+        },
+        inputSource: Cardano.InputSource.inputs
+      } as Cardano.OnChainTx);
+
+      expect(handles.length).toBe(1);
+      expect(handles[0].latestOwnerAddress).toBeNull();
+      expect(handles[0].handle).toBe('sub@handl');
+    });
+
+    it('includes a handle with "null" address, when transaction burns a virtualSubhandle', async () => {
+      const { handles } = await project({
+        body: {
+          mint: new Map([[Cardano.AssetId.fromParts(handlePolicyId, virtualHandleAssetName), -1n]]),
+          outputs: [] as Cardano.TxOut[]
+        },
+        inputSource: Cardano.InputSource.inputs
+      } as Cardano.OnChainTx);
+
+      expect(handles.length).toBe(1);
+      expect(handles[0].latestOwnerAddress).toBeNull();
+      expect(handles[0].handle).toBe('virtual@handl');
+    });
+  });
 });
