Documentation
¶
Index ¶
Constants ¶
const ( // Duplicated L1 RPC flag L1RPCFlagName = "l1-eth-rpc" // Key Management Flags (also have pt-signer client flags) MnemonicFlagName = "mnemonic" HDPathFlagName = "hd-path" PrivateKeyFlagName = "private-key" // TxMgr Flags (new + legacy + some shared flags) NumConfirmationsFlagName = "num-confirmations" SafeAbortNonceTooLowCountFlagName = "safe-abort-nonce-too-low-count" ResubmissionTimeoutFlagName = "resubmission-timeout" NetworkTimeoutFlagName = "network-timeout" TxSendTimeoutFlagName = "txmgr.send-timeout" TxNotInMempoolTimeoutFlagName = "txmgr.not-in-mempool-timeout" ReceiptQueryIntervalFlagName = "txmgr.receipt-query-interval" )
Variables ¶
var ( SequencerHDPathFlag = cli.StringFlag{ Name: "sequencer-hd-path", Usage: "DEPRECATED: The HD path used to derive the sequencer wallet from the " + "mnemonic. The mnemonic flag must also be set.", EnvVar: "PT_BATCHER_SEQUENCER_HD_PATH", } L2OutputHDPathFlag = cli.StringFlag{ Name: "l2-output-hd-path", Usage: "DEPRECATED:The HD path used to derive the l2output wallet from the " + "mnemonic. The mnemonic flag must also be set.", EnvVar: "PT_PROPOSER_L2_OUTPUT_HD_PATH", } )
Functions ¶
Types ¶
type CLIConfig ¶
type CLIConfig struct {
L1RPCURL string
Mnemonic string
HDPath string
SequencerHDPath string
L2OutputHDPath string
PrivateKey string
SignerCLIConfig client.CLIConfig
NumConfirmations uint64
SafeAbortNonceTooLowCount uint64
ResubmissionTimeout time.Duration
ReceiptQueryInterval time.Duration
NetworkTimeout time.Duration
TxSendTimeout time.Duration
TxNotInMempoolTimeout time.Duration
}
func ReadCLIConfig ¶
type Config ¶
type Config struct {
Backend ETHBackend
// ResubmissionTimeout is the interval at which, if no previously
// published transaction has been mined, the new tx with a bumped gas
// price will be published. Only one publication at MaxGasPrice will be
// attempted.
ResubmissionTimeout time.Duration
// ChainID is the chain ID of the L1 chain.
ChainID *big.Int
// TxSendTimeout is how long to wait for sending a transaction.
// By default it is unbounded. If set, this is recommended to be at least 20 minutes.
TxSendTimeout time.Duration
// TxNotInMempoolTimeout is how long to wait before aborting a transaction send if the transaction does not
// make it to the mempool. If the tx is in the mempool, TxSendTimeout is used instead.
TxNotInMempoolTimeout time.Duration
// NetworkTimeout is the allowed duration for a single network request.
// This is intended to be used for network requests that can be replayed.
NetworkTimeout time.Duration
// RequireQueryInterval is the interval at which the tx manager will
// query the backend to check for confirmations after a tx at a
// specific gas price has been published.
ReceiptQueryInterval time.Duration
// NumConfirmations specifies how many blocks are need to consider a
// transaction confirmed.
NumConfirmations uint64
// SafeAbortNonceTooLowCount specifies how many ErrNonceTooLow observations
// are required to give up on a tx at a particular nonce without receiving
// confirmation.
SafeAbortNonceTooLowCount uint64
// Signer is used to sign transactions when the gas price is increased.
Signer opcrypto.SignerFn
From common.Address
}
Config houses parameters for altering the behavior of a SimpleTxManager.
type ETHBackend ¶
type ETHBackend interface {
// BlockNumber returns the most recent block number.
BlockNumber(ctx context.Context) (uint64, error)
// TransactionReceipt queries the backend for a receipt associated with
// txHash. If lookup does not fail, but the transaction is not found,
// nil should be returned for both values.
TransactionReceipt(ctx context.Context, txHash common.Hash) (*types.Receipt, error)
// SendTransaction submits a signed transaction to L1.
SendTransaction(ctx context.Context, tx *types.Transaction) error
// These functions are used to estimate what the basefee & priority fee should be set to.
// TODO(CLI-3318): Maybe need a generic interface to support different RPC providers
HeaderByNumber(ctx context.Context, number *big.Int) (*types.Header, error)
SuggestGasTipCap(ctx context.Context) (*big.Int, error)
// NonceAt returns the account nonce of the given account.
// The block number can be nil, in which case the nonce is taken from the latest known block.
NonceAt(ctx context.Context, account common.Address, blockNumber *big.Int) (uint64, error)
// PendingNonceAt returns the pending nonce.
PendingNonceAt(ctx context.Context, account common.Address) (uint64, error)
// EstimateGas returns an estimate of the amount of gas needed to execute the given
// transaction against the current pending block.
EstimateGas(ctx context.Context, msg ethereum.CallMsg) (uint64, error)
}
ETHBackend is the set of methods that the transaction manager uses to resubmit gas & determine when transactions are included on L1.
type Queue ¶
type Queue[T any] struct { // contains filtered or unexported fields }
func NewQueue ¶
NewQueue creates a new transaction sending Queue, with the following parameters:
- maxPending: max number of pending txs at once (0 == no limit)
- pendingChanged: called whenever a tx send starts or finishes. The number of currently pending txs is passed as a parameter.
func (*Queue[T]) Send ¶
func (q *Queue[T]) Send(id T, candidate TxCandidate, receiptCh chan TxReceipt[T])
Send will wait until the number of pending txs is below the max pending, and then send the next tx.
The actual tx sending is non-blocking, with the receipt returned on the provided receipt channel. If the channel is unbuffered, the goroutine is blocked from completing until the channel is read from.
func (*Queue[T]) TrySend ¶
func (q *Queue[T]) TrySend(id T, candidate TxCandidate, receiptCh chan TxReceipt[T]) bool
TrySend sends the next tx, but only if the number of pending txs is below the max pending.
Returns false if there is no room in the queue to send. Otherwise, the transaction is queued and this method returns true.
The actual tx sending is non-blocking, with the receipt returned on the provided receipt channel. If the channel is unbuffered, the goroutine is blocked from completing until the channel is read from.
type SendState ¶
type SendState struct {
// contains filtered or unexported fields
}
SendState tracks information about the publication state of a given txn. In this context, a txn may correspond to multiple different txn hashes due to varying gas prices, though we treat them all as the same logical txn. This struct is primarily used to determine whether or not the txmgr should abort a given txn.
func NewSendState ¶
NewSendState creates a new send state
func NewSendStateWithNow ¶
func NewSendStateWithNow(safeAbortNonceTooLowCount uint64, unableToSendTimeout time.Duration, now func() time.Time) *SendState
NewSendStateWithNow creates a new send state with the provided clock.
func (*SendState) IsWaitingForConfirmation ¶
IsWaitingForConfirmation returns true if we have at least one confirmation on one of our txs.
func (*SendState) ProcessSendError ¶
ProcessSendError should be invoked with the error returned for each publication. It is safe to call this method with nil or arbitrary errors.
func (*SendState) ShouldAbortImmediately ¶
ShouldAbortImmediately returns true if the txmgr should give up on trying a given txn with the target nonce. This occurs when the set of errors recorded indicates that no further progress can be made on this transaction.
func (*SendState) TxMined ¶
TxMined records that the txn with txnHash has been mined and is await confirmation. It is safe to call this function multiple times.
func (*SendState) TxNotMined ¶
TxMined records that the txn with txnHash has not been mined or has been reorg'd out. It is safe to call this function multiple times.
type SimpleTxManager ¶
type SimpleTxManager struct {
// contains filtered or unexported fields
}
SimpleTxManager is a implementation of TxManager that performs linear fee bumping of a tx until it confirms.
func NewSimpleTxManager ¶
func NewSimpleTxManager(name string, l log.Logger, m metrics.TxMetricer, cfg CLIConfig) (*SimpleTxManager, error)
NewSimpleTxManager initializes a new SimpleTxManager with the passed Config.
func (*SimpleTxManager) From ¶
func (m *SimpleTxManager) From() common.Address
func (*SimpleTxManager) Send ¶
func (m *SimpleTxManager) Send(ctx context.Context, candidate TxCandidate) (*types.Receipt, error)
Send is used to publish a transaction with incrementally higher gas prices until the transaction eventually confirms. This method blocks until an invocation of sendTx returns (called with differing gas prices). The method may be canceled using the passed context.
The transaction manager handles all signing. If and only if the gas limit is 0, the transaction manager will do a gas estimation.
NOTE: Send can be called concurrently, the nonce will be managed internally.
type TxCandidate ¶
type TxCandidate struct {
// TxData is the transaction data to be used in the constructed tx.
TxData []byte
// To is the recipient of the constructed tx. Nil means contract creation.
To *common.Address
// GasLimit is the gas limit to be used in the constructed tx.
GasLimit uint64
}
TxCandidate is a transaction candidate that can be submitted to ask the TxManager to construct a transaction with gas price bounds.
type TxManager ¶
type TxManager interface {
// Send is used to create & send a transaction. It will handle increasing
// the gas price & ensuring that the transaction remains in the transaction pool.
// It can be stopped by cancelling the provided context; however, the transaction
// may be included on L1 even if the context is cancelled.
//
// NOTE: Send can be called concurrently, the nonce will be managed internally.
Send(ctx context.Context, candidate TxCandidate) (*types.Receipt, error)
// From returns the sending address associated with the instance of the transaction manager.
// It is static for a single instance of a TxManager.
From() common.Address
}
TxManager is an interface that allows callers to reliably publish txs, bumping the gas price if needed, and obtain the receipt of the resulting tx.
Source Files
Directories