feat: nft support

packages/api/src/app.module.ts

@@ -24,6 +24,7 @@ import { metricProviders } from "./metrics";
 import { DbMetricsService } from "./dbMetrics.service";
 import { disableExternalAPI } from "./config/featureFlags";
 import config from "./config";
+import { NftItemModule } from "./nft/nftItem.module";
 
 @Module({
   imports: [
@@ -49,6 +50,7 @@ import config from "./config";
     LogModule,
     StatsModule,
     HealthModule,
+    NftItemModule,
   ],
   providers: [Logger, ...metricProviders, DbMetricsService],
 })

packages/api/src/nft/nftItem.entity.ts

@@ -0,0 +1,31 @@
+import { hexTransformer } from "../common/transformers/hex.transformer";
+import { BaseEntity, Column, Entity, Index, PrimaryColumn } from "typeorm";
+
+@Entity({ name: "nftitems" })
+@Index(["tokenId", "tokenAddress"])
+export class NftItem extends BaseEntity {
+  @PrimaryColumn()
+  public readonly tokenId: string;
+
+  @PrimaryColumn({ type: "bytea", transformer: hexTransformer })
+  public readonly tokenAddress: string;
+
+  @Column({ generated: true, type: "bigint" })
+  public readonly number: number;
+
+  @Index()
+  @Column({ type: "bytea", transformer: hexTransformer })
+  public readonly owner: string;
+
+  @Column({ nullable: true })
+  public readonly name?: string;
+
+  @Column({ nullable: true })
+  public readonly description?: string;
+
+  @Column({ nullable: true })
+  public readonly imageUrl?: string;
+
+  @Column({ nullable: true })
+  public readonly metadataUrl?: string;
+}

packages/api/src/nft/nftItem.module.ts

@@ -0,0 +1,7 @@
+import { Module } from "@nestjs/common";
+import { TypeOrmModule } from "@nestjs/typeorm";
+import { NftItem } from "./nftItem.entity";
+@Module({
+  imports: [TypeOrmModule.forFeature([NftItem])],
+})
+export class NftItemModule {}

packages/api/src/token/token.dto.ts

@@ -1,4 +1,5 @@
 import { ApiProperty } from "@nestjs/swagger";
+import { TokenType } from "./token.entity";
 
 export class TokenDto {
   @ApiProperty({ type: String, description: "L2 token address", example: "0xd754Ff5e8a6f257E162F72578A4bB0493c0681d8" })
@@ -58,4 +59,13 @@ export class TokenDto {
     required: false,
   })
   public readonly iconURL?: string;
+
+  @ApiProperty({
+    type: String,
+    description: "Token type",
+    example: "ERC20",
+    enum: ["BASETOKEN", "ERC20", "ERC721"],
+    default: "ERC20",
+  })
+  public readonly type?: TokenType;
 }

packages/api/src/token/token.entity.ts

@@ -47,4 +47,7 @@ export class Token extends BaseEntity {
   @Index()
   @Column({ type: "timestamp", nullable: true, select: false })
   public readonly offChainDataUpdatedAt?: Date;
+
+  @Column({ type: "enum", enum: TokenType, default: TokenType.ERC20 })
+  public readonly type: TokenType;
 }

packages/api/src/transfer/transfer.entity.ts

@@ -1,11 +1,12 @@
-import { Entity, Column, Index, ManyToOne, JoinColumn, PrimaryColumn, AfterLoad } from "typeorm";
+import { Entity, Column, Index, ManyToOne, JoinColumn, PrimaryColumn, AfterLoad, OneToOne } from "typeorm";
 import { BaseEntity } from "../common/entities/base.entity";
 import { Token, TokenType } from "../token/token.entity";
 import { normalizeAddressTransformer } from "../common/transformers/normalizeAddress.transformer";
 import { bigIntNumberTransformer } from "../common/transformers/bigIntNumber.transformer";
 import { hexTransformer } from "../common/transformers/hex.transformer";
 import { Transaction } from "../transaction/entities/transaction.entity";
 import { baseToken, ethToken } from "../config";
+import { NftItem } from "../nft/nftItem.entity";
 
 export enum TransferType {
   Deposit = "deposit",
@@ -80,6 +81,9 @@ export class Transfer extends BaseEntity {
   @Column({ type: "boolean", default: false })
   public readonly isInternal: boolean;
 
+  @OneToOne(() => NftItem)
+  public nftItem?: NftItem;
+
   toJSON() {
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     const { number, ...restFields } = this;

packages/api/src/transfer/transfer.service.ts

@@ -8,6 +8,7 @@ import { Transfer, TransferType } from "./transfer.entity";
 import { TokenType } from "../token/token.entity";
 import { AddressTransfer } from "./addressTransfer.entity";
 import { normalizeAddressTransformer } from "../common/transformers/normalizeAddress.transformer";
+import { NftItem } from "../nft/nftItem.entity";
 
 export interface FilterTransfersOptions {
   tokenAddress?: string;
@@ -56,6 +57,12 @@ export class TransferService {
       const queryBuilder = this.addressTransferRepository.createQueryBuilder("addressTransfer");
       queryBuilder.select("addressTransfer.number");
       queryBuilder.leftJoinAndSelect("addressTransfer.transfer", "transfer");
+      queryBuilder.leftJoinAndMapOne(
+        "transfer.nftItem",
+        NftItem,
+        "nftItem",
+        "nftItem.tokenAddress = transfer.tokenAddress AND nftItem.tokenId = (transfer.fields->>'tokenId')::text"
+      );
       queryBuilder.leftJoinAndSelect("transfer.token", "token");
       queryBuilder.where(filterOptions);
       queryBuilder.orderBy("addressTransfer.timestamp", "DESC");
@@ -69,6 +76,12 @@ export class TransferService {
       const queryBuilder = this.transferRepository.createQueryBuilder("transfer");
       queryBuilder.where(filterOptions);
       queryBuilder.leftJoinAndSelect("transfer.token", "token");
+      queryBuilder.leftJoinAndMapOne(
+        "transfer.nftItem",
+        NftItem,
+        "nftItem",
+        "nftItem.tokenAddress = transfer.tokenAddress AND nftItem.tokenId = (transfer.fields->>'tokenId')::text"
+      );
       queryBuilder.orderBy("transfer.timestamp", "DESC");
       queryBuilder.addOrderBy("transfer.logIndex", "ASC");
       return await paginate<Transfer>(queryBuilder, paginationOptions);

packages/api/test/account-api.e2e-spec.ts

@@ -121,6 +121,7 @@ describe("Account API (e2e)", () => {
       decimals: 18,
       blockNumber: 1,
       logIndex: 1,
+      type: TokenType.ERC20,
     });
 
     const tokens = [