Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@ type AddCapabilitiesInput struct {
// SkipDuplicateCapabilityValidation disables the precondition check that rejects assigning
// the same capability to multiple DONs within a DON family.
SkipDuplicateCapabilityValidation bool `json:"skipDuplicateCapabilityValidation,omitempty" yaml:"skipDuplicateCapabilityValidation,omitempty"`

// SkipSignerFamilyJobCheck disables the precondition check that, when this change adds
// extraSignerFamilies to an OCR3 config, every node already has an APPROVED consensus job with a
// key bundle for each family. Use only for emergencies.
SkipSignerFamilyJobCheck bool `json:"skipSignerFamilyJobCheck,omitempty" yaml:"skipSignerFamilyJobCheck,omitempty"`
}

type AddCapabilities struct{}
Expand Down Expand Up @@ -71,6 +76,14 @@ func (u AddCapabilities) VerifyPreconditions(e cldf.Environment, config AddCapab
}
}

if !config.SkipSignerFamilyJobCheck {
for donName, donCapConfigs := range config.DonCapabilityConfigs {
if err := verifyDONSignerFamilies(e, config.RegistryChainSel, config.RegistryQualifier, donName, donCapConfigs, nil); err != nil {
return fmt.Errorf("AddCapabilities precondition failed: %w", err)
}
}
}

return nil
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,11 @@ type ConfigureCapabilitiesRegistryInput struct {
Nodes []CapabilitiesRegistryNodeParams `json:"nodes,omitempty" yaml:"nodes,omitempty"`
DONs []CapabilitiesRegistryNewDONParams `json:"dons,omitempty" yaml:"dons,omitempty"`
Qualifier string `json:"qualifier,omitempty" yaml:"qualifier,omitempty"`

// SkipSignerFamilyJobCheck disables the precondition check that, when this change adds
// extraSignerFamilies to an OCR3 config, every node already has an APPROVED consensus job with a
// key bundle for each family. Use only for emergencies.
SkipSignerFamilyJobCheck bool `json:"skipSignerFamilyJobCheck,omitempty" yaml:"skipSignerFamilyJobCheck,omitempty"`
}

type ConfigureCapabilitiesRegistryDeps struct {
Expand All @@ -55,6 +60,22 @@ func (l ConfigureCapabilitiesRegistry) VerifyPreconditions(e cldf.Environment, c
return fmt.Errorf("chain %d not found in environment", config.ChainSelector)
}

if !config.SkipSignerFamilyJobCheck {
for _, don := range config.DONs {
capConfigs := make([]ocr3CapConfig, len(don.CapabilityConfigurations))
for i, cc := range don.CapabilityConfigurations {
capConfigs[i] = ocr3CapConfig(cc)
}
families, err := requestedSignerFamilies(capConfigs)
if err != nil {
return fmt.Errorf("ConfigureCapabilitiesRegistry precondition failed: DON %q: %w", don.Name, err)
}
if err := verifySignerFamilyJobs(e, don.Nodes, families); err != nil {
return fmt.Errorf("ConfigureCapabilitiesRegistry precondition failed: DON %q: %w", don.Name, err)
}
}
}

return nil
}

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
package changeset_test

import (
"context"
"testing"

"github.com/stretchr/testify/require"
"google.golang.org/grpc"

cldf_offchain "github.com/smartcontractkit/chainlink-deployments-framework/offchain"
nodev1 "github.com/smartcontractkit/chainlink-protos/job-distributor/v1/node"

"github.com/smartcontractkit/chainlink/deployment/cre/capabilities_registry/v2/changeset"
"github.com/smartcontractkit/chainlink/deployment/cre/capabilities_registry/v2/changeset/operations/contracts"
"github.com/smartcontractkit/chainlink/deployment/cre/test"
)

// emptyJD knows no nodes, so no node can have an accepted job.
type emptyJD struct{ cldf_offchain.Client }

func (emptyJD) ListNodes(context.Context, *nodev1.ListNodesRequest, ...grpc.CallOption) (*nodev1.ListNodesResponse, error) {
return &nodev1.ListNodesResponse{}, nil
}

func stellarOCR3Config() map[string]any {
return map[string]any{"ocr3Configs": map[string]any{"__default__": map[string]any{
"offchainConfig": map[string]any{"maxFaultyOracles": 1},
"extraSignerFamilies": []any{"stellar"},
}}}
}

func TestAddCapabilities_VerifyPreconditions_SignerFamilyJobCheck(t *testing.T) {
h := test.NewTestHarness(t)

e := h.Runtime.Environment()
e.Offchain = emptyJD{}

in := changeset.AddCapabilitiesInput{
RegistryChainSel: h.RegistrySelector,
RegistryQualifier: test.RegistryQualifier,
DonCapabilityConfigs: map[string][]contracts.CapabilityConfig{
test.DONName: {{Capability: contracts.Capability{CapabilityID: "consensus@1.0.0"}, Config: stellarOCR3Config()}},
},
SkipDuplicateCapabilityValidation: true,
}

require.ErrorContains(t, changeset.AddCapabilities{}.VerifyPreconditions(e, in), "not in JD")

missing := in
missing.DonCapabilityConfigs = map[string][]contracts.CapabilityConfig{"no-such-don": in.DonCapabilityConfigs[test.DONName]}
require.ErrorContains(t, changeset.AddCapabilities{}.VerifyPreconditions(e, missing), "not found on-chain")

in.SkipSignerFamilyJobCheck = true
require.NoError(t, changeset.AddCapabilities{}.VerifyPreconditions(e, in))
}

func TestConfigureCapabilitiesRegistry_VerifyPreconditions_SignerFamilyJobCheck(t *testing.T) {
h := test.NewTestHarness(t)

e := h.Runtime.Environment()
e.Offchain = emptyJD{}

in := changeset.ConfigureCapabilitiesRegistryInput{
ChainSelector: h.RegistrySelector,
Qualifier: test.RegistryQualifier,
DONs: []changeset.CapabilitiesRegistryNewDONParams{{
Name: "new-don",
Nodes: h.Don.GetP2PIDs().Strings(),
CapabilityConfigurations: []changeset.CapabilitiesRegistryCapabilityConfiguration{
{CapabilityID: "consensus@1.0.0", Config: stellarOCR3Config()},
},
}},
}

require.ErrorContains(t, changeset.ConfigureCapabilitiesRegistry{}.VerifyPreconditions(e, in), "not in JD")

in.SkipSignerFamilyJobCheck = true
require.NoError(t, changeset.ConfigureCapabilitiesRegistry{}.VerifyPreconditions(e, in))
}
Loading
Loading