evmos: app (#1)

.gitignore

@@ -1,15 +1,73 @@
-# Binaries for programs and plugins
+# OS
+.DS_Store
+*.swp
+*.swo
+*.swl
+*.swm
+*.swn
+.vscode
+.idea
+*.pyc
 *.exe
 *.exe~
 *.dll
 *.so
 *.dylib
 
-# Test binary, built with `go test -c`
+# Build
 *.test
+.glide/
+vendor
+build
+bin
+tools/bin/*
+docs/_build
+docs/tutorial
+docs/node_modules
+docs/modules
+dist
+tools-stamp
+docs-tools-stamp
+proto-tools-stamp
+golangci-lint
+keyring_test_cosmos
+./**/node_modules
+./**/dist
+secret.yml
+# vue/
 
-# Output of the go coverage tool, specifically when used with LiteIDE
+# Local docker volume mappings
+localnet-setup
+
+# Testing
+coverage.txt
 *.out
+sim_log_file
+tests/**/tmp/*
+yarn.lock
+
+# Vagrant
+.vagrant/
+*.box
+*.log
+vagrant
+
+# IDE
+.idea/
+*.iml
+
+# Graphviz
+dependency-graph.png
+
+# Latex
+*.aux
+*.out
+*.synctex.gz
+
+# Contracts
+*.bin
+*.abi
 
-# Dependency directories (remove the comment below to include it)
-# vendor/
+# Node.js
+tests/**/node_modules/*
+tests-solidity/**/node_modules/*

CHANGELOG.md

@@ -0,0 +1,38 @@
+<!--
+Guiding Principles:
+
+Changelogs are for humans, not machines.
+There should be an entry for every single version.
+The same types of changes should be grouped.
+Versions and sections should be linkable.
+The latest version comes first.
+The release date of each version is displayed.
+Mention whether you follow Semantic Versioning.
+
+Usage:
+
+Change log entries are to be added to the Unreleased section under the
+appropriate stanza (see below). Each entry should ideally include a tag and
+the Github issue reference in the following format:
+
+* (<tag>) \#<issue-number> message
+
+The issue numbers will later be link-ified during the release process so you do
+not have to worry about including a link manually, but you can if you wish.
+
+Types of changes (Stanzas):
+
+"Features" for new features.
+"Improvements" for changes in existing functionality.
+"Deprecated" for soon-to-be removed features.
+"Bug Fixes" for any bug fixes.
+"Client Breaking" for breaking CLI commands and REST routes used by end-users.
+"API Breaking" for breaking exported APIs used by developers building on SDK.
+"State Machine Breaking" for any changes that result in a different AppState given same genesisState and txList.
+
+Ref: https://keepachangelog.com/en/1.0.0/
+-->
+
+# Changelog
+
+## Unreleased

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,219 @@
+# Evmos Contributor Guidelines
+
+* [General Procedure](#general_procedure)
+* [Architecture Decision Records (ADR)](#adr)
+* [Forking](#forking)
+* [Dependencies](#dependencies)
+* [Protobuf](#protobuf)
+* [Development Procedure](#dev_procedure)
+* [Testing](#testing)
+* [Updating Documentation](#updating_doc)
+* [Branching Model and Release](#braching_model_and_release)
+  * [PR Targeting](#pr_targeting)
+  * [Pull Requests](#pull_requests)
+  * [Process for reviewing PRs](#reviewing_prs)
+  * [Pull Merge Procedure](#pull_merge_procedure)
+  * [Release Procedure](#release_procedure)
+
+## <span id="general_procedure">General Procedure</span>
+
+Thank you for considering making contributions to Evmos and related repositories!
+
+Evmos uses [Tendermint’s coding repo](https://github.com/tendermint/coding) for overall information on repository
+workflow and standards.
+
+Contributing to this repo can mean many things such as participating in discussion or proposing code changes. To ensure
+a smooth workflow for all contributors, the following general procedure for contributing has been established:
+
+1. Either [open](https://github.com/tharsis/evmos/issues/new/choose)
+   or [find](https://github.com/tharsis/evmos/issues) an issue you have identified and would like to contribute to
+   resolving.
+2. Participate in thoughtful discussion on that issue.
+3. If you would like to contribute:
+    1. If the issue is a proposal, ensure that the proposal has been accepted by the Evmos team.
+    2. Ensure that nobody else has already begun working on the same issue. If someone already has, please make sure to
+       contact the individual to collaborate.
+    3. If nobody has been assigned the issue and you would like to work on it, make a comment on the issue to inform the
+       community of your intentions to begin work. Ideally, wait for confirmation that no one has started it. However,
+       if you are eager and do not get a prompt response, feel free to dive on in!
+    4. Follow standard Github best practices:
+        1. Fork the repo
+        2. Branch from the HEAD of `development`(For core developers working within the evmos repo, to ensure a
+           clear ownership of branches, branches must be named with the convention `{moniker}/{issue#}-branch-name`).
+        3. Make commits
+        4. Submit a PR to `development`
+    5. Be sure to submit the PR in `Draft` mode. Submit your PR early, even if it's incomplete as this indicates to the
+       community you're working on something and allows them to provide comments early in the development process.
+    6. When the code is complete it can be marked `Ready for Review`.
+    7. Be sure to include a relevant change log entry in the `Unreleased` section of `CHANGELOG.md` (see file for log
+       format).
+    8. Please make sure to run `make format` before every commit - the easiest way to do this is having your editor run
+       it for you upon saving a file. Additionally, please ensure that your code is lint compliant by running `make lint`
+       . There are CI tests built into the Evmos repository and all PR’s will require that these tests pass before
+       they are able to be merged.
+
+**Note**: for very small or blatantly obvious problems (such as typos), it is not required to open an issue to submit a
+PR, but be aware that for more complex problems/features, if a PR is opened before an adequate design discussion has
+taken place in a github issue, that PR runs a high likelihood of being rejected.
+
+Looking for a good place to start contributing? How about checking out
+some [good first issues](https://github.com/tharsis/evmos/issues?q=label%3A%22good+first+issue%22).
+
+## <span id="adr">Architecture Decision Records (ADR)</span>
+
+When proposing an architecture decision for Evmos, please create
+an [ADR](https://github.com/tharsis/evmos/blob/main/docs/architecture/README.md) so further discussions can be
+made. We are following this process so all involved parties are in agreement before any party begins coding the proposed
+implementation. If you would like to see some examples of how these are written refer
+to [Tendermint ADRs](https://github.com/tendermint/tendermint/tree/master/docs/architecture).
+
+## <span id="forking">Forking</span>
+
+Please note that Go requires code to live under absolute paths, which complicates forking. While my fork lives
+at `https://github.com/tharsis/evmos`, the code should never exist
+at `$GOPATH/src/github.com/tharsis/evmos`. Instead, we use `git remote` to add the fork as a new remote for the
+original repo,`$GOPATH/src/github.com/tharsis/evmos`, and do all the work there.
+
+For instance, to create a fork and work on a branch of it, you would:
+
+1. Create the fork on github, using the fork button.
+2. Go to the original repo checked out locally. (i.e. `$GOPATH/src/github.com/tharsis/evmos`)
+3. `git remote rename origin upstream`
+4. `git remote add origin [email protected]:tharsis/evmos.git`
+
+Now `origin` refers to my fork and `upstream` refers to the evmos version. So I can `git push -u origin master` to
+update my fork, and make pull requests to evmos from there. Of course, replace `tharsis` with your git handle.
+
+To pull in updates from the origin repo, run:
+
+1. `git fetch upstream`
+2. `git rebase upstream/master` (or whatever branch you want)
+
+Please **NO DOT** make Pull Requests from `development`.
+
+## <span id="dependencies">Dependencies</span>
+
+We use [Go 1.17](https://github.com/golang/go/wiki/Modules) Modules to manage dependency versions.
+
+The master branch of every Cosmos repository should just build with `go get`, which means they should be kept up-to-date
+with their dependencies, so we can get away with telling people they can just `go get` our software.
+
+Since some dependencies are not under our control, a third party may break our build, in which case we can fall back
+on `go mod tidy -v`.
+
+## <span id="protobuf">Protobuf</span>
+
+We use [Protocol Buffers](https://developers.google.com/protocol-buffers) along
+with [gogoproto](https://github.com/gogo/protobuf) to generate code for use in Evmos.
+
+For deterministic behavior around Protobuf tooling, everything is containerized using Docker. Make sure to have Docker
+installed on your machine, or head to [Docker's website](https://docs.docker.com/get-docker/) to install it.
+
+For formatting code in `.proto` files, you can run `make proto-format` command.
+
+For linting and checking breaking changes, we use [buf](https://buf.build/). You can use the commands `make proto-lint`
+and `make proto-check-breaking` to respectively lint your proto files and check for breaking changes.
+
+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.
+
+In order for imports to properly compile in your IDE, you may need to manually set your protobuf path in your IDE's
+workspace `settings/config`.
+
+For example, in vscode your `.vscode/settings.json` should look like:
+
+```json
+{
+  "protoc": {
+    "options": [
+      "--proto_path=${workspaceRoot}/proto",
+      "--proto_path=${workspaceRoot}/third_party/proto"
+    ]
+  }
+}
+```
+
+## <span id="dev_procedure">Development Procedure</span>
+
+1. The latest state of development is on `development`.
+2. `development` must never
+   fail `make lint, make test, make test-race, make test-rpc, make test-import`
+3. No `--force` onto `development` (except when reverting a broken commit, which should seldom happen).
+4. Create your feature branch from `development` either on `github.com/tharsis/evmos`, or your fork (
+   using `git remote add origin`).
+5. Before submitting a pull request, begin `git rebase` on top of `development`.
+
+## <span id="testing">Testing</span>
+
+Evmos uses [GitHub Actions](https://github.com/features/actions) for automated testing.
+
+## <span id="updating_doc">Updating Documentation</span>
+
+If you open a PR on the Evmos repo, it is mandatory to update the relevant documentation in `/docs`. Please refer to
+the docs subdirectory and make changes accordingly. Prior to approval, the Code owners/approvers may request some
+updates to specific docs.
+
+## <span id="braching_model_and_release">Branching Model and Release</span>
+
+User-facing repos should adhere to the [trunk based development branching model](https://trunkbaseddevelopment.com/).
+
+Libraries need not follow the model strictly, but would be wise to.
+
+Evmos utilizes [semantic versioning](https://semver.org/).
+
+### <span id="pr_targeting">PR Targeting</span>
+
+Ensure that you base and target your PR on the `development` branch.
+
+All feature additions should be targeted against `development`. Bug fixes for an outstanding release candidate should be
+targeted against the release candidate branch.
+
+### <span id="pull_requests">Pull Requests</span>
+
+To accommodate the review process, we suggest that PRs are categorically broken up. Ideally each PR addresses only a
+single issue. Additionally, as much as possible code refactoring and cleanup should be submitted as separate PRs from
+bug fixes/feature-additions.
+
+### <span id="reviewing_prs">Process for reviewing PRs</span>
+
+All PRs require two Reviews before merge. When reviewing PRs, please use the following review explanations:
+
+1. `LGTM` without an explicit approval means that the changes look good, but you haven't pulled down the code, run tests
+   locally and thoroughly reviewed it.
+2. `Approval` through the GH UI means that you understand the code, documentation/spec is updated in the right places,
+   you have pulled down and tested the code locally. In addition:
+    * You must think through whether any added code could be partially combined (DRYed) with existing code.
+    * You must think through any potential security issues or incentive-compatibility flaws introduced by the changes.
+    * Naming convention must be consistent with the rest of the codebase.
+    * Code must live in a reasonable location, considering dependency structures (e.g. not importing testing modules in
+      production code, or including example code modules in production code).
+    * If you approve of the PR, you are responsible for fixing any of the issues mentioned here.
+3. If you are only making "surface level" reviews, submit any notes as `Comments` without adding a review.
+
+### <span id="pull_merge_procedure">Pull Merge Procedure</span>
+
+1. Ensure pull branch is rebased on `development`.
+2. Run `make test` to ensure that all tests pass.
+3. Squash merge pull request.
+
+### <span id="release_procedure">Release Procedure</span>
+
+1. Start on `development`.
+2. Create the release candidate branch `rc/v*` (going forward known as `RC`) and ensure it's protected against pushing
+   from anyone except the release manager/coordinator. No PRs targeting this branch should be merged unless exceptional
+   circumstances arise.
+3. On the `RC` branch, prepare a new version section in the `CHANGELOG.md`. All links must be link-ified:   
+   `$ python ./scripts/linkify_changelog.py CHANGELOG.md`  
+   Copy the entries into a `RELEASE_CHANGELOG.md`. This is needed so the bot knows which entries to add to the release
+   page on github.
+4. Kick off a large round of simulation testing (e.g. 400 seeds for 2k blocks).
+5. If errors are found during the simulation testing, commit the fixes to `development` and create a new `RC` branch (
+   making sure to increment the `rcN`).
+6. After simulation has successfully completed, create the release branch (`release/vX.XX.X`) from the `RC` branch.
+7. Create a PR to `development` to incorporate the `CHANGELOG.md` updates.
+8. Tag the release (use `git tag -a`) and create a release in Github.
+9. Delete the `RC` branches.
+
+**Note**: tharsis’s Evmos team currently cuts releases on a need to have basis. We will announce a more
+standardized release schedule as we near production readiness.