@compass-labs/api-sdk 0.5.44 → 0.5.45

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

@@ -1 +1 @@
-{"version":3,"file":"sky.d.ts","sourceRoot":"","sources":["../../../src/sdk/sky.ts"],"names":[],"mappings":"AASA,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,GAAI,SAAQ,SAAS;IAChC;;;;;OAKG;IACG,QAAQ,CACZ,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAQ/C;;;;;;;;;;;OAWG;IACG,GAAG,CACP,OAAO,EAAE,UAAU,CAAC,aAAa,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;;;;;;;OAWG;IACG,IAAI,CACR,OAAO,EAAE,UAAU,CAAC,cAAc,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;;;OAOG;IACG,OAAO,CACX,OAAO,EAAE,UAAU,CAAC,iBAAiB,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;OAKG;IACG,QAAQ,CACZ,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;CAOlC"}
+{"version":3,"file":"sky.d.ts","sourceRoot":"","sources":["../../../src/sdk/sky.ts"],"names":[],"mappings":"AASA,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,GAAI,SAAQ,SAAS;IAChC;;;;;OAKG;IACG,QAAQ,CACZ,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAQ/C;;;;;;;;;;;OAWG;IACG,GAAG,CACP,OAAO,EAAE,UAAU,CAAC,aAAa,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;;;;;;;OAWG;IACG,IAAI,CACR,OAAO,EAAE,UAAU,CAAC,cAAc,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;;;;;OASG;IACG,OAAO,CACX,OAAO,EAAE,UAAU,CAAC,iBAAiB,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;IAQjC;;;;;;;;;OASG;IACG,QAAQ,CACZ,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;CAOlC"}

package/dist/esm/sdk/sky.js

