@compass-labs/api-sdk 2.2.19 → 2.2.20-rc.0

package/src/models/components/createcreditaccountresponse.ts

@@ -0,0 +1,51 @@
+/*
+ * 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 {
+  UnsignedTransaction,
+  UnsignedTransaction$inboundSchema,
+} from "./unsignedtransaction.js";
+
+/**
+ * Response containing unsigned transaction to create compass Credit account.
+ */
+export type CreateCreditAccountResponse = {
+  /**
+   * Transaction to create compass credit account
+   */
+  transaction: UnsignedTransaction | null;
+  /**
+   * Predicted address of the compass credit account that will be deployed
+   */
+  creditAccountAddress: string;
+};
+
+/** @internal */
+export const CreateCreditAccountResponse$inboundSchema: z.ZodType<
+  CreateCreditAccountResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  transaction: z.nullable(UnsignedTransaction$inboundSchema),
+  credit_account_address: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "credit_account_address": "creditAccountAddress",
+  });
+});
+
+export function createCreditAccountResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateCreditAccountResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateCreditAccountResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateCreditAccountResponse' from JSON`,
+  );
+}

package/src/models/components/creditborrowparams.ts

@@ -0,0 +1,89 @@
+/*
+ * 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 {
+  InterestRateMode,
+  InterestRateMode$outboundSchema,
+} from "./interestratemode.js";
+
+/**
+ * Amount in token units to borrow.
+ */
+export type CreditBorrowParamsAmount = number | string;
+
+/**
+ * Borrow from Aave via Credit Account.
+ */
+export type CreditBorrowParams = {
+  actionType: "CREDIT_BORROW";
+  /**
+   * Token to borrow from Aave.
+   */
+  token: string;
+  /**
+   * Amount in token units to borrow.
+   */
+  amount: number | string;
+  /**
+   * On AAVE there are 2 different interest modes.
+   *
+   * @remarks
+   *
+   * A stable (but typically higher rate), or a variable rate.
+   */
+  interestRateMode?: InterestRateMode | undefined;
+};
+
+/** @internal */
+export type CreditBorrowParamsAmount$Outbound = number | string;
+
+/** @internal */
+export const CreditBorrowParamsAmount$outboundSchema: z.ZodType<
+  CreditBorrowParamsAmount$Outbound,
+  z.ZodTypeDef,
+  CreditBorrowParamsAmount
+> = z.union([z.number(), z.string()]);
+
+export function creditBorrowParamsAmountToJSON(
+  creditBorrowParamsAmount: CreditBorrowParamsAmount,
+): string {
+  return JSON.stringify(
+    CreditBorrowParamsAmount$outboundSchema.parse(creditBorrowParamsAmount),
+  );
+}
+
+/** @internal */
+export type CreditBorrowParams$Outbound = {
+  action_type: "CREDIT_BORROW";
+  token: string;
+  amount: number | string;
+  interest_rate_mode?: string | undefined;
+};
+
+/** @internal */
+export const CreditBorrowParams$outboundSchema: z.ZodType<
+  CreditBorrowParams$Outbound,
+  z.ZodTypeDef,
+  CreditBorrowParams
+> = z.object({
+  actionType: z.literal("CREDIT_BORROW"),
+  token: z.string(),
+  amount: z.union([z.number(), z.string()]),
+  interestRateMode: InterestRateMode$outboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    actionType: "action_type",
+    interestRateMode: "interest_rate_mode",
+  });
+});
+
+export function creditBorrowParamsToJSON(
+  creditBorrowParams: CreditBorrowParams,
+): string {
+  return JSON.stringify(
+    CreditBorrowParams$outboundSchema.parse(creditBorrowParams),
+  );
+}

package/src/models/components/creditborrowrequest.ts

