LaconicNetwork/cosmos-sdk
7
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

docs: protocolpool wiring (backport #24607) (#24611)

Browse Source 
Co-authored-by: Alex | Interchain Labs <alex@interchainlabs.io>
This commit is contained in:
mergify[bot] 2025-04-29 12:59:02 -04:00 committed by GitHub
parent c1d1e6893b
commit 81b5b751ce
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
UPGRADE_GUIDE.md
View File

@ -161,6 +161,8 @@ app.ModuleManager.SetOrderInitGenesis(
### DI Wiring
Note: _as long as an external community pool keeper (here, `x/protocolpool`) is wired in DI configs, `x/distribution` will automatically use it for its external pool._
First, set up the keeper for the application.
Import the protocolpool keeper:

23
x/distribution/README.md
View File

@ -125,6 +125,29 @@ is created which might need to reference the historical record, the reference co
Each time one object which previously needed to reference the historical record is deleted, the reference
count is decremented. If the reference count hits zero, the historical record is deleted.
### External Community Pool Keepers
An external pool community keeper is defined as:
```go
// ExternalCommunityPoolKeeper is the interface that an external community pool module keeper must fulfill
// for x/distribution to properly accept it as a community pool fund destination.
type ExternalCommunityPoolKeeper interface {
// GetCommunityPoolModule gets the module name that funds should be sent to for the community pool.
// This is the address that x/distribution will send funds to for external management.
GetCommunityPoolModule() string
// FundCommunityPool allows an account to directly fund the community fund pool.
FundCommunityPool(ctx sdk.Context, amount sdk.Coins, senderAddr sdk.AccAddress) error
// DistributeFromCommunityPool distributes funds from the community pool module account to
// a receiver address.
DistributeFromCommunityPool(ctx sdk.Context, amount sdk.Coins, receiveAddr sdk.AccAddress) error
}
```
By default, the distribution module will use a community pool implementation that is internal. An external community pool
can be provided to the module which will have funds be diverted to it instead of the internal implementation. The reference
external community pool maintained by the Cosmos SDK is [`x/protocolpool`](../protocolpool/README.md).
## State
### FeePool

2
x/protocolpool/README.md
View File

@ -10,6 +10,8 @@ sidebar_position: 1
This module is `supplemental`; it is not required to run a Cosmos SDK chain. `x/protocolpool` enhances the community pool functionality provided by `x/distribution` and enables custom modules to further extend the community pool.
Note: _as long as an external commmunity pool keeper (here, `x/protocolpool`) is wired in DI configs, `x/distribution` will automatically use it for its external pool._
## Usage Limitations
The following `x/distribution` handlers will now return an error when the `protocolpool` module is used with `x/distribution`: