docs: add docs about x/auth/tx (#14021)

* docs: add docs about `x/auth/tx` * updates * updates * updates * updates * updates * updates * updates Co-authored-by: Marko <[email protected]>
cosmos · Nov 27, 2022 · 6f329d7 · 6f329d7
1 parent 75a2f26
commit 6f329d7
Show file tree

Hide file tree

Showing 57 changed files with 701 additions and 471 deletions.
diff --git a/api/cosmos/auth/v1beta1/query.pulsar.go b/api/cosmos/auth/v1beta1/query.pulsar.go
diff --git a/api/cosmos/consensus/v1/tx.pulsar.go b/api/cosmos/consensus/v1/tx.pulsar.go
diff --git a/api/cosmos/crisis/module/v1/module.pulsar.go b/api/cosmos/crisis/module/v1/module.pulsar.go
diff --git a/api/cosmos/crisis/v1beta1/tx.pulsar.go b/api/cosmos/crisis/v1beta1/tx.pulsar.go
diff --git a/api/cosmos/crisis/v1beta1/tx_grpc.pb.go b/api/cosmos/crisis/v1beta1/tx_grpc.pb.go
diff --git a/api/cosmos/tx/module/v1/module.pulsar.go → api/cosmos/tx/config/v1/config.pulsar.go b/api/cosmos/tx/module/v1/module.pulsar.go → api/cosmos/tx/config/v1/config.pulsar.go
diff --git a/api/cosmos/tx/v1beta1/service_grpc.pb.go b/api/cosmos/tx/v1beta1/service_grpc.pb.go
diff --git a/baseapp/util_test.go b/baseapp/util_test.go
@@ -15,7 +15,7 @@ import (
 	mintmodulev1 "cosmossdk.io/api/cosmos/mint/module/v1"
 	paramsmodulev1 "cosmossdk.io/api/cosmos/params/module/v1"
 	stakingmodulev1 "cosmossdk.io/api/cosmos/staking/module/v1"
-	txmodulev1 "cosmossdk.io/api/cosmos/tx/module/v1"
+	txconfigv1 "cosmossdk.io/api/cosmos/tx/config/v1"
 	"cosmossdk.io/core/appconfig"
 	"cosmossdk.io/depinject"
 	"github.com/cosmos/cosmos-sdk/baseapp"
@@ -27,7 +27,7 @@ import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/types/mempool"
 	_ "github.com/cosmos/cosmos-sdk/x/auth"
-	_ "github.com/cosmos/cosmos-sdk/x/auth/tx/module"
+	_ "github.com/cosmos/cosmos-sdk/x/auth/tx/config"
 	authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
 	_ "github.com/cosmos/cosmos-sdk/x/bank"
 	banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
@@ -143,7 +143,7 @@ func makeTestConfig() depinject.Config {
 			},
 			{
 				Name:   "tx",
-				Config: appconfig.WrapAny(&txmodulev1.Module{}),
+				Config: appconfig.WrapAny(&txconfigv1.Config{}),
 			},
 		},
 	})

diff --git a/docs/docs/core/05-encoding.md b/docs/docs/core/05-encoding.md
@@ -125,7 +125,7 @@ the consensus engine accepts only transactions in the form of raw bytes.
 https://github.com/cosmos/cosmos-sdk/blob/v0.46.0/types/tx_msg.go#L72-L76
 ```
 
-A standard implementation of both these objects can be found in the [`auth` module](../modules/auth/README.md):
+A standard implementation of both these objects can be found in the [`auth/tx` module](../modules/auth/tx/README.md):
 
 ```go reference
 https://github.com/cosmos/cosmos-sdk/blob/v0.46.0/x/auth/tx/decoder.go

diff --git a/docs/modules_category.json → docs/docs/modules/_category_.json b/docs/modules_category.json → docs/docs/modules/_category_.json
diff --git a/docs/docs/pkg/_category_.json b/docs/docs/pkg/_category_.json
@@ -0,0 +1,5 @@
+{
+    "label": "Notable Packages",
+    "position": 10,
+    "link": null
+}
diff --git a/docs/post.sh b/docs/post.sh
@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-rm -rf docs/modules
+find docs/modules ! -name '_category_.json' -type f -exec rm -rf {} +
 rm -rf docs/tooling/01-cosmovisor.md
 rm -rf docs/tooling/02-depinject.md
 rm -rf docs/run-node/04-rosetta.md

