@compass-labs/api-sdk 0.5.44 → 0.5.46

package/docs/sdks/aavev3/README.md

@@ -707,6 +707,14 @@ 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.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - `AaveV3Pool`
+</Info>
+
 
 ### Example Usage
 
@@ -789,6 +797,14 @@ 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.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - `AaveV3Pool`
+</Info>
+
 
 ### Example Usage
 
@@ -877,6 +893,14 @@ 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.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - `AaveV3Pool`
+</Info>
+
 
 ### Example Usage
 
@@ -966,6 +990,14 @@ for users to carefully consider their outstanding debts and the potential impact
 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.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - `AaveV3Pool`
+</Info>
+
 
 ### Example Usage
 

package/docs/sdks/aerodromeslipstream/README.md

@@ -175,6 +175,14 @@ received. The operation ensures that the trade is conducted within the constrain
 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.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - `AerodromeSlipstreamRouter`
+</Info>
+
 
 ### Example Usage
 
@@ -269,6 +277,14 @@ 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.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - `AerodromeSlipstreamRouter`
+</Info>
+
 
 ### Example Usage
 
@@ -362,6 +378,14 @@ 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.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - `AerodromeSlipstreamNonfungiblePositionManager`
+</Info>
+
 
 ### Example Usage
 
@@ -467,6 +491,14 @@ users with updated information about their enhanced position. This functionality
 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.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - `AerodromeSlipstreamRouter`
+</Info>
+
 
 ### Example Usage
 
@@ -562,6 +594,14 @@ wish to exit their liquidity provision activities, enabling them to reclaim thei
 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.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - `AerodromeSlipstreamNonfungiblePositionManager`
+</Info>
+
 
 ### Example Usage
 

package/docs/sdks/erc4626vaults/README.md

@@ -85,6 +85,14 @@ run();
 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>
+
 
 ### Example Usage
 
@@ -168,6 +176,14 @@ 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.
+<Info>
+  **Required Allowances**
+
+    In order to make this transaction, token allowances need to be set on the following contracts.
+
+ - `<vault address>`
+</Info>
+
 
 ### Example Usage
 

package/docs/sdks/morpho/README.md

@@ -467,6 +467,14 @@ paid by borrowers. Vaults feature automated risk management, actively curating r
 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>
+
 
 ### Example Usage
 
@@ -556,6 +564,14 @@ paid by borrowers. Vaults feature automated risk management, actively curating r
 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>
+
 
 ### Example Usage
 
@@ -640,6 +656,14 @@ A Morpho Market is a primitive lending pool that pairs one collateral asset with
 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>
+
 
 ### Example Usage
 
@@ -724,6 +748,14 @@ A Morpho Market is a primitive lending pool that pairs one collateral asset with
 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>
+
 
 ### Example Usage
 
@@ -811,6 +843,14 @@ A Morpho Market is a primitive lending pool that pairs one collateral asset with
 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>
+
 
 ### Example Usage
 
@@ -895,6 +935,14 @@ A Morpho Market is a primitive lending pool that pairs one collateral asset with
 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>
+
 
 ### Example Usage
 

package/docs/sdks/pendle/README.md

@@ -311,6 +311,14 @@ run();
 ## buyPt
 
 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>
+
 
 ### Example Usage
 
@@ -392,6 +400,14 @@ run();
 ## sellPt
 
 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>
+
 
 ### Example Usage
 
@@ -473,6 +489,14 @@ run();
 ## buyYt
 
 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>
+
 
 ### Example Usage
 
@@ -554,6 +578,14 @@ run();
 ## sellYt
 
 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>
+
 
 ### Example Usage
 
@@ -635,6 +667,14 @@ run();
 ## redeemYield
 
 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>
+
 
 ### Example Usage
 
@@ -715,6 +755,14 @@ Add liquidity to a Pendle Market to earn yield.
 
 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>
+
 
 ### Example Usage
 
@@ -800,6 +848,14 @@ Remove liquidity from a Pendle Market.
 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>
+
 
 ### Example Usage
 

package/docs/sdks/sky/README.md

@@ -88,7 +88,15 @@ If buying with DAI, user will need to set an allowance on the DAI contract for t
 '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>
+
 
 ### Example Usage
 
@@ -172,6 +180,14 @@ If swapping to DAI, user will need to set an allowance on the USDS contract for
 
 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>
+
 
 ### Example Usage
 
@@ -248,9 +264,19 @@ run();
 
 ## deposit
 
-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>
+
 
 ### Example Usage
 
@@ -325,7 +351,20 @@ run();
 
 ## withdraw
 
-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>
+
 
 ### Example Usage
 

package/docs/sdks/token/README.md

@@ -97,7 +97,9 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.token.price({});
+  const result = await compassApiSDK.token.price({
+    token: "AAVE",
+  });
 
   console.log(result);
 }
