-
Notifications
You must be signed in to change notification settings - Fork 51
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(e2e): add gas pump deployments and tests (#1805)
Adds gas pump / station deployments to e2e app / tests. issue: #1686
- Loading branch information
1 parent
5f7b815
commit d282d92
Showing
10 changed files
with
351 additions
and
34 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,228 @@ | ||
| package app | ||
|
|
||
| import ( | ||
| "context" | ||
| "math/big" | ||
|
|
||
| "github.com/omni-network/omni/contracts/bindings" | ||
| "github.com/omni-network/omni/e2e/app/eoa" | ||
| "github.com/omni-network/omni/lib/anvil" | ||
| "github.com/omni-network/omni/lib/contracts" | ||
| "github.com/omni-network/omni/lib/contracts/gaspump" | ||
| "github.com/omni-network/omni/lib/contracts/gasstation" | ||
| "github.com/omni-network/omni/lib/errors" | ||
| "github.com/omni-network/omni/lib/log" | ||
| "github.com/omni-network/omni/lib/txmgr" | ||
|
|
||
| "github.com/ethereum/go-ethereum/common" | ||
| ethtypes "github.com/ethereum/go-ethereum/core/types" | ||
| "github.com/ethereum/go-ethereum/params" | ||
| ) | ||
|
|
||
| // deployGasApp deploys OmniGasPump and OmniGasStation contracts. | ||
| func DeployGasApp(ctx context.Context, def Definition) error { | ||
| if err := deployGasPumps(ctx, def); err != nil { | ||
| return errors.Wrap(err, "deploy gas pumps") | ||
| } | ||
|
|
||
| if err := deployGasStation(ctx, def); err != nil { | ||
| return errors.Wrap(err, "deploy gas station") | ||
| } | ||
|
|
||
| if err := fundGasStation(ctx, def); err != nil { | ||
| return errors.Wrap(err, "fund gas station") | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| // deployGasPumps deploys OmniGasPump contracts to all chains except Omni's EVM. | ||
| func deployGasPumps(ctx context.Context, def Definition) error { | ||
| network := networkFromDef(def) | ||
| omniEVM, ok := network.OmniEVMChain() | ||
| if !ok { | ||
| return errors.New("no omni evm chain") | ||
| } | ||
|
|
||
| for _, chain := range network.EVMChains() { | ||
| // GasPump not deployed on OmniEVM | ||
| if chain.ID == omniEVM.ID { | ||
| continue | ||
| } | ||
|
|
||
| backend, err := def.Backends().Backend(chain.ID) | ||
| if err != nil { | ||
| return errors.Wrap(err, "backend", "chain", chain.Name) | ||
| } | ||
|
|
||
| addr, receipt, err := gaspump.DeployIfNeeded(ctx, def.Testnet.Network, backend) | ||
| if err != nil { | ||
| return errors.Wrap(err, "deploy", "chain", chain.Name, "tx", maybeTxHash(receipt)) | ||
| } | ||
|
|
||
| log.Info(ctx, "Gas pump deployed", "chain", chain.Name, "address", addr.Hex(), "tx", maybeTxHash(receipt)) | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| // deployGasStation deploys OmniGasStation contract to Omni's EVM. | ||
| func deployGasStation(ctx context.Context, def Definition) error { | ||
| network := networkFromDef(def) | ||
| omniEVM, ok := network.OmniEVMChain() | ||
| if !ok { | ||
| return errors.New("no omni evm chain") | ||
| } | ||
|
|
||
| backend, err := def.Backends().Backend(omniEVM.ID) | ||
| if err != nil { | ||
| return errors.Wrap(err, "backend") | ||
| } | ||
|
|
||
| gasPumps := make([]bindings.OmniGasStationGasPump, 0, len(network.EVMChains())-1) | ||
| for _, chain := range network.EVMChains() { | ||
| if chain.ID == omniEVM.ID { | ||
| continue | ||
| } | ||
|
|
||
| gasPumps = append(gasPumps, bindings.OmniGasStationGasPump{ | ||
| ChainID: chain.ID, | ||
| Addr: contracts.GasPump(network.ID), | ||
| }) | ||
| } | ||
|
|
||
| addr, receipt, err := gasstation.DeployIfNeeded(ctx, def.Testnet.Network, backend, gasPumps) | ||
| if err != nil { | ||
| return errors.Wrap(err, "deploy", "tx", maybeTxHash(receipt)) | ||
| } | ||
|
|
||
| log.Info(ctx, "Gas station deployed", "address", addr.Hex(), "tx", maybeTxHash(receipt)) | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| // fundGasStation funds a network's OmniGasStation contract on Omni's EVM. | ||
| // | ||
| // TODO: handle funding / monitoring properly. | ||
| // consider joining with e2e/app/eoa, or introduce something similar for contracts. | ||
| func fundGasStation(ctx context.Context, def Definition) error { | ||
| network := networkFromDef(def) | ||
| omniEVM, ok := network.OmniEVMChain() | ||
| if !ok { | ||
| return errors.New("no omni evm chain") | ||
| } | ||
|
|
||
| backend, err := def.Backends().Backend(omniEVM.ID) | ||
| if err != nil { | ||
| return errors.Wrap(err, "backend") | ||
| } | ||
|
|
||
| funder := eoa.Funder() | ||
|
|
||
| // use dev account for ephemeral networks | ||
| if network.ID.IsEphemeral() { | ||
| funder = anvil.DevAccount8() | ||
| } | ||
|
|
||
| addr := contracts.GasStation(network.ID) | ||
|
|
||
| // 1000 OMNI | ||
| amt := new(big.Int).Mul(big.NewInt(1000), big.NewInt(params.Ether)) | ||
|
|
||
| tx, rec, err := backend.Send(ctx, funder, txmgr.TxCandidate{ | ||
| To: &addr, | ||
| GasLimit: 0, | ||
| Value: amt, | ||
| }) | ||
| if err != nil { | ||
| return errors.Wrap(err, "send tx") | ||
| } else if rec.Status != ethtypes.ReceiptStatusSuccessful { | ||
| return errors.New("fund tx failed", "tx", tx.Hash()) | ||
| } | ||
|
|
||
| log.Info(ctx, "Funded gas station", "tx", tx.Hash(), "amount", amt) | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func maybeTxHash(receipt *ethtypes.Receipt) string { | ||
| if receipt != nil { | ||
| return receipt.TxHash.Hex() | ||
| } | ||
|
|
||
| return "nil" | ||
| } | ||
|
|
||
| type GasPumpTest struct { | ||
| Recipient common.Address | ||
| AmountETH *big.Int | ||
| } | ||
|
|
||
| var ( | ||
| GasPumpTests = []GasPumpTest{ | ||
| { | ||
| Recipient: common.HexToAddress("0x0000000000000000000000000000000000001111"), | ||
| AmountETH: big.NewInt(5000000000000000), // 0.005 ETH | ||
| }, | ||
| { | ||
| Recipient: common.HexToAddress("0x0000000000000000000000000000000000002222"), | ||
| AmountETH: big.NewInt(10000000000000000), // 0.01 ETH | ||
| }, | ||
| { | ||
| Recipient: common.HexToAddress("0x0000000000000000000000000000000000003333"), | ||
| AmountETH: big.NewInt(15000000000000000), // 0.015 ETH | ||
| }, | ||
| } | ||
| ) | ||
|
|
||
| func testGasPumps(ctx context.Context, def Definition) error { | ||
| networkID := def.Testnet.Network | ||
| network := networkFromDef(def) | ||
| pumpAddr := contracts.GasPump(networkID) | ||
|
|
||
| omniEVM, ok := network.OmniEVMChain() | ||
| if !ok { | ||
| return errors.New("no omni evm chain") | ||
| } | ||
|
|
||
| if !networkID.IsEphemeral() { | ||
| log.Warn(ctx, "Skipping bridge test", errors.New("only ephemeral networks")) | ||
| return nil | ||
| } | ||
|
|
||
| // just need an account with funds on ephemeral network chains | ||
| payor := anvil.DevAccount7() | ||
|
|
||
| for _, chain := range network.EVMChains() { | ||
| if chain.ID == omniEVM.ID { | ||
| continue | ||
| } | ||
|
|
||
| backend, err := def.Backends().Backend(chain.ID) | ||
| if err != nil { | ||
| return errors.Wrap(err, "backend", "chain", chain.Name) | ||
| } | ||
|
|
||
| gasPump, err := bindings.NewOmniGasPump(pumpAddr, backend) | ||
| if err != nil { | ||
| return errors.Wrap(err, "new gas pump") | ||
| } | ||
|
|
||
| txOpts, err := backend.BindOpts(ctx, payor) | ||
| if err != nil { | ||
| return errors.Wrap(err, "bind opts") | ||
| } | ||
|
|
||
| for _, test := range GasPumpTests { | ||
| txOpts.Value = test.AmountETH | ||
| tx, err := gasPump.FillUp(txOpts, test.Recipient) | ||
| if err != nil { | ||
| return errors.Wrap(err, "pump", "chain", chain.Name) | ||
| } | ||
|
|
||
| log.Info(ctx, "Pumped gas", "chain", chain.Name, "tx", tx.Hash(), "recipient", test.Recipient.Hex(), "amount", test.AmountETH) | ||
| } | ||
| } | ||
|
|
||
| return nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| package e2e_test | ||
|
|
||
| import ( | ||
| "context" | ||
| "testing" | ||
|
|
||
| "github.com/omni-network/omni/e2e/app" | ||
| "github.com/omni-network/omni/lib/ethclient" | ||
| "github.com/omni-network/omni/lib/netconf" | ||
| "github.com/omni-network/omni/lib/xchain" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| // TestGasPumps ensures that bridge tests cases defined in e2e/app/gaspump.go were successful. | ||
| func TestGasPumps(t *testing.T) { | ||
| t.Parallel() | ||
| testNetwork(t, func(t *testing.T, network netconf.Network, endpoints xchain.RPCEndpoints) { | ||
| t.Helper() | ||
| ctx := context.Background() | ||
|
|
||
| omniEVM, ok := network.OmniEVMChain() | ||
| require.True(t, ok) | ||
|
|
||
| omniRPC, err := endpoints.ByNameOrID(omniEVM.Name, omniEVM.ID) | ||
| require.NoError(t, err) | ||
|
|
||
| omniClient, err := ethclient.Dial(omniEVM.Name, omniRPC) | ||
| require.NoError(t, err) | ||
|
|
||
| for _, test := range app.GasPumpTests { | ||
| balance, err := omniClient.BalanceAt(ctx, test.Recipient, nil) | ||
| require.NoError(t, err) | ||
|
|
||
| // Just test that balance > 0 for now | ||
| // TODO: assert that amount is equal to sum of AmountETH spent converted to OMNI | ||
| // Should account for the xcall fee, gas pump toll, and fee oracle conversion rates | ||
| require.Positive(t, balance.Uint64(), "recipient: %s", test.Recipient) | ||
| } | ||
| }) | ||
| } |
Oops, something went wrong.