@compass-labs/api-sdk 2.2.5 → 2.2.6

package/src/funcs/earnEarnBalances.ts

@@ -0,0 +1,182 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CompassApiSDKCore } from "../core.js";
+import { encodeFormQuery } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import { CompassAPISDKError } from "../models/errors/compassapisdkerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Get token balances
+ *
+ * @remarks
+ * Get token balances and transfer history for an earn account.
+ *
+ * Returns on-chain token balances for all tokens the earn account has interacted with,
+ * along with the complete transfer history for each token. Balances are keyed by token
+ * symbol for easy access.
+ *
+ * Use this endpoint to display account balances, track token movements, or build
+ * transaction history interfaces.
+ */
+export function earnEarnBalances(
+  client: CompassApiSDKCore,
+  request: operations.V2EarnBalancesRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.EarnBalancesResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CompassApiSDKCore,
+  request: operations.V2EarnBalancesRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.EarnBalancesResponse,
+      | errors.HTTPValidationError
+      | CompassAPISDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.V2EarnBalancesRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/v2/earn/balances")();
+
+  const query = encodeFormQuery({
+    "chain": payload.chain,
+    "owner": payload.owner,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKeyAuth);
+  const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "v2_earn_balances",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKeyAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["422", "4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    components.EarnBalancesResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.EarnBalancesResponse$inboundSchema),
+    M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/earnEarnPendleMarkets.ts

@@ -105,6 +105,7 @@ async function $do(
     "chain": payload.chain,
     "direction": payload.direction,
     "limit": payload.limit,
+    "min_tvl_usd": payload.min_tvl_usd,
     "offset": payload.offset,
     "order_by": payload.order_by,
     "underlying_symbol": payload.underlying_symbol,

package/src/funcs/earnEarnVaults.ts

@@ -102,6 +102,7 @@ async function $do(
     "chain": payload.chain,
     "direction": payload.direction,
     "limit": payload.limit,
+    "min_tvl_usd": payload.min_tvl_usd,
     "offset": payload.offset,
     "order_by": payload.order_by,
   });

package/src/lib/config.ts

@@ -62,7 +62,7 @@ export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.0.1",
   sdkVersion: "2.0.0",
-  genVersion: "2.799.0",
+  genVersion: "2.801.2",
   userAgent:
-    "speakeasy-sdk/typescript 2.0.0 2.799.0 0.0.1 @compass-labs/api-sdk",
+    "speakeasy-sdk/typescript 2.0.0 2.801.2 0.0.1 @compass-labs/api-sdk",
 } as const;

package/src/models/components/compassapibackendv2modelsearnreadresponsebalancestokenbalance.ts

@@ -0,0 +1,77 @@
+/*
+ * 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 { TokenTransfer, TokenTransfer$inboundSchema } from "./tokentransfer.js";
+
+/**
+ * Balance and transfer history for a single token.
+ */
+export type CompassApiBackendV2ModelsEarnReadResponseBalancesTokenBalance = {
+  /**
+   * The token contract address.
+   */
+  tokenAddress: string;
+  /**
+   * The token symbol (e.g., 'USDC').
+   */
+  tokenSymbol: string;
+  /**
+   * The token's decimal places.
+   */
+  tokenDecimals: number;
+  /**
+   * The current on-chain balance (raw).
+   */
+  balance: string;
+  /**
+   * The human-readable balance.
+   */
+  balanceFormatted: string;
+  /**
+   * List of all transfers involving this token.
+   */
+  transfers?: Array<TokenTransfer> | undefined;
+};
+
+/** @internal */
+export const CompassApiBackendV2ModelsEarnReadResponseBalancesTokenBalance$inboundSchema:
+  z.ZodType<
+    CompassApiBackendV2ModelsEarnReadResponseBalancesTokenBalance,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    token_address: z.string(),
+    token_symbol: z.string(),
+    token_decimals: z.number().int(),
+    balance: z.string(),
+    balance_formatted: z.string(),
+    transfers: z.array(TokenTransfer$inboundSchema).optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "token_address": "tokenAddress",
+      "token_symbol": "tokenSymbol",
+      "token_decimals": "tokenDecimals",
+      "balance_formatted": "balanceFormatted",
+    });
+  });
+
+export function compassApiBackendV2ModelsEarnReadResponseBalancesTokenBalanceFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  CompassApiBackendV2ModelsEarnReadResponseBalancesTokenBalance,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CompassApiBackendV2ModelsEarnReadResponseBalancesTokenBalance$inboundSchema
+        .parse(JSON.parse(x)),
+    `Failed to parse 'CompassApiBackendV2ModelsEarnReadResponseBalancesTokenBalance' from JSON`,
+  );
+}

