Refactor account module message to send (#20)

Refactored the account modules to handle messageToSend creation on
FolksAccount, abstracting from the used spoke chain.

Removed prepareRaw from the evm account module.

src/chains/evm/common/utils/message.ts

@@ -0,0 +1,187 @@
+import { concat, isHex } from "viem";
+
+import { UINT16_LENGTH } from "../../../../common/constants/bytes.js";
+import { FINALITY } from "../../../../common/constants/message.js";
+import { ChainType } from "../../../../common/types/chain.js";
+import { Action } from "../../../../common/types/message.js";
+import {
+  convertToGenericAddress,
+  getRandomGenericAddress,
+  isGenericAddress,
+} from "../../../../common/utils/address.js";
+import { convertNumberToBytes } from "../../../../common/utils/bytes.js";
+import { exhaustiveCheck } from "../../../../utils/exhaustive-check.js";
+
+import type { GenericAddress } from "../../../../common/types/chain.js";
+import type {
+  MessageAdapters,
+  MessageParams,
+  MessageToSend,
+  MessageToSendBuilderParams,
+} from "../../../../common/types/message.js";
+import type { Hex } from "viem";
+
+export const DEFAULT_MESSAGE_PARAMS = (
+  adapters: MessageAdapters,
+): MessageParams => ({
+  ...adapters,
+  receiverValue: BigInt(0),
+  gasLimit: BigInt(30000),
+  returnGasLimit: BigInt(0),
+});
+
+export function buildMessagePayload(
+  action: Action,
+  accountId: Hex,
+  userAddr: GenericAddress,
+  data: string,
+): Hex {
+  if (!isGenericAddress(accountId)) throw Error("Unknown account id format");
+  if (!isGenericAddress(userAddr)) throw Error("Unknown user address format");
+  if (!isHex(data)) throw Error("Unknown data format");
+
+  return concat([
+    convertNumberToBytes(action, UINT16_LENGTH),
+    accountId,
+    userAddr,
+    data,
+  ]);
+}
+
+export function buildEvmMessageToSend(
+  messageToSendBuilderParams: MessageToSendBuilderParams,
+): MessageToSend {
+  const {
+    accountId,
+    adapters,
+    sender,
+    destinationChainId,
+    handler,
+    action,
+    data,
+  } = messageToSendBuilderParams;
+  switch (action) {
+    case Action.CreateAccount: {
+      const params = DEFAULT_MESSAGE_PARAMS(adapters);
+      const message: MessageToSend = {
+        params,
+        sender,
+        destinationChainId,
+        handler,
+        payload: buildMessagePayload(
+          Action.CreateAccount,
+          accountId,
+          getRandomGenericAddress(),
+          data,
+        ),
+        finalityLevel: FINALITY.IMMEDIATE,
+        extraArgs: "0x",
+      };
+      return message;
+    }
+    case Action.InviteAddress: {
+      const params = DEFAULT_MESSAGE_PARAMS(adapters);
+      const message: MessageToSend = {
+        params,
+        sender,
+        destinationChainId,
+        handler,
+        payload: buildMessagePayload(
+          Action.InviteAddress,
+          accountId,
+          getRandomGenericAddress(),
+          concat([
+            convertNumberToBytes(data.folksChainIdToInvite, UINT16_LENGTH),
+            convertToGenericAddress<ChainType.EVM>(
+              data.addressToInvite,
+              ChainType.EVM,
+            ),
+          ]),
+        ),
+        finalityLevel: FINALITY.IMMEDIATE,
+        extraArgs: "0x",
+      };
+      return message;
+    }
+    case Action.AcceptInviteAddress: {
+      const params = DEFAULT_MESSAGE_PARAMS(adapters);
+      const message: MessageToSend = {
+        params,
+        sender,
+        destinationChainId,
+        handler,
+        payload: buildMessagePayload(
+          Action.AcceptInviteAddress,
+          accountId,
+          getRandomGenericAddress(),
+          data,
+        ),
+        finalityLevel: FINALITY.IMMEDIATE,
+        extraArgs: "0x",
+      };
+      return message;
+    }
+    case Action.UnregisterAddress: {
+      const params = DEFAULT_MESSAGE_PARAMS(adapters);
+      const message: MessageToSend = {
+        params,
+        sender,
+        destinationChainId,
+        handler,
+        payload: buildMessagePayload(
+          Action.UnregisterAddress,
+          accountId,
+          getRandomGenericAddress(),
+          convertNumberToBytes(data.folksChainIdToUnregister, UINT16_LENGTH),
+        ),
+        finalityLevel: FINALITY.IMMEDIATE,
+        extraArgs: "0x",
+      };
+      return message;
+    }
+    case Action.AddDelegate: {
+      throw new Error("Not implemented yet: Action.AddDelegate case");
+    }
+    case Action.RemoveDelegate: {
+      throw new Error("Not implemented yet: Action.RemoveDelegate case");
+    }
+    case Action.CreateLoan: {
+      throw new Error("Not implemented yet: Action.CreateLoan case");
+    }
+    case Action.DeleteLoan: {
+      throw new Error("Not implemented yet: Action.DeleteLoan case");
+    }
+    case Action.Deposit: {
+      throw new Error("Not implemented yet: Action.Deposit case");
+    }
+    case Action.DepositFToken: {
+      throw new Error("Not implemented yet: Action.DepositFToken case");
+    }
+    case Action.Withdraw: {
+      throw new Error("Not implemented yet: Action.Withdraw case");
+    }
+    case Action.WithdrawFToken: {
+      throw new Error("Not implemented yet: Action.WithdrawFToken case");
+    }
+    case Action.Borrow: {
+      throw new Error("Not implemented yet: Action.Borrow case");
+    }
+    case Action.Repay: {
+      throw new Error("Not implemented yet: Action.Repay case");
+    }
+    case Action.RepayWithCollateral: {
+      throw new Error("Not implemented yet: Action.RepayWithCollateral case");
+    }
+    case Action.Liquidate: {
+      throw new Error("Not implemented yet: Action.Liquidate case");
+    }
+    case Action.SwitchBorrowType: {
+      throw new Error("Not implemented yet: Action.SwitchBorrowType case");
+    }
+    case Action.SendToken: {
+      throw new Error("Not implemented yet: Action.SendToken case");
+    }
+    default:
+      return exhaustiveCheck(action);
+  }
+}

src/chains/evm/hub/modules/folks-hub-loan.ts

@@ -7,17 +7,17 @@ import {
   getSpokeChain,
   getSpokeTokenData,
 } from "../../../../common/utils/chain.js";
+import { getSendTokenExtraArgsWhenRemoving } from "../../../../common/utils/messages.js";
 import {
   DEFAULT_MESSAGE_PARAMS,
   buildMessagePayload,
-  getSendTokenExtraArgsWhenRemoving,
-} from "../../../../common/utils/messages.js";
+} from "../../common/utils/message.js";
 import { getHubChain, getHubTokenData } from "../utils/chain.js";
 import { getBridgeRouterHubContract } from "../utils/contract.js";
 
 import type {
-  NetworkType,
   FolksChainId,
+  NetworkType,
 } from "../../../../common/types/chain.js";
 import type {
   MessageAdapters,