Hive Developer logo

Hive Developer Portal

PY: Power Up Hive

How to power up your HIVE to HIVE POWER using Python.

Full, runnable src of Power Up Hive can be downloaded as part of: tutorials/python.

In this tutorial we show you how to check the HIVE balance of an account on the Hive blockchain and how to power up your HIVE into HIVE POWER using the commit class found within the steem-python library.

Intro

The Hive python library has a built-in function to transmit transactions to the blockchain. We are using the transfer_to_vesting method found within the commit class in the library. When you power up you convert your HIVE into HIVE POWER to increase your influence on Hive. Before we do the conversion, we use the get_account function to check the current HIVE balance of the account to see what is available to power up. This is not strictly necessary but adds to the useability of the process. The transfer_to_vesting method has 3 parameters:

  1. amount - The amount of HIVE to power up. This must be of the float data type
  2. to - The account to where the HIVE will be powered up
  3. account - The source user account for the transfer

Steps

  1. App setup - Library install and import. Connection to testnet
  2. User information and steem node - Input user information and connection to Hive node
  3. Check balance - Check current vesting balance of user account
  4. Conversion amount - Input power up amount and check valid transfer
  5. Commit to blockchain - Commit transaction to blockchain

1. App setup

In this tutorial we use 2 packages:

We import the libraries and connect to the testnet.

import steembase
import steem
from steem.amount import Amount
from pick import pick

steembase.chains.known_chains['HIVE'] = {
    'chain_id': '79276aea5d4877d9a25892eaa01b0adf019d3e5cb12a97478df3298ccdd01673',
    'prefix': 'STX', 'hive_symbol': 'HIVE', 'hbd_symbol': 'HBD', 'vests_symbol': 'VESTS'
}

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

2. User information and steem 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 are using a testnet. The values are supplied via the terminal/console before we initialise the steem class. There are some demo accounts available but we encourage you to create your own accounts on this testnet and create balances you can claim; it’s good practice.

#capture user information
username = input('Enter username: ') #demo account: cdemo
wif = input('Enter private ACTIVE key: ') #demo account: 5KaNM84WWSqzwKzY82fXPaUW43idbLnPqf5SfjGxLfw6eV2kAP3

#connect node and private active key
client = steem.Hive(nodes=['https://testnet.steem.vc'], keys=[wif])

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 get_account function.

#check valid user and get account balance
userinfo = client.get_account(username)
if(userinfo is None) :
    print('Oops. Looks like user ' + username + ' doesn\'t exist on this chain!')
    exit()
balance = userinfo['balance']

print('Available HIVE balance: ' + balance + '\n')

input('Press any key to continue')

The results of the query are displayed in the console/terminal.

4. Conversion amount

Both the amount and the to parameters are assigned via input from the terminal/console. The user is given the option to power up the HIVE to their own account or to another user’s account. The amount has to be greater than zero and no more than the total available HIVE of the user. If you are using one of Hive’s demo accounts, please leave some HIVE for others to power up! We also check the to account to make sure it’s a valid account name.

#choice of account
title = 'Please choose an option for an account to transfer to: '
options = ['SELF', 'OTHER']
option, index = pick(options, title)

if (option == 'OTHER') :
    #account to power up to
    to_account = input('Please enter the ACCOUNT to where the HIVE will be transferred: ')
    #check valid username
    result = client.get_account(to_account)
    if (not result) :
        print(to_account + ' doesn\'t exist on this chain!')
        exit()
else :
    print('\n' + 'Power up HIVE to own account' + '\n')
    to_account = username

#amount to power up
amount = float(input('Please enter the amount of HIVE to power up: '))

5. Commit to blockchain

Now that all the parameters have been assigned we can continue with the actual transmission to the blockchain. The output and commit is based on the validity of the amount that has been input.

#parameters: amount, to, account
if (amount == 0) :
    print('\n' + 'No HIVE entered for powering up')
    exit()
else :
    if (amount > Amount(balance).amount) :
        print('\n' + 'Insufficient funds available')
        exit()
    else :
        client.transfer_to_vesting(amount, to_account, username)
        print('\n' + str(amount) + ' HIVE has been powered up successfully')

The result of the power up transfer is displayed on the console/terminal.

As an added check we also display the new HIVE balance of the user on the terminal/console

#get new account balance
userinfo = client.get_account(username)
balance = userinfo['balance']
print('New HIVE balance: ' + balance)

We encourage users to play around with different values and data types to fully understand how this process works. You can also check the balances and transaction history on the testnet portal.

To Run the tutorial

  1. review dev requirements
  2. git clone https://gitlab.syncad.com/hive/devportal.git
  3. cd devportal/tutorials/python/24_power_up_hive
  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.