@compass-labs/api-sdk 1.1.2-rc0 → 1.1.3-rc0

package/docs/sdks/swap/README.md

@@ -31,12 +31,12 @@ const compassApiSDK = new CompassApiSDK({
 
 async function run() {
   const result = await compassApiSDK.swap.swapOdos({
-    tokenIn: "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
-    tokenOut: "0xdac17f958d2ee523a2206206994597c13d831ec7",
-    amount: 1.5,
-    maxSlippagePercent: 0.5,
+    tokenIn: "0x0000000000000000000000000000000000000000",
+    tokenOut: "USDT",
+    amount: 0.0001,
+    maxSlippagePercent: 1,
     chain: "arbitrum",
-    sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+    sender: "0xBA5c2548003aDD027489EeDE2C90BE6f1c81cBb9",
   });
 
   console.log(result);
@@ -61,12 +61,12 @@ const compassApiSDK = new CompassApiSDKCore({
 
 async function run() {
   const res = await swapSwapOdos(compassApiSDK, {
-    tokenIn: "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
-    tokenOut: "0xdac17f958d2ee523a2206206994597c13d831ec7",
-    amount: 1.5,
-    maxSlippagePercent: 0.5,
+    tokenIn: "0x0000000000000000000000000000000000000000",
+    tokenOut: "USDT",
+    amount: 0.0001,
+    maxSlippagePercent: 1,
     chain: "arbitrum",
-    sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+    sender: "0xBA5c2548003aDD027489EeDE2C90BE6f1c81cBb9",
   });
   if (res.ok) {
     const { value: result } = res;

package/docs/sdks/token/README.md

@@ -25,7 +25,9 @@ const compassApiSDK = new CompassApiSDK({
 
 async function run() {
   const result = await compassApiSDK.token.tokenPrice({
-    token: "USDC",
+    chain: "ethereum",
+    block: null,
+    token: "AAVE",
   });
 
   console.log(result);
@@ -50,7 +52,9 @@ const compassApiSDK = new CompassApiSDKCore({
 
 async function run() {
   const res = await tokenTokenPrice(compassApiSDK, {
-    token: "USDC",
+    chain: "ethereum",
+    block: null,
+    token: "AAVE",
   });
   if (res.ok) {
     const { value: result } = res;
@@ -98,7 +102,11 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.token.tokenBalance({});
+  const result = await compassApiSDK.token.tokenBalance({
+    chain: "arbitrum",
+    user: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+    token: "USDC",
+  });
 
   console.log(result);
 }
@@ -121,7 +129,11 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await tokenTokenBalance(compassApiSDK, {});
+  const res = await tokenTokenBalance(compassApiSDK, {
+    chain: "arbitrum",
+    user: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+    token: "USDC",
+  });
   if (res.ok) {
     const { value: result } = res;
     console.log(result);
@@ -169,11 +181,11 @@ const compassApiSDK = new CompassApiSDK({
 
 async function run() {
   const result = await compassApiSDK.token.tokenTransfer({
-    to: "0x68b3465833fb72A70ecDF485E0e4C7bD8665Fc44",
+    to: "0x01E62835dd7F52173546A325294762143eE4a882",
     token: "USDC",
-    amount: 1.5,
-    chain: "ethereum",
-    sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+    amount: 0.1,
+    chain: "base",
+    sender: "0xA06a2D62D71BeAf93FA0a684A92c28729297eC81",
   });
 
   console.log(result);
@@ -198,11 +210,11 @@ const compassApiSDK = new CompassApiSDKCore({
 
 async function run() {
   const res = await tokenTokenTransfer(compassApiSDK, {
-    to: "0x68b3465833fb72A70ecDF485E0e4C7bD8665Fc44",
+    to: "0x01E62835dd7F52173546A325294762143eE4a882",
     token: "USDC",
-    amount: 1.5,
-    chain: "ethereum",
-    sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+    amount: 0.1,
+    chain: "base",
+    sender: "0xA06a2D62D71BeAf93FA0a684A92c28729297eC81",
   });
   if (res.ok) {
     const { value: result } = res;

package/docs/sdks/transactionbundler/README.md

@@ -112,8 +112,9 @@ const compassApiSDK = new CompassApiSDK({
 
 async function run() {
   const result = await compassApiSDK.transactionBundler.transactionBundlerExecute({
-    chain: "ethereum",
+    chain: "arbitrum",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+    estimateGas: true,
     signedAuthorization: {
       nonce: 1000,
       address: "0xcA11bde05977b3631167028862bE2a173976CA11",
@@ -131,6 +132,47 @@ async function run() {
           amount: "1000",
         },
       },
+      {
+        body: {
+          actionType: "UNISWAP_BUY_EXACTLY",
+          tokenIn: "WETH",
+          tokenOut: "USDC",
+          fee: "0.01",
+          amountOut: "1000",
+          maxSlippagePercent: 0.5,
+        },
+      },
+      {
+        body: {
+          actionType: "SET_ALLOWANCE",
+          token: "USDC",
+          contract: "AaveV3Pool",
+          amount: "1000",
+        },
+      },
+      {
+        body: {
+          actionType: "SET_ALLOWANCE",
+          token: "WETH",
+          contract: "AaveV3Pool",
+          amount: "0.1",
+        },
+      },
+      {
+        body: {
+          actionType: "AAVE_SUPPLY",
+          token: "USDC",
+          amount: "1000",
+        },
+      },
+      {
+        body: {
+          actionType: "AAVE_BORROW",
+          token: "WETH",
+          amount: "0.1",
+          interestRateMode: "variable",
+        },
+      },
     ],
   });
 
@@ -156,8 +198,9 @@ const compassApiSDK = new CompassApiSDKCore({
 
 async function run() {
   const res = await transactionBundlerTransactionBundlerExecute(compassApiSDK, {
-    chain: "ethereum",
+    chain: "arbitrum",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+    estimateGas: true,
     signedAuthorization: {
       nonce: 1000,
       address: "0xcA11bde05977b3631167028862bE2a173976CA11",
@@ -175,6 +218,47 @@ async function run() {
           amount: "1000",
         },
       },
+      {
+        body: {
+          actionType: "UNISWAP_BUY_EXACTLY",
+          tokenIn: "WETH",
+          tokenOut: "USDC",
+          fee: "0.01",
+          amountOut: "1000",
+          maxSlippagePercent: 0.5,
+        },
+      },
+      {
+        body: {
+          actionType: "SET_ALLOWANCE",
+          token: "USDC",
+          contract: "AaveV3Pool",
+          amount: "1000",
+        },
+      },
+      {
+        body: {
+          actionType: "SET_ALLOWANCE",
+          token: "WETH",
+          contract: "AaveV3Pool",
+          amount: "0.1",
+        },
+      },
+      {
+        body: {
+          actionType: "AAVE_SUPPLY",
+          token: "USDC",
+          amount: "1000",
+        },
+      },
+      {
+        body: {
+          actionType: "AAVE_BORROW",
+          token: "WETH",
+          amount: "0.1",
+          interestRateMode: "variable",
+        },
+      },
     ],
   });
   if (res.ok) {
@@ -234,8 +318,9 @@ const compassApiSDK = new CompassApiSDK({
 
 async function run() {
   const result = await compassApiSDK.transactionBundler.transactionBundlerAaveLoop({
-    chain: "base",
+    chain: "arbitrum",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+    estimateGas: true,
     signedAuthorization: {
       nonce: 1000,
       address: "0xcA11bde05977b3631167028862bE2a173976CA11",
@@ -248,9 +333,9 @@ async function run() {
     borrowToken: "WETH",
     initialCollateralAmount: "1000",
     multiplier: "2.5",
-    maxSlippagePercent: 2.5,
-    loanToValue: 20.5,
-    isAccountAbstraction: true,
+    maxSlippagePercent: "0.5",
+    loanToValue: "60",
+    isAccountAbstraction: false,
   });
 
   console.log(result);
@@ -275,8 +360,9 @@ const compassApiSDK = new CompassApiSDKCore({
 
 async function run() {
   const res = await transactionBundlerTransactionBundlerAaveLoop(compassApiSDK, {
-    chain: "base",
+    chain: "arbitrum",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+    estimateGas: true,
     signedAuthorization: {
       nonce: 1000,
       address: "0xcA11bde05977b3631167028862bE2a173976CA11",
@@ -289,9 +375,9 @@ async function run() {
     borrowToken: "WETH",
     initialCollateralAmount: "1000",
     multiplier: "2.5",
-    maxSlippagePercent: 2.5,
-    loanToValue: 20.5,
-    isAccountAbstraction: true,
+    maxSlippagePercent: "0.5",
+    loanToValue: "60",
+    isAccountAbstraction: false,
   });
   if (res.ok) {
     const { value: result } = res;

package/docs/sdks/uniswapv3/README.md

@@ -36,8 +36,11 @@ const compassApiSDK = new CompassApiSDK({
 
 async function run() {
   const result = await compassApiSDK.uniswapV3.uniswapQuoteBuyExactly({
-    tokenOut: "USDC",
-    amountOut: 9572.21,
+    chain: "arbitrum",
+    tokenIn: "USDC",
+    tokenOut: "USDT",
+    fee: "0.01",
+    amountOut: 1,
   });
 
   console.log(result);
@@ -62,8 +65,11 @@ const compassApiSDK = new CompassApiSDKCore({
 
 async function run() {
   const res = await uniswapV3UniswapQuoteBuyExactly(compassApiSDK, {
-    tokenOut: "USDC",
-    amountOut: 9572.21,
+    chain: "arbitrum",
+    tokenIn: "USDC",
+    tokenOut: "USDT",
+    fee: "0.01",
+    amountOut: 1,
   });
   if (res.ok) {
     const { value: result } = res;
@@ -116,8 +122,11 @@ const compassApiSDK = new CompassApiSDK({
 
 async function run() {
   const result = await compassApiSDK.uniswapV3.uniswapQuoteSellExactly({
-    tokenOut: "USDC",
-    amountIn: 4736.09,
+    chain: "arbitrum",
+    tokenIn: "USDC",
+    tokenOut: "USDT",
+    fee: "0.01",
+    amountIn: 1,
   });
 
   console.log(result);
@@ -142,8 +151,11 @@ const compassApiSDK = new CompassApiSDKCore({
 
 async function run() {
   const res = await uniswapV3UniswapQuoteSellExactly(compassApiSDK, {
-    tokenOut: "USDC",
-    amountIn: 4736.09,
+    chain: "arbitrum",
+    tokenIn: "USDC",
+    tokenOut: "USDT",
+    fee: "0.01",
+    amountIn: 1,
   });
   if (res.ok) {
     const { value: result } = res;
@@ -194,7 +206,10 @@ const compassApiSDK = new CompassApiSDK({
 
 async function run() {
   const result = await compassApiSDK.uniswapV3.uniswapPoolPrice({
-    tokenOut: "USDC",
+    chain: "arbitrum",
+    tokenIn: "USDC",
+    tokenOut: "USDT",
+    fee: "0.01",
   });
 
   console.log(result);
@@ -219,7 +234,10 @@ const compassApiSDK = new CompassApiSDKCore({
 
 async function run() {
   const res = await uniswapV3UniswapPoolPrice(compassApiSDK, {
-    tokenOut: "USDC",
+    chain: "arbitrum",
+    tokenIn: "USDC",
+    tokenOut: "USDT",
+    fee: "0.01",
   });
   if (res.ok) {
     const { value: result } = res;
@@ -274,7 +292,10 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.uniswapV3.uniswapLiquidityProvisionInRange({});
+  const result = await compassApiSDK.uniswapV3.uniswapLiquidityProvisionInRange({
+    chain: "arbitrum",
+    tokenId: 4318185,
+  });
 
   console.log(result);
 }
@@ -297,7 +318,10 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await uniswapV3UniswapLiquidityProvisionInRange(compassApiSDK, {});
+  const res = await uniswapV3UniswapLiquidityProvisionInRange(compassApiSDK, {
+    chain: "arbitrum",
+    tokenId: 4318185,
+  });
   if (res.ok) {
     const { value: result } = res;
     console.log(result);
@@ -350,7 +374,10 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.uniswapV3.uniswapLiquidityProvisionPositions({});
+  const result = await compassApiSDK.uniswapV3.uniswapLiquidityProvisionPositions({
+    chain: "arbitrum",
+    user: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+  });
 
   console.log(result);
 }
@@ -373,7 +400,10 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await uniswapV3UniswapLiquidityProvisionPositions(compassApiSDK, {});
+  const res = await uniswapV3UniswapLiquidityProvisionPositions(compassApiSDK, {
+    chain: "arbitrum",
+    user: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+  });
   if (res.ok) {
     const { value: result } = res;
     console.log(result);
@@ -435,13 +465,13 @@ const compassApiSDK = new CompassApiSDK({
 
 async function run() {
   const result = await compassApiSDK.uniswapV3.uniswapSwapBuyExactly({
-    tokenIn: "WETH",
-    tokenOut: "WETH",
-    fee: "1.0",
-    amountOut: 1.5,
+    tokenIn: "USDC",
+    tokenOut: "USDT",
+    fee: "0.01",
+    amountOut: 0.1,
     maxSlippagePercent: 0.5,
-    chain: "ethereum",
-    sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+    chain: "base",
+    sender: "0x7a27794511C14F6afFDE618D3d8ef7B9C24058Ac",
   });
 
   console.log(result);
@@ -466,13 +496,13 @@ const compassApiSDK = new CompassApiSDKCore({
 
 async function run() {
   const res = await uniswapV3UniswapSwapBuyExactly(compassApiSDK, {
-    tokenIn: "WETH",
-    tokenOut: "WETH",
-    fee: "1.0",
-    amountOut: 1.5,
+    tokenIn: "USDC",
+    tokenOut: "USDT",
+    fee: "0.01",
+    amountOut: 0.1,
     maxSlippagePercent: 0.5,
-    chain: "ethereum",
-    sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+    chain: "base",
+    sender: "0x7a27794511C14F6afFDE618D3d8ef7B9C24058Ac",
   });
   if (res.ok) {
     const { value: result } = res;
@@ -535,13 +565,13 @@ const compassApiSDK = new CompassApiSDK({
 
 async function run() {
   const result = await compassApiSDK.uniswapV3.uniswapSwapSellExactly({
-    tokenIn: "WETH",
-    tokenOut: "WETH",
-    fee: "1.0",
-    amountIn: 1.5,
+    tokenIn: "USDC",
+    tokenOut: "USDT",
+    fee: "0.01",
+    amountIn: 0.1,
     maxSlippagePercent: 0.5,
-    chain: "ethereum",
-    sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+    chain: "base",
+    sender: "0xA7DeA16238DdF6ed8AaC73A348bbdE6da20C20B5",
   });
 
   console.log(result);
@@ -566,13 +596,13 @@ const compassApiSDK = new CompassApiSDKCore({
 
 async function run() {
   const res = await uniswapV3UniswapSwapSellExactly(compassApiSDK, {
-    tokenIn: "WETH",
-    tokenOut: "WETH",
-    fee: "1.0",
-    amountIn: 1.5,
+    tokenIn: "USDC",
+    tokenOut: "USDT",
+    fee: "0.01",
+    amountIn: 0.1,
     maxSlippagePercent: 0.5,
-    chain: "ethereum",
-    sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+    chain: "base",
+    sender: "0xA7DeA16238DdF6ed8AaC73A348bbdE6da20C20B5",
   });
   if (res.ok) {
     const { value: result } = res;
@@ -637,18 +667,18 @@ const compassApiSDK = new CompassApiSDK({
 
 async function run() {
   const result = await compassApiSDK.uniswapV3.uniswapLiquidityProvisionMint({
-    token0: "WETH",
-    token1: "WETH",
-    fee: "0.05",
-    tickLower: -1000,
-    tickUpper: 1000,
-    amount0Desired: "1.5",
-    amount1Desired: "1.7",
-    amount0Min: "1.4",
-    amount1Min: "1.6",
-    recipient: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
-    chain: "arbitrum",
-    sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+    token0: "USDC",
+    token1: "USDT",
+    fee: "1.0",
+    tickLower: 1823,
+    tickUpper: 2623,
+    amount0Desired: "0.05",
+    amount1Desired: "0.00",
+    amount0Min: "0",
+    amount1Min: "0",
+    recipient: "0x41096de529D54718a5600185F8C4460979ed75C9",
+    chain: "base",
+    sender: "0x41096de529D54718a5600185F8C4460979ed75C9",
   });
 
   console.log(result);
@@ -673,18 +703,18 @@ const compassApiSDK = new CompassApiSDKCore({
 
 async function run() {
   const res = await uniswapV3UniswapLiquidityProvisionMint(compassApiSDK, {
-    token0: "WETH",
-    token1: "WETH",
-    fee: "0.05",
-    tickLower: -1000,
-    tickUpper: 1000,
-    amount0Desired: "1.5",
-    amount1Desired: "1.7",
-    amount0Min: "1.4",
-    amount1Min: "1.6",
-    recipient: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
-    chain: "arbitrum",
-    sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+    token0: "USDC",
+    token1: "USDT",
+    fee: "1.0",
+    tickLower: 1823,
+    tickUpper: 2623,
+    amount0Desired: "0.05",
+    amount1Desired: "0.00",
+    amount0Min: "0",
+    amount1Min: "0",
+    recipient: "0x41096de529D54718a5600185F8C4460979ed75C9",
+    chain: "base",
+    sender: "0x41096de529D54718a5600185F8C4460979ed75C9",
   });
   if (res.ok) {
     const { value: result } = res;
@@ -749,13 +779,13 @@ const compassApiSDK = new CompassApiSDK({
 
 async function run() {
   const result = await compassApiSDK.uniswapV3.uniswapLiquidityProvisionIncrease({
-    tokenId: 991701,
-    amount0Desired: "1.5",
-    amount1Desired: "1.7",
-    amount0Min: "1.4",
-    amount1Min: "1.6",
-    chain: "ethereum",
-    sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+    tokenId: 3432182,
+    amount0Desired: "0.3",
+    amount1Desired: "0.0",
+    amount0Min: "0.00",
+    amount1Min: "0.00",
+    chain: "base",
+    sender: "0x41096de529D54718a5600185F8C4460979ed75C9",
   });
 
   console.log(result);
@@ -780,13 +810,13 @@ const compassApiSDK = new CompassApiSDKCore({
 
 async function run() {
   const res = await uniswapV3UniswapLiquidityProvisionIncrease(compassApiSDK, {
-    tokenId: 991701,
-    amount0Desired: "1.5",
-    amount1Desired: "1.7",
-    amount0Min: "1.4",
-    amount1Min: "1.6",
-    chain: "ethereum",
-    sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+    tokenId: 3432182,
+    amount0Desired: "0.3",
+    amount1Desired: "0.0",
+    amount0Min: "0.00",
+    amount1Min: "0.00",
+    chain: "base",
+    sender: "0x41096de529D54718a5600185F8C4460979ed75C9",
   });
   if (res.ok) {
     const { value: result } = res;
@@ -852,10 +882,10 @@ const compassApiSDK = new CompassApiSDK({
 
 async function run() {
   const result = await compassApiSDK.uniswapV3.uniswapLiquidityProvisionWithdraw({
-    tokenId: 821299,
-    percentageForWithdrawal: "25",
-    chain: "ethereum",
-    sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+    tokenId: 3432182,
+    percentageForWithdrawal: 1,
+    chain: "base",
+    sender: "0x41096de529D54718a5600185F8C4460979ed75C9",
   });
 
   console.log(result);
@@ -880,10 +910,10 @@ const compassApiSDK = new CompassApiSDKCore({
 
 async function run() {
   const res = await uniswapV3UniswapLiquidityProvisionWithdraw(compassApiSDK, {
-    tokenId: 821299,
-    percentageForWithdrawal: "25",
-    chain: "ethereum",
-    sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
+    tokenId: 3432182,
+    percentageForWithdrawal: 1,
+    chain: "base",
+    sender: "0x41096de529D54718a5600185F8C4460979ed75C9",
   });
   if (res.ok) {
     const { value: result } = res;