@@ -0,0 +1,198 @@
+/*
+ * 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 { Chain, Chain$outboundSchema } from "./chain.js";
+import {
+  InterestRateMode,
+  InterestRateMode$outboundSchema,
+} from "./interestratemode.js";
+
+/**
+ * Amount of token_in to use (in token units, not wei).
+ */
+export type CreditBorrowRequestAmountIn = number | string;
+
+/**
+ * Amount to borrow (in token units, not wei).
+ */
+export type BorrowAmount = number | string;
+
+/**
+ * Maximum slippage tolerance as a percentage (e.g., 0.5 = 0.5%). Only used when a swap is needed.
+ */
+export type CreditBorrowRequestSlippage = number | string;
+
+export type CreditBorrowRequest = {
+  /**
+   * The address that owns the Credit Account.
+   */
+  owner: string;
+  /**
+   * The chain to use.
+   */
+  chain: Chain;
+  /**
+   * Token currently held in the Credit Account to use as input. If the same as collateral_token, no swap is performed.
+   */
+  tokenIn: string;
+  /**
+   * Amount of token_in to use (in token units, not wei).
+   */
+  amountIn: number | string;
+  /**
+   * Aave reserve token to supply as collateral.
+   */
+  collateralToken: string;
+  /**
+   * Asset to borrow from Aave.
+   */
+  borrowToken: string;
+  /**
+   * Amount to borrow (in token units, not wei).
+   */
+  borrowAmount: number | string;
+  /**
+   * On AAVE there are 2 different interest modes.
+   *
+   * @remarks
+   *
+   * A stable (but typically higher rate), or a variable rate.
+   */
+  interestRateMode?: InterestRateMode | undefined;
+  /**
+   * Maximum slippage tolerance as a percentage (e.g., 0.5 = 0.5%). Only used when a swap is needed.
+   */
+  slippage?: number | string | undefined;
+  /**
+   * If true, returns EIP-712 signature data instead of an unsigned transaction.
+   */
+  gasSponsorship?: boolean | undefined;
+  /**
+   * The EOA owner's signature of the Permit2 PermitTransferFrom typed data. When provided, the borrow bundle will first pull token_in from the owner's EOA into the Credit Account via Permit2. Obtain by calling /v2/credit/transfer and signing the returned EIP-712 data.
+   */
+  permit2Signature?: string | null | undefined;
+  /**
+   * The nonce used in the Permit2 signature (from the signed typed data).
+   */
+  permit2Nonce?: number | null | undefined;
+  /**
+   * The deadline timestamp used in the Permit2 signature (from the signed typed data).
+   */
+  permit2Deadline?: number | null | undefined;
+};
+
+/** @internal */
+export type CreditBorrowRequestAmountIn$Outbound = number | string;
+
+/** @internal */
+export const CreditBorrowRequestAmountIn$outboundSchema: z.ZodType<
+  CreditBorrowRequestAmountIn$Outbound,
+  z.ZodTypeDef,
+  CreditBorrowRequestAmountIn
+> = z.union([z.number(), z.string()]);
+
+export function creditBorrowRequestAmountInToJSON(
+  creditBorrowRequestAmountIn: CreditBorrowRequestAmountIn,
+): string {
+  return JSON.stringify(
+    CreditBorrowRequestAmountIn$outboundSchema.parse(
+      creditBorrowRequestAmountIn,
+    ),
+  );
+}
+
+/** @internal */
+export type BorrowAmount$Outbound = number | string;
+
+/** @internal */
+export const BorrowAmount$outboundSchema: z.ZodType<
+  BorrowAmount$Outbound,
+  z.ZodTypeDef,
+  BorrowAmount
+> = z.union([z.number(), z.string()]);
+
+export function borrowAmountToJSON(borrowAmount: BorrowAmount): string {
+  return JSON.stringify(BorrowAmount$outboundSchema.parse(borrowAmount));
+}
+
+/** @internal */
+export type CreditBorrowRequestSlippage$Outbound = number | string;
+
+/** @internal */
+export const CreditBorrowRequestSlippage$outboundSchema: z.ZodType<
+  CreditBorrowRequestSlippage$Outbound,
+  z.ZodTypeDef,
+  CreditBorrowRequestSlippage
+> = z.union([z.number(), z.string()]);
+
+export function creditBorrowRequestSlippageToJSON(
+  creditBorrowRequestSlippage: CreditBorrowRequestSlippage,
+): string {
+  return JSON.stringify(
+    CreditBorrowRequestSlippage$outboundSchema.parse(
+      creditBorrowRequestSlippage,
+    ),
+  );
+}
+
+/** @internal */
+export type CreditBorrowRequest$Outbound = {
+  owner: string;
+  chain: string;
+  token_in: string;
+  amount_in: number | string;
+  collateral_token: string;
+  borrow_token: string;
+  borrow_amount: number | string;
+  interest_rate_mode?: string | undefined;
+  slippage?: number | string | undefined;
+  gas_sponsorship?: boolean | undefined;
+  permit2_signature?: string | null | undefined;
+  permit2_nonce?: number | null | undefined;
+  permit2_deadline?: number | null | undefined;
+};
+
+/** @internal */
+export const CreditBorrowRequest$outboundSchema: z.ZodType<
+  CreditBorrowRequest$Outbound,
+  z.ZodTypeDef,
+  CreditBorrowRequest
+> = z.object({
+  owner: z.string(),
+  chain: Chain$outboundSchema,
+  tokenIn: z.string(),
+  amountIn: z.union([z.number(), z.string()]),
+  collateralToken: z.string(),
+  borrowToken: z.string(),
+  borrowAmount: z.union([z.number(), z.string()]),
+  interestRateMode: InterestRateMode$outboundSchema.optional(),
+  slippage: z.union([z.number(), z.string()]).optional(),
+  gasSponsorship: z.boolean().optional(),
+  permit2Signature: z.nullable(z.string()).optional(),
+  permit2Nonce: z.nullable(z.number().int()).optional(),
+  permit2Deadline: z.nullable(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    tokenIn: "token_in",
+    amountIn: "amount_in",
+    collateralToken: "collateral_token",
+    borrowToken: "borrow_token",
+    borrowAmount: "borrow_amount",
+    interestRateMode: "interest_rate_mode",
+    gasSponsorship: "gas_sponsorship",
+    permit2Signature: "permit2_signature",
+    permit2Nonce: "permit2_nonce",
+    permit2Deadline: "permit2_deadline",
+  });
+});
+
+export function creditBorrowRequestToJSON(
+  creditBorrowRequest: CreditBorrowRequest,
+): string {
+  return JSON.stringify(
+    CreditBorrowRequest$outboundSchema.parse(creditBorrowRequest),
+  );
+}