package/src/models/components/earnbalancesresponse.ts

@@ -0,0 +1,55 @@
+/*
+ * 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 {
+  CompassApiBackendV2ModelsEarnReadResponseBalancesTokenBalance,
+  CompassApiBackendV2ModelsEarnReadResponseBalancesTokenBalance$inboundSchema,
+} from "./compassapibackendv2modelsearnreadresponsebalancestokenbalance.js";
+
+/**
+ * Response containing earn account balances and transfer history.
+ */
+export type EarnBalancesResponse = {
+  /**
+   * The derived earn account (Safe) address.
+   */
+  earnAccountAddress: string;
+  /**
+   * Token balances keyed by token symbol.
+   */
+  balances?: {
+    [k: string]: CompassApiBackendV2ModelsEarnReadResponseBalancesTokenBalance;
+  } | undefined;
+};
+
+/** @internal */
+export const EarnBalancesResponse$inboundSchema: z.ZodType<
+  EarnBalancesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  earn_account_address: z.string(),
+  balances: z.record(
+    CompassApiBackendV2ModelsEarnReadResponseBalancesTokenBalance$inboundSchema,
+  ).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "earn_account_address": "earnAccountAddress",
+  });
+});
+
+export function earnBalancesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<EarnBalancesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EarnBalancesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EarnBalancesResponse' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -69,6 +69,7 @@ export * from "./compassapibackendv1modelspendlereadresponsemarketuserposition.j
 export * from "./compassapibackendv1modelspendlereadresponsepositionstokenbalance.js";
 export * from "./compassapibackendv1modelsvaultsreadresponsevaultuserposition.js";
 export * from "./compassapibackendv1modelswildcatreadresponsemarketuserposition.js";
+export * from "./compassapibackendv2modelsearnreadresponsebalancestokenbalance.js";
 export * from "./compassapibackendv2modelsearnreadresponsepositionsvaultposition.js";
 export * from "./compassapibackendv2modelsgassponsorshippermit2typeddataeip712domain.js";
 export * from "./compassapibackendv2modelsgassponsorshippermit2typeddataeip712types.js";
@@ -83,6 +84,7 @@ export * from "./depositevent.js";
 export * from "./depositforburnrequest.js";
 export * from "./depositforburnresponse.js";
 export * from "./details.js";
+export * from "./earnbalancesresponse.js";
 export * from "./earnmanageparams.js";
 export * from "./earnmanagerequest.js";
 export * from "./earnmanageresponse.js";
@@ -210,6 +212,7 @@ export * from "./tokenlistresponse.js";
 export * from "./tokenmarketdata.js";
 export * from "./tokenpermissions.js";
 export * from "./tokenpriceresponse.js";
+export * from "./tokentransfer.js";
 export * from "./tokentransferparams.js";
 export * from "./tokentransferrequest.js";
 export * from "./transactionresponse.js";

package/src/models/components/tokentransfer.ts

@@ -0,0 +1,101 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Direction relative to the earn account: 'in' for received, 'out' for sent.
+ */
+export const Direction = {
+  In: "in",
+  Out: "out",
+} as const;
+/**
+ * Direction relative to the earn account: 'in' for received, 'out' for sent.
+ */
+export type Direction = ClosedEnum<typeof Direction>;
+
+/**
+ * A single ERC20 token transfer event.
+ */
+export type TokenTransfer = {
+  /**
+   * The address tokens were sent from.
+   */
+  fromAddress: string;
+  /**
+   * The address tokens were sent to.
+   */
+  toAddress: string;
+  /**
+   * The raw transfer amount (in token's smallest unit).
+   */
+  amount: string;
+  /**
+   * The human-readable transfer amount.
+   */
+  amountFormatted: string;
+  /**
+   * The block number of the transfer.
+   */
+  blockNumber: number;
+  /**
+   * The timestamp of the transfer.
+   */
+  blockTimestamp: Date;
+  /**
+   * The transaction hash of the transfer.
+   */
+  transactionHash: string;
+  /**
+   * Direction relative to the earn account: 'in' for received, 'out' for sent.
+   */
+  direction: Direction;
+};
+
+/** @internal */
+export const Direction$inboundSchema: z.ZodNativeEnum<typeof Direction> = z
+  .nativeEnum(Direction);
+
+/** @internal */
+export const TokenTransfer$inboundSchema: z.ZodType<
+  TokenTransfer,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  from_address: z.string(),
+  to_address: z.string(),
+  amount: z.string(),
+  amount_formatted: z.string(),
+  block_number: z.number().int(),
+  block_timestamp: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  transaction_hash: z.string(),
+  direction: Direction$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "from_address": "fromAddress",
+    "to_address": "toAddress",
+    "amount_formatted": "amountFormatted",
+    "block_number": "blockNumber",
+    "block_timestamp": "blockTimestamp",
+    "transaction_hash": "transactionHash",
+  });
+});
+
+export function tokenTransferFromJSON(
+  jsonString: string,
+): SafeParseResult<TokenTransfer, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TokenTransfer$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TokenTransfer' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -42,6 +42,7 @@ export * from "./v1vaultsvault.js";
 export * from "./v1wildcatmarket.js";
 export * from "./v2cctpmint.js";
 export * from "./v2earnaavemarkets.js";
