@compass-labs/api-sdk 0.5.68 → 0.5.69

package/src/models/components/skywithdrawrequest.ts

@@ -10,29 +10,12 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export const SkyWithdrawRequestChain = {
-  EthereumMainnet: "ethereum:mainnet",
+  Ethereum: "ethereum",
 } as const;
 export type SkyWithdrawRequestChain = ClosedEnum<
   typeof SkyWithdrawRequestChain
 >;
 
-export type SkyWithdrawRequest = {
-  actionType?: "SKY_WITHDRAW" | undefined;
-  /**
-   * The amount of USDS you would like to withdraw. If set to 'ALL', your total deposited USDS amount will be withdrawn.
-   */
-  amount?: any | undefined;
-  /**
-   * The address which will receive the withdrawn USDS. Defaults to the sender.
-   */
-  receiver?: string | null | undefined;
-  chain?: SkyWithdrawRequestChain | undefined;
-  /**
-   * The address of the transaction sender.
-   */
-  sender: string;
-};
-
 /** @internal */
 export const SkyWithdrawRequestChain$inboundSchema: z.ZodNativeEnum<
   typeof SkyWithdrawRequestChain
@@ -54,6 +37,23 @@ export namespace SkyWithdrawRequestChain$ {
   export const outboundSchema = SkyWithdrawRequestChain$outboundSchema;
 }
 
+export type SkyWithdrawRequest = {
+  actionType?: "SKY_WITHDRAW" | undefined;
+  /**
+   * The amount of USDS you would like to withdraw. If set to 'ALL', your total deposited USDS amount will be withdrawn.
+   */
+  amount?: any | undefined;
+  /**
+   * The address which will receive the withdrawn USDS. Defaults to the sender.
+   */
+  receiver?: string | null | undefined;
+  chain?: SkyWithdrawRequestChain | undefined;
+  /**
+   * The address of the transaction sender.
+   */
+  sender: string;
+};
+
 /** @internal */
 export const SkyWithdrawRequest$inboundSchema: z.ZodType<
   SkyWithdrawRequest,
@@ -63,7 +63,7 @@ export const SkyWithdrawRequest$inboundSchema: z.ZodType<
   action_type: z.literal("SKY_WITHDRAW").default("SKY_WITHDRAW"),
   amount: z.any().optional(),
   receiver: z.nullable(z.string()).optional(),
