@compass-labs/api-sdk 2.2.56-rc.0 → 2.2.57-rc.0

package/src/funcs/{tokenizedAssetsTokenizedAssetsPositions.ts → tokenizedEquitiesTokenizedAssetsPositions.ts}

@@ -28,29 +28,30 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get tokenized-asset positions for a wallet
+ * Get tokenized-asset positions for an owner
  *
  * @remarks
- * Get the tokenized-asset holdings for a wallet.
+ * Get the tokenized-asset holdings for an owner.
  *
- * Returns the balance of every listed tokenized equity at the queried
- * address, plus the latest USD price and a USD-valued balance when
- * pricing is available. Zero balances are omitted, and a `total_usd`
+ * The owner's Tokenized Equities Account address is derived deterministically
+ * from the `owner` query param; balances are read from that account (proceeds
+ * from filled orders settle there). The response returns the balance of every
+ * listed tokenized equity, plus the latest USD price and a USD-valued balance
+ * when pricing is available. Zero balances are omitted, and a `total_usd`
  * aggregate is returned across all priced positions.
  *
- * Pass the **Tokenized Assets Account address** (returned by
- * `/create_account`), not the owner's wallet — proceeds from filled
- * orders settle into the Tokenized Assets Account.
+ * Returns 400 `ACCOUNT_NOT_DEPLOYED` if the owner has no Tokenized Equities
+ * Account deployed yet — create one via `/create_account` first.
  */
