From ab22bfdd72a33de36bb2b9eb069205a8f66c5c3b Mon Sep 17 00:00:00 2001 From: Julien Robert Date: Wed, 19 Oct 2022 16:18:46 +0300 Subject: [PATCH] docs: remove outdated documentation --- docs/docs/basics/00-app-anatomy.md | 18 +++--------------- docs/docs/core/00-baseapp.md | 11 ++++++++--- x/slashing/README.md | 2 +- 3 files changed, 12 insertions(+), 19 deletions(-) diff --git a/docs/docs/basics/00-app-anatomy.md b/docs/docs/basics/00-app-anatomy.md index 2c08e1cb1828..d03b5f35e0ba 100644 --- a/docs/docs/basics/00-app-anatomy.md +++ b/docs/docs/basics/00-app-anatomy.md @@ -244,31 +244,19 @@ The main interface is the [Command-Line Interface](../core/07-cli.md). The CLI o See an example of an application's main command-line file from the [Cosmos Hub](https://github.com/cosmos/gaia) ```go reference -https://github.com/cosmos/gaia/blob/Theta-main/cmd/gaiad/cmd/root.go#L39-L77 +https://github.com/cosmos/gaia/blob/26ae7c2/cmd/gaiad/cmd/root.go#L39-L80 ``` ## Dependencies and Makefile -:::warning -A patch introduced in `go-grpc v1.34.0` made gRPC incompatible with the `gogoproto` library, making some [gRPC queries](https://github.com/cosmos/cosmos-sdk/issues/8426) panic. As such, the Cosmos SDK requires that `go-grpc <=v1.33.2` is installed in your `go.mod`. - -To make sure that gRPC is working properly, it is **highly recommended** to add the following line in your application's `go.mod`: - -```go -replace google.golang.org/grpc => google.golang.org/grpc v1.33.2 -``` - -Please see [issue #8392](https://github.com/cosmos/cosmos-sdk/issues/8392) for more info. -::: - This section is optional, as developers are free to choose their dependency manager and project building method. That said, the current most used framework for versioning control is [`go.mod`](https://github.com/golang/go/wiki/Modules). It ensures each of the libraries used throughout the application are imported with the correct version. Below, the `go.mod` of the [Cosmos Hub](https://github.com/cosmos/gaia) is provided as an example. ```go reference -https://github.com/cosmos/gaia/blob/Theta-main/go.mod#L1-L20 +https://github.com/cosmos/gaia/blob/26ae7c2/go.mod#L1-L28 ``` For building the application, a [Makefile](https://en.wikipedia.org/wiki/Makefile) is generally used. The Makefile primarily ensures that the `go.mod` is run before building the two entrypoints to the application, [`appd`](#node-client) and [`appd`](#application-interface). -Here is an example of the [Cosmos Hub Makefile](https://github.com/cosmos/gaia/blob/Theta-main/Makefile). +Here is an example of the [Cosmos Hub Makefile](https://github.com/cosmos/gaia/blob/main/Makefile). diff --git a/docs/docs/core/00-baseapp.md b/docs/docs/core/00-baseapp.md index 0ac432fd5b72..b7ad57e58a80 100644 --- a/docs/docs/core/00-baseapp.md +++ b/docs/docs/core/00-baseapp.md @@ -270,9 +270,11 @@ The response contains: * `Info (string):` Additional information. May be non-deterministic. * `GasWanted (int64)`: Amount of gas requested for transaction. It is provided by users when they generate the transaction. * `GasUsed (int64)`: Amount of gas consumed by transaction. During `CheckTx`, this value is computed by multiplying the standard cost of a transaction byte by the size of the raw transaction. Next is an example: - ```go reference + +```go reference https://github.com/cosmos/cosmos-sdk/blob/v0.46.0/x/auth/ante/basic.go#L95-L95 ``` + * `Events ([]cmn.KVPair)`: Key-Value tags for filtering and indexing transactions (eg. by account). See [`event`s](./08-events.md) for more. * `Codespace (string)`: Namespace for the Code. @@ -389,10 +391,13 @@ Finally, the `InitChain(req abci.RequestInitChain)` method of `BaseApp` calls th The [`BeginBlock` ABCI message](https://docs.tendermint.com/master/spec/abci/abci.html#beginblock) is sent from the underlying Tendermint engine when a block proposal created by the correct proposer is received, before [`DeliverTx`](#delivertx) is run for each transaction in the block. It allows developers to have logic be executed at the beginning of each block. In the Cosmos SDK, the `BeginBlock(req abci.RequestBeginBlock)` method does the following: * Initialize [`deliverState`](#state-updates) with the latest header using the `req abci.RequestBeginBlock` passed as parameter via the `setDeliverState` function. + ```go reference -https://github.com/cosmos/cosmos-sdk/blob/v0.46.0/baseapp/baseapp.go#L386-L396 -``` + https://github.com/cosmos/cosmos-sdk/blob/v0.46.0/baseapp/baseapp.go#L386-L396 + ``` + This function also resets the [main gas meter](../basics/04-gas-fees.md#main-gas-meter). + * Initialize the [block gas meter](../basics/04-gas-fees.md#block-gas-meter) with the `maxGas` limit. The `gas` consumed within the block cannot go above `maxGas`. This parameter is defined in the application's consensus parameters. * Run the application's [`beginBlocker()`](../basics/00-app-anatomy.md#beginblocker-and-endblock), which mainly runs the [`BeginBlocker()`](../building-modules/05-beginblock-endblock.md#beginblock) method of each of the application's modules. * Set the [`VoteInfos`](https://docs.tendermint.com/master/spec/abci/abci.html#voteinfo) of the application, i.e. the list of validators whose _precommit_ for the previous block was included by the proposer of the current block. This information is carried into the [`Context`](./02-context.md) so that it can be used during `DeliverTx` and `EndBlock`. diff --git a/x/slashing/README.md b/x/slashing/README.md index 78f161b4b12d..435c55999dfb 100644 --- a/x/slashing/README.md +++ b/x/slashing/README.md @@ -625,7 +625,7 @@ simd tx slashing --help The `unjail` command allows users to unjail a validator previously jailed for downtime. ```bash - simd tx slashing unjail --from mykey [flags] +simd tx slashing unjail --from mykey [flags] ``` Example: