@compass-labs/api-sdk 0.0.24 → 0.0.26

package/docs/sdks/aerodromeslipstream/README.md

@@ -207,12 +207,12 @@ const compassApiSDK = new CompassApiSDK({
 
 async function run() {
   const result = await compassApiSDK.aerodromeSlipstream.slipstreamSwapSellExactly({
-    tokenIn: "FRAX",
-    tokenOut: "cbETH",
-    tickSpacing: 500,
+    tokenIn: "WETH",
+    tokenOut: "rsETH",
+    tickSpacing: 7000,
     amountIn: 1.5,
     amountOutMinimum: 1.4,
-    chain: "base:mainnet",
+    chain: "arbitrum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
@@ -239,12 +239,12 @@ const compassApiSDK = new CompassApiSDKCore({
 
 async function run() {
   const res = await aerodromeSlipstreamSlipstreamSwapSellExactly(compassApiSDK, {
-    tokenIn: "FRAX",
-    tokenOut: "cbETH",
-    tickSpacing: 500,
+    tokenIn: "WETH",
+    tokenOut: "rsETH",
+    tickSpacing: 7000,
     amountIn: 1.5,
     amountOutMinimum: 1.4,
-    chain: "base:mainnet",
+    chain: "arbitrum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
@@ -305,12 +305,12 @@ const compassApiSDK = new CompassApiSDK({
 
 async function run() {
   const result = await compassApiSDK.aerodromeSlipstream.slipstreamSwapBuyExactly({
-    tokenIn: "UNI",
-    tokenOut: "cbETH",
-    tickSpacing: 6000,
+    tokenIn: "USDCe",
+    tokenOut: "LINK",
+    tickSpacing: 2700,
     amountOut: 1.5,
     amountInMaximum: 1.6,
-    chain: "ethereum:mainnet",
+    chain: "arbitrum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
@@ -337,12 +337,12 @@ const compassApiSDK = new CompassApiSDKCore({
 
 async function run() {
   const res = await aerodromeSlipstreamSlipstreamSwapBuyExactly(compassApiSDK, {
-    tokenIn: "UNI",
-    tokenOut: "cbETH",
-    tickSpacing: 6000,
+    tokenIn: "USDCe",
+    tokenOut: "LINK",
+    tickSpacing: 2700,
     amountOut: 1.5,
     amountInMaximum: 1.6,
-    chain: "ethereum:mainnet",
+    chain: "arbitrum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
@@ -403,8 +403,8 @@ const compassApiSDK = new CompassApiSDK({
 async function run() {
   const result = await compassApiSDK.aerodromeSlipstream.slipstreamLiquidityProvisionMint({
     token0: "STG",
-    token1: "GHO",
-    tickSpacing: 5000,
+    token1: "RPL",
+    tickSpacing: 1500,
     tickLower: -1000,
     tickUpper: 1000,
     amount0Desired: "1.5",
@@ -412,7 +412,7 @@ async function run() {
     amount0Min: "1.4",
     amount1Min: "1.6",
     recipient: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
-    chain: "base:mainnet",
+    chain: "arbitrum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
@@ -440,8 +440,8 @@ const compassApiSDK = new CompassApiSDKCore({
 async function run() {
   const res = await aerodromeSlipstreamSlipstreamLiquidityProvisionMint(compassApiSDK, {
     token0: "STG",
-    token1: "GHO",
-    tickSpacing: 5000,
+    token1: "RPL",
+    tickSpacing: 1500,
     tickLower: -1000,
     tickUpper: 1000,
     amount0Desired: "1.5",
@@ -449,7 +449,7 @@ async function run() {
     amount0Min: "1.4",
     amount1Min: "1.6",
     recipient: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
-    chain: "base:mainnet",
+    chain: "arbitrum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
@@ -511,7 +511,7 @@ const compassApiSDK = new CompassApiSDK({
 
 async function run() {
   const result = await compassApiSDK.aerodromeSlipstream.slipstreamLiquidityProvisionIncrease({
-    tokenId: 88456,
+    tokenId: 708272,
     amount0Desired: "1.5",
     amount1Desired: "1.7",
     amount0Min: "1.4",
@@ -543,7 +543,7 @@ const compassApiSDK = new CompassApiSDKCore({
 
 async function run() {
   const res = await aerodromeSlipstreamSlipstreamLiquidityProvisionIncrease(compassApiSDK, {
-    tokenId: 88456,
+    tokenId: 708272,
     amount0Desired: "1.5",
     amount1Desired: "1.7",
     amount0Min: "1.4",
@@ -610,9 +610,9 @@ const compassApiSDK = new CompassApiSDK({
 
 async function run() {
   const result = await compassApiSDK.aerodromeSlipstream.slipstreamLiquidityProvisionWithdraw({
-    tokenId: 512590,
-    percentageForWithdrawal: "50",
-    chain: "base:mainnet",
+    tokenId: 354936,
+    percentageForWithdrawal: "100",
+    chain: "ethereum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
@@ -639,9 +639,9 @@ const compassApiSDK = new CompassApiSDKCore({
 
 async function run() {
   const res = await aerodromeSlipstreamSlipstreamLiquidityProvisionWithdraw(compassApiSDK, {
-    tokenId: 512590,
-    percentageForWithdrawal: "50",
-    chain: "base:mainnet",
+    tokenId: 354936,
+    percentageForWithdrawal: "100",
+    chain: "ethereum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 

package/docs/sdks/morpho/README.md

@@ -35,10 +35,7 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.morpho.vaults({
-    chain: "ethereum:mainnet",
-    depositToken: "<value>",
-  });
+  const result = await compassApiSDK.morpho.vaults({});
 
   // Handle the result
   console.log(result);
@@ -62,10 +59,7 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await morphoVaults(compassApiSDK, {
-    chain: "ethereum:mainnet",
-    depositToken: "<value>",
-  });
+  const res = await morphoVaults(compassApiSDK, {});
 
   if (!res.ok) {
     throw res.error;
@@ -116,7 +110,6 @@ const compassApiSDK = new CompassApiSDK({
 
 async function run() {
   const result = await compassApiSDK.morpho.vaultPosition({
-    chain: "ethereum:mainnet",
     userAddress: "0xa829B388A3DF7f581cE957a95edbe419dd146d1B",
     vaultAddress: "0xbEef047a543E45807105E51A8BBEFCc5950fcfBa",
   });
@@ -144,7 +137,6 @@ const compassApiSDK = new CompassApiSDKCore({
 
 async function run() {
   const res = await morphoVaultPosition(compassApiSDK, {
-    chain: "ethereum:mainnet",
     userAddress: "0xa829B388A3DF7f581cE957a95edbe419dd146d1B",
     vaultAddress: "0xbEef047a543E45807105E51A8BBEFCc5950fcfBa",
   });
@@ -199,9 +191,7 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.morpho.markets({
-    chain: "ethereum:mainnet",
-  });
+  const result = await compassApiSDK.morpho.markets({});
 
   // Handle the result
   console.log(result);
@@ -225,9 +215,7 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await morphoMarkets(compassApiSDK, {
-    chain: "ethereum:mainnet",
-  });
+  const res = await morphoMarkets(compassApiSDK, {});
 
   if (!res.ok) {
     throw res.error;
@@ -278,7 +266,6 @@ const compassApiSDK = new CompassApiSDK({
 
 async function run() {
   const result = await compassApiSDK.morpho.marketPosition({
-    chain: "ethereum:mainnet",
     userAddress: "0xa829B388A3DF7f581cE957a95edbe419dd146d1B",
     uniqueMarketKey: "0xe7399fdebc318d76dfec7356caafcf8cd4b91287e139a3ec423f09aeeb656fc4",
   });
@@ -306,7 +293,6 @@ const compassApiSDK = new CompassApiSDKCore({
 
 async function run() {
   const res = await morphoMarketPosition(compassApiSDK, {
-    chain: "ethereum:mainnet",
     userAddress: "0xa829B388A3DF7f581cE957a95edbe419dd146d1B",
     uniqueMarketKey: "0xe7399fdebc318d76dfec7356caafcf8cd4b91287e139a3ec423f09aeeb656fc4",
   });
@@ -365,7 +351,7 @@ async function run() {
   const result = await compassApiSDK.morpho.allowance({
     vaultAddress: "0xbEef047a543E45807105E51A8BBEFCc5950fcfBa",
     amount: 1.5,
-    chain: "arbitrum:mainnet",
+    chain: "ethereum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
@@ -394,7 +380,7 @@ async function run() {
   const res = await morphoAllowance(compassApiSDK, {
     vaultAddress: "0xbEef047a543E45807105E51A8BBEFCc5950fcfBa",
     amount: 1.5,
-    chain: "arbitrum:mainnet",
+    chain: "ethereum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
@@ -458,7 +444,7 @@ async function run() {
   const result = await compassApiSDK.morpho.deposit({
     vaultAddress: "0xbEef047a543E45807105E51A8BBEFCc5950fcfBa",
     amount: 1.5,
-    chain: "arbitrum:mainnet",
+    chain: "base:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
@@ -487,7 +473,7 @@ async function run() {
   const res = await morphoDeposit(compassApiSDK, {
     vaultAddress: "0xbEef047a543E45807105E51A8BBEFCc5950fcfBa",
     amount: 1.5,
-    chain: "arbitrum:mainnet",
+    chain: "base:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
@@ -639,7 +625,7 @@ async function run() {
   const result = await compassApiSDK.morpho.supplyCollateral({
     amount: 1.5,
     uniqueMarketKey: "0xe7399fdebc318d76dfec7356caafcf8cd4b91287e139a3ec423f09aeeb656fc4",
-    chain: "base:mainnet",
+    chain: "ethereum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
@@ -668,7 +654,7 @@ async function run() {
   const res = await morphoSupplyCollateral(compassApiSDK, {
     amount: 1.5,
     uniqueMarketKey: "0xe7399fdebc318d76dfec7356caafcf8cd4b91287e139a3ec423f09aeeb656fc4",
-    chain: "base:mainnet",
+    chain: "ethereum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
@@ -727,7 +713,7 @@ async function run() {
   const result = await compassApiSDK.morpho.withdrawCollateral({
     amount: 1.5,
     uniqueMarketKey: "0xe7399fdebc318d76dfec7356caafcf8cd4b91287e139a3ec423f09aeeb656fc4",
-    chain: "arbitrum:mainnet",
+    chain: "base:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
@@ -756,7 +742,7 @@ async function run() {
   const res = await morphoWithdrawCollateral(compassApiSDK, {
     amount: 1.5,
     uniqueMarketKey: "0xe7399fdebc318d76dfec7356caafcf8cd4b91287e139a3ec423f09aeeb656fc4",
-    chain: "arbitrum:mainnet",
+    chain: "base:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
@@ -818,7 +804,7 @@ async function run() {
   const result = await compassApiSDK.morpho.borrow({
     amount: 1.5,
     uniqueMarketKey: "0xe7399fdebc318d76dfec7356caafcf8cd4b91287e139a3ec423f09aeeb656fc4",
-    chain: "ethereum:mainnet",
+    chain: "base:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
@@ -847,7 +833,7 @@ async function run() {
   const res = await morphoBorrow(compassApiSDK, {
     amount: 1.5,
     uniqueMarketKey: "0xe7399fdebc318d76dfec7356caafcf8cd4b91287e139a3ec423f09aeeb656fc4",
-    chain: "ethereum:mainnet",
+    chain: "base:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
@@ -904,7 +890,7 @@ const compassApiSDK = new CompassApiSDK({
 
 async function run() {
   const result = await compassApiSDK.morpho.repay({
-    amount: "ALL",
+    amount: "1.5",
     uniqueMarketKey: "0xe7399fdebc318d76dfec7356caafcf8cd4b91287e139a3ec423f09aeeb656fc4",
     chain: "ethereum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
@@ -933,7 +919,7 @@ const compassApiSDK = new CompassApiSDKCore({
 
 async function run() {
   const res = await morphoRepay(compassApiSDK, {
-    amount: "ALL",
+    amount: "1.5",
     uniqueMarketKey: "0xe7399fdebc318d76dfec7356caafcf8cd4b91287e139a3ec423f09aeeb656fc4",
     chain: "ethereum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",

package/docs/sdks/sky/README.md

@@ -360,7 +360,7 @@ const compassApiSDK = new CompassApiSDK({
 
 async function run() {
   const result = await compassApiSDK.sky.withdraw({
-    amount: "259.48",
+    amount: "797.31",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
@@ -387,7 +387,7 @@ const compassApiSDK = new CompassApiSDKCore({
 
 async function run() {
   const res = await skyWithdraw(compassApiSDK, {
-    amount: "259.48",
+    amount: "797.31",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 

package/docs/sdks/token/README.md

@@ -189,7 +189,7 @@ async function run() {
   const result = await compassApiSDK.token.balance({
     chain: "arbitrum:mainnet",
     user: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
-    token: "<value>",
+    token: "KNC",
   });
 
   // Handle the result
@@ -217,7 +217,7 @@ async function run() {
   const res = await tokenBalance(compassApiSDK, {
     chain: "arbitrum:mainnet",
     user: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
-    token: "<value>",
+    token: "KNC",
   });
 
   if (!res.ok) {

package/docs/sdks/transactionbatching/README.md

@@ -7,6 +7,7 @@
 
 * [authorization](#authorization) - Get EIP-7702 Authorization
 * [execute](#execute) - Execute Tx Batching
+* [aaveLoop](#aaveloop) - Execute Aave Loop Strategy
 
 ## authorization
 
@@ -112,7 +113,7 @@ const compassApiSDK = new CompassApiSDK({
 
 async function run() {
   const result = await compassApiSDK.transactionBatching.execute({
-    chain: "ethereum:mainnet",
+    chain: "base:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
     signedAuthorization: {
       nonce: 1000,
@@ -124,14 +125,11 @@ async function run() {
     },
     actions: [
       {
-        actionType: "UNISWAP_BUY_EXACTLY",
+        actionType: "ALLOWANCE_INCREASE",
         body: {
-          tokenIn: "WETH",
-          tokenOut: "USDC",
-          fee: "0.01",
-          amountOut: 1.5,
-          maxSlippagePercent: 0.5,
-          wrapEth: true,
+          token: "WETH",
+          contractName: "AaveV3Pool",
+          amount: 1.5,
         },
       },
     ],
@@ -160,7 +158,7 @@ const compassApiSDK = new CompassApiSDKCore({
 
 async function run() {
   const res = await transactionBatchingExecute(compassApiSDK, {
-    chain: "ethereum:mainnet",
+    chain: "base:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
     signedAuthorization: {
       nonce: 1000,
@@ -172,14 +170,11 @@ async function run() {
     },
     actions: [
       {
-        actionType: "UNISWAP_BUY_EXACTLY",
+        actionType: "ALLOWANCE_INCREASE",
         body: {
-          tokenIn: "WETH",
-          tokenOut: "USDC",
-          fee: "0.01",
-          amountOut: 1.5,
-          maxSlippagePercent: 0.5,
-          wrapEth: true,
+          token: "WETH",
+          contractName: "AaveV3Pool",
+          amount: 1.5,
         },
       },
     ],
@@ -213,6 +208,123 @@ run();
 
 ### Errors
 
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## aaveLoop
+
+Execute an Aave looping strategy that involves repeated supply and borrow
+operations.
+
+This endpoint creates a multicall transaction that performs a series of operations:
+1. Approves and supplies initial token
+2. For each loop:
+    - Borrows another token
+    - Swaps borrowed token back to supply token
+    - Supplies the swapped tokens
+
+The transaction must be authorized using the /authorization endpoint to prevent replay attacks.
+
+### Example Usage
+
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.transactionBatching.aaveLoop({
+    chain: "base:mainnet",
+    sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+    signedAuthorization: {
+      nonce: 1000,
+      address: "0xcA11bde05977b3631167028862bE2a173976CA11",
+      chainId: 42161,
+      r: 4.3251085460800106e+76,
+      s: 5.471500338403868e+76,
+      yParity: 0,
+    },
+    collateralToken: "MKR",
+    borrowToken: "FXS",
+    collateralAmount: "1000",
+    loopCount: 3,
+    maxSlippagePercent: 10,
+    loanToValue: 70,
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { transactionBatchingAaveLoop } from "@compass-labs/api-sdk/funcs/transactionBatchingAaveLoop.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await transactionBatchingAaveLoop(compassApiSDK, {
+    chain: "base:mainnet",
+    sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+    signedAuthorization: {
+      nonce: 1000,
+      address: "0xcA11bde05977b3631167028862bE2a173976CA11",
+      chainId: 42161,
+      r: 4.3251085460800106e+76,
+      s: 5.471500338403868e+76,
+      yParity: 0,
+    },
+    collateralToken: "MKR",
+    borrowToken: "FXS",
+    collateralAmount: "1000",
+    loopCount: 3,
+    maxSlippagePercent: 10,
+    loanToValue: 70,
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.AaveLoopRequest](../../models/components/aavelooprequest.md)                                                                                                       | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.UnsignedMulticallTransaction](../../models/components/unsignedmulticalltransaction.md)\>**
+
+### Errors
+
 | Error Type                 | Status Code                | Content Type               |
 | -------------------------- | -------------------------- | -------------------------- |
 | errors.HTTPValidationError | 422                        | application/json           |