Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CCIP-3552 refactor OP oracle to accept generic DA oracle config #14599

Merged
merged 19 commits into from
Oct 11, 2024
Merged

CCIP-3552 refactor OP oracle to accept generic DA oracle config #14599

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
da931af
Add DA oracle interface
ogtownsend Sep 27, 2024
985f918
run mockery
ogtownsend Oct 2, 2024
bade665
changeset
ogtownsend Oct 2, 2024
48e387c
Comment out DA oracle validations for now
ogtownsend Oct 2, 2024
448ea19
adding tag to changeset
ogtownsend Oct 2, 2024
10a6a51
fix tests
ogtownsend Oct 2, 2024
7bf53a2
fix tests and some more refactoring
ogtownsend Oct 2, 2024
7e18916
add tests for custom gas API
ogtownsend Oct 3, 2024
e5623f4
Rebase
ogtownsend Oct 4, 2024
9b2f749
feedback
ogtownsend Oct 7, 2024
c50b940
Fall back to check chainType when creating the L1 oracle
ogtownsend Oct 7, 2024
6624bcb
update default tomls with DA config
ogtownsend Oct 7, 2024
258830e
renamings
ogtownsend Oct 8, 2024
1f978bd
remove custom calldata option from op oracle
ogtownsend Oct 9, 2024
b3fdfd1
update namings again
ogtownsend Oct 9, 2024
986a33b
change OP oracle type to opstack
ogtownsend Oct 9, 2024
226fe74
feedback
ogtownsend Oct 10, 2024
6ab6540
use random address for tests
ogtownsend Oct 10, 2024
8f50535
Merge branch 'develop' into CCIP-3552-refactor-op-stack-oracle-to-acc…
ogtownsend Oct 10, 2024
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
5 changes: 5 additions & 0 deletions .changeset/late-pillows-shake.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"chainlink": patch
---

