tests(werc20): Add WEVMOS acceptance tests (evmos#2074)

* fix: add gas estimation tests between the 2 WERC20s * tests(werc20): Add integration tests comparing behaviour with original Wevmos contract. * CHANGELOG * fix: rename contracts addr name * fix: fix RequiredGas so it's equal with the WEVMOS contract * Update CHANGELOG.md --------- Co-authored-by: Federico Kunze Küllmer <31522760+fedekunze@users.noreply.github.com>
qtpgv969wsyj · Nov 24, 2023 · 71c2f0b · 71c2f0b
1 parent 3c22225
commit 71c2f0b
Show file tree

Hide file tree

Showing 3 changed files with 176 additions and 10 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -107,6 +107,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 - (erc20) [#2067](https://github.com/evmos/evmos/pull/2067) Further alignments between ERC20 smart contracts and EVM extension.
 - (stride-outpost) [#2069](https://github.com/evmos/evmos/pull/2069) Refactor `osmosis` and `stride` testing.
 - (erc20) [#2073](https://github.com/evmos/evmos/pull/2073) Align metadata query errors with ERC20 contracts.
+- (werc20) [#2074](https://github.com/evmos/evmos/pull/2074) Add `werc20` EVM Extension acceptance tests with `WEVMOS` contract.
 
 ### Bug Fixes
 

diff --git a/precompiles/werc20/integration_test.go b/precompiles/werc20/integration_test.go
@@ -25,14 +25,16 @@ import (
 
 var _ = Describe("WEVMOS Extension -", func() {
 	var (
-		WEVMOSContractAddr common.Address
-		err                error
-		sender             keyring.Key
-		amount             *big.Int
+		WERC20ContractAddr         common.Address
+		WEVMOSOriginalContractAddr common.Address
+		err                        error
+		sender                     keyring.Key
+		amount                     *big.Int
 
 		// contractData is a helper struct to hold the addresses and ABIs for the
 		// different contract instances that are subject to testing here.
-		contractData ContractData
+		contractData         ContractData
+		contractDataOriginal ContractData
 
 		failCheck testutil.LogCheckArgs
 		passCheck testutil.LogCheckArgs
@@ -43,7 +45,7 @@ var _ = Describe("WEVMOS Extension -", func() {
 
 		sender = s.keyring.GetKey(0)
 
-		WEVMOSContractAddr, err = s.factory.DeployContract(
+		WERC20ContractAddr, err = s.factory.DeployContract(
 			sender.Priv,
 			evmtypes.EvmTxArgs{}, // NOTE: passing empty struct to use default values
 			factory.ContractDeploymentData{
@@ -53,7 +55,7 @@ var _ = Describe("WEVMOS Extension -", func() {
 		)
 		Expect(err).ToNot(HaveOccurred(), "failed to deploy contract")
 
-		tokenPair := erc20types.NewTokenPair(WEVMOSContractAddr, s.bondDenom, erc20types.OWNER_MODULE)
+		tokenPair := erc20types.NewTokenPair(WERC20ContractAddr, s.bondDenom, erc20types.OWNER_MODULE)
 
 		precompile, err := werc20.NewPrecompile(
 			tokenPair,
@@ -72,7 +74,7 @@ var _ = Describe("WEVMOS Extension -", func() {
 
 		contractData = ContractData{
 			ownerPriv:      sender.Priv,
-			erc20Addr:      WEVMOSContractAddr,
+			erc20Addr:      WERC20ContractAddr,
 			erc20ABI:       testdata.WEVMOSContract.ABI,
 			precompileAddr: s.precompile.Address(),
 			precompileABI:  s.precompile.ABI,
@@ -231,6 +233,169 @@ var _ = Describe("WEVMOS Extension -", func() {
 		})
 	})
 
+	Context("Comparing to original WEVMOS contract", func() {
+		BeforeEach(func() {
+			WEVMOSOriginalContractAddr, err = s.factory.DeployContract(
+				sender.Priv,
+				evmtypes.EvmTxArgs{}, // NOTE: passing empty struct to use default values
+				factory.ContractDeploymentData{
+					Contract:        testdata.WEVMOSContract,
+					ConstructorArgs: []interface{}{},
+				},
+			)
+			Expect(err).ToNot(HaveOccurred(), "failed to deploy contract")
+			contractDataOriginal = ContractData{
+				ownerPriv: sender.Priv,
+				erc20Addr: WEVMOSOriginalContractAddr,
+				erc20ABI:  testdata.WEVMOSContract.ABI,
+			}
+		})
+
+		When("calling deposit", func() {
+			It("should emit the Deposit event", func() {
+				depositCheck := passCheck.WithExpPass(true).WithExpEvents(werc20.EventTypeDeposit)
+				txArgsPrecompile, callArgsPrecompile := s.getTxAndCallArgs(erc20Call, contractData, werc20.DepositMethod)
+				txArgsPrecompile.Amount = amount
+
+				_, _, err := s.factory.CallContractAndCheckLogs(sender.Priv, txArgsPrecompile, callArgsPrecompile, depositCheck)
+				Expect(err).ToNot(HaveOccurred(), "unexpected result calling contract")
+
+				txArgsContract, callArgsContract := s.getTxAndCallArgs(erc20Call, contractDataOriginal, werc20.DepositMethod)
+				txArgsContract.Amount = amount
+				txArgsContract.GasLimit = 50_000
+
+				_, _, err = s.factory.CallContractAndCheckLogs(sender.Priv, txArgsContract, callArgsContract, depositCheck)
+				Expect(err).ToNot(HaveOccurred(), "unexpected result calling contract")
+			})
+
+			It("should have exact gas consumption", func() {
+				depositCheck := passCheck.WithExpPass(true).WithExpEvents(werc20.EventTypeDeposit)
+				txArgsPrecompile, callArgsPrecompile := s.getTxAndCallArgs(erc20Call, contractData, werc20.DepositMethod)
+				txArgsPrecompile.Amount = amount
+
+				_, ethResPrecompile, err := s.factory.CallContractAndCheckLogs(sender.Priv, txArgsPrecompile, callArgsPrecompile, depositCheck)
+				Expect(err).ToNot(HaveOccurred(), "unexpected result calling contract")
+
+				txArgsContract, callArgsContract := s.getTxAndCallArgs(erc20Call, contractDataOriginal, werc20.DepositMethod)
+				txArgsContract.Amount = amount
+				txArgsContract.GasLimit = 50_000
+
+				_, ethResOriginal, err := s.factory.CallContractAndCheckLogs(sender.Priv, txArgsContract, callArgsContract, depositCheck)
+				Expect(err).ToNot(HaveOccurred(), "unexpected result calling contract")
+
+				Expect(ethResOriginal.GasUsed).To(Equal(ethResPrecompile.GasUsed), "expected exact gas used")
+			})
+
+			It("should return the same error", func() {
+				depositCheck := passCheck.WithExpPass(true).WithExpEvents(werc20.EventTypeDeposit)
+				txArgsPrecompile, callArgsPrecompile := s.getTxAndCallArgs(erc20Call, contractData, werc20.DepositMethod)
+				txArgsPrecompile.Amount = big.NewInt(9e18)
+
+				_, _, errPrecompile := s.factory.CallContractAndCheckLogs(sender.Priv, txArgsPrecompile, callArgsPrecompile, depositCheck)
+				Expect(errPrecompile).To(HaveOccurred(), "unexpected result calling contract")
+
+				txArgsContract, callArgsContract := s.getTxAndCallArgs(erc20Call, contractDataOriginal, werc20.DepositMethod)
+				txArgsContract.Amount = big.NewInt(9e18)
+				txArgsContract.GasLimit = 50_000
+
+				_, _, errOriginal := s.factory.CallContractAndCheckLogs(sender.Priv, txArgsContract, callArgsContract, depositCheck)
+				Expect(errOriginal).To(HaveOccurred(), "unexpected result calling contract")
+
+				Expect(errOriginal.Error()).To(Equal(errPrecompile.Error()), "expected same error")
+			})
+
+			It("should reflect the correct balances", func() {
+				depositCheck := passCheck.WithExpPass(true).WithExpEvents(werc20.EventTypeDeposit)
+				txArgsPrecompile, callArgsPrecompile := s.getTxAndCallArgs(erc20Call, contractData, werc20.DepositMethod)
+				txArgsPrecompile.Amount = amount
+
+				_, _, errPrecompile := s.factory.CallContractAndCheckLogs(sender.Priv, txArgsPrecompile, callArgsPrecompile, depositCheck)
+				Expect(errPrecompile).ToNot(HaveOccurred(), "unexpected result calling contract")
+
+				txArgsContract, callArgsContract := s.getTxAndCallArgs(erc20Call, contractDataOriginal, werc20.DepositMethod)
+				txArgsContract.Amount = amount
+				txArgsContract.GasLimit = 50_000
+
+				_, _, errOriginal := s.factory.CallContractAndCheckLogs(sender.Priv, txArgsContract, callArgsContract, depositCheck)
+				Expect(errOriginal).ToNot(HaveOccurred(), "unexpected result calling contract")
+
+				// Check balances after calling precompile
+				s.checkBalances(failCheck, sender, contractData)
+
+				// Check balances after calling original contract
+				balanceCheck := failCheck.WithExpPass(true)
+				txArgs, balancesArgs := s.getTxAndCallArgs(erc20Call, contractDataOriginal, erc20.BalanceOfMethod, sender.Addr)
+
+				_, ethRes, err := s.factory.CallContractAndCheckLogs(sender.Priv, txArgs, balancesArgs, balanceCheck)
+				Expect(err).ToNot(HaveOccurred(), "failed to execute balanceOf")
+
+				// Check the balance in the bank module is the same as calling `balanceOf` on the precompile
+				var erc20Balance *big.Int
+				err = s.precompile.UnpackIntoInterface(&erc20Balance, erc20.BalanceOfMethod, ethRes.Ret)
+				Expect(err).ToNot(HaveOccurred(), "failed to unpack result")
+				Expect(erc20Balance).To(Equal(amount), "expected different balance")
+			})
+		})
+
+		When("calling withdraw", func() {
+			BeforeEach(func() {
+				// Deposit into the WEVMOS contract to have something to withdraw
+				depositCheck := passCheck.WithExpPass(true).WithExpEvents(werc20.EventTypeDeposit)
+				txArgsContract, callArgsContract := s.getTxAndCallArgs(erc20Call, contractDataOriginal, werc20.DepositMethod)
+				txArgsContract.Amount = amount
+				txArgsContract.GasLimit = 50_000
+
+				_, _, err = s.factory.CallContractAndCheckLogs(sender.Priv, txArgsContract, callArgsContract, depositCheck)
+				Expect(err).ToNot(HaveOccurred(), "unexpected result calling contract")
+			})
+
+			It("should emit the Withdraw event", func() {
+				withdrawCheck := passCheck.WithExpPass(true).WithExpEvents(werc20.EventTypeWithdrawal)
+				txArgsPrecompile, callArgsPrecompile := s.getTxAndCallArgs(erc20Call, contractData, werc20.WithdrawMethod, amount)
+
+				_, _, err := s.factory.CallContractAndCheckLogs(sender.Priv, txArgsPrecompile, callArgsPrecompile, withdrawCheck)
+				Expect(err).ToNot(HaveOccurred(), "unexpected result calling contract")
+
+				txArgsContract, callArgsContract := s.getTxAndCallArgs(erc20Call, contractDataOriginal, werc20.WithdrawMethod, amount)
+				txArgsContract.GasLimit = 50_000
+
+				_, _, err = s.factory.CallContractAndCheckLogs(sender.Priv, txArgsContract, callArgsContract, withdrawCheck)
+				Expect(err).ToNot(HaveOccurred(), "unexpected result calling contract")
+			})
+
+			It("should have exact gas consumption", func() {
+				withdrawCheck := passCheck.WithExpPass(true).WithExpEvents(werc20.EventTypeWithdrawal)
+				txArgsPrecompile, callArgsPrecompile := s.getTxAndCallArgs(erc20Call, contractData, werc20.WithdrawMethod, amount)
+
+				_, ethResPrecompile, err := s.factory.CallContractAndCheckLogs(sender.Priv, txArgsPrecompile, callArgsPrecompile, withdrawCheck)
+				Expect(err).ToNot(HaveOccurred(), "unexpected result calling contract")
+
+				txArgsContract, callArgsContract := s.getTxAndCallArgs(erc20Call, contractDataOriginal, werc20.WithdrawMethod, amount)
+
+				_, ethResOriginal, err := s.factory.CallContractAndCheckLogs(sender.Priv, txArgsContract, callArgsContract, withdrawCheck)
+				Expect(err).ToNot(HaveOccurred(), "unexpected result calling contract")
+
+				Expect(ethResOriginal.GasUsed).To(Equal(ethResPrecompile.GasUsed), "expected exact gas used")
+			})
+
+			It("should return the same error", func() {
+				withdrawCheck := passCheck.WithExpPass(true).WithExpEvents(werc20.EventTypeWithdrawal)
+				txArgsPrecompile, callArgsPrecompile := s.getTxAndCallArgs(erc20Call, contractData, werc20.WithdrawMethod)
+
+				_, _, errPrecompile := s.factory.CallContractAndCheckLogs(sender.Priv, txArgsPrecompile, callArgsPrecompile, withdrawCheck)
+				Expect(errPrecompile).To(HaveOccurred(), "unexpected result calling contract")
+
+				txArgsContract, callArgsContract := s.getTxAndCallArgs(erc20Call, contractDataOriginal, werc20.WithdrawMethod)
+				txArgsContract.GasLimit = 50_000
+
+				_, _, errOriginal := s.factory.CallContractAndCheckLogs(sender.Priv, txArgsContract, callArgsContract, withdrawCheck)
+				Expect(errOriginal).To(HaveOccurred(), "unexpected result calling contract")
+
+				Expect(errOriginal.Error()).To(Equal(errPrecompile.Error()), "expected same error")
+			})
+		})
+	})
+
 	Context("ERC20 specific functions", func() {
 		When("querying name", func() {
 			It("should return the correct name", func() {

diff --git a/precompiles/werc20/werc20.go b/precompiles/werc20/werc20.go
@@ -35,9 +35,9 @@ type Precompile struct {
 
 const (
 	// DepositRequiredGas defines the gas required for the Deposit transaction.
-	DepositRequiredGas uint64 = 28_799
+	DepositRequiredGas uint64 = 23_878
 	// WithdrawRequiredGas defines the gas required for the Withdraw transaction.
-	WithdrawRequiredGas uint64 = 35_960
+	WithdrawRequiredGas uint64 = 9207
 )
 
 // NewPrecompile creates a new WERC20 Precompile instance as a