@compass-labs/api-sdk 0.0.24 → 0.0.26

package/src/models/components/uniswapbuyexactlyrequest.ts

@@ -22,7 +22,7 @@ import {
 /**
  * The amount of the token to swap to
  */
-export type UniswapBuyExactlyRequestAmountOut = number | string;
+export type UniswapBuyExactlyRequestAmount = number | string;
 
 /**
  * Request model for buying exactly an amount of tokens.
@@ -57,7 +57,7 @@ export type UniswapBuyExactlyRequest = {
   /**
    * 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.
    */
@@ -77,53 +77,52 @@ export type UniswapBuyExactlyRequest = {
 };
 
 /** @internal */
-export const UniswapBuyExactlyRequestAmountOut$inboundSchema: z.ZodType<
-  UniswapBuyExactlyRequestAmountOut,
+export const UniswapBuyExactlyRequestAmount$inboundSchema: z.ZodType<
+  UniswapBuyExactlyRequestAmount,
   z.ZodTypeDef,
   unknown
 > = z.union([z.number(), z.string()]);
 
 /** @internal */
-export type UniswapBuyExactlyRequestAmountOut$Outbound = number | string;
+export type UniswapBuyExactlyRequestAmount$Outbound = number | string;
 
 /** @internal */
-export const UniswapBuyExactlyRequestAmountOut$outboundSchema: z.ZodType<
-  UniswapBuyExactlyRequestAmountOut$Outbound,
+export const UniswapBuyExactlyRequestAmount$outboundSchema: z.ZodType<
+  UniswapBuyExactlyRequestAmount$Outbound,
   z.ZodTypeDef,
-  UniswapBuyExactlyRequestAmountOut
+  UniswapBuyExactlyRequestAmount
 > = 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 UniswapBuyExactlyRequestAmountOut$ {
-  /** @deprecated use `UniswapBuyExactlyRequestAmountOut$inboundSchema` instead. */
-  export const inboundSchema = UniswapBuyExactlyRequestAmountOut$inboundSchema;
-  /** @deprecated use `UniswapBuyExactlyRequestAmountOut$outboundSchema` instead. */
-  export const outboundSchema =
-    UniswapBuyExactlyRequestAmountOut$outboundSchema;
-  /** @deprecated use `UniswapBuyExactlyRequestAmountOut$Outbound` instead. */
-  export type Outbound = UniswapBuyExactlyRequestAmountOut$Outbound;
+export namespace UniswapBuyExactlyRequestAmount$ {
+  /** @deprecated use `UniswapBuyExactlyRequestAmount$inboundSchema` instead. */
+  export const inboundSchema = UniswapBuyExactlyRequestAmount$inboundSchema;
+  /** @deprecated use `UniswapBuyExactlyRequestAmount$outboundSchema` instead. */
+  export const outboundSchema = UniswapBuyExactlyRequestAmount$outboundSchema;
+  /** @deprecated use `UniswapBuyExactlyRequestAmount$Outbound` instead. */
+  export type Outbound = UniswapBuyExactlyRequestAmount$Outbound;
 }
 
-export function uniswapBuyExactlyRequestAmountOutToJSON(
-  uniswapBuyExactlyRequestAmountOut: UniswapBuyExactlyRequestAmountOut,
+export function uniswapBuyExactlyRequestAmountToJSON(
+  uniswapBuyExactlyRequestAmount: UniswapBuyExactlyRequestAmount,
 ): string {
   return JSON.stringify(
-    UniswapBuyExactlyRequestAmountOut$outboundSchema.parse(
-      uniswapBuyExactlyRequestAmountOut,
+    UniswapBuyExactlyRequestAmount$outboundSchema.parse(
+      uniswapBuyExactlyRequestAmount,
     ),
   );
 }
 
-export function uniswapBuyExactlyRequestAmountOutFromJSON(
+export function uniswapBuyExactlyRequestAmountFromJSON(
   jsonString: string,
-): SafeParseResult<UniswapBuyExactlyRequestAmountOut, SDKValidationError> {
+): SafeParseResult<UniswapBuyExactlyRequestAmount, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => UniswapBuyExactlyRequestAmountOut$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'UniswapBuyExactlyRequestAmountOut' from JSON`,
+    (x) => UniswapBuyExactlyRequestAmount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UniswapBuyExactlyRequestAmount' from JSON`,
   );
 }
 
@@ -136,7 +135,7 @@ export const UniswapBuyExactlyRequest$inboundSchema: z.ZodType<
   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),
   chain: Chain$inboundSchema,
@@ -145,7 +144,6 @@ export const UniswapBuyExactlyRequest$inboundSchema: z.ZodType<
   return remap$(v, {
     "token_in": "tokenIn",
     "token_out": "tokenOut",
-    "amount_out": "amountOut",
     "max_slippage_percent": "maxSlippagePercent",
     "wrap_eth": "wrapEth",
   });
@@ -156,7 +154,7 @@ export type UniswapBuyExactlyRequest$Outbound = {
   token_in: string;
   token_out: string;
   fee: string;
-  amount_out: number | string;
+  amount: number | string;
   max_slippage_percent: number;
   wrap_eth: boolean;
   chain: string;
@@ -172,7 +170,7 @@ export const UniswapBuyExactlyRequest$outboundSchema: z.ZodType<
   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),
   chain: Chain$outboundSchema,
@@ -181,7 +179,6 @@ export const UniswapBuyExactlyRequest$outboundSchema: z.ZodType<
   return remap$(v, {
     tokenIn: "token_in",
     tokenOut: "token_out",
-    amountOut: "amount_out",
     maxSlippagePercent: "max_slippage_percent",
     wrapEth: "wrap_eth",
   });

package/src/models/components/usageascollateral.ts

@@ -14,9 +14,26 @@ import {
 } from "./reserve.js";
 
 export type UsageAsCollateral = {
-  fromState: string;
-  toState: string;
+  /**
+   * The id of a historical transaction on aave
+   */
+  id: string;
+  /**
+   * Timestamp in unix time
+   */
+  timestamp: number;
+  /**
+   * Transaction hash. You can paste these into the search bar on etherscan
+   */
+  txHash: string;
+  fromState: boolean;
+  toState: boolean;
   reserve: Reserve;
+  /**
+   * The type of transaction
+   */
+  action?: "UsageAsCollateral" | undefined;
+  block: number;
 };
 
 /** @internal */
@@ -25,16 +42,26 @@ export const UsageAsCollateral$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  fromState: z.string(),
-  toState: z.string(),
+  id: z.string(),
+  timestamp: z.number().int(),
+  txHash: z.string(),
+  fromState: z.boolean(),
+  toState: z.boolean(),
   reserve: Reserve$inboundSchema,
+  action: z.literal("UsageAsCollateral").optional(),
+  block: z.number().int(),
 });
 
 /** @internal */
 export type UsageAsCollateral$Outbound = {
-  fromState: string;
-  toState: string;
+  id: string;
+  timestamp: number;
+  txHash: string;
+  fromState: boolean;
+  toState: boolean;
   reserve: Reserve$Outbound;
+  action: "UsageAsCollateral";
+  block: number;
 };
 
 /** @internal */
