@compass-labs/api-sdk 0.1.0 → 0.1.2

package/docs/sdks/morpho/README.md

@@ -22,7 +22,7 @@
 
 ## vaults
 
-Query a list of available vaults for deposit token.
+Query a list of vaults you can deposit into.
 
 Each vault has one unique token that can be deposited. In exchange for depositing
 tokens into a vault you receive shares. You earn yield on these shares by their
@@ -105,6 +105,13 @@ run();
 
 Get data & metrics for a specific Morpho vault.
 
+Including:
+- Current, daily, weekly, monthly, yearly APY
+- Underlying asset data
+- Total liquidity
+- Pertinent metadata
+- Whitelist status
+
 ### Example Usage
 
 ```typescript
@@ -346,6 +353,15 @@ run();
 
 Get data & metrics for a specific Morpho market.
 
+Including:
+- Current, daily, weekly, monthly, yearly APY
+- Collateral & loan asset data
+- Liquidation loan-to-value ratio
+- Collateral, borrow & liquidity value
+- Utilization ratio
+- Pertinent metadata
+- Whitelist status
+
 ### Example Usage
 
 ```typescript
@@ -507,6 +523,9 @@ run();
 
 Check user's overall position across the entire Morpho ecosystem.
 
+Inlcuding all vault and market position metrics and relavant metadata of said vaults
+and markets.
+
 ### Example Usage
 
 ```typescript
@@ -660,7 +679,7 @@ run();
 
 ### Response
 
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 
 ### Errors
 
@@ -753,7 +772,7 @@ run();
 
 ### Response
 
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 
 ### Errors
 
@@ -846,7 +865,7 @@ run();
 
 ### Response
 
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 
 ### Errors
 
@@ -934,7 +953,7 @@ run();
 
 ### Response
 
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 
 ### Errors
 
@@ -1022,7 +1041,7 @@ run();
 
 ### Response
 
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 
 ### Errors
 
@@ -1113,7 +1132,7 @@ run();
 
 ### Response
 
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 
 ### Errors
 
@@ -1201,7 +1220,7 @@ run();
 
 ### Response
 
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 
 ### Errors
 

package/docs/sdks/sky/README.md

@@ -166,7 +166,7 @@ run();
 
 ### Response
 
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 
 ### Errors
 
@@ -253,7 +253,7 @@ run();
 
 ### Response
 
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 
 ### Errors
 
@@ -334,7 +334,7 @@ run();
 
 ### Response
 
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 
 ### Errors
 
@@ -413,7 +413,7 @@ run();
 
 ### Response
 
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 
 ### Errors
 

package/docs/sdks/token/README.md

@@ -329,7 +329,7 @@ run();
 
 ### Response
 
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 
 ### Errors
 

package/docs/sdks/transactionbatching/README.md

@@ -125,14 +125,11 @@ async function run() {
     },
     actions: [
       {
-        actionType: "UNISWAP_BUY_EXACTLY",
+        actionType: "ALLOWANCE_INCREASE",
         body: {
-          tokenIn: "WETH",
-          tokenOut: "USDC",
-          fee: "0.01",
-          amount: 1.5,
-          maxSlippagePercent: 0.5,
-          wrapEth: true,
+          token: "WETH",
+          contractName: "UniswapV3Router",
+          amount: "1000",
         },
       },
     ],
@@ -173,14 +170,11 @@ async function run() {
     },
     actions: [
       {
-        actionType: "UNISWAP_BUY_EXACTLY",
+        actionType: "ALLOWANCE_INCREASE",
         body: {
-          tokenIn: "WETH",
-          tokenOut: "USDC",
-          fee: "0.01",
-          amount: 1.5,
-          maxSlippagePercent: 0.5,
-          wrapEth: true,
+          token: "WETH",
+          contractName: "UniswapV3Router",
+          amount: "1000",
         },
       },
     ],
@@ -259,7 +253,7 @@ async function run() {
     collateralAmount: "1000",
     loopCount: 2,
     maxSlippagePercent: 2.5,
-    loanToValue: 50.6,
+    loanToValue: 20.5,
   });
 
   // Handle the result
@@ -300,7 +294,7 @@ async function run() {
     collateralAmount: "1000",
     loopCount: 2,
     maxSlippagePercent: 2.5,
-    loanToValue: 50.6,
+    loanToValue: 20.5,
   });
 
   if (!res.ok) {

package/docs/sdks/uniswapv3/README.md

@@ -534,7 +534,7 @@ run();
 
 ### Response
 
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 
 ### Errors
 
@@ -629,7 +629,7 @@ run();
 
 ### Response
 
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 
 ### Errors
 
@@ -726,7 +726,7 @@ run();
 
 ### Response
 
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 
 ### Errors
 
@@ -833,7 +833,7 @@ run();
 
 ### Response
 
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 
 ### Errors
 
@@ -867,7 +867,7 @@ const compassApiSDK = new CompassApiSDK({
 async function run() {
   const result = await compassApiSDK.uniswapV3.liquidityProvisionWithdraw({
     tokenId: 719537,
-    percentageForWithdrawal: "100",
+    percentageForWithdrawal: "25",
     chain: "arbitrum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
@@ -896,7 +896,7 @@ const compassApiSDK = new CompassApiSDKCore({
 async function run() {
   const res = await uniswapV3LiquidityProvisionWithdraw(compassApiSDK, {
     tokenId: 719537,
-    percentageForWithdrawal: "100",
+    percentageForWithdrawal: "25",
     chain: "arbitrum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
@@ -925,7 +925,7 @@ run();
 
 ### Response
 
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 
 ### Errors
 

package/docs/sdks/universal/README.md

@@ -492,7 +492,7 @@ run();
 
 ### Response
 
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 
 ### Errors
 
@@ -574,7 +574,7 @@ run();
 
 ### Response
 
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 
 ### Errors
 
@@ -665,7 +665,7 @@ run();
 
 ### Response
 
-**Promise\<[components.UnsignedTransaction](../../models/components/unsignedtransaction.md)\>**
+**Promise\<[components.TxResponse](../../models/components/txresponse.md)\>**
 
 ### Errors
 

package/jsr.json

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

package/src/funcs/aaveV3Borrow.ts

@@ -39,7 +39,7 @@ export function aaveV3Borrow(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -64,7 +64,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      components.UnsignedTransaction,
+      components.TxResponse,
       | errors.HTTPValidationError
       | APIError
       | SDKValidationError
@@ -143,7 +143,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -153,7 +153,7 @@ async function $do(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(200, components.UnsignedTransaction$inboundSchema),
+    M.json(200, components.TxResponse$inboundSchema),
     M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),

package/src/funcs/aaveV3Repay.ts

@@ -43,7 +43,7 @@ export function aaveV3Repay(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -68,7 +68,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      components.UnsignedTransaction,
+      components.TxResponse,
       | errors.HTTPValidationError
       | APIError
       | SDKValidationError
@@ -147,7 +147,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -157,7 +157,7 @@ async function $do(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(200, components.UnsignedTransaction$inboundSchema),
+    M.json(200, components.TxResponse$inboundSchema),
     M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),

package/src/funcs/aaveV3Supply.ts

@@ -44,7 +44,7 @@ export function aaveV3Supply(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -69,7 +69,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      components.UnsignedTransaction,
+      components.TxResponse,
       | errors.HTTPValidationError
       | APIError
       | SDKValidationError
@@ -148,7 +148,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -158,7 +158,7 @@ async function $do(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(200, components.UnsignedTransaction$inboundSchema),
+    M.json(200, components.TxResponse$inboundSchema),
     M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),

package/src/funcs/aaveV3Withdraw.ts

@@ -44,7 +44,7 @@ export function aaveV3Withdraw(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -69,7 +69,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      components.UnsignedTransaction,
+      components.TxResponse,
       | errors.HTTPValidationError
       | APIError
       | SDKValidationError
@@ -148,7 +148,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -158,7 +158,7 @@ async function $do(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(200, components.UnsignedTransaction$inboundSchema),
+    M.json(200, components.TxResponse$inboundSchema),
     M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),

package/src/funcs/aerodromeSlipstreamSlipstreamLiquidityProvisionIncrease.ts

@@ -46,7 +46,7 @@ export function aerodromeSlipstreamSlipstreamLiquidityProvisionIncrease(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -71,7 +71,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      components.UnsignedTransaction,
+      components.TxResponse,
       | errors.HTTPValidationError
       | APIError
       | SDKValidationError
@@ -155,7 +155,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -165,7 +165,7 @@ async function $do(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(200, components.UnsignedTransaction$inboundSchema),
+    M.json(200, components.TxResponse$inboundSchema),
     M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),

package/src/funcs/aerodromeSlipstreamSlipstreamLiquidityProvisionMint.ts

@@ -44,7 +44,7 @@ export function aerodromeSlipstreamSlipstreamLiquidityProvisionMint(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -69,7 +69,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      components.UnsignedTransaction,
+      components.TxResponse,
       | errors.HTTPValidationError
       | APIError
       | SDKValidationError
@@ -152,7 +152,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -162,7 +162,7 @@ async function $do(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(200, components.UnsignedTransaction$inboundSchema),
+    M.json(200, components.TxResponse$inboundSchema),
     M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),

package/src/funcs/aerodromeSlipstreamSlipstreamLiquidityProvisionWithdraw.ts

@@ -46,7 +46,7 @@ export function aerodromeSlipstreamSlipstreamLiquidityProvisionWithdraw(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -71,7 +71,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      components.UnsignedTransaction,
+      components.TxResponse,
       | errors.HTTPValidationError
       | APIError
       | SDKValidationError
@@ -155,7 +155,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -165,7 +165,7 @@ async function $do(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(200, components.UnsignedTransaction$inboundSchema),
+    M.json(200, components.TxResponse$inboundSchema),
     M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),

package/src/funcs/aerodromeSlipstreamSlipstreamSwapBuyExactly.ts

@@ -45,7 +45,7 @@ export function aerodromeSlipstreamSlipstreamSwapBuyExactly(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -70,7 +70,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      components.UnsignedTransaction,
+      components.TxResponse,
       | errors.HTTPValidationError
       | APIError
       | SDKValidationError
@@ -152,7 +152,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -162,7 +162,7 @@ async function $do(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(200, components.UnsignedTransaction$inboundSchema),
+    M.json(200, components.TxResponse$inboundSchema),
     M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),

package/src/funcs/aerodromeSlipstreamSlipstreamSwapSellExactly.ts

@@ -44,7 +44,7 @@ export function aerodromeSlipstreamSlipstreamSwapSellExactly(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -69,7 +69,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      components.UnsignedTransaction,
+      components.TxResponse,
       | errors.HTTPValidationError
       | APIError
       | SDKValidationError
@@ -151,7 +151,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -161,7 +161,7 @@ async function $do(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(200, components.UnsignedTransaction$inboundSchema),
+    M.json(200, components.TxResponse$inboundSchema),
     M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),

package/src/funcs/morphoAllowance.ts

@@ -40,7 +40,7 @@ export function morphoAllowance(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -65,7 +65,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      components.UnsignedTransaction,
+      components.TxResponse,
       | errors.HTTPValidationError
       | APIError
       | SDKValidationError
@@ -145,7 +145,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -155,7 +155,7 @@ async function $do(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(200, components.UnsignedTransaction$inboundSchema),
+    M.json(200, components.TxResponse$inboundSchema),
     M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),