mirror of
https://github.com/0glabs/0g-chain.git
synced 2024-12-25 15:55:18 +00:00
3afb656d1f
* Implement bep3 evm native conversion logic * Update changelog * Fix indentation * Add bep3 conversion keeper tests * make DefaultBEP3ConversionDenoms private * refactor bep3 conversion * update bep3 tests to cover all bep3 assets * minor refactor
416 lines
12 KiB
Go
416 lines
12 KiB
Go
package keeper_test
|
|
|
|
import (
|
|
"fmt"
|
|
"testing"
|
|
|
|
sdkmath "cosmossdk.io/math"
|
|
sdk "github.com/cosmos/cosmos-sdk/types"
|
|
"github.com/stretchr/testify/suite"
|
|
|
|
"github.com/kava-labs/kava/x/evmutil/testutil"
|
|
"github.com/kava-labs/kava/x/evmutil/types"
|
|
)
|
|
|
|
type Bep3ConversionTestSuite struct {
|
|
testutil.Suite
|
|
}
|
|
|
|
var (
|
|
bep3Denoms = []string{"bnb", "busd", "btcb", "xrpb"}
|
|
)
|
|
|
|
func TestBep3ConversionTestSuite(t *testing.T) {
|
|
suite.Run(t, new(Bep3ConversionTestSuite))
|
|
}
|
|
|
|
func (suite *Bep3ConversionTestSuite) TestConvertCoinToERC20_Bep3() {
|
|
for _, denom := range bep3Denoms {
|
|
suite.testConvertBep3CoinToERC20(denom)
|
|
}
|
|
}
|
|
|
|
func (suite *Bep3ConversionTestSuite) TestConvertERC20ToCoin_Bep3() {
|
|
for _, denom := range bep3Denoms {
|
|
suite.testConvertBep3ERC20ToCoin(denom)
|
|
}
|
|
}
|
|
|
|
func (suite *Bep3ConversionTestSuite) setEnabledConversionPairDenom(denom string) {
|
|
params := suite.Keeper.GetParams(suite.Ctx)
|
|
params.EnabledConversionPairs[0].Denom = denom
|
|
suite.Keeper.SetParams(suite.Ctx, params)
|
|
}
|
|
|
|
func (suite *Bep3ConversionTestSuite) testConvertBep3CoinToERC20(denom string) {
|
|
invoker, err := sdk.AccAddressFromBech32("kava123fxg0l602etulhhcdm0vt7l57qya5wjcrwhzz")
|
|
receiverAddr := testutil.MustNewInternalEVMAddressFromString("0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2")
|
|
suite.Require().NoError(err)
|
|
|
|
type errArgs struct {
|
|
expectPass bool
|
|
contains string
|
|
}
|
|
|
|
tests := []struct {
|
|
name string
|
|
userBankBalance sdkmath.Int
|
|
expUserErc20Balance sdkmath.Int
|
|
moduleErc20Balance sdkmath.Int
|
|
expModuleErc20Balance sdkmath.Int
|
|
disablePair bool
|
|
conversionDenom string
|
|
coinToConvert sdk.Coin
|
|
errArgs errArgs
|
|
}{
|
|
{
|
|
name: "success",
|
|
userBankBalance: sdkmath.NewInt(1_234),
|
|
moduleErc20Balance: sdkmath.NewInt(10e13),
|
|
expUserErc20Balance: sdkmath.NewInt(1.234e13),
|
|
expModuleErc20Balance: sdkmath.NewInt(8.766e13),
|
|
coinToConvert: sdk.NewCoin(denom, sdkmath.NewInt(1_234)),
|
|
errArgs: errArgs{
|
|
expectPass: true,
|
|
},
|
|
},
|
|
{
|
|
name: "success - convert smallest unit",
|
|
userBankBalance: sdkmath.NewInt(2),
|
|
moduleErc20Balance: sdkmath.NewInt(10e13),
|
|
expUserErc20Balance: sdkmath.NewInt(1e10),
|
|
expModuleErc20Balance: sdkmath.NewInt(9.999e13),
|
|
coinToConvert: sdk.NewCoin(denom, sdkmath.NewInt(1)),
|
|
errArgs: errArgs{
|
|
expectPass: true,
|
|
},
|
|
},
|
|
{
|
|
name: "success - no change when 0 amount converted",
|
|
userBankBalance: sdkmath.NewInt(1234),
|
|
moduleErc20Balance: sdkmath.NewInt(1e14),
|
|
expUserErc20Balance: sdkmath.ZeroInt(),
|
|
expModuleErc20Balance: sdkmath.NewInt(1e14),
|
|
coinToConvert: sdk.NewCoin(denom, sdkmath.NewInt(0)),
|
|
errArgs: errArgs{
|
|
expectPass: true,
|
|
},
|
|
},
|
|
{
|
|
name: "error - bep3 not enabled",
|
|
userBankBalance: sdkmath.NewInt(1_234),
|
|
moduleErc20Balance: sdkmath.NewInt(1e14),
|
|
disablePair: true,
|
|
coinToConvert: sdk.NewCoin(denom, sdkmath.NewInt(1_234)),
|
|
errArgs: errArgs{
|
|
expectPass: false,
|
|
contains: fmt.Sprintf("%s: ERC20 token not enabled to convert to sdk.Coin", denom),
|
|
},
|
|
},
|
|
{
|
|
name: "error - module account does not have enough balance to unlock",
|
|
userBankBalance: sdkmath.NewInt(1_234),
|
|
moduleErc20Balance: sdkmath.NewInt(1e9),
|
|
coinToConvert: sdk.NewCoin(denom, sdkmath.NewInt(1)),
|
|
errArgs: errArgs{
|
|
expectPass: false,
|
|
contains: "execution reverted: ERC20: transfer amount exceeds balance",
|
|
},
|
|
},
|
|
|
|
{
|
|
name: "success - not bep3 conversion",
|
|
conversionDenom: "hard",
|
|
userBankBalance: sdkmath.NewInt(1_234),
|
|
moduleErc20Balance: sdkmath.NewInt(2_000),
|
|
expUserErc20Balance: sdkmath.NewInt(1_234),
|
|
expModuleErc20Balance: sdkmath.NewInt(766),
|
|
coinToConvert: sdk.NewCoin("hard", sdkmath.NewInt(1_234)),
|
|
errArgs: errArgs{
|
|
expectPass: true,
|
|
},
|
|
},
|
|
{
|
|
name: "error - user converting more than user balance",
|
|
userBankBalance: sdkmath.NewInt(1_234),
|
|
moduleErc20Balance: sdkmath.NewInt(1e14),
|
|
coinToConvert: sdk.NewCoin(denom, sdkmath.NewInt(20_000)),
|
|
errArgs: errArgs{
|
|
expectPass: false,
|
|
contains: fmt.Sprintf("spendable balance 1234%s is smaller than 20000%s: insufficient funds", denom, denom),
|
|
},
|
|
},
|
|
}
|
|
|
|
for _, tc := range tests {
|
|
suite.Run(fmt.Sprintf("%s: %s", denom, tc.name), func() {
|
|
suite.SetupTest()
|
|
contractAddr := suite.DeployERC20()
|
|
|
|
// override conversion denom if needed
|
|
conversionDenom := tc.conversionDenom
|
|
if conversionDenom == "" {
|
|
conversionDenom = denom
|
|
}
|
|
|
|
if !tc.disablePair {
|
|
suite.setEnabledConversionPairDenom(conversionDenom)
|
|
}
|
|
|
|
pair := types.NewConversionPair(
|
|
contractAddr,
|
|
conversionDenom,
|
|
)
|
|
|
|
// fund user & module account
|
|
if tc.userBankBalance.GT(sdkmath.ZeroInt()) {
|
|
err = suite.App.FundAccount(
|
|
suite.Ctx,
|
|
invoker,
|
|
sdk.NewCoins(sdk.NewCoin(conversionDenom, tc.userBankBalance)),
|
|
)
|
|
suite.Require().NoError(err)
|
|
}
|
|
if tc.moduleErc20Balance.GT(sdkmath.ZeroInt()) {
|
|
err := suite.Keeper.MintERC20(
|
|
suite.Ctx,
|
|
pair.GetAddress(), // contractAddr
|
|
types.NewInternalEVMAddress(types.ModuleEVMAddress), //receiver
|
|
tc.moduleErc20Balance.BigInt(),
|
|
)
|
|
suite.Require().NoError(err)
|
|
}
|
|
|
|
// execute bep3 conversion
|
|
err := suite.Keeper.ConvertCoinToERC20(suite.Ctx, invoker, receiverAddr, tc.coinToConvert)
|
|
|
|
if tc.errArgs.expectPass {
|
|
suite.Require().NoError(err)
|
|
|
|
// validate user balance
|
|
bal := suite.GetERC20BalanceOf(
|
|
types.ERC20MintableBurnableContract.ABI,
|
|
pair.GetAddress(),
|
|
receiverAddr,
|
|
)
|
|
suite.Require().Equal(
|
|
tc.expUserErc20Balance.BigInt().Int64(),
|
|
bal.Int64(),
|
|
"user erc20 balance should match expected amount",
|
|
)
|
|
|
|
// validate module balance
|
|
bal = suite.GetERC20BalanceOf(
|
|
types.ERC20MintableBurnableContract.ABI,
|
|
pair.GetAddress(),
|
|
types.NewInternalEVMAddress(types.ModuleEVMAddress),
|
|
)
|
|
suite.Require().Equal(
|
|
tc.expModuleErc20Balance.BigInt().Int64(),
|
|
bal.Int64(),
|
|
"module erc20 balance should match expected amount",
|
|
)
|
|
|
|
// keeper event
|
|
suite.EventsContains(suite.GetEvents(),
|
|
sdk.NewEvent(
|
|
types.EventTypeConvertCoinToERC20,
|
|
sdk.NewAttribute(types.AttributeKeyInitiator, invoker.String()),
|
|
sdk.NewAttribute(types.AttributeKeyReceiver, receiverAddr.String()),
|
|
sdk.NewAttribute(types.AttributeKeyERC20Address, pair.GetAddress().String()),
|
|
sdk.NewAttribute(types.AttributeKeyAmount, tc.coinToConvert.String()),
|
|
))
|
|
} else {
|
|
suite.Require().Error(err)
|
|
suite.Require().Contains(err.Error(), tc.errArgs.contains)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func (suite *Bep3ConversionTestSuite) testConvertBep3ERC20ToCoin(denom string) {
|
|
invoker := testutil.MustNewInternalEVMAddressFromString("0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2")
|
|
invokerCosmosAddr, err := sdk.AccAddressFromHexUnsafe(invoker.String()[2:])
|
|
suite.Require().NoError(err)
|
|
|
|
type errArgs struct {
|
|
expectPass bool
|
|
contains string
|
|
}
|
|
|
|
tests := []struct {
|
|
name string
|
|
contractAddr string
|
|
conversionDenom string
|
|
disablePair bool
|
|
userErc20Balance sdkmath.Int
|
|
expUserBankBalance sdkmath.Int
|
|
expUserErc20Balance sdkmath.Int
|
|
convertAmount sdkmath.Int
|
|
errArgs errArgs
|
|
}{
|
|
{
|
|
name: "success - conversion with no dust",
|
|
userErc20Balance: sdkmath.NewInt(1.12e18),
|
|
expUserBankBalance: sdkmath.NewInt(1.0031e8),
|
|
expUserErc20Balance: sdkmath.NewInt(0.1169e18),
|
|
convertAmount: sdkmath.NewInt(1.0031e18),
|
|
errArgs: errArgs{
|
|
expectPass: true,
|
|
},
|
|
},
|
|
{
|
|
name: "success - convert smallest bank unit",
|
|
userErc20Balance: sdkmath.NewInt(2e18),
|
|
expUserBankBalance: sdkmath.NewInt(1),
|
|
expUserErc20Balance: sdkmath.NewInt(1.99999999e18),
|
|
convertAmount: sdkmath.NewInt(1.12e10),
|
|
errArgs: errArgs{
|
|
expectPass: true,
|
|
},
|
|
},
|
|
{
|
|
name: "success - bnb conversion with dust",
|
|
userErc20Balance: sdkmath.NewInt(2e18),
|
|
expUserBankBalance: sdkmath.NewInt(12),
|
|
expUserErc20Balance: sdkmath.NewInt(1.99999988e18),
|
|
convertAmount: sdkmath.NewInt(12.123e10),
|
|
errArgs: errArgs{
|
|
expectPass: true,
|
|
},
|
|
},
|
|
{
|
|
name: "fail - converting less than 1 bank unit",
|
|
userErc20Balance: sdkmath.NewInt(2e18),
|
|
convertAmount: sdkmath.NewInt(12e8),
|
|
errArgs: errArgs{
|
|
expectPass: false,
|
|
contains: "unable to convert bep3 coin due converting less than 1 native unit",
|
|
},
|
|
},
|
|
{
|
|
name: "fail - contract not enabled",
|
|
disablePair: true,
|
|
contractAddr: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
|
|
userErc20Balance: sdkmath.NewInt(2e18),
|
|
convertAmount: sdkmath.NewInt(2e18),
|
|
errArgs: errArgs{
|
|
expectPass: false,
|
|
contains: "ERC20 token not enabled to convert",
|
|
},
|
|
},
|
|
{
|
|
name: "fail - converting 0 amount of bep3 erc20 token",
|
|
userErc20Balance: sdkmath.NewInt(2e18),
|
|
convertAmount: sdkmath.NewInt(0),
|
|
errArgs: errArgs{
|
|
expectPass: false,
|
|
contains: "unable to convert bep3 coin due converting less than 1 native unit",
|
|
},
|
|
},
|
|
{
|
|
name: "success - not bep3 conversion",
|
|
conversionDenom: "xrp",
|
|
userErc20Balance: sdkmath.NewInt(2.5e18),
|
|
expUserBankBalance: sdkmath.NewInt(2.1e18),
|
|
expUserErc20Balance: sdkmath.NewInt(0.4e18),
|
|
convertAmount: sdkmath.NewInt(2.1e18),
|
|
errArgs: errArgs{
|
|
expectPass: true,
|
|
},
|
|
},
|
|
{
|
|
name: "fail - user converting more than user balance",
|
|
userErc20Balance: sdkmath.NewInt(2e18),
|
|
convertAmount: sdkmath.NewInt(2.3e18),
|
|
errArgs: errArgs{
|
|
expectPass: false,
|
|
contains: "transfer amount exceeds balance",
|
|
},
|
|
},
|
|
{
|
|
name: "success - user converting more than balance but only by dust amount",
|
|
userErc20Balance: sdkmath.NewInt(2e18),
|
|
expUserBankBalance: sdkmath.NewInt(2e8),
|
|
expUserErc20Balance: sdkmath.NewInt(0),
|
|
convertAmount: sdkmath.NewInt(2.0000000091e18),
|
|
errArgs: errArgs{
|
|
expectPass: true,
|
|
},
|
|
},
|
|
}
|
|
|
|
for _, tc := range tests {
|
|
suite.Run(fmt.Sprintf("%s: %s", denom, tc.name), func() {
|
|
suite.SetupTest()
|
|
contractAddr := suite.DeployERC20()
|
|
|
|
// override conversion denom if needed
|
|
conversionDenom := tc.conversionDenom
|
|
if conversionDenom == "" {
|
|
conversionDenom = denom
|
|
}
|
|
|
|
if !tc.disablePair {
|
|
suite.setEnabledConversionPairDenom(conversionDenom)
|
|
}
|
|
|
|
if tc.contractAddr != "" {
|
|
contractAddr = testutil.MustNewInternalEVMAddressFromString(tc.contractAddr)
|
|
}
|
|
|
|
pair := types.NewConversionPair(
|
|
contractAddr,
|
|
conversionDenom,
|
|
)
|
|
|
|
// fund user erc20 balance
|
|
if tc.userErc20Balance.GT(sdkmath.ZeroInt()) {
|
|
err := suite.Keeper.MintERC20(
|
|
suite.Ctx,
|
|
pair.GetAddress(),
|
|
invoker,
|
|
tc.userErc20Balance.BigInt(),
|
|
)
|
|
suite.Require().NoError(err)
|
|
}
|
|
|
|
// create user account, otherwise `CallEVMWithData` will fail due to failing to get user account when finding its sequence.
|
|
err = suite.App.FundAccount(suite.Ctx, invokerCosmosAddr, sdk.NewCoins(sdk.NewCoin(conversionDenom, sdk.ZeroInt())))
|
|
suite.Require().NoError(err)
|
|
|
|
// execute bep3 conversion
|
|
err := suite.Keeper.ConvertERC20ToCoin(suite.Ctx, invoker, invokerCosmosAddr, pair.GetAddress(), tc.convertAmount)
|
|
|
|
if tc.errArgs.expectPass {
|
|
suite.Require().NoError(err)
|
|
|
|
// validate user balance after conversion
|
|
bal := suite.GetERC20BalanceOf(
|
|
types.ERC20MintableBurnableContract.ABI,
|
|
pair.GetAddress(),
|
|
testutil.MustNewInternalEVMAddressFromString(invoker.String()),
|
|
)
|
|
suite.Require().Equal(tc.expUserErc20Balance.BigInt().Int64(), bal.Int64(), "user erc20 balance is invalid")
|
|
|
|
// validate user coin balance
|
|
coinBal := suite.App.GetBankKeeper().GetBalance(suite.Ctx, invokerCosmosAddr, pair.Denom)
|
|
suite.Require().Equal(tc.expUserBankBalance, coinBal.Amount, "user coin balance is invalid")
|
|
|
|
// keeper event
|
|
suite.EventsContains(suite.GetEvents(),
|
|
sdk.NewEvent(
|
|
types.EventTypeConvertERC20ToCoin,
|
|
sdk.NewAttribute(types.AttributeKeyERC20Address, pair.GetAddress().String()),
|
|
sdk.NewAttribute(types.AttributeKeyInitiator, invoker.String()),
|
|
sdk.NewAttribute(types.AttributeKeyReceiver, invokerCosmosAddr.String()),
|
|
sdk.NewAttribute(types.AttributeKeyAmount, sdk.NewCoin(pair.Denom, tc.expUserBankBalance).String()),
|
|
))
|
|
} else {
|
|
suite.Require().Error(err)
|
|
suite.Require().Contains(err.Error(), tc.errArgs.contains)
|
|
}
|
|
})
|
|
}
|
|
}
|