compass_api_sdk 0.9.45__py3-none-any.whl → 0.9.47__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.45"
6
+ __version__: str = "0.9.47"
7
7
  __openapi_doc_version__: str = "0.0.1"
8
- __gen_version__: str = "2.656.5"
9
- __user_agent__: str = "speakeasy-sdk/python 0.9.45 2.656.5 0.0.1 compass_api_sdk"
8
+ __gen_version__: str = "2.656.9"
9
+ __user_agent__: str = "speakeasy-sdk/python 0.9.47 2.656.9 0.0.1 compass_api_sdk"
10
10
 
11
11
  try:
12
12
  if __package__ is not None:
@@ -1863,6 +1863,14 @@ class AaveV3(BaseSDK):
1863
1863
  Overall, this endpoint is a critical component for users looking to maximize their
1864
1864
  asset utility within the AAVEv3 ecosystem, providing both earning potential and
1865
1865
  borrowing flexibility.
1866
+ <Info>
1867
+ **Required Allowances**
1868
+
1869
+ In order to make this transaction, token allowances need to be set on the following contracts.
1870
+
1871
+ - `AaveV3Pool`
1872
+ </Info>
1873
+
1866
1874
 
1867
1875
  :param token: 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.
1868
1876
  :param amount: The amount of the asset to supply
@@ -1975,6 +1983,14 @@ class AaveV3(BaseSDK):
1975
1983
  Overall, this endpoint is a critical component for users looking to maximize their
1976
1984
  asset utility within the AAVEv3 ecosystem, providing both earning potential and
1977
1985
  borrowing flexibility.
1986
+ <Info>
1987
+ **Required Allowances**
1988
+
1989
+ In order to make this transaction, token allowances need to be set on the following contracts.
1990
+
1991
+ - `AaveV3Pool`
1992
+ </Info>
1993
+
1978
1994
 
1979
1995
  :param token: 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.
1980
1996
  :param amount: The amount of the asset to supply
@@ -2083,6 +2099,14 @@ class AaveV3(BaseSDK):
2083
2099
 
2084
2100
  Price changes in the assets may lead to some or all of your collateral being
2085
2101
  liquidated, if the borrow position becomes unhealthy.
2102
+ <Info>
2103
+ **Required Allowances**
2104
+
2105
+ In order to make this transaction, token allowances need to be set on the following contracts.
2106
+
2107
+ - `AaveV3Pool`
2108
+ </Info>
2109
+
2086
2110
 
2087
2111
  :param token: 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.
2088
2112
  :param amount: The amount of the asset to borrow
@@ -2193,6 +2217,14 @@ class AaveV3(BaseSDK):
2193
2217
 
2194
2218
  Price changes in the assets may lead to some or all of your collateral being
2195
2219
  liquidated, if the borrow position becomes unhealthy.
2220
+ <Info>
2221
+ **Required Allowances**
2222
+
2223
+ In order to make this transaction, token allowances need to be set on the following contracts.
2224
+
2225
+ - `AaveV3Pool`
2226
+ </Info>
2227
+
2196
2228
 
2197
2229
  :param token: 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.
2198
2230
  :param amount: The amount of the asset to borrow
@@ -2307,6 +2339,14 @@ class AaveV3(BaseSDK):
2307
2339
  risk of liquidation, ensuring a more secure borrowing experience. The endpoint
2308
2340
  requires specifying the chain and the details of the repayment transaction,
2309
2341
  including the amount and the asset to be repaid.
2342
+ <Info>
2343
+ **Required Allowances**
2344
+
2345
+ In order to make this transaction, token allowances need to be set on the following contracts.
2346
+
2347
+ - `AaveV3Pool`
2348
+ </Info>
2349
+
2310
2350
 
2311
2351
  :param token: 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.
2312
2352
  :param amount: The amount of the asset to repay
@@ -2421,6 +2461,14 @@ class AaveV3(BaseSDK):
2421
2461
  risk of liquidation, ensuring a more secure borrowing experience. The endpoint
2422
2462
  requires specifying the chain and the details of the repayment transaction,
2423
2463
  including the amount and the asset to be repaid.
2464
+ <Info>
2465
+ **Required Allowances**
2466
+
2467
+ In order to make this transaction, token allowances need to be set on the following contracts.
2468
+
2469
+ - `AaveV3Pool`
2470
+ </Info>
2471
+
2424
2472
 
2425
2473
  :param token: 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.
2426
2474
  :param amount: The amount of the asset to repay
@@ -2535,6 +2583,14 @@ class AaveV3(BaseSDK):
2535
2583
  their liquidation threshold before proceeding with a withdrawal. This endpoint is
2536
2584
  designed to provide a seamless and efficient way to manage your collateral within
2537
2585
  the Aave ecosystem.
2586
+ <Info>
2587
+ **Required Allowances**
2588
+
2589
+ In order to make this transaction, token allowances need to be set on the following contracts.
2590
+
2591
+ - `AaveV3Pool`
2592
+ </Info>
2593
+
2538
2594
 
2539
2595
  :param token: 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.
2540
2596
  :param amount: The amount of the asset to withdraw
@@ -2647,6 +2703,14 @@ class AaveV3(BaseSDK):
2647
2703
  their liquidation threshold before proceeding with a withdrawal. This endpoint is
2648
2704
  designed to provide a seamless and efficient way to manage your collateral within
2649
2705
  the Aave ecosystem.
2706
+ <Info>
2707
+ **Required Allowances**
2708
+
2709
+ In order to make this transaction, token allowances need to be set on the following contracts.
2710
+
2711
+ - `AaveV3Pool`
2712
+ </Info>
2713
+
2650
2714
 
2651
2715
  :param token: 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.
2652
2716
  :param amount: The amount of the asset to withdraw
@@ -449,6 +449,14 @@ class AerodromeSlipstream(BaseSDK):
449
449
  of the current market conditions, taking into account the liquidity and price
450
450
  impact. This endpoint is suitable for users who want to sell a precise quantity of a
451
451
  token and are willing to accept the resulting amount of the other token.
452
+ <Info>
453
+ **Required Allowances**
454
+
455
+ In order to make this transaction, token allowances need to be set on the following contracts.
456
+
457
+ - `AerodromeSlipstreamRouter`
458
+ </Info>
459
+
452
460
 
453
461
  :param token_in: 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.
454
462
  :param token_out: 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.
@@ -577,6 +585,14 @@ class AerodromeSlipstream(BaseSDK):
577
585
  of the current market conditions, taking into account the liquidity and price
578
586
  impact. This endpoint is suitable for users who want to sell a precise quantity of a
579
587
  token and are willing to accept the resulting amount of the other token.
588
+ <Info>
589
+ **Required Allowances**
590
+
591
+ In order to make this transaction, token allowances need to be set on the following contracts.
592
+
593
+ - `AerodromeSlipstreamRouter`
594
+ </Info>
595
+
580
596
 
581
597
  :param token_in: 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.
582
598
  :param token_out: 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.
@@ -704,6 +720,14 @@ class AerodromeSlipstream(BaseSDK):
704
720
  transaction is executed with consideration of current market conditions, including
705
721
  liquidity and price impact, ensuring that the trade is completed efficiently and
706
722
  effectively.
723
+ <Info>
724
+ **Required Allowances**
725
+
726
+ In order to make this transaction, token allowances need to be set on the following contracts.
727
+
728
+ - `AerodromeSlipstreamRouter`
729
+ </Info>
730
+
707
731
 
708
732
  :param token_in: 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.
709
733
  :param token_out: 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.
@@ -831,6 +855,14 @@ class AerodromeSlipstream(BaseSDK):
831
855
  transaction is executed with consideration of current market conditions, including
832
856
  liquidity and price impact, ensuring that the trade is completed efficiently and
833
857
  effectively.
858
+ <Info>
859
+ **Required Allowances**
860
+
861
+ In order to make this transaction, token allowances need to be set on the following contracts.
862
+
863
+ - `AerodromeSlipstreamRouter`
864
+ </Info>
865
+
834
866
 
835
867
  :param token_in: 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.
836
868
  :param token_out: 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.
@@ -968,6 +1000,14 @@ class AerodromeSlipstream(BaseSDK):
968
1000
  necessary information to manage their newly minted position. This functionality is
969
1001
  crucial for users looking to expand their liquidity provision activities, offering
970
1002
  them the opportunity to engage in decentralized finance (DeFi) markets effectively.
1003
+ <Info>
1004
+ **Required Allowances**
1005
+
1006
+ In order to make this transaction, token allowances need to be set on the following contracts.
1007
+
1008
+ - `AerodromeSlipstreamNonfungiblePositionManager`
1009
+ </Info>
1010
+
971
1011
 
972
1012
  :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.
973
1013
  :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.
