@compass-labs/api-sdk 2.1.35 → 2.1.36-rc.0

package/src/models/components/aaveposition.ts

@@ -7,27 +7,50 @@ 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 { PositionPnL, PositionPnL$inboundSchema } from "./positionpnl.js";
+import {
+  WithdrawalEvent,
+  WithdrawalEvent$inboundSchema,
+} from "./withdrawalevent.js";
 
+/**
+ * Aave V3 lending position.
+ *
+ * @remarks
+ *
+ * Note: Unlike the old model, this no longer has vault_address/vault_name fields
+ * as they were nonsensical for Aave positions.
+ */
 export type AavePosition = {
   /**
    * The market type discriminator.
    */
   type: "AAVE";
-  vaultAddress?: "None" | undefined;
   /**
-   * The user's position value denominated in the supplied asset.
+   * The reserve (underlying token) address.
+   */
+  reserveAddress: string;
+  /**
+   * Symbol of the reserve asset (e.g., USDC).
    */
-  amountInUnderlyingToken: string;
+  reserveSymbol: string;
   /**
-   * Symbol of the Aave reserve asset (e.g., USDC).
+   * The user's position value (aToken balance).
    */
-  tokenName: string;
-  vaultName?: "None" | undefined;
+  balance: string;
   /**
-   * PnL breakdown with full deposit/withdrawal history.
+   * PnL metrics for this position.
    */
   pnl?: PositionPnL | null | undefined;
+  /**
+   * All deposit events for this position.
+   */
+  deposits?: Array<DepositEvent> | undefined;
+  /**
+   * All withdrawal events for this position.
+   */
+  withdrawals?: Array<WithdrawalEvent> | undefined;
 };
 
 /** @internal */
@@ -37,17 +60,16 @@ export const AavePosition$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   type: z.literal("AAVE"),
-  vault_address: z.literal("None").optional(),
-  amount_in_underlying_token: z.string(),
-  token_name: z.string(),
-  vault_name: z.literal("None").optional(),
+  reserve_address: z.string(),
+  reserve_symbol: z.string(),
+  balance: z.string(),
   pnl: z.nullable(PositionPnL$inboundSchema).optional(),
+  deposits: z.array(DepositEvent$inboundSchema).optional(),
+  withdrawals: z.array(WithdrawalEvent$inboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
-    "vault_address": "vaultAddress",
-    "amount_in_underlying_token": "amountInUnderlyingToken",
-    "token_name": "tokenName",
-    "vault_name": "vaultName",
+    "reserve_address": "reserveAddress",
+    "reserve_symbol": "reserveSymbol",
   });
 });
 

package/src/models/components/compassapibackendv2modelsearnreadresponsepositionsvaultposition.ts

@@ -7,33 +7,49 @@ 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 { PositionPnL, PositionPnL$inboundSchema } from "./positionpnl.js";
+import {
+  WithdrawalEvent,
+  WithdrawalEvent$inboundSchema,
+} from "./withdrawalevent.js";
 
+/**
+ * ERC-4626 vault position.
+ */
 export type CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition = {
   /**
    * The market type discriminator.
    */
   type: "VAULT";
   /**
-   * The vault address you are depositing to.
+   * The vault address.
    */
   vaultAddress: string;
   /**
-   * The user's position value denominated in the underlying token.
+   * Name of the vault token (share token).
    */
-  amountInUnderlyingToken: string;
+  vaultName: string;
   /**
    * Symbol of the underlying token (e.g., USDC).
    */
-  tokenName: string;
+  underlyingSymbol: string;
   /**
-   * Name of the vault token (share token).
+   * The user's position value in underlying token.
    */
-  vaultName: string;
+  balance: string;
   /**
-   * PnL breakdown with full deposit/withdrawal history.
+   * PnL metrics for this position.
    */
   pnl?: PositionPnL | null | undefined;
+  /**
+   * All deposit events for this position.
+   */
+  deposits?: Array<DepositEvent> | undefined;
+  /**
+   * All withdrawal events for this position.
+   */
+  withdrawals?: Array<WithdrawalEvent> | undefined;
 };
 
 /** @internal */
