@compass-labs/api-sdk 2.2.105-rc.0 → 2.2.106

package/src/models/components/dextokenref.ts

@@ -0,0 +1,66 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 { DexTokenKind, DexTokenKind$inboundSchema } from "./dextokenkind.js";
+import { PriceSource, PriceSource$inboundSchema } from "./pricesource.js";
+
+/**
+ * A token as every Risk Yield response describes it.
+ */
+export type DexTokenRef = {
+  address: string;
+  symbol?: string | null | undefined;
+  name?: string | null | undefined;
+  /**
+   * Null until read on chain; never assume 18 on this chain.
+   */
+  decimals?: number | null | undefined;
+  kind?: DexTokenKind | undefined;
+  priceUsd?: string | null | undefined;
+  priceSource?: PriceSource | null | undefined;
+  /**
+   * 0-1. Below 0.6 the USD figures derived from it are indicative only.
+   */
+  priceConfidence?: string | null | undefined;
+  stockTicker?: string | null | undefined;
+};
+
+/** @internal */
+export const DexTokenRef$inboundSchema: z.ZodType<
+  DexTokenRef,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  address: z.string(),
+  symbol: z.nullable(z.string()).optional(),
+  name: z.nullable(z.string()).optional(),
+  decimals: z.nullable(z.number().int()).optional(),
+  kind: DexTokenKind$inboundSchema.optional(),
+  price_usd: z.nullable(z.string()).optional(),
+  price_source: z.nullable(PriceSource$inboundSchema).optional(),
+  price_confidence: z.nullable(z.string()).optional(),
+  stock_ticker: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "price_usd": "priceUsd",
+    "price_source": "priceSource",
+    "price_confidence": "priceConfidence",
+    "stock_ticker": "stockTicker",
+  });
+});
+
+export function dexTokenRefFromJSON(
+  jsonString: string,
+): SafeParseResult<DexTokenRef, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DexTokenRef$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DexTokenRef' from JSON`,
+  );
+}

package/src/models/components/dextokensresponse.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 { DexTokenInfo, DexTokenInfo$inboundSchema } from "./dextokeninfo.js";
+
+export type DexTokensResponse = {
+  total: number;
+  offset: number;
+  limit: number;
+  tokens: Array<DexTokenInfo>;
+  /**
+   * When the indexer last restated these numbers.
+   */
+  statsUpdatedAt?: Date | null | undefined;
+};
+
+/** @internal */
+export const DexTokensResponse$inboundSchema: z.ZodType<
+  DexTokensResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  total: z.number().int(),
+  offset: z.number().int(),
+  limit: z.number().int(),
+  tokens: z.array(DexTokenInfo$inboundSchema),
+  stats_updated_at: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "stats_updated_at": "statsUpdatedAt",
+  });
+});
+
+export function dexTokensResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<DexTokensResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DexTokensResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DexTokensResponse' from JSON`,
+  );
+}

package/src/models/components/dexversion.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Which Uniswap deployment a pool belongs to.
+ *
+ * @remarks
+ *
+ * v3 pools hold their own tokens and pay LPs the fee tier. v4 pools live in a
+ * shared PoolManager and may route the fee through a hook, which is where the
+ * launchpad pools' zero LP yield comes from.
+ */
+export const DexVersion = {
+  V3: "V3",
+  V4: "V4",
+} as const;
+/**
+ * Which Uniswap deployment a pool belongs to.
+ *
+ * @remarks
+ *
+ * v3 pools hold their own tokens and pay LPs the fee tier. v4 pools live in a
+ * shared PoolManager and may route the fee through a hook, which is where the
+ * launchpad pools' zero LP yield comes from.
+ */
+export type DexVersion = ClosedEnum<typeof DexVersion>;
+
+/** @internal */
+export const DexVersion$inboundSchema: z.ZodNativeEnum<typeof DexVersion> = z
+  .nativeEnum(DexVersion);
+/** @internal */
+export const DexVersion$outboundSchema: z.ZodNativeEnum<typeof DexVersion> =
+  DexVersion$inboundSchema;

