feat(cast) add creation-code method [#8973] #9029

pawurb · 2024-10-04T08:23:13Z

Motivation

As described in #8973, currently there's no simple way to obtain contract creation code without compiling them locally. It is needed to deploy contracts with sol! macro.

If this is accepted I'll add artifact method generating file that can be used directly with sol! macro.

Solution

This PR adds cast creation-code method. It outputs the contract creation code.

Example usage

cast creation-code 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2 --etherscan-api-key API_KEY --rpc-url RPC_URL

crates/cast/bin/cmd/creation_code.rs

mds1 · 2024-10-04T14:44:18Z

crates/cast/bin/cmd/creation_code.rs

+    }
+}
+
+/// Fetches the creation code of a contract from Etherscan and RPC.


We should document whether or not this includes constructor args appended to initcode

@mds1 right, I should probably strip them to make the bytecode useful for local deployment. Maybe worth returning constructor args separately?

I'm reading up there's is no a single unified convention for encoding constructor args with different solidity versions. So I think I'll just add a comment that they are appended.

What is the use case for this method? I think that impacts whether or not you want to strip the constructor args. If you do want to strip them you'll likely need to use blockscout or etherscan to fetch constructor args

I want to get bytecode that I can use for deploying contracts locally, without compiling them myself. So prefer creation code without constructor args appended. But, optionally knowing what were the args values is also useful.

Eventually I want to add artifact method that will combine creation bytecode with JSON ABI, for simply use with sol! Alloy macro.

I'm thinking to add --without-args and --only-args flags. I think it's possible to know the size of appended args from the ABI. WDYT?

pawurb · 2024-10-10T09:50:05Z

I've added --only-args and --without-args flags to creation-code and creation-args method. With these tools it's possible to get bytecode for local deployment and also inspect args that were used in the original contract deployment.

cast creation-code 0x5f4eC3Df9cbd43714FE2740f5E3616155c5b8419 --only-args --etherscan-api-key API_KEY --rpc-url RPC_URL

# 0x000000000000000000000000f79d6afbb6da890132f9d7c355e3015f15f3406f0000000000000000000000000000000000000000000000000000000000000000

cast creation-args 0x5f4eC3Df9cbd43714FE2740f5E3616155c5b8419  --etherscan-api-key API_KEY --rpc-url RPC_URL

# address 0x000000000000000000000000f79d6afbb6da890132f9d7c355e3015f15f3406f
# address 0x0000000000000000000000000000000000000000000000000000000000000000

mattsse · 2024-10-16T09:50:16Z

what's missing here @zerosnacks ?

crates/cast/bin/cmd/creation_code.rs

crates/cast/bin/args.rs

zerosnacks

Resolved some nits I found

I think it makes sense to change creation_args to constructor_args as that is the common way to refer to it

crates/cast/bin/cmd/creation_args.rs

pawurb · 2024-10-23T14:50:27Z

@zerosnacks applied the review fixes. I've also added abi_path argument. It allows to use constructor-args for non verified contracts. I've implemented display in this format:

0x000000000000000000000000f79d6afbb6da890132f9d7c355e3015f15f3406f -> Address(0xf79d6afbb6da890132f9d7c355e3015f15f3406f)
0x0000000000000000000000000000000000000000000000000000000000000000 -> Address(0x0000000000000000000000000000000000000000)

Showing both raw and decoded values can be helpful for Etherscan contract verification that requires raw argument values.

crates/cast/bin/cmd/constructor_args.rs

crates/cast/bin/args.rs

zerosnacks · 2024-10-28T16:29:37Z

crates/cast/bin/cmd/constructor_args.rs

