feat: support chainport bridge fee v2 (#1805)

* feat: integrate chainport upgrade

* feat: upgrade actions/cache to v4

Author: iflabsfish

.env.template

@@ -3,6 +3,7 @@ BLOCK_LOADER_TRANSACTION_TIMEOUT=5000
 CHAINPORT_ACTIVE=false
 CHAINPORT_API_URL=https://preprod-api.chainport.io/
 CHAINPORT_API_VERSION=2
+CHAINPORT_BRIDGE_FEE_VERSION=1
 CHAINPORT_MAINTENANCE=false
 CHAINPORT_NETWORK_ID=22
 CORS_ENABLED=true

.env.test

@@ -3,6 +3,7 @@ BLOCK_LOADER_TRANSACTION_TIMEOUT=5000
 CHAINPORT_ACTIVE=false
 CHAINPORT_API_URL=https://preprod-api.chainport.io/
 CHAINPORT_API_VERSION=2
+CHAINPORT_BRIDGE_FEE_VERSION=1
 CHAINPORT_MAINTENANCE=false
 CHAINPORT_NETWORK_ID=22
 CORS_ENABLED=true

.github/workflows/ci.yml

@@ -38,7 +38,7 @@ jobs:
 
       - name: Restore Yarn cache
         id: yarn-cache
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: |
             node_modules
@@ -69,7 +69,7 @@ jobs:
 
       - name: Restore Yarn cache
         id: yarn-cache
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: |
             node_modules

src/app.module.ts

@@ -56,6 +56,7 @@ export const REST_MODULES = [
         CHAINPORT_ACTIVE: joi.boolean().required(),
         CHAINPORT_API_URL: joi.string().required(),
         CHAINPORT_API_VERSION: joi.number().required(),
+        CHAINPORT_BRIDGE_FEE_VERSION: joi.number().required(),
         CHAINPORT_MAINTENANCE: joi.boolean().required(),
         CHAINPORT_NETWORK_ID: joi.string().required(),
         CORS_ENABLED: joi.boolean().default(true),

src/bridges/bridges.controller.ts

@@ -107,6 +107,7 @@ export class BridgesController {
       query.asset_id,
       query.target_network_id,
       query.target_address,
+      query.source_address,
     );
 
     return transactionOutputs;

src/bridges/chainport.service.spec.ts

@@ -5,7 +5,11 @@ import { INestApplication } from '@nestjs/common';
 import { ApiConfigService } from '../api-config/api-config.service';
 import { NATIVE_ASSET_ID } from '../common/constants';
 import { bootstrapTestApp } from '../test/test-app';
-import { ChainportService } from './chainport.service';
+import {
+  ChainportBridgeFeeV1,
+  ChainportBridgeFeeV2,
+  ChainportService,
+} from './chainport.service';
 
 // eslint-disable-next-line jest/no-disabled-tests
 describe.skip('ChainportService', () => {
@@ -160,6 +164,54 @@ describe.skip('ChainportService', () => {
 
       expect(results).not.toBeNull();
     }, 20000);
+
+    it('works with bridge fee v1', async () => {
+      const originalGet = config.get.bind(config);
+      jest.spyOn(config, 'get').mockImplementation((val) => {
+        if (val === 'CHAINPORT_BRIDGE_FEE_VERSION') {
+          return 1;
+        }
+        return originalGet(val);
+      });
+      const results = await chainport.getIronFishMetadata(
+        100n,
+        NATIVE_ASSET_ID,
+        15,
+        '0xF1d90Af0D4638cD947971d858053696DC72bd241',
+      );
+
+      expect(results).not.toBeNull();
+      expect(results.bridge_fee).toMatchObject({
+        source_token_fee_amount: expect.any(String),
+        portx_fee_amount: expect.any(String),
+        is_portx_fee_payment: expect.any(Boolean),
+      } as ChainportBridgeFeeV1);
+    }, 20000);
+
+    it('works with bridge fee v2', async () => {
+      const originalGet = config.get.bind(config);
+      jest.spyOn(config, 'get').mockImplementation((val) => {
+        if (val === 'CHAINPORT_BRIDGE_FEE_VERSION') {
+          return 2;
+        }
+        return originalGet(val);
+      });
+      const results = await chainport.getIronFishMetadata(
+        100n,
+        NATIVE_ASSET_ID,
+        15,
+        '0xF1d90Af0D4638cD947971d858053696DC72bd241',
+        '2cabe0bddf475a478f4b3903f8fc2d2c70b52526f991bacea8267793da63f44b',
+      );
+
+      expect(results).not.toBeNull();
+      expect(results.bridge_fee).toMatchObject({
+        publicAddress: expect.any(String),
+        source_token_fee_amount: expect.any(String),
+        memo: expect.any(String),
+        assetId: expect.any(String),
+      } as ChainportBridgeFeeV2);
+    }, 20000);
   });
 
   describe('getPort', () => {

src/bridges/chainport.service.ts

@@ -4,6 +4,7 @@
 import { HttpService } from '@nestjs/axios';
 import {
   BadGatewayException,
+  BadRequestException,
   Injectable,
   NotFoundException,
   UnprocessableEntityException,
@@ -111,6 +112,32 @@ type ChainportTokenListResponse = {
   verified_tokens: ChainportToken[];
 };
 
+export type ChainportBridgeFeeV1 = {
+  source_token_fee_amount: string;
+  portx_fee_amount: string;
+  is_portx_fee_payment: boolean;
+};
+
+const chainportBridgeFeeV1Schema = Joi.object<ChainportBridgeFeeV1>({
+  source_token_fee_amount: Joi.string().required(),
+  portx_fee_amount: Joi.string().required(),
+  is_portx_fee_payment: Joi.boolean().required(),
+});
+
+export type ChainportBridgeFeeV2 = {
+  publicAddress: string;
+  source_token_fee_amount: string;
+  memo: string;
+  assetId: string;
+};
+
+const chainportBridgeFeeV2Schema = Joi.object<ChainportBridgeFeeV2>({
+  publicAddress: Joi.string().required(),
+  source_token_fee_amount: Joi.string().required(),
+  memo: Joi.string().required(),
+  assetId: Joi.string().required(),
+});
+
 export type ChainportIronFishMetadata = {
   bridge_output: {
     publicAddress: string;
@@ -123,11 +150,7 @@ export type ChainportIronFishMetadata = {
     amount: string;
     memo: string;
   };
-  bridge_fee: {
-    source_token_fee_amount: string;
-    portx_fee_amount: string;
-    is_portx_fee_payment: boolean;
-  };
+  bridge_fee: ChainportBridgeFeeV1 | ChainportBridgeFeeV2;
 };
 
 const chainportIronFishMetadataSchema = Joi.object<ChainportIronFishMetadata>({
@@ -142,11 +165,9 @@ const chainportIronFishMetadataSchema = Joi.object<ChainportIronFishMetadata>({
     amount: Joi.string().required(),
     memo: Joi.string().required(),
   }).required(),
-  bridge_fee: Joi.object({
-    source_token_fee_amount: Joi.string().required(),
-    portx_fee_amount: Joi.string().required(),
-    is_portx_fee_payment: Joi.boolean().required(),
-  }).required(),
+  bridge_fee: Joi.alternatives()
+    .try(chainportBridgeFeeV1Schema, chainportBridgeFeeV2Schema)
+    .required(),
 });
 
 export type ChainportPort =
@@ -432,8 +453,12 @@ export class ChainportService {
     assetId: string,
     targetNetworkId: number,
     targetWeb3Address: string,
+    sourceAddress?: string,
   ): Promise<ChainportIronFishMetadata> {
     const apiurl = this.config.get<string>('CHAINPORT_API_URL');
+    const bridgeFeeVersion = this.config.get<number>(
+      'CHAINPORT_BRIDGE_FEE_VERSION',
+    );
 
     const ironfishMetadataUrl = new URL(`/ironfish/metadata`, apiurl);
     ironfishMetadataUrl.searchParams.append('raw_amount', amount.toString());
@@ -447,6 +472,22 @@ export class ChainportService {
       targetWeb3Address,
     );
 
+    if (bridgeFeeVersion === 1 && sourceAddress) {
+      throw new BadRequestException(
+        'Source address is not supported for bridge fee version 1',
+      );
+    } else if (bridgeFeeVersion === 2 && !sourceAddress) {
+      throw new BadRequestException(
+        'Source address is required for bridge fee version 2',
+      );
+    }
+    if (sourceAddress) {
+      ironfishMetadataUrl.searchParams.append(
+        'ironfish_user_address',
+        sourceAddress,
+      );
+    }
+
     const ironfishMetadataResult =
       await this.makeChainportRequest<ChainportIronFishMetadata>(
         ironfishMetadataUrl.toString(),

src/bridges/dto/transactions-create.dto.ts

@@ -1,9 +1,15 @@
 /* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
-import { ApiProperty } from '@nestjs/swagger';
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
 import { Transform, TransformFnParams, Type } from 'class-transformer';
-import { IsDefined, IsInt, IsPositive, IsString } from 'class-validator';
+import {
+  IsDefined,
+  IsInt,
+  IsOptional,
+  IsPositive,
+  IsString,
+} from 'class-validator';
 import { stringToPositiveBigint } from '../../common/utils/bigint';
 
 export class TransactionsCreateDto {
@@ -45,4 +51,12 @@ export class TransactionsCreateDto {
   })
   @IsString()
   readonly target_address!: string;
+
+  @ApiPropertyOptional({
+    description:
+      'Address on the source network that will send the bridged asset',
+  })
+  @IsOptional()
+  @IsString()
+  readonly source_address: string | undefined;
 }

src/test/test-app.ts

@@ -23,6 +23,7 @@ export async function bootstrapTestApp(): Promise<INestApplication> {
           CHAINPORT_ACTIVE: joi.boolean().required(),
           CHAINPORT_API_URL: joi.string().required(),
           CHAINPORT_API_VERSION: joi.number().required(),
+          CHAINPORT_BRIDGE_FEE_VERSION: joi.number().required(),
           CHAINPORT_MAINTENANCE: joi.boolean().required(),
           CHAINPORT_NETWORK_ID: joi.string().required(),
           CORS_ENABLED: joi.boolean().default(true),