docs: add docs

src/external-api.ts

@@ -2,7 +2,7 @@ import axios from "axios";
 import { ethers } from "ethers";
 import memoize from "memoizee";
 import BigNumber from 'bignumber.js';
-import { llamalend } from "./lending.js";
+import { llamalend } from "./llamalend.js";
 import {
     IExtendedPoolDataFromApi,
     INetworkName,

src/index.ts

@@ -1,7 +1,7 @@
 import { ethers, Networkish } from "ethers";
 import { OneWayMarketTemplate, getOneWayMarket } from "./markets/index.js";
 import { LlammaTemplate, getLlamma} from "./llammas";
-import { llamalend as _llamalend} from "./lending.js";
+import { llamalend as _llamalend} from "./llamalend.js";
 import {
     getBalances,
     getAllowance,
@@ -63,7 +63,7 @@ function setCustomFeeData (customFeeData: { gasPrice?: number, maxFeePerGas?: nu
     _llamalend.setCustomFeeData(customFeeData);
 }
 
-const lending = {
+const llamalend = {
     init,
     chainId: 0,
     signerAddress: '',
@@ -125,4 +125,4 @@ const lending = {
     },
 }
 
-export default lending;
+export default llamalend;

src/interfaces.ts

@@ -57,7 +57,7 @@ export interface IOneWayMarket {
     collateral_token: ICoin,
 }
 
-export interface ILending {
+export interface ILlamalend {
     provider: ethers.BrowserProvider | ethers.JsonRpcProvider,
     multicallProvider: MulticallProvider,
     signer: ethers.Signer | null,

src/llamalend.ts

@@ -3,7 +3,7 @@ import { ethers,
 import { Provider as MulticallProvider, Contract as MulticallContract, Call } from '@curvefi/ethcall';
 import {
     IChainId,
-    ILending,
+    ILlamalend,
     ILlamma,
     IDict,
     INetworkName,
@@ -168,7 +168,7 @@ export const NETWORK_CONSTANTS: { [index: number]: any } = {
 }
 
 
-class Lending implements ILending {
+class Llamalend implements ILlamalend {
     address: string;
     provider: ethers.BrowserProvider | ethers.JsonRpcProvider;
     multicallProvider: MulticallProvider;
@@ -782,4 +782,4 @@ class Lending implements ILending {
     }
 }
 
-export const llamalend = new Lending();
+export const llamalend = new Llamalend();

src/llammas/LlammaTemplate.ts

@@ -1,6 +1,6 @@
 import memoize from "memoizee";
 import BigNumber from "bignumber.js";
-import { llamalend } from "../lending.js";
+import { llamalend } from "../llamalend.js";
 import {
     _getAddress,
     parseUnits,

src/markets/MarketConstructor.ts

@@ -1,5 +1,5 @@
 import { OneWayMarketTemplate} from "./OneWayMarketTemplate.js";
-import { llamalend } from "../lending.js";
+import { llamalend } from "../llamalend.js";
 
 export const getOneWayMarket = (oneWayMarketId: string): OneWayMarketTemplate => {
     const marketData = llamalend.constants.ONE_WAY_MARKETS[oneWayMarketId];

src/markets/OneWayMarketTemplate.ts

@@ -1,6 +1,6 @@
 import memoize from "memoizee";
 import BigNumber from "bignumber.js";
-import { llamalend } from "../lending.js";
+import { llamalend } from "../llamalend.js";
 import {
     _getAddress,
     parseUnits,

src/st-crvUSD.ts

@@ -10,7 +10,7 @@ import {
     getBalances,
     MAX_ALLOWANCE,
 } from "./utils.js";
-import { llamalend } from "./lending.js";
+import { llamalend } from "./llamalend.js";
 import { TAmount, TGas } from "./interfaces.js";
 
 // ---------------- UTILS ----------------

src/utils.ts

@@ -4,7 +4,7 @@ import { Call } from "@curvefi/ethcall";
 import BigNumber from 'bignumber.js';
 import { ICurveContract, IDict, TGas } from "./interfaces.js";
 import { _getUsdPricesFromApi } from "./external-api.js";
-import { llamalend } from "./lending.js";
+import { llamalend } from "./llamalend.js";
 import { JsonFragment } from "ethers/lib.esm";
 import { L2Networks } from "./constants/L2Networks.js";
 import memoize from "memoizee";

test/fetch.test.ts

@@ -1,5 +1,5 @@
 import { assert } from "chai";
-import lending from "../src/index.js";
+import llamalend from "../src/index.js";
 import {OneWayMarketTemplate} from "../src/markets";
 
 function cloneDeep<T>(obj: T): T {
@@ -106,15 +106,15 @@ describe('Fetch Markets Test', async function () {
     this.timeout(1200000);
 
     before(async function () {
-        await lending.init('JsonRpc', {}, { gasPrice: 0 });
+        await llamalend.init('JsonRpc', {}, { gasPrice: 0 });
     });
 
     it('should fetch and compare market lists with and without parameter', async function () {
-        await lending.oneWayfactory.fetchMarkets(true);
-        const marketsWithDefault = lending.oneWayfactory.getMarketList();
+        await llamalend.oneWayfactory.fetchMarkets(true);
+        const marketsWithDefault = llamalend.oneWayfactory.getMarketList();
 
-        await lending.oneWayfactory.fetchMarkets(false);
-        const marketsWithFalse = lending.oneWayfactory.getMarketList();
+        await llamalend.oneWayfactory.fetchMarkets(false);
+        const marketsWithFalse = llamalend.oneWayfactory.getMarketList();
 
         assert.deepEqual(
             marketsWithDefault,
@@ -124,20 +124,20 @@ describe('Fetch Markets Test', async function () {
     });
 
     it('should compare market objects from API and Blockchain', async function () {
-        await lending.oneWayfactory.fetchMarkets(true);
-        const marketListAPI = await lending.oneWayfactory.getMarketList();
+        await llamalend.oneWayfactory.fetchMarkets(true);
+        const marketListAPI = await llamalend.oneWayfactory.getMarketList();
 
         const marketsAPI: Record<string, any> = {};
         marketListAPI.forEach((item: string) => {
-            marketsAPI[item] = cloneDeep(lending.getOneWayMarket(item));
+            marketsAPI[item] = cloneDeep(llamalend.getOneWayMarket(item));
         });
 
-        await lending.oneWayfactory.fetchMarkets(false);
-        const marketListBlockchain = await lending.oneWayfactory.getMarketList();
+        await llamalend.oneWayfactory.fetchMarkets(false);
+        const marketListBlockchain = await llamalend.oneWayfactory.getMarketList();
 
         const marketsBlockchain: Record<string, any> = {};
         marketListBlockchain.forEach((item: string) => {
-            marketsBlockchain[item] = cloneDeep(lending.getOneWayMarket(item));
+            marketsBlockchain[item] = cloneDeep(llamalend.getOneWayMarket(item));
         });
 
         marketListAPI.forEach((item: string) => {

test/general.test.ts

@@ -1,5 +1,5 @@
 import { assert } from "chai";
-import lending from "../src/index.js";
+import llamalend from "../src/index.js";
 import { getOneWayMarket, OneWayMarketTemplate } from "../src/markets/index.js";
 import { BN } from "../src/utils.js";
 
@@ -206,8 +206,8 @@ describe('General test', async function () {
     this.timeout(120000);
 
     before(async function () {
-        await lending.init('JsonRpc', {},{ gasPrice: 0 });
-        await lending.oneWayfactory.fetchMarkets();
+        await llamalend.init('JsonRpc', {},{ gasPrice: 0 });
+        await llamalend.oneWayfactory.fetchMarkets();
     });
 
     for (const oneWayMarketId of ONE_WAY_MARKETS) {

test/leverageBorrowMore.test.ts

@@ -1,5 +1,5 @@
 import { assert } from "chai";
-import lending from "../src/index.js";
+import llamalend from "../src/index.js";
 import { getOneWayMarket, OneWayMarketTemplate } from "../src/markets/index.js";
 import { BN } from "../src/utils.js";
 
@@ -235,8 +235,8 @@ describe('Leverage borrowMore test', async function () {
     this.timeout(180000);
 
     before(async function () {
-        await lending.init('JsonRpc', {},{ gasPrice: 0 });
-        await lending.oneWayfactory.fetchMarkets();
+        await llamalend.init('JsonRpc', {},{ gasPrice: 0 });
+        await llamalend.oneWayfactory.fetchMarkets();
     });
 
     for (const oneWayMarketId of ONE_WAY_MARKETS) {

test/leverageCreateLoan.test.ts

@@ -1,5 +1,5 @@
 import { assert } from "chai";
-import lending from "../src/index.js";
+import llamalend from "../src/index.js";
 import { getOneWayMarket, OneWayMarketTemplate } from "../src/markets/index.js";
 import { BN } from "../src/utils.js";
 
@@ -226,8 +226,8 @@ describe('Leverage createLoan test', async function () {
     this.timeout(180000);
 
     before(async function () {
-        await lending.init('JsonRpc', {},{ gasPrice: 0 });
-        await lending.oneWayfactory.fetchMarkets();
+        await llamalend.init('JsonRpc', {},{ gasPrice: 0 });
+        await llamalend.oneWayfactory.fetchMarkets();
     });
 
     for (const oneWayMarketId of ONE_WAY_MARKETS) {

test/leverageRepay.test.ts

@@ -1,5 +1,5 @@
 import { assert } from "chai";
-import lending from "../src/index.js";
+import llamalend from "../src/index.js";
 import { getOneWayMarket, OneWayMarketTemplate } from "../src/markets/index.js";
 import { BN } from "../src/utils.js";
 
@@ -230,8 +230,8 @@ describe('Leverage repay test', async function () {
     this.timeout(180000);
 
     before(async function () {
-        await lending.init('JsonRpc', {},{ gasPrice: 0 });
-        await lending.oneWayfactory.fetchMarkets();
+        await llamalend.init('JsonRpc', {},{ gasPrice: 0 });
+        await llamalend.oneWayfactory.fetchMarkets();
     });
 
     for (const oneWayMarketId of ONE_WAY_MARKETS) {