package/src/models/components/creditborrowresponse.ts

@@ -0,0 +1,59 @@
+/*
+ * 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 {
+  BatchedSafeOperationsResponseOutput,
+  BatchedSafeOperationsResponseOutput$inboundSchema,
+} from "./batchedsafeoperationsresponseoutput.js";
+import {
+  UnsignedTransaction,
+  UnsignedTransaction$inboundSchema,
+} from "./unsignedtransaction.js";
+
+export type CreditBorrowResponse = {
+  /**
+   * Unsigned transaction to execute the borrow bundle. Present when gas_sponsorship is false.
+   */
+  transaction?: UnsignedTransaction | null | undefined;
+  /**
+   * EIP-712 typed data for gas-sponsored execution. Present when gas_sponsorship is true.
+   */
+  eip712?: BatchedSafeOperationsResponseOutput | null | undefined;
+  /**
+   * Estimated amount of collateral token received from swap. Only present when token_in differs from collateral_token.
+   */
+  estimatedCollateralAmount?: string | null | undefined;
+};
+
+/** @internal */
+export const CreditBorrowResponse$inboundSchema: z.ZodType<
+  CreditBorrowResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  transaction: z.nullable(UnsignedTransaction$inboundSchema).optional(),
+  eip_712: z.nullable(BatchedSafeOperationsResponseOutput$inboundSchema)
+    .optional(),
+  estimated_collateral_amount: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "eip_712": "eip712",
+    "estimated_collateral_amount": "estimatedCollateralAmount",
+  });
+});
+
+export function creditBorrowResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CreditBorrowResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreditBorrowResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreditBorrowResponse' from JSON`,
+  );
+}

