feat: functional options for mini-protocols

Fixes #167

Author: agaffney

README.md

@@ -90,6 +90,12 @@ Test local-tx-submission (only works in node-to-client mode).
 $ ./go-ouroboros-network ... local-tx-submission ...
 ```
 
+Test following the chain tip in the `preview` network.
+
+```
+$ ./go-ouroboros-network -preview -address preview-node.world.dev.cardano.org:30002 -ntn chain-sync -tip
+```
+
 ### Stopping the local `cardano-node` instance
 
 ```

cmd/go-ouroboros-network/chainsync.go

@@ -79,19 +79,19 @@ var eraIntersect = map[int]map[string][]interface{}{
 }
 
 func buildChainSyncConfig() chainsync.Config {
-	return chainsync.Config{
-		RollBackwardFunc: chainSyncRollBackwardHandler,
-		RollForwardFunc:  chainSyncRollForwardHandler,
-	}
+	return chainsync.NewConfig(
+		chainsync.WithRollBackwardFunc(chainSyncRollBackwardHandler),
+		chainsync.WithRollForwardFunc(chainSyncRollForwardHandler),
+	)
 }
 
 func buildBlockFetchConfig() blockfetch.Config {
-	return blockfetch.Config{
-		StartBatchFunc: blockFetchStartBatchHandler,
-		NoBlocksFunc:   blockFetchNoBlocksHandler,
-		BlockFunc:      blockFetchBlockHandler,
-		BatchDoneFunc:  blockFetchBatchDoneHandler,
-	}
+	return blockfetch.NewConfig(
+		blockfetch.WithStartBatchFunc(blockFetchStartBatchHandler),
+		blockfetch.WithNoBlocksFunc(blockFetchNoBlocksHandler),
+		blockfetch.WithBlockFunc(blockFetchBlockHandler),
+		blockfetch.WithBatchDoneFunc(blockFetchBatchDoneHandler),
+	)
 }
 
 func testChainSync(f *globalFlags) {

cmd/go-ouroboros-network/localtxsubmission.go

@@ -28,7 +28,7 @@ func newLocalTxSubmissionFlags() *localTxSubmissionFlags {
 }
 
 func buildLocalTxSubmissionConfig() localtxsubmission.Config {
-	return localtxsubmission.Config{}
+	return localtxsubmission.NewConfig()
 }
 
 func testLocalTxSubmission(f *globalFlags) {

cmd/go-ouroboros-network/query.go

@@ -20,7 +20,7 @@ func newQueryFlags() *queryFlags {
 }
 
 func buildLocalStateQueryConfig() localstatequery.Config {
-	return localstatequery.Config{}
+	return localstatequery.NewConfig()
 }
 
 func testQuery(f *globalFlags) {

ouroboros.go

@@ -167,18 +167,18 @@ func (o *Ouroboros) setupConnection() error {
 	// Perform handshake
 	var handshakeVersion uint16
 	var handshakeFullDuplex bool
-	handshakeConfig := &handshake.Config{
-		ProtocolVersions: protoVersions,
-		NetworkMagic:     o.networkMagic,
-		ClientFullDuplex: o.fullDuplex,
-		FinishedFunc: func(version uint16, fullDuplex bool) error {
+	handshakeConfig := handshake.NewConfig(
+		handshake.WithProtocolVersions(protoVersions),
+		handshake.WithNetworkMagic(o.networkMagic),
+		handshake.WithClientFullDuplex(o.fullDuplex),
+		handshake.WithFinishedFunc(func(version uint16, fullDuplex bool) error {
 			handshakeVersion = version
 			handshakeFullDuplex = fullDuplex
 			close(o.handshakeFinishedChan)
 			return nil
-		},
-	}
-	o.Handshake = handshake.New(protoOptions, handshakeConfig)
+		}),
+	)
+	o.Handshake = handshake.New(protoOptions, &handshakeConfig)
 	if o.server {
 		o.Handshake.Server.Start()
 	} else {

protocol/blockfetch/blockfetch.go

@@ -86,3 +86,38 @@ func New(protoOptions protocol.ProtocolOptions, cfg *Config) *BlockFetch {
 	}
 	return b
 }
+
+type BlockFetchOptionFunc func(*Config)
+
+func NewConfig(options ...BlockFetchOptionFunc) Config {
+	c := Config{}
+	// Apply provided options functions
+	for _, option := range options {
+		option(&c)
+	}
+	return c
+}
+
+func WithStartBatchFunc(startBatchFunc StartBatchFunc) BlockFetchOptionFunc {
+	return func(c *Config) {
+		c.StartBatchFunc = startBatchFunc
+	}
+}
+
+func WithNoBlocksFunc(noBlocksFunc NoBlocksFunc) BlockFetchOptionFunc {
+	return func(c *Config) {
+		c.NoBlocksFunc = noBlocksFunc
+	}
+}
+
+func WithBlockFunc(blockFunc BlockFunc) BlockFetchOptionFunc {
+	return func(c *Config) {
+		c.BlockFunc = blockFunc
+	}
+}
+
+func WithBatchDoneFunc(BatchDoneFunc BatchDoneFunc) BlockFetchOptionFunc {
+	return func(c *Config) {
+		c.BatchDoneFunc = BatchDoneFunc
+	}
+}

protocol/chainsync/chainsync.go

@@ -106,3 +106,26 @@ func New(protoOptions protocol.ProtocolOptions, cfg *Config) *ChainSync {
 	}
 	return c
 }
+
+type ChainSyncOptionFunc func(*Config)
+
+func NewConfig(options ...ChainSyncOptionFunc) Config {
+	c := Config{}
+	// Apply provided options functions
+	for _, option := range options {
+		option(&c)
+	}
+	return c
+}
+
+func WithRollBackwardFunc(rollBackwardFunc RollBackwardFunc) ChainSyncOptionFunc {
+	return func(c *Config) {
+		c.RollBackwardFunc = rollBackwardFunc
+	}
+}
+
+func WithRollForwardFunc(rollForwardFunc RollForwardFunc) ChainSyncOptionFunc {
+	return func(c *Config) {
+		c.RollForwardFunc = rollForwardFunc
+	}
+}

protocol/handshake/handshake.go

@@ -70,3 +70,38 @@ func New(protoOptions protocol.ProtocolOptions, cfg *Config) *Handshake {
 	}
 	return h
 }
+
+type HandshakeOptionFunc func(*Config)
+
+func NewConfig(options ...HandshakeOptionFunc) Config {
+	c := Config{}
+	// Apply provided options functions
+	for _, option := range options {
+		option(&c)
+	}
+	return c
+}
+
+func WithProtocolVersions(versions []uint16) HandshakeOptionFunc {
+	return func(c *Config) {
+		c.ProtocolVersions = versions
+	}
+}
+
+func WithNetworkMagic(networkMagic uint32) HandshakeOptionFunc {
+	return func(c *Config) {
+		c.NetworkMagic = networkMagic
+	}
+}
+
+func WithClientFullDuplex(fullDuplex bool) HandshakeOptionFunc {
+	return func(c *Config) {
+		c.ClientFullDuplex = fullDuplex
+	}
+}
+
+func WithFinishedFunc(finishedFunc FinishedFunc) HandshakeOptionFunc {
+	return func(c *Config) {
+		c.FinishedFunc = finishedFunc
+	}
+}

protocol/keepalive/keepalive.go

@@ -69,3 +69,32 @@ func New(protoOptions protocol.ProtocolOptions, cfg *Config) *KeepAlive {
 	}
 	return k
 }
+
+type KeepAliveOptionFunc func(*Config)
+
+func NewConfig(options ...KeepAliveOptionFunc) Config {
+	c := Config{}
+	// Apply provided options functions
+	for _, option := range options {
+		option(&c)
+	}
+	return c
+}
+
+func WithKeepAliveFunc(keepAliveFunc KeepAliveFunc) KeepAliveOptionFunc {
+	return func(c *Config) {
+		c.KeepAliveFunc = keepAliveFunc
+	}
+}
+
+func WithKeepAliveResponseFunc(keepAliveResponseFunc KeepAliveResponseFunc) KeepAliveOptionFunc {
+	return func(c *Config) {
+		c.KeepAliveResponseFunc = keepAliveResponseFunc
+	}
+}
+
+func WithDoneFunc(doneFunc DoneFunc) KeepAliveOptionFunc {
+	return func(c *Config) {
+		c.DoneFunc = doneFunc
+	}
+}

protocol/localstatequery/localstatequery.go

@@ -111,3 +111,44 @@ func New(protoOptions protocol.ProtocolOptions, cfg *Config) *LocalStateQuery {
 	}
 	return l
 }
