Skip to main content

This package contains a compiled python version of all osmosis protobuf files with their dependencies

Project description

Osmosis Protobuf

This repository contains the whole osmosis 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 osmosis-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 osmosis_protobuf.cosmos.bank.v1beta1.query_pb2_grpc as query_pb2_grpc
import osmosis_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)

Build yourself

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

  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 (branch: main)
  • Osmosis (this branch)

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

osmosis_protobuf-0.4.0.tar.gz (542.9 kB view details)

Uploaded Source

Built Distribution

osmosis_protobuf-0.4.0-py2.py3-none-any.whl (1.1 MB view details)

Uploaded Python 2 Python 3

File details

Details for the file osmosis_protobuf-0.4.0.tar.gz.

File metadata

  • Download URL: osmosis_protobuf-0.4.0.tar.gz
  • Upload date:
  • Size: 542.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.1

File hashes

Hashes for osmosis_protobuf-0.4.0.tar.gz
Algorithm Hash digest
SHA256 abf73d25c2df6506f671bae2f4d2546db3691c6deb91ba6556006aca32eab5f5
MD5 06108a3a3b9bc4dfad8a9fcd32993c48
BLAKE2b-256 527ed7abf6dc0eb8a361d9996e2d8315abc0690c5212209e3972b6c0e7e00253

See more details on using hashes here.

File details

Details for the file osmosis_protobuf-0.4.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for osmosis_protobuf-0.4.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 791ae0f582e1a419c850bfa9a6f7ad04644ef0386f327c664c1a93d5be37b84c
MD5 aa4eb6196e71bd6a1abe1181fe2aecef
BLAKE2b-256 4c38409b0642faad7a941d05e1b9a5feba71a05bb411bdc6d773d8c9480603f2

See more details on using hashes here.

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