compass_api_sdk 0.9.29__py3-none-any.whl → 0.9.31__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of compass_api_sdk might be problematic. Click here for more details.

@@ -3,10 +3,10 @@
3
3
  import importlib.metadata
4
4
 
5
5
  __title__: str = "compass_api_sdk"
6
- __version__: str = "0.9.29"
6
+ __version__: str = "0.9.31"
7
7
  __openapi_doc_version__: str = "0.0.1"
8
8
  __gen_version__: str = "2.638.5"
9
- __user_agent__: str = "speakeasy-sdk/python 0.9.29 2.638.5 0.0.1 compass_api_sdk"
9
+ __user_agent__: str = "speakeasy-sdk/python 0.9.31 2.638.5 0.0.1 compass_api_sdk"
10
10
 
11
11
  try:
12
12
  if __package__ is not None:
@@ -12,7 +12,7 @@ class AaveLiquidityChangeResponseTypedDict(TypedDict):
12
12
  start_time: datetime
13
13
  r"""Dateime of starting block"""
14
14
  end_time: datetime
15
- r"""Dateime of ending block"""
15
+ r"""Datetime of ending block"""
16
16
 
17
17
 
18
18
  class AaveLiquidityChangeResponse(BaseModel):
@@ -23,4 +23,4 @@ class AaveLiquidityChangeResponse(BaseModel):
23
23
  r"""Dateime of starting block"""
24
24
 
25
25
  end_time: datetime
26
- r"""Dateime of ending block"""
26
+ r"""Datetime of ending block"""
@@ -1664,52 +1664,62 @@ class UniswapV3(BaseSDK):
1664
1664
  http_res,
1665
1665
  )
1666
1666
 
