-
Notifications
You must be signed in to change notification settings - Fork 4
/
registration.go
170 lines (142 loc) · 5.79 KB
/
registration.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
package keeper
import (
"strings"
sdk "github.com/cosmos/cosmos-sdk/types"
sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
"github.com/ethereum/go-ethereum/common"
"github.com/ethereum/go-ethereum/crypto"
merlion "github.com/merlion-zone/merlion/types"
"github.com/merlion-zone/merlion/x/erc20/types"
"github.com/tharsis/evmos/v4/contracts"
)
// RegisterCoin deploys an erc20 contract and creates the token pair for the existing cosmos coin
func (k Keeper) RegisterCoin(ctx sdk.Context, denom string) (*types.TokenPair, error) {
// Prohibit denominations that contain the "lion" denom
if strings.Contains(denom, merlion.DisplayDenom) {
return nil, sdkerrors.Wrapf(types.ErrEVMDenom, "cannot register the EVM denomination %s", denom)
}
coinMetadata, found := k.bankKeeper.GetDenomMetaData(ctx, denom)
if !found {
return nil, sdkerrors.Wrapf(types.ErrEVMDenom, "cannot get metadata of denom %s", denom)
}
// Check if the denomination already registered
if k.IsDenomRegistered(ctx, coinMetadata.Base) {
return nil, sdkerrors.Wrapf(types.ErrTokenPairAlreadyExists, "coin denomination already registered: %s", coinMetadata.Base)
}
// Check if the coin exists by ensuring the supply is set
if !k.bankKeeper.HasSupply(ctx, coinMetadata.Base) {
return nil, sdkerrors.Wrapf(
sdkerrors.ErrInvalidCoins,
"base denomination '%s' cannot have a supply of 0", coinMetadata.Base,
)
}
addr, err := k.DeployERC20Contract(ctx, coinMetadata)
if err != nil {
return nil, sdkerrors.Wrap(err, "failed to create wrapped coin denom metadata for ERC20")
}
pair := types.NewTokenPair(addr, coinMetadata.Base, types.OWNER_MODULE)
k.SetTokenPair(ctx, pair)
k.SetDenomMap(ctx, pair.Denom, pair.GetID())
k.SetERC20Map(ctx, common.HexToAddress(pair.Erc20Address), pair.GetID())
return &pair, nil
}
// DeployERC20Contract creates and deploys an ERC20 contract on the EVM with the
// erc20 module account as owner.
func (k Keeper) DeployERC20Contract(
ctx sdk.Context,
coinMetadata banktypes.Metadata,
) (common.Address, error) {
decimals := uint8(coinMetadata.DenomUnits[0].Exponent)
ctorArgs, err := contracts.ERC20MinterBurnerDecimalsContract.ABI.Pack(
"",
coinMetadata.Name,
coinMetadata.Symbol,
decimals,
)
if err != nil {
return common.Address{}, sdkerrors.Wrapf(types.ErrABIPack, "coin metadata is invalid %s: %s", coinMetadata.Name, err.Error())
}
data := make([]byte, len(contracts.ERC20MinterBurnerDecimalsContract.Bin)+len(ctorArgs))
copy(data[:len(contracts.ERC20MinterBurnerDecimalsContract.Bin)], contracts.ERC20MinterBurnerDecimalsContract.Bin)
copy(data[len(contracts.ERC20MinterBurnerDecimalsContract.Bin):], ctorArgs)
nonce, err := k.accountKeeper.GetSequence(ctx, types.ModuleAddress.Bytes())
if err != nil {
return common.Address{}, err
}
contractAddr := crypto.CreateAddress(types.ModuleAddress, nonce)
_, err = k.CallEVMWithData(ctx, types.ModuleAddress, nil, data)
if err != nil {
return common.Address{}, sdkerrors.Wrapf(err, "failed to deploy contract for %s", coinMetadata.Name)
}
return contractAddr, nil
}
// RegisterERC20 registers the token pair between the coin and the ERC20
func (k Keeper) RegisterERC20(ctx sdk.Context, contract common.Address) (types.TokenPair, error) {
if k.IsERC20Registered(ctx, contract) {
return types.TokenPair{}, sdkerrors.Wrapf(types.ErrTokenPairAlreadyExists, "token ERC20 contract already registered: %s", contract.String())
}
metadata, err := k.CreateCoinMetadata(ctx, contract)
if err != nil {
return types.TokenPair{}, sdkerrors.Wrap(err, "failed to create wrapped coin denom metadata for ERC20")
}
pair := types.NewTokenPair(contract, metadata.Name, types.OWNER_EXTERNAL)
k.SetTokenPair(ctx, pair)
k.SetDenomMap(ctx, pair.Denom, pair.GetID())
k.SetERC20Map(ctx, common.HexToAddress(pair.Erc20Address), pair.GetID())
k.Logger(ctx).Info("registered erc20 token pair", "token_pair", pair)
return pair, nil
}
// CreateCoinMetadata generates the coin metadata to represent the ERC20 token.
func (k Keeper) CreateCoinMetadata(ctx sdk.Context, contract common.Address) (*banktypes.Metadata, error) {
strContract := contract.String()
erc20Data, err := k.QueryERC20(ctx, contract)
if err != nil {
return nil, err
}
_, found := k.bankKeeper.GetDenomMetaData(ctx, types.CreateDenom(strContract))
if found {
// metadata already exists; exit
return nil, sdkerrors.Wrap(types.ErrInternalTokenPair, "denom metadata already registered")
}
if k.IsDenomRegistered(ctx, types.CreateDenom(strContract)) {
return nil, sdkerrors.Wrapf(types.ErrInternalTokenPair, "coin denomination already registered: %s", erc20Data.Name)
}
// base denomination
base := types.CreateDenom(strContract)
// create a bank denom metadata based on the ERC20 token ABI details
// metadata name should always be the contract since it's the key
// to the bank store
metadata := banktypes.Metadata{
Description: types.CreateDenomDescription(strContract),
Base: base,
// NOTE: Denom units MUST be increasing
DenomUnits: []*banktypes.DenomUnit{
{
Denom: base,
Exponent: 0,
},
},
Name: types.CreateDenom(strContract),
Symbol: erc20Data.Symbol,
Display: base,
}
// only append metadata if decimals > 0, otherwise validation fails
if erc20Data.Decimals > 0 {
nameSanitized := types.SanitizeERC20Name(erc20Data.Name)
metadata.DenomUnits = append(
metadata.DenomUnits,
&banktypes.DenomUnit{
Denom: nameSanitized,
Exponent: uint32(erc20Data.Decimals),
},
)
metadata.Display = nameSanitized
}
if err := metadata.Validate(); err != nil {
return nil, sdkerrors.Wrapf(err, "ERC20 token data is invalid for contract %s", strContract)
}
k.bankKeeper.SetDenomMetaData(ctx, metadata)
k.Logger(ctx).Info("created coin metadata", "metadata", metadata)
return &metadata, nil
}