version 2.0.6

LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2021, Terraform Labs PTE. LTD
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

Makefile

@@ -0,0 +1,76 @@
+.PHONY: clean clean-test clean-pyc clean-build format test help docs
+.DEFAULT_GOAL := help
+
+define BROWSER_PYSCRIPT
+import os, webbrowser, sys
+
+from urllib.request import pathname2url
+
+webbrowser.open("file://" + pathname2url(os.path.abspath(sys.argv[1])))
+endef
+export BROWSER_PYSCRIPT
+
+define PRINT_HELP_PYSCRIPT
+import re, sys
+
+for line in sys.stdin:
+	match = re.match(r'^([a-zA-Z_-]+):.*?## (.*)$$', line)
+	if match:
+		target, help = match.groups()
+		print("%-20s %s" % (target, help))
+endef
+export PRINT_HELP_PYSCRIPT
+
+BROWSER := poetry run python -c "$$BROWSER_PYSCRIPT"
+
+help: 
+	@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
+
+coverage: ## check code coverage
+	poetry run coverage run --source terra_sdk -m pytest
+	poetry run coverage report -m
+	poetry run coverage html
+	# $(BROWSER) htmlcov/index.html
+
+clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts
+
+clean-build: ## remove build artifacts
+	rm -fr build/
+	rm -fr dist/
+	rm -fr .eggs/
+	find . -name '*.egg-info' -exec rm -fr {} +
+	find . -name '*.egg' -exec rm -f {} +
+
+clean-pyc: ## remove Python file artifacts
+	find . -name '*.pyc' -exec rm -f {} +
+	find . -name '*.pyo' -exec rm -f {} +
+	find . -name '*~' -exec rm -f {} +
+	find . -name '__pycache__' -exec rm -fr {} +
+
+clean-test: ## remove test and coverage artifacts
+	rm -fr .tox/
+	rm -f .coverage
+	rm -fr htmlcov/
+	rm -fr .pytest_cache
+
+test: ## runs tests
+	poetry run pytest --cov=terra_sdk
+
+qa: ## runs static analysis with mypy and flake8
+	poetry run flake8 terra_sdk
+	poetry run mypy -p terra_sdk
+
+format: ## runs code style and formatter
+	poetry run isort .
+	poetry run black .
+
+docs: ## build the documentation
+	poetry run sphinx-build docs/ docs/_build/html
+	# $(BROWSER) docs/_build/html/index.html
+
+dev-docs:
+	poetry run sphinx-autobuild docs/ docs/_build/html
+
+release: clean qa test format ## build dist version and release to pypi
+	poetry build
+	poetry publish

README.md

