@compass-labs/api-sdk 0.0.25 → 0.0.27

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

@@ -19,7 +19,13 @@ export type MorphoMarketPositionChain = ClosedEnum<
 
 export type MorphoMarketPositionRequest = {
   chain?: MorphoMarketPositionChain | undefined;
+  /**
+   * The user address of the desired market position.
+   */
   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

@@ -17,8 +17,14 @@ export type MorphoMarketsChain = ClosedEnum<typeof MorphoMarketsChain>;
 
 export type MorphoMarketsRequest = {
   chain?: MorphoMarketsChain | undefined;
-  collateralToken?: string | null | undefined;
-  loanToken?: string | null | undefined;
+  /**
+   * Collateral token to identify the market.
+   */
+  collateralToken: string | null;
+  /**
+   * Loan token to identify the market.
+   */
+  loanToken: string | null;
 };
 
 /** @internal */
@@ -49,8 +55,8 @@ export const MorphoMarketsRequest$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   chain: MorphoMarketsChain$inboundSchema.default("ethereum:mainnet"),
-  collateral_token: z.nullable(z.string()).optional(),
-  loan_token: z.nullable(z.string()).optional(),
+  collateral_token: z.nullable(z.string()),
+  loan_token: z.nullable(z.string()),
 }).transform((v) => {
   return remap$(v, {
     "collateral_token": "collateralToken",
@@ -61,8 +67,8 @@ export const MorphoMarketsRequest$inboundSchema: z.ZodType<
 /** @internal */
 export type MorphoMarketsRequest$Outbound = {
   chain: string;
-  collateral_token?: string | null | undefined;
-  loan_token?: string | null | undefined;
+  collateral_token: string | null;
+  loan_token: string | null;
 };
 
 /** @internal */
@@ -72,8 +78,8 @@ export const MorphoMarketsRequest$outboundSchema: z.ZodType<
   MorphoMarketsRequest
 > = z.object({
   chain: MorphoMarketsChain$outboundSchema.default("ethereum:mainnet"),
-  collateralToken: z.nullable(z.string()).optional(),
-  loanToken: z.nullable(z.string()).optional(),
+  collateralToken: z.nullable(z.string()),
+  loanToken: z.nullable(z.string()),
 }).transform((v) => {
   return remap$(v, {
     collateralToken: "collateral_token",

package/src/models/operations/morphovaultposition.ts

@@ -19,7 +19,13 @@ export type MorphoVaultPositionChain = ClosedEnum<
 
 export type MorphoVaultPositionRequest = {
   chain?: MorphoVaultPositionChain | undefined;
+  /**
+   * The user address of the desired vault position.
+   */
   userAddress?: string | undefined;
+  /**
+   * The vault address of the desired vault position.
+   */
   vaultAddress?: string | undefined;
 };
 

package/src/models/operations/morphovaults.ts

@@ -17,7 +17,10 @@ export type MorphoVaultsChain = ClosedEnum<typeof MorphoVaultsChain>;
 
 export type MorphoVaultsRequest = {
   chain?: MorphoVaultsChain | undefined;
-  depositToken?: string | null | undefined;
+  /**
+   * Token address that will filter vaults by this deposit token.
+   */
+  depositToken: string | null;
 };
 
 /** @internal */
@@ -48,7 +51,7 @@ export const MorphoVaultsRequest$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   chain: MorphoVaultsChain$inboundSchema.default("ethereum:mainnet"),
-  deposit_token: z.nullable(z.string()).optional(),
+  deposit_token: z.nullable(z.string()),
 }).transform((v) => {
   return remap$(v, {
     "deposit_token": "depositToken",
@@ -58,7 +61,7 @@ export const MorphoVaultsRequest$inboundSchema: z.ZodType<
 /** @internal */
 export type MorphoVaultsRequest$Outbound = {
   chain: string;
-  deposit_token?: string | null | undefined;
+  deposit_token: string | null;
 };
 
 /** @internal */
@@ -68,7 +71,7 @@ export const MorphoVaultsRequest$outboundSchema: z.ZodType<
   MorphoVaultsRequest
 > = z.object({
   chain: MorphoVaultsChain$outboundSchema.default("ethereum:mainnet"),
-  depositToken: z.nullable(z.string()).optional(),
+  depositToken: z.nullable(z.string()),
 }).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;
 };

package/src/models/operations/uniswapliquidityprovisioninrange.ts

@@ -29,6 +29,9 @@ export type UniswapLiquidityProvisionInRangeRequest = {
    * The chain to use.
    */
   chain?: UniswapLiquidityProvisionInRangeChain | undefined;
+  /**
+   * Token ID of the NFT representing the liquidity provisioned position.
+   */
   tokenId?: number | undefined;
 };
 

package/src/models/operations/uniswapliquidityprovisionpositions.ts

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

package/src/models/operations/uniswappoolprice.ts

@@ -184,29 +184,15 @@ export type UniswapPoolPriceRequest = {
    */
   chain?: UniswapPoolPriceChain | 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?: UniswapPoolPriceTokenInToken | 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?: UniswapPoolPriceTokenOutToken | undefined;
   /**
-   * The transaction fee of a Uniswap pool in bips.
-   *
-   * @remarks
-   *
-   * Uniswap supports 4 different fee levels.
+   * The fee of the pool
    */
   fee?: UniswapPoolPriceFeeEnum | undefined;
 };

package/src/models/operations/uniswapquotebuyexactly.ts

@@ -180,6 +180,9 @@ export type UniswapQuoteBuyExactlyFeeEnum = ClosedEnum<
   typeof UniswapQuoteBuyExactlyFeeEnum
 >;
 
+/**
+ * The amount of the token to swap to
+ */
 export type AmountOut = number | string;
 
 export type UniswapQuoteBuyExactlyRequest = {
@@ -188,31 +191,20 @@ export type UniswapQuoteBuyExactlyRequest = {
    */
   chain?: UniswapQuoteBuyExactlyChain | 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 to swap from.
    */
   tokenIn?: UniswapQuoteBuyExactlyTokenInToken | 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 to swap to.
    */
   tokenOut?: UniswapQuoteBuyExactlyTokenOutToken | undefined;
   /**
-   * The transaction fee of a Uniswap pool in bips.
-   *
-   * @remarks
-   *
-   * Uniswap supports 4 different fee levels.
+   * The fee to pay for the swap
    */
   fee?: UniswapQuoteBuyExactlyFeeEnum | undefined;
+  /**
+   * The amount of the token to swap to
+   */
   amountOut: number | string;
 };
 

package/src/models/operations/uniswapquotesellexactly.ts

@@ -180,6 +180,9 @@ export type UniswapQuoteSellExactlyFeeEnum = ClosedEnum<
   typeof UniswapQuoteSellExactlyFeeEnum
 >;
 
+/**
+ * The amount of the token to swap from
+ */
 export type AmountIn = number | string;
 
 export type UniswapQuoteSellExactlyRequest = {
@@ -188,31 +191,20 @@ export type UniswapQuoteSellExactlyRequest = {
    */
   chain?: UniswapQuoteSellExactlyChain | 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 to swap from.
    */
   tokenIn?: UniswapQuoteSellExactlyTokenInToken | 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 to swap to.
    */
   tokenOut?: UniswapQuoteSellExactlyTokenOutToken | undefined;
   /**
-   * The transaction fee of a Uniswap pool in bips.
-   *
-   * @remarks
-   *
-   * Uniswap supports 4 different fee levels.
+   * The fee to pay for the swap
    */
   fee?: UniswapQuoteSellExactlyFeeEnum | undefined;
+  /**
+   * The amount of the token to swap from
+   */
   amountIn: number | string;
 };