@@ -1115,6 +1155,14 @@ class AerodromeSlipstream(BaseSDK):
1115
1155
  necessary information to manage their newly minted position. This functionality is
1116
1156
  crucial for users looking to expand their liquidity provision activities, offering
1117
1157
  them the opportunity to engage in decentralized finance (DeFi) markets effectively.
1158
+ <Info>
1159
+ **Required Allowances**
1160
+
1161
+ In order to make this transaction, token allowances need to be set on the following contracts.
1162
+
1163
+ - `AerodromeSlipstreamNonfungiblePositionManager`
1164
+ </Info>
1165
+
1118
1166
 
1119
1167
  :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.
1120
1168
  :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.
@@ -1259,6 +1307,14 @@ class AerodromeSlipstream(BaseSDK):
1259
1307
  vital for users aiming to optimize their liquidity provision strategy, enabling them
1260
1308
  to adapt to market conditions and maximize their returns in decentralized finance
1261
1309
  (DeFi) markets.
1310
+ <Info>
1311
+ **Required Allowances**
1312
+
1313
+ In order to make this transaction, token allowances need to be set on the following contracts.
1314
+
1315
+ - `AerodromeSlipstreamRouter`
1316
+ </Info>
1317
+
1262
1318
 
1263
1319
  :param token_id: Token ID of the NFT representing the liquidity provisioned position.
1264
1320
  :param amount0_desired: The desired amount of the first token to deposit
@@ -1393,6 +1449,14 @@ class AerodromeSlipstream(BaseSDK):
1393
1449
  vital for users aiming to optimize their liquidity provision strategy, enabling them
1394
1450
  to adapt to market conditions and maximize their returns in decentralized finance
1395
1451
  (DeFi) markets.
1452
+ <Info>
1453
+ **Required Allowances**
1454
+
1455
+ In order to make this transaction, token allowances need to be set on the following contracts.
1456
+
1457
+ - `AerodromeSlipstreamRouter`
1458
+ </Info>
1459
+
1396
1460
 
1397
1461
  :param token_id: Token ID of the NFT representing the liquidity provisioned position.
1398
1462
  :param amount0_desired: The desired amount of the first token to deposit
@@ -1515,6 +1579,14 @@ class AerodromeSlipstream(BaseSDK):
1515
1579
  assets and potentially reallocate them to other investment opportunities. The
1516
1580
  endpoint ensures a smooth and secure withdrawal process, facilitating users'
1517
1581
  strategic management of their decentralized finance (DeFi) portfolios.
1582
+ <Info>
1583
+ **Required Allowances**
1584
+
1585
+ In order to make this transaction, token allowances need to be set on the following contracts.
1586
+
1587
+ - `AerodromeSlipstreamNonfungiblePositionManager`
1588
+ </Info>
1589
+
1518
1590
 
1519
1591
  :param token_id: Token ID of the NFT representing the liquidity provisioned position.
1520
1592
  :param percentage_for_withdrawal: How much liquidity to take out in percentage.
@@ -1631,6 +1703,14 @@ class AerodromeSlipstream(BaseSDK):
1631
1703
  assets and potentially reallocate them to other investment opportunities. The
1632
1704
  endpoint ensures a smooth and secure withdrawal process, facilitating users'
1633
1705
  strategic management of their decentralized finance (DeFi) portfolios.
1706
+ <Info>
1707
+ **Required Allowances**
1708
+
1709
+ In order to make this transaction, token allowances need to be set on the following contracts.
1710
+
1711
+ - `AerodromeSlipstreamNonfungiblePositionManager`
1712
+ </Info>
1713
+
1634
1714
 
1635
1715
  :param token_id: Token ID of the NFT representing the liquidity provisioned position.
1636
1716
  :param percentage_for_withdrawal: How much liquidity to take out in percentage.
@@ -225,6 +225,14 @@ class ERC4626Vaults(BaseSDK):
225
225
  Deposit tokens into a Vault (ERC-4626 Standard) to earn passive yield.
226
226
 
227
227
  Each vault accepts one unique token that can be deposited.
228
+ <Info>
229
+ **Required Allowances**
230
+
231
+ In order to make this transaction, token allowances need to be set on the following contracts.
232
+
233
+ - `<vault_address>`
234
+ </Info>
235
+
228
236
 
229
237
  :param vault_address: The vault address you are depositing to.
230
238
  :param amount: The amount of tokens to deposit into the vault.
@@ -331,6 +339,14 @@ class ERC4626Vaults(BaseSDK):
331
339
  Deposit tokens into a Vault (ERC-4626 Standard) to earn passive yield.
332
340
 
333
341
  Each vault accepts one unique token that can be deposited.
342
+ <Info>
343
+ **Required Allowances**
344
+
345
+ In order to make this transaction, token allowances need to be set on the following contracts.
346
+
347
+ - `<vault_address>`
348
+ </Info>
349
+
334
350
 
335
351
  :param vault_address: The vault address you are depositing to.
336
352
  :param amount: The amount of tokens to deposit into the vault.
@@ -437,6 +453,14 @@ class ERC4626Vaults(BaseSDK):
437
453
  The passive yield earned on token deposits is represented by the increased value of
438
454
  the shares received upon depositing tokens. Trade in these shares for the tokens you
439
455
  deposited plus any accrued yield.
456
+ <Info>
457
+ **Required Allowances**
458
+
459
+ In order to make this transaction, token allowances need to be set on the following contracts.
460
+
461
+ - `<vault address>`
462
+ </Info>
463
+
440
464
 
441
465
  :param vault_address: The vault address you are withdrawing from.
442
466
  :param amount: The amount of tokens to withdraw from the vault. If set to 'ALL', your total deposited token amount will be withdrawn.
@@ -543,6 +567,14 @@ class ERC4626Vaults(BaseSDK):
543
567
  The passive yield earned on token deposits is represented by the increased value of
544
568
  the shares received upon depositing tokens. Trade in these shares for the tokens you
545
569
  deposited plus any accrued yield.
570
+ <Info>
571
+ **Required Allowances**
572
+
573
+ In order to make this transaction, token allowances need to be set on the following contracts.
574
+
575
+ - `<vault address>`
576
+ </Info>
577
+
546
578
 
547
579
  :param vault_address: The vault address you are withdrawing from.
548
580
  :param amount: The amount of tokens to withdraw from the vault. If set to 'ALL', your total deposited token amount will be withdrawn.
@@ -73,6 +73,7 @@ class AaveAvgRateToken(str, Enum):
73
73
  AERO = "AERO"
74
74
  EUR = "EUR"
75
75
  VIRTUAL = "VIRTUAL"
76
+ EZ_ETH = "ezETH"
76
77
 
77
78
 
78
79
  class AaveAvgRateRequestTypedDict(TypedDict):
@@ -66,6 +66,7 @@ class AaveLiquidityChangeToken(str, Enum):
66
66
  AERO = "AERO"
67
67
  EUR = "EUR"
68
68
  VIRTUAL = "VIRTUAL"
69
+ EZ_ETH = "ezETH"
69
70
 
70
71
 
71
72
  class AaveLiquidityChangeRequestTypedDict(TypedDict):
@@ -73,6 +73,7 @@ class AaveRateToken(str, Enum):
73
73
  AERO = "AERO"
74
74
  EUR = "EUR"
75
75
  VIRTUAL = "VIRTUAL"
76
+ EZ_ETH = "ezETH"
76
77
 
77
78
 
78
79
  class AaveRateRequestTypedDict(TypedDict):
@@ -73,6 +73,7 @@ class AaveReserveOverviewToken(str, Enum):
73
73
  AERO = "AERO"
74
74
  EUR = "EUR"
75
75
  VIRTUAL = "VIRTUAL"
76
+ EZ_ETH = "ezETH"
76
77
 
77
78
 
78
79
  class AaveReserveOverviewRequestTypedDict(TypedDict):
@@ -73,6 +73,7 @@ class AaveStdRateToken(str, Enum):
73
73
  AERO = "AERO"
74
74
  EUR = "EUR"
75
75
  VIRTUAL = "VIRTUAL"
76
+ EZ_ETH = "ezETH"
76
77
 
77
78
 
78
79
  class AaveStdRateRequestTypedDict(TypedDict):
@@ -73,6 +73,7 @@ class AaveTokenPriceToken(str, Enum):
73
73
  AERO = "AERO"
74
74
  EUR = "EUR"
75
75
  VIRTUAL = "VIRTUAL"
76
+ EZ_ETH = "ezETH"
76
77
 
77
78
 
78
79
  class AaveTokenPriceRequestTypedDict(TypedDict):
@@ -73,6 +73,7 @@ class AaveUserPositionPerTokenToken(str, Enum):
73
73
  AERO = "AERO"
74
74
  EUR = "EUR"
75
75
  VIRTUAL = "VIRTUAL"
