npm - @compass-labs/api-sdk - Versions diffs - 2.1.34 → 2.1.35-rc.0 - Mend

@compass-labs/api-sdk 2.1.34 → 2.1.35-rc.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (131) hide show

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

@@ -6,87 +6,98 @@ export declare class Earn extends ClientSDK {
      * List earn positions
      *
      * @remarks
-     * This endpoint fetches all Compass Earn positions with PnL information.
+     * List all Earn positions for a given owner with PnL tracking.
+     *
+     * Returns position data including current balance, cost basis, and profit and loss.
+     * Use this endpoint to display portfolio performance, track yields over time, or build
+     * position management interfaces.
+     *
+     * Positions are tracked across all venue types (vaults and Aave markets). Each
+     * position includes the venue address, deposited amount, and performance metrics.
      */
     earnPositions(request: operations.V2EarnPositionsRequest, options?: RequestOptions): Promise<components.EarnPositionsResponse>;
     /**
      * List vaults
      *
      * @remarks
-     * List information about 4626 vaults.
+     * List ERC-4626 yield vaults across DeFi venues.
+     *
+     * Returns vault data including APY, TVL, and underlying asset information. Use this endpoint to discover yield opportunities, compare rates across venues, or build vault selection interfaces.
+     *
+     * Supports dozens of vaults and markets like Morpho and other ERC-4626 compatible yield venues.
      *
-     * These are earn opportunities for protocols like morpho.
+     * To deposit into a vault, use the [manage endpoint](https://docs.compasslabs.ai/v2/api-reference/earn/manage-earn-position) with `venue_type=VAULTS`.
      */
     earnVaults(request: operations.V2EarnVaultsRequest, options?: RequestOptions): Promise<components.VaultsResponse>;
     /**
      * List aave markets
      *
      * @remarks
-     * List all aave markets with their supply and borrow rates.
+     * List Aave lending markets with supply and borrow rates.
      *
-     * Returns rates organized by token symbol, with chain-specific data for each token.
-     * Each token includes rates for all chains where it's available, plus information
-     * about which chain offers the highest supply APY.
+     * Returns rates organized by token symbol, with chain-specific data for each token. Each token includes rates for all chains where it's available, plus information about which chain offers the highest supply APY.
      *
-     * APY values are returned in percentage format (e.g., 4.5 means 4.5%). Tokens with
-     * zero APY on both supply and borrow are excluded.
+     * APY values are returned in percentage format (e.g., 4.5 means 4.5%). Tokens with zero APY on both supply and borrow are excluded.
      *
-     * Optionally filter by chain.
+     * To deposit into an Aave market, use the [manage endpoint](https://docs.compasslabs.ai/v2/api-reference/earn/manage-earn-position) with `venue_type=AAVE`.
      */
     earnAaveMarkets(request: operations.V2EarnAaveMarketsRequest, options?: RequestOptions): Promise<components.ListAaveMarketsResponse>;
     /**
      * Create earn account
      *
      * @remarks
-     * Create an Earn Account.
+     * Create an Earn Account for a wallet address.
      *
-     * Before creating Earn positions, the `owner` must create an Earn Account associated with their wallet address.
+     * Before depositing into venues or managing positions, the owner must create an Earn Account. Each wallet address has one Earn Account per chain.
      *
-     * Only the `owner` has the authority to sign transactions for this account. This can be done in one of two ways:
+     * Returns an unsigned transaction to create the account. The `sender` signs and broadcasts this transaction.
      *
-     * 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.
+     * **If owner pays gas:** Set `sender` to the owner's address.
      *
-     * 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.
+     * **If someone else pays gas:** Set `sender` to the wallet that will sign and broadcast the transaction on behalf of the owner.
      */
     earnCreateAccount(request: components.CreateAccountRequest, options?: RequestOptions): Promise<components.CreateAccountResponse>;
     /**
      * Transfer tokens to/from account
      *
      * @remarks
-     * Transfer tokens to and from an Earn Account.
+     * Transfer tokens between an owner's wallet and their Earn Account.
+     *
+     * Use `DEPOSIT` to move tokens from the owner's wallet into their Earn Account. Use `WITHDRAW` to move tokens from the Earn Account back to the owner's wallet.
+     *
+     * **Gas-sponsored deposits** require two steps:
      *
-     * If `DEPOSIT`'` is selected, tokens will be transferred from the `owner`'s wallet into their Earn Account.
+     * **Step 1 (once per token):** Set up Permit2 allowance
+     * 1. Call [/gas_sponsorship/approve_transfer](https://docs.compasslabs.ai/v2/api-reference/gas-sponsorship/approve-token-transfer) to get EIP-712 typed data
+     * 2. Owner signs the typed data
+     * 3. Submit signature + typed data to [/gas_sponsorship/prepare](https://docs.compasslabs.ai/v2/api-reference/gas-sponsorship/prepare-gas-sponsored-transaction)
      *
-     * If `WITHDRAW` is selected, tokens will be transferred from the `owner`'s Earn Account into their wallet.
+     * **Step 2 (each transfer):** Execute the gas-sponsored transfer
+     * 1. Call this endpoint with `gas_sponsorship=true` to get EIP-712 typed data
+     * 2. Owner signs the typed data
+     * 3. Submit signature + typed data to [/gas_sponsorship/prepare](https://docs.compasslabs.ai/v2/api-reference/gas-sponsorship/prepare-gas-sponsored-transaction)
      *
-     * 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.
+     * **Note:** This endpoint moves tokens to/from the Earn Account itself—not into yield venues. To deposit into a vault or Aave market, use the [manage endpoint](https://docs.compasslabs.ai/v2/api-reference/earn/manage-earn-position).
      */
     earnTransfer(request: components.EarnTransferRequest, options?: RequestOptions): Promise<components.EarnTransferResponse>;
     /**
      * Manage earn position
      *
      * @remarks
-     * Manage an Earn position for a given `owner`'s Earn Account.
+     * Deposit into or withdraw from a yield venue.
      *
-     * The `owner` is the main wallet address that owns and controls the Earn Account. It is not the Earn Account address itself.
+     * Use `DEPOSIT` to move tokens from the Earn Account into a vault or Aave market. Use `WITHDRAW` to move tokens back from a venue into the Earn Account.
      *
-     * Venue Types:
-     * - VAULTS
-     * - AAVE
+     * **Venue types:**
+     * - `VAULTS`: ERC-4626 vaults (see [/vaults](https://docs.compasslabs.ai/v2/api-reference/earn/list-vaults) for available options)
+     * - `AAVE`: Aave lending pools (see [/aave_markets](https://docs.compasslabs.ai/v2/api-reference/earn/list-aave-markets) for available options)
      *
-     * If `DEPOSIT` is selected for `action`, tokens will be deposited into the selected venue address from the Earn Account associated with the  `owner` wallet.
+     * **Fees:** A fee can be configured and deducted from the transaction amount:
+     * - `FIXED`: A fixed token amount (e.g., 0.1 means 0.1 tokens)
+     * - `PERCENTAGE`: A percentage of the amount (e.g., 1.5 means 1.5%)
+     * - `PERFORMANCE`: A percentage of realized profit (withdrawals only)
      *
-     * If `WITHDRAW` is selected for `action`, tokens will be withdrawn from the selected venue address back into the Earn Account associated with the `owner` wallet.
-     *
-     * A fee can be configured. This fee is deducted from the total `amount`. It can be expressed as:
-     * - `FIXED`: a fixed token amount (e.g., 0.1 means 0.1 tokens)
-     * - `PERCENTAGE`: a percentage of the transaction amount (e.g., 1.5 means 1.5%)
-     * - `PERFORMANCE`: a percentage of realized profit using FIFO cost basis (e.g., 10 means 10% of profit). Only applicable for withdrawals.
-     *
-     * 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.
+     * **Gas sponsorship:** Set `gas_sponsorship=true` to receive EIP-712 typed data. Owner signs the typed data, then submit to [/gas_sponsorship/prepare](https://docs.compasslabs.ai/v2/api-reference/gas-sponsorship/prepare-gas-sponsored-transaction).
      */
     earnManage(request: components.EarnManageRequest, options?: RequestOptions): Promise<components.EarnManageResponse>;
     /**
@@ -94,26 +105,31 @@ export declare class Earn extends ClientSDK {
      *
      * @remarks
      * Swap tokens within an Earn Account.
+     *
+     * Use this endpoint to exchange one token for another without transferring funds out of the Earn Account.
+     *
+     * The swap executes atomically within the Earn Account and can be combined with other actions using the [bundle endpoint](https://docs.compasslabs.ai/v2/api-reference/earn/execute-multiple-earn-actions). For example, swap ETH to USDC, then deposit USDC into a vault—all in one transaction.
+     *
+     * Returns either an unsigned transaction (when `gas_sponsorship=false`) or EIP-712 typed data for off-chain signing (when `gas_sponsorship=true`). For gas-sponsored swaps, submit the signed typed data to `/gas_sponsorship/prepare`.
      */
     earnSwap(request: components.EarnSwapRequest, options?: RequestOptions): Promise<components.EarnSwapResponse>;
     /**
      * Execute multiple earn actions
      *
      * @remarks
-     * This endpoint allows combining multiple actions (swaps, vault
-     * deposits/withdrawals, Aave deposits/withdrawals) into a single atomic transaction
-     * executed via the Earn account).
+     * Combine multiple actions into a single atomic transaction.
+     *
+     * Bundle swaps and venue deposits/withdrawals into one transaction executed through the Earn Account. This saves gas compared to executing actions separately and ensures all actions succeed or fail together.
      *
-     * **Example Use Case:** Swap USDC to AUSD, then deposit AUSD into a vault - all in one transaction.
+     * **Example:** Swap AUSD to USDC, then deposit USDC into a vault - all in one transaction.
      *
-     * Actions are executed in the order they are provided. Each action type has its own parameters:
+     * **Action types:**
+     * - `V2_SWAP`: Swap tokens within the Earn Account
+     * - `V2_MANAGE`: Deposit/withdraw to ERC-4626 vaults or Aave markets
      *
-     * - **V2_SWAP**: Swapping tokens within the Earn Account
-     * - **V2_MANAGE**: Manage positions - deposit/withdraw to ERC-4626 vaults or Aave lending pool
+     * Actions execute in the order provided.
      *
-     * The bundled transaction can be gas-sponsored by setting `gas_sponsorship=true`.
-     * This returns EIP-712 typed data that the owner must sign and submit to
-     * `/gas_sponsorship/prepare` for execution by a gas sponsor.
+     * **Gas sponsorship:** Set `gas_sponsorship=true` to receive EIP-712 typed data. Owner signs the typed data, then submit to [/gas_sponsorship/prepare](https://docs.compasslabs.ai/v2/api-reference/gas-sponsorship/prepare-gas-sponsored-transaction).
      */
     earnBundle(request: components.V2BundleRequest, options?: RequestOptions): Promise<components.V2BundleResponse>;
 }

