Documentation
¶
Index ¶
- Constants
- Variables
- func NewSender(api SenderAPI, signer SignerAPI, db *harmonydb.DB, maximizeFeeCap bool) (*Sender, *SendTask)
- func NewSenderETH(client *ethclient.Client, db *harmonydb.DB) (*SenderETH, *SendTaskETH)
- type EthClient
- type EthTransactionManager
- type HarmonyEthTxManager
- func (h *HarmonyEthTxManager) AssignPendingToMachine(ctx context.Context, machineID int64) (int, error)
- func (h *HarmonyEthTxManager) GetPendingForMachine(ctx context.Context, machineID int64) ([]string, error)
- func (h *HarmonyEthTxManager) UpdateToConfirmed(ctx context.Context, signedTxHash string, blockNumber int64, ...) error
- type MessageWaiterApi
- type MessageWatcher
- type MessageWatcherEth
- type SendTask
- func (s *SendTask) Adder(taskFunc harmonytask.AddTaskFunc)
- func (s *SendTask) CanAccept(ids []harmonytask.TaskID, engine *harmonytask.TaskEngine) (*harmonytask.TaskID, error)
- func (s *SendTask) Do(taskID harmonytask.TaskID, stillOwned func() bool) (done bool, err error)
- func (s *SendTask) TypeDetails() harmonytask.TaskTypeDetails
- type SendTaskETH
- func (s *SendTaskETH) Adder(taskFunc harmonytask.AddTaskFunc)
- func (s *SendTaskETH) CanAccept(ids []harmonytask.TaskID, engine *harmonytask.TaskEngine) (*harmonytask.TaskID, error)
- func (s *SendTaskETH) Do(taskID harmonytask.TaskID, stillOwned func() bool) (done bool, err error)
- func (s *SendTaskETH) TypeDetails() harmonytask.TaskTypeDetails
- type Sender
- type SenderAPI
- type SenderETH
- type SignerAPI
- type TaskEngine
Constants ¶
const MinConfidence = 1
Variables ¶
var SendLockedWait = 100 * time.Millisecond
Functions ¶
func NewSender ¶
func NewSender(api SenderAPI, signer SignerAPI, db *harmonydb.DB, maximizeFeeCap bool) (*Sender, *SendTask)
NewSender creates a new Sender.
func NewSenderETH ¶ added in v1.25.1
NewSenderETH creates a new SenderETH.
Types ¶
type EthClient ¶ added in v1.26.0
type EthClient interface {
TransactionReceipt(ctx context.Context, txHash common.Hash) (*types.Receipt, error)
TransactionByHash(ctx context.Context, txHash common.Hash) (tx *types.Transaction, isPending bool, err error)
HeaderByNumber(ctx context.Context, number *big.Int) (*types.Header, error)
}
EthClient is an interface for the Ethereum client operations we need
type EthTransactionManager ¶ added in v1.26.0
type EthTransactionManager interface {
// AssignPendingToMachine assigns pending transactions to a machine for processing
AssignPendingToMachine(ctx context.Context, machineID int64) (int, error)
// GetPendingForMachine gets all pending transactions assigned to a machine
GetPendingForMachine(ctx context.Context, machineID int64) ([]string, error)
// UpdateToConfirmed updates a transaction to confirmed status with all the details
UpdateToConfirmed(ctx context.Context, signedTxHash string, blockNumber int64, confirmedTxHash string, txData []byte, receipt []byte, success bool) error
}
EthTransactionManager provides a simple interface for managing Ethereum transactions in the database
type HarmonyEthTxManager ¶ added in v1.26.0
type HarmonyEthTxManager struct {
// contains filtered or unexported fields
}
HarmonyEthTxManager is the real implementation using HarmonyDB
func NewHarmonyEthTxManager ¶ added in v1.26.0
func NewHarmonyEthTxManager(db *harmonydb.DB) *HarmonyEthTxManager
NewHarmonyEthTxManager creates a new HarmonyEthTxManager
func (*HarmonyEthTxManager) AssignPendingToMachine ¶ added in v1.26.0
func (h *HarmonyEthTxManager) AssignPendingToMachine(ctx context.Context, machineID int64) (int, error)
AssignPendingToMachine assigns pending transactions to a machine for processing
func (*HarmonyEthTxManager) GetPendingForMachine ¶ added in v1.26.0
func (h *HarmonyEthTxManager) GetPendingForMachine(ctx context.Context, machineID int64) ([]string, error)
GetPendingForMachine gets all pending transactions assigned to a machine
func (*HarmonyEthTxManager) UpdateToConfirmed ¶ added in v1.26.0
func (h *HarmonyEthTxManager) UpdateToConfirmed(ctx context.Context, signedTxHash string, blockNumber int64, confirmedTxHash string, txData []byte, receipt []byte, success bool) error
UpdateToConfirmed updates a transaction to confirmed status with all the details
type MessageWaiterApi ¶
type MessageWaiterApi interface {
StateGetActor(ctx context.Context, actor address.Address, tsk types.TipSetKey) (*types.Actor, error)
ChainGetTipSetByHeight(context.Context, abi.ChainEpoch, types.TipSetKey) (*types.TipSet, error)
ChainGetTipSet(context.Context, types.TipSetKey) (*types.TipSet, error)
StateSearchMsg(ctx context.Context, from types.TipSetKey, msg cid.Cid, limit abi.ChainEpoch, allowReplaced bool) (*api.MsgLookup, error)
ChainGetMessage(ctx context.Context, mc cid.Cid) (*types.Message, error)
}
type MessageWatcher ¶
type MessageWatcher struct {
// contains filtered or unexported fields
}
func NewMessageWatcher ¶
func NewMessageWatcher(db *harmonydb.DB, ht *harmonytask.TaskEngine, pcs *chainsched.CurioChainSched, api MessageWaiterApi) (*MessageWatcher, error)
type MessageWatcherEth ¶ added in v1.25.1
type MessageWatcherEth struct {
// contains filtered or unexported fields
}
func NewMessageWatcherEth ¶ added in v1.25.1
func NewMessageWatcherEth(db *harmonydb.DB, ht *harmonytask.TaskEngine, pcs *chainsched.CurioChainSched, api *ethclient.Client) (*MessageWatcherEth, error)
type SendTask ¶
type SendTask struct {
// contains filtered or unexported fields
}
func (*SendTask) Adder ¶
func (s *SendTask) Adder(taskFunc harmonytask.AddTaskFunc)
func (*SendTask) CanAccept ¶
func (s *SendTask) CanAccept(ids []harmonytask.TaskID, engine *harmonytask.TaskEngine) (*harmonytask.TaskID, error)
func (*SendTask) TypeDetails ¶
func (s *SendTask) TypeDetails() harmonytask.TaskTypeDetails
type SendTaskETH ¶ added in v1.25.1
type SendTaskETH struct {
// contains filtered or unexported fields
}
func (*SendTaskETH) Adder ¶ added in v1.25.1
func (s *SendTaskETH) Adder(taskFunc harmonytask.AddTaskFunc)
func (*SendTaskETH) CanAccept ¶ added in v1.25.1
func (s *SendTaskETH) CanAccept(ids []harmonytask.TaskID, engine *harmonytask.TaskEngine) (*harmonytask.TaskID, error)
func (*SendTaskETH) Do ¶ added in v1.25.1
func (s *SendTaskETH) Do(taskID harmonytask.TaskID, stillOwned func() bool) (done bool, err error)
func (*SendTaskETH) TypeDetails ¶ added in v1.25.1
func (s *SendTaskETH) TypeDetails() harmonytask.TaskTypeDetails
type Sender ¶
type Sender struct {
// contains filtered or unexported fields
}
Sender abstracts away highly-available message sending with coordination through HarmonyDB. It make sure that nonces are assigned transactionally, and that messages are correctly broadcasted to the network. It ensures that messages are sent serially, and that failures to send don't cause nonce gaps.
func (*Sender) Send ¶
func (s *Sender) Send(ctx context.Context, msg *types.Message, mss *api.MessageSendSpec, reason string) (cid.Cid, error)
Send atomically assigns a nonce, signs, and pushes a message to mempool. maxFee is only used when GasFeeCap/GasPremium fields aren't specified
When maxFee is set to 0, Send will guess appropriate fee based on current chain conditions
Send behaves much like fullnodeApi.MpoolPushMessage, but it coordinates through HarmonyDB, making it safe to broadcast messages from multiple independent API nodes
Send is also currently more strict about required parameters than MpoolPushMessage
type SenderAPI ¶
type SenderAPI interface {
StateAccountKey(ctx context.Context, addr address.Address, tsk types.TipSetKey) (address.Address, error)
GasEstimateMessageGas(ctx context.Context, msg *types.Message, spec *api.MessageSendSpec, tsk types.TipSetKey) (*types.Message, error)
WalletBalance(ctx context.Context, addr address.Address) (big.Int, error)
MpoolGetNonce(context.Context, address.Address) (uint64, error)
MpoolPush(context.Context, *types.SignedMessage) (cid.Cid, error)
}
type SenderETH ¶ added in v1.25.1
type SenderETH struct {
// contains filtered or unexported fields
}
type TaskEngine ¶ added in v1.26.0
TaskEngine is an interface for the parts of harmonytask.TaskEngine we need