Skip to main content

Hedera HCS gRPC API Python Client

Project description

pip install hcs-grpc-client

This is a Hedera Consensus Service (HCS) gRPC mirror node API Python client.

It only has functionality to subscribe to a HCS topic on mirror node.

For mirror node REST API, use curl or something like Python requests.

For all other interactions with Hedera, use an SDK: Python, Java, Javascript, or Go.

How to Use

import grpc
from hcs_grpc_client import TopicID, ConsensusTopic, ConsensusServiceStub
request = ConsensusTopicQuery(topicID=TopicID(2010293))
channel = grpc.insecure_channel("hcs.testnet.mirrornode.hedera.com:5600")
stub = ConsensusServiceStub(channel)
stream = stub.subscribeTopic(request)
for resp in stream:
    # do whatever you need
    print(resp)

Make sure the topic exists or create your own topic with an SDK. An example is given in examples/.

See examples for mainnet example and other usages.

How to Build

(Ignore this section unless you want to customized the client and/or want to contribute to this project)

Clone this repo:

git clone --recurse-submodules https://github.com/wensheng/hcs-grpc-api-py-client.git

Setup virtual env for python then install dependencies:

cd hcs-grpc-api-py-client
python3 -m venv venv
./venv/bin/python install -r requirements.txt

Generate code (compile .proto to .py):

./compile.sh
./compile_deps.sh

Build package:

rm -fr build dist
./venv/bin/python -m build

Test package:

./venv/bin/pip uninstall hcs-grpc-client
./venv/bin/pip install dist/hcs-grpc-client-(current_version)-py3-none-any.whl

Upload to Pypi (don't do this unless you're me):

python -m twine upload dist/*

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hcs-grpc-client-0.15.0.post1.tar.gz (20.2 kB view hashes)

Uploaded Source

Built Distribution

hcs_grpc_client-0.15.0.post1-py3-none-any.whl (22.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page