Skip to main content

Cosmos Protobuf

This repository compains the whole cosmos protobuf files compiled for python and ready to use with grpc. Please use the according .proto file as documentation for each python file.

Installation

You can install this package directly from the repository by using:

python -m pip install sentinel-protobuf

Usage

The following code snippet will query the balances for the address osmo15hzhcvgs2ljfng6unghvr5l32prwqdyq4aguxn. The according query.proto file in the bank subdirectory contains the Request and the Response for this request. The details for the response are defined in QueryAllBalancesResponse. It contains the balances and pagination attribute which can be accessed as shown in the example below.

import grpc
import cosmospy_protobuf.cosmos.bank.v1beta1.query_pb2_grpc as query_pb2_grpc
import cosmospy_protobuf.cosmos.bank.v1beta1.query_pb2 as query_pb2

host = "osmosis.strange.love"
port = "9090"

c = grpc.insecure_channel(f'{host}:{port}')
stub = query_pb2_grpc.QueryStub(c)

r = stub.AllBalances(query_pb2.QueryAllBalancesRequest(address="osmo15hzhcvgs2ljfng6unghvr5l32prwqdyq4aguxn"))
print(r.balances)

Sentinel example

The following code snippet will query all the subscription for sentnode123

import grpc
from sentinel_protobuf.sentinel.subscription.v2.subscription_pb2 import NodeSubscription
from sentinel_protobuf.sentinel.subscription.v2.querier_pb2 import QuerySubscriptionsForNodeRequest
from sentinel_protobuf.sentinel.subscription.v2.querier_pb2_grpc import QueryServiceStub

# channel = grpc.secure_channel("host:port", grpc.ssl_channel_credentials())
channel = grpc.insecure_channel("grpc.sentinel.co:9090")
stub = QueryServiceStub(channel)

response = stub.QuerySubscriptionsForNode(QuerySubscriptionsForNodeRequest(address="sentnode123"))
for subscription in response.subscriptions:
    print(NodeSubscription.FromString(subscription.value))

Build yourself

There are two scripts helping you to fork this repository to work with any cosmos based coin.

Addititional Requirements:

  1. grpcio-tools
  2. GitPython
  3. protoletariat

Steps:

  1. Create a config in configs and take a existing one as example
  2. Run the aggregate.py file with your filename without .json (Example python aggregate.py cosmos)
  3. Run the compile.py to compile all your files to protobuf
  4. Build your package. You're done!

Protobuf compilation

The files are compiled using the grpc_tools.protoc command from the grpcio-tools library. To compile a .proto file manually use following command:

python -m grpc_tools.protoc -I <absolute path to project root> --python_out=. --grpc_python_out=. <absolute path to .proto file>

After compiling all the files with protoc you need to fix the imports by using protoletariat

Note:

  • The --grpc_python_out=. is only needed when compiling a query.proto file as these define the actual grpc query
  • To compile the whole project it is favorable to match all proto files by using *.proto instead of each individual file. You can also match the whole folders to compile multiple folders at the same time. Not that the folders might contain sub-folders.

Other Cosmos based coins

Currently following coins are maintained by me:

  • Cosmos (this branch)
  • Evmos (branch: chain/evmos, package name: evmos-protobuf)
  • Osmosis (branch: chain/osmosis, package name: osmosis-protobuf)
  • Stargaze (branch: chain/stargaze, package name: stargaze-protobuf)
  • Sentinel (branch: chain/sentinel, package name sentinel-protobuf)

Metadata

Release files for sentinel-protobuf 0.4.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sentinel-protobuf 0.4.2
File Size Uploaded Provenance Actions
sentinel_protobuf-0.4.2.tar.gz 17.7 MB Without provenance Details for sentinel_protobuf-0.4.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for sentinel-protobuf 0.4.2
File Interpreter ABI Platform Actions
sentinel_protobuf-0.4.2-py2.py3-none-any.whl Python 3, Python 2 none any Details for sentinel_protobuf-0.4.2-py2.py3-none-any.whl

Total release size: 46.5 MB

Release files / sentinel_protobuf-0.4.2.tar.gz

Download URL sentinel_protobuf-0.4.2.tar.gz
Size 17.7 MB
Tags Source
SHA-256 checksum
How to use checksums
5d95db216cb05184d9da11a7e5b411fb83c7c02cf657f19d5f6c0540118db2f0
BLAKE2b-256 checksum
How to use checksums
bd3a583bb03557c91c19ffe8b7db1a4a7128b2948db83909dabc8806d73d5e0a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.10.13

Release files / sentinel_protobuf-0.4.2-py2.py3-none-any.whl

Download URL sentinel_protobuf-0.4.2-py2.py3-none-any.whl
Size 28.8 MB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
61bc8bbf1a21846e0d3480236a5ecb2b58fe29ca5a76f07349ce1c7aa92a579d
BLAKE2b-256 checksum
How to use checksums
d73cdc39f71e2c7dbd8e995c24fcb78ab508dfb7c7eaf48b769120c579b55217
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.10.13

Security for sentinel-protobuf 0.4.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page