Skip to main content
DefichainPython Logo

PyPI Version PyPI Python Version Downloads

Docs Build Tests

Telegram Group Twitter / X Status Page

This library is a community funded project. The objective is to interact with the defichain blockchain as effortlessly as possible. This can be archived by utilizing a variety of methods:

  1. Node / RPC

  2. Ocean

  3. HDWallet

  4. Transactions

Installation

Download the PyPi package:

pip install defichain -U

Clone the GitHub Repository:

git clone https://github.com/eric-volz/DefichainPython.git

Features

1. Node / RPC:

The node implementation empowers you to easily connect to your defichain node without having to deal with everything else. You can execute any function witch is supported by your defichain node.

Make a poolswap via your node:

# Import node object
from defichain import Node

# Specify connection
node =  Node("user", "password", url="127.0.0.1", port=8554)

addressFrom = "df1qn6utdvuaq0yshc4sah6puzf0dnlfkc2c8ryme8"
tokenFrom = "BTC"
amount = 0.1
addressTo = "df1qn6utdvuaq0yshc4sah6puzf0dnlfkc2c8ryme8"
tokenTo = "DFI"
maxprice = 3000

# Execute poolswap
txid = node.poolpair.poolswap(addressFrom, tokenFrom, amount, addressTo, tokenTo, maxprice)

# Print txid
print(txid)

2. Ocean:

Ocean is an API infrastructure, which is operated by Birthday Research. You can use it to retrieve a lot of information about the blockchain and to interact with it.

Ask for the utxo balance of an address:

# Import ocean object
from defichain import Ocean

# Specify connection
ocean =  Ocean(network="mainnet")

# Execute getBalace method
utxo_balance = ocean.address.getBalance("df1qn6utdvuaq0yshc4sah6puzf0dnlfkc2c8ryme8")

# Print the utxo balance of the requested address
print(utxo_balance)

3. HDWallet:

HDWallet (Hierarchical Deterministic Wallet) is a special wallet implementation for defichain. You can use it to derive your private / public keys from your mnemonic seed. This implementation is used in combination with the following feature: Transactions

Create a wallet for mainnet from mnemonic seed:

# Import wallet and network
from defichain import Wallet
from defichain.networks import DefichainMainnet

#  Mnemonic seed
mnemonic = "avocado key fan step egg engage winter upper attitude carry regret mixed utility body party trip valid oppose gas ensure deputy suspect blur trade"

# Create wallet for specified network and insert mnemonic seed
wallet = Wallet(DefichainMainnet)
wallet.from_mnemonic(mnemonic)

# Derive first account from the wallet
account = wallet.get_account(0)

# Print every address type
print(account.get_p2pkh())  # 8KvWa4oCfAhdyUNK8pXJS8XnddsxY6ZY7J
print(account.get_p2sh())  # dUiMDov5Jxg3qKcy9yi6petuUtrvBRezUS
print(account.get_p2wpkh())  # df1qx52ql637w4t7uk2vjdatj3a24cnvuu4fkxryrr

# Print every private key type
print(account.get_privateKey())  # c72f08c17b475d641a711ef1e16bcdb0cc0c1210e6da846060b2e04d5c2299b3
print(account.get_wif())  # L3tu3Bx5n8aWgcDd14btMPgxQ8H5VYbbNoodrNESaonom64YPnr9

4. Transactions:

This transaction implementation enables you to create, sign and broadcast your own transaction just within python. It supports native utxo (send, sendall, …), as well as defi transactions (poolswap, takeloan, …) for mainnet and testnet.

# Import ocean, wallet, network and txbuilder
from defichain import Ocean
from defichain import Wallet
from defichain.networks import DefichainMainnet
from defichain import TxBuilder

# Specify ocean connection
ocean =  Ocean(network="mainnet")

# Create wallet and account
mnemonic = "avocado key fan step egg engage winter upper attitude carry regret mixed utility body party trip valid oppose gas ensure deputy suspect blur trade"

wallet = Wallet(DefichainMainnet)
wallet.from_mnemonic(mnemonic)

account = wallet.get_account(0)

# Create TxBuilder
builder = TxBuilder(account.get_p2wpkh(), account, ocean)

addressFrom = account.get_p2wpkh()
tokenFrom = "BTC"
amount = 0.1
addressTo = account.get_p2wpkh()
tokenTo = "DFI"
maxprice = 3000

# Build poolswap transaction
tx = builder.pool.poolswap(addressFrom, tokenFrom, amount, addressTo, tokenTo, maxprice)

# Send transaction into the blockchain
txid = builder.send_tx(tx)

# Print txid
print(txid)

Community

This project is funded by the Defichain Community:

Thank you for your trust!

Because of that the community has the right to know about the progress and status of the project. You can view the status of each module yourself on the status page!

All official updates and CFPs are listed on this page!

If you have suggestions for improvement or other ideas, open an issue, write me on Twitter / X, leave a comment in the telegram group or write me oldschool via email (defichainpython@volz.link)!

License & Disclaimer

By using (this repo), you (the user) agree to be bound by the terms of this license (MIT License).

Metadata

Release files for defichain 3.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for defichain 3.1.3
File Size Uploaded
defichain-3.1.3.tar.gz 222.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for defichain 3.1.3
File Interpreter ABI Platform
defichain-3.1.3-py3-none-any.whl Python 3 none any Details

Total release size: 500.9 kB

Release files / defichain-3.1.3.tar.gz

Download URL defichain-3.1.3.tar.gz
Size 222.9 kB
Tags Source
SHA-256 checksum
How to use checksums
c44c16191786a18d5e6f436552e1c6bce7f7ea8ead75027ae69458a18c7b49f3
BLAKE2b-256 checksum
How to use checksums
f1ea912b6ffd39702b4f8bc7386461f5d986f69123e5142e3e8396340bc6803c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.7

Release files / defichain-3.1.3-py3-none-any.whl

Download URL defichain-3.1.3-py3-none-any.whl
Size 278.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
bce5e65e096ef6d73f2d9fd9c163f3e68a5f54cab549fba2c8b6e37e2617684f
BLAKE2b-256 checksum
How to use checksums
8f1c62523c45af3bf66face8bba19d534807e3cf43164d45d36f0e29104acff1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.7
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page