Merge pull request #179 from cloudstruct/feat/chainsync-timeout

feat: make chainsync timeouts configurable

Author: agaffney

protocol/chainsync/chainsync.go

@@ -1,6 +1,8 @@
 package chainsync
 
 import (
+	"time"
+
 	"github.com/cloudstruct/go-ouroboros-network/protocol"
 	"github.com/cloudstruct/go-ouroboros-network/protocol/common"
 )
@@ -93,6 +95,8 @@ type ChainSync struct {
 type Config struct {
 	RollBackwardFunc RollBackwardFunc
 	RollForwardFunc  RollForwardFunc
+	IntersectTimeout time.Duration
+	BlockTimeout     time.Duration
 }
 
 // Callback function types
@@ -110,7 +114,14 @@ func New(protoOptions protocol.ProtocolOptions, cfg *Config) *ChainSync {
 type ChainSyncOptionFunc func(*Config)
 
 func NewConfig(options ...ChainSyncOptionFunc) Config {
-	c := Config{}
+	c := Config{
+		IntersectTimeout: 5 * time.Second,
+		// We should really use something more useful like 30-60s, but we've seen 55s between blocks
+		// in the preview network
+		// https://preview.cexplorer.io/block/cb08a386363a946d2606e912fcd81ffed2bf326cdbc4058297b14471af4f67e9
+		// https://preview.cexplorer.io/block/86806dca4ba735b233cbeee6da713bdece36fd41fb5c568f9ef5a3f5cbf572a3
+		BlockTimeout: 180 * time.Second,
+	}
 	// Apply provided options functions
 	for _, option := range options {
 		option(&c)
@@ -129,3 +140,15 @@ func WithRollForwardFunc(rollForwardFunc RollForwardFunc) ChainSyncOptionFunc {
 		c.RollForwardFunc = rollForwardFunc
 	}
 }
+
+func WithIntersectTimeout(timeout time.Duration) ChainSyncOptionFunc {
+	return func(c *Config) {
+		c.IntersectTimeout = timeout
+	}
+}
+
+func WithBlockTimeout(timeout time.Duration) ChainSyncOptionFunc {
+	return func(c *Config) {
+		c.BlockTimeout = timeout
+	}
+}

protocol/chainsync/client.go

@@ -27,12 +27,29 @@ func NewClient(protoOptions protocol.ProtocolOptions, cfg *Config) *Client {
 		protocolId = PROTOCOL_ID_NTN
 		msgFromCborFunc = NewMsgFromCborNtN
 	}
+	if cfg == nil {
+		tmpCfg := NewConfig()
+		cfg = &tmpCfg
+	}
 	c := &Client{
 		config:                cfg,
 		intersectResultChan:   make(chan error),
 		readyForNextBlockChan: make(chan bool),
 		currentTipChan:        make(chan Tip),
 	}
+	// Update state map with timeouts
+	stateMap := StateMap
+	if entry, ok := stateMap[STATE_INTERSECT]; ok {
+		entry.Timeout = c.config.IntersectTimeout
+		stateMap[STATE_INTERSECT] = entry
+	}
+	for _, state := range []protocol.State{STATE_CAN_AWAIT, STATE_MUST_REPLY} {
+		if entry, ok := stateMap[state]; ok {
+			entry.Timeout = c.config.BlockTimeout
+			stateMap[state] = entry
+		}
+	}
+	// Configure underlying Protocol
 	protoConfig := protocol.ProtocolConfig{
 		Name:                PROTOCOL_NAME,
 		ProtocolId:          protocolId,