Hive Developers logo

Hive Developer Portal

Convert HIVE To HBD

How to convert HIVE to HBD for a specified account.

Full, runnable src of Convert HIVE to HBD can be downloaded as part of: tutorials/python (or download just this tutorial: devportal-master-tutorials-python-37_convert_hive_to_hbd.zip).

In this tutorial we will explain and show you how to convert some or all of your available HIVE balance into HBD on the Hive blockchain using the commit class found within the beem library.

It should be noted that unlike the opposite conversion, the converted HBD will be available instantly, but the collateral takes 3.5 days for the transaction to be processed. It is also not possible to stop a conversion once initialized. During the 3.5 days for it to be converted and as the conversion price fluctuates you could actually be receiving less released HIVE collateral. Because of this, the method in this tutorial is NOT the preferred and often NOT the most efficient way of converting HIVE to HBD. This tutorial just illustrates that it can be done in this manner.

Note: This is not a market process and will often result in unfavorable outcomes, if used bindly.

There is an internal market on Hive that allows you to sell your HIVE. You should use the internal market for routine trades between HIVE and HBD. With the market process you can get your HBD (sometimes immediately) and at the exact price that you expect. The market place is almost always the better way to exchange your HIVE. This article provides more information on using the market to exchange your HIVE for HBD.

The purpose of this process is for experts to help maintain the target price of HIVE, not to provide convenience to the end-user.

Intro

The Hive python library has built-in functionality to transmit transactions to the blockchain. We are using the collateralized_convert method found within the Account instance. Before we do the conversion, we check the current balance of the account to check how much HIVE is available. This is not strictly necessary as the process will automatically abort with the corresponding error, but it does give some insight into the process as a whole. We use the Account module to check for this. The collateralized_convert method has 2 parameters:

  1. amount - The amount of HIVE that will be converted
  2. request-id - An identifier for tracking the conversion. This parameter is optional

Also see:

Steps

  1. App setup - Library install and import. Connection to testnet
  2. User information and Hive node - Input user information and connection to Hive node
  3. Check balance - Check current HBD and HIVE balance of user account
  4. Conversion amount and commit - Input of HIVE amount to convert and commit to blockchain

1. App setup

In this tutorial we only use 1 package:

from pick import pick
import getpass
from beem import Hive
from beem.account import Account

Because this tutorial alters the blockchain we connect to the testnet so we don’t create spam on the production server.

2. User information and Hive node

We require the private active key of the user in order for the conversion to be committed to the blockchain. This is why we have to specify this alongside the testnet node. The values are supplied via the terminal/console before we initialize the beem class.

# capture user information
account = input('Enter username: ')
wif_active_key = getpass.getpass('Enter private ACTIVE key: ')

# node_url = 'https://testnet.openhive.network' # Public Testnet
node_url = 'http://127.0.0.1:8090' # Local Testnet

# connect node and private active key
client = Hive(node_url, keys=[wif_active_key])

3. Check balance

In order to give the user enough information to make the conversion we check the current balance of the account using the Account module.

# get account balance for HIVE and HBD
account = Account(account, blockchain_instance=client)
total_hbd = account['hbd_balance']
total_hive = account['balance']

print('CURRENT ACCOUNT BALANCE:' + '\n' + str(total_hbd) + '\n' + str(total_hive) + '\n')

The result of the query is displayed in the console/terminal.

4. Conversion amount and commit

The final step before we can commit the transaction to the blockchain is to assign the amount parameter. We do this via a simple input from the terminal/console.

# get recipient name
convert_amount = float(input('Enter the amount of HIVE to convert to HBD: ') or '0')

if (convert_amount <= 0):
  print("Must be greater than zero.")
  exit()

This value must be greater than zero in order for the transaction to execute without any errors. Now that we have all the parameters we can do the actual transmission of the transaction to the blockchain.

# parameters: amount, request_id
account.collateralized_convert(convert_amount)

print('\n' + format(convert_amount, '.3f') + ' HIVE has been converted to HBD')

If no errors are encountered a simple confirmation is printed on the UI.

As an added confirmation we check the balance of the user again and display it on the UI. This is not required at all but it serves as a more definitive confirmation that the conversion has been started correctly.

# get remaining account balance for HBD and HIVE
account.refresh()
total_hbd = account['hbd_balance']
total_hive = account['balance']

print('\n' + 'REMAINING ACCOUNT BALANCE:' + '\n' + str(total_hbd) + '\n' + str(total_hive))

The HIVE balance will not yet have been fully updated as it takes 3.5 days for the collateral to settle. The HBD will however show the new balance.

Final code:

from pick import pick
import getpass
from beem import Hive
from beem.account import Account

# capture user information
account = input('Enter username: ')
wif_active_key = getpass.getpass('Enter private ACTIVE key: ')

# node_url = 'https://testnet.openhive.network' # Public Testnet
node_url = 'http://127.0.0.1:8090' # Local Testnet

# connect node and private active key
client = Hive(node_url, keys=[wif_active_key])

# get account balance for HIVE and HBD
account = Account(account, blockchain_instance=client)
total_hbd = account['hbd_balance']
total_hive = account['balance']

print('CURRENT ACCOUNT BALANCE:' + '\n' + str(total_hbd) + '\n' + str(total_hive) + '\n')

# get recipient name
convert_amount = float(input('Enter the amount of HIVE to convert to HBD: ') or '0')

if (convert_amount <= 0):
  print("Must be greater than zero.")
  exit()

# parameters: amount, request_id
account.collateralized_convert(convert_amount)

print('\n' + format(convert_amount, '.3f') + ' HIVE has been converted to HBD')

# get remaining account balance for HBD and HIVE
account.refresh()
total_hbd = account['hbd_balance']
total_hive = account['balance']

print('\n' + 'REMAINING ACCOUNT BALANCE:' + '\n' + str(total_hbd) + '\n' + str(total_hive))

To Run the tutorial

You can launch a local testnet, with port 8090 mapped locally to the docker container:

docker run -d -p 8090:8090 inertia/tintoy:latest

For details on running a local testnet, see: Setting Up a Testnet

  1. review dev requirements
  2. git clone https://gitlab.syncad.com/hive/devportal.git
  3. cd devportal/tutorials/python/37_convert_hive_to_hbd
  4. pip install -r requirements.txt
  5. python index.py
  6. After a few moments, you should see a prompt for input in terminal screen.
Back to top