compass_api_sdk 0.1.3__py3-none-any.whl → 0.1.5__py3-none-any.whl

compassapisdk/models/skybuyrequest.py

@@ -0,0 +1,56 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compassapisdk.types import BaseModel
+from compassapisdk.utils import validate_const
+from enum import Enum
+import pydantic
+from pydantic.functional_validators import AfterValidator
+from typing import Literal, Optional, Union
+from typing_extensions import Annotated, TypeAliasType, TypedDict
+
+
+class TokenIn(str, Enum):
+    r"""The token you would like to swap 1:1 for USDS. Choose from DAI or USDC."""
+
+    DAI = "DAI"
+    USDC = "USDC"
+
+
+SkyBuyRequestAmountTypedDict = TypeAliasType(
+    "SkyBuyRequestAmountTypedDict", Union[float, str]
+)
+r"""The amount of USDS you would like to buy 1:1 with 'token_in'."""
+
+
+SkyBuyRequestAmount = TypeAliasType("SkyBuyRequestAmount", Union[float, str])
+r"""The amount of USDS you would like to buy 1:1 with 'token_in'."""
+
+
+class SkyBuyRequestTypedDict(TypedDict):
+    token_in: TokenIn
+    r"""The token you would like to swap 1:1 for USDS. Choose from DAI or USDC."""
+    amount: SkyBuyRequestAmountTypedDict
+    r"""The amount of USDS you would like to buy 1:1 with 'token_in'."""
+    sender: str
+    r"""The address of the transaction sender."""
+    chain: Literal["ethereum:mainnet"]
+
+
+class SkyBuyRequest(BaseModel):
+    token_in: TokenIn
+    r"""The token you would like to swap 1:1 for USDS. Choose from DAI or USDC."""
+
+    amount: SkyBuyRequestAmount
+    r"""The amount of USDS you would like to buy 1:1 with 'token_in'."""
+
+    sender: str
+    r"""The address of the transaction sender."""
+
+    CHAIN: Annotated[
+        Annotated[
+            Optional[Literal["ethereum:mainnet"]],
+            AfterValidator(validate_const("ethereum:mainnet")),
+        ],
+        pydantic.Field(alias="chain"),
+    ] = "ethereum:mainnet"

compassapisdk/models/skycheckpositionresponse.py

@@ -0,0 +1,18 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compassapisdk.types import BaseModel
+from typing_extensions import TypedDict
+
+
+class SkyCheckPositionResponseTypedDict(TypedDict):
+    usds_value_of_deposits: str
+    r"""The USDS equivalent value of the user's deposits thus far (principal + yield)."""
+    shares: int
+
+
+class SkyCheckPositionResponse(BaseModel):
+    usds_value_of_deposits: str
+    r"""The USDS equivalent value of the user's deposits thus far (principal + yield)."""
+
+    shares: int

compassapisdk/models/skydepositrequest.py

