@townsq/mm-sdk 1.0.1

package/src/common/types/gmp.ts

@@ -0,0 +1,19 @@
+import type { GenericAddress } from "./address.js";
+import type { Branded } from "./brand.js";
+
+export enum MessageDirection {
+  SpokeToHub,
+  HubToSpoke,
+}
+
+export type WormholeData = {
+  wormholeChainId: number;
+  wormholeRelayer: GenericAddress;
+};
+
+export type CCIPData = {
+  ccipChainId: bigint;
+  ccipRouter: GenericAddress;
+};
+
+export type MessageId = Branded<`0x${string}`, "MessageId">;

package/src/common/types/lending.ts

@@ -0,0 +1,26 @@
+import type { Branded } from './brand.js';
+
+export type Nonce = Branded<`0x${string}`, 'Nonce'>;
+export type AccountId = Branded<`0x${string}`, 'AccountId'>;
+export type LoanId = Branded<`0x${string}`, 'LoanId'>;
+export type LoanName = Branded<`0x${string}`, 'LoanName'>;
+
+export const MAINNET_LOAN_TYPE_ID = {
+  DEPOSIT: 1, // no support for borrows
+  GENERAL: 2,
+  MON_EFFICIENCY: 3,
+  STABLE_EFFICIENCY: 4,
+} as const;
+export type MainnetLoanTypeId =
+  (typeof MAINNET_LOAN_TYPE_ID)[keyof typeof MAINNET_LOAN_TYPE_ID];
+
+export const TESTNET_LOAN_TYPE_ID = {
+  DEPOSIT: 2, // no support for borrows
+  GENERAL: 1,
+  MON_EFFICIENCY: 3,
+  STABLE_EFFICIENCY: 4,
+} as const;
+export type TestnetLoanTypeId =
+  (typeof TESTNET_LOAN_TYPE_ID)[keyof typeof TESTNET_LOAN_TYPE_ID];
+
+export type LoanTypeId = MainnetLoanTypeId | TestnetLoanTypeId;

package/src/common/types/message.ts