package/src/models/components/eulermarket.ts

@@ -52,6 +52,10 @@ export type EulerMarket = {
    * Current supply APY for this market (yield for supplying the asset), in percentage (e.g. 3.45 means 3.45%). Null if the rate is unavailable.
    */
   supplyApy?: string | null | undefined;
+  /**
+   * What the borrowable asset earns inside its own price, in percentage, trailing 7 days. Debt owed in such a token grows by this on top of borrow_apy — a borrower's true cost is their sum. Null means unmeasured, NOT zero.
+   */
+  intrinsicApy?: string | null | undefined;
   /**
    * Asset available to borrow right now (vault cash), in token units. A borrow larger than this reverts even if the account is healthy.
    */
@@ -68,6 +72,14 @@ export type EulerMarket = {
    * Borrowed share of supplied assets, in percentage 0-100.
    */
   utilization: string;
+  /**
+   * Total asset supplied to this market in USD (total_supply_assets priced by the shared request-time feed). Null when the price feed can't quote the asset — size in token units instead.
+   */
+  tvlUsd?: string | null | undefined;
+  /**
+   * Asset available to borrow right now in USD (available_liquidity priced by the shared request-time feed; vault cash equals supplied minus borrowed). Null when the price feed can't quote the asset.
+   */
+  liquidityUsd?: string | null | undefined;
   /**
    * Maximum total supply allowed, in token units. Null when the market is uncapped.
    */
@@ -97,10 +109,13 @@ export const EulerMarket$inboundSchema: z.ZodType<
   unit_of_account_symbol: z.nullable(z.string()).optional(),
   borrow_apy: z.nullable(z.string()).optional(),
   supply_apy: z.nullable(z.string()).optional(),
+  intrinsic_apy: z.nullable(z.string()).optional(),
   available_liquidity: z.string(),
   total_supply_assets: z.string(),
   total_borrow_assets: z.string(),
   utilization: z.string(),
+  tvl_usd: z.nullable(z.string()).optional(),
+  liquidity_usd: z.nullable(z.string()).optional(),
   supply_cap: z.nullable(z.string()).optional(),
   borrow_cap: z.nullable(z.string()).optional(),
   collaterals: z.array(EulerMarketCollateral$inboundSchema).optional(),
@@ -113,9 +128,12 @@ export const EulerMarket$inboundSchema: z.ZodType<
     "unit_of_account_symbol": "unitOfAccountSymbol",
     "borrow_apy": "borrowApy",
     "supply_apy": "supplyApy",
+    "intrinsic_apy": "intrinsicApy",
     "available_liquidity": "availableLiquidity",
     "total_supply_assets": "totalSupplyAssets",
     "total_borrow_assets": "totalBorrowAssets",
+    "tvl_usd": "tvlUsd",
+    "liquidity_usd": "liquidityUsd",
     "supply_cap": "supplyCap",
     "borrow_cap": "borrowCap",
   });

package/src/models/components/eulermarketcollateral.ts

@@ -44,6 +44,10 @@ export type EulerMarketCollateral = {
    * Current supply APY earned on this collateral while it backs a loan, in percentage (e.g. 3.5 means 3.5%). Null if the rate is unavailable.
    */
   supplyApy?: string | null | undefined;
+  /**
+   * What the collateral token earns inside its own price, in percentage: an ERC-4626 share's vault yield, a staking token's rewards, or an RWA token's NAV accrual, trailing 7 days. Earned on top of supply_apy — the collateral leg's whole yield is their sum. Null means unmeasured, NOT zero: a plain token (USDC, cbBTC) earns nothing and a yield-bearing one may simply not be indexed yet.
+   */
+  intrinsicApy?: string | null | undefined;
 };
 
 /** @internal */
@@ -60,6 +64,7 @@ export const EulerMarketCollateral$inboundSchema: z.ZodType<
   borrow_ltv: z.string(),
   liquidation_ltv: z.string(),
   supply_apy: z.nullable(z.string()).optional(),
