@compass-labs/api-sdk 1.0.5 → 1.0.7

package/dist/esm/sdk/ethena.d.ts

@@ -4,6 +4,13 @@ import * as operations from "../models/operations/index.js";
 export declare class Ethena extends ClientSDK {
     /**
      * Get Vault & User Position
+     *
+     * @remarks
+     * Get data & user Position for the Ethena vault on Ethereum.
+     *
+     * Vault address: 0x9d39a5de30e57443bff2a8307a4256c8797a3497
+     *
+     * The user position is only included in the response if 'user_address' parameter is included in the request.
      */
     ethenaVault(request: operations.V1EthenaVaultRequest, options?: RequestOptions): Promise<components.EthenaGetVaultResponse>;
     /**

package/dist/esm/sdk/ethena.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ethena.d.ts","sourceRoot":"","sources":["../../../src/sdk/ethena.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,MAAO,SAAQ,SAAS;IACnC;;OAEG;IACG,WAAW,CACf,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAQ7C;;;;;;;;;;;;;;OAcG;IACG,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mBAAmB,CAAC;IAQ1C;;;;;;;;;;;;;;;;OAgBG;IACG,cAAc,CAClB,OAAO,EAAE,UAAU,CAAC,qBAAqB,EACzC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mBAAmB,CAAC;IAQ1C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,8BAA8B,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,0CAA0C,CAAC;CAOlE"}
+{"version":3,"file":"ethena.d.ts","sourceRoot":"","sources":["../../../src/sdk/ethena.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,MAAO,SAAQ,SAAS;IACnC;;;;;;;;;OASG;IACG,WAAW,CACf,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAQ7C;;;;;;;;;;;;;;OAcG;IACG,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mBAAmB,CAAC;IAQ1C;;;;;;;;;;;;;;;;OAgBG;IACG,cAAc,CAClB,OAAO,EAAE,UAAU,CAAC,qBAAqB,EACzC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mBAAmB,CAAC;IAQ1C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,8BAA8B,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,0CAA0C,CAAC;CAOlE"}

package/dist/esm/sdk/ethena.js

@@ -10,6 +10,13 @@ import { unwrapAsync } from "../types/fp.js";
 export class Ethena extends ClientSDK {
     /**
      * Get Vault & User Position
+     *
+     * @remarks
+     * Get data & user Position for the Ethena vault on Ethereum.
+     *
+     * Vault address: 0x9d39a5de30e57443bff2a8307a4256c8797a3497
+     *
+     * The user position is only included in the response if 'user_address' parameter is included in the request.
      */
     async ethenaVault(request, options) {
         return unwrapAsync(ethenaEthenaVault(this, request, options));

package/dist/esm/sdk/ethena.js.map

@@ -1 +1 @@
-{"version":3,"file":"ethena.js","sourceRoot":"","sources":["../../../src/sdk/ethena.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,MAAO,SAAQ,SAAS;IACnC;;OAEG;IACH,KAAK,CAAC,WAAW,CACf,OAAwC,EACxC,OAAwB;QAExB,OAAO,WAAW,CAAC,iBAAiB,CAClC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,aAAa,CACjB,OAAwC,EACxC,OAAwB;QAExB,OAAO,WAAW,CAAC,mBAAmB,CACpC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,cAAc,CAClB,OAAyC,EACzC,OAAwB;QAExB,OAAO,WAAW,CAAC,oBAAoB,CACrC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,aAAa,CACjB,OAAkD,EAClD,OAAwB;QAExB,OAAO,WAAW,CAAC,mBAAmB,CACpC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"ethena.js","sourceRoot":"","sources":["../../../src/sdk/ethena.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,MAAO,SAAQ,SAAS;IACnC;;;;;;;;;OASG;IACH,KAAK,CAAC,WAAW,CACf,OAAwC,EACxC,OAAwB;QAExB,OAAO,WAAW,CAAC,iBAAiB,CAClC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,aAAa,CACjB,OAAwC,EACxC,OAAwB;QAExB,OAAO,WAAW,CAAC,mBAAmB,CACpC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,cAAc,CAClB,OAAyC,EACzC,OAAwB;QAExB,OAAO,WAAW,CAAC,oBAAoB,CACrC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,aAAa,CACjB,OAAkD,EAClD,OAAwB;QAExB,OAAO,WAAW,CAAC,mBAAmB,CACpC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/docs/sdks/aavev3/README.md

@@ -716,6 +716,10 @@ repayments. Each transaction includes details such as the token, amount, timesta
 and transaction type. This provides a comprehensive view of the user's historical
 activity within the AAVE protocol.
 
+⚠️ Data comes from the official Aave subgraph (
+https://github.com/aave/protocol-subgraphs)
+and thus this particular endpoint may be less reliable than our other endpoints. ⚠️
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="v1_aave_historical_transactions" method="get" path="/v1/aave/historical_transactions" -->

package/docs/sdks/ethena/README.md

@@ -12,7 +12,11 @@
 
 ## ethenaVault
 
-Get Vault & User Position
+Get data & user Position for the Ethena vault on Ethereum.
+
+Vault address: 0x9d39a5de30e57443bff2a8307a4256c8797a3497
+
+The user position is only included in the response if 'user_address' parameter is included in the request.
 
 ### Example Usage
 

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@compass-labs/api-sdk",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@compass-labs/api-sdk",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "author": "royalnine",
   "type": "module",
   "bin": {

package/src/funcs/aaveV3AaveHistoricalTransactions.ts

@@ -36,6 +36,10 @@ import { Result } from "../types/fp.js";
  * repayments. Each transaction includes details such as the token, amount, timestamp,
  * and transaction type. This provides a comprehensive view of the user's historical
  * activity within the AAVE protocol.
+ *
+ * ⚠️ Data comes from the official Aave subgraph (
+ * https://github.com/aave/protocol-subgraphs)
+ * and thus this particular endpoint may be less reliable than our other endpoints. ⚠️
  */
 export function aaveV3AaveHistoricalTransactions(
   client: CompassApiSDKCore,

package/src/funcs/ethenaEthenaVault.ts

@@ -28,6 +28,13 @@ import { Result } from "../types/fp.js";
 
 /**
  * Get Vault & User Position
+ *
+ * @remarks
+ * Get data & user Position for the Ethena vault on Ethereum.
+ *
+ * Vault address: 0x9d39a5de30e57443bff2a8307a4256c8797a3497
+ *
+ * The user position is only included in the response if 'user_address' parameter is included in the request.
  */
 export function ethenaEthenaVault(
   client: CompassApiSDKCore,

package/src/lib/config.ts

@@ -61,8 +61,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.0.1",
-  sdkVersion: "1.0.5",
+  sdkVersion: "1.0.7",
   genVersion: "2.675.0",
   userAgent:
-    "speakeasy-sdk/typescript 1.0.5 2.675.0 0.0.1 @compass-labs/api-sdk",
+    "speakeasy-sdk/typescript 1.0.7 2.675.0 0.0.1 @compass-labs/api-sdk",
 } as const;

package/src/mcp-server/mcp-server.ts

@@ -19,7 +19,7 @@ const routes = buildRouteMap({
 export const app = buildApplication(routes, {
   name: "mcp",
   versionInfo: {
-    currentVersion: "1.0.5",
+    currentVersion: "1.0.7",
   },
 });
 

package/src/mcp-server/server.ts

@@ -103,7 +103,7 @@ export function createMCPServer(deps: {
 }) {
   const server = new McpServer({
     name: "CompassApiSDK",
-    version: "1.0.5",
+    version: "1.0.7",
   });
 
   const client = new CompassApiSDKCore({

package/src/mcp-server/tools/aaveV3AaveHistoricalTransactions.ts

@@ -21,7 +21,11 @@ This endpoint retrieves historical transactions for a user on the AAVE platform.
 It returns a list of transactions including deposits, withdrawals, borrows, and
 repayments. Each transaction includes details such as the token, amount, timestamp,
 and transaction type. This provides a comprehensive view of the user's historical
-activity within the AAVE protocol.`,
+activity within the AAVE protocol.
+
+⚠️ Data comes from the official Aave subgraph (
+https://github.com/aave/protocol-subgraphs)
+and thus this particular endpoint may be less reliable than our other endpoints. ⚠️`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await aaveV3AaveHistoricalTransactions(

package/src/mcp-server/tools/ethenaEthenaVault.ts

@@ -12,7 +12,13 @@ const args = {
 
 export const tool$ethenaEthenaVault: ToolDefinition<typeof args> = {
   name: "ethena-ethena-vault",
-  description: `Get Vault & User Position`,
+  description: `Get Vault & User Position
+
+Get data & user Position for the Ethena vault on Ethereum.
+
+Vault address: 0x9d39a5de30e57443bff2a8307a4256c8797a3497
+
+The user position is only included in the response if 'user_address' parameter is included in the request.`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await ethenaEthenaVault(

package/src/sdk/aavev3.ts

@@ -242,6 +242,10 @@ export class AaveV3 extends ClientSDK {
    * repayments. Each transaction includes details such as the token, amount, timestamp,
    * and transaction type. This provides a comprehensive view of the user's historical
    * activity within the AAVE protocol.
+   *
+   * ⚠️ Data comes from the official Aave subgraph (
+   * https://github.com/aave/protocol-subgraphs)
+   * and thus this particular endpoint may be less reliable than our other endpoints. ⚠️
    */
   async aaveHistoricalTransactions(
     request: operations.V1AaveHistoricalTransactionsRequest,

package/src/sdk/ethena.ts

@@ -14,6 +14,13 @@ import { unwrapAsync } from "../types/fp.js";
 export class Ethena extends ClientSDK {
   /**
    * Get Vault & User Position
+   *
+   * @remarks
+   * Get data & user Position for the Ethena vault on Ethereum.
+   *
+   * Vault address: 0x9d39a5de30e57443bff2a8307a4256c8797a3497
+   *
+   * The user position is only included in the response if 'user_address' parameter is included in the request.
    */
   async ethenaVault(
     request: operations.V1EthenaVaultRequest,