@compass-labs/api-sdk 2.1.26-rc.1 → 2.1.26-rc.11

package/src/models/components/aaveposition.ts

@@ -14,10 +14,6 @@ export type AavePosition = {
    * The market type discriminator.
    */
   type: "AAVE";
-  /**
-   * Base64-encoded position identifier.
-   */
-  id: string;
   vaultAddress?: "None" | undefined;
   /**
    * The user's position value denominated in the supplied asset.
@@ -41,7 +37,6 @@ export const AavePosition$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   type: z.literal("AAVE"),
-  id: z.string(),
   vault_address: z.literal("None").optional(),
   amount_in_underlying_token: z.string(),
   token_name: z.string(),

package/src/models/components/compassapibackendv2modelsearnreadresponsepositionsvaultposition.ts

@@ -14,10 +14,6 @@ export type CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition = {
    * The market type discriminator.
    */
   type: "VAULT";
-  /**
-   * Base64-encoded position identifier.
-   */
-  id: string;
   /**
    * The vault address you are depositing to.
    */
@@ -48,7 +44,6 @@ export const CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition$inb
     unknown
   > = z.object({
     type: z.literal("VAULT"),
-    id: z.string(),
     vault_address: z.string(),
     amount_in_underlying_token: z.string(),
     token_name: z.string(),

package/src/models/components/depositevent.ts

@@ -16,10 +16,6 @@ export type DepositEvent = {
    * Block number when deposit occurred
    */
   blockNumber: number;
-  /**
-   * Timestamp of the deposit
-   */
-  blockTimestamp: Date;
   /**
    * Transaction hash of the deposit
    */
@@ -45,9 +41,6 @@ export const DepositEvent$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   block_number: z.number().int(),
-  block_timestamp: z.string().datetime({ offset: true }).transform(v =>
-    new Date(v)
-  ),
   transaction_hash: z.string(),
   assets_deposited: z.string(),
   units_received: z.string(),
@@ -55,7 +48,6 @@ export const DepositEvent$inboundSchema: z.ZodType<
 }).transform((v) => {
   return remap$(v, {
     "block_number": "blockNumber",
-    "block_timestamp": "blockTimestamp",
     "transaction_hash": "transactionHash",
     "assets_deposited": "assetsDeposited",
     "units_received": "unitsReceived",

package/src/models/components/fee.ts

@@ -6,19 +6,20 @@ import * as z from "zod/v3";
 import { ClosedEnum } from "../../types/enums.js";
 
 /**
- * The fee amount. If `denomination` is 'PERCENTAGE', this is a percentage of the transaction amount (e.g., 1.5 for 1.5%). If `denomination` is 'FIXED', this is a fixed amount in token units (e.g., 0.1 for 0.1 tokens).
+ * The fee amount. If `denomination` is 'PERCENTAGE', this is a percentage of the transaction amount (e.g., 1.5 for 1.5%). If `denomination` is 'FIXED', this is a fixed amount in token units (e.g., 0.1 for 0.1 tokens). If `denomination` is 'PERFORMANCE', this is a percentage of realized profit calculated using FIFO cost basis (e.g., 10 for 10% of profit).
  */
 export type FeeAmount = number | string;
 
 /**
- * The unit type for the fee amount. Use 'PERCENTAGE' for a percentage-based fee (e.g., 1.5 means 1.5% of the transaction amount) or 'FIXED' for a fixed token amount (e.g., 0.1 means 0.1 tokens).
+ * The unit type for the fee amount. Use 'PERCENTAGE' for a percentage-based fee (e.g., 1.5 means 1.5% of the transaction amount), 'FIXED' for a fixed token amount (e.g., 0.1 means 0.1 tokens), or 'PERFORMANCE' for a fee based on realized profit using FIFO cost basis (e.g., 10 means 10% of profit).
  */
 export const Denomination = {
   Percentage: "PERCENTAGE",
   Fixed: "FIXED",
+  Performance: "PERFORMANCE",
 } as const;
 /**
- * The unit type for the fee amount. Use 'PERCENTAGE' for a percentage-based fee (e.g., 1.5 means 1.5% of the transaction amount) or 'FIXED' for a fixed token amount (e.g., 0.1 means 0.1 tokens).
+ * The unit type for the fee amount. Use 'PERCENTAGE' for a percentage-based fee (e.g., 1.5 means 1.5% of the transaction amount), 'FIXED' for a fixed token amount (e.g., 0.1 means 0.1 tokens), or 'PERFORMANCE' for a fee based on realized profit using FIFO cost basis (e.g., 10 means 10% of profit).
  */
 export type Denomination = ClosedEnum<typeof Denomination>;
 
@@ -28,11 +29,11 @@ export type Fee = {
    */
   recipient: string;
   /**
-   * The fee amount. If `denomination` is 'PERCENTAGE', this is a percentage of the transaction amount (e.g., 1.5 for 1.5%). If `denomination` is 'FIXED', this is a fixed amount in token units (e.g., 0.1 for 0.1 tokens).
+   * The fee amount. If `denomination` is 'PERCENTAGE', this is a percentage of the transaction amount (e.g., 1.5 for 1.5%). If `denomination` is 'FIXED', this is a fixed amount in token units (e.g., 0.1 for 0.1 tokens). If `denomination` is 'PERFORMANCE', this is a percentage of realized profit calculated using FIFO cost basis (e.g., 10 for 10% of profit).
    */
   amount: number | string;
   /**
-   * The unit type for the fee amount. Use 'PERCENTAGE' for a percentage-based fee (e.g., 1.5 means 1.5% of the transaction amount) or 'FIXED' for a fixed token amount (e.g., 0.1 means 0.1 tokens).
+   * The unit type for the fee amount. Use 'PERCENTAGE' for a percentage-based fee (e.g., 1.5 means 1.5% of the transaction amount), 'FIXED' for a fixed token amount (e.g., 0.1 means 0.1 tokens), or 'PERFORMANCE' for a fee based on realized profit using FIFO cost basis (e.g., 10 means 10% of profit).
    */
   denomination?: Denomination | undefined;
 };

package/src/models/components/withdrawalevent.ts

@@ -16,10 +16,6 @@ export type WithdrawalEvent = {
    * Block number when withdrawal occurred
    */
   blockNumber: number;
-  /**
-   * Timestamp of the withdrawal
-   */
-  blockTimestamp: Date;
   /**
    * Transaction hash of the withdrawal
    */
@@ -53,9 +49,6 @@ export const WithdrawalEvent$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   block_number: z.number().int(),
-  block_timestamp: z.string().datetime({ offset: true }).transform(v =>
-    new Date(v)
-  ),
   transaction_hash: z.string(),
   assets_received: z.string(),
   units_withdrawn: z.string(),
@@ -65,7 +58,6 @@ export const WithdrawalEvent$inboundSchema: z.ZodType<
 }).transform((v) => {
   return remap$(v, {
     "block_number": "blockNumber",
-    "block_timestamp": "blockTimestamp",
     "transaction_hash": "transactionHash",
     "assets_received": "assetsReceived",
     "units_withdrawn": "unitsWithdrawn",

package/src/models/operations/v2earnpositions.ts

@@ -3,7 +3,6 @@
  */
 
 import * as z from "zod/v3";
-import { remap as remap$ } from "../../lib/primitives.js";
 import { ClosedEnum } from "../../types/enums.js";
 
 export const V2EarnPositionsChain = {
@@ -24,13 +23,9 @@ export type V2EarnPositionsRequest = {
   limit?: number | undefined;
   chain: V2EarnPositionsChain;
   /**
-   * The address of the user to get vault positions for.
+   * The address of the owner of the earn account to get positions for.
    */
-  userAddress: string;
-  /**
-   * How many days back from the current time to include in the blockchain scan.
-   */
-  days?: number | undefined;
+  owner: string;
 };
 
 /** @internal */
@@ -43,8 +38,7 @@ export type V2EarnPositionsRequest$Outbound = {
   offset?: number | undefined;
   limit?: number | undefined;
   chain: string;
-  user_address: string;
-  days?: number | undefined;
+  owner: string;
 };
 
 /** @internal */
@@ -56,12 +50,7 @@ export const V2EarnPositionsRequest$outboundSchema: z.ZodType<
   offset: z.number().int().optional(),
   limit: z.number().int().optional(),
   chain: V2EarnPositionsChain$outboundSchema,
-  userAddress: z.string(),
-  days: z.number().int().optional(),
-}).transform((v) => {
-  return remap$(v, {
-    userAddress: "user_address",
-  });
+  owner: z.string(),
 });
 
 export function v2EarnPositionsRequestToJSON(

package/src/sdk/earn.ts

@@ -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.
    */