@compass-labs/api-sdk 0.5.44 → 0.5.46

package/src/funcs/erc4626VaultsDeposit.ts

@@ -32,6 +32,13 @@ import { Result } from "../types/fp.js";
  * Deposit tokens into a Vault (ERC-4626 Standard) to earn passive yield.
  *
  * Each vault accepts one unique token that can be deposited.
+ * <Info>
+ *   **Required Allowances**
+ *
+ *     In order to make this transaction, token allowances need to be set on the following contracts.
+ *
+ *  - `<vault_address>`
+ * </Info>
  */
 export function erc4626VaultsDeposit(
   client: CompassApiSDKCore,

package/src/funcs/erc4626VaultsWithdraw.ts

@@ -34,6 +34,13 @@ import { Result } from "../types/fp.js";
  * The passive yield earned on token deposits is represented by the increased value of
  * the shares received upon depositing tokens. Trade in these shares for the tokens you
  * deposited plus any accrued yield.
+ * <Info>
+ *   **Required Allowances**
+ *
+ *     In order to make this transaction, token allowances need to be set on the following contracts.
+ *
+ *  - `<vault address>`
+ * </Info>
  */
 export function erc4626VaultsWithdraw(
   client: CompassApiSDKCore,

package/src/funcs/morphoBorrow.ts

@@ -38,6 +38,13 @@ import { Result } from "../types/fp.js";
  * loan asset. Each market is isolated (meaning risks are contained within each
  * individual market), immutable (cannot be changed after deployment), and will persist
  * as long as the blockchain it is deployed on is live.
+ * <Info>
+ *   **Required Allowances**
+ *
+ *     In order to make this transaction, token allowances need to be set on the following contracts.
+ *
+ *  - `Morpho`
+ * </Info>
  */
 export function morphoBorrow(
   client: CompassApiSDKCore,

package/src/funcs/morphoDeposit.ts

@@ -40,6 +40,13 @@ import { Result } from "../types/fp.js";
  * exposure for all deposited assets so users don't need to make these decisions
  * themselves. Users maintain full control over their assets, can monitor the vault's
  * state at any time, and withdraw their liquidity at their discretion.
+ * <Info>
+ *   **Required Allowances**
+ *
+ *     In order to make this transaction, token allowances need to be set on the following contracts.
+ *
+ *  - `USDC`
+ * </Info>
  */
 export function morphoDeposit(
   client: CompassApiSDKCore,

package/src/funcs/morphoRepay.ts

@@ -35,6 +35,13 @@ import { Result } from "../types/fp.js";
  * loan asset. Each market is isolated (meaning risks are contained within each
  * individual market), immutable (cannot be changed after deployment), and will persist
  * as long as the blockchain it is deployed on is live.
+ * <Info>
+ *   **Required Allowances**
+ *
+ *     In order to make this transaction, token allowances need to be set on the following contracts.
+ *
+ *  - `Morpho`
+ * </Info>
  */
 export function morphoRepay(
   client: CompassApiSDKCore,

package/src/funcs/morphoSupplyCollateral.ts

@@ -35,6 +35,13 @@ import { Result } from "../types/fp.js";
  * loan asset. Each market is isolated (meaning risks are contained within each
  * individual market), immutable (cannot be changed after deployment), and will persist
  * as long as the blockchain it is deployed on is live.
+ * <Info>
+ *   **Required Allowances**
+ *
+ *     In order to make this transaction, token allowances need to be set on the following contracts.
+ *
+ *  - `Morpho`
+ * </Info>
  */
 export function morphoSupplyCollateral(
   client: CompassApiSDKCore,

package/src/funcs/morphoWithdraw.ts

@@ -40,6 +40,13 @@ import { Result } from "../types/fp.js";
  * exposure for all deposited assets so users don't need to make these decisions
  * themselves. Users maintain full control over their assets, can monitor the vault's
  * state at any time, and withdraw their liquidity at their discretion.
+ * <Info>
+ *   **Required Allowances**
+ *
+ *     In order to make this transaction, token allowances need to be set on the following contracts.
+ *
+ *  - `<token address>`
+ * </Info>
  */
 export function morphoWithdraw(
   client: CompassApiSDKCore,

package/src/funcs/morphoWithdrawCollateral.ts

@@ -35,6 +35,13 @@ import { Result } from "../types/fp.js";
  * loan asset. Each market is isolated (meaning risks are contained within each
  * individual market), immutable (cannot be changed after deployment), and will persist
  * as long as the blockchain it is deployed on is live.
+ * <Info>
+ *   **Required Allowances**
+ *
+ *     In order to make this transaction, token allowances need to be set on the following contracts.
+ *
+ *  - `Morpho`
+ * </Info>
  */
 export function morphoWithdrawCollateral(
   client: CompassApiSDKCore,

package/src/funcs/pendleAddLiquidity.ts

@@ -33,6 +33,13 @@ import { Result } from "../types/fp.js";
  *
  * Liquidity is added in the form of the market's Underlying Token. Representation of
  * the liquidity received is the market's Liquidity Provider Token (LP).
+ * <Info>
+ *   **Required Allowances**
+ *
+ *     In order to make this transaction, token allowances need to be set on the following contracts.
+ *
+ *  - `PendleRouter`
+ * </Info>
  */
 export function pendleAddLiquidity(
   client: CompassApiSDKCore,

package/src/funcs/pendleBuyPt.ts

@@ -30,6 +30,13 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  * Buy Principal Token (PT) with market's Underlying Token.
+ * <Info>
+ *   **Required Allowances**
+ *
+ *     In order to make this transaction, token allowances need to be set on the following contracts.
+ *
+ *  - `PendleRouter`
+ * </Info>
  */
 export function pendleBuyPt(
   client: CompassApiSDKCore,

package/src/funcs/pendleBuyYt.ts

@@ -30,6 +30,13 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  * Buy Yield Token (YT) with market's Underlying Token.
+ * <Info>
+ *   **Required Allowances**
+ *
+ *     In order to make this transaction, token allowances need to be set on the following contracts.
+ *
+ *  - `PendleRouter`
+ * </Info>
  */
 export function pendleBuyYt(
   client: CompassApiSDKCore,

package/src/funcs/pendleRedeemYield.ts

@@ -30,6 +30,13 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  * Redeem claimable yield from the market's associated Yield Token (YT).
+ * <Info>
+ *   **Required Allowances**
+ *
+ *     In order to make this transaction, token allowances need to be set on the following contracts.
+ *
+ *  - `PendleRouter`
+ * </Info>
  */
 export function pendleRedeemYield(
   client: CompassApiSDKCore,

package/src/funcs/pendleRemoveLiquidity.ts

@@ -34,6 +34,13 @@ import { Result } from "../types/fp.js";
  * Liquidity is removed in the form of the market's Liquidity Provider Token (LP) into
  * the market's Underlying Token. An appropriate allowance for the Pendle Router on the
  * market contract must be set beforehand
+ * <Info>
+ *   **Required Allowances**
+ *
+ *     In order to make this transaction, token allowances need to be set on the following contracts.
+ *
+ *  - `PendleRouter`
+ * </Info>
  */
 export function pendleRemoveLiquidity(
   client: CompassApiSDKCore,

package/src/funcs/pendleSellPt.ts

@@ -30,6 +30,13 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  * Sell Principal Token (PT) for the market's Underlying Token.
+ * <Info>
+ *   **Required Allowances**
+ *
+ *     In order to make this transaction, token allowances need to be set on the following contracts.
+ *
+ *  - `PendleRouter`
+ * </Info>
  */
 export function pendleSellPt(
   client: CompassApiSDKCore,

package/src/funcs/pendleSellYt.ts

@@ -30,6 +30,13 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  * Sell Yield Token (YT) for the market's Underlying Token.
+ * <Info>
+ *   **Required Allowances**
+ *
+ *     In order to make this transaction, token allowances need to be set on the following contracts.
+ *
+ *  - `PendleRouter`
+ * </Info>
  */
 export function pendleSellYt(
   client: CompassApiSDKCore,

package/src/funcs/skyBuy.ts

@@ -35,7 +35,14 @@ import { Result } from "../types/fp.js";
  * 'SkyDaiUsdsConverter' contract beforehand.
  *
  * If buying with USDC, user will need to set an allowance on the USDC contract for the
- * 'SkyDaiUsdsConverter' contract beforehand.
+ * 'SkyUsdcUsdsConverter' contract beforehand.
+ * <Info>
+ *   **Required Allowances**
+ *
+ *     In order to make this transaction, token allowances need to be set on the following contracts.
+ *
+ *  - `SkyUsdcUsdsConverter`
+ * </Info>
  */
 export function skyBuy(
   client: CompassApiSDKCore,

package/src/funcs/skyDeposit.ts

@@ -29,9 +29,18 @@ import { Result } from "../types/fp.js";
  * Deposit USDS
  *
  * @remarks
- * Deposit USDS for sUSDS to earn yield.
+ * Deposit USDS to earn yield. Deposited USDS is represented as sUSDS.
+ *
+ * Allowance must be set on USDS contract for UsdsVault.
  *
  * There are no fees.
+ * <Info>
+ *   **Required Allowances**
+ *
+ *     In order to make this transaction, token allowances need to be set on the following contracts.
+ *
+ *  - `SkyUsdsVault`
+ * </Info>
  */
 export function skyDeposit(
   client: CompassApiSDKCore,

package/src/funcs/skySell.ts

@@ -36,6 +36,13 @@ import { Result } from "../types/fp.js";
  *
  * If swapping to USDC, user will need to set an allowance on the USDS contract for the
  * 'SkyUsdcUsdsConverter' contract beforehand.
+ * <Info>
+ *   **Required Allowances**
+ *
+ *     In order to make this transaction, token allowances need to be set on the following contracts.
+ *
+ *  - `SkyUsdcUsdsConverter`
+ * </Info>
  */
 export function skySell(
   client: CompassApiSDKCore,

package/src/funcs/skyWithdraw.ts

@@ -29,7 +29,19 @@ import { Result } from "../types/fp.js";
  * Withdraw USDS
  *
  * @remarks
- * Withdraw USDS for sUSDS to stop earning yield.
+ * Withdraw USDS. Exchange yield-bearing sUSDS for USDS.
+ *
+ * Allowance must be set on USDS contract for UsdsVault.
+ *
+ * There are no fees.
+ * <Info>
+ *   **Required Allowances**
+ *
+ *     In order to make this transaction, token allowances need to be set on the following contracts.
+ *
+ *  - `SkyUsdcUsdsConverter`
+ *  - `SkyUsdsVault`
+ * </Info>
  */
 export function skyWithdraw(
   client: CompassApiSDKCore,

package/src/funcs/uniswapV3LiquidityProvisionIncrease.ts

@@ -38,6 +38,13 @@ import { Result } from "../types/fp.js";
  * within the pool. The endpoint requires details such as the token pair, additional
  * amount to be added, and any other parameters necessary for the liquidity increase
  * process.
+ * <Info>
+ *   **Required Allowances**
+ *
+ *     In order to make this transaction, token allowances need to be set on the following contracts.
+ *
+ *  - `AerodromeSlipstreamRouter`
+ * </Info>
  */
 export function uniswapV3LiquidityProvisionIncrease(
   client: CompassApiSDKCore,

package/src/funcs/uniswapV3LiquidityProvisionMint.ts

@@ -38,6 +38,13 @@ import { Result } from "../types/fp.js";
  * enabling them to earn fees from trades that occur within the pool. The endpoint
  * requires details such as the token pair, amount, and any additional parameters
  * needed for the minting process.
+ * <Info>
+ *   **Required Allowances**
+ *
+ *     In order to make this transaction, token allowances need to be set on the following contracts.
+ *
+ *  - `UniswapV3NFTPositionManager`
+ * </Info>
  */
 export function uniswapV3LiquidityProvisionMint(
   client: CompassApiSDKCore,

package/src/funcs/uniswapV3LiquidityProvisionWithdraw.ts

@@ -39,6 +39,13 @@ import { Result } from "../types/fp.js";
  * amount to be withdrawn, and any additional parameters needed for the withdrawal
  * process. Users should ensure they meet any protocol requirements or conditions
  * before initiating a withdrawal to avoid potential issues or penalties.
+ * <Info>
+ *   **Required Allowances**
+ *
+ *     In order to make this transaction, token allowances need to be set on the following contracts.
+ *
+ *  - `UniswapV3NFTPositionManager`
+ * </Info>
  */
 export function uniswapV3LiquidityProvisionWithdraw(
   client: CompassApiSDKCore,

package/src/funcs/uniswapV3SwapBuyExactly.ts

@@ -36,6 +36,13 @@ import { Result } from "../types/fp.js";
  * provide the necessary transaction details, including the token to buy, the token to
  * pay with, and the exact amount to receive. If the token being paid with is WETH and
  * needs to be wrapped, the appropriate amount will be wrapped automatically.
+ * <Info>
+ *   **Required Allowances**
+ *
+ *     In order to make this transaction, token allowances need to be set on the following contracts.
+ *
+ *  - `UniswapV3Router`
+ * </Info>
  */
 export function uniswapV3SwapBuyExactly(
   client: CompassApiSDKCore,

package/src/funcs/uniswapV3SwapSellExactly.ts

@@ -36,6 +36,13 @@ import { Result } from "../types/fp.js";
  * provide the necessary transaction details, including the token to sell, the token to
  * receive, and the amount to sell. If the token being sold is WETH and needs to be
  * wrapped, the appropriate amount will be wrapped automatically.
+ * <Info>
+ *   **Required Allowances**
+ *
+ *     In order to make this transaction, token allowances need to be set on the following contracts.
+ *
+ *  - `UniswapV3Router`
+ * </Info>
  */
 export function uniswapV3SwapSellExactly(
   client: CompassApiSDKCore,

package/src/lib/config.ts

@@ -61,8 +61,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.0.1",
-  sdkVersion: "0.5.44",
+  sdkVersion: "0.5.46",
   genVersion: "2.656.5",
   userAgent:
-    "speakeasy-sdk/typescript 0.5.44 2.656.5 0.0.1 @compass-labs/api-sdk",
+    "speakeasy-sdk/typescript 0.5.46 2.656.5 0.0.1 @compass-labs/api-sdk",
 } as const;

package/src/mcp-server/mcp-server.ts

@@ -19,7 +19,7 @@ const routes = buildRouteMap({
 export const app = buildApplication(routes, {
   name: "mcp",
   versionInfo: {
-    currentVersion: "0.5.44",
+    currentVersion: "0.5.46",
   },
 });
 

package/src/mcp-server/server.ts

@@ -101,7 +101,7 @@ export function createMCPServer(deps: {
 }) {
   const server = new McpServer({
     name: "CompassApiSDK",
-    version: "0.5.44",
+    version: "0.5.46",
   });
 
   const client = new CompassApiSDKCore({

package/src/mcp-server/tools/aaveV3Borrow.ts

@@ -17,7 +17,15 @@ export const tool$aaveV3Borrow: ToolDefinition<typeof args> = {
 You will pay interest for your borrows.
 
 Price changes in the assets may lead to some or all of your collateral being
-liquidated, if the borrow position becomes unhealthy.`,
+liquidated, if the borrow position becomes unhealthy.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - \`AaveV3Pool\`
+</Info>
+`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await aaveV3Borrow(

package/src/mcp-server/tools/aaveV3Repay.ts

@@ -21,7 +21,15 @@ By repaying borrowed amounts, users can improve their health factor, which is a
 measure of the safety of their loan position. A higher health factor reduces the
 risk of liquidation, ensuring a more secure borrowing experience. The endpoint
 requires specifying the chain and the details of the repayment transaction,
-including the amount and the asset to be repaid.`,
+including the amount and the asset to be repaid.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - \`AaveV3Pool\`
+</Info>
+`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await aaveV3Repay(

package/src/mcp-server/tools/aaveV3Supply.ts

@@ -22,7 +22,15 @@ create leverage.
 
 Overall, this endpoint is a critical component for users looking to maximize their
 asset utility within the AAVEv3 ecosystem, providing both earning potential and
-borrowing flexibility.`,
+borrowing flexibility.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - \`AaveV3Pool\`
+</Info>
+`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await aaveV3Supply(

package/src/mcp-server/tools/aaveV3Withdraw.ts

@@ -22,7 +22,15 @@ includes the collection of any interest earned on the collateral. It is importan
 for users to carefully consider their outstanding debts and the potential impact on
 their liquidation threshold before proceeding with a withdrawal. This endpoint is
 designed to provide a seamless and efficient way to manage your collateral within
-the Aave ecosystem.`,
+the Aave ecosystem.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - \`AaveV3Pool\`
+</Info>
+`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await aaveV3Withdraw(

package/src/mcp-server/tools/aerodromeSlipstreamSlipstreamLiquidityProvisionIncrease.ts

@@ -27,7 +27,15 @@ The response will confirm the successful increase of the LP position, providing
 users with updated information about their enhanced position. This functionality is
 vital for users aiming to optimize their liquidity provision strategy, enabling them
 to adapt to market conditions and maximize their returns in decentralized finance
-(DeFi) markets.`,
+(DeFi) markets.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - \`AerodromeSlipstreamRouter\`
+</Info>
+`,
     args,
     tool: async (client, args, ctx) => {
       const [result, apiCall] =

package/src/mcp-server/tools/aerodromeSlipstreamSlipstreamLiquidityProvisionMint.ts

@@ -24,7 +24,15 @@ specified parameters, such as token amounts and pool details. The response will
 confirm the successful creation of the LP position, providing users with the
 necessary information to manage their newly minted position. This functionality is
 crucial for users looking to expand their liquidity provision activities, offering
-them the opportunity to engage in decentralized finance (DeFi) markets effectively.`,
+them the opportunity to engage in decentralized finance (DeFi) markets effectively.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - \`AerodromeSlipstreamNonfungiblePositionManager\`
+</Info>
+`,
     args,
     tool: async (client, args, ctx) => {
       const [result, apiCall] =

package/src/mcp-server/tools/aerodromeSlipstreamSlipstreamLiquidityProvisionWithdraw.ts

@@ -27,7 +27,15 @@ tokens and any remaining balances. This functionality is essential for users who
 wish to exit their liquidity provision activities, enabling them to reclaim their
 assets and potentially reallocate them to other investment opportunities. The
 endpoint ensures a smooth and secure withdrawal process, facilitating users'
-strategic management of their decentralized finance (DeFi) portfolios.`,
+strategic management of their decentralized finance (DeFi) portfolios.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - \`AerodromeSlipstreamNonfungiblePositionManager\`
+</Info>
+`,
     args,
     tool: async (client, args, ctx) => {
       const [result, apiCall] =

package/src/mcp-server/tools/aerodromeSlipstreamSlipstreamSwapBuyExactly.ts

@@ -25,7 +25,15 @@ particularly useful for users who have a specific target amount of the output to
 in mind and are willing to provide the corresponding input token amount. The
 transaction is executed with consideration of current market conditions, including
 liquidity and price impact, ensuring that the trade is completed efficiently and
-effectively.`,
+effectively.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - \`AerodromeSlipstreamRouter\`
+</Info>
+`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await aerodromeSlipstreamSlipstreamSwapBuyExactly(

package/src/mcp-server/tools/aerodromeSlipstreamSlipstreamSwapSellExactly.ts

@@ -24,7 +24,15 @@ sold, and the system calculates the amount of the output token that will be
 received. The operation ensures that the trade is conducted within the constraints
 of the current market conditions, taking into account the liquidity and price
 impact. This endpoint is suitable for users who want to sell a precise quantity of a
-token and are willing to accept the resulting amount of the other token.`,
+token and are willing to accept the resulting amount of the other token.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - \`AerodromeSlipstreamRouter\`
+</Info>
+`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] =

package/src/mcp-server/tools/erc4626VaultsDeposit.ts

@@ -16,7 +16,15 @@ export const tool$erc4626VaultsDeposit: ToolDefinition<typeof args> = {
 
 Deposit tokens into a Vault (ERC-4626 Standard) to earn passive yield.
 
-Each vault accepts one unique token that can be deposited.`,
+Each vault accepts one unique token that can be deposited.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - \`<vault_address>\`
+</Info>
+`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await erc4626VaultsDeposit(

package/src/mcp-server/tools/erc4626VaultsWithdraw.ts

@@ -18,7 +18,15 @@ Withdraw deposited tokens from a Vault (ERC-4626 Standard).
 
 The passive yield earned on token deposits is represented by the increased value of
 the shares received upon depositing tokens. Trade in these shares for the tokens you
-deposited plus any accrued yield.`,
+deposited plus any accrued yield.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - \`<vault address>\`
+</Info>
+`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await erc4626VaultsWithdraw(

package/src/mcp-server/tools/morphoBorrow.ts

@@ -22,7 +22,15 @@ Liquidation Loan-To-Value (LLTV) threshold of the market.
 A Morpho Market is a primitive lending pool that pairs one collateral asset with one
 loan asset. Each market is isolated (meaning risks are contained within each
 individual market), immutable (cannot be changed after deployment), and will persist
-as long as the blockchain it is deployed on is live.`,
+as long as the blockchain it is deployed on is live.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - \`Morpho\`
+</Info>
+`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await morphoBorrow(

package/src/mcp-server/tools/morphoDeposit.ts

@@ -24,7 +24,15 @@ markets. Users can deposit into a vault to start earning passive yield from inte
 paid by borrowers. Vaults feature automated risk management, actively curating risk
 exposure for all deposited assets so users don't need to make these decisions
 themselves. Users maintain full control over their assets, can monitor the vault's
-state at any time, and withdraw their liquidity at their discretion.`,
+state at any time, and withdraw their liquidity at their discretion.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - \`USDC\`
+</Info>
+`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await morphoDeposit(