[P2P] refactor: peerstore provider (part 1)

p2p/CHANGELOG.md

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.0.54] - 2023-06-06
+
+- Replaced embedded modules.Module with simpler modules.IntegratableModule in PeerstoreProvider interface
+- Removed unused PeerstoreProvider#GetP2PConfig() method
+- Added PeerstoreProvider#GetUnstakedPeerstore() method
+- Added p2pPeerstoreProvider implementation of PeerstoreProvider interface
+
 ## [0.0.0.53] - 2023-06-01
 
 - Moved nonce field from RainTreeMessage to PocketEnvelope protobuf types

p2p/providers/peerstore_provider/peerstore_provider.go

@@ -5,7 +5,6 @@ package peerstore_provider
 import (
 	"github.com/pokt-network/pocket/logger"
 	typesP2P "github.com/pokt-network/pocket/p2p/types"
-	"github.com/pokt-network/pocket/runtime/configs"
 	coreTypes "github.com/pokt-network/pocket/shared/core/types"
 	cryptoPocket "github.com/pokt-network/pocket/shared/crypto"
 	"github.com/pokt-network/pocket/shared/modules"
@@ -16,10 +15,10 @@ const ModuleName = "peerstore_provider"
 
 // PeerstoreProvider is an interface that provides Peerstore accessors
 type PeerstoreProvider interface {
-	modules.Module
+	modules.IntegratableModule
 
 	GetStakedPeerstoreAtHeight(height uint64) (typesP2P.Peerstore, error)
-	GetP2PConfig() *configs.P2PConfig
+	GetUnstakedPeerstore() (typesP2P.Peerstore, error)
 }
 
 func ActorsToPeerstore(abp PeerstoreProvider, actors []*coreTypes.Actor) (pstore typesP2P.Peerstore, errs error) {

p2p/providers/peerstore_provider/persistence/p2p.go

@@ -0,0 +1,72 @@
+package persistence
+
+import (
+	"fmt"
+
+	"github.com/pokt-network/pocket/p2p/providers/peerstore_provider"
+	typesP2P "github.com/pokt-network/pocket/p2p/types"
+	"github.com/pokt-network/pocket/shared/modules"
+	"github.com/pokt-network/pocket/shared/modules/base_modules"
+)
+
+var (
+	_ peerstore_provider.PeerstoreProvider = &p2pPeerstoreProvider{}
+	_ p2pPStoreProviderFactory             = &p2pPeerstoreProvider{}
+)
+
+// unstakedPeerstoreProvider is an interface which the p2p module supports in
+// order to allow access to the unstaked-actor-router's peerstore
+//
+// TECHDEBT(#xxx): will become unnecessary after `modules.P2PModule#GetUnstakedPeerstore` is added.`
+// CONSIDERATION: split `PeerstoreProvider` into `StakedPeerstoreProvider` and `UnstakedPeerstoreProvider`.
+// (see: https://github.com/pokt-network/pocket/pull/804#issuecomment-1576531916)
+type unstakedPeerstoreProvider interface {
+	GetUnstakedPeerstore() (typesP2P.Peerstore, error)
+}
+
+type p2pPStoreProviderFactory = modules.Factory[peerstore_provider.PeerstoreProvider]
+
+type p2pPeerstoreProvider struct {
+	base_modules.IntegratableModule
+	persistencePeerstoreProvider
+
+	p2pModule modules.P2PModule
+}
+
+func NewP2PPeerstoreProvider(
+	bus modules.Bus,
+) (peerstore_provider.PeerstoreProvider, error) {
+	return new(p2pPeerstoreProvider).Create(bus)
+}
+
+func (*p2pPeerstoreProvider) Create(
+	bus modules.Bus,
+) (peerstore_provider.PeerstoreProvider, error) {
+	if bus == nil {
+		return nil, fmt.Errorf("bus is required")
+	}
+
+	p2pModule := bus.GetP2PModule()
+	if p2pModule == nil {
+		return nil, fmt.Errorf("p2p module is not registered to bus and is required")
+	}
+
+	p2pPSP := &p2pPeerstoreProvider{
+		IntegratableModule: *base_modules.NewIntegratableModule(bus),
+		p2pModule:          p2pModule,
+	}
+
+	return p2pPSP, nil
+}
+
+func (*p2pPeerstoreProvider) GetModuleName() string {
+	return peerstore_provider.ModuleName
+}
+
+func (p2pPSP *p2pPeerstoreProvider) GetUnstakedPeerstore() (typesP2P.Peerstore, error) {
+	unstakedPSP, ok := p2pPSP.p2pModule.(unstakedPeerstoreProvider)
+	if !ok {
+		return nil, fmt.Errorf("p2p module does not implement unstakedPeerstoreProvider")
+	}
+	return unstakedPSP.GetUnstakedPeerstore()
+}

p2p/providers/peerstore_provider/persistence/provider.go → p2p/providers/peerstore_provider/persistence/persistence.go

@@ -1,6 +1,8 @@
 package persistence
 
 import (
+	"fmt"
+
 	"github.com/pokt-network/pocket/p2p/providers/peerstore_provider"
 	typesP2P "github.com/pokt-network/pocket/p2p/types"
 	"github.com/pokt-network/pocket/runtime/configs"
@@ -15,6 +17,7 @@ type persistencePeerstoreProvider struct {
 	base_modules.InterruptableModule
 }
 
+// TECHDEBT: refactor
 func NewPersistencePeerstoreProvider(bus modules.Bus, options ...func(*persistencePeerstoreProvider)) *persistencePeerstoreProvider {
 	pabp := &persistencePeerstoreProvider{
 		IntegratableModule: *base_modules.NewIntegratableModule(bus),
@@ -27,10 +30,12 @@ func NewPersistencePeerstoreProvider(bus modules.Bus, options ...func(*persisten
 	return pabp
 }
 
+// TECHDEBT: remove
 func Create(bus modules.Bus, options ...modules.ModuleOption) (modules.Module, error) {
 	return new(persistencePeerstoreProvider).Create(bus, options...)
 }
 
+// TECHDEBT: refactor
 func (*persistencePeerstoreProvider) Create(bus modules.Bus, options ...modules.ModuleOption) (modules.Module, error) {
 	return NewPersistencePeerstoreProvider(bus), nil
 }
@@ -56,3 +61,7 @@ func (pabp *persistencePeerstoreProvider) GetStakedPeerstoreAtHeight(height uint
 func (pabp *persistencePeerstoreProvider) GetP2PConfig() *configs.P2PConfig {
 	return pabp.GetBus().GetRuntimeMgr().GetConfig().P2P
 }
+
+func (pabp *persistencePeerstoreProvider) GetUnstakedPeerstore() (typesP2P.Peerstore, error) {
+	return nil, fmt.Errorf("persistence peerstore provider does not support unstaked peerstore")
+}

p2p/providers/peerstore_provider/rpc/provider.go

@@ -101,6 +101,10 @@ func (rabp *rpcPeerstoreProvider) GetP2PConfig() *configs.P2PConfig {
 	return rabp.p2pCfg
 }
 
+func (rabp *rpcPeerstoreProvider) GetUnstakedPeerstore() (typesP2P.Peerstore, error) {
+	return nil, fmt.Errorf("unstaked peerstore not supported by rpc peerstore provider")
+}
+
 func (rabp *rpcPeerstoreProvider) initRPCClient() {
 	rpcClient, err := rpc.NewClientWithResponses(rabp.rpcURL)
 	if err != nil {

shared/CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.0.60] - 2023-06-06
+
+- Added `Factory` generic type
+- Improved godoc comments
+
 ## [0.0.0.59] - 2023-06-01
 
 - Use ApplicationAddress in RelayMeta

shared/modules/factory.go

@@ -4,25 +4,31 @@ package modules
 // a variadic `ModuleOption` argument(s) and returns a `Module`and an error.
 type ModuleFactoryWithOptions FactoryWithOptions[Module, ModuleOption]
 
-// FactoryWithConfig implements a `#Create()` factory method which takes a
-// required "config" argument of type K and returns a value of type T and an error.
+// Factory implements a `#Create()` factory method which takes a bus and returns
+// a value of type T and an error.
+type Factory[T any] interface {
+	Create(bus Bus) (T, error)
+}
+
+// FactoryWithConfig implements a `#Create()` factory method which takes a bus and
+// a required "config" argument of type K and returns a value of type T and an error.
 // TECHDEBT: apply enforcement across applicable "sub-modules" (see: `p2p/raintree/router.go`: `raintTreeFactory`)
-type FactoryWithConfig[T interface{}, K interface{}] interface {
+type FactoryWithConfig[T any, K any] interface {
 	Create(bus Bus, cfg K) (T, error)
 }
 
-// FactoryWithOptions implements a `#Create()` factory method which takes a
-// variadic "optional" argument(s) of type O and returns a value of type T
+// FactoryWithOptions implements a `#Create()` factory method which takes a bus
+// and a variadic "optional" argument(s) of type O and returns a value of type T
 // and an error.
 // TECHDEBT: apply enforcement across applicable "sub-modules"
-type FactoryWithOptions[T interface{}, O interface{}] interface {
+type FactoryWithOptions[T any, O any] interface {
 	Create(bus Bus, opts ...O) (T, error)
 }
 
-// FactoryWithConfigAndOptions implements a `#Create()` factory method which
-// takes both a required "config" argument of type K and a variadic "optional"
+// FactoryWithConfigAndOptions implements a `#Create()` factory method which takes
+// a bus, a required "config" argument of type K, and a variadic (optional)
 // argument(s) of type O and returns a value of type T and an error.
 // TECHDEBT: apply enforcement across applicable "sub-modules"
-type FactoryWithConfigAndOptions[T interface{}, K interface{}, O interface{}] interface {
+type FactoryWithConfigAndOptions[T any, K any, O any] interface {
 	Create(bus Bus, cfg K, opts ...O) (T, error)
 }

shared/modules/p2p_module.go

@@ -14,6 +14,8 @@ type P2PModule interface {
 
 	// Returns the public P2P address of this node
 	GetAddress() (cryptoPocket.Address, error)
+	// TECHDEBT(#xxx): uncomment after moving `typesP2P.Peerstore` interface to a shared package
+	// GetUnstakedPeerstore() (typesP2P.Peerstore, error)
 
 	// A network broadcast to all staked actors on the network using RainTree
 	Broadcast(msg *anypb.Any) error