|
| 1 | +package ethfinalizer |
| 2 | + |
| 3 | +import ( |
| 4 | + "context" |
| 5 | + "errors" |
| 6 | + "math/big" |
| 7 | + "sync/atomic" |
| 8 | + "testing" |
| 9 | + "time" |
| 10 | + |
| 11 | + "github.com/0xsequence/ethkit/ethwallet" |
| 12 | + "github.com/0xsequence/ethkit/go-ethereum/common" |
| 13 | + "github.com/0xsequence/ethkit/go-ethereum/core/types" |
| 14 | + "github.com/stretchr/testify/require" |
| 15 | +) |
| 16 | + |
| 17 | +type externalTestSigner struct { |
| 18 | + Signer |
| 19 | + fail atomic.Bool |
| 20 | + calls atomic.Int32 |
| 21 | +} |
| 22 | + |
| 23 | +func (s *externalTestSigner) SignTransaction(ctx context.Context, tx *types.Transaction, chain *big.Int) (*types.Transaction, error) { |
| 24 | + s.calls.Add(1) |
| 25 | + if s.fail.Load() { |
| 26 | + return nil, errors.New("signer unavailable") |
| 27 | + } |
| 28 | + return s.Signer.SignTransaction(ctx, tx, chain) |
| 29 | +} |
| 30 | + |
| 31 | +type externalTestChain struct { |
| 32 | + gas atomic.Int64 |
| 33 | + sent chan *types.Transaction |
| 34 | +} |
| 35 | + |
| 36 | +func (c *externalTestChain) ChainID() *big.Int { return big.NewInt(1) } |
| 37 | +func (c *externalTestChain) IsEIP1559() bool { return false } |
| 38 | +func (c *externalTestChain) LatestNonce(context.Context, common.Address) (uint64, error) { |
| 39 | + return 0, nil |
| 40 | +} |
| 41 | +func (c *externalTestChain) PendingNonce(context.Context, common.Address) (uint64, error) { |
| 42 | + return 0, nil |
| 43 | +} |
| 44 | +func (c *externalTestChain) GasPrice(context.Context) (*big.Int, error) { |
| 45 | + return big.NewInt(c.gas.Load()), nil |
| 46 | +} |
| 47 | +func (c *externalTestChain) BaseFee(context.Context) (*big.Int, error) { return nil, nil } |
| 48 | +func (c *externalTestChain) PriorityFee(context.Context) (*big.Int, error) { return nil, nil } |
| 49 | +func (c *externalTestChain) Send(ctx context.Context, tx *types.Transaction) error { |
| 50 | + select { |
| 51 | + case c.sent <- tx: |
| 52 | + return nil |
| 53 | + case <-ctx.Done(): |
| 54 | + return ctx.Err() |
| 55 | + } |
| 56 | +} |
| 57 | +func (c *externalTestChain) Subscribe(ctx context.Context) (<-chan Diff, error) { |
| 58 | + ch := make(chan Diff) |
| 59 | + go func() { <-ctx.Done(); close(ch) }() |
| 60 | + return ch, nil |
| 61 | +} |
| 62 | + |
| 63 | +func TestNewWalletSignerNil(t *testing.T) { |
| 64 | + signer := NewWalletSigner(nil) |
| 65 | + require.True(t, signer == nil, "nil wallet must produce a nil interface") |
| 66 | + |
| 67 | + finalizer, err := NewFinalizer(FinalizerOptions[string]{ |
| 68 | + Signer: signer, |
| 69 | + Chain: &externalTestChain{}, |
| 70 | + Mempool: NewMemoryMempool[string](), |
| 71 | + PollInterval: time.Second, |
| 72 | + PollTimeout: time.Second, |
| 73 | + RetryDelay: time.Second, |
| 74 | + }) |
| 75 | + require.ErrorContains(t, err, "exactly one of wallet or signer is required") |
| 76 | + require.Nil(t, finalizer) |
| 77 | +} |
| 78 | + |
| 79 | +func TestExternalSignerLifecycle(t *testing.T) { |
| 80 | + wallet, err := ethwallet.NewWalletFromRandomEntropy() |
| 81 | + require.NoError(t, err) |
| 82 | + signer := &externalTestSigner{Signer: NewWalletSigner(wallet)} |
| 83 | + chain := &externalTestChain{sent: make(chan *types.Transaction, 100)} |
| 84 | + chain.gas.Store(10) |
| 85 | + mempool := NewMemoryMempool[string]() |
| 86 | + options := FinalizerOptions[string]{Signer: signer, Chain: chain, Mempool: mempool, PollInterval: 5 * time.Millisecond, PollTimeout: time.Second, RetryDelay: time.Millisecond, PriceBump: 15} |
| 87 | + f, err := NewFinalizer(options) |
| 88 | + require.NoError(t, err) |
| 89 | + options.Wallet = wallet |
| 90 | + _, err = NewFinalizer(options) |
| 91 | + require.Error(t, err) |
| 92 | + options.Signer = nil |
| 93 | + _, err = NewFinalizer(options) |
| 94 | + require.NoError(t, err) |
| 95 | + options.Wallet = nil |
| 96 | + _, err = NewFinalizer(options) |
| 97 | + require.Error(t, err) |
| 98 | + tx := types.NewTx(&types.LegacyTx{Gas: 21000, GasPrice: big.NewInt(10)}) |
| 99 | + signer.fail.Store(true) |
| 100 | + _, err = f.Send(context.Background(), tx, "metadata") |
| 101 | + require.Error(t, err) |
| 102 | + nonce, err := mempool.Nonce(context.Background()) |
| 103 | + require.NoError(t, err) |
| 104 | + require.Zero(t, nonce) |
| 105 | + require.Empty(t, chain.sent) |
| 106 | + signer.fail.Store(false) |
| 107 | + ctx, cancel := context.WithCancel(context.Background()) |
| 108 | + cancel() |
| 109 | + _, err = f.Send(ctx, tx, "metadata") |
| 110 | + require.ErrorIs(t, err, context.Canceled) |
| 111 | + signed, err := f.Send(context.Background(), tx, "metadata") |
| 112 | + require.NoError(t, err) |
| 113 | + require.Equal(t, signed.Hash(), (<-chain.sent).Hash()) |
| 114 | + calls := signer.calls.Load() |
| 115 | + ctx, cancel = context.WithCancel(context.Background()) |
| 116 | + defer cancel() |
| 117 | + done := make(chan error, 1) |
| 118 | + go func() { done <- f.Run(ctx) }() |
| 119 | + select { |
| 120 | + case resent := <-chain.sent: |
| 121 | + require.Equal(t, signed.Hash(), resent.Hash()) |
| 122 | + case <-time.After(time.Second): |
| 123 | + t.Fatal("no rebroadcast") |
| 124 | + } |
| 125 | + require.Equal(t, calls, signer.calls.Load(), "rebroadcast must reuse persisted signature") |
| 126 | + signer.fail.Store(true) |
| 127 | + chain.gas.Store(20) |
| 128 | + require.Eventually(t, func() bool { return signer.calls.Load() > calls }, time.Second, time.Millisecond) |
| 129 | + _, latest, err := mempool.Status(context.Background(), 0) |
| 130 | + require.NoError(t, err) |
| 131 | + require.Equal(t, signed.Hash(), latest.Transaction.Hash()) |
| 132 | + signer.fail.Store(false) |
| 133 | + require.Eventually(t, func() bool { |
| 134 | + _, latest, err := mempool.Status(context.Background(), 0) |
| 135 | + return err == nil && latest.Transaction.GasPrice().Int64() == 20 |
| 136 | + }, time.Second, time.Millisecond) |
| 137 | + _, latest, err = mempool.Status(context.Background(), 0) |
| 138 | + require.NoError(t, err) |
| 139 | + require.Equal(t, "metadata", latest.Transaction.Metadata) |
| 140 | + require.Zero(t, latest.Transaction.Nonce()) |
| 141 | + cancel() |
| 142 | + select { |
| 143 | + case <-done: |
| 144 | + case <-time.After(time.Second): |
| 145 | + t.Fatal("finalizer did not stop") |
| 146 | + } |
| 147 | +} |
0 commit comments