Implement new `truffle call` command using @truffle/encoder and @truffle/decoder #5647

sukanyaparashar · 2022-10-26T06:02:58Z

PR description

This PR adds the truffle call command leveraging Truffle's encoding and decoding functionality (including overload resolution). Prior work credit: @gnidan (#5330).

Testing instructions

To test this new feature, write a smart contract inside a truffle project with a function that returns some value or you can clone this Test Project with a simple storage contract.

Run truffle develop inside a truffle project.
In the REPL, run migrate to deploy the contract.
In the REPL, run call <contract_name|contract_address> <function_name>.
In the REPL, run call <contract_name|contract_address> <function_name> <arg>.
In the REPL, run call <contract_name|contract_address> <function_name> that returns multiple values of different types.
In the REPL, run call <contract_name|contract_address> <function_signature> <arg>. NOTE: ABI-style signatures doesn't allow spaces.
In the REPL, run call <contract_name|contract_address> <function_name_that_reverts>.
In the REPL, run call <contract_name|contract_address> <function_name_that_panics>.

NOTE: This can also be tested in a truffle project outside of truffle REPL with the following steps -

Run a ganache instance in a separate terminal.
Run truffle migrate.
Run truffle call <contract_name|contract_address> <function_name>.
Run truffle call <contract_name|contract_address> <function_name> <arg>.
In the REPL, run truffle call <contract_name|contract_address> <function_name> that returns multiple values of different types.
Run call <contract_name|contract_address> <function_signature> <arg>. NOTE: Function signature should be in "" and without spaces.
Run truffle call <contract_name|contract_address> <function_name_that_reverts>.
Run truffle call <contract_name|contract_address> <function_name_that_panics>.

Breaking changes and new features

I have added any needed breaking-change and new-feature labels for the appropriate packages.

packages/provider/index.js

- Rename `sendRequest` to `request` - Make it public - See no evil (re: extra `formatOptions` option)

... using @truffle/encoder and @truffle/decoder

Co-authored-by: David Murdoch <187813+davidmurdoch@users.noreply.github.com> Co-authored-by: cds-amal <cds.sudama@gmail.com>

haltman-at · 2023-05-05T04:49:59Z

Oops, I also need to just straight-up update the tests, it's failing CI because I didn't...

I have revised things :)

haltman-at · 2023-05-08T23:10:41Z

OK, I have substantially revised this and I think it should be OK now!

I had to leave out a few tests due to the framework making them difficult.

Also sorry for how slow the tests are. We can cut some if you like. Or if you know a better way to do it that would be quick to implement...

gnidan · 2023-05-09T18:37:45Z

Also sorry for how slow the tests are. We can cut some if you like.

Yeah, let's cut all the slow tests for now and open an issue about the lack of automated testing as a result.

Or maybe we keep 1-2 basic end-to-end tests just for minimal safety

gnidan · 2023-05-09T18:47:30Z

packages/core/lib/commands/call/run.js

