feat: add proposal procedures deposit to compute implicit coins

Author: iccicci

packages/core/src/Cardano/util/computeImplicitCoin.ts

@@ -77,7 +77,8 @@ const computeShellyDeposits = (
 const computeConwayDeposits = (
   certificates: Cardano.Certificate[],
   rewardAccounts: Cardano.RewardAccount[],
-  dRepKeyHash?: Crypto.Ed25519KeyHashHex
+  dRepKeyHash?: Crypto.Ed25519KeyHashHex,
+  proposalProcedures?: Cardano.ProposalProcedure[]
 ): { deposit: Cardano.Lovelace; reclaimDeposit: Cardano.Lovelace } => {
   let deposit = 0n;
   let reclaimDeposit = 0n;
@@ -108,6 +109,8 @@ const computeConwayDeposits = (
     }
   }
 
+  if (proposalProcedures) for (const proposal of proposalProcedures) deposit += proposal.deposit;
+
   return {
     deposit,
     reclaimDeposit
@@ -119,17 +122,19 @@ const getTxDeposits = (
   { stakeKeyDeposit, poolDeposit }: Pick<Cardano.ProtocolParameters, 'stakeKeyDeposit' | 'poolDeposit'>,
   certificates: Cardano.Certificate[],
   rewardAccounts: Cardano.RewardAccount[] = [],
-  dRepKeyHash?: Crypto.Ed25519KeyHashHex
+  dRepKeyHash?: Crypto.Ed25519KeyHashHex,
+  proposalProcedures?: Cardano.ProposalProcedure[]
 ): { deposit: Cardano.Lovelace; reclaimDeposit: Cardano.Lovelace } => {
-  if (certificates.length === 0) return { deposit: 0n, reclaimDeposit: 0n };
+  if (certificates.length === 0 && (!proposalProcedures || proposalProcedures.length === 0))
+    return { deposit: 0n, reclaimDeposit: 0n };
 
   const depositParams = {
     poolDeposit: poolDeposit ? BigInt(poolDeposit) : 0n,
     stakeKeyDeposit: BigInt(stakeKeyDeposit)
   };
 
   const shelleyDeposits = computeShellyDeposits(depositParams, certificates, rewardAccounts);
-  const conwayDeposits = computeConwayDeposits(certificates, rewardAccounts, dRepKeyHash);
+  const conwayDeposits = computeConwayDeposits(certificates, rewardAccounts, dRepKeyHash, proposalProcedures);
 
   return {
     deposit: shelleyDeposits.deposit + conwayDeposits.deposit,
@@ -150,19 +155,24 @@ const getTxDeposits = (
  * On the other hand, the transaction summary/display could receive a transaction from a dApp,
  * and can have mixed certificates (foreign and ours), so we need the list of reward accounts and drepKeyHash
  * to be able to distinguish the deposits that are going to our rewardAccounts from the ones that could
- * potentially go to a different reward accounts that we dont control (same with reclaims).
+ * potentially go to a different reward accounts that we don't control (same with reclaims).
  */
 export const computeImplicitCoin = (
   { stakeKeyDeposit, poolDeposit }: Pick<Cardano.ProtocolParameters, 'stakeKeyDeposit' | 'poolDeposit'>,
-  { certificates, withdrawals }: Pick<HydratedTxBody, 'certificates' | 'withdrawals'>,
+  {
+    certificates,
+    proposalProcedures,
+    withdrawals
+  }: Pick<HydratedTxBody, 'certificates' | 'proposalProcedures' | 'withdrawals'>,
   rewardAccounts?: Cardano.RewardAccount[],
   dRepKeyHash?: Crypto.Ed25519KeyHashHex
 ): ImplicitCoin => {
   const { deposit, reclaimDeposit } = getTxDeposits(
     { poolDeposit, stakeKeyDeposit },
     certificates ?? [],
     rewardAccounts,
-    dRepKeyHash
+    dRepKeyHash,
+    proposalProcedures
   );
 
   const withdrawalsTotal = (withdrawals && BigIntMath.sum(withdrawals.map(({ quantity }) => quantity))) || 0n;

packages/core/test/Cardano/util/computeImplicitCoin.test.ts

@@ -198,4 +198,35 @@ describe('Cardano.util.computeImplicitCoin', () => {
     expect(coin.input).toBe(withdrawals[0].quantity + expectedReclaim);
     expect(coin.withdrawals).toBe(withdrawals[0].quantity);
   });
+
+  it('sums certificates and proposal procedures for deposit', () => {
+    const protocolParameters = { governanceActionDeposit: 4, stakeKeyDeposit: 2 } as Cardano.ProtocolParameters;
+    const governanceActionDeposit = BigInt(protocolParameters.governanceActionDeposit);
+    const stakeKeyDeposit = BigInt(protocolParameters.stakeKeyDeposit);
+
+    const anchor = {
+      dataHash: '3e33018e8293d319ef5b3ac72366dd28006bd315b715f7e7cfcbd3004129b80d' as Crypto.Hash32ByteBase16,
+      url: 'https://testing.this'
+    };
+    const certificates: Cardano.Certificate[] = [
+      { __typename: Cardano.CertificateType.Registration, deposit: stakeKeyDeposit, stakeCredential }
+    ];
+    const proposalProcedures: Cardano.ProposalProcedure[] = [
+      {
+        anchor,
+        deposit: governanceActionDeposit,
+        governanceAction: { __typename: Cardano.GovernanceActionType.info_action },
+        rewardAccount
+      }
+    ];
+
+    const coin = Cardano.util.computeImplicitCoin(
+      protocolParameters,
+      { certificates, proposalProcedures },
+      [rewardAccount],
+      dRepKeyHash
+    );
+
+    expect(coin.deposit).toBe(stakeKeyDeposit + governanceActionDeposit);
+  });
 });

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

@@ -260,6 +260,7 @@ export class GenericTxBuilder implements TxBuilder {
                 customizeCb: this.#customizeCb,
                 handleResolutions: this.#handleResolutions,
                 outputs: new Set(this.partialTxBody.outputs || []),
+                proposalProcedures: this.partialTxBody.proposalProcedures,
                 signingOptions: partialSigningOptions,
                 witness: { extraSigners }
               },
@@ -361,15 +362,15 @@ export class GenericTxBuilder implements TxBuilder {
     );
 
     // Reward accounts already delegated to the correct pool. Change must be distributed accordingly
-    for (const accnt of rewardAccounts.filter(
+    for (const account of rewardAccounts.filter(
       (rewardAccount) =>
         rewardAccount.keyStatus === Cardano.StakeKeyStatus.Registered &&
         rewardAccount.delegatee?.nextNextEpoch &&
         this.#requestedPortfolio?.some(({ id }) => id === rewardAccount.delegatee?.nextNextEpoch?.id)
     ))
       rewardAccountsWithWeights.set(
-        accnt.address,
-        this.#requestedPortfolio!.find(({ id }) => id === accnt.delegatee?.nextNextEpoch?.id)!.weight
+        account.address,
+        this.#requestedPortfolio!.find(({ id }) => id === account.delegatee?.nextNextEpoch?.id)!.weight
       );
 
     // Reward accounts which don't have the stake key registered or that were delegated but should not be anymore

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

@@ -88,6 +88,7 @@ export const initializeTx = async (
 
   const implicitCoin = Cardano.util.computeImplicitCoin(protocolParameters, {
     certificates: bodyPreInputSelection.certificates,
+    proposalProcedures: bodyPreInputSelection.proposalProcedures,
     withdrawals: bodyPreInputSelection.withdrawals
   });
 

packages/tx-construction/src/types.ts

@@ -48,6 +48,7 @@ export interface InitializeTxProps {
   witness?: InitializeTxWitness;
   signingOptions?: Pick<SignTransactionOptions, 'additionalKeyPaths'>;
   handleResolutions?: HandleResolution[];
+  proposalProcedures?: Cardano.ProposalProcedure[];
   /** callback function that allows updating the transaction before input selection */
   customizeCb?: CustomizeCb;
 }