diff --git a/.github/workflows/markdown-links.yml b/.github/workflows/markdown-links.yml index 6dead86294..6908866963 100644 --- a/.github/workflows/markdown-links.yml +++ b/.github/workflows/markdown-links.yml @@ -2,15 +2,19 @@ name: Check Markdown links on: - # Temporarily disabled job on PRs. Re-enable when docs are fixed. - # pull_request: - # paths: - # - "**.md" + pull_request: push: branches: - master - dev +permissions: + contents: read + +concurrency: + group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.event.pull_request.number || github.run_id }} + cancel-in-progress: ${{ github.event_name == 'pull_request' }} + # Branch creation/rename events can refer to the deleted old branch. env: GIT_DIFF: ${{ github.event_name == 'push' && github.event.created && 'all' || '' }} @@ -23,10 +27,24 @@ jobs: - uses: technote-space/get-diff-action@v6 if: github.event_name != 'push' || !github.event.created with: + # book/ links are relative to the staged mdBook tree; the docs + # build checks them. PATTERNS: | **/**.md - - uses: gaurav-nelson/github-action-markdown-link-check@v1 - with: - check-modified-files-only: "yes" - config-file: ".md-link-check.json" + !book/** + FORMAT: json + # Also match .github/ and .agents/. + MINIMATCH_OPTION_DOT: true + - name: Check links in changed Markdown files if: env.GIT_DIFF + run: | + if [ "$GIT_DIFF" = all ]; then + mapfile -t files < <(git ls-files '*.md' ':!:book/**') + else + mapfile -t files < <(jq -r '.[]' <<<"$GIT_DIFF") + fi + if [ "${#files[@]}" -eq 0 ]; then + echo "No changed Markdown files." + exit 0 + fi + npx --yes markdown-link-check@3.14.2 --config .md-link-check.json --quiet -- "${files[@]}" diff --git a/.md-link-check.json b/.md-link-check.json index 6f47fa2c94..502eba4fae 100644 --- a/.md-link-check.json +++ b/.md-link-check.json @@ -2,5 +2,18 @@ "retryOn429": true, "retryCount": 5, "fallbackRetryDelay": "30s", - "aliveStatusCodes": [200, 206, 503] + "aliveStatusCodes": [200, 206, 503, 504], + "ignorePatterns": [ + { + "comment": "Cloudflare answers every non-browser client with a 403 challenge.", + "pattern": "^https://(eprint|www)\\.iacr\\.org/" + } + ], + "replacementPatterns": [ + { + "comment": "prepare-docs.py publishes rpc/openapi/ as api/rpc/ in the docs site.", + "pattern": "^((?:\\.\\./)*)api/rpc/", + "replacement": "$1rpc/openapi/" + } + ] } diff --git a/DOCKER/README.md b/DOCKER/README.md index 442e370651..1e3dc95a96 100644 --- a/DOCKER/README.md +++ b/DOCKER/README.md @@ -6,7 +6,7 @@ DockerHub tags for official releases are [here](https://hub.docker.com/r/dashpay Official releases can be found [here](https://github.com/dashpay/tenderdash/releases). -The Dockerfile used for all builds can be found [here](https://github.com/dashpay/tenderdash/blob/master/DOCKER/Dockerfile). +The Dockerfile used for all builds can be found [here](Dockerfile). Respective versioned files can be found at `https://raw.githubusercontent.com/tendermint/tendermint/vX.XX.XX/DOCKER/Dockerfile` (replace the Xs with the version number). diff --git a/Makefile b/Makefile index 2d442b0509..ce34d3f059 100644 --- a/Makefile +++ b/Makefile @@ -163,6 +163,8 @@ proto-doc: --doc_opt=markdown,api.md \ --doc_out=spec/abci \ tendermint/abci/types.proto +# Types from other packages are not in api.md; link their protos instead. + @perl -pi -e 's{\]\(#tendermint-(types|crypto|version)-\w+\)}{](../../proto/tendermint/$$1/)}g; s{\]\(#google-protobuf-(\w+)\)}{"](https://protobuf.dev/reference/protobuf/google.protobuf/#" . lc($$1) . ")"}ge' spec/abci/api.md ############################################################################### ### Build ABCI ### diff --git a/UPGRADING.md b/UPGRADING.md index 26556ccd16..78b5313945 100644 --- a/UPGRADING.md +++ b/UPGRADING.md @@ -1125,7 +1125,7 @@ the compilation tag: Use `cleveldb` tag instead of `gcc` to compile Tendermint with CLevelDB or use `make build_c` / `make install_c` (full instructions can be found at -) ## v0.31.0 diff --git a/crypto/README.md b/crypto/README.md index d60628d970..55708b98aa 100644 --- a/crypto/README.md +++ b/crypto/README.md @@ -12,7 +12,7 @@ For any specific algorithm, use its specific module e.g. ## Binary encoding -For Binary encoding, please refer to the [Tendermint encoding specification](https://docs.tendermint.com/master/spec/core/encoding.html). +For Binary encoding, please refer to the [Tendermint encoding specification](../spec/core/encoding.md). ## JSON Encoding diff --git a/docs/architecture/adr-079-ed25519-verification.md b/docs/architecture/adr-079-ed25519-verification.md index 273d4d2ba2..2b45fed78c 100644 --- a/docs/architecture/adr-079-ed25519-verification.md +++ b/docs/architecture/adr-079-ed25519-verification.md @@ -23,7 +23,7 @@ Ed25519 keys are the only supported key types for Tendermint validators currentl - This library is implements `ed25519.Verify()` in accordance to zip-215. Tendermint-go will continue to use `crypto/ed25519` for signing and key generation. - Tendermint-rs would adopt [ed25519-zebra](https://github.com/ZcashFoundation/ed25519-zebra) - - related [issue](https://github.com/informalsystems/tendermint-rs/issues/355) + - related [issue](https://github.com/cometbft/tendermint-rs/issues/355) Signature verification is one of the major bottlenecks of Tendermint-go, batch verification can not be used unless it has the same consensus rules, ZIP 215 makes verification safe in consensus critical areas. diff --git a/docs/nodes/running-in-production.md b/docs/nodes/running-in-production.md index 237d1e2627..e325e22180 100644 --- a/docs/nodes/running-in-production.md +++ b/docs/nodes/running-in-production.md @@ -321,7 +321,7 @@ give you limited number of file descriptors. If you want to accept greater number of connections, you will need to increase these limits. -[Sysctls to tune the system to be able to open more connections](https://github.com/satori-com/tcpkali/blob/master/doc/tcpkali.man.md#sysctls-to-tune-the-system-to-be-able-to-open-more-connections) +[Sysctls to tune the system to be able to open more connections](https://web.archive.org/web/2022/https://github.com/satori-com/tcpkali/blob/master/doc/tcpkali.man.md#sysctls-to-tune-the-system-to-be-able-to-open-more-connections) The process file limits must also be increased, e.g. via `ulimit -n 8192`. diff --git a/docs/nodes/validators.md b/docs/nodes/validators.md index 10898c61c6..dbc2f34a83 100644 --- a/docs/nodes/validators.md +++ b/docs/nodes/validators.md @@ -92,7 +92,7 @@ The sentry nodes should be able to talk to the entire network hence why `pex=tru More Information can be found at these links: -- +- - ### Validator keys diff --git a/docs/rfc/rfc-012-custom-indexing.md b/docs/rfc/rfc-012-custom-indexing.md index 18412d2399..4d8062c653 100644 --- a/docs/rfc/rfc-012-custom-indexing.md +++ b/docs/rfc/rfc-012-custom-indexing.md @@ -348,7 +348,7 @@ something like this (subject to refinement): [i7247]: https://github.com/tendermint/tendermint/issues/7247 [kv-index]: ../../internal/state/indexer/tx/kv [postgres]: https://postgresql.org/ -[psql]: https://github.com/tendermint/tendermint/blob/master/internal/state/indexer/sink/psql +[psql]: https://github.com/tendermint/tendermint/tree/master/internal/state/indexer/sink/psql [query]: https://pkg.go.dev/github.com/dashpay/tenderdash/internal/pubsub/query/syntax [sdk]: https://github.com/cosmos/cosmos-sdk [tmdb]: https://pkg.go.dev/github.com/cometbft/cometbft-db#DB diff --git a/docs/rfc/rfc-013-abci++.md b/docs/rfc/rfc-013-abci++.md index 0b301e673d..54aa1ffa77 100644 --- a/docs/rfc/rfc-013-abci++.md +++ b/docs/rfc/rfc-013-abci++.md @@ -239,7 +239,7 @@ Proposed ## References -Reference for IPC delay constants: +Reference for IPC delay constants: ### Short list of blocked features / scaling improvements with required ABCI++ Phases diff --git a/docs/rfc/rfc-019-config-version.md b/docs/rfc/rfc-019-config-version.md index 211853b393..26a325a5e3 100644 --- a/docs/rfc/rfc-019-config-version.md +++ b/docs/rfc/rfc-019-config-version.md @@ -293,10 +293,10 @@ balance: - [ADR 075: RPC Event Subscription Interface][adr075] [config-pkg]: https://godoc.org/github.com/tendermint/tendermint/config -[confix]: https://github.com/tendermint/tendermint/blob/master/scripts/confix -[condiff]: https://github.com/tendermint/tendermint/blob/master/scripts/confix/condiff -[plan]: https://github.com/tendermint/tendermint/blob/master/scripts/confix/plan.go -[testdata]: https://github.com/tendermint/tendermint/blob/master/scripts/confix/testdata +[confix]: ../../internal/libs/confix +[condiff]: https://github.com/dashpay/tenderdash/tree/6dd4bcc93efa5cdcafe8128502f81851fa574146/scripts/confix/condiff +[plan]: ../../internal/libs/confix/plan.go +[testdata]: ../../internal/libs/confix/testdata [adr075]: https://github.com/tendermint/tendermint/blob/master/docs/architecture/adr-075-rpc-subscription.md ## Appendix: Research Notes diff --git a/docs/rfc/rfc-021-socket-protocol.md b/docs/rfc/rfc-021-socket-protocol.md index 760e21f700..f10cb41c9e 100644 --- a/docs/rfc/rfc-021-socket-protocol.md +++ b/docs/rfc/rfc-021-socket-protocol.md @@ -260,10 +260,10 @@ visual inspection. - Tenderdash Core (Go): [client][socket-client], [server][socket-server] - Informal Systems [tendermint-rs](https://github.com/informalsystems/tendermint-rs) (Rust): [client](https://github.com/informalsystems/tendermint-rs/blob/master/abci/src/client.rs), [server](https://github.com/informalsystems/tendermint-rs/blob/master/abci/src/server.rs) - Tendermint [js-abci](https://github.com/tendermint/js-abci) (JS): [server](https://github.com/tendermint/js-abci/blob/master/src/server.js) -- [Hotmoka](https://github.com/Hotmoka/hotmoka) ABCI (Java): [server](https://github.com/Hotmoka/hotmoka/blob/master/io-hotmoka-tendermint-abci/src/main/java/io/hotmoka/tendermint_abci/Server.java) -- [Tower ABCI](https://github.com/penumbra-zone/tower-abci) (Rust): [server](https://github.com/penumbra-zone/tower-abci/blob/main/src/server.rs) +- [Hotmoka](https://github.com/Hotmoka/hotmoka) ABCI (Java): [server](https://github.com/Hotmoka/hotmoka/blob/master/io-hotmoka-node-tendermint-abci/src/main/java/io/hotmoka/tendermint/abci/Server.java) +- [Tower ABCI](https://github.com/penumbra-zone/tower-abci) (Rust): [server](https://github.com/penumbra-zone/tower-abci/blob/v0.5.0/src/server.rs) - [abci-host](https://github.com/datopia/abci-host) (Clojure): [server](https://github.com/datopia/abci-host/blob/master/src/abci/host.clj) - [abci_server](https://github.com/KrzysiekJ/abci_server) (Erlang): [server](https://github.com/KrzysiekJ/abci_server/blob/master/src/abci_server.erl) - [py-abci](https://github.com/davebryson/py-abci) (Python): [server](https://github.com/davebryson/py-abci/blob/master/src/abci/server.py) -- [scala-tendermint-server](https://github.com/intechsa/scala-tendermint-server) (Scala): [server](https://github.com/InTechSA/scala-tendermint-server/blob/master/src/main/scala/lu/intech/tendermint/Server.scala) +- [scala-tendermint-server](https://web.archive.org/web/2023/https://github.com/InTechSA/scala-tendermint-server) (Scala; repository no longer available, archived copy) - [kepler](https://github.com/f-o-a-m/kepler) (Rust): [server](https://github.com/f-o-a-m/kepler/blob/master/hs-abci-server/src/Network/ABCI/Server.hs) diff --git a/docs/tools/debugging/proposer-based-timestamps-runbook.md b/docs/tools/debugging/proposer-based-timestamps-runbook.md index 2f63e0ec5b..342cf7ff9b 100644 --- a/docs/tools/debugging/proposer-based-timestamps-runbook.md +++ b/docs/tools/debugging/proposer-based-timestamps-runbook.md @@ -81,7 +81,7 @@ to make sure your local clock is properly synchronized to NTP. NTP configuration and tooling is very specific to the operating system and distribution that your validator node is running. This guide assumes you have `timedatectl` installed with -[chrony](https://chrony.tuxfamily.org/), a popular tool for interacting with time +[chrony](https://chrony-project.org/), a popular tool for interacting with time synchronization on Linux distributions. If you are using an operating system or distribution with a different time synchronization mechanism, please consult the documentation for your operating system to check the status and re-synchronize the daemon. diff --git a/internal/p2p/README.md b/internal/p2p/README.md index 16ad1d5f68..23a9c2c707 100644 --- a/internal/p2p/README.md +++ b/internal/p2p/README.md @@ -4,8 +4,8 @@ The p2p package provides an abstraction around peer-to-peer communication. Docs: -- [Connection](https://docs.tendermint.com/master/spec/p2p/connection.html) for details on how connections and multiplexing work -- [Peer](https://docs.tendermint.com/master/spec/p2p/node.html) for details on peer ID, handshakes, and peer exchange -- [Node](https://docs.tendermint.com/master/spec/p2p/node.html) for details about different types of nodes and how they should work -- [Pex](https://docs.tendermint.com/master/spec/p2p/messages/pex.html) for details on peer discovery and exchange -- [Config](https://docs.tendermint.com/master/spec/p2p/config.html) for details on some config option +- [Connection](../../spec/p2p/connection.md) for details on how connections and multiplexing work +- [Peer](../../spec/p2p/peer.md) for details on peer ID, handshakes, and peer exchange +- [Node](../../spec/p2p/node.md) for details about different types of nodes and how they should work +- [Pex](../../spec/p2p/messages/pex.md) for details on peer discovery and exchange +- [Config](../../spec/p2p/config.md) for details on some config option diff --git a/networks/local/README.md b/networks/local/README.md index 10fc19932c..083da4ad22 100644 --- a/networks/local/README.md +++ b/networks/local/README.md @@ -1,3 +1,3 @@ # Local Cluster with Docker Compose -See the [docs](https://docs.tendermint.com/master/tools/docker-compose.html). +See the [docs](../../docs/tools/docker-compose.md). diff --git a/networks/remote/README.md b/networks/remote/README.md index eab906e452..6cabfc45e7 100644 --- a/networks/remote/README.md +++ b/networks/remote/README.md @@ -1,3 +1,3 @@ # Remote Cluster with Terraform and Ansible -See the [docs](https://docs.tendermint.com/master/tools/terraform-and-ansible.html). +See the [docs](../../docs/tools/terraform-and-ansible.md). diff --git a/proto/README.md b/proto/README.md index 0e06f56336..7d06577187 100644 --- a/proto/README.md +++ b/proto/README.md @@ -14,7 +14,7 @@ The `.proto` files within this section are core to the protocol and updates must ### Steps 1. Make an issue with the proposed change. - - Within the issue members, from the Tendermint team will leave comments. If there is not consensus on the change an [RFC](../docs/rfc/README.md) may be requested. + - Within the issue members, from the Tendermint team will leave comments. If there is not consensus on the change an [RFC](../docs/rfc/) may be requested. 1a. Submission of an RFC as a pull request should be made to facilitate further discussion. 1b. Merge the RFC. 2. Make the necessary changes to the `.proto` file(s), [core data structures](../spec/core/data_structures.md) and/or [ABCI protocol](../spec/abci/app-requirements.md). diff --git a/spec/abci/api.md b/spec/abci/api.md index 13eb3f0c63..af717364ee 100644 --- a/spec/abci/api.md +++ b/spec/abci/api.md @@ -86,7 +86,7 @@ | round | [int32](#int32) | | | | quorum_hash | [bytes](#bytes) | | | | block_signature | [bytes](#bytes) | | | -| threshold_vote_extensions | [tendermint.types.VoteExtension](#tendermint-types-VoteExtension) | repeated | | +| threshold_vote_extensions | [tendermint.types.VoteExtension](../../proto/tendermint/types/) | repeated | | @@ -158,7 +158,7 @@ Provides a vote extension for signing. `type` and `extension` fields are mandato | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| type | [tendermint.types.VoteExtensionType](#tendermint-types-VoteExtensionType) | | Vote extension type can be either DEFAULT, THRESHOLD_RECOVER or THRESHOLD_RECOVER_RAW. The Tenderdash supports only THRESHOLD_RECOVER and THRESHOLD_RECOVER_RAW at this moment. | +| type | [tendermint.types.VoteExtensionType](../../proto/tendermint/types/) | | Vote extension type can be either DEFAULT, THRESHOLD_RECOVER or THRESHOLD_RECOVER_RAW. The Tenderdash supports only THRESHOLD_RECOVER and THRESHOLD_RECOVER_RAW at this moment. | | extension | [bytes](#bytes) | | Deterministic or (Non-Deterministic) extension provided by the sending validator's Application. For THRESHOLD_RECOVER_RAW, it MUST be 32 bytes. @@ -205,7 +205,7 @@ ExtendedVoteInfo | type | [MisbehaviorType](#tendermint-abci-MisbehaviorType) | | | | validator | [Validator](#tendermint-abci-Validator) | | The offending validator | | height | [int64](#int64) | | The height when the offense occurred | -| time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The corresponding time where the offense occurred | +| time | [google.protobuf.Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp) | | The corresponding time where the offense occurred | | total_voting_power | [int64](#int64) | | Total voting power of the validator set in case the ABCI application does not store historical validators. https://github.com/tendermint/tendermint/issues/4581 | @@ -371,8 +371,8 @@ See the [FinalizeBlock contract](methods.md#finalizeblock) and | hash | [bytes](#bytes) | | The block header's hash. Present for convenience (can be derived from the block header). | | height | [int64](#int64) | | The height of the finalized block. | | round | [int32](#int32) | | Round number for the block | -| block | [tendermint.types.Block](#tendermint-types-Block) | | The block that was finalized | -| block_id | [tendermint.types.BlockID](#tendermint-types-BlockID) | | The block ID that was finalized | +| block | [tendermint.types.Block](../../proto/tendermint/types/) | | The block that was finalized | +| block_id | [tendermint.types.BlockID](../../proto/tendermint/types/) | | The block ID that was finalized | @@ -428,9 +428,9 @@ Called once upon genesis. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | Genesis time | +| time | [google.protobuf.Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp) | | Genesis time | | chain_id | [string](#string) | | ID of the blockchain. | -| consensus_params | [tendermint.types.ConsensusParams](#tendermint-types-ConsensusParams) | | Initial consensus-critical parameters. | +| consensus_params | [tendermint.types.ConsensusParams](../../proto/tendermint/types/) | | Initial consensus-critical parameters. | | validator_set | [ValidatorSetUpdate](#tendermint-abci-ValidatorSetUpdate) | | Initial genesis validators, sorted by voting power. | | app_state_bytes | [bytes](#bytes) | | Serialized initial application state. JSON bytes. | | initial_height | [int64](#int64) | | Height of the initial block (typically `1`). | @@ -515,13 +515,13 @@ constraints, response validation and the exact conditions for preparing a fresh | local_last_commit | [CommitInfo](#tendermint-abci-CommitInfo) | | Info about the last commit, obtained locally from Tenderdash's data structures. | | misbehavior | [Misbehavior](#tendermint-abci-Misbehavior) | repeated | List of information about validators that acted incorrectly. | | height | [int64](#int64) | | The height of the block that will be proposed. | -| time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | Timestamp of the block that that will be proposed. | +| time | [google.protobuf.Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp) | | Timestamp of the block that that will be proposed. | | next_validators_hash | [bytes](#bytes) | | Merkle root of the next validator set. | | round | [int32](#int32) | | Round number for the block. | | core_chain_locked_height | [uint32](#uint32) | | Core chain lock height to be used when signing this block. | | proposer_pro_tx_hash | [bytes](#bytes) | | ProTxHash of the original proposer of the block. | | proposed_app_version | [uint64](#uint64) | | Proposer's latest available app protocol version. | -| version | [tendermint.version.Consensus](#tendermint-version-Consensus) | | App and block version used to generate the block. App version included in the block can be modified by setting ResponsePrepareProposal.app_version. | +| version | [tendermint.version.Consensus](../../proto/tendermint/version/) | | App and block version used to generate the block. App version included in the block can be modified by setting ResponsePrepareProposal.app_version. | | quorum_hash | [bytes](#bytes) | | quorum_hash contains hash of validator quorum that will sign the block | @@ -548,13 +548,13 @@ See the [ProcessProposal contract](methods.md#processproposal) and | hash | [bytes](#bytes) | | The block header's hash of the proposed block. It is computed as a Merkle tree from the header fields. | | height | [int64](#int64) | | The height of the proposed block. | | round | [int32](#int32) | | Round number for the block | -| time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | Timestamp included in the proposed block. | +| time | [google.protobuf.Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp) | | Timestamp included in the proposed block. | | next_validators_hash | [bytes](#bytes) | | Merkle root of the next validator set. | | core_chain_locked_height | [uint32](#uint32) | | Core chain lock height to be used when signing this block. | -| core_chain_lock_update | [tendermint.types.CoreChainLock](#tendermint-types-CoreChainLock) | | Next core-chain-lock-update for validation in ABCI. | +| core_chain_lock_update | [tendermint.types.CoreChainLock](../../proto/tendermint/types/) | | Next core-chain-lock-update for validation in ABCI. | | proposer_pro_tx_hash | [bytes](#bytes) | | ProTxHash of the original proposer of the block. | | proposed_app_version | [uint64](#uint64) | | Proposer's latest available app protocol version. | -| version | [tendermint.version.Consensus](#tendermint-version-Consensus) | | App and block version used to generate the block. App version MUST be verified by the app. | +| version | [tendermint.version.Consensus](../../proto/tendermint/version/) | | App and block version used to generate the block. App version MUST be verified by the app. | | quorum_hash | [bytes](#bytes) | | quorum_hash contains hash of validator quorum that will sign the block | @@ -837,12 +837,12 @@ nondeterministic | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| consensus_params | [tendermint.types.ConsensusParams](#tendermint-types-ConsensusParams) | | Initial consensus-critical parameters (optional). | +| consensus_params | [tendermint.types.ConsensusParams](../../proto/tendermint/types/) | | Initial consensus-critical parameters (optional). | | app_hash | [bytes](#bytes) | | Initial application hash. 32 bytes. | | validator_set_update | [ValidatorSetUpdate](#tendermint-abci-ValidatorSetUpdate) | | Initial validator set (optional). | -| next_core_chain_lock_update | [tendermint.types.CoreChainLock](#tendermint-types-CoreChainLock) | | Initial core chain lock update. | +| next_core_chain_lock_update | [tendermint.types.CoreChainLock](../../proto/tendermint/types/) | | Initial core chain lock update. | | initial_core_height | [uint32](#uint32) | | Initial height of core lock. | -| genesis_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | optional | Override genesis time with provided time. | +| genesis_time | [google.protobuf.Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp) | optional | Override genesis time with provided time. | @@ -905,8 +905,8 @@ nondeterministic | tx_records | [TxRecord](#tendermint-abci-TxRecord) | repeated | Possibly modified list of transactions that have been picked as part of the proposed block. | | app_hash | [bytes](#bytes) | | The Merkle root hash of the application state. 32 bytes. | | tx_results | [ExecTxResult](#tendermint-abci-ExecTxResult) | repeated | List of structures containing the data resulting from executing the transactions. | -| consensus_param_updates | [tendermint.types.ConsensusParams](#tendermint-types-ConsensusParams) | | Changes to consensus-critical gas, size, and other parameters that will be applied at next height. | -| core_chain_lock_update | [tendermint.types.CoreChainLock](#tendermint-types-CoreChainLock) | | Core chain lock that will be used for next block. | +| consensus_param_updates | [tendermint.types.ConsensusParams](../../proto/tendermint/types/) | | Changes to consensus-critical gas, size, and other parameters that will be applied at next height. | +| core_chain_lock_update | [tendermint.types.CoreChainLock](../../proto/tendermint/types/) | | Core chain lock that will be used for next block. | | validator_set_update | [ValidatorSetUpdate](#tendermint-abci-ValidatorSetUpdate) | | Changes to validator set that will be applied at next height. | | app_version | [uint64](#uint64) | | Application version that was used to create the current proposal. | @@ -926,7 +926,7 @@ nondeterministic | status | [ResponseProcessProposal.ProposalStatus](#tendermint-abci-ResponseProcessProposal-ProposalStatus) | | `enum` that signals if the application finds the proposal valid. | | app_hash | [bytes](#bytes) | | The Merkle root hash of the application state. 32 bytes. | | tx_results | [ExecTxResult](#tendermint-abci-ExecTxResult) | repeated | List of structures containing the data resulting from executing the transactions. | -| consensus_param_updates | [tendermint.types.ConsensusParams](#tendermint-types-ConsensusParams) | | Changes to consensus-critical gas, size, and other parameters. | +| consensus_param_updates | [tendermint.types.ConsensusParams](../../proto/tendermint/types/) | | Changes to consensus-critical gas, size, and other parameters. | | validator_set_update | [ValidatorSetUpdate](#tendermint-abci-ValidatorSetUpdate) | | Changes to validator set (set voting power to 0 to remove). | | events | [Event](#tendermint-abci-Event) | repeated | Type & Key-Value events for indexing | @@ -949,7 +949,7 @@ nondeterministic | index | [int64](#int64) | | The index of the key in the tree. | | key | [bytes](#bytes) | | The key of the matching data. | | value | [bytes](#bytes) | | The value of the matching data. | -| proof_ops | [tendermint.crypto.ProofOps](#tendermint-crypto-ProofOps) | | Serialized proof for the value data, if requested, to be verified against the `app_hash` for the given Height. | +| proof_ops | [tendermint.crypto.ProofOps](../../proto/tendermint/crypto/) | | Serialized proof for the value data, if requested, to be verified against the `app_hash` for the given Height. | | height | [int64](#int64) | | The block height from which data was derived. Note that this is the height of the block containing the application's Merkle root hash, which represents the state as it was after committing the block at Height-1. | | codespace | [string](#string) | | Namespace for the `code`. | @@ -999,7 +999,7 @@ nondeterministic | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| threshold_public_key | [tendermint.crypto.PublicKey](#tendermint-crypto-PublicKey) | | | +| threshold_public_key | [tendermint.crypto.PublicKey](../../proto/tendermint/crypto/) | | | @@ -1081,7 +1081,7 @@ the new validator set update. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | validator_updates | [ValidatorUpdate](#tendermint-abci-ValidatorUpdate) | repeated | | -| threshold_public_key | [tendermint.crypto.PublicKey](#tendermint-crypto-PublicKey) | | | +| threshold_public_key | [tendermint.crypto.PublicKey](../../proto/tendermint/crypto/) | | | | quorum_hash | [bytes](#bytes) | | | @@ -1097,7 +1097,7 @@ ValidatorUpdate | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| pub_key | [tendermint.crypto.PublicKey](#tendermint-crypto-PublicKey) | | | +| pub_key | [tendermint.crypto.PublicKey](../../proto/tendermint/crypto/) | | | | power | [int64](#int64) | | | | pro_tx_hash | [bytes](#bytes) | | | | node_address | [string](#string) | | node_address is an URI containing address of validator (`proto://node_id@ip_address:port`), for example: `tcp://f2dbd9b0a1f541a7c44d34a58674d0262f5feca5@12.34.5.6:1234` | diff --git a/spec/light-client/accountability/README.md b/spec/light-client/accountability/README.md index a6eda7e674..088eaf82ab 100644 --- a/spec/light-client/accountability/README.md +++ b/spec/light-client/accountability/README.md @@ -207,7 +207,7 @@ Execution: *Remark.* In this case, the more than 1/3 of faulty validators do not need to commit an equivocation (F1) as they only vote once per round in the execution. -Detecting faulty validators in the case of such an attack can be done by the fork accountability mechanism described in: . +Detecting faulty validators in the case of such an attack can be done by the fork accountability mechanism described in the fork accountability report (a Google Doc that is no longer available). If a light client is attacked using this attack with 1/3 or more of voting power (and less than 2/3), the attacker cannot change the application state arbitrarily. Rather, the attacker is limited to a state a correct validator finds acceptable: In the execution above, correct validators still find the value acceptable, however, the block the light client trusts deviates from the one on the main chain. @@ -232,7 +232,7 @@ Consequences: * The validators in F1 will be detectable by the the fork accountability mechanisms. * The validators in F2 cannot be detected using this mechanism. Only in case they signed something which conflicts with the application this can be used against them. Otherwise they do not do anything incorrect. -* This case is not covered by the report as it only assumes at most 2/3 of faulty validators. +* This case is not covered by the fork accountability report as it only assumes at most 2/3 of faulty validators. **Q:** do we need to define a special kind of attack for the case where a validator sign arbitrarily state? It seems that detecting such attack requires a different mechanism that would require as an evidence a sequence of blocks that led to that state. This might be very tricky to implement. diff --git a/spec/light-client/detection/draft-functions.md b/spec/light-client/detection/draft-functions.md index c56594a533..1c3198e139 100644 --- a/spec/light-client/detection/draft-functions.md +++ b/spec/light-client/detection/draft-functions.md @@ -3,7 +3,7 @@ This document collects drafts of function for generating and submitting proof of fork in the IBC context -- [IBC](#on---chain-ibc-component) +- [IBC](#on-chain-ibc-component) - [Relayer](#relayer) diff --git a/tools/README.md b/tools/README.md index 44bd0691d7..411e90a7c0 100644 --- a/tools/README.md +++ b/tools/README.md @@ -2,4 +2,4 @@ Tools for working with Tendermint and associated technologies. Documentation for these tools can be found online in the [Tendermint tools -documentation](https://docs.tendermint.com/master/tools/). +documentation](../docs/tools/README.md).