@folks-finance/xchain-sdk 0.0.20 → 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

@@ -0,0 +1,7 @@
+import type { NetworkType } from "../../../../common/types/chain.js";
+import type { AccountId, LoanId } from "../../../../common/types/lending.js";
+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, loanIds: Array<LoanId>, loanTypesInfo: Partial<Record<LoanTypeId, LoanTypeInfo>>): Promise<UserRewards>;

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

@@ -0,0 +1,82 @@
+import { multicall } from "viem/actions";
+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";
+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
+    const seen = new Map();
+    const poolIds = [];
+    const folksTokenIds = [];
+    for (const { pools } of Object.values(loanTypesInfo)) {
+        for (const { poolId, folksTokenId } of Object.values(pools)) {
+            if (!seen.has(poolId)) {
+                poolIds.push(poolId);
+                folksTokenIds.push(folksTokenId);
+                seen.set(poolId, folksTokenId);
+            }
+        }
+    }
+    // fetch the account rewards which are updated
+    const getUsersPoolRewards = [];
+    for (const poolId of poolIds) {
+        getUsersPoolRewards.push({
+            address: loanManager.address,
+            abi: loanManager.abi,
+            functionName: "getUserPoolRewards",
+            args: [accountId, poolId],
+        });
+    }
+    const accountPoolRewards = (await multicall(provider, {
+        contracts: getUsersPoolRewards,
+        allowFailure: false,
+    }));
+    // 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, loanIds);
+    for (const loanId of loanIds) {
+        const userLoan = userLoans.get(loanId);
+        if (userLoan === undefined)
+            throw Error("Unknown user loan");
+        const { accountId: userLoanAccountId, loanTypeId, colPools, borPools, userLoanCollateral, userLoanBorrow, } = userLoan;
+        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}`);
+        for (const [i, poolId] of colPools.entries()) {
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            const folksTokenId = seen.get(poolId);
+            const { balance, rewardIndex } = userLoanCollateral[i];
+            const loanPool = loanTypeInfo.pools[folksTokenId];
+            if (!loanPool)
+                throw new Error(`Unknown loan pool for token ${folksTokenId}`);
+            const { collateralRewardIndex } = loanPool.reward;
+            const accrued = calcAccruedRewards(balance, collateralRewardIndex, [rewardIndex, 18]);
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            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);
+            const { amount, rewardIndex } = userLoanBorrow[i];
+            const loanPool = loanTypeInfo.pools[folksTokenId];
+            if (!loanPool)
+                throw new Error(`Unknown loan pool for token ${folksTokenId}`);
+            const { borrowRewardIndex } = loanPool.reward;
+            const accrued = calcAccruedRewards(amount, borrowRewardIndex, [rewardIndex, 18]);
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            userRewards.rewards[folksTokenId].collateral += accrued;
+        }
+    }
+    return userRewards;
+}
+//# sourceMappingURL=folks-hub-rewards.js.map

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

@@ -0,0 +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,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/modules/index.d.ts

@@ -2,4 +2,5 @@ export * as FolksHubAccount from "./folks-hub-account.js";
 export * as FolksHubLoan from "./folks-hub-loan.js";
 export * as FolksHubOracle from "./folks-hub-oracle.js";
 export * as FolksHubPool from "./folks-hub-pool.js";
+export * as FolksHubRewards from "./folks-hub-rewards.js";
 export * as FolksHubGmp from "./folks-hub-gmp.js";

package/dist/chains/evm/hub/modules/index.js

@@ -2,5 +2,6 @@ export * as FolksHubAccount from "./folks-hub-account.js";
 export * as FolksHubLoan from "./folks-hub-loan.js";
 export * as FolksHubOracle from "./folks-hub-oracle.js";
 export * as FolksHubPool from "./folks-hub-pool.js";
+export * as FolksHubRewards from "./folks-hub-rewards.js";
 export * as FolksHubGmp from "./folks-hub-gmp.js";
 //# sourceMappingURL=index.js.map

package/dist/chains/evm/hub/modules/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/chains/evm/hub/modules/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,eAAe,MAAM,wBAAwB,CAAC;AAC1D,OAAO,KAAK,YAAY,MAAM,qBAAqB,CAAC;AACpD,OAAO,KAAK,cAAc,MAAM,uBAAuB,CAAC;AACxD,OAAO,KAAK,YAAY,MAAM,qBAAqB,CAAC;AACpD,OAAO,KAAK,WAAW,MAAM,oBAAoB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/chains/evm/hub/modules/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,eAAe,MAAM,wBAAwB,CAAC;AAC1D,OAAO,KAAK,YAAY,MAAM,qBAAqB,CAAC;AACpD,OAAO,KAAK,cAAc,MAAM,uBAAuB,CAAC;AACxD,OAAO,KAAK,YAAY,MAAM,qBAAqB,CAAC;AACpD,OAAO,KAAK,eAAe,MAAM,wBAAwB,CAAC;AAC1D,OAAO,KAAK,WAAW,MAAM,oBAAoB,CAAC"}

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

@@ -0,0 +1,12 @@
+import type { AccountId } from "../../../../common/types/lending.js";
+import type { FolksTokenId } from "../../../../common/types/token.js";
+export type AccountPoolRewards = {
+    collateral: bigint;
+    borrow: bigint;
+    interestPaid: bigint;
+};
+export type AccountRewards = Partial<Record<FolksTokenId, AccountPoolRewards>>;
+export type UserRewards = {
+    accountId: AccountId;
+    rewards: AccountRewards;
+};

package/dist/chains/evm/hub/types/rewards.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=rewards.js.map

package/dist/chains/evm/hub/types/rewards.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rewards.js","sourceRoot":"","sources":["../../../../../src/chains/evm/hub/types/rewards.ts"],"names":[],"mappings":""}

package/dist/common/utils/formulae.d.ts

@@ -4,6 +4,7 @@ export declare function calcNextPeriodReset(periodNumber: bigint, offset: bigint
 export declare function calcDepositInterestIndex(dirt1: Dnum, diit1: Dnum, latestUpdate: bigint): Dnum;
 export declare function calcBorrowInterestIndex(birt1: Dnum, biit1: Dnum, latestUpdate: bigint): Dnum;
 export declare function calcRewardIndex(used: bigint, ma: bigint, rit1: Dnum, rs: Dnum, latestUpdate: bigint): Dnum;
+export declare function calcAccruedRewards(amount: bigint, rit: Dnum, ritn1: Dnum): bigint;
 export declare function toFAmount(underlyingAmount: bigint, diit: Dnum): bigint;
 export declare function toUnderlyingAmount(fAmount: bigint, diit: Dnum): bigint;
 export declare function calcCollateralAssetLoanValue(amount: bigint, tokenPrice: Dnum, tokenDecimals: number, collateralFactor: Dnum): Dnum;

package/dist/common/utils/formulae.js

@@ -24,6 +24,10 @@ export function calcRewardIndex(used, ma, rit1, rs, latestUpdate) {
         rounding: "ROUND_DOWN",
     }));
 }
+export function calcAccruedRewards(amount, rit, ritn1) {
+    const [accruedRewards] = dn.mul([amount, 0], dn.sub(rit, ritn1), { rounding: "ROUND_DOWN" });
+    return accruedRewards;
+}
 export function toFAmount(underlyingAmount, diit) {
     const [fAmount] = dn.div([underlyingAmount, 0], diit, { rounding: "ROUND_DOWN" });
     return fAmount;

package/dist/common/utils/formulae.js.map

@@ -1 +1 @@
-{"version":3,"file":"formulae.js","sourceRoot":"","sources":["../../../src/common/utils/formulae.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,MAAM,CAAC;AAE3B,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAIzE,MAAM,UAAU,gBAAgB,CAAC,MAAc,EAAE,MAAc;IAC7D,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,GAAG,MAAM,CAAC,GAAG,MAAM,CAAC;AAChD,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,YAAoB,EAAE,MAAc,EAAE,MAAc;IACtF,OAAO,CAAC,YAAY,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,MAAM,CAAC;AACtD,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,KAAW,EAAE,KAAW,EAAE,YAAoB;IACrF,MAAM,EAAE,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,GAAG,YAAY,CAAC;IAC7C,OAAO,EAAE,CAAC,GAAG,CACX,KAAK,EACL,EAAE,CAAC,GAAG,CACJ,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,CAAC,EACd,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC,EAAE,eAAe,EAAE;QACrE,QAAQ,EAAE,YAAY;KACvB,CAAC,CACH,EACD,EAAE,QAAQ,EAAE,YAAY,EAAE,CAC3B,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,KAAW,EAAE,KAAW,EAAE,YAAoB;IACpF,MAAM,EAAE,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,GAAG,YAAY,CAAC;IAC7C,OAAO,EAAE,CAAC,GAAG,CACX,KAAK,EACL,aAAa,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE,eAAe,EAAE,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,EACrG,EAAE,QAAQ,EAAE,YAAY,EAAE,CAC3B,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,IAAY,EAAE,EAAU,EAAE,IAAU,EAAE,EAAQ,EAAE,YAAoB;IAClG,IAAI,IAAI,IAAI,EAAE;QAAE,OAAO,IAAI,CAAC;IAC5B,MAAM,EAAE,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,GAAG,YAAY,CAAC;IAC7C,OAAO,EAAE,CAAC,GAAG,CACX,IAAI,EACJ,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC,EAAE,IAAI,EAAE;QACvD,QAAQ,EAAE,YAAY;KACvB,CAAC,CACH,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,gBAAwB,EAAE,IAAU;IAC5D,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,gBAAgB,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC,CAAC;IAClF,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,OAAe,EAAE,IAAU;IAC5D,MAAM,CAAC,gBAAgB,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC,CAAC;IAClF,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAED,SAAS,oBAAoB,CAAC,MAAc,EAAE,UAAgB,EAAE,aAAqB;IACnF,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,aAAa,CAAC,EAAE,UAAU,EAAE;QACjD,QAAQ,EAAE,YAAY;KACvB,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,4BAA4B,CAC1C,MAAc,EACd,UAAgB,EAChB,aAAqB,EACrB,gBAAsB;IAEtB,OAAO,EAAE,CAAC,GAAG,CAAC,oBAAoB,CAAC,MAAM,EAAE,UAAU,EAAE,aAAa,CAAC,EAAE,gBAAgB,EAAE,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC,CAAC;AACvH,CAAC;AAED,MAAM,UAAU,wBAAwB,CACtC,MAAc,EACd,UAAgB,EAChB,aAAqB,EACrB,YAAkB;IAElB,OAAO,EAAE,CAAC,GAAG,CAAC,oBAAoB,CAAC,MAAM,EAAE,UAAU,EAAE,aAAa,CAAC,EAAE,YAAY,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;AACjH,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,KAAa,EAAE,IAAU,EAAE,MAAY;IACvE,MAAM,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,EAAE;QACzF,QAAQ,EAAE,UAAU;KACrB,CAAC,CAAC;IACH,OAAO,aAAa,CAAC;AACvB,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,GAAW,EAAE,MAAc,EAAE,OAAa,EAAE,MAAY;IAC7F,OAAO,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AAC/G,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,uBAA6B,EAAE,2BAAiC;IAC3F,MAAM,CAAC,EAAE,QAAQ,CAAC,GAAG,uBAAuB,CAAC;IAC7C,IAAI,EAAE,CAAC,KAAK,CAAC,2BAA2B,EAAE,CAAC,CAAC;QAAE,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC1E,OAAO,EAAE,CAAC,GAAG,CAAC,uBAAuB,EAAE,2BAA2B,EAAE;QAClE,QAAQ,EAAE,UAAU;KACrB,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,0BAA0B,CACxC,gCAAsC,EACtC,oCAA0C;IAE1C,MAAM,CAAC,EAAE,QAAQ,CAAC,GAAG,gCAAgC,CAAC;IACtD,IAAI,EAAE,CAAC,KAAK,CAAC,oCAAoC,EAAE,CAAC,CAAC;QAAE,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;IACnF,OAAO,EAAE,CAAC,GAAG,CAAC,gCAAgC,EAAE,oCAAoC,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;AAClH,CAAC;AAED,MAAM,UAAU,qBAAqB,CACnC,gCAAsC,EACtC,oCAA0C;IAE1C,MAAM,CAAC,EAAE,QAAQ,CAAC,GAAG,gCAAgC,CAAC;IACtD,IAAI,EAAE,CAAC,KAAK,CAAC,oCAAoC,EAAE,CAAC,CAAC;QAAE,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;IACnF,OAAO,EAAE,CAAC,GAAG,CACX,EAAE,CAAC,GAAG,CAAC,oCAAoC,EAAE,gCAAgC,CAAC,EAC9E,oCAAoC,EACpC;QACE,QAAQ,EAAE,YAAY;KACvB,CACF,CAAC;AACJ,CAAC"}
+{"version":3,"file":"formulae.js","sourceRoot":"","sources":["../../../src/common/utils/formulae.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,MAAM,CAAC;AAE3B,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAIzE,MAAM,UAAU,gBAAgB,CAAC,MAAc,EAAE,MAAc;IAC7D,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,GAAG,MAAM,CAAC,GAAG,MAAM,CAAC;AAChD,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,YAAoB,EAAE,MAAc,EAAE,MAAc;IACtF,OAAO,CAAC,YAAY,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,MAAM,CAAC;AACtD,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,KAAW,EAAE,KAAW,EAAE,YAAoB;IACrF,MAAM,EAAE,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,GAAG,YAAY,CAAC;IAC7C,OAAO,EAAE,CAAC,GAAG,CACX,KAAK,EACL,EAAE,CAAC,GAAG,CACJ,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,CAAC,EACd,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC,EAAE,eAAe,EAAE;QACrE,QAAQ,EAAE,YAAY;KACvB,CAAC,CACH,EACD,EAAE,QAAQ,EAAE,YAAY,EAAE,CAC3B,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,KAAW,EAAE,KAAW,EAAE,YAAoB;IACpF,MAAM,EAAE,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,GAAG,YAAY,CAAC;IAC7C,OAAO,EAAE,CAAC,GAAG,CACX,KAAK,EACL,aAAa,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE,eAAe,EAAE,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,EACrG,EAAE,QAAQ,EAAE,YAAY,EAAE,CAC3B,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,IAAY,EAAE,EAAU,EAAE,IAAU,EAAE,EAAQ,EAAE,YAAoB;IAClG,IAAI,IAAI,IAAI,EAAE;QAAE,OAAO,IAAI,CAAC;IAC5B,MAAM,EAAE,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,GAAG,YAAY,CAAC;IAC7C,OAAO,EAAE,CAAC,GAAG,CACX,IAAI,EACJ,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC,EAAE,IAAI,EAAE;QACvD,QAAQ,EAAE,YAAY;KACvB,CAAC,CACH,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,MAAc,EAAE,GAAS,EAAE,KAAW;IACvE,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC,CAAC;IAC7F,OAAO,cAAc,CAAC;AACxB,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,gBAAwB,EAAE,IAAU;IAC5D,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,gBAAgB,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC,CAAC;IAClF,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,OAAe,EAAE,IAAU;IAC5D,MAAM,CAAC,gBAAgB,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC,CAAC;IAClF,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAED,SAAS,oBAAoB,CAAC,MAAc,EAAE,UAAgB,EAAE,aAAqB;IACnF,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,aAAa,CAAC,EAAE,UAAU,EAAE;QACjD,QAAQ,EAAE,YAAY;KACvB,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,4BAA4B,CAC1C,MAAc,EACd,UAAgB,EAChB,aAAqB,EACrB,gBAAsB;IAEtB,OAAO,EAAE,CAAC,GAAG,CAAC,oBAAoB,CAAC,MAAM,EAAE,UAAU,EAAE,aAAa,CAAC,EAAE,gBAAgB,EAAE,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC,CAAC;AACvH,CAAC;AAED,MAAM,UAAU,wBAAwB,CACtC,MAAc,EACd,UAAgB,EAChB,aAAqB,EACrB,YAAkB;IAElB,OAAO,EAAE,CAAC,GAAG,CAAC,oBAAoB,CAAC,MAAM,EAAE,UAAU,EAAE,aAAa,CAAC,EAAE,YAAY,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;AACjH,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,KAAa,EAAE,IAAU,EAAE,MAAY;IACvE,MAAM,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,EAAE;QACzF,QAAQ,EAAE,UAAU;KACrB,CAAC,CAAC;IACH,OAAO,aAAa,CAAC;AACvB,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,GAAW,EAAE,MAAc,EAAE,OAAa,EAAE,MAAY;IAC7F,OAAO,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AAC/G,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,uBAA6B,EAAE,2BAAiC;IAC3F,MAAM,CAAC,EAAE,QAAQ,CAAC,GAAG,uBAAuB,CAAC;IAC7C,IAAI,EAAE,CAAC,KAAK,CAAC,2BAA2B,EAAE,CAAC,CAAC;QAAE,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC1E,OAAO,EAAE,CAAC,GAAG,CAAC,uBAAuB,EAAE,2BAA2B,EAAE;QAClE,QAAQ,EAAE,UAAU;KACrB,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,0BAA0B,CACxC,gCAAsC,EACtC,oCAA0C;IAE1C,MAAM,CAAC,EAAE,QAAQ,CAAC,GAAG,gCAAgC,CAAC;IACtD,IAAI,EAAE,CAAC,KAAK,CAAC,oCAAoC,EAAE,CAAC,CAAC;QAAE,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;IACnF,OAAO,EAAE,CAAC,GAAG,CAAC,gCAAgC,EAAE,oCAAoC,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;AAClH,CAAC;AAED,MAAM,UAAU,qBAAqB,CACnC,gCAAsC,EACtC,oCAA0C;IAE1C,MAAM,CAAC,EAAE,QAAQ,CAAC,GAAG,gCAAgC,CAAC;IACtD,IAAI,EAAE,CAAC,KAAK,CAAC,oCAAoC,EAAE,CAAC,CAAC;QAAE,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;IACnF,OAAO,EAAE,CAAC,GAAG,CACX,EAAE,CAAC,GAAG,CAAC,oCAAoC,EAAE,gCAAgC,CAAC,EAC9E,oCAAoC,EACpC;QACE,QAAQ,EAAE,YAAY;KACvB,CACF,CAAC;AACJ,CAAC"}

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export { FolksCore } from "./xchain/core/folks-core.js";
-export { FolksAccount, FolksLoan, FolksOracle, FolksPool } from "./xchain/modules/index.js";
+export { FolksAccount, FolksLoan, FolksOracle, FolksPool, FolksGmp, FolksRewards } from "./xchain/modules/index.js";
 export * from "./common/types/adapter.js";
 export * from "./common/types/address.js";
 export * from "./common/types/chain.js";
@@ -32,4 +32,5 @@ export * from "./chains/evm/hub/types/chain.js";
 export * from "./chains/evm/hub/types/loan.js";
 export * from "./chains/evm/hub/types/oracle.js";
 export * from "./chains/evm/hub/types/pool.js";
+export * from "./chains/evm/hub/types/rewards.js";
 export * from "./chains/evm/hub/types/token.js";

package/dist/index.js

@@ -1,7 +1,7 @@
 // === CORE ===
 export { FolksCore } from "./xchain/core/folks-core.js";
 // === MODULES ===
-export { FolksAccount, FolksLoan, FolksOracle, FolksPool } from "./xchain/modules/index.js";
+export { FolksAccount, FolksLoan, FolksOracle, FolksPool, FolksGmp, FolksRewards } from "./xchain/modules/index.js";
 // === COMMON ===
 export * from "./common/types/adapter.js";
 export * from "./common/types/address.js";
@@ -39,5 +39,6 @@ export * from "./chains/evm/hub/types/chain.js";
 export * from "./chains/evm/hub/types/loan.js";
 export * from "./chains/evm/hub/types/oracle.js";
 export * from "./chains/evm/hub/types/pool.js";
+export * from "./chains/evm/hub/types/rewards.js";
 export * from "./chains/evm/hub/types/token.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,eAAe;AACf,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AAExD,kBAAkB;AAClB,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAE5F,iBAAiB;AACjB,cAAc,2BAA2B,CAAC;AAC1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AAExC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,+BAA+B,CAAC;AAE9C,OAAO,EAAE,2BAA2B,EAAE,MAAM,2BAA2B,CAAC;AACxE,OAAO,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAC/F,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxE,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAC3E,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACrE,OAAO,EAAE,4BAA4B,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC5F,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAEzD,cAAc;AACd,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAEhE,iBAAiB;AAEjB,QAAQ;AACR,cAAc,wCAAwC,CAAC;AAEvD,cAAc,oCAAoC,CAAC;AAEnD,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAElE,aAAa;AACb,cAAc,mCAAmC,CAAC;AAClD,cAAc,iCAAiC,CAAC;AAChD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kCAAkC,CAAC;AACjD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,iCAAiC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,eAAe;AACf,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AAExD,kBAAkB;AAClB,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAEpH,iBAAiB;AACjB,cAAc,2BAA2B,CAAC;AAC1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AAExC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,+BAA+B,CAAC;AAE9C,OAAO,EAAE,2BAA2B,EAAE,MAAM,2BAA2B,CAAC;AACxE,OAAO,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAC/F,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxE,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAC3E,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACrE,OAAO,EAAE,4BAA4B,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC5F,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAEzD,cAAc;AACd,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAEhE,iBAAiB;AAEjB,QAAQ;AACR,cAAc,wCAAwC,CAAC;AAEvD,cAAc,oCAAoC,CAAC;AAEnD,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAElE,aAAa;AACb,cAAc,mCAAmC,CAAC;AAClD,cAAc,iCAAiC,CAAC;AAChD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kCAAkC,CAAC;AACjD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,mCAAmC,CAAC;AAClD,cAAc,iCAAiC,CAAC"}

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

@@ -0,0 +1,7 @@
+import type { LoanTypeInfo } from "../../chains/evm/hub/types/loan.js";
+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, loanIds: Array<LoanId>, loanTypesInfo: Partial<Record<LoanTypeId, LoanTypeInfo>>): Promise<UserRewards>;
+};

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

@@ -0,0 +1,8 @@
+import { FolksHubRewards } from "../../chains/evm/hub/modules/index.js";
+import { FolksCore } from "../core/folks-core.js";
+export const read = {
+    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

@@ -0,0 +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,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/dist/xchain/modules/index.d.ts

@@ -2,4 +2,5 @@ export * as FolksAccount from "./folks-account.js";
 export * as FolksLoan from "./folks-loan.js";
 export * as FolksOracle from "./folks-oracle.js";
 export * as FolksPool from "./folks-pool.js";
+export * as FolksRewards from "./folks-rewards.js";
 export * as FolksGmp from "./folks-gmp.js";

package/dist/xchain/modules/index.js

@@ -2,5 +2,6 @@ export * as FolksAccount from "./folks-account.js";
 export * as FolksLoan from "./folks-loan.js";
 export * as FolksOracle from "./folks-oracle.js";
 export * as FolksPool from "./folks-pool.js";
+export * as FolksRewards from "./folks-rewards.js";
 export * as FolksGmp from "./folks-gmp.js";
 //# sourceMappingURL=index.js.map

package/dist/xchain/modules/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/xchain/modules/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,YAAY,MAAM,oBAAoB,CAAC;AACnD,OAAO,KAAK,SAAS,MAAM,iBAAiB,CAAC;AAC7C,OAAO,KAAK,WAAW,MAAM,mBAAmB,CAAC;AACjD,OAAO,KAAK,SAAS,MAAM,iBAAiB,CAAC;AAC7C,OAAO,KAAK,QAAQ,MAAM,gBAAgB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/xchain/modules/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,YAAY,MAAM,oBAAoB,CAAC;AACnD,OAAO,KAAK,SAAS,MAAM,iBAAiB,CAAC;AAC7C,OAAO,KAAK,WAAW,MAAM,mBAAmB,CAAC;AACjD,OAAO,KAAK,SAAS,MAAM,iBAAiB,CAAC;AAC7C,OAAO,KAAK,YAAY,MAAM,oBAAoB,CAAC;AACnD,OAAO,KAAK,QAAQ,MAAM,gBAAgB,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.20",
+  "version": "0.0.22",
   "license": "MIT",
   "publishConfig": {
     "access": "public"

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

@@ -0,0 +1,114 @@
+import { multicall } from "viem/actions";
+
+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";
+
+import type { NetworkType } from "../../../../common/types/chain.js";
+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, UserRewards } from "../types/rewards.js";
+import type { Client, ContractFunctionParameters } from "viem";
+
+export async function getUserRewards(
+  provider: Client,
+  network: NetworkType,
+  accountId: AccountId,
+  loanIds: Array<LoanId>,
+  loanTypesInfo: Partial<Record<LoanTypeId, LoanTypeInfo>>,
+): Promise<UserRewards> {
+  const hubChain = getHubChain(network);
+  const loanManager = getLoanManagerContract(provider, hubChain.loanManagerAddress);
+
+  // derive the tokens/pools you are interested in
+  const seen = new Map<number, FolksTokenId>();
+  const poolIds: Array<number> = [];
+  const folksTokenIds: Array<FolksTokenId> = [];
+  for (const { pools } of Object.values(loanTypesInfo)) {
+    for (const { poolId, folksTokenId } of Object.values(pools)) {
+      if (!seen.has(poolId)) {
+        poolIds.push(poolId);
+        folksTokenIds.push(folksTokenId);
+        seen.set(poolId, folksTokenId);
+      }
+    }
+  }
+
+  // fetch the account rewards which are updated
+  const getUsersPoolRewards: Array<ContractFunctionParameters> = [];
+  for (const poolId of poolIds) {
+    getUsersPoolRewards.push({
+      address: loanManager.address,
+      abi: loanManager.abi,
+      functionName: "getUserPoolRewards",
+      args: [accountId, poolId],
+    });
+  }
+
+  const accountPoolRewards: Array<AccountPoolRewards> = (await multicall(provider, {
+    contracts: getUsersPoolRewards,
+    allowFailure: false,
+  })) as Array<AccountPoolRewards>;
+
+  // 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, loanIds);
+  for (const loanId of loanIds) {
+    const userLoan = userLoans.get(loanId);
+    if (userLoan === undefined) throw Error("Unknown user loan");
+
+    const {
+      accountId: userLoanAccountId,
+      loanTypeId,
+      colPools,
+      borPools,
+      userLoanCollateral,
+      userLoanBorrow,
+    } = userLoan;
+
+    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}`);
+
+    for (const [i, poolId] of colPools.entries()) {
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      const folksTokenId = seen.get(poolId)!;
+      const { balance, rewardIndex } = userLoanCollateral[i];
+
+      const loanPool = loanTypeInfo.pools[folksTokenId];
+      if (!loanPool) throw new Error(`Unknown loan pool for token ${folksTokenId}`);
+      const { collateralRewardIndex } = loanPool.reward;
+
+      const accrued = calcAccruedRewards(balance, collateralRewardIndex, [rewardIndex, 18]);
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      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)!;
+      const { amount, rewardIndex } = userLoanBorrow[i];
+
+      const loanPool = loanTypeInfo.pools[folksTokenId];
+      if (!loanPool) throw new Error(`Unknown loan pool for token ${folksTokenId}`);
+      const { borrowRewardIndex } = loanPool.reward;
+
+      const accrued = calcAccruedRewards(amount, borrowRewardIndex, [rewardIndex, 18]);
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      userRewards.rewards[folksTokenId]!.collateral += accrued;
+    }
+  }
+
+  return userRewards;
+}

