Merge pull request #35 from ElrondNetwork/development

Version 1.0.18

Author: camilbancioiu

.github/workflows/erdpy-mypy.yml

@@ -0,0 +1,14 @@
+name: mypy reviewdog check
+on: [pull_request]
+jobs:
+  mypy:
+    name: runner / mypy
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install Python dependencies
+        uses: py-actions/py-dependency-install@v2
+      - uses: tsuyoshicho/action-mypy@v3
+        with:
+          github_token: ${{ secrets.github_token }}
+          filter_mode: nofilter

erdpy/CHANGELOG.md

@@ -4,6 +4,15 @@ All notable changes will be documented in this file.
 
 Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
 
+## [1.0.18] - 14.09.2021
+ - Load a local `erdpy.json` file when running `erdpy` commands, containing default values for CLI options per project
+ - Bugfix by [MWFIAE](https://github.com/MWFIAE): correctly verify the value of the `--bytecode` argument
+ - Bugfix by [MWFIAE](https://github.com/MWFIAE): `QueryResult` objects are now properly JSON-serializable
+ - Add more output information after building and deploying contracts
+ - Improve error reporting to standard output
+ - Enable `mypy` checking as a GitHub action
+ - Add and fix more type hints for `mypy`
+
 ## [1.0.16] - 27.08.2021
  - Merge branch `legolas-addons`
  - Fix `erdpy testnet` to work with recent changes in `elrond-go`
@@ -22,7 +31,7 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
  - Add --wait-result flag for erdpy tx new cli command.
 
 ## [1.0.10] - 25.02.2021
- - [Fixed a bug in the testnet setup process when creting the config for the proxy app #213](https://github.com/ElrondNetwork/elrond-sdk/pull/213) 
+ - [Fixed a bug in the testnet setup process when creating the config for the proxy app #213](https://github.com/ElrondNetwork/elrond-sdk/pull/213) 
 
 ## [1.0.9] - 29.01.2021
  -  [Multiple config templates #152](https://github.com/ElrondNetwork/elrond-sdk/pull/152). One can now `switch` between different **configuration** profiles.
@@ -149,7 +158,7 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
  - Refactoring and design improvements
 
 
-**Note that below, the change log is in chronological order. Will be soon updated to be in inverse chronological order (how it should have been in the first place).**
+**Note that below, the changelog is in chronological order. It will be soon updated to be in inverse chronological order (how it should have been in the first place).**
 
 ## [0.0.4]
 
@@ -498,7 +507,7 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
  - Removed .py SC interaction samples, moved to `sc-examples` `sc-examples-rs` repositories, so that they become available in Elrond IDE.
  - Removed some deprecated code.
  - `mypy`-related refactoring.
- - Fix accounts CLI. Trucate data for "account get-transactions"
+ - Fix accounts CLI. Truncate data for "account get-transactions".
 
 ## [0.7.1] - 13.07.2020
 

erdpy/_version.py

@@ -1 +1 @@
-__version__ = "1.0.17"
+__version__ = "1.0.18"

erdpy/accounts.py

@@ -133,7 +133,7 @@ def __repr__(self):
         return self.bech32()
 
     @classmethod
-    def zero(cls):
+    def zero(cls) -> 'Address':
         return Address("0" * 64)
 
 

erdpy/cli.py

@@ -21,7 +21,7 @@
 import erdpy.cli_wallet
 import erdpy.cli_delagation
 import erdpy.cli_dns
-from erdpy import errors, scope
+from erdpy import config, errors, scope
 from erdpy._version import __version__
 
 logger = logging.getLogger("cli")
@@ -32,18 +32,20 @@ def main():
         _do_main()
     except errors.KnownError as err:
         logger.critical(err.get_pretty())
-        sys.exit(1)
+        return 1
     except KeyboardInterrupt:
         print("erdpy process killed by user.")
-        sys.exit(1)
+        return 1
+    return 0
 
 
 def _do_main():
     logging.basicConfig(level=logging.INFO)
     scope.initialize()
 
-    parser = setup_parser()
-    args = parser.parse_args()
+    argv_with_config_args = config.add_config_args(sys.argv[1:])
+    parser = setup_parser(argv_with_config_args)
+    args = parser.parse_args(argv_with_config_args)
 
     if args.verbose:
         logging.basicConfig(level=logging.DEBUG)
@@ -56,7 +58,7 @@ def _do_main():
         args.func(args)
 
 
-def setup_parser():
+def setup_parser(args: List[str] = sys.argv[1:]):
     parser = ArgumentParser(
         prog="erdpy",
         usage="erdpy [-h] [-v] [--verbose] COMMAND-GROUP [-h] COMMAND ...",
@@ -82,23 +84,23 @@ def setup_parser():
     subparsers = parser.add_subparsers()
     commands: List[Any] = []
 
-    commands.append(erdpy.cli_contracts.setup_parser(subparsers))
-    commands.append(erdpy.cli_transactions.setup_parser(subparsers))
-    commands.append(erdpy.cli_validators.setup_parser(subparsers))
+    commands.append(erdpy.cli_contracts.setup_parser(args, subparsers))
+    commands.append(erdpy.cli_transactions.setup_parser(args, subparsers))
+    commands.append(erdpy.cli_validators.setup_parser(args, subparsers))
     commands.append(erdpy.cli_accounts.setup_parser(subparsers))
     commands.append(erdpy.cli_ledger.setup_parser(subparsers))
-    commands.append(erdpy.cli_wallet.setup_parser(subparsers))
+    commands.append(erdpy.cli_wallet.setup_parser(args, subparsers))
     commands.append(erdpy.cli_network.setup_parser(subparsers))
     commands.append(erdpy.cli_cost.setup_parser(subparsers))
-    commands.append(erdpy.cli_dispatcher.setup_parser(subparsers))
+    commands.append(erdpy.cli_dispatcher.setup_parser(args, subparsers))
     commands.append(erdpy.cli_blockatlas.setup_parser(subparsers))
     commands.append(erdpy.cli_deps.setup_parser(subparsers))
     commands.append(erdpy.cli_config.setup_parser(subparsers))
     commands.append(erdpy.cli_block.setup_parser(subparsers))
-    commands.append(erdpy.cli_testnet.setup_parser(subparsers))
+    commands.append(erdpy.cli_testnet.setup_parser(args, subparsers))
     commands.append(erdpy.cli_data.setup_parser(subparsers))
-    commands.append(erdpy.cli_delagation.setup_parser(subparsers))
-    commands.append(erdpy.cli_dns.setup_parser(subparsers))
+    commands.append(erdpy.cli_delagation.setup_parser(args, subparsers))
+    commands.append(erdpy.cli_dns.setup_parser(args, subparsers))
 
     parser.epilog = """
 ----------------------
@@ -112,4 +114,5 @@ def setup_parser():
 
 
 if __name__ == "__main__":
-    main()
+    ret = main()
+    sys.exit(ret)

erdpy/cli_contracts.py

@@ -1,6 +1,6 @@
 import logging
 import os
-from typing import Any
+from typing import Any, List
 
 from pathlib import Path
 
@@ -14,7 +14,7 @@
 logger = logging.getLogger("cli.contracts")
 
 
-def setup_parser(subparsers: Any) -> Any:
+def setup_parser(args: List[str], subparsers: Any) -> Any:
     parser = cli_shared.add_group_subparser(subparsers, "contract", "Build, deploy and interact with Smart Contracts")
     subparsers = parser.add_subparsers()
 
@@ -50,9 +50,9 @@ def setup_parser(subparsers: Any) -> Any:
     _add_project_or_bytecode_arg(sub)
     _add_metadata_arg(sub)
     cli_shared.add_outfile_arg(sub)
-    cli_shared.add_wallet_args(sub)
+    cli_shared.add_wallet_args(args, sub)
     cli_shared.add_proxy_arg(sub)
-    cli_shared.add_tx_args(sub, with_receiver=False, with_data=False)
+    cli_shared.add_tx_args(args, sub, with_receiver=False, with_data=False)
     _add_arguments_arg(sub)
     sub.add_argument("--wait-result", action="store_true", default=False,
                      help="signal to wait for the transaction result - only valid if --send is set")
@@ -65,9 +65,9 @@ def setup_parser(subparsers: Any) -> Any:
     sub = cli_shared.add_command_subparser(subparsers, "contract", "call", "Interact with a Smart Contract (execute function).")
     _add_contract_arg(sub)
     cli_shared.add_outfile_arg(sub)
-    cli_shared.add_wallet_args(sub)
+    cli_shared.add_wallet_args(args, sub)
     cli_shared.add_proxy_arg(sub)
-    cli_shared.add_tx_args(sub, with_receiver=False, with_data=False)
+    cli_shared.add_tx_args(args, sub, with_receiver=False, with_data=False)
     _add_function_arg(sub)
     _add_arguments_arg(sub)
     sub.add_argument("--wait-result", action="store_true", default=False,
@@ -83,9 +83,9 @@ def setup_parser(subparsers: Any) -> Any:
     cli_shared.add_outfile_arg(sub)
     _add_project_or_bytecode_arg(sub)
     _add_metadata_arg(sub)
-    cli_shared.add_wallet_args(sub)
+    cli_shared.add_wallet_args(args, sub)
     cli_shared.add_proxy_arg(sub)
-    cli_shared.add_tx_args(sub, with_receiver=False, with_data=False)
+    cli_shared.add_tx_args(args, sub, with_receiver=False, with_data=False)
     _add_arguments_arg(sub)
     sub.add_argument("--wait-result", action="store_true", default=False,
                      help="signal to wait for the transaction result - only valid if --send is set")
@@ -115,7 +115,7 @@ def _add_project_or_bytecode_arg(sub: Any):
     group.add_argument("--project", default=os.getcwd(),
                        help="🗀 the project directory (default: current directory)")
     group.add_argument("--bytecode", type=str,
-                      help="the file containing the WASM bytecode")
+                       help="the file containing the WASM bytecode")
 
 
 def _add_contract_arg(sub: Any):
@@ -187,6 +187,7 @@ def deploy(args: Any):
 
     tx = contract.deploy(sender, arguments, gas_price, gas_limit, value, chain, version)
     logger.info("Contract address: %s", contract.address)
+    utils.log_explorer_contract_address(chain, contract.address)
 
     result = None
     try:
@@ -221,7 +222,7 @@ def dump_tx_and_result(tx: Any, result: Any, args: Any):
 
 
 def _prepare_contract(args: Any) -> SmartContract:
-    if len(args.bytecode):
+    if args.bytecode and len(args.bytecode):
         bytecode = utils.read_binary_file(Path(args.bytecode)).hex()
     else:
         project = load_project(args.project)

erdpy/cli_delagation.py

@@ -1,6 +1,6 @@
 import binascii
 import sys
-from typing import Any
+from typing import Any, List
 
 from erdpy import cli_shared, errors, utils
 from erdpy.accounts import Address
@@ -9,15 +9,15 @@
 from erdpy.transactions import do_prepare_transaction
 
 
-def setup_parser(subparsers: Any) -> Any:
+def setup_parser(args: List[str], subparsers: Any) -> Any:
     parser = cli_shared.add_group_subparser(subparsers, "staking-provider", "Staking provider omnitool")
     subparsers = parser.add_subparsers()
 
     # create new delegation contract
     sub = cli_shared.add_command_subparser(subparsers, "staking-provider", "create-new-delegation-contract",
                                            "Create a new delegation system smart contract, transferred value must be"
                                            "greater than baseIssuingCost + min deposit value")
-    _add_common_arguments(sub)
+    _add_common_arguments(args, sub)
     sub.add_argument("--total-delegation-cap", required=True, help="the total delegation contract capacity")
     sub.add_argument("--service-fee", required=True, help="the delegation contract service fee")
     sub.set_defaults(func=do_create_delegation_contract)
@@ -37,87 +37,87 @@ def setup_parser(subparsers: Any) -> Any:
     sub.add_argument("--validators-file", required=True, help="a JSON file describing the Nodes")
     sub.add_argument("--delegation-contract", required=True, help="address of the delegation contract")
     sub.add_argument("--using-delegation-manager", action="store_true", required=False, help="whether delegation contract was created using the Delegation Manager")
-    _add_common_arguments(sub)
+    _add_common_arguments(args, sub)
     sub.set_defaults(func=add_new_nodes)
 
     # remove nodes
     sub = cli_shared.add_command_subparser(subparsers, "staking-provider", "remove-nodes",
                                            "Remove nodes must be called by the contract owner")
     sub.add_argument("--bls-keys", required=True, help="a list with the bls keys of the nodes")
     sub.add_argument("--delegation-contract", required=True, help="address of the delegation contract")
-    _add_common_arguments(sub)
+    _add_common_arguments(args, sub)
     sub.set_defaults(func=remove_nodes)
 
     # stake nodes
     sub = cli_shared.add_command_subparser(subparsers, "staking-provider", "stake-nodes",
                                            "Stake nodes must be called by the contract owner")
     sub.add_argument("--bls-keys", required=True, help="a list with the bls keys of the nodes")
     sub.add_argument("--delegation-contract", required=True, help="address of the delegation contract")
-    _add_common_arguments(sub)
+    _add_common_arguments(args, sub)
     sub.set_defaults(func=stake_nodes)
 
     # unbond nodes
     sub = cli_shared.add_command_subparser(subparsers, "staking-provider", "unbond-nodes",
                                            "Unbond nodes must be called by the contract owner")
     sub.add_argument("--bls-keys", required=True, help="a list with the bls keys of the nodes")
     sub.add_argument("--delegation-contract", required=True, help="address of the delegation contract")
-    _add_common_arguments(sub)
+    _add_common_arguments(args, sub)
     sub.set_defaults(func=unbond_nodes)
 
     # unstake nodes
     sub = cli_shared.add_command_subparser(subparsers, "staking-provider", "unstake-nodes",
                                            "Unstake nodes must be called by the contract owner")
     sub.add_argument("--bls-keys", required=True, help="a list with the bls keys of the nodes")
     sub.add_argument("--delegation-contract", required=True, help="address of the delegation contract")
-    _add_common_arguments(sub)
+    _add_common_arguments(args, sub)
     sub.set_defaults(func=unstake_nodes)
 
     # unjail nodes
     sub = cli_shared.add_command_subparser(subparsers, "staking-provider", "unjail-nodes",
                                            "Unjail nodes must be called by the contract owner")
     sub.add_argument("--bls-keys", required=True, help="a list with the bls keys of the nodes")
     sub.add_argument("--delegation-contract", required=True, help="address of the delegation contract")
-    _add_common_arguments(sub)
+    _add_common_arguments(args, sub)
     sub.set_defaults(func=unjail_nodes)
 
     # change service fee
     sub = cli_shared.add_command_subparser(subparsers, "staking-provider", "change-service-fee",
                                            "Change service fee must be called by the contract owner")
     sub.add_argument("--service-fee", required=True, help="new service fee value")
     sub.add_argument("--delegation-contract", required=True, help="address of the delegation contract")
-    _add_common_arguments(sub)
+    _add_common_arguments(args, sub)
     sub.set_defaults(func=change_service_fee)
 
     # modify total delegation cap
     sub = cli_shared.add_command_subparser(subparsers, "staking-provider", "modify-delegation-cap",
                                            "Modify delegation cap must be called by the contract owner")
     sub.add_argument("--delegation-cap", required=True, help="new delegation contract capacity")
     sub.add_argument("--delegation-contract", required=True, help="address of the delegation contract")
-    _add_common_arguments(sub)
+    _add_common_arguments(args, sub)
     sub.set_defaults(func=modify_delegation_cap)
 
     # set automatic activation
     sub = cli_shared.add_command_subparser(subparsers, "staking-provider", "automatic-activation",
                                            "Automatic activation must be called by the contract owner")
 
-    sub.add_argument("--set", action="store_true", required=not (utils.is_arg_present("--unset", sys.argv)),
+    sub.add_argument("--set", action="store_true", required=not (utils.is_arg_present(args, "--unset")),
                      help="set automatic activation True")
-    sub.add_argument("--unset", action="store_true", required=not (utils.is_arg_present("--set", sys.argv)),
+    sub.add_argument("--unset", action="store_true", required=not (utils.is_arg_present(args, "--set")),
                      help="set automatic activation False")
     sub.add_argument("--delegation-contract", required=True, help="address of the delegation contract")
-    _add_common_arguments(sub)
+    _add_common_arguments(args, sub)
     sub.set_defaults(func=automatic_activation)
 
     # set redelegate cap
     sub = cli_shared.add_command_subparser(subparsers, "staking-provider", "redelegate-cap",
                                            "Redelegate cap must be called by the contract owner")
 
-    sub.add_argument("--set", action="store_true", required=not (utils.is_arg_present("--unset", sys.argv)),
+    sub.add_argument("--set", action="store_true", required=not (utils.is_arg_present(args, "--unset")),
                      help="set redelegate cap True")
-    sub.add_argument("--unset", action="store_true", required=not (utils.is_arg_present("--set", sys.argv)),
+    sub.add_argument("--unset", action="store_true", required=not (utils.is_arg_present(args, "--set")),
                      help="set redelegate cap False")
     sub.add_argument("--delegation-contract", required=True, help="address of the delegation contract")
-    _add_common_arguments(sub)
+    _add_common_arguments(args, sub)
     sub.set_defaults(func=redelegate_cap)
 
     # set metadata
@@ -128,14 +128,14 @@ def setup_parser(subparsers: Any) -> Any:
     sub.add_argument("--website", required=True, help="website field in staking provider metadata")
     sub.add_argument("--identifier", required=True, help="identifier field in staking provider metadata")
     sub.add_argument("--delegation-contract", required=True, help="address of the delegation contract")
-    _add_common_arguments(sub)
+    _add_common_arguments(args, sub)
     sub.set_defaults(func=set_metadata)
 
 
-def _add_common_arguments(sub: Any):
+def _add_common_arguments(args: List[str], sub: Any):
     cli_shared.add_proxy_arg(sub)
-    cli_shared.add_wallet_args(sub)
-    cli_shared.add_tx_args(sub, with_receiver=False, with_data=False, with_estimate_gas=True)
+    cli_shared.add_wallet_args(args, sub)
+    cli_shared.add_tx_args(args, sub, with_receiver=False, with_data=False, with_estimate_gas=True)
     cli_shared.add_broadcast_args(sub, relay=False)
     cli_shared.add_outfile_arg(sub, what="signed transaction, hash")