python SDK for AERGO
Project description
herapy
HeraPy is a Python package for AERGO that provides the features below.
Features
Communication with AERGO node
Getting AERGO blockchain information
Creating/Exporting/Importing an account
Making and sending a transaction
Deploying/Calling/Querying a smart contract
Querying and prooving contract/account states
Install
Install the latest version in the Python Package Index
pip install aergo-herapy
or, install locally
git clone git@github.com:aergoio/herapy.git
cd herapy
make install
Run examples
After installing aergo-herapy, you can run examples
make ex
The examples in the ‘examples’ directory connect the public Aergo testnet.
Build
Downloading HeraPy
Download HeraPy from this repository
git clone git@github.com:aergoio/herapy.git
Installing Dependencies
pip install -r requirements.txt
But, we recommend to use a virtual environment below.
Virtual Environment (Pipenv)
Using Pipenv, all dependencies will be installed automatically.
pipenv shell
If you cleaned up and setup again,
pipenv install
If you want to test or contribute, then do not forget ‘–dev’ option
pipenv install --dev
make test
Updating Protocol
If need to upgrade a protocol,
make protoc
After this command, all protocol related source files will be generated if it’s different.
Updating Aergo Configurations
If need to upgrade Aergo Configurations,
make aergo-types
After this command, ‘aergo/herapy/obj/aergo_conf.py’ will be generated if it’s different.
If occur the error message below
ERROR: Cannot find 'AERGO_TYPES_SRC'
, find the source code ‘aergo/config/types.go’ and make this file path as an environment variable of ‘AERGO_TYPES_SRC’
export AERGO_TYPES_SRC=`find ~ -path '*/aergo/config/types.go' 2>/dev/null`
make aergo-types
Releases and Contributing
HeraPy follows a major release cycle of AERGO. A minor release such as fixing bugs and errors are occasionally patched. Please let us know if you encounter a bug by filling an issue.
If you are planning to contribute a new feature, class, or function, please open an issue and discuss with us.
We appreciate all contributions.
Documentation
License
HeraPy is MIT license as found in the LICENSE file.
Credits
This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.
History
1.2.3 (2019-08-22)
support redploy tx type
support ‘GetConfChangeProgress’ protocol to find a state of ‘changeCluster’ system contract
support ‘name’ (string) address
support enterprise consensus info
Bug fix * miss match a tx type in tx
0.12.2 (2019-03-21)
encrypt/decrypt logic moves to ‘util’ for a general usage
Bug fix * when tx result handling, get error message from a changed varialbe
0.12.0 (2019-03-08)
Apply v0.12.0 protocol
Bug fix * get a genesis block with a block height 0
0.11.0 (2019-02-20)
Change the result type from the ‘get_tx_result’ function (‘SmartContractStatus’ –> ‘TxResultStatus’)
Separate two function ‘send_tx’ and ‘batch_tx’ from the single ‘send_tx’ function for a single and multiple txs
Open the ‘generate_tx’ function for helping a new transaction manually
Support multiple proof queries with the array of Storage Keys
Simplify verifying proof as the ‘verify_proof’ function from ‘verify_inclusion’ and ‘verify_exclusion’
0.9.0 (2018-12-31)
Fit for the public Aergo testnet.
First public release on PyPI.
0.1.0 (2018-11-07)
First release on PyPI.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for aergo_herapy-1.2.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1898d106b90643977a76d4f7d7d372c391d953f1fd275e49aeaf43695ce0e982 |
|
MD5 | 868b3a9e94e001147cf283ac39a4afe5 |
|
BLAKE2b-256 | 9c944acb0e1b1207a719011f0560fdcb4731e6f9aca217069160cb96e9b78f70 |