nado-protocol 0.1.1__py3-none-any.whl → 0.1.3__py3-none-any.whl

nado_protocol/engine_client/types/models.py

@@ -15,20 +15,6 @@ class EngineStatus(StrEnum):
     FAILED = "failed"
 
 
-class MintLp(NadoBaseModel):
-    product_id: int
-    subaccount: str
-    amount_base: str
-    quote_amount_low: str
-    quote_amount_high: str
-
-
-class BurnLp(NadoBaseModel):
-    product_id: int
-    subaccount: str
-    amount_lp: str
-
-
 class ApplyDelta(NadoBaseModel):
     product_id: int
     subaccount: str
@@ -36,14 +22,6 @@ class ApplyDelta(NadoBaseModel):
     v_quote_delta: str
 
 
-class MintLpTx(NadoBaseModel):
-    mint_lp: MintLp
-
-
-class BurnLpTx(NadoBaseModel):
-    burn_lp: BurnLp
-
-
 class ApplyDeltaTx(NadoBaseModel):
     apply_delta: ApplyDelta
 
@@ -54,26 +32,15 @@ class SubaccountHealth(NadoBaseModel):
     health: str
 
 
-class SpotLpBalance(NadoBaseModel):
-    amount: str
-
-
 class SpotBalance(NadoBaseModel):
     amount: str
-    last_cumulative_multiplier_x18: str
 
 
 class SpotProductBalance(NadoBaseModel):
     product_id: int
-    lp_balance: SpotLpBalance
     balance: SpotBalance
 
 
-class PerpLpBalance(NadoBaseModel):
-    amount: str
-    last_cumulative_funding_x18: str
-
-
 class PerpBalance(NadoBaseModel):
     amount: str
     v_quote_balance: str
@@ -82,7 +49,6 @@ class PerpBalance(NadoBaseModel):
 
 class PerpProductBalance(NadoBaseModel):
     product_id: int
-    lp_balance: PerpLpBalance
     balance: PerpBalance
 
 
@@ -91,7 +57,7 @@ class ProductRisk(NadoBaseModel):
     short_weight_initial_x18: str
     long_weight_maintenance_x18: str
     short_weight_maintenance_x18: str
-    large_position_penalty_x18: str
+    price_x18: str
 
 
 class ProductBookInfo(NadoBaseModel):
@@ -99,7 +65,6 @@ class ProductBookInfo(NadoBaseModel):
     price_increment_x18: str
     min_size: str
     collected_fees: str
-    lp_spread_x18: str
 
 
 class BaseProduct(NadoBaseModel):
@@ -109,16 +74,14 @@ class BaseProduct(NadoBaseModel):
     book_info: ProductBookInfo
 
 
-class BaseProductLpState(NadoBaseModel):
-    supply: str
-
-
 class SpotProductConfig(NadoBaseModel):
     token: str
     interest_inflection_util_x18: str
     interest_floor_x18: str
     interest_small_cap_x18: str
     interest_large_cap_x18: str
+    withdraw_fee_x18: str
+    min_deposit_rate_x18: str
 
 
 class SpotProductState(NadoBaseModel):
@@ -128,20 +91,9 @@ class SpotProductState(NadoBaseModel):
     total_borrows_normalized: str
 
 
-class SpotProductLpAmount(NadoBaseModel):
-    amount: str
-    last_cumulative_multiplier_x18: str
-
-
-class SpotProductLpState(BaseProductLpState):
-    quote: SpotProductLpAmount
-    base: SpotProductLpAmount
-
-
 class SpotProduct(BaseProduct):
     config: SpotProductConfig
     state: SpotProductState
-    lp_state: SpotProductLpState
 
 
 class PerpProductState(NadoBaseModel):
@@ -151,16 +103,8 @@ class PerpProductState(NadoBaseModel):
     open_interest: str
 
 
-class PerpProductLpState(BaseProductLpState):
-    last_cumulative_funding_x18: str
-    cumulative_funding_per_lp_x18: str
-    base: str
-    quote: str
-
-
 class PerpProduct(BaseProduct):
     state: PerpProductState