@@ -0,0 +1,401 @@
+import type { MessageAdapterParamsType } from './adapter.js';
+import type { GenericAddress } from './address.js';
+import type { TSChainId } from './chain.js';
+import type {
+  AccountId,
+  LoanId,
+  LoanName,
+  LoanTypeId,
+  Nonce,
+} from './lending.js';
+import type {
+  TSTokenId as LendingTokenId,
+  TsSpokeTokenType,
+  TsHubTokenType,
+} from './token.js';
+import type { NonEmptyArray } from '../../types/generics.js';
+import type {
+  FINALITY,
+  HUB_ACTIONS,
+  RECEIVE_TOKEN_ACTIONS,
+  REVERSIBLE_HUB_ACTIONS,
+  SEND_TOKEN_ACTIONS,
+} from '../constants/message.js';
+import type { Hex } from 'viem';
+
+export enum AdapterType {
+  HUB = 1,
+  WORMHOLE_DATA = 1,
+}
+
+export enum Action {
+  // SPOKE -> HUB
+  CreateAccount,
+  InviteAddress,
+  AcceptInviteAddress,
+  UnregisterAddress,
+  AddDelegate,
+  RemoveDelegate,
+  CreateLoan,
+  DeleteLoan,
+  InitiateLoanAccountWithDeposit,
+  Deposit,
+  DepositTsToken,
+  Withdraw,
+  WithdrawTsToken,
+  Borrow,
+  Repay,
+  RepayWithCollateral,
+  Liquidate,
+  ChangeBorrowMode,
+  // HUB -> SPOKE
+  SendToken,
+  // CUSTOM,
+  ClaimRewardsV2,
+}
+
+export type SendTokenAction = Extract<
+  Action,
+  (typeof SEND_TOKEN_ACTIONS)[number]
+>;
+export type ReceiveTokenAction = Extract<
+  Action,
+  (typeof RECEIVE_TOKEN_ACTIONS)[number]
+>;
+export type HubAction = Extract<Action, (typeof HUB_ACTIONS)[number]>;
+
+export type ReversibleHubAction = Extract<
+  Action,
+  (typeof REVERSIBLE_HUB_ACTIONS)[number]
+>;
+
+export type DataAction = Extract<
+  Action,
+  | Action.CreateAccount
+  | Action.InviteAddress
+  | Action.AcceptInviteAddress
+  | Action.UnregisterAddress
+  | Action.AddDelegate
+  | Action.RemoveDelegate
+  | Action.CreateLoan
+  | Action.DeleteLoan
+  | Action.RepayWithCollateral
+  | Action.ChangeBorrowMode
+>;
+
+export type ClaimRewardAction = Extract<Action, Action.ClaimRewardsV2>;
+
+export type Finality = (typeof FINALITY)[keyof typeof FINALITY];
+
+export type MessageAdapters = {
+  adapterId: AdapterType;
+  returnAdapterId: AdapterType;
+};
+
+export type SupportedMessageAdapters = {
+  adapterIds: NonEmptyArray<AdapterType>;
+  returnAdapterIds: NonEmptyArray<AdapterType>;
+};
+
+export type SupportedMessageAdaptersMap = {
+  [MessageAdapterParamsType.SendToken]: SupportedMessageAdapters;
+  [MessageAdapterParamsType.ReceiveToken]: SupportedMessageAdapters;
+  [MessageAdapterParamsType.Data]: SupportedMessageAdapters;
+};
+
+export type FeeParams = {
+  receiverValue: bigint;
+  gasLimit: bigint;
+  returnGasLimit: bigint;
+};
+
+export type MessageParams = FeeParams & MessageAdapters;
+
+export type OptionalFeeParams = Partial<FeeParams>;
+
+export type Payload = {
+  action: Action;
+  accountId: AccountId;
+  userAddr: GenericAddress;
+  data: Hex;
+};
+
+export type MessageToSend = {
+  params: MessageParams;
+  sender: GenericAddress;
+  destinationChainId: number;
+  handler: GenericAddress;
+  payload: Hex;
+  finalityLevel: Finality;
+  extraArgs: Hex;
+};
+
+// Data
+export type DefaultMessageData = '0x';
+
+// Data: account
+export type CreateAccountMessageData = {
+  nonce: Nonce;
+  refAccountId: AccountId;
+};
+
+export type InviteAddressMessageData = {
+  tsChainIdToInvite: TSChainId;
+  addressToInvite: GenericAddress;
+  refAccountId: AccountId;
+};
+
+export type UnregisterAddressMessageData = {
+  tsChainIdToUnregister: TSChainId;
+};
+
+// Data: loan
+export type CreateLoanMessageData = {
+  nonce: Nonce;
+  loanTypeId: LoanTypeId;
+  loanName: LoanName;
+};
+
+export type DeleteLoanMessageData = {
+  accountId: AccountId;
+  loanId: LoanId;
+};
+
+export type CreateLoanAndDepositMessageData = {
+  nonce: Nonce;
+  poolId: number;
+  amount: bigint;
+  loanTypeId: LoanTypeId;
+  loanName: LoanName;
+};
+
+export type DepositMessageData = {
+  loanId: LoanId;
+  poolId: number;
+  amount: bigint;
+};
+
+export type WithdrawMessageData = {
+  loanId: LoanId;
+  poolId: number;
+  receiverTsChainId: TSChainId;
+  amount: bigint;
+  isFAmount: boolean;
+};
+
+export type BorrowMessageData = {
+  loanId: LoanId;
+  poolId: number;
+  receiverTsChainId: TSChainId;
+  amount: bigint;
+  maxStableRate: bigint;
+};
+
+export type RepayMessageData = {
+  loanId: LoanId;
+  poolId: number;
+  amount: bigint;
+  maxOverRepayment: bigint;
+};
+
+export type RepayWithCollateralMessageData = {
+  loanId: LoanId;
+  poolId: number;
+  amount: bigint;
+};
+
+export type SwitchBorrowTypeMessageData = {
+  loanId: LoanId;
+  poolId: number;
+  maxStableRate: bigint;
+};
+
+export type LiquidateMessageData = {
+  violatorLoanId: LoanId;
+  liquidatorLoanId: LoanId;
+  colPoolId: number;
+  borPoolId: number;
+  repayingAmount: bigint;
+  minSeizedAmount: bigint;
+};
+
+export type SendTokenMessageData = {
+  amount: bigint;
+};
+
+// Extra args
+export type DefaultExtraArgs = '0x';
+
+// Extra args: loan
+export type DepositExtraArgs = {
+  token: TsSpokeTokenType;
+  recipient: GenericAddress;
+  amount: bigint;
+};
+
+export type RepayExtraArgs = {
+  token: TsSpokeTokenType;
+  recipient: GenericAddress;
+  amount: bigint;
+};
+
+export type SendTokenExtraArgs = {
+  tsTokenId: LendingTokenId;
+  token: TsHubTokenType;
+  recipient: GenericAddress;
+  amount: bigint;
+};
+
+export type OverrideTokenData = {
+  tsTokenId: LendingTokenId;
+  token: TsSpokeTokenType;
+  address: GenericAddress;
+  amount: bigint;
+};
+
+export type MessageDataMap = {
+  [Action.AcceptInviteAddress]: DefaultMessageData;
+  [Action.AddDelegate]: DefaultMessageData;
+  [Action.RemoveDelegate]: DefaultMessageData;
+  [Action.DepositTsToken]: DefaultMessageData;
+  [Action.WithdrawTsToken]: DefaultMessageData;
+  [Action.CreateAccount]: CreateAccountMessageData;
+  [Action.InviteAddress]: InviteAddressMessageData;
+  [Action.UnregisterAddress]: UnregisterAddressMessageData;
+  [Action.CreateLoan]: CreateLoanMessageData;
+  [Action.DeleteLoan]: DeleteLoanMessageData;
+  [Action.InitiateLoanAccountWithDeposit]: CreateLoanAndDepositMessageData;
+  [Action.Deposit]: DepositMessageData;
+  [Action.Withdraw]: WithdrawMessageData;
+  [Action.Borrow]: BorrowMessageData;
+  [Action.Repay]: RepayMessageData;
+  [Action.RepayWithCollateral]: RepayWithCollateralMessageData;
+  [Action.ChangeBorrowMode]: SwitchBorrowTypeMessageData;
+  [Action.Liquidate]: LiquidateMessageData;
+  [Action.SendToken]: SendTokenMessageData;
+};
+
+// Params
+export type DefaultMessageDataParams = {
+  action:
+    | Action.AcceptInviteAddress
+    | Action.AddDelegate
+    | Action.RemoveDelegate
+    | Action.DepositTsToken
+    | Action.WithdrawTsToken;
+  data: DefaultMessageData;
+  extraArgs: DefaultExtraArgs;
+};
+
+// Params: account
+export type CreateAccountMessageDataParams = {
+  action: Action.CreateAccount;
+  data: CreateAccountMessageData;
+  extraArgs: DefaultExtraArgs;
+};
+
+export type InviteAddressMessageDataParams = {
+  action: Action.InviteAddress;
+  data: InviteAddressMessageData;
+  extraArgs: DefaultExtraArgs;
+};
+
+export type UnregisterAddressMessageDataParams = {
+  action: Action.UnregisterAddress;
+  data: UnregisterAddressMessageData;
+  extraArgs: DefaultExtraArgs;
+};
+
+// Params: loan
+export type CreateLoanMessageDataParams = {
+  action: Action.CreateLoan;
+  data: CreateLoanMessageData;
+  extraArgs: DefaultExtraArgs;
+};
+
+export type DeleteLoanMessageDataParams = {
+  action: Action.DeleteLoan;
+  data: DeleteLoanMessageData;
+  extraArgs: DefaultExtraArgs;
+};
+
+export type CreateLoanAndDepositMessageDataParams = {
+  action: Action.InitiateLoanAccountWithDeposit;
+  data: CreateLoanAndDepositMessageData;
+  extraArgs: DepositExtraArgs;
+};
+
+export type DepositMessageDataParams = {
+  action: Action.Deposit;
+  data: DepositMessageData;
+  extraArgs: DepositExtraArgs;
+};
+
+export type WithdrawMessageDataParams = {
+  action: Action.Withdraw;
+  data: WithdrawMessageData;
+  extraArgs: DefaultExtraArgs;
+};
+
+export type BorrowMessageDataParams = {
+  action: Action.Borrow;
+  data: BorrowMessageData;
+  extraArgs: DefaultExtraArgs;
+};
+
+export type RepayMessageDataParams = {
+  action: Action.Repay;
+  data: RepayMessageData;
+  extraArgs: RepayExtraArgs;
+};
+
+export type RepayWithCollateralMessageDataParams = {
+  action: Action.RepayWithCollateral;
+  data: RepayWithCollateralMessageData;
+  extraArgs: DefaultExtraArgs;
+};
+
+export type SwitchBorrowTypeMessageDataParams = {
+  action: Action.ChangeBorrowMode;
+  data: SwitchBorrowTypeMessageData;
+  extraArgs: DefaultExtraArgs;
+};
+
+export type LiquidateMessageDataParams = {
+  action: Action.Liquidate;
+  data: LiquidateMessageData;
+  extraArgs: DefaultExtraArgs;
+};
+
+export type SendTokenMessageDataParams = {
+  action: Action.SendToken;
+  data: SendTokenMessageData;
+  extraArgs: SendTokenExtraArgs;
+  overrideData: OverrideTokenData;
+};
+
+export type MessageDataParams =
+  | DefaultMessageDataParams
+  | CreateAccountMessageDataParams
+  | InviteAddressMessageDataParams
+  | UnregisterAddressMessageDataParams
+  | CreateLoanMessageDataParams
+  | DeleteLoanMessageDataParams
+  | CreateLoanAndDepositMessageDataParams
+  | DepositMessageDataParams
+  | WithdrawMessageDataParams
+  | BorrowMessageDataParams
+  | RepayMessageDataParams
+  | RepayWithCollateralMessageDataParams
+  | SwitchBorrowTypeMessageDataParams
+  | LiquidateMessageDataParams
+  | SendTokenMessageDataParams;
+
+export type MessageBuilderParams = {
+  userAddress: GenericAddress;
+  accountId: AccountId;
+  adapters: MessageAdapters;
+  sender: GenericAddress;
+  destinationChainId: TSChainId;
+  handler: GenericAddress;
+} & MessageDataParams;

