The Terra Classic Data Analysis Software Development Kit (SDK) not only possesses the functions of a basic SDK but also specifically enhances the on - chain historical data tracing and data analysis functions.
-
Basic SDK: Inherit all the LCD query、Tx transaction from the basic SDK and maintain updates.
-
Data Analysis: Enhanced the on-chain data analysis function, providing aggregation interfaces for historical data tracing and display of pre - processed results.
-
BUG Fixed: Since validators have the greatest stake in the development of the Terra chain, they actively fix bugs and add features. Currently, the Binodes validator is the main maintainer.
feat(bank): Add the function to query the total supply of tokens
- Import the
Coinclass inbank.pyto support the handling of the amount of a single token. - Implement the asynchronous method
total_denomto query the total supply of the specifieddenom. - Add a synchronous binding wrapper for the
total_denommethod. - Add a method to query the unclaimed rewards of validators in
distribution.py - Implement both asynchronous and synchronous interfaces for
validator_outstanding_rewards. - Update the relevant API docstrings to reflect the new features.
feat(wasm, slashing): add new functionality and update messages
- Add MsgStoreCode_vbeta1 to wasm module
- Update connection data parsing in ibc module
- Add codes and contracts_by_code methods to WasmAPI- Update contract_info method in WasmAPI
- Add MsgUpdateParams to slashing module
feat(bank): add denominations metadata endpoint and update related data objects
- Add denoms_metadata method to AsyncBankAPI and BankAPI
- Create Metadata and DenomUnit classes in bank/data.py
- Update TxBody and TxInfo classes to include new fields
feat(auth): add ModuleAccount and update related components
- Add ModuleAccount import in auth/data/init.py- Update Account class to handle ModuleAccount type
- Add to_data method in DenomTrace class
- Implement denom_traces method in IbcTransferAPI
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.
Terra SDK can be installed (preferably in a virtual environment from PyPI using pip) as follows:
Upgrade the SDK:
$ pip install -U terra-classic-data-analysis-sdk
You might need to run pip via python -m pip install -U terra-classic-data-analysis-sdk. Additionally, you might have pip3 installed instead of pip; proceed according to your own setup.
An intricate reference to the APIs on the Terra SDK can be found here.
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 here as reference.
Terra Classic SDK requires Python v3.7+.
One line of code to query the maximum block height on the current blockchain：
>>> from terra_classic_sdk.client.lcd import LCDClient
>>> LCDClient().tendermint.block_info()['block']['header']['height']'1687543'
Notice：User-defined LCD and CHAIN are still supported, and the usage inherits from the underlying basic SDK capabilities.
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.
>>> import asyncio
>>> from terra_classic_sdk.client.lcd import AsyncLCDClient
>>> async def main():
terra = AsyncLCDClient()
total_supply = await terra.bank.total()
print(total_supply)
await terra.session.close # you must close the session
>>> asyncio.get_event_loop().run_until_complete(main())If you wish to perform a state-changing operation on the Terra Classic 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 Classic SDK provides functions that help create StdTx objects.
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.
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.
>>> from terra_classic_sdk.client.lcd import LCDClient
>>> from terra_classic_sdk.key.mnemonic import MnemonicKey
# Fill in the mnemonic phrase of your wallet. A better practice is to set it as a system variable and read it.
>>> key = MnemonicKey(
mnemonic="sport oppose usual cream task benefit canvas xxxxxxxxxxxxxxxxxx")
# Init wallet
>>> wallet = LCDClient().wallet(key=key)Once you have your Wallet, you can simply create a StdTx using Wallet.create_and_sign_tx.
>>> from terra_classic_sdk.core.bank import MsgSend
>>> from terra_classic_sdk.client.lcd.api.tx import CreateTxOptions
>>> tx = wallet.create_and_sign_tx(CreateTxOptions(
msgs=[MsgSend(
"terra1drs4gul908c59638gu9s88mugdnujdprjhtu7n", # Sender
'terra1s2xpff7mj6jpxfyhr7pe25vt8puvgj4wyq8lz4', # Receiver
"1000000uluna" # send 1 lunc
)],
memo="test transaction!",
gas_adjustment=1.2, # Auto fee, can be increased during peak periods.
# fee=Fee(240324,'7023928uluna'), # Set the fees manually if you need
))You should now be able to broadcast your transaction to the network.
>>> result = LCDClient().tx.broadcast(tx)
>>> print(result)Terra Classic SDK uses Poetry to manage dependencies. To get set up with all the required dependencies, run:
$ pip install poetry
$ poetry install
Terra Classic SDK provides extensive tests for data classes and functions. To run them, after the steps in Dependencies:
$ make test
Terra Classic SDK uses Black, isort, and Mypy for checking code quality and maintaining style. To reformat, after the steps in Dependencies:
$ make qa && make format
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.
First things first: Do NOT report security vulnerabilities in public issues! Please disclose responsibly by submitting your findings to the Terra Bugcrowd submission form. 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 Issues page, or if there is a pull request on the Pull requests 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.
If you wish to request the addition of a feature, please first check out the Issues page and the Pull requests 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 Issues page.
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.
- Fork the repository.
- Build the project using the Dependencies and Tests steps.
- Install a virtualenv.
- Develop your code and test the changes using the Tests and Code Quality steps.
- Commit your changes (ideally follow the Angular commit message guidelines).
- Push your fork and submit a pull request to the repository's
mainbranch 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 (
Flake8). - 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).
Documentation improvements are always welcome. The documentation files live in the docs directory of the repository and are written in reStructuredText and use Sphinx to create the full suite of documentation.
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.
You can give this guide read for more insight.
This software is licensed under the MIT license. See LICENSE for full disclosure.
