TWEAK: Add CLI flag for IPCs path.

Author: Tyler Smith

ipcs/chainipc.go

@@ -13,28 +13,36 @@ import (
 )
 
 const (
-	defaultBaseURL = "/tmp"
+	DefaultBaseURL = "/tmp"
 
 	ipcIdentifierPrefix    = "ipc"
 	ipcConsensusIdentifier = "consensus"
 	ipcDecisionsIdentifier = "decisions"
 )
 
+type context struct {
+	log       logging.Logger
+	networkID uint32
+	path      string
+}
+
 // ChainIPCs maintains IPCs for a set of chains
 type ChainIPCs struct {
-	log             logging.Logger
-	networkID       uint32
+	context
 	chains          map[[32]byte]*eventSockets
 	consensusEvents *triggers.EventDispatcher
 	decisionEvents  *triggers.EventDispatcher
 }
 
 // NewChainIPCs creates a new *ChainIPCs that writes consensus and decision
 // events to IPC sockets
-func NewChainIPCs(log logging.Logger, networkID uint32, consensusEvents *triggers.EventDispatcher, decisionEvents *triggers.EventDispatcher, defaultChainIDs []ids.ID) (*ChainIPCs, error) {
+func NewChainIPCs(log logging.Logger, path string, networkID uint32, consensusEvents *triggers.EventDispatcher, decisionEvents *triggers.EventDispatcher, defaultChainIDs []ids.ID) (*ChainIPCs, error) {
 	cipcs := &ChainIPCs{
-		log:             log,
-		networkID:       networkID,
+		context: context{
+			log:       log,
+			networkID: networkID,
+			path:      path,
+		},
 		chains:          make(map[[32]byte]*eventSockets),
 		consensusEvents: consensusEvents,
 		decisionEvents:  decisionEvents,
@@ -56,7 +64,7 @@ func (cipcs *ChainIPCs) Publish(chainID ids.ID) (*eventSockets, error) {
 		return es, nil
 	}
 
-	es, err := newEventSockets(cipcs.log, cipcs.networkID, chainID, cipcs.consensusEvents, cipcs.decisionEvents)
+	es, err := newEventSockets(cipcs.context, chainID, cipcs.consensusEvents, cipcs.decisionEvents)
 	if err != nil {
 		cipcs.log.Error("can't create ipcs: %s", err)
 		return nil, err
@@ -77,6 +85,6 @@ func (cipcs *ChainIPCs) Unpublish(chainID ids.ID) (bool, error) {
 	return true, chainIPCs.stop()
 }
 
-func ipcURL(base string, networkID uint32, chainID ids.ID, eventType string) string {
-	return path.Join(base, fmt.Sprintf("%d-%s-%s", networkID, chainID.String(), eventType))
+func ipcURL(ctx context, chainID ids.ID, eventType string) string {
+	return path.Join(ctx.path, fmt.Sprintf("%d-%s-%s", ctx.networkID, chainID.String(), eventType))
 }

ipcs/eventsocket.go

@@ -14,20 +14,25 @@ import (
 	"github.com/ava-labs/gecko/utils/wrappers"
 )
 
+type chainEventDipatcher struct {
+	chainID ids.ID
+	events  *triggers.EventDispatcher
+}
+
 // eventSockets is a set of named eventSockets
 type eventSockets struct {
 	consensusSocket *eventSocket
 	decisionsSocket *eventSocket
 }
 
 // newEventSockets creates a *ChainIPCs with both consensus and decisions IPCs
-func newEventSockets(log logging.Logger, networkID uint32, chainID ids.ID, consensusEvents *triggers.EventDispatcher, decisionEvents *triggers.EventDispatcher) (*eventSockets, error) {
-	consensusIPC, err := newEventIPCSocket(log, networkID, chainID, ipcConsensusIdentifier, consensusEvents)
+func newEventSockets(ctx context, chainID ids.ID, consensusEvents *triggers.EventDispatcher, decisionEvents *triggers.EventDispatcher) (*eventSockets, error) {
+	consensusIPC, err := newEventIPCSocket(ctx, chainID, ipcConsensusIdentifier, consensusEvents)
 	if err != nil {
 		return nil, err
 	}
 
-	decisionsIPC, err := newEventIPCSocket(log, networkID, chainID, ipcDecisionsIdentifier, decisionEvents)
+	decisionsIPC, err := newEventIPCSocket(ctx, chainID, ipcDecisionsIdentifier, decisionEvents)
 	if err != nil {
 		return nil, err
 	}
@@ -90,7 +95,7 @@ type eventSocket struct {
 
 // newEventIPCSocket creates a *eventSocket for the given chain and
 // EventDispatcher that writes to a local IPC socket
-func newEventIPCSocket(log logging.Logger, networkID uint32, chainID ids.ID, name string, events *triggers.EventDispatcher) (*eventSocket, error) {
+func newEventIPCSocket(ctx context, chainID ids.ID, name string, events *triggers.EventDispatcher) (*eventSocket, error) {
 	sock, err := pub.NewSocket()
 	if err != nil {
 		return nil, err
@@ -99,9 +104,9 @@ func newEventIPCSocket(log logging.Logger, networkID uint32, chainID ids.ID, nam
 	ipcName := ipcIdentifierPrefix + "-" + name
 
 	eis := &eventSocket{
-		log:    log,
+		log:    ctx.log,
 		socket: sock,
-		url:    ipcURL(defaultBaseURL, networkID, chainID, name),
+		url:    ipcURL(ctx, chainID, name),
 		unregisterFn: func() error {
 			return events.DeregisterChain(chainID, ipcName)
 		},

main/params.go

@@ -17,6 +17,7 @@ import (
 	"github.com/ava-labs/gecko/database/memdb"
 	"github.com/ava-labs/gecko/genesis"
 	"github.com/ava-labs/gecko/ids"
+	"github.com/ava-labs/gecko/ipcs"
 	"github.com/ava-labs/gecko/nat"
 	"github.com/ava-labs/gecko/node"
 	"github.com/ava-labs/gecko/snow/networking/router"
@@ -240,6 +241,7 @@ func init() {
 
 	// IPC
 	ipcsChainIDs := fs.String("ipcs-chain-ids", "", "Comma separated list of chain ids to add to the IPC engine. Example: 11111111111111111111111111111111LpoYY,4R5p2RXDGLqaifZE4hHWH9owe34pfoBULn1DrQTWivjg8o4aH")
+	fs.StringVar(&Config.IPCPath, "ipcs-path", ipcs.DefaultBaseURL, "The directory (Unix) or named pipe name prefix (Windows) for IPC sockets")
 
 	ferr := fs.Parse(os.Args[1:])
 

node/config.go

@@ -72,6 +72,7 @@ type Config struct {
 
 	// IPC configuration
 	IPCAPIEnabled      bool
+	IPCPath            string
 	IPCDefaultChainIDs []string
 
 	// Router that is used to handle incoming consensus messages

node/node.go

@@ -346,7 +346,7 @@ func (n *Node) initIPCs() error {
 	}
 
 	var err error
-	n.IPCs, err = ipcs.NewChainIPCs(n.Log, n.Config.NetworkID, n.ConsensusDispatcher, n.DecisionDispatcher, chainIDs)
+	n.IPCs, err = ipcs.NewChainIPCs(n.Log, n.Config.IPCPath, n.Config.NetworkID, n.ConsensusDispatcher, n.DecisionDispatcher, chainIDs)
 	return err
 }