package/src/chains/evm/hub/modules/index.ts

@@ -2,4 +2,5 @@ export * as FolksHubAccount from "./folks-hub-account.js";
 export * as FolksHubLoan from "./folks-hub-loan.js";
 export * as FolksHubOracle from "./folks-hub-oracle.js";
 export * as FolksHubPool from "./folks-hub-pool.js";
+export * as FolksHubRewards from "./folks-hub-rewards.js";
 export * as FolksHubGmp from "./folks-hub-gmp.js";

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

@@ -0,0 +1,15 @@
+import type { AccountId } from "../../../../common/types/lending.js";
+import type { FolksTokenId } from "../../../../common/types/token.js";
+
+export type AccountPoolRewards = {
+  collateral: bigint;
+  borrow: bigint;
+  interestPaid: bigint;
+};
+
+export type AccountRewards = Partial<Record<FolksTokenId, AccountPoolRewards>>;
+
+export type UserRewards = {
+  accountId: AccountId;
+  rewards: AccountRewards;
+};

package/src/common/utils/formulae.ts

@@ -46,6 +46,11 @@ export function calcRewardIndex(used: bigint, ma: bigint, rit1: Dnum, rs: Dnum,
   );
 }
 
+export function calcAccruedRewards(amount: bigint, rit: Dnum, ritn1: Dnum): bigint {
+  const [accruedRewards] = dn.mul([amount, 0], dn.sub(rit, ritn1), { rounding: "ROUND_DOWN" });
+  return accruedRewards;
+}
+
 export function toFAmount(underlyingAmount: bigint, diit: Dnum): bigint {
   const [fAmount] = dn.div([underlyingAmount, 0], diit, { rounding: "ROUND_DOWN" });
   return fAmount;

package/src/index.ts

@@ -2,7 +2,7 @@
 export { FolksCore } from "./xchain/core/folks-core.js";
 
 // === MODULES ===
-export { FolksAccount, FolksLoan, FolksOracle, FolksPool } from "./xchain/modules/index.js";
+export { FolksAccount, FolksLoan, FolksOracle, FolksPool, FolksGmp, FolksRewards } from "./xchain/modules/index.js";
 
 // === COMMON ===
 export * from "./common/types/adapter.js";
@@ -49,4 +49,5 @@ export * from "./chains/evm/hub/types/chain.js";
 export * from "./chains/evm/hub/types/loan.js";
 export * from "./chains/evm/hub/types/oracle.js";
 export * from "./chains/evm/hub/types/pool.js";
+export * from "./chains/evm/hub/types/rewards.js";
 export * from "./chains/evm/hub/types/token.js";

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

@@ -0,0 +1,23 @@
+import { FolksHubRewards } from "../../chains/evm/hub/modules/index.js";
+import { FolksCore } from "../core/folks-core.js";
+
+import type { LoanTypeInfo } from "../../chains/evm/hub/types/loan.js";
+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 const read = {
+  async rewards(
+    accountId: AccountId,
+    loanIds: Array<LoanId>,
+    loanTypesInfo: Partial<Record<LoanTypeId, LoanTypeInfo>>,
+  ): Promise<UserRewards> {
+    return FolksHubRewards.getUserRewards(
+      FolksCore.getHubProvider(),
+      FolksCore.getSelectedNetwork(),
+      accountId,
+      loanIds,
+      loanTypesInfo,
+    );
+  },
+};

package/src/xchain/modules/index.ts

@@ -2,4 +2,5 @@ export * as FolksAccount from "./folks-account.js";
 export * as FolksLoan from "./folks-loan.js";
 export * as FolksOracle from "./folks-oracle.js";
 export * as FolksPool from "./folks-pool.js";
+export * as FolksRewards from "./folks-rewards.js";
 export * as FolksGmp from "./folks-gmp.js";