1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796
//! Methods expansion
use super::{structs::expand_struct, types, Context};
use crate::util;
use ethers_core::{
abi::{Function, FunctionExt, Param, ParamType},
macros::{ethers_contract_crate, ethers_core_crate},
types::Selector,
};
use eyre::{Context as _, Result};
use inflector::Inflector;
use proc_macro2::{Literal, TokenStream};
use quote::quote;
use std::collections::{btree_map::Entry, BTreeMap, HashMap, HashSet};
use syn::Ident;
/// The maximum amount of overloaded functions that are attempted to auto aliased with their param
/// name. If there is a function that with `NAME_ALIASING_OVERLOADED_FUNCTIONS_CAP` overloads then
/// all functions are aliased with their index, like `log0, log1, log2,....`
const NAME_ALIASING_OVERLOADED_FUNCTIONS_CAP: usize = 3;
/// Expands a context into a method struct containing all the generated bindings
/// to the Solidity contract methods.
impl Context {
/// Expands all method implementations
pub(crate) fn methods_and_call_structs(&self) -> Result<(TokenStream, TokenStream)> {
let aliases = self.get_method_aliases()?;
let sorted_functions: BTreeMap<_, _> = self.abi.functions.iter().collect();
let functions = sorted_functions
.values()
.flat_map(std::ops::Deref::deref)
.map(|function| {
let signature = function.abi_signature();
self.expand_function(function, aliases.get(&signature).cloned())
.wrap_err_with(|| eyre::eyre!("error expanding function '{signature}'"))
})
.collect::<Result<Vec<_>>>()?;
let function_impls = quote! { #( #functions )* };
let call_structs = self.expand_call_structs(aliases.clone())?;
let return_structs = self.expand_return_structs(aliases)?;
let all_structs = quote! {
#call_structs
#return_structs
};
Ok((function_impls, all_structs))
}
/// Returns all deploy (constructor) implementations
#[cfg(feature = "providers")]
pub(crate) fn deployment_methods(&self) -> Option<TokenStream> {
// don't generate deploy if no bytecode
self.contract_bytecode.as_ref()?;
let ethers_core = ethers_core_crate();
let ethers_contract = ethers_contract_crate();
let abi_name = self.inline_abi_ident();
let get_abi = quote! {
#abi_name.clone()
};
let bytecode_name = self.inline_bytecode_ident();
let get_bytecode = quote! {
#bytecode_name.clone().into()
};
Some(quote! {
/// Constructs the general purpose `Deployer` instance based on the provided constructor arguments and sends it.
/// Returns a new instance of a deployer that returns an instance of this contract after sending the transaction
///
/// Notes:
/// - If there are no constructor arguments, you should pass `()` as the argument.
/// - The default poll duration is 7 seconds.
/// - The default number of confirmations is 1 block.
///
///
/// # Example
///
/// Generate contract bindings with `abigen!` and deploy a new contract instance.
///
/// *Note*: this requires a `bytecode` and `abi` object in the `greeter.json` artifact.
///
/// ```ignore
/// # async fn deploy<M: ethers::providers::Middleware>(client: ::std::sync::Arc<M>) {
/// abigen!(Greeter, "../greeter.json");
///
/// let greeter_contract = Greeter::deploy(client, "Hello world!".to_string()).unwrap().send().await.unwrap();
/// let msg = greeter_contract.greet().call().await.unwrap();
/// # }
/// ```
pub fn deploy<T: #ethers_core::abi::Tokenize>(
client: ::std::sync::Arc<M>,
constructor_args: T,
) -> ::core::result::Result<#ethers_contract::builders::ContractDeployer<M, Self>, #ethers_contract::ContractError<M>> {
let factory = #ethers_contract::ContractFactory::new(#get_abi, #get_bytecode, client);
let deployer = factory.deploy(constructor_args)?;
let deployer = #ethers_contract::ContractDeployer::new(deployer);
Ok(deployer)
}
})
}
/// Expands to the corresponding struct type based on the inputs of the given function
fn expand_call_struct(
&self,
function: &Function,
alias: Option<&MethodAlias>,
) -> Result<TokenStream> {
let struct_name = expand_call_struct_name(function, alias);
let fields = self.expand_input_params(function)?;
// expand as a tuple if all fields are anonymous
let all_anonymous_fields = function.inputs.iter().all(|input| input.name.is_empty());
let call_type_definition = expand_struct(&struct_name, &fields, all_anonymous_fields);
let function_name = &function.name;
let abi_signature = function.abi_signature();
let doc_str = format!(
"Container type for all input parameters for the `{function_name}` function with signature `{abi_signature}` and selector `0x{}`",
hex::encode(function.selector())
);
let mut derives = self.expand_extra_derives();
let params = function.inputs.iter().map(|param| ¶m.kind);
util::derive_builtin_traits(params, &mut derives, true, true);
let ethers_contract = ethers_contract_crate();
Ok(quote! {
#[doc = #doc_str]
#[derive(Clone, #ethers_contract::EthCall, #ethers_contract::EthDisplay, #derives)]
#[ethcall( name = #function_name, abi = #abi_signature )]
pub #call_type_definition
})
}
/// Expands to the corresponding struct type based on the inputs of the given function
pub fn expand_return_struct(
&self,
function: &Function,
alias: Option<&MethodAlias>,
) -> Result<Option<TokenStream>> {
// no point in having structs when there is no data returned
if function.outputs.is_empty() {
return Ok(None)
}
let name = &function.name;
let struct_name = expand_return_struct_name(function, alias);
let fields = self.expand_output_params(function)?;
// expand as a tuple if all fields are anonymous
let all_anonymous_fields = function.outputs.iter().all(|output| output.name.is_empty());
let return_type_definition = expand_struct(&struct_name, &fields, all_anonymous_fields);
let abi_signature = function.abi_signature();
let doc_str = format!(
"Container type for all return fields from the `{name}` function with signature `{abi_signature}` and selector `0x{}`",
hex::encode(function.selector())
);
let mut derives = self.expand_extra_derives();
let params = function.outputs.iter().map(|param| ¶m.kind);
util::derive_builtin_traits(params, &mut derives, true, true);
let ethers_contract = ethers_contract_crate();
Ok(Some(quote! {
#[doc = #doc_str]
#[derive(Clone, #ethers_contract::EthAbiType, #ethers_contract::EthAbiCodec, #derives)]
pub #return_type_definition
}))
}
/// Expands all call structs
fn expand_call_structs(&self, aliases: BTreeMap<String, MethodAlias>) -> Result<TokenStream> {
let len = self.abi.functions.len();
let mut struct_defs = Vec::with_capacity(len);
let mut struct_names = Vec::with_capacity(len);
let mut variant_names = Vec::with_capacity(len);
for function in self.abi.functions.values().flatten() {
let signature = function.abi_signature();
let alias = aliases.get(&signature);
struct_defs.push(self.expand_call_struct(function, alias)?);
struct_names.push(expand_call_struct_name(function, alias));
variant_names.push(expand_call_struct_variant_name(function, alias));
}
let struct_def_tokens = quote!(#(#struct_defs)*);
if struct_defs.len() <= 1 {
// no need for an enum
return Ok(struct_def_tokens)
}
let mut derives = self.expand_extra_derives();
let params =
self.abi.functions.values().flatten().flat_map(|f| &f.inputs).map(|param| ¶m.kind);
util::derive_builtin_traits(params, &mut derives, false, true);
let enum_name = self.expand_calls_enum_name();
let ethers_core = ethers_core_crate();
let ethers_contract = ethers_contract_crate();
let tokens = quote! {
#struct_def_tokens
#[doc = "Container type for all of the contract's call "]
#[derive(Clone, #ethers_contract::EthAbiType, #derives)]
pub enum #enum_name {
#( #variant_names(#struct_names), )*
}
impl #ethers_core::abi::AbiDecode for #enum_name {
fn decode(data: impl AsRef<[u8]>) -> ::core::result::Result<Self, #ethers_core::abi::AbiError> {
let data = data.as_ref();
#(
if let Ok(decoded) = <#struct_names as #ethers_core::abi::AbiDecode>::decode(data) {
return Ok(Self::#variant_names(decoded))
}
)*
Err(#ethers_core::abi::Error::InvalidData.into())
}
}
impl #ethers_core::abi::AbiEncode for #enum_name {
fn encode(self) -> Vec<u8> {
match self {
#(
Self::#variant_names(element) => #ethers_core::abi::AbiEncode::encode(element),
)*
}
}
}
impl ::core::fmt::Display for #enum_name {
fn fmt(&self, f: &mut ::core::fmt::Formatter<'_>) -> ::core::fmt::Result {
match self {
#(
Self::#variant_names(element) => ::core::fmt::Display::fmt(element, f),
)*
}
}
}
#(
impl ::core::convert::From<#struct_names> for #enum_name {
fn from(value: #struct_names) -> Self {
Self::#variant_names(value)
}
}
)*
};
Ok(tokens)
}
/// Expands all return structs
fn expand_return_structs(&self, aliases: BTreeMap<String, MethodAlias>) -> Result<TokenStream> {
let mut tokens = TokenStream::new();
for function in self.abi.functions.values().flatten() {
let signature = function.abi_signature();
let alias = aliases.get(&signature);
match self.expand_return_struct(function, alias) {
Ok(Some(def)) => tokens.extend(def),
Ok(None) => {}
Err(e) => return Err(e),
}
}
Ok(tokens)
}
/// The name ident of the calls enum
fn expand_calls_enum_name(&self) -> Ident {
util::ident(&format!("{}Calls", self.contract_ident))
}
/// Expands to the `name : type` pairs of the function's inputs
fn expand_input_params(&self, fun: &Function) -> Result<Vec<(TokenStream, TokenStream)>> {
types::expand_params(&fun.inputs, |p| {
self.internal_structs.get_function_input_struct_type(&fun.name, &p.name)
})
}
/// Expands to the `name: type` pairs of the function's outputs
fn expand_output_params(&self, fun: &Function) -> Result<Vec<(TokenStream, TokenStream)>> {
types::expand_params(&fun.outputs, |p| {
p.internal_type
.as_deref()
.and_then(|s| self.internal_structs.get_function_output_struct_type(&fun.name, s))
})
}
/// Expands the arguments for the call that eventually calls the contract
fn expand_contract_call_args(&self, fun: &Function) -> TokenStream {
let mut call_args = fun.inputs.iter().enumerate().map(|(idx, param)| {
let name = util::expand_input_name(idx, ¶m.name);
match param.kind {
// this is awkward edge case where the function inputs are a single struct
// we need to force this argument into a tuple so it gets expanded to
// `((#name,))` this is currently necessary because
// internally `flatten_tokens` is called which removes the
// outermost `tuple` level and since `((#name))` is not
// a rust tuple it doesn't get wrapped into another tuple that will be peeled
// off by `flatten_tokens`
ParamType::Tuple(_) if fun.inputs.len() == 1 => {
// make sure the tuple gets converted to `Token::Tuple`
quote!((#name,))
}
_ => name,
}
});
match fun.inputs.len() {
0 => quote!(()),
1 => call_args.next().unwrap(),
_ => quote!(( #( #call_args ),* )),
}
}
/// Expands a single function with the given alias
fn expand_function(
&self,
function: &Function,
alias: Option<MethodAlias>,
) -> Result<TokenStream> {
let name = &function.name;
let function_name = expand_function_name(function, alias.as_ref());
let selector = function.selector();
let selector_tokens = expand_selector(selector);
let contract_args = self.expand_contract_call_args(function);
let function_params =
self.expand_input_params(function)?.into_iter().map(|(name, ty)| quote! { #name: #ty });
let function_params = quote! { #( , #function_params )* };
let outputs = {
let mut out = self.expand_output_params(function)?;
match out.len() {
0 => quote!(()),
1 => out.pop().unwrap().1,
_ => {
let iter = out.into_iter().map(|(_, ty)| ty);
quote!(( #( #iter ),* ))
}
}
};
let doc_str =
format!("Calls the contract's `{name}` (0x{}) function", hex::encode(selector));
let ethers_contract = ethers_contract_crate();
Ok(quote! {
#[doc = #doc_str]
pub fn #function_name(&self #function_params) -> #ethers_contract::builders::ContractCall<M, #outputs> {
self.0.method_hash(#selector_tokens, #contract_args)
.expect("method not found (this should never happen)")
}
})
}
/// Returns the method aliases, either configured by the user or determined
/// based on overloaded functions.
///
/// In case of overloaded functions we would follow rust's general
/// convention of suffixing the function name with _with
///
/// The first function or the function with the least amount of arguments should
/// be named as in the ABI, the following functions suffixed with:
/// `_with_ + additional_params[0].name + (_and_(additional_params[1+i].name))*`
fn get_method_aliases(&self) -> Result<BTreeMap<String, MethodAlias>> {
let mut aliases = self.method_aliases.clone();
// it might be the case that there are functions with different capitalization so we sort
// them all by lc name first
let mut all_functions = HashMap::new();
for function in self.abi.functions() {
all_functions
.entry(util::safe_snake_case_ident(&function.name))
.or_insert_with(Vec::new)
.push(function);
}
// find all duplicates, where no aliases where provided
for functions in all_functions.values() {
if functions.iter().filter(|f| !aliases.contains_key(&f.abi_signature())).count() <= 1 {
// no overloads, hence no conflicts
continue
}
let num_functions = functions.len();
// sort functions by number of inputs asc
let mut functions = functions.iter().enumerate().collect::<Vec<_>>();
functions.sort_by(|(_, f1), (_, f2)| f1.inputs.len().cmp(&f2.inputs.len()));
// the `functions` are now mapped with their index as defined in the ABI, but
// we always want the zero arg function (`log()`) to be `log0`
for (idx, (f_idx, _)) in functions.iter_mut().enumerate() {
*f_idx = idx;
}
// the first function will be the function with the least amount of inputs, like log()
// and is the baseline for the diff
let (first_fun_idx, first_fun) = functions[0];
// assuming here that if there is an overloaded function with nameless params like
// `log;, log(string); log(string, string)` `log()` it should also be
// aliased as well with its index to `log0`
let mut needs_alias_for_first_fun_using_idx = false;
// all the overloaded functions together with their diffs compare to the `first_fun`
let mut diffs = Vec::new();
/// helper function that checks if there are any conflicts due to parameter names
fn name_conflicts(idx: usize, diffs: &[(usize, Vec<&Param>, &&Function)]) -> bool {
let diff = &diffs.iter().find(|(i, _, _)| *i == idx).expect("diff exists").1;
for (_, other, _) in diffs.iter().filter(|(i, _, _)| *i != idx) {
let (a, b) =
if other.len() > diff.len() { (other, diff) } else { (diff, other) };
if a.iter()
.all(|d| b.iter().any(|o| o.name.to_snake_case() == d.name.to_snake_case()))
{
return true
}
}
false
}
// compare each overloaded function with the `first_fun`
for (idx, overloaded_fun) in functions.into_iter().skip(1) {
// keep track of matched params
let mut already_matched_param_diff = HashSet::new();
// attempt to find diff in the input arguments
let mut diff = Vec::new();
let mut same_params = true;
for (idx, i1) in overloaded_fun.inputs.iter().enumerate() {
// Find the first param that differs and hasn't already been matched as diff
if let Some((pos, _)) = first_fun
.inputs
.iter()
.enumerate()
.filter(|(pos, _)| !already_matched_param_diff.contains(pos))
.find(|(_, i2)| i1 != *i2)
{
already_matched_param_diff.insert(pos);
diff.push(i1);
same_params = false;
} else {
// check for cases like `log(string); log(string, string)` by keep track of
// same order
if same_params && idx + 1 > first_fun.inputs.len() {
diff.push(i1);
}
}
}
diffs.push((idx, diff, overloaded_fun));
}
for (idx, diff, overloaded_fun) in &diffs {
let alias = match diff.len() {
0 => {
// this may happen if there are functions with different casing,
// like `INDEX`and `index`
// this should not happen since functions with same
// name and inputs are illegal
eyre::ensure!(
overloaded_fun.name != first_fun.name,
"Function with same name and parameter types defined twice: {}",
overloaded_fun.name
);
let overloaded_id = overloaded_fun.name.to_snake_case();
let first_fun_id = first_fun.name.to_snake_case();
if first_fun_id != overloaded_id {
// no conflict
overloaded_id
} else {
let overloaded_alias = MethodAlias {
function_name: util::safe_ident(&overloaded_fun.name),
struct_name: util::safe_ident(&overloaded_fun.name),
};
aliases.insert(overloaded_fun.abi_signature(), overloaded_alias);
let first_fun_alias = MethodAlias {
function_name: util::safe_ident(&first_fun.name),
struct_name: util::safe_ident(&first_fun.name),
};
aliases.insert(first_fun.abi_signature(), first_fun_alias);
continue
}
}
1 => {
// single additional input params
if diff[0].name.is_empty() ||
num_functions > NAME_ALIASING_OVERLOADED_FUNCTIONS_CAP ||
name_conflicts(*idx, &diffs)
{
needs_alias_for_first_fun_using_idx = true;
format!("{}{idx}", overloaded_fun.name.to_snake_case())
} else {
format!(
"{}_with_{}",
overloaded_fun.name.to_snake_case(),
diff[0].name.to_snake_case()
)
}
}
_ => {
if diff.iter().any(|d| d.name.is_empty()) ||
num_functions > NAME_ALIASING_OVERLOADED_FUNCTIONS_CAP ||
name_conflicts(*idx, &diffs)
{
needs_alias_for_first_fun_using_idx = true;
format!("{}{idx}", overloaded_fun.name.to_snake_case())
} else {
// 1 + n additional input params
let and = diff
.iter()
.skip(1)
.map(|i| i.name.to_snake_case())
.collect::<Vec<_>>()
.join("_and_");
format!(
"{}_with_{}_and_{}",
overloaded_fun.name.to_snake_case(),
diff[0].name.to_snake_case(),
and
)
}
}
};
let alias = MethodAlias::new(&alias);
aliases.insert(overloaded_fun.abi_signature(), alias);
}
if needs_alias_for_first_fun_using_idx {
// insert an alias for the root duplicated call
let prev_alias = format!("{}{first_fun_idx}", first_fun.name.to_snake_case());
let alias = MethodAlias::new(&prev_alias);
aliases.insert(first_fun.abi_signature(), alias);
}
}
// we have to handle the edge cases with underscore prefix and suffix that would get
// stripped by Inflector::to_snake_case/pascalCase if there is another function that
// would collide we manually add an alias for it eg. abi = ["_a(), a(), a_(),
// _a_()"] will generate identical rust functions
for (name, functions) in self.abi.functions.iter() {
if name.starts_with('_') || name.ends_with('_') {
let ident = name.trim_matches('_').trim_end_matches('_');
// check for possible collisions after Inflector would remove the underscores
if self.abi.functions.contains_key(ident) {
for function in functions {
if let Entry::Vacant(entry) = aliases.entry(function.abi_signature()) {
// use the full name as alias
entry.insert(MethodAlias::new(name.as_str()));
}
}
}
}
}
Ok(aliases)
}
}
fn expand_selector(selector: Selector) -> TokenStream {
let bytes = selector.iter().copied().map(Literal::u8_unsuffixed);
quote!([ #( #bytes ),* ])
}
/// Represents the aliases to use when generating method related elements
#[derive(Debug, Clone)]
pub struct MethodAlias {
pub function_name: Ident,
pub struct_name: Ident,
}
impl MethodAlias {
pub fn new(alias: &str) -> Self {
MethodAlias {
function_name: util::safe_snake_case_ident(alias),
struct_name: util::safe_pascal_case_ident(alias),
}
}
}
fn expand_function_name(function: &Function, alias: Option<&MethodAlias>) -> Ident {
if let Some(alias) = alias {
alias.function_name.clone()
} else {
util::safe_ident(&util::safe_snake_case(&function.name))
}
}
/// Expands the name of a struct by a postfix
fn expand_struct_name_postfix(
function: &Function,
alias: Option<&MethodAlias>,
postfix: &str,
) -> Ident {
let name = if let Some(alias) = alias {
format!("{}{postfix}", alias.struct_name)
} else {
format!("{}{postfix}", util::safe_pascal_case(&function.name))
};
util::ident(&name)
}
/// Expands to the name of the call struct
fn expand_call_struct_name(function: &Function, alias: Option<&MethodAlias>) -> Ident {
expand_struct_name_postfix(function, alias, "Call")
}
/// Expands to the name of the return struct
fn expand_return_struct_name(function: &Function, alias: Option<&MethodAlias>) -> Ident {
expand_struct_name_postfix(function, alias, "Return")
}
/// Expands to the name of the call struct
fn expand_call_struct_variant_name(function: &Function, alias: Option<&MethodAlias>) -> Ident {
if let Some(alias) = alias {
alias.struct_name.clone()
} else {
util::safe_ident(&util::safe_pascal_case(&function.name))
}
}
#[cfg(test)]
mod tests {
use super::*;
fn expand_fn_outputs(outputs: &[Param]) -> Result<TokenStream> {
match outputs.len() {
0 => Ok(quote! { () }),
1 => types::expand(&outputs[0].kind),
_ => {
let types = outputs
.iter()
.map(|param| types::expand(¶m.kind))
.collect::<Result<Vec<_>>>()?;
Ok(quote! { (#( #types ),*) })
}
}
}
// packs the argument in a tuple to be used for the contract call
fn expand_inputs_call_arg(inputs: &[Param]) -> TokenStream {
let names = inputs
.iter()
.enumerate()
.map(|(i, param)| {
let name = util::expand_input_name(i, ¶m.name);
match param.kind {
// this is awkward edge case where the function inputs are a single struct
// we need to force this argument into a tuple so it gets expanded to
// `((#name,))` this is currently necessary because
// internally `flatten_tokens` is called which removes the outermost `tuple`
// level and since `((#name))` is not a rust tuple it
// doesn't get wrapped into another tuple that will be peeled off by
// `flatten_tokens`
ParamType::Tuple(_) if inputs.len() == 1 => {
// make sure the tuple gets converted to `Token::Tuple`
quote! {(#name,)}
}
_ => name,
}
})
.collect::<Vec<TokenStream>>();
match names.len() {
0 => quote! { () },
1 => quote! { #( #names )* },
_ => quote! { ( #(#names, )* ) },
}
}
// converts the function params to name/type pairs
fn expand_inputs(inputs: &[Param]) -> Result<TokenStream> {
let params = inputs
.iter()
.enumerate()
.map(|(i, param)| {
let name = util::expand_input_name(i, ¶m.name);
let kind = types::expand(¶m.kind)?;
Ok(quote! { #name: #kind })
})
.collect::<Result<Vec<_>>>()?;
Ok(quote! { #( , #params )* })
}
#[test]
fn test_expand_inputs_call_arg() {
// no inputs
let params = vec![];
let token_stream = expand_inputs_call_arg(¶ms);
assert_eq!(token_stream.to_string(), "()");
// single input
let params = vec![Param {
name: "arg_a".to_string(),
kind: ParamType::Address,
internal_type: None,
}];
let token_stream = expand_inputs_call_arg(¶ms);
assert_eq!(token_stream.to_string(), "arg_a");
// two inputs
let params = vec![
Param { name: "arg_a".to_string(), kind: ParamType::Address, internal_type: None },
Param {
name: "arg_b".to_string(),
kind: ParamType::Uint(256usize),
internal_type: None,
},
];
let token_stream = expand_inputs_call_arg(¶ms);
assert_eq!(token_stream.to_string(), "(arg_a , arg_b ,)");
// three inputs
let params = vec![
Param { name: "arg_a".to_string(), kind: ParamType::Address, internal_type: None },
Param {
name: "arg_b".to_string(),
kind: ParamType::Uint(128usize),
internal_type: None,
},
Param { name: "arg_c".to_string(), kind: ParamType::Bool, internal_type: None },
];
let token_stream = expand_inputs_call_arg(¶ms);
assert_eq!(token_stream.to_string(), "(arg_a , arg_b , arg_c ,)");
}
#[test]
fn expand_inputs_empty() {
assert_quote!(expand_inputs(&[]).unwrap().to_string(), {},);
}
#[test]
fn test_expand_inputs() {
assert_quote!(
expand_inputs(&[
Param {
name: "a".to_string(),
kind: ParamType::Bool,
internal_type: None,
},
Param {
name: "b".to_string(),
kind: ParamType::Address,
internal_type: None,
},
])
.unwrap(),
{ , a: bool, b: ::ethers_core::types::Address },
);
}
#[test]
fn expand_fn_outputs_empty() {
assert_quote!(expand_fn_outputs(&[]).unwrap(), { () });
}
#[test]
fn expand_fn_outputs_single() {
assert_quote!(
expand_fn_outputs(&[Param {
name: "a".to_string(),
kind: ParamType::Bool,
internal_type: None,
}])
.unwrap(),
{ bool },
);
}
#[test]
fn expand_fn_outputs_multiple() {
assert_quote!(
expand_fn_outputs(&[
Param { name: "a".to_string(), kind: ParamType::Bool, internal_type: None },
Param { name: "b".to_string(), kind: ParamType::Address, internal_type: None },
])
.unwrap(),
{ (bool, ::ethers_core::types::Address) },
);
}
}