Merge pull request #1101 from input-output-hk/fix/LW-9604-deposit-values

LW-9604 deposit values

Author: iccicci

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

@@ -155,7 +155,7 @@ export const mapAnchor = (anchorUrl: string, anchorDataHash: string): Cardano.An
 export const mapCertificate = (
   certModel: WithCertType<CertificateModel>
   // eslint-disable-next-line sonarjs/cognitive-complexity
-): WithCertIndex<Cardano.Certificate> | null => {
+): WithCertIndex<Cardano.HydratedCertificate> | null => {
   if (isPoolRetireCertModel(certModel))
     return {
       __typename: Cardano.CertificateType.PoolRetirement,
@@ -168,8 +168,9 @@ export const mapCertificate = (
     return {
       __typename: Cardano.CertificateType.PoolRegistration,
       cert_index: certModel.cert_index,
+      deposit: BigInt(certModel.deposit),
       poolParameters: null as unknown as Cardano.PoolParameters
-    } as WithCertIndex<Cardano.PoolRegistrationCertificate>;
+    } as WithCertIndex<Cardano.HydratedPoolRegistrationCertificate>;
 
   if (isMirCertModel(certModel)) {
     const credential = Cardano.Address.fromString(certModel.address)?.asReward()?.getPaymentCredential();

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

@@ -238,13 +238,32 @@ export const findPoolRetireCertsTxIds = `
 	ORDER BY tx.id ASC`;
 
 export const findPoolRegisterCertsByTxIds = `
-	SELECT	
+	SELECT
 		cert.cert_index AS cert_index,
 		pool."view" AS pool_id,
-		tx.hash AS tx_id
+		tx.hash AS tx_id,
+		CASE
+			WHEN (
+				SELECT count(*) = 0
+				FROM pool_update AS pu
+				WHERE pu.registered_tx_id BETWEEN (
+					CASE WHEN (
+						SELECT count(*) FROM pool_retire AS pr
+						WHERE pr.announced_tx_id < cert.registered_tx_id
+					) > 0 THEN (
+						SELECT max(pr.announced_tx_id) FROM pool_retire AS pr
+						WHERE pr.announced_tx_id < cert.registered_tx_id
+					)
+					ELSE 0 END
+				) AND cert.registered_tx_id - 1
+			) THEN pool_deposit
+			ELSE '0'
+		END AS deposit
 	FROM tx
 	JOIN pool_update AS cert ON cert.registered_tx_id = tx.id
 	JOIN pool_hash AS pool ON pool.id = cert.hash_id
+	JOIN block ON block_id = block.id
+	JOIN epoch_param ON epoch_param.epoch_no = (CASE WHEN block.epoch_no > 1 THEN block.epoch_no ELSE 1 END)
 	WHERE tx.id = ANY($1)
 	ORDER BY tx.id ASC`;
 
@@ -293,12 +312,18 @@ export const findStakeCertsByTxIds = `
 		addr."view" AS address,
 		FALSE AS registration,
 		tx.hash AS tx_id,
-		-epoch_param.key_deposit AS deposit
+		-(SELECT key_deposit FROM stake_registration AS sr
+			JOIN tx AS tx2 ON sr.tx_id = tx2.id
+			JOIN block ON tx2.block_id = block.id
+			JOIN epoch_param ON block.epoch_no = epoch_param.epoch_no
+			WHERE sr.addr_id = cert.addr_id
+				AND sr.tx_id < tx.id
+			ORDER BY sr.tx_id DESC
+			LIMIT 1
+		) AS deposit
 	FROM tx
 	JOIN stake_deregistration AS cert ON cert.tx_id = tx.id
 	JOIN stake_address AS addr ON addr.id = cert.addr_id
-	JOIN block ON block_id = block.id
-	JOIN epoch_param ON block.epoch_no = epoch_param.epoch_no
 	WHERE tx.id = ANY($1)
 	ORDER BY tx.id ASC)`;
 

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

@@ -163,8 +163,10 @@ export interface PoolRetireCertModel extends CertificateModel {
   retiring_epoch: number;
   pool_id: string;
 }
+
 export interface PoolRegisterCertModel extends CertificateModel {
   pool_id: string;
+  deposit: string;
 }
 
 export interface MirCertModel extends CertificateModel {

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

@@ -201,15 +201,17 @@ describe('chain history mappers', () => {
         poolId: Cardano.PoolId(poolId)
       });
     });
-    test('map PoolUpdateCertModel to Cardano.PoolRegistrationCertificate', () => {
+    test('map PoolUpdateCertModel to Cardano.HydratedPoolRegistrationCertificate', () => {
       const result = mappers.mapCertificate({
         ...baseCertModel,
+        deposit: '500000000',
         pool_id: poolId,
         type: 'register'
       } as WithCertType<PoolRegisterCertModel>);
-      expect(result).toEqual<WithCertIndex<Cardano.PoolRegistrationCertificate>>({
+      expect(result).toEqual<WithCertIndex<Cardano.HydratedPoolRegistrationCertificate>>({
         __typename: Cardano.CertificateType.PoolRegistration,
         cert_index: 0,
+        deposit: 500_000_000n,
         poolParameters: null as unknown as Cardano.PoolParameters
       });
     });

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

@@ -1,7 +1,7 @@
 import * as Crypto from '@cardano-sdk/crypto';
 import { AuxiliaryData } from './AuxiliaryData';
 import { Base64Blob, HexBlob, OpaqueString } from '@cardano-sdk/util';
-import { Certificate } from './Certificate';
+import { Certificate, PoolRegistrationCertificate } from './Certificate';
 import { ExUnits, Update, ValidityInterval } from './ProtocolParameters';
 import { HydratedTxIn, TxIn, TxOut } from './Utxo';
 import { Lovelace, TokenMap } from './Value';
@@ -36,14 +36,20 @@ export interface Withdrawal {
   quantity: Lovelace;
 }
 
+export type HydratedPoolRegistrationCertificate = PoolRegistrationCertificate & { deposit?: Lovelace };
+
+export type HydratedCertificate =
+  | Exclude<Certificate, PoolRegistrationCertificate>
+  | HydratedPoolRegistrationCertificate;
+
 export interface HydratedTxBody {
   inputs: HydratedTxIn[];
   collaterals?: HydratedTxIn[];
   outputs: TxOut[];
   fee: Lovelace;
   validityInterval?: ValidityInterval;
   withdrawals?: Withdrawal[];
-  certificates?: Certificate[];
+  certificates?: HydratedCertificate[];
   mint?: TokenMap;
   scriptIntegrityHash?: Crypto.Hash32ByteBase16;
   requiredExtraSignatures?: Crypto.Ed25519KeyHashHex[];
@@ -80,9 +86,10 @@ export interface HydratedTxBody {
   donation?: Lovelace;
 }
 
-export interface TxBody extends Omit<HydratedTxBody, 'inputs' | 'collaterals' | 'referenceInputs'> {
-  inputs: TxIn[];
+export interface TxBody extends Omit<HydratedTxBody, 'certificates' | 'inputs' | 'collaterals' | 'referenceInputs'> {
+  certificates?: Certificate[];
   collaterals?: TxIn[];
+  inputs: TxIn[];
   referenceInputs?: TxIn[];
 }
 

packages/core/src/Serialization/Certificates/PoolRegistration.ts

@@ -170,7 +170,7 @@ export class PoolRegistration {
    * @param cert core PoolRegistrationCertificate object.
    */
   static fromCore(cert: Cardano.PoolRegistrationCertificate) {
-    return new PoolRegistration(PoolParams.fromCore(cert.poolParameters)); // TODO: Core type does not support script hash as credential, fix?
+    return new PoolRegistration(PoolParams.fromCore(cert.poolParameters));
   }
 
   /**

packages/projection/test/InMemory/storeStakePools.test.ts

@@ -3,7 +3,7 @@ import { InMemory, Mappers, ProjectionEvent } from '../../src';
 import { firstValueFrom, of } from 'rxjs';
 
 describe('InMemory.storeStakePools', () => {
-  it('adds pool updates and retirements on RollRorward, removes on RollBackward', async () => {
+  it('adds pool updates and retirements on RollForward, removes on RollBackward', async () => {
     const store = InMemory.createStore();
     const project = async (
       eventType: ChainSyncEventType,

packages/projection/test/operators/Mappers/certificates/withStakePools.test.ts

@@ -70,7 +70,7 @@ describe('withStakePools', () => {
     expect(result.stakePools.retirements[0].epoch).toEqual(4);
   });
 
-  it("omits pool retirement if it's folowed by a pool registration", async () => {
+  it("omits pool retirement if it's followed by a pool registration", async () => {
     const data: Mappers.WithCertificates & WithEpochNo = {
       certificates: [
         {