From 7982a73aa71dad7866e28fd04a6dea6148027731 Mon Sep 17 00:00:00 2001 From: thunderbiscuit Date: Wed, 16 Feb 2022 21:31:39 -0500 Subject: [PATCH] Fix long description examples after API change --- setup.py | 30 ++++++++++-------------------- 1 file changed, 10 insertions(+), 20 deletions(-) diff --git a/setup.py b/setup.py index 55de5d7..3e36a59 100644 --- a/setup.py +++ b/setup.py @@ -13,25 +13,11 @@ The Python language bindings for the [bitcoindevkit](https://github.com/bitcoind pip install bdkpython ``` -## Simple examples -**Generate a testnet address** +## Simple example ```python import bdkpython as bdk -descriptor = "wpkh(tprv8ZgxMBicQKsPcx5nBGsR63Pe8KnRUqmbJNENAfGftF3yuXoMMoVJJcYeUw5eVkm9WBPjWYt6HMWYJNesB5HaNVBaFc1M6dRjWSYnmewUMYy/84h/1h/0h/0/*)" -config = bdk.DatabaseConfig.MEMORY("") - -wallet = bdk.OfflineWallet(descriptor, bdk.Network.TESTNET, config) -address = wallet.get_new_address() - -print(f"New BIP84 testnet address: {address}") -``` - -**Sync a wallet using Electrum** -```python -import bdkpython as bdk - descriptor = "wpkh(tprv8ZgxMBicQKsPcx5nBGsR63Pe8KnRUqmbJNENAfGftF3yuXoMMoVJJcYeUw5eVkm9WBPjWYt6HMWYJNesB5HaNVBaFc1M6dRjWSYnmewUMYy/84h/1h/0h/0/*)" config = bdk.DatabaseConfig.MEMORY("") client = bdk.BlockchainConfig.ELECTRUM( @@ -44,7 +30,7 @@ client = bdk.BlockchainConfig.ELECTRUM( ) ) -wallet = bdk.OnlineWallet( +wallet = bdk.Wallet( descriptor=descriptor, change_descriptor=descriptor, network=bdk.Network.TESTNET, @@ -52,15 +38,19 @@ wallet = bdk.OnlineWallet( blockchain_config=client ) +# print new receive address +address = wallet.get_new_address() +print(f"New BIP84 testnet address: {address}") + + +# print wallet balance class LogProgress(bdk.BdkProgress): def update(self, progress, update): pass - + wallet.sync(progress_update=LogProgress(), max_address_param=20) balance = wallet.get_balance() - print(f"Wallet balance is: {balance}") -``` """ rust_ext = RustExtension( @@ -71,7 +61,7 @@ rust_ext = RustExtension( setup( name = 'bdkpython', - version = '0.0.4', + version = '0.1.0', description="The Python language bindings for the bitcoindevkit", long_description=LONG_DESCRIPTION, long_description_content_type='text/markdown',