Hive Developer Portal
PY: Transfer HIVE And HBD
How to transfer HIVE and HBD to another account using Python.
Full, runnable src of Transfer HIVE And HBD can be downloaded as part of: tutorials/python (or download just this tutorial: devportal-master-tutorials-python-21_transfer_hive_and_hbd.zip).
In this tutorial we will explain and show you how to to check the HIVE and HBD balance of an account and also how to transfer a portion of that to another user on the Hive blockchain using the beem library.
The beem library has a built-in function to transmit transactions to the blockchain. We are using the
transfer method found within the account instance. Before we do the transfer, we check the current balance of the account to ensure that there are sufficient funds available. We also check if the intended recipient of the transfer is a valid user account. 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 lookup function to check for this. We are using the following
- to - The intended recipient of the funds transfer
- amount - The amount of HIVE or HBD that the user wants to transfer. This parameter has to be of the
floatdata type and is rounded up to 3 decimal spaces
- asset - A string value specifying whether
HBDis being transferred
- memo - An optional text field containing comments on the transfer. This value may begin with ‘#’ for encrypted messaging
- App setup - Library install and import. Connection to testnet
- User information and hive node - Input user information and connection to Hive node
- Check balance - Check current HIVE and HBD balance of user account
- Recipient input - Check for valid recipient account name
- Transfer type and amount - Input of transfer type and the amount to transfer
- Transfer - Broadcast the transfer to blockchain
1. App setup
In this tutorial we use 2 packages:
beem- hive library and interaction with Blockchain
pick- helps select the query type interactively
We import the libraries and connect to the
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 transfer to be broadcasted 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('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 transfer we check the current balance of the account using account lookup.
# get account balance for HIVE and HBD account = Account(account, blockchain_instance=client) total_base = account['balance'] total_debt = account['hbd_balance'] base_symbol = total_base.symbol debt_symbol = total_debt.symbol print('CURRENT ACCOUNT BALANCE:' + '\n' + str(total_base) + '\n' + str(total_debt) + '\n')
The result of the query is displayed in the console/terminal.
4. Recipient input
The recipient account is input via the console/terminal and then a check is done whether that username does in fact exist.
# get recipient name recipient = input('Enter the user you wish to transfer funds to: ') # check for valid recipient name recipient = Account(recipient, blockchain_instance=client)
The query will return a null value if the account does not match to anything on the blockchain. This result is then used to determine the next step.
5. Transfer type and amount
If the query in the previous step returns a valid result the user is then given a choice of transfer types or to cancel the operation completely. If the username is not found the process aborts.
if recipient: # choice of transfer title = 'Please choose transfer type: ' options = [base_symbol, debt_symbol, 'Cancel Transfer'] # get index and selected transfer type option, index = pick(options, title) else: print('Invalid recipient for funds transfer') exit()
Once the user chooses the type of transfer we proceed to assign the amount as well as the
if option == 'Cancel Transfer': print('Transaction cancelled') exit() if option == base_symbol: # get HIVE transfer amount amount = input('Enter amount of ' + base_symbol + ' to transfer to ' + recipient.name + ': ') amount = float(amount) symbol = base_symbol else: # get HBD transfer amount amount = input('Enter amount of ' + debt_symbol + ' to transfer to ' + recipient.name + ': ') amount = float(amount) symbol = debt_symbol
Once all the parameters have been assigned we can proceed with the actual broadcast to the blockchain.
account.transfer(recipient.name, amount, symbol) print('\n' + str(amount) + ' ' + symbol + ' has been transferred to ' + recipient.name)
memo parameter can be left empty as in the above example. 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 transfer has been completed correctly.
# get remaining account balance for HIVE and HBD account = Account(account.name, blockchain_instance=client) total_base = account['balance'] total_debt = account['hbd_balance'] print('\n' + 'REMAINING ACCOUNT BALANCE:' + '\n' + str(total_base) + '\n' + str(total_debt) + '\n')
Click the play button below:
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
- review dev requirements
git clone https://gitlab.syncad.com/hive/devportal.git
pip install -r requirements.txt
- After a few moments, you should see a prompt for input in terminal screen.