76
+ EZ_ETH = "ezETH"
76
77
 
77
78
 
78
79
  class AaveUserPositionPerTokenRequestTypedDict(TypedDict):
@@ -67,6 +67,7 @@ class AerodromeSlipstreamPoolPriceTokenInToken(str, Enum):
67
67
  AERO = "AERO"
68
68
  EUR = "EUR"
69
69
  VIRTUAL = "VIRTUAL"
70
+ EZ_ETH = "ezETH"
70
71
 
71
72
 
72
73
  class AerodromeSlipstreamPoolPriceTokenOutToken(str, Enum):
@@ -120,6 +121,7 @@ class AerodromeSlipstreamPoolPriceTokenOutToken(str, Enum):
120
121
  AERO = "AERO"
121
122
  EUR = "EUR"
122
123
  VIRTUAL = "VIRTUAL"
124
+ EZ_ETH = "ezETH"
123
125
 
124
126
 
125
127
  class AerodromeSlipstreamPoolPriceRequestTypedDict(TypedDict):
@@ -66,6 +66,7 @@ class TokenAddressToken(str, Enum):
66
66
  AERO = "AERO"
67
67
  EUR = "EUR"
68
68
  VIRTUAL = "VIRTUAL"
69
+ EZ_ETH = "ezETH"
69
70
 
70
71
 
71
72
  class TokenAddressRequestTypedDict(TypedDict):
@@ -55,3 +55,4 @@ class TokenEnum(str, Enum):
55
55
  AERO = "AERO"
56
56
  EUR = "EUR"
57
57
  VIRTUAL = "VIRTUAL"
58
+ EZ_ETH = "ezETH"
@@ -66,6 +66,7 @@ class UniswapPoolPriceTokenInToken(str, Enum):
66
66
  AERO = "AERO"
67
67
  EUR = "EUR"
68
68
  VIRTUAL = "VIRTUAL"
69
+ EZ_ETH = "ezETH"
69
70
 
70
71
 
71
72
  class UniswapPoolPriceTokenOutToken(str, Enum):
@@ -119,6 +120,7 @@ class UniswapPoolPriceTokenOutToken(str, Enum):
119
120
  AERO = "AERO"
120
121
  EUR = "EUR"
121
122
  VIRTUAL = "VIRTUAL"
123
+ EZ_ETH = "ezETH"
122
124
 
123
125
 
124
126
  class UniswapPoolPriceFeeEnum(str, Enum):
@@ -67,6 +67,7 @@ class UniswapQuoteBuyExactlyTokenInToken(str, Enum):
67
67
  AERO = "AERO"
68
68
  EUR = "EUR"
69
69
  VIRTUAL = "VIRTUAL"
70
+ EZ_ETH = "ezETH"
70
71
 
71
72
 
72
73
  class UniswapQuoteBuyExactlyTokenOutToken(str, Enum):
@@ -120,6 +121,7 @@ class UniswapQuoteBuyExactlyTokenOutToken(str, Enum):
120
121
  AERO = "AERO"
121
122
  EUR = "EUR"
122
123
  VIRTUAL = "VIRTUAL"
124
+ EZ_ETH = "ezETH"
123
125
 
124
126
 
125
127
  class UniswapQuoteBuyExactlyFeeEnum(str, Enum):
@@ -67,6 +67,7 @@ class UniswapQuoteSellExactlyTokenInToken(str, Enum):
67
67
  AERO = "AERO"
68
68
  EUR = "EUR"
69
69
  VIRTUAL = "VIRTUAL"
70
+ EZ_ETH = "ezETH"
70
71
 
71
72
 
72
73
  class UniswapQuoteSellExactlyTokenOutToken(str, Enum):
@@ -120,6 +121,7 @@ class UniswapQuoteSellExactlyTokenOutToken(str, Enum):
120
121
  AERO = "AERO"
121
122
  EUR = "EUR"
122
123
  VIRTUAL = "VIRTUAL"
124
+ EZ_ETH = "ezETH"
123
125
 
124
126
 
125
127
  class UniswapQuoteSellExactlyFeeEnum(str, Enum):
compass_api_sdk/morpho.py CHANGED
@@ -1194,6 +1194,14 @@ class Morpho(BaseSDK):
1194
1194
  exposure for all deposited assets so users don't need to make these decisions
1195
1195
  themselves. Users maintain full control over their assets, can monitor the vault's
1196
1196
  state at any time, and withdraw their liquidity at their discretion.
1197
+ <Info>
1198
+ **Required Allowances**
1199
+
1200
+ In order to make this transaction, token allowances need to be set on the following contracts.
1201
+
1202
+ - `USDC`
1203
+ </Info>
1204
+
1197
1205
 
1198
1206
  :param vault_address: The vault address you are depositing to.
1199
1207
  :param amount: The amount of tokens to deposit into the vault.
@@ -1309,6 +1317,14 @@ class Morpho(BaseSDK):
1309
1317
  exposure for all deposited assets so users don't need to make these decisions
1310
1318
  themselves. Users maintain full control over their assets, can monitor the vault's
1311
1319
  state at any time, and withdraw their liquidity at their discretion.
1320
+ <Info>
1321
+ **Required Allowances**
1322
+
1323
+ In order to make this transaction, token allowances need to be set on the following contracts.
1324
+
1325
+ - `USDC`
1326
+ </Info>
1327
+
1312
1328
 
1313
1329
  :param vault_address: The vault address you are depositing to.
1314
1330
  :param amount: The amount of tokens to deposit into the vault.
@@ -1421,6 +1437,14 @@ class Morpho(BaseSDK):
1421
1437
  exposure for all deposited assets so users don't need to make these decisions
1422
1438
  themselves. Users maintain full control over their assets, can monitor the vault's
1423
1439
  state at any time, and withdraw their liquidity at their discretion.
1440
+ <Info>
1441
+ **Required Allowances**
1442
+
1443
+ In order to make this transaction, token allowances need to be set on the following contracts.
1444
+
1445
+ - `<token address>`
1446
+ </Info>
1447
+
1424
1448
 
1425
1449
  :param vault_address: The vault address you are withdrawing from.
1426
1450
  :param amount: The amount of tokens to withdraw from the vault. If set to 'ALL', your total deposited token amount will be withdrawn.
@@ -1533,6 +1557,14 @@ class Morpho(BaseSDK):
1533
1557
  exposure for all deposited assets so users don't need to make these decisions
1534
1558
  themselves. Users maintain full control over their assets, can monitor the vault's
1535
1559
  state at any time, and withdraw their liquidity at their discretion.
1560
+ <Info>
1561
+ **Required Allowances**
1562
+
1563
+ In order to make this transaction, token allowances need to be set on the following contracts.
1564
+
1565
+ - `<token address>`
1566
+ </Info>
1567
+
1536
1568
 
1537
1569
  :param vault_address: The vault address you are withdrawing from.
1538
1570
  :param amount: The amount of tokens to withdraw from the vault. If set to 'ALL', your total deposited token amount will be withdrawn.
@@ -1644,6 +1676,14 @@ class Morpho(BaseSDK):
1644
1676
  loan asset. Each market is isolated (meaning risks are contained within each
1645
1677
  individual market), immutable (cannot be changed after deployment), and will persist
1646
1678
  as long as the blockchain it is deployed on is live.
1679
+ <Info>
1680
+ **Required Allowances**
1681
+
1682
+ In order to make this transaction, token allowances need to be set on the following contracts.
1683
+
1684
+ - `Morpho`
1685
+ </Info>
1686
+
1647
1687
 
1648
1688
  :param amount: Amount of the token to supply to the market as collateral.
1649
1689
  :param unique_market_key: The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint.
@@ -1757,6 +1797,14 @@ class Morpho(BaseSDK):
1757
1797
  loan asset. Each market is isolated (meaning risks are contained within each
1758
1798
  individual market), immutable (cannot be changed after deployment), and will persist
1759
1799
  as long as the blockchain it is deployed on is live.
1800
+ <Info>
1801
+ **Required Allowances**
1802
+
1803
+ In order to make this transaction, token allowances need to be set on the following contracts.
1804
+
1805
+ - `Morpho`
1806
+ </Info>
1807
+
1760
1808
 
1761
1809
  :param amount: Amount of the token to supply to the market as collateral.
1762
1810
  :param unique_market_key: The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint.
@@ -1870,6 +1918,14 @@ class Morpho(BaseSDK):
1870
1918
  loan asset. Each market is isolated (meaning risks are contained within each
1871
1919
  individual market), immutable (cannot be changed after deployment), and will persist
1872
1920
  as long as the blockchain it is deployed on is live.
1921
+ <Info>
1922
+ **Required Allowances**
1923
+
1924
+ In order to make this transaction, token allowances need to be set on the following contracts.
1925
+
1926
+ - `Morpho`
1927
+ </Info>
1928
+
1873
1929
 
