refactor: centralize control for pre and post conwa era

Author: iccicci

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

@@ -241,6 +241,7 @@ export const isCertType = <K extends keyof CertificateTypeMap>(
   certificateTypes: readonly K[]
 ): certificate is CertificateTypeMap[K] => certificateTypes.includes(certificate.__typename as K);
 
+// LW-10773 add the deposit and change StakeRegistration certificate into Registration certificate
 /**
  * Creates a stake key registration certificate from a given reward account.
  *
@@ -254,6 +255,7 @@ export const createStakeRegistrationCert = (rewardAccount: RewardAccount): Certi
   }
 });
 
+// LW-10773 change deposit from optional to required and remove StakeDeregistration certificate
 /**
  * Creates a stake key de-registration certificate from a given reward account.
  *

packages/core/src/Serialization/Common/CborSet.ts

@@ -1,5 +1,6 @@
 import { CborReader, CborReaderState, CborTag, CborWriter } from '../CBOR';
 import { HexBlob } from '@cardano-sdk/util';
+import { inConwayEra } from '../../util';
 
 /** Represents a cbor serialization wrapper for a Core type <{@link C}> */
 interface CborSerializable<C> {
@@ -16,8 +17,6 @@ interface CborSerializable<C> {
 export class CborSet<C, T extends CborSerializable<C>> {
   #values: T[];
 
-  static useConwaySerialization = false;
-
   // Prevent users from directly creating an instance. Only allow creating via fromCore or fromCbor.
   private constructor(values: T[]) {
     this.#values = [...values];
@@ -50,13 +49,13 @@ export class CborSet<C, T extends CborSerializable<C>> {
   /**
    * Serializes a CborSet<T> into CBOR format.
    *
-   * @returns The CborSet in CBOR format, using the `258` tag representation if {@link useConwaySerialization} flag is set,
+   * @returns The CborSet in CBOR format, using the `258` tag representation if {@link inConwayEra} flag is set,
    * or as an the array.
    */
   toCbor(): HexBlob {
     const writer = new CborWriter();
 
-    if (CborSet.useConwaySerialization) writer.writeTag(CborTag.Set);
+    if (inConwayEra) writer.writeTag(CborTag.Set);
 
     writer.writeStartArray(this.size());
 

packages/core/src/Serialization/TransactionWitnessSet/Redeemer/Redeemers.ts

@@ -1,4 +1,4 @@
-import { Cardano } from '../../..';
+import { Cardano, inConwayEra } from '../../..';
 import { CborReader, CborReaderState, CborWriter } from '../../CBOR';
 import { ExUnits } from '../../Common';
 import { HexBlob, InvalidArgumentError } from '@cardano-sdk/util';
@@ -13,27 +13,22 @@ const MAP_VALUE_EMBEDDED_GROUP_SIZE = 2;
 export class Redeemers {
   #values: Redeemer[];
 
-  // TODO: set to true or remove once mainnet is hardforked to mainnet
-  /**
-   * Enable encoding `redeemers` as `Map`:
-   * https://github.com/IntersectMBO/cardano-ledger/blob/master/eras/conway/impl/cddl-files/conway.cddl#L480
-   */
-  static useConwaySerialization = false;
-
   private constructor(redeemers: Redeemer[]) {
     this.#values = [...redeemers];
   }
 
   /**
    * Serializes Redeemers into CBOR format.
-   * Redeemers are encoded as array when {@link useConwaySerialization} is false, and as map when
-   * {@link useConwaySerialization} is true.
+   * Redeemers are encoded as array when {@link inConwayEra} is false, and as map when
+   * {@link inConwayEra} is true.
    *
    * @returns The Redeemers in CBOR format.
    */
   toCbor(): HexBlob {
     const writer = new CborWriter();
-    if (Redeemers.useConwaySerialization) {
+    // Encoding `redeemers` as `Map`:
+    // https://github.com/IntersectMBO/cardano-ledger/blob/master/eras/conway/impl/cddl-files/conway.cddl#L480
+    if (inConwayEra) {
       // { + [ tag: redeemer_tag, index: uint ] => [ data: plutus_data, ex_units: ex_units ] }
       const redeemersMap = new Map(this.#values.map((redeemer) => [`${redeemer.tag()}:${redeemer.index()}`, redeemer]));
 

packages/core/src/util/conwayEra.ts

@@ -0,0 +1,7 @@
+// LW-10773 remove this file
+
+/** Specifies if SDK should behave as in Conway era. */
+// eslint-disable-next-line import/no-mutable-exports
+export let inConwayEra = false as const;
+
+export const setInConwayEra = (value: boolean) => (inConwayEra = value as false);

packages/core/src/util/index.ts

@@ -1,4 +1,5 @@
 export * as util from './misc';
+export * from './conwayEra';
 export * from './slotCalc';
 export * from './txInspector';
 export * from './tokenTransferInspector';

packages/core/test/Serialization/Common/CborSet.test.ts

@@ -1,5 +1,6 @@
 import { CborReader, CborSet, CborTag, CborWriter } from '../../../src/Serialization';
 import { HexBlob } from '@cardano-sdk/util';
+import { setInConwayEra } from '../../../src';
 
 class TestNumber {
   #value: number;
@@ -54,14 +55,14 @@ describe('CborSet', () => {
     testCborConway = writer.encodeAsHex();
   });
 
-  afterEach(() => (CborSet.useConwaySerialization = false));
+  afterEach(() => setInConwayEra(false));
 
   it('can serialize as array', () => {
     expect(testCbor).toEqual(set.toCbor());
   });
 
   it('can serialize as 258 tag set', () => {
-    CborSet.useConwaySerialization = true;
+    setInConwayEra(true);
     expect(testCborConway).toEqual(set.toCbor());
   });
 
@@ -84,7 +85,7 @@ describe('CborSet', () => {
     const emptyArrayCbor = writer.encodeAsHex();
 
     const emptySet = CborSet.fromCore<number, TestNumber>([], TestNumber.fromCore);
-    CborSet.useConwaySerialization = useConwaySerialization;
+    setInConwayEra(useConwaySerialization);
     expect(emptySet.toCbor()).toEqual(emptyArrayCbor);
   });
 

packages/core/test/Serialization/TransactionWitnessSet/Redeemers.test.ts

@@ -1,4 +1,4 @@
-import { Cardano } from '../../../src';
+import { Cardano, setInConwayEra } from '../../../src';
 import { HexBlob } from '@cardano-sdk/util';
 import { RedeemerPurpose } from '../../../src/Cardano';
 import { Redeemers } from '../../../src/Serialization';
@@ -33,7 +33,7 @@ const cborInvalidMapIndex = HexBlob('a28308000082d8799f0102030405ff821821182c820
 const cborInvalidMapValue = HexBlob('a28200008300d8799f0102030405ff821821182c82040082d8799f0102030405ff8218371842');
 
 describe('Redeemers', () => {
-  afterEach(() => (Redeemers.useConwaySerialization = false));
+  afterEach(() => setInConwayEra(false));
 
   it('can decode Redeemers from CBOR', () => {
     const redeemers = Redeemers.fromCbor(cbor);
@@ -47,13 +47,12 @@ describe('Redeemers', () => {
 
   it('can decode Redeemers from map encoded CBOR', () => {
     const redeemers = Redeemers.fromCbor(cborConway);
-    // Redeemers.useConwaySerialization = true;
     expect(redeemers.toCore()).toEqual(core);
   });
 
   it('can encode Redeemers as map in CBOR', () => {
     const redeemers = Redeemers.fromCore(core);
-    Redeemers.useConwaySerialization = true;
+    setInConwayEra(true);
     expect(redeemers.toCbor()).toEqual(cborConway);
   });
 

packages/e2e/test/wallet_epoch_0/PersonalWallet/conwayTransactions.test.ts

@@ -1,6 +1,6 @@
 import * as Crypto from '@cardano-sdk/crypto';
 import { BaseWallet } from '@cardano-sdk/wallet';
-import { Cardano, Serialization } from '@cardano-sdk/core';
+import { Cardano, setInConwayEra } from '@cardano-sdk/core';
 import { logger } from '@cardano-sdk/util-dev';
 
 import { firstValueFrom, map } from 'rxjs';
@@ -161,9 +161,7 @@ describe.skip('PersonalWallet/conwayTransactions', () => {
   };
 
   beforeAll(async () => {
-    // TODO: remove once mainnet hardforks to conway-era, and this becomes "the norm"
-    Serialization.CborSet.useConwaySerialization = true;
-    Serialization.Redeemers.useConwaySerialization = true;
+    setInConwayEra(true);
 
     // TODO LW-10555: Revert this so that wallet is at account 0 and drepWallet at account 1, once the dbsync bug is fixed
     // https://github.com/IntersectMBO/cardano-db-sync/issues/1702
@@ -191,9 +189,7 @@ describe.skip('PersonalWallet/conwayTransactions', () => {
     wallet.shutdown();
     dRepWallet.shutdown();
 
-    // TODO: remove once mainnet hardforks to conway-era, and this becomes "the norm"
-    Serialization.CborSet.useConwaySerialization = false;
-    Serialization.Redeemers.useConwaySerialization = false;
+    setInConwayEra(false);
   });
 
   it('can register a stake key and delegate stake using a combo certificate', async () => {

packages/tx-construction/src/tx-builder/TxBuilder.ts

@@ -8,7 +8,7 @@ import {
   WitnessedTx,
   util
 } from '@cardano-sdk/key-management';
-import { Cardano, HandleProvider, HandleResolution, Serialization, metadatum } from '@cardano-sdk/core';
+import { Cardano, HandleProvider, HandleResolution, Serialization, inConwayEra, metadatum } from '@cardano-sdk/core';
 import {
   CustomizeCb,
   InsufficientRewardAccounts,
@@ -570,6 +570,7 @@ export class GenericTxBuilder implements TxBuilder {
     return rewardAccountsWithWeights;
   }
 
+  // eslint-disable-next-line sonarjs/cognitive-complexity
   async #delegatePortfolio(): Promise<RewardAccountsAndWeights> {
     const rewardAccountsWithWeights: RewardAccountsAndWeights = new Map();
     if (!this.#requestedPortfolio) {
@@ -641,8 +642,9 @@ export class GenericTxBuilder implements TxBuilder {
     this.#logger.debug(`De-registering ${availableRewardAccounts.length} stake keys`);
     for (const rewardAccount of availableRewardAccounts) {
       if (rewardAccount.credentialStatus === Cardano.StakeCredentialStatus.Registered) {
-        // TODO: re-enable conway stake deregistration cert, after the conway hardfork
-        certificates.push(Cardano.createStakeDeregistrationCert(rewardAccount.address /* , rewardAccount.deposit*/));
+        certificates.push(
+          Cardano.createStakeDeregistrationCert(rewardAccount.address, inConwayEra ? rewardAccount.deposit : undefined)
+        );
       }
     }
     this.partialTxBody = { ...this.partialTxBody, certificates };