You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

269 lines
12 KiB

7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
[RPC] Static swagger (#3880) * manually swagging Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * three definitions with polymorphism Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * added blockchain and block Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * low quality generation, commit, block_response and validators Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * genesis and consensus states endpoints Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * fix indentation Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * consensus parameters Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * fix indentation Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * add height to consensus parameters endpoint Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * unconfirmed_txs and num_unconfirmed_txs Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * add missing query parameter Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * add ABCI queries Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * added index document for swagger documentation Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * add missing routes Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * contract tests added on CCI Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * contract tests job should be in the test suite Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * simplify requirements to test Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * typo Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * build is a prerequisite to start localnet Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * reduce nodejs size, move goodman to get_tools, add docs, fix comments Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * Update scripts/get_tools.sh That's cleaner, thanks! Co-Authored-By: Anton Kaliaev <anton.kalyaev@gmail.com> * xz not supported by cci image, let's keep it simple Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * REMOVE-indirect debug of CCI paths Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * dirty experiment, volume is empty but binary has been produced Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * dirty experiment, volume is empty but binary has been produced Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * dirty experiment going on Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * locally works, CCI have difficulties with second layaer containers volumes Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * restore experiment, use machine instead of docker for contract tests Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * simplify a bit Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * rollback on machine golang Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * Document the changes Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * Changelog Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * comments Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com>
5 years ago
[RPC] Static swagger (#3880) * manually swagging Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * three definitions with polymorphism Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * added blockchain and block Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * low quality generation, commit, block_response and validators Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * genesis and consensus states endpoints Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * fix indentation Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * consensus parameters Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * fix indentation Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * add height to consensus parameters endpoint Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * unconfirmed_txs and num_unconfirmed_txs Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * add missing query parameter Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * add ABCI queries Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * added index document for swagger documentation Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * add missing routes Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * contract tests added on CCI Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * contract tests job should be in the test suite Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * simplify requirements to test Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * typo Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * build is a prerequisite to start localnet Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * reduce nodejs size, move goodman to get_tools, add docs, fix comments Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * Update scripts/get_tools.sh That's cleaner, thanks! Co-Authored-By: Anton Kaliaev <anton.kalyaev@gmail.com> * xz not supported by cci image, let's keep it simple Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * REMOVE-indirect debug of CCI paths Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * dirty experiment, volume is empty but binary has been produced Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * dirty experiment, volume is empty but binary has been produced Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * dirty experiment going on Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * locally works, CCI have difficulties with second layaer containers volumes Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * restore experiment, use machine instead of docker for contract tests Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * simplify a bit Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * rollback on machine golang Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * Document the changes Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * Changelog Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * comments Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com>
5 years ago
[RPC] Static swagger (#3880) * manually swagging Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * three definitions with polymorphism Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * added blockchain and block Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * low quality generation, commit, block_response and validators Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * genesis and consensus states endpoints Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * fix indentation Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * consensus parameters Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * fix indentation Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * add height to consensus parameters endpoint Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * unconfirmed_txs and num_unconfirmed_txs Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * add missing query parameter Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * add ABCI queries Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * added index document for swagger documentation Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * add missing routes Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * contract tests added on CCI Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * contract tests job should be in the test suite Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * simplify requirements to test Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * typo Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * build is a prerequisite to start localnet Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * reduce nodejs size, move goodman to get_tools, add docs, fix comments Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * Update scripts/get_tools.sh That's cleaner, thanks! Co-Authored-By: Anton Kaliaev <anton.kalyaev@gmail.com> * xz not supported by cci image, let's keep it simple Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * REMOVE-indirect debug of CCI paths Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * dirty experiment, volume is empty but binary has been produced Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * dirty experiment, volume is empty but binary has been produced Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * dirty experiment going on Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * locally works, CCI have difficulties with second layaer containers volumes Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * restore experiment, use machine instead of docker for contract tests Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * simplify a bit Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * rollback on machine golang Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * Document the changes Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * Changelog Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * comments Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com>
5 years ago
  1. # Contributing
  2. Thank you for your interest in contributing to Tendermint! Before
  3. contributing, it may be helpful to understand the goal of the project. The goal
  4. of Tendermint is to develop a BFT consensus engine robust enough to
  5. support permissionless value-carrying networks. While all contributions are
  6. welcome, contributors should bear this goal in mind in deciding if they should
  7. target the main tendermint project or a potential fork. When targeting the
  8. main Tendermint project, the following process leads to the best chance of
  9. landing changes in master.
  10. All work on the code base should be motivated by a [Github
  11. Issue](https://github.com/tendermint/tendermint/issues).
  12. [Search](https://github.com/tendermint/tendermint/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)
  13. is a good place start when looking for places to contribute. If you
  14. would like to work on an issue which already exists, please indicate so
  15. by leaving a comment.
  16. All new contributions should start with a [Github
  17. Issue](https://github.com/tendermint/tendermint/issues/new/choose). The
  18. issue helps capture the problem you're trying to solve and allows for
  19. early feedback. Once the issue is created the process can proceed in different
  20. directions depending on how well defined the problem and potential
  21. solution are. If the change is simple and well understood, maintainers
  22. will indicate their support with a heartfelt emoji.
  23. If the issue would benefit from thorough discussion, maintainers may
  24. request that you create a [Request For
  25. Comment](https://github.com/tendermint/spec/tree/master/rfc). Discussion
  26. at the RFC stage will build collective understanding of the dimensions
  27. of the problems and help structure conversations around trade-offs.
  28. When the problem is well understood but the solution leads to large
  29. structural changes to the code base, these changes should be proposed in
  30. the form of an [Architectural Decision Record
  31. (ADR)](./docs/architecture/). The ADR will help build consensus on an
  32. overall strategy to ensure the code base maintains coherence
  33. in the larger context. If you are not comfortable with writing an ADR,
  34. you can open a less-formal issue and the maintainers will help you
  35. turn it into an ADR. ADR numbers can be registered [here](https://github.com/tendermint/tendermint/issues/2313).
  36. When the problem as well as proposed solution are well understood,
  37. changes should start with a [draft
  38. pull request](https://github.blog/2019-02-14-introducing-draft-pull-requests/)
  39. against master. The draft signals that work is underway. When the work
  40. is ready for feedback, hitting "Ready for Review" will signal to the
  41. maintainers to take a look.
  42. ![Contributing flow](./docs/imgs/contributing.png)
  43. Each stage of the process is aimed at creating feedback cycles which align contributors and maintainers to make sure:
  44. - Contributors don’t waste their time implementing/proposing features which won’t land in master.
  45. - Maintainers have the necessary context in order to support and review contributions.
  46. ## Forking
  47. Please note that Go requires code to live under absolute paths, which complicates forking.
  48. While my fork lives at `https://github.com/ebuchman/tendermint`,
  49. the code should never exist at `$GOPATH/src/github.com/ebuchman/tendermint`.
  50. Instead, we use `git remote` to add the fork as a new remote for the original repo,
  51. `$GOPATH/src/github.com/tendermint/tendermint`, and do all the work there.
  52. For instance, to create a fork and work on a branch of it, I would:
  53. - Create the fork on github, using the fork button.
  54. - Go to the original repo checked out locally (i.e. `$GOPATH/src/github.com/tendermint/tendermint`)
  55. - `git remote rename origin upstream`
  56. - `git remote add origin git@github.com:ebuchman/basecoin.git`
  57. Now `origin` refers to my fork and `upstream` refers to the tendermint version.
  58. So I can `git push -u origin master` to update my fork, and make pull requests to tendermint from there.
  59. Of course, replace `ebuchman` with your git handle.
  60. To pull in updates from the origin repo, run
  61. - `git fetch upstream`
  62. - `git rebase upstream/master` (or whatever branch you want)
  63. ## Dependencies
  64. We use [go modules](https://github.com/golang/go/wiki/Modules) to manage dependencies.
  65. That said, the master branch of every Tendermint repository should just build
  66. with `go get`, which means they should be kept up-to-date with their
  67. dependencies so we can get away with telling people they can just `go get` our
  68. software.
  69. Since some dependencies are not under our control, a third party may break our
  70. build, in which case we can fall back on `go mod tidy`. Even for dependencies under our control, go helps us to
  71. keep multiple repos in sync as they evolve. Anything with an executable, such
  72. as apps, tools, and the core, should use dep.
  73. Run `go list -u -m all` to get a list of dependencies that may not be
  74. up-to-date.
  75. When updating dependencies, please only update the particular dependencies you
  76. need. Instead of running `go get -u=patch`, which will update anything,
  77. specify exactly the dependency you want to update, eg.
  78. `GO111MODULE=on go get -u github.com/tendermint/go-amino@master`.
  79. ## Protobuf
  80. We use [Protocol Buffers](https://developers.google.com/protocol-buffers) along with [gogoproto](https://github.com/gogo/protobuf) to generate code for use across Tendermint Core.
  81. For linting and checking breaking changes, we use [buf](https://buf.build/). If you would like to run linting and check if the changes you have made are breaking then you will need to have docker running locally. Then the linting cmd will be `make proto-lint` and the breaking changes check will be `make proto-check-breaking`.
  82. To generate new stubs based off of your changes you can run `make proto-gen` after installing `protoc` and gogoproto.
  83. ### Installation Instructions
  84. To install `protoc`, download an appropriate release (https://github.com/protocolbuffers/protobuf) and then move the provided binaries into your PATH (follow instructions in README included with the download).
  85. To install `gogoproto`, do the following:
  86. ```sh
  87. $ go get github.com/gogo/protobuf/gogoproto
  88. $ cd $GOPATH/pkg/mod/github.com/gogo/protobuf@v1.3.1 # or wherever go get installs things
  89. $ make install
  90. ```
  91. You should now be able to run `make proto-gen` from inside the root Tendermint directory to generate new files from proto files.
  92. ## Vagrant
  93. If you are a [Vagrant](https://www.vagrantup.com/) user, you can get started
  94. hacking Tendermint with the commands below.
  95. NOTE: In case you installed Vagrant in 2017, you might need to run
  96. `vagrant box update` to upgrade to the latest `ubuntu/xenial64`.
  97. ```
  98. vagrant up
  99. vagrant ssh
  100. make test
  101. ```
  102. ## Changelog
  103. Every fix, improvement, feature, or breaking change should be made in a
  104. pull-request that includes an update to the `CHANGELOG_PENDING.md` file.
  105. Changelog entries should be formatted as follows:
  106. ```
  107. - [module] \#xxx Some description about the change (@contributor)
  108. ```
  109. Here, `module` is the part of the code that changed (typically a
  110. top-level Go package), `xxx` is the pull-request number, and `contributor`
  111. is the author/s of the change.
  112. It's also acceptable for `xxx` to refer to the relevent issue number, but pull-request
  113. numbers are preferred.
  114. Note this means pull-requests should be opened first so the changelog can then
  115. be updated with the pull-request's number.
  116. There is no need to include the full link, as this will be added
  117. automatically during release. But please include the backslash and pound, eg. `\#2313`.
  118. Changelog entries should be ordered alphabetically according to the
  119. `module`, and numerically according to the pull-request number.
  120. Changes with multiple classifications should be doubly included (eg. a bug fix
  121. that is also a breaking change should be recorded under both).
  122. Breaking changes are further subdivided according to the APIs/users they impact.
  123. Any change that effects multiple APIs/users should be recorded multiply - for
  124. instance, a change to the `Blockchain Protocol` that removes a field from the
  125. header should also be recorded under `CLI/RPC/Config` since the field will be
  126. removed from the header in rpc responses as well.
  127. ## Branching Model and Release
  128. The main development branch is master.
  129. Every release is maintained in a release branch named `vX.Y.Z`.
  130. Note all pull requests should be squash merged except for merging to a release branch (named `vX.Y`). This keeps the commit history clean and makes it
  131. easy to reference the pull request where a change was introduced.
  132. ### Development Procedure
  133. - the latest state of development is on `master`
  134. - `master` must never fail `make test`
  135. - never --force onto `master` (except when reverting a broken commit, which should seldom happen)
  136. - create a development branch either on github.com/tendermint/tendermint, or your fork (using `git remote add origin`)
  137. - make changes and update the `CHANGELOG_PENDING.md` to record your change
  138. - before submitting a pull request, run `git rebase` on top of the latest `master`
  139. ### Pull Merge Procedure
  140. - ensure pull branch is based on a recent `master`
  141. - run `make test` to ensure that all tests pass
  142. - [squash](https://stackoverflow.com/questions/5189560/squash-my-last-x-commits-together-using-git) merge pull request
  143. - the `unstable` branch may be used to aggregate pull merges before fixing tests
  144. ### Git Commit Style
  145. We follow the [Go style guide on commit messages](https://tip.golang.org/doc/contribute.html#commit_messages). Write concise commits that start with the package name and have a description that finishes the sentence "This change modifies Tendermint to...". For example,
  146. \```
  147. cmd/debug: execute p.Signal only when p is not nil
  148. [potentially longer description in the body]
  149. Fixes #nnnn
  150. \```
  151. Each PR should have one commit once it lands on `master`; this can be accomplished by using the "squash and merge" button on Github. Be sure to edit your commit message, though!
  152. ### Release Procedure
  153. #### Major Release
  154. 1. start on `master`
  155. 2. run integration tests (see `test_integrations` in Makefile)
  156. 3. prepare release in a pull request against `master` (to be squash merged):
  157. - copy `CHANGELOG_PENDING.md` to top of `CHANGELOG.md`
  158. - run `python ./scripts/linkify_changelog.py CHANGELOG.md` to add links for
  159. all issues
  160. - run `bash ./scripts/authors.sh` to get a list of authors since the latest
  161. release, and add the github aliases of external contributors to the top of
  162. the changelog. To lookup an alias from an email, try `bash ./scripts/authors.sh <email>`
  163. - reset the `CHANGELOG_PENDING.md`
  164. - bump versions
  165. 4. push your changes with prepared release details to `vX.X` (this will trigger the release `vX.X.0`)
  166. 5. merge back to master (don't squash merge!)
  167. #### Minor Release
  168. If there were no breaking changes and you need to create a release nonetheless,
  169. the procedure is almost exactly like with a new release above.
  170. The only difference is that in the end you create a pull request against the existing `X.X` branch.
  171. The branch name should match the release number you want to create.
  172. Merging this PR will trigger the next release.
  173. For example, if the PR is against an existing 0.34 branch which already contains a v0.34.0 release/tag,
  174. the patch version will be incremented and the created release will be v0.34.1.
  175. #### Backport Release
  176. 1. start from the existing release branch you want to backport changes to (e.g. v0.30)
  177. Branch to a release/vX.X.X branch locally (e.g. release/v0.30.7)
  178. 2. cherry pick the commit(s) that contain the changes you want to backport (usually these commits are from squash-merged PRs which were already reviewed)
  179. 3. steps 2 and 3 from [Major Release](#major-release)
  180. 4. push changes to release/vX.X.X branch
  181. 5. open a PR against the existing vX.X branch
  182. ## Testing
  183. All repos should be hooked up to [CircleCI](https://circleci.com/).
  184. If they have `.go` files in the root directory, they will be automatically
  185. tested by circle using `go test -v -race ./...`. If not, they will need a
  186. `circle.yml`. Ideally, every repo has a `Makefile` that defines `make test` and
  187. includes its continuous integration status using a badge in the `README.md`.
  188. ### RPC Testing
  189. If you contribute to the RPC endpoints it's important to document your changes in the [Swagger file](./rpc/swagger/swagger.yaml)
  190. To test your changes you should install `nodejs` and run:
  191. ```bash
  192. npm i -g dredd
  193. make build-linux build-contract-tests-hooks
  194. make contract-tests
  195. ```
  196. This command will popup a network and check every endpoint against what has been documented