Merge pull request #1176 from input-output-hk/fix/chain-history-redeemer-purpose-mapper

fix(cardano-services): correct mapping of chain history redeemer purpose

Author: mkazlauskas

.github/workflows/std.yml

@@ -217,7 +217,7 @@ jobs:
 
             for target in \
               "dev-preview@us-east-1" \
-              "dev-preprod@us-east-1@v1" \
+              "dev-preprod@us-east-1@v2" \
               "dev-mainnet@us-east-1" \
             ; do
               nix run -L ".#cardano-services.${target}.plan" | tee k8s-plan.diff

packages/cardano-services/src/ChainHistory/DbSyncChainHistory/mappers.ts

@@ -20,7 +20,7 @@ import {
   WithCertType,
   WithdrawalModel
 } from './types';
-import { Cardano } from '@cardano-sdk/core';
+import { Cardano, NotImplementedError } from '@cardano-sdk/core';
 import { Hash32ByteBase16 } from '@cardano-sdk/crypto';
 import {
   isDelegationCertModel,
@@ -105,14 +105,29 @@ export const mapWithdrawal = (withdrawalModel: WithdrawalModel): Cardano.Withdra
 // Remove this and select the actual redeemer data from `redeemer_data` table.
 const stubRedeemerData = Buffer.from('not implemented');
 
+const redeemerPurposeMap: Record<RedeemerModel['purpose'], Cardano.RedeemerPurpose> = {
+  cert: Cardano.RedeemerPurpose.certificate,
+  mint: Cardano.RedeemerPurpose.mint,
+  proposing: Cardano.RedeemerPurpose.propose,
+  reward: Cardano.RedeemerPurpose.withdrawal,
+  spend: Cardano.RedeemerPurpose.spend,
+  voting: Cardano.RedeemerPurpose.vote
+};
+
+const mapRedeemerPurpose = (purpose: RedeemerModel['purpose']): Cardano.RedeemerPurpose =>
+  redeemerPurposeMap[purpose] ||
+  (() => {
+    throw new NotImplementedError(`Failed to map redeemer "purpose": ${purpose}`);
+  })();
+
 export const mapRedeemer = (redeemerModel: RedeemerModel): Cardano.Redeemer => ({
   data: stubRedeemerData,
   executionUnits: {
     memory: Number(redeemerModel.unit_mem),
     steps: Number(redeemerModel.unit_steps)
   },
   index: redeemerModel.index,
-  purpose: redeemerModel.purpose as Cardano.RedeemerPurpose
+  purpose: mapRedeemerPurpose(redeemerModel.purpose)
 });
 
 export const mapCertificate = (

packages/cardano-services/src/ChainHistory/DbSyncChainHistory/types.ts

@@ -95,7 +95,7 @@ export interface WithdrawalModel {
 
 export interface RedeemerModel {
   index: number;
-  purpose: string;
+  purpose: 'cert' | 'mint' | 'spend' | 'reward' | 'voting' | 'proposing';
   script_hash: Buffer;
   unit_mem: string;
   unit_steps: string;

packages/cardano-services/src/ChainHistory/openApi.json

@@ -361,7 +361,9 @@
               "spend",
               "mint",
               "certificate",
-              "withdrawal"
+              "withdrawal",
+              "vote",
+              "propose"
             ]
           },
           "data": {

packages/cardano-services/test/ChainHistory/DbSyncChainHistoryProvider/mappers.test.ts

@@ -294,24 +294,30 @@ describe('chain history mappers', () => {
     });
   });
   describe('mapRedeemer', () => {
-    const redeemerModel: RedeemerModel = {
+    const redeemerModel: Omit<RedeemerModel, 'purpose'> = {
       index: 1,
-      purpose: 'mint',
       script_hash: Buffer.from(hash28ByteBase16, 'hex'),
       tx_id: Buffer.from(transactionHash, 'hex'),
       unit_mem: '2000',
       unit_steps: '5000'
     };
-    test('map RedeemerModel to Cardano.Redeemer', () => {
-      const result = mappers.mapRedeemer(redeemerModel);
+    test.each([
+      ['spend' as const, Cardano.RedeemerPurpose.spend],
+      ['mint' as const, Cardano.RedeemerPurpose.mint],
+      ['cert' as const, Cardano.RedeemerPurpose.certificate],
+      ['reward' as const, Cardano.RedeemerPurpose.withdrawal],
+      ['voting' as const, Cardano.RedeemerPurpose.vote],
+      ['proposing' as const, Cardano.RedeemerPurpose.propose]
+    ])("maps '%p' redeemer", (dbSyncRedeemerPurpose, sdkRedeemerPurpose) => {
+      const result = mappers.mapRedeemer({ ...redeemerModel, purpose: dbSyncRedeemerPurpose });
       expect(result).toEqual<Cardano.Redeemer>({
         data: Buffer.from('not implemented'),
         executionUnits: {
           memory: 2000,
           steps: 5000
         },
         index: 1,
-        purpose: Cardano.RedeemerPurpose.mint
+        purpose: sdkRedeemerPurpose
       });
     });
   });

packages/core/src/Cardano/types/Transaction.ts

@@ -96,7 +96,6 @@ export enum RedeemerPurpose {
   mint = 'mint',
   certificate = 'certificate',
   withdrawal = 'withdrawal',
-  delegateRepresentative = 'representative',
   propose = 'propose',
   vote = 'vote'
 }