@compass-labs/api-sdk 2.1.0 → 2.1.1

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

@@ -10,7 +10,7 @@ export declare class Earn extends ClientSDK {
      */
     earnPositions(request: operations.V2EarnPositionsRequest, options?: RequestOptions): Promise<components.EarnPositionsResponse>;
     /**
-     * Get individual earn position
+     * Get earn position
      *
      * @remarks
      * This endpoint fetches a single Compass Earn position by its encoded ID.
@@ -27,15 +27,15 @@ export declare class Earn extends ClientSDK {
      * Create earn account
      *
      * @remarks
-     * Create a Compass Earn Account.
+     * Create an Earn Account.
      *
-     * Before creating Earn positions you must create a Compass Earn Account. This account will be associated with the `owner` wallet address.
+     * Before creating Earn positions, the `owner` must create an Earn Account associated with their wallet address.
      *
      * Only the `owner` has the authority to sign transactions for this account. This can be done in one of two ways:
      *
-     * 1) The `owner` signs an unsigned transaction and submits to the network for execution. The `owner` covers the cost of gas in this case.
+     * 1) **No gas-sponsorship:** The `owner` signs a transaction and submits it to the network for execution. The `owner` covers the cost of gas in this case.
      *
-     * 2) The `owner` does an off-chain EIP-712 signature and submits this signature to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`).
+     * 2) **Gas-sponsorship:** The `owner` does an off-chain EIP-712 signature and submits this signature to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`). Here, another wallet address is set as `sender`. This wallet will sign, submit and cover the gas fees of the transaction.
      *
      * The creation of an Earn Account itself can be a gas-sponsored transaction by setting the `sender` to the wallet which will sign and send the transaction.
      */
@@ -44,14 +44,14 @@ export declare class Earn extends ClientSDK {
      * Transfer tokens to/from account
      *
      * @remarks
-     * Transfer tokens to and from a Compass Earn Account.
+     * Transfer tokens to and from an Earn Account.
      *
      * If `DEPOSIT`'` is selected, tokens will be transferred from the `owner`'s wallet into their Earn Account.
      *
      * If `WITHDRAW` is selected, tokens will be transferred from the `owner`'s Earn Account into their wallet.
      *
-     * If a gas-sponsored `DEPOSIT` transfer is desired for a given token, a one-time Permit2 allowance must be set before proceeding. This is common practice for many other applications and, for many users, this one-time allowance will already have been set for the token they would like to transfer.
-     * Once the one-time allowance is set for a given token, EIP-712 typed data will be returned and can be signed off-chain by the user. This signature can then be submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`).
+     * If a gas-sponsored `DEPOSIT` transfer is desired for a given token, a one-time Permit2 allowance must be set before proceeding. This is common practice for many other applications and, for many `owner`s, this one-time allowance will already have been set for the token they would like to transfer.
+     * Once the one-time allowance is set for a given token and `gas_sponsorship` is set to 'true', EIP-712 typed data will be returned and can be signed off-chain by the user. This signature can then be submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`) where a `sender` can be set for the transaction.
      */
     earnTransfer(request: components.EarnTransferRequest, options?: RequestOptions): Promise<components.EarnTransferResponse>;
     /**
@@ -68,9 +68,9 @@ export declare class Earn extends ClientSDK {
      *
      * If `WITHDRAW` is selected, tokens will be withdrawn from the market to the `owner`'s Earn Account.
      *
-     * A fee can be configured. This fee is deducted from the total `amount`. It can be expressed as a `FIXED` amount or a `PERCENTAGE`.
+     * A fee can be configured. This fee is deducted from the total `amount`. It can be expressed as a `FIXED` amount or a `PERCENTAGE` of `amount`.
      *
-     * The transaction can be gas-sponsored by an arbitrary wallet address. Where the owner of said wallet will sign, submit and pay the required gas for the transaction. If `gas_sponsorship` is set to `true`, EIP-712 typed data will be returned that must be signed by the `owner` and submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`) where the `sender` of the transaction can be set.
+     * The transaction can be gas-sponsored by an arbitrary wallet address which will sign, submit and pay the required gas for the transaction. If `gas_sponsorship` is set to `true`, EIP-712 typed data will be returned that must be signed by the `owner` and submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`) where the `sender` of the transaction can be set.
      */
     earnManage(request: components.EarnManageRequest, options?: RequestOptions): Promise<components.EarnManageResponse>;
 }

