feat!: add deposit to stake pool registration certificates

Author: iccicci

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

@@ -168,6 +168,7 @@ 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>;
 

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`;
 
@@ -413,42 +432,3 @@ FROM combined`,
     WITH: ''
   }
 } as const;
-
-/*
-	(SELECT
-		tx.id,
-		cert.cert_index AS cert_index,
-		addr."view" AS address,
-		TRUE AS registration,
-		tx.hash AS tx_id,
-		epoch_param.key_deposit AS deposit
-	FROM tx
-	JOIN stake_registration 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 in (134,135,143,144)
-	ORDER BY tx.id ASC)
-	UNION
-	(SELECT
-		tx.id,
-		cert.cert_index AS cert_index,
-		addr."view" AS address,
-		FALSE AS registration,
-		tx.hash AS tx_id,
-		-(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
-	WHERE tx.id in (134,135,143,144)
-	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/core/src/Cardano/types/Certificate.ts

@@ -115,6 +115,7 @@ export interface StakeAddressCertificate {
 
 export interface PoolRegistrationCertificate {
   __typename: CertificateType.PoolRegistration;
+  deposit: Lovelace;
   poolParameters: PoolParameters;
 }
 

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

@@ -13,6 +13,7 @@ const EMBEDDED_GROUP_SIZE = 10;
  * about the pool such as the pledge, costs, margin, reward account, and the pool's owners and relays.
  */
 export class PoolRegistration {
+  #deposit: Cardano.Lovelace;
   #params: PoolParams;
   #originalBytes: HexBlob | undefined = undefined;
 
@@ -21,7 +22,8 @@ export class PoolRegistration {
    *
    * @param params The pool registration/update parameters.
    */
-  constructor(params: PoolParams) {
+  constructor(params: PoolParams, deposit: Cardano.Lovelace) {
+    this.#deposit = deposit;
     this.#params = params;
   }
 
@@ -146,7 +148,8 @@ export class PoolRegistration {
 
     reader.readEndArray();
 
-    const cert = new PoolRegistration(params);
+    // TODO: the hard-coded 0 deposit should actually be read/computed from tx implicit coins (?)
+    const cert = new PoolRegistration(params, 0n);
     cert.#originalBytes = cbor;
 
     return cert;
@@ -160,6 +163,7 @@ export class PoolRegistration {
   toCore(): Cardano.PoolRegistrationCertificate {
     return {
       __typename: Cardano.CertificateType.PoolRegistration,
+      deposit: this.#deposit,
       poolParameters: this.#params.toCore()
     };
   }
@@ -170,7 +174,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), cert.deposit); // TODO: Core type does not support script hash as credential, fix?
   }
 
   /**

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

@@ -31,6 +31,8 @@ export const withStakePools = unifiedProjectorOperator<WithCertificates & WithEp
     switch (certificate.__typename) {
       case Cardano.CertificateType.PoolRegistration:
         updates[certificate.poolParameters.id] = {
+          // TODO: the hard-coded 0 deposit should actually be read/computed from tx implicit coins or from stake pool status (?)
+          deposit: 0n,
           poolParameters: certificate.poolParameters,
           source
         };