@instadapp/avocado-base 0.0.0-dev.19925f5 → 0.0.0-dev.21292ef

package/utils/metadata.ts

@@ -0,0 +1,694 @@
+import { ethers, utils } from "ethers";
+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: Record<MetadataTypes, string[]> = {
+  transfer: ["address token", "uint256 amount", "address receiver"],
+  "cross-transfer": [
+    "address fromToken",
+    "address toToken",
+    "uint256 toChainId",
+    "uint256 amount",
+    "address receiver",
+  ],
+  "cross-transfer-v2": [
+    "address fromToken",
+    "address toToken",
+    "uint256 toChainId",
+    "uint256 amount",
+    "address receiver",
+    "bytes32 provider",
+  ],
+  bridge: [
+    "uint256 amount",
+    "address receiver",
+    "address fromToken",
+    "address toToken",
+    "uint256 toChainId",
+    "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",
+    "uint256 sellAmount",
+    "uint256 buyAmount",
+    "address receiver",
+    "bytes32 protocol",
+  ],
+  "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",
+    "uint160 amount",
+    "uint48 expiration",
+  ],
+  "instadapp-pro": ["string castDetails"],
+  "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) => {
+  return ethers.utils.defaultAbiCoder.encode(metadataTypes, [
+    ethers.utils.formatBytes32String(props.type),
+    props.version || "1",
+    props.encodedData,
+  ]);
+};
+
+export const encodeDappMetadata = (
+  params: DappMetadataProps,
+  single = true
+) => {
+  const encodedData = ethers.utils.defaultAbiCoder.encode(
+    actionMetadataTypes.dapp,
+    [params.name, params.url]
+  );
+
+  const data = encodeMetadata({
+    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,
+  });
+
+  return single ? encodeMultipleActions(data) : data;
+};
+
+export const encodeTransferMetadata = (
+  params: SendMetadataProps,
+  single = true
+) => {
+  const encodedData = ethers.utils.defaultAbiCoder.encode(
+    actionMetadataTypes.transfer,
+    [params.token, params.amount, params.receiver]
+  );
+
+  const data = encodeMetadata({
+    type: MetadataEnums.transfer,
+    encodedData,
+  });
+
+  return single ? encodeMultipleActions(data) : data;
+};
+
+export const encodeRejectionMetadata = (id: string, single = true) => {
+  const encodedData = ethers.utils.defaultAbiCoder.encode(
+    actionMetadataTypes.rejection,
+    [id]
+  );
+
+  const data = encodeMetadata({
+    type: MetadataEnums.rejection,
+    encodedData,
+  });
+
+  return single ? encodeMultipleActions(data) : data;
+};
+
+export const encodeCrossTransferMetadata = (
+  params: CrossSendMetadataProps,
+  single = true
+) => {
+
+  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,
+      params.toChainId,
+      params.amount,
+      params.receiver,
+    ]
+  );
+
+  const data = encodeMetadata({
+    type: MetadataEnums[type],
+    encodedData,
+  });
+
+  return single ? encodeMultipleActions(data) : data;
+};
+
+export const encodeAuthMetadata = (
+  params: AuthMetadataProps,
+  single = true
+) => {
+  const encodedData = ethers.utils.defaultAbiCoder.encode(
+    actionMetadataTypes["auth"],
+    [params.address, params.chainId, params.remove]
+  );
+
+  const data = encodeMetadata({
+    type: MetadataEnums.auth,
+    encodedData,
+  });
+
+  return single ? encodeMultipleActions(data) : data;
+};
+
+export const encodeDeployMetadata = (single = true) => {
+  const data = encodeMetadata({
+    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
+) => {
+  const encodedData = ethers.utils.defaultAbiCoder.encode(
+    actionMetadataTypes["permit2"],
+    [params.token, params.spender, params.amount, params.expiration]
+  );
+
+  const data = encodeMetadata({
+    type: MetadataEnums.permit2,
+    encodedData,
+  });
+
+  return single ? encodeMultipleActions(data) : data;
+};
+
+export const encodeUpgradeMetadata = (
+  params: UpgradeMetadataProps,
+  single = true
+) => {
+  const encodedData = ethers.utils.defaultAbiCoder.encode(
+    actionMetadataTypes.upgrade,
+    [params.version, params.walletImpl]
+  );
+
+  const data = encodeMetadata({
+    type: MetadataEnums.upgrade,
+    encodedData,
+  });
+
+  return single ? encodeMultipleActions(data) : data;
+};
+
+export const encodeSwapMetadata = (
+  params: SwapMetadataProps,
+  single = true
+) => {
+  const encodedData = ethers.utils.defaultAbiCoder.encode(
+    actionMetadataTypes.swap,
+    [
+      params.sellToken,
+      params.buyToken,
+      params.sellAmount,
+      params.buyAmount,
+      params.receiver,
+      params.protocol,
+    ]
+  );
+
+  const data = encodeMetadata({
+    type: MetadataEnums.swap,
+    encodedData,
+  });
+
+  return single ? encodeMultipleActions(data) : data;
+};
+
+export const encodeTopupMetadata = (
+  params: TopupMetadataProps,
+  single = true
+) => {
+  const encodedData = ethers.utils.defaultAbiCoder.encode(
+    actionMetadataTypes["gas-topup"],
+    [params.amount, params.token, params.onBehalf]
+  );
+
+  const data = encodeMetadata({
+    type: MetadataEnums["gas-topup"],
+    encodedData,
+  });
+
+  return single ? encodeMultipleActions(data) : data;
+};
+
+export const encodeBridgeMetadata = (
+  params: BridgeMetadataProps,
+  single = true
+) => {
+  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,
+      params.receiver,
+      params.fromToken,
+      params.toToken,
+      params.toChainId,
+      params.bridgeFee,
+      params.nativeToken,
+    ]
+  );
+
+  const data = encodeMetadata({
+    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,
+  });
+
+  return single ? encodeMultipleActions(data) : data;
+};
+
+export const encodeMultipleActions = (...actionData: string[]) => {
+  return ethers.utils.defaultAbiCoder.encode(multiMetadataTypes, [actionData]);
+};
+
+export const decodeData = (data: string) => {
+  try {
+    const metadata = getMetadataFromData(data) || "0x";
+
+    return parseMetadata(metadata);
+  } catch (e) {
+    // console.log(e);
+    return null;
+  }
+};
+
+export const decodeMetadata = (metadata: string) => {
+  try {
+    return parseMetadata(metadata);
+  } catch (e) {
+    return null;
+  }
+};
+
+const iface = Forwarder__factory.createInterface();
+const ifaceMultisig = MultisigForwarder__factory.createInterface();
+const ifaceAgnostic = MultisigAgnosticForwarder__factory.createInterface();
+
+const getMetadataFromData = (data: string) => {
+  let metadata = "0x";
+
+  if(data.startsWith('0xc5e15557')) {
+
+    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;
+    } else {
+      metadata = executeData.metadata_;
+    }
+  } else if (data.startsWith("0x14f80a8d")) {
+    const executeDataV2 = iface.decodeFunctionData("executeV2", data);
+    if (
+      executeDataV2.params_.metadata === "0x" ||
+      !executeDataV2.params_.metadata
+    ) {
+      return null;
+    } else {
+      metadata = executeDataV2.params_.metadata;
+    }
+  } else {
+    const executeDataMultisig = ifaceMultisig.decodeFunctionData(
+      "executeV1",
+      data
+    );
+    if (
+      executeDataMultisig.params_.metadata === "0x" ||
+      !executeDataMultisig.params_.metadata
+    ) {
+      return null;
+    } else {
+      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 = [];
+
+  const [decodedMultiMetadata = []] =
+    (ethers.utils.defaultAbiCoder.decode(
+      multiMetadataTypes,
+      metadata
+    ) as string[]) || [];
+
+  for (let metadata of decodedMultiMetadata) {
+    const decodedMetadata = ethers.utils.defaultAbiCoder.decode(
+      metadataTypes,
+      metadata
+    );
+
+    const type = ethers.utils.parseBytes32String(
+      decodedMetadata.type
+    ) as keyof typeof actionMetadataTypes;
+
+    const decodedData = decodedMetadata?.data === '0x' ? '' : ethers.utils.defaultAbiCoder.decode(
+      actionMetadataTypes[type],
+      decodedMetadata.data
+    );
+
+    const payloadFunc = typesPayload[type];
+
+    if (payloadFunc) {
+      const payload = payloadFunc(decodedData, type);
+      metadataArr.push(payload);
+    }
+  }
+
+  return metadataArr;
+};
+
+/**
+ * Replaces hyphens with spaces and capitalizes the first letter of each word in a sentence.
+ * @param {string} txType - The input sentence to modify
+ *
+ * @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());
+
+  return finalSentence;
+};