package/src/common/types/module.ts

@@ -0,0 +1,46 @@
+import type {
+  PrepareCreateAccountCall as PrepareCreateAccountEVMCall,
+  PrepareInviteAddressCall as PrepareInviteAddressEVMCall,
+  PrepareAcceptInviteAddressCall as PrepareAcceptInviteAddressEVMCall,
+  PrepareUnregisterAddressCall as PrepareUnregisterAddressEVMCall,
+  PrepareCreateLoanCall as PrepareCreateLoanEVMCall,
+  PrepareDeleteLoanCall as PrepareDeleteLoanEVMCall,
+  PrepareCreateLoanAndDepositCall as PrepareCreateLoanAndDepositEVMCall,
+  PrepareDepositCall as PrepareDepositEVMCall,
+  PrepareWithdrawCall as PrepareWithdrawEVMCall,
+  PrepareCall as PrepareEVMCall,
+  PrepareBorrowCall as PrepareBorrowEVMCall,
+  PrepareRepayCall as PrepareRepayEVMCall,
+  PrepareRepayWithCollateralCall as PrepareRepayWithCollateralEVMCall,
+  PrepareSwitchBorrowTypeCall as PrepareSwitchBorrowTypeEVMCall,
+  PrepareLiquidateCall as PrepareLiquidateEVMCall,
+  PrepareUpdateUserPointsInLoansCall as PrepareUpdateUserPointsInLoansEVMCall,
+  PrepareRetryMessageCall as PrepareRetryMessageEVMCall,
+  PrepareReverseMessageCall as PrepareReverseMessageEVMCall,
+  PrepareResendWormholeMessageCall as PrepareResendWormholeMessageEVMCall,
+} from '../../chains/evm/common/types/module.js';
+
+export type PrepareCall = PrepareEVMCall;
+
+export type PrepareCreateAccountCall = PrepareCreateAccountEVMCall;
+export type PrepareInviteAddressCall = PrepareInviteAddressEVMCall;
+export type PrepareAcceptInviteAddressCall = PrepareAcceptInviteAddressEVMCall;
+export type PrepareUnregisterAddressCall = PrepareUnregisterAddressEVMCall;
+
+export type PrepareCreateLoanCall = PrepareCreateLoanEVMCall;
+export type PrepareDeleteLoanCall = PrepareDeleteLoanEVMCall;
+export type PrepareCreateLoanAndDepositCall =
+  PrepareCreateLoanAndDepositEVMCall;
+export type PrepareDepositCall = PrepareDepositEVMCall;
+export type PrepareWithdrawCall = PrepareWithdrawEVMCall;
+export type PrepareBorrowCall = PrepareBorrowEVMCall;
+export type PrepareRepayCall = PrepareRepayEVMCall;
+export type PrepareRepayWithCollateralCall = PrepareRepayWithCollateralEVMCall;
+export type PrepareSwitchBorrowTypeCall = PrepareSwitchBorrowTypeEVMCall;
+export type PrepareLiquidateCall = PrepareLiquidateEVMCall;
+export type PrepareUpdateUserPointsInLoansCall =
+  PrepareUpdateUserPointsInLoansEVMCall;
+export type PrepareRetryMessageCall = PrepareRetryMessageEVMCall;
+export type PrepareReverseMessageCall = PrepareReverseMessageEVMCall;
+export type PrepareResendWormholeMessageCall =
+  PrepareResendWormholeMessageEVMCall;

