(feat:CRE-86): Forwarder view - revisited

deployment/changeset.go

@@ -114,3 +114,5 @@ type ChangesetOutput struct {
 // ViewState produces a product specific JSON representation of
 // the on and offchain state of the environment.
 type ViewState func(e Environment) (json.Marshaler, error)
+
+type ViewStateV2 func(e Environment, previousView json.Marshaler) (json.Marshaler, error)

deployment/keystone/changeset/state.go

@@ -1,8 +1,11 @@
 package changeset
 
 import (
+	"context"
 	"errors"
 	"fmt"
+	"sync"
+	"time"
 
 	"github.com/ethereum/go-ethereum/common"
 
@@ -33,10 +36,15 @@ type GetContractSetsResponse struct {
 	ContractSets map[uint64]ContractSet
 }
 
+type ForwarderContract struct {
+	Contract       *forwarder.KeystoneForwarder
+	TypeAndVersion deployment.TypeAndVersion
+}
+
 type ContractSet struct {
 	commonchangeset.MCMSWithTimelockState
 	OCR3                 map[common.Address]*ocr3_capability.OCR3Capability
-	Forwarder            *forwarder.KeystoneForwarder
+	Forwarder            *ForwarderContract
 	CapabilitiesRegistry *capabilities_registry.CapabilitiesRegistry
 	WorkflowRegistry     *workflow_registry.WorkflowRegistry
 }
@@ -46,7 +54,7 @@ func (cs ContractSet) Convert() internal.ContractSet {
 		MCMSWithTimelockState: commonchangeset.MCMSWithTimelockState{
 			MCMSWithTimelockContracts: cs.MCMSWithTimelockContracts,
 		},
-		Forwarder:            cs.Forwarder,
+		Forwarder:            cs.Forwarder.Contract,
 		WorkflowRegistry:     cs.WorkflowRegistry,
 		OCR3:                 cs.OCR3,
 		CapabilitiesRegistry: cs.CapabilitiesRegistry,
@@ -61,7 +69,7 @@ func (cs ContractSet) TransferableContracts() []common.Address {
 		}
 	}
 	if cs.Forwarder != nil {
-		out = append(out, cs.Forwarder.Address())
+		out = append(out, cs.Forwarder.Contract.Address())
 	}
 	if cs.CapabilitiesRegistry != nil {
 		out = append(out, cs.CapabilitiesRegistry.Address())
@@ -73,47 +81,125 @@ func (cs ContractSet) TransferableContracts() []common.Address {
 }
 
 // View is a view of the keystone chain
-// It is best effort and logs errors
-func (cs ContractSet) View(lggr logger.Logger) (KeystoneChainView, error) {
+// It is best-effort, logs errors and generates the views in parallel.
+func (cs ContractSet) View(ctx context.Context, prevView KeystoneChainView, lggr logger.Logger) (KeystoneChainView, error) {
 	out := NewKeystoneChainView()
 	var allErrs error
+	var wg sync.WaitGroup
+	errCh := make(chan error, 4) // We are generating 4 views concurrently
+
+	// Not sure if we want the timeout here... As more blocks are added, the timeout will be reached for Forwarders...
+	// TODO: If we keep the timeout, we need to make it configurable via ENV or params.
+	ctx, cancel := context.WithTimeout(ctx, 6*time.Minute)
+	defer cancel()
+
 	if cs.CapabilitiesRegistry != nil {
-		capRegView, err := common_v1_0.GenerateCapabilityRegistryView(cs.CapabilitiesRegistry)
-		if err != nil {
-			allErrs = errors.Join(allErrs, err)
-			lggr.Warn("failed to generate capability registry view: %w", err)
-		}
-		out.CapabilityRegistry[cs.CapabilitiesRegistry.Address().String()] = capRegView
+		wg.Add(1)
+		go func() {
+			defer wg.Done()
+			capRegView, err := common_v1_0.GenerateCapabilityRegistryView(cs.CapabilitiesRegistry)
+			if err != nil {
+				lggr.Warn("failed to generate capability registry view: %w", err)
+				errCh <- err
+			}
+			out.CapabilityRegistry[cs.CapabilitiesRegistry.Address().String()] = capRegView
+		}()
 	}
 
 	if cs.OCR3 != nil {
-		for addr, ocr3Cap := range cs.OCR3 {
-			oc := *ocr3Cap
-			addrCopy := addr
-			ocrView, err := GenerateOCR3ConfigView(oc)
-			if err != nil {
-				allErrs = errors.Join(allErrs, err)
-				// don't block view on single OCR3 not being configured
-				if errors.Is(err, ErrOCR3NotConfigured) {
-					lggr.Warnf("ocr3 not configured for address %s", addr)
-				} else {
-					lggr.Errorf("failed to generate OCR3 config view: %v", err)
+		wg.Add(1)
+		go func() {
+			defer wg.Done()
+			for addr, ocr3Cap := range cs.OCR3 {
+				select {
+				case <-ctx.Done():
+					return
+				default:
+					oc := *ocr3Cap
+					addrCopy := addr
+					ocrView, err := GenerateOCR3ConfigView(ctx, oc)
+					if err != nil {
+						// don't block view on single OCR3 not being configured
+						if errors.Is(err, ErrOCR3NotConfigured) {
+							lggr.Warnf("ocr3 not configured for address %s", addr)
+						} else {
+							lggr.Errorf("failed to generate OCR3 config view: %v", err)
+							errCh <- err
+						}
+						continue
+					}
+					out.OCRContracts[addrCopy.String()] = ocrView
 				}
 			}
-			out.OCRContracts[addrCopy.String()] = ocrView
-		}
+		}()
 	}
 
 	// Process the workflow registry and print if WorkflowRegistryError errors.
 	if cs.WorkflowRegistry != nil {
-		wrView, wrErrs := common_v1_0.GenerateWorkflowRegistryView(cs.WorkflowRegistry)
-		for _, err := range wrErrs {
-			allErrs = errors.Join(allErrs, err)
-			lggr.Errorf("WorkflowRegistry error: %v", err)
-		}
-		out.WorkflowRegistry[cs.WorkflowRegistry.Address().String()] = wrView
+		wg.Add(1)
+		go func() {
+			defer wg.Done()
+			wrView, wrErrs := common_v1_0.GenerateWorkflowRegistryView(cs.WorkflowRegistry)
+			for _, err := range wrErrs {
+				lggr.Errorf("WorkflowRegistry error: %v", err)
+				errCh <- err
+			}
+			out.WorkflowRegistry[cs.WorkflowRegistry.Address().String()] = wrView
+		}()
 	}
 
+	if cs.Forwarder != nil {
+		wg.Add(1)
+		go func() {
+			defer wg.Done()
+			fwrAddr := cs.Forwarder.Contract.Address().String()
+			var prevViews []ForwarderView
+			if prevView.Forwarders != nil {
+				pv, ok := prevView.Forwarders[fwrAddr]
+				if !ok {
+					prevViews = []ForwarderView{}
+				} else {
+					prevViews = pv
+				}
+			} else {
+				prevViews = []ForwarderView{}
+			}
+
+			select {
+			case <-ctx.Done():
+				errCh <- ctx.Err()
+				return
+			default:
+				fwrView, fwrErr := GenerateForwarderView(ctx, cs.Forwarder, prevViews)
+				if fwrErr != nil {
+					// don't block view on single forwarder not being configured
+					switch {
+					case errors.Is(fwrErr, ErrForwarderNotConfigured):
+						lggr.Warnf("forwarder not configured for address %s", cs.Forwarder.Contract.Address())
+					case errors.Is(fwrErr, context.Canceled), errors.Is(fwrErr, context.DeadlineExceeded):
+						lggr.Warnf("forwarder view generation cancelled for address %s", cs.Forwarder.Contract.Address())
+						errCh <- fwrErr
+					default:
+						lggr.Errorf("failed to generate forwarder view: %v", fwrErr)
+						errCh <- fwrErr
+					}
+				} else {
+					out.Forwarders[fwrAddr] = fwrView
+				}
+			}
+		}()
+	}
+
+	wg.Wait()
+	close(errCh)
+
+	var errList []error
+	// Collect all errors
+	for err := range errCh {
+		errList = append(errList, err)
+	}
+	allErrs = errors.Join(errList...)
+
 	return out, allErrs
 }
 
@@ -179,7 +265,10 @@ func loadContractSet(lggr logger.Logger, chain deployment.Chain, addresses map[s
 			if err != nil {
 				return nil, fmt.Errorf("failed to create forwarder contract from address %s: %w", addr, err)
 			}
-			out.Forwarder = c
+			out.Forwarder = &ForwarderContract{
+				Contract:       c,
+				TypeAndVersion: tv,
+			}
 		case OCR3Capability:
 			c, err := ocr3_capability.NewOCR3Capability(common.HexToAddress(addr), chain.Client)
 			if err != nil {

deployment/keystone/changeset/view.go

@@ -11,9 +11,9 @@ import (
 	commonview "github.com/smartcontractkit/chainlink/deployment/common/view"
 )
 
-var _ deployment.ViewState = ViewKeystone
+var _ deployment.ViewStateV2 = ViewKeystone
 
-func ViewKeystone(e deployment.Environment) (json.Marshaler, error) {
+func ViewKeystone(e deployment.Environment, previousView json.Marshaler) (json.Marshaler, error) {
 	lggr := e.Logger
 	state, err := GetContractSets(e.Logger, &GetContractSetsRequest{
 		Chains:      e.Chains,
@@ -23,6 +23,20 @@ func ViewKeystone(e deployment.Environment) (json.Marshaler, error) {
 	if err != nil {
 		return nil, fmt.Errorf("failed to get contract sets: %w", err)
 	}
+
+	prevViewBytes, err := previousView.MarshalJSON()
+	if err != nil {
+		// just log the error, we don't need to stop the execution since the previous view is optional
+		lggr.Warnf("failed to marshal previous keystone view: %v", err)
+	}
+	var prevView KeystoneView
+	if len(prevViewBytes) == 0 {
+		prevView.Chains = make(map[string]KeystoneChainView)
+	} else if err = json.Unmarshal(prevViewBytes, &prevView); err != nil {
+		lggr.Warnf("failed to unmarshal previous keystone view: %v", err)
+		prevView.Chains = make(map[string]KeystoneChainView)
+	}
+
 	var viewErrs error
 	chainViews := make(map[string]KeystoneChainView)
 	for chainSel, contracts := range state.ContractSets {
@@ -40,7 +54,7 @@ func ViewKeystone(e deployment.Environment) (json.Marshaler, error) {
 			viewErrs = errors.Join(viewErrs, err2)
 			continue
 		}
-		v, err := contracts.View(e.Logger)
+		v, err := contracts.View(e.GetContext(), prevView.Chains[chainName], e.Logger)
 		if err != nil {
 			err2 := fmt.Errorf("failed to view chain %s: %w", chainName, err)
 			lggr.Error(err2)