package/dist/esm/sdk/earn.js

@@ -20,7 +20,7 @@ export class Earn extends ClientSDK {
         return unwrapAsync(earnEarnPositions(this, request, options));
     }
     /**
-     * Get individual earn position
+     * Get earn position
      *
      * @remarks
      * This endpoint fetches a single Compass Earn position by its encoded ID.
@@ -41,15 +41,15 @@ export class Earn extends ClientSDK {
      * Create earn account
      *
      * @remarks
-     * Create a Compass Earn Account.
+     * Create an Earn Account.
      *
-     * Before creating Earn positions you must create a Compass Earn Account. This account will be associated with the `owner` wallet address.
+     * Before creating Earn positions, the `owner` must create an Earn Account associated with their wallet address.
      *
      * Only the `owner` has the authority to sign transactions for this account. This can be done in one of two ways:
      *
-     * 1) The `owner` signs an unsigned transaction and submits to the network for execution. The `owner` covers the cost of gas in this case.
+     * 1) **No gas-sponsorship:** The `owner` signs a transaction and submits it to the network for execution. The `owner` covers the cost of gas in this case.
      *
-     * 2) The `owner` does an off-chain EIP-712 signature and submits this signature to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`).
+     * 2) **Gas-sponsorship:** The `owner` does an off-chain EIP-712 signature and submits this signature to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`). Here, another wallet address is set as `sender`. This wallet will sign, submit and cover the gas fees of the transaction.
      *
      * The creation of an Earn Account itself can be a gas-sponsored transaction by setting the `sender` to the wallet which will sign and send the transaction.
      */
@@ -60,14 +60,14 @@ export class Earn extends ClientSDK {
      * Transfer tokens to/from account
      *
      * @remarks
-     * Transfer tokens to and from a Compass Earn Account.
+     * Transfer tokens to and from an Earn Account.
      *
      * If `DEPOSIT`'` is selected, tokens will be transferred from the `owner`'s wallet into their Earn Account.
      *
      * If `WITHDRAW` is selected, tokens will be transferred from the `owner`'s Earn Account into their wallet.
      *
-     * If a gas-sponsored `DEPOSIT` transfer is desired for a given token, a one-time Permit2 allowance must be set before proceeding. This is common practice for many other applications and, for many users, this one-time allowance will already have been set for the token they would like to transfer.
-     * Once the one-time allowance is set for a given token, EIP-712 typed data will be returned and can be signed off-chain by the user. This signature can then be submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`).
+     * If a gas-sponsored `DEPOSIT` transfer is desired for a given token, a one-time Permit2 allowance must be set before proceeding. This is common practice for many other applications and, for many `owner`s, this one-time allowance will already have been set for the token they would like to transfer.
+     * Once the one-time allowance is set for a given token and `gas_sponsorship` is set to 'true', EIP-712 typed data will be returned and can be signed off-chain by the user. This signature can then be submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`) where a `sender` can be set for the transaction.
      */
     async earnTransfer(request, options) {
         return unwrapAsync(earnEarnTransfer(this, request, options));
@@ -86,9 +86,9 @@ export class Earn extends ClientSDK {
      *
      * If `WITHDRAW` is selected, tokens will be withdrawn from the market to the `owner`'s Earn Account.
      *
-     * A fee can be configured. This fee is deducted from the total `amount`. It can be expressed as a `FIXED` amount or a `PERCENTAGE`.
+     * A fee can be configured. This fee is deducted from the total `amount`. It can be expressed as a `FIXED` amount or a `PERCENTAGE` of `amount`.
      *
-     * The transaction can be gas-sponsored by an arbitrary wallet address. Where the owner of said wallet will sign, submit and pay the required gas for the transaction. If `gas_sponsorship` is set to `true`, EIP-712 typed data will be returned that must be signed by the `owner` and submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`) where the `sender` of the transaction can be set.
+     * The transaction can be gas-sponsored by an arbitrary wallet address which will sign, submit and pay the required gas for the transaction. If `gas_sponsorship` is set to `true`, EIP-712 typed data will be returned that must be signed by the `owner` and submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`) where the `sender` of the transaction can be set.
      */
     async earnManage(request, options) {
         return unwrapAsync(earnEarnManage(this, request, options));

package/package.json

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

package/src/funcs/earnEarnCreateAccount.ts

@@ -29,15 +29,15 @@ import { Result } from "../types/fp.js";
  * Create earn account
  *
  * @remarks
- * Create a Compass Earn Account.
+ * Create an Earn Account.
  *
- * Before creating Earn positions you must create a Compass Earn Account. This account will be associated with the `owner` wallet address.
+ * Before creating Earn positions, the `owner` must create an Earn Account associated with their wallet address.
  *
  * Only the `owner` has the authority to sign transactions for this account. This can be done in one of two ways:
  *
- * 1) The `owner` signs an unsigned transaction and submits to the network for execution. The `owner` covers the cost of gas in this case.
+ * 1) **No gas-sponsorship:** The `owner` signs a transaction and submits it to the network for execution. The `owner` covers the cost of gas in this case.
  *