+export * from "./v2earnbalances.js";
 export * from "./v2earnpendlemarkets.js";
 export * from "./v2earnpositions.js";
 export * from "./v2earnvaults.js";

package/src/models/operations/v2earnbalances.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const V2EarnBalancesChain = {
+  Arbitrum: "arbitrum",
+  Base: "base",
+  Ethereum: "ethereum",
+} as const;
+export type V2EarnBalancesChain = ClosedEnum<typeof V2EarnBalancesChain>;
+
+export type V2EarnBalancesRequest = {
+  chain: V2EarnBalancesChain;
+  /**
+   * The address of the owner of the earn account.
+   */
+  owner: string;
+};
+
+/** @internal */
+export const V2EarnBalancesChain$outboundSchema: z.ZodNativeEnum<
+  typeof V2EarnBalancesChain
+> = z.nativeEnum(V2EarnBalancesChain);
+
+/** @internal */
+export type V2EarnBalancesRequest$Outbound = {
+  chain: string;
+  owner: string;
+};
+
+/** @internal */
+export const V2EarnBalancesRequest$outboundSchema: z.ZodType<
+  V2EarnBalancesRequest$Outbound,
+  z.ZodTypeDef,
+  V2EarnBalancesRequest
+> = z.object({
+  chain: V2EarnBalancesChain$outboundSchema,
+  owner: z.string(),
+});
+
+export function v2EarnBalancesRequestToJSON(
+  v2EarnBalancesRequest: V2EarnBalancesRequest,
+): string {
+  return JSON.stringify(
+    V2EarnBalancesRequest$outboundSchema.parse(v2EarnBalancesRequest),
+  );
+}

package/src/models/operations/v2earnpendlemarkets.ts

@@ -21,6 +21,11 @@ export type V2EarnPendleMarketsDirection = ClosedEnum<
   typeof V2EarnPendleMarketsDirection
 >;
 
+/**
+ * Minimum TVL in USD. Markets with TVL below this value will be excluded.
+ */
+export type V2EarnPendleMarketsMinTvlUsd = number | string;
+
 export type V2EarnPendleMarketsRequest = {
   /**
    * The field to order the results by.
@@ -46,6 +51,10 @@ export type V2EarnPendleMarketsRequest = {
    * Filter markets by underlying asset symbol (e.g., 'USDC', 'WETH').
    */
   underlyingSymbol?: string | null | undefined;
+  /**
+   * Minimum TVL in USD. Markets with TVL below this value will be excluded.
+   */
+  minTvlUsd?: number | string | null | undefined;
 };
 
 /** @internal */
@@ -53,6 +62,26 @@ export const V2EarnPendleMarketsDirection$outboundSchema: z.ZodNativeEnum<
   typeof V2EarnPendleMarketsDirection
 > = z.nativeEnum(V2EarnPendleMarketsDirection);
 
