0g-chain/x/evmutil/keeper/erc20.go

272 lines
7.5 KiB
Go
Raw Normal View History

package keeper
import (
"encoding/hex"
"fmt"
"math/big"
errorsmod "cosmossdk.io/errors"
sdk "github.com/cosmos/cosmos-sdk/types"
"github.com/ethereum/go-ethereum/core/vm"
"github.com/ethereum/go-ethereum/crypto"
feat: upgrade to Cosmos v0.46 (#1477) * Update cosmos-sdk to v0.45.10-kava * Add RegisterNodeService to app * Update cosmos proto files * Update cosmos proto files * Use tagged v0.45.10-kava-v0.19-0.21 cosmos version * update x/auth/legacy to x/auth/migrations * Delete rest packages and registration * Remove rest from proposal handlers * Remove legacy types referencing removed sdk types * Remove legacy tx broadcast handler * Update incentive staking hooks to return error * Remove grpc replace directive, use new grpc version * Fix storetypes import * Update tally_handler with updated gov types * Delete legacy types * Use new gov default config * Update RegisterTendermintService params Signed-off-by: drklee3 <derrick@dlee.dev> * Replace sdk.StoreKey with storetypes.StoreKey * Replace sdk.Int#ToDec with sdk.NewDecFromInt * Replace sdk.NewUintFromBigInt with sdkmath.NewUintFromBigInt Signed-off-by: drklee3 <derrick@dlee.dev> * Update most intances of govtypes to govv1beta1 * Unpack coin slice for Coins#Sub and Coins#SafeSub Signed-off-by: drklee3 <derrick@dlee.dev> * Update committee gov codec registration Signed-off-by: drklee3 <derrick@dlee.dev> * Update migrate utils period_vesting Coins#Sub Signed-off-by: drklee3 <derrick@dlee.dev> * Update Coin#Sub in community proposal handler Signed-off-by: drklee3 <derrick@dlee.dev> * Update Coin#Sub, FundModuleAccount/FundAccount in banktestutil Signed-off-by: drklee3 <derrick@dlee.dev> * Update community, earn, kavadist proposal gov registration * Update evm cli client EthSecp256k1Type check * AccAddressFromHex to AccAddressFromHexUnsafe * Add mint DefaultInflationCalculationFn to earn test * Update use of removed staking.NewHandler * Rename FlagIAVLFastNode -> FlagDisableIAVLFastNode * cmd: Update new snapshot app option Signed-off-by: drklee3 <derrick@dlee.dev> * cmd: Add tendermint default config, use cosmos rpc status command Signed-off-by: drklee3 <derrick@dlee.dev> * Update ethermint import path github.com/tharsis/ethermint -> github.com/evmos/ethermint * Upgrade ibc-go to v6 * Update proto dependencies Signed-off-by: drklee3 <derrick@dlee.dev> * Update Tally handler test with new gov types * Update helpers.GenTx -> helpers.GenSignedMockTx * Update evmkeeper.NewKeeper params Signed-off-by: drklee3 <derrick@dlee.dev> * Update ante authz, tests * Add feemarket transient key, pass subspaces to evm/feemarket keepers * Update new ante decorators * Add new addModuleInitFlags to server commands * Pass codec to keyring.New in genaccounts * Pass codec to client keys add * Add SendCoins to evmutil bank_keeper * Use github.com/cosmos/iavl@v0.19.5 * Add ante HandlerOptions * Add unimplemented SendCoins to evmutil bank keeper Ethermint x/evm does not use this method * Update init-new-chain script to disable post-london blocks * Modify test genesis states to append 1 validator * Update tally handler test to use string values * Prevent querying balance for empty sdk.AccAddress in auction bidding test * Set default bond denom to ukava * Remove overwritten bank genesis total supply in committee proposal test Signed-off-by: drklee3 <derrick@dlee.dev> * Use ukava for testing staked balance * Disable minting in community proposal handler test Previously stake denom is used, which resulted in 0 minted coins * Update hard APYToSPY test expected value Increased iterations in sdk.ApproxRoot, updated closer to real value * Fix NewDecCoinsFromCoins bug in incentive collectDerivativeStakingRewards * Allow bkava earn incentive test values to match within small margin for rounding Signed-off-by: drklee3 <derrick@dlee.dev> * Update invalid denom in issuance message coin validation Colons are now valid in denoms Signed-off-by: drklee3 <derrick@dlee.dev> * Remove genesis validator in incentive delegation tests * Update pricefeed market test for invalid denom Signed-off-by: drklee3 <derrick@dlee.dev> * Update incentive delegator rewards test without genesis validator Signed-off-by: drklee3 <derrick@dlee.dev> * Add validator to export test * Clear bank state in minting tests Signed-off-by: drklee3 <derrick@dlee.dev> * Remove validator for no stake tally test Signed-off-by: drklee3 <derrick@dlee.dev> * Clear incentive state before InitGenesis in incentive genesis export test * Update swagger Signed-off-by: drklee3 <derrick@dlee.dev> * Update ethermint version to match replaced version * Remove legacy swagger * Add NewEthEmitEventDecorator * Remove redundant func for AddModuleInitFlags * Remove unused addBankBalanceForAddress func * Add SetIAVLLazyLoading option to app cmd * Use legacy.RegisterAminoMsg for committee msg concrete registration * Remove unnecessary Amino field * Add evm_util bankkeeper SendCoins comment * Update test method ResetBankState to DeleteGenesisValidatorCoins to be more clear * Validate incentive params.RewardsPerSecond to be non-zero * Validate swap pools to disallow colons in token denoms * Register all legacy amino types on gov modulecdc * Remove redundant Comittee interface registration * Pin goleveldb to v1.0.1-0.20210819022825-2ae1ddf74ef7 Causes failed to load state at height errors * Update ethermint to new pinned version with minGasPrices parse error fix * Update cosmos fork dependcy commit to include reverted account constructor patch * Update Cosmos v0.46.11 and cometbft v0.34.27 * Bump minimum go version to 1.19 * Update tendermint proto * Update internal testnet genesis * Move NewCanTransferDecorator before NewEthGasConsumeDecorator * Add hard borrow store tests (#1514) * add store tests for Borrow type * refactor Deposit tests to match * Fix old bep3 tests (#1515) * Update Ethermint to 1b17445 to fix duplicate proto registration * Add custom status command to use snake_case and stdout * Add SetInflation helper * Reduce ambiguity with evm CanSignEthTx error * Remove init genesis validator claim in test * Add disabled evmante.NewMinGasPriceDecorator with x/feemarket note * chore: use tagged versions for Cosmos and Ethermint forks * update kvtool & increase wait for ibc transfer test --------- Signed-off-by: drklee3 <derrick@dlee.dev> Co-authored-by: Ruaridh <rhuairahrighairidh@users.noreply.github.com> Co-authored-by: Robert Pirtle <astropirtle@gmail.com>
2023-04-04 00:08:45 +00:00
evmtypes "github.com/evmos/ethermint/x/evm/types"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
2024-05-01 03:17:24 +00:00
"github.com/0glabs/0g-chain/x/evmutil/types"
)
const (
erc20BalanceOfMethod = "balanceOf"
erc20BurnMethod = "burn"
erc20MintMethod = "mint"
erc20TotalSupplyMethod = "totalSupply"
)
// DeployTestMintableERC20Contract deploys an ERC20 contract on the EVM as the
// module account and returns the address of the contract. This contract has
// minting permissions for the module account.
// Derived from tharsis/evmos
// https://github.com/tharsis/evmos/blob/ee54f496551df937915ff6f74a94732a35abc505/x/erc20/keeper/evm.go
func (k Keeper) DeployTestMintableERC20Contract(
ctx sdk.Context,
name string,
symbol string,
decimals uint8,
) (types.InternalEVMAddress, error) {
ctorArgs, err := types.ERC20MintableBurnableContract.ABI.Pack(
"", // Empty string for contract constructor
name,
symbol,
decimals,
)
if err != nil {
return types.InternalEVMAddress{}, errorsmod.Wrapf(err, "token %v is invalid", name)
}
data := make([]byte, len(types.ERC20MintableBurnableContract.Bin)+len(ctorArgs))
copy(
data[:len(types.ERC20MintableBurnableContract.Bin)],
types.ERC20MintableBurnableContract.Bin,
)
copy(
data[len(types.ERC20MintableBurnableContract.Bin):],
ctorArgs,
)
nonce, err := k.accountKeeper.GetSequence(ctx, types.ModuleEVMAddress.Bytes())
if err != nil {
return types.InternalEVMAddress{}, err
}
contractAddr := crypto.CreateAddress(types.ModuleEVMAddress, nonce)
_, err = k.CallEVMWithData(ctx, types.ModuleEVMAddress, nil, data)
if err != nil {
return types.InternalEVMAddress{}, fmt.Errorf("failed to deploy ERC20 for %s: %w", name, err)
}
return types.NewInternalEVMAddress(contractAddr), nil
}
2024-05-01 05:53:58 +00:00
// DeployZgChainWrappedCosmosCoinERC20Contract validates token details and then deploys an ERC20
// contract with the token metadata.
// This method does NOT check if a token for the provided SdkDenom has already been deployed.
2024-05-01 05:53:58 +00:00
func (k Keeper) DeployZgChainWrappedCosmosCoinERC20Contract(
ctx sdk.Context,
token types.AllowedCosmosCoinERC20Token,
) (types.InternalEVMAddress, error) {
if err := token.Validate(); err != nil {
return types.InternalEVMAddress{}, errorsmod.Wrapf(err, "failed to deploy erc20 for sdk denom %s", token.CosmosDenom)
}
2024-05-01 05:53:58 +00:00
packedAbi, err := types.ERC20ZgChainWrappedCosmosCoinContract.ABI.Pack(
"", // Empty string for contract constructor
token.Name,
token.Symbol,
uint8(token.Decimals), // cast to uint8 is safe because of Validate()
)
if err != nil {
return types.InternalEVMAddress{}, errorsmod.Wrapf(err, "failed to pack token with details %+v", token)
}
2024-05-01 05:53:58 +00:00
data := make([]byte, len(types.ERC20ZgChainWrappedCosmosCoinContract.Bin)+len(packedAbi))
copy(
2024-05-01 05:53:58 +00:00
data[:len(types.ERC20ZgChainWrappedCosmosCoinContract.Bin)],
types.ERC20ZgChainWrappedCosmosCoinContract.Bin,
)
copy(
2024-05-01 05:53:58 +00:00
data[len(types.ERC20ZgChainWrappedCosmosCoinContract.Bin):],
packedAbi,
)
nonce, err := k.accountKeeper.GetSequence(ctx, types.ModuleEVMAddress.Bytes())
if err != nil {
return types.InternalEVMAddress{}, err
}
contractAddr := crypto.CreateAddress(types.ModuleEVMAddress, nonce)
_, err = k.CallEVMWithData(ctx, types.ModuleEVMAddress, nil, data)
if err != nil {
return types.InternalEVMAddress{}, fmt.Errorf("failed to deploy ERC20 %s (nonce=%d, data=%s): %s", token.Name, nonce, hex.EncodeToString(data), err)
}
return types.NewInternalEVMAddress(contractAddr), nil
}
// GetOrDeployCosmosCoinERC20Contract checks the module store for a deployed contract for the given
// token info and returns it if preset. Otherwise, it deploys and registers the contract.
func (k *Keeper) GetOrDeployCosmosCoinERC20Contract(
ctx sdk.Context,
tokenInfo types.AllowedCosmosCoinERC20Token,
) (types.InternalEVMAddress, error) {
contractAddress, found := k.GetDeployedCosmosCoinContract(ctx, tokenInfo.CosmosDenom)
if found {
// contract has already been deployed
return contractAddress, nil
}
// deploy a new contract
2024-05-01 05:53:58 +00:00
contractAddress, err := k.DeployZgChainWrappedCosmosCoinERC20Contract(ctx, tokenInfo)
if err != nil {
return contractAddress, err
}
// register the contract to the module store
err = k.SetDeployedCosmosCoinContract(ctx, tokenInfo.CosmosDenom, contractAddress)
// TODO: emit event that contract was deployed
return contractAddress, err
}
// MintERC20 mints the given amount of an ERC20 token to an address. This is
// unchecked and should only be called after permission and enabled ERC20 checks.
func (k Keeper) MintERC20(
ctx sdk.Context,
contractAddr types.InternalEVMAddress,
receiver types.InternalEVMAddress,
amount *big.Int,
) error {
_, err := k.CallEVM(
ctx,
types.ERC20MintableBurnableContract.ABI,
types.ModuleEVMAddress,
contractAddr,
erc20MintMethod,
// Mint ERC20 args
receiver.Address,
amount,
)
return err
}
// BurnERC20 burns the token amount from the initiator's balance.
func (k Keeper) BurnERC20(
ctx sdk.Context,
contractAddr types.InternalEVMAddress,
initiator types.InternalEVMAddress,
amount *big.Int,
) error {
_, err := k.CallEVM(
ctx,
2024-05-01 05:53:58 +00:00
types.ERC20ZgChainWrappedCosmosCoinContract.ABI,
types.ModuleEVMAddress,
contractAddr,
erc20BurnMethod,
// Burn ERC20 args
initiator.Address,
amount,
)
return err
}
// QueryERC20BalanceOf makes a contract call to the balanceOf method of the ERC20 contract to get
// the ERC20 balance of the given account.
func (k Keeper) QueryERC20BalanceOf(
ctx sdk.Context,
contractAddr types.InternalEVMAddress,
account types.InternalEVMAddress,
) (*big.Int, error) {
res, err := k.CallEVM(
ctx,
types.ERC20MintableBurnableContract.ABI,
types.ModuleEVMAddress,
contractAddr,
erc20BalanceOfMethod,
// balanceOf ERC20 args
account.Address,
)
if err != nil {
return nil, err
}
return unpackERC20ResToBigInt(res, erc20BalanceOfMethod)
}
// QueryERC20TotalSupply makes a contract call to the totalSupply method of the ERC20 contract to
// get the total supply of the token.
func (k Keeper) QueryERC20TotalSupply(
ctx sdk.Context,
contractAddr types.InternalEVMAddress,
) (*big.Int, error) {
res, err := k.CallEVM(
ctx,
2024-05-01 05:53:58 +00:00
types.ERC20ZgChainWrappedCosmosCoinContract.ABI,
types.ModuleEVMAddress,
contractAddr,
erc20TotalSupplyMethod,
// totalSupply takes no args
)
if err != nil {
return nil, err
}
return unpackERC20ResToBigInt(res, erc20TotalSupplyMethod)
}
func unpackERC20ResToBigInt(res *evmtypes.MsgEthereumTxResponse, methodName string) (*big.Int, error) {
if res.Failed() {
if res.VmError == vm.ErrExecutionReverted.Error() {
// Unpacks revert
return nil, evmtypes.NewExecErrorWithReason(res.Ret)
}
return nil, status.Error(codes.Internal, res.VmError)
}
if len(res.Ret) == 0 {
return nil, fmt.Errorf("failed to unpack method %s: expected response to be big.Int but found nil", methodName)
}
anyOutput, err := types.ERC20MintableBurnableContract.ABI.Unpack(methodName, res.Ret)
if err != nil {
return nil, fmt.Errorf(
"failed to unpack method %v response: %w",
methodName,
err,
)
}
if len(anyOutput) != 1 {
return nil, fmt.Errorf(
"invalid ERC20 %v call return outputs %v, expected %v",
methodName,
len(anyOutput),
1,
)
}
bal, ok := anyOutput[0].(*big.Int)
if !ok {
return nil, fmt.Errorf(
"invalid ERC20 return type %T, expected %T",
anyOutput[0],
&big.Int{},
)
}
return bal, nil
}