appv1alpha1

package
v0.0.0-...-a315113 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 20, 2022 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Overview

Code generated by protoc-gen-go-pulsar. DO NOT EDIT.

Code generated by protoc-gen-go-pulsar. DO NOT EDIT.

Code generated by protoc-gen-go-pulsar. DO NOT EDIT.

Index

Constants

This section is empty.

Variables

View Source
var (
	// module indicates that this proto type is a config object for an app module
	// and optionally provides other descriptive information about the module.
	// It is recommended that a new module config object and go module is versioned
	// for every state machine breaking version of a module. The recommended
	// pattern for doing this is to put module config objects in a separate proto
	// package from the API they expose. Ex: the cosmos.group.v1 API would be
	// exposed by module configs cosmos.group.module.v1, cosmos.group.module.v2, etc.
	//
	// optional cosmos.app.v1alpha1.ModuleDescriptor module = 57193479;
	E_Module = &file_cosmos_app_v1alpha1_module_proto_extTypes[0]
)

Extension fields to descriptorpb.MessageOptions.

View Source
var File_cosmos_app_v1alpha1_config_proto protoreflect.FileDescriptor
View Source
var File_cosmos_app_v1alpha1_module_proto protoreflect.FileDescriptor
View Source
var File_cosmos_app_v1alpha1_query_proto protoreflect.FileDescriptor
View Source
var Query_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "cosmos.app.v1alpha1.Query",
	HandlerType: (*QueryServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Config",
			Handler:    _Query_Config_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "cosmos/app/v1alpha1/query.proto",
}

Query_ServiceDesc is the grpc.ServiceDesc for Query service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterQueryServer

func RegisterQueryServer(s grpc.ServiceRegistrar, srv QueryServer)

Types

type Config

type Config struct {

	// modules are the module configurations for the app.
	Modules []*ModuleConfig `protobuf:"bytes,1,rep,name=modules,proto3" json:"modules,omitempty"`
	// contains filtered or unexported fields
}

Config represents the configuration for a Cosmos SDK ABCI app. It is intended that all state machine logic including the version of baseapp and tx handlers (and possibly even Tendermint) that an app needs can be described in a config object. For compatibility, the framework should allow a mixture of declarative and imperative app wiring, however, apps that strive for the maximum ease of maintainability should be able to describe their state machine with a config object alone.

func (*Config) Descriptor deprecated

func (*Config) Descriptor() ([]byte, []int)

Deprecated: Use Config.ProtoReflect.Descriptor instead.

func (*Config) GetModules

func (x *Config) GetModules() []*ModuleConfig

func (*Config) ProtoMessage

func (*Config) ProtoMessage()

func (*Config) ProtoReflect

func (x *Config) ProtoReflect() protoreflect.Message

func (*Config) Reset

func (x *Config) Reset()

func (*Config) String

func (x *Config) String() string

type MigrateFromInfo

type MigrateFromInfo struct {

	// module is the fully-qualified protobuf name of the module config object
	// for the previous module version, ex: "cosmos.group.module.v1.Module".
	Module string `protobuf:"bytes,1,opt,name=module,proto3" json:"module,omitempty"`
	// contains filtered or unexported fields
}

MigrateFromInfo is information on a module version that a newer module can migrate from.

func (*MigrateFromInfo) Descriptor deprecated

func (*MigrateFromInfo) Descriptor() ([]byte, []int)

Deprecated: Use MigrateFromInfo.ProtoReflect.Descriptor instead.

func (*MigrateFromInfo) GetModule

func (x *MigrateFromInfo) GetModule() string

func (*MigrateFromInfo) ProtoMessage

func (*MigrateFromInfo) ProtoMessage()

func (*MigrateFromInfo) ProtoReflect

func (x *MigrateFromInfo) ProtoReflect() protoreflect.Message

func (*MigrateFromInfo) Reset

func (x *MigrateFromInfo) Reset()

func (*MigrateFromInfo) String

func (x *MigrateFromInfo) String() string

type ModuleConfig

type ModuleConfig struct {

	// name is the unique name of the module within the app. It should be a name
	// that persists between different versions of a module so that modules
	// can be smoothly upgraded to new versions.
	//
	// For example, for the module cosmos.bank.module.v1.Module, we may chose
	// to simply name the module "bank" in the app. When we upgrade to
	// cosmos.bank.module.v2.Module, the app-specific name "bank" stays the same
	// and the framework knows that the v2 module should receive all the same state
	// that the v1 module had. Note: modules should provide info on which versions
	// they can migrate from in the ModuleDescriptor.can_migration_from field.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// config is the config object for the module. Module config messages should
	// define a ModuleDescriptor using the cosmos.app.v1alpha1.is_module extension.
	Config *anypb.Any `protobuf:"bytes,2,opt,name=config,proto3" json:"config,omitempty"`
	// contains filtered or unexported fields
}

