0g-chain/x/evmutil/keeper/keeper.go
2024-08-02 12:59:16 +08:00

233 lines
6.8 KiB
Go

package keeper
import (
"fmt"
errorsmod "cosmossdk.io/errors"
sdkmath "cosmossdk.io/math"
"github.com/cosmos/cosmos-sdk/codec"
storetypes "github.com/cosmos/cosmos-sdk/store/types"
sdk "github.com/cosmos/cosmos-sdk/types"
sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
paramtypes "github.com/cosmos/cosmos-sdk/x/params/types"
"github.com/0glabs/0g-chain/x/evmutil/types"
)
// Keeper of the evmutil store.
// This keeper stores additional data related to evm accounts.
type Keeper struct {
cdc codec.Codec
storeKey storetypes.StoreKey
paramSubspace paramtypes.Subspace
bankKeeper types.BankKeeper
evmKeeper types.EvmKeeper
accountKeeper types.AccountKeeper
}
// NewKeeper creates an evmutil keeper.
func NewKeeper(
cdc codec.Codec,
storeKey storetypes.StoreKey,
params paramtypes.Subspace,
bk types.BankKeeper,
ak types.AccountKeeper,
) Keeper {
if !params.HasKeyTable() {
params = params.WithKeyTable(types.ParamKeyTable())
}
return Keeper{
cdc: cdc,
storeKey: storeKey,
paramSubspace: params,
bankKeeper: bk,
accountKeeper: ak,
}
}
func (k *Keeper) SetEvmKeeper(evmKeeper types.EvmKeeper) {
k.evmKeeper = evmKeeper
}
// GetAllAccounts returns all accounts.
func (k Keeper) GetAllAccounts(ctx sdk.Context) (accounts []types.Account) {
k.IterateAllAccounts(ctx, func(account types.Account) bool {
accounts = append(accounts, account)
return false
})
return accounts
}
// IterateAllAccounts iterates over all accounts. If true is returned from the
// callback, iteration is halted.
func (k Keeper) IterateAllAccounts(ctx sdk.Context, cb func(types.Account) bool) {
store := ctx.KVStore(k.storeKey)
iterator := sdk.KVStorePrefixIterator(store, types.AccountStoreKeyPrefix)
defer iterator.Close()
for ; iterator.Valid(); iterator.Next() {
var acc types.Account
if err := k.cdc.Unmarshal(iterator.Value(), &acc); err != nil {
panic(err)
}
if cb(acc) {
break
}
}
}
// GetAccount returns the account for a given address.
func (k Keeper) GetAccount(ctx sdk.Context, addr sdk.AccAddress) *types.Account {
store := ctx.KVStore(k.storeKey)
var account types.Account
bz := store.Get(types.AccountStoreKey(addr))
if bz == nil {
return nil
}
if err := account.Unmarshal(bz); err != nil {
panic(err)
}
return &account
}
// SetAccount sets the account for a given address.
func (k Keeper) SetAccount(ctx sdk.Context, account types.Account) error {
if err := account.Validate(); err != nil {
return err
}
store := ctx.KVStore(k.storeKey)
accountKey := types.AccountStoreKey(account.Address)
// make sure we remove accounts with zero balance
if !account.Balance.IsPositive() {
if store.Has(accountKey) {
store.Delete(accountKey)
}
return nil
}
bz, err := k.cdc.Marshal(&account)
if err != nil {
panic(err)
}
store.Set(accountKey, bz)
return nil
}
// GetBalance returns the total balance of base denom for a given account by address.
func (k Keeper) GetBalance(ctx sdk.Context, addr sdk.AccAddress) sdkmath.Int {
account := k.GetAccount(ctx, addr)
if account == nil {
return sdk.ZeroInt()
}
return account.Balance
}
// SetBalance sets the total balance of base denom for a given account by address.
func (k Keeper) SetBalance(ctx sdk.Context, addr sdk.AccAddress, bal sdkmath.Int) error {
account := k.GetAccount(ctx, addr)
if account == nil {
account = types.NewAccount(addr, bal)
} else {
account.Balance = bal
}
if err := account.Validate(); err != nil {
return err
}
return k.SetAccount(ctx, *account)
}
// SendBalance transfers the base denom balance from sender addr to recipient addr.
func (k Keeper) SendBalance(ctx sdk.Context, senderAddr sdk.AccAddress, recipientAddr sdk.AccAddress, amt sdkmath.Int) error {
if amt.IsNegative() {
return fmt.Errorf("cannot send a negative amount of base denom: %d", amt)
}
if amt.IsZero() {
return nil
}
senderBal := k.GetBalance(ctx, senderAddr)
if senderBal.LT(amt) {
return errorsmod.Wrapf(sdkerrors.ErrInsufficientFunds, "insufficient funds to send %s", amt.String())
}
if err := k.SetBalance(ctx, senderAddr, senderBal.Sub(amt)); err != nil {
return err
}
receiverBal := k.GetBalance(ctx, recipientAddr).Add(amt)
return k.SetBalance(ctx, recipientAddr, receiverBal)
}
// AddBalance increments the base denom balance of an address.
func (k Keeper) AddBalance(ctx sdk.Context, addr sdk.AccAddress, amt sdkmath.Int) error {
bal := k.GetBalance(ctx, addr)
return k.SetBalance(ctx, addr, amt.Add(bal))
}
// RemoveBalance decrements the base denom balance of an address.
func (k Keeper) RemoveBalance(ctx sdk.Context, addr sdk.AccAddress, amt sdkmath.Int) error {
if amt.IsNegative() {
return fmt.Errorf("cannot remove a negative amount from balance: %d", amt)
}
if amt.IsZero() {
return nil
}
bal := k.GetBalance(ctx, addr)
finalBal := bal.Sub(amt)
if finalBal.IsNegative() {
return errorsmod.Wrapf(sdkerrors.ErrInsufficientFunds, "insufficient funds to send %s", amt.String())
}
return k.SetBalance(ctx, addr, finalBal)
}
// SetDeployedCosmosCoinContract stores a single deployed ERC20ZgChainWrappedCosmosCoin contract address
func (k *Keeper) SetDeployedCosmosCoinContract(ctx sdk.Context, cosmosDenom string, contractAddress types.InternalEVMAddress) error {
if err := sdk.ValidateDenom(cosmosDenom); err != nil {
return errorsmod.Wrap(types.ErrInvalidCosmosDenom, cosmosDenom)
}
if contractAddress.IsNil() {
return errorsmod.Wrapf(
sdkerrors.ErrInvalidAddress,
"attempting to register empty contract address for denom '%s'",
cosmosDenom,
)
}
store := ctx.KVStore(k.storeKey)
storeKey := types.DeployedCosmosCoinContractKey(cosmosDenom)
store.Set(storeKey, contractAddress.Bytes())
return nil
}
// SetDeployedCosmosCoinContract gets a deployed ERC20ZgChainWrappedCosmosCoin contract address by cosmos denom
// Returns the stored address and a bool indicating if it was found or not
func (k *Keeper) GetDeployedCosmosCoinContract(ctx sdk.Context, cosmosDenom string) (types.InternalEVMAddress, bool) {
store := ctx.KVStore(k.storeKey)
storeKey := types.DeployedCosmosCoinContractKey(cosmosDenom)
bz := store.Get(storeKey)
found := len(bz) != 0
return types.BytesToInternalEVMAddress(bz), found
}
// IterateAllDeployedCosmosCoinContracts iterates through all the deployed ERC20 contracts representing
// cosmos-sdk coins. If true is returned from the callback, iteration is halted.
func (k Keeper) IterateAllDeployedCosmosCoinContracts(ctx sdk.Context, cb func(types.DeployedCosmosCoinContract) bool) {
store := ctx.KVStore(k.storeKey)
iterator := sdk.KVStorePrefixIterator(store, types.DeployedCosmosCoinContractKeyPrefix)
defer iterator.Close()
for ; iterator.Valid(); iterator.Next() {
contract := types.NewDeployedCosmosCoinContract(
types.DenomFromDeployedCosmosCoinContractKey(iterator.Key()),
types.BytesToInternalEVMAddress(iterator.Value()),
)
if cb(contract) {
break
}
}
}