chore(types): deprecate acc address stringer (#21435)

Co-authored-by: Julián Toledano <JulianToledano@users.noreply.github.com>
This commit is contained in:
Julien Robert
2024-08-28 09:04:44 +00:00
committed by GitHub
co-authored by Julián Toledano
parent 01abf4fbf9
commit 39b61a3102
4 changed files with 23 additions and 13 deletions
+9
View File
@@ -149,6 +149,7 @@ type Address interface {
Marshal() ([]byte, error)
MarshalJSON() ([]byte, error)
Bytes() []byte
// Deprecated: Use an address.Codec to convert addresses from and to string/bytes.
String() string
Format(s fmt.State, verb rune)
}
@@ -179,6 +180,7 @@ func AccAddressFromHexUnsafe(address string) (addr AccAddress, err error) {
}
// MustAccAddressFromBech32 calls AccAddressFromBech32 and panics on error.
// Deprecated: Use an address.Codec to convert addresses from and to string/bytes.
func MustAccAddressFromBech32(address string) AccAddress {
addr, err := AccAddressFromBech32(address)
if err != nil {
@@ -189,6 +191,7 @@ func MustAccAddressFromBech32(address string) AccAddress {
}
// AccAddressFromBech32 creates an AccAddress from a Bech32 string.
// Deprecated: Use an address.Codec to convert addresses from and to string/bytes.
func AccAddressFromBech32(address string) (addr AccAddress, err error) {
bech32PrefixAccAddr := GetConfig().GetBech32AccountAddrPrefix()
@@ -281,6 +284,7 @@ func (aa AccAddress) Bytes() []byte {
}
// String implements the Stringer interface.
// Deprecated: Use an address.Codec to convert addresses from and to string/bytes.
func (aa AccAddress) String() string {
if aa.Empty() {
return ""
@@ -328,6 +332,7 @@ func ValAddressFromHex(address string) (addr ValAddress, err error) {
}
// ValAddressFromBech32 creates a ValAddress from a Bech32 string.
// Deprecated: Use an address.Codec to convert addresses from and to string/bytes.
func ValAddressFromBech32(address string) (addr ValAddress, err error) {
bech32PrefixValAddr := GetConfig().GetBech32ValidatorAddrPrefix()
@@ -336,6 +341,7 @@ func ValAddressFromBech32(address string) (addr ValAddress, err error) {
}
// MustValAddressFromBech32 calls ValAddressFromBech32 and panics on error.
// Deprecated: Use an address.Codec to convert addresses from and to string/bytes.
func MustValAddressFromBech32(address string) ValAddress {
addr, err := ValAddressFromBech32(address)
if err != nil {
@@ -432,6 +438,7 @@ func (va ValAddress) Bytes() []byte {
}
// String implements the Stringer interface.
// Deprecated: Use an address.Codec to convert addresses from and to string/bytes.
func (va ValAddress) String() string {
if va.Empty() {
return ""
@@ -480,6 +487,7 @@ func ConsAddressFromHex(address string) (addr ConsAddress, err error) {
}
// ConsAddressFromBech32 creates a ConsAddress from a Bech32 string.
// Deprecated: Use an address.Codec to convert addresses from and to string/bytes.
func ConsAddressFromBech32(address string) (addr ConsAddress, err error) {
bech32PrefixConsAddr := GetConfig().GetBech32ConsensusAddrPrefix()
@@ -579,6 +587,7 @@ func (ca ConsAddress) Bytes() []byte {
}
// String implements the Stringer interface.
// Deprecated: Use an address.Codec to convert addresses from and to string/bytes.
func (ca ConsAddress) String() string {
if ca.Empty() {
return ""
+9 -8
View File
@@ -10,8 +10,16 @@ import (
// DefaultKeyringServiceName defines a default service name for the keyring.
const DefaultKeyringServiceName = "cosmos"
func KeyringServiceName() string {
if len(version.Name) == 0 {
return DefaultKeyringServiceName
}
return version.Name
}
// Config is the structure that holds the SDK configuration parameters.
// This could be used to initialize certain configuration parameters for the SDK.
// Deprecated: The global SDK config is deprecated and users should prefer using an address codec.
// Users must still set the global config until the Stringer interface on `AccAddress`, `ValAddress`, and `ConsAddress` is removed.
type Config struct {
bech32AddressPrefix map[string]string
mtx sync.RWMutex
@@ -140,10 +148,3 @@ func (config *Config) GetBech32ValidatorPubPrefix() string {
func (config *Config) GetBech32ConsensusPubPrefix() string {
return config.bech32AddressPrefix["consensus_pub"]
}
func KeyringServiceName() string {
if len(version.Name) == 0 {
return DefaultKeyringServiceName
}
return version.Name
}