Refactor global sdk.Config

[aaronc]

Summary

Remove global bech32 prefixes and the rest of the global config before v1.0 (see #7421).

Problem Definition

Global config variables are generally a bad design decision. And in interchain world having more flexibility around bech32 prefixes is probably desirable.

If we are targeting a v1.0 release at some point, we likely want to remove the global Config and do something better that allows us to keep the core SDK minimal, well-designed and the other parts modular.

#7242 likely brings us closer to being able to do this because address parsing is now happening inside handlers rather than at the encoding level.

Proposal

• Remove bech32 EPIC: Remove bech32 globals #9690 / EPIC: remove global bech32 #13140
• Remove sdk.Config

See initial proposal

In #7242, addresses are now parsed manually using sdk.AccAddressFromBech32, etc. Instead we can either pass the parameters into keepers (like we do for codecs) or attach them to sdk.Context and maybe decode address using ctx.AccAddressFromBech32 in keepers and handlers.

Also we may consider removing ValAddress and ConsAddress from types/ as they are specific to x/staking.

---

For Admin Use

• Not duplicate issue
• Appropriate labels applied
• Appropriate contributors tagged
• Contributor assigned/self-assigned

[alexanderbez]

ACK

[jazg]

@aaronc @alexanderbez Do we have an ETA for this? Our project currently only supports Terra so it's not a major problem (we just set the prefix for the global config on boot), but it would cause issues (e.g. concurrent map read/write panics) if we choose to support more Cosmos-compatible chains in the future.

[alexanderbez]

Not sure on timelines here, but we're welcome to reviewing PRs if you believe you have a good understanding of the proposed solution.

[clevinson]

Blocked on #9293

[tac0turtle]

is this done @JulianToledano

[JulianToledano]

is this done @JulianToledano

nope, we need to deprecate the address string method and then remove it from the sdk. Since those make use of the global config.

cosmos-sdk/types/address.go

Line 300 in 38c1d6a

return cacheBech32Addr(GetConfig().GetBech32AccountAddrPrefix(), aa, accAddrCache, key)

[julienrbrt]

Is this completed @JulianToledano ?

[JulianToledano]

Is this completed @JulianToledano ?

Nope, most of the calls have been removed but there're still some that may need some refactors. For example there are a lot of ValidateBasic() that relies on the String() method.

For example govs MsgExecLegacyContent

cosmos-sdk/x/gov/types/v1/msgs.go

Lines 114 to 122 in eeeb5b8

	// ValidateBasic implements the sdk.Msg interface.
	func (c MsgExecLegacyContent) ValidateBasic() error {
	_, err := sdk.AccAddressFromBech32(c.Authority)
	if err != nil {
	return err
	}
	return nil
	}

but there are more such as banks Balance and Input, evidence MsgSubmitEvidence plus some group messages.
The string method also makes it as key in some collections.

cosmos-sdk/types/collections.go

Lines 17 to 32 in eeeb5b8

	AccAddressKey collcodec.KeyCodec[AccAddress] = genericAddressKey[AccAddress]{
	stringDecoder: AccAddressFromBech32,
	keyType: "sdk.AccAddress",
	}
	// ValAddressKey follows the same semantics as AccAddressKey.
	ValAddressKey collcodec.KeyCodec[ValAddress] = genericAddressKey[ValAddress]{
	stringDecoder: ValAddressFromBech32,
	keyType: "sdk.ValAddress",
	}
	// ConsAddressKey follows the same semantics as ConsAddressKey.
	ConsAddressKey collcodec.KeyCodec[ConsAddress] = genericAddressKey[ConsAddress]{
	stringDecoder: ConsAddressFromBech32,
	keyType: "sdk.ConsAddress",
	}

Furthermore all addresses unmarshall methods relies on the String method:

cosmos-sdk/types/address.go

Lines 234 to 258 in eeeb5b8

	// MarshalYAML marshals to YAML using Bech32.
	func (aa AccAddress) MarshalYAML() (interface{}, error) {
	return aa.String(), nil
	}
	// UnmarshalJSON unmarshals from JSON assuming Bech32 encoding.
	func (aa *AccAddress) UnmarshalJSON(data []byte) error {
	var s string
	err := json.Unmarshal(data, &s)
	if err != nil {
	return err
	}
	if s == "" {
	*aa = AccAddress{}
	return nil
	}
	aa2, err := AccAddressFromBech32(s)
	if err != nil {
	return err
	}
	*aa = aa2
	return nil
	}

[tac0turtle]

reopen if not completed

[julienrbrt]

Is this completed @JulianToledano ?

Nope, most of the calls have been removed but there're still some that may need some refactors. For example there are a lot of ValidateBasic() that relies on the String() method.

For example govs MsgExecLegacyContent

cosmos-sdk/x/gov/types/v1/msgs.go

Lines 114 to 122 in eeeb5b8

// ValidateBasic implements the sdk.Msg interface.
func (c MsgExecLegacyContent) ValidateBasic() error {
_, err := sdk.AccAddressFromBech32(c.Authority)
if err != nil {
return err
}

return nil
}
but there are more such as banks Balance and Input, evidence MsgSubmitEvidence plus some group messages. The string method also makes it as key in some collections.

cosmos-sdk/types/collections.go

Lines 17 to 32 in eeeb5b8

AccAddressKey collcodec.KeyCodec[AccAddress] = genericAddressKey[AccAddress]{
stringDecoder: AccAddressFromBech32,
keyType: "sdk.AccAddress",
}

// ValAddressKey follows the same semantics as AccAddressKey.
ValAddressKey collcodec.KeyCodec[ValAddress] = genericAddressKey[ValAddress]{
stringDecoder: ValAddressFromBech32,
keyType: "sdk.ValAddress",
}

// ConsAddressKey follows the same semantics as ConsAddressKey.
ConsAddressKey collcodec.KeyCodec[ConsAddress] = genericAddressKey[ConsAddress]{
stringDecoder: ConsAddressFromBech32,
keyType: "sdk.ConsAddress",
}

Furthermore all addresses unmarshall methods relies on the String method:
cosmos-sdk/types/address.go

Lines 234 to 258 in eeeb5b8

// MarshalYAML marshals to YAML using Bech32.
func (aa AccAddress) MarshalYAML() (interface{}, error) {
return aa.String(), nil
}

// UnmarshalJSON unmarshals from JSON assuming Bech32 encoding.
func (aa *AccAddress) UnmarshalJSON(data []byte) error {
var s string
err := json.Unmarshal(data, &s)
if err != nil {
return err
}
if s == "" {
*aa = AccAddress{}
return nil
}

aa2, err := AccAddressFromBech32(s)
if err != nil {
return err
}

*aa = aa2
return nil
}

We won't be able to change most of those, I think without breaking too much

[JulianToledano]

Is this completed @JulianToledano ?

Nope, most of the calls have been removed but there're still some that may need some refactors. For example there are a lot of ValidateBasic() that relies on the String() method.
For example govs MsgExecLegacyContent
cosmos-sdk/x/gov/types/v1/msgs.go
Lines 114 to 122 in eeeb5b8
// ValidateBasic implements the sdk.Msg interface.
func (c MsgExecLegacyContent) ValidateBasic() error {
_, err := sdk.AccAddressFromBech32(c.Authority)
if err != nil {
return err
}
return nil
}
but there are more such as banks Balance and Input, evidence MsgSubmitEvidence plus some group messages. The string method also makes it as key in some collections.
cosmos-sdk/types/collections.go
Lines 17 to 32 in eeeb5b8
AccAddressKey collcodec.KeyCodec[AccAddress] = genericAddressKey[AccAddress]{
stringDecoder: AccAddressFromBech32,
keyType: "sdk.AccAddress",
}
// ValAddressKey follows the same semantics as AccAddressKey.
ValAddressKey collcodec.KeyCodec[ValAddress] = genericAddressKey[ValAddress]{
stringDecoder: ValAddressFromBech32,
keyType: "sdk.ValAddress",
}
// ConsAddressKey follows the same semantics as ConsAddressKey.
ConsAddressKey collcodec.KeyCodec[ConsAddress] = genericAddressKey[ConsAddress]{
stringDecoder: ConsAddressFromBech32,
keyType: "sdk.ConsAddress",
}
Furthermore all addresses unmarshall methods relies on the String method:
cosmos-sdk/types/address.go
Lines 234 to 258 in eeeb5b8
// MarshalYAML marshals to YAML using Bech32.
func (aa AccAddress) MarshalYAML() (interface{}, error) {
return aa.String(), nil
}
// UnmarshalJSON unmarshals from JSON assuming Bech32 encoding.
func (aa *AccAddress) UnmarshalJSON(data []byte) error {
var s string
err := json.Unmarshal(data, &s)
if err != nil {
return err
}
if s == "" {
*aa = AccAddress{}
return nil
}
aa2, err := AccAddressFromBech32(s)
if err != nil {
return err
}
*aa = aa2
return nil
}

We won't be able to change most of those, I think without breaking too much

Yeah, main problem is the string method depends on the global config 😢