@lombard.finance/sdk-agentkit 0.1.0 → 0.2.0-canary.11

package/README.md

@@ -55,10 +55,10 @@ const agent = createReactAgent({ llm: yourModel, tools });
 | Action | Description |
 | ------ | ----------- |
 | `stake_btcb_to_lbtc` | Stake BTC.b to receive LBTC. Handles approval and fee authorization automatically |
-| `unstake_lbtc` | Unstake LBTC to native BTC (cross-chain) or BTC.b (same-chain) |
+| `unstake_lbtc_to_btc` | Unstake LBTC to native BTC (cross-chain) or BTC.b (same-chain) |
 | `redeem_lbtc_to_btcb` | Simple same-chain LBTC to BTC.b conversion |
-| `deploy_to_defi` | Deploy LBTC into a DeFi vault (Bitcoin Earn) for additional yield |
-| `claim_deposit` | Claim a notarized BTC deposit to mint LBTC |
+| `deploy_to_earn` | Deploy LBTC into a DeFi vault (Bitcoin Earn) for additional yield |
+| `claim_lbtc_deposit` | Claim a notarized BTC deposit to mint LBTC |
 
 ### Read Actions
 
@@ -68,7 +68,7 @@ const agent = createReactAgent({ llm: yourModel, tools });
 | `get_btcb_balance` | Check BTC.b balance for any address on the current chain |
 | `get_lbtc_exchange_rate` | Current LBTC/BTC exchange rate and minimum stake amount |
 | `get_deposit_status` | Track all deposits (pending, claimable, claimed, failed) |
-| `get_unstake_status` | Track all unstake and redemption operations |
+| `get_redemption_status` | Track all unstake and redemption operations |
 
 ## Supported Networks
 

package/dist/index.cjs

