mirror of
https://github.com/nspcc-dev/neo-go.git
synced 2024-11-29 13:41:47 +00:00
446 lines
15 KiB
Go
446 lines
15 KiB
Go
package waiter
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/nspcc-dev/neo-go/pkg/core/block"
|
|
"github.com/nspcc-dev/neo-go/pkg/core/state"
|
|
"github.com/nspcc-dev/neo-go/pkg/neorpc"
|
|
"github.com/nspcc-dev/neo-go/pkg/neorpc/result"
|
|
"github.com/nspcc-dev/neo-go/pkg/smartcontract/trigger"
|
|
"github.com/nspcc-dev/neo-go/pkg/util"
|
|
)
|
|
|
|
// DefaultPollRetryCount is a threshold for a number of subsequent failed
|
|
// attempts to get block count from the RPC server for PollingBased. If it fails
|
|
// to retrieve block count DefaultPollRetryCount times in a raw then transaction
|
|
// awaiting attempt considered to be failed and an error is returned.
|
|
const DefaultPollRetryCount = 3
|
|
|
|
var (
|
|
// ErrTxNotAccepted is returned when transaction wasn't accepted to the chain
|
|
// even after ValidUntilBlock block persist.
|
|
ErrTxNotAccepted = errors.New("transaction was not accepted to chain")
|
|
// ErrContextDone is returned when Waiter context has been done in the middle
|
|
// of transaction awaiting process and no result was received yet.
|
|
ErrContextDone = errors.New("waiter context done")
|
|
// ErrAwaitingNotSupported is returned from Wait method if Waiter instance
|
|
// doesn't support transaction awaiting. It's compatible with [errors.ErrUnsupported].
|
|
ErrAwaitingNotSupported = fmt.Errorf("%w: awaiting", errors.ErrUnsupported)
|
|
// ErrMissedEvent is returned when RPCEventBased closes receiver channel
|
|
// which happens if missed event was received from the RPC server.
|
|
ErrMissedEvent = errors.New("some event was missed")
|
|
)
|
|
|
|
type (
|
|
// Waiter is an interface providing transaction awaiting functionality.
|
|
Waiter interface {
|
|
// Wait allows to wait until transaction will be accepted to the chain. It can be
|
|
// used as a wrapper for Send or SignAndSend and accepts transaction hash,
|
|
// ValidUntilBlock value and an error. It returns transaction execution result
|
|
// or an error if transaction wasn't accepted to the chain. Notice that "already
|
|
// exists" err value is not treated as an error by this routine because it
|
|
// means that the transactions given might be already accepted or soon going
|
|
// to be accepted. Such transaction can be waited for in a usual way, potentially
|
|
// with positive result, so that's what will happen.
|
|
Wait(h util.Uint256, vub uint32, err error) (*state.AppExecResult, error)
|
|
// WaitAny waits until at least one of the specified transactions will be accepted
|
|
// to the chain until vub (including). It returns execution result of this
|
|
// transaction or an error if none of the transactions was accepted to the chain.
|
|
// It uses underlying RPCPollingBased or RPCEventBased context to interrupt
|
|
// awaiting process, but additional ctx can be passed as an argument for the same
|
|
// purpose.
|
|
WaitAny(ctx context.Context, vub uint32, hashes ...util.Uint256) (*state.AppExecResult, error)
|
|
}
|
|
// RPCPollingBased is an interface that enables transaction awaiting functionality
|
|
// based on periodical BlockCount and ApplicationLog polls.
|
|
RPCPollingBased interface {
|
|
// Context should return the RPC client context to be able to gracefully
|
|
// shut down all running processes (if so).
|
|
Context() context.Context
|
|
GetVersion() (*result.Version, error)
|
|
GetBlockCount() (uint32, error)
|
|
GetApplicationLog(hash util.Uint256, trig *trigger.Type) (*result.ApplicationLog, error)
|
|
}
|
|
// RPCEventBased is an interface that enables improved transaction awaiting functionality
|
|
// based on web-socket Block and ApplicationLog notifications. RPCEventBased
|
|
// contains RPCPollingBased under the hood and falls back to polling when subscription-based
|
|
// awaiting fails.
|
|
RPCEventBased interface {
|
|
RPCPollingBased
|
|
|
|
ReceiveHeadersOfAddedBlocks(flt *neorpc.BlockFilter, rcvr chan<- *block.Header) (string, error)
|
|
ReceiveBlocks(flt *neorpc.BlockFilter, rcvr chan<- *block.Block) (string, error)
|
|
ReceiveExecutions(flt *neorpc.ExecutionFilter, rcvr chan<- *state.AppExecResult) (string, error)
|
|
Unsubscribe(id string) error
|
|
}
|
|
)
|
|
|
|
// Null is a Waiter stub that doesn't support transaction awaiting functionality.
|
|
type Null struct{}
|
|
|
|
// PollingBased is a polling-based Waiter.
|
|
type PollingBased struct {
|
|
polling RPCPollingBased
|
|
version *result.Version
|
|
config PollConfig
|
|
}
|
|
|
|
// Config is a unified configuration for [Waiter] implementations that allows to
|
|
// customize awaiting behaviour.
|
|
type Config struct {
|
|
PollConfig
|
|
}
|
|
|
|
// PollConfig is a configuration for PollingBased waiter.
|
|
type PollConfig struct {
|
|
// PollInterval is a time interval between subsequent polls. If not set, then
|
|
// default value is a half of configured block time (in milliseconds).
|
|
PollInterval time.Duration
|
|
// RetryCount is the number of retry attempts while fetching a subsequent block
|
|
// count before an error is returned from Wait or WaitAny.
|
|
RetryCount int
|
|
}
|
|
|
|
// EventBased is a websocket-based Waiter.
|
|
type EventBased struct {
|
|
ws RPCEventBased
|
|
polling Waiter
|
|
}
|
|
|
|
// errIsAlreadyExists is a temporary helper until we have #2248 solved. Both C#
|
|
// and Go nodes return this string (possibly among other data).
|
|
func errIsAlreadyExists(err error) bool {
|
|
return strings.Contains(strings.ToLower(err.Error()), "already exists")
|
|
}
|
|
|
|
// New creates Waiter instance. It can be either websocket-based or
|
|
// polling-base, otherwise Waiter stub is returned. As a first argument
|
|
// it accepts RPCEventBased implementation, RPCPollingBased implementation
|
|
// or not an implementation of these two interfaces. It returns websocket-based
|
|
// waiter, polling-based waiter or a stub correspondingly.
|
|
func New(base any, v *result.Version) Waiter {
|
|
return NewCustom(base, v, Config{})
|
|
}
|
|
|
|
// NewCustom creates Waiter instance. It can be either websocket-based or
|
|
// polling-base, otherwise Waiter stub is returned. As a first argument
|
|
// it accepts RPCEventBased implementation, RPCPollingBased implementation
|
|
// or not an implementation of these two interfaces. It returns websocket-based
|
|
// waiter, polling-based waiter or a stub correspondingly. As the second
|
|
// argument it accepts the RPC node version necessary for awaiting behaviour
|
|
// customisation. As a third argument it accepts the configuration of
|
|
// [Waiter].
|
|
func NewCustom(base any, v *result.Version, config Config) Waiter {
|
|
if eventW, ok := base.(RPCEventBased); ok {
|
|
return &EventBased{
|
|
ws: eventW,
|
|
polling: newCustomPollingBased(eventW, v, config.PollConfig),
|
|
}
|
|
}
|
|
if pollW, ok := base.(RPCPollingBased); ok {
|
|
return newCustomPollingBased(pollW, v, config.PollConfig)
|
|
}
|
|
return NewNull()
|
|
}
|
|
|
|
// NewNull creates an instance of Waiter stub.
|
|
func NewNull() Null {
|
|
return Null{}
|
|
}
|
|
|
|
// Wait implements Waiter interface.
|
|
func (Null) Wait(h util.Uint256, vub uint32, err error) (*state.AppExecResult, error) {
|
|
return nil, ErrAwaitingNotSupported
|
|
}
|
|
|
|
// WaitAny implements Waiter interface.
|
|
func (Null) WaitAny(ctx context.Context, vub uint32, hashes ...util.Uint256) (*state.AppExecResult, error) {
|
|
return nil, ErrAwaitingNotSupported
|
|
}
|
|
|
|
// NewPollingBased creates an instance of Waiter supporting poll-based transaction awaiting.
|
|
func NewPollingBased(waiter RPCPollingBased) (*PollingBased, error) {
|
|
return NewCustomPollingBased(waiter, PollConfig{})
|
|
}
|
|
|
|
// NewCustomPollingBased creates an instance of Waiter supporting poll-based transaction awaiting.
|
|
// Poll options may be specified via config parameter.
|
|
func NewCustomPollingBased(waiter RPCPollingBased, config PollConfig) (*PollingBased, error) {
|
|
v, err := waiter.GetVersion()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return newCustomPollingBased(waiter, v, config), nil
|
|
}
|
|
|
|
// newCustomPollingBased is an internal constructor of PollingBased waiter that sets
|
|
// default configuration values if needed.
|
|
func newCustomPollingBased(waiter RPCPollingBased, v *result.Version, config PollConfig) *PollingBased {
|
|
if config.PollInterval <= 0 {
|
|
config.PollInterval = time.Millisecond * time.Duration(v.Protocol.MillisecondsPerBlock) / 2
|
|
}
|
|
if config.RetryCount <= 0 {
|
|
config.RetryCount = DefaultPollRetryCount
|
|
}
|
|
return &PollingBased{
|
|
polling: waiter,
|
|
version: v,
|
|
config: config,
|
|
}
|
|
}
|
|
|
|
// Wait implements Waiter interface.
|
|
func (w *PollingBased) Wait(h util.Uint256, vub uint32, err error) (*state.AppExecResult, error) {
|
|
if err != nil && !errIsAlreadyExists(err) {
|
|
return nil, err
|
|
}
|
|
return w.WaitAny(context.TODO(), vub, h)
|
|
}
|
|
|
|
// WaitAny implements Waiter interface.
|
|
func (w *PollingBased) WaitAny(ctx context.Context, vub uint32, hashes ...util.Uint256) (*state.AppExecResult, error) {
|
|
var (
|
|
currentHeight uint32
|
|
failedAttempt int
|
|
)
|
|
timer := time.NewTicker(w.config.PollInterval)
|
|
defer timer.Stop()
|
|
for {
|
|
select {
|
|
case <-timer.C:
|
|
blockCount, err := w.polling.GetBlockCount()
|
|
if err != nil {
|
|
failedAttempt++
|
|
if failedAttempt > w.config.RetryCount {
|
|
return nil, fmt.Errorf("failed to retrieve block count: %w", err)
|
|
}
|
|
continue
|
|
}
|
|
failedAttempt = 0
|
|
if blockCount-1 > currentHeight {
|
|
currentHeight = blockCount - 1
|
|
}
|
|
t := trigger.Application
|
|
for _, h := range hashes {
|
|
res, err := w.polling.GetApplicationLog(h, &t)
|
|
if err == nil {
|
|
return &state.AppExecResult{
|
|
Container: res.Container,
|
|
Execution: res.Executions[0],
|
|
}, nil
|
|
}
|
|
}
|
|
if currentHeight >= vub {
|
|
return nil, ErrTxNotAccepted
|
|
}
|
|
case <-w.polling.Context().Done():
|
|
return nil, fmt.Errorf("%w: %w", ErrContextDone, w.polling.Context().Err())
|
|
case <-ctx.Done():
|
|
return nil, fmt.Errorf("%w: %w", ErrContextDone, ctx.Err())
|
|
}
|
|
}
|
|
}
|
|
|
|
// NewEventBased creates an instance of Waiter supporting websocket event-based transaction awaiting.
|
|
// EventBased contains PollingBased under the hood and falls back to polling when subscription-based
|
|
// awaiting fails.
|
|
func NewEventBased(waiter RPCEventBased) (*EventBased, error) {
|
|
return NewCustomEventBased(waiter, Config{})
|
|
}
|
|
|
|
// NewCustomEventBased creates an instance of Waiter supporting websocket event-based transaction awaiting.
|
|
// EventBased contains PollingBased under the hood and falls back to polling when subscription-based
|
|
// awaiting fails. Waiter configuration options may be specified via config parameter
|
|
// (defaults are used if not specified).
|
|
func NewCustomEventBased(waiter RPCEventBased, config Config) (*EventBased, error) {
|
|
polling, err := NewCustomPollingBased(waiter, config.PollConfig)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return &EventBased{
|
|
ws: waiter,
|
|
polling: polling,
|
|
}, nil
|
|
}
|
|
|
|
// Wait implements Waiter interface.
|
|
func (w *EventBased) Wait(h util.Uint256, vub uint32, err error) (res *state.AppExecResult, waitErr error) {
|
|
if err != nil && !errIsAlreadyExists(err) {
|
|
return nil, err
|
|
}
|
|
return w.WaitAny(context.TODO(), vub, h)
|
|
}
|
|
|
|
// WaitAny implements Waiter interface.
|
|
func (w *EventBased) WaitAny(ctx context.Context, vub uint32, hashes ...util.Uint256) (res *state.AppExecResult, waitErr error) {
|
|
var (
|
|
wsWaitErr error
|
|
waitersActive int
|
|
hRcvr = make(chan *block.Header, 2)
|
|
bRcvr = make(chan *block.Block, 2)
|
|
aerRcvr = make(chan *state.AppExecResult, len(hashes))
|
|
unsubErrs = make(chan error)
|
|
exit = make(chan struct{})
|
|
)
|
|
|
|
// Execution event preceded the block event, thus wait until the VUB-th block to be sure.
|
|
since := vub
|
|
blocksID, err := w.ws.ReceiveHeadersOfAddedBlocks(&neorpc.BlockFilter{Since: &since}, hRcvr)
|
|
if err != nil {
|
|
// Falling back to block-based subscription.
|
|
if errors.Is(err, neorpc.ErrInvalidParams) {
|
|
blocksID, err = w.ws.ReceiveBlocks(&neorpc.BlockFilter{Since: &since}, bRcvr)
|
|
}
|
|
}
|
|
if err != nil {
|
|
wsWaitErr = fmt.Errorf("failed to subscribe for new blocks/headers: %w", err)
|
|
} else {
|
|
waitersActive++
|
|
go func() {
|
|
<-exit
|
|
err = w.ws.Unsubscribe(blocksID)
|
|
if err != nil {
|
|
unsubErrs <- fmt.Errorf("failed to unsubscribe from blocks/headers (id: %s): %w", blocksID, err)
|
|
return
|
|
}
|
|
unsubErrs <- nil
|
|
}()
|
|
}
|
|
if wsWaitErr == nil {
|
|
trig := trigger.Application
|
|
for _, h := range hashes {
|
|
txsID, err := w.ws.ReceiveExecutions(&neorpc.ExecutionFilter{Container: &h}, aerRcvr)
|
|
if err != nil {
|
|
wsWaitErr = fmt.Errorf("failed to subscribe for execution results: %w", err)
|
|
break
|
|
}
|
|
waitersActive++
|
|
go func() {
|
|
<-exit
|
|
err = w.ws.Unsubscribe(txsID)
|
|
if err != nil {
|
|
unsubErrs <- fmt.Errorf("failed to unsubscribe from transactions (id: %s): %w", txsID, err)
|
|
return
|
|
}
|
|
unsubErrs <- nil
|
|
}()
|
|
// There is a potential race between subscription and acceptance, so
|
|
// do a polling check once _after_ the subscription.
|
|
appLog, err := w.ws.GetApplicationLog(h, &trig)
|
|
if err == nil {
|
|
res = &state.AppExecResult{
|
|
Container: appLog.Container,
|
|
Execution: appLog.Executions[0],
|
|
}
|
|
break // We have the result, no need for other subscriptions.
|
|
}
|
|
}
|
|
}
|
|
|
|
if wsWaitErr == nil && res == nil {
|
|
select {
|
|
case _, ok := <-hRcvr:
|
|
if !ok {
|
|
// We're toast, retry with non-ws client.
|
|
hRcvr = nil
|
|
bRcvr = nil
|
|
aerRcvr = nil
|
|
wsWaitErr = ErrMissedEvent
|
|
break
|
|
}
|
|
waitErr = ErrTxNotAccepted
|
|
case _, ok := <-bRcvr:
|
|
if !ok {
|
|
// We're toast, retry with non-ws client.
|
|
hRcvr = nil
|
|
bRcvr = nil
|
|
aerRcvr = nil
|
|
wsWaitErr = ErrMissedEvent
|
|
break
|
|
}
|
|
waitErr = ErrTxNotAccepted
|
|
case aer, ok := <-aerRcvr:
|
|
if !ok {
|
|
// We're toast, retry with non-ws client.
|
|
hRcvr = nil
|
|
bRcvr = nil
|
|
aerRcvr = nil
|
|
wsWaitErr = ErrMissedEvent
|
|
break
|
|
}
|
|
res = aer
|
|
case <-w.ws.Context().Done():
|
|
waitErr = fmt.Errorf("%w: %w", ErrContextDone, w.ws.Context().Err())
|
|
case <-ctx.Done():
|
|
waitErr = fmt.Errorf("%w: %w", ErrContextDone, ctx.Err())
|
|
}
|
|
}
|
|
close(exit)
|
|
|
|
if waitersActive > 0 {
|
|
// Drain receivers to avoid other notification receivers blocking.
|
|
drainLoop:
|
|
for {
|
|
select {
|
|
case _, ok := <-hRcvr:
|
|
if !ok { // Missed event means both channels are closed.
|
|
hRcvr = nil
|
|
bRcvr = nil
|
|
aerRcvr = nil
|
|
}
|
|
case _, ok := <-bRcvr:
|
|
if !ok { // Missed event means both channels are closed.
|
|
hRcvr = nil
|
|
bRcvr = nil
|
|
aerRcvr = nil
|
|
}
|
|
case _, ok := <-aerRcvr:
|
|
if !ok { // Missed event means both channels are closed.
|
|
hRcvr = nil
|
|
bRcvr = nil
|
|
aerRcvr = nil
|
|
}
|
|
case unsubErr := <-unsubErrs:
|
|
if unsubErr != nil {
|
|
errFmt := "unsubscription error: %w"
|
|
errArgs := []any{unsubErr}
|
|
if waitErr != nil {
|
|
errFmt = "%w; " + errFmt
|
|
errArgs = append([]any{waitErr}, errArgs...)
|
|
}
|
|
waitErr = fmt.Errorf(errFmt, errArgs...)
|
|
}
|
|
waitersActive--
|
|
// Wait until all receiver channels finish their work.
|
|
if waitersActive == 0 {
|
|
break drainLoop
|
|
}
|
|
}
|
|
}
|
|
}
|
|
if hRcvr != nil {
|
|
close(hRcvr)
|
|
}
|
|
if bRcvr != nil {
|
|
close(bRcvr)
|
|
}
|
|
if aerRcvr != nil {
|
|
close(aerRcvr)
|
|
}
|
|
close(unsubErrs)
|
|
|
|
// Rollback to a poll-based waiter if needed.
|
|
if wsWaitErr != nil && waitErr == nil {
|
|
res, waitErr = w.polling.WaitAny(ctx, vub, hashes...)
|
|
if waitErr != nil {
|
|
// Wrap the poll-based error, it's more important.
|
|
waitErr = fmt.Errorf("event-based error: %w; poll-based waiter error: %w", wsWaitErr, waitErr)
|
|
}
|
|
}
|
|
return
|
|
}
|