-    lp_state: PerpProductLpState
 
 
 class MaxOrderSizeDirection(StrEnum):

nado_protocol/engine_client/types/query.py

@@ -5,12 +5,10 @@ from nado_protocol.utils.model import NadoBaseModel
 from nado_protocol.engine_client.types.models import (
     ApplyDeltaTx,
     Asset,
-    BurnLpTx,
     EngineStatus,
     IsolatedPosition,
     MarketPair,
     MaxOrderSizeDirection,
-    MintLpTx,
     ProductSymbol,
     ResponseStatus,
     SpotApr,
@@ -42,7 +40,7 @@ class EngineQueryType(StrEnum):
     MARKET_PRICE = "market_price"
     MAX_ORDER_SIZE = "max_order_size"
     MAX_WITHDRAWABLE = "max_withdrawable"
-    MAX_LP_MINTABLE = "max_lp_mintable"
+    MAX_NLP_MINTABLE = "max_nlp_mintable"
     SUBACCOUNT_INFO = "subaccount_info"
     SUBACCOUNT_ORDERS = "subaccount_orders"
     ORDERS = "orders"
@@ -93,7 +91,7 @@ class QueryIsolatedPositionsParams(NadoBaseModel):
     subaccount: str
 
 
-QuerySubaccountInfoTx = Union[MintLpTx, BurnLpTx, ApplyDeltaTx]
+QuerySubaccountInfoTx = Union[ApplyDeltaTx]
 
 
 class QuerySubaccountInfoParams(NadoBaseModel):
@@ -202,7 +200,7 @@ class QueryMaxLpMintableParams(SpotLeverageSerializerMixin):
     Parameters for querying the maximum liquidity that can be minted by a specified sender for a specific product.
     """
 
-    type = EngineQueryType.MAX_LP_MINTABLE.value
+    type = EngineQueryType.MAX_NLP_MINTABLE.value
     sender: str
     product_id: int
 
@@ -264,7 +262,6 @@ class ContractsData(NadoBaseModel):
 
     chain_id: str
     endpoint_addr: str
-    book_addrs: list[str]
 
 
 class NoncesData(NadoBaseModel):

nado_protocol/indexer_client/query.py

@@ -2,7 +2,7 @@ from typing import Optional, Union
 import requests
 from functools import singledispatchmethod
 from nado_protocol.indexer_client.types import IndexerClientOpts
-from nado_protocol.indexer_client.types.models import MarketType, VrtxTokenQueryType
+from nado_protocol.indexer_client.types.models import MarketType
 from nado_protocol.indexer_client.types.query import (
     IndexerCandlesticksParams,
     IndexerCandlesticksData,
@@ -44,7 +44,7 @@ from nado_protocol.indexer_client.types.query import (
     IndexerTokenRewardsParams,
     IndexerUsdcPriceParams,
     IndexerUsdcPriceData,
-    IndexerVrtxMerkleProofsParams,
+    IndexerTokenMerkleProofsParams,
     IndexerFoundationRewardsMerkleProofsParams,
     IndexerMerkleProofsData,
     IndexerInterestAndFundingParams,
@@ -413,9 +413,9 @@ class IndexerQueryClient:
             IndexerUsdcPriceData,
         )
 
-    def get_vrtx_merkle_proofs(self, address: str) -> IndexerMerkleProofsData:
+    def get_token_merkle_proofs(self, address: str) -> IndexerMerkleProofsData:
         return ensure_data_type(
-            self.query(IndexerVrtxMerkleProofsParams(address=address)).data,
+            self.query(IndexerTokenMerkleProofsParams(address=address)).data,
             IndexerMerkleProofsData,
         )
 
@@ -459,8 +459,3 @@ class IndexerQueryClient:
         if max_trade_id is not None:
             url += f"&max_trade_id={max_trade_id}"
         return ensure_data_type(self._query_v2(url), list)
-
-    def get_vrtx_token_info(self, query_type: VrtxTokenQueryType) -> float:
-        return ensure_data_type(
-            self._query_v2(f"{self.url_v2}/vrtx?q={str(query_type)}"), float
-        )

nado_protocol/indexer_client/types/__init__.py

@@ -86,10 +86,10 @@ __all__ = [
     "IndexerWithdrawCollateralTx",
     "IndexerLiquidateSubaccountTxData",
     "IndexerLiquidateSubaccountTx",
-    "IndexerMintLpTxData",
-    "IndexerMintLpTx",
-    "IndexerBurnLpTxData",
-    "IndexerBurnLpTx",
+    "IndexerMintNlpTxData",
+    "IndexerMintNlpTx",
+    "IndexerBurnNlpTxData",
+    "IndexerBurnNlpTx",
     "IndexerTxData",
     "IndexerTx",
     "IndexerSpotProductBalanceData",
@@ -115,7 +115,6 @@ __all__ = [
     "IndexerTickerInfo",
     "IndexerPerpContractInfo",
     "IndexerTradeInfo",
-    "VrtxTokenQueryType",
     "IndexerTickersData",
     "IndexerPerpContractsData",
     "IndexerHistoricalTradesData",

nado_protocol/indexer_client/types/models.py

@@ -20,8 +20,8 @@ class IndexerEventType(StrEnum):
     MATCH_ORDERS = "match_orders"
     MATCH_ORDER_A_M_M = "match_order_a_m_m"
     SWAP_AMM = "swap_a_m_m"
-    MINT_LP = "mint_lp"
-    BURN_LP = "burn_lp"
+    MINT_NLP = "mint_nlp"
+    BURN_NLP = "burn_nlp"
     MANUAL_ASSERT = "manual_assert"
     LINK_SIGNER = "link_signer"
     TRANSFER_QUOTE = "transfer_quote"
@@ -118,36 +118,32 @@ class IndexerLiquidateSubaccountTx(NadoBaseModel):
     liquidate_subaccount: IndexerLiquidateSubaccountTxData
 
 
-class IndexerMintLpTxData(NadoBaseModel):
+class IndexerMintNlpTxData(NadoBaseModel):
     sender: str
-    product_id: int
-    amount_base: str
-    quote_amount_low: str
-    quote_amount_high: str
+    quote_amount: str
     nonce: int
 
 
-class IndexerMintLpTx(NadoBaseModel):
-    mint_lp: IndexerMintLpTxData
+class IndexerMintNlpTx(NadoBaseModel):
+    mint_nlp: IndexerMintNlpTxData
 
 
-class IndexerBurnLpTxData(NadoBaseModel):
+class IndexerBurnNlpTxData(NadoBaseModel):
     sender: str
-    product_id: int
-    amount: str
+    nlp_amount: str
     nonce: int
 
 
-class IndexerBurnLpTx(NadoBaseModel):
-    burn_lp: IndexerBurnLpTxData
+class IndexerBurnNlpTx(NadoBaseModel):
+    burn_nlp: IndexerBurnNlpTxData
 
 
 IndexerTxData = Union[
     IndexerMatchOrdersTx,
     IndexerWithdrawCollateralTx,
     IndexerLiquidateSubaccountTx,
-    IndexerMintLpTx,
-    IndexerBurnLpTx,
+    IndexerMintNlpTx,
+    IndexerBurnNlpTx,
 ]
 
 
@@ -186,8 +182,6 @@ class IndexerEventTrackedData(NadoBaseModel):
     net_funding_cumulative: str
     net_entry_unrealized: str
     net_entry_cumulative: str
-    net_entry_lp_unrealized: str
-    net_entry_lp_cumulative: str
 
 
 class IndexerEvent(IndexerBaseModel, IndexerEventTrackedData):
@@ -303,6 +297,10 @@ class IndexerLiquidatableAccount(NadoBaseModel):
 class IndexerSubaccount(NadoBaseModel):
     id: str
     subaccount: str
+    address: str
+    subaccount_name: str
+    created_at: str
+    isolated: bool
 
 
 class IndexerMerkleProof(NadoBaseModel):
@@ -357,8 +355,3 @@ class IndexerTradeInfo(NadoBaseModel):
 class MarketType(StrEnum):
     SPOT = "spot"
     PERP = "perp"
-
-
-class VrtxTokenQueryType(StrEnum):
-    TOTAL_SUPPLY = "total_supply"
-    CIRCULATING_SUPPLY = "circulating_supply"

nado_protocol/indexer_client/types/query.py

@@ -49,7 +49,8 @@ class IndexerQueryType(StrEnum):
     REFERRAL_CODE = "referral_code"
     SUBACCOUNTS = "subaccounts"
     USDC_PRICE = "usdc_price"
-    VRTX_MERKLE_PROOFS = "vrtx_merkle_proofs"
+    # TODO: revise once this endpoint is live
+    TOKEN_MERKLE_PROOFS = "token_merkle_proofs"
     FOUNDATION_REWARDS_MERKLE_PROOFS = "foundation_rewards_merkle_proofs"
     INTEREST_AND_FUNDING = "interest_and_funding"
 
@@ -262,9 +263,9 @@ class IndexerUsdcPriceParams(NadoBaseModel):
     pass
 
 
-class IndexerVrtxMerkleProofsParams(NadoBaseModel):
+class IndexerTokenMerkleProofsParams(NadoBaseModel):
     """
-    Parameters for querying VRTX merkle proofs.
+    Parameters for querying token merkle proofs.
     """
 
     address: str
@@ -308,7 +309,7 @@ IndexerParams = Union[
     IndexerSubaccountsParams,
     IndexerUsdcPriceParams,
     IndexerMarketSnapshotsParams,
-    IndexerVrtxMerkleProofsParams,
+    IndexerTokenMerkleProofsParams,
     IndexerFoundationRewardsMerkleProofsParams,
     IndexerInterestAndFundingParams,
 ]
@@ -460,12 +461,12 @@ class IndexerUsdcPriceRequest(NadoBaseModel):
     usdc_price: IndexerUsdcPriceParams
 
 
-class IndexerVrtxMerkleProofsRequest(NadoBaseModel):
+class IndexerTokenMerkleProofsRequest(NadoBaseModel):
     """
-    Request object for querying VRTX merkle proofs.
+    Request object for querying token merkle proofs.
     """
 
-    vrtx_merkle_proofs: IndexerVrtxMerkleProofsParams
+    token_merkle_proofs: IndexerTokenMerkleProofsParams
 
 
 class IndexerFoundationRewardsMerkleProofsRequest(NadoBaseModel):
@@ -502,7 +503,7 @@ IndexerRequest = Union[
     IndexerSubaccountsRequest,
     IndexerUsdcPriceRequest,
     IndexerMarketSnapshotsRequest,
-    IndexerVrtxMerkleProofsRequest,
+    IndexerTokenMerkleProofsRequest,
     IndexerFoundationRewardsMerkleProofsRequest,
     IndexerInterestAndFundingRequest,
 ]
@@ -794,9 +795,9 @@ def to_indexer_request(params: IndexerParams) -> IndexerRequest:
             IndexerUsdcPriceRequest,
             IndexerQueryType.USDC_PRICE.value,
         ),
-        IndexerVrtxMerkleProofsParams: (
-            IndexerVrtxMerkleProofsRequest,
-            IndexerQueryType.VRTX_MERKLE_PROOFS.value,
+        IndexerTokenMerkleProofsParams: (
+            IndexerTokenMerkleProofsRequest,
+            IndexerQueryType.TOKEN_MERKLE_PROOFS.value,
         ),
         IndexerFoundationRewardsMerkleProofsParams: (
             IndexerFoundationRewardsMerkleProofsRequest,

nado_protocol/trigger_client/execute.py

@@ -89,7 +89,7 @@ class TriggerExecuteClient(NadoBaseExecute):
 
     def place_trigger_order(self, params: PlaceTriggerOrderParams) -> ExecuteResponse:
         params = PlaceTriggerOrderParams.parse_obj(params)
-        params.order = self.prepare_execute_params(params.order, True, True)
+        params.order = self.prepare_execute_params(params.order, True)
         params.signature = params.signature or self._sign(
             NadoExecuteType.PLACE_ORDER, params.order.dict(), params.product_id
         )

nado_protocol/trigger_client/types/execute.py

@@ -46,7 +46,9 @@ class PlaceTriggerOrderRequest(NadoBaseModel):
             raise ValueError("Missing `signature")
         if isinstance(v.order.sender, bytes):
             v.order.serialize_dict(["sender"], bytes32_to_hex)
-        v.order.serialize_dict(["nonce", "priceX18", "amount", "expiration"], str)
+        v.order.serialize_dict(
+            ["nonce", "priceX18", "amount", "expiration", "appendix"], str
+        )
         return v
 
 

nado_protocol/utils/__init__.py

@@ -5,6 +5,7 @@ from nado_protocol.utils.expiration import *
 from nado_protocol.utils.math import *
 from nado_protocol.utils.nonce import *
 from nado_protocol.utils.exceptions import *
+from nado_protocol.utils.order import *
 
 __all__ = [
     "NadoBackendURL",
@@ -24,7 +25,6 @@ __all__ = [
     "OrderType",
     "get_expiration_timestamp",
     "gen_order_nonce",
-    "decode_expiration",
     "to_pow_10",
     "to_x18",
     "from_pow_10",
@@ -34,4 +34,21 @@ __all__ = [
     "BadStatusCodeException",
     "MissingSignerException",
     "InvalidProductId",
+    # Order appendix utilities
+    "OrderAppendixTriggerType",
+    "APPENDIX_VERSION",
+    "AppendixBitFields",
+    "TWAPBitFields",
+    "gen_order_verifying_contract",
+    "pack_twap_appendix_value",
+    "unpack_twap_appendix_value",
+    "build_appendix",
+    "order_reduce_only",
+    "order_is_trigger_order",
+    "order_is_isolated",
+    "order_isolated_margin",
+    "order_version",
+    "order_trigger_type",
+    "order_twap_data",
+    "order_execution_type",
 ]

nado_protocol/utils/backend.py

@@ -13,6 +13,11 @@ class NadoBackendURL(StrEnum):
     DEVNET_INDEXER = "http://localhost:8000"
     DEVNET_TRIGGER = "http://localhost:8080"
 
+    # testnets
+    TESTNET_GATEWAY = "https://gateway.test.nado-backend.xyz/v1"
+    TESTNET_INDEXER = "https://archive.test.nado-backend.xyz/v1"
+    TESTNET_TRIGGER = "https://trigger.test.nado-backend.xyz/v1"
+
 
 PrivateKey = str
 Signer = Union[LocalAccount, PrivateKey]
@@ -29,7 +34,6 @@ class NadoClientOpts(BaseModel):
         linked_signer (Optional[Signer]): An optional signer linked the main subaccount to perform executes on it's behalf.
         chain_id (Optional[int]): An optional network chain ID.
         endpoint_addr (Optional[str]): Nado's endpoint address used for verifying executes.
-        book_addrs (Optional[list[str]]): Nado's book addresses used for verifying order placement.
 
     Notes:
         - The class also includes several methods for validating and sanitizing the input values.
@@ -41,7 +45,6 @@ class NadoClientOpts(BaseModel):
     linked_signer: Optional[Signer] = None
     chain_id: Optional[int] = None
     endpoint_addr: Optional[str] = None
-    book_addrs: Optional[list[str]] = None
 
     class Config:
         arbitrary_types_allowed = True

nado_protocol/utils/exceptions.py

@@ -38,12 +38,12 @@ class InvalidProductId(Exception):
         super().__init__(self.message)
 
 
-class InvalidVrtxClaimParams(Exception):
-    """Raised when providing invalid VRTX claim parameters."""
+class InvalidTokenClaimParams(Exception):
+    """Raised when providing invalid token claim parameters."""
 
     def __init__(
         self,
-        message="Invalid VRTX params. Either `amount` or `claim_all` must be provided",
+        message="Invalid token params. Either `amount` or `claim_all` must be provided",
     ):
         self.message = message
         super().__init__(self.message)