1874
1930
  :param amount: Amount of the token to supply to the market as collateral.
1875
1931
  :param unique_market_key: The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint.
@@ -1983,6 +2039,14 @@ class Morpho(BaseSDK):
1983
2039
  loan asset. Each market is isolated (meaning risks are contained within each
1984
2040
  individual market), immutable (cannot be changed after deployment), and will persist
1985
2041
  as long as the blockchain it is deployed on is live.
2042
+ <Info>
2043
+ **Required Allowances**
2044
+
2045
+ In order to make this transaction, token allowances need to be set on the following contracts.
2046
+
2047
+ - `Morpho`
2048
+ </Info>
2049
+
1986
2050
 
1987
2051
  :param amount: Amount of the token to supply to the market as collateral.
1988
2052
  :param unique_market_key: The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint.
@@ -2098,6 +2162,14 @@ class Morpho(BaseSDK):
2098
2162
  loan asset. Each market is isolated (meaning risks are contained within each
2099
2163
  individual market), immutable (cannot be changed after deployment), and will persist
2100
2164
  as long as the blockchain it is deployed on is live.
2165
+ <Info>
2166
+ **Required Allowances**
2167
+
2168
+ In order to make this transaction, token allowances need to be set on the following contracts.
2169
+
2170
+ - `Morpho`
2171
+ </Info>
2172
+
2101
2173
 
2102
2174
  :param amount: Amount of the token to borrow from the market.
2103
2175
  :param unique_market_key: The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint.
@@ -2213,6 +2285,14 @@ class Morpho(BaseSDK):
2213
2285
  loan asset. Each market is isolated (meaning risks are contained within each
2214
2286
  individual market), immutable (cannot be changed after deployment), and will persist
2215
2287
  as long as the blockchain it is deployed on is live.
2288
+ <Info>
2289
+ **Required Allowances**
2290
+
2291
+ In order to make this transaction, token allowances need to be set on the following contracts.
2292
+
2293
+ - `Morpho`
2294
+ </Info>
2295
+
2216
2296
 
2217
2297
  :param amount: Amount of the token to borrow from the market.
2218
2298
  :param unique_market_key: The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint.
@@ -2323,6 +2403,14 @@ class Morpho(BaseSDK):
2323
2403
  loan asset. Each market is isolated (meaning risks are contained within each
2324
2404
  individual market), immutable (cannot be changed after deployment), and will persist
2325
2405
  as long as the blockchain it is deployed on is live.
2406
+ <Info>
2407
+ **Required Allowances**
2408
+
2409
+ In order to make this transaction, token allowances need to be set on the following contracts.
2410
+
2411
+ - `Morpho`
2412
+ </Info>
2413
+
2326
2414
 
2327
2415
  :param amount: Amount of the token to repay to the market. If set to 'ALL', all debt plus interest will be paid back if the user has a sufficient token balance in their wallet.
2328
2416
  :param unique_market_key: The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint.
@@ -2433,6 +2521,14 @@ class Morpho(BaseSDK):
2433
2521
  loan asset. Each market is isolated (meaning risks are contained within each
2434
2522
  individual market), immutable (cannot be changed after deployment), and will persist
2435
2523
  as long as the blockchain it is deployed on is live.
2524
+ <Info>
2525
+ **Required Allowances**
2526
+
2527
+ In order to make this transaction, token allowances need to be set on the following contracts.
2528
+
2529
+ - `Morpho`
2530
+ </Info>
2531
+
2436
2532
 
2437
2533
  :param amount: Amount of the token to repay to the market. If set to 'ALL', all debt plus interest will be paid back if the user has a sufficient token balance in their wallet.
2438
2534
  :param unique_market_key: The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint.
compass_api_sdk/pendle.py CHANGED
@@ -795,6 +795,14 @@ class Pendle(BaseSDK):
795
795
  r"""Buy Principal Token (PT)
796
796
 
797
797
  Buy Principal Token (PT) with market's Underlying Token.
798
+ <Info>
799
+ **Required Allowances**
800
+
801
+ In order to make this transaction, token allowances need to be set on the following contracts.
802
+
803
+ - `PendleRouter`
804
+ </Info>
805
+
798
806
 
799
807
  :param market_address: The address of the market identifying which Principal Token (PT) you would like to buy.
800
808
  :param amount: The amount of market's Underlying Token you would like to sell for market's Principal Token (PT).
@@ -899,6 +907,14 @@ class Pendle(BaseSDK):
899
907
  r"""Buy Principal Token (PT)
900
908
 
901
909
  Buy Principal Token (PT) with market's Underlying Token.
910
+ <Info>
911
+ **Required Allowances**
912
+
913
+ In order to make this transaction, token allowances need to be set on the following contracts.
914
+
915
+ - `PendleRouter`
916
+ </Info>
917
+
902
918
 
903
919
  :param market_address: The address of the market identifying which Principal Token (PT) you would like to buy.
904
920
  :param amount: The amount of market's Underlying Token you would like to sell for market's Principal Token (PT).
@@ -1003,6 +1019,14 @@ class Pendle(BaseSDK):
1003
1019
  r"""Sell Principal Token (PT)
1004
1020
 
1005
1021
  Sell Principal Token (PT) for the market's Underlying Token.
1022
+ <Info>
1023
+ **Required Allowances**
1024
+
1025
+ In order to make this transaction, token allowances need to be set on the following contracts.
1026
+
1027
+ - `PendleRouter`
1028
+ </Info>
1029
+
1006
1030
 
1007
1031
  :param market_address: The address of the market identifying which Principal Token (PT) you would like to sell.
1008
1032
  :param amount: The amount of market's Principal Token (PT) you would like to sell for market's Underlying Token.
@@ -1107,6 +1131,14 @@ class Pendle(BaseSDK):
1107
1131
  r"""Sell Principal Token (PT)
1108
1132
 
1109
1133
  Sell Principal Token (PT) for the market's Underlying Token.
1134
+ <Info>
1135
+ **Required Allowances**
1136
+
1137
+ In order to make this transaction, token allowances need to be set on the following contracts.
1138
+
1139
+ - `PendleRouter`
1140
+ </Info>
1141
+
1110
1142
 
1111
1143
  :param market_address: The address of the market identifying which Principal Token (PT) you would like to sell.
1112
1144
  :param amount: The amount of market's Principal Token (PT) you would like to sell for market's Underlying Token.
@@ -1211,6 +1243,14 @@ class Pendle(BaseSDK):
1211
1243
  r"""Buy Yield Token (YT)
1212
1244
 
1213
1245
  Buy Yield Token (YT) with market's Underlying Token.
1246
+ <Info>
1247
+ **Required Allowances**
1248
+
1249
+ In order to make this transaction, token allowances need to be set on the following contracts.
1250
+
1251
+ - `PendleRouter`
1252
+ </Info>
1253
+
1214
1254
 
1215
1255
  :param market_address: The address of the market identifying which Yield Token (YT) you would like to buy.
1216
1256
  :param amount: The amount of market's Underlying Token you would like to sell for market's Yield Token (YT).
@@ -1315,6 +1355,14 @@ class Pendle(BaseSDK):
1315
1355
  r"""Buy Yield Token (YT)
1316
1356
 
1317
1357
  Buy Yield Token (YT) with market's Underlying Token.
1358
+ <Info>
1359
+ **Required Allowances**
1360
+
1361
+ In order to make this transaction, token allowances need to be set on the following contracts.
1362
+
1363
+ - `PendleRouter`
1364
+ </Info>
1365
+
1318
1366
 
1319
1367
  :param market_address: The address of the market identifying which Yield Token (YT) you would like to buy.
1320
1368
  :param amount: The amount of market's Underlying Token you would like to sell for market's Yield Token (YT).
@@ -1419,6 +1467,14 @@ class Pendle(BaseSDK):
1419
1467
  r"""Sell Yield Token (YT)
1420
1468
 
1421
1469
  Sell Yield Token (YT) for the market's Underlying Token.
1470
+ <Info>
1471
+ **Required Allowances**
1472
+
1473
+ In order to make this transaction, token allowances need to be set on the following contracts.
1474
+
1475
+ - `PendleRouter`
1476
+ </Info>
1477
+
1422
1478
 
1423
1479
  :param market_address: The address of the market identifying which Yield Token (YT) you would like to sell.
1424
1480
  :param amount: The amount of market's Yield Token (YT) you would like to sell for market's Underlying Token.
@@ -1523,6 +1579,14 @@ class Pendle(BaseSDK):
1523
1579
  r"""Sell Yield Token (YT)
1524
1580
 
1525
1581
  Sell Yield Token (YT) for the market's Underlying Token.