diff --git a/docs/pre.sh b/docs/pre.sh
@@ -1,9 +1,6 @@
 #!/usr/bin/env bash
 
 ## Create modules pages
-mkdir -p docs/modules
-cp modules_category.json docs/modules/_category_.json
-
 for D in ../x/*; do
   if [ -d "${D}" ]; then
     MODDOC=docs/modules/$(echo $D | awk -F/ '{print $NF}')
@@ -14,8 +11,8 @@ done
 
 ## Vesting is a submodule of auth, but we still want to display it in docs
 ## TODO to be removed in https://github.com/cosmos/cosmos-sdk/issues/9958
-mkdir -p docs/modules/vesting
-cp -r ../x/auth/vesting/README.md ./docs/modules/vesting/README.md
+cp ../x/auth/vesting/README.md ./docs/modules/auth/1-vesting.md
+cp ../x/auth/tx/README.md ./docs/modules/auth/2-tx.md
 
 ## Add modules page list
 cat ../x/README.md | sed 's/\.\.\/docs\/building-modules\/README\.md/\/building-modules\/intro\.html/g' > ./docs/modules/README.md

diff --git a/fuzz/README.md b/fuzz/README.md
@@ -5,8 +5,8 @@
 The fuzz tests are in standard [Go format](https://go.dev/doc/fuzz/).
 To run a fuzz test, use the `-fuzz` flag to `go test`. For example:
 
-```
-$ go test -fuzz FuzzCryptoHDNewParamsFromPath ./tests
+```shell
+go test -fuzz FuzzCryptoHDNewParamsFromPath ./tests
 ```
 
 ## oss-fuzz build status

diff --git a/go.mod b/go.mod
@@ -164,6 +164,9 @@ require (
 	nhooyr.io/websocket v1.8.6 // indirect
 )
 
+// TODO remove after this PR
+replace cosmossdk.io/api => ./api
+
 replace (
 	github.com/99designs/keyring => github.com/cosmos/keyring v1.2.0
 	// Update to rosetta-sdk-go temporarly to have `check:spec` passing. See https://github.com/coinbase/rosetta-sdk-go/issues/449

diff --git a/go.sum b/go.sum
@@ -46,8 +46,6 @@ cloud.google.com/go/storage v1.10.0/go.mod h1:FLPqc6j+Ki4BU591ie1oL6qBQGu2Bl/tZ9
 cloud.google.com/go/storage v1.14.0/go.mod h1:GrKmX003DSIwi9o29oFT7YDnHYwZoctc3fOKtUw0Xmo=
 cloud.google.com/go/storage v1.27.0 h1:YOO045NZI9RKfCj1c5A/ZtuuENUc8OAW+gHdGnDgyMQ=
 cloud.google.com/go/storage v1.27.0/go.mod h1:x9DOL8TK/ygDUMieqwfhdpQryTeEkhGKMi80i/iqR2s=
-cosmossdk.io/api v0.2.4 h1:o2t77GXWWEN5egCzD2ZyyFgbsoAif/XdF3T+/sAYiHQ=
-cosmossdk.io/api v0.2.4/go.mod h1:7xfxe8ghXHoKj3W2oG/HcuxGVwUHN3q8piiIEiJ3CEU=
 cosmossdk.io/core v0.3.2 h1:KlQIufpJHJvOs7YLGTZsZcCo1WlkencDXepsr8STKZQ=
 cosmossdk.io/core v0.3.2/go.mod h1:CO7vbe+evrBvHc0setFHL/u7nlY7HJGzdRSBkT/sirc=
 cosmossdk.io/depinject v1.0.0-alpha.3 h1:6evFIgj//Y3w09bqOUOzEpFj5tsxBqdc5CfkO7z+zfw=

diff --git a/proto/cosmos/tx/module/v1/module.proto → proto/cosmos/tx/config/v1/config.proto b/proto/cosmos/tx/module/v1/module.proto → proto/cosmos/tx/config/v1/config.proto
@@ -1,13 +1,13 @@
 syntax = "proto3";
 
-package cosmos.tx.module.v1;
+package cosmos.tx.config.v1;
 
 import "cosmos/app/v1alpha1/module.proto";
 
-// Module is the config object of the tx module.
-message Module {
+// Config is the config object of the x/auth/tx package.
+message Config {
   option (cosmos.app.v1alpha1.module) = {
-    go_import: "github.com/cosmos/cosmos-sdk/x/auth/tx/module"
+    go_import: "github.com/cosmos/cosmos-sdk/x/auth/tx"
   };
 
   // skip_ante_handler defines whether the ante handler registration should be skipped in case an app wants to override

diff --git a/server/grpc/grpc_web_test.go b/server/grpc/grpc_web_test.go
@@ -23,7 +23,7 @@ import (
 	cryptotypes "github.com/cosmos/cosmos-sdk/crypto/types"
 	"github.com/cosmos/cosmos-sdk/testutil/network"
 	_ "github.com/cosmos/cosmos-sdk/x/auth"
-	_ "github.com/cosmos/cosmos-sdk/x/auth/tx/module"
+	_ "github.com/cosmos/cosmos-sdk/x/auth/tx/config"
 	_ "github.com/cosmos/cosmos-sdk/x/bank"
 	banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
 	_ "github.com/cosmos/cosmos-sdk/x/genutil"

diff --git a/simapp/app_config.go b/simapp/app_config.go
@@ -22,7 +22,7 @@ import (
 	paramsmodulev1 "cosmossdk.io/api/cosmos/params/module/v1"
 	slashingmodulev1 "cosmossdk.io/api/cosmos/slashing/module/v1"
 	stakingmodulev1 "cosmossdk.io/api/cosmos/staking/module/v1"
-	txmodulev1 "cosmossdk.io/api/cosmos/tx/module/v1"
+	txconfigv1 "cosmossdk.io/api/cosmos/tx/config/v1"
 	upgrademodulev1 "cosmossdk.io/api/cosmos/upgrade/module/v1"
 	vestingmodulev1 "cosmossdk.io/api/cosmos/vesting/module/v1"
 	"cosmossdk.io/core/appconfig"
@@ -169,7 +169,7 @@ var (
 			},
 			{
 				Name:   "tx",
-				Config: appconfig.WrapAny(&txmodulev1.Module{}),
+				Config: appconfig.WrapAny(&txconfigv1.Config{}),
 			},
 			{
 				Name:   genutiltypes.ModuleName,

diff --git a/simapp/app_v2.go b/simapp/app_v2.go
@@ -32,7 +32,7 @@ import (
 	"github.com/cosmos/cosmos-sdk/x/auth"
 	authkeeper "github.com/cosmos/cosmos-sdk/x/auth/keeper"
 	authsims "github.com/cosmos/cosmos-sdk/x/auth/simulation"
-	_ "github.com/cosmos/cosmos-sdk/x/auth/tx/module" // import for side-effects
+	_ "github.com/cosmos/cosmos-sdk/x/auth/tx/config" // import for side-effects
 	authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
 	"github.com/cosmos/cosmos-sdk/x/auth/vesting"
 	vestingtypes "github.com/cosmos/cosmos-sdk/x/auth/vesting/types"

diff --git a/simapp/go.mod b/simapp/go.mod
@@ -160,6 +160,9 @@ require (
 	sigs.k8s.io/yaml v1.3.0 // indirect
 )
 
+// TODO remove after this PR
+replace cosmossdk.io/api => ../api
+
 replace (
 	github.com/99designs/keyring => github.com/cosmos/keyring v1.2.0
 	// Update to rosetta-sdk-go temporarly to have `check:spec` passing. See https://github.com/coinbase/rosetta-sdk-go/issues/449

diff --git a/simapp/go.sum b/simapp/go.sum
@@ -46,8 +46,6 @@ cloud.google.com/go/storage v1.10.0/go.mod h1:FLPqc6j+Ki4BU591ie1oL6qBQGu2Bl/tZ9
 cloud.google.com/go/storage v1.14.0/go.mod h1:GrKmX003DSIwi9o29oFT7YDnHYwZoctc3fOKtUw0Xmo=
 cloud.google.com/go/storage v1.27.0 h1:YOO045NZI9RKfCj1c5A/ZtuuENUc8OAW+gHdGnDgyMQ=
 cloud.google.com/go/storage v1.27.0/go.mod h1:x9DOL8TK/ygDUMieqwfhdpQryTeEkhGKMi80i/iqR2s=
-cosmossdk.io/api v0.2.4 h1:o2t77GXWWEN5egCzD2ZyyFgbsoAif/XdF3T+/sAYiHQ=
-cosmossdk.io/api v0.2.4/go.mod h1:7xfxe8ghXHoKj3W2oG/HcuxGVwUHN3q8piiIEiJ3CEU=
 cosmossdk.io/core v0.3.2 h1:KlQIufpJHJvOs7YLGTZsZcCo1WlkencDXepsr8STKZQ=
 cosmossdk.io/core v0.3.2/go.mod h1:CO7vbe+evrBvHc0setFHL/u7nlY7HJGzdRSBkT/sirc=
 cosmossdk.io/depinject v1.0.0-alpha.3 h1:6evFIgj//Y3w09bqOUOzEpFj5tsxBqdc5CfkO7z+zfw=

diff --git a/tests/go.mod b/tests/go.mod
@@ -7,7 +7,7 @@ require (
 	cosmossdk.io/depinject v1.0.0-alpha.3
 	cosmossdk.io/math v1.0.0-beta.3
 	cosmossdk.io/simapp v0.0.0-00010101000000-000000000000
-	github.com/cosmos/cosmos-sdk v0.46.1
+	github.com/cosmos/cosmos-sdk v0.46.0-beta2.0.20220909113810-4882f933b1a1
 	github.com/cosmos/gogoproto v1.4.3
 	github.com/golang/mock v1.6.0
 	github.com/google/uuid v1.3.0
@@ -162,6 +162,9 @@ require (
 	sigs.k8s.io/yaml v1.3.0 // indirect
 )
 
+// TODO to remove after this PR
+replace cosmossdk.io/api => ../api
+
 replace (
 	// We always want to test against the latest version of the simapp.
 	cosmossdk.io/simapp => ../simapp

diff --git a/tests/go.sum b/tests/go.sum
@@ -46,8 +46,6 @@ cloud.google.com/go/storage v1.10.0/go.mod h1:FLPqc6j+Ki4BU591ie1oL6qBQGu2Bl/tZ9
 cloud.google.com/go/storage v1.14.0/go.mod h1:GrKmX003DSIwi9o29oFT7YDnHYwZoctc3fOKtUw0Xmo=
 cloud.google.com/go/storage v1.27.0 h1:YOO045NZI9RKfCj1c5A/ZtuuENUc8OAW+gHdGnDgyMQ=
 cloud.google.com/go/storage v1.27.0/go.mod h1:x9DOL8TK/ygDUMieqwfhdpQryTeEkhGKMi80i/iqR2s=
-cosmossdk.io/api v0.2.4 h1:o2t77GXWWEN5egCzD2ZyyFgbsoAif/XdF3T+/sAYiHQ=
-cosmossdk.io/api v0.2.4/go.mod h1:7xfxe8ghXHoKj3W2oG/HcuxGVwUHN3q8piiIEiJ3CEU=
 cosmossdk.io/core v0.3.2 h1:KlQIufpJHJvOs7YLGTZsZcCo1WlkencDXepsr8STKZQ=
 cosmossdk.io/core v0.3.2/go.mod h1:CO7vbe+evrBvHc0setFHL/u7nlY7HJGzdRSBkT/sirc=
 cosmossdk.io/depinject v1.0.0-alpha.3 h1:6evFIgj//Y3w09bqOUOzEpFj5tsxBqdc5CfkO7z+zfw=

diff --git a/tests/integration/bank/keeper/deterministic_test.go b/tests/integration/bank/keeper/deterministic_test.go
@@ -19,7 +19,7 @@ import (
 	minttypes "github.com/cosmos/cosmos-sdk/x/mint/types"
 
 	_ "github.com/cosmos/cosmos-sdk/x/auth"
-	_ "github.com/cosmos/cosmos-sdk/x/auth/tx/module"
+	_ "github.com/cosmos/cosmos-sdk/x/auth/tx/config"
 	_ "github.com/cosmos/cosmos-sdk/x/bank"
 	_ "github.com/cosmos/cosmos-sdk/x/consensus"
 	_ "github.com/cosmos/cosmos-sdk/x/params"

diff --git a/tests/integration/genutil/gentx_test.go b/tests/integration/genutil/gentx_test.go
@@ -22,7 +22,7 @@ import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	moduletestutil "github.com/cosmos/cosmos-sdk/types/module/testutil"
 	_ "github.com/cosmos/cosmos-sdk/x/auth"
-	_ "github.com/cosmos/cosmos-sdk/x/auth/tx/module"
+	_ "github.com/cosmos/cosmos-sdk/x/auth/tx/config"
 	_ "github.com/cosmos/cosmos-sdk/x/bank"
 	"github.com/cosmos/cosmos-sdk/x/bank/testutil"
 	banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"

diff --git a/tests/integration/runtime/query_test.go b/tests/integration/runtime/query_test.go
@@ -21,7 +21,7 @@ import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
 
 	_ "github.com/cosmos/cosmos-sdk/x/auth"
-	_ "github.com/cosmos/cosmos-sdk/x/auth/tx/module"
+	_ "github.com/cosmos/cosmos-sdk/x/auth/tx/config"
 	_ "github.com/cosmos/cosmos-sdk/x/bank"
 	_ "github.com/cosmos/cosmos-sdk/x/consensus"
 	_ "github.com/cosmos/cosmos-sdk/x/params"

diff --git a/testutil/configurator/configurator.go b/testutil/configurator/configurator.go
@@ -14,7 +14,7 @@ import (
 	paramsmodulev1 "cosmossdk.io/api/cosmos/params/module/v1"
 	slashingmodulev1 "cosmossdk.io/api/cosmos/slashing/module/v1"
 	stakingmodulev1 "cosmossdk.io/api/cosmos/staking/module/v1"
-	txmodulev1 "cosmossdk.io/api/cosmos/tx/module/v1"
+	txconfigv1 "cosmossdk.io/api/cosmos/tx/config/v1"
 	vestingmodulev1 "cosmossdk.io/api/cosmos/vesting/module/v1"
 	"cosmossdk.io/core/appconfig"
 	"cosmossdk.io/depinject"
@@ -134,7 +134,7 @@ func TxModule() ModuleOption {
 	return func(config *appConfig) {
 		config.moduleConfigs["tx"] = &appv1alpha1.ModuleConfig{
 			Name:   "tx",
-			Config: appconfig.WrapAny(&txmodulev1.Module{}),
+			Config: appconfig.WrapAny(&txconfigv1.Config{}),
 		}
 	}
 }

diff --git a/testutil/network/network.go b/testutil/network/network.go
@@ -46,7 +46,7 @@ import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	moduletestutil "github.com/cosmos/cosmos-sdk/types/module/testutil"
 	_ "github.com/cosmos/cosmos-sdk/x/auth"
-	_ "github.com/cosmos/cosmos-sdk/x/auth/tx/module"
+	_ "github.com/cosmos/cosmos-sdk/x/auth/tx/config"
 	authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
 	_ "github.com/cosmos/cosmos-sdk/x/bank"
 	banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"

diff --git a/types/tx/service.pb.go b/types/tx/service.pb.go
diff --git a/x/README.md b/x/README.md
@@ -8,6 +8,7 @@ slug : /modules
 Here are some production-grade modules that can be used in Cosmos SDK applications, along with their respective documentation:
 
 * [Auth](./auth/README.md) - Authentication of accounts and transactions for Cosmos SDK applications.
+  * [Vesting](./auth/vesting) - Vesting account implementation.
 * [Authz](./authz/README.md) - Authorization for accounts to perform actions on behalf of other accounts.
 * [Bank](./bank/README.md) - Token transfer functionalities.
 * [Capability](./capability/README.md) - Object capability implementation.
@@ -24,6 +25,7 @@ Here are some production-grade modules that can be used in Cosmos SDK applicatio
 * [NFT](./nft/README.md) - NFT module implemented based on [ADR43](https://docs.cosmos.network/main/architecture/adr-043-nft-module.html).
 * [Consensus](./consensus/README.md) - Consensus module for modifying Tendermint's ABCI consensus params.
 
+
 To learn more about the process of building modules, visit the [building modules reference documentation](https://docs.cosmos.network/main/building-modules/intro).
 
 ## IBC