@@ -45,16 +61,17 @@ export const CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition$inb
   > = z.object({
     type: z.literal("VAULT"),
     vault_address: z.string(),
-    amount_in_underlying_token: z.string(),
-    token_name: z.string(),
     vault_name: z.string(),
+    underlying_symbol: z.string(),
+    balance: z.string(),
     pnl: z.nullable(PositionPnL$inboundSchema).optional(),
+    deposits: z.array(DepositEvent$inboundSchema).optional(),
+    withdrawals: z.array(WithdrawalEvent$inboundSchema).optional(),
   }).transform((v) => {
     return remap$(v, {
       "vault_address": "vaultAddress",
-      "amount_in_underlying_token": "amountInUnderlyingToken",
-      "token_name": "tokenName",
       "vault_name": "vaultName",
+      "underlying_symbol": "underlyingSymbol",
     });
   });
 

package/src/models/components/depositevent.ts

@@ -10,6 +10,13 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
  * Historical deposit event for position transparency.
+ *
+ * @remarks
+ *
+ * Uses generic input/output format that works across all protocols:
+ * - Vault: input=underlying, output=shares
+ * - Aave: input=underlying, output=aTokens
+ * - Pendle: input=token (varies), output=PT
  */
 export type DepositEvent = {
   /**
@@ -21,29 +28,25 @@ export type DepositEvent = {
    */
   transactionHash: string;
   /**
-   * Amount of underlying asset deposited (for Pendle: SY-denominated cost basis)
+   * Amount deposited (underlying asset or swap token)
    */
-  assetsDeposited: string;
+  inputAmount: string;
   /**
-   * Shares (vault), aTokens (Aave), or PT tokens (Pendle) received
+   * Symbol of token deposited
    */
-  unitsReceived: string;
+  inputSymbol: string;
   /**
-   * Cost basis per unit at time of deposit
-   */
-  costPerUnit: string;
-  /**
-   * Address of token used for deposit (for Pendle swaps)
+   * Units received (shares, aTokens, or PT)
    */
-  tokenAddress?: string | null | undefined;
+  outputAmount: string;
   /**
-   * Symbol of token used for deposit (for Pendle swaps)
+   * Symbol of units received
    */
-  tokenSymbol?: string | null | undefined;
+  outputSymbol: string;
   /**
-   * Amount of token spent in native decimals (for Pendle swaps)
+   * Cost basis per unit at time of deposit
    */
-  tokenAmount?: string | null | undefined;
+  costPerUnit: string;
 };
 
 /** @internal */
@@ -54,22 +57,20 @@ export const DepositEvent$inboundSchema: z.ZodType<
 > = z.object({
   block_number: z.number().int(),
   transaction_hash: z.string(),
-  assets_deposited: z.string(),
-  units_received: z.string(),
+  input_amount: z.string(),
+  input_symbol: z.string(),
+  output_amount: z.string(),
+  output_symbol: z.string(),
   cost_per_unit: z.string(),
-  token_address: z.nullable(z.string()).optional(),
-  token_symbol: z.nullable(z.string()).optional(),
-  token_amount: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
     "block_number": "blockNumber",
     "transaction_hash": "transactionHash",
-    "assets_deposited": "assetsDeposited",
-    "units_received": "unitsReceived",
+    "input_amount": "inputAmount",
+    "input_symbol": "inputSymbol",
+    "output_amount": "outputAmount",
+    "output_symbol": "outputSymbol",
     "cost_per_unit": "costPerUnit",
-    "token_address": "tokenAddress",
-    "token_symbol": "tokenSymbol",
-    "token_amount": "tokenAmount",
   });
 });
 

package/src/models/components/earnpositionsresponse.ts

@@ -17,59 +17,45 @@ import {
   PendlePTPosition$inboundSchema,
 } from "./pendleptposition.js";
 
-export type UserPosition =
-  | AavePosition
-  | PendlePTPosition
-  | CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition;
-
+/**
+ * Grouped positions by protocol.
+ *
+ * @remarks
+ *
+ * This new structure groups positions by protocol type for better organization and
+ * removes the need for a discriminated union in SDK consumers.
+ */
 export type EarnPositionsResponse = {
   /**
-   * A list of the user's earn positions.
+   * Aave V3 lending positions.
    */
-  userPositions: Array<
-    | AavePosition
-    | PendlePTPosition
-    | CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition
-  >;
+  aave?: Array<AavePosition> | undefined;
+  /**
+   * ERC-4626 vault positions.
+   */
+  vaults?:
+    | Array<CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition>
+    | undefined;
+  /**
+   * Pendle Principal Token positions.
+   */
+  pendlePt?: Array<PendlePTPosition> | undefined;
 };
 
