chore: introduce Submodule interface (#855)

## Description

Introduces the `Submodule` interface and applies it to the P2P module's
peerstore provider.

## Issue

Deliverables 1, 2, 3, & 5:
- #810

## Type of change

Please mark the relevant option(s):

- [ ] New feature, functionality or library
- [ ] Bug fix
- [x] Code health or cleanup
- [ ] Major breaking change
- [x] Documentation
- [ ] Other <!-- add details here if it a different type of change -->

## List of changes

* fixed typo; renamee `IntegratableModule` to `IntegrableModule`
* renamed `InitializableModule` to `InjectableModule`
* removed `InjectableModule#Create()` as `Moudle` also embeds
`ModuleFactoryWithConfig`
* added `Submodule` interface type
* refactored peerstore providers as submodules
* updated module README

## Testing

- [x] `make develop_test`; if any code changes were made
- [x] `make test_e2e` on [k8s
LocalNet](https://github.com/pokt-network/pocket/blob/main/build/localnet/README.md);
if any code changes were made
- [x] `e2e-devnet-test` passes tests on
[DevNet](https://pocketnetwork.notion.site/How-to-DevNet-ff1598f27efe44c09f34e2aa0051f0dd);
if any code was changed
- [ ] [Docker Compose
LocalNet](https://github.com/pokt-network/pocket/blob/main/docs/development/README.md);
if any major functionality was changed or introduced
- [x] [k8s
LocalNet](https://github.com/pokt-network/pocket/blob/main/build/localnet/README.md);
if any infrastructure or configuration changes were made

## Required Checklist

- [x] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have added, or updated, [`godoc` format
comments](https://go.dev/blog/godoc) on touched members (see:
[tip.golang.org/doc/comment](https://tip.golang.org/doc/comment))
- [ ] I have tested my changes using the available tooling
- [ ] I have updated the corresponding CHANGELOG

### If Applicable Checklist

- [x] I have updated the corresponding README(s); local and/or global
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [x] I have added, or updated,
[mermaid.js](https://mermaid-js.github.io) diagrams in the corresponding
README(s)
- [ ] I have added, or updated, documentation and
[mermaid.js](https://mermaid-js.github.io) diagrams in `shared/docs/*`
if I updated `shared/*`README(s)

---------

Co-authored-by: d7t <[email protected]>
Co-authored-by: @olshansky <[email protected]>
Co-authored-by: Daniel Olshansky <[email protected]>
Co-authored-by: Daniel Olshansky <[email protected]>

Author: 4 people

app/client/cli/debug.go

@@ -228,7 +228,9 @@ func fetchPeerstore(cmd *cobra.Command) (typesP2P.Peerstore, error) {
 		return nil, errors.New("retrieving bus from CLI context")
 	}
 	modulesRegistry := bus.GetModulesRegistry()
-	pstoreProvider, err := modulesRegistry.GetModule(peerstore_provider.ModuleName)
+	// TECHDEBT(#810, #811): use `bus.GetPeerstoreProvider()` after peerstore provider
+	// is retrievable as a proper submodule
+	pstoreProvider, err := modulesRegistry.GetModule(peerstore_provider.PeerstoreProviderSubmoduleName)
 	if err != nil {
 		return nil, errors.New("retrieving peerstore provider")
 	}

app/client/cli/helpers/setup.go

@@ -27,24 +27,26 @@ func P2PDependenciesPreRunE(cmd *cobra.Command, _ []string) error {
 	bus := runtimeMgr.GetBus()
 	SetValueInCLIContext(cmd, BusCLICtxKey, bus)
 
-	setupPeerstoreProvider(*runtimeMgr, flags.RemoteCLIURL)
+	if err := setupPeerstoreProvider(*runtimeMgr, flags.RemoteCLIURL); err != nil {
+		return err
+	}
 	setupCurrentHeightProvider(*runtimeMgr, flags.RemoteCLIURL)
 	setupAndStartP2PModule(*runtimeMgr)
 
 	return nil
 }
 
-func setupPeerstoreProvider(rm runtime.Manager, rpcURL string) {
-	bus := rm.GetBus()
-	modulesRegistry := bus.GetModulesRegistry()
-	pstoreProvider := rpcPSP.Create(
-		rpcPSP.WithP2PConfig(rm.GetConfig().P2P),
-		rpcPSP.WithCustomRPCURL(rpcURL),
-	)
-	modulesRegistry.RegisterModule(pstoreProvider)
+func setupPeerstoreProvider(rm runtime.Manager, rpcURL string) error {
+	// Ensure `PeerstoreProvider` exists in the modules registry.
+	if _, err := rpcPSP.Create(rm.GetBus(), rpcPSP.WithCustomRPCURL(rpcURL)); err != nil {
+		return err
+	}
+	return nil
 }
 
 func setupCurrentHeightProvider(rm runtime.Manager, rpcURL string) {
+	// TECHDEBT(#810): simplify after current height provider is refactored as
+	// a submodule.
 	bus := rm.GetBus()
 	modulesRegistry := bus.GetModulesRegistry()
 	currentHeightProvider := rpcCHP.NewRPCCurrentHeightProvider(

consensus/events.go

@@ -4,7 +4,7 @@ import (
 	"github.com/pokt-network/pocket/shared/messaging"
 )
 
-// publishNewHeightEvent publishes a new height event to the bus so that other interested IntegratableModules can react to it if necessary
+// publishNewHeightEvent publishes a new height event to the bus so that other interested IntegrableModules can react to it if necessary
 func (m *consensusModule) publishNewHeightEvent(height uint64) {
 	newHeightEvent, err := messaging.PackMessage(&messaging.ConsensusNewHeightEvent{Height: height})
 	if err != nil {

consensus/leader_election/module.go

@@ -14,7 +14,7 @@ type LeaderElectionModule interface {
 var _ LeaderElectionModule = &leaderElectionModule{}
 
 type leaderElectionModule struct {
-	base_modules.IntegratableModule
+	base_modules.IntegrableModule
 	base_modules.InterruptableModule
 }
 

consensus/module.go

@@ -31,7 +31,7 @@ const (
 )
 
 type consensusModule struct {
-	base_modules.IntegratableModule
+	base_modules.IntegrableModule
 
 	privateKey cryptoPocket.Ed25519PrivateKey
 
@@ -209,7 +209,7 @@ func (m *consensusModule) GetModuleName() string {
 }
 
 func (m *consensusModule) SetBus(pocketBus modules.Bus) {
-	m.IntegratableModule.SetBus(pocketBus)
+	m.IntegrableModule.SetBus(pocketBus)
 	if m.paceMaker != nil {
 		m.paceMaker.SetBus(pocketBus)
 	}

consensus/pacemaker/module.go

@@ -45,7 +45,7 @@ type Pacemaker interface {
 }
 
 type pacemaker struct {
-	base_modules.IntegratableModule
+	base_modules.IntegrableModule
 	base_modules.InterruptableModule
 
 	pacemakerCfg    *configs.PacemakerConfig

ibc/module.go

@@ -11,7 +11,7 @@ import (
 var _ modules.IBCModule = &ibcModule{}
 
 type ibcModule struct {
-	base_modules.IntegratableModule
+	base_modules.IntegrableModule
 
 	cfg    *configs.IBCConfig
 	logger *modules.Logger

logger/module.go

@@ -14,7 +14,7 @@ import (
 var _ modules.Module = &loggerModule{}
 
 type loggerModule struct {
-	base_modules.IntegratableModule
+	base_modules.IntegrableModule
 	base_modules.InterruptableModule
 
 	zerolog.Logger

p2p/background/router.go

@@ -27,16 +27,16 @@ import (
 )
 
 var (
-	_ typesP2P.Router            = &backgroundRouter{}
-	_ modules.IntegratableModule = &backgroundRouter{}
-	_ backgroundRouterFactory    = &backgroundRouter{}
+	_ typesP2P.Router          = &backgroundRouter{}
+	_ modules.IntegrableModule = &backgroundRouter{}
+	_ backgroundRouterFactory  = &backgroundRouter{}
 )
 
 type backgroundRouterFactory = modules.FactoryWithConfig[typesP2P.Router, *config.BackgroundConfig]
 
 // backgroundRouter implements `typesP2P.Router` for use with all P2P participants.
 type backgroundRouter struct {
-	base_modules.IntegratableModule
+	base_modules.IntegrableModule
 	unicast.UnicastRouter
 
 	logger *modules.Logger
@@ -260,6 +260,7 @@ func (rtr *backgroundRouter) setupPeerstore(
 		return err
 	}
 
+	// TECHDEBT(#859): integrate with `p2pModule#bootstrap()`.
 	if err := rtr.bootstrap(ctx); err != nil {
 		return fmt.Errorf("bootstrapping peerstore: %w", err)
 	}
@@ -318,6 +319,7 @@ func (rtr *backgroundRouter) setupSubscription() (err error) {
 	return err
 }
 
+// TECHDEBT(#859): integrate with `p2pModule#bootstrap()`.
 func (rtr *backgroundRouter) bootstrap(ctx context.Context) error {
 	// CONSIDERATION: add `GetPeers` method, which returns a map,
 	// to the `PeerstoreProvider` interface to simplify this loop.

p2p/bootstrap.go

@@ -59,12 +59,13 @@ func (m *p2pModule) bootstrap() error {
 			continue
 		}
 
-		pstoreProvider := rpcABP.Create(
-			rpcABP.WithP2PConfig(
-				m.GetBus().GetRuntimeMgr().GetConfig().P2P,
-			),
+		pstoreProvider, err := rpcABP.Create(
+			m.GetBus(),
 			rpcABP.WithCustomRPCURL(bootstrapNode),
 		)
+		if err != nil {
+			return fmt.Errorf("creating RPC peerstore provider: %w", err)
+		}
 
 		currentHeightProvider := rpcCHP.NewRPCCurrentHeightProvider(rpcCHP.WithCustomRPCURL(bootstrapNode))