@instadapp/avocado-base 0.0.0-dev.9853aa2 → 0.0.0-dev.9d4ed5b

package/utils/metadata.ts

@@ -1,11 +1,36 @@
 import { ethers, utils } from "ethers";
-import { Forwarder__factory } from "../contracts";
+import { Forwarder__factory, MultisigForwarder__factory, MultisigAgnosticForwarder__factory } from "../contracts";
+import { toBN } from "./bignumber";
+
+export const MetadataEnums = {
+  transfer: "transfer",
+  bridge: "bridge",
+  'bridge-v2': 'bridge-v2',
+  swap: "swap",
+  "gas-topup": "gas-topup",
+  upgrade: "upgrade",
+  dapp: "dapp",
+  deploy: "deploy",
+  permit2: "permit2",
+  "cross-transfer": "cross-transfer",
+  'cross-transfer-v2': 'cross-transfer-v2',
+  auth: "auth",
+  rejection: "rejection",
+  "instadapp-pro": "instadapp-pro",
+  "add-signers": "add-signers",
+  "remove-signers": "remove-signers",
+  "change-threshold": "change-threshold",
+  import: "import",
+  mass: "mass",
+  "tx-builder": "tx-builder",
+  "avocado-bridge": "avocado-bridge",
+} as const;
 
 const multiMetadataTypes = ["bytes[]"];
 
 const metadataTypes = ["bytes32 type", "uint8 version", "bytes data"];
 
