-
Notifications
You must be signed in to change notification settings - Fork 838
/
proposal.go
218 lines (178 loc) · 7.3 KB
/
proposal.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
package types
import (
"fmt"
"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"
govtypes "github.com/cosmos/cosmos-sdk/x/gov/types"
ibctransfertypes "github.com/cosmos/ibc-go/v3/modules/apps/transfer/types"
"github.com/ethereum/go-ethereum/common"
ethermint "github.com/tharsis/ethermint/types"
)
// constants
const (
ProposalTypeRegisterCoin string = "RegisterCoin"
ProposalTypeRegisterERC20 string = "RegisterERC20"
ProposalTypeToggleTokenRelay string = "ToggleTokenRelay" // #nosec
ProposalTypeUpdateTokenPairERC20 string = "UpdateTokenPairERC20"
)
// Implements Proposal Interface
var (
_ govtypes.Content = &RegisterCoinProposal{}
_ govtypes.Content = &RegisterERC20Proposal{}
_ govtypes.Content = &ToggleTokenRelayProposal{}
_ govtypes.Content = &UpdateTokenPairERC20Proposal{}
)
func init() {
govtypes.RegisterProposalType(ProposalTypeRegisterCoin)
govtypes.RegisterProposalType(ProposalTypeRegisterERC20)
govtypes.RegisterProposalType(ProposalTypeToggleTokenRelay)
govtypes.RegisterProposalType(ProposalTypeUpdateTokenPairERC20)
govtypes.RegisterProposalTypeCodec(&RegisterCoinProposal{}, "erc20/RegisterCoinProposal")
govtypes.RegisterProposalTypeCodec(&RegisterERC20Proposal{}, "erc20/RegisterERC20Proposal")
govtypes.RegisterProposalTypeCodec(&ToggleTokenRelayProposal{}, "erc20/ToggleTokenRelayProposal")
govtypes.RegisterProposalTypeCodec(&UpdateTokenPairERC20Proposal{}, "erc20/UpdateTokenPairERC20Proposal")
}
// CreateDenomDescription generates a string with the coin description
func CreateDenomDescription(address string) string {
return fmt.Sprintf("Cosmos coin token representation of %s", address)
}
// CreateDenom generates a string the module name plus the address to avoid conflicts with names staring with a number
func CreateDenom(address string) string {
return fmt.Sprintf("%s/%s", ModuleName, address)
}
// NewRegisterCoinProposal returns new instance of RegisterCoinProposal
func NewRegisterCoinProposal(title, description string, coinMetadata banktypes.Metadata) govtypes.Content {
return &RegisterCoinProposal{
Title: title,
Description: description,
Metadata: coinMetadata,
}
}
// ProposalRoute returns router key for this proposal
func (*RegisterCoinProposal) ProposalRoute() string { return RouterKey }
// ProposalType returns proposal type for this proposal
func (*RegisterCoinProposal) ProposalType() string {
return ProposalTypeRegisterCoin
}
// ValidateBasic performs a stateless check of the proposal fields
func (rtbp *RegisterCoinProposal) ValidateBasic() error {
if err := rtbp.Metadata.Validate(); err != nil {
return err
}
if err := ibctransfertypes.ValidateIBCDenom(rtbp.Metadata.Base); err != nil {
return err
}
if err := validateIBC(rtbp.Metadata); err != nil {
return err
}
return govtypes.ValidateAbstract(rtbp)
}
func validateIBC(metadata banktypes.Metadata) error {
// Check ibc/ denom
denomSplit := strings.SplitN(metadata.Base, "/", 2)
if denomSplit[0] == metadata.Base && strings.TrimSpace(metadata.Base) != "" {
// Not IBC
return nil
}
if len(denomSplit) != 2 || denomSplit[0] != ibctransfertypes.DenomPrefix {
// NOTE: should be unaccessible (covered on ValidateIBCDenom)
return fmt.Errorf("invalid metadata. %s denomination should be prefixed with the format 'ibc/", metadata.Base)
}
if !strings.Contains(metadata.Name, "channel-") {
return fmt.Errorf("invalid metadata (Name) for ibc. %s should include channel", metadata.Name)
}
if !strings.HasPrefix(metadata.Symbol, "ibc") {
return fmt.Errorf("invalid metadata (Symbol) for ibc. %s should include \"ibc\" prefix", metadata.Symbol)
}
return nil
}
// ValidateErc20Denom checks if a denom is a valid erc20/
// denomination
func ValidateErc20Denom(denom string) error {
denomSplit := strings.SplitN(denom, "/", 2)
if len(denomSplit) != 2 || denomSplit[0] != ModuleName {
return fmt.Errorf("invalid denom. %s denomination should be prefixed with the format 'erc20/", denom)
}
return ethermint.ValidateAddress(denomSplit[1])
}
// NewRegisterERC20Proposal returns new instance of RegisterERC20Proposal
func NewRegisterERC20Proposal(title, description, erc20Addr string) govtypes.Content {
return &RegisterERC20Proposal{
Title: title,
Description: description,
Erc20Address: erc20Addr,
}
}
// ProposalRoute returns router key for this proposal
func (*RegisterERC20Proposal) ProposalRoute() string { return RouterKey }
// ProposalType returns proposal type for this proposal
func (*RegisterERC20Proposal) ProposalType() string {
return ProposalTypeRegisterERC20
}
// ValidateBasic performs a stateless check of the proposal fields
func (rtbp *RegisterERC20Proposal) ValidateBasic() error {
if err := ethermint.ValidateAddress(rtbp.Erc20Address); err != nil {
return sdkerrors.Wrap(err, "ERC20 address")
}
return govtypes.ValidateAbstract(rtbp)
}
// NewToggleTokenRelayProposal returns new instance of ToggleTokenRelayProposal
func NewToggleTokenRelayProposal(title, description string, token string) govtypes.Content {
return &ToggleTokenRelayProposal{
Title: title,
Description: description,
Token: token,
}
}
// ProposalRoute returns router key for this proposal
func (*ToggleTokenRelayProposal) ProposalRoute() string { return RouterKey }
// ProposalType returns proposal type for this proposal
func (*ToggleTokenRelayProposal) ProposalType() string {
return ProposalTypeToggleTokenRelay
}
// ValidateBasic performs a stateless check of the proposal fields
func (etrp *ToggleTokenRelayProposal) ValidateBasic() error {
// check if the token is a hex address, if not, check if it is a valid SDK
// denom
if err := ethermint.ValidateAddress(etrp.Token); err != nil {
if err := sdk.ValidateDenom(etrp.Token); err != nil {
return err
}
}
return govtypes.ValidateAbstract(etrp)
}
// NewUpdateTokenPairERC20Proposal returns new instance of UpdateTokenPairERC20Proposal
func NewUpdateTokenPairERC20Proposal(title, description, erc20Addr, newERC20Addr string) govtypes.Content {
return &UpdateTokenPairERC20Proposal{
Title: title,
Description: description,
Erc20Address: erc20Addr,
NewErc20Address: newERC20Addr,
}
}
// ProposalRoute returns router key for this proposal
func (*UpdateTokenPairERC20Proposal) ProposalRoute() string { return RouterKey }
// ProposalType returns proposal type for this proposal
func (*UpdateTokenPairERC20Proposal) ProposalType() string {
return ProposalTypeUpdateTokenPairERC20
}
// ValidateBasic performs a stateless check of the proposal fields
func (p *UpdateTokenPairERC20Proposal) ValidateBasic() error {
if err := ethermint.ValidateAddress(p.Erc20Address); err != nil {
return sdkerrors.Wrap(err, "ERC20 address")
}
if err := ethermint.ValidateAddress(p.NewErc20Address); err != nil {
return sdkerrors.Wrap(err, "new ERC20 address")
}
return govtypes.ValidateAbstract(p)
}
// GetERC20Address returns the common.Address representation of the ERC20 hex address
func (p UpdateTokenPairERC20Proposal) GetERC20Address() common.Address {
return common.HexToAddress(p.Erc20Address)
}
// GetNewERC20Address returns the common.Address representation of the new ERC20 hex address
func (p UpdateTokenPairERC20Proposal) GetNewERC20Address() common.Address {
return common.HexToAddress(p.NewErc20Address)
}