package/src/common/types/token.ts

@@ -0,0 +1,72 @@
+import type { GenericAddress } from './address.js';
+import type { AdapterType } from './message.js';
+
+export const MAINNET_TS_TOKEN_ID = {
+  USDC: 'USDC',
+  MON: 'MON',
+  wMON: 'wMON',
+  AZND: 'AZND',
+  muBOND: 'muBOND',
+  AUSD: 'AUSD',
+  // earnAUSD: 'earnAUSD',
+  // IoAZND: 'IoAZND',
+  USD1: 'USD1',
+  WETH: 'WETH',
+  WBTC: 'WBTC',
+  // shMON: 'shMON',
+  // aprMON: 'aprMON',
+  // gMON: 'gMON',
+  // sMON: 'sMON',
+} as const;
+export type MainnetTsTokenId =
+  (typeof MAINNET_TS_TOKEN_ID)[keyof typeof MAINNET_TS_TOKEN_ID];
+
+export type TSTokenId = MainnetTsTokenId;
+
+export enum TokenType {
+  NATIVE = 'NATIVE',
+  ERC20 = 'ERC20',
+  CROSS_CHAIN = 'CROSS_CHAIN',
+}
+
+export type ITokenData = {
+  TsTokenId: TSTokenId;
+};
+
+export type Erc20SpokeTokenType = {
+  type: TokenType.ERC20;
+  address: GenericAddress;
+  decimals: number;
+};
+
+export type Erc20HubTokenType = {
+  type: TokenType.ERC20;
+  decimals: number;
+};
+
+export type CrossChainTokenType = {
+  type: TokenType.CROSS_CHAIN;
+  adapters: Array<AdapterType>;
+  address: GenericAddress;
+  decimals: number;
+};
+
+export type NativeTokenType = {
+  type: TokenType.NATIVE;
+  decimals: number;
+};
+
+export type TsSpokeTokenType =
+  | Erc20SpokeTokenType
+  | CrossChainTokenType
+  | NativeTokenType;
+export type TsHubTokenType =
+  | Erc20HubTokenType
+  | CrossChainTokenType
+  | NativeTokenType;
+
+export type SpokeTokenData = {
+  poolId: number;
+  spokeAddress: GenericAddress;
+  token: TsSpokeTokenType;
+} & ITokenData;