1667
- def liquidity_provision_increase(
1667
+ def liquidity_provision_mint(
1668
1668
  self,
1669
1669
  *,
1670
- token_id: int,
1670
+ token0: models.TokenEnum,
1671
+ token1: models.TokenEnum,
1672
+ fee: models.FeeEnum,
1673
+ tick_lower: int,
1674
+ tick_upper: int,
1671
1675
  amount0_desired: Union[
1672
- models.UniswapIncreaseLiquidityProvisionRequestAmount0Desired,
1673
- models.UniswapIncreaseLiquidityProvisionRequestAmount0DesiredTypedDict,
1676
+ models.UniswapMintLiquidityProvisionRequestAmount0Desired,
1677
+ models.UniswapMintLiquidityProvisionRequestAmount0DesiredTypedDict,
1674
1678
  ],
1675
1679
  amount1_desired: Union[
1676
- models.UniswapIncreaseLiquidityProvisionRequestAmount1Desired,
1677
- models.UniswapIncreaseLiquidityProvisionRequestAmount1DesiredTypedDict,
1680
+ models.UniswapMintLiquidityProvisionRequestAmount1Desired,
1681
+ models.UniswapMintLiquidityProvisionRequestAmount1DesiredTypedDict,
1678
1682
  ],
1679
1683
  amount0_min: Union[
1680
- models.UniswapIncreaseLiquidityProvisionRequestAmount0Min,
1681
- models.UniswapIncreaseLiquidityProvisionRequestAmount0MinTypedDict,
1684
+ models.UniswapMintLiquidityProvisionRequestAmount0Min,
1685
+ models.UniswapMintLiquidityProvisionRequestAmount0MinTypedDict,
1682
1686
  ],
1683
1687
  amount1_min: Union[
1684
- models.UniswapIncreaseLiquidityProvisionRequestAmount1Min,
1685
- models.UniswapIncreaseLiquidityProvisionRequestAmount1MinTypedDict,
1688
+ models.UniswapMintLiquidityProvisionRequestAmount1Min,
1689
+ models.UniswapMintLiquidityProvisionRequestAmount1MinTypedDict,
1686
1690
  ],
1687
1691
  chain: models.Chain,
1688
1692
  sender: str,
1693
+ recipient: OptionalNullable[str] = UNSET,
1689
1694
  retries: OptionalNullable[utils.RetryConfig] = UNSET,
1690
1695
  server_url: Optional[str] = None,
1691
1696
  timeout_ms: Optional[int] = None,
1692
1697
  http_headers: Optional[Mapping[str, str]] = None,
1693
1698
  ) -> models.TxResponse:
1694
- r"""Increase an LP position
1699
+ r"""Open a new LP position
1695
1700
 
1696
- This endpoint allows users to increase their existing Liquidity Provider (LP)
1697
- positions on the Uniswap platform.
1701
+ This endpoint allows users to open a new Liquidity Provider (LP) position on the
1702
+ Uniswap platform.
1698
1703
 
1699
- By providing the necessary parameters, users can add more liquidity to their current
1700
- positions, thereby increasing their stake in the liquidity pool. This operation is
1701
- beneficial for users who wish to enhance their potential earnings from trading fees
1702
- within the pool. The endpoint requires details such as the token pair, additional
1703
- amount to be added, and any other parameters necessary for the liquidity increase
1704
- process.
1704
+ By providing the necessary parameters, users can initiate a minting process to
1705
+ create a new LP token, which represents their stake in a specific liquidity pool.
1706
+ This operation is essential for users looking to participate in liquidity provision,
1707
+ enabling them to earn fees from trades that occur within the pool. The endpoint
1708
+ requires details such as the token pair, amount, and any additional parameters
1709
+ needed for the minting process.
1705
1710
 
1706
- :param token_id: Token ID of the NFT representing the liquidity provisioned position.
1711
+ :param token0: A class representing the token. This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
1712
+ :param token1: A class representing the token. This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
1713
+ :param fee: The transaction fee of a Uniswap pool in bips. Uniswap supports 4 different fee levels.
1714
+ :param tick_lower: The lower tick of the range to mint the position in
1715
+ :param tick_upper: The upper tick of the range to mint the position in
1707
1716
  :param amount0_desired: The desired amount of the first token to deposit
1708
1717
  :param amount1_desired: The desired amount of the second token to deposit
1709
1718
  :param amount0_min: The minimum amount of the first token to deposit
1710
1719
  :param amount1_min: The minimum amount of the second token to deposit
1711
1720
  :param chain: The chain to use.
1712
1721
  :param sender: The address of the transaction sender.
1722
+ :param recipient: The address that will receive the LP tokens
1713
1723
  :param retries: Override the default retry configuration for this method
1714
1724
  :param server_url: Override the default server URL for this method
1715
1725
  :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -1725,19 +1735,24 @@ class UniswapV3(BaseSDK):
1725
1735
  else:
1726
1736
  base_url = self._get_url(base_url, url_variables)
1727
1737
 
1728
- request = models.UniswapIncreaseLiquidityProvisionRequest(
1729
- token_id=token_id,
1738
+ request = models.UniswapMintLiquidityProvisionRequest(
1739
+ token0=token0,
1740
+ token1=token1,
1741
+ fee=fee,
1742
+ tick_lower=tick_lower,
1743
+ tick_upper=tick_upper,
1730
1744
  amount0_desired=amount0_desired,
1731
1745
  amount1_desired=amount1_desired,
1732
1746
  amount0_min=amount0_min,
1733
1747
  amount1_min=amount1_min,
1748
+ recipient=recipient,
1734
1749
  chain=chain,
1735
1750
  sender=sender,
1736
1751
  )
1737
1752
 
1738
1753
  req = self._build_request(
1739
1754
  method="POST",
1740
- path="/v0/uniswap/liquidity_provision/increase",
1755
+ path="/v0/uniswap/liquidity_provision/mint",
1741
1756
  base_url=base_url,
1742
1757
  url_variables=url_variables,
1743
1758
  request=request,
@@ -1753,7 +1768,7 @@ class UniswapV3(BaseSDK):
1753
1768
  False,
1754
1769
  False,
1755
1770
  "json",
1756
- models.UniswapIncreaseLiquidityProvisionRequest,
1771
+ models.UniswapMintLiquidityProvisionRequest,
1757
1772
  ),
1758
1773
  timeout_ms=timeout_ms,
1759
1774
  )
@@ -1770,7 +1785,7 @@ class UniswapV3(BaseSDK):
1770
1785
  hook_ctx=HookContext(
1771
1786
  config=self.sdk_configuration,
1772
1787
  base_url=base_url or "",
1773
- operation_id="uniswap_liquidity_provision_increase",
1788
+ operation_id="uniswap_liquidity_provision_mint",
1774
1789
  oauth2_scopes=[],
1775
1790
  security_source=self.sdk_configuration.security,
1776
1791
  ),
@@ -1807,52 +1822,62 @@ class UniswapV3(BaseSDK):
1807
1822
  http_res,
1808
1823
  )
1809
1824
 