+/** @internal */
+export type V2EarnPendleMarketsMinTvlUsd$Outbound = number | string;
+
+/** @internal */
+export const V2EarnPendleMarketsMinTvlUsd$outboundSchema: z.ZodType<
+  V2EarnPendleMarketsMinTvlUsd$Outbound,
+  z.ZodTypeDef,
+  V2EarnPendleMarketsMinTvlUsd
+> = z.union([z.number(), z.string()]);
+
+export function v2EarnPendleMarketsMinTvlUsdToJSON(
+  v2EarnPendleMarketsMinTvlUsd: V2EarnPendleMarketsMinTvlUsd,
+): string {
+  return JSON.stringify(
+    V2EarnPendleMarketsMinTvlUsd$outboundSchema.parse(
+      v2EarnPendleMarketsMinTvlUsd,
+    ),
+  );
+}
+
 /** @internal */
 export type V2EarnPendleMarketsRequest$Outbound = {
   order_by: string;
@@ -61,6 +90,7 @@ export type V2EarnPendleMarketsRequest$Outbound = {
   limit?: number | undefined;
   chain?: string | null | undefined;
   underlying_symbol?: string | null | undefined;
+  min_tvl_usd?: number | string | null | undefined;
 };
 
 /** @internal */
@@ -75,10 +105,12 @@ export const V2EarnPendleMarketsRequest$outboundSchema: z.ZodType<
   limit: z.number().int().optional(),
   chain: z.nullable(components.Chain$outboundSchema).optional(),
   underlyingSymbol: z.nullable(z.string()).optional(),
+  minTvlUsd: z.nullable(z.union([z.number(), z.string()])).optional(),
 }).transform((v) => {
   return remap$(v, {
     orderBy: "order_by",
     underlyingSymbol: "underlying_symbol",
+    minTvlUsd: "min_tvl_usd",
   });
 });
 

package/src/models/operations/v2earnvaults.ts

@@ -19,6 +19,11 @@ export const V2EarnVaultsDirection = {
  */
 export type V2EarnVaultsDirection = ClosedEnum<typeof V2EarnVaultsDirection>;
 
+/**
+ * Minimum TVL in USD. Vaults with TVL below this value will be excluded.
+ */
+export type V2EarnVaultsMinTvlUsd = number | string;
+
 export type V2EarnVaultsRequest = {
   /**
    * The field to order the results by.
@@ -44,6 +49,10 @@ export type V2EarnVaultsRequest = {
    * Filter vaults by underlying asset symbol (e.g., 'USDC', 'WETH').
    */
   assetSymbol?: string | null | undefined;
+  /**
+   * Minimum TVL in USD. Vaults with TVL below this value will be excluded.
+   */
+  minTvlUsd?: number | string | null | undefined;
 };
 
 /** @internal */
@@ -51,6 +60,24 @@ export const V2EarnVaultsDirection$outboundSchema: z.ZodNativeEnum<
   typeof V2EarnVaultsDirection
 > = z.nativeEnum(V2EarnVaultsDirection);
 
+/** @internal */
+export type V2EarnVaultsMinTvlUsd$Outbound = number | string;
+
+/** @internal */
+export const V2EarnVaultsMinTvlUsd$outboundSchema: z.ZodType<
+  V2EarnVaultsMinTvlUsd$Outbound,
+  z.ZodTypeDef,
+  V2EarnVaultsMinTvlUsd
+> = z.union([z.number(), z.string()]);
+
+export function v2EarnVaultsMinTvlUsdToJSON(
+  v2EarnVaultsMinTvlUsd: V2EarnVaultsMinTvlUsd,
+): string {
+  return JSON.stringify(
+    V2EarnVaultsMinTvlUsd$outboundSchema.parse(v2EarnVaultsMinTvlUsd),
+  );
+}
+
 /** @internal */
 export type V2EarnVaultsRequest$Outbound = {
   order_by: string;
@@ -59,6 +86,7 @@ export type V2EarnVaultsRequest$Outbound = {
   limit?: number | undefined;
   chain?: string | null | undefined;
   asset_symbol?: string | null | undefined;
+  min_tvl_usd?: number | string | null | undefined;
 };
 
 /** @internal */
@@ -73,10 +101,12 @@ export const V2EarnVaultsRequest$outboundSchema: z.ZodType<
   limit: z.number().int().optional(),
   chain: z.nullable(components.Chain$outboundSchema).optional(),
   assetSymbol: z.nullable(z.string()).optional(),
+  minTvlUsd: z.nullable(z.union([z.number(), z.string()])).optional(),
 }).transform((v) => {
   return remap$(v, {
     orderBy: "order_by",
     assetSymbol: "asset_symbol",
+    minTvlUsd: "min_tvl_usd",
   });
 });