Merge pull request #10 from geoffmunn/documentation_updates

Documentation updates

Author: geoffmunn

Diff for: dist/terra_classic_sdk-2.0.7-py3-none-any.whl

@@ -8,7 +8,7 @@ they take a type like :class:`AccAddress` where one may expect a ``str``. It is
 type alias annotation (equivalent to ``str``) that serves only to remind the developer
 which format the string is expected to be in. 
 
-Terra SDK also provides useful functions for checking and converting **addresses** and **pubkeys**.
+The Terra Classic SDK also provides useful functions for checking and converting **addresses** and **pubkeys**.
 
 Addresses
 ---------

Diff for: dist/terra_classic_sdk-2.0.7.tar.gz

@@ -9,12 +9,12 @@ Numeric Types
 Integers
 --------
 
-Terra SDK uses Python's native ``int`` type to capture both native numbers like ``uint8``, as well
+The Terra Classic SDK uses Python's native ``int`` type to capture both native numbers like ``uint8``, as well
 as Cosmos SDK's ``sdk.Int`` which is normally coerced into a string as it must be passed in JSON format.
 The Python's ``int`` provides support for BigNumber implementation for artihmetic operations.
 
 .. warning::
-    It is possible to introduce numbers larger than 256-bit precision allowed by Terra blockchain but
+    It is possible to introduce numbers larger than 256-bit precision allowed by the Terra Classic blockchain but
     they will result in an error when processing.
 
 

Diff for: docs/common/bech32.rst

@@ -19,12 +19,12 @@
 
 # -- Project information -----------------------------------------------------
 
-project = "Terra SDK"
-copyright = "2021, Terraform Labs, PTE."
-author = "Terraform Labs, PTE."
+project = "Terra Classic SDK"
+copyright = "License: CC-BY-SA-4.0"
+author = "Geoff Munn"
 
 # The full version, including alpha/beta/rc tags
-release = "2.0.3"
+release = "2.0.4"
 
 
 # -- General configuration ---------------------------------------------------

Diff for: docs/common/numeric.rst

@@ -10,7 +10,6 @@ Async module APIs
 You can replace your LCDClient instance with AsyncLCDClient inside a coroutine function:
 
 .. code-block:: python
-    :emphasize-lines: 5,8
 
     import asyncio 
     from terra_classic_sdk.client.lcd import AsyncLCDClient
@@ -21,14 +20,13 @@ You can replace your LCDClient instance with AsyncLCDClient inside a coroutine f
         print(total_supply)
         await terra.session.close() # you must close the session
 
-    asyncio.get_event_loop().run_until_complete(main())
+    asyncio.run(main())
 
 
 For convenience, you can use the async context manager to automatically teardown the
 session. Here's the same code as above, this time using the ``async with`` construct.
 
 .. code-block:: python
-    :emphasize-lines: 5
 
     import asyncio 
     from terra_classic_sdk.client.lcd import AsyncLCDClient
@@ -38,7 +36,7 @@ session. Here's the same code as above, this time using the ``async with`` const
             total_supply = await terra.bank.total()
             print(total_supply)
 
-    asyncio.get_event_loop().run_until_complete(main())
+    asyncio.run(main())
 
 Async wallet API
 ----------------
@@ -47,28 +45,30 @@ When creating a wallet with AsyncLCDClient, the wallet's methods that create LCD
 are also asychronous and therefore must be awaited.
 
 .. code-block:: python
-    :emphasize-lines: 12-13
 
     import asyncio
     from terra_classic_sdk.client.lcd.api.tx import CreateTxOptions
     from terra_classic_sdk.client.lcd import AsyncLCDClient
+    from terra_classic_sdk.core.bank import MsgSend
     from terra_classic_sdk.key.mnemonic import MnemonicKey
     from terra_classic_sdk.core import Coins
+    from terra_classic_sdk.core.tx import Tx
 
-    mk = MnemonicKey()
-    recipient = "terra1..."
+    mk = MnemonicKey(mnemonic='secret 24 word phrase')
+    recipient = "terra..."
 
     async def main():
         async with AsyncLCDClient("https://terra-classic-lcd.publicnode.com", "columbus-5") as terra:
             wallet = terra.wallet(mk)
