-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
00329ee
commit 5225cac
Showing
4 changed files
with
230 additions
and
4 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,104 @@ | ||
| package hooks | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
|
|
||
| "github.com/kwilteam/kwil-db/common" | ||
| "github.com/kwilteam/kwil-db/core/utils/order" | ||
| ) | ||
|
|
||
| // GenesisHook is a function that is run exactly once, at network genesis. | ||
| // It can be used to create initial state or perform other setup tasks. | ||
| // If it returns an error, the network will immediately halt. Any state | ||
| // changed or error returned should be deterministic, as all nodes will | ||
| // run the same GenesisHooks in the same order. | ||
| type GenesisHook func(ctx context.Context, app *common.App, chain *common.ChainContext) error | ||
|
|
||
| // RegisterGenesisHook registers a GenesisHook to be run at network genesis. | ||
| // The name can be anything, as long as it is unique. It is used to deterministically | ||
| // order the hooks. | ||
| func RegisterGenesisHook(name string, hook GenesisHook) error { | ||
| _, ok := genesisHooks[name] | ||
| if ok { | ||
| return fmt.Errorf("genesis hook with name %s already exists", name) | ||
| } | ||
|
|
||
| genesisHooks[name] = hook | ||
| return nil | ||
| } | ||
|
|
||
| var genesisHooks map[string]GenesisHook | ||
|
|
||
| // ListGenesisHooks deterministically returns a list of all registered GenesisHooks. | ||
| func ListGenesisHooks() []struct { | ||
| Name string | ||
| Hook GenesisHook | ||
| } { | ||
| hooks := make([]struct { | ||
| Name string | ||
| Hook GenesisHook | ||
| }, 0, len(genesisHooks)) | ||
| for _, hook := range order.OrderMap(genesisHooks) { | ||
| hooks = append(hooks, struct { | ||
| Name string | ||
| Hook GenesisHook | ||
| }{ | ||
| Name: hook.Key, | ||
| Hook: hook.Value, | ||
| }) | ||
| } | ||
|
|
||
| return hooks | ||
| } | ||
|
|
||
| // EndBlockHook is a function that is run at the end of each block, after | ||
| // all of the transactions in the block have been processed, but before the | ||
| // any state has been committed. It is meant to be used to alter state, send | ||
| // data to external services, or perform cleanup tasks for other extensions. | ||
| // An error returned will halt the local node. All state changes and errors | ||
| // should be deterministic, as all nodes will run the same EndBlockHooks in | ||
| // the same order. | ||
| type EndBlockHook func(ctx context.Context, app *common.App, block *common.BlockContext) error | ||
|
|
||
| // RegisterEndBlockHook registers an EndBlockHook to be run at the end of each block. | ||
| // The name can be anything, as long as it is unique. It is used to deterministically | ||
| // order the hooks. | ||
| func RegisterEndBlockHook(name string, hook EndBlockHook) error { | ||
| _, ok := endBlockHooks[name] | ||
| if ok { | ||
| return fmt.Errorf("end block hook with name %s already exists", name) | ||
| } | ||
|
|
||
| endBlockHooks[name] = hook | ||
| return nil | ||
| } | ||
|
|
||
| var endBlockHooks map[string]EndBlockHook | ||
|
|
||
| // ListEndBlockHooks deterministically returns a list of all registered EndBlockHooks. | ||
| func ListEndBlockHooks() []struct { | ||
| Name string | ||
| Hook EndBlockHook | ||
| } { | ||
| var hooks []struct { | ||
| Name string | ||
| Hook EndBlockHook | ||
| } | ||
| for _, hook := range order.OrderMap(endBlockHooks) { | ||
| hooks = append(hooks, struct { | ||
| Name string | ||
| Hook EndBlockHook | ||
| }{ | ||
| Name: hook.Key, | ||
| Hook: hook.Value, | ||
| }) | ||
| } | ||
|
|
||
| return hooks | ||
| } | ||
|
|
||
| func init() { | ||
| genesisHooks = make(map[string]GenesisHook) | ||
| endBlockHooks = make(map[string]EndBlockHook) | ||
| } |
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
Oops, something went wrong.