Using a provider proxied commit store implementation in commit #1080
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,135 @@ | ||
| package ccip | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "io" | ||
| "math/big" | ||
| "time" | ||
|
|
||
| "go.uber.org/multierr" | ||
|
|
||
| "github.com/smartcontractkit/chainlink/v2/core/chains/evm/gas" | ||
|
|
||
| cciptypes "github.com/smartcontractkit/chainlink-common/pkg/types/ccip" | ||
| ) | ||
|
|
||
| // The disjunct methods in IncompleteSourceCommitStoreReader and IncompleteDestCommitStoreReader satisfy the full | ||
| // CommitStoreReader iface in Union | ||
| var _ cciptypes.CommitStoreReader = (*ProviderProxyCommitStoreReader)(nil) | ||
|
|
||
| // ProviderProxyCommitStoreReader is a CommitStoreReader that proxies to two custom provider grpc backed implementations | ||
| // of a CommitStoreReader. | ||
| // [ProviderProxyCommitStoreReader] lives in the memory space of the reporting plugin factory and reporting plugin, and should have no chain-specific details. | ||
| // Why? Historical implementations of a commit store consumed in reporting plugins mixed usage of a gas estimator from | ||
| // the source relayer and contract read and write abilities to a dest relayer. This is not valid in LOOP world. | ||
| type ProviderProxyCommitStoreReader struct { | ||
| srcCommitStoreReader IncompleteSourceCommitStoreReader | ||
| dstCommitStoreReader IncompleteDestCommitStoreReader | ||
| } | ||
|
|
||
| // IncompleteSourceCommitStoreReader contains only the methods of CommitStoreReader that are serviced by the source chain/relayer. | ||
| type IncompleteSourceCommitStoreReader interface { | ||
|
There was a problem hiding this comment. I feel |
||
| ChangeConfig(ctx context.Context, onchainConfig []byte, offchainConfig []byte) (cciptypes.Address, error) | ||
| GasPriceEstimator(ctx context.Context) (cciptypes.GasPriceEstimatorCommit, error) | ||
| OffchainConfig(ctx context.Context) (cciptypes.CommitOffchainConfig, error) | ||
| io.Closer | ||
| } | ||
|
|
||
| // IncompleteDestCommitStoreReader contains only the methods of CommitStoreReader that are serviced by the dest chain/relayer. | ||
| type IncompleteDestCommitStoreReader interface { | ||
| DecodeCommitReport(ctx context.Context, report []byte) (cciptypes.CommitStoreReport, error) | ||
| EncodeCommitReport(ctx context.Context, report cciptypes.CommitStoreReport) ([]byte, error) | ||
| GetAcceptedCommitReportsGteTimestamp(ctx context.Context, ts time.Time, confirmations int) ([]cciptypes.CommitStoreReportWithTxMeta, error) | ||
| GetCommitReportMatchingSeqNum(ctx context.Context, seqNum uint64, confirmations int) ([]cciptypes.CommitStoreReportWithTxMeta, error) | ||
| GetCommitStoreStaticConfig(ctx context.Context) (cciptypes.CommitStoreStaticConfig, error) | ||
| GetExpectedNextSequenceNumber(ctx context.Context) (uint64, error) | ||
| GetLatestPriceEpochAndRound(ctx context.Context) (uint64, error) | ||
| IsBlessed(ctx context.Context, root [32]byte) (bool, error) | ||
| IsDestChainHealthy(ctx context.Context) (bool, error) | ||
| IsDown(ctx context.Context) (bool, error) | ||
| VerifyExecutionReport(ctx context.Context, report cciptypes.ExecReport) (bool, error) | ||
| io.Closer | ||
| } | ||
|
|
||
| func NewProviderProxyCommitStoreReader(srcReader cciptypes.CommitStoreReader, dstReader cciptypes.CommitStoreReader) *ProviderProxyCommitStoreReader { | ||
| return &ProviderProxyCommitStoreReader{ | ||
| srcCommitStoreReader: srcReader, | ||
| dstCommitStoreReader: dstReader, | ||
| } | ||
| } | ||
|
|
||
| // ChangeConfig updates the offchainConfig values for the source relayer gas estimator by calling ChangeConfig | ||
| // on the source relayer. Once this is called, GasPriceEstimator and OffchainConfig can be called. | ||
| func (p *ProviderProxyCommitStoreReader) ChangeConfig(ctx context.Context, onchainConfig []byte, offchainConfig []byte) (cciptypes.Address, error) { | ||
| return p.srcCommitStoreReader.ChangeConfig(ctx, onchainConfig, offchainConfig) | ||
| } | ||
|
|
||
| func (p *ProviderProxyCommitStoreReader) DecodeCommitReport(ctx context.Context, report []byte) (cciptypes.CommitStoreReport, error) { | ||
| return p.dstCommitStoreReader.DecodeCommitReport(ctx, report) | ||
| } | ||
|
|
||
| func (p *ProviderProxyCommitStoreReader) EncodeCommitReport(ctx context.Context, report cciptypes.CommitStoreReport) ([]byte, error) { | ||
| return p.dstCommitStoreReader.EncodeCommitReport(ctx, report) | ||
| } | ||
|
|
||
| // GasPriceEstimator constructs a gas price estimator on the source relayer | ||
| func (p *ProviderProxyCommitStoreReader) GasPriceEstimator(ctx context.Context) (cciptypes.GasPriceEstimatorCommit, error) { | ||
| return p.srcCommitStoreReader.GasPriceEstimator(ctx) | ||
| } | ||
|
|
||
| func (p *ProviderProxyCommitStoreReader) GetAcceptedCommitReportsGteTimestamp(ctx context.Context, ts time.Time, confirmations int) ([]cciptypes.CommitStoreReportWithTxMeta, error) { | ||
| return p.dstCommitStoreReader.GetAcceptedCommitReportsGteTimestamp(ctx, ts, confirmations) | ||
| } | ||
|
|
||
| func (p *ProviderProxyCommitStoreReader) GetCommitReportMatchingSeqNum(ctx context.Context, seqNum uint64, confirmations int) ([]cciptypes.CommitStoreReportWithTxMeta, error) { | ||
| return p.dstCommitStoreReader.GetCommitReportMatchingSeqNum(ctx, seqNum, confirmations) | ||
| } | ||
|
|
||
| func (p *ProviderProxyCommitStoreReader) GetCommitStoreStaticConfig(ctx context.Context) (cciptypes.CommitStoreStaticConfig, error) { | ||
| return p.dstCommitStoreReader.GetCommitStoreStaticConfig(ctx) | ||
| } | ||
|
|
||
| func (p *ProviderProxyCommitStoreReader) GetExpectedNextSequenceNumber(ctx context.Context) (uint64, error) { | ||
| return p.dstCommitStoreReader.GetExpectedNextSequenceNumber(ctx) | ||
| } | ||
|
|
||
| func (p *ProviderProxyCommitStoreReader) GetLatestPriceEpochAndRound(ctx context.Context) (uint64, error) { | ||
| return p.dstCommitStoreReader.GetLatestPriceEpochAndRound(ctx) | ||
| } | ||
|
|
||
| func (p *ProviderProxyCommitStoreReader) IsBlessed(ctx context.Context, root [32]byte) (bool, error) { | ||
| return p.dstCommitStoreReader.IsBlessed(ctx, root) | ||
| } | ||
|
|
||
| func (p *ProviderProxyCommitStoreReader) IsDestChainHealthy(ctx context.Context) (bool, error) { | ||
| return p.dstCommitStoreReader.IsDestChainHealthy(ctx) | ||
| } | ||
|
|
||
| func (p *ProviderProxyCommitStoreReader) IsDown(ctx context.Context) (bool, error) { | ||
| return p.dstCommitStoreReader.IsDown(ctx) | ||
| } | ||
|
|
||
| func (p *ProviderProxyCommitStoreReader) OffchainConfig(ctx context.Context) (cciptypes.CommitOffchainConfig, error) { | ||
| return p.srcCommitStoreReader.OffchainConfig(ctx) | ||
| } | ||
|
|
||
| func (p *ProviderProxyCommitStoreReader) VerifyExecutionReport(ctx context.Context, report cciptypes.ExecReport) (bool, error) { | ||
| return p.dstCommitStoreReader.VerifyExecutionReport(ctx, report) | ||
| } | ||
|
|
||
| // SetGasEstimator is invalid on ProviderProxyCommitStoreReader. The provider based impl's do not have SetGasEstimator | ||
| // defined, so this serves no purpose other than satisfying an interface. | ||
| func (p *ProviderProxyCommitStoreReader) SetGasEstimator(ctx context.Context, gpe gas.EvmFeeEstimator) error { | ||
| return fmt.Errorf("invalid usage of ProviderProxyCommitStoreReader") | ||
| } | ||
|
|
||
| // SetSourceMaxGasPrice is invalid on ProviderProxyCommitStoreReader. The provider based impl's do not have SetSourceMaxGasPrice | ||
| // defined, so this serves no purpose other than satisfying an interface. | ||
| func (p *ProviderProxyCommitStoreReader) SetSourceMaxGasPrice(ctx context.Context, sourceMaxGasPrice *big.Int) error { | ||
| return fmt.Errorf("invalid usage of ProviderProxyCommitStoreReader") | ||
| } | ||
|
|
||
| func (p *ProviderProxyCommitStoreReader) Close() error { | ||
| return multierr.Append(p.srcCommitStoreReader.Close(), p.dstCommitStoreReader.Close()) | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
that will cause confusion, worths at least adding a comment explaining
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll add here: #1150