1582
+ <Info>
1583
+ **Required Allowances**
1584
+
1585
+ In order to make this transaction, token allowances need to be set on the following contracts.
1586
+
1587
+ - `PendleRouter`
1588
+ </Info>
1589
+
1526
1590
 
1527
1591
  :param market_address: The address of the market identifying which Yield Token (YT) you would like to sell.
1528
1592
  :param amount: The amount of market's Yield Token (YT) you would like to sell for market's Underlying Token.
@@ -1623,6 +1687,14 @@ class Pendle(BaseSDK):
1623
1687
  r"""Redeem Claimable Yield
1624
1688
 
1625
1689
  Redeem claimable yield from the market's associated Yield Token (YT).
1690
+ <Info>
1691
+ **Required Allowances**
1692
+
1693
+ In order to make this transaction, token allowances need to be set on the following contracts.
1694
+
1695
+ - `PendleRouter`
1696
+ </Info>
1697
+
1626
1698
 
1627
1699
  :param market_address: The address of the market identifying which Yield Token (YT) you would like to claim yield from.
1628
1700
  :param chain: The chain to use.
@@ -1719,6 +1791,14 @@ class Pendle(BaseSDK):
1719
1791
  r"""Redeem Claimable Yield
1720
1792
 
1721
1793
  Redeem claimable yield from the market's associated Yield Token (YT).
1794
+ <Info>
1795
+ **Required Allowances**
1796
+
1797
+ In order to make this transaction, token allowances need to be set on the following contracts.
1798
+
1799
+ - `PendleRouter`
1800
+ </Info>
1801
+
1722
1802
 
1723
1803
  :param market_address: The address of the market identifying which Yield Token (YT) you would like to claim yield from.
1724
1804
  :param chain: The chain to use.
@@ -1823,6 +1903,14 @@ class Pendle(BaseSDK):
1823
1903
 
1824
1904
  Liquidity is added in the form of the market's Underlying Token. Representation of
1825
1905
  the liquidity received is the market's Liquidity Provider Token (LP).
1906
+ <Info>
1907
+ **Required Allowances**
1908
+
1909
+ In order to make this transaction, token allowances need to be set on the following contracts.
1910
+
1911
+ - `PendleRouter`
1912
+ </Info>
1913
+
1826
1914
 
1827
1915
  :param market_address: The address identifying which Pendle Market you would like to add liquidity to.
1828
1916
  :param amount: The amount of liquidity you would like to add to the market denominated in the market's Underlying Token.
@@ -1931,6 +2019,14 @@ class Pendle(BaseSDK):
1931
2019
 
1932
2020
  Liquidity is added in the form of the market's Underlying Token. Representation of
1933
2021
  the liquidity received is the market's Liquidity Provider Token (LP).
2022
+ <Info>
2023
+ **Required Allowances**
2024
+
2025
+ In order to make this transaction, token allowances need to be set on the following contracts.
2026
+
2027
+ - `PendleRouter`
2028
+ </Info>
2029
+
1934
2030
 
1935
2031
  :param market_address: The address identifying which Pendle Market you would like to add liquidity to.
1936
2032
  :param amount: The amount of liquidity you would like to add to the market denominated in the market's Underlying Token.
@@ -2040,6 +2136,14 @@ class Pendle(BaseSDK):
2040
2136
  Liquidity is removed in the form of the market's Liquidity Provider Token (LP) into
2041
2137
  the market's Underlying Token. An appropriate allowance for the Pendle Router on the
2042
2138
  market contract must be set beforehand
2139
+ <Info>
2140
+ **Required Allowances**
2141
+
2142
+ In order to make this transaction, token allowances need to be set on the following contracts.
2143
+
2144
+ - `PendleRouter`
2145
+ </Info>
2146
+
2043
2147
 
2044
2148
  :param market_address: The address identifying which Pendle Market you would like to remove liquidity from.
2045
2149
  :param amount: The amount of liquidity you would like to remove from the market denominated in the market's Liquidity Provider Token (LP).
@@ -2149,6 +2253,14 @@ class Pendle(BaseSDK):
2149
2253
  Liquidity is removed in the form of the market's Liquidity Provider Token (LP) into
2150
2254
  the market's Underlying Token. An appropriate allowance for the Pendle Router on the
2151
2255
  market contract must be set beforehand
2256
+ <Info>
2257
+ **Required Allowances**
2258
+
2259
+ In order to make this transaction, token allowances need to be set on the following contracts.
2260
+
2261
+ - `PendleRouter`
2262
+ </Info>
2263
+
2152
2264
 
2153
2265
  :param market_address: The address identifying which Pendle Market you would like to remove liquidity from.
2154
2266
  :param amount: The amount of liquidity you would like to remove from the market denominated in the market's Liquidity Provider Token (LP).
compass_api_sdk/sky.py CHANGED
@@ -203,6 +203,14 @@ class Sky(BaseSDK):
203
203
 
204
204
  If buying with USDC, user will need to set an allowance on the USDC contract for the
205
205
  'SkyUsdcUsdsConverter' contract beforehand.
206
+ <Info>
207
+ **Required Allowances**
208
+
209
+ In order to make this transaction, token allowances need to be set on the following contracts.
210
+
211
+ - `SkyUsdcUsdsConverter`
212
+ </Info>
213
+
206
214
 
207
215
  :param token_in: The token you would like to swap 1:1 for USDS. Choose from DAI or USDC.
208
216
  :param amount: The amount of USDS you would like to buy 1:1 with 'token_in'.
@@ -305,6 +313,14 @@ class Sky(BaseSDK):
305
313
 
306
314
  If buying with USDC, user will need to set an allowance on the USDC contract for the
307
315
  'SkyUsdcUsdsConverter' contract beforehand.
316
+ <Info>
317
+ **Required Allowances**
318
+
319
+ In order to make this transaction, token allowances need to be set on the following contracts.
320
+
321
+ - `SkyUsdcUsdsConverter`
322
+ </Info>
323
+
308
324
 
309
325
  :param token_in: The token you would like to swap 1:1 for USDS. Choose from DAI or USDC.
310
326
  :param amount: The amount of USDS you would like to buy 1:1 with 'token_in'.
@@ -409,6 +425,14 @@ class Sky(BaseSDK):
409
425
 
410
426
  If swapping to USDC, user will need to set an allowance on the USDS contract for the
411
427
  'SkyUsdcUsdsConverter' contract beforehand.
428
+ <Info>
429
+ **Required Allowances**
430
+
431
+ In order to make this transaction, token allowances need to be set on the following contracts.
432
+
433
+ - `SkyUsdcUsdsConverter`
434
+ </Info>
435
+
412
436
 
413
437
  :param token_out: The token you would like to swap 1:1 with USDS. Choose from DAI or USDC.
414
438
  :param amount: The amount of USDS you would like to sell 1:1 for 'token_out'.
@@ -513,6 +537,14 @@ class Sky(BaseSDK):
513
537
 
514
538
  If swapping to USDC, user will need to set an allowance on the USDS contract for the
515
539
  'SkyUsdcUsdsConverter' contract beforehand.
540
+ <Info>
541
+ **Required Allowances**
542
+
543
+ In order to make this transaction, token allowances need to be set on the following contracts.
544
+
545
+ - `SkyUsdcUsdsConverter`
546
+ </Info>
547
+
516
548
 
517
549
  :param token_out: The token you would like to swap 1:1 with USDS. Choose from DAI or USDC.
518
550
  :param amount: The amount of USDS you would like to sell 1:1 for 'token_out'.
@@ -615,6 +647,14 @@ class Sky(BaseSDK):
615
647
  Allowance must be set on USDS contract for UsdsVault.
616
648
 
617
649
  There are no fees.
650
+ <Info>
651
+ **Required Allowances**
652
+
653
+ In order to make this transaction, token allowances need to be set on the following contracts.
654
+
655
+ - `SkyUsdsVault`
656
+ </Info>
657
+
618
658
 
619
659
  :param amount: The amount of USDS you would like to deposit for sUSDS to earn yield.
620
660
  :param sender: The address of the transaction sender.
@@ -717,6 +757,14 @@ class Sky(BaseSDK):
717
757
  Allowance must be set on USDS contract for UsdsVault.
718
758
 
719
759
  There are no fees.
760
+ <Info>
761
+ **Required Allowances**
762
+
763
+ In order to make this transaction, token allowances need to be set on the following contracts.
764
+
765
+ - `SkyUsdsVault`
766
+ </Info>
767
+
720
768
 
721
769
  :param amount: The amount of USDS you would like to deposit for sUSDS to earn yield.
722
770
  :param sender: The address of the transaction sender.
@@ -817,6 +865,15 @@ class Sky(BaseSDK):
817
865
  Allowance must be set on USDS contract for UsdsVault.
818
866
 
819
867
  There are no fees.
