@compass-labs/api-sdk 0.5.7 → 0.5.9

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();

package/docs/sdks/universal/README.md

@@ -12,7 +12,7 @@
 * [ens](#ens) - Resolve ENS
 * [wrapEth](#wrapeth) - Wrap ETH
 * [unwrapWeth](#unwrapweth) - Unwrap WETH
-* [allowanceSet](#allowanceset) - Set Allowance (symbol)
+* [allowanceSet](#allowanceset) - Set Allowance
 
 ## portfolio
 
@@ -31,11 +31,8 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.universal.portfolio({
-    chain: "arbitrum:mainnet",
-  });
+  const result = await compassApiSDK.universal.portfolio({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -57,18 +54,13 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await universalPortfolio(compassApiSDK, {
-    chain: "arbitrum:mainnet",
-  });
-
-  if (!res.ok) {
-    throw res.error;
+  const res = await universalPortfolio(compassApiSDK, {});
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("universalPortfolio failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -112,11 +104,8 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.universal.visualizePortfolio({
-    chain: "arbitrum:mainnet",
-  });
+  const result = await compassApiSDK.universal.visualizePortfolio({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -138,18 +127,13 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await universalVisualizePortfolio(compassApiSDK, {
-    chain: "arbitrum:mainnet",
-  });
-
-  if (!res.ok) {
-    throw res.error;
+  const res = await universalVisualizePortfolio(compassApiSDK, {});
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("universalVisualizePortfolio failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -189,11 +173,8 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.universal.supportedTokens({
-    chain: "arbitrum:mainnet",
-  });
+  const result = await compassApiSDK.universal.supportedTokens({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -215,18 +196,13 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await universalSupportedTokens(compassApiSDK, {
-    chain: "arbitrum:mainnet",
-  });
-
-  if (!res.ok) {
-    throw res.error;
+  const res = await universalSupportedTokens(compassApiSDK, {});
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("universalSupportedTokens failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -272,13 +248,8 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.universal.allowance({
-    chain: "arbitrum:mainnet",
-    token: "USDC",
-    contractName: "AaveV3Pool",
-  });
+  const result = await compassApiSDK.universal.allowance({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -300,20 +271,13 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await universalAllowance(compassApiSDK, {
-    chain: "arbitrum:mainnet",
-    token: "USDC",
-    contractName: "AaveV3Pool",
-  });
-
-  if (!res.ok) {
-    throw res.error;
+  const res = await universalAllowance(compassApiSDK, {});
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("universalAllowance failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -356,11 +320,8 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.universal.ens({
-    chain: "ethereum:mainnet",
-  });
+  const result = await compassApiSDK.universal.ens({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -382,18 +343,13 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await universalEns(compassApiSDK, {
-    chain: "ethereum:mainnet",
-  });
-
-  if (!res.ok) {
-    throw res.error;
+  const res = await universalEns(compassApiSDK, {});
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("universalEns failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -440,7 +396,6 @@ async function run() {
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -467,15 +422,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("universalWrapEth failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -522,7 +474,6 @@ async function run() {
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -549,15 +500,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("universalUnwrapWeth failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -585,7 +533,8 @@ run();
 
 ## allowanceSet
 
-This endpoint allows users to modify the token allowance for a specific protocol.
+This endpoint allows users to modify the token allowance on any ERC-20 token for
+a specific protocol.
 
 In decentralized finance (DeFi), setting an allowance is a necessary step to
 authorize a protocol to spend a specified amount of tokens on behalf of the user.
@@ -611,7 +560,6 @@ async function run() {
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -640,15 +588,12 @@ async function run() {
     chain: "base:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("universalAllowanceSet failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@compass-labs/api-sdk",
-  "version": "0.5.7",
+  "version": "0.5.9",
   "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.7",
+  "version": "0.5.9",
   "author": "royalnine",
   "type": "module",
   "bin": {