@compass-labs/api-sdk 0.5.6 → 0.5.8

package/docs/sdks/transactionbatching/README.md

@@ -5,18 +5,18 @@
 
 ### Available Operations
 
-* [authorization](#authorization) - Get EIP-7702 Authorization
-* [execute](#execute) - Execute Tx Batching
-* [aaveLoop](#aaveloop) - Execute Aave Loop Strategy
+* [authorization](#authorization) - Enable transaction bundling.
+* [execute](#execute) - Construct Bundled Transaction
+* [aaveLoop](#aaveloop) - AAVE leverage long/short
 
 ## authorization
 
-Get authorization data for EIP-7702 batching operations.
+Get authorization for bundling transactions.
 
-This authorization is required to prevent replay attacks and ensure transaction
-ordering when batching multiple actions into a single transaction. The authorization
-includes a nonce and chain ID to guarantee transaction uniqueness and proper network
-targeting.
+Currently this is required for every transaction bundle to prevent replay attacks
+and ensure transaction ordering when batching multiple actions into a single
+transaction. The authorization includes a nonce and chain ID to guarantee
+transaction uniqueness and proper network targeting.
 
 ### Example Usage
 
@@ -33,7 +33,6 @@ async function run() {
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -59,15 +58,12 @@ async function run() {
     chain: "ethereum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("transactionBatchingAuthorization failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -95,7 +91,8 @@ run();
 
 ## execute
 
-Execute a batch of transactions in a single multicall using EIP-7702.
+Bundle arbitrary transactions together into a single multicall transaction using
+EIP-7702.
 
 This endpoint allows bundling multiple contract calls into a single atomic
 transaction, reducing gas costs and ensuring all operations succeed or fail
@@ -134,7 +131,6 @@ async function run() {
     ],
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -177,15 +173,12 @@ async function run() {
       },
     ],
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("transactionBatchingExecute failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -254,7 +247,6 @@ async function run() {
     loanToValue: 20.5,
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -294,15 +286,12 @@ async function run() {
     maxSlippagePercent: 2.5,
     loanToValue: 20.5,
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("transactionBatchingAaveLoop failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/uniswapv3/README.md

@@ -35,14 +35,9 @@ const compassApiSDK = new CompassApiSDK({
 
 async function run() {
   const result = await compassApiSDK.uniswapV3.quoteBuyExactly({
-    chain: "arbitrum:mainnet",
-    tokenIn: "USDC",
-    tokenOut: "USDT",
-    fee: "0.01",
     amountOut: "<value>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -65,21 +60,14 @@ const compassApiSDK = new CompassApiSDKCore({
 
 async function run() {
   const res = await uniswapV3QuoteBuyExactly(compassApiSDK, {
-    chain: "arbitrum:mainnet",
-    tokenIn: "USDC",
-    tokenOut: "USDT",
-    fee: "0.01",
     amountOut: "<value>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("uniswapV3QuoteBuyExactly failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -124,14 +112,9 @@ const compassApiSDK = new CompassApiSDK({
 
 async function run() {
   const result = await compassApiSDK.uniswapV3.quoteSellExactly({
-    chain: "arbitrum:mainnet",
-    tokenIn: "USDC",
-    tokenOut: "USDT",
-    fee: "0.01",
     amountIn: "<value>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -154,21 +137,14 @@ const compassApiSDK = new CompassApiSDKCore({
 
 async function run() {
   const res = await uniswapV3QuoteSellExactly(compassApiSDK, {
-    chain: "arbitrum:mainnet",
-    tokenIn: "USDC",
-    tokenOut: "USDT",
-    fee: "0.01",
     amountIn: "<value>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("uniswapV3QuoteSellExactly failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -210,14 +186,8 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.uniswapV3.poolPrice({
-    chain: "arbitrum:mainnet",
-    tokenIn: "USDC",
-    tokenOut: "USDT",
-    fee: "0.01",
-  });
+  const result = await compassApiSDK.uniswapV3.poolPrice({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -239,21 +209,13 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await uniswapV3PoolPrice(compassApiSDK, {
-    chain: "arbitrum:mainnet",
-    tokenIn: "USDC",
-    tokenOut: "USDT",
-    fee: "0.01",
-  });
-
-  if (!res.ok) {
-    throw res.error;
+  const res = await uniswapV3PoolPrice(compassApiSDK, {});
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("uniswapV3PoolPrice failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -300,12 +262,8 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.uniswapV3.liquidityProvisionInRange({
-    chain: "arbitrum:mainnet",
-    tokenId: 4318185,
-  });
+  const result = await compassApiSDK.uniswapV3.liquidityProvisionInRange({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -327,19 +285,13 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await uniswapV3LiquidityProvisionInRange(compassApiSDK, {
-    chain: "arbitrum:mainnet",
-    tokenId: 4318185,
-  });
-
-  if (!res.ok) {
-    throw res.error;
+  const res = await uniswapV3LiquidityProvisionInRange(compassApiSDK, {});
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("uniswapV3LiquidityProvisionInRange failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -385,11 +337,8 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.uniswapV3.liquidityProvisionPositions({
-    chain: "arbitrum:mainnet",
-  });
+  const result = await compassApiSDK.uniswapV3.liquidityProvisionPositions({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -411,18 +360,13 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await uniswapV3LiquidityProvisionPositions(compassApiSDK, {
-    chain: "arbitrum:mainnet",
-  });
-
-  if (!res.ok) {
-    throw res.error;
+  const res = await uniswapV3LiquidityProvisionPositions(compassApiSDK, {});
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("uniswapV3LiquidityProvisionPositions failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -474,11 +418,11 @@ async function run() {
     fee: "0.01",
     amount: 1.5,
     maxSlippagePercent: 0.5,
+    wrapEth: true,
     chain: "ethereum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -506,18 +450,16 @@ async function run() {
     fee: "0.01",
     amount: 1.5,
     maxSlippagePercent: 0.5,
+    wrapEth: true,
     chain: "ethereum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("uniswapV3SwapBuyExactly failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -569,11 +511,11 @@ async function run() {
     fee: "0.05",
     amount: 1.5,
     maxSlippagePercent: 0.5,
+    wrapEth: true,
     chain: "arbitrum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -601,18 +543,16 @@ async function run() {
     fee: "0.05",
     amount: 1.5,
     maxSlippagePercent: 0.5,
+    wrapEth: true,
     chain: "arbitrum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("uniswapV3SwapSellExactly failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -670,7 +610,6 @@ async function run() {
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -701,15 +640,12 @@ async function run() {
     chain: "ethereum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("uniswapV3LiquidityProvisionIncrease failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -772,7 +708,6 @@ async function run() {
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -808,15 +743,12 @@ async function run() {
     chain: "arbitrum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("uniswapV3LiquidityProvisionMint failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -872,7 +804,6 @@ async function run() {
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -900,15 +831,12 @@ async function run() {
     chain: "arbitrum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("uniswapV3LiquidityProvisionWithdraw failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();