@compass-labs/api-sdk 2.1.26-rc.0 → 2.1.26-rc.10

package/src/models/components/positionpnl.ts

@@ -0,0 +1,93 @@
+/*
+ * 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 { DepositEvent, DepositEvent$inboundSchema } from "./depositevent.js";
+import {
+  WithdrawalEvent,
+  WithdrawalEvent$inboundSchema,
+} from "./withdrawalevent.js";
+
+/**
+ * PnL breakdown for a position.
+ */
+export type PositionPnL = {
+  /**
+   * Total assets deposited over all time
+   */
+  totalDeposited: string;
+  /**
+   * Total assets withdrawn over all time
+   */
+  totalWithdrawn: string;
+  /**
+   * FIFO cost basis of remaining position
+   */
+  costBasis: string;
+  /**
+   * current_value - cost_basis
+   */
+  unrealizedPnl: string;
+  /**
+   * Sum of profits/losses from all withdrawals
+   */
+  realizedPnl: string;
+  /**
+   * unrealized_pnl + realized_pnl
+   */
+  totalYield: string;
+  /**
+   * Sum of performance fees paid
+   */
+  totalFeesPaid: string;
+  /**
+   * All deposit events for this position
+   */
+  deposits?: Array<DepositEvent> | undefined;
+  /**
+   * All withdrawal events for this position
+   */
+  withdrawals?: Array<WithdrawalEvent> | undefined;
+};
+
+/** @internal */
+export const PositionPnL$inboundSchema: z.ZodType<
+  PositionPnL,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  total_deposited: z.string(),
+  total_withdrawn: z.string(),
+  cost_basis: z.string(),
+  unrealized_pnl: z.string(),
+  realized_pnl: z.string(),
+  total_yield: z.string(),
+  total_fees_paid: z.string(),
+  deposits: z.array(DepositEvent$inboundSchema).optional(),
+  withdrawals: z.array(WithdrawalEvent$inboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "total_deposited": "totalDeposited",
+    "total_withdrawn": "totalWithdrawn",
+    "cost_basis": "costBasis",
+    "unrealized_pnl": "unrealizedPnl",
+    "realized_pnl": "realizedPnl",
+    "total_yield": "totalYield",
+    "total_fees_paid": "totalFeesPaid",
+  });
+});
+
+export function positionPnLFromJSON(
+  jsonString: string,
+): SafeParseResult<PositionPnL, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PositionPnL$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PositionPnL' from JSON`,
+  );
+}

package/src/models/components/withdrawalevent.ts

@@ -0,0 +1,78 @@
+/*
+ * 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";
+
+/**
+ * Historical withdrawal event with realized PnL.
+ */
+export type WithdrawalEvent = {
+  /**
+   * Block number when withdrawal occurred
+   */
+  blockNumber: number;
+  /**
+   * Transaction hash of the withdrawal
+   */
+  transactionHash: string;
+  /**
+   * Amount of underlying asset received
+   */
+  assetsReceived: string;
+  /**
+   * Shares (vault) or aTokens (Aave) burned
+   */
+  unitsWithdrawn: string;
+  /**
+   * FIFO cost basis of units withdrawn
+   */
+  costBasisConsumed: string;
+  /**
+   * Profit/loss: assets_received - cost_basis_consumed
+   */
+  realizedPnl: string;
+  /**
+   * Performance fee charged on this withdrawal
+   */
+  feeCharged: string;
+};
+
+/** @internal */
+export const WithdrawalEvent$inboundSchema: z.ZodType<
+  WithdrawalEvent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  block_number: z.number().int(),
+  transaction_hash: z.string(),
+  assets_received: z.string(),
+  units_withdrawn: z.string(),
+  cost_basis_consumed: z.string(),
+  realized_pnl: z.string(),
+  fee_charged: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "block_number": "blockNumber",
+    "transaction_hash": "transactionHash",
+    "assets_received": "assetsReceived",
+    "units_withdrawn": "unitsWithdrawn",
+    "cost_basis_consumed": "costBasisConsumed",
+    "realized_pnl": "realizedPnl",
+    "fee_charged": "feeCharged",
+  });
+});
+
+export function withdrawalEventFromJSON(
+  jsonString: string,
+): SafeParseResult<WithdrawalEvent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => WithdrawalEvent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WithdrawalEvent' from JSON`,
+  );
+}

package/src/models/operations/v2earnpositions.ts

@@ -27,10 +27,6 @@ export type V2EarnPositionsRequest = {
    * The address of the user to get vault positions for.
    */
   userAddress: string;
-  /**
-   * How many days back from the current time to include in the blockchain scan.
-   */
-  days?: number | undefined;
 };
 
 /** @internal */
@@ -44,7 +40,6 @@ export type V2EarnPositionsRequest$Outbound = {
   limit?: number | undefined;
   chain: string;
   user_address: string;
-  days?: number | undefined;
 };
 
 /** @internal */
@@ -57,7 +52,6 @@ export const V2EarnPositionsRequest$outboundSchema: z.ZodType<
   limit: z.number().int().optional(),
   chain: V2EarnPositionsChain$outboundSchema,
   userAddress: z.string(),
-  days: z.number().int().optional(),
 }).transform((v) => {
   return remap$(v, {
     userAddress: "user_address",

package/src/sdk/earn.ts

@@ -20,7 +20,7 @@ export class Earn extends ClientSDK {
    * List earn positions
    *
    * @remarks
-   * This endpoint fetches all Compass Earn positions.
+   * This endpoint fetches all Compass Earn positions with PnL information.
    */
   async earnPositions(
     request: operations.V2EarnPositionsRequest,
@@ -145,7 +145,10 @@ export class Earn extends ClientSDK {
    *
    * If `WITHDRAW` is selected for `action`, tokens will be withdrawn from the selected venue address back into the Earn Account associated with the `owner` wallet.
    *
-   * A fee can be configured. This fee is deducted from the total `amount`. It can be expressed as a `FIXED` amount or a `PERCENTAGE` of `amount`.
+   * A fee can be configured. This fee is deducted from the total `amount`. It can be expressed as:
+   * - `FIXED`: a fixed token amount (e.g., 0.1 means 0.1 tokens)
+   * - `PERCENTAGE`: a percentage of the transaction amount (e.g., 1.5 means 1.5%)
+   * - `PERFORMANCE`: a percentage of realized profit using FIFO cost basis (e.g., 10 means 10% of profit). Only applicable for withdrawals.
    *
    * The transaction can be gas-sponsored by an arbitrary wallet address which will sign, submit and pay the required gas for the transaction. If `gas_sponsorship` is set to `true`, EIP-712 typed data will be returned that must be signed by the `owner` and submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`) where the `sender` of the transaction can be set.
    */