Skip to content

Commit

Permalink
Rename Tendermint to CometBFT: further actions (#224)
Browse files Browse the repository at this point in the history
* rename: Tendermint -> CometBFT in README files

* rename: Tendermint -> CometBFT in doc.go files

* rename: Tendermint -> CometBFT in Go documentation

* Removing unused/outdated CHANGELOGs

* rename: using CometBFT in issues and PR templates

* rename: references to tendermin in libs/events

* rename: renaming on text files under rpc/ dir

* rename: Tendermint-go -> CometBFT in proto docs

* rename: Tendermint -> CometBFT in generated go docs

* rename: renaming Tendermint -> CometBFT in scripts

* rename: renaming to CometBFT in code comments

* rename: general script files on repository root

* rename: using CometBFT in github config files

* rename: Go docs in .proto files, pb.go regenerated

* rename: toml config file generated content

* rename: avoiding unnecessary TM entries in comments

* rename: renaming in log messages and strings

* rename: upgrading instructions renamed, needs review

* rename: fixing generated protobuf files

* rename: fixing generated protobuf files

* rename: fixing broken test, renamed string

* Apply suggestions from code review

* Update .github/PULL_REQUEST_TEMPLATE.md

Co-authored-by: Thane Thomson <connect@thanethomson.com>

* Update abci/README.md

Co-authored-by: Thane Thomson <connect@thanethomson.com>

* Update proto/README.md

Co-authored-by: Thane Thomson <connect@thanethomson.com>

* rename: removing unused files on repo root

---------

Co-authored-by: Daniel Cason <cason@gandria>
Co-authored-by: Thane Thomson <connect@thanethomson.com>
(cherry picked from commit 1cb55d4)

# Conflicts:
#	.github/ISSUE_TEMPLATE/bug-report.md
#	.github/ISSUE_TEMPLATE/config.yml
#	.github/PULL_REQUEST_TEMPLATE.md
#	.github/issue_template.md
#	.github/workflows/janitor.yml
#	.github/workflows/lint.yml
#	.gitignore
#	.goreleaser.yml
#	UPGRADING.md
#	abci/README.md
#	abci/types/application.go
#	abci/types/mocks/base.go
#	cmd/cometbft/commands/version.go
#	config/config.go
#	config/toml.go
#	consensus/README.md
#	consensus/replay.go
#	consensus/replay_test.go
#	consensus/state.go
#	crypto/README.md
#	crypto/ed25519/ed25519.go
#	inspect/doc.go
#	inspect/inspect.go
#	internal/test/doc.go
#	libs/pubsub/query/query.go
#	libs/pubsub/query/syntax/doc.go
#	light/doc.go
#	networks/local/README.md
#	node/node.go
#	node/setup.go
#	p2p/README.md
#	proto/README.md
#	rpc/core/abci.go
#	rpc/core/blocks.go
#	rpc/core/consensus.go
#	rpc/core/doc.go
#	rpc/core/events.go
#	rpc/core/evidence.go
#	rpc/core/health.go
#	rpc/core/mempool.go
#	rpc/core/net.go
#	rpc/core/status.go
#	rpc/core/tx.go
#	rpc/jsonrpc/doc.go
#	rpc/openapi/openapi.yaml
#	scripts/metricsgen/metricsgen.go
#	test/fuzz/README.md
#	test/fuzz/oss-fuzz-build.sh
#	test/loadtime/cmd/load/main.go
#	tools/README.md
#	version/version.go
  • Loading branch information
cason authored and mergify[bot] committed Feb 1, 2023
1 parent d41a46e commit 1b1844d
Show file tree
Hide file tree
Showing 127 changed files with 2,171 additions and 884 deletions.
11 changes: 10 additions & 1 deletion .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,20 @@ about: Create a report to help us squash bugs!
<!--
Please fill in as much of the template below as you can.
<<<<<<< HEAD
Be ready for followup questions, and please respond in a timely
manner. We might ask you to provide additional logs and data (tendermint & app).
=======
If you have general questions, please create a new discussion:
https://github.com/cometbft/cometbft/discussions
Be ready for followup questions, and please respond in a timely manner. We might
ask you to provide additional logs and data (CometBFT & App).
>>>>>>> 1cb55d49b (Rename Tendermint to CometBFT: further actions (#224))
-->

**Tendermint version** (use `tendermint version` or `git rev-parse --verify HEAD` if installed from source):
**CometBFT version** (use `cometbft version` or `git rev-parse --verify HEAD` if installed from source):


**ABCI app** (name for built-in, URL for self-written if it's publicly available):
Expand Down
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Ask a question
url: https://github.com/cometbft/cometbft/discussions
about: Please ask and answer questions here
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ v without deliberation

<!-- Why do we need this feature?
What problems may be addressed by introducing this feature?
What benefits does Tendermint stand to gain by including this feature?
What benefits does CometBFT stand to gain by including this feature?
Are there any disadvantages of including this feature? -->

## Proposal
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/proposal.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ v Word of caution: Under-specified proposals may be rejected summarily

<!-- Why do we need this change?
What problems may be addressed by introducing this change?
What benefits does Tendermint stand to gain by including this change?
What benefits does CometBFT stand to gain by including this change?
Are there any disadvantages of including this change? -->

## Proposal
Expand Down
28 changes: 28 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,33 @@
_Please add a description of the changes that this PR introduces and the files that
are the most critical to review._

<<<<<<< HEAD
Closes: #XXX
=======
If this PR is non-trivial/large/complex, please ensure that you have either
created an issue that the team's had a chance to respond to, or had some
discussion with the team prior to submitting substantial pull requests. The team
can be reached via GitHub Discussions or the Cosmos Network Discord server in
the #cometbft channel. GitHub Discussions is preferred over Discord as it
allows us to keep track of conversations topically.
https://github.com/cometbft/cometbft/discussions

If the work in this PR is not aligned with the team's current priorities, please
be advised that it may take some time before it is merged - especially if it has
not yet been discussed with the team.

See the project board for the team's current priorities:
https://github.com/orgs/cometbft/projects/1

-->

---

#### PR checklist

- [ ] Tests written/updated, or no tests needed
- [ ] `CHANGELOG_PENDING.md` updated, or no changelog entry needed
- [ ] Updated relevant documentation (`docs/`) and code comments, or no
documentation updates needed
>>>>>>> 1cb55d49b (Rename Tendermint to CometBFT: further actions (#224))
6 changes: 6 additions & 0 deletions .github/issue_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<!--
If you want to ask a general question, please create a new discussion instead of
an issue: https://github.com/cometbft/cometbft/discussions
-->
16 changes: 16 additions & 0 deletions .github/workflows/janitor.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: Janitor
# Janitor cleans up previous runs of various workflows
# To add more workflows to cancel visit https://api.github.com/repos/cometbft/cometbft/actions/workflows and find the actions name
on:
pull_request:

jobs:
cancel:
name: "Cancel Previous Runs"
runs-on: ubuntu-latest
timeout-minutes: 3
steps:
- uses: styfle/cancel-workflow-action@0.11.0
with:
workflow_id: 1041851,1401230,2837803
access_token: ${{ github.token }}
13 changes: 13 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,20 @@
<<<<<<< HEAD
name: Lint
# Lint runs golangci-lint over the entire Tendermint repository
# This workflow is run on every pull request and push to master
# The `golangci` job will pass without running if no *.{go, mod, sum} files have been modified.
=======
name: Golang Linter
# Lint runs golangci-lint over the entire CometBFT repository.
#
# This workflow is run on every pull request and push to main.
#
# The `golangci` job will pass without running if no *.{go, mod, sum}
# files have been modified.
#
# To run this locally, simply run `make lint` from the root of the repo.

>>>>>>> 1cb55d49b (Rename Tendermint to CometBFT: further actions (#224))
on:
pull_request:
push:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/pre-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ jobs:
args: build --skip-validate # skip validate skips initial sanity checks in order to be able to fully run

# Link to CHANGELOG_PENDING.md as release notes.
- run: echo https://github.com/tendermint/tendermint/blob/${GITHUB_REF#refs/tags/}/CHANGELOG_PENDING.md > ../release_notes.md
- run: echo https://github.com/cometbft/cometbft/blob/${GITHUB_REF#refs/tags/}/CHANGELOG_PENDING.md > ../release_notes.md

- name: Release
uses: goreleaser/goreleaser-action@v4
Expand Down Expand Up @@ -58,7 +58,7 @@ jobs:
"type": "section",
"text": {
"type": "mrkdwn",
"text": ":sparkles: New Tendermint pre-release: <${{ env.RELEASE_URL }}|${{ github.ref_name }}>"
"text": ":sparkles: New CometBFT pre-release: <${{ env.RELEASE_URL }}|${{ github.ref_name }}>"
}
}
]
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:
version: latest
args: build --skip-validate # skip validate skips initial sanity checks in order to be able to fully run

- run: echo https://github.com/tendermint/tendermint/blob/${GITHUB_REF#refs/tags/}/CHANGELOG.md#${GITHUB_REF#refs/tags/} > ../release_notes.md
- run: echo https://github.com/cometbft/cometbft/blob/${GITHUB_REF#refs/tags/}/CHANGELOG.md#${GITHUB_REF#refs/tags/} > ../release_notes.md

- name: Release
uses: goreleaser/goreleaser-action@v4
Expand Down Expand Up @@ -55,7 +55,7 @@ jobs:
"type": "section",
"text": {
"type": "mrkdwn",
"text": ":rocket: New Tendermint release: <${{ env.RELEASE_URL }}|${{ github.ref_name }}>"
"text": ":rocket: New CometBFT release: <${{ env.RELEASE_URL }}|${{ github.ref_name }}>"
}
}
]
Expand Down
13 changes: 13 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
*.swp
*.swo
.bak
<<<<<<< HEAD
*.bak
.DS_Store
build/*
=======
.idea/
.revision
>>>>>>> 1cb55d49b (Rename Tendermint to CometBFT: further actions (#224))
.cometbft
.cometbft-lite
rpc/test/.cometbft
Expand All @@ -22,7 +27,15 @@ abci-cli
docs/node_modules/
docs/.vuepress/public/rpc
index.html.md
<<<<<<< HEAD

=======
libs/pubsub/query/fuzz_test/output
profile\.out
remote_dump
rpc/test/.cometbft
scripts/cutWALUntil/cutWALUntil
>>>>>>> 1cb55d49b (Rename Tendermint to CometBFT: further actions (#224))
scripts/wal2json/wal2json
scripts/cutWALUntil/cutWALUntil

Expand Down
7 changes: 6 additions & 1 deletion .goreleaser.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
project_name: tendermint
project_name: cometbft

env:
# Require use of Go modules.
- GO111MODULE=on

builds:
<<<<<<< HEAD
- id: "Tendermint"
main: ./cmd/tendermint/main.go
=======
- id: "cometbft"
main: ./cmd/cometbft/main.go
>>>>>>> 1cb55d49b (Rename Tendermint to CometBFT: further actions (#224))
ldflags:
- -s -w -X github.com/cometbft/cometbft/version.TMCoreSemVer={{ .Version }}
env:
Expand Down
25 changes: 25 additions & 0 deletions UPGRADING.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ Note also that Tendermint 0.34 also requires Go 1.16 or higher.

* The `ABCIVersion` is now `0.17.0`.

<<<<<<< HEAD
* New ABCI methods (`ListSnapshots`, `LoadSnapshotChunk`, `OfferSnapshot`, and `ApplySnapshotChunk`)
were added to support the new State Sync feature.
Previously, syncing a new node to a preexisting network could take days; but with State Sync,
Expand Down Expand Up @@ -766,3 +767,27 @@ multiple validator sets at once to accomodate this delay.
The `ConsensusParams.BlockSize.MaxTxs` was removed in favour of
`ConsensusParams.BlockSize.MaxBytes`, which is now enforced. This means blocks
are limitted only by byte-size, not by number of transactions.
=======
* Added new ABCI methods `PrepareProposal` and `ProcessProposal`. For details,
please see the [spec](spec/abci/README.md). Applications upgrading to
v0.37.0 must implement these methods, at the very minimum, as described
[here](./spec/abci/abci++_app_requirements.md)
* Deduplicated `ConsensusParams` and `BlockParams`.
In the v0.34 branch they are defined both in `abci/types.proto` and `types/params.proto`.
The definitions in `abci/types.proto` have been removed.
In-process applications should make sure they are not using the deleted
version of those structures.
* In v0.34, messages on the wire used to be length-delimited with `int64` varint
values, which was inconsistent with the `uint64` varint length delimiters used
in the P2P layer. Both now consistently use `uint64` varint length delimiters.
* Added `AbciVersion` to `RequestInfo`.
Applications should check that CometBFT's ABCI version matches the one they expect
in order to ensure compatibility.
* The `SetOption` method has been removed from the ABCI `Client` interface.
The corresponding Protobuf types have been deprecated.
* The `key` and `value` fields in the `EventAttribute` type have been changed
from type `bytes` to `string`. As per the [Protocol Buffers updating
guidelines](https://developers.google.com/protocol-buffers/docs/proto3#updating),
this should have no effect on the wire-level encoding for UTF8-encoded
strings.
>>>>>>> 1cb55d49b (Rename Tendermint to CometBFT: further actions (#224))
66 changes: 0 additions & 66 deletions Vagrantfile

This file was deleted.

6 changes: 5 additions & 1 deletion abci/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ can manage an application state running in another.

Previously, the ABCI was referred to as TMSP.

The community has provided a number of additional implementations, see the [Tendermint Ecosystem](https://github.com/tendermint/awesome#ecosystem)


## Installation & Usage
Expand All @@ -19,8 +18,13 @@ To get up and running quickly, see the [getting started guide](../docs/app-dev/g

A detailed description of the ABCI methods and message types is contained in:

<<<<<<< HEAD
- [The main spec](https://github.com/tendermint/tendermint/blob/v0.34.x/spec/abci/abci.md)
- [A protobuf file](./types/types.proto)
=======
- [The main spec](https://github.com/cometbft/cometbft/blob/main/spec/abci/README.md)
- [A protobuf file](../proto/tendermint/types/types.proto)
>>>>>>> 1cb55d49b (Rename Tendermint to CometBFT: further actions (#224))
- [A Go interface](./types/application.go)

## Protocol Buffers
Expand Down
2 changes: 1 addition & 1 deletion abci/example/kvstore/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The app has no replay protection (other than what the mempool provides).
The PersistentKVStoreApplication wraps the KVStoreApplication
and provides two additional features:

1) persistence of state across app restarts (using Tendermint's ABCI-Handshake mechanism)
1) persistence of state across app restarts (using CometBFT's ABCI-Handshake mechanism)
2) validator set changes

The state is persisted in leveldb along with the last block committed,
Expand Down
6 changes: 6 additions & 0 deletions abci/types/application.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,13 @@ type Application interface {
CheckTx(RequestCheckTx) ResponseCheckTx // Validate a tx for the mempool

// Consensus Connection
<<<<<<< HEAD
InitChain(RequestInitChain) ResponseInitChain // Initialize blockchain w validators/other info from TendermintCore
=======
InitChain(RequestInitChain) ResponseInitChain // Initialize blockchain w validators/other info from CometBFT
PrepareProposal(RequestPrepareProposal) ResponsePrepareProposal
ProcessProposal(RequestProcessProposal) ResponseProcessProposal
>>>>>>> 1cb55d49b (Rename Tendermint to CometBFT: further actions (#224))
BeginBlock(RequestBeginBlock) ResponseBeginBlock // Signals the beginning of a block
DeliverTx(RequestDeliverTx) ResponseDeliverTx // Deliver a tx for full processing
EndBlock(RequestEndBlock) ResponseEndBlock // Signals the end of a block, returns changes to the validator set
Expand Down

0 comments on commit 1b1844d

Please sign in to comment.