Skip to content

Commit f0eb18b

Browse files
[skip ci] update changelog, remove staking references
1 parent 344a518 commit f0eb18b

3 files changed

Lines changed: 17 additions & 25 deletions

File tree

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,15 @@
66

77
**Implemented enhancements:**
88

9+
- Resolve "Add NFT support: `kraken.nft.Trade` and `kraken.nft.Market`" [\#200](https://github.com/btschwertfeger/python-kraken-sdk/pull/200) ([btschwertfeger](https://github.com/btschwertfeger))
910
- Resolve "Mark `kraken.spot.Staking` as deprecated and add `kraken.spot.Earn`" [\#199](https://github.com/btschwertfeger/python-kraken-sdk/pull/199) ([btschwertfeger](https://github.com/btschwertfeger))
1011
- Resolve "Add `ledger` parameter to `kraken.spot.User.get_trades_history`" [\#195](https://github.com/btschwertfeger/python-kraken-sdk/pull/195) ([btschwertfeger](https://github.com/btschwertfeger))
1112
- Resolve "Add `kraken.futures.Trade.get_max_order_size`" [\#193](https://github.com/btschwertfeger/python-kraken-sdk/pull/193) ([btschwertfeger](https://github.com/btschwertfeger))
1213
- Resolve "Add `processBefore` parameter to `kraken.futures.Trade.`{`cancel_order`,`edit_order`,`create_order`,`create_batch_order`}" [\#192](https://github.com/btschwertfeger/python-kraken-sdk/pull/192) ([btschwertfeger](https://github.com/btschwertfeger))
1314

1415
Uncategorized merged pull requests:
1516

17+
- Resolve "Mark `kraken.spot.KrakenSpotWSClientV1` as deprecated" [\#201](https://github.com/btschwertfeger/python-kraken-sdk/pull/201) ([btschwertfeger](https://github.com/btschwertfeger))
1618
- Resolve "The POST and query parameters of KrakenSpotBaseAPI and KrakenFuturesBaseAPI are not proper encoded in some case" [\#189](https://github.com/btschwertfeger/python-kraken-sdk/pull/189) ([btschwertfeger](https://github.com/btschwertfeger))
1719
- adjust CI configuration [\#187](https://github.com/btschwertfeger/python-kraken-sdk/pull/187) ([btschwertfeger](https://github.com/btschwertfeger))
1820
- Merge the CI/CD and release workflow + fix scheduled execution [\#186](https://github.com/btschwertfeger/python-kraken-sdk/pull/186) ([btschwertfeger](https://github.com/btschwertfeger))

README.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -139,13 +139,13 @@ maintain a valid order book using the Orderbook client can be found in
139139

140140
The Kraken Spot REST API offers many endpoints for almost every use-case. The
141141
python-kraken-sdk aims to provide all of them - split in User, Market, Trade,
142-
Funding and Staking related clients.
142+
Funding and Staking (Earn) related clients.
143143

144144
The following code block demonstrates how to use some of them. More examples
145145
can be found in `examples/spot_examples.py`.
146146

147147
```python
148-
from kraken.spot import User, Market, Trade, Funding, Staking
148+
from kraken.spot import Earn, User, Market, Trade, Funding
149149

150150
def main():
151151
key = "kraken-public-key"
@@ -183,14 +183,9 @@ def main():
183183
print(funding.cancel_withdraw(asset="DOT", refid="<some id>"))
184184
#
185185

186-
# ____STAKING___________________________
187-
staking = Staking(key=key, secret=secret)
188-
print(staking.list_stakeable_assets())
189-
print(
190-
staking.stake_asset(
191-
asset="DOT", amount=20, method="polkadot-staked"
192-
)
193-
)
186+
# ____EARN________________________
187+
earn = Earn(key=key, secret=secret)
188+
print(earn.list_earn_strategies(asset="DOT"))
194189
#
195190

196191
if __name__ == "__main__":

examples/spot_examples.py

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
import time
1818
from pathlib import Path
1919

20-
from kraken.spot import Funding, Market, Staking, Trade, User
20+
from kraken.spot import Earn, Funding, Market, Trade, User
2121

2222
logging.basicConfig(
2323
format="%(asctime)s %(module)s,line: %(lineno)d %(levelname)8s | %(message)s",
@@ -185,27 +185,22 @@ def funding_examples() -> None:
185185
)
186186

187187

188-
def staking_examples() -> None:
189-
"""Example usage of the Staking client"""
190-
staking = Staking(key=key, secret=secret)
191-
print(staking.list_stakeable_assets())
192-
print(staking.list_staking_transactions())
193-
print(staking.get_pending_staking_transactions())
194-
raise ValueError(
195-
"Attention: Please check if you really want to execute staking functions.",
196-
)
197-
if False:
198-
print(staking.stake_asset(asset="DOT", amount=2000, method="polkadot-staked"))
199-
print(staking.unstake_asset(asset="DOT", amount=200, method="polkadot-staked"))
200-
time.sleep(2)
188+
def earn_examples() -> None:
189+
"""
190+
Example usage of the Funding client; not shown, since special API key
191+
permissions must be set.
192+
"""
193+
earn = Earn(key=key, secret=secret) # noqa: F841
194+
# ...
195+
# see tests/spot/test_spot_earn.py for examples.
201196

202197

203198
def main() -> None:
204199
user_examples()
205200
market_examples()
206201
trade_examples()
207202
funding_examples()
208-
staking_examples()
203+
earn_examples()
209204

210205

211206
if __name__ == "__main__":

0 commit comments

Comments
 (0)