feat: add transaction projection indexed by credentials

Author: will-break-it

packages/cardano-services/src/Projection/prepareTypeormProjection.ts

@@ -3,6 +3,7 @@ import {
   AssetEntity,
   BlockDataEntity,
   BlockEntity,
+  CredentialEntity,
   CurrentPoolMetricsEntity,
   DataSourceExtensions,
   GovernanceActionEntity,
@@ -18,22 +19,26 @@ import {
   StakeKeyRegistrationEntity,
   StakePoolEntity,
   TokensEntity,
+  TransactionEntity,
   createStorePoolMetricsUpdateJob,
   createStoreStakePoolMetadataJob,
   storeAddresses,
   storeAssets,
   storeBlock,
+  storeCredentials,
   storeGovernanceAction,
   storeHandleMetadata,
   storeHandles,
   storeNftMetadata,
   storeStakeKeyRegistrations,
   storeStakePoolRewardsJob,
   storeStakePools,
+  storeTransactions,
   storeUtxo,
   willStoreAddresses,
   willStoreAssets,
   willStoreBlockData,
+  willStoreCredentials,
   willStoreGovernanceAction,
   willStoreHandleMetadata,
   willStoreHandles,
@@ -42,6 +47,7 @@ import {
   willStoreStakePoolMetadataJob,
   willStoreStakePoolRewardsJob,
   willStoreStakePools,
+  willStoreTransactions,
   willStoreUtxo
 } from '@cardano-sdk/projection-typeorm';
 import { Cardano, ChainSyncEventType } from '@cardano-sdk/core';
@@ -61,6 +67,7 @@ export enum ProjectionName {
   StakePoolMetadataJob = 'stake-pool-metadata-job',
   StakePoolMetricsJob = 'stake-pool-metrics-job',
   StakePoolRewardsJob = 'stake-pool-rewards-job',
+  Transaction = 'transaction',
   UTXO = 'utxo'
 }
 
@@ -105,7 +112,8 @@ const createMapperOperators = (
     withNftMetadata: Mapper.withNftMetadata({ logger }),
     withStakeKeyRegistrations: Mapper.withStakeKeyRegistrations(),
     withStakePools: Mapper.withStakePools(),
-    withUtxo: Mapper.withUtxo()
+    withUtxo: Mapper.withUtxo(),
+    withValidByronAddresses: Mapper.withValidByronAddresses()
   };
 };
 type MapperOperators = ReturnType<typeof createMapperOperators>;
@@ -116,6 +124,7 @@ export const storeOperators = {
   storeAddresses: storeAddresses(),
   storeAssets: storeAssets(),
   storeBlock: storeBlock(),
+  storeCredentials: storeCredentials(),
   storeGovernanceAction: storeGovernanceAction(),
   storeHandleMetadata: storeHandleMetadata(),
   storeHandles: storeHandles(),
@@ -128,6 +137,7 @@ export const storeOperators = {
   storeStakePoolMetadataJob: createStoreStakePoolMetadataJob()(),
   storeStakePoolRewardsJob: storeStakePoolRewardsJob(),
   storeStakePools: storeStakePools(),
+  storeTransactions: storeTransactions(),
   storeUtxo: storeUtxo()
 };
 type StoreOperators = typeof storeOperators;
@@ -143,6 +153,7 @@ type WillStore = {
 const willStore: Partial<WillStore> = {
   storeAddresses: willStoreAddresses,
   storeAssets: willStoreAssets,
+  storeCredentials: willStoreCredentials,
   storeGovernanceAction: willStoreGovernanceAction,
   storeHandleMetadata: willStoreHandleMetadata,
   storeHandles: willStoreHandles,
@@ -151,6 +162,7 @@ const willStore: Partial<WillStore> = {
   storeStakePoolMetadataJob: willStoreStakePoolMetadataJob,
   storeStakePoolRewardsJob: willStoreStakePoolRewardsJob,
   storeStakePools: willStoreStakePools,
+  storeTransactions: willStoreTransactions,
   storeUtxo: willStoreUtxo
 };
 
@@ -159,6 +171,7 @@ const entities = {
   asset: AssetEntity,
   block: BlockEntity,
   blockData: BlockDataEntity,
+  credential: CredentialEntity,
   currentPoolMetrics: CurrentPoolMetricsEntity,
   governanceAction: GovernanceActionEntity,
   handle: HandleEntity,
@@ -172,7 +185,8 @@ const entities = {
   poolRewards: PoolRewardsEntity,
   stakeKeyRegistration: StakeKeyRegistrationEntity,
   stakePool: StakePoolEntity,
-  tokens: TokensEntity
+  tokens: TokensEntity,
+  transaction: TransactionEntity
 };
 export const allEntities = Object.values(entities);
 type Entities = typeof entities;
@@ -183,6 +197,7 @@ const storeEntities: Partial<Record<StoreName, EntityName[]>> = {
   storeAddresses: ['address'],
   storeAssets: ['asset'],
   storeBlock: ['block', 'blockData'],
+  storeCredentials: ['credential', 'transaction', 'output'],
   storeGovernanceAction: ['governanceAction'],
   storeHandleMetadata: ['handleMetadata', 'output'],
   storeHandles: ['handle', 'asset', 'tokens', 'output'],
@@ -194,13 +209,15 @@ const storeEntities: Partial<Record<StoreName, EntityName[]>> = {
   storeStakePoolMetadataJob: ['stakePool', 'currentPoolMetrics', 'poolMetadata'],
   storeStakePoolRewardsJob: ['poolRewards', 'stakePool'],
   storeStakePools: ['stakePool', 'currentPoolMetrics', 'poolMetadata', 'poolDelisted'],
+  storeTransactions: ['block', 'transaction'],
   storeUtxo: ['tokens', 'output']
 };
 
 const entityInterDependencies: Partial<Record<EntityName, EntityName[]>> = {
   address: ['stakeKeyRegistration'],
   asset: ['block', 'nftMetadata'],
   blockData: ['block'],
+  credential: [],
   currentPoolMetrics: ['stakePool'],
   governanceAction: ['block'],
   handle: ['asset'],
@@ -212,7 +229,8 @@ const entityInterDependencies: Partial<Record<EntityName, EntityName[]>> = {
   poolRetirement: ['block'],
   stakeKeyRegistration: ['block'],
   stakePool: ['block', 'poolRegistration', 'poolRetirement'],
-  tokens: ['asset']
+  tokens: ['asset'],
+  transaction: ['block', 'credential']
 };
 
 export const getEntities = (entityNames: EntityName[]): Entity[] => {
@@ -244,12 +262,14 @@ const mapperInterDependencies: Partial<Record<MapperName, MapperName[]>> = {
   withHandles: ['withMint', 'filterMint', 'withUtxo', 'filterUtxo', 'withCIP67'],
   withNftMetadata: ['withCIP67', 'withMint', 'filterMint'],
   withStakeKeyRegistrations: ['withCertificates'],
-  withStakePools: ['withCertificates']
+  withStakePools: ['withCertificates'],
+  withValidByronAddresses: ['withUtxo']
 };
 
 const storeMapperDependencies: Partial<Record<StoreName, MapperName[]>> = {
   storeAddresses: ['withAddresses'],
   storeAssets: ['withMint'],
+  storeCredentials: ['withAddresses', 'withCertificates', 'withUtxo', 'withValidByronAddresses'],
   storeHandleMetadata: ['withHandleMetadata'],
   storeHandles: ['withHandles'],
   storeNftMetadata: ['withNftMetadata'],
@@ -270,6 +290,7 @@ const storeInterDependencies: Partial<Record<StoreName, StoreName[]>> = {
   storeStakePoolMetadataJob: ['storeBlock'],
   storeStakePoolRewardsJob: ['storeBlock'],
   storeStakePools: ['storeBlock'],
+  storeTransactions: ['storeCredentials', 'storeBlock', 'storeUtxo'],
   storeUtxo: ['storeBlock', 'storeAssets']
 };
 
@@ -284,6 +305,7 @@ const projectionStoreDependencies: Record<ProjectionName, StoreName[]> = {
   'stake-pool-metadata-job': ['storeStakePoolMetadataJob'],
   'stake-pool-metrics-job': ['storePoolMetricsUpdateJob'],
   'stake-pool-rewards-job': ['storeStakePoolRewardsJob'],
+  transaction: ['storeCredentials', 'storeTransactions'],
   utxo: ['storeUtxo']
 };
 

packages/projection-typeorm/src/entity/Credential.entity.ts

@@ -0,0 +1,26 @@
+import { Column, Entity, Index, ManyToMany, PrimaryColumn } from 'typeorm';
+import { Hash28ByteBase16 } from '@cardano-sdk/crypto';
+import { TransactionEntity } from './Transaction.entity';
+
+export enum CredentialType {
+  PaymentKey = 'payment_key',
+  PaymentScript = 'payment_script',
+  StakeKey = 'stake_key',
+  StakeScript = 'stake_script'
+}
+
+@Entity()
+export class CredentialEntity {
+  @Index()
+  @PrimaryColumn('varchar')
+  credentialHash?: Hash28ByteBase16;
+
+  @Column('enum', { enum: CredentialType, nullable: false })
+  credentialType?: CredentialType;
+
+  @ManyToMany(() => TransactionEntity, (transaction) => transaction.credentials, { onDelete: 'CASCADE' })
+  transactions?: TransactionEntity[];
+}
+
+export const credentialEntityComparator = (c1: CredentialEntity, c2: CredentialEntity) =>
+  c1.credentialHash === c2.credentialHash && c1.credentialType === c2.credentialType;

packages/projection-typeorm/src/entity/Transaction.entity.ts

@@ -0,0 +1,27 @@
+import { BlockEntity } from './Block.entity';
+import { Cardano, Serialization } from '@cardano-sdk/core';
+import { Column, Entity, Index, JoinColumn, JoinTable, ManyToMany, ManyToOne, PrimaryColumn } from 'typeorm';
+import { CredentialEntity } from './Credential.entity';
+import { OnDeleteCascadeRelationOptions } from './util';
+
+@Entity()
+export class TransactionEntity {
+  @Index()
+  @PrimaryColumn('varchar')
+  txId?: Cardano.TransactionId;
+
+  @Column('varchar', { nullable: false })
+  cbor?: Serialization.TxCBOR;
+
+  @ManyToOne(() => BlockEntity, OnDeleteCascadeRelationOptions)
+  @JoinColumn({ name: 'block_id' })
+  block?: BlockEntity;
+
+  @ManyToMany(() => CredentialEntity, (credential) => credential.transactions, { onDelete: 'CASCADE' })
+  @JoinTable({
+    inverseJoinColumn: { name: 'credential_id', referencedColumnName: 'credentialHash' },
+    joinColumn: { name: 'transaction_id', referencedColumnName: 'txId' },
+    name: 'transaction_credentials'
+  })
+  credentials?: CredentialEntity[];
+}

packages/projection-typeorm/src/entity/index.ts

@@ -2,6 +2,7 @@ export * from './Address.entity';
 export * from './Asset.entity';
 export * from './Block.entity';
 export * from './BlockData.entity';
+export * from './Credential.entity';
 export * from './CurrentPoolMetrics.entity';
 export * from './Handle.entity';
 export * from './HandleMetadata.entity';
@@ -16,4 +17,5 @@ export * from './PoolRewards.entity';
 export * from './StakeKey.entity';
 export * from './StakeKeyRegistration.entity';
 export * from './StakePool.entity';
+export * from './Transaction.entity';
 export * from './Tokens.entity';

packages/projection-typeorm/src/operators/index.ts

@@ -1,6 +1,7 @@
 export * from './storeAddresses';
 export * from './storeAssets';
 export * from './storeBlock';
+export * from './storeCredentials';
 export * from './storeGovernanceAction';
 export * from './storeHandles';
 export * from './storeHandleMetadata';
@@ -11,6 +12,7 @@ export * from './storeStakeKeyRegistrations';
 export * from './storeStakePools';
 export * from './storeStakePoolMetadataJob';
 export * from './storeStakePoolRewardsJob';
+export * from './storeTransactions';
 export * from './storeUtxo';
 export * from './util';
 export * from './withTypeormTransaction';