1810
- async def liquidity_provision_increase_async(
1825
+ async def liquidity_provision_mint_async(
1811
1826
  self,
1812
1827
  *,
1813
- token_id: int,
1828
+ token0: models.TokenEnum,
1829
+ token1: models.TokenEnum,
1830
+ fee: models.FeeEnum,
1831
+ tick_lower: int,
1832
+ tick_upper: int,
1814
1833
  amount0_desired: Union[
1815
- models.UniswapIncreaseLiquidityProvisionRequestAmount0Desired,
1816
- models.UniswapIncreaseLiquidityProvisionRequestAmount0DesiredTypedDict,
1834
+ models.UniswapMintLiquidityProvisionRequestAmount0Desired,
1835
+ models.UniswapMintLiquidityProvisionRequestAmount0DesiredTypedDict,
1817
1836
  ],
1818
1837
  amount1_desired: Union[
1819
- models.UniswapIncreaseLiquidityProvisionRequestAmount1Desired,
1820
- models.UniswapIncreaseLiquidityProvisionRequestAmount1DesiredTypedDict,
1838
+ models.UniswapMintLiquidityProvisionRequestAmount1Desired,
1839
+ models.UniswapMintLiquidityProvisionRequestAmount1DesiredTypedDict,
1821
1840
  ],
1822
1841
  amount0_min: Union[
1823
- models.UniswapIncreaseLiquidityProvisionRequestAmount0Min,
1824
- models.UniswapIncreaseLiquidityProvisionRequestAmount0MinTypedDict,
1842
+ models.UniswapMintLiquidityProvisionRequestAmount0Min,
1843
+ models.UniswapMintLiquidityProvisionRequestAmount0MinTypedDict,
1825
1844
  ],
1826
1845
  amount1_min: Union[
1827
- models.UniswapIncreaseLiquidityProvisionRequestAmount1Min,
1828
- models.UniswapIncreaseLiquidityProvisionRequestAmount1MinTypedDict,
1846
+ models.UniswapMintLiquidityProvisionRequestAmount1Min,
1847
+ models.UniswapMintLiquidityProvisionRequestAmount1MinTypedDict,
1829
1848
  ],
1830
1849
  chain: models.Chain,
1831
1850
  sender: str,
1851
+ recipient: OptionalNullable[str] = UNSET,
1832
1852
  retries: OptionalNullable[utils.RetryConfig] = UNSET,
1833
1853
  server_url: Optional[str] = None,
1834
1854
  timeout_ms: Optional[int] = None,
1835
1855
  http_headers: Optional[Mapping[str, str]] = None,
1836
1856
  ) -> models.TxResponse:
1837
- r"""Increase an LP position
1857
+ r"""Open a new LP position
1838
1858
 
1839
- This endpoint allows users to increase their existing Liquidity Provider (LP)
1840
- positions on the Uniswap platform.
1859
+ This endpoint allows users to open a new Liquidity Provider (LP) position on the
1860
+ Uniswap platform.
1841
1861
 
1842
- By providing the necessary parameters, users can add more liquidity to their current
1843
- positions, thereby increasing their stake in the liquidity pool. This operation is
1844
- beneficial for users who wish to enhance their potential earnings from trading fees
1845
- within the pool. The endpoint requires details such as the token pair, additional
1846
- amount to be added, and any other parameters necessary for the liquidity increase
1847
- process.
1862
+ By providing the necessary parameters, users can initiate a minting process to
1863
+ create a new LP token, which represents their stake in a specific liquidity pool.
1864
+ This operation is essential for users looking to participate in liquidity provision,
1865
+ enabling them to earn fees from trades that occur within the pool. The endpoint
1866
+ requires details such as the token pair, amount, and any additional parameters
1867
+ needed for the minting process.
1848
1868
 
1849
- :param token_id: Token ID of the NFT representing the liquidity provisioned position.
1869
+ :param token0: A class representing the token. This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
1870
+ :param token1: A class representing the token. This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
1871
+ :param fee: The transaction fee of a Uniswap pool in bips. Uniswap supports 4 different fee levels.
1872
+ :param tick_lower: The lower tick of the range to mint the position in
1873
+ :param tick_upper: The upper tick of the range to mint the position in
1850
1874
  :param amount0_desired: The desired amount of the first token to deposit
1851
1875
  :param amount1_desired: The desired amount of the second token to deposit
1852
1876
  :param amount0_min: The minimum amount of the first token to deposit
1853
1877
  :param amount1_min: The minimum amount of the second token to deposit
1854
1878
  :param chain: The chain to use.
1855
1879
  :param sender: The address of the transaction sender.
1880
+ :param recipient: The address that will receive the LP tokens
1856
1881
  :param retries: Override the default retry configuration for this method
1857
1882
  :param server_url: Override the default server URL for this method
1858
1883
  :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -1868,19 +1893,24 @@ class UniswapV3(BaseSDK):
1868
1893
  else:
1869
1894
  base_url = self._get_url(base_url, url_variables)
1870
1895
 
1871
- request = models.UniswapIncreaseLiquidityProvisionRequest(
1872
- token_id=token_id,
1896
+ request = models.UniswapMintLiquidityProvisionRequest(
1897
+ token0=token0,
1898
+ token1=token1,
1899
+ fee=fee,
1900
+ tick_lower=tick_lower,
1901
+ tick_upper=tick_upper,
1873
1902
  amount0_desired=amount0_desired,
1874
1903
  amount1_desired=amount1_desired,
1875
1904
  amount0_min=amount0_min,
1876
1905
  amount1_min=amount1_min,
1906
+ recipient=recipient,
1877
1907
  chain=chain,
1878
1908
  sender=sender,
1879
1909
  )
1880
1910
 
1881
1911
  req = self._build_request_async(
1882
1912
  method="POST",
1883
- path="/v0/uniswap/liquidity_provision/increase",
1913
+ path="/v0/uniswap/liquidity_provision/mint",
1884
1914
  base_url=base_url,
1885
1915
  url_variables=url_variables,
1886
1916
  request=request,
@@ -1896,7 +1926,7 @@ class UniswapV3(BaseSDK):
1896
1926
  False,
1897
1927
  False,
1898
1928
  "json",
1899
- models.UniswapIncreaseLiquidityProvisionRequest,
1929
+ models.UniswapMintLiquidityProvisionRequest,
1900
1930
  ),
1901
1931
  timeout_ms=timeout_ms,
1902
1932
  )
@@ -1913,7 +1943,7 @@ class UniswapV3(BaseSDK):
1913
1943
  hook_ctx=HookContext(
1914
1944
  config=self.sdk_configuration,
1915
1945
  base_url=base_url or "",
1916
- operation_id="uniswap_liquidity_provision_increase",
1946
+ operation_id="uniswap_liquidity_provision_mint",
1917
1947
  oauth2_scopes=[],
1918
1948
  security_source=self.sdk_configuration.security,
1919
1949
  ),
@@ -1950,62 +1980,52 @@ class UniswapV3(BaseSDK):
1950
1980
  http_res,
1951
1981
  )