@@ -43,9 +70,14 @@ export const UsageAsCollateral$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   UsageAsCollateral
 > = z.object({
-  fromState: z.string(),
-  toState: z.string(),
+  id: z.string(),
+  timestamp: z.number().int(),
+  txHash: z.string(),
+  fromState: z.boolean(),
+  toState: z.boolean(),
   reserve: Reserve$outboundSchema,
+  action: z.literal("UsageAsCollateral").default("UsageAsCollateral" as const),
+  block: z.number().int(),
 });
 
 /**

package/src/models/operations/aavehistoricaltransactions.ts

@@ -25,12 +25,21 @@ export type AaveHistoricalTransactionsChain = ClosedEnum<
 >;
 
 export type AaveHistoricalTransactionsRequest = {
+  /**
+   * The offset of the first item to return.
+   */
   offset?: number | undefined;
+  /**
+   * The number of items to return.
+   */
   limit?: number | undefined;
   /**
    * The chain to use.
    */
   chain?: AaveHistoricalTransactionsChain | undefined;
+  /**
+   * The address of the user to get historical transactions for.
+   */
   userAddress?: string | undefined;
 };
 

package/src/models/operations/aaveliquiditychange.ts

@@ -96,15 +96,16 @@ export type AaveLiquidityChangeRequest = {
    */
   chain?: AaveLiquidityChangeChain | undefined;
   /**
-   * 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 of the asset to get liquidity change for..
    */
   token?: AaveLiquidityChangeToken | undefined;
+  /**
+   * The start block to calculate liquidity change from.
+   */
   startBlock?: number | undefined;
+  /**
+   * The end block to calculate liquidity change to.
+   */
   endBlock?: number | undefined;
 };
 

