refactor: update nullable TypeORM entity field types to include '| null'

querying a nullable column can return 'null' - entity types should reflect that

Author: mkazlauskas

packages/cardano-services/src/Handle/TypeOrmHandleProvider.ts

@@ -48,6 +48,10 @@ export class TypeOrmHandleProvider extends TypeormProvider implements HandleProv
 
       const mapEntity = (entity: PartialHandleEntity | undefined): HandleResolution | null => {
         if (!entity) return null;
+        if (!entity.cardanoAddress) {
+          this.logger.warn(`${entity.handle} has no associated address, which could be the result of a double mint.`);
+          return null;
+        }
 
         const { cardanoAddress, handle, hasDatum, policyId } = entity;
 

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

@@ -19,5 +19,5 @@ export class AssetEntity {
   firstMintBlock?: BlockEntity;
   @OneToOne(() => NftMetadataEntity, OnDeleteSetNullRelationOptions)
   @JoinColumn()
-  nftMetadata?: NftMetadataEntity;
+  nftMetadata?: NftMetadataEntity | null;
 }

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

@@ -6,8 +6,8 @@ import { Column, Entity, JoinColumn, OneToOne, PrimaryColumn } from 'typeorm';
 export class HandleEntity {
   @PrimaryColumn()
   handle?: string;
-  @Column({ nullable: true })
-  cardanoAddress?: Cardano.PaymentAddress;
+  @Column({ nullable: true, type: 'varchar' })
+  cardanoAddress?: Cardano.PaymentAddress | null;
   @OneToOne(() => AssetEntity, { onDelete: 'CASCADE' })
   @JoinColumn()
   asset?: AssetEntity;

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

@@ -16,18 +16,18 @@ export class NftMetadataEntity {
   id?: number;
   @Column()
   name?: string;
-  @Column({ nullable: true })
-  description?: string;
+  @Column({ nullable: true, type: 'varchar' })
+  description?: string | null;
   @Column()
   image?: string;
-  @Column({ nullable: true })
-  mediaType?: string;
+  @Column({ nullable: true, type: 'varchar' })
+  mediaType?: string | null;
   @Column({ nullable: true, type: 'jsonb' })
-  files?: Asset.NftMetadataFile[];
-  @Column({ enum: NftMetadataType })
+  files?: Asset.NftMetadataFile[] | null;
+  @Column({ enum: NftMetadataType, type: 'enum' })
   type: NftMetadataType;
   @Column({ nullable: true, transformer: [serializableObj], type: 'jsonb' })
-  otherProperties?: Map<string, Cardano.Metadatum>;
+  otherProperties?: Map<string, Cardano.Metadatum> | null;
   @ManyToOne(() => AssetEntity, OnDeleteCascadeRelationOptions)
   @JoinColumn()
   /**
@@ -36,7 +36,7 @@ export class NftMetadataEntity {
    */
   parentAsset?: AssetEntity;
   @ManyToOne(() => AssetEntity, OnDeleteSetNullRelationOptions)
-  userTokenAsset?: AssetEntity;
+  userTokenAsset?: AssetEntity | null;
   @ManyToOne(() => BlockEntity, OnDeleteCascadeRelationOptions)
   createdAt?: BlockEntity;
 }

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

@@ -20,16 +20,16 @@ export class OutputEntity {
   outputIndex?: number;
   @Column(BigIntColumnOptions)
   coins?: bigint;
-  @Column({ nullable: true })
-  consumedAtSlot?: Cardano.Slot;
+  @Column({ nullable: true, type: 'integer' })
+  consumedAtSlot?: Cardano.Slot | null;
   @OneToMany(() => TokensEntity, (tokens) => tokens.output)
   tokens?: TokensEntity[];
   @Column({ length: 64, nullable: true, type: 'char' })
-  datumHash?: Cardano.DatumHash;
-  @Column({ nullable: true })
-  datum?: HexBlob;
+  datumHash?: Cardano.DatumHash | null;
+  @Column({ nullable: true, type: 'varchar' })
+  datum?: HexBlob | null;
   @Column({ nullable: true, type: 'jsonb' })
-  scriptReference?: Cardano.Script;
+  scriptReference?: Cardano.Script | null;
   @ManyToOne(() => BlockEntity, OnDeleteCascadeRelationOptions)
   @JoinColumn()
   block?: BlockEntity;

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

@@ -21,7 +21,7 @@ export class PoolMetadataEntity {
   @Column()
   hash?: string;
   @Column('jsonb', { nullable: true })
-  ext?: Cardano.ExtendedStakePoolMetadata | null | undefined;
+  ext?: Cardano.ExtendedStakePoolMetadata | null;
   @JoinColumn({ referencedColumnName: 'id' })
   @ManyToOne(() => StakePoolEntity)
   stakePool?: StakePoolEntity;

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

@@ -25,7 +25,6 @@ export class StakePoolEntity {
   @JoinColumn()
   @OneToOne(() => PoolRetirementEntity, OnDeleteSetNullRelationOptions)
   lastRetirement?: PoolRetirementEntity | null;
-
-  @OneToOne(() => CurrentPoolMetricsEntity, (metric) => metric.stakePool)
+  @OneToOne(() => CurrentPoolMetricsEntity, (metric) => metric.stakePool, OnDeleteSetNullRelationOptions)
   metrics?: CurrentPoolMetricsEntity | null;
 }