ModuleConfig is a module configuration for an app.

func (*ModuleConfig) Descriptor deprecated

func (*ModuleConfig) Descriptor() ([]byte, []int)

Deprecated: Use ModuleConfig.ProtoReflect.Descriptor instead.

func (*ModuleConfig) GetConfig

func (x *ModuleConfig) GetConfig() *anypb.Any

func (*ModuleConfig) GetName

func (x *ModuleConfig) GetName() string

func (*ModuleConfig) ProtoMessage

func (*ModuleConfig) ProtoMessage()

func (*ModuleConfig) ProtoReflect

func (x *ModuleConfig) ProtoReflect() protoreflect.Message

func (*ModuleConfig) Reset

func (x *ModuleConfig) Reset()

func (*ModuleConfig) String

func (x *ModuleConfig) String() string

type ModuleDescriptor

type ModuleDescriptor struct {

	// go_import names the package that should be imported by an app to load the
	// module in the runtime module registry. Either go_import must be defined here
	// or the go_package option must be defined at the file level to indicate
	// to users where to location the module implementation. go_import takes
	// precedence over go_package when both are defined.
	GoImport string `protobuf:"bytes,1,opt,name=go_import,json=goImport,proto3" json:"go_import,omitempty"`
	// use_package refers to a protobuf package that this module
	// uses and exposes to the world. In an app, only one module should "use"
	// or own a single protobuf package. It is assumed that the module uses
	// all of the .proto files in a single package.
	UsePackage []*PackageReference `protobuf:"bytes,2,rep,name=use_package,json=usePackage,proto3" json:"use_package,omitempty"`
	// can_migrate_from defines which module versions this module can migrate
	// state from. The framework will check that one module version is able to
	// migrate from a previous module version before attempting to update its
	// config. It is assumed that modules can transitively migrate from earlier
	// versions. For instance if v3 declares it can migrate from v2, and v2
	// declares it can migrate from v1, the framework knows how to migrate
	// from v1 to v3, assuming all 3 module versions are registered at runtime.
	CanMigrateFrom []*MigrateFromInfo `protobuf:"bytes,3,rep,name=can_migrate_from,json=canMigrateFrom,proto3" json:"can_migrate_from,omitempty"`
	// contains filtered or unexported fields
}

ModuleDescriptor describes an app module.

func (*ModuleDescriptor) Descriptor deprecated

func (*ModuleDescriptor) Descriptor() ([]byte, []int)

Deprecated: Use ModuleDescriptor.ProtoReflect.Descriptor instead.

func (*ModuleDescriptor) GetCanMigrateFrom

func (x *ModuleDescriptor) GetCanMigrateFrom() []*MigrateFromInfo

func (*ModuleDescriptor) GetGoImport

func (x *ModuleDescriptor) GetGoImport() string

func (*ModuleDescriptor) GetUsePackage

func (x *ModuleDescriptor) GetUsePackage() []*PackageReference

func (*ModuleDescriptor) ProtoMessage

func (*ModuleDescriptor) ProtoMessage()

func (*ModuleDescriptor) ProtoReflect

func (x *ModuleDescriptor) ProtoReflect() protoreflect.Message

func (*ModuleDescriptor) Reset

func (x *ModuleDescriptor) Reset()

func (*ModuleDescriptor) String

func (x *ModuleDescriptor) String() string

type PackageReference

