feat: add token offchain data

packages/api/src/api/api.controller.ts

@@ -234,7 +234,9 @@ export class ApiController {
 
   @ApiTags("Account API")
   @Get("api?module=account&action=txlistinternal")
-  @ApiOperation({ summary: "Retrieve internal transactions" })
+  @ApiOperation({
+    summary: "Retrieve internal transactions for a given blocks range (only transfers are supported for now)",
+  })
   @ApiQuery({
     name: "startblock",
     type: "integer",
@@ -265,7 +267,9 @@ export class ApiController {
 
   @ApiTags("Account API")
   @Get("api?module=account&action=txlistinternal&address=")
-  @ApiOperation({ summary: "Retrieve internal transactions for a given address" })
+  @ApiOperation({
+    summary: "Retrieve internal transactions for a given address (only transfers are supported for now)",
+  })
   @ApiQuery({
     name: "address",
     description: "The address to filter internal transactions by",
@@ -302,7 +306,9 @@ export class ApiController {
 
   @ApiTags("Account API")
   @Get("api?module=account&action=txlistinternal&txhash=")
-  @ApiOperation({ summary: "Retrieve internal transactions for a given transaction hash" })
+  @ApiOperation({
+    summary: "Retrieve internal transactions for a given transaction hash (only transfers are supported for now)",
+  })
   @ApiQuery({
     name: "txhash",
     description: "The transaction hash to filter internal transaction by",

packages/api/src/api/mappers/transferMapper.spec.ts

@@ -163,5 +163,19 @@ describe("transferMapper", () => {
         });
       });
     });
+
+    describe("when transfer amount is NULL", () => {
+      it("sets value as undefined", () => {
+        expect(
+          mapTransferListItem(
+            {
+              ...transfer,
+              amount: null,
+            } as unknown as Transfer,
+            100
+          ).value
+        ).toBe(undefined);
+      });
+    });
   });
 });

packages/api/src/api/mappers/transferMapper.ts

@@ -10,7 +10,7 @@ export const mapTransferListItem = (transfer: Transfer, lastBlockNumber: number)
   transactionIndex: transfer.transaction?.transactionIndex.toString(),
   from: transfer.from,
   to: transfer.to,
-  value: transfer.amount,
+  value: transfer.amount || undefined,
   tokenID: transfer.fields?.tokenId,
   tokenName: transfer.token?.name,
   tokenSymbol: transfer.token?.symbol,

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

@@ -14,17 +14,21 @@ export const ETH_TOKEN: Token = {
   symbol: "ETH",
   name: "Ether",
   decimals: 18,
+  iconURL: null,
+  liquidity: null,
+  usdPrice: null,
 } as Token;
 
 @Entity({ name: "tokens" })
-@Index(["blockNumber", "logIndex"])
+@Index(["liquidity", "blockNumber", "logIndex"])
 export class Token extends BaseEntity {
   @PrimaryColumn({ type: "bytea", transformer: normalizeAddressTransformer })
   public readonly l2Address: string;
 
   @Column({ generated: true, type: "bigint", select: false })
   public readonly number: number;
 
+  @Index()
   @Column({ type: "bytea", nullable: true, transformer: normalizeAddressTransformer })
   public readonly l1Address?: string;
 
@@ -42,4 +46,17 @@ export class Token extends BaseEntity {
 
   @Column({ type: "int", select: false })
   public readonly logIndex: number;
+
+  @Column({ type: "double precision", nullable: true })
+  public readonly usdPrice?: number;
+
+  @Column({ type: "double precision", nullable: true })
+  public readonly liquidity?: number;
+
+  @Column({ nullable: true })
+  public readonly iconURL?: string;
+
+  @Index()
+  @Column({ type: "timestamp", nullable: true, select: false })
+  public readonly offChainDataUpdatedAt?: Date;
 }

packages/api/src/token/token.service.spec.ts

@@ -68,6 +68,9 @@ describe("TokenService", () => {
           l2Address: "0x000000000000000000000000000000000000800A",
           name: "Ether",
           symbol: "ETH",
+          iconURL: null,
+          liquidity: null,
+          usdPrice: null,
         });
       });
 
@@ -139,11 +142,12 @@ describe("TokenService", () => {
       expect(repositoryMock.createQueryBuilder).toHaveBeenCalledWith("token");
     });
 
-    it("returns tokens ordered by blockNumber and logIndex DESC", async () => {
+    it("returns tokens ordered by liquidity, blockNumber and logIndex DESC", async () => {
       await service.findAll(pagingOptions);
       expect(queryBuilderMock.orderBy).toBeCalledTimes(1);
-      expect(queryBuilderMock.orderBy).toHaveBeenCalledWith("token.blockNumber", "DESC");
-      expect(queryBuilderMock.addOrderBy).toBeCalledTimes(1);
+      expect(queryBuilderMock.orderBy).toHaveBeenCalledWith("token.liquidity", "DESC");
+      expect(queryBuilderMock.addOrderBy).toBeCalledTimes(2);
+      expect(queryBuilderMock.addOrderBy).toHaveBeenCalledWith("token.blockNumber", "DESC");
       expect(queryBuilderMock.addOrderBy).toHaveBeenCalledWith("token.logIndex", "DESC");
     });
 

packages/api/src/token/token.service.ts

@@ -31,7 +31,8 @@ export class TokenService {
 
   public async findAll(paginationOptions: IPaginationOptions): Promise<Pagination<Token>> {
     const queryBuilder = this.tokenRepository.createQueryBuilder("token");
-    queryBuilder.orderBy("token.blockNumber", "DESC");
+    queryBuilder.orderBy("token.liquidity", "DESC");
+    queryBuilder.addOrderBy("token.blockNumber", "DESC");
     queryBuilder.addOrderBy("token.logIndex", "DESC");
     return await paginate<Token>(queryBuilder, paginationOptions);
   }