@@ -3264,7 +3264,7 @@ function _ts_metadata(k, v) {
         try {
             const resolved = resolveNetwork(walletProvider.getNetwork());
             if (!resolved) {
-                return formatError("unstake_lbtc", "Current network is not supported by Lombard");
+                return formatError("unstake_lbtc_to_btc", "Current network is not supported by Lombard");
             }
             const { chainId, env } = resolved;
             const account = walletProvider.getAddress();
@@ -3281,7 +3281,7 @@ function _ts_metadata(k, v) {
                     provider,
                     env
                 });
-                return formatSuccess("unstake_lbtc", {
+                return formatSuccess("unstake_lbtc_to_btc", {
                     txHash,
                     amount: args.amount,
                     to: "BTC",
@@ -3307,9 +3307,9 @@ function _ts_metadata(k, v) {
             if (args.recipient && args.recipient.toLowerCase() !== account.toLowerCase()) {
                 result.warning = "BTC.b redemption always sends to the connected wallet. The recipient address was ignored.";
             }
-            return formatSuccess("unstake_lbtc", result);
+            return formatSuccess("unstake_lbtc_to_btc", result);
         } catch (error) {
-            return formatError("unstake_lbtc", error);
+            return formatError("unstake_lbtc_to_btc", error);
         }
     }
     async redeemLbtcToBtcb(walletProvider, args) {
@@ -3345,7 +3345,7 @@ function _ts_metadata(k, v) {
         try {
             const resolved = resolveNetwork(walletProvider.getNetwork());
             if (!resolved) {
-                return formatError("deploy_to_defi", "Current network is not supported by Lombard");
+                return formatError("deploy_to_earn", "Current network is not supported by Lombard");
             }
             const { chainId } = resolved;
             const account = walletProvider.getAddress();
@@ -3360,20 +3360,20 @@ function _ts_metadata(k, v) {
                 rpcUrl: undefined,
                 env: resolved.env
             });
-            return formatSuccess("deploy_to_defi", {
+            return formatSuccess("deploy_to_earn", {
                 txHash,
                 amount: args.amount,
                 asset: "LBTC"
             });
         } catch (error) {
-            return formatError("deploy_to_defi", error);
+            return formatError("deploy_to_earn", error);
         }
     }
     async claimDeposit(walletProvider, args) {
         try {
             const resolved = resolveNetwork(walletProvider.getNetwork());
             if (!resolved) {
-                return formatError("claim_deposit", "Current network is not supported by Lombard");
+                return formatError("claim_lbtc_deposit", "Current network is not supported by Lombard");
             }
             const { chainId, env } = resolved;
             const account = walletProvider.getAddress();
@@ -3385,15 +3385,15 @@ function _ts_metadata(k, v) {
             });
             const deposit = deposits.find((d)=>d.txHash === args.depositTxHash);
             if (!deposit) {
-                return formatError("claim_deposit", `No deposit found with txHash: ${args.depositTxHash}`);
+                return formatError("claim_lbtc_deposit", `No deposit found with txHash: ${args.depositTxHash}`);
             }
             const status = sdk.getDepositStatus(deposit);
             if (status !== "claimable") {
                 const display = sdk.getDepositStatusDisplay(status);
-                return formatError("claim_deposit", `Deposit is not claimable. Current status: ${display.label} - ${display.description}`);
+                return formatError("claim_lbtc_deposit", `Deposit is not claimable. Current status: ${display.label} - ${display.description}`);
             }
             if (!deposit.rawPayload || !deposit.proof) {
-                return formatError("claim_deposit", "Deposit proof data is not yet available");
+                return formatError("claim_lbtc_deposit", "Deposit proof data is not yet available");
             }
             const txHash = await sdk.claimLBTC({
                 data: deposit.rawPayload,
@@ -3403,12 +3403,12 @@ function _ts_metadata(k, v) {
                 provider,
                 env
             });
-            return formatSuccess("claim_deposit", {
+            return formatSuccess("claim_lbtc_deposit", {
                 txHash,
                 depositTxHash: args.depositTxHash
             });
         } catch (error) {
-            return formatError("claim_deposit", error);
+            return formatError("claim_lbtc_deposit", error);
         }
     }
     // ─── Read Actions ───────────────────────────────────────────────────
@@ -3514,7 +3514,7 @@ function _ts_metadata(k, v) {
         try {
             const resolved = resolveNetwork(walletProvider.getNetwork());
             if (!resolved) {
-                return formatError("get_unstake_status", "Current network is not supported by Lombard");
+                return formatError("get_redemption_status", "Current network is not supported by Lombard");
             }
             const { env } = resolved;
             const address = args.address || walletProvider.getAddress();
@@ -3523,7 +3523,7 @@ function _ts_metadata(k, v) {
                 env
             });
             if (unstakes.length === 0) {
-                return formatSuccess("get_unstake_status", {
+                return formatSuccess("get_redemption_status", {
                     address,
                     unstakes: [],
                     message: "No unstakes found for this address"
@@ -3536,13 +3536,13 @@ function _ts_metadata(k, v) {
                     payoutTxHash: u.payoutTxHash || null,
                     toAddress: u.toAddress || null
                 }));
-            return formatSuccess("get_unstake_status", {
+            return formatSuccess("get_redemption_status", {
                 address,
                 totalUnstakes: unstakes.length,
                 unstakes: summaries
             });
         } catch (error) {
-            return formatError("get_unstake_status", error);
+            return formatError("get_redemption_status", error);
         }
     }
     // ─── Private Helpers ────────────────────────────────────────────────
@@ -3603,7 +3603,7 @@ _ts_decorate([
 ], LombardActionProvider.prototype, "stakeBtcbToLbtc", null);
 _ts_decorate([
     agentkit.CreateAction({
-        name: "unstake_lbtc",
+        name: "unstake_lbtc_to_btc",
         description: "Unstake LBTC (Lombard Staked Bitcoin). " + "Output can be native BTC (cross-chain, requires a Bitcoin address) or BTC.b (same EVM chain). " + "BTC unstaking takes longer as it crosses chains. BTC.b is faster, same-chain.",
         schema: UnstakeLbtcSchema
     }),
@@ -3617,7 +3617,7 @@ _ts_decorate([
 _ts_decorate([
     agentkit.CreateAction({
         name: "redeem_lbtc_to_btcb",
-        description: "Use this for simple same-chain LBTC to BTC.b conversion. " + "For cross-chain unstaking to native BTC, use unstake_lbtc instead.",
+        description: "Use this for simple same-chain LBTC to BTC.b conversion. " + "For cross-chain unstaking to native BTC, use unstake_lbtc_to_btc instead.",
         schema: RedeemLbtcToBtcbSchema
     }),
     _ts_metadata("design:type", Function),
@@ -3629,7 +3629,7 @@ _ts_decorate([
 ], LombardActionProvider.prototype, "redeemLbtcToBtcb", null);
 _ts_decorate([
     agentkit.CreateAction({
-        name: "deploy_to_defi",
+        name: "deploy_to_earn",
         description: "Deploy LBTC into a DeFi vault to earn additional yield. " + "Currently supports the Veda vault. " + "Handles approval automatically.",
         schema: DeployToDefiSchema
     }),
@@ -3642,7 +3642,7 @@ _ts_decorate([
 ], LombardActionProvider.prototype, "deployToDefi", null);
 _ts_decorate([
     agentkit.CreateAction({
-        name: "claim_deposit",
+        name: "claim_lbtc_deposit",
         description: "Claim a notarized deposit to mint LBTC. " + "Use get_deposit_status first to check if a deposit is claimable. " + 'Only deposits with status "claimable" can be claimed.',
         schema: ClaimDepositSchema
     }),
@@ -3695,7 +3695,7 @@ _ts_decorate([
 _ts_decorate([
     agentkit.CreateAction({
         name: "get_deposit_status",
-        description: "Check the status of all deposits for an address. " + "Shows pending, claimable, claimed, and failed deposits. " + "Use this to find claimable deposits before calling claim_deposit.",
+        description: "Check the status of all deposits for an address. " + "Shows pending, claimable, claimed, and failed deposits. " + "Use this to find claimable deposits before calling claim_lbtc_deposit.",
         schema: GetDepositStatusSchema
     }),
     _ts_metadata("design:type", Function),
@@ -3707,7 +3707,7 @@ _ts_decorate([
 ], LombardActionProvider.prototype, "getDepositStatusAction", null);
 _ts_decorate([
     agentkit.CreateAction({
-        name: "get_unstake_status",
+        name: "get_redemption_status",
         description: "Check the status of all unstake/redeem operations for an address. " + "Shows pending and completed unstakes with payout transaction details.",
         schema: GetUnstakeStatusSchema
     }),

package/dist/index.js

@@ -3260,7 +3260,7 @@ function _ts_metadata(k, v) {
         try {
             const resolved = resolveNetwork(walletProvider.getNetwork());
             if (!resolved) {
-                return formatError("unstake_lbtc", "Current network is not supported by Lombard");
+                return formatError("unstake_lbtc_to_btc", "Current network is not supported by Lombard");
             }
             const { chainId, env } = resolved;
             const account = walletProvider.getAddress();
@@ -3277,7 +3277,7 @@ function _ts_metadata(k, v) {
                     provider,
                     env
                 });
-                return formatSuccess("unstake_lbtc", {
+                return formatSuccess("unstake_lbtc_to_btc", {
                     txHash,
                     amount: args.amount,
                     to: "BTC",
@@ -3303,9 +3303,9 @@ function _ts_metadata(k, v) {
             if (args.recipient && args.recipient.toLowerCase() !== account.toLowerCase()) {
                 result.warning = "BTC.b redemption always sends to the connected wallet. The recipient address was ignored.";
             }
-            return formatSuccess("unstake_lbtc", result);
+            return formatSuccess("unstake_lbtc_to_btc", result);
         } catch (error) {
-            return formatError("unstake_lbtc", error);
+            return formatError("unstake_lbtc_to_btc", error);
         }
     }
     async redeemLbtcToBtcb(walletProvider, args) {
@@ -3341,7 +3341,7 @@ function _ts_metadata(k, v) {
         try {
             const resolved = resolveNetwork(walletProvider.getNetwork());
             if (!resolved) {
-                return formatError("deploy_to_defi", "Current network is not supported by Lombard");
+                return formatError("deploy_to_earn", "Current network is not supported by Lombard");
             }
             const { chainId } = resolved;
             const account = walletProvider.getAddress();
@@ -3356,20 +3356,20 @@ function _ts_metadata(k, v) {
                 rpcUrl: undefined,
                 env: resolved.env
             });
-            return formatSuccess("deploy_to_defi", {
+            return formatSuccess("deploy_to_earn", {
                 txHash,
                 amount: args.amount,
                 asset: "LBTC"
             });
         } catch (error) {
-            return formatError("deploy_to_defi", error);
+            return formatError("deploy_to_earn", error);
         }
     }
     async claimDeposit(walletProvider, args) {
         try {
             const resolved = resolveNetwork(walletProvider.getNetwork());
             if (!resolved) {
-                return formatError("claim_deposit", "Current network is not supported by Lombard");
+                return formatError("claim_lbtc_deposit", "Current network is not supported by Lombard");
             }
             const { chainId, env } = resolved;
             const account = walletProvider.getAddress();
@@ -3381,15 +3381,15 @@ function _ts_metadata(k, v) {
             });
             const deposit = deposits.find((d)=>d.txHash === args.depositTxHash);
             if (!deposit) {
-                return formatError("claim_deposit", `No deposit found with txHash: ${args.depositTxHash}`);
+                return formatError("claim_lbtc_deposit", `No deposit found with txHash: ${args.depositTxHash}`);
             }
             const status = getDepositStatus(deposit);
             if (status !== "claimable") {
                 const display = getDepositStatusDisplay(status);
-                return formatError("claim_deposit", `Deposit is not claimable. Current status: ${display.label} - ${display.description}`);
+                return formatError("claim_lbtc_deposit", `Deposit is not claimable. Current status: ${display.label} - ${display.description}`);
             }
             if (!deposit.rawPayload || !deposit.proof) {
-                return formatError("claim_deposit", "Deposit proof data is not yet available");
+                return formatError("claim_lbtc_deposit", "Deposit proof data is not yet available");
             }
             const txHash = await claimLBTC({
                 data: deposit.rawPayload,
@@ -3399,12 +3399,12 @@ function _ts_metadata(k, v) {
                 provider,
                 env
             });
-            return formatSuccess("claim_deposit", {
+            return formatSuccess("claim_lbtc_deposit", {
                 txHash,
                 depositTxHash: args.depositTxHash
             });
         } catch (error) {
-            return formatError("claim_deposit", error);
+            return formatError("claim_lbtc_deposit", error);
         }
     }
     // ─── Read Actions ───────────────────────────────────────────────────
@@ -3510,7 +3510,7 @@ function _ts_metadata(k, v) {
         try {
             const resolved = resolveNetwork(walletProvider.getNetwork());
             if (!resolved) {
-                return formatError("get_unstake_status", "Current network is not supported by Lombard");
+                return formatError("get_redemption_status", "Current network is not supported by Lombard");
             }
             const { env } = resolved;
             const address = args.address || walletProvider.getAddress();
@@ -3519,7 +3519,7 @@ function _ts_metadata(k, v) {
                 env
             });
             if (unstakes.length === 0) {
-                return formatSuccess("get_unstake_status", {
+                return formatSuccess("get_redemption_status", {
                     address,
                     unstakes: [],
                     message: "No unstakes found for this address"
@@ -3532,13 +3532,13 @@ function _ts_metadata(k, v) {
                     payoutTxHash: u.payoutTxHash || null,
                     toAddress: u.toAddress || null
                 }));
-            return formatSuccess("get_unstake_status", {
+            return formatSuccess("get_redemption_status", {
                 address,
                 totalUnstakes: unstakes.length,
                 unstakes: summaries
             });
         } catch (error) {
-            return formatError("get_unstake_status", error);
+            return formatError("get_redemption_status", error);
         }
     }
     // ─── Private Helpers ────────────────────────────────────────────────
@@ -3599,7 +3599,7 @@ _ts_decorate([
 ], LombardActionProvider.prototype, "stakeBtcbToLbtc", null);
 _ts_decorate([
     CreateAction({
-        name: "unstake_lbtc",
+        name: "unstake_lbtc_to_btc",
         description: "Unstake LBTC (Lombard Staked Bitcoin). " + "Output can be native BTC (cross-chain, requires a Bitcoin address) or BTC.b (same EVM chain). " + "BTC unstaking takes longer as it crosses chains. BTC.b is faster, same-chain.",
         schema: UnstakeLbtcSchema
     }),
@@ -3613,7 +3613,7 @@ _ts_decorate([
 _ts_decorate([
     CreateAction({
         name: "redeem_lbtc_to_btcb",
-        description: "Use this for simple same-chain LBTC to BTC.b conversion. " + "For cross-chain unstaking to native BTC, use unstake_lbtc instead.",
+        description: "Use this for simple same-chain LBTC to BTC.b conversion. " + "For cross-chain unstaking to native BTC, use unstake_lbtc_to_btc instead.",
         schema: RedeemLbtcToBtcbSchema
     }),
     _ts_metadata("design:type", Function),
@@ -3625,7 +3625,7 @@ _ts_decorate([
 ], LombardActionProvider.prototype, "redeemLbtcToBtcb", null);
 _ts_decorate([
     CreateAction({
-        name: "deploy_to_defi",
+        name: "deploy_to_earn",
         description: "Deploy LBTC into a DeFi vault to earn additional yield. " + "Currently supports the Veda vault. " + "Handles approval automatically.",
         schema: DeployToDefiSchema
     }),
@@ -3638,7 +3638,7 @@ _ts_decorate([
 ], LombardActionProvider.prototype, "deployToDefi", null);
 _ts_decorate([
     CreateAction({
-        name: "claim_deposit",
+        name: "claim_lbtc_deposit",
         description: "Claim a notarized deposit to mint LBTC. " + "Use get_deposit_status first to check if a deposit is claimable. " + 'Only deposits with status "claimable" can be claimed.',
         schema: ClaimDepositSchema
     }),
@@ -3691,7 +3691,7 @@ _ts_decorate([
 _ts_decorate([
     CreateAction({
         name: "get_deposit_status",
-        description: "Check the status of all deposits for an address. " + "Shows pending, claimable, claimed, and failed deposits. " + "Use this to find claimable deposits before calling claim_deposit.",
+        description: "Check the status of all deposits for an address. " + "Shows pending, claimable, claimed, and failed deposits. " + "Use this to find claimable deposits before calling claim_lbtc_deposit.",
         schema: GetDepositStatusSchema
     }),
     _ts_metadata("design:type", Function),
@@ -3703,7 +3703,7 @@ _ts_decorate([
 ], LombardActionProvider.prototype, "getDepositStatusAction", null);
 _ts_decorate([
     CreateAction({
-        name: "get_unstake_status",
+        name: "get_redemption_status",
         description: "Check the status of all unstake/redeem operations for an address. " + "Shows pending and completed unstakes with payout transaction details.",
         schema: GetUnstakeStatusSchema
     }),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lombard.finance/sdk-agentkit",
-  "version": "0.1.0",
+  "version": "0.2.0-canary.11",
   "description": "Lombard Action Provider for Coinbase AgentKit - stake BTC, mint LBTC, and interact with DeFi via AI agents",
   "exports": {
     ".": {
@@ -57,8 +57,8 @@
     "zod": "^3.22.0"
   },
   "dependencies": {
-    "@lombard.finance/sdk": "5.0.4",
-    "@lombard.finance/sdk-common": "4.0.0",
+    "@lombard.finance/sdk": "5.1.0-canary.11",
+    "@lombard.finance/sdk-common": "4.1.0-canary.11",
     "reflect-metadata": "^0.2.2"
   },
   "devDependencies": {