@folks-finance/xchain-sdk 0.0.21 → 0.0.22

package/README.md

@@ -9,9 +9,29 @@
 
 The official JavaScript SDK for the Folks Finance Cross-Chain Lending Protocol.
 
-## Installation
+## Table of Contents
 
-### Package manager
+- [Getting Started](#getting-started)
+  - [Installation](#installation)
+    - [Package manager](#package-manager)
+  - [SDK Structure and Usage](#sdk-structure-and-usage)
+    - [FolksCore](#folkscore)
+    - [Modules](#modules)
+  - [Basic Usage](#basic-usage)
+  - [React Usage](#react-usage)
+    - [Initializing FolksCore](#initializing-folkscore)
+    - [Synchronizing FolksCore Signer](#synchronizing-folkscore-signer)
+
+## Getting Started
+
+Before diving into the SDK, we recommend familiarizing yourself with the Folks Finance Cross-Chain Lending Protocol:
+
+- Explore our [comprehensive documentation](https://docs.xapp.folks.finance/?utm_source=github&utm_medium=sdk-readme&utm_campaign=xchain-sdk) for in-depth information about the protocol and its features.
+- Access additional resources and materials in our [Google Drive folder](https://drive.google.com/drive/folders/1P-C_V28JlIJNmoUH6pUKVgVpIfZYQYn5?usp=drive_link).
+
+### Installation
+
+#### Package manager
 
 Using npm:
 
@@ -37,6 +57,207 @@ Using bun:
 bun add @folks-finance/xchain-sdk
 ```
 
+### SDK Structure and Usage
+
+The Folks Finance Cross-Chain Lending SDK consists of two main components:
+
+1. `FolksCore`: This acts as the central context for the SDK, managing configuration and state that is shared across all modules.
+2. Various modules: Located in `/src/xchain/modules`, these provide specific functionalities for interacting with different aspects of the Folks Finance protocol.
+
+#### FolksCore
+
+`FolksCore` is responsible for initializing the SDK and maintaining the global context. It handles:
+
+- Network selection (testnet/mainnet)
+- Provider management
+- Signer management
+
+Any changes made to `FolksCore` will affect subsequent calls to the various modules. For example, changing the network or signer will impact how the modules interact with the blockchain.
+
+#### Modules
+
+The SDK includes several modules, each focusing on a specific area of functionality:
+
+- `FolksAccount`: Manages account-related operations, including creating accounts, retrieving account information, and performing management operations such as inviting addresses, accepting invites, and unregistering addresses.
+- `FolksLoan`: Handles all loan-related functions, including retrieving loan information, creating loans, and performing operations such as depositing, withdrawing, repaying, and more.
+- `FolksOracle`: Provides access to updated price information from the oracle.
+- `FolksPool`: Allows retrieval of informations about the pools.
+- `FolksRewards`: Offers access to information about the rewards system.
+- `FolksGmp`: Manages retry and revert functions for failed operations.
+
+These modules use the context provided by `FolksCore` internally, so they always operate based on the current state of `FolksCore`.
+
+### Basic Usage
+
+To start using the Folks Finance Cross-Chain Lending SDK:
+
+1. Import and initialize `FolksCore`:
+
+```ts
+import { FolksCore, NetworkType } from "@folks-finance/xchain-sdk";
+
+const folksConfig = {
+  network: NetworkType.TESTNET, // or NetworkType.MAINNET
+  provider: {
+    evm: {
+      // Add your EVM provider configuration here (optional)
+      // If not provided, default providers will be used
+    },
+  },
+};
+
+FolksCore.init(folksConfig);
+```
+
+Note: The `provider` configuration in `folksConfig` is optional. If not provided, the SDK will use default providers defined in `src/chains/evm/common/utils/provider.ts`.
+
+2. Use the desired modules to interact with the protocol:
+
+```ts
+import {
+  Action,
+  BYTES4_LENGTH,
+  FolksAccount,
+  FolksCore,
+  getRandomBytes,
+  getSupportedMessageAdapters,
+  MessageAdapterParamsType,
+  NetworkType,
+} from "@folks-finance/xchain-sdk";
+import { createWalletClient, http } from "viem";
+import { mnemonicToAccount } from "viem/accounts";
+
+import type { FolksChainId, Nonce } from "@folks-finance/xchain-sdk";
+
+const generateRandomNonce = () => {
+  return getRandomBytes(BYTES4_LENGTH) as Nonce;
+};
+
+const MNEMONIC = "your mnemonic here";
+const account = mnemonicToAccount(MNEMONIC);
+
+// In a real environment you should already have a signer
+const signer = createWalletClient({
+  account,
+  transport: http(),
+});
+
+// Example: Creating an account
+const createAccount = async (sourceFolksChainId: FolksChainId) => {
+  const nonce = generateRandomNonce();
+  const {
+    adapterIds: [adapterId],
+    returnAdapterIds: [returnAdapterId],
+  } = getSupportedMessageAdapters({
+    action: Action.CreateAccount,
+    network: NetworkType.TESTNET,
+    messageAdapterParamType: MessageAdapterParamsType.Data,
+    sourceFolksChainId,
+  });
+  const adapters = { adapterId, returnAdapterId };
+
+  // You must set the correct signer before calling a write method that involves signing a transaction
+  FolksCore.setFolksSigner({
+    signer,
+    folksChainId,
+  });
+
+  const prepareCall = await FolksAccount.prepare.createAccount(nonce, adapters);
+  const hash = await FolksAccount.write.createAccount(nonce, prepareCall);
+
+  console.log("Create account hash:", hash);
+};
+```
+
+Remember that any changes made to `FolksCore` (like changing the network or signer) will affect all subsequent module calls. This design allows for flexible and context-aware interactions with the Folks Finance protocol across different chains and environments.
+
+### React Usage
+
+When using the SDK with React, there are a few additional considerations to ensure proper initialization and synchronization. Here's how to set up and use the SDK in a React environment:
+
+#### Initializing FolksCore
+
+To initialize FolksCore only once in your React application, you can create a custom hook:
+
+```ts
+import { useEffect } from "react";
+import { FolksCore, NetworkType } from "@folks-finance/xchain-sdk";
+
+import type { FolksCoreConfig } from "@folks-finance/xchain-sdk";
+
+export const useInitFolksCore = () => {
+  useEffect(() => {
+    if (FolksCore.isInitialized()) return;
+
+    const folksCoreConfig: FolksCoreConfig = {
+      network: NetworkType.TESTNET,
+      provider,
+    };
+
+    FolksCore.init(folksCoreConfig);
+  }, []);
+};
+```
+
+Use this hook in a component that's common to all pages, such as the root layout in Next.js.
+
+#### Synchronizing FolksCore Signer
+
+To ensure that the correct signer is used for transactions, you need to synchronize the FolksCore signer whenever the chain (and consequently the associated signer) changes on the frontend:
+
+```ts
+import { FOLKS_CHAIN, NetworkType, ChainType } from "@folks-finance/xchain-sdk";
+import { useWalletClient } from "wagmi";
+import { useMemo, useEffect } from "react";
+
+import type { FolksChainId } from "@folks-finance/xchain-sdk";
+
+function assertExhaustive(value: never, message = "Reached unexpected case in exhaustive switch"): never {
+  throw new Error(message);
+}
+
+const AVAILABLE_FOLKS_CHAINS = FOLKS_CHAIN[NetworkType.TESTNET];
+const getFolksChainFromFolksChainId = (folksChainId: FolksChainId) => AVAILABLE_FOLKS_CHAINS[folksChainId];
+
+const useEvmSigner = ({ chainId }: { chainId?: number }) => {
+  const { data: walletClient } = useWalletClient({ chainId });
+  const signer = useMemo(() => walletClient, [walletClient]);
+  return { signer };
+};
+
+export const useSyncFolksCoreSigner = () => {
+  // useFolksChain is a hook that returns the current selected FolksChainId on frontend
+  const { selectedFolksChainId } = useFolksChain();
+
+  const selectedFolksChain = selectedFolksChainId ? getFolksChainFromFolksChainId(selectedFolksChainId) : null;
+
+  const { signer: evmSigner } = useEvmSigner(
+    selectedFolksChain?.chainType === ChainType.EVM ? { chainId: selectedFolksChain.chainId as number } : {},
+  );
+
+  useEffect(() => {
+    if (!selectedFolksChain) return;
+
+    const folksChainId = selectedFolksChain.folksChainId;
+
+    switch (selectedFolksChain.chainType) {
+      case ChainType.EVM: {
+        if (!evmSigner) return;
+        FolksCore.setFolksSigner({
+          signer: evmSigner,
+          folksChainId,
+        });
+        break;
+      }
+      default:
+        assertExhaustive(selectedFolksChain.chainType);
+    }
+  }, [selectedFolksChain, evmSigner]);
+};
+```
+
+Like the initialization hook, `useSyncFolksCoreSigner` should be called in a component shared by all pages.
+
 [license-image]: https://img.shields.io/badge/License-MIT-brightgreen.svg?style=flat-square
 [license-url]: https://opensource.org/licenses/MIT
 [ci-image]: https://img.shields.io/github/actions/workflow/status/Folks-Finance/folks-finance-xchain-js-sdk/lint-and-typecheck.yml?branch=main&logo=github&style=flat-square

package/dist/chains/evm/hub/modules/folks-hub-rewards.d.ts

@@ -4,4 +4,4 @@ import type { LoanTypeId } from "../../../../common/types/module.js";
 import type { LoanTypeInfo } from "../types/loan.js";
 import type { UserRewards } from "../types/rewards.js";
 import type { Client } from "viem";
-export declare function getUserRewards(provider: Client, network: NetworkType, accountId: AccountId, referredAccountIds: Array<AccountId>, allLoanIds: Array<LoanId>, loanTypesInfo: Partial<Record<LoanTypeId, LoanTypeInfo>>): Promise<UserRewards>;
+export declare function getUserRewards(provider: Client, network: NetworkType, accountId: AccountId, loanIds: Array<LoanId>, loanTypesInfo: Partial<Record<LoanTypeId, LoanTypeInfo>>): Promise<UserRewards>;

package/dist/chains/evm/hub/modules/folks-hub-rewards.js

@@ -3,19 +3,7 @@ import { calcAccruedRewards } from "../../../../common/utils/formulae.js";
 import { getHubChain } from "../utils/chain.js";
 import { getLoanManagerContract } from "../utils/contract.js";
 import { getUserLoans } from "./folks-hub-loan.js";
-const emptyAccountRewards = (folksTokenIds) => {
-    const accountRewards = {};
-    for (const folksTokenId of folksTokenIds) {
-        accountRewards[folksTokenId] = { collateral: 0n, borrow: 0n, interestPaid: 0n };
-    }
-    return accountRewards;
-};
-const addToAccountRewards = (existing, add) => {
-    existing.collateral += add.collateral;
-    existing.borrow += add.borrow;
-    existing.interestPaid += add.interestPaid;
-};
-export async function getUserRewards(provider, network, accountId, referredAccountIds, allLoanIds, loanTypesInfo) {
+export async function getUserRewards(provider, network, accountId, loanIds, loanTypesInfo) {
     const hubChain = getHubChain(network);
     const loanManager = getLoanManagerContract(provider, hubChain.loanManagerAddress);
     // derive the tokens/pools you are interested in
@@ -31,41 +19,30 @@ export async function getUserRewards(provider, network, accountId, referredAccou
             }
         }
     }
-    // fetch the accounts rewards which are updated
+    // fetch the account rewards which are updated
     const getUsersPoolRewards = [];
-    for (const aId of [accountId, ...referredAccountIds]) {
-        for (const pId of poolIds) {
-            getUsersPoolRewards.push({
-                address: loanManager.address,
-                abi: loanManager.abi,
-                functionName: "getUserPoolRewards",
-                args: [aId, pId],
-            });
-        }
+    for (const poolId of poolIds) {
+        getUsersPoolRewards.push({
+            address: loanManager.address,
+            abi: loanManager.abi,
+            functionName: "getUserPoolRewards",
+            args: [accountId, poolId],
+        });
     }
-    const accountsPoolRewards = (await multicall(provider, {
+    const accountPoolRewards = (await multicall(provider, {
         contracts: getUsersPoolRewards,
         allowFailure: false,
     }));
-    // initialise the rewards
-    const userRewards = {
-        accountId,
-        rewards: emptyAccountRewards(folksTokenIds),
-        referrals: {},
-    };
-    for (const aId of referredAccountIds)
-        userRewards.referrals[aId] = emptyAccountRewards(folksTokenIds);
-    // add all the rewards which are updated
-    for (const [i, accountPoolReward] of accountsPoolRewards.entries()) {
-        const accountIndex = Math.floor(i / folksTokenIds.length) - 1;
-        const folksTokenId = folksTokenIds[Math.floor(i / folksTokenIds.length)];
-        const accountRewards = accountIndex === -1 ? userRewards.rewards : userRewards.referrals[referredAccountIds[accountIndex]];
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        addToAccountRewards(accountRewards[folksTokenId], accountPoolReward);
+    // initialise with all the rewards which are updated
+    const rewards = {};
+    for (const [i, accountPoolReward] of accountPoolRewards.entries()) {
+        const folksTokenId = folksTokenIds[i];
+        rewards[folksTokenId] = accountPoolReward;
     }
+    const userRewards = { accountId, rewards };
     // add all the rewards which are not updated
-    const userLoans = await getUserLoans(provider, network, allLoanIds);
-    for (const loanId of allLoanIds) {
+    const userLoans = await getUserLoans(provider, network, loanIds);
+    for (const loanId of loanIds) {
         const userLoan = userLoans.get(loanId);
         if (userLoan === undefined)
             throw Error("Unknown user loan");
@@ -73,7 +50,8 @@ export async function getUserRewards(provider, network, accountId, referredAccou
         const loanTypeInfo = loanTypesInfo[loanTypeId];
         if (!loanTypeInfo)
             throw new Error(`Unknown loan type id ${loanTypeId}`);
-        const accountRewards = accountId === userLoanAccountId ? userRewards.rewards : userRewards.referrals[userLoanAccountId];
+        if (accountId !== userLoanAccountId)
+            throw new Error(`Loan ${loanId} belongs to account ${userLoanAccountId}`);
         for (const [i, poolId] of colPools.entries()) {
             // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
             const folksTokenId = seen.get(poolId);
@@ -84,7 +62,7 @@ export async function getUserRewards(provider, network, accountId, referredAccou
             const { collateralRewardIndex } = loanPool.reward;
             const accrued = calcAccruedRewards(balance, collateralRewardIndex, [rewardIndex, 18]);
             // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            accountRewards[folksTokenId].collateral += accrued;
+            userRewards.rewards[folksTokenId].collateral += accrued;
         }
         for (const [i, poolId] of borPools.entries()) {
             // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
@@ -96,7 +74,7 @@ export async function getUserRewards(provider, network, accountId, referredAccou
             const { borrowRewardIndex } = loanPool.reward;
             const accrued = calcAccruedRewards(amount, borrowRewardIndex, [rewardIndex, 18]);
             // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            accountRewards[folksTokenId].borrow += accrued;
+            userRewards.rewards[folksTokenId].collateral += accrued;
         }
     }
     return userRewards;

package/dist/chains/evm/hub/modules/folks-hub-rewards.js.map

@@ -1 +1 @@
-{"version":3,"file":"folks-hub-rewards.js","sourceRoot":"","sources":["../../../../../src/chains/evm/hub/modules/folks-hub-rewards.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,OAAO,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAE9D,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAUnD,MAAM,mBAAmB,GAAG,CAAC,aAAkC,EAAkB,EAAE;IACjF,MAAM,cAAc,GAAmB,EAAE,CAAC;IAC1C,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;QACzC,cAAc,CAAC,YAAY,CAAC,GAAG,EAAE,UAAU,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC;IAClF,CAAC;IACD,OAAO,cAAc,CAAC;AACxB,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,QAA4B,EAAE,GAAuB,EAAE,EAAE;IACpF,QAAQ,CAAC,UAAU,IAAI,GAAG,CAAC,UAAU,CAAC;IACtC,QAAQ,CAAC,MAAM,IAAI,GAAG,CAAC,MAAM,CAAC;IAC9B,QAAQ,CAAC,YAAY,IAAI,GAAG,CAAC,YAAY,CAAC;AAC5C,CAAC,CAAC;AAEF,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,QAAgB,EAChB,OAAoB,EACpB,SAAoB,EACpB,kBAAoC,EACpC,UAAyB,EACzB,aAAwD;IAExD,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;IACtC,MAAM,WAAW,GAAG,sBAAsB,CAAC,QAAQ,EAAE,QAAQ,CAAC,kBAAkB,CAAC,CAAC;IAElF,gDAAgD;IAChD,MAAM,IAAI,GAAG,IAAI,GAAG,EAAwB,CAAC;IAC7C,MAAM,OAAO,GAAkB,EAAE,CAAC;IAClC,MAAM,aAAa,GAAwB,EAAE,CAAC;IAC9C,KAAK,MAAM,EAAE,KAAK,EAAE,IAAI,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;QACrD,KAAK,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5D,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;gBACtB,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBACrB,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;gBACjC,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;YACjC,CAAC;QACH,CAAC;IACH,CAAC;IAED,+CAA+C;IAC/C,MAAM,mBAAmB,GAAsC,EAAE,CAAC;IAClE,KAAK,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,GAAG,kBAAkB,CAAC,EAAE,CAAC;QACrD,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;YAC1B,mBAAmB,CAAC,IAAI,CAAC;gBACvB,OAAO,EAAE,WAAW,CAAC,OAAO;gBAC5B,GAAG,EAAE,WAAW,CAAC,GAAG;gBACpB,YAAY,EAAE,oBAAoB;gBAClC,IAAI,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;aACjB,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,MAAM,mBAAmB,GAA8B,CAAC,MAAM,SAAS,CAAC,QAAQ,EAAE;QAChF,SAAS,EAAE,mBAAmB;QAC9B,YAAY,EAAE,KAAK;KACpB,CAAC,CAA8B,CAAC;IAEjC,yBAAyB;IACzB,MAAM,WAAW,GAAgB;QAC/B,SAAS;QACT,OAAO,EAAE,mBAAmB,CAAC,aAAa,CAAC;QAC3C,SAAS,EAAE,EAAE;KACd,CAAC;IACF,KAAK,MAAM,GAAG,IAAI,kBAAkB;QAAE,WAAW,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,mBAAmB,CAAC,aAAa,CAAC,CAAC;IAEtG,wCAAwC;IACxC,KAAK,MAAM,CAAC,CAAC,EAAE,iBAAiB,CAAC,IAAI,mBAAmB,CAAC,OAAO,EAAE,EAAE,CAAC;QACnE,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC9D,MAAM,YAAY,GAAG,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;QACzE,MAAM,cAAc,GAClB,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC,CAAC;QACtG,oEAAoE;QACpE,mBAAmB,CAAC,cAAc,CAAC,YAAY,CAAE,EAAE,iBAAiB,CAAC,CAAC;IACxE,CAAC;IAED,4CAA4C;IAC5C,MAAM,SAAS,GAAG,MAAM,YAAY,CAAC,QAAQ,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;IACpE,KAAK,MAAM,MAAM,IAAI,UAAU,EAAE,CAAC;QAChC,MAAM,QAAQ,GAAG,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACvC,IAAI,QAAQ,KAAK,SAAS;YAAE,MAAM,KAAK,CAAC,mBAAmB,CAAC,CAAC;QAE7D,MAAM,EACJ,SAAS,EAAE,iBAAiB,EAC5B,UAAU,EACV,QAAQ,EACR,QAAQ,EACR,kBAAkB,EAClB,cAAc,GACf,GAAG,QAAQ,CAAC;QAEb,MAAM,YAAY,GAAG,aAAa,CAAC,UAAU,CAAC,CAAC;QAC/C,IAAI,CAAC,YAAY;YAAE,MAAM,IAAI,KAAK,CAAC,wBAAwB,UAAU,EAAE,CAAC,CAAC;QAEzE,MAAM,cAAc,GAClB,SAAS,KAAK,iBAAiB,CAAC,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;QACnG,KAAK,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,IAAI,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC;YAC7C,oEAAoE;YACpE,MAAM,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAE,CAAC;YACvC,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAC;YAEvD,MAAM,QAAQ,GAAG,YAAY,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YAClD,IAAI,CAAC,QAAQ;gBAAE,MAAM,IAAI,KAAK,CAAC,+BAA+B,YAAY,EAAE,CAAC,CAAC;YAC9E,MAAM,EAAE,qBAAqB,EAAE,GAAG,QAAQ,CAAC,MAAM,CAAC;YAElD,MAAM,OAAO,GAAG,kBAAkB,CAAC,OAAO,EAAE,qBAAqB,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC;YAEtF,oEAAoE;YACpE,cAAc,CAAC,YAAY,CAAE,CAAC,UAAU,IAAI,OAAO,CAAC;QACtD,CAAC;QACD,KAAK,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,IAAI,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC;YAC7C,oEAAoE;YACpE,MAAM,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAE,CAAC;YACvC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;YAElD,MAAM,QAAQ,GAAG,YAAY,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YAClD,IAAI,CAAC,QAAQ;gBAAE,MAAM,IAAI,KAAK,CAAC,+BAA+B,YAAY,EAAE,CAAC,CAAC;YAC9E,MAAM,EAAE,iBAAiB,EAAE,GAAG,QAAQ,CAAC,MAAM,CAAC;YAE9C,MAAM,OAAO,GAAG,kBAAkB,CAAC,MAAM,EAAE,iBAAiB,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC;YACjF,oEAAoE;YACpE,cAAc,CAAC,YAAY,CAAE,CAAC,MAAM,IAAI,OAAO,CAAC;QAClD,CAAC;IACH,CAAC;IAED,OAAO,WAAW,CAAC;AACrB,CAAC"}
+{"version":3,"file":"folks-hub-rewards.js","sourceRoot":"","sources":["../../../../../src/chains/evm/hub/modules/folks-hub-rewards.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,OAAO,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAE9D,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAUnD,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,QAAgB,EAChB,OAAoB,EACpB,SAAoB,EACpB,OAAsB,EACtB,aAAwD;IAExD,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;IACtC,MAAM,WAAW,GAAG,sBAAsB,CAAC,QAAQ,EAAE,QAAQ,CAAC,kBAAkB,CAAC,CAAC;IAElF,gDAAgD;IAChD,MAAM,IAAI,GAAG,IAAI,GAAG,EAAwB,CAAC;IAC7C,MAAM,OAAO,GAAkB,EAAE,CAAC;IAClC,MAAM,aAAa,GAAwB,EAAE,CAAC;IAC9C,KAAK,MAAM,EAAE,KAAK,EAAE,IAAI,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;QACrD,KAAK,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5D,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;gBACtB,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBACrB,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;gBACjC,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;YACjC,CAAC;QACH,CAAC;IACH,CAAC;IAED,8CAA8C;IAC9C,MAAM,mBAAmB,GAAsC,EAAE,CAAC;IAClE,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,mBAAmB,CAAC,IAAI,CAAC;YACvB,OAAO,EAAE,WAAW,CAAC,OAAO;YAC5B,GAAG,EAAE,WAAW,CAAC,GAAG;YACpB,YAAY,EAAE,oBAAoB;YAClC,IAAI,EAAE,CAAC,SAAS,EAAE,MAAM,CAAC;SAC1B,CAAC,CAAC;IACL,CAAC;IAED,MAAM,kBAAkB,GAA8B,CAAC,MAAM,SAAS,CAAC,QAAQ,EAAE;QAC/E,SAAS,EAAE,mBAAmB;QAC9B,YAAY,EAAE,KAAK;KACpB,CAAC,CAA8B,CAAC;IAEjC,oDAAoD;IACpD,MAAM,OAAO,GAAsD,EAAE,CAAC;IACtE,KAAK,MAAM,CAAC,CAAC,EAAE,iBAAiB,CAAC,IAAI,kBAAkB,CAAC,OAAO,EAAE,EAAE,CAAC;QAClE,MAAM,YAAY,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;QACtC,OAAO,CAAC,YAAY,CAAC,GAAG,iBAAiB,CAAC;IAC5C,CAAC;IACD,MAAM,WAAW,GAAgB,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC;IAExD,4CAA4C;IAC5C,MAAM,SAAS,GAAG,MAAM,YAAY,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IACjE,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,MAAM,QAAQ,GAAG,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACvC,IAAI,QAAQ,KAAK,SAAS;YAAE,MAAM,KAAK,CAAC,mBAAmB,CAAC,CAAC;QAE7D,MAAM,EACJ,SAAS,EAAE,iBAAiB,EAC5B,UAAU,EACV,QAAQ,EACR,QAAQ,EACR,kBAAkB,EAClB,cAAc,GACf,GAAG,QAAQ,CAAC;QAEb,MAAM,YAAY,GAAG,aAAa,CAAC,UAAU,CAAC,CAAC;QAC/C,IAAI,CAAC,YAAY;YAAE,MAAM,IAAI,KAAK,CAAC,wBAAwB,UAAU,EAAE,CAAC,CAAC;QACzE,IAAI,SAAS,KAAK,iBAAiB;YAAE,MAAM,IAAI,KAAK,CAAC,QAAQ,MAAM,uBAAuB,iBAAiB,EAAE,CAAC,CAAC;QAE/G,KAAK,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,IAAI,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC;YAC7C,oEAAoE;YACpE,MAAM,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAE,CAAC;YACvC,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAC;YAEvD,MAAM,QAAQ,GAAG,YAAY,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YAClD,IAAI,CAAC,QAAQ;gBAAE,MAAM,IAAI,KAAK,CAAC,+BAA+B,YAAY,EAAE,CAAC,CAAC;YAC9E,MAAM,EAAE,qBAAqB,EAAE,GAAG,QAAQ,CAAC,MAAM,CAAC;YAElD,MAAM,OAAO,GAAG,kBAAkB,CAAC,OAAO,EAAE,qBAAqB,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC;YACtF,oEAAoE;YACpE,WAAW,CAAC,OAAO,CAAC,YAAY,CAAE,CAAC,UAAU,IAAI,OAAO,CAAC;QAC3D,CAAC;QAED,KAAK,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,IAAI,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC;YAC7C,oEAAoE;YACpE,MAAM,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAE,CAAC;YACvC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;YAElD,MAAM,QAAQ,GAAG,YAAY,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YAClD,IAAI,CAAC,QAAQ;gBAAE,MAAM,IAAI,KAAK,CAAC,+BAA+B,YAAY,EAAE,CAAC,CAAC;YAC9E,MAAM,EAAE,iBAAiB,EAAE,GAAG,QAAQ,CAAC,MAAM,CAAC;YAE9C,MAAM,OAAO,GAAG,kBAAkB,CAAC,MAAM,EAAE,iBAAiB,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC;YACjF,oEAAoE;YACpE,WAAW,CAAC,OAAO,CAAC,YAAY,CAAE,CAAC,UAAU,IAAI,OAAO,CAAC;QAC3D,CAAC;IACH,CAAC;IAED,OAAO,WAAW,CAAC;AACrB,CAAC"}

package/dist/chains/evm/hub/types/rewards.d.ts

@@ -9,5 +9,4 @@ export type AccountRewards = Partial<Record<FolksTokenId, AccountPoolRewards>>;
 export type UserRewards = {
     accountId: AccountId;
     rewards: AccountRewards;
-    referrals: Record<AccountId, AccountRewards>;
 };

package/dist/xchain/modules/folks-rewards.d.ts

@@ -3,5 +3,5 @@ import type { UserRewards } from "../../chains/evm/hub/types/rewards.js";
 import type { AccountId, LoanId } from "../../common/types/lending.js";
 import type { LoanTypeId } from "../../common/types/module.js";
 export declare const read: {
-    rewards(accountId: AccountId, referredAccountIds: Array<AccountId>, allLoanIds: Array<LoanId>, loanTypesInfo: Partial<Record<LoanTypeId, LoanTypeInfo>>): Promise<UserRewards>;
+    rewards(accountId: AccountId, loanIds: Array<LoanId>, loanTypesInfo: Partial<Record<LoanTypeId, LoanTypeInfo>>): Promise<UserRewards>;
 };

package/dist/xchain/modules/folks-rewards.js

@@ -1,8 +1,8 @@
 import { FolksHubRewards } from "../../chains/evm/hub/modules/index.js";
 import { FolksCore } from "../core/folks-core.js";
 export const read = {
-    async rewards(accountId, referredAccountIds, allLoanIds, loanTypesInfo) {
-        return FolksHubRewards.getUserRewards(FolksCore.getHubProvider(), FolksCore.getSelectedNetwork(), accountId, referredAccountIds, allLoanIds, loanTypesInfo);
+    async rewards(accountId, loanIds, loanTypesInfo) {
+        return FolksHubRewards.getUserRewards(FolksCore.getHubProvider(), FolksCore.getSelectedNetwork(), accountId, loanIds, loanTypesInfo);
     },
 };
 //# sourceMappingURL=folks-rewards.js.map

package/dist/xchain/modules/folks-rewards.js.map

@@ -1 +1 @@
-{"version":3,"file":"folks-rewards.js","sourceRoot":"","sources":["../../../src/xchain/modules/folks-rewards.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AACxE,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAOlD,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,KAAK,CAAC,OAAO,CACX,SAAoB,EACpB,kBAAoC,EACpC,UAAyB,EACzB,aAAwD;QAExD,OAAO,eAAe,CAAC,cAAc,CACnC,SAAS,CAAC,cAAc,EAAE,EAC1B,SAAS,CAAC,kBAAkB,EAAE,EAC9B,SAAS,EACT,kBAAkB,EAClB,UAAU,EACV,aAAa,CACd,CAAC;IACJ,CAAC;CACF,CAAC"}
+{"version":3,"file":"folks-rewards.js","sourceRoot":"","sources":["../../../src/xchain/modules/folks-rewards.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AACxE,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAOlD,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,KAAK,CAAC,OAAO,CACX,SAAoB,EACpB,OAAsB,EACtB,aAAwD;QAExD,OAAO,eAAe,CAAC,cAAc,CACnC,SAAS,CAAC,cAAc,EAAE,EAC1B,SAAS,CAAC,kBAAkB,EAAE,EAC9B,SAAS,EACT,OAAO,EACP,aAAa,CACd,CAAC;IACJ,CAAC;CACF,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@folks-finance/xchain-sdk",
   "description": "The official JavaScript SDK for the Folks Finance Cross-Chain Lending Protocol",
-  "version": "0.0.21",
+  "version": "0.0.22",
   "license": "MIT",
   "publishConfig": {
     "access": "public"

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

@@ -11,29 +11,14 @@ import type { AccountId, LoanId } from "../../../../common/types/lending.js";
 import type { LoanTypeId } from "../../../../common/types/module.js";
 import type { FolksTokenId } from "../../../../common/types/token.js";
 import type { LoanTypeInfo } from "../types/loan.js";
-import type { AccountPoolRewards, AccountRewards, UserRewards } from "../types/rewards.js";
+import type { AccountPoolRewards, UserRewards } from "../types/rewards.js";
 import type { Client, ContractFunctionParameters } from "viem";
 
-const emptyAccountRewards = (folksTokenIds: Array<FolksTokenId>): AccountRewards => {
-  const accountRewards: AccountRewards = {};
-  for (const folksTokenId of folksTokenIds) {
-    accountRewards[folksTokenId] = { collateral: 0n, borrow: 0n, interestPaid: 0n };
-  }
-  return accountRewards;
-};
-
-const addToAccountRewards = (existing: AccountPoolRewards, add: AccountPoolRewards) => {
-  existing.collateral += add.collateral;
-  existing.borrow += add.borrow;
-  existing.interestPaid += add.interestPaid;
-};
-
 export async function getUserRewards(
   provider: Client,
   network: NetworkType,
   accountId: AccountId,
-  referredAccountIds: Array<AccountId>,
-  allLoanIds: Array<LoanId>,
+  loanIds: Array<LoanId>,
   loanTypesInfo: Partial<Record<LoanTypeId, LoanTypeInfo>>,
 ): Promise<UserRewards> {
   const hubChain = getHubChain(network);
@@ -53,45 +38,33 @@ export async function getUserRewards(
     }
   }
 
-  // fetch the accounts rewards which are updated
+  // fetch the account rewards which are updated
   const getUsersPoolRewards: Array<ContractFunctionParameters> = [];
-  for (const aId of [accountId, ...referredAccountIds]) {
-    for (const pId of poolIds) {
-      getUsersPoolRewards.push({
-        address: loanManager.address,
-        abi: loanManager.abi,
-        functionName: "getUserPoolRewards",
-        args: [aId, pId],
-      });
-    }
+  for (const poolId of poolIds) {
+    getUsersPoolRewards.push({
+      address: loanManager.address,
+      abi: loanManager.abi,
+      functionName: "getUserPoolRewards",
+      args: [accountId, poolId],
+    });
   }
 
-  const accountsPoolRewards: Array<AccountPoolRewards> = (await multicall(provider, {
+  const accountPoolRewards: Array<AccountPoolRewards> = (await multicall(provider, {
     contracts: getUsersPoolRewards,
     allowFailure: false,
   })) as Array<AccountPoolRewards>;
 
-  // initialise the rewards
-  const userRewards: UserRewards = {
-    accountId,
-    rewards: emptyAccountRewards(folksTokenIds),
-    referrals: {},
-  };
-  for (const aId of referredAccountIds) userRewards.referrals[aId] = emptyAccountRewards(folksTokenIds);
-
-  // add all the rewards which are updated
-  for (const [i, accountPoolReward] of accountsPoolRewards.entries()) {
-    const accountIndex = Math.floor(i / folksTokenIds.length) - 1;
-    const folksTokenId = folksTokenIds[Math.floor(i / folksTokenIds.length)];
-    const accountRewards =
-      accountIndex === -1 ? userRewards.rewards : userRewards.referrals[referredAccountIds[accountIndex]];
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-    addToAccountRewards(accountRewards[folksTokenId]!, accountPoolReward);
+  // initialise with all the rewards which are updated
+  const rewards: Partial<Record<FolksTokenId, AccountPoolRewards>> = {};
+  for (const [i, accountPoolReward] of accountPoolRewards.entries()) {
+    const folksTokenId = folksTokenIds[i];
+    rewards[folksTokenId] = accountPoolReward;
   }
+  const userRewards: UserRewards = { accountId, rewards };
 
   // add all the rewards which are not updated
-  const userLoans = await getUserLoans(provider, network, allLoanIds);
-  for (const loanId of allLoanIds) {
+  const userLoans = await getUserLoans(provider, network, loanIds);
+  for (const loanId of loanIds) {
     const userLoan = userLoans.get(loanId);
     if (userLoan === undefined) throw Error("Unknown user loan");
 
@@ -106,9 +79,8 @@ export async function getUserRewards(
 
     const loanTypeInfo = loanTypesInfo[loanTypeId];
     if (!loanTypeInfo) throw new Error(`Unknown loan type id ${loanTypeId}`);
+    if (accountId !== userLoanAccountId) throw new Error(`Loan ${loanId} belongs to account ${userLoanAccountId}`);
 
-    const accountRewards =
-      accountId === userLoanAccountId ? userRewards.rewards : userRewards.referrals[userLoanAccountId];
     for (const [i, poolId] of colPools.entries()) {
       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
       const folksTokenId = seen.get(poolId)!;
@@ -119,10 +91,10 @@ export async function getUserRewards(
       const { collateralRewardIndex } = loanPool.reward;
 
       const accrued = calcAccruedRewards(balance, collateralRewardIndex, [rewardIndex, 18]);
-
       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-      accountRewards[folksTokenId]!.collateral += accrued;
+      userRewards.rewards[folksTokenId]!.collateral += accrued;
     }
+
     for (const [i, poolId] of borPools.entries()) {
       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
       const folksTokenId = seen.get(poolId)!;
@@ -134,7 +106,7 @@ export async function getUserRewards(
 
       const accrued = calcAccruedRewards(amount, borrowRewardIndex, [rewardIndex, 18]);
       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-      accountRewards[folksTokenId]!.borrow += accrued;
+      userRewards.rewards[folksTokenId]!.collateral += accrued;
     }
   }
 

package/src/chains/evm/hub/types/rewards.ts

@@ -12,5 +12,4 @@ export type AccountRewards = Partial<Record<FolksTokenId, AccountPoolRewards>>;
 export type UserRewards = {
   accountId: AccountId;
   rewards: AccountRewards;
-  referrals: Record<AccountId, AccountRewards>;
 };

package/src/xchain/modules/folks-rewards.ts

@@ -9,16 +9,14 @@ import type { LoanTypeId } from "../../common/types/module.js";
 export const read = {
   async rewards(
     accountId: AccountId,
-    referredAccountIds: Array<AccountId>,
-    allLoanIds: Array<LoanId>,
+    loanIds: Array<LoanId>,
     loanTypesInfo: Partial<Record<LoanTypeId, LoanTypeInfo>>,
   ): Promise<UserRewards> {
     return FolksHubRewards.getUserRewards(
       FolksCore.getHubProvider(),
       FolksCore.getSelectedNetwork(),
       accountId,
-      referredAccountIds,
-      allLoanIds,
+      loanIds,
       loanTypesInfo,
     );
   },