Skip to content

Commit

Permalink
godoc
Browse files Browse the repository at this point in the history
  • Loading branch information
sontrinh16 committed Nov 22, 2024
1 parent 8c8f0e4 commit 2c1f3a4
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 7 deletions.
16 changes: 10 additions & 6 deletions runtime/v2/module.go
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ func ProvideEnvironment(
headerService header.Service,
eventService event.Service,
branchService branch.Service,
routerBuilder ServiceBuilder,
routerBuilder RouterServiceBuilder,
) appmodulev2.Environment {
return appmodulev2.Environment{
Logger: logger,
Expand All @@ -232,13 +232,17 @@ func ProvideEnvironment(
}
}

type ServiceBuilder interface {
BuildMsgRouter([]byte) router.Service
// ServiceBuilder builds the msg router and query router service during app initialization.
type RouterServiceBuilder interface {
// BuildMsgRouter return a msg router service.
// - actor is the module store key.
BuildMsgRouter(actor []byte) router.Service
BuildQueryRouter() router.Service
}

type RouterServiceFactory func([]byte) router.Service

// routerBuilder implements RouterServiceBuilder
type routerBuilder struct {
msgRouterServiceFactory RouterServiceFactory
queryRouter router.Service
Expand All @@ -247,7 +251,7 @@ type routerBuilder struct {
func NewRouterBuilder(
msgRouterServiceFactory RouterServiceFactory,
queryRouter router.Service,
) ServiceBuilder {
) RouterServiceBuilder {
return routerBuilder{
msgRouterServiceFactory: msgRouterServiceFactory,
queryRouter: queryRouter,
Expand All @@ -269,7 +273,7 @@ func (b routerBuilder) BuildQueryRouter() router.Service {
// - event.Service
// - store/v2/root.Builder
// - branch.Service
// - router.ServiceBuilder
// - RouterServiceBuilder
//
// They are all required. For most use cases these default services bindings should be sufficient.
// Power users (or tests) may wish to provide their own services bindings, in which case they must
Expand All @@ -282,7 +286,7 @@ func DefaultServiceBindings() depinject.Config {
stf.NewKVStoreService(actor),
)
}
routerBuilder ServiceBuilder = routerBuilder{
routerBuilder RouterServiceBuilder = routerBuilder{
msgRouterServiceFactory: stf.NewMsgRouterService,
queryRouter: stf.NewQueryRouterService(),
}
Expand Down
2 changes: 1 addition & 1 deletion tests/integration/v2/app.go
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ func NewApp(
appConfig depinject.Config,
startupConfig StartupConfig,
branchService corebranch.Service,
routerServiceBuilder runtime.ServiceBuilder,
routerServiceBuilder runtime.RouterServiceBuilder,
extraOutputs ...interface{},
) (*App, error) {
// create the app with depinject
Expand Down

0 comments on commit 2c1f3a4

Please sign in to comment.