Add examples

Author: jimmy-openlev

.gitignore

@@ -1,3 +1,4 @@
 dist
 node_modules
 /.idea/
+/build/

README.md

@@ -1 +1,30 @@
-# openleverage-ts-sdk
+# OpenLeverage TypeScript SDK
+
+## Alpha Software
+This SDK is currently considered Alpha software and is under active development. It may contain bugs or undergo significant changes. If you have questions or encounter issues, feel free to join our #dev-chat channel on Discord. Pull requests are welcome!
+
+## Description
+OpenLeverage TypeScript SDK provides a set of utilities and tools for interacting with the OpenLeverage protocol. This SDK is designed to help developers build and integrate applications with OpenLeverage more efficiently.
+
+## Current Features:
+- JSON API to read lending pool information.
+- Lending:
+  - Deposit: Users can deposit their tokens to any pool. 
+  - Withdrawal: Users can withdraw their tokens.
+
+## Upcoming Features:
+- Borrowing: Users will be able to borrow assets.
+- Margin Trade: Enabling leveraged trading of assets with DEX and aggregator integration.
+
+## Build
+```console
+yarn build
+```
+
+## Run Examples
+```console
+tsx src/examples/<example_script_name>.ts
+```
+
+## Contributing
+We welcome contributions! Please see our [Grants Program](https://openleverage.notion.site/OpenLeverage-Grants-Program-63bcd1cd95f242ae8f654230d54340a4?pvs=4) for more details.

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@openleverage/sdk",
   "license": "MIT",
-  "version": "1.0.0",
+  "version": "0.1.0",
   "type": "module",
   "description": "⚒️ An SDK for building applications on top of OpenLeverage",
   "main": "dist/index.js",
@@ -20,15 +20,15 @@
   "scripts": {
     "build": "tsdx build",
     "start": "tsdx watch",
-    "test": "tsdx test",
-    "prepublishOnly": "tsdx build"
+    "test": "tsdx test"
   },
   "dependencies": {
     "@ethersproject/address": "^5.0.2",
     "big.js": "^5.2.2",
     "decimal.js-light": "^2.5.0",
     "ethers": "^6.8.0",
     "jsbi": "^3.1.4",
+    "node-fetch": "^3.3.2",
     "tiny-invariant": "^1.1.0",
     "toformat": "^2.0.0"
   },

src/addresses.ts

@@ -1,37 +1,61 @@
-export enum ChainId {
-  MAINNET = 1,
-  GOERLI = 5,
-  SEPOLIA = 11155111,
-  OPTIMISM = 10,
-  OPTIMISM_GOERLI = 420,
-  ARBITRUM_ONE = 42161,
-  ARBITRUM_GOERLI = 421613,
-  POLYGON = 137,
-  POLYGON_MUMBAI = 80001,
-  CELO = 42220,
-  CELO_ALFAJORES = 44787,
-  GNOSIS = 100,
-  MOONBEAM = 1284,
-  BNB = 56,
-  AVALANCHE = 43114,
-  BASE_GOERLI = 84531,
-  BASE = 8453
+export enum Chain {
+  ETHEREUM = "ETHEREUM",
+  ARBITRUM_ONE = "ARBITRUM_ONE",
+  BNB = "BNB"
 }
 
-export const SUPPORTED_CHAINS = [
-  ChainId.MAINNET,
-  ChainId.ARBITRUM_ONE,
-  ChainId.BNB
-] as const
-export type SupportedChainsType = typeof SUPPORTED_CHAINS[number]
+type ChainAddresses = {
+  lpoolDepositor: string
+}
 
 export enum NativeCurrencyName {
   // Strings match input for CLI
   ETHER = 'ETH',
-  MATIC = 'MATIC',
-  CELO = 'CELO',
-  GNOSIS = 'XDAI',
-  MOONBEAM = 'GLMR',
-  BNB = 'BNB',
-  AVAX = 'AVAX'
+  BNB = 'BNB'
+}
+
+type ChainInfo = {
+  chainId: number;
+  rpc: string;
+  addresses: ChainAddresses;
+  nativeCurrency: NativeCurrencyName;
+  poolInfoUrl: string;
+};
+
+
+const MAINNET_ADDRESSES: ChainAddresses = {
+  lpoolDepositor: '0xA6C4bB39F031CC74d4bd005A764E152970762561'
 }
+
+const BNB_ADDRESSES: ChainAddresses = {
+  lpoolDepositor: '0x73FB88ffF5F22ea7276F73832C6334696b7A3541'
+}
+
+const ARBITRUM_ONE_ADDRESSES: ChainAddresses = {
+  lpoolDepositor: '0x3C54c8309c6aE22cEaef9b6aeb94668d7ad7846b'
+}
+
+export const chainInfos: { [key in Chain]: ChainInfo } = {
+  [Chain.ETHEREUM]: {
+    chainId: 1,
+    rpc: "https://ethereum.publicnode.com",
+    addresses: MAINNET_ADDRESSES,
+    nativeCurrency: NativeCurrencyName.ETHER,
+    poolInfoUrl: "N/A"
+  },
+  [Chain.BNB]: {
+    chainId: 56,
+    rpc: "https://bsc-dataseed4.binance.org",
+    addresses: BNB_ADDRESSES,
+    nativeCurrency: NativeCurrencyName.BNB,
+    poolInfoUrl: "https://bnb.openleverage.finance/api/info/pools/interest"
+  },
+  [Chain.ARBITRUM_ONE]: {
+    chainId: 42161,
+    rpc: "https://arb1.arbitrum.io/rpc",
+    addresses: ARBITRUM_ONE_ADDRESSES,
+    nativeCurrency: NativeCurrencyName.ETHER,
+    poolInfoUrl: "https://arbitrum.openleverage.finance/api/info/pools/interest"
+  },
+};
+

src/chains.ts

@@ -0,0 +1,34 @@
+import {ethers} from "ethers";
+import {LPoolDepositor} from "../lpoolDepositor";
+import {chainInfos} from "../chains";
+
+// Example of depositing ERC20 tokens
+
+const PRIVATE_KEY = "YOUR_PRIVATE_KEY_HERE";
+
+let chain = chainInfos.BNB;
+const provider = new ethers.JsonRpcProvider(chain.rpc);
+
+// Create a wallet from a private key
+const wallet = new ethers.Wallet(PRIVATE_KEY);
+
+// Connect the wallet to the provider
+const signer = wallet.connect(provider);
+const lpoolDepositor = new LPoolDepositor({provider, signer, contractAddress: chain.addresses.lpoolDepositor});
+const usdcAddress = "0x8AC76a51cc950d9822D68b83fE1Ad97B32Cd580d";
+
+const erc20Abi = [
+    "function approve(address spender, uint256 amount) public returns (bool)"
+];
+
+const usdcContract = new ethers.Contract(usdcAddress, erc20Abi, signer);
+
+// You can change poolAddress and amount
+const usdcEthPool = "0x360e4262c1eb19529c00009eab9f91360d664bf3";
+const amount = 10;
+
+// First, approve the LPoolDepositor contract to move your USDC
+const approveTx = await usdcContract.approve(chain.addresses.lpoolDepositor, ethers.parseUnits(amount.toString(), 18));
+await approveTx.wait();
+
+await lpoolDepositor.deposit(usdcEthPool, ethers.parseUnits(amount.toString(), 18));

src/examples.js

@@ -0,0 +1,17 @@
+
+import {ethers} from "ethers";
+import {LPoolDepositor} from "../lpoolDepositor";
+import {chainInfos} from "../chains";
+
+let chain = chainInfos.BNB;
+
+const PRIVATE_KEY = "YOUR_PRIVATE_KEY_HERE";
+
+const provider = new ethers.JsonRpcProvider(chain.rpc);
+const wallet = new ethers.Wallet(PRIVATE_KEY);
+const signer = wallet.connect(provider);
+const lpoolDepositor = new LPoolDepositor({ provider, signer, contractAddress: chain.addresses.lpoolDepositor });
+const bnbUsdtPool = "0x7c5e04894410e98b1788fbdb181ffacbf8e60617";
+const amount = 0.001;
+
+await lpoolDepositor.depositNative(bnbUsdtPool, amount);

src/examples.ts

@@ -0,0 +1,15 @@
+
+import {PoolDataFetcher} from "../poolDataFetcher";
+import {chainInfos} from "../chains";
+
+const fetcher = new PoolDataFetcher(chainInfos.BNB.poolInfoUrl);
+
+fetcher.fetchPoolData()
+    .then(data => {
+        // Do something with the data
+        console.log(data);
+    })
+    .catch(error => {
+        // Handle the error
+        console.error(`Error fetching data: ${error}`);
+    });