docs(examples): liquidation status check, PR comments

Folks-Finance · Jan 6, 2025 · e879b52 · e879b52
1 parent f9de360
commit e879b52
Show file tree

Hide file tree

Showing 8 changed files with 98 additions and 217 deletions.
diff --git a/examples/borrow-variable-rate.ts b/examples/borrow-variable-rate.ts
diff --git a/examples/borrow-stable-rate.ts → examples/borrow.ts b/examples/borrow-stable-rate.ts → examples/borrow.ts
@@ -1,5 +1,5 @@
-import { multiply, divide } from "dnum";
-import { createClient, createWalletClient, http, parseUnits } from "viem";
+import * as dn from "dnum";
+import { createWalletClient, http, parseUnits } from "viem";
 import { mnemonicToAccount } from "viem/accounts";
 
 import {
@@ -18,38 +18,28 @@ import {
 import type { FolksCoreConfig, MessageAdapters, AccountId, LoanId } from "../src/index.js";
 
 async function main() {
+  const network = NetworkType.TESTNET;
   const chain = FOLKS_CHAIN_ID.BSC_TESTNET;
   const tokenId = TESTNET_FOLKS_TOKEN_ID.BNB;
-  const jsonRpcAddress = "https://my-rpc.avax-testnet.network/<API_KEY>";
 
-  const folksConfig: FolksCoreConfig = {
-    network: NetworkType.TESTNET,
-    provider: {
-      evm: {
-        [chain]: createClient({
-          chain: CHAIN_VIEM[chain],
-          transport: http(jsonRpcAddress),
-        }),
-      },
-    },
-  };
+  const folksConfig: FolksCoreConfig = { network, provider: { evm: {} } };
 
   FolksCore.init(folksConfig);
-  FolksCore.setNetwork(NetworkType.TESTNET);
+  FolksCore.setNetwork(network);
 
   const MNEMONIC = "your mnemonic here";
   const account = mnemonicToAccount(MNEMONIC);
 
   const signer = createWalletClient({
     account,
     chain: CHAIN_VIEM[chain],
-    transport: http(jsonRpcAddress),
+    transport: http(),
   });
 
   const { adapterIds, returnAdapterIds } = getSupportedMessageAdapters({
     action: Action.Borrow,
     messageAdapterParamType: MessageAdapterParamsType.ReceiveToken,
-    network: NetworkType.TESTNET,
+    network,
     sourceFolksChainId: chain,
     destFolksChainId: chain,
     folksTokenId: tokenId,
@@ -67,15 +57,14 @@ async function main() {
   const amountToBorrow = parseUnits("0.0005", 18); // 0.0005 BNB (BNB has 18 decimals)
   const poolInfo = await FolksPool.read.poolInfo(tokenId);
   const interestRate = poolInfo.stableBorrowData.interestRate[0];
-  const stableRateSlippagePercent = 5; // 5% max deviation from current rate
-  const [maxStableRate] = divide(multiply(interestRate, 100 + stableRateSlippagePercent), 100);
+  const [maxStableRate] = dn.mul(interestRate, 1.05); // 5% max deviation from current rate
 
   const prepareBorrowCall = await FolksLoan.prepare.borrow(
     accountId,
     loanId,
     tokenId,
     amountToBorrow,
-    maxStableRate,
+    maxStableRate, // Use BigInt(0) for variable rate
     chain,
     adapters,
   );
@@ -84,7 +73,7 @@ async function main() {
     loanId,
     tokenId,
     amountToBorrow,
-    maxStableRate,
+    maxStableRate, // Use BigInt(0) for variable rate
     chain,
     prepareBorrowCall,
   );

diff --git a/examples/create-loan.ts b/examples/create-loan.ts
@@ -1,4 +1,4 @@
-import { createClient, createWalletClient, http } from "viem";
+import { createWalletClient, http } from "viem";
 import { mnemonicToAccount } from "viem/accounts";
 
 import { convertStringToLoanName } from "../src/common/utils/lending.js";
@@ -19,23 +19,13 @@ import {
 import type { FolksCoreConfig, MessageAdapters, Nonce, AccountId } from "../src/index.js";
 
 async function main() {
+  const network = NetworkType.TESTNET;
   const chain = FOLKS_CHAIN_ID.AVALANCHE_FUJI;
-  const jsonRpcAddress = "https://my-rpc.avax-testnet.network/<API_KEY>";
 
-  const folksConfig: FolksCoreConfig = {
-    network: NetworkType.TESTNET,
-    provider: {
-      evm: {
-        [chain]: createClient({
-          chain: CHAIN_VIEM[chain],
-          transport: http(jsonRpcAddress),
-        }),
-      },
-    },
-  };
+  const folksConfig: FolksCoreConfig = { network, provider: { evm: {} } };
 
   FolksCore.init(folksConfig);
-  FolksCore.setNetwork(NetworkType.TESTNET);
+  FolksCore.setNetwork(network);
 
   const nonce: Nonce = getRandomBytes(BYTES4_LENGTH) as Nonce;
 
@@ -45,13 +35,13 @@ async function main() {
   const signer = createWalletClient({
     account,
     chain: CHAIN_VIEM[chain],
-    transport: http(jsonRpcAddress),
+    transport: http(),
   });
 
   const { adapterIds, returnAdapterIds } = getSupportedMessageAdapters({
     action: Action.CreateLoan,
     messageAdapterParamType: MessageAdapterParamsType.Data,
-    network: NetworkType.TESTNET,
+    network,
     sourceFolksChainId: chain,
   });
 
@@ -62,20 +52,15 @@ async function main() {
 
   FolksCore.setFolksSigner({ signer, folksChainId: chain });
 
-  const accountId = "0x7d6...b66" as AccountId; //Your xChainApp account id
+  const accountId = "0x7d6...b66" as AccountId; // Your xChainApp account id
+  const loanType = LoanTypeId.GENERAL; // LoanTypeId.DEPOSIT for deposits
   const loanName = convertStringToLoanName("Test Loan");
 
-  const prepareCreateLoanCall = await FolksLoan.prepare.createLoan(
-    accountId,
-    nonce,
-    LoanTypeId.GENERAL, // LoanTypeId.DEPOSIT for deposits
-    loanName,
-    adapters,
-  );
+  const prepareCreateLoanCall = await FolksLoan.prepare.createLoan(accountId, nonce, loanType, loanName, adapters);
   const createLoanCallRes = await FolksLoan.write.createLoan(
     accountId,
     nonce,
-    LoanTypeId.GENERAL, // LoanTypeId.DEPOSIT for deposits
+    loanType,
     loanName,
     prepareCreateLoanCall,
   );

diff --git a/examples/deposit-collateralise.ts → examples/deposit-or-collateralise.ts b/examples/deposit-collateralise.ts → examples/deposit-or-collateralise.ts
@@ -1,4 +1,4 @@
-import { createClient, createWalletClient, http, parseUnits } from "viem";
+import { createWalletClient, http, parseUnits } from "viem";
 import { mnemonicToAccount } from "viem/accounts";
 
 import {
@@ -17,38 +17,28 @@ import {
 import type { FolksCoreConfig, MessageAdapters, AccountId, LoanId } from "../src/index.js";
 
 async function main() {
+  const network = NetworkType.TESTNET;
   const chain = FOLKS_CHAIN_ID.AVALANCHE_FUJI;
   const tokenId = TESTNET_FOLKS_TOKEN_ID.AVAX;
-  const jsonRpcAddress = "https://my-rpc.avax-testnet.network/<API_KEY>";
 
-  const folksConfig: FolksCoreConfig = {
-    network: NetworkType.TESTNET,
-    provider: {
-      evm: {
-        [chain]: createClient({
-          chain: CHAIN_VIEM[chain],
-          transport: http(jsonRpcAddress),
-        }),
-      },
-    },
-  };
+  const folksConfig: FolksCoreConfig = { network, provider: { evm: {} } };
 
   FolksCore.init(folksConfig);
-  FolksCore.setNetwork(NetworkType.TESTNET);
+  FolksCore.setNetwork(network);
 
   const MNEMONIC = "your mnemonic here";
   const account = mnemonicToAccount(MNEMONIC);
 
   const signer = createWalletClient({
     account,
     chain: CHAIN_VIEM[chain],
-    transport: http(jsonRpcAddress),
+    transport: http(),
   });
 
   const { adapterIds, returnAdapterIds } = getSupportedMessageAdapters({
     action: Action.Deposit,
     messageAdapterParamType: MessageAdapterParamsType.SendToken,
-    network: NetworkType.TESTNET,
+    network,
     sourceFolksChainId: chain,
     folksTokenId: tokenId,
   });
@@ -62,12 +52,13 @@ async function main() {
 
   const accountId = "0x7d6...b66" as AccountId; // Your xChainApp account id
   const loanId = "0x166...c12" as LoanId; // Your loan id
+  const loanType = LoanTypeId.GENERAL; // LoanTypeId.DEPOSIT for deposits
   const amountToDeposit = parseUnits("0.1", 18); // 0.1 AVAX (AVAX has 18 decimals)
 
   const prepareDepositCall = await FolksLoan.prepare.deposit(
     accountId,
     loanId,
-    LoanTypeId.GENERAL, // LoanTypeId.DEPOSIT for deposits
+    loanType,
     tokenId,
     amountToDeposit,
     adapters,
@@ -76,7 +67,7 @@ async function main() {
     accountId,
     loanId,
     amountToDeposit,
-    false,
+    true,
     prepareDepositCall,
   );
   console.log(`Transaction ID: ${createDepositCallRes}`);