- * 2) The `owner` does an off-chain EIP-712 signature and submits this signature to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`).
+ * 2) **Gas-sponsorship:** The `owner` does an off-chain EIP-712 signature and submits this signature to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`). Here, another wallet address is set as `sender`. This wallet will sign, submit and cover the gas fees of the transaction.
  *
  * The creation of an Earn Account itself can be a gas-sponsored transaction by setting the `sender` to the wallet which will sign and send the transaction.
  */

package/src/funcs/earnEarnManage.ts

@@ -39,9 +39,9 @@ import { Result } from "../types/fp.js";
  *
  * If `WITHDRAW` is selected, tokens will be withdrawn from the market to the `owner`'s Earn Account.
  *
- * A fee can be configured. This fee is deducted from the total `amount`. It can be expressed as a `FIXED` amount or a `PERCENTAGE`.
+ * A fee can be configured. This fee is deducted from the total `amount`. It can be expressed as a `FIXED` amount or a `PERCENTAGE` of `amount`.
  *
- * The transaction can be gas-sponsored by an arbitrary wallet address. Where the owner of said wallet will sign, submit and pay the required gas for the transaction. If `gas_sponsorship` is set to `true`, EIP-712 typed data will be returned that must be signed by the `owner` and submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`) where the `sender` of the transaction can be set.
+ * The transaction can be gas-sponsored by an arbitrary wallet address which will sign, submit and pay the required gas for the transaction. If `gas_sponsorship` is set to `true`, EIP-712 typed data will be returned that must be signed by the `owner` and submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`) where the `sender` of the transaction can be set.
  */
 export function earnEarnManage(
   client: CompassApiSDKCore,

package/src/funcs/earnEarnPositionsPositionId.ts

@@ -27,7 +27,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get individual earn position
+ * Get earn position
  *
  * @remarks
  * This endpoint fetches a single Compass Earn position by its encoded ID.

package/src/funcs/earnEarnTransfer.ts

@@ -29,14 +29,14 @@ import { Result } from "../types/fp.js";
  * Transfer tokens to/from account
  *
  * @remarks
- * Transfer tokens to and from a Compass Earn Account.
+ * Transfer tokens to and from an Earn Account.
  *
  * If `DEPOSIT`'` is selected, tokens will be transferred from the `owner`'s wallet into their Earn Account.
  *
  * If `WITHDRAW` is selected, tokens will be transferred from the `owner`'s Earn Account into their wallet.
  *
- * If a gas-sponsored `DEPOSIT` transfer is desired for a given token, a one-time Permit2 allowance must be set before proceeding. This is common practice for many other applications and, for many users, this one-time allowance will already have been set for the token they would like to transfer.
- * Once the one-time allowance is set for a given token, EIP-712 typed data will be returned and can be signed off-chain by the user. This signature can then be submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`).
+ * If a gas-sponsored `DEPOSIT` transfer is desired for a given token, a one-time Permit2 allowance must be set before proceeding. This is common practice for many other applications and, for many `owner`s, this one-time allowance will already have been set for the token they would like to transfer.
+ * Once the one-time allowance is set for a given token and `gas_sponsorship` is set to 'true', EIP-712 typed data will be returned and can be signed off-chain by the user. This signature can then be submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`) where a `sender` can be set for the transaction.
  */
 export function earnEarnTransfer(
   client: CompassApiSDKCore,

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

@@ -14,15 +14,15 @@ export const tool$earnEarnCreateAccount: ToolDefinition<typeof args> = {
   name: "earn-earn-create-account",
   description: `Create earn account
 
-Create a Compass Earn Account.
+Create an Earn Account.
 
-Before creating Earn positions you must create a Compass Earn Account. This account will be associated with the \`owner\` wallet address.
+Before creating Earn positions, the \`owner\` must create an Earn Account associated with their wallet address.
 
 Only the \`owner\` has the authority to sign transactions for this account. This can be done in one of two ways:
 
-1) The \`owner\` signs an unsigned transaction and submits to the network for execution. The \`owner\` covers the cost of gas in this case.
+1) **No gas-sponsorship:** The \`owner\` signs a transaction and submits it to the network for execution. The \`owner\` covers the cost of gas in this case.
 
-2) The \`owner\` does an off-chain EIP-712 signature and submits this signature to the 'Prepare gas-sponsored transaction' endpoint (\`/gas_sponsorship/prepare\`).
+2) **Gas-sponsorship:** The \`owner\` does an off-chain EIP-712 signature and submits this signature to the 'Prepare gas-sponsored transaction' endpoint (\`/gas_sponsorship/prepare\`). Here, another wallet address is set as \`sender\`. This wallet will sign, submit and cover the gas fees of the transaction.
 
 The creation of an Earn Account itself can be a gas-sponsored transaction by setting the \`sender\` to the wallet which will sign and send the transaction.`,
   args,

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

@@ -24,9 +24,9 @@ If \`DEPOSIT\` is selected for \`action\`, tokens will be deposited to the marke
 
 If \`WITHDRAW\` is selected, tokens will be withdrawn from the market to the \`owner\`'s Earn Account.
 
-A fee can be configured. This fee is deducted from the total \`amount\`. It can be expressed as a \`FIXED\` amount or a \`PERCENTAGE\`.
+A fee can be configured. This fee is deducted from the total \`amount\`. It can be expressed as a \`FIXED\` amount or a \`PERCENTAGE\` of \`amount\`.
 
-The transaction can be gas-sponsored by an arbitrary wallet address. Where the owner of said wallet will sign, submit and pay the required gas for the transaction. If \`gas_sponsorship\` is set to \`true\`, EIP-712 typed data will be returned that must be signed by the \`owner\` and submitted to the 'Prepare gas-sponsored transaction' endpoint (\`/gas_sponsorship/prepare\`) where the \`sender\` of the transaction can be set.`,
+The transaction can be gas-sponsored by an arbitrary wallet address which will sign, submit and pay the required gas for the transaction. If \`gas_sponsorship\` is set to \`true\`, EIP-712 typed data will be returned that must be signed by the \`owner\` and submitted to the 'Prepare gas-sponsored transaction' endpoint (\`/gas_sponsorship/prepare\`) where the \`sender\` of the transaction can be set.`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await earnEarnManage(

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

@@ -12,7 +12,7 @@ const args = {
 
 export const tool$earnEarnPositionsPositionId: ToolDefinition<typeof args> = {
   name: "earn-earn-positions-position-id",
-  description: `Get individual earn position
+  description: `Get earn position
 
 This endpoint fetches a single Compass Earn position by its encoded ID.`,
   args,

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

@@ -14,14 +14,14 @@ export const tool$earnEarnTransfer: ToolDefinition<typeof args> = {
   name: "earn-earn-transfer",
   description: `Transfer tokens to/from account
 
-Transfer tokens to and from a Compass Earn Account.
+Transfer tokens to and from an Earn Account.
 
 If \`DEPOSIT\`'\` is selected, tokens will be transferred from the \`owner\`'s wallet into their Earn Account.
 
 If \`WITHDRAW\` is selected, tokens will be transferred from the \`owner\`'s Earn Account into their wallet.
 
-If a gas-sponsored \`DEPOSIT\` transfer is desired for a given token, a one-time Permit2 allowance must be set before proceeding. This is common practice for many other applications and, for many users, this one-time allowance will already have been set for the token they would like to transfer.
-Once the one-time allowance is set for a given token, EIP-712 typed data will be returned and can be signed off-chain by the user. This signature can then be submitted to the 'Prepare gas-sponsored transaction' endpoint (\`/gas_sponsorship/prepare\`).`,
+If a gas-sponsored \`DEPOSIT\` transfer is desired for a given token, a one-time Permit2 allowance must be set before proceeding. This is common practice for many other applications and, for many \`owner\`s, this one-time allowance will already have been set for the token they would like to transfer.
+Once the one-time allowance is set for a given token and \`gas_sponsorship\` is set to 'true', EIP-712 typed data will be returned and can be signed off-chain by the user. This signature can then be submitted to the 'Prepare gas-sponsored transaction' endpoint (\`/gas_sponsorship/prepare\`) where a \`sender\` can be set for the transaction.`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await earnEarnTransfer(

package/src/sdk/earn.ts

@@ -32,7 +32,7 @@ export class Earn extends ClientSDK {
   }
 
   /**
-   * Get individual earn position
+   * Get earn position
    *
    * @remarks
    * This endpoint fetches a single Compass Earn position by its encoded ID.
@@ -69,15 +69,15 @@ export class Earn extends ClientSDK {
    * Create earn account
    *
    * @remarks
-   * Create a Compass Earn Account.
+   * Create an Earn Account.
    *
-   * Before creating Earn positions you must create a Compass Earn Account. This account will be associated with the `owner` wallet address.
+   * Before creating Earn positions, the `owner` must create an Earn Account associated with their wallet address.
    *
    * Only the `owner` has the authority to sign transactions for this account. This can be done in one of two ways:
    *
-   * 1) The `owner` signs an unsigned transaction and submits to the network for execution. The `owner` covers the cost of gas in this case.
+   * 1) **No gas-sponsorship:** The `owner` signs a transaction and submits it to the network for execution. The `owner` covers the cost of gas in this case.
    *
-   * 2) The `owner` does an off-chain EIP-712 signature and submits this signature to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`).
+   * 2) **Gas-sponsorship:** The `owner` does an off-chain EIP-712 signature and submits this signature to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`). Here, another wallet address is set as `sender`. This wallet will sign, submit and cover the gas fees of the transaction.
    *
    * The creation of an Earn Account itself can be a gas-sponsored transaction by setting the `sender` to the wallet which will sign and send the transaction.
    */
@@ -96,14 +96,14 @@ export class Earn extends ClientSDK {
    * Transfer tokens to/from account
    *
    * @remarks
-   * Transfer tokens to and from a Compass Earn Account.
+   * Transfer tokens to and from an Earn Account.
    *
    * If `DEPOSIT`'` is selected, tokens will be transferred from the `owner`'s wallet into their Earn Account.
    *
    * If `WITHDRAW` is selected, tokens will be transferred from the `owner`'s Earn Account into their wallet.
    *
-   * If a gas-sponsored `DEPOSIT` transfer is desired for a given token, a one-time Permit2 allowance must be set before proceeding. This is common practice for many other applications and, for many users, this one-time allowance will already have been set for the token they would like to transfer.
-   * Once the one-time allowance is set for a given token, EIP-712 typed data will be returned and can be signed off-chain by the user. This signature can then be submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`).
+   * If a gas-sponsored `DEPOSIT` transfer is desired for a given token, a one-time Permit2 allowance must be set before proceeding. This is common practice for many other applications and, for many `owner`s, this one-time allowance will already have been set for the token they would like to transfer.
+   * Once the one-time allowance is set for a given token and `gas_sponsorship` is set to 'true', EIP-712 typed data will be returned and can be signed off-chain by the user. This signature can then be submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`) where a `sender` can be set for the transaction.
    */
   async earnTransfer(
     request: components.EarnTransferRequest,
@@ -130,9 +130,9 @@ export class Earn extends ClientSDK {
    *
    * If `WITHDRAW` is selected, tokens will be withdrawn from the market to the `owner`'s Earn Account.
    *
-   * A fee can be configured. This fee is deducted from the total `amount`. It can be expressed as a `FIXED` amount or a `PERCENTAGE`.
+   * A fee can be configured. This fee is deducted from the total `amount`. It can be expressed as a `FIXED` amount or a `PERCENTAGE` of `amount`.
    *
-   * The transaction can be gas-sponsored by an arbitrary wallet address. Where the owner of said wallet will sign, submit and pay the required gas for the transaction. If `gas_sponsorship` is set to `true`, EIP-712 typed data will be returned that must be signed by the `owner` and submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`) where the `sender` of the transaction can be set.
+   * The transaction can be gas-sponsored by an arbitrary wallet address which will sign, submit and pay the required gas for the transaction. If `gas_sponsorship` is set to `true`, EIP-712 typed data will be returned that must be signed by the `owner` and submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`) where the `sender` of the transaction can be set.
    */
   async earnManage(
     request: components.EarnManageRequest,