@@ -120,7 +122,9 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await tokenPrice(compassApiSDK, {});
+  const res = await tokenPrice(compassApiSDK, {
+    token: "AAVE",
+  });
   if (res.ok) {
     const { value: result } = res;
     console.log(result);

package/docs/sdks/uniswapv3/README.md

@@ -401,6 +401,14 @@ The transaction is executed on the specified blockchain network, and the user mu
 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>
+
 
 ### Example Usage
 
@@ -494,6 +502,14 @@ The transaction is executed on the specified blockchain network, and the user mu
 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>
+
 
 ### Example Usage
 
@@ -589,6 +605,14 @@ This operation is essential for users looking to participate in liquidity provis
 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>
+
 
 ### Example Usage
 
@@ -692,6 +716,14 @@ beneficial for users who wish to enhance their potential earnings from trading f
 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>
+
 
 ### Example Usage
 
@@ -786,6 +818,14 @@ pools or investments. The endpoint requires details such as the token pair, the
 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>
+
 
 ### Example Usage
 

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@compass-labs/api-sdk",
-  "version": "0.5.44",
+  "version": "0.5.46",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@compass-labs/api-sdk",
-  "version": "0.5.44",
+  "version": "0.5.46",
   "author": "royalnine",
   "type": "module",
   "bin": {

package/src/funcs/aaveV3Borrow.ts

@@ -33,6 +33,13 @@ import { Result } from "../types/fp.js";
  *
  * Price changes in the assets may lead to some or all of your collateral being
  * 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>
  */
 export function aaveV3Borrow(
   client: CompassApiSDKCore,

package/src/funcs/aaveV3Repay.ts

@@ -37,6 +37,13 @@ import { Result } from "../types/fp.js";
  * 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.
+ * <Info>
+ *   **Required Allowances**
+ *
+ *     In order to make this transaction, token allowances need to be set on the following contracts.
+ *
+ *  - `AaveV3Pool`
+ * </Info>
  */
 export function aaveV3Repay(
   client: CompassApiSDKCore,

package/src/funcs/aaveV3Supply.ts

@@ -38,6 +38,13 @@ import { Result } from "../types/fp.js";
  * 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.
+ * <Info>
+ *   **Required Allowances**
+ *
+ *     In order to make this transaction, token allowances need to be set on the following contracts.
+ *
+ *  - `AaveV3Pool`
+ * </Info>
  */
 export function aaveV3Supply(
   client: CompassApiSDKCore,

package/src/funcs/aaveV3Withdraw.ts

@@ -38,6 +38,13 @@ import { Result } from "../types/fp.js";
  * 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.
+ * <Info>
+ *   **Required Allowances**
+ *
+ *     In order to make this transaction, token allowances need to be set on the following contracts.
+ *
+ *  - `AaveV3Pool`
+ * </Info>
  */
 export function aaveV3Withdraw(
   client: CompassApiSDKCore,

package/src/funcs/aerodromeSlipstreamSlipstreamLiquidityProvisionIncrease.ts

@@ -40,6 +40,13 @@ import { Result } from "../types/fp.js";
  * 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.
+ * <Info>
+ *   **Required Allowances**
+ *
+ *     In order to make this transaction, token allowances need to be set on the following contracts.
+ *
+ *  - `AerodromeSlipstreamRouter`
+ * </Info>
  */
 export function aerodromeSlipstreamSlipstreamLiquidityProvisionIncrease(
   client: CompassApiSDKCore,

package/src/funcs/aerodromeSlipstreamSlipstreamLiquidityProvisionMint.ts

@@ -38,6 +38,13 @@ import { Result } from "../types/fp.js";
  * 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.
+ * <Info>
+ *   **Required Allowances**
+ *
+ *     In order to make this transaction, token allowances need to be set on the following contracts.
+ *
+ *  - `AerodromeSlipstreamNonfungiblePositionManager`
+ * </Info>
  */
 export function aerodromeSlipstreamSlipstreamLiquidityProvisionMint(
   client: CompassApiSDKCore,

package/src/funcs/aerodromeSlipstreamSlipstreamLiquidityProvisionWithdraw.ts

@@ -40,6 +40,13 @@ import { Result } from "../types/fp.js";
  * 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.
+ * <Info>
+ *   **Required Allowances**
+ *
+ *     In order to make this transaction, token allowances need to be set on the following contracts.
+ *
+ *  - `AerodromeSlipstreamNonfungiblePositionManager`
+ * </Info>
  */
 export function aerodromeSlipstreamSlipstreamLiquidityProvisionWithdraw(
   client: CompassApiSDKCore,

package/src/funcs/aerodromeSlipstreamSlipstreamSwapBuyExactly.ts

@@ -39,6 +39,13 @@ import { Result } from "../types/fp.js";
  * transaction is executed with consideration of current market conditions, including
  * liquidity and price impact, ensuring that the trade is completed efficiently and
  * effectively.
+ * <Info>
+ *   **Required Allowances**
+ *
+ *     In order to make this transaction, token allowances need to be set on the following contracts.
+ *
+ *  - `AerodromeSlipstreamRouter`
+ * </Info>
  */
 export function aerodromeSlipstreamSlipstreamSwapBuyExactly(
   client: CompassApiSDKCore,

package/src/funcs/aerodromeSlipstreamSlipstreamSwapSellExactly.ts

@@ -38,6 +38,13 @@ import { Result } from "../types/fp.js";
  * 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.
+ * <Info>
+ *   **Required Allowances**
+ *
+ *     In order to make this transaction, token allowances need to be set on the following contracts.
+ *
+ *  - `AerodromeSlipstreamRouter`
+ * </Info>
  */
 export function aerodromeSlipstreamSlipstreamSwapSellExactly(
   client: CompassApiSDKCore,