-export function tokenizedAssetsTokenizedAssetsPositions(
+export function tokenizedEquitiesTokenizedAssetsPositions(
   client: CompassApiSDKCore,
   request: operations.V2TokenizedAssetsPositionsRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
     components.TokenizedAssetsPositionsResponse,
-    | errors.HTTPValidationError
     | errors.TokenizedAssetsErrorResponse
+    | errors.HTTPValidationError
     | CompassAPISDKError
     | ResponseValidationError
     | ConnectionError
@@ -76,8 +77,8 @@ async function $do(
   [
     Result<
       components.TokenizedAssetsPositionsResponse,
-      | errors.HTTPValidationError
       | errors.TokenizedAssetsErrorResponse
+      | errors.HTTPValidationError
       | CompassAPISDKError
       | ResponseValidationError
       | ConnectionError
@@ -105,7 +106,7 @@ async function $do(
   const path = pathToFunc("/v2/tokenized_assets/positions")();
 
   const query = encodeFormQuery({
-    "wallet": payload.wallet,
+    "owner": payload.owner,
   });
 
   const headers = new Headers(compactMap({
@@ -165,8 +166,8 @@ async function $do(
 
   const [result] = await M.match<
     components.TokenizedAssetsPositionsResponse,
-    | errors.HTTPValidationError
     | errors.TokenizedAssetsErrorResponse
+    | errors.HTTPValidationError
     | CompassAPISDKError
     | ResponseValidationError
     | ConnectionError
@@ -177,6 +178,7 @@ async function $do(
     | SDKValidationError
   >(
     M.json(200, components.TokenizedAssetsPositionsResponse$inboundSchema),
+    M.jsonErr(400, errors.TokenizedAssetsErrorResponse$inboundSchema),
     M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
     M.jsonErr(502, errors.TokenizedAssetsErrorResponse$inboundSchema),
     M.fail("4XX"),

package/src/funcs/{tokenizedAssetsTokenizedAssetsQuote.ts → tokenizedEquitiesTokenizedAssetsQuote.ts}

@@ -49,7 +49,7 @@ import { Result } from "../types/fp.js";
  *   end amount and the reference quote amount. Use to surface a
  *   thin-liquidity warning to the user.
  */
-export function tokenizedAssetsTokenizedAssetsQuote(
+export function tokenizedEquitiesTokenizedAssetsQuote(
   client: CompassApiSDKCore,
   request: components.TokenizedAssetsQuoteRequest,
   options?: RequestOptions,

package/src/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.ts

@@ -5,22 +5,9 @@
 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";
 
-/**
- * Chain on which the contract is deployed.
- */
-export const CompassApiBackendV2ModelsTokenizedAssetsMarketMarketChain = {
-  Ethereum: "ethereum",
-} as const;
-/**
- * Chain on which the contract is deployed.
- */
-export type CompassApiBackendV2ModelsTokenizedAssetsMarketMarketChain =
-  ClosedEnum<typeof CompassApiBackendV2ModelsTokenizedAssetsMarketMarketChain>;
-
 /**
  * Compact market entry returned in list responses.
  */
@@ -37,10 +24,6 @@ export type CompassApiBackendV2ModelsTokenizedAssetsMarketMarket = {
    * Underlying equity full name (e.g. 'Tesla, Inc. Common Stock').
    */
   name: string;
-  /**
-   * Chain on which the contract is deployed.
-   */
-  chain?: CompassApiBackendV2ModelsTokenizedAssetsMarketMarketChain | undefined;
   /**
    * Ethereum mainnet ERC-20 address for this token.
    */
@@ -71,12 +54,6 @@ export type CompassApiBackendV2ModelsTokenizedAssetsMarketMarket = {
   regionExposure?: Array<string> | undefined;
 };
 
-/** @internal */
-export const CompassApiBackendV2ModelsTokenizedAssetsMarketMarketChain$inboundSchema:
-  z.ZodNativeEnum<
-    typeof CompassApiBackendV2ModelsTokenizedAssetsMarketMarketChain
-  > = z.nativeEnum(CompassApiBackendV2ModelsTokenizedAssetsMarketMarketChain);
-
 /** @internal */
 export const CompassApiBackendV2ModelsTokenizedAssetsMarketMarket$inboundSchema:
   z.ZodType<
@@ -87,9 +64,6 @@ export const CompassApiBackendV2ModelsTokenizedAssetsMarketMarket$inboundSchema:
     symbol: z.string(),
     underlying_ticker: z.string(),
     name: z.string(),
-    chain:
-      CompassApiBackendV2ModelsTokenizedAssetsMarketMarketChain$inboundSchema
-        .optional(),
     contract_address: z.string(),
     decimals: z.number().int(),
     current_price_usd: z.string(),

package/src/models/components/createtokenizedassetsaccountrequest.ts

@@ -4,45 +4,30 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
-import { ClosedEnum } from "../../types/enums.js";
-
-export const CreateTokenizedAssetsAccountRequestChain = {
-  Ethereum: "ethereum",
-} as const;
-export type CreateTokenizedAssetsAccountRequestChain = ClosedEnum<
-  typeof CreateTokenizedAssetsAccountRequestChain
->;
 
 /**
- * Request to create a compass tokenized assets account.
+ * Request to create a compass Tokenized Equities Account.
  */
 export type CreateTokenizedAssetsAccountRequest = {
-  chain: CreateTokenizedAssetsAccountRequestChain;
   /**
    * The address of the transaction sender.
    */
   sender: string;
   /**
-   * Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed.
+   * The address that will own and control the compass Tokenized Equities Account
    */
-  estimateGas?: boolean | undefined;
+  owner: string;
   /**
-   * The address that will own and control the compass tokenized assets account
+   * Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed.
    */
-  owner: string;
+  estimateGas?: boolean | undefined;
 };
 
-/** @internal */
-export const CreateTokenizedAssetsAccountRequestChain$outboundSchema:
-  z.ZodNativeEnum<typeof CreateTokenizedAssetsAccountRequestChain> = z
-    .nativeEnum(CreateTokenizedAssetsAccountRequestChain);
-
 /** @internal */
 export type CreateTokenizedAssetsAccountRequest$Outbound = {
-  chain: string;
   sender: string;
-  estimate_gas?: boolean | undefined;
   owner: string;
+  estimate_gas?: boolean | undefined;
 };
 
 /** @internal */
@@ -51,10 +36,9 @@ export const CreateTokenizedAssetsAccountRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   CreateTokenizedAssetsAccountRequest
 > = z.object({
-  chain: CreateTokenizedAssetsAccountRequestChain$outboundSchema,
   sender: z.string(),
-  estimateGas: z.boolean().optional(),
   owner: z.string(),
+  estimateGas: z.boolean().optional(),
 }).transform((v) => {
   return remap$(v, {
     estimateGas: "estimate_gas",

package/src/models/components/createtokenizedassetsaccountresponse.ts

@@ -13,15 +13,15 @@ import {
 } from "./unsignedtransaction.js";
 
 /**
- * Response containing unsigned transaction to create compass tokenized assets account.
+ * Response containing unsigned transaction to create compass Tokenized Equities Account.
  */
 export type CreateTokenizedAssetsAccountResponse = {
   /**
-   * Transaction to create compass tokenized assets account
+   * Transaction to create compass Tokenized Equities Account
    */
   transaction: UnsignedTransaction | null;
   /**
-   * Predicted address of the compass tokenized assets account that will be deployed
+   * Predicted address of the compass Tokenized Equities Account that will be deployed
    */
   tokenizedAssetsAccountAddress: string;
 };

package/src/models/components/marketdetail.ts

@@ -5,23 +5,11 @@
 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";
 import { OhlcCandle, OhlcCandle$inboundSchema } from "./ohlccandle.js";
 import { PricePoint, PricePoint$inboundSchema } from "./pricepoint.js";
 
-/**
- * Chain on which the contract is deployed.
- */
-export const MarketDetailChain = {
-  Ethereum: "ethereum",
-} as const;
-/**
- * Chain on which the contract is deployed.
- */
-export type MarketDetailChain = ClosedEnum<typeof MarketDetailChain>;
-
 /**
  * Extended market view returned when fetching a single market.
  */
@@ -38,10 +26,6 @@ export type MarketDetail = {
    * Underlying equity full name (e.g. 'Tesla, Inc. Common Stock').
    */
   name: string;
-  /**
-   * Chain on which the contract is deployed.
-   */
-  chain?: MarketDetailChain | undefined;
   /**
    * Ethereum mainnet ERC-20 address for this token.
    */
@@ -116,11 +100,6 @@ export type MarketDetail = {
   candles?: Array<OhlcCandle> | null | undefined;
 };
 
-/** @internal */
-export const MarketDetailChain$inboundSchema: z.ZodNativeEnum<
-  typeof MarketDetailChain
-> = z.nativeEnum(MarketDetailChain);
-
 /** @internal */
 export const MarketDetail$inboundSchema: z.ZodType<
   MarketDetail,
@@ -130,7 +109,6 @@ export const MarketDetail$inboundSchema: z.ZodType<
   symbol: z.string(),
   underlying_ticker: z.string(),
   name: z.string(),
-  chain: MarketDetailChain$inboundSchema.optional(),
   contract_address: z.string(),
   decimals: z.number().int(),
   current_price_usd: z.string(),

package/src/models/components/ordertosign.ts

@@ -20,7 +20,7 @@ import {
  * The owner signs ``safe_message_eip712`` off-chain. At submit time the
  * signature is sent back to ``/order/submit`` together with
  * ``order_message``, ``extension``, and ``quote_id``; resolvers validate
- * the signature against the Tokenized Assets Account at fill time.
+ * the signature against the Tokenized Equities Account at fill time.
  */
 export type OrderToSign = {
   /**
@@ -36,7 +36,7 @@ export type OrderToSign = {
    */
   quoteId: string;
   /**
-   * Order struct (maker, makerAsset, makingAmount, etc.) — pass back to `/order/submit` unchanged. The maker is the Tokenized Assets Account, not the owner's wallet.
+   * Order struct (maker, makerAsset, makingAmount, etc.) — pass back to `/order/submit` unchanged. The maker is the Tokenized Equities Account, not the owner's wallet.
    */
   orderMessage: { [k: string]: any };
   /**

package/src/models/components/tokenizedassetsbuildorderrequest.ts

@@ -4,16 +4,11 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
-import { Chain, Chain$outboundSchema } from "./chain.js";
 
 /**
  * Build a buy or sell order for a tokenized equity.
  */
 export type TokenizedAssetsBuildOrderRequest = {
-  /**
-   * The chain to use.
-   */
-  chain: Chain;
   /**
    * Token the sender is paying. Either an on-chain symbol (e.g. `TSLAon`), the literal `USDC`, or a 0x-prefixed token address.
    */
@@ -27,7 +22,7 @@ export type TokenizedAssetsBuildOrderRequest = {
    */
   amount: string;
   /**
-   * Wallet that owns the Tokenized Assets Account. The product account address is derived deterministically from this owner. The owner signs the EIP-712 payloads returned by this endpoint (the optional approval and the order itself).
+   * Wallet that owns the Tokenized Equities Account. The product account address is derived deterministically from this owner. The owner signs the EIP-712 payloads returned by this endpoint (the optional approval and the order itself).
    */
   owner: string;
   /**
@@ -38,7 +33,6 @@ export type TokenizedAssetsBuildOrderRequest = {
 
 /** @internal */
 export type TokenizedAssetsBuildOrderRequest$Outbound = {
-  chain: string;
   from_token: string;
   to_token: string;
   amount: string;
@@ -52,7 +46,6 @@ export const TokenizedAssetsBuildOrderRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   TokenizedAssetsBuildOrderRequest
 > = z.object({
-  chain: Chain$outboundSchema,
   fromToken: z.string(),
   toToken: z.string(),
   amount: z.string(),

package/src/models/components/tokenizedassetsbuildorderresponse.ts

@@ -23,7 +23,7 @@ export type TokenizedAssetsBuildOrderResponse = {
    */
   quote: Quote;
   /**
-   * EIP-712 payload that authorizes a one-time max-approve of `from_token` to the settlement contract. Populated when the Tokenized Assets Account's existing allowance is below `amount`. The owner signs it, then it is broadcast via `POST /v2/gas_sponsorship/prepare` (or directly by the owner) to set the allowance on-chain. `null` when the allowance is already sufficient.
+   * EIP-712 payload that authorizes a one-time max-approve of `from_token` to the settlement contract. Populated when the Tokenized Equities Account's existing allowance is below `amount`. The owner signs it, then it is broadcast via `POST /v2/gas_sponsorship/prepare` (or directly by the owner) to set the allowance on-chain. `null` when the allowance is already sufficient.
    */
   approvalSafeTxEip712?: BatchedSafeOperationsResponseOutput | null | undefined;
   /**
@@ -34,7 +34,7 @@ export type TokenizedAssetsBuildOrderResponse = {
    * The owner signs ``safe_message_eip712`` off-chain. At submit time the
    * signature is sent back to ``/order/submit`` together with
    * ``order_message``, ``extension``, and ``quote_id``; resolvers validate
-   * the signature against the Tokenized Assets Account at fill time.
+   * the signature against the Tokenized Equities Account at fill time.
    */
   order: OrderToSign;
 };

package/src/models/components/tokenizedassetscancelorderrequest.ts

@@ -6,7 +6,7 @@ import * as z from "zod/v3";
 
 export type TokenizedAssetsCancelOrderRequest = {
   /**
-   * Wallet that owns the Tokenized Assets Account. The account address derived from this owner must match the order's on-chain maker; the API rejects otherwise (only the order's maker can cancel it).
+   * Wallet that owns the Tokenized Equities Account. The account address derived from this owner must match the order's on-chain maker; the API rejects otherwise (only the order's maker can cancel it).
    */
   owner: string;
 };

package/src/models/components/tokenizedassetspositionsresponse.ts

@@ -5,7 +5,6 @@
 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";
 import {
@@ -14,30 +13,13 @@ import {
 } from "./compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.js";
 
 /**
- * Chain on which the balances were read.
- */
-export const TokenizedAssetsPositionsResponseChain = {
-  Ethereum: "ethereum",
-} as const;
-/**
- * Chain on which the balances were read.
- */
-export type TokenizedAssetsPositionsResponseChain = ClosedEnum<
-  typeof TokenizedAssetsPositionsResponseChain
->;
-
-/**
- * Wallet's on-chain tokenized-asset holdings.
+ * On-chain tokenized-asset holdings for an owner's Tokenized Equities Account.
  */
 export type TokenizedAssetsPositionsResponse = {
   /**
-   * Queried wallet.
+   * Owner address from the request. Balances are read from the Tokenized Equities Account address derived from this owner.
    */
-  wallet: string;
-  /**
-   * Chain on which the balances were read.
-   */
-  chain?: TokenizedAssetsPositionsResponseChain | undefined;
+  owner: string;
   /**
    * Non-zero positions only; tokens with a zero balance are omitted.
    */
@@ -52,20 +34,13 @@ export type TokenizedAssetsPositionsResponse = {
   totalUsd: string;
 };
 
-/** @internal */
-export const TokenizedAssetsPositionsResponseChain$inboundSchema:
-  z.ZodNativeEnum<typeof TokenizedAssetsPositionsResponseChain> = z.nativeEnum(
-    TokenizedAssetsPositionsResponseChain,
-  );
-
 /** @internal */
 export const TokenizedAssetsPositionsResponse$inboundSchema: z.ZodType<
   TokenizedAssetsPositionsResponse,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  wallet: z.string(),
-  chain: TokenizedAssetsPositionsResponseChain$inboundSchema.optional(),
+  owner: z.string(),
   positions: z.array(
     CompassApiBackendV2ModelsTokenizedAssetsReadResponsePositionsPosition$inboundSchema,
   ).optional(),

package/src/models/components/tokenizedassetsquoterequest.ts

@@ -4,7 +4,6 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
-import { Chain, Chain$outboundSchema } from "./chain.js";
 
 /**
  * Preview a buy or sell quote for a tokenized equity.
@@ -18,10 +17,6 @@ import { Chain, Chain$outboundSchema } from "./chain.js";
  * when they do.
  */
 export type TokenizedAssetsQuoteRequest = {
-  /**
-   * The chain to use.
-   */
-  chain: Chain;
   /**
    * Token the sender is paying. Either an on-chain symbol (e.g. `TSLAon`), the literal `USDC`, or a 0x-prefixed token address.
    */
@@ -35,14 +30,13 @@ export type TokenizedAssetsQuoteRequest = {
    */
   amount: string;
   /**
-   * Wallet that owns the Tokenized Assets Account. Used to verify the account is deployed before quoting; the account address is derived deterministically from this owner.
+   * Wallet that owns the Tokenized Equities Account. Used to verify the account is deployed before quoting; the account address is derived deterministically from this owner.
    */
   owner: string;
 };
 
 /** @internal */
 export type TokenizedAssetsQuoteRequest$Outbound = {
-  chain: string;
   from_token: string;
   to_token: string;
   amount: string;
@@ -55,7 +49,6 @@ export const TokenizedAssetsQuoteRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   TokenizedAssetsQuoteRequest
 > = z.object({
-  chain: Chain$outboundSchema,
   fromToken: z.string(),
   toToken: z.string(),
   amount: z.string(),

package/src/models/components/tokenizedassetssubmitorderrequest.ts

@@ -11,16 +11,16 @@ import { remap as remap$ } from "../../lib/primitives.js";
  * @remarks
  *
  * The shape echoes what `POST /order` returned plus the owner's
- * EIP-712 signature. The maker is the Tokenized Assets Account, so the
+ * EIP-712 signature. The maker is the Tokenized Equities Account, so the
  * signature is validated against the product account at fill time.
  */
 export type TokenizedAssetsSubmitOrderRequest = {
   /**
-   * The order struct returned by `/order` (`order.order_message`). `maker` is the Tokenized Assets Account, not the owner's wallet — pass this dict back to the API verbatim.
+   * The order struct returned by `/order` (`order.order_message`). `maker` is the Tokenized Equities Account, not the owner's wallet — pass this dict back to the API verbatim.
    */
   signedOrder: { [k: string]: any };
   /**
-   * Owner's EIP-712 signature over `order.safe_message_eip712` from the `/order` response. The signature is validated against the Tokenized Assets Account at fill time, so it must be a signature over the typed-data hash, not the raw order hash.
+   * Owner's EIP-712 signature over `order.safe_message_eip712` from the `/order` response. The signature is validated against the Tokenized Equities Account at fill time, so it must be a signature over the typed-data hash, not the raw order hash.
    */
   signature: string;
   /**

package/src/models/operations/v2tokenizedassetspositions.ts

@@ -6,14 +6,14 @@ import * as z from "zod/v3";
 
 export type V2TokenizedAssetsPositionsRequest = {
   /**
-   * Wallet address to read on-chain ERC-20 balances for.
+   * The address of the owner of the Tokenized Equities Account to get positions for. The account address is derived deterministically from this owner; balances are read from the derived account.
    */
-  wallet: string;
+  owner: string;
 };
 
 /** @internal */
 export type V2TokenizedAssetsPositionsRequest$Outbound = {
-  wallet: string;
+  owner: string;
 };
 
 /** @internal */
@@ -22,7 +22,7 @@ export const V2TokenizedAssetsPositionsRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   V2TokenizedAssetsPositionsRequest
 > = z.object({
-  wallet: z.string(),
+  owner: z.string(),
 });
 
 export function v2TokenizedAssetsPositionsRequestToJSON(

package/src/sdk/sdk.ts

@@ -18,7 +18,7 @@ import { Sky } from "./sky.js";
 import { SmartAccount } from "./smartaccount.js";
 import { Swap } from "./swap.js";
 import { Token } from "./token.js";
-import { TokenizedAssets } from "./tokenizedassets.js";
+import { TokenizedEquities } from "./tokenizedequities.js";
 import { TransactionBundler } from "./transactionbundler.js";
 import { UniswapV3 } from "./uniswapv3.js";
 import { Universal } from "./universal.js";
@@ -122,8 +122,8 @@ export class CompassApiSDK extends ClientSDK {
     return (this._globalMarketsPerps ??= new GlobalMarketsPerps(this._options));
   }
 
-  private _tokenizedAssets?: TokenizedAssets;
-  get tokenizedAssets(): TokenizedAssets {
-    return (this._tokenizedAssets ??= new TokenizedAssets(this._options));
+  private _tokenizedEquities?: TokenizedEquities;
+  get tokenizedEquities(): TokenizedEquities {
+    return (this._tokenizedEquities ??= new TokenizedEquities(this._options));
   }
 }