frost/bdk-ffi
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix long description examples after API change

Browse Source
This commit is contained in:
thunderbiscuit 2022-02-16 21:31:39 -05:00
parent a6943af686
commit 7982a73aa7
No known key found for this signature in database
GPG Key ID: 88253696EB836462
1 changed files with 10 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
setup.py
View File

@ -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',