type PackageReference struct {

	// name is the fully-qualified name of the package.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// revision is the optional revision of the package that is being used.
	// Protobuf packages used in Cosmos should generally have a major version
	// as the last part of the package name, ex. foo.bar.baz.v1.
	// The revision of a package can be thought of as the minor version of a
	// package which has additional backwards compatible definitions that weren't
	// present in a previous version.
	//
	// A package should indicate its revision with a source code comment
	// above the package declaration in one of its fields containing the
	// test "Revision N" where N is an integer revision. All packages start
	// at revision 0 the first time they are released in a module.
	//
	// When a new version of a module is released and items are added to existing
	// .proto files, these definitions should contain comments of the form
	// "Since Revision N" where N is an integer revision.
	//
	// When the module runtime starts up, it will check the pinned proto
	// image and panic if there are runtime protobuf definitions that are not
	// in the pinned descriptor which do not have
	// a "Since Revision N" comment or have a "Since Revision N" comment where
	// N is <= to the revision specified here. This indicates that the protobuf
	// files have been updated, but the pinned file descriptor hasn't.
	//
	// If there are items in the pinned file descriptor with a revision
	// greater than the value indicated here, this will also cause a panic
	// as it may mean that the pinned descriptor for a legacy module has been
	// improperly updated or that there is some other versioning discrepancy.
	// Runtime protobuf definitions will also be checked for compatibility
	// with pinned file descriptors to make sure there are no incompatible changes.
	//
	// This behavior ensures that:
	// * pinned proto images are up-to-date
	// * protobuf files are carefully annotated with revision comments which
	//   are important good client UX
	// * protobuf files are changed in backwards and forwards compatible ways
	Revision uint32 `protobuf:"varint,2,opt,name=revision,proto3" json:"revision,omitempty"`
	// contains filtered or unexported fields
}

PackageReference is a reference to a protobuf package used by a module.

func (*PackageReference) Descriptor deprecated

func (*PackageReference) Descriptor() ([]byte, []int)

Deprecated: Use PackageReference.ProtoReflect.Descriptor instead.

func (*PackageReference) GetName

func (x *PackageReference) GetName() string

func (*PackageReference) GetRevision

func (x *PackageReference) GetRevision() uint32

func (*PackageReference) ProtoMessage

func (*PackageReference) ProtoMessage()

func (*PackageReference) ProtoReflect

func (x *PackageReference) ProtoReflect() protoreflect.Message

func (*PackageReference) Reset

func (x *PackageReference) Reset()

func (*PackageReference) String

func (x *PackageReference) String() string

type QueryClient

type QueryClient interface {
	// Config returns the current app config.
	Config(ctx context.Context, in *QueryConfigRequest, opts ...grpc.CallOption) (*QueryConfigResponse, error)
}

QueryClient is the client API for Query service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewQueryClient

func NewQueryClient(cc grpc.ClientConnInterface) QueryClient

type QueryConfigRequest

type QueryConfigRequest struct {
	// contains filtered or unexported fields
}

QueryConfigRequest is the Query/Config request type.

func (*QueryConfigRequest) Descriptor deprecated

func (*QueryConfigRequest) Descriptor() ([]byte, []int)

Deprecated: Use QueryConfigRequest.ProtoReflect.Descriptor instead.

func (*QueryConfigRequest) ProtoMessage

func (*QueryConfigRequest) ProtoMessage()

func (*QueryConfigRequest) ProtoReflect

func (x *QueryConfigRequest) ProtoReflect() protoreflect.Message

func (*QueryConfigRequest) Reset

func (x *QueryConfigRequest) Reset()

func (*QueryConfigRequest) String

func (x *QueryConfigRequest) String() string

type QueryConfigResponse

type QueryConfigResponse struct {

	// config is the current app config.
	Config *Config `protobuf:"bytes,1,opt,name=config,proto3" json:"config,omitempty"`
	// contains filtered or unexported fields
}

QueryConfigRequest is the Query/Config response type.

func (*QueryConfigResponse) Descriptor deprecated

func (*QueryConfigResponse) Descriptor() ([]byte, []int)

Deprecated: Use QueryConfigResponse.ProtoReflect.Descriptor instead.

func (*QueryConfigResponse) GetConfig

func (x *QueryConfigResponse) GetConfig() *Config

func (*QueryConfigResponse) ProtoMessage

func (*QueryConfigResponse) ProtoMessage()

func (*QueryConfigResponse) ProtoReflect

func (x *QueryConfigResponse) ProtoReflect() protoreflect.Message

func (*QueryConfigResponse) Reset

func (x *QueryConfigResponse) Reset()

func (*QueryConfigResponse) String

func (x *QueryConfigResponse) String() string

type QueryServer

type QueryServer interface {
	// Config returns the current app config.
	Config(context.Context, *QueryConfigRequest) (*QueryConfigResponse, error)
	// contains filtered or unexported methods
}

QueryServer is the server API for Query service. All implementations must embed UnimplementedQueryServer for forward compatibility

type UnimplementedQueryServer

type UnimplementedQueryServer struct {
}

UnimplementedQueryServer must be embedded to have forward compatible implementations.

func (UnimplementedQueryServer) Config

type UnsafeQueryServer

type UnsafeQueryServer interface {
	// contains filtered or unexported methods
}

UnsafeQueryServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to QueryServer will result in compilation errors.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL