Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
// StoragePath is the path of the sqlite db on which the AggSender will store the data
StoragePath string `mapstructure:"StoragePath"`
// AgglayerClient is the Agglayer gRPC client configuration
AgglayerClient *aggkitgrpc.ClientConfig `mapstructure:"AgglayerClient"`
// AggsenderPrivateKey is the private key which is used to sign certificates
AggsenderPrivateKey signertypes.SignerConfig `mapstructure:"AggsenderPrivateKey"`
// URLRPCL2 is the URL of the L2 RPC node
URLRPCL2 string `mapstructure:"URLRPCL2"`
// BlockFinality indicates which finality the AggLayer follows
BlockFinality string `` //nolint:lll
/* 134-byte string literal not displayed */
// EpochNotificationPercentage indicates the percentage of the epoch
// the AggSender should send the certificate
// 0 -> Begin
// 50 -> Middle
EpochNotificationPercentage uint `mapstructure:"EpochNotificationPercentage"`
// MaxRetriesStoreCertificate is the maximum number of retries to store a certificate
// 0 is infinite
MaxRetriesStoreCertificate int `mapstructure:"MaxRetriesStoreCertificate"`
// DelayBetweenRetries is the delay between retries:
// is used on store Certificate and also in initial check
DelayBetweenRetries types.Duration `mapstructure:"DelayBetweenRetries"`
// KeepCertificatesHistory is a flag to keep the certificates history on storage
KeepCertificatesHistory bool `mapstructure:"KeepCertificatesHistory"`
// MaxCertSize is the maximum size of the certificate (the emitted certificate cannot be bigger that this size)
// 0 is infinite
MaxCertSize uint `mapstructure:"MaxCertSize"`
// DryRun is a flag to enable the dry run mode
// in this mode the AggSender will not send the certificates to Agglayer
DryRun bool `mapstructure:"DryRun"`
// EnableRPC is a flag to enable the RPC for aggsender
EnableRPC bool `mapstructure:"EnableRPC"`
// AggkitProverClient is the config for the AggkitProver client
AggkitProverClient *aggkitgrpc.ClientConfig `mapstructure:"AggkitProverClient"`
// Mode is the mode of the AggSender (regular pessimistic proof mode or the aggchain proof mode)
Mode string `jsonschema:"enum=PessimisticProof, enum=AggchainProof" mapstructure:"Mode"`
// CheckStatusCertificateInterval is the interval at which the AggSender will check the certificate status in Agglayer
CheckStatusCertificateInterval types.Duration `mapstructure:"CheckStatusCertificateInterval"`
// RetryCertAfterInError when a cert pass to 'InError'
// state the AggSender will try to resend it immediately
RetryCertAfterInError bool `mapstructure:"RetryCertAfterInError"`
// MaxSubmitCertificateRate is the maximum rate of certificate submission allowed
MaxSubmitCertificateRate common.RateLimitConfig `mapstructure:"MaxSubmitCertificateRate"`
// GlobalExitRootL2Addr is the address of the GlobalExitRootManager contract on l2 sovereign chain
// this address is needed for the AggchainProof mode of the AggSender
GlobalExitRootL2Addr ethCommon.Address `mapstructure:"GlobalExitRootL2"`
// SovereignRollupAddr is the address of the sovereign rollup contract on L1
SovereignRollupAddr ethCommon.Address `mapstructure:"SovereignRollupAddr"`
// RequireStorageContentCompatibility is true it's mandatory that data stored in the database
// is compatible with the running environment
RequireStorageContentCompatibility bool `mapstructure:"RequireStorageContentCompatibility"`
// RequireNoFEPBlockGap is true if the AggSender should not accept a gap between
// lastBlock from lastCertificate and first block of FEP
RequireNoFEPBlockGap bool `mapstructure:"RequireNoFEPBlockGap"`
// OptimisticModeConfig is the configuration for optimistic mode (required by FEP mode)
OptimisticModeConfig optimistic.Config `mapstructure:"OptimisticModeConfig"`
// RequireOneBridgeInPPCertificate is a flag to force the AggSender to have at least one bridge exit
// for the Pessimistic Proof certificates
RequireOneBridgeInPPCertificate bool `mapstructure:"RequireOneBridgeInPPCertificate"`
// RollupManagerAddr is the address of the RollupManager contract on L1
RollupManagerAddr ethCommon.Address `mapstructure:"RollupManagerAddr"`
// RollupCreationBlockL1 is the block number when the rollup was created on L1
RollupCreationBlockL1 uint64 `mapstructure:"RollupCreationBlockL1"`
// MaxL2BlockNumber is the last L2 block number that is going to be included in a certificate
// 0 means disabled
MaxL2BlockNumber uint64 `mapstructure:"MaxL2BlockNumber"`
// StopOnFinishedSendingAllCertificates is a flag to stop the AggSender when it finishes sending all certificates
// up to MaxL2BlockNumber
StopOnFinishedSendingAllCertificates bool `mapstructure:"StopOnFinishedSendingAllCertificates"`
}
Config is the configuration for the AggSender
func (Config) CheckCertConfigBriefString ¶
Click to show internal directories.
Click to hide internal directories.