package/dist/esm/sdk/earn.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"earn.d.ts","sourceRoot":"","sources":["../../../src/sdk/earn.ts"],"names":[],"mappings":"AAYA,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,IAAK,SAAQ,SAAS;IACjC~~;;;;;OAKG~~;IACG,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,sBAAsB,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,qBAAqB,CAAC;IAQ5C~~;;;;;;;OAOG~~;IACG,UAAU,CACd,OAAO,EAAE,UAAU,CAAC,mBAAmB,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC;IAQrC~~;;;;;;;;;;;;;;OAcG~~;IACG,eAAe,CACnB,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,uBAAuB,CAAC;IAQ9C~~;;;;;;;;;;;;;;;OAeG~~;IACG,iBAAiB,CACrB,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,qBAAqB,CAAC;IAQ5C~~;;;;;;;;;;;;OAYG~~;IACG,YAAY,CAChB,OAAO,EAAE,UAAU,CAAC,mBAAmB,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,oBAAoB,CAAC;IAQ3C~~;;;;;;;;;;;;;;;;;;;;;;OAsBG~~;IACG,UAAU,CACd,OAAO,EAAE,UAAU,CAAC,iBAAiB,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,kBAAkB,CAAC;IAQzC~~;;;;;OAKG~~;IACG,QAAQ,CACZ,OAAO,EAAE,UAAU,CAAC,eAAe,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC;IAQvC~~;;;;;;;;;;;;;;;;;;OAkBG~~;IACG,UAAU,CACd,OAAO,EAAE,UAAU,CAAC,eAAe,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC;CAOxC"}
1	+ {"version":3,"file":"earn.d.ts","sourceRoot":"","sources":["../../../src/sdk/earn.ts"],"names":[],"mappings":"AAYA,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,IAAK,SAAQ,SAAS;IACjC;;;;;;;;;;;;OAYG;IACG,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,sBAAsB,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,qBAAqB,CAAC;IAQ5C;;;;;;;;;;;OAWG;IACG,UAAU,CACd,OAAO,EAAE,UAAU,CAAC,mBAAmB,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC;IAQrC;;;;;;;;;;;OAWG;IACG,eAAe,CACnB,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,uBAAuB,CAAC;IAQ9C;;;;;;;;;;;;;OAaG;IACG,iBAAiB,CACrB,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,qBAAqB,CAAC;IAQ5C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,YAAY,CAChB,OAAO,EAAE,UAAU,CAAC,mBAAmB,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,oBAAoB,CAAC;IAQ3C;;;;;;;;;;;;;;;;;;OAkBG;IACG,UAAU,CACd,OAAO,EAAE,UAAU,CAAC,iBAAiB,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,kBAAkB,CAAC;IAQzC;;;;;;;;;;;OAWG;IACG,QAAQ,CACZ,OAAO,EAAE,UAAU,CAAC,eAAe,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC;IAQvC;;;;;;;;;;;;;;;;;OAiBG;IACG,UAAU,CACd,OAAO,EAAE,UAAU,CAAC,eAAe,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC;CAOxC"}

