From 03b3fa80dd6dee1dda403a91e15c3590c06182e0 Mon Sep 17 00:00:00 2001 From: Arihant Bansal <17180950+arihantbansal@users.noreply.github.com> Date: Tue, 26 Nov 2024 17:22:28 +0530 Subject: [PATCH] update readme --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 80d091d..45bddd7 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,9 @@ A powerful toolkit for interacting with the Solana blockchain, providing easy-to - Token swaps with customizable slippage - Direct routing options +- 🏦 Yield Farming + - Lend idle assets to earn interest with Lulo + - 🔗 LangChain Integration - Utilize LangChain tools for enhanced blockchain interactions - Access a suite of tools for balance checks, transfers, token deployments, and more @@ -93,6 +96,20 @@ const signature = await trade( ); ``` +### Lend Tokens + +```typescript +import { lend } from 'solana-agent-kit'; +import { PublicKey } from '@solana/web3.js'; + +const signature = await lendAsset( + agent, + new PublicKey('asset-mint'), + 100, // amount + "lulo-api-key" +); +``` + ## API Reference ### Core Functions @@ -115,6 +132,9 @@ Swap tokens using Jupiter Exchange integration. #### `get_balance(agent, token_address)` Check SOL or token balance for the agent's wallet. +#### `lendAsset(agent, assetMint, amount, apiKey)` +Lend idle assets to earn interest with Lulo. + ## Dependencies The toolkit relies on several key Solana and Metaplex libraries: