@compass-labs/api-sdk 0.0.31 → 0.0.33

package/docs/sdks/morpho/README.md

@@ -6,9 +6,12 @@
 ### Available Operations
 
 * [vaults](#vaults) - Get Vaults
+* [vault](#vault) - Get Vault
 * [vaultPosition](#vaultposition) - Check Vault Position
 * [markets](#markets) - Get Markets
+* [market](#market) - Get Market
 * [marketPosition](#marketposition) - Check Market Position
+* [userPosition](#userposition) - Check User Position
 * [allowance](#allowance) - Set Allowance for Vault
 * [deposit](#deposit) - Deposit to Vault
 * [withdraw](#withdraw) - Withdraw from Vault
@@ -19,7 +22,7 @@
 
 ## vaults
 
-Query a list of vaults you can deposit into.
+Query a list of available vaults for depositing tokens.
 
 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
@@ -37,7 +40,6 @@ const compassApiSDK = new CompassApiSDK({
 async function run() {
   const result = await compassApiSDK.morpho.vaults({
     chain: "ethereum:mainnet",
-    depositToken: "<value>",
   });
 
   // Handle the result
@@ -64,7 +66,6 @@ const compassApiSDK = new CompassApiSDKCore({
 async function run() {
   const res = await morphoVaults(compassApiSDK, {
     chain: "ethereum:mainnet",
-    depositToken: "<value>",
   });
 
   if (!res.ok) {
@@ -100,6 +101,85 @@ run();
 | errors.HTTPValidationError | 422                        | application/json           |
 | errors.APIError            | 4XX, 5XX                   | \*/\*                      |
 
+## vault
+
+Get data & metrics for a specific Morpho vault.
+
+### Example Usage
+
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.morpho.vault({
+    chain: "ethereum:mainnet",
+    vaultAddress: "0xbEef047a543E45807105E51A8BBEFCc5950fcfBa",
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { morphoVault } from "@compass-labs/api-sdk/funcs/morphoVault.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await morphoVault(compassApiSDK, {
+    chain: "ethereum:mainnet",
+    vaultAddress: "0xbEef047a543E45807105E51A8BBEFCc5950fcfBa",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.MorphoVaultRequest](../../models/operations/morphovaultrequest.md)                                                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.MorphoGetVaultResponse](../../models/components/morphogetvaultresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
 ## vaultPosition
 
 Check how many shares you own and the equivalent token amount of a given
@@ -201,8 +281,6 @@ const compassApiSDK = new CompassApiSDK({
 async function run() {
   const result = await compassApiSDK.morpho.markets({
     chain: "ethereum:mainnet",
-    collateralToken: "<value>",
-    loanToken: "<value>",
   });
 
   // Handle the result
@@ -229,8 +307,6 @@ const compassApiSDK = new CompassApiSDKCore({
 async function run() {
   const res = await morphoMarkets(compassApiSDK, {
     chain: "ethereum:mainnet",
-    collateralToken: "<value>",
-    loanToken: "<value>",
   });
 
   if (!res.ok) {
@@ -266,6 +342,85 @@ run();
 | errors.HTTPValidationError | 422                        | application/json           |
 | errors.APIError            | 4XX, 5XX                   | \*/\*                      |
 
+## market
+
+Get data & metrics for a specific Morpho market.
+
+### Example Usage
+
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.morpho.market({
+    chain: "ethereum:mainnet",
+    uniqueMarketKey: "0x83b7ad16905809ea36482f4fbf6cfee9c9f316d128de9a5da1952607d5e4df5e",
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { morphoMarket } from "@compass-labs/api-sdk/funcs/morphoMarket.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await morphoMarket(compassApiSDK, {
+    chain: "ethereum:mainnet",
+    uniqueMarketKey: "0x83b7ad16905809ea36482f4fbf6cfee9c9f316d128de9a5da1952607d5e4df5e",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.MorphoMarketRequest](../../models/operations/morphomarketrequest.md)                                                                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.MorphoGetMarketResponse](../../models/components/morphogetmarketresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
 ## marketPosition
 
 Check how many shares you've borrowed and the equivalent token amount of a given
@@ -348,6 +503,85 @@ run();
 | errors.HTTPValidationError | 422                        | application/json           |
 | errors.APIError            | 4XX, 5XX                   | \*/\*                      |
 
+## userPosition
+
+Check user's overall position across the entire Morpho ecosystem.
+
+### Example Usage
+
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.morpho.userPosition({
+    chain: "ethereum:mainnet",
+    userAddress: "0xa829B388A3DF7f581cE957a95edbe419dd146d1B",
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { morphoUserPosition } from "@compass-labs/api-sdk/funcs/morphoUserPosition.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await morphoUserPosition(compassApiSDK, {
+    chain: "ethereum:mainnet",
+    userAddress: "0xa829B388A3DF7f581cE957a95edbe419dd146d1B",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.MorphoUserPositionRequest](../../models/operations/morphouserpositionrequest.md)                                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.MorphoCheckUserPositionResponse](../../models/components/morphocheckuserpositionresponse.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
 ## allowance
 
 Set an allowance for a Morpho vault. You must set this for at least the amount you wish to deposit - before depositing.

package/docs/sdks/sky/README.md

@@ -347,8 +347,6 @@ run();
 
 Withdraw USDS for sUSDS to stop earning yield.
 
-There are no fees.
-
 ### Example Usage
 
 ```typescript

package/docs/sdks/token/README.md

@@ -8,7 +8,7 @@
 * [address](#address) - Token Address
 * [price](#price) - Token Price
 * [balance](#balance) - Token Balance
-* [transfer](#transfer) - Transfer ETH or ERC20 Tokens
+* [transfer](#transfer) - Transfer ETH or ERC20 Tokens.
 
 ## address
 

package/docs/sdks/universal/README.md

@@ -421,7 +421,7 @@ run();
 
 ## wrapEth
 
-Wrapping ETH creates an ERC-20 compliant form of ETH that is typically needed for
+Wrapping ETH creates an ERC20 compliant form of ETH that is typically needed for
 it to be traded on DeFi protocols.
 
 ### Example Usage

package/jsr.json

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

package/src/funcs/aaveV3AvgRate.ts

@@ -29,7 +29,7 @@ import { Result } from "../types/fp.js";
  * Average interest rates
  *
  * @remarks
- * Returns time averaged Interest Rates for Aave Reserves:
+ * Returns time averaged Interest Rates for Aave Reserves.
  */
 export function aaveV3AvgRate(
   client: CompassApiSDKCore,

package/src/funcs/aaveV3StdRate.ts

@@ -29,7 +29,7 @@ import { Result } from "../types/fp.js";
  * Standard deviation of interest rates
  *
  * @remarks
- * Returns the standard deviation of Interest Rates for Aave Reserves over time:
+ * Returns the standard deviation of Interest Rates for Aave Reserves over time.
  */
 export function aaveV3StdRate(
   client: CompassApiSDKCore,

package/src/funcs/morphoMarket.ts

@@ -0,0 +1,169 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CompassApiSDKCore } from "../core.js";
+import { encodeFormQuery } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import { APIError } from "../models/errors/apierror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Get Market
+ *
+ * @remarks
+ * Get data & metrics for a specific Morpho market.
+ */
+export function morphoMarket(
+  client: CompassApiSDKCore,
+  request: operations.MorphoMarketRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.MorphoGetMarketResponse,
+    | errors.HTTPValidationError
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CompassApiSDKCore,
+  request: operations.MorphoMarketRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.MorphoGetMarketResponse,
+      | errors.HTTPValidationError
+      | APIError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.MorphoMarketRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/v0/morpho/market")();
+
+  const query = encodeFormQuery({
+    "chain": payload.chain,
+    "unique_market_key": payload.unique_market_key,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKeyAuth);
+  const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "morpho_market",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKeyAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["422", "4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    components.MorphoGetMarketResponse,
+    | errors.HTTPValidationError
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, components.MorphoGetMarketResponse$inboundSchema),
+    M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}