add blurb in @truffle/contract README about overloaded functions #5836
Conversation
eggplantzzz
requested review from
cds-amal,
gnidan,
haltman-at,
lsqproduction and
sukanyaparashar
packages/contract/README.md
Outdated
| ``` | ||
|
|
||
| Truffle contract (internally using web3's overloaded function resolution) will see that you input a string and | ||
| call the second method in the contract to set `myString`. Again however, sometimes when your contract is more |
There was a problem hiding this comment.
Hahaha you wish! Web3's overload resolution only works reliably when the functions have different numbers of arguments. The behavior you describe here is obviously what ought to actually happen, but not necessarily what actually will. In reality there's a decent chance that Web3 tries to go with the integer function anyway and then just errors on you because the input wasn't an integer like expected. This is why I keep saying it's so bad, and the primary reason I created Truffle Encoder with the hope of replacing this!
There was a problem hiding this comment.
Oh I didn't realize it was primarily based on number of arguments. Bummer, I'll update this blurb here. I wonder how easy it would be to create our own shim/adapter-thingy for this...
No description provided.