-
Notifications
You must be signed in to change notification settings - Fork 2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactor CLI by adding add new click types for fees, amounts, address…
…es and bytes32 (#15718)
- Loading branch information
Showing
21 changed files
with
1,438 additions
and
1,307 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,193 @@ | ||
| from __future__ import annotations | ||
|
|
||
| from decimal import Decimal | ||
| from pathlib import Path | ||
| from typing import Any, cast | ||
|
|
||
| import pytest | ||
| from click import BadParameter, Context | ||
|
|
||
| from chia.cmds.param_types import ( | ||
| AddressParamType, | ||
| AmountParamType, | ||
| Bytes32ParamType, | ||
| CliAddress, | ||
| CliAmount, | ||
| TransactionFeeParamType, | ||
| Uint64ParamType, | ||
| ) | ||
| from chia.cmds.units import units | ||
| from chia.types.blockchain_format.sized_bytes import bytes32 | ||
| from chia.util.bech32m import encode_puzzle_hash | ||
| from chia.util.ints import uint64 | ||
| from chia.wallet.util.address_type import AddressType | ||
|
|
||
| """ | ||
| This File tests all of the custom click param types. | ||
| Click automatically handles all cases where it is None and all cases where it is in some sort of Iterable. | ||
| """ | ||
|
|
||
| burn_ph = bytes32.from_hexstr("0x000000000000000000000000000000000000000000000000000000000000dead") | ||
| burn_address = encode_puzzle_hash(burn_ph, "xch") | ||
| burn_address_txch = encode_puzzle_hash(burn_ph, "txch") | ||
| burn_nft_addr = encode_puzzle_hash(burn_ph, "did:chia:") | ||
| burn_bad_prefix = encode_puzzle_hash(burn_ph, "badprefix") | ||
| overflow_ammt = 18446744073709551616 # max coin + 1 | ||
| overflow_decimal_str = "18446744.073709551616" | ||
| overflow_decimal = Decimal(overflow_decimal_str) | ||
|
|
||
|
|
||
| class FakeContext: | ||
| obj: dict[Any, Any] = {} | ||
|
|
||
| def __init__(self, obj: dict[Any, Any]): | ||
| self.obj = obj | ||
|
|
||
|
|
||
| def test_click_tx_fee_type() -> None: | ||
| # Test uint64 (only used as default) | ||
| # assert TransactionFeeParamType().convert(uint64(10000), None, None) == uint64(10000) | ||
|
|
||
| # TODO: Test MOJO Logic When Implemented | ||
|
|
||
| # Test Decimal / XCH | ||
| assert TransactionFeeParamType().convert("0.5", None, None) == uint64(Decimal("0.5") * units["chia"]) | ||
| assert TransactionFeeParamType().convert("0.000000000001", None, None) == uint64(1) | ||
| assert TransactionFeeParamType().convert("0", None, None) == uint64(0) | ||
| # Test Decimal Failures | ||
| with pytest.raises(BadParameter): | ||
| TransactionFeeParamType().convert("test", None, None) | ||
| with pytest.raises(BadParameter): | ||
| TransactionFeeParamType().convert("0.6", None, None) | ||
| with pytest.raises(BadParameter): | ||
| TransactionFeeParamType().convert("0.0000000000001", None, None) # 0.1 mojos | ||
| with pytest.raises(BadParameter): | ||
| TransactionFeeParamType().convert("-0.6", None, None) | ||
| with pytest.raises(BadParameter): | ||
| TransactionFeeParamType().convert(overflow_decimal_str, None, None) | ||
| # Test Type Failures | ||
| with pytest.raises(BadParameter): | ||
| TransactionFeeParamType().convert(float(0.01), None, None) | ||
|
|
||
|
|
||
| def test_click_amount_type() -> None: | ||
| decimal_cli_amount = CliAmount(mojos=False, amount=Decimal("5.25")) | ||
| large_decimal_amount = CliAmount(mojos=False, amount=overflow_decimal) | ||
| mojos_cli_amount = CliAmount(mojos=True, amount=uint64(100000)) | ||
| one_mojo_cli_amount = CliAmount(mojos=False, amount=Decimal("0.000000000001")) | ||
| # Test CliAmount (Generally is not used) | ||
| assert AmountParamType().convert(decimal_cli_amount, None, None) == decimal_cli_amount | ||
|
|
||
| # Test uint64 (only usable as default) | ||
| # assert AmountParamType().convert(uint64(100000), None, None) == mojos_cli_amount | ||
|
|
||
| # TODO: Test MOJO Logic When Implemented | ||
|
|
||
| # Test Decimal / XCH (we don't test overflow because we don't know the conversion ratio yet) | ||
| assert AmountParamType().convert("5.25", None, None) == decimal_cli_amount | ||
| assert AmountParamType().convert(overflow_decimal_str, None, None) == large_decimal_amount | ||
| assert AmountParamType().convert("0.000000000001", None, None) == one_mojo_cli_amount | ||
| # Test Decimal Failures | ||
| with pytest.raises(BadParameter): | ||
| AmountParamType().convert("test", None, None) | ||
| with pytest.raises(BadParameter): | ||
| AmountParamType().convert("0.0000000000001", None, None) # 0.1 mojos | ||
| with pytest.raises(BadParameter): | ||
| AmountParamType().convert("-999999", None, None) | ||
| with pytest.raises(BadParameter): | ||
| AmountParamType().convert("-0.6", None, None) | ||
| # Test Type Failures | ||
| with pytest.raises(BadParameter): | ||
| AmountParamType().convert(0.01, None, None) | ||
|
|
||
| # Test CliAmount Class | ||
| assert decimal_cli_amount.convert_amount(units["chia"]) == uint64(Decimal("5.25") * units["chia"]) | ||
| assert mojos_cli_amount.convert_amount(units["chia"]) == uint64(100000) | ||
| assert one_mojo_cli_amount.convert_amount(units["chia"]) == uint64(1) | ||
| with pytest.raises(ValueError): # incorrect arg | ||
| CliAmount(mojos=True, amount=Decimal("5.25")).convert_amount(units["chia"]) | ||
| with pytest.raises(ValueError): # incorrect arg | ||
| CliAmount(mojos=False, amount=uint64(100000)).convert_amount(units["chia"]) | ||
| with pytest.raises(ValueError): # overflow | ||
| large_decimal_amount.convert_amount(units["chia"]) | ||
|
|
||
|
|
||
| def test_click_address_type() -> None: | ||
| context = cast(Context, FakeContext(obj={"expected_prefix": "xch"})) # this makes us not have to use a config file | ||
| std_cli_address = CliAddress(burn_ph, burn_address, AddressType.XCH) | ||
| nft_cli_address = CliAddress(burn_ph, burn_nft_addr, AddressType.DID) | ||
| # Test CliAddress (Generally is not used) | ||
| # assert AddressParamType().convert(std_cli_address, None, context) == std_cli_address | ||
|
|
||
| # test address parsing | ||
| assert AddressParamType().convert(burn_address, None, context) == std_cli_address | ||
| assert AddressParamType().convert(burn_nft_addr, None, context) == nft_cli_address | ||
|
|
||
| # check address type validation | ||
| assert std_cli_address.validate_address_type(AddressType.XCH) == burn_address | ||
| assert std_cli_address.validate_address_type_get_ph(AddressType.XCH) == burn_ph | ||
| assert nft_cli_address.validate_address_type(AddressType.DID) == burn_nft_addr | ||
| assert nft_cli_address.validate_address_type_get_ph(AddressType.DID) == burn_ph | ||
| # check error handling | ||
| with pytest.raises(BadParameter): | ||
| AddressParamType().convert("test", None, None) | ||
| with pytest.raises(AttributeError): # attribute error because the context does not have a real error handler | ||
| AddressParamType().convert(burn_address_txch, None, context) | ||
| with pytest.raises(BadParameter): | ||
| AddressParamType().convert(burn_bad_prefix, None, None) | ||
| # Test Type Failures | ||
| with pytest.raises(BadParameter): | ||
| AddressParamType().convert(float(0.01), None, None) | ||
|
|
||
| # check class error handling | ||
| with pytest.raises(ValueError): | ||
| std_cli_address.validate_address_type_get_ph(AddressType.DID) | ||
| with pytest.raises(ValueError): | ||
| std_cli_address.validate_address_type(AddressType.DID) | ||
|
|
||
|
|
||
| def test_click_address_type_config(root_path_populated_with_config: Path) -> None: | ||
| # set a root path in context. | ||
| context = cast(Context, FakeContext(obj={"root_path": root_path_populated_with_config})) | ||
| # run test that should pass | ||
| assert AddressParamType().convert(burn_address, None, context) == CliAddress(burn_ph, burn_address, AddressType.XCH) | ||
| assert context.obj["expected_prefix"] == "xch" # validate that the prefix was set correctly | ||
| # use txch address | ||
| with pytest.raises(AttributeError): # attribute error because the context does not have a real error handler | ||
| AddressParamType().convert(burn_address_txch, None, context) | ||
|
|
||
|
|
||
| def test_click_bytes32_type() -> None: | ||
| # Test bytes32 (Generally it is not used) | ||
| # assert Bytes32ParamType().convert(burn_ph, None, None) == burn_ph | ||
|
|
||
| # test bytes32 parsing | ||
| assert Bytes32ParamType().convert("0x" + burn_ph.hex(), None, None) == burn_ph | ||
| # check error handling | ||
| with pytest.raises(BadParameter): | ||
| Bytes32ParamType().convert("test", None, None) | ||
| # Test Type Failures | ||
| with pytest.raises(BadParameter): | ||
| Bytes32ParamType().convert(float(0.01), None, None) | ||
|
|
||
|
|
||
| def test_click_uint64_type() -> None: | ||
| # Test uint64 (only used as default) | ||
| assert Uint64ParamType().convert(uint64(10000), None, None) == uint64(10000) | ||
|
|
||
| # Test Uint64 Parsing | ||
| assert Uint64ParamType().convert("5", None, None) == uint64(5) | ||
| assert Uint64ParamType().convert("10000000000000", None, None) == uint64(10000000000000) | ||
| assert Uint64ParamType().convert("0", None, None) == uint64(0) | ||
| # Test Failures | ||
| with pytest.raises(BadParameter): | ||
| Uint64ParamType().convert("test", None, None) | ||
| with pytest.raises(BadParameter): | ||
| Uint64ParamType().convert("0.1", None, None) | ||
| with pytest.raises(BadParameter): | ||
| Uint64ParamType().convert("-1", None, None) | ||
| with pytest.raises(BadParameter): | ||
| Uint64ParamType().convert(str(overflow_ammt), None, None) | ||
| # Test Type Failures | ||
| with pytest.raises(BadParameter): | ||
| Uint64ParamType().convert(float(0.01), None, None) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.