feat: Provide source, builder and codehash information in store code proposal message #1072

orkunkl · 2022-11-02T06:35:58Z

This PR's aim is to standardize contract verification on store code proposals.
On store code proposals, proposal creators usually pass code source, builder and code hash information as a part of the description. Let's move these fields back to proposal content and run a check during store to verify provided hash is correct.

proto/cosmwasm/wasm/v1/proposal.proto

orkunkl · 2022-11-02T06:48:09Z

x/wasm/types/proposal.pb.go

 }

 func (m *StoreCodeProposal) Reset()      { *m = StoreCodeProposal{} }
 func (*StoreCodeProposal) ProtoMessage() {}
 func (*StoreCodeProposal) Descriptor() ([]byte, []int) {
 	return fileDescriptor_be6422d717c730cb, []int{0}
 }
-


I've used make proto-gen to generate proto code. All proto files had these formatting changes, reverted them.

Please use make proto-all which also runs the formatter (make format)

codecov · 2022-11-02T06:54:21Z

Codecov Report

Merging #1072 (049ce58) into main (e6f5149) will increase coverage by 0.14%.
The diff coverage is 55.04%.

❗ Current head 049ce58 differs from pull request most recent head 36c921e. Consider uploading reports for the commit 36c921e to get more accurate results

@@            Coverage Diff             @@
##             main    #1072      +/-   ##
==========================================
+ Coverage   59.80%   59.94%   +0.14%     
==========================================
  Files          54       54              
  Lines        7306     7373      +67     
==========================================
+ Hits         4369     4420      +51     
- Misses       2621     2632      +11     
- Partials      316      321       +5

Impacted Files	Coverage Δ
x/wasm/client/cli/tx.go	`22.94% <ø> (ø)`
x/wasm/keeper/proposal_handler.go	`64.44% <33.33%> (-1.47%)`	⬇️
x/wasm/client/cli/gov_tx.go	`13.90% <50.00%> (+6.93%)`	⬆️
x/wasm/types/proposal.go	`55.33% <50.00%> (-0.20%)`	⬇️
x/wasm/types/validation.go	`87.50% <69.23%> (-12.50%)`	⬇️
x/wasm/types/test_fixtures.go	`93.61% <75.00%> (-1.16%)`	⬇️
app/app.go	`88.14% <0.00%> (-0.40%)`	⬇️
app/test_helpers.go	`0.80% <0.00%> (+0.01%)`	⬆️
x/wasm/keeper/keeper.go	`87.71% <0.00%> (+0.31%)`	⬆️
x/wasm/keeper/relay.go	`97.67% <0.00%> (+1.20%)`	⬆️
... and 2 more

alpe

Thanks for bringing this topic up and this very nice PR 💐

I think validators have a hard time to verify a StoreCodeProposal currently. Providing additional data for this process can help with to build better tooling on the client side.
Nevertheless the data needs to be specified well and be verified, so that the expectations for everybody are the same.

We also need to support a transition period (on the server side) where fields are empty to not break execution of existing in flight proposals.

alpe · 2022-11-02T09:11:58Z

x/wasm/keeper/proposal_handler.go

 	if err != nil {
 		return err
 	}

+	if !bytes.Equal(checksum, p.CodeHash) {


There may be in flight proposals without this data. It would be good to not enforce the check when p.CodeHash is empty

I think you got me wrong. if !bytes.Equal(checksum, p.CodeHash) makes a lot of sense and ensures consistency of the proposal. Please add it back but with a if p.CodeHash != nil && !bytes.Equal(checksum, p.CodeHash) so that it works for old in flight proposals (without the new fields) , too.

alpe · 2022-11-02T09:13:12Z

x/wasm/types/proposal.go

@@ -113,6 +113,16 @@ func (p StoreCodeProposal) ValidateBasic() error {
 			return sdkerrors.Wrap(err, "instantiate permission")
 		}
 	}