+  intrinsic_apy: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
     "asset_symbol": "assetSymbol",
@@ -68,6 +73,7 @@ export const EulerMarketCollateral$inboundSchema: z.ZodType<
     "borrow_ltv": "borrowLtv",
     "liquidation_ltv": "liquidationLtv",
     "supply_apy": "supplyApy",
+    "intrinsic_apy": "intrinsicApy",
   });
 });
 

package/src/models/components/fullrange.ts

@@ -0,0 +1,30 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+/**
+ * The whole price range: never out of range, and never concentrated.
+ */
+export type FullRange = {
+  type: "full";
+};
+
+/** @internal */
+export type FullRange$Outbound = {
+  type: "full";
+};
+
+/** @internal */
+export const FullRange$outboundSchema: z.ZodType<
+  FullRange$Outbound,
+  z.ZodTypeDef,
+  FullRange
+> = z.object({
+  type: z.literal("full"),
+});
+
+export function fullRangeToJSON(fullRange: FullRange): string {
+  return JSON.stringify(FullRange$outboundSchema.parse(fullRange));
+}

package/src/models/components/index.ts

@@ -50,6 +50,7 @@ export * from "./batcheduseroperationsrequest.js";
 export * from "./batcheduseroperationsresponse.js";
 export * from "./borrow.js";
 export * from "./borrowabletoken.js";
+export * from "./bothsidesdeposit.js";
 export * from "./builder.js";
 export * from "./bundlertransactionresponse.js";
 export * from "./candle.js";
@@ -87,10 +88,14 @@ export * from "./compassapibackendv2modelssafetransactresponsebatchedsafeoperati
 export * from "./compassapibackendv2modelstokenizedassetsmarketmarket.js";
 export * from "./compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.js";
 export * from "./cooldownposition.js";
+export * from "./costbasis.js";
+export * from "./costbasissource.js";
 export * from "./createaccountrequest.js";
 export * from "./createaccountresponse.js";
 export * from "./createcreditaccountrequest.js";
 export * from "./createcreditaccountresponse.js";
+export * from "./createriskyieldaccountrequest.js";
+export * from "./createriskyieldaccountresponse.js";
 export * from "./createtokenizedassetsaccountrequest.js";
 export * from "./createtokenizedassetsaccountresponse.js";
 export * from "./creditbalancesresponse.js";
@@ -127,7 +132,16 @@ export * from "./debtposition.js";
 export * from "./depositevent.js";
 export * from "./depositforburnrequest.js";
 export * from "./depositforburnresponse.js";
+export * from "./depositplan.js";
 export * from "./details.js";
+export * from "./dexpooldetailresponse.js";
+export * from "./dexpoolinfo.js";
+export * from "./dexpoolsresponse.js";
+export * from "./dextokeninfo.js";
+export * from "./dextokenkind.js";
+export * from "./dextokenref.js";
+export * from "./dextokensresponse.js";
+export * from "./dexversion.js";
 export * from "./earnbalancesresponse.js";
 export * from "./earnmanageparams.js";
 export * from "./earnmanagerequest.js";
@@ -160,8 +174,12 @@ export * from "./eulermarketcollateral.js";
 export * from "./eulermarketsresponse.js";
 export * from "./fee.js";
 export * from "./feeenum.js";
+export * from "./fullrange.js";
 export * from "./interestratemode.js";
+export * from "./launchpad.js";
+export * from "./launchpadmetadata.js";
 export * from "./liquidationcall.js";
+export * from "./liquiditybucket.js";
 export * from "./listaavemarketsresponse.js";
 export * from "./loopedposition.js";
 export * from "./loopedpositioncurrentstate.js";
@@ -169,6 +187,7 @@ export * from "./loopedpositionhistoryentry.js";
 export * from "./loopedpositiontotals.js";
 export * from "./looplegpreview.js";
 export * from "./lpbalance.js";
