@compass-labs/api-sdk 2.1.1-rc.1 → 2.1.2-rc.1

package/src/models/operations/v2earnvaults.ts

@@ -4,10 +4,7 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
-import { safeParse } from "../../lib/schemas.js";
 import { ClosedEnum } from "../../types/enums.js";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
  * The direction to order the results by.
@@ -49,37 +46,14 @@ export type V2EarnVaultsRequest = {
 };
 
 /** @internal */
-export const Direction$inboundSchema: z.ZodNativeEnum<typeof Direction> = z
+export const Direction$outboundSchema: z.ZodNativeEnum<typeof Direction> = z
   .nativeEnum(Direction);
-/** @internal */
-export const Direction$outboundSchema: z.ZodNativeEnum<typeof Direction> =
-  Direction$inboundSchema;
 
-/** @internal */
-export const V2EarnVaultsChain$inboundSchema: z.ZodNativeEnum<
-  typeof V2EarnVaultsChain
-> = z.nativeEnum(V2EarnVaultsChain);
 /** @internal */
 export const V2EarnVaultsChain$outboundSchema: z.ZodNativeEnum<
   typeof V2EarnVaultsChain
-> = V2EarnVaultsChain$inboundSchema;
+> = z.nativeEnum(V2EarnVaultsChain);
 
-/** @internal */
-export const V2EarnVaultsRequest$inboundSchema: z.ZodType<
-  V2EarnVaultsRequest,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  order_by: z.string(),
-  direction: Direction$inboundSchema.optional(),
-  offset: z.number().int().optional(),
-  limit: z.number().int().optional(),
-  chain: V2EarnVaultsChain$inboundSchema,
-}).transform((v) => {
-  return remap$(v, {
-    "order_by": "orderBy",
-  });
-});
 /** @internal */
 export type V2EarnVaultsRequest$Outbound = {
   order_by: string;
@@ -113,12 +87,3 @@ export function v2EarnVaultsRequestToJSON(
     V2EarnVaultsRequest$outboundSchema.parse(v2EarnVaultsRequest),
   );
 }
-export function v2EarnVaultsRequestFromJSON(
-  jsonString: string,
-): SafeParseResult<V2EarnVaultsRequest, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => V2EarnVaultsRequest$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'V2EarnVaultsRequest' from JSON`,
-  );
-}

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,