Add Developer's guide and best practices #1075

pinosu · 2022-11-04T11:58:18Z

Resolves #654

ethanfrey · 2022-11-04T13:31:15Z

Very cool to see this. I'll let @alpe review and give approval, but great addition

alpe

This looks great. A lot to read for newbies.

I have added some comments where we work differently. Please adjust.

alpe · 2022-11-04T15:48:01Z

CODING_GUIDELINES.md

+    * think about maintainbility and testability.
+* "Depend upon abstractions, [not] concretions".
+* Try to limit the number of methods you are exposing. It's easier to expose something later than to hide it.
+* Take advantage of `internal` package concept.


The internal package was not working well with wasmd as a library. Let's not bring it back

alpe · 2022-11-04T15:49:26Z

CODING_GUIDELINES.md

+        } 
+        ```
+
+    * It would be an improvement to return  `return nil, sdkerror.Wrap(err, "lock contract coins")`


alpe · 2022-11-04T15:56:08Z

CONTRIBUTING.md

+    * Fork the repo (core developers must create a branch directly in the Wasmd repo),
+    branch from the HEAD of `main`, make some commits, and submit a PR to `main`.
+    * For core developers working within the `wasmd` repo, follow branch name conventions to ensure a clear
+    ownership of branches: `{moniker}/{issue#}-branch-name`.


do we want to do this branch pattern? I am doing {issue}_name only

alpe · 2022-11-04T15:56:28Z

CONTRIBUTING.md

+    * For core developers working within the `wasmd` repo, follow branch name conventions to ensure a clear
+    ownership of branches: `{moniker}/{issue#}-branch-name`.
+    * See [Branching Model](#branching-model-and-release) for more details.
+* Be sure to run `make format` before every commit. The easiest way


👍 this is good

alpe · 2022-11-04T15:56:59Z

CONTRIBUTING.md

+
+### Testing
+
+Tests can be executed by running `make test` at the top level of the Cosmos SDK repository.


Suggested change

Tests can be executed by running `make test` at the top level of the Cosmos SDK repository.

Tests can be executed by running `make test` at the top level of the wasmd repository.

alpe · 2022-11-04T15:57:43Z

CONTRIBUTING.md

+1. If you have something to show, **start with a `Draft` PR**. It's good to have early validation of your work and we highly recommend this practice. A Draft PR also indicates to the community that the work is in progress.
+   Draft PRs also helps the core team provide early feedback and ensure the work is in the right direction.
+2. When the code is complete, change your PR from `Draft` to `Ready for Review`.
+3. Go through the actions for each checkbox present in the PR template description. The PR actions are automatically provided for each new PR.


we don't have checkboxes :-)

alpe · 2022-11-04T15:58:40Z

CONTRIBUTING.md

+3. Go through the actions for each checkbox present in the PR template description. The PR actions are automatically provided for each new PR.
+4. Be sure to include a relevant changelog entry in the `Unreleased` section of `CHANGELOG.md` (see file for log format). The entry should be on top of all others changes in the section.
+
+PRs should have a category prefix that is based on the type of changes being made (for example, `fix`, `feat`,


PR names should start uppercase . Let's not have prefixes. This can look odd in the history

alpe · 2022-11-04T16:00:22Z

CONTRIBUTING.md

+PRs should have a category prefix that is based on the type of changes being made (for example, `fix`, `feat`,
+`refactor`, `docs`, and so on). The *type* must be included in the PR title as a prefix (for example,
+`fix: <description>`). This convention ensures that all changes that are committed to the base branch follow the
+[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.


maybe we can add this later when needed. A lot to read for a new contributor

alpe · 2022-11-04T16:01:00Z

CONTRIBUTING.md

+[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
+Additionally, each PR should only address a single issue.
+
+Pull requests are merged automatically using [`A:automerge` action](https://mergify.io/features/auto-merge).


This is not used, yet

alpe · 2022-11-04T16:01:37Z

CONTRIBUTING.md

+
+To generate the protobuf stubs, you can run `make proto-gen`.
+
+We also added the `make proto-all` command to run all the above commands sequentially.


👍 my favourite

dakom · 2022-11-05T20:16:25Z

Hey.. in the name of "Developer's guide and best practices", can we please have a Getting Started.md?

What I mean is a list of steps that gets a new developer up and running with an instance of wasmd that they can deploy contracts to.

I'd write it and suggest in the PR, but as of right now I don't know the correct steps.

A bit of a guess, but something like:

make install (okay, that is in the Readme)
add initial accounts (wasmd keys something or other?)
create genesis (I am not sure what this is for, if it's necessary, how to do it, and how it relates to wasmd as opposed to other layers of the stack)
speed up block time (something like this?)

dakom · 2022-11-05T20:44:46Z

I see scripts at https://github.com/CosmWasm/wasmd/tree/main/contrib/local - maybe adapt these into English instructions with some explanation of what's going on (and reduce to bare minimum, i.e. no need to transfer tokens or deploy contracts to get up and running, that's kinda after everything is working)

dakom · 2022-11-05T23:30:48Z

putting that together, my notes, in case it helps:

after make install (on apple silicon, LEDGER_ENABLED=false make install)

our chain-id is going to be localnet
our gas denomination is going to be configured to uwasm
staking denomination is the default ustake

adding two users: tester1 and validator1

wasmd init localnet --chain-id localnet
edit ~/.wasmd/config/app.toml
- set minimum-gas-prices to 0.025uwasm
edit ~/.wasmd/config/client.toml
- set chain-id to localnet
edit ~/.wasmd/config/config.toml
- change all the times to 200ms
wasm keys add tester1
wasmd add-genesis-account $(wasmd keys show -a tester1) 10000000000uwasm,10000000000ustake
wasm keys add validator1
wasmd add-genesis-account $(wasmd keys show -a validator1) 10000000000uwasm,10000000000ustake
wasmd gentx validator1 "250000000ustake" --chain-id="localnet" --amount="250000000ustake"
wasmd collect-gentxs

now wasmd start should just work

ethanfrey · 2022-11-07T22:04:15Z

Hey.. in the name of "Developer's guide and best practices", can we please have a Getting Started.md?

What I mean is a list of steps that gets a new developer up and running with an instance of wasmd that they can deploy contracts to.

I'd write it and suggest in the PR, but as of right now I don't know the correct steps.

A bit of a guess, but something like:

make install (okay, that is in the Readme)

add initial accounts (wasmd keys something or other?)

create genesis (I am not sure what this is for, if it's necessary, how to do it, and how it relates to wasmd as opposed to other layers of the stack)

speed up block time (something like this?)

I agree with the general gist of these comments. That can be a new PR, but should be part of or clearly linked from any such dev setup doc.

A lot of this should be in an overhauled docs site, and definitely info on connecting to chains, setting up Go, etc. But it would be good to have the notes here. Especially things like compiling on MacOS (the ledger warnings/errors), arm64 compatibility, etc.

alpe · 2022-11-08T07:44:45Z

Documentation is an epic were you can always add more or improve it. I think it is important to get something out that we use to iterate and improve.
This document is targeting wasmd contributors as a start. There is a lot more that we need to share with new developers like test strategy and best practices, in order to grow the contributor list in the future.
Other roles like contract developers are not covered here. It is a fair request to have doc for them, too or link to it.

I have create #1081 to follow up on your request @dakom . Thanks a lot for bringing this up! I would be happy if you can help us building better docs.

* Add StoreAndInstantiateContract gov proposal * Add integration tests * Bump github.com/prometheus/client_golang from 1.13.0 to 1.14.0 Bumps [github.com/prometheus/client_golang](https://github.com/prometheus/client_golang) from 1.13.0 to 1.14.0. - [Release notes](https://github.com/prometheus/client_golang/releases) - [Changelog](https://github.com/prometheus/client_golang/blob/main/CHANGELOG.md) - [Commits](prometheus/client_golang@v1.13.0...v1.14.0) --- updated-dependencies: - dependency-name: github.com/prometheus/client_golang dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> * Remove exposed functions * Add tests * Add Developer's guide and best practices (#1075) * Add Developer's guide and best practices * Fix comments * Change genesis preserving contract history (#1076) * preserve contract created date on genesis import and add query contract created date * add validate created * fix sims test app import export * add preserve contract history * Make proto-all only * Remove ResetFromGenesis * Add validation Co-authored-by: Alex Peters <[email protected]> * Return contract history updates * Bump github.com/spf13/viper from 1.13.0 to 1.14.0 (#1082) Bumps [github.com/spf13/viper](https://github.com/spf13/viper) from 1.13.0 to 1.14.0. - [Release notes](https://github.com/spf13/viper/releases) - [Commits](spf13/viper@v1.13.0...v1.14.0) --- updated-dependencies: - dependency-name: github.com/spf13/viper dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Revert "Bump github.com/spf13/viper from 1.13.0 to 1.14.0 (#1082)" This reverts commit cf81eb8. * Add cli and refactor code * Contract authz - redesign (#1077) * Add contract authz proto * Implement contract autorization * Register contract authz * Add contract-authz tests * Consume gas for contract authz * Add contract authz cli * Update cli usage * Model spike * Add max funds limit * Redesign authz model * Start e2e test * Full e2e test * Test filter and limits * Test accept * Fix description * No linter warning Co-authored-by: Giancarlos Salas <[email protected]> * Add StoreAndInstantiateContract gov proposal * Add integration tests * Remove exposed functions * Add tests * Add cli and refactor code * Fix comments Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: GNaD13 <[email protected]> Co-authored-by: Alex Peters <[email protected]> Co-authored-by: Giancarlos Salas <[email protected]>

* Add Developer's guide and best practices * Fix comments

* Add StoreAndInstantiateContract gov proposal * Add integration tests * Bump github.com/prometheus/client_golang from 1.13.0 to 1.14.0 Bumps [github.com/prometheus/client_golang](https://github.com/prometheus/client_golang) from 1.13.0 to 1.14.0. - [Release notes](https://github.com/prometheus/client_golang/releases) - [Changelog](https://github.com/prometheus/client_golang/blob/main/CHANGELOG.md) - [Commits](prometheus/client_golang@v1.13.0...v1.14.0) --- updated-dependencies: - dependency-name: github.com/prometheus/client_golang dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> * Remove exposed functions * Add tests * Add Developer's guide and best practices (CosmWasm#1075) * Add Developer's guide and best practices * Fix comments * Change genesis preserving contract history (CosmWasm#1076) * preserve contract created date on genesis import and add query contract created date * add validate created * fix sims test app import export * add preserve contract history * Make proto-all only * Remove ResetFromGenesis * Add validation Co-authored-by: Alex Peters <[email protected]> * Return contract history updates * Bump github.com/spf13/viper from 1.13.0 to 1.14.0 (CosmWasm#1082) Bumps [github.com/spf13/viper](https://github.com/spf13/viper) from 1.13.0 to 1.14.0. - [Release notes](https://github.com/spf13/viper/releases) - [Commits](spf13/viper@v1.13.0...v1.14.0) --- updated-dependencies: - dependency-name: github.com/spf13/viper dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Revert "Bump github.com/spf13/viper from 1.13.0 to 1.14.0 (CosmWasm#1082)" This reverts commit cf81eb8. * Add cli and refactor code * Contract authz - redesign (CosmWasm#1077) * Add contract authz proto * Implement contract autorization * Register contract authz * Add contract-authz tests * Consume gas for contract authz * Add contract authz cli * Update cli usage * Model spike * Add max funds limit * Redesign authz model * Start e2e test * Full e2e test * Test filter and limits * Test accept * Fix description * No linter warning Co-authored-by: Giancarlos Salas <[email protected]> * Add StoreAndInstantiateContract gov proposal * Add integration tests * Remove exposed functions * Add tests * Add cli and refactor code * Fix comments Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: GNaD13 <[email protected]> Co-authored-by: Alex Peters <[email protected]> Co-authored-by: Giancarlos Salas <[email protected]>

* Add Developer's guide and best practices * Fix comments

* Add StoreAndInstantiateContract gov proposal * Add integration tests * Bump github.com/prometheus/client_golang from 1.13.0 to 1.14.0 Bumps [github.com/prometheus/client_golang](https://github.com/prometheus/client_golang) from 1.13.0 to 1.14.0. - [Release notes](https://github.com/prometheus/client_golang/releases) - [Changelog](https://github.com/prometheus/client_golang/blob/main/CHANGELOG.md) - [Commits](prometheus/client_golang@v1.13.0...v1.14.0) --- updated-dependencies: - dependency-name: github.com/prometheus/client_golang dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> * Remove exposed functions * Add tests * Add Developer's guide and best practices (CosmWasm#1075) * Add Developer's guide and best practices * Fix comments * Change genesis preserving contract history (CosmWasm#1076) * preserve contract created date on genesis import and add query contract created date * add validate created * fix sims test app import export * add preserve contract history * Make proto-all only * Remove ResetFromGenesis * Add validation Co-authored-by: Alex Peters <[email protected]> * Return contract history updates * Bump github.com/spf13/viper from 1.13.0 to 1.14.0 (CosmWasm#1082) Bumps [github.com/spf13/viper](https://github.com/spf13/viper) from 1.13.0 to 1.14.0. - [Release notes](https://github.com/spf13/viper/releases) - [Commits](spf13/viper@v1.13.0...v1.14.0) --- updated-dependencies: - dependency-name: github.com/spf13/viper dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Revert "Bump github.com/spf13/viper from 1.13.0 to 1.14.0 (CosmWasm#1082)" This reverts commit cf81eb8. * Add cli and refactor code * Contract authz - redesign (CosmWasm#1077) * Add contract authz proto * Implement contract autorization * Register contract authz * Add contract-authz tests * Consume gas for contract authz * Add contract authz cli * Update cli usage * Model spike * Add max funds limit * Redesign authz model * Start e2e test * Full e2e test * Test filter and limits * Test accept * Fix description * No linter warning Co-authored-by: Giancarlos Salas <[email protected]> * Add StoreAndInstantiateContract gov proposal * Add integration tests * Remove exposed functions * Add tests * Add cli and refactor code * Fix comments Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: GNaD13 <[email protected]> Co-authored-by: Alex Peters <[email protected]> Co-authored-by: Giancarlos Salas <[email protected]>

* Add Developer's guide and best practices * Fix comments

* Add StoreAndInstantiateContract gov proposal * Add integration tests * Bump github.com/prometheus/client_golang from 1.13.0 to 1.14.0 Bumps [github.com/prometheus/client_golang](https://github.com/prometheus/client_golang) from 1.13.0 to 1.14.0. - [Release notes](https://github.com/prometheus/client_golang/releases) - [Changelog](https://github.com/prometheus/client_golang/blob/main/CHANGELOG.md) - [Commits](prometheus/client_golang@v1.13.0...v1.14.0) --- updated-dependencies: - dependency-name: github.com/prometheus/client_golang dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> * Remove exposed functions * Add tests * Add Developer's guide and best practices (CosmWasm#1075) * Add Developer's guide and best practices * Fix comments * Change genesis preserving contract history (CosmWasm#1076) * preserve contract created date on genesis import and add query contract created date * add validate created * fix sims test app import export * add preserve contract history * Make proto-all only * Remove ResetFromGenesis * Add validation Co-authored-by: Alex Peters <[email protected]> * Return contract history updates * Bump github.com/spf13/viper from 1.13.0 to 1.14.0 (CosmWasm#1082) Bumps [github.com/spf13/viper](https://github.com/spf13/viper) from 1.13.0 to 1.14.0. - [Release notes](https://github.com/spf13/viper/releases) - [Commits](spf13/viper@v1.13.0...v1.14.0) --- updated-dependencies: - dependency-name: github.com/spf13/viper dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Revert "Bump github.com/spf13/viper from 1.13.0 to 1.14.0 (CosmWasm#1082)" This reverts commit cf81eb8. * Add cli and refactor code * Contract authz - redesign (CosmWasm#1077) * Add contract authz proto * Implement contract autorization * Register contract authz * Add contract-authz tests * Consume gas for contract authz * Add contract authz cli * Update cli usage * Model spike * Add max funds limit * Redesign authz model * Start e2e test * Full e2e test * Test filter and limits * Test accept * Fix description * No linter warning Co-authored-by: Giancarlos Salas <[email protected]> * Add StoreAndInstantiateContract gov proposal * Add integration tests * Remove exposed functions * Add tests * Add cli and refactor code * Fix comments Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: GNaD13 <[email protected]> Co-authored-by: Alex Peters <[email protected]> Co-authored-by: Giancarlos Salas <[email protected]>

Add Developer's guide and best practices

9468035

pinosu requested a review from alpe as a code owner November 4, 2022 11:58

ethanfrey added this to the v0.30.0 milestone Nov 4, 2022

alpe approved these changes Nov 4, 2022

View reviewed changes

Fix comments

01a21dc

alpe mentioned this pull request Nov 8, 2022

Add or link to "getting started" doc for contract developers #1081

Open

pinosu merged commit 5caaab9 into main Nov 11, 2022

NoahSaso pushed a commit to NoahSaso/wasmd that referenced this pull request Dec 2, 2022

Add Developer's guide and best practices (CosmWasm#1075)

27252ff

* Add Developer's guide and best practices * Fix comments

Magicloud pushed a commit to fpco/wasmd that referenced this pull request Jan 13, 2023

Add Developer's guide and best practices (CosmWasm#1075)

7738492

* Add Developer's guide and best practices * Fix comments

conorpp pushed a commit to wormhole-foundation/wasmd that referenced this pull request Feb 1, 2023

Add Developer's guide and best practices (CosmWasm#1075)

1c5ad5d

* Add Developer's guide and best practices * Fix comments

alpe deleted the 654-dev_giude branch May 10, 2023 08:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Developer's guide and best practices #1075

Add Developer's guide and best practices #1075

pinosu commented Nov 4, 2022

ethanfrey commented Nov 4, 2022

alpe left a comment

alpe Nov 4, 2022

alpe Nov 4, 2022

alpe Nov 4, 2022

alpe Nov 4, 2022

alpe Nov 4, 2022

alpe Nov 4, 2022

alpe Nov 4, 2022

alpe Nov 4, 2022

alpe Nov 4, 2022

alpe Nov 4, 2022

dakom commented Nov 5, 2022

dakom commented Nov 5, 2022

dakom commented Nov 5, 2022 •

edited

Loading

ethanfrey commented Nov 7, 2022 •

edited

Loading

alpe commented Nov 8, 2022


		### Testing

		Tests can be executed by running `make test` at the top level of the Cosmos SDK repository.


		To generate the protobuf stubs, you can run `make proto-gen`.

		We also added the `make proto-all` command to run all the above commands sequentially.

Add Developer's guide and best practices #1075

Add Developer's guide and best practices #1075

Conversation

pinosu commented Nov 4, 2022

ethanfrey commented Nov 4, 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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dakom commented Nov 5, 2022

dakom commented Nov 5, 2022

dakom commented Nov 5, 2022 • edited Loading

ethanfrey commented Nov 7, 2022 • edited Loading

alpe commented Nov 8, 2022

dakom commented Nov 5, 2022 •

edited

Loading

ethanfrey commented Nov 7, 2022 •

edited

Loading