@@ -0,0 +1,85 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compassapisdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from compassapisdk.utils import validate_const
+import pydantic
+from pydantic import model_serializer
+from pydantic.functional_validators import AfterValidator
+from typing import Literal, Optional, Union
+from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
+
+
+SkyDepositRequestAmountTypedDict = TypeAliasType(
+    "SkyDepositRequestAmountTypedDict", Union[float, str]
+)
+r"""The amount of USDS you would like to deposit for sUSDS to earn yield."""
+
+
+SkyDepositRequestAmount = TypeAliasType("SkyDepositRequestAmount", Union[float, str])
+r"""The amount of USDS you would like to deposit for sUSDS to earn yield."""
+
+
+class SkyDepositRequestTypedDict(TypedDict):
+    amount: SkyDepositRequestAmountTypedDict
+    r"""The amount of USDS you would like to deposit for sUSDS to earn yield."""
+    sender: str
+    r"""The address of the transaction sender."""
+    receiver: NotRequired[Nullable[str]]
+    r"""The address which will receive the sUSDS. Defaults to the sender."""
+    chain: Literal["ethereum:mainnet"]
+
+
+class SkyDepositRequest(BaseModel):
+    amount: SkyDepositRequestAmount
+    r"""The amount of USDS you would like to deposit for sUSDS to earn yield."""
+
+    sender: str
+    r"""The address of the transaction sender."""
+
+    receiver: OptionalNullable[str] = UNSET
+    r"""The address which will receive the sUSDS. Defaults to the sender."""
+
+    CHAIN: Annotated[
+        Annotated[
+            Optional[Literal["ethereum:mainnet"]],
+            AfterValidator(validate_const("ethereum:mainnet")),
+        ],
+        pydantic.Field(alias="chain"),
+    ] = "ethereum:mainnet"
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["receiver", "chain"]
+        nullable_fields = ["receiver"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            serialized.pop(k, None)
+
+            optional_nullable = k in optional_fields and k in nullable_fields
+            is_set = (
+                self.__pydantic_fields_set__.intersection({n})
+                or k in null_default_fields
+            )  # pylint: disable=no-member
+
+            if val is not None and val != UNSET_SENTINEL:
+                m[k] = val
+            elif val != UNSET_SENTINEL and (
+                not k in optional_fields or (optional_nullable and is_set)
+            ):
+                m[k] = val
+
+        return m

compassapisdk/models/skysellrequest.py

@@ -0,0 +1,56 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compassapisdk.types import BaseModel
+from compassapisdk.utils import validate_const
+from enum import Enum
+import pydantic
+from pydantic.functional_validators import AfterValidator
+from typing import Literal, Optional, Union
+from typing_extensions import Annotated, TypeAliasType, TypedDict
+
+
+class TokenOut(str, Enum):
+    r"""The token you would like to swap 1:1 with USDS. Choose from DAI or USDC."""
+
+    DAI = "DAI"
+    USDC = "USDC"
+
+
+SkySellRequestAmountTypedDict = TypeAliasType(
+    "SkySellRequestAmountTypedDict", Union[float, str]
+)
+r"""The amount of USDS you would like to sell 1:1 for 'token_out'."""
+
+
+SkySellRequestAmount = TypeAliasType("SkySellRequestAmount", Union[float, str])
+r"""The amount of USDS you would like to sell 1:1 for 'token_out'."""
+
+
+class SkySellRequestTypedDict(TypedDict):
+    token_out: TokenOut
+    r"""The token you would like to swap 1:1 with USDS. Choose from DAI or USDC."""
+    amount: SkySellRequestAmountTypedDict
+    r"""The amount of USDS you would like to sell 1:1 for 'token_out'."""
+    sender: str
+    r"""The address of the transaction sender."""
+    chain: Literal["ethereum:mainnet"]
+
+
+class SkySellRequest(BaseModel):
+    token_out: TokenOut
+    r"""The token you would like to swap 1:1 with USDS. Choose from DAI or USDC."""
+
+    amount: SkySellRequestAmount
+    r"""The amount of USDS you would like to sell 1:1 for 'token_out'."""
+
+    sender: str
+    r"""The address of the transaction sender."""
+
+    CHAIN: Annotated[
+        Annotated[
+            Optional[Literal["ethereum:mainnet"]],
+            AfterValidator(validate_const("ethereum:mainnet")),
+        ],
+        pydantic.Field(alias="chain"),
+    ] = "ethereum:mainnet"

compassapisdk/models/skywithdrawrequest.py

@@ -0,0 +1,75 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compassapisdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from compassapisdk.utils import validate_const
+import pydantic
+from pydantic import model_serializer
+from pydantic.functional_validators import AfterValidator
+from typing import Any, Literal, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class SkyWithdrawRequestTypedDict(TypedDict):
+    amount: Any
+    r"""The amount of USDS you would like to withdraw. If set to 'ALL', your total deposited USDS amount will be withdrawn."""
+    sender: str
+    r"""The address of the transaction sender."""
+    receiver: NotRequired[Nullable[str]]
+    r"""The address which will receive the withdrawn USDS. Defaults to the sender."""
+    chain: Literal["ethereum:mainnet"]
+
+
+class SkyWithdrawRequest(BaseModel):
+    amount: Any
+    r"""The amount of USDS you would like to withdraw. If set to 'ALL', your total deposited USDS amount will be withdrawn."""
+
+    sender: str
+    r"""The address of the transaction sender."""
+
+    receiver: OptionalNullable[str] = UNSET
+    r"""The address which will receive the withdrawn USDS. Defaults to the sender."""
+
+    CHAIN: Annotated[
+        Annotated[
+            Optional[Literal["ethereum:mainnet"]],
+            AfterValidator(validate_const("ethereum:mainnet")),
+        ],
+        pydantic.Field(alias="chain"),
+    ] = "ethereum:mainnet"
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["receiver", "chain"]
+        nullable_fields = ["receiver"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            serialized.pop(k, None)
+
+            optional_nullable = k in optional_fields and k in nullable_fields
+            is_set = (
+                self.__pydantic_fields_set__.intersection({n})
+                or k in null_default_fields
+            )  # pylint: disable=no-member
+
+            if val is not None and val != UNSET_SENTINEL:
+                m[k] = val
+            elif val != UNSET_SENTINEL and (
+                not k in optional_fields or (optional_nullable and is_set)
+            ):
+                m[k] = val
+
+        return m

compassapisdk/models/token_addressop.py

@@ -13,6 +13,9 @@ class TokenAddressChain(str, Enum):
     BASE_MAINNET = "base:mainnet"
     ETHEREUM_MAINNET = "ethereum:mainnet"
     ARBITRUM_MAINNET = "arbitrum:mainnet"
+    ETHEREUM_LOCAL = "ethereum:local"
+    ARBITRUM_LOCAL = "arbitrum:local"
+    BASE_LOCAL = "base:local"
 
 
 class TokenAddressToken(str, Enum):

compassapisdk/models/token_balanceop.py

@@ -15,6 +15,9 @@ class TokenBalanceChain(str, Enum):
     BASE_MAINNET = "base:mainnet"
     ETHEREUM_MAINNET = "ethereum:mainnet"
     ARBITRUM_MAINNET = "arbitrum:mainnet"
+    ETHEREUM_LOCAL = "ethereum:local"
+    ARBITRUM_LOCAL = "arbitrum:local"
+    BASE_LOCAL = "base:local"
 
 
 TokenBalanceTokenTypedDict = TypeAliasType(

compassapisdk/models/token_priceop.py

@@ -13,6 +13,9 @@ class TokenPriceChain(str, Enum):
     BASE_MAINNET = "base:mainnet"
     ETHEREUM_MAINNET = "ethereum:mainnet"
     ARBITRUM_MAINNET = "arbitrum:mainnet"
+    ETHEREUM_LOCAL = "ethereum:local"
+    ARBITRUM_LOCAL = "arbitrum:local"
+    BASE_LOCAL = "base:local"
 
 
 class TokenPriceToken(str, Enum):

compassapisdk/models/uniswap_liquidity_provision_in_rangeop.py

@@ -13,6 +13,9 @@ class UniswapLiquidityProvisionInRangeChain(str, Enum):
     BASE_MAINNET = "base:mainnet"
     ETHEREUM_MAINNET = "ethereum:mainnet"
     ARBITRUM_MAINNET = "arbitrum:mainnet"
+    ETHEREUM_LOCAL = "ethereum:local"
+    ARBITRUM_LOCAL = "arbitrum:local"
+    BASE_LOCAL = "base:local"
 
 
 class UniswapLiquidityProvisionInRangeRequestTypedDict(TypedDict):

compassapisdk/models/uniswap_liquidity_provision_positionsop.py

@@ -14,6 +14,9 @@ class UniswapLiquidityProvisionPositionsChain(str, Enum):
     BASE_MAINNET = "base:mainnet"
     ETHEREUM_MAINNET = "ethereum:mainnet"
     ARBITRUM_MAINNET = "arbitrum:mainnet"
+    ETHEREUM_LOCAL = "ethereum:local"
+    ARBITRUM_LOCAL = "arbitrum:local"
+    BASE_LOCAL = "base:local"
 
 
 class UniswapLiquidityProvisionPositionsRequestTypedDict(TypedDict):

compassapisdk/models/uniswap_pool_priceop.py

@@ -13,6 +13,9 @@ class UniswapPoolPriceChain(str, Enum):
     BASE_MAINNET = "base:mainnet"
     ETHEREUM_MAINNET = "ethereum:mainnet"
     ARBITRUM_MAINNET = "arbitrum:mainnet"
+    ETHEREUM_LOCAL = "ethereum:local"
+    ARBITRUM_LOCAL = "arbitrum:local"
+    BASE_LOCAL = "base:local"
 
 
 class UniswapPoolPriceTokenInToken(str, Enum):

compassapisdk/models/uniswap_quote_buy_exactlyop.py

@@ -14,6 +14,9 @@ class UniswapQuoteBuyExactlyChain(str, Enum):
     BASE_MAINNET = "base:mainnet"
     ETHEREUM_MAINNET = "ethereum:mainnet"
     ARBITRUM_MAINNET = "arbitrum:mainnet"
+    ETHEREUM_LOCAL = "ethereum:local"
+    ARBITRUM_LOCAL = "arbitrum:local"
+    BASE_LOCAL = "base:local"
 
 
 class UniswapQuoteBuyExactlyTokenInToken(str, Enum):

compassapisdk/models/uniswap_quote_sell_exactlyop.py

@@ -14,6 +14,9 @@ class UniswapQuoteSellExactlyChain(str, Enum):
     BASE_MAINNET = "base:mainnet"
     ETHEREUM_MAINNET = "ethereum:mainnet"
     ARBITRUM_MAINNET = "arbitrum:mainnet"
+    ETHEREUM_LOCAL = "ethereum:local"
+    ARBITRUM_LOCAL = "arbitrum:local"
+    BASE_LOCAL = "base:local"
 
 
 class UniswapQuoteSellExactlyTokenInToken(str, Enum):

compassapisdk/sdk.py

@@ -10,6 +10,7 @@ from compassapisdk._hooks import SDKHooks
 from compassapisdk.aave_v3 import AaveV3
 from compassapisdk.aerodrome_slipstream import AerodromeSlipstream
 from compassapisdk.morpho import Morpho
+from compassapisdk.sky import Sky
 from compassapisdk.token_sdk import TokenSDK
 from compassapisdk.transaction_batching import TransactionBatching
 from compassapisdk.types import OptionalNullable, UNSET
@@ -26,6 +27,7 @@ class CompassAPISDK(BaseSDK):
     aave_v3: AaveV3
     aerodrome_slipstream: AerodromeSlipstream
     morpho: Morpho
+    sky: Sky
     token: TokenSDK
     uniswap_v3: UniswapV3
     universal: Universal
@@ -130,6 +132,7 @@ class CompassAPISDK(BaseSDK):
         self.aave_v3 = AaveV3(self.sdk_configuration)
         self.aerodrome_slipstream = AerodromeSlipstream(self.sdk_configuration)
         self.morpho = Morpho(self.sdk_configuration)
+        self.sky = Sky(self.sdk_configuration)
         self.token = TokenSDK(self.sdk_configuration)
         self.uniswap_v3 = UniswapV3(self.sdk_configuration)
         self.universal = Universal(self.sdk_configuration)

compassapisdk/sdkconfiguration.py

@@ -17,8 +17,8 @@ from typing import Callable, Dict, Optional, Tuple, Union
 
 
 SERVERS = [
-    "https://api.compasslabs.ai",
-    # Production server
+    "http://0.0.0.0:80",
+    # Development server
 ]
 """Contains the list of servers available to the SDK"""