868
+ <Info>
869
+ **Required Allowances**
870
+
871
+ In order to make this transaction, token allowances need to be set on the following contracts.
872
+
873
+ - `SkyUsdcUsdsConverter`
874
+ - `SkyUsdsVault`
875
+ </Info>
876
+
820
877
 
821
878
  :param amount: The amount of USDS you would like to withdraw. If set to 'ALL', your total deposited USDS amount will be withdrawn.
822
879
  :param sender: The address of the transaction sender.
@@ -917,6 +974,15 @@ class Sky(BaseSDK):
917
974
  Allowance must be set on USDS contract for UsdsVault.
918
975
 
919
976
  There are no fees.
977
+ <Info>
978
+ **Required Allowances**
979
+
980
+ In order to make this transaction, token allowances need to be set on the following contracts.
981
+
982
+ - `SkyUsdcUsdsConverter`
983
+ - `SkyUsdsVault`
984
+ </Info>
985
+
920
986
 
921
987
  :param amount: The amount of USDS you would like to withdraw. If set to 'ALL', your total deposited USDS amount will be withdrawn.
922
988
  :param sender: The address of the transaction sender.
@@ -1057,6 +1057,14 @@ class UniswapV3(BaseSDK):
1057
1057
  provide the necessary transaction details, including the token to buy, the token to
1058
1058
  pay with, and the exact amount to receive. If the token being paid with is WETH and
1059
1059
  needs to be wrapped, the appropriate amount will be wrapped automatically.
1060
+ <Info>
1061
+ **Required Allowances**
1062
+
1063
+ In order to make this transaction, token allowances need to be set on the following contracts.
1064
+
1065
+ - `UniswapV3Router`
1066
+ </Info>
1067
+
1060
1068
 
1061
1069
  :param token_in: The symbol of the token to swap from.
1062
1070
  :param token_out: The symbol of the token to swap to.
@@ -1183,6 +1191,14 @@ class UniswapV3(BaseSDK):
1183
1191
  provide the necessary transaction details, including the token to buy, the token to
1184
1192
  pay with, and the exact amount to receive. If the token being paid with is WETH and
1185
1193
  needs to be wrapped, the appropriate amount will be wrapped automatically.
1194
+ <Info>
1195
+ **Required Allowances**
1196
+
1197
+ In order to make this transaction, token allowances need to be set on the following contracts.
1198
+
1199
+ - `UniswapV3Router`
1200
+ </Info>
1201
+
1186
1202
 
1187
1203
  :param token_in: The symbol of the token to swap from.
1188
1204
  :param token_out: The symbol of the token to swap to.
@@ -1303,6 +1319,14 @@ class UniswapV3(BaseSDK):
1303
1319
  provide the necessary transaction details, including the token to sell, the token to
1304
1320
  receive, and the amount to sell. If the token being sold is WETH and needs to be
1305
1321
  wrapped, the appropriate amount will be wrapped automatically.
1322
+ <Info>
1323
+ **Required Allowances**
1324
+
1325
+ In order to make this transaction, token allowances need to be set on the following contracts.
1326
+
1327
+ - `UniswapV3Router`
1328
+ </Info>
1329
+
1306
1330
 
1307
1331
  :param token_in: 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.
1308
1332
  :param token_out: 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.
@@ -1423,6 +1447,14 @@ class UniswapV3(BaseSDK):
1423
1447
  provide the necessary transaction details, including the token to sell, the token to
1424
1448
  receive, and the amount to sell. If the token being sold is WETH and needs to be
1425
1449
  wrapped, the appropriate amount will be wrapped automatically.
1450
+ <Info>
1451
+ **Required Allowances**
1452
+
1453
+ In order to make this transaction, token allowances need to be set on the following contracts.
1454
+
1455
+ - `UniswapV3Router`
1456
+ </Info>
1457
+
1426
1458
 
1427
1459
  :param token_in: 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.
1428
1460
  :param token_out: 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.
@@ -1558,6 +1590,14 @@ class UniswapV3(BaseSDK):
1558
1590
  enabling them to earn fees from trades that occur within the pool. The endpoint
1559
1591
  requires details such as the token pair, amount, and any additional parameters
1560
1592
  needed for the minting process.
1593
+ <Info>
1594
+ **Required Allowances**
1595
+
1596
+ In order to make this transaction, token allowances need to be set on the following contracts.
1597
+
1598
+ - `UniswapV3NFTPositionManager`
1599
+ </Info>
1600
+
1561
1601
 
1562
1602
  :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.
1563
1603
  :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.
@@ -1705,6 +1745,14 @@ class UniswapV3(BaseSDK):
1705
1745
  enabling them to earn fees from trades that occur within the pool. The endpoint
1706
1746
  requires details such as the token pair, amount, and any additional parameters
1707
1747
  needed for the minting process.
1748
+ <Info>
1749
+ **Required Allowances**
1750
+
1751
+ In order to make this transaction, token allowances need to be set on the following contracts.
1752
+
1753
+ - `UniswapV3NFTPositionManager`
1754
+ </Info>
1755
+
1708
1756
 
1709
1757
  :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.
1710
1758
  :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.
@@ -1847,6 +1895,14 @@ class UniswapV3(BaseSDK):
1847
1895
  within the pool. The endpoint requires details such as the token pair, additional
1848
1896
  amount to be added, and any other parameters necessary for the liquidity increase
1849
1897
  process.
1898
+ <Info>
1899
+ **Required Allowances**
1900
+
1901
+ In order to make this transaction, token allowances need to be set on the following contracts.
1902
+
1903
+ - `AerodromeSlipstreamRouter`
1904
+ </Info>
1905
+
1850
1906
 
1851
1907
  :param token_id: Token ID of the NFT representing the liquidity provisioned position.
1852
1908
  :param amount0_desired: The desired amount of the first token to deposit
@@ -1979,6 +2035,14 @@ class UniswapV3(BaseSDK):
1979
2035
  within the pool. The endpoint requires details such as the token pair, additional
1980
2036
  amount to be added, and any other parameters necessary for the liquidity increase
1981
2037
  process.
2038
+ <Info>
2039
+ **Required Allowances**
2040
+
2041
+ In order to make this transaction, token allowances need to be set on the following contracts.
2042
+
2043
+ - `AerodromeSlipstreamRouter`
2044
+ </Info>
2045
+
1982
2046
 
1983
2047
  :param token_id: Token ID of the NFT representing the liquidity provisioned position.
1984
2048
  :param amount0_desired: The desired amount of the first token to deposit
@@ -2100,6 +2164,14 @@ class UniswapV3(BaseSDK):
2100
2164
  amount to be withdrawn, and any additional parameters needed for the withdrawal
2101
2165
  process. Users should ensure they meet any protocol requirements or conditions
2102
2166
  before initiating a withdrawal to avoid potential issues or penalties.
2167
+ <Info>
2168
+ **Required Allowances**
2169
+
2170
+ In order to make this transaction, token allowances need to be set on the following contracts.
2171
+
2172
+ - `UniswapV3NFTPositionManager`
2173
+ </Info>
2174
+
2103
2175
 
2104
2176
  :param token_id: Token ID of the NFT representing the liquidity provisioned position.
2105
2177
  :param percentage_for_withdrawal: How much liquidity to take out in percentage.
@@ -2215,6 +2287,14 @@ class UniswapV3(BaseSDK):
2215
2287
  amount to be withdrawn, and any additional parameters needed for the withdrawal
2216
2288
  process. Users should ensure they meet any protocol requirements or conditions
2217
2289
  before initiating a withdrawal to avoid potential issues or penalties.
2290
+ <Info>
2291
+ **Required Allowances**
2292
+
2293
+ In order to make this transaction, token allowances need to be set on the following contracts.
2294
+
2295
+ - `UniswapV3NFTPositionManager`
2296
+ </Info>
2297
+
2218
2298
 
2219
2299
  :param token_id: Token ID of the NFT representing the liquidity provisioned position.
2220
2300
  :param percentage_for_withdrawal: How much liquidity to take out in percentage.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.3
2
2
  Name: compass_api_sdk
3
- Version: 0.9.45
3
+ Version: 0.9.47
4
4
  Summary: Compass API SDK.
5
5
  Author: royalnine
6
6
  Requires-Python: >=3.9.2