1952
1982
 
1953
- def liquidity_provision_mint(
1983
+ def liquidity_provision_increase(
1954
1984
  self,
1955
1985
  *,
1956
- token0: models.TokenEnum,
1957
- token1: models.TokenEnum,
1958
- fee: models.FeeEnum,
1959
- tick_lower: int,
1960
- tick_upper: int,
1986
+ token_id: int,
1961
1987
  amount0_desired: Union[
1962
- models.UniswapMintLiquidityProvisionRequestAmount0Desired,
1963
- models.UniswapMintLiquidityProvisionRequestAmount0DesiredTypedDict,
1988
+ models.UniswapIncreaseLiquidityProvisionRequestAmount0Desired,
1989
+ models.UniswapIncreaseLiquidityProvisionRequestAmount0DesiredTypedDict,
1964
1990
  ],
1965
1991
  amount1_desired: Union[
1966
- models.UniswapMintLiquidityProvisionRequestAmount1Desired,
1967
- models.UniswapMintLiquidityProvisionRequestAmount1DesiredTypedDict,
1992
+ models.UniswapIncreaseLiquidityProvisionRequestAmount1Desired,
1993
+ models.UniswapIncreaseLiquidityProvisionRequestAmount1DesiredTypedDict,
1968
1994
  ],
1969
1995
  amount0_min: Union[
1970
- models.UniswapMintLiquidityProvisionRequestAmount0Min,
1971
- models.UniswapMintLiquidityProvisionRequestAmount0MinTypedDict,
1996
+ models.UniswapIncreaseLiquidityProvisionRequestAmount0Min,
1997
+ models.UniswapIncreaseLiquidityProvisionRequestAmount0MinTypedDict,
1972
1998
  ],
1973
1999
  amount1_min: Union[
1974
- models.UniswapMintLiquidityProvisionRequestAmount1Min,
1975
- models.UniswapMintLiquidityProvisionRequestAmount1MinTypedDict,
2000
+ models.UniswapIncreaseLiquidityProvisionRequestAmount1Min,
2001
+ models.UniswapIncreaseLiquidityProvisionRequestAmount1MinTypedDict,
1976
2002
  ],
1977
2003
  chain: models.Chain,
1978
2004
  sender: str,
1979
- recipient: OptionalNullable[str] = UNSET,
1980
2005
  retries: OptionalNullable[utils.RetryConfig] = UNSET,
1981
2006
  server_url: Optional[str] = None,
1982
2007
  timeout_ms: Optional[int] = None,
1983
2008
  http_headers: Optional[Mapping[str, str]] = None,
1984
2009
  ) -> models.TxResponse:
1985
- r"""Open a new LP position
2010
+ r"""Increase an LP position
1986
2011
 
1987
- This endpoint allows users to open a new Liquidity Provider (LP) position on the
1988
- Uniswap platform.
2012
+ This endpoint allows users to increase their existing Liquidity Provider (LP)
2013
+ positions on the Uniswap platform.
1989
2014
 
1990
- By providing the necessary parameters, users can initiate a minting process to
1991
- create a new LP token, which represents their stake in a specific liquidity pool.
1992
- This operation is essential for users looking to participate in liquidity provision,
1993
- enabling them to earn fees from trades that occur within the pool. The endpoint
1994
- requires details such as the token pair, amount, and any additional parameters
1995
- needed for the minting process.
2015
+ By providing the necessary parameters, users can add more liquidity to their current
2016
+ positions, thereby increasing their stake in the liquidity pool. This operation is
2017
+ beneficial for users who wish to enhance their potential earnings from trading fees
2018
+ within the pool. The endpoint requires details such as the token pair, additional
2019
+ amount to be added, and any other parameters necessary for the liquidity increase
2020
+ process.
1996
2021
 
1997
- :param token0: A class representing the token. This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
1998
- :param token1: A class representing the token. This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
1999
- :param fee: The transaction fee of a Uniswap pool in bips. Uniswap supports 4 different fee levels.
2000
- :param tick_lower: The lower tick of the range to mint the position in
2001
- :param tick_upper: The upper tick of the range to mint the position in
2022
+ :param token_id: Token ID of the NFT representing the liquidity provisioned position.
2002
2023
  :param amount0_desired: The desired amount of the first token to deposit
2003
2024
  :param amount1_desired: The desired amount of the second token to deposit
2004
2025
  :param amount0_min: The minimum amount of the first token to deposit
2005
2026
  :param amount1_min: The minimum amount of the second token to deposit
2006
2027
  :param chain: The chain to use.
2007
2028
  :param sender: The address of the transaction sender.
2008
- :param recipient: The address that will receive the LP tokens
2009
2029
  :param retries: Override the default retry configuration for this method
2010
2030
  :param server_url: Override the default server URL for this method
2011
2031
  :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -2021,24 +2041,19 @@ class UniswapV3(BaseSDK):
2021
2041
  else:
2022
2042
  base_url = self._get_url(base_url, url_variables)
2023
2043
 
2024
- request = models.UniswapMintLiquidityProvisionRequest(
2025
- token0=token0,
2026
- token1=token1,
2027
- fee=fee,
2028
- tick_lower=tick_lower,
2029
- tick_upper=tick_upper,
2044
+ request = models.UniswapIncreaseLiquidityProvisionRequest(
2045
+ token_id=token_id,
2030
2046
  amount0_desired=amount0_desired,
2031
2047
  amount1_desired=amount1_desired,
2032
2048
  amount0_min=amount0_min,
2033
2049
  amount1_min=amount1_min,
2034
- recipient=recipient,
2035
2050
  chain=chain,
2036
2051
  sender=sender,
2037
2052
  )
2038
2053
 
2039
2054
  req = self._build_request(
2040
2055
  method="POST",
2041
- path="/v0/uniswap/liquidity_provision/mint",
2056
+ path="/v0/uniswap/liquidity_provision/increase",
2042
2057
  base_url=base_url,
2043
2058
  url_variables=url_variables,
2044
2059
  request=request,
@@ -2054,7 +2069,7 @@ class UniswapV3(BaseSDK):
2054
2069
  False,
2055
2070
  False,
2056
2071
  "json",
2057
- models.UniswapMintLiquidityProvisionRequest,
2072
+ models.UniswapIncreaseLiquidityProvisionRequest,
2058
2073
  ),
2059
2074
  timeout_ms=timeout_ms,
2060
2075
  )
@@ -2071,7 +2086,7 @@ class UniswapV3(BaseSDK):
2071
2086
  hook_ctx=HookContext(
2072
2087
  config=self.sdk_configuration,
2073
2088
  base_url=base_url or "",
2074
- operation_id="uniswap_liquidity_provision_mint",
2089
+ operation_id="uniswap_liquidity_provision_increase",
2075
2090
  oauth2_scopes=[],
2076
2091
  security_source=self.sdk_configuration.security,
2077
2092
  ),
@@ -2108,62 +2123,52 @@ class UniswapV3(BaseSDK):
2108
2123
  http_res,
2109
2124
  )
