diff --git a/docs/architecture/README.md b/docs/architecture/README.md index c591cec70..a4e326274 100644 --- a/docs/architecture/README.md +++ b/docs/architecture/README.md @@ -61,7 +61,7 @@ Note the context/background should be written in the present tense. - [ADR-053: State-Sync-Prototype](./adr-053-state-sync-prototype.md) - [ADR-054: Crypto-Encoding-2](./adr-054-crypto-encoding-2.md) - [ADR-055: Protobuf-Design](./adr-055-protobuf-design.md) -- [ADR-056: Light-Client-Amnesia-Attacks](./adr-056-light-client-amnesia-attacks) +- [ADR-056: Light-Client-Amnesia-Attacks](./adr-056-light-client-amnesia-attacks.md) - [ADR-059: Evidence-Composition-and-Lifecycle](./adr-059-evidence-composition-and-lifecycle.md) - [ADR-062: P2P-Architecture](./adr-062-p2p-architecture.md) - [ADR-063: Privval-gRPC](./adr-063-privval-grpc.md) diff --git a/docs/architecture/adr-042-state-sync.md b/docs/architecture/adr-042-state-sync.md index 89d95f2e4..72d71ae22 100644 --- a/docs/architecture/adr-042-state-sync.md +++ b/docs/architecture/adr-042-state-sync.md @@ -97,8 +97,7 @@ design for tendermint was originally tracked in [#828](https://github.com/tendermint/tendermint/issues/828). #### Eager StateSync -Warp Sync as implemented in Parity -["Warp Sync"](https://wiki.parity.io/Warp-Sync-Snapshot-Format.html) to rapidly +Warp Sync as implemented in OpenEthereum to rapidly download both blocks and state snapshots from peers. Data is carved into ~4MB chunks and snappy compressed. Hashes of snappy compressed chunks are stored in a manifest file which co-ordinates the state-sync. Obtaining a correct manifest @@ -234,5 +233,3 @@ Proposed [WIP General/Lazy State-Sync pseudo-spec](https://github.com/tendermint/tendermint/issues/3639) - Jae Proposal [Warp Sync Implementation](https://github.com/tendermint/tendermint/pull/3594) - ackratos [Chunk Proposal](https://github.com/tendermint/tendermint/pull/3799) - Bucky proposed - - diff --git a/docs/architecture/adr-044-lite-client-with-weak-subjectivity.md b/docs/architecture/adr-044-lite-client-with-weak-subjectivity.md index 06de78658..f66c3ec62 100644 --- a/docs/architecture/adr-044-lite-client-with-weak-subjectivity.md +++ b/docs/architecture/adr-044-lite-client-with-weak-subjectivity.md @@ -119,7 +119,7 @@ network usage. --- Check out the formal specification -[here](https://docs.tendermint.com/master/spec/consensus/light-client.html). +[here](https://github.com/tendermint/spec/tree/master/spec/light-client). ## Status diff --git a/docs/architecture/adr-045-abci-evidence.md b/docs/architecture/adr-045-abci-evidence.md index f694c71d4..257564021 100644 --- a/docs/architecture/adr-045-abci-evidence.md +++ b/docs/architecture/adr-045-abci-evidence.md @@ -18,7 +18,7 @@ graceful here, but that's for another day. It's possible to fool lite clients without there being a fork on the main chain - so called Fork-Lite. See the -[fork accountability](https://docs.tendermint.com/master/spec/consensus/fork-accountability.html) +[fork accountability](https://docs.tendermint.com/master/spec/light-client/accountability/) document for more details. For a sequential lite client, this can happen via equivocation or amnesia attacks. For a skipping lite client this can also happen via lunatic validator attacks. There must be some way for applications to punish diff --git a/docs/architecture/adr-047-handling-evidence-from-light-client.md b/docs/architecture/adr-047-handling-evidence-from-light-client.md index 2848212f9..cede04399 100644 --- a/docs/architecture/adr-047-handling-evidence-from-light-client.md +++ b/docs/architecture/adr-047-handling-evidence-from-light-client.md @@ -179,7 +179,7 @@ This then ends the process and the verify function that was called at the start the user. For a detailed overview of how each of these three attacks can be conducted please refer to the -[fork accountability spec]((https://github.com/tendermint/spec/blob/master/spec/consensus/light-client/accountability.md)). +[fork accountability spec](https://github.com/tendermint/spec/blob/master/spec/consensus/light-client/accountability.md). ## Full Node Verification diff --git a/docs/nodes/logging.md b/docs/nodes/logging.md index 73e629f76..88c736213 100644 --- a/docs/nodes/logging.md +++ b/docs/nodes/logging.md @@ -32,7 +32,7 @@ tendermint start --log-level "info" Here is the list of modules you may encounter in Tendermint's log and a little overview what they do. -- `abci-client` As mentioned in [Application Development Guide](../app-dev/app-development.md), Tendermint acts as an ABCI +- `abci-client` As mentioned in [Application Architecture Guide](../app-dev/app-architecture.md), Tendermint acts as an ABCI client with respect to the application and maintains 3 connections: mempool, consensus and query. The code used by Tendermint Core can be found [here](https://github.com/tendermint/tendermint/tree/master/abci/client). @@ -45,12 +45,12 @@ little overview what they do. from a crash. [here](https://github.com/tendermint/tendermint/blob/master/types/events.go). You can subscribe to them by calling `subscribe` RPC method. Refer - to [RPC docs](./rpc.md) for additional information. + to [RPC docs](../tendermint-core/rpc.md) for additional information. - `mempool` Mempool module handles all incoming transactions, whenever they are coming from peers or the application. - `p2p` Provides an abstraction around peer-to-peer communication. For more details, please check out the - [README](https://github.com/tendermint/tendermint/blob/master/p2p/README.md). + [README](https://github.com/tendermint/spec/tree/master/spec/p2p). - `rpc-server` RPC server. For implementation details, please read the [doc.go](https://github.com/tendermint/tendermint/blob/master/rpc/jsonrpc/doc.go). - `state` Represents the latest state and execution submodule, which diff --git a/docs/nodes/running-in-production.md b/docs/nodes/running-in-production.md index 70f316334..d20224e1b 100644 --- a/docs/nodes/running-in-production.md +++ b/docs/nodes/running-in-production.md @@ -40,7 +40,7 @@ Default logging level (`log-level = "info"`) should suffice for normal operation mode. Read [this post](https://blog.cosmos.network/one-of-the-exciting-new-features-in-0-10-0-release-is-smart-log-level-flag-e2506b4ab756) for details on how to configure `log-level` config variable. Some of the -modules can be found [here](../nodes/logging#list-of-modules). If +modules can be found [here](logging.md#list-of-modules). If you're trying to debug Tendermint or asked to provide logs with debug logging level, you can do so by running Tendermint with `--log-level="debug"`. @@ -114,7 +114,7 @@ just the votes seen at the current height. If, after consulting with the logs and above endpoints, you still have no idea what's happening, consider using `tendermint debug kill` sub-command. This command will scrap all the available info and kill the process. See -[Debugging](../tools/debugging.md) for the exact format. +[Debugging](../tools/debugging/README.md) for the exact format. You can inspect the resulting archive yourself or create an issue on [Github](https://github.com/tendermint/tendermint). Before opening an issue @@ -134,7 +134,7 @@ Tendermint also can report and serve Prometheus metrics. See [Metrics](./metrics.md). `tendermint debug dump` sub-command can be used to periodically dump useful -information into an archive. See [Debugging](../tools/debugging.md) for more +information into an archive. See [Debugging](../tools/debugging/README.md) for more information. ## What happens when my app dies @@ -315,7 +315,7 @@ We want `skip-timeout-commit=false` when there is economics on the line because proposers should wait to hear for more votes. But if you don't care about that and want the fastest consensus, you can skip it. It will be kept false by default for public deployments (e.g. [Cosmos -Hub](https://cosmos.network/intro/hub)) while for enterprise +Hub](https://hub.cosmos.network/main/hub-overview/overview.html)) while for enterprise applications, setting it to true is not a problem. - `consensus.peer-gossip-sleep-duration` diff --git a/docs/tendermint-core/subscription.md b/docs/tendermint-core/subscription.md index 067d0bf51..1ab6828b6 100644 --- a/docs/tendermint-core/subscription.md +++ b/docs/tendermint-core/subscription.md @@ -36,7 +36,7 @@ more information on query syntax and other options. You can also use tags, given you had included them into DeliverTx response, to query transaction results. See [Indexing -transactions](./indexing-transactions.md) for details. +transactions](../app-dev/indexing-transactions.md) for details. ## ValidatorSetUpdates diff --git a/docs/tendermint-core/using-tendermint.md b/docs/tendermint-core/using-tendermint.md index e6204c89e..bbcdd0370 100644 --- a/docs/tendermint-core/using-tendermint.md +++ b/docs/tendermint-core/using-tendermint.md @@ -552,8 +552,7 @@ To make a Tendermint network that can tolerate one of the validators failing, you need at least four validator nodes (e.g., 2/3). Updating validators in a live network is supported but must be -explicitly programmed by the application developer. See the [application -developers guide](../app-dev/app-development.md) for more details. +explicitly programmed by the application developer. ### Local Network