Skip to main content

The Python SDK for supported Cosmos SDK chains.

Project description

Python SDK for the Cosmos Ecosystem

(Unfamiliar with Cosmos? Check out the Cosmos Network Docs)

This (SDK) in Python is a simple library toolkit for building software that can interact with the supported Cosmos blockchains and provides simple abstractions over core data structures, serialization, key management, and API request generation.

Note - This is currently a W.I.P.

Features

  • This SDK follows a module specific approach, and new Cosmos Modules will be added to the SDK on a priority basis.
  • Written in Python with extensive support libraries
  • Versatile support for key management solutions

❗ This SDK currently does not support Terra Classic. If you want to communicate with Terra Classic, use terra-sdk==2.x


Requirements

Cosmos.py SDK requires Python v3.7+.

Installation

NOTE: All code starting with a $ is meant to run on your terminal (a bash prompt). All code starting with a >>> is meant to run in a python interpreter, like ipython.

Cosmos SDK can be installed (preferably in a virtual environment from PyPI using pip) as follows:

$ pip install -U cosmos_SDK

You might have pip3 installed instead of pip; proceed according to your own setup.

Usage Examples

from cosmos_sdk.client.lcd import LCDClient
from cosmos_sdk.key.mnemonic import MnemonicKey

mnemonic = <MNEMONIC_PHRASE>

# Terra client
terra_client = LCDClient(chain_id="phoenix-1", url="https://phoenix-lcd.terra.dev")
mk = MnemonicKey(mnemonic,"terra")
terra_wallet = terra_client.wallet(mk)

# Persistence client
persistence_client = LCDClient(chain_id="core-1", url="http://rest.core.persistence.one")
mk = MnemonicKey(mnemonic,"persistence")
persistence_wallet = persistence_client.wallet(mk)

Dependencies

Cosmos SDK uses Poetry to manage dependencies. To get set up with all the required dependencies, run:

$ pip install poetry
$ poetry install

If you encounter "version solving failed." error, try poetry add <package_name>, followed by poetry lock and then poetry install


Contributing

Community contribution, whether it's a new feature, correction, bug report, additional documentation, or any other feedback is always welcome. Please read through this section to ensure that your contribution is in the most suitable format for us to effectively process.


License

This reporitory was forked from Terra SDK and is being repurposed from there on.

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

cosmos-sdk-0.0.3.tar.gz (82.9 kB view hashes)

Uploaded Source

Built Distribution

cosmos_sdk-0.0.3-py3-none-any.whl (125.5 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