feat: support chainport bridge fee upgrade (#307)

* feat: support chainport bridge fee upgrade

* feat: update chainport memo decode

* Bump version 3.0.17

* fix: update memoHex decoding v1 v2

* Update package.json

we don't need to bump the version until after releases

* Update package-lock.json

* feat: update bridge memoHex decode mechanism

* feat: remove date config for chainport upgrade

---------

Co-authored-by: Daniel Cogan <[email protected]>

Author: iflabsfish

main/api/chainport/index.ts

@@ -86,21 +86,27 @@ ${err}
         assetId: z.string(),
         to: z.string(),
         selectedNetwork: z.number(),
+        fromAccount: z.string(),
       }),
     )
     .query(async (opts) => {
       const ironfish = await manager.getIronfish();
       const rpcClient = await ironfish.rpcClient();
       const network = await rpcClient.chain.getNetworkInfo();
 
-      const { amount, assetId, to, selectedNetwork } = opts.input;
+      const { amount, assetId, to, selectedNetwork, fromAccount } = opts.input;
+      const publicAddressResponse = await rpcClient.wallet.getAccountPublicKey({
+        account: fromAccount,
+      });
+      const sourceAddress = publicAddressResponse.content.publicKey;
       try {
         return await fetchChainportBridgeTransaction(
           network.content.networkId,
           BigInt(amount),
           assetId,
           selectedNetwork,
           to,
+          sourceAddress,
         );
       } catch (err) {
         log.error(`Failed to fetch Chainport bridge transaction details.

main/api/chainport/utils/buildTransactionRequestParams.ts

@@ -15,6 +15,12 @@ export const buildTransactionRequestParamsInputs = z.object({
       amount: z.string(),
       memo: z.string(),
     }),
+    bridge_fee: z.object({
+      publicAddress: z.string(),
+      source_token_fee_amount: z.string(),
+      memo: z.string(),
+      assetId: z.string(),
+    }),
   }),
   fee: z.number().optional(),
   feeRate: z.string().optional(),
@@ -30,21 +36,38 @@ export function buildTransactionRequestParams({
   fee,
   feeRate,
 }: BuildTransactionRequestParamsInputs) {
+  const userOutput = {
+    publicAddress: txDetails.bridge_output.publicAddress,
+    amount: txDetails.bridge_output.amount,
+    memoHex: txDetails.bridge_output.memoHex,
+    assetId: txDetails.bridge_output.assetId,
+  };
+  const gasFeeOutput = {
+    publicAddress: txDetails.gas_fee_output.publicAddress,
+    amount: txDetails.gas_fee_output.amount,
+    memo: txDetails.gas_fee_output.memo,
+  };
+
+  const outputs = [userOutput, gasFeeOutput];
+
+  const bridgeFee = txDetails.bridge_fee.source_token_fee_amount;
+  if (BigInt(bridgeFee) > 0n) {
+    userOutput.amount = (
+      BigInt(userOutput.amount) - BigInt(bridgeFee)
+    ).toString();
+
+    const bridgeFeeOutput = {
+      publicAddress: txDetails.bridge_fee.publicAddress,
+      amount: bridgeFee,
+      memo: txDetails.bridge_fee.memo,
+      assetId: txDetails.bridge_fee.assetId,
+    };
+    outputs.push(bridgeFeeOutput);
+  }
+
   const params: CreateTransactionRequest = {
     account: fromAccount,
-    outputs: [
-      {
-        publicAddress: txDetails.bridge_output.publicAddress,
-        amount: txDetails.bridge_output.amount,
-        memoHex: txDetails.bridge_output.memoHex,
-        assetId: txDetails.bridge_output.assetId,
-      },
-      {
-        publicAddress: txDetails.gas_fee_output.publicAddress,
-        amount: txDetails.gas_fee_output.amount,
-        memo: txDetails.gas_fee_output.memo,
-      },
-    ],
+    outputs,
     fee: fee ? CurrencyUtils.encode(BigInt(fee)) : null,
     feeRate: feeRate ?? null,
     expiration: undefined,

main/api/chainport/vendor/metadata.ts

@@ -44,31 +44,21 @@ export class ChainportMemoMetadata {
     return String.fromCharCode(num - 10 + "a".charCodeAt(0));
   }
 
-  public static encode(
-    networkId: number,
-    address: string,
-    toIronfish: boolean,
-  ) {
-    if (address.startsWith("0x")) {
-      address = address.slice(2);
+  public static convertHexToBinary(encodedHex: string): string {
+    const buffer = Buffer.from(encodedHex, "hex");
+    let binaryString = "";
+    for (let i = 0; i < buffer.length; i++) {
+      binaryString += buffer[i].toString(2).padStart(8, "0");
     }
-
-    const encodedNetworkId = this.encodeNumberTo10Bits(networkId);
-    const encodedAddress = address
-      .toLowerCase()
-      .split("")
-      .map((character: string) => {
-        return this.encodeCharacterTo6Bits(character);
-      })
-      .join("");
-
-    const combined =
-      (toIronfish ? "1" : "0") + (encodedNetworkId + encodedAddress).slice(1);
-    const hexString = BigInt("0b" + combined).toString(16);
-    return hexString.padStart(64, "0");
+    return binaryString;
   }
 
-  public static decode(encodedHex: string): [number, string, boolean] {
+  /**
+   * Decode the encoded hex string into a network id, address, and toIronfish flag
+   * @param encodedHex - The encoded hex string
+   * @returns A tuple containing the network id, address, and toIronfish flag
+   */
+  public static decodeV1(encodedHex: string): [number, string, boolean] {
     const hexInteger = BigInt("0x" + encodedHex);
     const encodedString = hexInteger.toString(2);
     const padded = encodedString.padStart(250, "0");
@@ -87,4 +77,32 @@ export class ChainportMemoMetadata {
 
     return [networkId, address.toLowerCase(), toIronfish];
   }
+
+  public static decodeV2(encodedHex: string): [number, string, boolean] {
+    const bits = this.convertHexToBinary(encodedHex);
+    const toIronfish = bits[6] === "1";
+    const memoHexVersion = bits.slice(8, 10);
+    if (memoHexVersion !== "01") {
+      throw new Error(`Unexpected memoHex version: ${memoHexVersion}`);
+    }
+
+    const networkIdBits = bits.slice(10, 16);
+    const networkId = parseInt(networkIdBits, 2);
+    const addressBits = bits.slice(16, 176);
+    let address = "0x";
+    for (let i = 0; i < addressBits.length; i += 4) {
+      address += parseInt(addressBits.slice(i, i + 4), 2).toString(16);
+    }
+
+    return [networkId, address.toLowerCase(), toIronfish];
+  }
+
+  public static decode(encodedHex: string): [number, string, boolean] {
+    const bits = this.convertHexToBinary(encodedHex);
+    const memoHexVersion = bits.slice(8, 10);
+    if (memoHexVersion === "01") {
+      return this.decodeV2(encodedHex);
+    }
+    return this.decodeV1(encodedHex);
+  }
 }

main/api/chainport/vendor/requests.ts

@@ -64,13 +64,15 @@ export const fetchChainportBridgeTransaction = async (
   assetId: string,
   targetNetworkId: number,
   targetAddress: string,
+  sourceAddress: string,
 ): Promise<ChainportBridgeTransaction> => {
   const config = getConfig(networkId);
   const url = new URL(`/bridges/transactions/create`, config.endpoint);
   url.searchParams.append("amount", amount.toString());
   url.searchParams.append("asset_id", assetId);
   url.searchParams.append("target_network_id", targetNetworkId.toString());
   url.searchParams.append("target_address", targetAddress.toString());
+  url.searchParams.append("source_address", sourceAddress);
 
   return await makeChainportRequest<ChainportBridgeTransaction>(url.toString());
 };

main/api/chainport/vendor/types.ts

@@ -4,6 +4,19 @@
 
 // This file contains response types for chainport requests
 
+export type ChainportBridgeFeeV1 = {
+  source_token_fee_amount: string;
+  portx_fee_amount: string;
+  is_portx_fee_payment: boolean;
+};
+
+export type ChainportBridgeFeeV2 = {
+  publicAddress: string;
+  source_token_fee_amount: string;
+  memo: string;
+  assetId: string;
+};
+
 export type ChainportBridgeTransaction = {
   bridge_output: {
     publicAddress: string;
@@ -16,11 +29,7 @@ export type ChainportBridgeTransaction = {
     amount: string;
     memo: string;
   };
-  bridge_fee: {
-    source_token_fee_amount: string;
-    portx_fee_amount: string;
-    is_portx_fee_payment: boolean;
-  };
+  bridge_fee: ChainportBridgeFeeV2;
 };
 
 export type ChainportNetwork = {

renderer/components/BridgeAssetsForm/BridgeConfirmationModal/BridgeConfirmationModal.tsx

@@ -115,6 +115,7 @@ export function BridgeConfirmationModal({
       assetId: chainportToken.web3_address,
       to: formData.destinationAddress,
       selectedNetwork: destinationNetwork.network.chainport_network_id,
+      fromAccount: formData.fromAccount,
     },
     {
       retry: false,
@@ -210,14 +211,6 @@ export function BridgeConfirmationModal({
       return <Skeleton>123 FOO</Skeleton>;
     }
 
-    if (txDetails.bridge_fee.is_portx_fee_payment) {
-      const fee = CurrencyUtils.formatCurrency(
-        txDetails.bridge_fee.portx_fee_amount,
-        18,
-      );
-      return `${fee} PORTX`;
-    }
-
     return `${CurrencyUtils.formatCurrency(
       txDetails.bridge_fee.source_token_fee_amount,
       chainportToken.decimals,