+export * from "./lpposition.js";
 export * from "./marketallocation.js";
 export * from "./marketdetail.js";
 export * from "./marketposition.js";
@@ -212,6 +231,7 @@ export * from "./openposition.js";
 export * from "./operationtype.js";
 export * from "./orderstatus.js";
 export * from "./ordertosign.js";
+export * from "./pairclass.js";
 export * from "./pendledepositevent.js";
 export * from "./pendlegetmarketresponse.js";
 export * from "./pendlelistmarketsresponse.js";
@@ -267,13 +287,25 @@ export * from "./perpetualtradingsetleveragerequest.js";
 export * from "./perpetualtradingsetleverageresponse.js";
 export * from "./perpetualtradingsignableactionresponse.js";
 export * from "./perpetualtradingwithdrawrequest.js";
+export * from "./planstep.js";
+export * from "./planstepkind.js";
+export * from "./poolhourlypoint.js";
+export * from "./poolonchainstate.js";
+export * from "./poolselector.js";
 export * from "./portfolio.js";
 export * from "./positionpnl.js";
+export * from "./positionstatus.js";
 export * from "./pricepoint.js";
+export * from "./pricerange.js";
+export * from "./pricesource.js";
+export * from "./probabilisticoutlook.js";
 export * from "./protocol.js";
 export * from "./quote.js";
 export * from "./quotefee.js";
 export * from "./rebalancedirection.js";
+export * from "./rebalancephase.js";
+export * from "./rebalancereason.js";
+export * from "./rebalancestrategy.js";
 export * from "./rebalancetarget.js";
 export * from "./rebalancetargetpreview.js";
 export * from "./redemption.js";
@@ -281,6 +313,21 @@ export * from "./redemptionsresponse.js";
 export * from "./repay.js";
 export * from "./reserve.js";
 export * from "./reserveinfo.js";
+export * from "./resolvedrange.js";
+export * from "./riskassumptions.js";
+export * from "./riskscenariosrequest.js";
+export * from "./riskscenariosresponse.js";
+export * from "./riskyieldcollectrequest.js";
+export * from "./riskyielddecreaserequest.js";
+export * from "./riskyieldincreaserequest.js";
+export * from "./riskyieldliquidityresponse.js";
+export * from "./riskyieldmintrequest.js";
+export * from "./riskyieldpositionsresponse.js";
+export * from "./riskyieldrebalancerequest.js";
+export * from "./riskyieldrebalanceresponse.js";
+export * from "./riskyieldswaprequest.js";
+export * from "./riskyieldswapresponse.js";
+export * from "./riskyieldtransferrequest.js";
 export * from "./routingswappreview.js";
 export * from "./safemessageeip712response.js";
 export * from "./safemessageeip712types.js";
@@ -290,10 +337,14 @@ export * from "./safetransactionparams.js";
 export * from "./safetransactionresponse.js";
 export * from "./safetxfield.js";
 export * from "./safetxmessage.js";
+export * from "./scenarioinput.js";
+export * from "./scenarioresult.js";
 export * from "./security.js";
 export * from "./setallowanceparams.js";
 export * from "./setallowancerequest.js";
 export * from "./signedauthorization.js";
+export * from "./simulation.js";
+export * from "./singlesideddeposit.js";
 export * from "./skybuyparams.js";
 export * from "./skybuyrequest.js";
 export * from "./skycheckpositionresponse.js";
@@ -305,11 +356,16 @@ export * from "./skywithdrawparams.js";
 export * from "./skywithdrawrequest.js";
 export * from "./sponsorgasrequest.js";
 export * from "./sponsorgasresponse.js";
+export * from "./stockmetadata.js";
+export * from "./stockreference.js";
 export * from "./supply.js";
 export * from "./supportedchaininfo.js";
 export * from "./swapborrowrate.js";
 export * from "./swapinfo.js";
+export * from "./swapplan.js";
+export * from "./symmetricrange.js";
 export * from "./syposition.js";