Refactor OP oracle to accept generic DA oracle config #wip
20 changes: 20 additions & 0 deletions core/capabilities/ccip/ocrimpls/contract_transmitter_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ import (

"github.com/smartcontractkit/chainlink/v2/core/capabilities/ccip/ocrimpls"
cctypes "github.com/smartcontractkit/chainlink/v2/core/capabilities/ccip/types"
"github.com/smartcontractkit/chainlink/v2/core/chains/evm/config/toml"
"github.com/smartcontractkit/chainlink/v2/core/chains/evm/types"

"github.com/ethereum/go-ethereum/accounts/abi/bind"
"github.com/ethereum/go-ethereum/accounts/abi/bind/backends"
Expand Down Expand Up @@ -588,6 +590,24 @@ type TestGasEstimatorConfig struct {
bumpThreshold uint64
}

func (g *TestGasEstimatorConfig) DAOracle() evmconfig.DAOracle {
return &TestDAOracleConfig{}
}

type TestDAOracleConfig struct {
evmconfig.DAOracle
}

func (d *TestDAOracleConfig) OracleType() toml.OracleType { return toml.OPStack }
func (d *TestDAOracleConfig) OracleAddress() *types.EIP55Address {
a, err := types.NewEIP55Address("0x420000000000000000000000000000000000000F")
if err != nil {
panic(err)
}
return &a
}
Comment on lines +602 to +608
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks eth specific but the capability generally tries to keep all the chain specific things separated. Might be worth discussing /w @asoliman92 at some point

func (d *TestDAOracleConfig) CustomGasPriceCalldata() string { return "" }

func (g *TestGasEstimatorConfig) BlockHistory() evmconfig.BlockHistory {
return &TestBlockHistoryConfig{}
}
Expand Down
24 changes: 24 additions & 0 deletions core/chains/evm/config/chain_scoped_gas_estimator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (

"github.com/smartcontractkit/chainlink/v2/core/chains/evm/assets"
"github.com/smartcontractkit/chainlink/v2/core/chains/evm/config/toml"
"github.com/smartcontractkit/chainlink/v2/core/chains/evm/types"
)

type gasEstimatorConfig struct {
Expand Down Expand Up @@ -42,6 +43,10 @@ func (g *gasEstimatorConfig) FeeHistory() FeeHistory {
return &feeHistoryConfig{c: g.c.FeeHistory}
}

func (g *gasEstimatorConfig) DAOracle() DAOracle {
return &daOracleConfig{c: g.c.DAOracle}
}

func (g *gasEstimatorConfig) EIP1559DynamicFees() bool {
return *g.c.EIP1559DynamicFees
}
Expand Down Expand Up @@ -118,6 +123,25 @@ func (g *gasEstimatorConfig) EstimateLimit() bool {
return *g.c.EstimateLimit
}

type daOracleConfig struct {
c toml.DAOracle
}

func (d *daOracleConfig) OracleType() toml.OracleType {
return d.c.OracleType
}

// OracleAddress returns the address of the oracle contract and is only supported on the OP stack for now.
func (d *daOracleConfig) OracleAddress() *types.EIP55Address {
return d.c.OracleAddress
}

// CustomGasPriceCalldata returns the calldata for a custom gas price API.
func (d *daOracleConfig) CustomGasPriceCalldata() string {
ogtownsend marked this conversation as resolved.
Show resolved Hide resolved
// TODO: CCIP-3710 update once custom calldata oracle is added
return ""
}

type limitJobTypeConfig struct {
c toml.GasLimitJobType
}
Expand Down
8 changes: 8 additions & 0 deletions core/chains/evm/config/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import (

"github.com/smartcontractkit/chainlink/v2/core/chains/evm/assets"
"github.com/smartcontractkit/chainlink/v2/core/chains/evm/config/chaintype"
"github.com/smartcontractkit/chainlink/v2/core/chains/evm/config/toml"
"github.com/smartcontractkit/chainlink/v2/core/chains/evm/types"
)

Expand Down Expand Up @@ -141,6 +142,7 @@ type GasEstimator interface {
Mode() string
PriceMaxKey(gethcommon.Address) *assets.Wei
EstimateLimit() bool
DAOracle() DAOracle
}

type LimitJobType interface {
Expand All @@ -162,6 +164,12 @@ type BlockHistory interface {
TransactionPercentile() uint16
}

type DAOracle interface {
ogtownsend marked this conversation as resolved.
Show resolved Hide resolved
OracleType() toml.OracleType
OracleAddress() *types.EIP55Address
CustomGasPriceCalldata() string
}

type FeeHistory interface {
CacheTimeout() time.Duration
}
Expand Down
47 changes: 47 additions & 0 deletions core/chains/evm/config/mocks/gas_estimator.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

24 changes: 24 additions & 0 deletions core/chains/evm/config/toml/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -588,6 +588,7 @@ type GasEstimator struct {

BlockHistory BlockHistoryEstimator `toml:",omitempty"`
FeeHistory FeeHistoryEstimator `toml:",omitempty"`
DAOracle DAOracle `toml:",omitempty"`
}

func (e *GasEstimator) ValidateConfig() (err error) {
Expand Down Expand Up @@ -683,6 +684,7 @@ func (e *GasEstimator) setFrom(f *GasEstimator) {
e.LimitJobType.setFrom(&f.LimitJobType)
e.BlockHistory.setFrom(&f.BlockHistory)
e.FeeHistory.setFrom(&f.FeeHistory)
e.DAOracle.setFrom(&f.DAOracle)
}

type GasLimitJobType struct {
Expand Down Expand Up @@ -755,6 +757,28 @@ func (u *FeeHistoryEstimator) setFrom(f *FeeHistoryEstimator) {
}
}

type DAOracle struct {
OracleType OracleType
OracleAddress *types.EIP55Address
CustomGasPriceCalldata string
}

type OracleType string

const (
OPStack = OracleType("opstack")
Arbitrum = OracleType("arbitrum")
ZKSync = OracleType("zksync")
)

func (d *DAOracle) setFrom(f *DAOracle) {
d.OracleType = f.OracleType
if v := f.OracleAddress; v != nil {
d.OracleAddress = v
}
d.CustomGasPriceCalldata = f.CustomGasPriceCalldata
}

type KeySpecificConfig []KeySpecific

func (ks KeySpecificConfig) ValidateConfig() (err error) {
Expand Down
4 changes: 4 additions & 0 deletions core/chains/evm/config/toml/defaults/Base_Goerli.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ BumpMin = '100 wei'
[GasEstimator.BlockHistory]
BlockHistorySize = 60

[GasEstimator.DAOracle]
OracleType = 'opstack'
OracleAddress = '0x420000000000000000000000000000000000000F'

[Transactions]
ResendAfterThreshold = '30s'

Expand Down
4 changes: 4 additions & 0 deletions core/chains/evm/config/toml/defaults/Base_Mainnet.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ BumpMin = '100 wei'
[GasEstimator.BlockHistory]
BlockHistorySize = 24

[GasEstimator.DAOracle]
OracleType = 'opstack'
OracleAddress = '0x420000000000000000000000000000000000000F'

[Transactions]
ResendAfterThreshold = '30s'

Expand Down
4 changes: 4 additions & 0 deletions core/chains/evm/config/toml/defaults/Base_Sepolia.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ BumpMin = '100 wei'
[GasEstimator.BlockHistory]
BlockHistorySize = 60

[GasEstimator.DAOracle]
OracleType = 'opstack'
OracleAddress = '0x420000000000000000000000000000000000000F'

[Transactions]
ResendAfterThreshold = '30s'

Expand Down
4 changes: 4 additions & 0 deletions core/chains/evm/config/toml/defaults/Kroma_Mainnet.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ BumpMin = '100 wei'
[GasEstimator.BlockHistory]
BlockHistorySize = 24

[GasEstimator.DAOracle]
OracleType = 'opstack'
OracleAddress = '0x4200000000000000000000000000000000000005'

[Transactions]
ResendAfterThreshold = '30s'

Expand Down
4 changes: 4 additions & 0 deletions core/chains/evm/config/toml/defaults/Kroma_Sepolia.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ BumpMin = '100 wei'
[GasEstimator.BlockHistory]
BlockHistorySize = 24

[GasEstimator.DAOracle]
OracleType = 'opstack'
OracleAddress = '0x4200000000000000000000000000000000000005'

[Transactions]
ResendAfterThreshold = '30s'

Expand Down
4 changes: 4 additions & 0 deletions core/chains/evm/config/toml/defaults/Optimism_Goerli.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ BumpMin = '100 wei'
[GasEstimator.BlockHistory]
BlockHistorySize = 60

[GasEstimator.DAOracle]
OracleType = 'opstack'
OracleAddress = '0x420000000000000000000000000000000000000F'

[Transactions]
ResendAfterThreshold = '30s'

Expand Down
4 changes: 4 additions & 0 deletions core/chains/evm/config/toml/defaults/Optimism_Mainnet.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ BumpMin = '100 wei'
[GasEstimator.BlockHistory]
BlockHistorySize = 24

[GasEstimator.DAOracle]
OracleType = 'opstack'
OracleAddress = '0x420000000000000000000000000000000000000F'

[Transactions]
ResendAfterThreshold = '30s'

Expand Down
4 changes: 4 additions & 0 deletions core/chains/evm/config/toml/defaults/Optimism_Sepolia.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ BumpMin = '100 wei'
[GasEstimator.BlockHistory]
BlockHistorySize = 60

[GasEstimator.DAOracle]
OracleType = 'opstack'
OracleAddress = '0x420000000000000000000000000000000000000F'

[Transactions]
ResendAfterThreshold = '30s'

Expand Down
4 changes: 4 additions & 0 deletions core/chains/evm/config/toml/defaults/Scroll_Mainnet.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ BumpMin = '1 gwei'
[GasEstimator.BlockHistory]
BlockHistorySize = 24

[GasEstimator.DAOracle]
OracleType = 'opstack'
OracleAddress = '0x5300000000000000000000000000000000000002'

[HeadTracker]
HistoryDepth = 50

Expand Down
4 changes: 4 additions & 0 deletions core/chains/evm/config/toml/defaults/Scroll_Sepolia.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ BumpMin = '1 gwei'
[GasEstimator.BlockHistory]
BlockHistorySize = 24

[GasEstimator.DAOracle]
OracleType = 'opstack'
OracleAddress = '0x5300000000000000000000000000000000000002'

[HeadTracker]
HistoryDepth = 50

Expand Down
4 changes: 4 additions & 0 deletions core/chains/evm/config/toml/defaults/Soneium_Sepolia.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ BumpMin = '1 mwei'
[GasEstimator.BlockHistory]
BlockHistorySize = 60

[GasEstimator.DAOracle]
OracleType = 'opstack'
OracleAddress = '0x420000000000000000000000000000000000000F'

[Transactions]
ResendAfterThreshold = '30s'

Expand Down
4 changes: 4 additions & 0 deletions core/chains/evm/config/toml/defaults/Zircuit_Mainnet.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ BumpMin = '100 wei'
[GasEstimator.BlockHistory]
BlockHistorySize = 24

[GasEstimator.DAOracle]
OracleType = 'opstack'
OracleAddress = '0x420000000000000000000000000000000000000F'

[Transactions]
ResendAfterThreshold = '30s'

Expand Down
4 changes: 4 additions & 0 deletions core/chains/evm/config/toml/defaults/Zircuit_Sepolia.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ BumpMin = '100 wei'
[GasEstimator.BlockHistory]
BlockHistorySize = 60

[GasEstimator.DAOracle]
OracleType = 'opstack'
patrickhuie19 marked this conversation as resolved.
Show resolved Hide resolved
OracleAddress = '0x420000000000000000000000000000000000000F'

[Transactions]
ResendAfterThreshold = '30s'

Expand Down
3 changes: 2 additions & 1 deletion core/chains/evm/gas/models.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,14 +76,15 @@ func NewEstimator(lggr logger.Logger, ethClient feeEstimatorClient, chaintype ch
"priceMax", geCfg.PriceMax(),
"priceMin", geCfg.PriceMin(),
"estimateLimit", geCfg.EstimateLimit(),
"daOracleAddress", geCfg.DAOracle().OracleAddress(),
)
df := geCfg.EIP1559DynamicFees()

// create l1Oracle only if it is supported for the chain
var l1Oracle rollups.L1Oracle
if rollups.IsRollupWithL1Support(chaintype) {
var err error
l1Oracle, err = rollups.NewL1GasOracle(lggr, ethClient, chaintype)
l1Oracle, err = rollups.NewL1GasOracle(lggr, ethClient, chaintype, geCfg.DAOracle())
if err != nil {
return nil, fmt.Errorf("failed to initialize L1 oracle: %w", err)
}
Expand Down
4 changes: 3 additions & 1 deletion core/chains/evm/gas/models_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import (
commonfee "github.com/smartcontractkit/chainlink/v2/common/fee"
"github.com/smartcontractkit/chainlink/v2/core/chains/evm/assets"
"github.com/smartcontractkit/chainlink/v2/core/chains/evm/config/chaintype"
"github.com/smartcontractkit/chainlink/v2/core/chains/evm/config/toml"
"github.com/smartcontractkit/chainlink/v2/core/chains/evm/gas"
"github.com/smartcontractkit/chainlink/v2/core/chains/evm/gas/mocks"
"github.com/smartcontractkit/chainlink/v2/core/chains/evm/gas/rollups"
Expand Down Expand Up @@ -71,7 +72,8 @@ func TestWrappedEvmEstimator(t *testing.T) {
assert.Nil(t, l1Oracle)

// expect l1Oracle
oracle, err := rollups.NewL1GasOracle(lggr, nil, chaintype.ChainOptimismBedrock)
daOracle := rollups.CreateTestDAOracle(t, toml.OPStack, "0x420000000000000000000000000000000000000F", "")
oracle, err := rollups.NewL1GasOracle(lggr, nil, chaintype.ChainOptimismBedrock, daOracle)
require.NoError(t, err)
// cast oracle to L1Oracle interface
estimator = gas.NewEvmFeeEstimator(lggr, getEst, false, geCfg, nil)
Expand Down
Loading
Loading