+}
+
+fn format_arg(ty: &str, arg: Vec<u8>) -> Result<String> {
+    let arg_type: DynSolType = ty.parse().expect("Invalid ABI type.");


Elegant solution w/ DynSolType 👍

crates/cast/bin/cmd/creation_code.rs

zerosnacks

Thanks @pawurb! Tiny nits related to documentation, implementation looks good 👍

Co-authored-by: zerosnacks <95942363+zerosnacks@users.noreply.github.com>

mattsse

pedantic style nits, otherwise lgtm

mattsse · 2024-10-29T10:46:41Z

crates/cast/bin/cmd/constructor_args.rs

+    if abi.constructor.is_none() {
+        return Err(eyre!("No constructor found."));
+    }
+
+    let constructor = abi.constructor.unwrap();


nit: this can be abi.constructor.ok_or_else? I think

mattsse · 2024-10-29T10:47:47Z

crates/cast/bin/cmd/constructor_args.rs

+    let bytes = Bytes::from(arg.clone());
+    let decoded = arg_type.abi_decode(&arg)?;


this alloc is likely not required and the function can also accept &[u8]

mattsse · 2024-10-29T10:48:02Z

crates/cast/bin/cmd/constructor_args.rs

+        .chunks(32)
+        .enumerate()
+        .map(|(i, arg)| {
+            let arg = arg.to_vec();


then we also dont need the to_vec here I believe

grandizzy

lgtm, thank you. I left a comment re using newly introduced sh_println macro

crates/cast/bin/cmd/constructor_args.rs

* feat(cast) add creation-code method [foundry-rs#8973] * Fix typo * Fix CI * Code review fixes * Add creation-code flags and creation-args * Update comments * eyre style fixes * typo * use r#".."# for snapbox * Apply suggestions from code review * fix test regression * tag arguments as mutually exclusive * use unreachable! * Rename and add abi_path param * Decode constructor args * Update crates/cast/bin/cmd/constructor_args.rs * fix test * Update crates/cast/bin/args.rs Co-authored-by: zerosnacks <95942363+zerosnacks@users.noreply.github.com> * Update crates/cast/bin/cmd/creation_code.rs Co-authored-by: zerosnacks <95942363+zerosnacks@users.noreply.github.com> * Update crates/cast/bin/cmd/creation_code.rs Co-authored-by: zerosnacks <95942363+zerosnacks@users.noreply.github.com> * Fix formatting * Code review fixes --------- Co-authored-by: zerosnacks <zerosnacks@protonmail.com> Co-authored-by: zerosnacks <95942363+zerosnacks@users.noreply.github.com>

pawurb requested review from DaniPopes, klkvr, mattsse, grandizzy, yash-atreya and zerosnacks as code owners October 4, 2024 08:23

zerosnacks linked an issue Oct 4, 2024 that may be closed by this pull request

feat(cast) add deploydata method #8973

Closed

mattsse requested changes Oct 4, 2024

View reviewed changes

crates/cast/bin/cmd/creation_code.rs Outdated Show resolved Hide resolved

crates/cast/bin/cmd/creation_code.rs Outdated Show resolved Hide resolved

mds1 reviewed Oct 4, 2024

View reviewed changes

pawurb force-pushed the cast_bytecode branch from aa0bca6 to 5554ef1 Compare October 4, 2024 15:33

pawurb requested a review from mattsse October 4, 2024 15:39

pawurb force-pushed the cast_bytecode branch from 5554ef1 to f3641e0 Compare October 10, 2024 09:40

pawurb force-pushed the cast_bytecode branch 3 times, most recently from e1df312 to fd6ee4e Compare October 10, 2024 09:59

pawurb requested a review from mds1 October 10, 2024 10:02

pawurb added 7 commits October 16, 2024 22:00

feat(cast) add creation-code method [foundry-rs#8973]

7efeaec

Fix typo

5f86a8f

Fix CI

057495e

Code review fixes

b2807ed

Add creation-code flags and creation-args

0c78d60

Update comments

6185a74

eyre style fixes

e4e7110

pawurb force-pushed the cast_bytecode branch from 313c330 to e4e7110 Compare October 16, 2024 20:00

louisbrown0212 reviewed Oct 18, 2024

View reviewed changes

crates/cast/bin/cmd/creation_code.rs Outdated Show resolved Hide resolved

typo

92732e8

pawurb requested a review from louisbrown0212 October 18, 2024 10:19

zerosnacks reviewed Oct 23, 2024

View reviewed changes

crates/cast/bin/args.rs Outdated Show resolved Hide resolved

use unreachable!

f5d1ae2

zerosnacks self-requested a review October 23, 2024 09:48

zerosnacks requested changes Oct 23, 2024

View reviewed changes

zerosnacks reviewed Oct 23, 2024

View reviewed changes

crates/cast/bin/cmd/creation_args.rs Outdated Show resolved Hide resolved

pawurb added 2 commits October 23, 2024 15:54

Rename and add abi_path param

261d82f

Decode constructor args

6bde573

pawurb force-pushed the cast_bytecode branch from d38086c to 6bde573 Compare October 23, 2024 14:47

pawurb requested a review from zerosnacks October 28, 2024 08:12

zerosnacks reviewed Oct 28, 2024

View reviewed changes

crates/cast/bin/cmd/constructor_args.rs Outdated Show resolved Hide resolved

zerosnacks and others added 3 commits October 28, 2024 17:24

Update crates/cast/bin/cmd/constructor_args.rs

daf6013

fix test

c210f97

Merge branch 'master' into cast_bytecode

94d0b82

zerosnacks reviewed Oct 28, 2024

View reviewed changes

crates/cast/bin/args.rs Outdated Show resolved Hide resolved

zerosnacks reviewed Oct 28, 2024

View reviewed changes

crates/cast/bin/cmd/creation_code.rs Outdated Show resolved Hide resolved

zerosnacks reviewed Oct 28, 2024

View reviewed changes

crates/cast/bin/cmd/creation_code.rs Outdated Show resolved Hide resolved

zerosnacks approved these changes Oct 28, 2024

View reviewed changes

pawurb and others added 4 commits October 28, 2024 21:15

Update crates/cast/bin/args.rs

dd8bada

Co-authored-by: zerosnacks <95942363+zerosnacks@users.noreply.github.com>

Update crates/cast/bin/cmd/creation_code.rs

c70088b

Co-authored-by: zerosnacks <95942363+zerosnacks@users.noreply.github.com>

Update crates/cast/bin/cmd/creation_code.rs

0ab37fc

Co-authored-by: zerosnacks <95942363+zerosnacks@users.noreply.github.com>

Fix formatting

a4ac984

mattsse approved these changes Oct 29, 2024

View reviewed changes

grandizzy approved these changes Oct 29, 2024

View reviewed changes

crates/cast/bin/cmd/constructor_args.rs Outdated Show resolved Hide resolved

Code review fixes

268636a

grandizzy merged commit 3e901af into foundry-rs:master Oct 29, 2024
21 checks passed

pawurb mentioned this pull request Nov 1, 2024

feat(cast): add artifact method #9249

Merged

grandizzy added T-feature Type: feature C-cast Command: cast labels Dec 18, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(cast) add creation-code method [#8973] #9029

feat(cast) add creation-code method [#8973] #9029

pawurb commented Oct 4, 2024

mds1 Oct 4, 2024

pawurb Oct 4, 2024

pawurb Oct 4, 2024

mds1 Oct 4, 2024

pawurb Oct 4, 2024

pawurb commented Oct 10, 2024

mattsse commented Oct 16, 2024

zerosnacks left a comment •

edited

Loading

pawurb commented Oct 23, 2024

zerosnacks Oct 28, 2024

zerosnacks left a comment

mattsse left a comment

mattsse Oct 29, 2024

mattsse Oct 29, 2024

mattsse Oct 29, 2024

grandizzy left a comment

		let bytes = Bytes::from(arg.clone());
		let decoded = arg_type.abi_decode(&arg)?;

feat(cast) add creation-code method [#8973] #9029

feat(cast) add creation-code method [#8973] #9029

Conversation

pawurb commented Oct 4, 2024

Motivation

Solution

Example usage

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pawurb commented Oct 10, 2024

mattsse commented Oct 16, 2024

zerosnacks left a comment • edited Loading

Choose a reason for hiding this comment

pawurb commented Oct 23, 2024

Choose a reason for hiding this comment

zerosnacks left a comment

Choose a reason for hiding this comment

mattsse left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

grandizzy left a comment

Choose a reason for hiding this comment

zerosnacks left a comment •

edited

Loading