+
+	if len(p.Source) == 0 {


As mentioned above, these fields should be optional on the server side to support a transition period for in flight proposals.
But there is no problem to enforce checks on the CLI before submitting a proposal.
There can be stronger constraints on the expected data (when set).

orkunkl · 2022-11-08T12:20:19Z

x/wasm/client/cli/tx_test.go

+			args:   []string{"--source=bar", "--builder=foo"},
+			expErr: true,
+		},
+		"happy path": {


I am getting an error here that I could not solve.
The hash generated on 76th line and in parseStoreCodeArgs do not match. I decided to not get stuck and ask help from your elven 👀 @alpe here.

I have commented on parseStoreCodeArgs which contains a 🐛

alpe

Thanks for the updates but I think updating the TX and gen-messages should be discussed first, given the negative experience on chain in the past. Let's have an issue for them and fully focus on the gov store proposal here to get it into v0.30 if possible

proto/cosmwasm/wasm/v1/proposal.proto

alpe · 2022-11-09T08:35:16Z

proto/cosmwasm/wasm/v1/tx.proto

@@ -41,7 +41,16 @@ message MsgStoreCode {
  // InstantiatePermission access control to apply on contract creation,
  // optional
  AccessConfig instantiate_permission = 5;
+  // Source is a valid absolute HTTPS URI to the contract's source code,


The original intend as I understood it, was to add this metadata to the gov process where it made sense for me. Not sure about the TX though as they were not used proper in the past. Let's focus on the gov process in this PR and open a ticket for the TX to discuss, if you like.

Makes sense 👍

x/wasm/client/cli/genesis_msg.go

x/wasm/client/cli/gov_tx.go

x/wasm/client/cli/tx.go

x/wasm/client/cli/tx_test.go

alpe · 2022-11-09T09:19:51Z

x/wasm/client/cli/tx_test.go

+			args:   []string{"--source=bar", "--builder=foo"},
+			expErr: true,
+		},
+		"happy path": {


I have commented on parseStoreCodeArgs which contains a 🐛

alpe · 2022-11-09T09:21:36Z

x/wasm/client/cli/tx_test.go

+		"happy path": {
+			args:   []string{"--source=bar", "--builder=foo", "--code-hash=" + checksumStr},
+			expErr: false,
+		},


Please add a case where the source file is zipped so that you are not running into a problem when comparing the hash

alpe · 2022-11-11T13:38:27Z

fyi: @pinosu is working on the StoreAndInstantiateProposal that would also benefit from the new fields
Do you need help with the implementation?

orkunkl · 2022-11-15T07:56:32Z

@alpe I got carried away with other tasks, I will finish this today/tomorrow thanks!

x/wasm/client/cli/tx.go

…al message

alpe

Thanks for the updates. Good progress! 🤾‍♂️
As I had mentioned before, I would like to have some good data validation on the new fields (when set) so that we ensure they won't break clients easily.

Also the StoreAndInstantiateContractProposal was merged to main meanwhile. This proposal would require the fields as well

go.mod

x/wasm/types/proposal.go

x/wasm/client/cli/tx.go

x/wasm/simulation/proposals.go

x/wasm/client/cli/gov_tx.go

Co-authored-by: Alexander Peters <alpe@users.noreply.github.com>

Bumps [github.com/cosmos/gogoproto](https://github.com/cosmos/gogoproto) from 1.4.2 to 1.4.3. - [Release notes](https://github.com/cosmos/gogoproto/releases) - [Changelog](https://github.com/cosmos/gogoproto/blob/main/CHANGELOG.md) - [Commits](cosmos/gogoproto@v1.4.2...v1.4.3) --- updated-dependencies: - dependency-name: github.com/cosmos/gogoproto dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com>

* Enable larger wasm bytecode upload for gov proposals * Set max proposal wasm code size to 3MB

* bump go 1.19 * add change log * correct change log

…al message

orkunkl · 2022-11-21T11:11:10Z

Maybe best to wrap source, builder and code hash information under VerificationInfo and treat them as one pack?

alpe · 2022-11-22T13:32:59Z

@Mergifyio rebase

* main: Upgrade to IBC v4.2.0 with interchain-accounts v0.2.4 (#1088)

sonarcloud · 2022-11-22T14:08:40Z

SonarCloud Quality Gate failed.

0 Bugs
0 Vulnerabilities
0 Security Hotspots
9 Code Smells

No Coverage information
34.8% Duplication

alpe

Very good work! Thanks for applying all my requests. 🥇
I am looking forward to see some client side tooling that makes use of the new fields. Great innovation 👍

x/wasm/client/cli/gov_tx.go

x/wasm/keeper/proposal_handler.go

alpe · 2022-11-21T10:56:00Z

x/wasm/types/validation.go

+	// if any set require others to be set
+	if len(source) != 0 || len(builder) != 0 || codeHash != nil {
+		if source == "" {
+			return fmt.Errorf("source is required")


nit:

Suggested change

return fmt.Errorf("source is required")

return ErrEmpty.Wrap("source:)

The sdk package comes with some nice error support. Next time, please use them instead

…proposal message (CosmWasm#1072) * Provide source, builder and codehash information in store code proposal message * Make linter happy * Update x/wasm/simulation/proposals.go Co-authored-by: Alexander Peters <alpe@users.noreply.github.com> * Update x/wasm/client/cli/gov_tx.go * Update x/wasm/client/cli/gov_tx.go * Bump github.com/cosmos/gogoproto from 1.4.2 to 1.4.3 Bumps [github.com/cosmos/gogoproto](https://github.com/cosmos/gogoproto) from 1.4.2 to 1.4.3. - [Release notes](https://github.com/cosmos/gogoproto/releases) - [Changelog](https://github.com/cosmos/gogoproto/blob/main/CHANGELOG.md) - [Commits](cosmos/gogoproto@v1.4.2...v1.4.3) --- updated-dependencies: - dependency-name: github.com/cosmos/gogoproto dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> * Update authz grant examples * Enable larger wasm bytecode upload for gov proposals (CosmWasm#1095) * Enable larger wasm bytecode upload for gov proposals * Set max proposal wasm code size to 3MB * Bump SDK to v0.45.11 * Fix license head * Fix README header * Bump version go to 1.19 (CosmWasm#1044) * bump go 1.19 * add change log * correct change log * Provide source, builder and codehash information in store code proposal message * Implement source, builder, code_info for StoreAndInstantiateProposal * Apply review recommendations * Make linter happy * Fix tests * Formatting only Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Alexander Peters <alpe@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Giancarlos Salas <giansalex@gmail.com> Co-authored-by: pinosu <95283998+pinosu@users.noreply.github.com> Co-authored-by: GNaD13 <89174180+GNaD13@users.noreply.github.com>

faddat · 2022-12-10T14:53:14Z

Incredibly important work. Thank you!

…proposal message (CosmWasm#1072) * Provide source, builder and codehash information in store code proposal message * Make linter happy * Update x/wasm/simulation/proposals.go Co-authored-by: Alexander Peters <alpe@users.noreply.github.com> * Update x/wasm/client/cli/gov_tx.go * Update x/wasm/client/cli/gov_tx.go * Bump github.com/cosmos/gogoproto from 1.4.2 to 1.4.3 Bumps [github.com/cosmos/gogoproto](https://github.com/cosmos/gogoproto) from 1.4.2 to 1.4.3. - [Release notes](https://github.com/cosmos/gogoproto/releases) - [Changelog](https://github.com/cosmos/gogoproto/blob/main/CHANGELOG.md) - [Commits](cosmos/gogoproto@v1.4.2...v1.4.3) --- updated-dependencies: - dependency-name: github.com/cosmos/gogoproto dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> * Update authz grant examples * Enable larger wasm bytecode upload for gov proposals (CosmWasm#1095) * Enable larger wasm bytecode upload for gov proposals * Set max proposal wasm code size to 3MB * Bump SDK to v0.45.11 * Fix license head * Fix README header * Bump version go to 1.19 (CosmWasm#1044) * bump go 1.19 * add change log * correct change log * Provide source, builder and codehash information in store code proposal message * Implement source, builder, code_info for StoreAndInstantiateProposal * Apply review recommendations * Make linter happy * Fix tests * Formatting only Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Alexander Peters <alpe@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Giancarlos Salas <giansalex@gmail.com> Co-authored-by: pinosu <95283998+pinosu@users.noreply.github.com> Co-authored-by: GNaD13 <89174180+GNaD13@users.noreply.github.com>

orkunkl requested a review from alpe as a code owner November 2, 2022 06:35

orkunkl commented Nov 2, 2022

View reviewed changes

proto/cosmwasm/wasm/v1/proposal.proto Show resolved Hide resolved

orkunkl commented Nov 2, 2022

View reviewed changes

alpe reviewed Nov 2, 2022

View reviewed changes

orkunkl commented Nov 8, 2022

View reviewed changes

orkunkl requested a review from alpe November 8, 2022 15:16

alpe reviewed Nov 9, 2022

View reviewed changes

orkunkl force-pushed the store-prop-codehash-check branch from 50904e6 to b102cfa Compare November 15, 2022 11:32

orkunkl commented Nov 15, 2022

View reviewed changes

x/wasm/client/cli/tx.go Show resolved Hide resolved

orkunkl force-pushed the store-prop-codehash-check branch from b102cfa to 477e8d9 Compare November 15, 2022 11:48

Provide source, builder and codehash information in store code propos…

151d18e

…al message

orkunkl force-pushed the store-prop-codehash-check branch from 477e8d9 to 151d18e Compare November 15, 2022 11:57

Make linter happy

43f19b0

orkunkl requested a review from alpe November 16, 2022 08:38

alpe reviewed Nov 17, 2022

View reviewed changes

orkunkl and others added 12 commits November 19, 2022 14:23

Update x/wasm/simulation/proposals.go

73a93e3

Co-authored-by: Alexander Peters <alpe@users.noreply.github.com>

Update x/wasm/client/cli/gov_tx.go

c79ddad

Update x/wasm/client/cli/gov_tx.go

1b2aa2b

Update authz grant examples

0300480

Enable larger wasm bytecode upload for gov proposals (#1095)

b0c7402

* Enable larger wasm bytecode upload for gov proposals * Set max proposal wasm code size to 3MB

Bump SDK to v0.45.11

d052f6d

Fix license head

b5c3807

Fix README header

1ecd1d4

Bump version go to 1.19 (#1044)

9236aaa

* bump go 1.19 * add change log * correct change log

Provide source, builder and codehash information in store code propos…

b95ce8b

…al message

Implement source, builder, code_info for StoreAndInstantiateProposal

9ccd8e5

orkunkl added 3 commits November 21, 2022 12:35

Apply review recommendations

3d74a53

Make linter happy

f500584

Merge branch 'main' into store-prop-codehash-check

da0a42f

Fix tests

049ce58

orkunkl requested a review from alpe November 21, 2022 11:14

alpe added 2 commits November 22, 2022 14:58

Merge branch 'main' into store-prop-codehash-check

2f0cd92

* main: Upgrade to IBC v4.2.0 with interchain-accounts v0.2.4 (#1088)

Formatting only

36c921e

alpe approved these changes Nov 22, 2022

View reviewed changes

alpe merged commit a589fe9 into main Nov 22, 2022

alpe deleted the store-prop-codehash-check branch November 22, 2022 14:14

orkunkl mentioned this pull request Nov 30, 2022

Update submit proposal page CosmWasm/docs-deprecated#427

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Provide source, builder and codehash information in store code proposal message #1072

feat: Provide source, builder and codehash information in store code proposal message #1072

orkunkl commented Nov 2, 2022

orkunkl Nov 2, 2022

alpe Nov 2, 2022

codecov bot commented Nov 2, 2022 •

edited

Loading

alpe left a comment

alpe Nov 2, 2022

alpe Nov 17, 2022

alpe Nov 2, 2022

orkunkl Nov 8, 2022 •

edited

Loading

alpe Nov 9, 2022

alpe left a comment

alpe Nov 9, 2022

orkunkl Nov 9, 2022

alpe Nov 9, 2022

alpe Nov 9, 2022

alpe commented Nov 11, 2022

orkunkl commented Nov 15, 2022

alpe left a comment

orkunkl commented Nov 21, 2022

alpe commented Nov 22, 2022

sonarcloud bot commented Nov 22, 2022

alpe left a comment

alpe Nov 21, 2022

alpe Nov 22, 2022

faddat commented Dec 10, 2022

	return fmt.Errorf("source is required")
	return ErrEmpty.Wrap("source:)

feat: Provide source, builder and codehash information in store code proposal message #1072

feat: Provide source, builder and codehash information in store code proposal message #1072

Conversation

orkunkl commented Nov 2, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Nov 2, 2022 • edited Loading

Codecov Report

alpe 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

orkunkl Nov 8, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alpe 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

Choose a reason for hiding this comment

alpe commented Nov 11, 2022

orkunkl commented Nov 15, 2022

alpe left a comment

Choose a reason for hiding this comment

orkunkl commented Nov 21, 2022

alpe commented Nov 22, 2022

sonarcloud bot commented Nov 22, 2022

alpe left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

faddat commented Dec 10, 2022

codecov bot commented Nov 2, 2022 •

edited

Loading

orkunkl Nov 8, 2022 •

edited

Loading