package/src/models/components/creditbundlerequest.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 { Chain, Chain$outboundSchema } from "./chain.js";
+import {
+  CreditUserOperation,
+  CreditUserOperation$Outbound,
+  CreditUserOperation$outboundSchema,
+} from "./credituseroperation.js";
+
+/**
+ * Request to execute multiple credit actions in a single atomic transaction.
+ */
+export type CreditBundleRequest = {
+  /**
+   * The owner's wallet address that controls the Credit Account.
+   */
+  owner: string;
+  /**
+   * The chain to use.
+   */
+  chain: Chain;
+  /**
+   * List of actions to bundle. Actions are executed in order.
+   */
+  actions: Array<CreditUserOperation>;
+  /**
+   * If true, returns EIP-712 typed data for gas-sponsored execution.
+   */
+  gasSponsorship?: boolean | undefined;
+};
+
+/** @internal */
+export type CreditBundleRequest$Outbound = {
+  owner: string;
+  chain: string;
+  actions: Array<CreditUserOperation$Outbound>;
+  gas_sponsorship?: boolean | undefined;
+};
+
+/** @internal */
+export const CreditBundleRequest$outboundSchema: z.ZodType<
+  CreditBundleRequest$Outbound,
+  z.ZodTypeDef,
+  CreditBundleRequest
+> = z.object({
+  owner: z.string(),
+  chain: Chain$outboundSchema,
+  actions: z.array(CreditUserOperation$outboundSchema),
+  gasSponsorship: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    gasSponsorship: "gas_sponsorship",
+  });
+});
+
+export function creditBundleRequestToJSON(
+  creditBundleRequest: CreditBundleRequest,
+): string {
+  return JSON.stringify(
+    CreditBundleRequest$outboundSchema.parse(creditBundleRequest),
+  );
+}

package/src/models/components/creditbundleresponse.ts

@@ -0,0 +1,59 @@
+/*
+ * 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 {
+  BatchedSafeOperationsResponseOutput,
+  BatchedSafeOperationsResponseOutput$inboundSchema,
+} from "./batchedsafeoperationsresponseoutput.js";
+import {
+  UnsignedTransaction,
+  UnsignedTransaction$inboundSchema,
+} from "./unsignedtransaction.js";
+
+export type CreditBundleResponse = {
+  /**
+   * Unsigned transaction for direct execution by the owner. Present when gas_sponsorship=false.
+   */
+  transaction?: UnsignedTransaction | null | undefined;
+  /**
+   * EIP-712 typed data for gas-sponsored execution. Present when gas_sponsorship=true. Owner must sign and submit to /gas_sponsorship/prepare.
+   */
+  eip712?: BatchedSafeOperationsResponseOutput | null | undefined;
+  /**
+   * Number of individual transactions bundled in this execution.
+   */
+  actionsCount: number;
+};
+
+/** @internal */
+export const CreditBundleResponse$inboundSchema: z.ZodType<
+  CreditBundleResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  transaction: z.nullable(UnsignedTransaction$inboundSchema).optional(),
+  eip_712: z.nullable(BatchedSafeOperationsResponseOutput$inboundSchema)
+    .optional(),
+  actions_count: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    "eip_712": "eip712",
+    "actions_count": "actionsCount",
+  });
+});
+
+export function creditBundleResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CreditBundleResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreditBundleResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreditBundleResponse' from JSON`,
+  );
+}

package/src/models/components/creditevent.ts