@@ -0,0 +1,274 @@
+<br/>
+<br/>
+
+<div  align="center"> <p > <img src="https://raw.githubusercontent.com/terra-money/terra-sdk-python/main/docs/img/logo.png" width=500 alt="py-sdk-logo"></p>
+
+The Python SDK for Terra
+<br/>
+
+<p><sub>(Unfamiliar with Terra?  <a href="https://docs.terra.money/">Check out the Terra Docs</a>)</sub></p>
+
+  <p > <img alt="GitHub" src="https://img.shields.io/github/license/terra-money/terra-sdk-python">
+<img alt="Python" src="https://img.shields.io/pypi/pyversions/terra-sdk">
+  <img alt="pip" src="https://img.shields.io/pypi/v/terra-sdk"></p>
+<p>
+  <a href="https://terra-money.github.io/terra.py/index.html"><strong>Explore the Docs »</strong></a>
+<br/>
+  <a href="https://pypi.org/project/terra-sdk/">PyPI Package</a>
+  ·
+  <a href="https://github.com/terra-money/terra.py">GitHub Repository</a>
+</p></div>
+
+The Terra Software Development Kit (SDK) in Python is a simple library toolkit for building software that can interact with the Terra blockchain and provides simple abstractions over core data structures, serialization, key management, and API request generation.
+
+## Features
+
+- Written in Python with extensive support libraries
+- Versatile support for key management solutions
+- Exposes the Terra API through LCDClient
+
+<br/>
+
+# Table of Contents
+
+- [API Reference](#api-reference)
+- [Getting Started](#getting-started)
+  - [Requirements](#requirements)
+  - [Installation](#installation)
+  - [Dependencies](#dependencies)
+  - [Tests](#tests)
+  - [Code Quality](#code-quality)
+- [Usage Examples](#usage-examples)
+  - [Getting Blockchain Information](#getting-blockchain-information)
+    - [Async Usage](#async-usage)
+  - [Building and Signing Transactions](#building-and-signing-transactions)
+    - [Example Using a Wallet](#example-using-a-wallet-recommended)
+- [Contributing](#contributing)
+  - [Reporting an Issue](#reporting-an-issue)
+  - [Requesting a Feature](#requesting-a-feature)
+  - [Contributing Code](#contributing-code)
+  - [Documentation Contributions](#documentation-contributions)
+- [License](#license)
+
+<br/>
+
+# API Reference
+
+An intricate reference to the APIs on the Terra SDK can be found <a href="https://terra-money.github.io/terra.py/index.html">here</a>.
+
+<br/>
+
+# Getting Started
+
+A walk-through of the steps to get started with the Terra SDK alongside a few use case examples are provided below. Alternatively, a tutorial video is also available <a href="https://www.youtube.com/watch?v=GfasBlJHKIg">here</a> as reference.
+
+## Requirements
+
+Terra SDK requires <a href="https://www.python.org/downloads/">Python v3.7+</a>.
+
+## Installation
+
+<sub>**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 <a href="https://pypi.org/project/ipython/">ipython</a>._</sub>
+
+Terra SDK can be installed (preferably in a `virtual environment` from PyPI using `pip`) as follows:
+
+```
+$ pip install -U terra_sdk
+```
+
+<sub>_You might have `pip3` installed instead of `pip`; proceed according to your own setup._<sub>
+
+## Dependencies
+
+Terra SDK uses <a href="https://python-poetry.org/">Poetry</a> to manage dependencies. To get set up with all the required dependencies, run:
+
+```
+$ pip install poetry
+$ poetry install
+```
+
+## Tests
+
+Terra SDK provides extensive tests for data classes and functions. To run them, after the steps in [Dependencies](#dependencies):
+
+```
+$ make test
+```
+
+## Code Quality
+
+Terra SDK uses <a href="https://black.readthedocs.io/en/stable/">Black</a>, <a href="https://isort.readthedocs.io/en/latest/">isort</a>, and <a href="https://mypy.readthedocs.io/en/stable/index.html">Mypy</a> for checking code quality and maintaining style. To reformat, after the steps in [Dependencies](#dependencies):
+
+```
+$ make qa && make format
+```
+
+<br/>
+
+# Usage Examples
+
+Terra SDK can help you read block data, sign and send transactions, deploy and interact with contracts, and many more.
+The following examples are provided to help you get started. Use cases and functionalities of the Terra SDK are not limited to the following examples and can be found in full <a href="https://terra-money.github.io/terra.py/index.html">here</a>.
+
+In order to interact with the Terra blockchain, you'll need a connection to a Terra node. This can be done through setting up an LCDClient (The LCDClient is an object representing an HTTP connection to a Terra LCD node.):
+
+```
+>>> from terra_sdk.client.lcd import LCDClient
+>>> terra = LCDClient(chain_id="columbus-5", url="https://lcd.terra.dev")
+```
+
+## Getting Blockchain Information
+
+Once properly configured, the `LCDClient` instance will allow you to interact with the Terra blockchain. Try getting the latest block height:
+
+```
+>>> terra.tendermint.block_info()['block']['header']['height']
+```
+
+`'1687543'`
+
+### Async Usage
+
+If you want to make asynchronous, non-blocking LCD requests, you can use AsyncLCDClient. The interface is similar to LCDClient, except the module and wallet API functions must be awaited.
+
+<pre><code>
+>>> import asyncio 
+>>> from terra_sdk.client.lcd import AsyncLCDClient
+
+>>> async def main():
+      <strong>terra = AsyncLCDClient("https://lcd.terra.dev", "columbus-5")</strong>
+      total_supply = await terra.bank.total()
+      print(total_supply)
+      <strong>await terra.session.close # you must close the session</strong>
+
+>>> asyncio.get_event_loop().run_until_complete(main())
+</code></pre>
+
+## Building and Signing Transactions
+
+If you wish to perform a state-changing operation on the Terra blockchain such as sending tokens, swapping assets, withdrawing rewards, or even invoking functions on smart contracts, you must create a **transaction** and broadcast it to the network.
+Terra SDK provides functions that help create StdTx objects.
+
+### Example Using a Wallet (_recommended_)
+
+A `Wallet` allows you to create and sign a transaction in a single step by automatically fetching the latest information from the blockchain (chain ID, account number, sequence).
+
+Use `LCDClient.wallet()` to create a Wallet from any Key instance. The Key provided should correspond to the account you intend to sign the transaction with.
+
+<sub>**NOTE:** *If you are using MacOS and got an exception 'bad key length' from MnemonicKey, please check your python implementation. if `python3 -c "import ssl; print(ssl.OPENSSL_VERSION)"` returns LibreSSL 2.8.3, you need to reinstall python via pyenv or homebrew.*</sub>
+
+```
+>>> from terra_sdk.client.lcd import LCDClient
+>>> from terra_sdk.key.mnemonic import MnemonicKey
+
+>>> mk = MnemonicKey(mnemonic=MNEMONIC)
+>>> terra = LCDClient("https://lcd.terra.dev", "columbus-5")
+>>> wallet = terra.wallet(mk)
+```
+
+Once you have your Wallet, you can simply create a StdTx using `Wallet.create_and_sign_tx`.
+
+```
+>>> from terra_sdk.core.fee import Fee
+>>> from terra_sdk.core.bank import MsgSend
+>>> from terra_sdk.client.lcd.api.tx import CreateTxOptions
+
+>>> tx = wallet.create_and_sign_tx(CreateTxOptions(
+        msgs=[MsgSend(
+            wallet.key.acc_address,
+            RECIPIENT,
+            "1000000uluna"    # send 1 luna
+        )],
+        memo="test transaction!",
+        fee=Fee(200000, "120000uluna")
+    ))
+```
+
+You should now be able to broadcast your transaction to the network.
+
+```
+>>> result = terra.tx.broadcast(tx)
+>>> print(result)
+```
+
+<br/>
+
+# 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.
+
+<br/>
+
+## Reporting an Issue
+
+First things first: **Do NOT report security vulnerabilities in public issues!** Please disclose responsibly by submitting your findings to the [Terra Bugcrowd submission form](https://www.terra.money/bugcrowd). The issue will be assessed as soon as possible.
+If you encounter a different issue with the Python SDK, check first to see if there is an existing issue on the <a href="https://github.com/terra-money/terra-sdk-python/issues">Issues</a> page, or if there is a pull request on the <a href="https://github.com/terra-money/terra-sdk-python/pulls">Pull requests</a> page. Be sure to check both the Open and Closed tabs addressing the issue.
+
+If there isn't a discussion on the topic there, you can file an issue. The ideal report includes:
+
+- A description of the problem / suggestion.
+- How to recreate the bug.
+- If relevant, including the versions of your:
+  - Python interpreter
+  - Terra SDK
+  - Optionally of the other dependencies involved
+- If possible, create a pull request with a (failing) test case demonstrating what's wrong. This makes the process for fixing bugs quicker & gets issues resolved sooner.
+  </br>
+
+## Requesting a Feature
+
+If you wish to request the addition of a feature, please first check out the <a href="https://github.com/terra-money/terra-sdk-python/issues">Issues</a> page and the <a href="https://github.com/terra-money/terra-sdk-python/pulls">Pull requests</a> page (both Open and Closed tabs). If you decide to continue with the request, think of the merits of the feature to convince the project's developers, and provide as much detail and context as possible in the form of filing an issue on the <a href="https://github.com/terra-money/terra-sdk-python/issues">Issues</a> page.
+
+<br/>
+
+## Contributing Code
+
+If you wish to contribute to the repository in the form of patches, improvements, new features, etc., first scale the contribution. If it is a major development, like implementing a feature, it is recommended that you consult with the developers of the project before starting the development to avoid duplicating efforts. Once confirmed, you are welcome to submit your pull request.
+</br>
+
+### For new contributors, here is a quick guide:
+
+1. Fork the repository.
+2. Build the project using the [Dependencies](#dependencies) and [Tests](#tests) steps.
+3. Install a <a href="https://virtualenv.pypa.io/en/latest/index.html">virtualenv</a>.
+4. Develop your code and test the changes using the [Tests](#tests) and [Code Quality](#code-quality) steps.
+5. Commit your changes (ideally follow the <a href="https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit">Angular commit message guidelines</a>).
+6. Push your fork and submit a pull request to the repository's `main` branch to propose your code.
+
+A good pull request:
+
+- Is clear and concise.
+- Works across all supported versions of Python. (3.7+)
+- Follows the existing style of the code base (<a href="https://pypi.org/project/flake8/">`Flake8`</a>).
+- Has comments included as needed.
+- Includes a test case that demonstrates the previous flaw that now passes with the included patch, or demonstrates the newly added feature.
+- Must include documentation for changing or adding any public APIs.
+- Must be appropriately licensed (MIT License).
+  </br>
+
+## Documentation Contributions
+
+Documentation improvements are always welcome. The documentation files live in the [docs](./docs) directory of the repository and are written in <a href="https://docutils.sourceforge.io/rst.html">reStructuredText</a> and use <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> to create the full suite of documentation.
+</br>
+When contributing documentation, please do your best to follow the style of the documentation files. This means a soft limit of 88 characters wide in your text files and a semi-formal, yet friendly and approachable, prose style. You can propose your improvements by submitting a pull request as explained above.
+
+### Need more information on how to contribute?
+
+You can give this <a href="https://opensource.guide/how-to-contribute/#how-to-submit-a-contribution">guide</a> read for more insight.
+
+<br/>
+
+# License
+
+This software is licensed under the MIT license. See [LICENSE](./LICENSE) for full disclosure.
+
+© 2021 Terraform Labs, PTE.
+
+<hr/>
+
+<p>&nbsp;</p>
+<p align="center">
+    <a href="https://terra.money/"><img src="https://assets.website-files.com/611153e7af981472d8da199c/61794f2b6b1c7a1cb9444489_symbol-terra-blue.svg" alt="Terra-logo" width=200/></a>
+<div align="center">
+  <sub><em>Powering the innovation of money.</em></sub>
+</div>

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)