package types import ( "github.com/gogo/protobuf/proto" sdkerrors "github.com/cosmos/cosmos-sdk/types/errors" ) type Any struct { // A URL/resource name that uniquely identifies the type of the serialized // protocol buffer message. This string must contain at least // one "/" character. The last segment of the URL's path must represent // the fully qualified name of the type (as in // `path/google.protobuf.Duration`). The name should be in a canonical form // (e.g., leading "." is not accepted). // // In practice, teams usually precompile into the binary all types that they // expect it to use in the context of Any. However, for URLs which use the // scheme `http`, `https`, or no scheme, one can optionally set up a type // server that maps type URLs to message definitions as follows: // // * If no scheme is provided, `https` is assumed. // * An HTTP GET on the URL must yield a [google.protobuf.Type][] // value in binary format, or produce an error. // * Applications are allowed to cache lookup results based on the // URL, or have them precompiled into a binary to avoid any // lookup. Therefore, binary compatibility needs to be preserved // on changes to types. (Use versioned type names to manage // breaking changes.) // // Note: this functionality is not currently available in the official // protobuf release, and it is not used for type URLs beginning with // type.googleapis.com. // // Schemes other than `http`, `https` (or the empty scheme) might be // used with implementation specific semantics. // nolint TypeUrl string `protobuf:"bytes,1,opt,name=type_url,json=typeUrl,proto3" json:"type_url,omitempty"` // Must be a valid serialized protocol buffer of the above specified type. Value []byte `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` // nolint XXX_NoUnkeyedLiteral struct{} `json:"-"` // nolint XXX_unrecognized []byte `json:"-"` // nolint XXX_sizecache int32 `json:"-"` cachedValue interface{} compat *anyCompat } // NewAnyWithValue constructs a new Any packed with the value provided or // returns an error if that value couldn't be packed. This also caches // the packed value so that it can be retrieved from GetCachedValue without // unmarshaling func NewAnyWithValue(value proto.Message) (*Any, error) { any := &Any{} err := any.Pack(value) if err != nil { return nil, err } return any, nil } // NewAnyWithCustomTypeURL same as NewAnyWithValue, but sets a custom type url, instead // using the one from proto.Message. // NOTE: This functions should be only used for types with additional logic bundled // into the protobuf Any serialization. For simple marshaling you should use NewAnyWithValue. func NewAnyWithCustomTypeURL(v proto.Message, typeURL string) (*Any, error) { bz, err := proto.Marshal(v) return &Any{ TypeUrl: typeURL, Value: bz, cachedValue: v, }, err } // Pack packs the value x in the Any or returns an error. This also caches // the packed value so that it can be retrieved from GetCachedValue without // unmarshaling func (any *Any) Pack(x proto.Message) error { any.TypeUrl = "/" + proto.MessageName(x) bz, err := proto.Marshal(x) if err != nil { return err } any.Value = bz any.cachedValue = x return nil } // UnsafePackAny packs the value x in the Any and instead of returning the error // in the case of a packing failure, keeps the cached value. This should only // be used in situations where compatibility is needed with amino. Amino-only // values can safely be packed using this method when they will only be // marshaled with amino and not protobuf. func UnsafePackAny(x interface{}) *Any { if msg, ok := x.(proto.Message); ok { any, err := NewAnyWithValue(msg) if err == nil { return any } } return &Any{cachedValue: x} } // PackAny is a checked and safe version of UnsafePackAny. It assures that // `x` implements the proto.Message interface and uses it to serialize `x`. // [DEPRECATED]: should be moved away: https://github.com/cosmos/cosmos-sdk/issues/7479 func PackAny(x interface{}) (*Any, error) { if x == nil { return nil, nil } if intoany, ok := x.(IntoAny); ok { return intoany.AsAny(), nil } protoMsg, ok := x.(proto.Message) if !ok { return nil, sdkerrors.Wrapf(sdkerrors.ErrInvalidType, "Expecting %T to implement proto.Message", x) } return NewAnyWithValue(protoMsg) } // GetCachedValue returns the cached value from the Any if present func (any *Any) GetCachedValue() interface{} { return any.cachedValue } // ClearCachedValue clears the cached value from the Any func (any *Any) ClearCachedValue() { any.cachedValue = nil } // IntoAny represents a type that can be wrapped into an Any. type IntoAny interface { AsAny() *Any }