cosmos-sdk/x/params/spec
Marie Gauthier 1b1dbf8ab7
x/params docs general audit & cleanup (#8295)
* Update doc.go

* Update spec/

* More updates

* Update README

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2021-01-15 13:30:17 +00:00
..
01_keeper.md x/params docs general audit & cleanup (#8295) 2021-01-15 13:30:17 +00:00
02_subspace.md x/params docs general audit & cleanup (#8295) 2021-01-15 13:30:17 +00:00
README.md x/params docs general audit & cleanup (#8295) 2021-01-15 13:30:17 +00:00

README.md

params

Abstract

Package params provides a globally available parameter store.

There are two main types, Keeper and Subspace. Subspace is an isolated namespace for a paramstore, where keys are prefixed by preconfigured spacename. Keeper has a permission to access all existing spaces.

Subspace can be used by the individual keepers, which need a private parameter store that the other keepers cannot modify. The params Keeper can be used to add a route to x/gov router in order to modify any parameter in case a proposal passes.

The following contents explains how to use params module for master and user modules.

Contents

  1. Keeper
  2. Subspace