@@ -28,7 +28,7 @@ export class Sky extends ClientSDK {
      * 'SkyDaiUsdsConverter' contract beforehand.
      *
      * If buying with USDC, user will need to set an allowance on the USDC contract for the
-     * 'SkyDaiUsdsConverter' contract beforehand.
+     * 'SkyUsdcUsdsConverter' contract beforehand.
      */
     async buy(request, options) {
         return unwrapAsync(skyBuy(this, request, options));
@@ -52,7 +52,9 @@ export class Sky extends ClientSDK {
      * Deposit USDS
      *
      * @remarks
-     * Deposit USDS for sUSDS to earn yield.
+     * Deposit USDS to earn yield. Deposited USDS is represented as sUSDS.
+     *
+     * Allowance must be set on USDS contract for UsdsVault.
      *
      * There are no fees.
      */
@@ -63,7 +65,11 @@ export class Sky extends ClientSDK {
      * Withdraw USDS
      *
      * @remarks
-     * Withdraw USDS for sUSDS to stop earning yield.
+     * Withdraw USDS. Exchange yield-bearing sUSDS for USDS.
+     *
+     * Allowance must be set on USDS contract for UsdsVault.
+     *
+     * There are no fees.
      */
     async withdraw(request, options) {
         return unwrapAsync(skyWithdraw(this, request, options));

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

@@ -1 +1 @@
-{"version":3,"file":"sky.js","sourceRoot":"","sources":["../../../src/sdk/sky.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,GAAI,SAAQ,SAAS;IAChC;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CACZ,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,WAAW,CAC5B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,GAAG,CACP,OAAiC,EACjC,OAAwB;QAExB,OAAO,WAAW,CAAC,MAAM,CACvB,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,IAAI,CACR,OAAkC,EAClC,OAAwB;QAExB,OAAO,WAAW,CAAC,OAAO,CACxB,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,OAAO,CACX,OAAqC,EACrC,OAAwB;QAExB,OAAO,WAAW,CAAC,UAAU,CAC3B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CACZ,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,WAAW,CAC5B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"sky.js","sourceRoot":"","sources":["../../../src/sdk/sky.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,GAAI,SAAQ,SAAS;IAChC;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CACZ,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,WAAW,CAC5B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,GAAG,CACP,OAAiC,EACjC,OAAwB;QAExB,OAAO,WAAW,CAAC,MAAM,CACvB,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,IAAI,CACR,OAAkC,EAClC,OAAwB;QAExB,OAAO,WAAW,CAAC,OAAO,CACxB,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,OAAO,CACX,OAAqC,EACrC,OAAwB;QAExB,OAAO,WAAW,CAAC,UAAU,CAC3B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,QAAQ,CACZ,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,WAAW,CAC5B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/docs/sdks/sky/README.md

@@ -88,7 +88,7 @@ If buying with DAI, user will need to set an allowance on the DAI contract for t
 'SkyDaiUsdsConverter' contract beforehand.
 
 If buying with USDC, user will need to set an allowance on the USDC contract for the
-'SkyDaiUsdsConverter' contract beforehand.
+'SkyUsdcUsdsConverter' contract beforehand.
 
 ### Example Usage
 
@@ -248,7 +248,9 @@ run();
 
 ## deposit
 
-Deposit USDS for sUSDS to earn yield.
+Deposit USDS to earn yield. Deposited USDS is represented as sUSDS.
+
+Allowance must be set on USDS contract for UsdsVault.
 
 There are no fees.
 
@@ -325,7 +327,11 @@ run();
 
 ## withdraw
 
-Withdraw USDS for sUSDS to stop earning yield.
+Withdraw USDS. Exchange yield-bearing sUSDS for USDS.
+
+Allowance must be set on USDS contract for UsdsVault.
+
+There are no fees.
 
 ### Example Usage
 

package/jsr.json

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

package/src/funcs/skyBuy.ts

@@ -35,7 +35,7 @@ import { Result } from "../types/fp.js";
  * 'SkyDaiUsdsConverter' contract beforehand.
  *
  * If buying with USDC, user will need to set an allowance on the USDC contract for the
- * 'SkyDaiUsdsConverter' contract beforehand.
+ * 'SkyUsdcUsdsConverter' contract beforehand.
  */
 export function skyBuy(
   client: CompassApiSDKCore,

package/src/funcs/skyDeposit.ts

@@ -29,7 +29,9 @@ import { Result } from "../types/fp.js";
  * Deposit USDS
  *
  * @remarks
- * Deposit USDS for sUSDS to earn yield.
+ * Deposit USDS to earn yield. Deposited USDS is represented as sUSDS.
+ *
+ * Allowance must be set on USDS contract for UsdsVault.
  *
  * There are no fees.
  */

package/src/funcs/skyWithdraw.ts

@@ -29,7 +29,11 @@ import { Result } from "../types/fp.js";
  * Withdraw USDS
  *
  * @remarks
- * Withdraw USDS for sUSDS to stop earning yield.
+ * Withdraw USDS. Exchange yield-bearing sUSDS for USDS.
+ *
+ * Allowance must be set on USDS contract for UsdsVault.
+ *
+ * There are no fees.
  */
 export function skyWithdraw(
   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: "0.5.44",
+  sdkVersion: "0.5.45",
   genVersion: "2.656.5",
   userAgent:
-    "speakeasy-sdk/typescript 0.5.44 2.656.5 0.0.1 @compass-labs/api-sdk",
+    "speakeasy-sdk/typescript 0.5.45 2.656.5 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: "0.5.44",
+    currentVersion: "0.5.45",
   },
 });
 

package/src/mcp-server/server.ts

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

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

@@ -20,7 +20,7 @@ If buying with DAI, user will need to set an allowance on the DAI contract for t
 'SkyDaiUsdsConverter' contract beforehand.
 
 If buying with USDC, user will need to set an allowance on the USDC contract for the
-'SkyDaiUsdsConverter' contract beforehand.`,
+'SkyUsdcUsdsConverter' contract beforehand.`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await skyBuy(

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

@@ -14,7 +14,9 @@ export const tool$skyDeposit: ToolDefinition<typeof args> = {
   name: "sky-deposit",
   description: `Deposit USDS
 
-Deposit USDS for sUSDS to earn yield.
+Deposit USDS to earn yield. Deposited USDS is represented as sUSDS.
+
+Allowance must be set on USDS contract for UsdsVault.
 
 There are no fees.`,
   args,

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

@@ -14,7 +14,11 @@ export const tool$skyWithdraw: ToolDefinition<typeof args> = {
   name: "sky-withdraw",
   description: `Withdraw USDS
 
-Withdraw USDS for sUSDS to stop earning yield.`,
+Withdraw USDS. Exchange yield-bearing sUSDS for USDS.
+
+Allowance must be set on USDS contract for UsdsVault.
+
+There are no fees.`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await skyWithdraw(

package/src/sdk/sky.ts

@@ -40,7 +40,7 @@ export class Sky extends ClientSDK {
    * 'SkyDaiUsdsConverter' contract beforehand.
    *
    * If buying with USDC, user will need to set an allowance on the USDC contract for the
-   * 'SkyDaiUsdsConverter' contract beforehand.
+   * 'SkyUsdcUsdsConverter' contract beforehand.
    */
   async buy(
     request: components.SkyBuyRequest,
@@ -80,7 +80,9 @@ export class Sky extends ClientSDK {
    * Deposit USDS
    *
    * @remarks
-   * Deposit USDS for sUSDS to earn yield.
+   * Deposit USDS to earn yield. Deposited USDS is represented as sUSDS.
+   *
+   * Allowance must be set on USDS contract for UsdsVault.
    *
    * There are no fees.
    */
@@ -99,7 +101,11 @@ export class Sky extends ClientSDK {
    * Withdraw USDS
    *
    * @remarks
-   * Withdraw USDS for sUSDS to stop earning yield.
+   * Withdraw USDS. Exchange yield-bearing sUSDS for USDS.
+   *
+   * Allowance must be set on USDS contract for UsdsVault.
+   *
+   * There are no fees.
    */
   async withdraw(
     request: components.SkyWithdrawRequest,