2110
2125
 
2111
- async def liquidity_provision_mint_async(
2126
+ async def liquidity_provision_increase_async(
2112
2127
  self,
2113
2128
  *,
2114
- token0: models.TokenEnum,
2115
- token1: models.TokenEnum,
2116
- fee: models.FeeEnum,
2117
- tick_lower: int,
2118
- tick_upper: int,
2129
+ token_id: int,
2119
2130
  amount0_desired: Union[
2120
- models.UniswapMintLiquidityProvisionRequestAmount0Desired,
2121
- models.UniswapMintLiquidityProvisionRequestAmount0DesiredTypedDict,
2131
+ models.UniswapIncreaseLiquidityProvisionRequestAmount0Desired,
2132
+ models.UniswapIncreaseLiquidityProvisionRequestAmount0DesiredTypedDict,
2122
2133
  ],
2123
2134
  amount1_desired: Union[
2124
- models.UniswapMintLiquidityProvisionRequestAmount1Desired,
2125
- models.UniswapMintLiquidityProvisionRequestAmount1DesiredTypedDict,
2135
+ models.UniswapIncreaseLiquidityProvisionRequestAmount1Desired,
2136
+ models.UniswapIncreaseLiquidityProvisionRequestAmount1DesiredTypedDict,
2126
2137
  ],
2127
2138
  amount0_min: Union[
2128
- models.UniswapMintLiquidityProvisionRequestAmount0Min,
2129
- models.UniswapMintLiquidityProvisionRequestAmount0MinTypedDict,
2139
+ models.UniswapIncreaseLiquidityProvisionRequestAmount0Min,
2140
+ models.UniswapIncreaseLiquidityProvisionRequestAmount0MinTypedDict,
2130
2141
  ],
2131
2142
  amount1_min: Union[
2132
- models.UniswapMintLiquidityProvisionRequestAmount1Min,
2133
- models.UniswapMintLiquidityProvisionRequestAmount1MinTypedDict,
2143
+ models.UniswapIncreaseLiquidityProvisionRequestAmount1Min,
2144
+ models.UniswapIncreaseLiquidityProvisionRequestAmount1MinTypedDict,
2134
2145
  ],
2135
2146
  chain: models.Chain,
2136
2147
  sender: str,
2137
- recipient: OptionalNullable[str] = UNSET,
2138
2148
  retries: OptionalNullable[utils.RetryConfig] = UNSET,
2139
2149
  server_url: Optional[str] = None,
2140
2150
  timeout_ms: Optional[int] = None,
2141
2151
  http_headers: Optional[Mapping[str, str]] = None,
2142
2152
  ) -> models.TxResponse:
2143
- r"""Open a new LP position
2153
+ r"""Increase an LP position
2144
2154
 
2145
- This endpoint allows users to open a new Liquidity Provider (LP) position on the
2146
- Uniswap platform.
2155
+ This endpoint allows users to increase their existing Liquidity Provider (LP)
2156
+ positions on the Uniswap platform.
2147
2157
 
2148
- By providing the necessary parameters, users can initiate a minting process to
2149
- create a new LP token, which represents their stake in a specific liquidity pool.
2150
- This operation is essential for users looking to participate in liquidity provision,
2151
- enabling them to earn fees from trades that occur within the pool. The endpoint
2152
- requires details such as the token pair, amount, and any additional parameters
2153
- needed for the minting process.
2158
+ By providing the necessary parameters, users can add more liquidity to their current
2159
+ positions, thereby increasing their stake in the liquidity pool. This operation is
2160
+ beneficial for users who wish to enhance their potential earnings from trading fees
2161
+ within the pool. The endpoint requires details such as the token pair, additional
2162
+ amount to be added, and any other parameters necessary for the liquidity increase
2163
+ process.
2154
2164
 
2155
- :param token0: A class representing the token. This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
2156
- :param token1: A class representing the token. This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
2157
- :param fee: The transaction fee of a Uniswap pool in bips. Uniswap supports 4 different fee levels.
2158
- :param tick_lower: The lower tick of the range to mint the position in
2159
- :param tick_upper: The upper tick of the range to mint the position in
2165
+ :param token_id: Token ID of the NFT representing the liquidity provisioned position.
2160
2166
  :param amount0_desired: The desired amount of the first token to deposit
2161
2167
  :param amount1_desired: The desired amount of the second token to deposit
2162
2168
  :param amount0_min: The minimum amount of the first token to deposit
2163
2169
  :param amount1_min: The minimum amount of the second token to deposit
2164
2170
  :param chain: The chain to use.
2165
2171
  :param sender: The address of the transaction sender.
2166
- :param recipient: The address that will receive the LP tokens
2167
2172
  :param retries: Override the default retry configuration for this method
2168
2173
  :param server_url: Override the default server URL for this method
2169
2174
  :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -2179,24 +2184,19 @@ class UniswapV3(BaseSDK):
2179
2184
  else:
2180
2185
  base_url = self._get_url(base_url, url_variables)
2181
2186
 
2182
- request = models.UniswapMintLiquidityProvisionRequest(
2183
- token0=token0,
2184
- token1=token1,
2185
- fee=fee,
2186
- tick_lower=tick_lower,
2187
- tick_upper=tick_upper,
2187
+ request = models.UniswapIncreaseLiquidityProvisionRequest(
2188
+ token_id=token_id,
2188
2189
  amount0_desired=amount0_desired,
2189
2190
  amount1_desired=amount1_desired,
2190
2191
  amount0_min=amount0_min,
2191
2192
  amount1_min=amount1_min,
2192
- recipient=recipient,
2193
2193
  chain=chain,
2194
2194
  sender=sender,
2195
2195
  )
2196
2196
 
2197
2197
  req = self._build_request_async(
2198
2198
  method="POST",
2199
- path="/v0/uniswap/liquidity_provision/mint",
2199
+ path="/v0/uniswap/liquidity_provision/increase",
2200
2200
  base_url=base_url,
2201
2201
  url_variables=url_variables,
2202
2202
  request=request,
@@ -2212,7 +2212,7 @@ class UniswapV3(BaseSDK):
2212
2212
  False,
2213
2213
  False,
2214
2214
  "json",
2215
- models.UniswapMintLiquidityProvisionRequest,
2215
+ models.UniswapIncreaseLiquidityProvisionRequest,
2216
2216
  ),
2217
2217
  timeout_ms=timeout_ms,
2218
2218
  )
@@ -2229,7 +2229,7 @@ class UniswapV3(BaseSDK):
2229
2229
  hook_ctx=HookContext(
2230
2230
  config=self.sdk_configuration,
2231
2231
  base_url=base_url or "",
2232
- operation_id="uniswap_liquidity_provision_mint",
2232
+ operation_id="uniswap_liquidity_provision_increase",
2233
2233
  oauth2_scopes=[],
2234
2234
  security_source=self.sdk_configuration.security,
2235
2235
  ),
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.3
2
2
  Name: compass_api_sdk
3
- Version: 0.9.29
3
+ Version: 0.9.31
4
4
  Summary: Compass API SDK.
5
5
  Author: royalnine
6
6
  Requires-Python: >=3.9.2
@@ -287,8 +287,8 @@ with CompassAPI(
287
287
  * [liquidity_provision_positions](https://github.com/CompassLabs/mono/blob/master/docs/sdks/uniswapv3/README.md#liquidity_provision_positions) - List LP
288
288
  * [swap_buy_exactly](https://github.com/CompassLabs/mono/blob/master/docs/sdks/uniswapv3/README.md#swap_buy_exactly) - Buy exact amount
289
289
  * [swap_sell_exactly](https://github.com/CompassLabs/mono/blob/master/docs/sdks/uniswapv3/README.md#swap_sell_exactly) - Sell exact amount
290
- * [liquidity_provision_increase](https://github.com/CompassLabs/mono/blob/master/docs/sdks/uniswapv3/README.md#liquidity_provision_increase) - Increase an LP position
291
290
  * [liquidity_provision_mint](https://github.com/CompassLabs/mono/blob/master/docs/sdks/uniswapv3/README.md#liquidity_provision_mint) - Open a new LP position
291
+ * [liquidity_provision_increase](https://github.com/CompassLabs/mono/blob/master/docs/sdks/uniswapv3/README.md#liquidity_provision_increase) - Increase an LP position
292
292
  * [liquidity_provision_withdraw](https://github.com/CompassLabs/mono/blob/master/docs/sdks/uniswapv3/README.md#liquidity_provision_withdraw) - Withdraw an LP position
293
293
 
294
294
  ### [universal](https://github.com/CompassLabs/mono/blob/master/docs/sdks/universal/README.md)
@@ -2,7 +2,7 @@ compass_api_sdk/__init__.py,sha256=w2u919V3Tzv4zEPQ-OYJ79gQ_4_SyW7GOFFoHtqXDFA,4
2
2
  compass_api_sdk/_hooks/__init__.py,sha256=p5J13DeYuISQyQWirjJAObHIf2VtIlOtFqnIpvjjVwk,118
3
3
  compass_api_sdk/_hooks/sdkhooks.py,sha256=eVxHB2Q_JG6zZx5xn74i208ij-fpTHqq2jod6fbghRQ,2503
4
4
  compass_api_sdk/_hooks/types.py,sha256=4qXm6dEntJOC2QeOdTklcc53oFzTU3HBb1xGdZ-kBXY,3059
5
- compass_api_sdk/_version.py,sha256=wjLwBBO7N_S6BcHHASX6RHnjZhUNAbQ151CIb7MWJN4,474
5
+ compass_api_sdk/_version.py,sha256=P8sYE1gaAKZM6seOorxFFLOGQQWTi3_pMjFOFSw_30w,474
6
6
  compass_api_sdk/aave_v3.py,sha256=bP2bYTsFsHpZ0PsClTV5qdDHP_n-98NGQKoN3zd9dqo,126376
7
7
  compass_api_sdk/aerodrome_slipstream.py,sha256=xGt8wnAItW8w6kgnqfwDrsX24qw8TIhsD8fRhxta7Bs,83443
8
8
  compass_api_sdk/basesdk.py,sha256=xDxC-X-LHCwtVy8SPM6nckSu1NmF8uKhHUUQd3X-syo,11810
@@ -25,7 +25,7 @@ compass_api_sdk/models/aaveavgrateresponse.py,sha256=q_MArkpvKD2WdjxV7fljIHfnCbB
25
25
  compass_api_sdk/models/aaveborrowparams.py,sha256=Sb_i4KtK1ZVGGzkt7WU391cJzCryRpPp2m6vg7Du9Z8,3309
26
26
  compass_api_sdk/models/aaveborrowrequest.py,sha256=IUHTHTa3icfr9esg4owq98SyckK2rzOX-odpVFn6l8w,3568
27
27
  compass_api_sdk/models/aavehistoricaltransactionsresponse.py,sha256=G9yw8V7UHQL9m8mJZgHSqhvdymo5mJbJoIKtbtRSzlg,2504
28
- compass_api_sdk/models/aaveliquiditychangeresponse.py,sha256=G_fjNFMMAViJVXUejTdqNDyNrv-BieQDDpT6iwtwCwg,811
28
+ compass_api_sdk/models/aaveliquiditychangeresponse.py,sha256=aBo8-P90yg_lD7D2h5XoqX8BojvD9bXW2JJf2eKufcY,813
29
29
  compass_api_sdk/models/aavelooprequest.py,sha256=9U4Z_yRQRY3Abw6kWuU4V_ZVMgfYxE5KjWIuEyHohlM,3958
30
30
  compass_api_sdk/models/aaverateresponse.py,sha256=7Ra_FKYbGrm7ZqzNi8-1T0v2xDAGyZf6Iw5Juh1bXBI,1156
31
31
  compass_api_sdk/models/aaverepayparams.py,sha256=CJxfD0lckwHMqvoEqGvJFCS0yN4ADsgMLbaD0ajdOTg,3293
@@ -231,7 +231,7 @@ compass_api_sdk/token_sdk.py,sha256=O_bHPJX-ZMMQnN3Dvw9DF5SSGV2g-52mDfDATymvGWI,
231
231
  compass_api_sdk/transaction_bundler.py,sha256=FJyHVR-9nWB-ibny3aGmrs9qKvSUn-TM09OuYcaUijE,32440
232
232
  compass_api_sdk/types/__init__.py,sha256=RArOwSgeeTIva6h-4ttjXwMUeCkz10nAFBL9D-QljI4,377
233
233
  compass_api_sdk/types/basemodel.py,sha256=L79WXvTECbSqaJzs8D3ud_KdIWkU7Cx2wbohDAktE9E,1127
234
- compass_api_sdk/uniswap_v3.py,sha256=qRCWOkXbpHKWMHpgvXlioflGog4L5TIUWY5F456bpi4,109087
234
+ compass_api_sdk/uniswap_v3.py,sha256=xgdGEGBSpi8bevHpn1--71UZg8bXi9zs962tAm1hdpw,109087
235
235
  compass_api_sdk/universal.py,sha256=wsCKlFtrA0UNEe8ATv5cX1icLV6XmfwVpIbYNEqNsIs,71015
236
236
  compass_api_sdk/utils/__init__.py,sha256=811KKdkxMaWDfz2lMohUWqrR4JnIWxqeNQ1lRGQU4DM,5341
237
237
  compass_api_sdk/utils/annotations.py,sha256=aR7mZG34FzgRdew7WZPYEu9QGBerpuKxCF4sek5Z_5Y,1699
@@ -249,6 +249,6 @@ compass_api_sdk/utils/security.py,sha256=ktep3HKwbFs-MLxUYTM8Jd4v-ZBum5_Z0u1PFId
249
249
  compass_api_sdk/utils/serializers.py,sha256=hiHBXM1AY8_N2Z_rvFfNSYwvLBkSQlPGFp8poasdU4s,5986
250
250
  compass_api_sdk/utils/url.py,sha256=BgGPgcTA6MRK4bF8fjP2dUopN3NzEzxWMXPBVg8NQUA,5254
251
251
  compass_api_sdk/utils/values.py,sha256=CcaCXEa3xHhkUDROyXZocN8f0bdITftv9Y0P9lTf0YM,3517
252
- compass_api_sdk-0.9.29.dist-info/METADATA,sha256=cBL29dQuCgdOTTQORZ2XNgyon2gNx4jYbOW0siNhXR4,26910
253
- compass_api_sdk-0.9.29.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
254
- compass_api_sdk-0.9.29.dist-info/RECORD,,
252
+ compass_api_sdk-0.9.31.dist-info/METADATA,sha256=Qs8ne9DYLSdSngck-RQ8UCD1EWWqApGlDk11vrgKI4s,26910
253
+ compass_api_sdk-0.9.31.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
254
+ compass_api_sdk-0.9.31.dist-info/RECORD,,