package/src/models/operations/aaverate.ts

@@ -91,12 +91,7 @@ export type AaveRateRequest = {
    */
   chain?: AaveRateChain | undefined;
   /**
-   * 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 of the asset to fetch the users' position on..
    */
   token?: AaveRateToken | undefined;
 };

package/src/models/operations/aavereserveoverview.ts

@@ -95,12 +95,7 @@ export type AaveReserveOverviewRequest = {
    */
   chain?: AaveReserveOverviewChain | undefined;
   /**
-   * 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 of the asset..
    */
   token?: AaveReserveOverviewToken | undefined;
 };

package/src/models/operations/aavetokenprice.ts

@@ -91,12 +91,7 @@ export type AaveTokenPriceRequest = {
    */
   chain?: AaveTokenPriceChain | undefined;
   /**
-   * 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 of the asset whose price you want..
    */
   token?: AaveTokenPriceToken | undefined;
 };

package/src/models/operations/aaveuserpositionpertoken.ts

@@ -94,14 +94,12 @@ export type AaveUserPositionPerTokenRequest = {
    * The chain to use.
    */
   chain?: AaveUserPositionPerTokenChain | undefined;
+  /**
+   * The user to fetch the token-specific position of.
+   */
   user?: string | undefined;
   /**
-   * 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 of the asset to fetch the user's position on..
    */
   token?: AaveUserPositionPerTokenToken | undefined;
 };

package/src/models/operations/aaveuserpositionsummary.ts

@@ -28,6 +28,9 @@ export type AaveUserPositionSummaryRequest = {
    * The chain to use.
    */
   chain?: AaveUserPositionSummaryChain | undefined;
+  /**
+   * The user to get position summary for.
+   */
   user?: string | undefined;
 };
 

package/src/models/operations/aerodromeslipstreamliquidityprovisionpositions.ts

@@ -28,6 +28,9 @@ export type AerodromeSlipstreamLiquidityProvisionPositionsRequest = {
    * The chain to use.
    */
   chain?: AerodromeSlipstreamLiquidityProvisionPositionsChain | undefined;
+  /**
+   * The user to get positions for.
+   */
   user?: string | undefined;
 };
 

package/src/models/operations/aerodromeslipstreampoolprice.ts

@@ -162,23 +162,16 @@ export type AerodromeSlipstreamPoolPriceRequest = {
    */
   chain?: AerodromeSlipstreamPoolPriceChain | undefined;
   /**
-   * 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 of a token in the pool.
    */
   tokenIn?: AerodromeSlipstreamPoolPriceTokenInToken | undefined;
   /**
-   * 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 of a token in the pool.
    */
   tokenOut?: AerodromeSlipstreamPoolPriceTokenOutToken | undefined;
+  /**
+   * The tick spacing of the pool
+   */
   tickSpacing?: number | undefined;
 };
 

package/src/models/operations/genericallowance.ts

