-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: demonstrate how to define hooks using depinject (#21892)
- Loading branch information
Showing
7 changed files
with
169 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
--- | ||
sidebar_position: 1 | ||
--- | ||
|
||
# Hooks | ||
|
||
Hooks are functions that are called before and/or after certain events in the module's lifecycle. | ||
|
||
## Defining Hooks | ||
|
||
1. Define the hook interface and a wrapper implementing `depinject.OnePerModuleType`: | ||
|
||
```go reference | ||
https://github.com/cosmos/cosmos-sdk/blob/71c603a2a5a103df00f216d78ec8b108ed64ae28/testutil/x/counter/types/expected_keepers.go#L5-L12 | ||
``` | ||
|
||
2. Add a `CounterHooks` field to the keeper: | ||
|
||
```go reference | ||
https://github.com/cosmos/cosmos-sdk/blob/71c603a2a5a103df00f216d78ec8b108ed64ae28/testutil/x/counter/keeper/keeper.go#L25 | ||
``` | ||
|
||
3. Create a `depinject` invoker function | ||
|
||
```go reference | ||
https://github.com/cosmos/cosmos-sdk/blob/71c603a2a5a103df00f216d78ec8b108ed64ae28/testutil/x/counter/depinject.go#L53-L75 | ||
``` | ||
|
||
4. Inject the hooks during app initialization: | ||
|
||
```go | ||
appConfig = appconfig.Compose(&appv1alpha1.Config{ | ||
Modules: []*appv1alpha1.ModuleConfig{ | ||
// .... | ||
{ | ||
Name: types.ModuleName, | ||
Config: appconfig.WrapAny(&types.Module{}), | ||
}, | ||
} | ||
}) | ||
appConfig = depinject.Configs( | ||
AppConfig(), | ||
runtime.DefaultServiceBindings(), | ||
depinject.Supply( | ||
logger, | ||
viper, | ||
map[string]types.CounterHooksWrapper{ | ||
"counter": types.CounterHooksWrapper{&types.Hooks{}}, | ||
}, | ||
)) | ||
``` | ||
|
||
## Examples in the SDK | ||
|
||
For examples of hooks implementation in the Cosmos SDK, refer to the [Epochs Hooks documentation](https://docs.cosmos.network/main/build/modules/epochs#hooks) and [Distribution Hooks Documentation](https://docs.cosmos.network/main/build/modules/distribution#hooks). | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
package keeper | ||
|
||
import ( | ||
"context" | ||
) | ||
|
||
type Hooks struct { | ||
AfterCounterIncreased bool | ||
} | ||
|
||
func (h *Hooks) AfterIncreaseCount(ctx context.Context, n int64) error { | ||
h.AfterCounterIncreased = true | ||
return nil | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
package types | ||
|
||
import "context" | ||
|
||
type CounterHooks interface { | ||
AfterIncreaseCount(ctx context.Context, newCount int64) error | ||
} | ||
|
||
type CounterHooksWrapper struct{ CounterHooks } | ||
|
||
// IsOnePerModuleType implements the depinject.OnePerModuleType interface. | ||
func (CounterHooksWrapper) IsOnePerModuleType() {} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
package types | ||
|
||
import ( | ||
"context" | ||
"errors" | ||
) | ||
|
||
var _ CounterHooks = MultiCounterHooks{} | ||
|
||
// MultiCounterHooks is a slice of hooks to be called in sequence. | ||
type MultiCounterHooks []CounterHooks | ||
|
||
// NewMultiCounterHooks returns a MultiCounterHooks from a list of CounterHooks | ||
func NewMultiCounterHooks(hooks ...CounterHooks) MultiCounterHooks { | ||
return hooks | ||
} | ||
|
||
// AfterIncreaseCount calls AfterIncreaseCount on all hooks and collects the errors if any. | ||
func (ch MultiCounterHooks) AfterIncreaseCount(ctx context.Context, newCount int64) error { | ||
var errs error | ||
for i := range ch { | ||
errs = errors.Join(errs, ch[i].AfterIncreaseCount(ctx, newCount)) | ||
} | ||
|
||
return errs | ||
} |