def test_error_when_invalid_args_kwargs_combo_provided():
with pytest.raises(TypeError):
merge_args_and_kwargs(GENERATED_FUNCTION_ABI, (
1,
2,
), {
'a': 1,
'b': 2
})
def get_function_info(
fn_name: str,
abi_codec: ABICodec,
contract_abi: Optional[ABI] = None,
fn_abi: Optional[ABIFunction] = None,
args: Optional[Sequence[Any]] = None,
kwargs: Optional[Any] = None,
) -> Tuple[ABIFunction, HexStr, Tuple[Any, ...]]:
if args is None:
args = tuple()
if kwargs is None:
kwargs = {}
if fn_abi is None:
fn_abi = find_matching_fn_abi(contract_abi, abi_codec, fn_name, args,
kwargs)
# typed dict cannot be used w/ a normal Dict
# https://github.com/python/mypy/issues/4976
fn_selector = encode_hex(
function_abi_to_4byte_selector(fn_abi)) # type: ignore
fn_arguments = merge_args_and_kwargs(fn_abi, args, kwargs)
_, aligned_fn_arguments = get_aligned_abi_inputs(fn_abi, fn_arguments)
return fn_abi, fn_selector, aligned_fn_arguments
def get_function_info(fn_name, contract_abi=None, fn_abi=None, args=None, kwargs=None):
if args is None:
args = tuple()
if kwargs is None:
kwargs = {}
if fn_abi is None:
fn_abi = find_matching_fn_abi(contract_abi, fn_name, args, kwargs)
fn_selector = encode_hex(function_abi_to_4byte_selector(fn_abi))
fn_arguments = merge_args_and_kwargs(fn_abi, args, kwargs)
return fn_abi, fn_selector, fn_arguments
def _set_function_info(self):
if not self.abi:
self.abi = find_matching_fn_abi(self.contract_abi,
self.function_identifier,
self.args, self.kwargs)
if self.function_identifier is FallbackFn:
self.selector = encode_hex(b'')
elif is_text(self.function_identifier):
self.selector = encode_hex(function_abi_to_4byte_selector(
self.abi))
else:
raise TypeError("Unsupported function identifier")
self.arguments = merge_args_and_kwargs(self.abi, self.args,
self.kwargs)
def _set_function_info(self):
if not self.abi:
self.abi = find_matching_fn_abi(
self.contract_abi,
self.function_identifier,
self.args,
self.kwargs
)
if self.function_identifier is FallbackFn:
self.selector = encode_hex(b'')
elif is_text(self.function_identifier):
self.selector = encode_hex(function_abi_to_4byte_selector(self.abi))
else:
raise TypeError("Unsupported function identifier")
self.arguments = merge_args_and_kwargs(self.abi, self.args, self.kwargs)
def _encode_data_in_transaction(self, *args, **kwargs):
constructor_abi = get_constructor_abi(self.abi)
if constructor_abi:
if not args:
args = tuple()
if not kwargs:
kwargs = {}
arguments = merge_args_and_kwargs(constructor_abi, args, kwargs)
data = add_0x_prefix(
encode_abi(self.web3, constructor_abi, arguments, data=self.bytecode)
)
else:
data = to_hex(self.bytecode)
return data
def encode_constructor_arguments(web3: Web3,
constructor_function: ContractConstructor,
*constructor_args,
**constructor_kwargs) -> HexStr:
"""
Takes a web3 constructor function and the arguments passed to it, and produces an encoding hex string
of the constructor arguments, following the standard ABI encoding conventions.
If there's no constructor, it returns None.
"""
constructor_abi = get_constructor_abi(constructor_function.abi)
if constructor_abi:
arguments = merge_args_and_kwargs(constructor_abi, constructor_args,
constructor_kwargs)
data = encode_abi(web3, constructor_abi, arguments)
else:
data = None
return data
def _encode_data_in_transaction(self, *args, **kwargs):
constructor_abi = get_constructor_abi(self.abi)
if constructor_abi:
if not args:
args = tuple()
if not kwargs:
kwargs = {}
arguments = merge_args_and_kwargs(constructor_abi, args, kwargs)
data = add_0x_prefix(
encode_abi(self.web3, constructor_abi, arguments, data=self.bytecode)
)
else:
data = to_hex(self.bytecode)
return data
def _encode_constructor_data(cls, args=None, kwargs=None):
constructor_abi = get_constructor_abi(cls.abi)
if constructor_abi:
if args is None:
args = tuple()
if kwargs is None:
kwargs = {}
arguments = merge_args_and_kwargs(constructor_abi, args, kwargs)
deploy_data = add_0x_prefix(
encode_abi(cls.web3, constructor_abi, arguments, data=cls.bytecode)
)
else:
deploy_data = to_hex(cls.bytecode)
return deploy_data
def _encode_constructor_data(cls, args=None, kwargs=None):
constructor_abi = get_constructor_abi(cls.abi)
if constructor_abi:
if args is None:
args = tuple()
if kwargs is None:
kwargs = {}
arguments = merge_args_and_kwargs(constructor_abi, args, kwargs)
deploy_data = add_0x_prefix(
encode_abi(cls.web3, constructor_abi, arguments, data=cls.bytecode)
)
else:
deploy_data = to_hex(cls.bytecode)
return deploy_data
def get_function_info(fn_name,
contract_abi=None,
fn_abi=None,
args=None,
kwargs=None):
if args is None:
args = tuple()
if kwargs is None:
kwargs = {}
if fn_abi is None:
fn_abi = find_matching_fn_abi(contract_abi, fn_name, args, kwargs)
fn_selector = encode_hex(function_abi_to_4byte_selector(fn_abi))
fn_arguments = merge_args_and_kwargs(fn_abi, args, kwargs)
return fn_abi, fn_selector, fn_arguments
def _encode_constructor_data(cls, args=None, kwargs=None):
constructor_abi = get_constructor_abi(cls.abi)
if constructor_abi:
if args is None:
args = tuple()
if kwargs is None:
kwargs = {}
arguments = merge_args_and_kwargs(constructor_abi, args, kwargs)
deploy_data = add_0x_prefix(
encode_abi(cls.web3, constructor_abi, arguments, data=cls.bytecode)
)
else:
if args is not None or kwargs is not None:
msg = "Constructor args were provided, but no constructor function was provided."
raise TypeError(msg)
deploy_data = to_hex(cls.bytecode)
return deploy_data
def get_function_info(
fn_name: str,
abi_codec: ABICodec,
contract_abi: ABI = None,
fn_abi: ABIFunction = None,
args: Sequence[Any] = None,
kwargs: Any = None,
) -> Tuple[ABIFunction, HexStr, Sequence[Any]]:
if args is None:
args = tuple()
if kwargs is None:
kwargs = {}
if fn_abi is None:
fn_abi = find_matching_fn_abi(contract_abi, abi_codec, fn_name, args,
kwargs)
fn_selector = encode_hex(function_abi_to_4byte_selector(fn_abi))
fn_arguments = merge_args_and_kwargs(fn_abi, args, kwargs)
_, aligned_fn_arguments = get_aligned_abi_inputs(fn_abi, fn_arguments)
return fn_abi, fn_selector, aligned_fn_arguments
def test_merging_of_args_and_kwargs(args, kwargs, expected_args):
actual_args = merge_args_and_kwargs(FUNCTION_ABI, args, kwargs)
assert actual_args == expected_args
def test_merging_of_args_and_kwargs_with_no_inputs():
actual = merge_args_and_kwargs(NO_INPUTS_FUNCTION_ABI, tuple(), {})
assert actual == tuple()
def test_kwargs_is_disallowed_when_merging_with_unnamed_inputs():
with pytest.raises(TypeError):
merge_args_and_kwargs(GENERATED_FUNCTION_ABI, tuple(), {'x': 1, 'y': 2})
def test_args_works_when_merging_with_unnamed_inputs():
actual = merge_args_and_kwargs(GENERATED_FUNCTION_ABI, (1, 2), {})
assert actual == (1, 2)
def test_args_allowed_when_duplicate_named_inputs():
actual = merge_args_and_kwargs(DUPLICATE_NAMES_FUNCTION_ABI, (1, 2, 3), {})
assert actual == (1, 2, 3)
def test_args_allowed_when_duplicate_named_inputs():
actual = merge_args_and_kwargs(DUPLICATE_NAMES_FUNCTION_ABI, (1, 2, 3), {})
assert actual == (1, 2, 3)
def test_kwargs_allowed_if_no_intersections_with_duplicate_input_names():
with pytest.raises(TypeError):
merge_args_and_kwargs(DUPLICATE_NAMES_FUNCTION_ABI, (1,), {'a': 2, 'b': 3})
def test_merging_of_args_and_kwargs_with_no_inputs():
actual = merge_args_and_kwargs(NO_INPUTS_FUNCTION_ABI, tuple(), {})
assert actual == tuple()
def test_error_when_invalid_args_kwargs_combo_provided():
with pytest.raises(TypeError):
merge_args_and_kwargs(GENERATED_FUNCTION_ABI, (1, 2,), {'a': 1, 'b': 2})
def test_kwargs_is_disallowed_when_merging_with_unnamed_inputs():
with pytest.raises(TypeError):
merge_args_and_kwargs(GENERATED_FUNCTION_ABI, tuple(), {
'x': 1,
'y': 2
})
def test_kwargs_allowed_if_no_intersections_with_duplicate_input_names():
with pytest.raises(TypeError):
merge_args_and_kwargs(DUPLICATE_NAMES_FUNCTION_ABI, (1, ), {
'a': 2,
'b': 3
})
def test_merging_of_args_and_kwargs(args, kwargs, expected_args):
actual_args = merge_args_and_kwargs(FUNCTION_ABI, args, kwargs)
assert actual_args == expected_args
def test_args_works_when_merging_with_unnamed_inputs():
actual = merge_args_and_kwargs(GENERATED_FUNCTION_ABI, (1, 2), {})
assert actual == (1, 2)