package/dist/esm/sdk/earn.js CHANGED Viewed

@@ -16,7 +16,14 @@ export class Earn extends ClientSDK {
      * List earn positions
      *
      * @remarks
-     * This endpoint fetches all Compass Earn positions with PnL information.
+     * List all Earn positions for a given owner with PnL tracking.
+     *
+     * Returns position data including current balance, cost basis, and profit and loss.
+     * Use this endpoint to display portfolio performance, track yields over time, or build
+     * position management interfaces.
+     *
+     * Positions are tracked across all venue types (vaults and Aave markets). Each
+     * position includes the venue address, deposited amount, and performance metrics.
      */
     async earnPositions(request, options) {
         return unwrapAsync(earnEarnPositions(this, request, options));
@@ -25,9 +32,13 @@ export class Earn extends ClientSDK {
      * List vaults
      *
      * @remarks
-     * List information about 4626 vaults.
+     * List ERC-4626 yield vaults across DeFi venues.
+     *
+     * Returns vault data including APY, TVL, and underlying asset information. Use this endpoint to discover yield opportunities, compare rates across venues, or build vault selection interfaces.
+     *
+     * Supports dozens of vaults and markets like Morpho and other ERC-4626 compatible yield venues.
      *
-     * These are earn opportunities for protocols like morpho.
+     * To deposit into a vault, use the [manage endpoint](https://docs.compasslabs.ai/v2/api-reference/earn/manage-earn-position) with `venue_type=VAULTS`.
      */
     async earnVaults(request, options) {
         return unwrapAsync(earnEarnVaults(this, request, options));
@@ -36,16 +47,13 @@ export class Earn extends ClientSDK {
      * List aave markets
      *
      * @remarks
-     * List all aave markets with their supply and borrow rates.
+     * List Aave lending markets with supply and borrow rates.
      *
-     * Returns rates organized by token symbol, with chain-specific data for each token.
-     * Each token includes rates for all chains where it's available, plus information
-     * about which chain offers the highest supply APY.
+     * Returns rates organized by token symbol, with chain-specific data for each token. Each token includes rates for all chains where it's available, plus information about which chain offers the highest supply APY.
      *
-     * APY values are returned in percentage format (e.g., 4.5 means 4.5%). Tokens with
-     * zero APY on both supply and borrow are excluded.
+     * APY values are returned in percentage format (e.g., 4.5 means 4.5%). Tokens with zero APY on both supply and borrow are excluded.
      *
-     * Optionally filter by chain.
+     * To deposit into an Aave market, use the [manage endpoint](https://docs.compasslabs.ai/v2/api-reference/earn/manage-earn-position) with `venue_type=AAVE`.
      */
     async earnAaveMarkets(request, options) {
         return unwrapAsync(earnEarnAaveMarkets(this, request, options));
@@ -54,17 +62,15 @@ export class Earn extends ClientSDK {
      * Create earn account
      *
      * @remarks
-     * Create an Earn Account.
+     * Create an Earn Account for a wallet address.
      *
-     * Before creating Earn positions, the `owner` must create an Earn Account associated with their wallet address.
+     * Before depositing into venues or managing positions, the owner must create an Earn Account. Each wallet address has one Earn Account per chain.
      *
-     * Only the `owner` has the authority to sign transactions for this account. This can be done in one of two ways:
+     * Returns an unsigned transaction to create the account. The `sender` signs and broadcasts this transaction.
      *
-     * 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.
+     * **If owner pays gas:** Set `sender` to the owner's address.
      *
-     * 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.
+     * **If someone else pays gas:** Set `sender` to the wallet that will sign and broadcast the transaction on behalf of the owner.
      */
     async earnCreateAccount(request, options) {
         return unwrapAsync(earnEarnCreateAccount(this, request, options));
@@ -73,14 +79,23 @@ export class Earn extends ClientSDK {
      * Transfer tokens to/from account
      *
      * @remarks
-     * Transfer tokens to and from an Earn Account.
+     * Transfer tokens between an owner's wallet and their Earn Account.
+     *
+     * Use `DEPOSIT` to move tokens from the owner's wallet into their Earn Account. Use `WITHDRAW` to move tokens from the Earn Account back to the owner's wallet.
+     *
+     * **Gas-sponsored deposits** require two steps:
      *
-     * If `DEPOSIT`'` is selected, tokens will be transferred from the `owner`'s wallet into their Earn Account.
+     * **Step 1 (once per token):** Set up Permit2 allowance
+     * 1. Call [/gas_sponsorship/approve_transfer](https://docs.compasslabs.ai/v2/api-reference/gas-sponsorship/approve-token-transfer) to get EIP-712 typed data
+     * 2. Owner signs the typed data
+     * 3. Submit signature + typed data to [/gas_sponsorship/prepare](https://docs.compasslabs.ai/v2/api-reference/gas-sponsorship/prepare-gas-sponsored-transaction)
      *
-     * If `WITHDRAW` is selected, tokens will be transferred from the `owner`'s Earn Account into their wallet.
+     * **Step 2 (each transfer):** Execute the gas-sponsored transfer
+     * 1. Call this endpoint with `gas_sponsorship=true` to get EIP-712 typed data
+     * 2. Owner signs the typed data
+     * 3. Submit signature + typed data to [/gas_sponsorship/prepare](https://docs.compasslabs.ai/v2/api-reference/gas-sponsorship/prepare-gas-sponsored-transaction)
      *
-     * 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.
+     * **Note:** This endpoint moves tokens to/from the Earn Account itself—not into yield venues. To deposit into a vault or Aave market, use the [manage endpoint](https://docs.compasslabs.ai/v2/api-reference/earn/manage-earn-position).
      */
     async earnTransfer(request, options) {
         return unwrapAsync(earnEarnTransfer(this, request, options));
@@ -89,24 +104,20 @@ export class Earn extends ClientSDK {
      * Manage earn position
      *
      * @remarks
-     * Manage an Earn position for a given `owner`'s Earn Account.
+     * Deposit into or withdraw from a yield venue.
      *
-     * The `owner` is the main wallet address that owns and controls the Earn Account. It is not the Earn Account address itself.
+     * Use `DEPOSIT` to move tokens from the Earn Account into a vault or Aave market. Use `WITHDRAW` to move tokens back from a venue into the Earn Account.
      *
-     * Venue Types:
-     * - VAULTS
-     * - AAVE
+     * **Venue types:**
+     * - `VAULTS`: ERC-4626 vaults (see [/vaults](https://docs.compasslabs.ai/v2/api-reference/earn/list-vaults) for available options)
+     * - `AAVE`: Aave lending pools (see [/aave_markets](https://docs.compasslabs.ai/v2/api-reference/earn/list-aave-markets) for available options)
      *
-     * If `DEPOSIT` is selected for `action`, tokens will be deposited into the selected venue address from the Earn Account associated with the  `owner` wallet.
+     * **Fees:** A fee can be configured and deducted from the transaction amount:
+     * - `FIXED`: A fixed token amount (e.g., 0.1 means 0.1 tokens)
+     * - `PERCENTAGE`: A percentage of the amount (e.g., 1.5 means 1.5%)
+     * - `PERFORMANCE`: A percentage of realized profit (withdrawals only)
      *
-     * If `WITHDRAW` is selected for `action`, tokens will be withdrawn from the selected venue address back into the Earn Account associated with the `owner` wallet.
-     *
-     * A fee can be configured. This fee is deducted from the total `amount`. It can be expressed as:
-     * - `FIXED`: a fixed token amount (e.g., 0.1 means 0.1 tokens)
-     * - `PERCENTAGE`: a percentage of the transaction amount (e.g., 1.5 means 1.5%)
-     * - `PERFORMANCE`: a percentage of realized profit using FIFO cost basis (e.g., 10 means 10% of profit). Only applicable for withdrawals.
-     *
-     * 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.
+     * **Gas sponsorship:** Set `gas_sponsorship=true` to receive EIP-712 typed data. Owner signs the typed data, then submit to [/gas_sponsorship/prepare](https://docs.compasslabs.ai/v2/api-reference/gas-sponsorship/prepare-gas-sponsored-transaction).
      */
     async earnManage(request, options) {
         return unwrapAsync(earnEarnManage(this, request, options));
@@ -116,6 +127,12 @@ export class Earn extends ClientSDK {
      *
      * @remarks
      * Swap tokens within an Earn Account.
+     *
+     * Use this endpoint to exchange one token for another without transferring funds out of the Earn Account.
+     *
+     * The swap executes atomically within the Earn Account and can be combined with other actions using the [bundle endpoint](https://docs.compasslabs.ai/v2/api-reference/earn/execute-multiple-earn-actions). For example, swap ETH to USDC, then deposit USDC into a vault—all in one transaction.
+     *
+     * Returns either an unsigned transaction (when `gas_sponsorship=false`) or EIP-712 typed data for off-chain signing (when `gas_sponsorship=true`). For gas-sponsored swaps, submit the signed typed data to `/gas_sponsorship/prepare`.
      */
     async earnSwap(request, options) {
         return unwrapAsync(earnEarnSwap(this, request, options));
@@ -124,20 +141,19 @@ export class Earn extends ClientSDK {
      * Execute multiple earn actions
      *
      * @remarks
-     * This endpoint allows combining multiple actions (swaps, vault
-     * deposits/withdrawals, Aave deposits/withdrawals) into a single atomic transaction
-     * executed via the Earn account).
+     * Combine multiple actions into a single atomic transaction.
+     *
+     * Bundle swaps and venue deposits/withdrawals into one transaction executed through the Earn Account. This saves gas compared to executing actions separately and ensures all actions succeed or fail together.
      *
-     * **Example Use Case:** Swap USDC to AUSD, then deposit AUSD into a vault - all in one transaction.
+     * **Example:** Swap AUSD to USDC, then deposit USDC into a vault - all in one transaction.
      *
-     * Actions are executed in the order they are provided. Each action type has its own parameters:
+     * **Action types:**
+     * - `V2_SWAP`: Swap tokens within the Earn Account
+     * - `V2_MANAGE`: Deposit/withdraw to ERC-4626 vaults or Aave markets
      *
-     * - **V2_SWAP**: Swapping tokens within the Earn Account
-     * - **V2_MANAGE**: Manage positions - deposit/withdraw to ERC-4626 vaults or Aave lending pool
+     * Actions execute in the order provided.
      *
-     * The bundled transaction can be gas-sponsored by setting `gas_sponsorship=true`.
-     * This returns EIP-712 typed data that the owner must sign and submit to
-     * `/gas_sponsorship/prepare` for execution by a gas sponsor.
+     * **Gas sponsorship:** Set `gas_sponsorship=true` to receive EIP-712 typed data. Owner signs the typed data, then submit to [/gas_sponsorship/prepare](https://docs.compasslabs.ai/v2/api-reference/gas-sponsorship/prepare-gas-sponsored-transaction).
      */
     async earnBundle(request, options) {
         return unwrapAsync(earnEarnBundle(this, request, options));

package/dist/esm/sdk/earn.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"earn.js","sourceRoot":"","sources":["../../../src/sdk/earn.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,IAAK,SAAQ,SAAS;IACjC~~;;;;;OAKG~~;IACH,KAAK,CAAC,aAAa,CACjB,OAA0C,EAC1C,OAAwB;QAExB,OAAO,WAAW,CAAC,iBAAiB,CAClC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED~~;;;;;;;OAOG~~;IACH,KAAK,CAAC,UAAU,CACd,OAAuC,EACvC,OAAwB;QAExB,OAAO,WAAW,CAAC,cAAc,CAC/B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED~~;;;;;;;;;;;;;;OAcG~~;IACH,KAAK,CAAC,eAAe,CACnB,OAA4C,EAC5C,OAAwB;QAExB,OAAO,WAAW,CAAC,mBAAmB,CACpC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED~~;;;;;;;;;;;;;;;OAeG~~;IACH,KAAK,CAAC,iBAAiB,CACrB,OAAwC,EACxC,OAAwB;QAExB,OAAO,WAAW,CAAC,qBAAqB,CACtC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED~~;;;;;;;;;;;;OAYG~~;IACH,KAAK,CAAC,YAAY,CAChB,OAAuC,EACvC,OAAwB;QAExB,OAAO,WAAW,CAAC,gBAAgB,CACjC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED~~;;;;;;;;;;;;;;;;;;;;;;OAsBG~~;IACH,KAAK,CAAC,UAAU,CACd,OAAqC,EACrC,OAAwB;QAExB,OAAO,WAAW,CAAC,cAAc,CAC/B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED~~;;;;;OAKG~~;IACH,KAAK,CAAC,QAAQ,CACZ,OAAmC,EACnC,OAAwB;QAExB,OAAO,WAAW,CAAC,YAAY,CAC7B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED~~;;;;;;;;;;;;;;;;;;OAkBG~~;IACH,KAAK,CAAC,UAAU,CACd,OAAmC,EACnC,OAAwB;QAExB,OAAO,WAAW,CAAC,cAAc,CAC/B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}
1	+ {"version":3,"file":"earn.js","sourceRoot":"","sources":["../../../src/sdk/earn.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,IAAK,SAAQ,SAAS;IACjC;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,aAAa,CACjB,OAA0C,EAC1C,OAAwB;QAExB,OAAO,WAAW,CAAC,iBAAiB,CAClC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,UAAU,CACd,OAAuC,EACvC,OAAwB;QAExB,OAAO,WAAW,CAAC,cAAc,CAC/B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,eAAe,CACnB,OAA4C,EAC5C,OAAwB;QAExB,OAAO,WAAW,CAAC,mBAAmB,CACpC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAAwC,EACxC,OAAwB;QAExB,OAAO,WAAW,CAAC,qBAAqB,CACtC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,YAAY,CAChB,OAAuC,EACvC,OAAwB;QAExB,OAAO,WAAW,CAAC,gBAAgB,CACjC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,UAAU,CACd,OAAqC,EACrC,OAAwB;QAExB,OAAO,WAAW,CAAC,cAAc,CAC/B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,QAAQ,CACZ,OAAmC,EACnC,OAAwB;QAExB,OAAO,WAAW,CAAC,YAAY,CAC7B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,UAAU,CACd,OAAmC,EACnC,OAAwB;QAExB,OAAO,WAAW,CAAC,cAAc,CAC/B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/esm/sdk/gassponsorship.d.ts CHANGED Viewed

@@ -5,27 +5,33 @@ export declare class GasSponsorship extends ClientSDK {
      * Prepare gas-sponsored transaction
      *
      * @remarks
-     * Prepare a gas-sponsored transaction to be signed and submitted by `sender`.
+     * Prepare a gas-sponsored transaction from signed EIP-712 typed data.
      *
-     * The `owner` submits their off-chain signature of EIP-712 typed data along with the data itself.
+     * Submit the `owner`'s off-chain signature along with the EIP-712 typed data that was signed. Returns an unsigned transaction for the `sender` to sign and broadcast.
      *
-     * The `sender` will sign and submit the transaction returned from this endpoint, effectively sponsoring the gas for the transaction on behalf of the `owner`.
+     * **How gas sponsorship works:**
+     * 1. Call an endpoint with `gas_sponsorship=true` (e.g., [/earn/transfer](https://docs.compasslabs.ai/v2/api-reference/earn/transfer-tokens-tofrom-account), [/earn/manage](https://docs.compasslabs.ai/v2/api-reference/earn/manage-earn-position)) to get EIP-712 typed data
+     * 2. Owner signs the typed data off-chain
+     * 3. Submit signature + typed data to this endpoint
+     * 4. Sender signs and broadcasts the returned transaction, paying gas on behalf of the owner
+     *
+     * **Note:** For gas-sponsored deposits via [/earn/transfer](https://docs.compasslabs.ai/v2/api-reference/earn/transfer-tokens-tofrom-account), the owner must first set up a Permit2 allowance using [/approve_transfer](https://docs.compasslabs.ai/v2/api-reference/gas-sponsorship/approve-token-transfer) (once per token).
      */
     gasSponsorshipPrepare(request: components.SponsorGasRequest, options?: RequestOptions): Promise<components.SponsorGasResponse>;
     /**
      * Approve token transfer
      *
      * @remarks
-     * Prepare a one-time permit2 approval transaction for a given token.
+     * Set up a one-time Permit2 allowance for gas-sponsored token transfers.
+     *
+     * Only required when using [/earn/transfer](https://docs.compasslabs.ai/v2/api-reference/earn/transfer-tokens-tofrom-account) with `gas_sponsorship=true`. This allowance only needs to be set up once per token.
      *
-     * This is only required if the `owner` would like to transfer tokens from their wallet to their Earn Account with gas-sponsorship.
+     * **With gas sponsorship (`gas_sponsorship=true`):**
+     * - Returns EIP-712 typed data for the owner to sign off-chain
+     * - Submit signature + typed data to [/prepare](https://docs.compasslabs.ai/v2/api-reference/gas-sponsorship/prepare-gas-sponsored-transaction)
+     * - Only works for tokens that support EIP-2612 permit (e.g., USDC)
      *
-     * This approval transaction itself can be submitted with gas-sponsorship.
-     * In this case, EIP-712 typed data will be returned and should be signed by the `owner` off-chain.
-     * This signature can then be submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`).
-     * Gas-sponsored approvals can only be achieved by ERC-20 tokens that support permit (EIP-2612).
-     * Some tokens, like USDT and WETH, do not allow for this behavior.
-     * In the case of non-permit tokens, the one-time approval transaction can be submitted in the conventional manner where the `owner` must sign, submit and pay gas for the transaction.
+     * Some tokens, like USDT and WETH, do not support EIP-2612 permit. For these tokens, set `gas_sponsorship=false` to receive an unsigned transaction that the owner must sign, submit, and pay gas for.
      */
     gasSponsorshipApproveTransfer(request: components.ApproveTransferRequest, options?: RequestOptions): Promise<components.ApproveTransferResponse>;
 }

package/dist/esm/sdk/gassponsorship.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"gassponsorship.d.ts","sourceRoot":"","sources":["../../../src/sdk/gassponsorship.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,cAAe,SAAQ,SAAS;IAC3C~~;;;;;;;;;OASG~~;IACG,qBAAqB,CACzB,OAAO,EAAE,UAAU,CAAC,iBAAiB,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,kBAAkB,CAAC;IAQzC;;;;;;;;;;;;;;OAcG;IACG,6BAA6B,CACjC,OAAO,EAAE,UAAU,CAAC,sBAAsB,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,uBAAuB,CAAC;CAO/C"}
1	+ {"version":3,"file":"gassponsorship.d.ts","sourceRoot":"","sources":["../../../src/sdk/gassponsorship.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,cAAe,SAAQ,SAAS;IAC3C;;;;;;;;;;;;;;;OAeG;IACG,qBAAqB,CACzB,OAAO,EAAE,UAAU,CAAC,iBAAiB,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,kBAAkB,CAAC;IAQzC;;;;;;;;;;;;;;OAcG;IACG,6BAA6B,CACjC,OAAO,EAAE,UAAU,CAAC,sBAAsB,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,uBAAuB,CAAC;CAO/C"}

package/dist/esm/sdk/gassponsorship.js CHANGED Viewed

@@ -10,11 +10,17 @@ export class GasSponsorship extends ClientSDK {
      * Prepare gas-sponsored transaction
      *
      * @remarks
-     * Prepare a gas-sponsored transaction to be signed and submitted by `sender`.
+     * Prepare a gas-sponsored transaction from signed EIP-712 typed data.
      *
-     * The `owner` submits their off-chain signature of EIP-712 typed data along with the data itself.
+     * Submit the `owner`'s off-chain signature along with the EIP-712 typed data that was signed. Returns an unsigned transaction for the `sender` to sign and broadcast.
      *
-     * The `sender` will sign and submit the transaction returned from this endpoint, effectively sponsoring the gas for the transaction on behalf of the `owner`.
+     * **How gas sponsorship works:**
+     * 1. Call an endpoint with `gas_sponsorship=true` (e.g., [/earn/transfer](https://docs.compasslabs.ai/v2/api-reference/earn/transfer-tokens-tofrom-account), [/earn/manage](https://docs.compasslabs.ai/v2/api-reference/earn/manage-earn-position)) to get EIP-712 typed data
+     * 2. Owner signs the typed data off-chain
+     * 3. Submit signature + typed data to this endpoint
+     * 4. Sender signs and broadcasts the returned transaction, paying gas on behalf of the owner
+     *
+     * **Note:** For gas-sponsored deposits via [/earn/transfer](https://docs.compasslabs.ai/v2/api-reference/earn/transfer-tokens-tofrom-account), the owner must first set up a Permit2 allowance using [/approve_transfer](https://docs.compasslabs.ai/v2/api-reference/gas-sponsorship/approve-token-transfer) (once per token).
      */
     async gasSponsorshipPrepare(request, options) {
         return unwrapAsync(gasSponsorshipGasSponsorshipPrepare(this, request, options));
@@ -23,16 +29,16 @@ export class GasSponsorship extends ClientSDK {
      * Approve token transfer
      *
      * @remarks
-     * Prepare a one-time permit2 approval transaction for a given token.
+     * Set up a one-time Permit2 allowance for gas-sponsored token transfers.
+     *
+     * Only required when using [/earn/transfer](https://docs.compasslabs.ai/v2/api-reference/earn/transfer-tokens-tofrom-account) with `gas_sponsorship=true`. This allowance only needs to be set up once per token.
      *
-     * This is only required if the `owner` would like to transfer tokens from their wallet to their Earn Account with gas-sponsorship.
+     * **With gas sponsorship (`gas_sponsorship=true`):**
+     * - Returns EIP-712 typed data for the owner to sign off-chain
+     * - Submit signature + typed data to [/prepare](https://docs.compasslabs.ai/v2/api-reference/gas-sponsorship/prepare-gas-sponsored-transaction)
+     * - Only works for tokens that support EIP-2612 permit (e.g., USDC)
      *
-     * This approval transaction itself can be submitted with gas-sponsorship.
-     * In this case, EIP-712 typed data will be returned and should be signed by the `owner` off-chain.
-     * This signature can then be submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`).
-     * Gas-sponsored approvals can only be achieved by ERC-20 tokens that support permit (EIP-2612).
-     * Some tokens, like USDT and WETH, do not allow for this behavior.
-     * In the case of non-permit tokens, the one-time approval transaction can be submitted in the conventional manner where the `owner` must sign, submit and pay gas for the transaction.
+     * Some tokens, like USDT and WETH, do not support EIP-2612 permit. For these tokens, set `gas_sponsorship=false` to receive an unsigned transaction that the owner must sign, submit, and pay gas for.
      */
     async gasSponsorshipApproveTransfer(request, options) {
         return unwrapAsync(gasSponsorshipGasSponsorshipApproveTransfer(this, request, options));

package/dist/esm/sdk/gassponsorship.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"gassponsorship.js","sourceRoot":"","sources":["../../../src/sdk/gassponsorship.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,2CAA2C,EAAE,MAAM,yDAAyD,CAAC;AACtH,OAAO,EAAE,mCAAmC,EAAE,MAAM,iDAAiD,CAAC;AACtG,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAE3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,cAAe,SAAQ,SAAS;IAC3C~~;;;;;;;;;OASG~~;IACH,KAAK,CAAC,qBAAqB,CACzB,OAAqC,EACrC,OAAwB;QAExB,OAAO,WAAW,CAAC,mCAAmC,CACpD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,6BAA6B,CACjC,OAA0C,EAC1C,OAAwB;QAExB,OAAO,WAAW,CAAC,2CAA2C,CAC5D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}
1	+ {"version":3,"file":"gassponsorship.js","sourceRoot":"","sources":["../../../src/sdk/gassponsorship.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,2CAA2C,EAAE,MAAM,yDAAyD,CAAC;AACtH,OAAO,EAAE,mCAAmC,EAAE,MAAM,iDAAiD,CAAC;AACtG,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAE3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,cAAe,SAAQ,SAAS;IAC3C;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,qBAAqB,CACzB,OAAqC,EACrC,OAAwB;QAExB,OAAO,WAAW,CAAC,mCAAmC,CACpD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,6BAA6B,CACjC,OAA0C,EAC1C,OAAwB;QAExB,OAAO,WAAW,CAAC,2CAA2C,CAC5D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/docs/models/components/approvetransferrequest.md CHANGED Viewed

@@ -16,7 +16,7 @@ let value: ApproveTransferRequest = {
 | Field                                                                                                                                                                                      | Type                                                                                                                                                                                       | Required                                                                                                                                                                                   | Description                                                                                                                                                                                | Example                                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `owner`                                                                                                                                                                                    | *string*                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                         | The owner of the smart account's address.                                                                                                                                                  | 0x01E62835dd7F52173546A325294762143eE4a882                                                                                                                                                 |
+| `owner`                                                                                                                                                                                    | *string*                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                         | The wallet address that owns the Earn Account.                                                                                                                                             | 0x01E62835dd7F52173546A325294762143eE4a882                                                                                                                                                 |
 | `chain`                                                                                                                                                                                    | [components.Chain](../../models/components/chain.md)                                                                                                                                       | :heavy_check_mark:                                                                                                                                                                         | The chain to use.                                                                                                                                                                          |                                                                                                                                                                                            |
 | `token`                                                                                                                                                                                    | *string*                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                         | The token you would like to transfer with gas sponsorship.                                                                                                                                 | USDT                                                                                                                                                                                       |
 | `gasSponsorship`                                                                                                                                                                           | *boolean*                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                         | Optionally request gas sponsorship. If set to `true`, EIP-712 signature data will be returned that must be signed by the `owner` and submitted to the `/gas_sponsorship/prepare` endpoint. | false                                                                                                                                                                                      |

package/docs/models/components/batchedsafeoperationsresponseinput.md CHANGED Viewed

@@ -54,7 +54,7 @@ let value: BatchedSafeOperationsResponseInput = {
 | Field                                                                                                                                                                                                  | Type                                                                                                                                                                                                   | Required                                                                                                                                                                                               | Description                                                                                                                                                                                            |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `domain`                                                                                                                                                                                               | [components.CompassApiBackendV2ModelsSafeTransactResponseBatchedSafeOperationsEip712Domain](../../models/components/compassapibackendv2modelssafetransactresponsebatchedsafeoperationseip712domain.md) | :heavy_check_mark:                                                                                                                                                                                     | The EIP-712 domain separator for Safe transactions.                                                                                                                                                    |
+| `domain`                                                                                                                                                                                               | [components.CompassApiBackendV2ModelsSafeTransactResponseBatchedSafeOperationsEip712Domain](../../models/components/compassapibackendv2modelssafetransactresponsebatchedsafeoperationseip712domain.md) | :heavy_check_mark:                                                                                                                                                                                     | The EIP-712 domain separator.                                                                                                                                                                          |
 | `types`                                                                                                                                                                                                | [components.CompassApiBackendV2ModelsSafeTransactResponseBatchedSafeOperationsEip712Types](../../models/components/compassapibackendv2modelssafetransactresponsebatchedsafeoperationseip712types.md)   | :heavy_check_mark:                                                                                                                                                                                     | The type definitions for EIP-712 structured data.                                                                                                                                                      |
 | `primaryType`                                                                                                                                                                                          | *"SafeTx"*                                                                                                                                                                                             | :heavy_check_mark:                                                                                                                                                                                     | Primary type for the structured data                                                                                                                                                                   |
-| `message`                                                                                                                                                                                              | [components.SafeTxMessage](../../models/components/safetxmessage.md)                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                     | The message data for a Safe transaction.                                                                                                                                                               |
+| `message`                                                                                                                                                                                              | [components.SafeTxMessage](../../models/components/safetxmessage.md)                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                     | The message data for the transaction.                                                                                                                                                                  |

package/docs/models/components/batchedsafeoperationsresponseoutput.md CHANGED Viewed

@@ -36,7 +36,7 @@ let value: BatchedSafeOperationsResponseOutput = {
 | Field                                                                                                                                                                                                  | Type                                                                                                                                                                                                   | Required                                                                                                                                                                                               | Description                                                                                                                                                                                            |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `domain`                                                                                                                                                                                               | [components.CompassApiBackendV2ModelsSafeTransactResponseBatchedSafeOperationsEip712Domain](../../models/components/compassapibackendv2modelssafetransactresponsebatchedsafeoperationseip712domain.md) | :heavy_check_mark:                                                                                                                                                                                     | The EIP-712 domain separator for Safe transactions.                                                                                                                                                    |
+| `domain`                                                                                                                                                                                               | [components.CompassApiBackendV2ModelsSafeTransactResponseBatchedSafeOperationsEip712Domain](../../models/components/compassapibackendv2modelssafetransactresponsebatchedsafeoperationseip712domain.md) | :heavy_check_mark:                                                                                                                                                                                     | The EIP-712 domain separator.                                                                                                                                                                          |
 | `types`                                                                                                                                                                                                | [components.CompassApiBackendV2ModelsSafeTransactResponseBatchedSafeOperationsEip712Types](../../models/components/compassapibackendv2modelssafetransactresponsebatchedsafeoperationseip712types.md)   | :heavy_check_mark:                                                                                                                                                                                     | The type definitions for EIP-712 structured data.                                                                                                                                                      |
 | `primaryType`                                                                                                                                                                                          | *"SafeTx"*                                                                                                                                                                                             | :heavy_check_mark:                                                                                                                                                                                     | Primary type for the structured data                                                                                                                                                                   |
-| `message`                                                                                                                                                                                              | [components.SafeTxMessage](../../models/components/safetxmessage.md)                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                     | The message data for a Safe transaction.                                                                                                                                                               |
+| `message`                                                                                                                                                                                              | [components.SafeTxMessage](../../models/components/safetxmessage.md)                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                     | The message data for the transaction.                                                                                                                                                                  |

package/docs/models/components/compassapibackendv2modelssafetransactresponsebatchedsafeoperationseip712domain.md CHANGED Viewed

@@ -1,6 +1,6 @@
 # CompassApiBackendV2ModelsSafeTransactResponseBatchedSafeOperationsEip712Domain
-The EIP-712 domain separator for Safe transactions.
+The EIP-712 domain separator.
 ## Example Usage
@@ -17,7 +17,7 @@ let value:
 ## Fields
-| Field                             | Type                              | Required                          | Description                       |
-| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- |
-| `chainId`                         | *number*                          | :heavy_check_mark:                | Chain ID for the Safe transaction |
-| `verifyingContract`               | *string*                          | :heavy_check_mark:                | Address of the Safe contract      |
+| Field                          | Type                           | Required                       | Description                    |
+| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
+| `chainId`                      | *number*                       | :heavy_check_mark:             | Chain ID                       |
+| `verifyingContract`            | *string*                       | :heavy_check_mark:             | Address of the Product Account |