/
config.go
255 lines (217 loc) · 8.89 KB
/
config.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
package validator
import (
"context"
"errors"
"time"
"github.com/ethereum/go-ethereum/common"
"github.com/ethereum/go-ethereum/ethclient"
"github.com/ethereum/go-ethereum/log"
"github.com/urfave/cli/v2"
"github.com/ethereum-optimism/optimism/op-node/rollup"
opservice "github.com/ethereum-optimism/optimism/op-service"
"github.com/ethereum-optimism/optimism/op-service/dial"
oplog "github.com/ethereum-optimism/optimism/op-service/log"
opmetrics "github.com/ethereum-optimism/optimism/op-service/metrics"
pprof "github.com/ethereum-optimism/optimism/op-service/pprof"
oprpc "github.com/ethereum-optimism/optimism/op-service/rpc"
"github.com/ethereum-optimism/optimism/op-service/sources"
"github.com/ethereum-optimism/optimism/op-service/txmgr"
chal "github.com/kroma-network/kroma/kroma-validator/challenge"
"github.com/kroma-network/kroma/kroma-validator/flags"
"github.com/kroma-network/kroma/kroma-validator/metrics"
)
// Config contains the well typed fields that are used to initialize the output submitter.
// It is intended for programmatic use.
type Config struct {
L2OutputOracleAddr common.Address
ColosseumAddr common.Address
SecurityCouncilAddr common.Address
ValidatorPoolAddr common.Address
ChallengerPollInterval time.Duration
NetworkTimeout time.Duration
TxManager *txmgr.BufferedTxManager
L1Client *ethclient.Client
L2Client *ethclient.Client
RollupClient *sources.RollupClient
RollupConfig *rollup.Config
AllowNonFinalized bool
OutputSubmitterEnabled bool
OutputSubmitterAllowPublicRound bool
OutputSubmitterRetryInterval time.Duration
OutputSubmitterRoundBuffer uint64
ChallengerEnabled bool
GuardianEnabled bool
ProofFetcher ProofFetcher
}
// Check ensures that the [Config] is valid.
func (c *Config) Check() error {
if err := c.RollupConfig.Check(); err != nil {
return err
}
return nil
}
// CLIConfig is a well typed config that is parsed from the CLI params.
// This also contains config options for auxiliary services.
// It is transformed into a `Config` before the Validator is started.
type CLIConfig struct {
// L1EthRpc is the Websocket provider URL for L1.
L1EthRpc string
// L2EthRpc is the HTTP provider URL for the L2 execution engine.
L2EthRpc string
// RollupRpc is the HTTP provider URL for the rollup node.
RollupRpc string
// L2OOAddress is the L2OutputOracle contract address.
L2OOAddress string
// ColosseumAddress is the Colosseum contract address.
ColosseumAddress string
// SecurityCouncilAddress is the SecurityCouncil contract address.
SecurityCouncilAddress string
// ValPoolAddress is the ValidatorPool contract address.
ValPoolAddress string
// ChallengerPollInterval is how frequently to poll L2 for new finalized outputs.
ChallengerPollInterval time.Duration
// ProverRPC is the URL of prover jsonRPC server.
ProverRPC string
// AllowNonFinalized can be set to true to submit outputs
// for L2 blocks derived from non-finalized L1 data.
AllowNonFinalized bool
OutputSubmitterEnabled bool
OutputSubmitterAllowPublicRound bool
// OutputSubmitterRetryInterval is how frequently to retry output submission.
OutputSubmitterRetryInterval time.Duration
// OutputSubmitterRoundBuffer is how many blocks before each round to start trying submission.
OutputSubmitterRoundBuffer uint64
ChallengerEnabled bool
GuardianEnabled bool
FetchingProofTimeout time.Duration
TxMgrConfig txmgr.CLIConfig
RPCConfig oprpc.CLIConfig
LogConfig oplog.CLIConfig
MetricsConfig opmetrics.CLIConfig
PprofConfig pprof.CLIConfig
}
func (c CLIConfig) Check() error {
if !(c.OutputSubmitterEnabled || c.ChallengerEnabled || c.GuardianEnabled) {
return errors.New("one of output submitter, challenger, guardian should be enabled")
}
if c.OutputSubmitterAllowPublicRound && !c.OutputSubmitterEnabled {
return errors.New("OutputSubmitterAllowPublicRound is meaningful when OutputSubmitterEnabled enabled")
}
if err := c.RPCConfig.Check(); err != nil {
return err
}
if err := c.MetricsConfig.Check(); err != nil {
return err
}
if err := c.PprofConfig.Check(); err != nil {
return err
}
if err := c.TxMgrConfig.Check(); err != nil {
return err
}
return nil
}
// NewConfig parses the Config from the provided flags or environment variables.
func NewConfig(ctx *cli.Context) CLIConfig {
return CLIConfig{
// Required Flags
L1EthRpc: ctx.String(flags.L1EthRpcFlag.Name),
L2EthRpc: ctx.String(flags.L2EthRpcFlag.Name),
RollupRpc: ctx.String(flags.RollupRpcFlag.Name),
L2OOAddress: ctx.String(flags.L2OOAddressFlag.Name),
ColosseumAddress: ctx.String(flags.ColosseumAddressFlag.Name),
ValPoolAddress: ctx.String(flags.ValPoolAddressFlag.Name),
OutputSubmitterEnabled: ctx.Bool(flags.OutputSubmitterEnabledFlag.Name),
ChallengerEnabled: ctx.Bool(flags.ChallengerEnabledFlag.Name),
ChallengerPollInterval: ctx.Duration(flags.ChallengerPollIntervalFlag.Name),
TxMgrConfig: txmgr.ReadCLIConfig(ctx),
// Optional Flags
AllowNonFinalized: ctx.Bool(flags.AllowNonFinalizedFlag.Name),
OutputSubmitterRetryInterval: ctx.Duration(flags.OutputSubmitterRetryIntervalFlag.Name),
OutputSubmitterRoundBuffer: ctx.Uint64(flags.OutputSubmitterRoundBufferFlag.Name),
OutputSubmitterAllowPublicRound: ctx.Bool(flags.OutputSubmitterAllowPublicRoundFlag.Name),
SecurityCouncilAddress: ctx.String(flags.SecurityCouncilAddressFlag.Name),
ProverRPC: ctx.String(flags.ProverRPCFlag.Name),
GuardianEnabled: ctx.Bool(flags.GuardianEnabledFlag.Name),
FetchingProofTimeout: ctx.Duration(flags.FetchingProofTimeoutFlag.Name),
RPCConfig: oprpc.ReadCLIConfig(ctx),
LogConfig: oplog.ReadCLIConfig(ctx),
MetricsConfig: opmetrics.ReadCLIConfig(ctx),
PprofConfig: pprof.ReadCLIConfig(ctx),
}
}
// NewValidatorConfig creates a validator config with given the CLIConfig
func NewValidatorConfig(cfg CLIConfig, l log.Logger, m metrics.Metricer) (*Config, error) {
l2ooAddress, err := opservice.ParseAddress(cfg.L2OOAddress)
if err != nil {
return nil, err
}
colosseumAddress, err := opservice.ParseAddress(cfg.ColosseumAddress)
if err != nil {
return nil, err
}
var securityCouncilAddress common.Address
if cfg.GuardianEnabled {
securityCouncilAddress, err = opservice.ParseAddress(cfg.SecurityCouncilAddress)
if err != nil {
return nil, err
}
}
valPoolAddress, err := opservice.ParseAddress(cfg.ValPoolAddress)
if err != nil {
return nil, err
}
txManager, err := txmgr.NewBufferedTxManager("validator", l, m, cfg.TxMgrConfig)
if err != nil {
return nil, err
}
if cfg.ChallengerEnabled && len(cfg.ProverRPC) == 0 {
return nil, errors.New("ProverRPC is required when challenger enabled, but given empty")
}
var fetcher ProofFetcher
if len(cfg.ProverRPC) > 0 {
fetcher, err = chal.NewFetcher(cfg.ProverRPC, cfg.FetchingProofTimeout, l)
if err != nil {
return nil, err
}
}
// Connect to L1 and L2 providers. Perform these last since they are the most expensive.
ctx := context.Background()
l1Client, err := dial.DialEthClientWithTimeout(ctx, dial.DefaultDialTimeout, l, cfg.L1EthRpc)
if err != nil {
return nil, err
}
l2Client, err := dial.DialEthClientWithTimeout(ctx, dial.DefaultDialTimeout, l, cfg.L2EthRpc)
if err != nil {
return nil, err
}
rollupClient, err := dial.DialRollupClientWithTimeout(ctx, dial.DefaultDialTimeout, l, cfg.RollupRpc)
if err != nil {
return nil, err
}
rollupConfig, err := rollupClient.RollupConfig(ctx)
if err != nil {
return nil, err
}
return &Config{
L2OutputOracleAddr: l2ooAddress,
ColosseumAddr: colosseumAddress,
SecurityCouncilAddr: securityCouncilAddress,
ValidatorPoolAddr: valPoolAddress,
ChallengerPollInterval: cfg.ChallengerPollInterval,
NetworkTimeout: cfg.TxMgrConfig.NetworkTimeout,
TxManager: txManager,
L1Client: l1Client,
L2Client: l2Client,
RollupClient: rollupClient,
RollupConfig: rollupConfig,
AllowNonFinalized: cfg.AllowNonFinalized,
OutputSubmitterEnabled: cfg.OutputSubmitterEnabled,
OutputSubmitterAllowPublicRound: cfg.OutputSubmitterAllowPublicRound,
OutputSubmitterRetryInterval: cfg.OutputSubmitterRetryInterval,
OutputSubmitterRoundBuffer: cfg.OutputSubmitterRoundBuffer,
ChallengerEnabled: cfg.ChallengerEnabled,
GuardianEnabled: cfg.GuardianEnabled,
ProofFetcher: fetcher,
}, nil
}