Skip to content

Commit

Permalink
Update reporting plugin factory constructors (#20)
Browse files Browse the repository at this point in the history 
* commit: update factory constructor

* add contract writers, plugin limits

* add exec plugin factory constructor

* add consts for chain writer

* more method names

* disambiguate common methods further

* add home chain reader consts

* use consts in home chain reader

* remove panic

* hacky hacks

* don't fetch source chain cfg for dest

* add todo

* pass in filled config

* info level logs

* cast to ptr

* another log

* fix lint

* address comments

* use const from merklemulti
  • Loading branch information
@makramkd
makramkd authored Jul 17, 2024
1 parent 39aad01 commit 0bcfc8e
Show file tree
Hide file tree
Showing 14 changed files with 343 additions and 118 deletions.
96 changes: 73 additions & 23 deletions commit/factory.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,23 @@ package commit

import (
"context"
"errors"
"math/big"

"github.com/smartcontractkit/chainlink-ccip/internal/reader"
"github.com/smartcontractkit/chainlink-ccip/pluginconfig"

"google.golang.org/grpc"

"github.com/smartcontractkit/chainlink-common/pkg/logger"
"github.com/smartcontractkit/chainlink-common/pkg/merklemulti"
"github.com/smartcontractkit/chainlink-common/pkg/types"
cciptypes "github.com/smartcontractkit/chainlink-common/pkg/types/ccipocr3"
"github.com/smartcontractkit/chainlink-common/pkg/types/core"

"github.com/smartcontractkit/libocr/commontypes"
"github.com/smartcontractkit/libocr/offchainreporting2plus/ocr3types"
ocr2types "github.com/smartcontractkit/libocr/offchainreporting2plus/types"
libocrtypes "github.com/smartcontractkit/libocr/ragep2p/types"
ragep2ptypes "github.com/smartcontractkit/libocr/ragep2p/types"

"github.com/smartcontractkit/chainlink-ccip/internal/reader"
"github.com/smartcontractkit/chainlink-ccip/pluginconfig"
)

// PluginFactoryConstructor implements common OCR3ReportingPluginClient and is used for initializing a plugin factory
Expand All @@ -35,42 +39,88 @@ func (p PluginFactoryConstructor) NewReportingPluginFactory(
keyValueStore core.KeyValueStore,
relayerSet core.RelayerSet,
) (core.OCR3ReportingPluginFactory, error) {
return NewPluginFactory(), nil
return nil, errors.New("unimplemented")
}

func (p PluginFactoryConstructor) NewValidationService(ctx context.Context) (core.ValidationService, error) {
panic("implement me")
}

// PluginFactory implements common ReportingPluginFactory and is used for (re-)initializing commit plugin instances.
type PluginFactory struct{}
type PluginFactory struct {
lggr logger.Logger
ocrConfig reader.OCR3ConfigWithMeta
commitCodec cciptypes.CommitPluginCodec
msgHasher cciptypes.MessageHasher
homeChainReader reader.HomeChain
contractReaders map[cciptypes.ChainSelector]types.ContractReader
chainWriters map[cciptypes.ChainSelector]types.ChainWriter
}

func NewPluginFactory() *PluginFactory {
return &PluginFactory{}
func NewPluginFactory(
lggr logger.Logger,
ocrConfig reader.OCR3ConfigWithMeta,
commitCodec cciptypes.CommitPluginCodec,
msgHasher cciptypes.MessageHasher,
homeChainReader reader.HomeChain,
contractReaders map[cciptypes.ChainSelector]types.ContractReader,
chainWriters map[cciptypes.ChainSelector]types.ChainWriter,
) *PluginFactory {
return &PluginFactory{
lggr: lggr,
ocrConfig: ocrConfig,
commitCodec: commitCodec,
msgHasher: msgHasher,
homeChainReader: homeChainReader,
contractReaders: contractReaders,
chainWriters: chainWriters,
}
}

func (p PluginFactory) NewReportingPlugin(config ocr3types.ReportingPluginConfig,
func (p *PluginFactory) NewReportingPlugin(config ocr3types.ReportingPluginConfig,
) (ocr3types.ReportingPlugin[[]byte], ocr3types.ReportingPluginInfo, error) {
// TODO: Get this from ocr config, it's the mapping of the oracleId index in the DON
var oracleIDToP2pID map[commontypes.OracleID]libocrtypes.PeerID
var oracleIDToP2PID = make(map[commontypes.OracleID]ragep2ptypes.PeerID)
for oracleID, p2pID := range p.ocrConfig.Config.P2PIds {
oracleIDToP2PID[commontypes.OracleID(oracleID)] = p2pID
}

onChainTokenPricesReader := reader.NewOnchainTokenPricesReader(
reader.TokenPriceConfig{ // TODO: Inject config
StaticPrices: map[ocr2types.Account]big.Int{},
},
nil, // TODO: Inject this
)
ccipReader := reader.NewCCIPChainReader(
p.lggr,
p.contractReaders,
p.chainWriters,
p.ocrConfig.Config.ChainSelector,
)
return NewPlugin(
context.Background(),
config.OracleID,
oracleIDToP2pID,
pluginconfig.CommitPluginConfig{},
nil, // ccipReader
onChainTokenPricesReader,
nil, // reportCodec
nil, // msgHasher
nil, // lggr
nil, // homeChain
), ocr3types.ReportingPluginInfo{}, nil
context.Background(),
config.OracleID,
oracleIDToP2PID,
pluginconfig.CommitPluginConfig{
DestChain: p.ocrConfig.Config.ChainSelector,
NewMsgScanBatchSize: merklemulti.MaxNumberTreeLeaves,
},
ccipReader,
onChainTokenPricesReader,
p.commitCodec,
p.msgHasher,
p.lggr,
p.homeChainReader,
), ocr3types.ReportingPluginInfo{
Name: "CCIPRoleCommit",
Limits: ocr3types.ReportingPluginLimits{
// No query for this commit implementation.
MaxQueryLength: 0,
MaxObservationLength: 20_000, // 20kB
MaxOutcomeLength: 10_000, // 10kB
MaxReportLength: 10_000, // 10kB
MaxReportCount: 10,
},
}, nil
}

func (p PluginFactory) Name() string {
Expand Down
18 changes: 9 additions & 9 deletions commit/plugin.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ func (p *Plugin) Observation(
// If there's no previous outcome (first round ever), we only observe the latest committed sequence numbers.
// and on the next round we use those to look for messages.
if outctx.PreviousOutcome == nil {
p.lggr.Debugw("first round ever, can't observe new messages yet")
p.lggr.Infow("first round ever, can't observe new messages yet")
return plugintypes.NewCommitPluginObservation(
msgBaseDetails, gasPrices, tokenPrices, latestCommittedSeqNumsObservation, fChain,
).Encode()
Expand All @@ -167,7 +167,7 @@ func (p *Plugin) Observation(
if err != nil {
return types.Observation{}, fmt.Errorf("decode commit plugin previous outcome: %w", err)
}
p.lggr.Debugw("previous outcome decoded", "outcome", prevOutcome.String())
p.lggr.Infow("previous outcome decoded", "outcome", prevOutcome.String())

// Always observe based on previous outcome. We'll filter out stale messages in the outcome phase.
newMsgs, err := observeNewMsgs(
Expand Down Expand Up @@ -262,25 +262,25 @@ func (p *Plugin) Outcome(
}

maxSeqNums := maxSeqNumsConsensus(p.lggr, fChainDest, decodedObservations)
p.lggr.Debugw("max sequence numbers consensus", "maxSeqNumsConsensus", maxSeqNums)
p.lggr.Infow("max sequence numbers consensus", "maxSeqNumsConsensus", maxSeqNums)

merkleRoots, err := newMsgsConsensus(p.lggr, maxSeqNums, decodedObservations, fChains)
if err != nil {
return ocr3types.Outcome{}, fmt.Errorf("new messages consensus: %w", err)
}
p.lggr.Debugw("new messages consensus", "merkleRoots", merkleRoots)
p.lggr.Infow("new messages consensus", "merkleRoots", merkleRoots)

tokenPrices := tokenPricesConsensus(decodedObservations, fChainDest)

gasPrices := gasPricesConsensus(p.lggr, decodedObservations, fChainDest)
p.lggr.Debugw("gas prices consensus", "gasPrices", gasPrices)
p.lggr.Infow("gas prices consensus", "gasPrices", gasPrices)

outcome := plugintypes.NewCommitPluginOutcome(maxSeqNums, merkleRoots, tokenPrices, gasPrices)
if outcome.IsEmpty() {
p.lggr.Debugw("empty outcome")
p.lggr.Infow("empty outcome")
return ocr3types.Outcome{}, nil
}
p.lggr.Debugw("sending outcome", "outcome", outcome)
p.lggr.Infow("sending outcome", "outcome", outcome)

return outcome.Encode()
}
Expand Down Expand Up @@ -332,7 +332,7 @@ func (p *Plugin) ShouldTransmitAcceptedReport(
return false, fmt.Errorf("can't know if it's a writer: %w", err)
}
if !isWriter {
p.lggr.Debugw("not a writer, skipping report transmission")
p.lggr.Infow("not a writer, skipping report transmission")
return false, nil
}

Expand All @@ -349,7 +349,7 @@ func (p *Plugin) ShouldTransmitAcceptedReport(
return false, fmt.Errorf("validate merkle roots state: %w", err)
}

p.lggr.Debugw("transmitting report",
p.lggr.Infow("transmitting report",
"roots", len(decodedReport.MerkleRoots),
"tokenPriceUpdates", len(decodedReport.PriceUpdates.TokenPriceUpdates),
"gasPriceUpdates", len(decodedReport.PriceUpdates.GasPriceUpdates),
Expand Down
8 changes: 7 additions & 1 deletion commit/plugin_e2e_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import (
helpers "github.com/smartcontractkit/chainlink-ccip/internal/libs/testhelpers"
"github.com/smartcontractkit/chainlink-ccip/internal/mocks"
"github.com/smartcontractkit/chainlink-ccip/internal/reader"
"github.com/smartcontractkit/chainlink-ccip/pkg/consts"
"github.com/smartcontractkit/chainlink-ccip/pluginconfig"
"github.com/smartcontractkit/chainlink-ccip/plugintypes"
)
Expand Down Expand Up @@ -402,7 +403,12 @@ func newNode(
func setupHomeChainPoller(lggr logger.Logger, chainConfigInfos []reader.ChainConfigInfo) reader.HomeChain {
homeChainReader := mocks.NewContractReaderMock()
homeChainReader.On(
"GetLatestValue", mock.Anything, "CCIPConfig", "getAllChainConfigs", mock.Anything, mock.Anything,
"GetLatestValue",
mock.Anything,
consts.ContractNameCCIPConfig,
consts.MethodNameGetAllChainConfigs,
mock.Anything,
mock.Anything,
).Run(
func(args mock.Arguments) {
arg := args.Get(4).(*[]reader.ChainConfigInfo)
Expand Down
6 changes: 4 additions & 2 deletions commit/plugin_functions.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,12 @@ func observeLatestCommittedSeqNums(
sort.Slice(knownSourceChains, func(i, j int) bool { return knownSourceChains[i] < knownSourceChains[j] })
latestCommittedSeqNumsObservation := make([]plugintypes.SeqNumChain, 0)
if readableChains.Contains(destChain) {
lggr.Debugw("reading sequence numbers", "chains", knownSourceChains, "destChain", destChain)
lggr.Infow("reading sequence numbers", "chains", knownSourceChains, "destChain", destChain)
expectedNextSeqNums, err := ccipReader.NextSeqNum(ctx, knownSourceChains)
if err != nil {
return latestCommittedSeqNumsObservation, fmt.Errorf("get next seq nums: %w", err)
}
lggr.Debugw("observing latest committed sequence numbers",
lggr.Infow("observing latest committed sequence numbers",
"onChainNextSeqNums", expectedNextSeqNums, "destChain", destChain)
for i, ch := range knownSourceChains {
committedSeqNum := expectedNextSeqNums[i] - 1
Expand All @@ -50,6 +50,8 @@ func observeLatestCommittedSeqNums(
plugintypes.NewSeqNumChain(ch, committedSeqNum),
)
}
} else {
lggr.Infow("dest chain is not supported", "destChain", destChain)
}
return latestCommittedSeqNumsObservation, nil
}
Expand Down
85 changes: 71 additions & 14 deletions execute/factory.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,21 @@ package execute

import (
"context"
"errors"
"time"

"google.golang.org/grpc"

"github.com/smartcontractkit/chainlink-common/pkg/logger"
"github.com/smartcontractkit/chainlink-common/pkg/types"
cciptypes "github.com/smartcontractkit/chainlink-common/pkg/types/ccipocr3"
"github.com/smartcontractkit/libocr/offchainreporting2plus/ocr3types"

"github.com/smartcontractkit/chainlink-common/pkg/types/core"
"github.com/smartcontractkit/libocr/commontypes"
ragep2ptypes "github.com/smartcontractkit/libocr/ragep2p/types"

"github.com/smartcontractkit/chainlink-ccip/internal/reader"
"github.com/smartcontractkit/chainlink-ccip/pluginconfig"
)

Expand All @@ -30,34 +38,83 @@ func (p PluginFactoryConstructor) NewReportingPluginFactory(
keyValueStore core.KeyValueStore,
relayerSet core.RelayerSet,
) (core.OCR3ReportingPluginFactory, error) {
return NewPluginFactory(), nil
return nil, errors.New("unimplemented")
}

func (p PluginFactoryConstructor) NewValidationService(ctx context.Context) (core.ValidationService, error) {
panic("implement me")
}

// PluginFactory implements common ReportingPluginFactory and is used for (re-)initializing commit plugin instances.
type PluginFactory struct{}
type PluginFactory struct {
lggr logger.Logger
ocrConfig reader.OCR3ConfigWithMeta
execCodec cciptypes.ExecutePluginCodec
msgHasher cciptypes.MessageHasher
homeChainReader reader.HomeChain
contractReaders map[cciptypes.ChainSelector]types.ContractReader
chainWriters map[cciptypes.ChainSelector]types.ChainWriter
}

func NewPluginFactory() *PluginFactory {
return &PluginFactory{}
func NewPluginFactory(
lggr logger.Logger,
ocrConfig reader.OCR3ConfigWithMeta,
execCodec cciptypes.ExecutePluginCodec,
msgHasher cciptypes.MessageHasher,
homeChainReader reader.HomeChain,
contractReaders map[cciptypes.ChainSelector]types.ContractReader,
chainWriters map[cciptypes.ChainSelector]types.ChainWriter,
) *PluginFactory {
return &PluginFactory{
lggr: lggr,
ocrConfig: ocrConfig,
execCodec: execCodec,
msgHasher: msgHasher,
homeChainReader: homeChainReader,
contractReaders: contractReaders,
chainWriters: chainWriters,
}
}

func (p PluginFactory) NewReportingPlugin(
config ocr3types.ReportingPluginConfig,
) (ocr3types.ReportingPlugin[[]byte], ocr3types.ReportingPluginInfo, error) {
var oracleIDToP2PID = make(map[commontypes.OracleID]ragep2ptypes.PeerID)
for oracleID, p2pID := range p.ocrConfig.Config.P2PIds {
oracleIDToP2PID[commontypes.OracleID(oracleID)] = p2pID
}

ccipReader := reader.NewCCIPChainReader(
p.lggr,
p.contractReaders,
p.chainWriters,
p.ocrConfig.Config.ChainSelector,
)

return NewPlugin(
config,
pluginconfig.ExecutePluginConfig{},
nil,
nil,
nil,
nil,
nil,
nil,
nil,
), ocr3types.ReportingPluginInfo{}, nil
config,
pluginconfig.ExecutePluginConfig{
DestChain: p.ocrConfig.Config.ChainSelector,
MessageVisibilityInterval: 8 * time.Hour,
},
oracleIDToP2PID,
ccipReader,
p.execCodec,
p.msgHasher,
p.homeChainReader,
nil, // TODO: token data reader
p.lggr,
), ocr3types.ReportingPluginInfo{
Name: "CCIPRoleExecute",
Limits: ocr3types.ReportingPluginLimits{
// No query for this execute implementation.
MaxQueryLength: 0,
MaxObservationLength: 20_000, // 20kB
MaxOutcomeLength: 20_000, // 20kB
MaxReportLength: maxReportSizeBytes, // 250kB
MaxReportCount: 10,
},
}, nil
}

func (p PluginFactory) Name() string {
Expand Down
8 changes: 7 additions & 1 deletion execute/plugin_e2e_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import (
"github.com/smartcontractkit/chainlink-ccip/internal/mocks"
"github.com/smartcontractkit/chainlink-ccip/internal/mocks/inmem"
"github.com/smartcontractkit/chainlink-ccip/internal/reader"
"github.com/smartcontractkit/chainlink-ccip/pkg/consts"
"github.com/smartcontractkit/chainlink-ccip/pluginconfig"
"github.com/smartcontractkit/chainlink-ccip/plugintypes"
)
Expand Down Expand Up @@ -78,7 +79,12 @@ type nodeSetup struct {
func setupHomeChainPoller(lggr logger.Logger, chainConfigInfos []reader.ChainConfigInfo) reader.HomeChain {
homeChainReader := mocks.NewContractReaderMock()
homeChainReader.On(
"GetLatestValue", mock.Anything, "CCIPConfig", "getAllChainConfigs", mock.Anything, mock.Anything,
"GetLatestValue",
mock.Anything,
consts.ContractNameCCIPConfig,
consts.MethodNameGetAllChainConfigs,
mock.Anything,
mock.Anything,
).Run(
func(args mock.Arguments) {
arg := args.Get(4).(*[]reader.ChainConfigInfo)
Expand Down
Loading

0 comments on commit 0bcfc8e

Please sign in to comment.