-  chain: SkyWithdrawRequestChain$inboundSchema.default("ethereum:mainnet"),
+  chain: SkyWithdrawRequestChain$inboundSchema.default("ethereum"),
   sender: z.string(),
 }).transform((v) => {
   return remap$(v, {
@@ -89,7 +89,7 @@ export const SkyWithdrawRequest$outboundSchema: z.ZodType<
   actionType: z.literal("SKY_WITHDRAW").default("SKY_WITHDRAW" as const),
   amount: z.any().optional(),
   receiver: z.nullable(z.string()).optional(),
-  chain: SkyWithdrawRequestChain$outboundSchema.default("ethereum:mainnet"),
+  chain: SkyWithdrawRequestChain$outboundSchema.default("ethereum"),
   sender: z.string(),
 }).transform((v) => {
   return remap$(v, {

package/src/models/components/tokentransferrequest.ts

@@ -14,6 +14,36 @@ import {
   TokenEnum$outboundSchema,
 } from "./tokenenum.js";
 
+export const TokenTransferRequestChain = {
+  Arbitrum: "arbitrum",
+  Base: "base",
+  Ethereum: "ethereum",
+} as const;
+export type TokenTransferRequestChain = ClosedEnum<
+  typeof TokenTransferRequestChain
+>;
+
+/** @internal */
+export const TokenTransferRequestChain$inboundSchema: z.ZodNativeEnum<
+  typeof TokenTransferRequestChain
+> = z.nativeEnum(TokenTransferRequestChain);
+
+/** @internal */
+export const TokenTransferRequestChain$outboundSchema: z.ZodNativeEnum<
+  typeof TokenTransferRequestChain
+> = TokenTransferRequestChain$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TokenTransferRequestChain$ {
+  /** @deprecated use `TokenTransferRequestChain$inboundSchema` instead. */
+  export const inboundSchema = TokenTransferRequestChain$inboundSchema;
+  /** @deprecated use `TokenTransferRequestChain$outboundSchema` instead. */
+  export const outboundSchema = TokenTransferRequestChain$outboundSchema;
+}
+
 /**
  * Amount of token to transfer
  */
@@ -24,15 +54,6 @@ export type TokenTransferRequestAmount = number | string;
  */
 export type TokenTransferRequestToken = TokenEnum | string;
 
-export const TokenTransferRequestChain = {
-  ArbitrumMainnet: "arbitrum:mainnet",
-  BaseMainnet: "base:mainnet",
-  EthereumMainnet: "ethereum:mainnet",
-} as const;
-export type TokenTransferRequestChain = ClosedEnum<
-  typeof TokenTransferRequestChain
->;
-
 /**
  * Request model for transferring ETH or ERC20 tokens.
  */
@@ -153,27 +174,6 @@ export function tokenTransferRequestTokenFromJSON(
   );
 }
 
-/** @internal */
-export const TokenTransferRequestChain$inboundSchema: z.ZodNativeEnum<
-  typeof TokenTransferRequestChain
-> = z.nativeEnum(TokenTransferRequestChain);
-
-/** @internal */
-export const TokenTransferRequestChain$outboundSchema: z.ZodNativeEnum<
-  typeof TokenTransferRequestChain
-> = TokenTransferRequestChain$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace TokenTransferRequestChain$ {
-  /** @deprecated use `TokenTransferRequestChain$inboundSchema` instead. */
-  export const inboundSchema = TokenTransferRequestChain$inboundSchema;
-  /** @deprecated use `TokenTransferRequestChain$outboundSchema` instead. */
-  export const outboundSchema = TokenTransferRequestChain$outboundSchema;
-}
-
 /** @internal */
 export const TokenTransferRequest$inboundSchema: z.ZodType<
   TokenTransferRequest,

package/src/models/components/uniswapbuyexactlyparams.ts

@@ -19,30 +19,30 @@ import {
 } from "./tokenenum.js";
 
 /**
- * The symbol or address of the token to swap from.
+ * The amount of the token to swap to
  */
-export type UniswapBuyExactlyParamsTokenIn = TokenEnum | string;
-
-/**
- * The symbol or address of the token to swap to.
- */
-export type UniswapBuyExactlyParamsTokenOut = TokenEnum | string;
-
-/**
- * The amount of 'token_out' to buy.
- */
-export type UniswapBuyExactlyParamsAmountOut = number | string;
+export type UniswapBuyExactlyParamsAmount = number | string;
 
 export type UniswapBuyExactlyParams = {
   actionType?: "UNISWAP_BUY_EXACTLY" | undefined;
   /**
-   * The symbol or address of the token to swap from.
+   * A class representing the token.
+   *
+   * @remarks
+   *
+   * This class is used to represent the token in the system. Notice individual
+   * endpoints' documentation where per chain tokens are presented.
    */
-  tokenIn: TokenEnum | string;
+  tokenIn: TokenEnum;
   /**
-   * The symbol or address of the token to swap to.
+   * A class representing the token.
+   *
+   * @remarks
+   *
+   * This class is used to represent the token in the system. Notice individual
+   * endpoints' documentation where per chain tokens are presented.
    */
-  tokenOut: TokenEnum | string;
+  tokenOut: TokenEnum;
   /**
    * The transaction fee of a Uniswap pool in bips.
    *
@@ -52,162 +52,66 @@ export type UniswapBuyExactlyParams = {
    */
   fee: FeeEnum;
   /**
-   * The amount of 'token_out' to buy.
+   * The amount of the token to swap to
    */
-  amountOut: number | string;
+  amount: number | string;
   /**
    * The maximum slippage allowed in percent. e.g. `1` means `1 %` slippage allowed.
    */
   maxSlippagePercent: number;
+  /**
+   * Whether to wrap ETH to WETH, only use when swapping WETH into something
+   */
+  wrapEth?: boolean | undefined;
 };
 
 /** @internal */
-export const UniswapBuyExactlyParamsTokenIn$inboundSchema: z.ZodType<
-  UniswapBuyExactlyParamsTokenIn,
-  z.ZodTypeDef,
-  unknown
-> = z.union([TokenEnum$inboundSchema, z.string()]);
-
-/** @internal */
-export type UniswapBuyExactlyParamsTokenIn$Outbound = string | string;
-
-/** @internal */
-export const UniswapBuyExactlyParamsTokenIn$outboundSchema: z.ZodType<
-  UniswapBuyExactlyParamsTokenIn$Outbound,
-  z.ZodTypeDef,
-  UniswapBuyExactlyParamsTokenIn
-> = z.union([TokenEnum$outboundSchema, z.string()]);
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace UniswapBuyExactlyParamsTokenIn$ {
-  /** @deprecated use `UniswapBuyExactlyParamsTokenIn$inboundSchema` instead. */
-  export const inboundSchema = UniswapBuyExactlyParamsTokenIn$inboundSchema;
-  /** @deprecated use `UniswapBuyExactlyParamsTokenIn$outboundSchema` instead. */
-  export const outboundSchema = UniswapBuyExactlyParamsTokenIn$outboundSchema;
-  /** @deprecated use `UniswapBuyExactlyParamsTokenIn$Outbound` instead. */
-  export type Outbound = UniswapBuyExactlyParamsTokenIn$Outbound;
-}
-
-export function uniswapBuyExactlyParamsTokenInToJSON(
-  uniswapBuyExactlyParamsTokenIn: UniswapBuyExactlyParamsTokenIn,
-): string {
-  return JSON.stringify(
-    UniswapBuyExactlyParamsTokenIn$outboundSchema.parse(
-      uniswapBuyExactlyParamsTokenIn,
-    ),
-  );
-}
-
-export function uniswapBuyExactlyParamsTokenInFromJSON(
-  jsonString: string,
-): SafeParseResult<UniswapBuyExactlyParamsTokenIn, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => UniswapBuyExactlyParamsTokenIn$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'UniswapBuyExactlyParamsTokenIn' from JSON`,
-  );
-}
-
-/** @internal */
-export const UniswapBuyExactlyParamsTokenOut$inboundSchema: z.ZodType<
-  UniswapBuyExactlyParamsTokenOut,
-  z.ZodTypeDef,
-  unknown
-> = z.union([TokenEnum$inboundSchema, z.string()]);
-
-/** @internal */
-export type UniswapBuyExactlyParamsTokenOut$Outbound = string | string;
-
-/** @internal */
-export const UniswapBuyExactlyParamsTokenOut$outboundSchema: z.ZodType<
-  UniswapBuyExactlyParamsTokenOut$Outbound,
-  z.ZodTypeDef,
-  UniswapBuyExactlyParamsTokenOut
-> = z.union([TokenEnum$outboundSchema, z.string()]);
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace UniswapBuyExactlyParamsTokenOut$ {
-  /** @deprecated use `UniswapBuyExactlyParamsTokenOut$inboundSchema` instead. */
-  export const inboundSchema = UniswapBuyExactlyParamsTokenOut$inboundSchema;
-  /** @deprecated use `UniswapBuyExactlyParamsTokenOut$outboundSchema` instead. */
-  export const outboundSchema = UniswapBuyExactlyParamsTokenOut$outboundSchema;
-  /** @deprecated use `UniswapBuyExactlyParamsTokenOut$Outbound` instead. */
-  export type Outbound = UniswapBuyExactlyParamsTokenOut$Outbound;
-}
-
-export function uniswapBuyExactlyParamsTokenOutToJSON(
-  uniswapBuyExactlyParamsTokenOut: UniswapBuyExactlyParamsTokenOut,
-): string {
-  return JSON.stringify(
-    UniswapBuyExactlyParamsTokenOut$outboundSchema.parse(
-      uniswapBuyExactlyParamsTokenOut,
-    ),
-  );
-}
-
-export function uniswapBuyExactlyParamsTokenOutFromJSON(
-  jsonString: string,
-): SafeParseResult<UniswapBuyExactlyParamsTokenOut, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => UniswapBuyExactlyParamsTokenOut$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'UniswapBuyExactlyParamsTokenOut' from JSON`,
-  );
-}
-
-/** @internal */
-export const UniswapBuyExactlyParamsAmountOut$inboundSchema: z.ZodType<
-  UniswapBuyExactlyParamsAmountOut,
+export const UniswapBuyExactlyParamsAmount$inboundSchema: z.ZodType<
+  UniswapBuyExactlyParamsAmount,
   z.ZodTypeDef,
   unknown
 > = z.union([z.number(), z.string()]);
 
 /** @internal */
-export type UniswapBuyExactlyParamsAmountOut$Outbound = number | string;
+export type UniswapBuyExactlyParamsAmount$Outbound = number | string;
 
 /** @internal */
-export const UniswapBuyExactlyParamsAmountOut$outboundSchema: z.ZodType<
-  UniswapBuyExactlyParamsAmountOut$Outbound,
+export const UniswapBuyExactlyParamsAmount$outboundSchema: z.ZodType<
+  UniswapBuyExactlyParamsAmount$Outbound,
   z.ZodTypeDef,
-  UniswapBuyExactlyParamsAmountOut
+  UniswapBuyExactlyParamsAmount
 > = z.union([z.number(), z.string()]);
 
 /**
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace UniswapBuyExactlyParamsAmountOut$ {
-  /** @deprecated use `UniswapBuyExactlyParamsAmountOut$inboundSchema` instead. */
-  export const inboundSchema = UniswapBuyExactlyParamsAmountOut$inboundSchema;
-  /** @deprecated use `UniswapBuyExactlyParamsAmountOut$outboundSchema` instead. */
-  export const outboundSchema = UniswapBuyExactlyParamsAmountOut$outboundSchema;
-  /** @deprecated use `UniswapBuyExactlyParamsAmountOut$Outbound` instead. */
-  export type Outbound = UniswapBuyExactlyParamsAmountOut$Outbound;
+export namespace UniswapBuyExactlyParamsAmount$ {
+  /** @deprecated use `UniswapBuyExactlyParamsAmount$inboundSchema` instead. */
+  export const inboundSchema = UniswapBuyExactlyParamsAmount$inboundSchema;
+  /** @deprecated use `UniswapBuyExactlyParamsAmount$outboundSchema` instead. */
+  export const outboundSchema = UniswapBuyExactlyParamsAmount$outboundSchema;
+  /** @deprecated use `UniswapBuyExactlyParamsAmount$Outbound` instead. */
+  export type Outbound = UniswapBuyExactlyParamsAmount$Outbound;
 }
 
-export function uniswapBuyExactlyParamsAmountOutToJSON(
-  uniswapBuyExactlyParamsAmountOut: UniswapBuyExactlyParamsAmountOut,
+export function uniswapBuyExactlyParamsAmountToJSON(
+  uniswapBuyExactlyParamsAmount: UniswapBuyExactlyParamsAmount,
 ): string {
   return JSON.stringify(
-    UniswapBuyExactlyParamsAmountOut$outboundSchema.parse(
-      uniswapBuyExactlyParamsAmountOut,
+    UniswapBuyExactlyParamsAmount$outboundSchema.parse(
+      uniswapBuyExactlyParamsAmount,
     ),
   );
 }
 
-export function uniswapBuyExactlyParamsAmountOutFromJSON(
+export function uniswapBuyExactlyParamsAmountFromJSON(
   jsonString: string,
-): SafeParseResult<UniswapBuyExactlyParamsAmountOut, SDKValidationError> {
+): SafeParseResult<UniswapBuyExactlyParamsAmount, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => UniswapBuyExactlyParamsAmountOut$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'UniswapBuyExactlyParamsAmountOut' from JSON`,
+    (x) => UniswapBuyExactlyParamsAmount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UniswapBuyExactlyParamsAmount' from JSON`,
   );
 }
 
@@ -218,29 +122,31 @@ export const UniswapBuyExactlyParams$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   action_type: z.literal("UNISWAP_BUY_EXACTLY").default("UNISWAP_BUY_EXACTLY"),
-  token_in: z.union([TokenEnum$inboundSchema, z.string()]),
-  token_out: z.union([TokenEnum$inboundSchema, z.string()]),
+  token_in: TokenEnum$inboundSchema,
+  token_out: TokenEnum$inboundSchema,
   fee: FeeEnum$inboundSchema,
-  amount_out: z.union([z.number(), z.string()]),
+  amount: z.union([z.number(), z.string()]),
   max_slippage_percent: z.number(),
+  wrap_eth: z.boolean().default(false),
 }).transform((v) => {
   return remap$(v, {
     "action_type": "actionType",
     "token_in": "tokenIn",
     "token_out": "tokenOut",
-    "amount_out": "amountOut",
     "max_slippage_percent": "maxSlippagePercent",
+    "wrap_eth": "wrapEth",
   });
 });
 
 /** @internal */
 export type UniswapBuyExactlyParams$Outbound = {
   action_type: "UNISWAP_BUY_EXACTLY";
-  token_in: string | string;
-  token_out: string | string;
+  token_in: string;
+  token_out: string;
   fee: string;
-  amount_out: number | string;
+  amount: number | string;
   max_slippage_percent: number;
+  wrap_eth: boolean;
 };
 
 /** @internal */
@@ -252,18 +158,19 @@ export const UniswapBuyExactlyParams$outboundSchema: z.ZodType<
   actionType: z.literal("UNISWAP_BUY_EXACTLY").default(
     "UNISWAP_BUY_EXACTLY" as const,
   ),
-  tokenIn: z.union([TokenEnum$outboundSchema, z.string()]),
-  tokenOut: z.union([TokenEnum$outboundSchema, z.string()]),
+  tokenIn: TokenEnum$outboundSchema,
+  tokenOut: TokenEnum$outboundSchema,
   fee: FeeEnum$outboundSchema,
-  amountOut: z.union([z.number(), z.string()]),
+  amount: z.union([z.number(), z.string()]),
   maxSlippagePercent: z.number(),
+  wrapEth: z.boolean().default(false),
 }).transform((v) => {
   return remap$(v, {
     actionType: "action_type",
     tokenIn: "token_in",
     tokenOut: "token_out",
-    amountOut: "amount_out",
     maxSlippagePercent: "max_slippage_percent",
+    wrapEth: "wrap_eth",
   });
 });