@@ -86,6 +86,9 @@ export const GenericAllowanceToken = {
  */
 export type GenericAllowanceToken = ClosedEnum<typeof GenericAllowanceToken>;
 
+/**
+ * The name of the contract to check allowance for.
+ */
 export const ContractName = {
   AaveV3Pool: "AaveV3Pool",
   AerodromeBasicRouter: "AerodromeBasicRouter",
@@ -99,6 +102,9 @@ export const ContractName = {
   SkyUsdcUsdsConverter: "SkyUsdcUsdsConverter",
   SkyUsdsVault: "SkyUsdsVault",
 } as const;
+/**
+ * The name of the contract to check allowance for.
+ */
 export type ContractName = ClosedEnum<typeof ContractName>;
 
 export type GenericAllowanceRequest = {
@@ -106,16 +112,17 @@ export type GenericAllowanceRequest = {
    * The chain to use.
    */
   chain?: GenericAllowanceChain | undefined;
+  /**
+   * The user to get the ERC20 allowance of.
+   */
   user?: string | undefined;
   /**
-   * 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 of the token for which the allowance is checked..
    */
   token?: GenericAllowanceToken | undefined;
+  /**
+   * The name of the contract to check allowance for.
+   */
   contractName?: ContractName | undefined;
 };
 

package/src/models/operations/genericens.ts

@@ -27,6 +27,9 @@ export type GenericEnsRequest = {
    * The chain to use.
    */
   chain?: GenericEnsChain | undefined;
+  /**
+   * The ENS name to resolve.
+   */
   ensName?: string | undefined;
 };
 

package/src/models/operations/genericportfolio.ts

@@ -26,6 +26,9 @@ export type GenericPortfolioRequest = {
    * The chain to use.
    */
   chain?: GenericPortfolioChain | undefined;
+  /**
+   * The user to get portfolio for.
+   */
   user?: string | undefined;
 };
 

package/src/models/operations/genericvisualizeportfolio.ts

@@ -28,6 +28,9 @@ export type GenericVisualizePortfolioRequest = {
    * The chain to use.
    */
   chain?: GenericVisualizePortfolioChain | undefined;
+  /**
+   * The user to get portfolio for.
+   */
   user?: string | undefined;
 };
 

package/src/models/operations/morphomarketposition.ts

@@ -9,27 +9,23 @@ import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-/**
- * The chain to use.
- */
 export const MorphoMarketPositionChain = {
-  BaseMainnet: "base:mainnet",
   EthereumMainnet: "ethereum:mainnet",
-  ArbitrumMainnet: "arbitrum:mainnet",
+  BaseMainnet: "base:mainnet",
 } as const;
-/**
- * The chain to use.
- */
 export type MorphoMarketPositionChain = ClosedEnum<
   typeof MorphoMarketPositionChain
 >;
 
 export type MorphoMarketPositionRequest = {
+  chain?: MorphoMarketPositionChain | undefined;
   /**
-   * The chain to use.
+   * The user address of the desired market position.
    */
-  chain?: MorphoMarketPositionChain | undefined;
   userAddress?: string | undefined;
+  /**
+   * The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint.
+   */
   uniqueMarketKey?: string | undefined;
 };
 

package/src/models/operations/morphomarkets.ts

@@ -9,25 +9,21 @@ import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-/**
- * The chain to use.
- */
 export const MorphoMarketsChain = {
-  BaseMainnet: "base:mainnet",
   EthereumMainnet: "ethereum:mainnet",
-  ArbitrumMainnet: "arbitrum:mainnet",
+  BaseMainnet: "base:mainnet",
 } as const;
-/**
- * The chain to use.
- */
 export type MorphoMarketsChain = ClosedEnum<typeof MorphoMarketsChain>;
 
 export type MorphoMarketsRequest = {
+  chain?: MorphoMarketsChain | undefined;
   /**
-   * The chain to use.
+   * Collateral token to identify the market.
    */
-  chain?: MorphoMarketsChain | undefined;
   collateralToken?: string | null | undefined;
+  /**
+   * Loan token to identify the market.
+   */
   loanToken?: string | null | undefined;
 };
 

package/src/models/operations/morphovaultposition.ts

@@ -9,27 +9,23 @@ import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-/**
- * The chain to use.
- */
 export const MorphoVaultPositionChain = {
-  BaseMainnet: "base:mainnet",
   EthereumMainnet: "ethereum:mainnet",
-  ArbitrumMainnet: "arbitrum:mainnet",
+  BaseMainnet: "base:mainnet",
 } as const;
-/**
- * The chain to use.
- */
 export type MorphoVaultPositionChain = ClosedEnum<
   typeof MorphoVaultPositionChain
 >;
 
 export type MorphoVaultPositionRequest = {
+  chain?: MorphoVaultPositionChain | undefined;
   /**
-   * The chain to use.
+   * The user address of the desired vault position.
    */
-  chain?: MorphoVaultPositionChain | undefined;
   userAddress?: string | undefined;
+  /**
+   * The vault address of the desired vault position.
+   */
   vaultAddress?: string | undefined;
 };
 

package/src/models/operations/morphovaults.ts

@@ -9,25 +9,18 @@ import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-/**
- * The chain to use.
- */
 export const MorphoVaultsChain = {
-  BaseMainnet: "base:mainnet",
   EthereumMainnet: "ethereum:mainnet",
-  ArbitrumMainnet: "arbitrum:mainnet",
+  BaseMainnet: "base:mainnet",
 } as const;
-/**
- * The chain to use.
- */
 export type MorphoVaultsChain = ClosedEnum<typeof MorphoVaultsChain>;
 
 export type MorphoVaultsRequest = {
+  chain?: MorphoVaultsChain | undefined;
   /**
-   * The chain to use.
+   * Token address that will filter vaults by this deposit token.
    */
-  chain?: MorphoVaultsChain | undefined;
-  depositToken: string | null;
+  depositToken?: string | null | undefined;
 };
 
 /** @internal */
@@ -58,7 +51,7 @@ export const MorphoVaultsRequest$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   chain: MorphoVaultsChain$inboundSchema.default("ethereum:mainnet"),
-  deposit_token: z.nullable(z.string()),
+  deposit_token: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
     "deposit_token": "depositToken",
@@ -68,7 +61,7 @@ export const MorphoVaultsRequest$inboundSchema: z.ZodType<
 /** @internal */
 export type MorphoVaultsRequest$Outbound = {
   chain: string;
-  deposit_token: string | null;
+  deposit_token?: string | null | undefined;
 };
 
 /** @internal */
@@ -78,7 +71,7 @@ export const MorphoVaultsRequest$outboundSchema: z.ZodType<
   MorphoVaultsRequest
 > = z.object({
   chain: MorphoVaultsChain$outboundSchema.default("ethereum:mainnet"),
-  depositToken: z.nullable(z.string()),
+  depositToken: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
     depositToken: "deposit_token",

package/src/models/operations/skyposition.ts

@@ -10,6 +10,9 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type SkyPositionRequest = {
   chain?: "ethereum:mainnet" | undefined;
+  /**
+   * The user address of the desired position.
+   */
   userAddress?: string | undefined;
 };
 

package/src/models/operations/tokenaddress.ts

@@ -91,12 +91,7 @@ export type TokenAddressRequest = {
    */
   chain?: TokenAddressChain | undefined;
   /**
-   * 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 token symbol to get the address for..
    */
   token?: TokenAddressToken | undefined;
 };

package/src/models/operations/tokenbalance.ts

@@ -22,6 +22,9 @@ export const TokenBalanceChain = {
  */
 export type TokenBalanceChain = ClosedEnum<typeof TokenBalanceChain>;
 
+/**
+ * The symbol of the token for which the balance is checked..
+ */
 export type TokenBalanceToken = components.TokenEnum | string;
 
 export type TokenBalanceRequest = {
@@ -29,7 +32,13 @@ export type TokenBalanceRequest = {
    * The chain to use.
    */
   chain?: TokenBalanceChain | undefined;
+  /**
+   * The user to get the ERC20 balance of.
+   */
   user?: string | undefined;
+  /**
+   * The symbol of the token for which the balance is checked..
+   */
   token: components.TokenEnum | string;
 };
 

package/src/models/operations/tokenprice.ts

@@ -91,12 +91,7 @@ export type TokenPriceRequest = {
    */
   chain?: TokenPriceChain | undefined;
   /**
-   * 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 of the token for which to get the price.
    */
   token?: TokenPriceToken | undefined;
 };