npm - @compass-labs/api-sdk - Versions diffs - 0.1.0 → 0.1.2 - Mend

@compass-labs/api-sdk 0.1.0 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (488) hide show

package/src/funcs/morphoBorrow.ts CHANGED Viewed

@@ -44,7 +44,7 @@ export function morphoBorrow(
   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/morphoDeposit.ts CHANGED Viewed

@@ -46,7 +46,7 @@ export function morphoDeposit(
   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
@@ -150,7 +150,7 @@ async function $do(
   };
   const [result] = await M.match<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -160,7 +160,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/morphoMarket.ts CHANGED Viewed

@@ -30,6 +30,15 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  * 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
  */
 export function morphoMarket(
   client: CompassApiSDKCore,

package/src/funcs/morphoRepay.ts CHANGED Viewed

@@ -41,7 +41,7 @@ export function morphoRepay(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -66,7 +66,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"),

package/src/funcs/morphoSupplyCollateral.ts CHANGED Viewed

@@ -41,7 +41,7 @@ export function morphoSupplyCollateral(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -66,7 +66,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      components.UnsignedTransaction,
+      components.TxResponse,
       | errors.HTTPValidationError
       | APIError
       | SDKValidationError
@@ -146,7 +146,7 @@ async function $do(
   };
   const [result] = await M.match<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -156,7 +156,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/morphoUserPosition.ts CHANGED Viewed

@@ -30,6 +30,9 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  * 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.
  */
 export function morphoUserPosition(
   client: CompassApiSDKCore,

package/src/funcs/morphoVault.ts CHANGED Viewed

@@ -30,6 +30,13 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  * Get data & metrics for a specific Morpho vault.
+ *
+ * Including:
+ * - Current, daily, weekly, monthly, yearly APY
+ * - Underlying asset data
+ * - Total liquidity
+ * - Pertinent metadata
+ * - Whitelist status
  */
 export function morphoVault(
   client: CompassApiSDKCore,

package/src/funcs/morphoVaults.ts CHANGED Viewed

@@ -29,7 +29,7 @@ import { Result } from "../types/fp.js";
  * Get Vaults
  *
  * @remarks
- * 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

package/src/funcs/morphoWithdraw.ts CHANGED Viewed

@@ -46,7 +46,7 @@ export function morphoWithdraw(
   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
@@ -150,7 +150,7 @@ async function $do(
   };
   const [result] = await M.match<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -160,7 +160,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/morphoWithdrawCollateral.ts CHANGED Viewed

@@ -41,7 +41,7 @@ export function morphoWithdrawCollateral(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -66,7 +66,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      components.UnsignedTransaction,
+      components.TxResponse,
       | errors.HTTPValidationError
       | APIError
       | SDKValidationError
@@ -146,7 +146,7 @@ async function $do(
   };
   const [result] = await M.match<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -156,7 +156,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/skyBuy.ts CHANGED Viewed

@@ -42,7 +42,7 @@ export function skyBuy(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -67,7 +67,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      components.UnsignedTransaction,
+      components.TxResponse,
       | errors.HTTPValidationError
       | APIError
       | SDKValidationError
@@ -146,7 +146,7 @@ async function $do(
   };
   const [result] = await M.match<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -156,7 +156,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/skyDeposit.ts CHANGED Viewed

@@ -38,7 +38,7 @@ export function skyDeposit(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -63,7 +63,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      components.UnsignedTransaction,
+      components.TxResponse,
       | errors.HTTPValidationError
       | APIError
       | SDKValidationError
@@ -142,7 +142,7 @@ async function $do(
   };
   const [result] = await M.match<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -152,7 +152,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/skySell.ts CHANGED Viewed

@@ -42,7 +42,7 @@ export function skySell(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -67,7 +67,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      components.UnsignedTransaction,
+      components.TxResponse,
       | errors.HTTPValidationError
       | APIError
       | SDKValidationError
@@ -146,7 +146,7 @@ async function $do(
   };
   const [result] = await M.match<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -156,7 +156,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/skyWithdraw.ts CHANGED Viewed

@@ -36,7 +36,7 @@ export function skyWithdraw(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -61,7 +61,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      components.UnsignedTransaction,
+      components.TxResponse,
       | errors.HTTPValidationError
       | APIError
       | SDKValidationError
@@ -140,7 +140,7 @@ async function $do(
   };
   const [result] = await M.match<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -150,7 +150,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/tokenTransfer.ts CHANGED Viewed

@@ -36,7 +36,7 @@ export function tokenTransfer(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -61,7 +61,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      components.UnsignedTransaction,
+      components.TxResponse,
       | errors.HTTPValidationError
       | APIError
       | SDKValidationError
@@ -140,7 +140,7 @@ async function $do(
   };
   const [result] = await M.match<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -150,7 +150,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/uniswapV3LiquidityProvisionIncrease.ts CHANGED Viewed

@@ -44,7 +44,7 @@ export function uniswapV3LiquidityProvisionIncrease(
   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/uniswapV3LiquidityProvisionMint.ts CHANGED Viewed

@@ -44,7 +44,7 @@ export function uniswapV3LiquidityProvisionMint(
   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/uniswapV3LiquidityProvisionWithdraw.ts CHANGED Viewed

@@ -45,7 +45,7 @@ export function uniswapV3LiquidityProvisionWithdraw(
   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/uniswapV3SwapBuyExactly.ts CHANGED Viewed

@@ -42,7 +42,7 @@ export function uniswapV3SwapBuyExactly(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -67,7 +67,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      components.UnsignedTransaction,
+      components.TxResponse,
       | errors.HTTPValidationError
       | APIError
       | SDKValidationError
@@ -146,7 +146,7 @@ async function $do(
   };
   const [result] = await M.match<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -156,7 +156,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/uniswapV3SwapSellExactly.ts CHANGED Viewed

@@ -42,7 +42,7 @@ export function uniswapV3SwapSellExactly(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -67,7 +67,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      components.UnsignedTransaction,
+      components.TxResponse,
       | errors.HTTPValidationError
       | APIError
       | SDKValidationError
@@ -146,7 +146,7 @@ async function $do(
   };
   const [result] = await M.match<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -156,7 +156,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/universalAllowanceSet.ts CHANGED Viewed

@@ -42,7 +42,7 @@ export function universalAllowanceSet(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -67,7 +67,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      components.UnsignedTransaction,
+      components.TxResponse,
       | errors.HTTPValidationError
       | APIError
       | SDKValidationError
@@ -146,7 +146,7 @@ async function $do(
   };
   const [result] = await M.match<
-    components.UnsignedTransaction,
+    components.TxResponse,
     | errors.HTTPValidationError
     | APIError
     | SDKValidationError
@@ -156,7 +156,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"),