-const actionMetadataTypes = {
+const actionMetadataTypes: Record<MetadataTypes, string[]> = {
   transfer: ["address token", "uint256 amount", "address receiver"],
   "cross-transfer": [
     "address fromToken",
@@ -14,6 +39,14 @@ const actionMetadataTypes = {
     "uint256 amount",
     "address receiver",
   ],
+  "cross-transfer-v2": [
+    "address fromToken",
+    "address toToken",
+    "uint256 toChainId",
+    "uint256 amount",
+    "address receiver",
+    "bytes32 provider",
+  ],
   bridge: [
     "uint256 amount",
     "address receiver",
@@ -23,6 +56,16 @@ const actionMetadataTypes = {
     "uint256 bridgeFee",
     "address nativeToken",
   ],
+  'bridge-v2': [
+    "uint256 amount",
+    "address receiver",
+    "address fromToken",
+    "address toToken",
+    "uint256 toChainId",
+    "uint256 bridgeFee",
+    "address nativeToken",
+    "bytes32 provider",
+  ],
   swap: [
     "address sellToken",
     "address buyToken",
@@ -34,8 +77,10 @@ const actionMetadataTypes = {
   "gas-topup": ["uint256 amount", "address token", "address onBehalf"],
   upgrade: ["bytes32 version", "address walletImpl"],
   dapp: ["string name", "string url"],
+  import: ["bytes32 protocol", "uint256 valueInUsd"],
   auth: ["address address", "uint256 chainId", "bool remove"],
   deploy: [],
+  "tx-builder": ["bytes32 actionCount"],
   permit2: [
     "address token",
     "address spender",
@@ -43,7 +88,12 @@ const actionMetadataTypes = {
     "uint48 expiration",
   ],
   "instadapp-pro": ["string castDetails"],
-  reject: ["string reason"],
+  "add-signers": ["address[] signers"],
+  "remove-signers": ["address[] signers"],
+  "change-threshold": ["uint8 count"],
+  rejection: ["bytes32 id"],
+  "avocado-bridge": ["bytes32 id", "uint256 toChainId"],
+  mass: ["bool isMass"],
 };
 
 const encodeMetadata = (props: MetadataProps) => {
@@ -64,7 +114,25 @@ export const encodeDappMetadata = (
   );
 
   const data = encodeMetadata({
-    type: "dapp",
+    type: MetadataEnums.dapp,
+    encodedData,
+  });
+
+  return single ? encodeMultipleActions(data) : data;
+};
+
+export const encodeAvocadoBridgeMetadata = (
+  id: string,
+  toChainId: string | number,
+  single = true
+) => {
+  const encodedData = ethers.utils.defaultAbiCoder.encode(
+    actionMetadataTypes["avocado-bridge"],
+    [id, toChainId]
+  );
+
+  const data = encodeMetadata({
+    type: MetadataEnums["avocado-bridge"],
     encodedData,
   });
 
@@ -81,21 +149,21 @@ export const encodeTransferMetadata = (
   );
 
   const data = encodeMetadata({
-    type: "transfer",
+    type: MetadataEnums.transfer,
     encodedData,
   });
 
   return single ? encodeMultipleActions(data) : data;
 };
 
-export const encodeRejectMetadata = (reason: string, single = true) => {
+export const encodeRejectionMetadata = (id: string, single = true) => {
   const encodedData = ethers.utils.defaultAbiCoder.encode(
-    actionMetadataTypes.reject,
-    [reason]
+    actionMetadataTypes.rejection,
+    [id]
   );
 
   const data = encodeMetadata({
-    type: "reject",
+    type: MetadataEnums.rejection,
     encodedData,
   });
 
@@ -106,8 +174,21 @@ export const encodeCrossTransferMetadata = (
   params: CrossSendMetadataProps,
   single = true
 ) => {
-  const encodedData = ethers.utils.defaultAbiCoder.encode(
-    actionMetadataTypes["cross-transfer"],
+
+  const type = params.provider ? MetadataEnums["cross-transfer-v2"] : MetadataEnums["cross-transfer"]
+
+  const encodedData = params.provider ? ethers.utils.defaultAbiCoder.encode(
+    actionMetadataTypes[type],
+    [
+      params.fromToken,
+      params.toToken,
+      params.toChainId,
+      params.amount,
+      params.receiver,
+      params.provider
+    ]
+  ) : ethers.utils.defaultAbiCoder.encode(
+    actionMetadataTypes[type],
     [
       params.fromToken,
       params.toToken,
@@ -118,7 +199,7 @@ export const encodeCrossTransferMetadata = (
   );
 
   const data = encodeMetadata({
-    type: "cross-transfer",
+    type: MetadataEnums[type],
     encodedData,
   });
 
@@ -135,7 +216,7 @@ export const encodeAuthMetadata = (
   );
 
   const data = encodeMetadata({
-    type: "auth",
+    type: MetadataEnums.auth,
     encodedData,
   });
 
@@ -144,13 +225,30 @@ export const encodeAuthMetadata = (
 
 export const encodeDeployMetadata = (single = true) => {
   const data = encodeMetadata({
-    type: "deploy",
+    type: MetadataEnums.deploy,
     encodedData: "0x",
   });
 
   return single ? encodeMultipleActions(data) : data;
 };
 
+export const encodeTransactionBuilderMetadata = (
+  actionCount: string,
+  single = true
+) => {
+  const encodedData = ethers.utils.defaultAbiCoder.encode(
+    actionMetadataTypes["tx-builder"],
+    [actionCount]
+  );
+
+  const data = encodeMetadata({
+    type: MetadataEnums["tx-builder"],
+    encodedData,
+  });
+
+  return single ? encodeMultipleActions(data) : data;
+};
+
 export const encodeWCSignMetadata = (
   params: SignMetadataProps,
   single = true
@@ -161,7 +259,7 @@ export const encodeWCSignMetadata = (
   );
 
   const data = encodeMetadata({
-    type: "permit2",
+    type: MetadataEnums.permit2,
     encodedData,
   });
 
@@ -178,7 +276,7 @@ export const encodeUpgradeMetadata = (
   );
 
   const data = encodeMetadata({
-    type: "upgrade",
+    type: MetadataEnums.upgrade,
     encodedData,
   });
 
@@ -202,7 +300,7 @@ export const encodeSwapMetadata = (
   );
 
   const data = encodeMetadata({
-    type: "swap",
+    type: MetadataEnums.swap,
     encodedData,
   });
 
@@ -218,10 +316,8 @@ export const encodeTopupMetadata = (
     [params.amount, params.token, params.onBehalf]
   );
 
-  console.log(params);
-
   const data = encodeMetadata({
-    type: "gas-topup",
+    type: MetadataEnums["gas-topup"],
     encodedData,
   });
 
@@ -232,7 +328,21 @@ export const encodeBridgeMetadata = (
   params: BridgeMetadataProps,
   single = true
 ) => {
-  const encodedData = ethers.utils.defaultAbiCoder.encode(
+  const type = params.version === '2' ? MetadataEnums["bridge-v2"] : MetadataEnums.bridge
+
+  const encodedData = params.version === '2' ?  ethers.utils.defaultAbiCoder.encode(
+    actionMetadataTypes["bridge-v2"],
+    [
+      params.amount,
+      params.receiver,
+      params.fromToken,
+      params.toToken,
+      params.toChainId,
+      params.bridgeFee,
+      params.nativeToken,
+      params.provider
+    ]
+  ): ethers.utils.defaultAbiCoder.encode(
     actionMetadataTypes.bridge,
     [
       params.amount,
@@ -246,7 +356,85 @@ export const encodeBridgeMetadata = (
   );
 
   const data = encodeMetadata({
-    type: "bridge",
+    type,
+    encodedData,
+  });
+
+  return single ? encodeMultipleActions(data) : data;
+};
+
+export const encodeChangeThresholdMetadata = (
+  threshold: string | number,
+  single = true
+) => {
+  const encodedData = ethers.utils.defaultAbiCoder.encode(
+    actionMetadataTypes["change-threshold"],
+    [toBN(threshold).toNumber()]
+  );
+
+  const data = encodeMetadata({
+    type: MetadataEnums["change-threshold"],
+    encodedData,
+  });
+
+  return single ? encodeMultipleActions(data) : data;
+};
+
+export const encodeRemoveSignersMetadata = (
+  addresses: string[],
+  single = true
+) => {
+  const encodedData = ethers.utils.defaultAbiCoder.encode(
+    actionMetadataTypes["remove-signers"],
+    [addresses]
+  );
+
+  const data = encodeMetadata({
+    type: MetadataEnums["remove-signers"],
+    encodedData,
+  });
+
+  return single ? encodeMultipleActions(data) : data;
+};
+
+export const encodeImportMetadata = (
+  protocol: string,
+  valueInUsd: string,
+  single = true
+) => {
+  const encodedData = ethers.utils.defaultAbiCoder.encode(
+    actionMetadataTypes["import"],
+    [protocol, valueInUsd]
+  );
+
+  const data = encodeMetadata({
+    type: MetadataEnums["import"],
+    encodedData,
+  });
+
+  return single ? encodeMultipleActions(data) : data;
+};
+
+export const encodeMassMetadata = (single = true) => {
+  const data = encodeMetadata({
+    type: MetadataEnums.mass,
+    encodedData: '0x',
+  });
+
+  return single ? encodeMultipleActions(data) : data;
+}
+
+export const encodeAddSignersMetadata = (
+  addresses: string[],
+  single = true
+) => {
+  const encodedData = ethers.utils.defaultAbiCoder.encode(
+    actionMetadataTypes["add-signers"],
+    [addresses]
+  );
+
+  const data = encodeMetadata({
+    type: MetadataEnums["add-signers"],
     encodedData,
   });
 
@@ -276,11 +464,23 @@ export const decodeMetadata = (metadata: string) => {
   }
 };
 
+const iface = Forwarder__factory.createInterface();
+const ifaceMultisig = MultisigForwarder__factory.createInterface();
+const ifaceAgnostic = MultisigAgnosticForwarder__factory.createInterface();
+
 const getMetadataFromData = (data: string) => {
-  const iface = Forwarder__factory.createInterface();
   let metadata = "0x";
 
-  if (data.startsWith("0x18e7f485")) {
+
+  if(data.startsWith('0x320036b4')) {
+    const executeData = ifaceAgnostic.decodeFunctionData("executeChainAgnosticV1", data);
+
+    const metadata = executeData?.params_?.params?.metadata
+
+    return metadata === '0x' || !metadata ? null : metadata
+  }
+
+  else if (data.startsWith("0x18e7f485")) {
     const executeData = iface.decodeFunctionData("execute", data);
     if (executeData.metadata_ === "0x" || !executeData.metadata_) {
       return null;
@@ -297,37 +497,150 @@ const getMetadataFromData = (data: string) => {
     } else {
       metadata = executeDataV2.params_.metadata;
     }
-  } else if (data.startsWith("0x85114d53")) {
-    const executeDataV3 = iface.decodeFunctionData("executeV3", data);
-    if (
-      executeDataV3.params_.metadata === "0x" ||
-      !executeDataV3.params_.metadata
-    ) {
-      return null;
-    } else {
-      metadata = executeDataV3.params_.metadata;
-    }
   } else {
-    const executeDataMultisigV3 = iface.decodeFunctionData(
-      "executeMultisigV3",
+    const executeDataMultisig = ifaceMultisig.decodeFunctionData(
+      "executeV1",
       data
     );
     if (
-      executeDataMultisigV3.params_.metadata === "0x" ||
-      !executeDataMultisigV3.params_.metadata
+      executeDataMultisig.params_.metadata === "0x" ||
+      !executeDataMultisig.params_.metadata
     ) {
       return null;
     } else {
-      metadata = executeDataMultisigV3.params_.metadata;
+      metadata = executeDataMultisig.params_.metadata;
     }
   }
 
   return metadata;
 };
 
+const typesPayload: IPayload = {
+  import: (data, type) => ({
+    type,
+    protocol: utils.parseBytes32String(data.protocol || ""),
+    valueInUsd: toBN(data.valueInUsd).toFixed(),
+  }),
+  transfer: (data, type) => ({
+    type,
+    token: data.token,
+    amount: toBN(data.amount).toFixed(),
+    receiver: data.receiver,
+  }),
+  bridge: (data, type) => ({
+    type,
+    amount: toBN(data.amount).toFixed(),
+    receiver: data.receiver,
+    toToken: data.toToken,
+    fromToken: data.fromToken,
+    toChainId: data.toChainId ? data.toChainId.toString() : null,
+    bridgeFee: toBN(data.bridgeFee).toFixed(),
+  }),
+  'bridge-v2': (data, type) => ({
+    type: 'bridge',
+    amount: toBN(data.amount).toFixed(),
+    receiver: data.receiver,
+    toToken: data.toToken,
+    fromToken: data.fromToken,
+    toChainId: data.toChainId ? data.toChainId.toString() : null,
+    bridgeFee: toBN(data.bridgeFee).toFixed(),
+    provider: utils.parseBytes32String(data.provider || ""),
+  }),
+  swap: (data, type) => ({
+    type,
+    buyAmount: toBN(data.buyAmount).toFixed(),
+    sellAmount: toBN(data.sellAmount).toFixed(),
+    buyToken: data.buyToken,
+    sellToken: data.sellToken,
+    receiver: data.receiver,
+    protocol: utils.parseBytes32String(data.protocol || ""),
+  }),
+  upgrade: (data, type) => ({
+    type,
+    version: utils.parseBytes32String(data.version || ""),
+    walletImpl: data.walletImpl,
+  }),
+  "gas-topup": (data, type) => ({
+    type,
+    amount: toBN(data.amount).toFixed(),
+    token: data.token,
+    onBehalf: data.onBehalf,
+  }),
+  dapp: (data, type) => ({
+    type,
+    name: data.name,
+    url: data.url,
+  }),
+  deploy: (data, type) => ({
+    type,
+  }),
+  "tx-builder": (data, type) => ({
+    type,
+    actionCount: utils.parseBytes32String(data.actionCount || ""),
+  }),
+  permit2: (data, type) => ({
+    type,
+    token: data.token,
+    spender: data.spender,
+    amount: toBN(data.amount).toFixed(),
+    expiration: data.expiration,
+  }),
+  "cross-transfer": (data, type) => ({
+    type,
+    fromToken: data.fromToken,
+    toToken: data.toToken,
+    toChainId: data.toChainId ? data.toChainId.toString() : null,
+    amount: toBN(data.amount).toFixed(),
+    receiver: data.receiver,
+  }),
+  "cross-transfer-v2": (data, type) => ({
+    type: 'cross-transfer',
+    fromToken: data.fromToken,
+    toToken: data.toToken,
+    toChainId: data.toChainId ? data.toChainId.toString() : null,
+    amount: toBN(data.amount).toFixed(),
+    receiver: data.receiver,
+    provider: utils.parseBytes32String(data.provider || ""),
+  }),
+  auth: (data) => ({
+    type: data.remove ? "remove-authority" : "add-authority",
+    address: data.address,
+    chainId: data.chainId ? data.chainId.toString() : null,
+    remove: data.remove,
+  }),
+  "instadapp-pro": (data, type) => ({
+    type,
+    castDetails: data.castDetails,
+  }),
+  rejection: (data, type) => ({
+    type,
+    id: data.id,
+  }),
+  "add-signers": (data, type) => ({
+    type,
+    addresses: data.signers,
+  }),
+  "remove-signers": (data, type) => ({
+    type,
+    addresses: data.signers,
+  }),
+  "change-threshold": (data, type) => ({
+    type,
+    count: data.count,
+  }),
+  "avocado-bridge": (data, type) => ({
+    type,
+    id: data.id,
+    toChainId: data.toChainId ? data.toChainId.toString() : null,
+  }),
+  mass: (data, type) => ({
+    type,
+    data,
+  }),
+};
+
 const parseMetadata = (metadata: string) => {
   const metadataArr = [];
-  let payload = {};
 
   const [decodedMultiMetadata = []] =
     (ethers.utils.defaultAbiCoder.decode(
@@ -345,121 +658,17 @@ const parseMetadata = (metadata: string) => {
       decodedMetadata.type
     ) as keyof typeof actionMetadataTypes;
 
-    const decodedData = ethers.utils.defaultAbiCoder.decode(
+    const decodedData = decodedMetadata?.data === '0x' ? '' : ethers.utils.defaultAbiCoder.decode(
       actionMetadataTypes[type],
       decodedMetadata.data
     );
 
-    switch (type) {
-      case "transfer":
-        payload = {
-          type,
-          token: decodedData.token,
-          amount: toBN(decodedData.amount).toFixed(),
-          receiver: decodedData.receiver,
-        };
-        break;
-      case "bridge":
-        payload = {
-          type,
-          amount: toBN(decodedData.amount).toFixed(),
-          receiver: decodedData.receiver,
-          toToken: decodedData.toToken,
-          fromToken: decodedData.fromToken,
-          toChainId: decodedData.toChainId
-            ? decodedData.toChainId.toString()
-            : null,
-          bridgeFee: toBN(decodedData.bridgeFee).toFixed(),
-        };
-        break;
-      case "swap":
-        payload = {
-          type,
-          buyAmount: toBN(decodedData.buyAmount).toFixed(),
-          sellAmount: toBN(decodedData.sellAmount).toFixed(),
-          buyToken: decodedData.buyToken,
-          sellToken: decodedData.sellToken,
-          receiver: decodedData.receiver,
-          protocol: utils.parseBytes32String(decodedData?.protocol || ""),
-        };
-        break;
-      case "upgrade":
-        payload = {
-          type,
-          version: utils.parseBytes32String(decodedData?.version || ""),
-          walletImpl: decodedData?.walletImpl,
-        };
-        break;
-      case "gas-topup":
-        payload = {
-          type,
-          amount: toBN(decodedData.amount).toFixed(),
-          token: decodedData.token,
-          onBehalf: decodedData.onBehalf,
-        };
-        break;
-      case "dapp":
-        payload = {
-          type,
-          name: decodedData?.name,
-          url: decodedData?.url,
-        };
-        break;
-      case "deploy":
-        payload = {
-          type,
-        };
-        break;
-
-      case "permit2":
-        payload = {
-          type,
-          token: decodedData.token,
-          spender: decodedData.spender,
-          amount: toBN(decodedData.amount).toFixed(),
-          expiration: decodedData.expiration,
-        };
-        break;
-
-      case "cross-transfer":
-        payload = {
-          type,
-          fromToken: decodedData.fromToken,
-          toToken: decodedData.toToken,
-          toChainId: decodedData.toChainId
-            ? decodedData.toChainId.toString()
-            : null,
-          amount: toBN(decodedData.amount).toFixed(),
-          receiver: decodedData.receiver,
-        };
-
-        break;
-      case "auth":
-        payload = {
-          type: decodedData.remove ? "remove-authority" : "add-authority",
-          address: decodedData.address,
-          chainId: decodedData.chainId ? decodedData.chainId.toString() : null,
-          remove: decodedData.remove,
-        };
-
-        break;
-      case "instadapp-pro":
-        payload = {
-          type,
-          castDetails: decodedData.castDetails,
-        };
-
-        break;
-
-      case "reject":
-        payload = {
-          type,
-          reason: decodedData.reason,
-        };
-        break;
-    }
+    const payloadFunc = typesPayload[type];
 
-    metadataArr.push(payload);
+    if (payloadFunc) {
+      const payload = payloadFunc(decodedData, type);
+      metadataArr.push(payload);
+    }
   }
 
   return metadataArr;
@@ -472,6 +681,10 @@ const parseMetadata = (metadata: string) => {
  * @returns {string} - The modified sentence with hyphens replaced with spaces and the first letter of each word capitalized.
  */
 export const formatTxType = (txType: string) => {
+  if(txType === 'mass') {
+    return  'Chain Agnostic Payments'
+  }
+
   const finalSentence = txType
     .replace("-", " ")
     .replace(/(^\w{1})|(\s+\w{1})/g, (letter) => letter.toUpperCase());