+
+type LocalStateQueryOptionFunc func(*Config)
+
+func NewConfig(options ...LocalStateQueryOptionFunc) Config {
+	c := Config{}
+	// Apply provided options functions
+	for _, option := range options {
+		option(&c)
+	}
+	return c
+}
+
+func WithAcquireFunc(acquireFunc AcquireFunc) LocalStateQueryOptionFunc {
+	return func(c *Config) {
+		c.AcquireFunc = acquireFunc
+	}
+}
+
+func WithQueryFunc(queryFunc QueryFunc) LocalStateQueryOptionFunc {
+	return func(c *Config) {
+		c.QueryFunc = queryFunc
+	}
+}
+
+func WithReleaseFunc(releaseFunc ReleaseFunc) LocalStateQueryOptionFunc {
+	return func(c *Config) {
+		c.ReleaseFunc = releaseFunc
+	}
+}
+
+func WithReAcquireFunc(reAcquireFunc ReAcquireFunc) LocalStateQueryOptionFunc {
+	return func(c *Config) {
+		c.ReAcquireFunc = reAcquireFunc
+	}
+}
+
+func WithDoneFunc(doneFunc DoneFunc) LocalStateQueryOptionFunc {
+	return func(c *Config) {
+		c.DoneFunc = doneFunc
+	}
+}