@compass-labs/api-sdk 0.0.23 → 0.0.25

package/src/models/components/morphowithdrawrequest.ts

@@ -5,9 +5,17 @@
 import * as z from "zod";
 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";
-import { Chain, Chain$inboundSchema, Chain$outboundSchema } from "./chain.js";
+
+export const MorphoWithdrawRequestChain = {
+  EthereumMainnet: "ethereum:mainnet",
+  BaseMainnet: "base:mainnet",
+} as const;
+export type MorphoWithdrawRequestChain = ClosedEnum<
+  typeof MorphoWithdrawRequestChain
+>;
 
 export type MorphoWithdrawRequest = {
   /**
@@ -22,16 +30,34 @@ export type MorphoWithdrawRequest = {
    * The address which will receive the tokens withdrawn. Defaults to the sender.
    */
   receiver?: string | null | undefined;
-  /**
-   * The chain to use.
-   */
-  chain: Chain;
+  chain: MorphoWithdrawRequestChain;
   /**
    * The address of the transaction sender.
    */
   sender: string;
 };
 
+/** @internal */
+export const MorphoWithdrawRequestChain$inboundSchema: z.ZodNativeEnum<
+  typeof MorphoWithdrawRequestChain
+> = z.nativeEnum(MorphoWithdrawRequestChain);
+
+/** @internal */
+export const MorphoWithdrawRequestChain$outboundSchema: z.ZodNativeEnum<
+  typeof MorphoWithdrawRequestChain
+> = MorphoWithdrawRequestChain$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace MorphoWithdrawRequestChain$ {
+  /** @deprecated use `MorphoWithdrawRequestChain$inboundSchema` instead. */
+  export const inboundSchema = MorphoWithdrawRequestChain$inboundSchema;
+  /** @deprecated use `MorphoWithdrawRequestChain$outboundSchema` instead. */
+  export const outboundSchema = MorphoWithdrawRequestChain$outboundSchema;
+}
+
 /** @internal */
 export const MorphoWithdrawRequest$inboundSchema: z.ZodType<
   MorphoWithdrawRequest,
@@ -41,7 +67,7 @@ export const MorphoWithdrawRequest$inboundSchema: z.ZodType<
   vault_address: z.string(),
   amount: z.any().optional(),
   receiver: z.nullable(z.string()).optional(),
