-
Notifications
You must be signed in to change notification settings - Fork 104
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor(ecocredit/basket): wire core submodule into baskets (#935)
* wip: baskets integration * feat: integrate core module into baskets * chore: fmt * fix: add credit type check * chore: go fmt * chore: fix comment * chore: remove regex call * chore: imports, fmt * chore: comment out sims temporarily * chore: address review * chore: comment correct sim call and add todo comment * Update proto/regen/ecocredit/v1/types.proto Co-authored-by: Ryan Christoffersen <12519942+ryanchristo@users.noreply.github.com> * chore: use full batch denoms * gomock.Any() -> gmAny * chore: Save -> Update * chore: proto-gen * fix: put acceptance tests * chore: move batch balance util functions to core utils Co-authored-by: technicallyty <48813565+tytech3@users.noreply.github.com> Co-authored-by: Ryan Christoffersen <12519942+ryanchristo@users.noreply.github.com>
- Loading branch information
3 people
authored
Mar 31, 2022
1 parent
29c8666
commit f39b517
Showing
18 changed files
with
1,456 additions
and
1,360 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,209 @@ | ||
| package core | ||
|
|
||
| import ( | ||
| "regexp" | ||
|
|
||
| "github.com/regen-network/regen-ledger/x/ecocredit" | ||
|
|
||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| sdkerrors "github.com/cosmos/cosmos-sdk/types/errors" | ||
| paramtypes "github.com/cosmos/cosmos-sdk/x/params/types" | ||
| ) | ||
|
|
||
| var ( | ||
| // This is a value of 20 REGEN | ||
| DefaultCreditClassFeeTokens = sdk.NewInt(2e7) | ||
| DefaultBasketCreationFee = sdk.NewInt(2e7) | ||
| KeyCreditClassFee = []byte("CreditClassFee") | ||
| KeyAllowedClassCreators = []byte("AllowedClassCreators") | ||
| KeyAllowlistEnabled = []byte("AllowlistEnabled") | ||
| KeyCreditTypes = []byte("CreditTypes") | ||
| KeyBasketCreationFee = []byte("BasketCreationFee") | ||
| ) | ||
|
|
||
| // TODO: remove after we open governance changes for precision | ||
|
|
||
| const ( | ||
| PRECISION uint32 = 6 | ||
| ) | ||
|
|
||
| // ParamKeyTable returns the parameter key table. | ||
| func ParamKeyTable() paramtypes.KeyTable { | ||
| return paramtypes.NewKeyTable().RegisterParamSet(&Params{}) | ||
| } | ||
|
|
||
| func (p *Params) ParamSetPairs() paramtypes.ParamSetPairs { | ||
| return paramtypes.ParamSetPairs{ | ||
| paramtypes.NewParamSetPair(KeyCreditClassFee, &p.CreditClassFee, validateCreditClassFee), | ||
| paramtypes.NewParamSetPair(KeyAllowedClassCreators, &p.AllowedClassCreators, validateAllowedClassCreators), | ||
| paramtypes.NewParamSetPair(KeyAllowlistEnabled, &p.AllowlistEnabled, validateAllowlistEnabled), | ||
| paramtypes.NewParamSetPair(KeyCreditTypes, &p.CreditTypes, validateCreditTypes), | ||
| paramtypes.NewParamSetPair(KeyBasketCreationFee, &p.BasketFee, validateBasketCreationFee), | ||
| } | ||
| } | ||
|
|
||
| // Validate will run each param field's validate method | ||
| func (p Params) Validate() error { | ||
| if err := validateCreditTypes(p.CreditTypes); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if err := validateAllowedClassCreators(p.AllowedClassCreators); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if err := validateAllowlistEnabled(p.AllowlistEnabled); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if err := validateCreditClassFee(p.CreditClassFee); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if err := validateBasketCreationFee(p.BasketFee); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func validateCreditClassFee(i interface{}) error { | ||
| v, ok := i.(sdk.Coins) | ||
| if !ok { | ||
| return sdkerrors.ErrInvalidType.Wrapf("invalid parameter type: %T", i) | ||
| } | ||
|
|
||
| if err := v.Validate(); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func validateAllowedClassCreators(i interface{}) error { | ||
| v, ok := i.([]string) | ||
| if !ok { | ||
| return sdkerrors.ErrInvalidType.Wrapf("invalid parameter type: %T", i) | ||
| } | ||
| for _, sAddr := range v { | ||
| _, err := sdk.AccAddressFromBech32(sAddr) | ||
| if err != nil { | ||
| return sdkerrors.ErrInvalidAddress.Wrapf("invalid creator address: %s", err.Error()) | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func validateAllowlistEnabled(i interface{}) error { | ||
| _, ok := i.(bool) | ||
| if !ok { | ||
| return sdkerrors.ErrInvalidType.Wrapf("invalid parameter type: %T", i) | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func validateCreditTypes(i interface{}) error { | ||
| creditTypes, ok := i.([]*CreditType) | ||
| if !ok { | ||
| return sdkerrors.ErrInvalidType.Wrapf("invalid parameter type: %T", i) | ||
| } | ||
|
|
||
| // ensure no duplicate credit types or abbreviations and that all | ||
| // precisions conform to hardcoded PRECISION above | ||
| seenTypes := make(map[string]bool) | ||
| seenAbbrs := make(map[string]bool) | ||
| for _, creditType := range creditTypes { | ||
| // Validate name | ||
| T := ecocredit.NormalizeCreditTypeName(creditType.Name) | ||
| if T != creditType.Name { | ||
| return sdkerrors.ErrInvalidRequest.Wrapf("credit type name should be normalized: got %s, should be %s", creditType.Name, T) | ||
| } | ||
| if creditType.Name == "" { | ||
| return sdkerrors.ErrInvalidRequest.Wrap("empty credit type name") | ||
| } | ||
| if seenTypes[T] { | ||
| return sdkerrors.ErrInvalidRequest.Wrapf("duplicate credit type name in request: %s", T) | ||
| } | ||
|
|
||
| // Validate abbreviation | ||
| abbr := creditType.Abbreviation | ||
| err := ValidateCreditTypeAbbreviation(abbr) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| if seenAbbrs[abbr] { | ||
| return sdkerrors.ErrInvalidRequest.Wrapf("duplicate credit type abbreviation: %s", abbr) | ||
| } | ||
|
|
||
| // Validate precision | ||
| // TODO: remove after we open governance changes for precision | ||
| if creditType.Precision != PRECISION { | ||
| return sdkerrors.ErrInvalidRequest.Wrapf("invalid precision %d: precision is currently locked to %d", creditType.Precision, PRECISION) | ||
| } | ||
|
|
||
| // Validate units | ||
| if creditType.Unit == "" { | ||
| return sdkerrors.ErrInvalidRequest.Wrap("empty credit type unit") | ||
| } | ||
|
|
||
| // Mark type and abbr as seen | ||
| seenTypes[T] = true | ||
| seenAbbrs[abbr] = true | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| // Check that CreditType abbreviation is valid, i.e. it consists of 1-3 | ||
| // uppercase letters | ||
| func ValidateCreditTypeAbbreviation(abbr string) error { | ||
| reAbbr := regexp.MustCompile(`^[A-Z]{1,3}$`) | ||
| matches := reAbbr.FindStringSubmatch(abbr) | ||
| if matches == nil { | ||
| return sdkerrors.ErrInvalidRequest.Wrapf("credit type abbreviation must be 1-3 uppercase latin letters: got %s", abbr) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func validateBasketCreationFee(i interface{}) error { | ||
| v, ok := i.(sdk.Coins) | ||
| if !ok { | ||
| return sdkerrors.ErrInvalidType.Wrapf("invalid parameter type: %T", i) | ||
| } | ||
|
|
||
| if err := v.Validate(); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| // NewParams creates a new Params object. | ||
| func NewParams(creditClassFee, basketCreationFee sdk.Coins, allowlist []string, allowlistEnabled bool, creditTypes []*CreditType) Params { | ||
| return Params{ | ||
| CreditClassFee: creditClassFee, | ||
| AllowedClassCreators: allowlist, | ||
| AllowlistEnabled: allowlistEnabled, | ||
| CreditTypes: creditTypes, | ||
| BasketFee: basketCreationFee, | ||
| } | ||
| } | ||
|
|
||
| // DefaultParams returns a default set of parameters. | ||
| func DefaultParams() Params { | ||
| return NewParams( | ||
| sdk.NewCoins(sdk.NewCoin(sdk.DefaultBondDenom, DefaultCreditClassFeeTokens)), | ||
| sdk.NewCoins(sdk.NewCoin(sdk.DefaultBondDenom, DefaultBasketCreationFee)), | ||
| []string{}, | ||
| false, | ||
| []*CreditType{ | ||
| { | ||
| Name: "carbon", | ||
| Abbreviation: "C", | ||
| Unit: "metric ton CO2 equivalent", | ||
| Precision: PRECISION, | ||
| }, | ||
| }, | ||
| ) | ||
| } |
Oops, something went wrong.