-/** @internal */
-export const UserPosition$inboundSchema: z.ZodType<
-  UserPosition,
-  z.ZodTypeDef,
-  unknown
-> = z.union([
-  AavePosition$inboundSchema,
-  PendlePTPosition$inboundSchema,
-  CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition$inboundSchema,
-]);
-
-export function userPositionFromJSON(
-  jsonString: string,
-): SafeParseResult<UserPosition, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => UserPosition$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'UserPosition' from JSON`,
-  );
-}
-
 /** @internal */
 export const EarnPositionsResponse$inboundSchema: z.ZodType<
   EarnPositionsResponse,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  user_positions: z.array(
-    z.union([
-      AavePosition$inboundSchema,
-      PendlePTPosition$inboundSchema,
-      CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition$inboundSchema,
-    ]),
-  ),
+  aave: z.array(AavePosition$inboundSchema).optional(),
+  vaults: z.array(
+    CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition$inboundSchema,
+  ).optional(),
+  pendle_pt: z.array(PendlePTPosition$inboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
-    "user_positions": "userPositions",
+    "pendle_pt": "pendlePt",
   });
 });
 

package/src/models/components/pendleptposition.ts

@@ -7,10 +7,15 @@ 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 { PositionPnL, PositionPnL$inboundSchema } from "./positionpnl.js";
+import {
+  WithdrawalEvent,
+  WithdrawalEvent$inboundSchema,
+} from "./withdrawalevent.js";
 
 /**
- * Position in Pendle Principal Tokens (PT).
+ * Pendle Principal Token position.
  */
 export type PendlePTPosition = {
   /**
@@ -25,26 +30,30 @@ export type PendlePTPosition = {
    * The PT (Principal Token) contract address.
    */
   ptAddress: string;
-  /**
-   * The user's PT token balance.
-   */
-  amountInPt: string;
-  /**
-   * The underlying asset address.
-   */
-  underlyingAsset: string;
   /**
    * Symbol of the underlying asset (e.g., rsETH, weETH).
    */
   underlyingSymbol: string;
+  /**
+   * The user's PT token balance.
+   */
+  ptBalance: string;
   /**
    * Market expiry timestamp (Unix seconds).
    */
   expiry: number;
   /**
-   * PnL breakdown with full buy/sell history.
+   * PnL metrics (in SY terms) for this position.
    */
   pnl?: PositionPnL | null | undefined;
+  /**
+   * All buy PT events for this position.
+   */
+  deposits?: Array<DepositEvent> | undefined;
+  /**
+   * All sell/redeem PT events for this position.
+   */
+  withdrawals?: Array<WithdrawalEvent> | undefined;
 };
 
 /** @internal */
@@ -56,18 +65,18 @@ export const PendlePTPosition$inboundSchema: z.ZodType<
   type: z.literal("PENDLE_PT"),
   market_address: z.string(),
   pt_address: z.string(),
-  amount_in_pt: z.string(),
-  underlying_asset: z.string(),
   underlying_symbol: z.string(),
+  pt_balance: z.string(),
   expiry: z.number().int(),
   pnl: z.nullable(PositionPnL$inboundSchema).optional(),
+  deposits: z.array(DepositEvent$inboundSchema).optional(),
+  withdrawals: z.array(WithdrawalEvent$inboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
     "market_address": "marketAddress",
     "pt_address": "ptAddress",
-    "amount_in_pt": "amountInPt",
-    "underlying_asset": "underlyingAsset",
     "underlying_symbol": "underlyingSymbol",
+    "pt_balance": "ptBalance",
   });
 });
 

package/src/models/components/positionpnl.ts

@@ -7,14 +7,14 @@ 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.
+ * Simplified PnL metrics for API response.
+ *
+ * @remarks
+ *
+ * Historical events (deposits/withdrawals) are now at the position level, not inside
+ * PnL.
  */
 export type PositionPnL = {
   /**
@@ -22,15 +22,11 @@ export type PositionPnL = {
    */
   totalDeposited: string;
   /**
-   * Total assets withdrawn over all time
+   * Current position value in underlying
    */
-  totalWithdrawn: string;
+  currentValue: string;
   /**
-   * FIFO cost basis of remaining position
-   */
-  costBasis: string;
-  /**
-   * current_value - cost_basis
+   * current_value - cost_basis_remaining
    */
   unrealizedPnl: string;
   /**
@@ -40,19 +36,11 @@ export type PositionPnL = {
   /**
    * unrealized_pnl + realized_pnl
    */
-  totalYield: string;
-  /**
-   * Sum of performance fees paid
-   */
-  totalFeesPaid: string;
-  /**
-   * All deposit events for this position
-   */
-  deposits?: Array<DepositEvent> | undefined;
+  totalPnl: string;
   /**
-   * All withdrawal events for this position
+   * (total_pnl / total_deposited) * 100
    */
-  withdrawals?: Array<WithdrawalEvent> | undefined;
+  totalPnlPercent: string;
 };
 
 /** @internal */
@@ -62,23 +50,19 @@ export const PositionPnL$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   total_deposited: z.string(),
-  total_withdrawn: z.string(),
-  cost_basis: z.string(),
+  current_value: 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(),
+  total_pnl: z.string(),
+  total_pnl_percent: z.string(),
 }).transform((v) => {
   return remap$(v, {
     "total_deposited": "totalDeposited",
-    "total_withdrawn": "totalWithdrawn",
-    "cost_basis": "costBasis",
+    "current_value": "currentValue",
     "unrealized_pnl": "unrealizedPnl",
     "realized_pnl": "realizedPnl",
-    "total_yield": "totalYield",
-    "total_fees_paid": "totalFeesPaid",
+    "total_pnl": "totalPnl",
+    "total_pnl_percent": "totalPnlPercent",
   });
 });
 

package/src/models/components/withdrawalevent.ts

@@ -10,6 +10,13 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
  * Historical withdrawal event with realized PnL.
+ *
+ * @remarks
+ *
+ * Uses generic input/output format:
+ * - Vault: input=shares, output=underlying
+ * - Aave: input=aTokens, output=underlying
+ * - Pendle: input=PT, output=token (varies)
  */
 export type WithdrawalEvent = {
   /**
@@ -21,25 +28,25 @@ export type WithdrawalEvent = {
    */
   transactionHash: string;
   /**
-   * Amount of underlying asset received
+   * Units withdrawn (shares, aTokens, PT)
    */
-  assetsReceived: string;
+  inputAmount: string;
   /**
-   * Shares (vault) or aTokens (Aave) burned
+   * Symbol of units withdrawn
    */
-  unitsWithdrawn: string;
+  inputSymbol: string;
   /**
-   * FIFO cost basis of units withdrawn
+   * Amount received (underlying or token)
    */
-  costBasisConsumed: string;
+  outputAmount: string;
   /**
-   * Profit/loss: assets_received - cost_basis_consumed
+   * Symbol of token received
    */
-  realizedPnl: string;
+  outputSymbol: string;
   /**
-   * Performance fee charged on this withdrawal
+   * Profit/loss: output value - cost basis consumed
    */
-  feeCharged: string;
+  realizedPnl: string;
 };
 
 /** @internal */
@@ -50,20 +57,20 @@ export const WithdrawalEvent$inboundSchema: z.ZodType<
 > = z.object({
   block_number: z.number().int(),
   transaction_hash: z.string(),
-  assets_received: z.string(),
-  units_withdrawn: z.string(),
-  cost_basis_consumed: z.string(),
+  input_amount: z.string(),
+  input_symbol: z.string(),
+  output_amount: z.string(),
+  output_symbol: 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",
+    "input_amount": "inputAmount",
+    "input_symbol": "inputSymbol",
+    "output_amount": "outputAmount",
+    "output_symbol": "outputSymbol",
     "realized_pnl": "realizedPnl",
-    "fee_charged": "feeCharged",
   });
 });
 

package/docs/models/components/userposition.md

@@ -1,42 +0,0 @@
-# UserPosition
-
-
-## Supported Types
-
-### `components.AavePosition`
-
-```typescript
-const value: components.AavePosition = {
-  type: "AAVE",
-  amountInUnderlyingToken: "<value>",
-  tokenName: "<value>",
-};
-```
-
-### `components.PendlePTPosition`
-
-```typescript
-const value: components.PendlePTPosition = {
-  type: "PENDLE_PT",
-  marketAddress: "<value>",
-  ptAddress: "<value>",
-  amountInPt: "<value>",
-  underlyingAsset: "<value>",
-  underlyingSymbol: "<value>",
-  expiry: 858301,
-};
-```
-
-### `components.CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition`
-
-```typescript
-const value:
-  components.CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition = {
-    type: "VAULT",
-    vaultAddress: "<value>",
-    amountInUnderlyingToken: "<value>",
-    tokenName: "<value>",
-    vaultName: "<value>",
-  };
-```
-