ModuleDescriptor describes an app module.

from message cosmos.app.v1alpha1.ModuleDescriptor

Hierarchy

Constructors

Properties

canMigrateFrom: MigrateFromInfo[] = []

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.

from field: repeated cosmos.app.v1alpha1.MigrateFromInfo can_migrate_from = 3;

goImport: string = ""

go_import names the package that should be imported by an app to load the module in the runtime module registry. It is required to make debugging of configuration errors easier for users.

from field: string go_import = 1;

usePackage: PackageReference[] = []

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.

from field: repeated cosmos.app.v1alpha1.PackageReference use_package = 2;

fields: FieldList = ...
runtime: ProtoRuntime = proto3
typeName: "cosmos.app.v1alpha1.ModuleDescriptor" = "cosmos.app.v1alpha1.ModuleDescriptor"

Methods