compass_api_sdk 2.2.63rc1__tar.gz → 2.2.65__tar.gz

{compass_api_sdk-2.2.63rc1 → compass_api_sdk-2.2.65}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: compass_api_sdk
-Version: 2.2.63rc1
+Version: 2.2.65
 Summary: Compass API SDK.
 Author: royalnine
 Requires-Python: >=3.10
@@ -351,15 +351,15 @@ with CompassAPI(
 * [tokenized_assets_markets](docs/sdks/tokenizedassets/README.md#tokenized_assets_markets) - List tokenized asset markets
 * [tokenized_assets_markets_symbol_](docs/sdks/tokenizedassets/README.md#tokenized_assets_markets_symbol_) - Get a single market
 * [tokenized_assets_positions](docs/sdks/tokenizedassets/README.md#tokenized_assets_positions) - Get tokenized-asset positions for an owner
-* [tokenized_assets_order_order_hash_](docs/sdks/tokenizedassets/README.md#tokenized_assets_order_order_hash_) - Get order status
+* [tokenized_assets_order_order_hash_](docs/sdks/tokenizedassets/README.md#tokenized_assets_order_order_hash_) - Get tokenized-equity order status (Ondo)
 * [tokenized_assets_create_account](docs/sdks/tokenizedassets/README.md#tokenized_assets_create_account) - Create a Tokenized Assets Account
 * [tokenized_assets_transfer](docs/sdks/tokenizedassets/README.md#tokenized_assets_transfer) - Deposit to / withdraw from a Tokenized Assets Account
-* [tokenized_assets_quote](docs/sdks/tokenizedassets/README.md#tokenized_assets_quote) - Preview a buy/sell quote
-* [tokenized_assets_order](docs/sdks/tokenizedassets/README.md#tokenized_assets_order) - Build a buy/sell order
-* [tokenized_assets_order_submit](docs/sdks/tokenizedassets/README.md#tokenized_assets_order_submit) - Submit a signed order
-* [tokenized_assets_order_order_hash_cancel](docs/sdks/tokenizedassets/README.md#tokenized_assets_order_order_hash_cancel) - Cancel an unfilled order
-* [tokenized_assets_transact_buy](docs/sdks/tokenizedassets/README.md#tokenized_assets_transact_buy) - Buy a swap-traded tokenized asset
-* [tokenized_assets_transact_sell](docs/sdks/tokenizedassets/README.md#tokenized_assets_transact_sell) - Sell a swap-traded tokenized asset
+* [tokenized_assets_quote](docs/sdks/tokenizedassets/README.md#tokenized_assets_quote) - Preview a tokenized-equity buy/sell quote (Ondo)
+* [tokenized_assets_order](docs/sdks/tokenizedassets/README.md#tokenized_assets_order) - Build a tokenized-equity buy/sell order (Ondo)
+* [tokenized_assets_order_submit](docs/sdks/tokenizedassets/README.md#tokenized_assets_order_submit) - Submit a signed tokenized-equity order (Ondo)
+* [tokenized_assets_order_order_hash_cancel](docs/sdks/tokenizedassets/README.md#tokenized_assets_order_order_hash_cancel) - Cancel an unfilled tokenized-equity order (Ondo)
+* [tokenized_assets_transact_buy](docs/sdks/tokenizedassets/README.md#tokenized_assets_transact_buy) - Buy an RWA yield token (Midas: mTBILL/mBASIS/mBTC)
+* [tokenized_assets_transact_sell](docs/sdks/tokenizedassets/README.md#tokenized_assets_transact_sell) - Sell an RWA yield token (Midas: mTBILL/mBASIS/mBTC)
 
 ### [TransactionBundler](docs/sdks/transactionbundler/README.md)
 

{compass_api_sdk-2.2.63rc1 → compass_api_sdk-2.2.65}/README-PYPI.md

@@ -333,15 +333,15 @@ with CompassAPI(
 * [tokenized_assets_markets](docs/sdks/tokenizedassets/README.md#tokenized_assets_markets) - List tokenized asset markets
 * [tokenized_assets_markets_symbol_](docs/sdks/tokenizedassets/README.md#tokenized_assets_markets_symbol_) - Get a single market
 * [tokenized_assets_positions](docs/sdks/tokenizedassets/README.md#tokenized_assets_positions) - Get tokenized-asset positions for an owner
-* [tokenized_assets_order_order_hash_](docs/sdks/tokenizedassets/README.md#tokenized_assets_order_order_hash_) - Get order status
+* [tokenized_assets_order_order_hash_](docs/sdks/tokenizedassets/README.md#tokenized_assets_order_order_hash_) - Get tokenized-equity order status (Ondo)
 * [tokenized_assets_create_account](docs/sdks/tokenizedassets/README.md#tokenized_assets_create_account) - Create a Tokenized Assets Account
 * [tokenized_assets_transfer](docs/sdks/tokenizedassets/README.md#tokenized_assets_transfer) - Deposit to / withdraw from a Tokenized Assets Account
-* [tokenized_assets_quote](docs/sdks/tokenizedassets/README.md#tokenized_assets_quote) - Preview a buy/sell quote
-* [tokenized_assets_order](docs/sdks/tokenizedassets/README.md#tokenized_assets_order) - Build a buy/sell order
-* [tokenized_assets_order_submit](docs/sdks/tokenizedassets/README.md#tokenized_assets_order_submit) - Submit a signed order
-* [tokenized_assets_order_order_hash_cancel](docs/sdks/tokenizedassets/README.md#tokenized_assets_order_order_hash_cancel) - Cancel an unfilled order
-* [tokenized_assets_transact_buy](docs/sdks/tokenizedassets/README.md#tokenized_assets_transact_buy) - Buy a swap-traded tokenized asset
-* [tokenized_assets_transact_sell](docs/sdks/tokenizedassets/README.md#tokenized_assets_transact_sell) - Sell a swap-traded tokenized asset
+* [tokenized_assets_quote](docs/sdks/tokenizedassets/README.md#tokenized_assets_quote) - Preview a tokenized-equity buy/sell quote (Ondo)
+* [tokenized_assets_order](docs/sdks/tokenizedassets/README.md#tokenized_assets_order) - Build a tokenized-equity buy/sell order (Ondo)
+* [tokenized_assets_order_submit](docs/sdks/tokenizedassets/README.md#tokenized_assets_order_submit) - Submit a signed tokenized-equity order (Ondo)
+* [tokenized_assets_order_order_hash_cancel](docs/sdks/tokenizedassets/README.md#tokenized_assets_order_order_hash_cancel) - Cancel an unfilled tokenized-equity order (Ondo)
+* [tokenized_assets_transact_buy](docs/sdks/tokenizedassets/README.md#tokenized_assets_transact_buy) - Buy an RWA yield token (Midas: mTBILL/mBASIS/mBTC)
+* [tokenized_assets_transact_sell](docs/sdks/tokenizedassets/README.md#tokenized_assets_transact_sell) - Sell an RWA yield token (Midas: mTBILL/mBASIS/mBTC)
 
 ### [TransactionBundler](docs/sdks/transactionbundler/README.md)
 

{compass_api_sdk-2.2.63rc1 → compass_api_sdk-2.2.65}/pyproject.toml

@@ -1,7 +1,7 @@
 
 [project]
 name = "compass_api_sdk"
-version = "2.2.63rc1"
+version = "2.2.65"
 description = "Compass API SDK."
 authors = [{ name = "royalnine" },]
 readme = "README-PYPI.md"
@@ -14,7 +14,7 @@ dependencies = [
 
 [tool.poetry]
 name = "compass_api_sdk"
-version = "2.2.63rc1"
+version = "2.2.65"
 description = "Compass API SDK."
 authors = ["Compass Labs"]
 repository = "https://github.com/CompassLabs/mono.git"

{compass_api_sdk-2.2.63rc1 → compass_api_sdk-2.2.65}/src/compass_api_sdk/_version.py

@@ -5,8 +5,8 @@ import importlib.metadata
 __title__: str = "compass_api_sdk"
 __version__: str = "2.0.0"
 __openapi_doc_version__: str = "0.0.1"
-__gen_version__: str = "2.899.1"
-__user_agent__: str = "speakeasy-sdk/python 2.0.0 2.899.1 0.0.1 compass_api_sdk"
+__gen_version__: str = "2.906.0"
+__user_agent__: str = "speakeasy-sdk/python 2.0.0 2.906.0 0.0.1 compass_api_sdk"
 
 try:
     if __package__ is not None:

{compass_api_sdk-2.2.63rc1 → compass_api_sdk-2.2.65}/src/compass_api_sdk/models/__init__.py

@@ -1188,6 +1188,7 @@ if TYPE_CHECKING:
     )
     from .tokenizedassetsohlcinterval import TokenizedAssetsOhlcInterval
     from .tokenizedassetsohlcrange import TokenizedAssetsOhlcRange
+    from .tokenizedassetspnl import TokenizedAssetsPnl, TokenizedAssetsPnlTypedDict
     from .tokenizedassetspositionsresponse import (
         TokenizedAssetsPositionsResponse,
         TokenizedAssetsPositionsResponseTypedDict,
@@ -1692,6 +1693,7 @@ if TYPE_CHECKING:
         V2GlobalMarketsPerpsPositionsRequestTypedDict,
     )
     from .v2_tokenized_assets_markets_symbol_op import (
+        V2TokenizedAssetsMarketsSymbolChain,
         V2TokenizedAssetsMarketsSymbolRequest,
         V2TokenizedAssetsMarketsSymbolRequestTypedDict,
     )
@@ -2652,6 +2654,8 @@ __all__ = [
     "TokenizedAssetsMarketsListResponseTypedDict",
     "TokenizedAssetsOhlcInterval",
     "TokenizedAssetsOhlcRange",
+    "TokenizedAssetsPnl",
+    "TokenizedAssetsPnlTypedDict",
     "TokenizedAssetsPositionsResponse",
     "TokenizedAssetsPositionsResponseTypedDict",
     "TokenizedAssetsQuoteRequest",
@@ -2966,6 +2970,7 @@ __all__ = [
     "V2GlobalMarketsPerpsPositionsRequestTypedDict",
     "V2TokenizedAssetsMarketsRequest",
     "V2TokenizedAssetsMarketsRequestTypedDict",
+    "V2TokenizedAssetsMarketsSymbolChain",
     "V2TokenizedAssetsMarketsSymbolRequest",
     "V2TokenizedAssetsMarketsSymbolRequestTypedDict",
     "V2TokenizedAssetsOrderOrderHashCancelRequest",
@@ -3874,6 +3879,8 @@ _dynamic_imports: dict[str, str] = {
     "TokenizedAssetsMarketsListResponseTypedDict": ".tokenizedassetsmarketslistresponse",
     "TokenizedAssetsOhlcInterval": ".tokenizedassetsohlcinterval",
     "TokenizedAssetsOhlcRange": ".tokenizedassetsohlcrange",
+    "TokenizedAssetsPnl": ".tokenizedassetspnl",
+    "TokenizedAssetsPnlTypedDict": ".tokenizedassetspnl",
     "TokenizedAssetsPositionsResponse": ".tokenizedassetspositionsresponse",
     "TokenizedAssetsPositionsResponseTypedDict": ".tokenizedassetspositionsresponse",
     "TokenizedAssetsQuoteRequest": ".tokenizedassetsquoterequest",
@@ -4213,6 +4220,7 @@ _dynamic_imports: dict[str, str] = {
     "V2GlobalMarketsPerpsOpportunitiesRequestTypedDict": ".v2_global_markets_perps_opportunitiesop",
     "V2GlobalMarketsPerpsPositionsRequest": ".v2_global_markets_perps_positionsop",
     "V2GlobalMarketsPerpsPositionsRequestTypedDict": ".v2_global_markets_perps_positionsop",
+    "V2TokenizedAssetsMarketsSymbolChain": ".v2_tokenized_assets_markets_symbol_op",
     "V2TokenizedAssetsMarketsSymbolRequest": ".v2_tokenized_assets_markets_symbol_op",
     "V2TokenizedAssetsMarketsSymbolRequestTypedDict": ".v2_tokenized_assets_markets_symbol_op",
     "V2TokenizedAssetsMarketsRequest": ".v2_tokenized_assets_marketsop",

{compass_api_sdk-2.2.63rc1 → compass_api_sdk-2.2.65}/src/compass_api_sdk/models/compass_api_backend_v2_models_tokenized_assets_read_response_positions_position.py

@@ -4,6 +4,7 @@ from __future__ import annotations
 from .chain import Chain
 from .tokenizedassetclass import TokenizedAssetClass
 from .tokenizedassetprovider import TokenizedAssetProvider
+from .tokenizedassetspnl import TokenizedAssetsPnl, TokenizedAssetsPnlTypedDict
 from compass_api_sdk.types import (
     BaseModel,
     Nullable,
@@ -48,6 +49,8 @@ class CompassAPIBackendV2ModelsTokenizedAssetsReadResponsePositionsPositionTyped
     """
     chain: NotRequired[Chain]
     r"""The chain to use."""
+    pnl: NotRequired[Nullable[TokenizedAssetsPnlTypedDict]]
+    r"""Realized + unrealized PnL for this position, or `null` when it cannot be priced (no current price, or externally-funded inventory with no on-chain cost basis)."""
 
 
 class CompassAPIBackendV2ModelsTokenizedAssetsReadResponsePositionsPosition(BaseModel):
@@ -91,12 +94,22 @@ class CompassAPIBackendV2ModelsTokenizedAssetsReadResponsePositionsPosition(Base
     chain: Optional[Chain] = None
     r"""The chain to use."""
 
+    pnl: OptionalNullable[TokenizedAssetsPnl] = UNSET
+    r"""Realized + unrealized PnL for this position, or `null` when it cannot be priced (no current price, or externally-funded inventory with no on-chain cost basis)."""
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
         optional_fields = set(
-            ["current_price_usd", "balance_usd", "provider", "asset_class", "chain"]
+            [
+                "current_price_usd",
+                "balance_usd",
+                "provider",
+                "asset_class",
+                "chain",
+                "pnl",
+            ]
         )
-        nullable_fields = set(["current_price_usd", "balance_usd"])
+        nullable_fields = set(["current_price_usd", "balance_usd", "pnl"])
         serialized = handler(self)
         m = {}
 

compass_api_sdk-2.2.65/src/compass_api_sdk/models/tokenizedassetspnl.py

@@ -0,0 +1,56 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compass_api_sdk.types import BaseModel
+from typing_extensions import TypedDict
+
+
+class TokenizedAssetsPnlTypedDict(TypedDict):
+    r"""Realized + unrealized PnL for a tokenized-asset position.
+
+    Mirrors Earn's ``pnl`` shape so SDK/widget reuse is trivial. Cost basis is
+    the USDC paid for the position through its product account; ``current_value``
+    marks the held balance to the current price. All amounts are USD decimal
+    strings; ``total_pnl_percent`` is a percentage (also a decimal string).
+    """
+
+    total_deposited: str
+    r"""Total USDC paid for this position over all time."""
+    current_value: str
+    r"""Current USD value of the held balance (`balance * current_price_usd`)."""
+    unrealized_pnl: str
+    r"""`current_value` minus the remaining cost basis."""
+    realized_pnl: str
+    r"""Realized profit/loss banked from past sales."""
+    total_pnl: str
+    r"""`unrealized_pnl + realized_pnl`."""
+    total_pnl_percent: str
+    r"""`(total_pnl / total_deposited) * 100`."""
+
+
+class TokenizedAssetsPnl(BaseModel):
+    r"""Realized + unrealized PnL for a tokenized-asset position.
+
+    Mirrors Earn's ``pnl`` shape so SDK/widget reuse is trivial. Cost basis is
+    the USDC paid for the position through its product account; ``current_value``
+    marks the held balance to the current price. All amounts are USD decimal
+    strings; ``total_pnl_percent`` is a percentage (also a decimal string).
+    """
+
+    total_deposited: str
+    r"""Total USDC paid for this position over all time."""
+
+    current_value: str
+    r"""Current USD value of the held balance (`balance * current_price_usd`)."""
+
+    unrealized_pnl: str
+    r"""`current_value` minus the remaining cost basis."""
+
+    realized_pnl: str
+    r"""Realized profit/loss banked from past sales."""
+
+    total_pnl: str
+    r"""`unrealized_pnl + realized_pnl`."""
+
+    total_pnl_percent: str
+    r"""`(total_pnl / total_deposited) * 100`."""

{compass_api_sdk-2.2.63rc1 → compass_api_sdk-2.2.65}/src/compass_api_sdk/models/tokenizedassetspositionsresponse.py

@@ -5,7 +5,14 @@ from .compass_api_backend_v2_models_tokenized_assets_read_response_positions_pos
     CompassAPIBackendV2ModelsTokenizedAssetsReadResponsePositionsPosition,
     CompassAPIBackendV2ModelsTokenizedAssetsReadResponsePositionsPositionTypedDict,
 )
-from compass_api_sdk.types import BaseModel, UNSET_SENTINEL
+from .tokenizedassetspnl import TokenizedAssetsPnl, TokenizedAssetsPnlTypedDict
+from compass_api_sdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
 from pydantic import model_serializer
 from typing import List, Optional
 from typing_extensions import NotRequired, TypedDict
@@ -24,6 +31,8 @@ class TokenizedAssetsPositionsResponseTypedDict(TypedDict):
         ]
     ]
     r"""Non-zero positions only; tokens with a zero balance are omitted."""
+    pnl: NotRequired[Nullable[TokenizedAssetsPnlTypedDict]]
+    r"""Account-level PnL summed across positions that have a known PnL; `null` when no position can be priced."""
 
 
 class TokenizedAssetsPositionsResponse(BaseModel):
@@ -40,18 +49,30 @@ class TokenizedAssetsPositionsResponse(BaseModel):
     ] = None
     r"""Non-zero positions only; tokens with a zero balance are omitted."""
 
+    pnl: OptionalNullable[TokenizedAssetsPnl] = UNSET
+    r"""Account-level PnL summed across positions that have a known PnL; `null` when no position can be priced."""
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = set(["positions"])
+        optional_fields = set(["positions", "pnl"])
+        nullable_fields = set(["pnl"])
         serialized = handler(self)
         m = {}
 
         for n, f in type(self).model_fields.items():
             k = f.alias or n
             val = serialized.get(k, serialized.get(n))
+            is_nullable_and_explicitly_set = (
+                k in nullable_fields
+                and (self.__pydantic_fields_set__.intersection({n}))  # pylint: disable=no-member
+            )
 
             if val != UNSET_SENTINEL:
-                if val is not None or k not in optional_fields:
+                if (
+                    val is not None
+                    or k not in optional_fields
+                    or is_nullable_and_explicitly_set
+                ):
                     m[k] = val
 
         return m

{compass_api_sdk-2.2.63rc1 → compass_api_sdk-2.2.65}/src/compass_api_sdk/models/tokenizedassetstraderequest.py

@@ -40,9 +40,9 @@ class TokenizedAssetsTradeRequestTypedDict(TypedDict):
     """
 
     token_in: str
-    r"""Token to spend. For a buy this is any supported token (e.g. 'USDC'); for a sell it must be a swap-traded tokenized asset (e.g. 'mTBILL')."""
+    r"""Token to spend. For a buy this must be a stablecoin the Midas issuance vault accepts (USDC on every supported network; mBASIS also accepts USDT/DAI on Ethereum). For a sell it is the Midas RWA asset to redeem (e.g. 'mTBILL')."""
     token_out: str
-    r"""Token to receive. For a buy this must be a swap-traded tokenized asset (e.g. 'mTBILL'); for a sell it is any supported token."""
+    r"""Token to receive. For a buy this is the Midas RWA asset to mint (e.g. 'mTBILL'); for a sell it is the payout stablecoin (USDC)."""
     amount_in: TokenizedAssetsTradeRequestAmountInTypedDict
     r"""Human-readable amount of `token_in` to trade (token units, not wei)."""
     owner: str
@@ -63,10 +63,10 @@ class TokenizedAssetsTradeRequest(BaseModel):
     """
 
     token_in: str
-    r"""Token to spend. For a buy this is any supported token (e.g. 'USDC'); for a sell it must be a swap-traded tokenized asset (e.g. 'mTBILL')."""
+    r"""Token to spend. For a buy this must be a stablecoin the Midas issuance vault accepts (USDC on every supported network; mBASIS also accepts USDT/DAI on Ethereum). For a sell it is the Midas RWA asset to redeem (e.g. 'mTBILL')."""
 
     token_out: str
-    r"""Token to receive. For a buy this must be a swap-traded tokenized asset (e.g. 'mTBILL'); for a sell it is any supported token."""
+    r"""Token to receive. For a buy this is the Midas RWA asset to mint (e.g. 'mTBILL'); for a sell it is the payout stablecoin (USDC)."""
 
     amount_in: TokenizedAssetsTradeRequestAmountIn
     r"""Human-readable amount of `token_in` to trade (token units, not wei)."""

{compass_api_sdk-2.2.63rc1 → compass_api_sdk-2.2.65}/src/compass_api_sdk/models/v2_tokenized_assets_markets_symbol_op.py

@@ -11,12 +11,26 @@ from compass_api_sdk.types import (
     UNSET_SENTINEL,
 )
 from compass_api_sdk.utils import FieldMetadata, PathParamMetadata, QueryParamMetadata
+from enum import Enum
 from pydantic import model_serializer
+from typing import Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
+class V2TokenizedAssetsMarketsSymbolChain(str, Enum):
+    r"""The chain to use."""
+
+    BASE = "base"
+    ETHEREUM = "ethereum"
+    ARBITRUM = "arbitrum"
+    HYPEREVM = "hyperevm"
+    TEMPO = "tempo"
+
+
 class V2TokenizedAssetsMarketsSymbolRequestTypedDict(TypedDict):
     symbol: str
+    chain: NotRequired[V2TokenizedAssetsMarketsSymbolChain]
+    r"""Network the market is deployed on (defaults to Ethereum). A token deployed on multiple chains (e.g. Midas RWA on Ethereum and Base) is resolved per chain; 404 if the symbol isn't deployed there. Ondo equities are Ethereum-only."""
     interval: NotRequired[Nullable[TokenizedAssetsOhlcInterval]]
     r"""Optional candle interval. Must be paired with `range` and form a valid `(interval, range)` pair to include OHLC candles in the response."""
     range: NotRequired[Nullable[TokenizedAssetsOhlcRange]]
@@ -28,6 +42,12 @@ class V2TokenizedAssetsMarketsSymbolRequest(BaseModel):
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
 
+    chain: Annotated[
+        Optional[V2TokenizedAssetsMarketsSymbolChain],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Network the market is deployed on (defaults to Ethereum). A token deployed on multiple chains (e.g. Midas RWA on Ethereum and Base) is resolved per chain; 404 if the symbol isn't deployed there. Ondo equities are Ethereum-only."""
+
     interval: Annotated[
         OptionalNullable[TokenizedAssetsOhlcInterval],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
@@ -42,7 +62,7 @@ class V2TokenizedAssetsMarketsSymbolRequest(BaseModel):
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = set(["interval", "range"])
+        optional_fields = set(["chain", "interval", "range"])
         nullable_fields = set(["interval", "range"])
         serialized = handler(self)
         m = {}