-  chain: Chain$inboundSchema,
+  chain: MorphoWithdrawRequestChain$inboundSchema,
   sender: z.string(),
 }).transform((v) => {
   return remap$(v, {
@@ -67,7 +93,7 @@ export const MorphoWithdrawRequest$outboundSchema: z.ZodType<
   vaultAddress: z.string(),
   amount: z.any().optional(),
   receiver: z.nullable(z.string()).optional(),
-  chain: Chain$outboundSchema,
+  chain: MorphoWithdrawRequestChain$outboundSchema,
   sender: z.string(),
 }).transform((v) => {
   return remap$(v, {

package/src/models/components/redeemunderlying.ts

@@ -14,9 +14,32 @@ import {
 } from "./reserve.js";
 
 export type RedeemUnderlying = {
-  amount: 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;
+  /**
+   * Quantity of token
+   */
+  amount: number;
   reserve: Reserve;
-  assetPriceUSD: string;
+  /**
+   * Price of token in USD
+   */
+  assetPriceUSD: number;
+  /**
+   * The type of transaction
+   */
+  action: string;
+  block: number;
 };
 
 /** @internal */
@@ -25,16 +48,26 @@ export const RedeemUnderlying$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  amount: z.string(),
+  id: z.string(),
+  timestamp: z.number().int(),
+  txHash: z.string(),
+  amount: z.number(),
   reserve: Reserve$inboundSchema,
-  assetPriceUSD: z.string(),
+  assetPriceUSD: z.number(),
+  action: z.string(),
+  block: z.number().int(),
 });
 
 /** @internal */
 export type RedeemUnderlying$Outbound = {
-  amount: string;
+  id: string;
+  timestamp: number;
+  txHash: string;
+  amount: number;
   reserve: Reserve$Outbound;
-  assetPriceUSD: string;
+  assetPriceUSD: number;
+  action: string;
+  block: number;
 };
 
 /** @internal */
@@ -43,9 +76,14 @@ export const RedeemUnderlying$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   RedeemUnderlying
 > = z.object({
-  amount: z.string(),
+  id: z.string(),
+  timestamp: z.number().int(),
+  txHash: z.string(),
+  amount: z.number(),
   reserve: Reserve$outboundSchema,
-  assetPriceUSD: z.string(),
+  assetPriceUSD: z.number(),
+  action: z.string(),
+  block: z.number().int(),
 });
 
 /**

package/src/models/components/repay.ts

@@ -14,24 +14,54 @@ import {
 } from "./reserve.js";
 
 export type Repay = {
-  amount: 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;
+  /**
+   * Quantity of token
+   */
+  amount: number;
   reserve: Reserve;
-  assetPriceUSD: string;
+  assetPriceUSD: number;
+  /**
+   * The type of transaction
+   */
+  action?: "Repay" | undefined;
+  block: number;
 };
 
 /** @internal */
 export const Repay$inboundSchema: z.ZodType<Repay, z.ZodTypeDef, unknown> = z
   .object({
-    amount: z.string(),
+    id: z.string(),
+    timestamp: z.number().int(),
+    txHash: z.string(),
+    amount: z.number(),
     reserve: Reserve$inboundSchema,
-    assetPriceUSD: z.string(),
+    assetPriceUSD: z.number(),
+    action: z.literal("Repay").optional(),
+    block: z.number().int(),
   });
 
 /** @internal */
 export type Repay$Outbound = {
-  amount: string;
+  id: string;
+  timestamp: number;
+  txHash: string;
+  amount: number;
   reserve: Reserve$Outbound;
-  assetPriceUSD: string;
+  assetPriceUSD: number;
+  action: "Repay";
+  block: number;
 };
 
 /** @internal */
@@ -40,9 +70,14 @@ export const Repay$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   Repay
 > = z.object({
-  amount: z.string(),
+  id: z.string(),
+  timestamp: z.number().int(),
+  txHash: z.string(),
+  amount: z.number(),
   reserve: Reserve$outboundSchema,
-  assetPriceUSD: z.string(),
+  assetPriceUSD: z.number(),
+  action: z.literal("Repay").default("Repay" as const),
+  block: z.number().int(),
 });
 
 /**

package/src/models/components/reserve.ts

@@ -6,23 +6,51 @@ import * as z from "zod";
 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";
 
 export type Reserve = {
-  symbol: string;
-  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: TokenEnum;
+  /**
+   * Number of decimals of token.
+   */
+  decimals?: number | null | undefined;
+  /**
+   * Name of Token
+   */
+  name: string;
+  /**
+   * Checksum address of Token.
+   */
+  underlyingAsset: string;
 };
 
 /** @internal */
 export const Reserve$inboundSchema: z.ZodType<Reserve, z.ZodTypeDef, unknown> =
   z.object({
-    symbol: z.string(),
-    decimals: z.number().int(),
+    symbol: TokenEnum$inboundSchema,
+    decimals: z.nullable(z.number().int()).optional(),
+    name: z.string(),
+    underlyingAsset: z.string(),
   });
 
 /** @internal */
 export type Reserve$Outbound = {
   symbol: string;
-  decimals: number;
+  decimals?: number | null | undefined;
+  name: string;
+  underlyingAsset: string;
 };
 
 /** @internal */
@@ -31,8 +59,10 @@ export const Reserve$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   Reserve
 > = z.object({
-  symbol: z.string(),
-  decimals: z.number().int(),
+  symbol: TokenEnum$outboundSchema,
+  decimals: z.nullable(z.number().int()).optional(),
+  name: z.string(),
+  underlyingAsset: z.string(),
 });
 
 /**

package/src/models/components/supply.ts

@@ -14,24 +14,57 @@ import {
 } from "./reserve.js";
 
 export type Supply = {
-  amount: 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;
+  /**
+   * Quantity of token
+   */
+  amount: number;
   reserve: Reserve;
-  assetPriceUSD: string;
+  /**
+   * Price of token in USD
+   */
+  assetPriceUSD: number;
+  /**
+   * The type of transaction
+   */
+  action?: "Supply" | undefined;
+  block: number;
 };
 
 /** @internal */
 export const Supply$inboundSchema: z.ZodType<Supply, z.ZodTypeDef, unknown> = z
   .object({
-    amount: z.string(),
+    id: z.string(),
+    timestamp: z.number().int(),
+    txHash: z.string(),
+    amount: z.number(),
     reserve: Reserve$inboundSchema,
-    assetPriceUSD: z.string(),
+    assetPriceUSD: z.number(),
+    action: z.literal("Supply").optional(),
+    block: z.number().int(),
   });
 
 /** @internal */
 export type Supply$Outbound = {
-  amount: string;
+  id: string;
+  timestamp: number;
+  txHash: string;
+  amount: number;
   reserve: Reserve$Outbound;
-  assetPriceUSD: string;
+  assetPriceUSD: number;
+  action: "Supply";
+  block: number;
 };
 
 /** @internal */
@@ -40,9 +73,14 @@ export const Supply$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   Supply
 > = z.object({
-  amount: z.string(),
+  id: z.string(),
+  timestamp: z.number().int(),
+  txHash: z.string(),
+  amount: z.number(),
   reserve: Reserve$outboundSchema,
-  assetPriceUSD: z.string(),
+  assetPriceUSD: z.number(),
+  action: z.literal("Supply").default("Supply" as const),
+  block: z.number().int(),
 });
 
 /**

package/src/models/components/swapborrowrate.ts

@@ -14,11 +14,25 @@ import {
 } from "./reserve.js";
 
 export type SwapBorrowRate = {
-  borrowRateModeFrom: string;
-  borrowRateModeTo: string;
-  variableBorrowRate: string;
-  stableBorrowRate: 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;
+  borrowRateModeFrom: number;
+  borrowRateModeTo: number;
+  variableBorrowRate: number;
+  stableBorrowRate: number;
   reserve: Reserve;
+  action?: "SwapBorrowRate" | undefined;
+  block: number;
 };
 
 /** @internal */
@@ -27,20 +41,30 @@ export const SwapBorrowRate$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  borrowRateModeFrom: z.string(),
-  borrowRateModeTo: z.string(),
-  variableBorrowRate: z.string(),
-  stableBorrowRate: z.string(),
+  id: z.string(),
+  timestamp: z.number().int(),
+  txHash: z.string(),
+  borrowRateModeFrom: z.number().int(),
+  borrowRateModeTo: z.number().int(),
+  variableBorrowRate: z.number().int(),
+  stableBorrowRate: z.number().int(),
   reserve: Reserve$inboundSchema,
+  action: z.literal("SwapBorrowRate").optional(),
+  block: z.number().int(),
 });
 
 /** @internal */
 export type SwapBorrowRate$Outbound = {
-  borrowRateModeFrom: string;
-  borrowRateModeTo: string;
-  variableBorrowRate: string;
-  stableBorrowRate: string;
+  id: string;
+  timestamp: number;
+  txHash: string;
+  borrowRateModeFrom: number;
+  borrowRateModeTo: number;
+  variableBorrowRate: number;
+  stableBorrowRate: number;
   reserve: Reserve$Outbound;
+  action: "SwapBorrowRate";
+  block: number;
 };
 
 /** @internal */
