feat: make block/tx event CBOR optional

Fixes #31

Author: agaffney

input/chainsync/block.go

@@ -22,15 +22,17 @@ type BlockEvent struct {
 	BlockNumber uint64           `json:"blockNumber"`
 	BlockHash   string           `json:"blockHash"`
 	SlotNumber  uint64           `json:"slotNumber"`
-	BlockCbor   byteSliceJsonHex `json:"blockCbor"`
+	BlockCbor   byteSliceJsonHex `json:"blockCbor,omitempty"`
 }
 
-func NewBlockEvent(block ledger.Block) BlockEvent {
+func NewBlockEvent(block ledger.Block, includeCbor bool) BlockEvent {
 	evt := BlockEvent{
 		BlockNumber: block.BlockNumber(),
 		BlockHash:   block.Hash(),
 		SlotNumber:  block.SlotNumber(),
-		BlockCbor:   block.Cbor(),
+	}
+	if includeCbor {
+		evt.BlockCbor = block.Cbor()
 	}
 	return evt
 }

input/chainsync/chainsync.go

@@ -21,7 +21,7 @@ import (
 
 	"github.com/blinklabs-io/snek/event"
 
-	"github.com/blinklabs-io/gouroboros"
+	ouroboros "github.com/blinklabs-io/gouroboros"
 	"github.com/blinklabs-io/gouroboros/ledger"
 	ochainsync "github.com/blinklabs-io/gouroboros/protocol/chainsync"
 	ocommon "github.com/blinklabs-io/gouroboros/protocol/common"
@@ -36,6 +36,7 @@ type ChainSync struct {
 	ntcTcp             bool
 	intersectTip       bool
 	intersectPoints    []ocommon.Point
+	includeCbor        bool
 	errorChan          chan error
 	eventChan          chan event.Event
 	byronEpochBaseSlot uint64
@@ -175,7 +176,7 @@ func (c *ChainSync) handleRollBackward(point ocommon.Point, tip ochainsync.Tip)
 func (c *ChainSync) handleRollForward(blockType uint, blockData interface{}, tip ochainsync.Tip) error {
 	switch v := blockData.(type) {
 	case ledger.Block:
-		evt := event.New("block", time.Now(), NewBlockEvent(v))
+		evt := event.New("block", time.Now(), NewBlockEvent(v, c.includeCbor))
 		c.eventChan <- evt
 	case ledger.BlockHeader:
 		var blockSlot uint64
@@ -201,10 +202,10 @@ func (c *ChainSync) handleRollForward(blockType uint, blockData interface{}, tip
 		if err != nil {
 			return err
 		}
-		blockEvt := event.New("block", time.Now(), NewBlockEvent(block))
+		blockEvt := event.New("block", time.Now(), NewBlockEvent(block, c.includeCbor))
 		c.eventChan <- blockEvt
 		for _, transaction := range block.Transactions() {
-			txEvt := event.New("transaction", time.Now(), NewTransactionEvent(block, transaction))
+			txEvt := event.New("transaction", time.Now(), NewTransactionEvent(block, transaction, c.includeCbor))
 			c.eventChan <- txEvt
 		}
 	}

input/chainsync/options.go

@@ -68,3 +68,10 @@ func WithIntersectTip(intersectTip bool) ChainSyncOptionFunc {
 		c.intersectTip = intersectTip
 	}
 }
+
+// WithIncludeCbor specifies whether to include the original CBOR for a block or transaction with the event
+func WithIncludeCbor(includeCbor bool) ChainSyncOptionFunc {
+	return func(c *ChainSync) {
+		c.includeCbor = includeCbor
+	}
+}

input/chainsync/plugin.go

@@ -26,6 +26,7 @@ var cmdlineOptions struct {
 	ntcTcp         bool
 	intersectTip   bool
 	intersectPoint string
+	includeCbor    bool
 }
 
 func init() {
@@ -81,6 +82,13 @@ func init() {
 					Dest:         &(cmdlineOptions.intersectTip),
 				},
 				// TODO: intersect-point
+				{
+					Name:         "include-cbor",
+					Type:         plugin.PluginOptionTypeBool,
+					Description:  "include original CBOR for block/transaction in events",
+					DefaultValue: false,
+					Dest:         &(cmdlineOptions.includeCbor),
+				},
 			},
 		},
 	)
@@ -95,6 +103,7 @@ func NewFromCmdlineOptions() plugin.Plugin {
 		WithNtcTcp(cmdlineOptions.ntcTcp),
 		WithIntersectTip(cmdlineOptions.intersectTip),
 		// TODO: WithIntersectPoints
+		WithIncludeCbor(cmdlineOptions.includeCbor),
 	)
 	return p
 }

input/chainsync/tx.go

@@ -23,16 +23,18 @@ type TransactionEvent struct {
 	BlockHash       string           `json:"blockHash"`
 	SlotNumber      uint64           `json:"slotNumber"`
 	TransactionHash string           `json:"transactionHash"`
-	TransactionCbor byteSliceJsonHex `json:"transactionCbor"`
+	TransactionCbor byteSliceJsonHex `json:"transactionCbor,omitempty"`
 }
 
-func NewTransactionEvent(block ledger.Block, txBody ledger.TransactionBody) TransactionEvent {
+func NewTransactionEvent(block ledger.Block, txBody ledger.TransactionBody, includeCbor bool) TransactionEvent {
 	evt := TransactionEvent{
 		BlockNumber:     block.BlockNumber(),
 		BlockHash:       block.Hash(),
 		SlotNumber:      block.SlotNumber(),
 		TransactionHash: txBody.Hash(),
-		TransactionCbor: txBody.Cbor(),
+	}
+	if includeCbor {
+		evt.TransactionCbor = txBody.Cbor()
 	}
 	return evt
 }