-            account_number = await wallet.account_number()
-            tx = await wallet.create_and_sign_tx(
+            tx:Tx = await wallet.create_and_sign_tx(
                 CreateTxOptions(
-                    msgs=[MsgSend(wallet.key.acc_address, recipient, Coins(uluna=10202))]
+                    msgs=[MsgSend(wallet.key.acc_address, recipient, Coins(uluna=100000000))]
                 )
             )
-    
-    asyncio.get_event_loop().run_until_complete(main())
+
+            print (tx.auth_info.fee)
+
+    asyncio.run(main())
 
 Alternative event loops
 -----------------------
@@ -77,16 +77,29 @@ The native ``asyncio`` event loop can be replaced with an alternative such as ``
 for more performance. For example:
 
 .. code-block:: python
-    :emphasize-lines: 2, 10
 
     import asyncio
     import uvloop
-
+    from terra_classic_sdk.client.lcd.api.tx import CreateTxOptions
     from terra_classic_sdk.client.lcd import AsyncLCDClient
+    from terra_classic_sdk.core.bank import MsgSend
+    from terra_classic_sdk.key.mnemonic import MnemonicKey
+    from terra_classic_sdk.core import Coins
+    from terra_classic_sdk.core.tx import Tx
+
+    mk = MnemonicKey(mnemonic='secret 24 word phrase')
+    recipient = "terra..."
 
     async def main():
         async with AsyncLCDClient("https://terra-classic-lcd.publicnode.com", "columbus-5") as terra:
-            total_supply = await wallet.bank.total()
+            wallet = terra.wallet(mk)
+            tx:Tx = await wallet.create_and_sign_tx(
+                CreateTxOptions(
+                    msgs=[MsgSend(wallet.key.acc_address, recipient, Coins(uluna=100000000))]
+                )
+            )
+
+            print (tx.auth_info.fee)
 
-    uvloop.install() 
-    asyncio.get_event_loop().run_until_complete(main())
+    uvloop.install()
+    asyncio.run(main())

Diff for: docs/conf.py

@@ -3,11 +3,10 @@
 Implementing a Custom Key
 =========================
 
-If none of the Key solutions provided by Terra Classic SDK or the community are able to meet your requirements,
+If none of the Key solutions provided by the Terra Classic SDK or the community are able to meet your requirements,
 you might consider writing your own Key implementation. 
 
-Here are just a couple  that help guide
-your design pathways:
+Here are just a couple that help guide your design pathways:
 
 Is the private key accessible by developer?
     * YES: Subclass :class:`terra_classic_sdk.key.raw.RawKey`
@@ -26,13 +25,13 @@ Usually, reasons for requiring a custom Key fall into one of 3 patterns:
 
 * External signing
 
-    **Scenario:** The transaction signing is to be performed outside the Python program running Terra Classic SDK,
+    **Scenario:** The transaction signing is to be performed outside the Python program running the Terra Classic SDK,
     such as signing via hardware wallet (Ledger, Trezor), etc. 
 
 
 * Alternative signing algorithm
 
-    **Scenario:** Terra Classic account you need to sign transactions for requires a signature algorithm other than
+    **Scenario:** The Terra Classic account you need to sign transactions for requires a signature algorithm other than
     ECDSA on Secp256k1, such as Threshold Multisig or Ed25519. 
 
 
@@ -49,14 +48,34 @@ The source for MnemonicKey is provided as an example:
     from bip32utils import BIP32_HARDEN, BIP32Key
     from mnemonic import Mnemonic
 
+    coin_types = {
+        'cosmos': 118,
+        'juno': 118,
+        'kava': 459,
+        'kujira': 118,
+        'osmo': 118,
+        'terra': 330,
+        'emoney': 118,
+        'sif': 118,
+        'inj': 60,     # Possibly wrong coin type
+        'axelar': 118,
+        'umee': 118,
+        'omniflix': 118,
+        'gravity': 118,
+        'somm': 118
+    }
+
     class MnemonicKey(RawKey):
         def __init__(
             self,
             mnemonic: str = None,
             account: int = 0,
             index: int = 0,
-            coin_type: int = 330,
+            prefix:str = 'terra'
         ):
+            
+            coin_type = coin_types[prefix]
+            
             if mnemonic is None:
                 mnemonic = Mnemonic("english").generate(256)
             seed = Mnemonic("english").to_seed(mnemonic)
@@ -72,5 +91,7 @@ The source for MnemonicKey is provided as an example:
 
             super().__init__(child.PrivateKey())
             self.mnemonic = mnemonic
+            self.coin_type = coin_type
             self.account = account
             self.index = index
+            self.address_prefix = prefix

Diff for: docs/guides/async.rst

@@ -1,7 +1,7 @@
 LCDClient
 =========
 
-The :class:`LCDClient` is an object representing a HTTP connection to a Terra LCD node.
+The :class:`LCDClient` is an object representing a HTTP connection to a Terra Classic LCD node.
 
 Get connected
 -------------
@@ -16,24 +16,29 @@ Create a new LCDClient instance by specifying the URL and chain ID of the node t
     >>> from terra_classic_sdk.client.lcd import LCDClient
     >>> terra = LCDClient(url="https://terra-classic-lcd.publicnode.com", chain_id="columbus-5")
     >>> terra.tendermint.node_info()['default_node_info']['network']
+
     'columbus-5'
 
 You can also specify gas estimation parameters for your chain for building transactions.
 
 .. code-block:: python
-    :emphasize-lines: 8-9
 
-    import requests
-    from terra_classic_sdk.core import Coins
+    >>> import requests
+    >>> from terra_classic_sdk.client.lcd import LCDClient
+    >>> from terra_classic_sdk.core import Coins
 
-    res = requests.get("https://terra-classic-fcd.publicnode.com/v1/txs/gas_prices")
-    terra = LCDClient(
-        url="https://terra-classic-lcd.publicnode.com",
-        chain_id="columbus-5",
-        gas_prices=Coins(res.json()),
-        gas_adjustment="1.4"
-    )    
+    >>> res = requests.get("https://terra-classic-fcd.publicnode.com/v1/txs/gas_prices")
 
+    >>> terra = LCDClient(
+            url="https://terra-classic-lcd.publicnode.com",
+            chain_id="columbus-5",
+            gas_prices=Coins(res.json()),
+            gas_adjustment="1.4"
+        ) 
+
+    >>> terra.gas_prices
+
+    Coins('0.95uaud,0.95ucad,0.7uchf,4.9ucny,4.5udkk,0.625ueur,0.55ugbp,5.85uhkd,10900.0uidr,54.4uinr,81.85ujpy,850.0ukrw,28.325uluna,2142.855umnt,3.0umyr,6.25unok,38.0uphp,0.52469usdr,6.25usek,1.0usgd,23.1uthb,20.0utwd,0.75uusd')
 
 Using the module APIs
 ---------------------
@@ -46,15 +51,21 @@ Each request fetches live data from the blockchain:
 
 .. code-block:: python
 
+    >>> from terra_classic_sdk.client.lcd import LCDClient
+    >>> terra = LCDClient(url="https://terra-classic-lcd.publicnode.com", chain_id="columbus-5")
     >>> terra.market.parameters()
-    {'base_pool': '7000000000000.000000000000000000', 'pool_recovery_period': '200', 'min_spread': '0.005000000000000000'}
+    
+    {'base_pool': Dec('100000000000000'), 'pool_recovery_period': 18, 'min_stability_spread': Dec('1')}
 
 The height of the last result (if applicable) is available:
 
 .. code-block:: python
 
-    >>> terra.last_request_height
-    89292
+    >>> from terra_classic_sdk.client.lcd import LCDClient
+    >>> terra = LCDClient(url="https://terra-classic-lcd.publicnode.com", chain_id="columbus-5")
+    >>> terra.treasury.tax_rate()
+
+    0.005000000000000000
 
 
 Create a wallet
@@ -65,11 +76,25 @@ are useful for easily creating and signing transactions.
 
 .. code-block:: python
 
+    >>> import requests
+    >>> from terra_classic_sdk.client.lcd import LCDClient
+    >>> from terra_classic_sdk.client.lcd.wallet import Wallet
+    >>> from terra_classic_sdk.core import Coins
     >>> from terra_classic_sdk.key.mnemonic import MnemonicKey
-    >>> mk = MnemonicKey()
-    >>> wallet = terra.wallet(mk)
+
+    >>> res = requests.get("https://terra-classic-fcd.publicnode.com/v1/txs/gas_prices")
+
+    >>> mk = MnemonicKey(mnemonic='secret 24 word phrase')
+    >>> terra = LCDClient(
+        url="https://terra-classic-lcd.publicnode.com",
+        chain_id="columbus-5",
+        gas_prices=Coins(res.json()),
+        gas_adjustment="1.4"
+    )
+    >>> wallet:Wallet = terra.wallet(mk)
     >>> wallet.account_number()
-    27
+
+    5151262
 
 
 LCDClient Reference

Diff for: docs/guides/custom_key.rst

@@ -15,21 +15,26 @@ PaginationOption
 You can use PaginationOptions as APIParams for params of query functions.
 
 .. code-block:: python
-    :emphasize-lines: 5,8
 
     from terra_classic_sdk.client.lcd import LCDClient, PaginationOptions
 
     terra = LCDClient(
         url="https://terra-classic-lcd.publicnode.com",
-        chain_id="columbus-5",
+        chain_id="columbus-5"
     )
 
-
     result, pagination  = terra.gov.proposals()
 
+    page_count:int = 1
     while pagination["next_key"] is not None:
         pagOpt = PaginationOptions(key=pagination["next_key"])
-        result, pagination = terra.gov.proposals(params=pagOpt)
+        proposals, pagination = terra.gov.proposals(params=pagOpt)
         pagOpt.key = pagination["next_key"]
-        print(result)
+
+        print ('****************')
+        print (f'Page number {page_count}')
+        for proposal in proposals:
+            print (proposal.content.title)
+
+        page_count += 1