django-bitcoin is a Django web framework application for building Bitcoin web apps.
- Simple Bitcoin wallet management
- Bitcoin address input field
- Bitcoin payment processing
- Bitcoin market information
To install, just add the app to your settings.py INSTALLED_APPS like:
INSTALLED_APPS = [
...
'django_bitcoin',
...
]Also you have to run a local bitcoind instance, and specify connection string in settings:
BITCOIND_CONNECTION_STRING = "http://bitcoinuser:password@localhost:8332"Currently the project is tested onlin on MySQL InnoDB engine using https://pypi.python.org/pypi/DistributedLock to make transactions atomic.
Configure your Django database using InnoDB:
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.mysql', # Add 'postgresql_psycopg2', 'mysql', 'sqlite3' or 'oracle'.
'NAME': 'xxx', # Or path to database file if using sqlite3.
'USER': 'xxx', # Not used with sqlite3.
'PASSWORD': 'xxx', # Not used with sqlite3.
'HOST': '', # Set to empty string for localhost. Not used with sqlite3.
'PORT': '', # Set to empty string for default. Not used with sqlite3.
'OPTIONS': {
"init_command": "SET storage_engine=INNODB",
}
}
}There is a small tutorial about how to use django-bitcoin to create your own instawallet.
You can use the Wallet class to do different bitcoin-moving applications. Typical example would be a marketplace-style site, where there are multiple sellers and buyer. Or job freelance site, where escrow is needed. Or even an exchange could be done with this abstraction (a little extra classes would be needed however).
Note that while you move bitcoins between Wallet-objects, only bitcoin transactions needed are incoming and outgoing transactions. Transactions between the system "Wallet"-objects don't generate "real" bitcoin transactions. Every transaction (except incoming transactions) is logged to WalletTransaction object to ease accounting.
This also means that outgoing bitcoin transactions are "mixed":
from django_bitcoin import Wallet, currency
class Profile(models.Model):
wallet = ForeignKey(Wallet)
outgoing_bitcoin_address = CharField()
class Escrow(models.Model):
wallet = ForeignKey(Wallet)
buyer_happy = BooleanField(default=False)
def master_wallet():
""" Create one singleton master wallet. """
mw, created = Wallet.objects.get_or_create(label="system_master_wallet")
return mw
buyer=Profile.objects.create()
seller=Profile.objects.create()
purchase=Escrow.objects.create()
AMOUNT_USD="9.99"
m=currency.Money(AMOUNT_USD, "USD")
btc_amount=currency.exchange(m, "BTC")
print "Send "+str(btc_amount)+" BTC to address "+buyer.wallet.receiving_address()
sleep(5000) # wait for transaction
if p1.wallet.total_balance()>=btc_amount:
p1.send_to_wallet(purchase, btc_amount)
sleep(1000) # wait for product/service delivery
if purchase.buyer_happy:
purchase.wallet.send_to_wallet(seller.wallet)
seller.wallet.send_to_address(seller.outgoing_bitcoin_address, seller.wallet.total_balance())
else:
print "WHY U NO HAPPY"
#return bitcoins to buyer, 50/50 split or somethingTo display transaction history and simple wallet tagline in your views, use the following templatetags:
{% load currency_conversions %}
<!-- display balance tagline, estimate in USD and received/sent -->
{% wallet_tagline profile.bitcoin_wallet %}
<!-- display list of transactions as a table -->
{% wallet_history profile.bitcoin_wallet %}Easy way to convert currencies from each other: btc2usd, usd2btc, eur2btc, btc2eur
Also currency2btc, btc2currency for any currencies on bitcoincharts.com:
{% load currency_conversions %}
Hi, for the pizza: send me {{bitcoin_amount}}BTC (about {{ bitcoin_amount|btc2usd }}USD).Display QR code of the bitcoin payment using google charts API:
{% load currency_conversions %}
Pay the following payment with your android bitcoin wallet:
{% bitcoin_payment_qr wallet.receiving_address bitcoin_amount %}.
The same but display also description and an estimate in EUR:
{% bitcoin_payment_qr wallet.receiving_address bitcoin_amount "One beer" "EUR" %}.To enable bitcoin transaction notifications, set the following flag in your settings.py:
BITCOIN_TRANSACTION_SIGNALING = TrueAfter that, you need to setup a cron job to run each minute, something like the following:
* * * * * (cd $APP_PATH && python manage.py python manage.py CheckTransactions >> $APP_PATH/logs/email_sends.log 2>&1)After that you can define your balance_changed and balance_changed_confirmed signals:
from django_bitcoin.models import balance_changed, balance_changed_confirmed
from django.dispatch import receiver
@receiver(balance_changed)
def balance_changed_handler(sender, **kwargs):
pass
# try:
# print "balance changed", sender.id, kwargs["changed"], sender.total_balance()
@receiver(balance_changed_confirmed)
def balance_changed_confirmed_handler(sender, **kwargs):
passWhat happens here
CheckTransactionsgoes through everyBitcoinAddressin the your database- It asks 50 latest transactions for each address from bitcoind
- If there are any unprocessed transactions in the bitcoind for these addresses, not marked in your database yet,
CheckTransactionscreatesDepositTransactionsto this wallet and updates the balance
If you have transaction backlog more than 50 transactions per address, you need to use CheckOldTransactions management command to go through every transaction for your available bitcoin addresses.
There is a Django form field django_bitcoin.BCAddressField.BCAddressField which performs a bitcoin address validation.
You can store the input on your models in models.CharField().
For debugging purposes you probably don't want to play with real money. Thus, you can simulate incoming bitcoin transactions as following:
wallet = master_wallet()
wallet.send()Currently django-bitcoin is used at production in
More to come!
If you have a site using django-bitcoin, drop me an email and I will link to it here.