@compass-labs/api-sdk 0.5.7 → 0.5.9

package/FUNCTIONS.md

@@ -21,7 +21,6 @@ specific category of applications.
 ```typescript
 import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
 import { aaveV3Rate } from "@compass-labs/api-sdk/funcs/aaveV3Rate.js";
-import { SDKValidationError } from "@compass-labs/api-sdk/models/errors/sdkvalidationerror.js";
 
 // Use `CompassApiSDKCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -30,32 +29,13 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await aaveV3Rate(compassApiSDK, {
-    chain: "arbitrum:mainnet",
-    token: "USDC",
-  });
-
-  switch (true) {
-    case res.ok:
-      // The success case will be handled outside of the switch block
-      break;
-    case res.error instanceof SDKValidationError:
-      // Pretty-print validation errors.
-      return console.log(res.error.pretty());
-    case res.error instanceof Error:
-      return console.log(res.error);
-    default:
-      // TypeScript's type checking will fail on the following line if the above
-      // cases were not exhaustive.
-      res.error satisfies never;
-      throw new Error("Assertion failed: expected error checks to be exhaustive: " + res.error);
+  const res = await aaveV3Rate(compassApiSDK, {});
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("aaveV3Rate failed:", res.error);
   }
-
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/README.md

@@ -168,12 +168,8 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.aaveV3.rate({
-    chain: "arbitrum:mainnet",
-    token: "USDC",
-  });
+  const result = await compassApiSDK.aaveV3.rate({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -202,12 +198,8 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.aaveV3.rate({
-    chain: "arbitrum:mainnet",
-    token: "USDC",
-  });
+  const result = await compassApiSDK.aaveV3.rate({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -270,13 +262,15 @@ run();
 
 * [position](docs/sdks/pendle/README.md#position) - Check User's Market Position
 * [positions](docs/sdks/pendle/README.md#positions) - List User's Market Positions
-* [markets](docs/sdks/pendle/README.md#markets) - List Market Data
 * [market](docs/sdks/pendle/README.md#market) - Get Market Data
+* [markets](docs/sdks/pendle/README.md#markets) - List Market Data
 * [buyPt](docs/sdks/pendle/README.md#buypt) - Buy Principal Token (PT)
 * [sellPt](docs/sdks/pendle/README.md#sellpt) - Sell Principal Token (PT)
 * [buyYt](docs/sdks/pendle/README.md#buyyt) - Buy Yield Token (YT)
 * [sellYt](docs/sdks/pendle/README.md#sellyt) - Sell Yield Token (YT)
 * [redeemYield](docs/sdks/pendle/README.md#redeemyield) - Redeem Claimable Yield
+* [addLiquidity](docs/sdks/pendle/README.md#addliquidity) - Add Liquidity
+* [removeLiquidity](docs/sdks/pendle/README.md#removeliquidity) - Remove Liquidity
 
 ### [sky](docs/sdks/sky/README.md)
 
@@ -325,7 +319,7 @@ run();
 * [ens](docs/sdks/universal/README.md#ens) - Resolve ENS
 * [wrapEth](docs/sdks/universal/README.md#wrapeth) - Wrap ETH
 * [unwrapWeth](docs/sdks/universal/README.md#unwrapweth) - Unwrap WETH
-* [allowanceSet](docs/sdks/universal/README.md#allowanceset) - Set Allowance (symbol)
+* [allowanceSet](docs/sdks/universal/README.md#allowanceset) - Set Allowance
 
 </details>
 <!-- End Available Resources and Operations [operations] -->
@@ -379,6 +373,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`morphoVaults`](docs/sdks/morpho/README.md#vaults) - Get Vaults
 - [`morphoWithdraw`](docs/sdks/morpho/README.md#withdraw) - Withdraw from Vault
 - [`morphoWithdrawCollateral`](docs/sdks/morpho/README.md#withdrawcollateral) - Withdraw Collateral from Market
+- [`pendleAddLiquidity`](docs/sdks/pendle/README.md#addliquidity) - Add Liquidity
 - [`pendleBuyPt`](docs/sdks/pendle/README.md#buypt) - Buy Principal Token (PT)
 - [`pendleBuyYt`](docs/sdks/pendle/README.md#buyyt) - Buy Yield Token (YT)
 - [`pendleMarket`](docs/sdks/pendle/README.md#market) - Get Market Data
@@ -386,6 +381,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`pendlePosition`](docs/sdks/pendle/README.md#position) - Check User's Market Position
 - [`pendlePositions`](docs/sdks/pendle/README.md#positions) - List User's Market Positions
 - [`pendleRedeemYield`](docs/sdks/pendle/README.md#redeemyield) - Redeem Claimable Yield
+- [`pendleRemoveLiquidity`](docs/sdks/pendle/README.md#removeliquidity) - Remove Liquidity
 - [`pendleSellPt`](docs/sdks/pendle/README.md#sellpt) - Sell Principal Token (PT)
 - [`pendleSellYt`](docs/sdks/pendle/README.md#sellyt) - Sell Yield Token (YT)
 - [`skyBuy`](docs/sdks/sky/README.md#buy) - Buy USDS
@@ -412,7 +408,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`uniswapV3SwapBuyExactly`](docs/sdks/uniswapv3/README.md#swapbuyexactly) - Buy exact amount
 - [`uniswapV3SwapSellExactly`](docs/sdks/uniswapv3/README.md#swapsellexactly) - Sell exact amount
 - [`universalAllowance`](docs/sdks/universal/README.md#allowance) - Get allowance - Protocol
-- [`universalAllowanceSet`](docs/sdks/universal/README.md#allowanceset) - Set Allowance (symbol)
+- [`universalAllowanceSet`](docs/sdks/universal/README.md#allowanceset) - Set Allowance
 - [`universalEns`](docs/sdks/universal/README.md#ens) - Resolve ENS
 - [`universalPortfolio`](docs/sdks/universal/README.md#portfolio) - List user portfolio
 - [`universalSupportedTokens`](docs/sdks/universal/README.md#supportedtokens) - List supported tokens
@@ -437,10 +433,7 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.aaveV3.rate({
-    chain: "arbitrum:mainnet",
-    token: "USDC",
-  }, {
+  const result = await compassApiSDK.aaveV3.rate({}, {
     retries: {
       strategy: "backoff",
       backoff: {
@@ -453,7 +446,6 @@ async function run() {
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -480,12 +472,8 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.aaveV3.rate({
-    chain: "arbitrum:mainnet",
-    token: "USDC",
-  });
+  const result = await compassApiSDK.aaveV3.rate({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -497,54 +485,42 @@ run();
 <!-- Start Error Handling [errors] -->
 ## Error Handling
 
-Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `rate` method may throw the following errors:
-
-| Error Type                 | Status Code | Content Type     |
-| -------------------------- | ----------- | ---------------- |
-| errors.HTTPValidationError | 422         | application/json |
-| errors.APIError            | 4XX, 5XX    | \*/\*            |
+[`CompassAPISDKError`](./src/models/errors/compassapisdkerror.ts) is the base class for all HTTP error responses. It has the following properties:
 
-If the method throws an error and it is not captured by the known errors, it will default to throwing a `APIError`.
+| Property            | Type       | Description                                                                             |
+| ------------------- | ---------- | --------------------------------------------------------------------------------------- |
+| `error.message`     | `string`   | Error message                                                                           |
+| `error.statusCode`  | `number`   | HTTP response status code eg `404`                                                      |
+| `error.headers`     | `Headers`  | HTTP response headers                                                                   |
+| `error.body`        | `string`   | HTTP body. Can be empty string if no body is returned.                                  |
+| `error.rawResponse` | `Response` | Raw HTTP response                                                                       |
+| `error.data$`       |            | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |
 
+### Example
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
-import {
-  HTTPValidationError,
-  SDKValidationError,
-} from "@compass-labs/api-sdk/models/errors";
+import * as errors from "@compass-labs/api-sdk/models/errors";
 
 const compassApiSDK = new CompassApiSDK({
   apiKeyAuth: "<YOUR_API_KEY_HERE>",
 });
 
 async function run() {
-  let result;
   try {
-    result = await compassApiSDK.aaveV3.rate({
-      chain: "arbitrum:mainnet",
-      token: "USDC",
-    });
+    const result = await compassApiSDK.aaveV3.rate({});
 
-    // Handle the result
     console.log(result);
-  } catch (err) {
-    switch (true) {
-      // The server response does not match the expected SDK schema
-      case (err instanceof SDKValidationError): {
-        // Pretty-print will provide a human-readable multi-line error message
-        console.error(err.pretty());
-        // Raw value may also be inspected
-        console.error(err.rawValue);
-        return;
-      }
-      case (err instanceof HTTPValidationError): {
-        // Handle err.data$: HTTPValidationErrorData
-        console.error(err);
-        return;
-      }
-      default: {
-        // Other errors such as network errors, see HTTPClientErrors for more details
-        throw err;
+  } catch (error) {
+    // The base class for HTTP error responses
+    if (error instanceof errors.CompassAPISDKError) {
+      console.log(error.message);
+      console.log(error.statusCode);
+      console.log(error.body);
+      console.log(error.headers);
+
+      // Depending on the method different errors may be thrown
+      if (error instanceof errors.HTTPValidationError) {
+        console.log(error.data$.detail); // ValidationError[]
       }
     }
   }
@@ -554,17 +530,27 @@ run();
 
 ```
 
-Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.
+### Error Classes
+**Primary errors:**
+* [`CompassAPISDKError`](./src/models/errors/compassapisdkerror.ts): The base class for HTTP error responses.
+  * [`HTTPValidationError`](docs/models/errors/httpvalidationerror.md): Validation Error. Status code `422`.
+
+<details><summary>Less common errors (6)</summary>
+
+<br />
+
+**Network errors:**
+* [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.
+* [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.
+* [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.
+* [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.
+* [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.
 
-In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the `models/errors/httpclienterrors.ts` module:
 
-| HTTP Client Error                                    | Description                                          |
-| ---------------------------------------------------- | ---------------------------------------------------- |
-| RequestAbortedError                                  | HTTP request was aborted by the client               |
-| RequestTimeoutError                                  | HTTP request timed out due to an AbortSignal signal  |
-| ConnectionError                                      | HTTP client was unable to make a request to a server |
-| InvalidRequestError                                  | Any input used to create a request is invalid        |
-| UnexpectedClientError                                | Unrecognised or unexpected error                     |
+**Inherit from [`CompassAPISDKError`](./src/models/errors/compassapisdkerror.ts)**:
+* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
+
+</details>
 <!-- End Error Handling [errors] -->
 
 <!-- Start Server Selection [server] -->
@@ -582,12 +568,8 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.aaveV3.rate({
-    chain: "arbitrum:mainnet",
-    token: "USDC",
-  });
+  const result = await compassApiSDK.aaveV3.rate({});
 
-  // Handle the result
   console.log(result);
 }