@@ -0,0 +1,92 @@
+/*
+ * 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";
+
+/**
+ * Type of credit event.
+ */
+export const EventType = {
+  Supply: "supply",
+  Withdraw: "withdraw",
+  Borrow: "borrow",
+  Repay: "repay",
+  Liquidation: "liquidation",
+} as const;
+/**
+ * Type of credit event.
+ */
+export type EventType = ClosedEnum<typeof EventType>;
+
+/**
+ * A single historical event in a credit position.
+ */
+export type CreditEvent = {
+  /**
+   * Type of credit event.
+   */
+  eventType: EventType;
+  /**
+   * Block number when the event occurred
+   */
+  blockNumber: number;
+  /**
+   * Timestamp when the event occurred
+   */
+  blockTimestamp: Date;
+  /**
+   * Transaction hash of the event
+   */
+  transactionHash: string;
+  /**
+   * Amount involved in the event
+   */
+  amount: string;
+  /**
+   * Symbol of the token
+   */
+  symbol: string;
+};
+
+/** @internal */
+export const EventType$inboundSchema: z.ZodNativeEnum<typeof EventType> = z
+  .nativeEnum(EventType);
+
+/** @internal */
+export const CreditEvent$inboundSchema: z.ZodType<
+  CreditEvent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  event_type: EventType$inboundSchema,
+  block_number: z.number().int(),
+  block_timestamp: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  transaction_hash: z.string(),
+  amount: z.string(),
+  symbol: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "event_type": "eventType",
+    "block_number": "blockNumber",
+    "block_timestamp": "blockTimestamp",
+    "transaction_hash": "transactionHash",
+  });
+});
+
+export function creditEventFromJSON(
+  jsonString: string,
+): SafeParseResult<CreditEvent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreditEvent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreditEvent' from JSON`,
+  );
+}

package/src/models/components/creditpositionsresponse.ts

@@ -0,0 +1,79 @@
+/*
+ * 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 {
+  AccountSummary,
+  AccountSummary$inboundSchema,
+} from "./accountsummary.js";
+import {
+  BorrowableToken,
+  BorrowableToken$inboundSchema,
+} from "./borrowabletoken.js";
+import {
+  CollateralPosition,
+  CollateralPosition$inboundSchema,
+} from "./collateralposition.js";
+import { DebtPosition, DebtPosition$inboundSchema } from "./debtposition.js";
+
+/**
+ * Credit account positions response with per-reserve positions and account summary.
+ */
+export type CreditPositionsResponse = {
+  /**
+   * All collateral positions, one per reserve.
+   */
+  collateralPositions?: Array<CollateralPosition> | undefined;
+  /**
+   * All debt positions, one per reserve.
+   */
+  debtPositions?: Array<DebtPosition> | undefined;
+  /**
+   * Aave account-level summary from getUserAccountData().
+   */
+  accountSummary: AccountSummary;
+  /**
+   * All tokens available for borrowing with max amounts based on current collateral.
+   */
+  borrowableTokens?: Array<BorrowableToken> | undefined;
+  /**
+   * Net position value in USD (total collateral - total debt). Null if prices unavailable.
+   */
+  totalUsdValue?: string | null | undefined;
+};
+
+/** @internal */
+export const CreditPositionsResponse$inboundSchema: z.ZodType<
+  CreditPositionsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  collateral_positions: z.array(CollateralPosition$inboundSchema).optional(),
+  debt_positions: z.array(DebtPosition$inboundSchema).optional(),
+  account_summary: AccountSummary$inboundSchema,
+  borrowable_tokens: z.array(BorrowableToken$inboundSchema).optional(),
+  total_usd_value: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "collateral_positions": "collateralPositions",
+    "debt_positions": "debtPositions",
+    "account_summary": "accountSummary",
+    "borrowable_tokens": "borrowableTokens",
+    "total_usd_value": "totalUsdValue",
+  });
+});
+
+export function creditPositionsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CreditPositionsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreditPositionsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreditPositionsResponse' from JSON`,
+  );
+}