@@ -49,11 +73,16 @@ export const SwapBorrowRate$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   SwapBorrowRate
 > = z.object({
-  borrowRateModeFrom: z.string(),
-  borrowRateModeTo: z.string(),
-  variableBorrowRate: z.string(),
-  stableBorrowRate: z.string(),
+  id: z.string(),
+  timestamp: z.number().int(),
+  txHash: z.string(),
+  borrowRateModeFrom: z.number().int(),
+  borrowRateModeTo: z.number().int(),
+  variableBorrowRate: z.number().int(),
+  stableBorrowRate: z.number().int(),
   reserve: Reserve$outboundSchema,
+  action: z.literal("SwapBorrowRate").default("SwapBorrowRate" as const),
+  block: z.number().int(),
 });
 
 /**

package/src/models/components/uniswapbuyexactlyparams.ts

@@ -21,7 +21,7 @@ import {
 /**
  * The amount of the token to swap to
  */
-export type UniswapBuyExactlyParamsAmountOut = number | string;
+export type UniswapBuyExactlyParamsAmount = number | string;
 
 export type UniswapBuyExactlyParams = {
   /**
@@ -53,7 +53,7 @@ export type UniswapBuyExactlyParams = {
   /**
    * 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.
    */
@@ -65,52 +65,52 @@ export type UniswapBuyExactlyParams = {
 };
 
 /** @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`,
   );
 }
 
@@ -123,14 +123,13 @@ export const UniswapBuyExactlyParams$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),
 }).transform((v) => {
   return remap$(v, {
     "token_in": "tokenIn",
     "token_out": "tokenOut",
-    "amount_out": "amountOut",
     "max_slippage_percent": "maxSlippagePercent",
     "wrap_eth": "wrapEth",
   });
@@ -141,7 +140,7 @@ export type UniswapBuyExactlyParams$Outbound = {
   token_in: string;
   token_out: string;
   fee: string;
-  amount_out: number | string;
+  amount: number | string;
   max_slippage_percent: number;
   wrap_eth: boolean;
 };
@@ -155,14 +154,13 @@ export const UniswapBuyExactlyParams$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),
 }).transform((v) => {
   return remap$(v, {
     tokenIn: "token_in",
     tokenOut: "token_out",
-    amountOut: "amount_out",
     maxSlippagePercent: "max_slippage_percent",
     wrapEth: "wrap_eth",
   });