+
+  const fromAddress =
+    options.from ?? config.networks[config.network]?.from ?? config.from;
+  if (!web3Utils.isAddress(fromAddress)) {


Can we skip the need to specify a from field?

At the very least this error should indicate which address is the problem, since this error now suggests that it might be the contract address that's wrong

But I'm thinking... maybe we can just use 0x0 as the from address

gnidan

Looks good apart from the requirement for from. Let's use the zero-address for from instead of erroring.

haltman-at · 2023-05-09T20:45:55Z

OK, made those changes!

gnidan

Looks good, thanks!

sukanyaparashar marked this pull request as draft October 26, 2022 06:04

sukanyaparashar added the new feature label Oct 26, 2022

sukanyaparashar mentioned this pull request Oct 26, 2022

Implement encoder/decoder-based truffle call command #5330

Closed

sukanyaparashar force-pushed the implement-truffle-call branch 2 times, most recently from 0ec573c to 7c25656 Compare November 8, 2022 16:06

gnidan reviewed Nov 14, 2022

View reviewed changes

packages/provider/index.js Outdated Show resolved Hide resolved

davidmurdoch reviewed Nov 14, 2022

View reviewed changes

packages/provider/index.js Outdated Show resolved Hide resolved

sukanyaparashar force-pushed the implement-truffle-call branch 2 times, most recently from d7d0063 to 468d8e2 Compare November 24, 2022 19:20

sukanyaparashar marked this pull request as ready for review November 29, 2022 03:15

sukanyaparashar requested review from lsqproduction, eggplantzzz, cds-amal, cliffoo, davidmurdoch, gnidan and haltman-at November 29, 2022 18:34

sukanyaparashar marked this pull request as draft December 16, 2022 02:48

gnidan and others added 10 commits December 16, 2022 12:02

Adhere Encoder.ProviderAdapter to EIP-1193

ca90ba3

- Rename `sendRequest` to `request` - Make it public - See no evil (re: extra `formatOptions` option)

Implement prototype truffle call command

97222b0

... using @truffle/encoder and @truffle/decoder

Define yargs metadata for truffle call command

917d810

Validate commandline args for truffle call

013d8b6

Implement truffle call command

3c24b5b

Monkey patch @truffle/provider to handle EIP-1193 request method

ca7f9ef

Co-authored-by: David Murdoch <187813+davidmurdoch@users.noreply.github.com> Co-authored-by: cds-amal <cds.sudama@gmail.com>

Remove unnecessary commented lines

6f509e7

Add integration tests for truffle call command

b335d87

Use cleanupSandboxDir callback

055c6c4

Move 1193 provider implementation logic to wrapper.js

0151949

sukanyaparashar force-pushed the implement-truffle-call branch from e5e1b32 to 0151949 Compare December 16, 2022 19:07

sukanyaparashar marked this pull request as ready for review December 16, 2022 19:55

haltman-at removed the request for review from fainashalts May 5, 2023 04:26

haltman-at added 12 commits May 8, 2023 16:12

Fix block number handling

6a80394

Fix accidental variable shadowing

662ee6b

Add missing export

c2b1765

Add "Error: " prefix to many errors

1808179

Rewrite test cases (still need to add a few more)

ea1e84a

Fix incorrect getting of from & block

6a80caf

Add tests of overload resolution

7ab4766

Fix incorrect contract syntax

8d132fb

Fix solidity syntax again (sorry)

d514885

Fix some remaining test issues

ebc7c54

Fix regex syntax

e10848a

Fix incorrect assert method (sorry)

d89d919

haltman-at marked this pull request as ready for review May 8, 2023 23:07

haltman-at requested a review from davidmurdoch May 8, 2023 23:09

Handle case where no decodings returned

6b5b4e6

haltman-at self-requested a review May 9, 2023 01:40

gnidan reviewed May 9, 2023

View reviewed changes

gnidan suggested changes May 9, 2023

View reviewed changes

haltman-at added 2 commits May 9, 2023 16:43

Add zero address as default from address

9eed33a

Remove most Truffle Call tests because they're too slow

3cb74c7

haltman-at requested a review from gnidan May 9, 2023 20:46

gnidan approved these changes May 9, 2023

View reviewed changes

haltman-at merged commit 4c17a8e into develop May 9, 2023
10 checks passed

haltman-at deleted the implement-truffle-call branch May 9, 2023 21:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement new `truffle call` command using @truffle/encoder and @truffle/decoder #5647

Implement new `truffle call` command using @truffle/encoder and @truffle/decoder #5647

sukanyaparashar commented Oct 26, 2022 •

edited

haltman-at commented May 5, 2023

haltman-at commented May 8, 2023

gnidan commented May 9, 2023 •

edited

gnidan May 9, 2023

gnidan May 9, 2023

gnidan left a comment

haltman-at commented May 9, 2023

gnidan left a comment

Implement new truffle call command using @truffle/encoder and @truffle/decoder #5647

Implement new truffle call command using @truffle/encoder and @truffle/decoder #5647

Conversation

sukanyaparashar commented Oct 26, 2022 • edited

PR description

Testing instructions

Breaking changes and new features

haltman-at commented May 5, 2023

haltman-at commented May 8, 2023

gnidan commented May 9, 2023 • edited

gnidan May 9, 2023

Choose a reason for hiding this comment

gnidan May 9, 2023

Choose a reason for hiding this comment

gnidan left a comment

Choose a reason for hiding this comment

haltman-at commented May 9, 2023

gnidan left a comment

Choose a reason for hiding this comment

Implement new `truffle call` command using @truffle/encoder and @truffle/decoder #5647

Implement new `truffle call` command using @truffle/encoder and @truffle/decoder #5647

sukanyaparashar commented Oct 26, 2022 •

edited

gnidan commented May 9, 2023 •

edited