# Python Substrate Interface Library # # Copyright 2018-2020 Stichting Polkascan (Polkascan Foundation). # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. import os import unittest from scalecodec import ScaleBytes from substrateinterface import SubstrateInterface, ContractMetadata, ContractInstance, Keypair, ContractEvent from substrateinterface.exceptions import ContractMetadataParseException from test import settings class ContractMetadataTestCase(unittest.TestCase): @classmethod def setUpClass(cls): cls.substrate = SubstrateInterface(url=settings.KUSAMA_NODE_URL) def setUp(self) -> None: self.contract_metadata = ContractMetadata.create_from_file( metadata_file=os.path.join(os.path.dirname(__file__), 'fixtures', 'erc20-v0.json'), substrate=self.substrate ) def test_metadata_parsed(self): self.assertNotEqual(self.contract_metadata.metadata_dict, {}) def test_incorrect_metadata_file(self): with self.assertRaises(ContractMetadataParseException): ContractMetadata.create_from_file( metadata_file=os.path.join(os.path.dirname(__file__), 'fixtures', 'incorrect_metadata.json'), substrate=self.substrate ) def test_extract_typestring_from_types(self): self.assertEqual('u128', self.contract_metadata.get_type_string_for_metadata_type(1)) self.assertEqual('AccountId', self.contract_metadata.get_type_string_for_metadata_type(5)) self.assertEqual('[u8; 32]', self.contract_metadata.get_type_string_for_metadata_type(6)) self.assertEqual('Option', self.contract_metadata.get_type_string_for_metadata_type(15)) def test_invalid_type_id(self): with self.assertRaises(ValueError) as cm: self.contract_metadata.get_type_string_for_metadata_type(99) self.assertEqual('type_id 99 not found in metadata', str(cm.exception)) def test_contract_types_added_type_registry(self): for type_id in range(1, 16): type_string = self.contract_metadata.get_type_string_for_metadata_type(type_id) if type_string != '()': self.assertIsNotNone(self.substrate.runtime_config.get_decoder_class(type_string)) def test_return_type_for_message(self): self.assertEqual('u128', self.contract_metadata.get_return_type_string_for_message('total_supply')) self.assertEqual('u128', self.contract_metadata.get_return_type_string_for_message('balance_of')) self.assertEqual( 'ink::0x6e689bb2d2a19d1821177a607480a4527195b76dffec908f94ad7af0ed80c21f::12', self.contract_metadata.get_return_type_string_for_message('approve') ) def test_invalid_constructor_name(self): with self.assertRaises(ValueError) as cm: self.contract_metadata.generate_constructor_data("invalid") self.assertEqual('Constructor "invalid" not found', str(cm.exception)) def test_constructor_missing_arg(self): with self.assertRaises(ValueError) as cm: self.contract_metadata.generate_constructor_data("new", args={'test': 2}) self.assertEqual('Argument "initial_supply" is missing', str(cm.exception)) def test_constructor_data(self): scale_data = self.contract_metadata.generate_constructor_data("new", args={'initial_supply': 1000}) self.assertEqual('0xd183512be8030000000000000000000000000000', scale_data.to_hex()) def test_invalid_message_name(self): with self.assertRaises(ValueError) as cm: self.contract_metadata.generate_message_data("invalid_msg_name") self.assertEqual('Message "invalid_msg_name" not found', str(cm.exception)) def test_generate_message_data(self): scale_data = self.contract_metadata.generate_message_data("total_supply") self.assertEqual('0xdcb736b5', scale_data.to_hex()) def test_generate_message_data_with_args(self): scale_data = self.contract_metadata.generate_message_data("transfer", args={ 'to': '5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty', 'value': 10000 }) self.assertEqual( '0xfae3a09d8eaf04151687736326c9fea17e25fc5287613693c912909cb226aa4794f26a4810270000000000000000000000000000', scale_data.to_hex() ) def test_generate_message_data_missing_arg(self): with self.assertRaises(ValueError) as cm: self.contract_metadata.generate_message_data("transfer", args={ 'value': 10000 }) self.assertEqual('Argument "to" is missing', str(cm.exception)) def test_contract_event_decoding(self): contract_event_data = '0x0001d43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d018eaf04151687' + \ '736326c9fea17e25fc5287613693c912909cb226aa4794f26a480000a7dcf75015000000000000000000' contract_event_obj = ContractEvent( data=ScaleBytes(contract_event_data), runtime_config=self.substrate.runtime_config, contract_metadata=self.contract_metadata ) contract_event_obj.decode() self.assertEqual( 'HNZata7iMYWmk5RvZRTiAsSDhV8366zq2YGb3tLH5Upf74F', contract_event_obj.args[0]['value'] ) self.assertEqual( 'FoQJpPyadYccjavVdTWxpxU7rUEaYhfLCPwXgkfD6Zat9QP', contract_event_obj.args[1]['value'] ) self.assertEqual(6000000000000000, contract_event_obj.args[2]['value']) def test_unsupported_ink_env_type_handling(self): with self.assertRaises(NotImplementedError): ContractMetadata.create_from_file( metadata_file=os.path.join(os.path.dirname(__file__), 'fixtures', 'unsupported_type_metadata.json'), substrate=self.substrate ) class ContractMetadataV1TestCase(ContractMetadataTestCase): def setUp(self) -> None: self.contract_metadata = ContractMetadata.create_from_file( metadata_file=os.path.join(os.path.dirname(__file__), 'fixtures', 'erc20-v1.json'), substrate=self.substrate ) def test_metadata_parsed(self): self.assertNotEqual(self.contract_metadata.metadata_dict, {}) def test_incorrect_metadata_file(self): with self.assertRaises(ContractMetadataParseException): ContractMetadata.create_from_file( metadata_file=os.path.join(os.path.dirname(__file__), 'fixtures', 'incorrect_metadata.json'), substrate=self.substrate ) def test_extract_typestring_from_types(self): self.assertEqual( 'ink::0x418399d957539253bbabc230dffce9e131d9d2e7918edd67e9d7d3f6924e3d9e::1', self.contract_metadata.get_type_string_for_metadata_type(1) ) self.assertEqual( 'ink::0x418399d957539253bbabc230dffce9e131d9d2e7918edd67e9d7d3f6924e3d9e::5', self.contract_metadata.get_type_string_for_metadata_type(5) ) def test_invalid_type_id(self): with self.assertRaises(ValueError) as cm: self.contract_metadata.get_type_string_for_metadata_type(99) self.assertEqual('type_id 99 not found in metadata', str(cm.exception)) def test_contract_types_added_type_registry(self): for type_id in range(0, len(self.contract_metadata.metadata_dict['types'])): type_string = self.contract_metadata.get_type_string_for_metadata_type(type_id) if type_string != '()': self.assertIsNotNone(self.substrate.runtime_config.get_decoder_class(type_string)) def test_return_type_for_message(self): self.assertEqual( 'ink::0x418399d957539253bbabc230dffce9e131d9d2e7918edd67e9d7d3f6924e3d9e::0', self.contract_metadata.get_return_type_string_for_message('total_supply') ) self.assertEqual( 'ink::0x418399d957539253bbabc230dffce9e131d9d2e7918edd67e9d7d3f6924e3d9e::0', self.contract_metadata.get_return_type_string_for_message('balance_of') ) self.assertEqual( 'ink::0x418399d957539253bbabc230dffce9e131d9d2e7918edd67e9d7d3f6924e3d9e::11', self.contract_metadata.get_return_type_string_for_message('approve') ) def test_invalid_constructor_name(self): with self.assertRaises(ValueError) as cm: self.contract_metadata.generate_constructor_data("invalid") self.assertEqual('Constructor "invalid" not found', str(cm.exception)) def test_constructor_missing_arg(self): with self.assertRaises(ValueError) as cm: self.contract_metadata.generate_constructor_data("new", args={'test': 2}) self.assertEqual('Argument "initial_supply" is missing', str(cm.exception)) def test_constructor_data(self): scale_data = self.contract_metadata.generate_constructor_data("new", args={'initial_supply': 1000}) self.assertEqual('0x9bae9d5ee8030000000000000000000000000000', scale_data.to_hex()) def test_invalid_message_name(self): with self.assertRaises(ValueError) as cm: self.contract_metadata.generate_message_data("invalid_msg_name") self.assertEqual('Message "invalid_msg_name" not found', str(cm.exception)) def test_generate_message_data(self): scale_data = self.contract_metadata.generate_message_data("total_supply") self.assertEqual('0xdb6375a8', scale_data.to_hex()) def test_generate_message_data_with_args(self): scale_data = self.contract_metadata.generate_message_data("transfer", args={ 'to': '5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty', 'value': 10000 }) self.assertEqual( '0x84a15da18eaf04151687736326c9fea17e25fc5287613693c912909cb226aa4794f26a4810270000000000000000000000000000', scale_data.to_hex() ) def test_generate_message_data_missing_arg(self): with self.assertRaises(ValueError) as cm: self.contract_metadata.generate_message_data("transfer", args={ 'value': 10000 }) self.assertEqual('Argument "to" is missing', str(cm.exception)) def test_contract_event_decoding(self): contract_event_data = '0x0001d43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d018eaf04151687' + \ '736326c9fea17e25fc5287613693c912909cb226aa4794f26a480000a7dcf75015000000000000000000' contract_event_obj = ContractEvent( data=ScaleBytes(contract_event_data), runtime_config=self.substrate.runtime_config, contract_metadata=self.contract_metadata ) contract_event_obj.decode() self.assertEqual( 'HNZata7iMYWmk5RvZRTiAsSDhV8366zq2YGb3tLH5Upf74F', contract_event_obj.args[0]['value'] ) self.assertEqual( 'FoQJpPyadYccjavVdTWxpxU7rUEaYhfLCPwXgkfD6Zat9QP', contract_event_obj.args[1]['value'] ) self.assertEqual(6000000000000000, contract_event_obj.args[2]['value']) def test_unsupported_ink_env_type_handling(self): with self.assertRaises(NotImplementedError): ContractMetadata.create_from_file( metadata_file=os.path.join(os.path.dirname(__file__), 'fixtures', 'unsupported_type_metadata.json'), substrate=self.substrate ) class ContractMetadataV3TestCase(ContractMetadataV1TestCase): def setUp(self) -> None: self.contract_metadata = ContractMetadata.create_from_file( metadata_file=os.path.join(os.path.dirname(__file__), 'fixtures', 'erc20-v3.json'), substrate=self.substrate ) class FlipperMetadataV3TestCase(unittest.TestCase): @classmethod def setUpClass(cls): cls.substrate = SubstrateInterface(url=settings.KUSAMA_NODE_URL) def setUp(self) -> None: self.contract_metadata = ContractMetadata.create_from_file( metadata_file=os.path.join(os.path.dirname(__file__), 'fixtures', 'flipper-v3.json'), substrate=self.substrate ) def test_metadata_parsed(self): self.assertNotEqual(self.contract_metadata.metadata_dict, {}) def test_incorrect_metadata_file(self): with self.assertRaises(ContractMetadataParseException): ContractMetadata.create_from_file( metadata_file=os.path.join(os.path.dirname(__file__), 'fixtures', 'incorrect_metadata.json'), substrate=self.substrate ) def test_extract_typestring_from_types(self): self.assertEqual( 'ink::0xf051c631190ac47f82e280ba763df932210f6e2447978e24cbe0dcc6d6903c7a::0', self.contract_metadata.get_type_string_for_metadata_type(0) ) def test_contract_types_added_type_registry(self): type_string = self.contract_metadata.get_type_string_for_metadata_type(0) if type_string != '()': self.assertIsNotNone(self.substrate.runtime_config.get_decoder_class(type_string)) def test_return_type_for_message(self): self.assertEqual( 'ink::0xf051c631190ac47f82e280ba763df932210f6e2447978e24cbe0dcc6d6903c7a::0', self.contract_metadata.get_return_type_string_for_message('get') ) self.assertEqual('Null', self.contract_metadata.get_return_type_string_for_message('flip')) def test_constructor_data(self): scale_data = self.contract_metadata.generate_constructor_data("new", args={'init_value': True}) self.assertEqual('0x9bae9d5e01', scale_data.to_hex()) def test_generate_message_data(self): scale_data = self.contract_metadata.generate_message_data("get") self.assertEqual('0x2f865bd9', scale_data.to_hex()) def test_invalid_constructor_name(self): with self.assertRaises(ValueError) as cm: self.contract_metadata.generate_constructor_data("invalid") self.assertEqual('Constructor "invalid" not found', str(cm.exception)) def test_invalid_message_name(self): with self.assertRaises(ValueError) as cm: self.contract_metadata.generate_message_data("invalid_msg_name") self.assertEqual('Message "invalid_msg_name" not found', str(cm.exception)) class FlipperInstanceTestCase(unittest.TestCase): @classmethod def setUpClass(cls): class MockedSubstrateInterface(SubstrateInterface): def rpc_request(self, method, params, result_handler=None): if method == 'state_call': return { 'jsonrpc': '2.0', 'result': '0x7ee58accd6100100070000c0ce020200100001000000000000000000000000000000000000000000000400', 'id': 10 } if method == 'contracts_call': return { 'jsonrpc': '2.0', 'result': { 'gasConsumed': 7419127834, 'gasRequired': 74999922688, 'storageDeposit': {'charge': '0x0'}, 'debugMessage': '', 'result': {'Ok': {'flags': 0, 'data': '0x00'}} }, 'id': self.request_id} return super().rpc_request(method, params, result_handler) cls.substrate = MockedSubstrateInterface(url=settings.KUSAMA_NODE_URL, type_registry_preset='canvas') # cls.substrate = SubstrateInterface(url='ws://127.0.0.1:9944') cls.keypair = Keypair.create_from_uri('//Alice') def setUp(self) -> None: self.contract = ContractInstance.create_from_address( contract_address="5GhwarrVMH8kjb8XyW6zCfURHbHy3v84afzLbADyYYX6H2Kk", metadata_file=os.path.join(os.path.dirname(__file__), 'fixtures', 'flipper-v3.json'), substrate=self.substrate ) def test_instance_read(self): result = self.contract.read(self.keypair, 'get') self.assertEqual(False, result.contract_result_data.value) def test_instance_read_at_not_best_block(self): parent_hash = self.substrate.get_block_header()['header']['parentHash'] result = self.contract.read(self.keypair, 'get', block_hash = parent_hash) self.assertEqual(False, result.contract_result_data.value) class FlipperInstanceV4TestCase(FlipperInstanceTestCase): def setUp(self) -> None: self.contract = ContractInstance.create_from_address( contract_address="5DaohteAvvR9PZEhynqWvbFT8HEaHNuiiPTZV61VEUHnqsfU", metadata_file=os.path.join(os.path.dirname(__file__), 'fixtures', 'flipper-v4.json'), substrate=self.substrate ) class FlipperInstanceV5TestCase(FlipperInstanceTestCase): @classmethod def setUpClass(cls): class MockedSubstrateInterface(SubstrateInterface): def rpc_request(self, method, params, result_handler=None): if method == 'state_call': return { 'jsonrpc': '2.0', 'result': '0x1a987a663dbd8e5cf16786bc0100010000000000000000000000000000000000000000000008000000', 'id': 16 } if method == 'contracts_call': return { 'jsonrpc': '2.0', 'result': { 'gasConsumed': 7419127834, 'gasRequired': 74999922688, 'storageDeposit': {'charge': '0x0'}, 'debugMessage': '', 'result': {'Ok': {'flags': 0, 'data': '0x0000'}} }, 'id': self.request_id} return super().rpc_request(method, params, result_handler) cls.substrate = MockedSubstrateInterface( url=settings.KUSAMA_NODE_URL, type_registry_preset='canvas', type_registry={'types': {"ContractExecResult": "ContractExecResultTo269"}} ) cls.keypair = Keypair.create_from_uri('//Alice') def setUp(self) -> None: self.contract = ContractInstance.create_from_address( contract_address="5DaohteAvvR9PZEhynqWvbFT8HEaHNuiiPTZV61VEUHnqsfU", metadata_file=os.path.join(os.path.dirname(__file__), 'fixtures', 'flipper-v5.json'), substrate=self.substrate ) def test_instance_read(self): result = self.contract.read(self.keypair, 'get') self.assertEqual({'Ok': False}, result.contract_result_data.value) def test_instance_read_at_not_best_block(self): parent_hash = self.substrate.get_block_header()['header']['parentHash'] result = self.contract.read(self.keypair, 'get', block_hash=parent_hash) self.assertEqual({'Ok': False}, result.contract_result_data.value) if __name__ == '__main__': unittest.main()