@@ -2,11 +2,11 @@ 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=qaG6705xNObV_Og9r38dN8EroFcJKKE4ud64r49wmf0,474
6
- compass_api_sdk/aave_v3.py,sha256=OhQmjeWl2emRwT0g1D9RUdPn5B3NsO2fdwzszPs3Uug,116614
7
- compass_api_sdk/aerodrome_slipstream.py,sha256=l57AwIZqQvYpeZp9ZJxfhHXqPD5XRGSH0d5ETV3YLww,78289
5
+ compass_api_sdk/_version.py,sha256=00039VYx5tU-ckWdT7WcYhMT0pMdVsEm6DM6NQFNwzc,474
6
+ compass_api_sdk/aave_v3.py,sha256=4eQQKFIjY-adOE6Uv30n_9K7XCT74am8uFhvZXE2o4I,118150
7
+ compass_api_sdk/aerodrome_slipstream.py,sha256=Ym1DuavVYneGxdCUp2aGsSnsd6_z4aQ53vohR4RQLoU,80439
8
8
  compass_api_sdk/basesdk.py,sha256=PQNcMD7BiLruZwOuU2TeWIE_zQ0iO--XYUFmIDr5zX0,11844
9
- compass_api_sdk/erc_4626_vaults.py,sha256=h2lIPJYbyj6eBZQ6ww9FiU-ZYwLZpcgN3P0nieQtptc,26383
9
+ compass_api_sdk/erc_4626_vaults.py,sha256=X3CTaLLs5MR6miC_2qzbXpYoAU8m0PT54R_uryOGOps,27171
10
10
  compass_api_sdk/errors/__init__.py,sha256=UZYQ_CPi1cQkYcHe6n00nfKPIRwbmcufTY-FmMJGmk8,1693
11
11
  compass_api_sdk/errors/apierror.py,sha256=y1lf-8zwQhv1JGntxj03ViMUyHN_Uewe0oZoH8MhwSM,1235
12
12
  compass_api_sdk/errors/compassapierror.py,sha256=VqVzBWmwoS3OvoKbgBNh2WFFhrM3K5Kbz_5q4bupD7o,717
@@ -15,14 +15,14 @@ compass_api_sdk/errors/no_response_error.py,sha256=FQG44Lq6uF7uUlzbUYfM3dJon6sbq
15
15
  compass_api_sdk/errors/responsevalidationerror.py,sha256=baMAkfmUhcPt_cxzyOCBCGBOzlXAeTHwcn5AUCsAgOw,702
16
16
  compass_api_sdk/httpclient.py,sha256=Eu73urOAiZQtdUIyOUnPccxCiBbWEKrXG-JrRG3SLM4,3946
17
17
  compass_api_sdk/models/__init__.py,sha256=GR_nXZ5ZhQDUmAv0uvptb7cy8DRJYrOrfJ8aWFHZhsE,119867
18
- compass_api_sdk/models/aave_avg_rateop.py,sha256=Qn7IkBwZv5zY_L15V_LONkANzQPTbtmK2Wwhc2iqYz8,3718
18
+ compass_api_sdk/models/aave_avg_rateop.py,sha256=rBneLLelvbRzLENqEWaRgZd1EAm3f3Uq9IEsXRoOroI,3739
19
19
  compass_api_sdk/models/aave_historical_transactionsop.py,sha256=oWOjaRhNyjddZPqr5RfhNYf6V4Ye4gOQ0BDIXoqZGSs,1785
20
- compass_api_sdk/models/aave_liquidity_changeop.py,sha256=o9G4dD2foyhbunziTv_177Qr2AK37KTIQsQfvPxo5Fs,2785
21
- compass_api_sdk/models/aave_rateop.py,sha256=XXSijtbokJT2U1rOoqjLr80Sff8ttbUmzv4GsU6XogY,3479
22
- compass_api_sdk/models/aave_reserve_overviewop.py,sha256=aVsX994CYVHFxhCkNC4nXezjaPA5GfKTkKrgCWITXR4,3525
23
- compass_api_sdk/models/aave_std_rateop.py,sha256=H7D_0KPFWPUXksWnAE75ZqMzPh_cAlgCA5QbXcNcy-Y,3742
24
- compass_api_sdk/models/aave_token_priceop.py,sha256=VoybSuyqgeXfU08dvKwlXLj559jckT770zAuWmgMu3A,3517
25
- compass_api_sdk/models/aave_user_position_per_tokenop.py,sha256=sKZ9rKj6nqvIBCmXx8NCcUvGFkujFcfWfGT1Qqzmy9g,3927
20
+ compass_api_sdk/models/aave_liquidity_changeop.py,sha256=14bkUs750CC6yS65bWSveDMbP5PwfMzpdV-nxPUcqAY,2806
21
+ compass_api_sdk/models/aave_rateop.py,sha256=4Tl-rNyFI6eqQD2AwnNNyT0JZh35HFlTYMrB_UnBR1U,3500
22
+ compass_api_sdk/models/aave_reserve_overviewop.py,sha256=0q2q-vrghPvOPzVEzY1R9WkZDo8eZl9K_1T7gEaqJE4,3546
23
+ compass_api_sdk/models/aave_std_rateop.py,sha256=qCW3VstHniBOLJaYR3p8pI3B2RD1NHJxMmW4i3fhrKA,3763
24
+ compass_api_sdk/models/aave_token_priceop.py,sha256=4Xabx2BlxmfTuhkuU_icPwSnil2bjYDj7MsU2KG0VCE,3538
25
+ compass_api_sdk/models/aave_user_position_per_tokenop.py,sha256=IFXaCznKIxGJ1be6Gl3DJbPOmOZrC_z7G_lDa3MyrmU,3948
26
26
  compass_api_sdk/models/aave_user_position_summaryop.py,sha256=zNhqGuyyale1iCT-hsXo32n2NO_XK5JtZYjVO-XuBl4,2480
27
27
  compass_api_sdk/models/aaveavgrateresponse.py,sha256=q_MArkpvKD2WdjxV7fljIHfnCbBytjddcj4m6UUGkR0,1330
28
28
  compass_api_sdk/models/aaveborrowparams.py,sha256=Sb_i4KtK1ZVGGzkt7WU391cJzCryRpPp2m6vg7Du9Z8,3309
@@ -43,7 +43,7 @@ compass_api_sdk/models/aaveuserpositionsummaryresponse.py,sha256=_m2f4XkNQnaftbJ
43
43
  compass_api_sdk/models/aavewithdrawparams.py,sha256=xAhnVgQcJY1sJ16dN0wrR0oQCQKNIIpUMx3H4U_9pk0,1852
44
44
  compass_api_sdk/models/aavewithdrawrequest.py,sha256=InLgD46BU0NA1SvZP_OtCpvMKSAWM6C_w6Cb7PyapuY,2117
45
45
  compass_api_sdk/models/aerodrome_slipstream_liquidity_provision_positionsop.py,sha256=_lxIcoo4g4S7ZzSfHc-kWCmbAiesEFdTOJTkQn3XbQc,1351
46
- compass_api_sdk/models/aerodrome_slipstream_pool_priceop.py,sha256=tSwL-RVu9GTyMPMZaYyQDWrsyuWNCFJoUgzpRvWdDc4,4062
46
+ compass_api_sdk/models/aerodrome_slipstream_pool_priceop.py,sha256=aJ13RIykFYvQMz_2VWDwHpfG1dyP2ingz4SMxO_px94,4104
47
47
  compass_api_sdk/models/aerodromelppositionsresponse.py,sha256=FpFiz78711CsO1r3lLo-YaPldHL6UTVruNxhWlXkhOY,861
48
48
  compass_api_sdk/models/aerodromeposition.py,sha256=I-SHEmis8d5lGu37mauJPomjQKJs4_lvgtCYER5Fn3o,1695
49
49
  compass_api_sdk/models/aerodromeslipstreambuyexactlyparams.py,sha256=tQfmHERlJIFbJ1Thoj6d-iqpov2-rC5HlnKr2RyXPl4,3323
@@ -171,9 +171,9 @@ compass_api_sdk/models/skywithdrawrequest.py,sha256=nPjZLaeKusGF90yYO6SPW8iTpuB0
171
171
  compass_api_sdk/models/supply.py,sha256=uH7dvmTkDtSU9btasJNbdFmesF2AdJc-Yoxusz7rYf8,1554
172
172
  compass_api_sdk/models/swapborrowrate.py,sha256=RhZtLKwlDEMiHLdkvD3_URREdcBBbaFk95NN2QZug5g,1744
173
173
  compass_api_sdk/models/syposition.py,sha256=AZK-1B3zsZphz-zmYOR_cTONyyhbPJnVe3x93NVwcH8,396
174
- compass_api_sdk/models/token_addressop.py,sha256=4rmH4aUL9rPQWpeI3YSUPr-UVgIvB8q4QEMRHPHMv7g,2161
174
+ compass_api_sdk/models/token_addressop.py,sha256=923mPnJfyi4dMV3M2FIaMEeVtAFeRYnLJMfkzCunvnc,2182
175
175
  compass_api_sdk/models/token_balanceop.py,sha256=IJ9QjyIDvpNNvGzeUF9E4FsCR8Q-tciB6zvFcskK_ic,1793
