@compass-labs/api-sdk 0.5.17 → 0.5.19

package/src/models/components/allowanceinforesponse.ts

@@ -7,11 +7,6 @@ import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-import {
-  TokenEnum,
-  TokenEnum$inboundSchema,
-  TokenEnum$outboundSchema,
-} from "./tokenenum.js";
 
 /**
  * Response model for token allowance information.
@@ -26,14 +21,9 @@ export type AllowanceInfoResponse = {
    */
   decimals: number;
   /**
-   * 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.
+   * Symbol of the token.
    */
-  tokenSymbol: TokenEnum;
+  tokenSymbol: string;
   /**
    * Address of the token
    */
@@ -52,7 +42,7 @@ export const AllowanceInfoResponse$inboundSchema: z.ZodType<
 > = z.object({
   amount: z.string(),
   decimals: z.number().int(),
-  token_symbol: TokenEnum$inboundSchema,
+  token_symbol: z.string(),
   token_address: z.string(),
   contract_address: z.string(),
 }).transform((v) => {
@@ -80,7 +70,7 @@ export const AllowanceInfoResponse$outboundSchema: z.ZodType<
 > = z.object({
   amount: z.string(),
   decimals: z.number().int(),
-  tokenSymbol: TokenEnum$outboundSchema,
+  tokenSymbol: z.string(),
   tokenAddress: z.string(),
   contractAddress: z.string(),
 }).transform((v) => {

package/src/models/operations/genericallowance.ts

@@ -7,6 +7,7 @@ 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 * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
@@ -23,68 +24,9 @@ export const GenericAllowanceChain = {
 export type GenericAllowanceChain = ClosedEnum<typeof GenericAllowanceChain>;
 
 /**
- * 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.
+ * The symbol or address of the token for which the allowance is checked..
  */
-export const GenericAllowanceToken = {
-  OneINCH: "1INCH",
-  Aave: "AAVE",
-  Bal: "BAL",
-  CbBTC: "cbBTC",
-  CbETH: "cbETH",
-  Crv: "CRV",
-  CrvUSD: "crvUSD",
-  Dai: "DAI",
-  Ens: "ENS",
-  ETHx: "ETHx",
-  Frax: "FRAX",
-  Fxs: "FXS",
-  Gho: "GHO",
-  Knc: "KNC",
-  Ldo: "LDO",
-  Link: "LINK",
-  Lusd: "LUSD",
-  Mkr: "MKR",
-  OsETH: "osETH",
-  Pyusd: "PYUSD",
-  RETH: "rETH",
-  Rpl: "RPL",
-  RsETH: "rsETH",
-  SDAI: "sDAI",
-  Snx: "SNX",
-  Stg: "STG",
-  SUSDe: "sUSDe",
-  TBTC: "tBTC",
-  Uni: "UNI",
-  Usdc: "USDC",
-  USDe: "USDe",
-  Usds: "USDS",
-  Usdt: "USDT",
-  Wbtc: "WBTC",
-  WeETH: "weETH",
-  Weth: "WETH",
-  WstETH: "wstETH",
-  Arb: "ARB",
-  Eurs: "EURS",
-  Mai: "MAI",
-  USDCe: "USDCe",
-  Aero: "AERO",
-  Eur: "EUR",
-  Virtual: "VIRTUAL",
-} as const;
-/**
- * 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.
- */
-export type GenericAllowanceToken = ClosedEnum<typeof GenericAllowanceToken>;
+export type GenericAllowanceToken = components.TokenEnum | string;
 
 /**
  * The name of the contract to check allowance for.
@@ -118,9 +60,9 @@ export type GenericAllowanceRequest = {
    */
   user?: string | undefined;
   /**
-   * The symbol of the token for which the allowance is checked..
+   * The symbol or address of the token for which the allowance is checked..
    */
-  token?: GenericAllowanceToken | undefined;
+  token: components.TokenEnum | string;
   /**
    * The name of the contract to check allowance for.
    */
@@ -149,14 +91,21 @@ export namespace GenericAllowanceChain$ {
 }
 
 /** @internal */
-export const GenericAllowanceToken$inboundSchema: z.ZodNativeEnum<
-  typeof GenericAllowanceToken
-> = z.nativeEnum(GenericAllowanceToken);
+export const GenericAllowanceToken$inboundSchema: z.ZodType<
+  GenericAllowanceToken,
+  z.ZodTypeDef,
+  unknown
+> = z.union([components.TokenEnum$inboundSchema, z.string()]);
+
+/** @internal */
+export type GenericAllowanceToken$Outbound = string | string;
 
 /** @internal */
-export const GenericAllowanceToken$outboundSchema: z.ZodNativeEnum<
-  typeof GenericAllowanceToken
-> = GenericAllowanceToken$inboundSchema;
+export const GenericAllowanceToken$outboundSchema: z.ZodType<
+  GenericAllowanceToken$Outbound,
+  z.ZodTypeDef,
+  GenericAllowanceToken
+> = z.union([components.TokenEnum$outboundSchema, z.string()]);
 
 /**
  * @internal
@@ -167,6 +116,26 @@ export namespace GenericAllowanceToken$ {
   export const inboundSchema = GenericAllowanceToken$inboundSchema;
   /** @deprecated use `GenericAllowanceToken$outboundSchema` instead. */
   export const outboundSchema = GenericAllowanceToken$outboundSchema;
+  /** @deprecated use `GenericAllowanceToken$Outbound` instead. */
+  export type Outbound = GenericAllowanceToken$Outbound;
+}
+
+export function genericAllowanceTokenToJSON(
+  genericAllowanceToken: GenericAllowanceToken,
+): string {
+  return JSON.stringify(
+    GenericAllowanceToken$outboundSchema.parse(genericAllowanceToken),
+  );
+}
+
+export function genericAllowanceTokenFromJSON(
+  jsonString: string,
+): SafeParseResult<GenericAllowanceToken, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GenericAllowanceToken$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GenericAllowanceToken' from JSON`,
+  );
 }
 
 /** @internal */
@@ -196,7 +165,7 @@ export const GenericAllowanceRequest$inboundSchema: z.ZodType<
 > = z.object({
   chain: GenericAllowanceChain$inboundSchema.default("arbitrum:mainnet"),
   user: z.string().default("0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"),
-  token: GenericAllowanceToken$inboundSchema.default("USDC"),
+  token: z.union([components.TokenEnum$inboundSchema, z.string()]),
   contract_name: ContractName$inboundSchema.default("AaveV3Pool"),
 }).transform((v) => {
   return remap$(v, {
@@ -208,7 +177,7 @@ export const GenericAllowanceRequest$inboundSchema: z.ZodType<
 export type GenericAllowanceRequest$Outbound = {
   chain: string;
   user: string;
-  token: string;
+  token: string | string;
   contract_name: string;
 };
 
@@ -220,7 +189,7 @@ export const GenericAllowanceRequest$outboundSchema: z.ZodType<
 > = z.object({
   chain: GenericAllowanceChain$outboundSchema.default("arbitrum:mainnet"),
   user: z.string().default("0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"),
-  token: GenericAllowanceToken$outboundSchema.default("USDC"),
+  token: z.union([components.TokenEnum$outboundSchema, z.string()]),
   contractName: ContractName$outboundSchema.default("AaveV3Pool"),
 }).transform((v) => {
   return remap$(v, {

package/src/sdk/transactionbatching.ts

@@ -11,7 +11,7 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class TransactionBatching extends ClientSDK {
   /**
-   * Enable transaction bundling.
+   * Enable transaction bundling
    *
    * @remarks
    * Get authorization for bundling transactions.