+export * from "./tickrange.js";
 export * from "./tokenamount.js";
 export * from "./tokenbalanceresponse.js";
 export * from "./tokenconfig.js";
@@ -372,6 +428,7 @@ export * from "./unsignedtransaction.js";
 export * from "./unwrapwethparams.js";
 export * from "./unwrapwethrequest.js";
 export * from "./usageascollateral.js";
+export * from "./usddeposit.js";
 export * from "./useroperation.js";
 export * from "./useroperationresponse.js";
 export * from "./userstate.js";

package/src/models/components/launchpad.ts

@@ -0,0 +1,21 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const Launchpad = {
+  PonsV1: "PONS_V1",
+  PonsV2: "PONS_V2",
+  PoolsTrade: "POOLS_TRADE",
+  Bags: "BAGS",
+} as const;
+export type Launchpad = ClosedEnum<typeof Launchpad>;
+
+/** @internal */
+export const Launchpad$inboundSchema: z.ZodNativeEnum<typeof Launchpad> = z
+  .nativeEnum(Launchpad);
+/** @internal */
+export const Launchpad$outboundSchema: z.ZodNativeEnum<typeof Launchpad> =
+  Launchpad$inboundSchema;

package/src/models/components/launchpadmetadata.ts

@@ -0,0 +1,57 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 { Launchpad, Launchpad$inboundSchema } from "./launchpad.js";
+
+/**
+ * Where a memecoin came from, and whether it made it out of the curve.
+ */
+export type LaunchpadMetadata = {
+  launchpad: Launchpad;
+  /**
+   * CURVE (still bonding), GRADUATED (a tradable pool exists), or a wind-down state. Sweeping happens before graduation, so a swept launch that graduated is alive.
+   */
+  status: string;
+  pairToken?: string | null | undefined;
+  graduationPoolId?: number | null | undefined;
+  launchedAt?: Date | null | undefined;
+  creator?: string | null | undefined;
+};
+
+/** @internal */
+export const LaunchpadMetadata$inboundSchema: z.ZodType<
+  LaunchpadMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  launchpad: Launchpad$inboundSchema,
+  status: z.string(),
+  pair_token: z.nullable(z.string()).optional(),
+  graduation_pool_id: z.nullable(z.number().int()).optional(),
+  launched_at: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+  creator: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "pair_token": "pairToken",
+    "graduation_pool_id": "graduationPoolId",
+    "launched_at": "launchedAt",
+  });
+});
+
+export function launchpadMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<LaunchpadMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LaunchpadMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LaunchpadMetadata' from JSON`,
+  );
+}

package/src/models/components/liquiditybucket.ts

@@ -0,0 +1,62 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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";
+
+/**
+ * Active liquidity between two initialized ticks.
+ *
+ * @remarks
+ *
+ * This is the shape of the book. A range you open outside where the liquidity
+ * is will earn nothing while the price stays where it is; a range inside a
+ * wall of it earns a small share of a large pot.
+ */
+export type LiquidityBucket = {
+  tickLower: number;
+  tickUpper: number;
+  priceLower?: string | null | undefined;
+  priceUpper?: string | null | undefined;
+  liquidity: string;
+  /**
+   * Whether the pool's price sits in this bucket.
+   */
+  isCurrent?: boolean | undefined;
+};
+
+/** @internal */
+export const LiquidityBucket$inboundSchema: z.ZodType<
+  LiquidityBucket,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  tick_lower: z.number().int(),
+  tick_upper: z.number().int(),
+  price_lower: z.nullable(z.string()).optional(),
+  price_upper: z.nullable(z.string()).optional(),
+  liquidity: z.string(),
+  is_current: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "tick_lower": "tickLower",
+    "tick_upper": "tickUpper",
+    "price_lower": "priceLower",
+    "price_upper": "priceUpper",
+    "is_current": "isCurrent",
+  });
+});
+
+export function liquidityBucketFromJSON(
+  jsonString: string,
+): SafeParseResult<LiquidityBucket, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LiquidityBucket$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LiquidityBucket' from JSON`,
+  );
+}