176
- compass_api_sdk/models/token_enum.py,sha256=klu_nFSPn35oWFaduBEjRQm5WjkNOpZztRVj0FucuK4,1166
176
+ compass_api_sdk/models/token_enum.py,sha256=9gm9D1c-Sw0dfqd6r8EnuCBXTQZiXRUkrDOXB3yTcRU,1187
177
177
  compass_api_sdk/models/token_priceop.py,sha256=ALzMZLAwM2fZ_wIifwGszBPyCQm7d3i7_gVxOtuECPc,2843
178
178
  compass_api_sdk/models/tokenaddressresponse.py,sha256=alnjhUzaC_oBUWl1iyoSTh3La_I49CT5YyrPNN0ukmk,399
179
179
  compass_api_sdk/models/tokenbalanceresponse.py,sha256=CvSBOatB-SsFtkXkfYsOplcJyN0AhmP1PailafwloPs,1193
@@ -184,9 +184,9 @@ compass_api_sdk/models/tokentransferrequest.py,sha256=axFQ4c11iQpXCAXPwY4aMxkVaQ
184
184
  compass_api_sdk/models/txresponse.py,sha256=F6e_6eqRd4ou5EiK5BQ4_WpZj0HMjHFemp5jD9Q86_M,818
185
185
  compass_api_sdk/models/uniswap_liquidity_provision_in_rangeop.py,sha256=mkg0Eg50xQCiQ00Nq_Rw-KPZ0iwb56YsQZ05k-loAnw,1245
186
186
  compass_api_sdk/models/uniswap_liquidity_provision_positionsop.py,sha256=-HW4PPi8j1KEypBbuoqLoH89djhW8zDvUTACdklYoqg,1283
187
- compass_api_sdk/models/uniswap_pool_priceop.py,sha256=JTBQcsaeJSN_tELQW6iMBztsww84x8ORdJaQmLIRb5c,4115
188
- compass_api_sdk/models/uniswap_quote_buy_exactlyop.py,sha256=bccb6R2Vont8p2uPI339D9tQ8gpuyTnXLT0odLXHHws,4914
189
- compass_api_sdk/models/uniswap_quote_sell_exactlyop.py,sha256=xOsycQxu7rpp_s5TbYbOarQZnW3yDhRCvX3EBe1x28c,4938
187
+ compass_api_sdk/models/uniswap_pool_priceop.py,sha256=A7wSyaWblWMNd7VXBZ-2MVukGyy7UdiTfEMUhuBlIvI,4157
188
+ compass_api_sdk/models/uniswap_quote_buy_exactlyop.py,sha256=dh1YawT0imWIR79T5-y_lB-Bo2sI7xFihLMmnGN8fDE,4956
189
+ compass_api_sdk/models/uniswap_quote_sell_exactlyop.py,sha256=Ma6pmKJ_4zX8jW180bROyfKlyU87XrOswC_9bUFonzs,4980
190
190
  compass_api_sdk/models/uniswapbuyexactlyparams.py,sha256=xJLxM351q-hMtgeKYEgpsxFxKxKdXpZZy1fYMtd4Xrw,3156
191
191
  compass_api_sdk/models/uniswapbuyexactlyrequest.py,sha256=NcCbCHw5MpBPd8j3U26toGculyoPagXKnEVmyw-qrP0,3555
192
192
  compass_api_sdk/models/uniswapbuyquoteinforesponse.py,sha256=9vhkblgXbV_2wrAMZXv2iswxl7TxzlUMrMNLTUvCeeI,734
@@ -222,18 +222,18 @@ compass_api_sdk/models/weeklyapys.py,sha256=AaGjDD4NeGsZQBwdRW1G09Pmx17pLPe2oUA9
222
222
  compass_api_sdk/models/wrapethparams.py,sha256=nw1fZiDrj5wZnI25Vmg0DcNI01k-uhot68lG1_H7xrY,1223
223
223
  compass_api_sdk/models/wrapethrequest.py,sha256=pjo0BZtzdOZKuwgnc05LsCWO1A6ZAGLwFixLuXQNKDg,1476
224
224
  compass_api_sdk/models/yieldrange.py,sha256=WEpZR24JddnCS1_13y2P1CdD0lBi6dPktysCNu3TUic,324
225
- compass_api_sdk/morpho.py,sha256=RJ7uw5GswJmy65Imwq3i3svxjuhVpl5c3Q9bv9AY9jw,107770
226
- compass_api_sdk/pendle.py,sha256=Eb4zJfmfU28fria3eeA_tA2xnKZjvmtTrTJpNrrhb98,93890
225
+ compass_api_sdk/morpho.py,sha256=pviK4dBnaaCENUIEvfI3-2F22SMz9xgXDDWzx1WOHpY,110040
226
+ compass_api_sdk/pendle.py,sha256=hLldhz26PwMgx7vnpIMPNtT5nHL83PZuy-WtOLQGL-Q,96606
227
227
  compass_api_sdk/py.typed,sha256=zrp19r0G21lr2yRiMC0f8MFkQFGj9wMpSbboePMg8KM,59
228
228
  compass_api_sdk/sdk.py,sha256=rQ3ANGf0BxHoZc9hCQvsxkNc9qOW3DbGAuOz_sy3o7g,7865
229
229
  compass_api_sdk/sdkconfiguration.py,sha256=5nec4ViMLCsNWBd3DyEv8zWqU5Z77YZfzwX69jkdSnM,1607
230
- compass_api_sdk/sky.py,sha256=z7vR7IRGP80G_v7FedI33XJjDMJdk1dID5yi4ezEpew,40691
230
+ compass_api_sdk/sky.py,sha256=hb6gocNjaammmojMrs0PA0uSvmYNWaOjWHdvMNHDgbA,42341
231
231
  compass_api_sdk/smart_account.py,sha256=H28RSfvyffnWNBOy7irXHsp4Xcmz-mBgKuJWlsQ6Rv4,8704
232
232
  compass_api_sdk/token_sdk.py,sha256=0ecx4CkCV05_KLLDAxX5krEPRgJ8YUKea2ulTTZd1qY,32006
233
233
  compass_api_sdk/transaction_bundler.py,sha256=6nij4Wf5g5fyE_DEY0tGr9VGUNvyjXRLqEfA1Y1FUNM,30278
234
234
  compass_api_sdk/types/__init__.py,sha256=RArOwSgeeTIva6h-4ttjXwMUeCkz10nAFBL9D-QljI4,377
235
235
  compass_api_sdk/types/basemodel.py,sha256=L79WXvTECbSqaJzs8D3ud_KdIWkU7Cx2wbohDAktE9E,1127
236
- compass_api_sdk/uniswap_v3.py,sha256=MVyv6u_nQFoMXUGv0M6TWTHYAtPuTZjdK3ZQv0NAJRU,101489
236
+ compass_api_sdk/uniswap_v3.py,sha256=RrBsMi9-LZw9RH5SCtx-3l-UxDGNDoGzKyg5xs2CUhU,103527
237
237
  compass_api_sdk/universal.py,sha256=zdmsKmRxI9u3kv-kGXUXFY30ARz9Yp8yCYNl1bvjLxs,65113
238
238
  compass_api_sdk/utils/__init__.py,sha256=811KKdkxMaWDfz2lMohUWqrR4JnIWxqeNQ1lRGQU4DM,5341
239
239
  compass_api_sdk/utils/annotations.py,sha256=aR7mZG34FzgRdew7WZPYEu9QGBerpuKxCF4sek5Z_5Y,1699
@@ -252,6 +252,6 @@ compass_api_sdk/utils/serializers.py,sha256=Hndks5M_rJXVub_N5lu0gKZQUoEmWrn6PN7R
252
252
  compass_api_sdk/utils/unmarshal_json_response.py,sha256=GI4Cw4JB6H2qNkqbOuBiUcxtEOJhRm2bz3qfer9KmoE,591
253
253
  compass_api_sdk/utils/url.py,sha256=BgGPgcTA6MRK4bF8fjP2dUopN3NzEzxWMXPBVg8NQUA,5254
254
254
  compass_api_sdk/utils/values.py,sha256=CcaCXEa3xHhkUDROyXZocN8f0bdITftv9Y0P9lTf0YM,3517
255
- compass_api_sdk-0.9.45.dist-info/METADATA,sha256=E2rD5bUPoppC9ivsYWuE36Al0rfquCx9TAzbL68jrL8,28507
256
- compass_api_sdk-0.9.45.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
257
- compass_api_sdk-0.9.45.dist-info/RECORD,,
255
+ compass_api_sdk-0.9.47.dist-info/METADATA,sha256=2klrHHqELRY_OnhMbvD8JE_n4qfRSxP6f_4wFxJAO_E,28507
256
+ compass_api_sdk-0.9.47.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
257
+ compass_api_sdk-0.9.47.dist-info/RECORD,,