-
Notifications
You must be signed in to change notification settings - Fork 0
/
bank_keeper.go
261 lines (213 loc) · 8.14 KB
/
bank_keeper.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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
package keeper
import (
"fmt"
sdk "github.com/cosmos/cosmos-sdk/types"
sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
evmtypes "github.com/tharsis/ethermint/x/evm/types"
"github.com/furya-official/mage/x/evmutil/types"
)
const (
// EvmDenom is the gas denom used by the evm
EvmDenom = "amage"
// CosmosDenom is the gas denom used by the mage app
CosmosDenom = "umage"
)
// ConversionMultiplier is the conversion multiplier between amage and umage
var ConversionMultiplier = sdk.NewInt(1_000_000_000_000)
var _ evmtypes.BankKeeper = EvmBankKeeper{}
// EvmBankKeeper is a BankKeeper wrapper for the x/evm module to allow the use
// of the 18 decimal amage coin on the evm.
// x/evm consumes gas and send coins by minting and burning amage coins in its module
// account and then sending the funds to the target account.
// This keeper uses both the umage coin and a separate amage balance to manage the
// extra percision needed by the evm.
type EvmBankKeeper struct {
amageKeeper Keeper
bk types.BankKeeper
ak types.AccountKeeper
}
func NewEvmBankKeeper(amageKeeper Keeper, bk types.BankKeeper, ak types.AccountKeeper) EvmBankKeeper {
return EvmBankKeeper{
amageKeeper: amageKeeper,
bk: bk,
ak: ak,
}
}
// GetBalance returns the total **spendable** balance of amage for a given account by address.
func (k EvmBankKeeper) GetBalance(ctx sdk.Context, addr sdk.AccAddress, denom string) sdk.Coin {
if denom != EvmDenom {
panic(fmt.Errorf("only evm denom %s is supported by EvmBankKeeper", EvmDenom))
}
spendableCoins := k.bk.SpendableCoins(ctx, addr)
umage := spendableCoins.AmountOf(CosmosDenom)
amage := k.amageKeeper.GetBalance(ctx, addr)
total := umage.Mul(ConversionMultiplier).Add(amage)
return sdk.NewCoin(EvmDenom, total)
}
// SendCoinsFromModuleToAccount transfers amage coins from a ModuleAccount to an AccAddress.
// It will panic if the module account does not exist. An error is returned if the recipient
// address is black-listed or if sending the tokens fails.
func (k EvmBankKeeper) SendCoinsFromModuleToAccount(ctx sdk.Context, senderModule string, recipientAddr sdk.AccAddress, amt sdk.Coins) error {
umage, amage, err := SplitAmageCoins(amt)
if err != nil {
return err
}
if umage.Amount.IsPositive() {
if err := k.bk.SendCoinsFromModuleToAccount(ctx, senderModule, recipientAddr, sdk.NewCoins(umage)); err != nil {
return err
}
}
senderAddr := k.GetModuleAddress(senderModule)
if err := k.ConvertOneUmageToAmageIfNeeded(ctx, senderAddr, amage); err != nil {
return err
}
if err := k.amageKeeper.SendBalance(ctx, senderAddr, recipientAddr, amage); err != nil {
return err
}
return k.ConvertAmageToUmage(ctx, recipientAddr)
}
// SendCoinsFromAccountToModule transfers amage coins from an AccAddress to a ModuleAccount.
// It will panic if the module account does not exist.
func (k EvmBankKeeper) SendCoinsFromAccountToModule(ctx sdk.Context, senderAddr sdk.AccAddress, recipientModule string, amt sdk.Coins) error {
umage, amageNeeded, err := SplitAmageCoins(amt)
if err != nil {
return err
}
if umage.IsPositive() {
if err := k.bk.SendCoinsFromAccountToModule(ctx, senderAddr, recipientModule, sdk.NewCoins(umage)); err != nil {
return err
}
}
if err := k.ConvertOneUmageToAmageIfNeeded(ctx, senderAddr, amageNeeded); err != nil {
return err
}
recipientAddr := k.GetModuleAddress(recipientModule)
if err := k.amageKeeper.SendBalance(ctx, senderAddr, recipientAddr, amageNeeded); err != nil {
return err
}
return k.ConvertAmageToUmage(ctx, recipientAddr)
}
// MintCoins mints amage coins by minting the equivalent umage coins and any remaining amage coins.
// It will panic if the module account does not exist or is unauthorized.
func (k EvmBankKeeper) MintCoins(ctx sdk.Context, moduleName string, amt sdk.Coins) error {
umage, amage, err := SplitAmageCoins(amt)
if err != nil {
return err
}
if umage.IsPositive() {
if err := k.bk.MintCoins(ctx, moduleName, sdk.NewCoins(umage)); err != nil {
return err
}
}
recipientAddr := k.GetModuleAddress(moduleName)
if err := k.amageKeeper.AddBalance(ctx, recipientAddr, amage); err != nil {
return err
}
return k.ConvertAmageToUmage(ctx, recipientAddr)
}
// BurnCoins burns amage coins by burning the equivalent umage coins and any remaining amage coins.
// It will panic if the module account does not exist or is unauthorized.
func (k EvmBankKeeper) BurnCoins(ctx sdk.Context, moduleName string, amt sdk.Coins) error {
umage, amage, err := SplitAmageCoins(amt)
if err != nil {
return err
}
if umage.IsPositive() {
if err := k.bk.BurnCoins(ctx, moduleName, sdk.NewCoins(umage)); err != nil {
return err
}
}
moduleAddr := k.GetModuleAddress(moduleName)
if err := k.ConvertOneUmageToAmageIfNeeded(ctx, moduleAddr, amage); err != nil {
return err
}
return k.amageKeeper.RemoveBalance(ctx, moduleAddr, amage)
}
// ConvertOneUmageToAmageIfNeeded converts 1 umage to amage for an address if
// its amage balance is smaller than the amageNeeded amount.
func (k EvmBankKeeper) ConvertOneUmageToAmageIfNeeded(ctx sdk.Context, addr sdk.AccAddress, amageNeeded sdk.Int) error {
amageBal := k.amageKeeper.GetBalance(ctx, addr)
if amageBal.GTE(amageNeeded) {
return nil
}
umageToStore := sdk.NewCoins(sdk.NewCoin(CosmosDenom, sdk.OneInt()))
if err := k.bk.SendCoinsFromAccountToModule(ctx, addr, types.ModuleName, umageToStore); err != nil {
return err
}
// add 1umage equivalent of amage to addr
amageToReceive := ConversionMultiplier
if err := k.amageKeeper.AddBalance(ctx, addr, amageToReceive); err != nil {
return err
}
return nil
}
// ConvertAmageToUmage converts all available amage to umage for a given AccAddress.
func (k EvmBankKeeper) ConvertAmageToUmage(ctx sdk.Context, addr sdk.AccAddress) error {
totalAmage := k.amageKeeper.GetBalance(ctx, addr)
umage, _, err := SplitAmageCoins(sdk.NewCoins(sdk.NewCoin(EvmDenom, totalAmage)))
if err != nil {
return err
}
// do nothing if account does not have enough amage for a single umage
umageToReceive := umage.Amount
if !umageToReceive.IsPositive() {
return nil
}
// remove amage used for converting to umage
amageToBurn := umageToReceive.Mul(ConversionMultiplier)
finalBal := totalAmage.Sub(amageToBurn)
if err := k.amageKeeper.SetBalance(ctx, addr, finalBal); err != nil {
return err
}
fromAddr := k.GetModuleAddress(types.ModuleName)
if err := k.bk.SendCoins(ctx, fromAddr, addr, sdk.NewCoins(umage)); err != nil {
return err
}
return nil
}
func (k EvmBankKeeper) GetModuleAddress(moduleName string) sdk.AccAddress {
addr := k.ak.GetModuleAddress(moduleName)
if addr == nil {
panic(sdkerrors.Wrapf(sdkerrors.ErrUnknownAddress, "module account %s does not exist", moduleName))
}
return addr
}
// SplitAmageCoins splits amage coins to the equivalent umage coins and any remaining amage balance.
// An error will be returned if the coins are not valid or if the coins are not the amage denom.
func SplitAmageCoins(coins sdk.Coins) (sdk.Coin, sdk.Int, error) {
amage := sdk.ZeroInt()
umage := sdk.NewCoin(CosmosDenom, sdk.ZeroInt())
if len(coins) == 0 {
return umage, amage, nil
}
if err := ValidateEvmCoins(coins); err != nil {
return umage, amage, err
}
// note: we should always have len(coins) == 1 here since coins cannot have dup denoms after we validate.
coin := coins[0]
remainingBalance := coin.Amount.Mod(ConversionMultiplier)
if remainingBalance.IsPositive() {
amage = remainingBalance
}
umageAmount := coin.Amount.Quo(ConversionMultiplier)
if umageAmount.IsPositive() {
umage = sdk.NewCoin(CosmosDenom, umageAmount)
}
return umage, amage, nil
}
// ValidateEvmCoins validates the coins from evm is valid and is the EvmDenom (amage).
func ValidateEvmCoins(coins sdk.Coins) error {
if len(coins) == 0 {
return nil
}
// validate that coins are non-negative, sorted, and no dup denoms
if err := coins.Validate(); err != nil {
return sdkerrors.Wrap(sdkerrors.ErrInvalidCoins, coins.String())
}
// validate that coin denom is amage
if len(coins) != 1 || coins[0].Denom != EvmDenom {
errMsg := fmt.Sprintf("invalid evm coin denom, only %s is supported", EvmDenom)
return sdkerrors.Wrap(sdkerrors.ErrInvalidCoins, errMsg)
}
return nil
}