@folks-finance/xchain-sdk 0.0.1

package/src/chains/evm/hub/constants/abi/oracle-manager-abi.ts

@@ -0,0 +1,388 @@
+export const OracleManagerAbi = [
+  {
+    inputs: [
+      { internalType: "address", name: "admin", type: "address" },
+      { internalType: "address", name: "nodeManager", type: "address" },
+    ],
+    stateMutability: "nonpayable",
+    type: "constructor",
+  },
+  { inputs: [], name: "AccessControlBadConfirmation", type: "error" },
+  {
+    inputs: [{ internalType: "uint48", name: "schedule", type: "uint48" }],
+    name: "AccessControlEnforcedDefaultAdminDelay",
+    type: "error",
+  },
+  { inputs: [], name: "AccessControlEnforcedDefaultAdminRules", type: "error" },
+  {
+    inputs: [{ internalType: "address", name: "defaultAdmin", type: "address" }],
+    name: "AccessControlInvalidDefaultAdmin",
+    type: "error",
+  },
+  {
+    inputs: [
+      { internalType: "address", name: "account", type: "address" },
+      { internalType: "bytes32", name: "neededRole", type: "bytes32" },
+    ],
+    name: "AccessControlUnauthorizedAccount",
+    type: "error",
+  },
+  {
+    inputs: [{ internalType: "address", name: "nodeManager", type: "address" }],
+    name: "InvalidNodeManager",
+    type: "error",
+  },
+  {
+    inputs: [{ internalType: "uint8", name: "poolId", type: "uint8" }],
+    name: "NoNodeIdForPool",
+    type: "error",
+  },
+  {
+    inputs: [
+      { internalType: "uint8", name: "bits", type: "uint8" },
+      { internalType: "uint256", name: "value", type: "uint256" },
+    ],
+    name: "SafeCastOverflowedUintDowncast",
+    type: "error",
+  },
+  {
+    anonymous: false,
+    inputs: [],
+    name: "DefaultAdminDelayChangeCanceled",
+    type: "event",
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: false,
+        internalType: "uint48",
+        name: "newDelay",
+        type: "uint48",
+      },
+      {
+        indexed: false,
+        internalType: "uint48",
+        name: "effectSchedule",
+        type: "uint48",
+      },
+    ],
+    name: "DefaultAdminDelayChangeScheduled",
+    type: "event",
+  },
+  {
+    anonymous: false,
+    inputs: [],
+    name: "DefaultAdminTransferCanceled",
+    type: "event",
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: "address",
+        name: "newAdmin",
+        type: "address",
+      },
+      {
+        indexed: false,
+        internalType: "uint48",
+        name: "acceptSchedule",
+        type: "uint48",
+      },
+    ],
+    name: "DefaultAdminTransferScheduled",
+    type: "event",
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: false,
+        internalType: "bytes32",
+        name: "nodeId",
+        type: "bytes32",
+      },
+      { indexed: false, internalType: "uint8", name: "poolId", type: "uint8" },
+    ],
+    name: "NodeIdSetForPool",
+    type: "event",
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: false,
+        internalType: "address",
+        name: "nodeManager",
+        type: "address",
+      },
+    ],
+    name: "NodeManagerSet",
+    type: "event",
+  },
+  {
+    anonymous: false,
+    inputs: [
+      { indexed: true, internalType: "bytes32", name: "role", type: "bytes32" },
+      {
+        indexed: true,
+        internalType: "bytes32",
+        name: "previousAdminRole",
+        type: "bytes32",
+      },
+      {
+        indexed: true,
+        internalType: "bytes32",
+        name: "newAdminRole",
+        type: "bytes32",
+      },
+    ],
+    name: "RoleAdminChanged",
+    type: "event",
+  },
+  {
+    anonymous: false,
+    inputs: [
+      { indexed: true, internalType: "bytes32", name: "role", type: "bytes32" },
+      {
+        indexed: true,
+        internalType: "address",
+        name: "account",
+        type: "address",
+      },
+      {
+        indexed: true,
+        internalType: "address",
+        name: "sender",
+        type: "address",
+      },
+    ],
+    name: "RoleGranted",
+    type: "event",
+  },
+  {
+    anonymous: false,
+    inputs: [
+      { indexed: true, internalType: "bytes32", name: "role", type: "bytes32" },
+      {
+        indexed: true,
+        internalType: "address",
+        name: "account",
+        type: "address",
+      },
+      {
+        indexed: true,
+        internalType: "address",
+        name: "sender",
+        type: "address",
+      },
+    ],
+    name: "RoleRevoked",
+    type: "event",
+  },
+  {
+    inputs: [],
+    name: "DEFAULT_ADMIN_ROLE",
+    outputs: [{ internalType: "bytes32", name: "", type: "bytes32" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "MANAGER_ROLE",
+    outputs: [{ internalType: "bytes32", name: "", type: "bytes32" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "acceptDefaultAdminTransfer",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [{ internalType: "address", name: "newAdmin", type: "address" }],
+    name: "beginDefaultAdminTransfer",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "cancelDefaultAdminTransfer",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [{ internalType: "uint48", name: "newDelay", type: "uint48" }],
+    name: "changeDefaultAdminDelay",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "defaultAdmin",
+    outputs: [{ internalType: "address", name: "", type: "address" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "defaultAdminDelay",
+    outputs: [{ internalType: "uint48", name: "", type: "uint48" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "defaultAdminDelayIncreaseWait",
+    outputs: [{ internalType: "uint48", name: "", type: "uint48" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "getNodeManager",
+    outputs: [{ internalType: "address", name: "", type: "address" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [{ internalType: "bytes32", name: "role", type: "bytes32" }],
+    name: "getRoleAdmin",
+    outputs: [{ internalType: "bytes32", name: "", type: "bytes32" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [
+      { internalType: "bytes32", name: "role", type: "bytes32" },
+      { internalType: "address", name: "account", type: "address" },
+    ],
+    name: "grantRole",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [
+      { internalType: "bytes32", name: "role", type: "bytes32" },
+      { internalType: "address", name: "account", type: "address" },
+    ],
+    name: "hasRole",
+    outputs: [{ internalType: "bool", name: "", type: "bool" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "owner",
+    outputs: [{ internalType: "address", name: "", type: "address" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "pendingDefaultAdmin",
+    outputs: [
+      { internalType: "address", name: "newAdmin", type: "address" },
+      { internalType: "uint48", name: "schedule", type: "uint48" },
+    ],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "pendingDefaultAdminDelay",
+    outputs: [
+      { internalType: "uint48", name: "newDelay", type: "uint48" },
+      { internalType: "uint48", name: "schedule", type: "uint48" },
+    ],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [{ internalType: "uint8", name: "poolId", type: "uint8" }],
+    name: "poolIdToNode",
+    outputs: [
+      { internalType: "bytes32", name: "nodeId", type: "bytes32" },
+      { internalType: "uint8", name: "decimals", type: "uint8" },
+    ],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [{ internalType: "uint8", name: "poolId", type: "uint8" }],
+    name: "processPriceFeed",
+    outputs: [
+      {
+        components: [
+          { internalType: "uint256", name: "price", type: "uint256" },
+          { internalType: "uint8", name: "decimals", type: "uint8" },
+        ],
+        internalType: "struct DataTypes.PriceFeed",
+        name: "priceFeed",
+        type: "tuple",
+      },
+    ],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [
+      { internalType: "bytes32", name: "role", type: "bytes32" },
+      { internalType: "address", name: "account", type: "address" },
+    ],
+    name: "renounceRole",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [
+      { internalType: "bytes32", name: "role", type: "bytes32" },
+      { internalType: "address", name: "account", type: "address" },
+    ],
+    name: "revokeRole",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "rollbackDefaultAdminDelay",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [
+      { internalType: "uint8", name: "poolId", type: "uint8" },
+      { internalType: "bytes32", name: "nodeId", type: "bytes32" },
+      { internalType: "uint8", name: "decimals", type: "uint8" },
+    ],
+    name: "setNodeId",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [{ internalType: "address", name: "nodeManager", type: "address" }],
+    name: "setNodeManager",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [{ internalType: "bytes4", name: "interfaceId", type: "bytes4" }],
+    name: "supportsInterface",
+    outputs: [{ internalType: "bool", name: "", type: "bool" }],
+    stateMutability: "view",
+    type: "function",
+  },
+] as const;

package/src/chains/evm/hub/constants/chain.ts

@@ -0,0 +1,130 @@
+import { FOLKS_CHAIN_ID } from "../../../../common/constants/chain.js";
+import { TESTNET_POOLS } from "../../../../common/constants/pool.js";
+import { NetworkType, ChainType } from "../../../../common/types/chain.js";
+import { AdapterType } from "../../../../common/types/message.js";
+import { LoanTypeId } from "../../../../common/types/module.js";
+import { FolksTokenId, TokenType } from "../../../../common/types/token.js";
+import { convertToGenericAddress } from "../../../../common/utils/address.js";
+
+import type { EvmAddress, GenericAddress } from "../../../../common/types/address.js";
+import type { FolksChainId } from "../../../../common/types/chain.js";
+import type { HubChain } from "../types/chain.js";
+
+export const HUB_CHAIN: Record<NetworkType, HubChain> = {
+  [NetworkType.MAINNET]: {
+    folksChainId: 0 as FolksChainId,
+    hubAddress: "0x" as GenericAddress,
+    bridgeRouterAddress: "0x" as GenericAddress,
+    adapters: {
+      [AdapterType.HUB]: "0x" as GenericAddress,
+      [AdapterType.WORMHOLE_DATA]: "0x" as GenericAddress,
+      [AdapterType.WORMHOLE_CCTP]: "0x" as GenericAddress,
+      [AdapterType.CCIP_DATA]: "0x" as GenericAddress,
+      [AdapterType.CCIP_TOKEN]: "0x" as GenericAddress,
+    },
+    oracleManagerAddress: "0x" as GenericAddress,
+    spokeManagerAddress: "0x" as GenericAddress,
+    accountManagerAddress: "0x" as GenericAddress,
+    loanManagerAddress: "0x" as GenericAddress,
+    tokens: {},
+  },
+  [NetworkType.TESTNET]: {
+    folksChainId: FOLKS_CHAIN_ID.AVALANCHE_FUJI,
+    hubAddress: convertToGenericAddress("0xaE4C62510F4d930a5C8796dbfB8C4Bc7b9B62140" as EvmAddress, ChainType.EVM),
+    bridgeRouterAddress: convertToGenericAddress(
+      "0xa9491a1f4f058832e5742b76eE3f1F1fD7bb6837" as EvmAddress,
+      ChainType.EVM,
+    ),
+    adapters: {
+      [AdapterType.HUB]: convertToGenericAddress(
+        "0xf472ab58969709De9FfEFaeFFd24F9e90cf8DbF9" as EvmAddress,
+        ChainType.EVM,
+      ),
+      [AdapterType.WORMHOLE_DATA]: convertToGenericAddress(
+        "0x8F27355662D6de024FEE83b176dD8DB1F2CA1585" as EvmAddress,
+        ChainType.EVM,
+      ),
+      [AdapterType.WORMHOLE_CCTP]: convertToGenericAddress(
+        "0x8a81dbF6D6b6A8693181de7ad6Ff7F4c47a5B8bd" as EvmAddress,
+        ChainType.EVM,
+      ),
+      [AdapterType.CCIP_DATA]: convertToGenericAddress(
+        "0xE7F80b606614989209f2c36F6074bAfDe1565A19" as EvmAddress,
+        ChainType.EVM,
+      ),
+      [AdapterType.CCIP_TOKEN]: convertToGenericAddress(
+        "0x006A9A176662920306074bB00B57f5CA836e4200" as EvmAddress,
+        ChainType.EVM,
+      ),
+    },
+    oracleManagerAddress: convertToGenericAddress(
+      "0x46c425F4Ec43b25B6222bcc05De051e6D3845165" as EvmAddress,
+      ChainType.EVM,
+    ),
+    spokeManagerAddress: convertToGenericAddress(
+      "0xA5b9525a0A46d4D4bf6f588f565f0d15AffDB81d" as EvmAddress,
+      ChainType.EVM,
+    ),
+    accountManagerAddress: convertToGenericAddress(
+      "0x3324B5BF2b5C85999C6DAf2f77b5a29aB74197cc" as EvmAddress,
+      ChainType.EVM,
+    ),
+    loanManagerAddress: convertToGenericAddress(
+      "0x2cAa1315bd676FbecABFC3195000c642f503f1C9" as EvmAddress,
+      ChainType.EVM,
+    ),
+    tokens: {
+      [FolksTokenId.USDC]: {
+        token: {
+          type: TokenType.CIRCLE,
+          address: convertToGenericAddress("0x5425890298aed601595a70ab815c96711a31bc65" as EvmAddress, ChainType.EVM),
+          decimals: 6,
+        },
+        folksTokenId: FolksTokenId.USDC,
+        poolId: TESTNET_POOLS[FolksTokenId.USDC],
+        poolAddress: convertToGenericAddress("0x1968237f3a7D256D08BcAb212D7ae28fEda72c34" as EvmAddress, ChainType.EVM),
+        supportedLoanTypes: new Set([LoanTypeId.DEPOSIT, LoanTypeId.GENERAL]),
+      },
+      [FolksTokenId.AVAX]: {
+        token: {
+          type: TokenType.NATIVE,
+          decimals: 18,
+        },
+        folksTokenId: FolksTokenId.AVAX,
+        poolId: TESTNET_POOLS[FolksTokenId.AVAX],
+        poolAddress: convertToGenericAddress("0xd90B7614551E799Cdef87463143eCe2efd4054f9" as EvmAddress, ChainType.EVM),
+        supportedLoanTypes: new Set([LoanTypeId.DEPOSIT, LoanTypeId.GENERAL]),
+      },
+      [FolksTokenId.ETH_eth_sep]: {
+        token: {
+          type: TokenType.NATIVE,
+          decimals: 18,
+        },
+        folksTokenId: FolksTokenId.ETH_eth_sep,
+        poolId: TESTNET_POOLS[FolksTokenId.ETH_eth_sep],
+        poolAddress: convertToGenericAddress("0xecD328082035146d99fd621E809Bc9642cDd0BAd" as EvmAddress, ChainType.EVM),
+        supportedLoanTypes: new Set([LoanTypeId.DEPOSIT, LoanTypeId.GENERAL]),
+      },
+      [FolksTokenId.ETH_base_sep]: {
+        token: {
+          type: TokenType.NATIVE,
+          decimals: 18,
+        },
+        folksTokenId: FolksTokenId.ETH_base_sep,
+        poolId: TESTNET_POOLS[FolksTokenId.ETH_base_sep],
+        poolAddress: convertToGenericAddress("0x9E7dfcDFA94C007e868917ec3088107De0B8Dff8" as EvmAddress, ChainType.EVM),
+        supportedLoanTypes: new Set([LoanTypeId.DEPOSIT, LoanTypeId.GENERAL]),
+      },
+      [FolksTokenId.LINK_eth_sep]: {
+        token: {
+          type: TokenType.ERC20,
+          decimals: 18,
+        },
+        folksTokenId: FolksTokenId.LINK_eth_sep,
+        poolId: TESTNET_POOLS[FolksTokenId.LINK_eth_sep],
+        poolAddress: convertToGenericAddress("0xf66A38192A953fe22dCA4229d9429219aaeB09d8" as EvmAddress, ChainType.EVM),
+        supportedLoanTypes: new Set([LoanTypeId.DEPOSIT, LoanTypeId.GENERAL]),
+      },
+    },
+  },
+};

package/src/chains/evm/hub/modules/folks-hub-account.ts

@@ -0,0 +1,137 @@
+import { multicall } from "viem/actions";
+
+import { getFolksChainIdsByNetwork } from "../../../../common/utils/chain.js";
+import { defaultEventParams } from "../../common/constants/contract.js";
+import { extractRevertErrorName } from "../../common/utils/contract.js";
+import { getHubChain } from "../utils/chain.js";
+import { getAccountManagerContract } from "../utils/contract.js";
+import { fetchInvitationByAddress } from "../utils/events.js";
+
+import type { GenericAddress } from "../../../../common/types/address.js";
+import type { FolksChainId, NetworkType } from "../../../../common/types/chain.js";
+import type { AccountId } from "../../../../common/types/lending.js";
+import type { AccountIdByAddress, AccountInfo } from "../types/account.js";
+import type { Client } from "viem";
+
+export async function getAccountInfo(
+  provider: Client,
+  network: NetworkType,
+  accountId: AccountId,
+  folksChainIds?: Array<FolksChainId>,
+): Promise<AccountInfo> {
+  const hubChain = getHubChain(network);
+  const accountManager = getAccountManagerContract(provider, hubChain.accountManagerAddress);
+
+  // get chain ids to check
+  folksChainIds = folksChainIds ? folksChainIds : getFolksChainIdsByNetwork(network);
+
+  // define return variable
+  const accountInfo: AccountInfo = {
+    registered: new Map<FolksChainId, GenericAddress>(),
+    invited: new Map<FolksChainId, GenericAddress>(),
+  };
+
+  // query for registered and invited addresses on each respective chain
+  const registeredAddresses = await multicall(provider, {
+    contracts: folksChainIds.map((folksChainId) => ({
+      address: accountManager.address,
+      abi: accountManager.abi,
+      functionName: "getAddressRegisteredToAccountOnChain",
+      args: [accountId, folksChainId],
+    })),
+    allowFailure: true,
+  });
+
+  const invitedAddresses = await multicall(provider, {
+    contracts: folksChainIds.map((folksChainId) => ({
+      address: accountManager.address,
+      abi: accountManager.abi,
+      functionName: "getAddressInvitedToAccountOnChain",
+      args: [accountId, folksChainId],
+    })),
+    allowFailure: true,
+  });
+
+  for (const [index, result] of registeredAddresses.entries()) {
+    const chainId = folksChainIds[index];
+    if (result.status === "success") accountInfo.registered.set(chainId, result.result as GenericAddress);
+  }
+  for (const [index, result] of invitedAddresses.entries()) {
+    const chainId = folksChainIds[index];
+    if (result.status === "success") accountInfo.invited.set(chainId, result.result as GenericAddress);
+  }
+
+  return accountInfo;
+}
+
+export async function getAccountIdByAddress(
+  provider: Client,
+  network: NetworkType,
+  address: GenericAddress,
+  folksChainIds?: Array<FolksChainId>,
+): Promise<AccountIdByAddress> {
+  const hubChain = getHubChain(network);
+  const accountManager = getAccountManagerContract(provider, hubChain.accountManagerAddress);
+
+  // get chain ids to check
+  folksChainIds = folksChainIds ? folksChainIds : getFolksChainIdsByNetwork(network);
+
+  const accountIds = await multicall(provider, {
+    contracts: folksChainIds.map((folksChainId) => ({
+      address: accountManager.address,
+      abi: accountManager.abi,
+      functionName: "getAccountIdOfAddressOnChain",
+      args: [address, folksChainId],
+    })),
+    allowFailure: true,
+  });
+
+  const accountIdByAddress: AccountIdByAddress = [];
+
+  for (const [index, result] of accountIds.entries()) {
+    const folksChainId = folksChainIds[index];
+    if (result.status === "success")
+      accountIdByAddress.push({
+        accountId: result.result as AccountId,
+        folksChainId,
+      });
+  }
+
+  return accountIdByAddress;
+}
+
+export async function getAccountIdByAddressOnChain(
+  provider: Client,
+  network: NetworkType,
+  address: GenericAddress,
+  folksChainId: FolksChainId,
+): Promise<AccountId | null> {
+  const hubChain = getHubChain(network);
+  const accountManager = getAccountManagerContract(provider, hubChain.accountManagerAddress);
+
+  try {
+    const accountId = await accountManager.read.getAccountIdOfAddressOnChain([address, folksChainId]);
+    return accountId as AccountId;
+  } catch (err: unknown) {
+    const errorName = extractRevertErrorName(err);
+    if (errorName === "NoAccountRegisteredTo") return null;
+    throw err;
+  }
+}
+
+export async function getInvitationByAddress(
+  provider: Client,
+  network: NetworkType,
+  address: GenericAddress,
+  folksChainId?: FolksChainId,
+) {
+  const hubChain = getHubChain(network);
+  const accountManager = getAccountManagerContract(provider, hubChain.accountManagerAddress);
+
+  return fetchInvitationByAddress({
+    accountManager,
+    address,
+    folksChainId,
+    eventParams: defaultEventParams,
+  });
+}