interchainjs/cosmos/orm/v1alpha1/schema.d.ts

InterchainJS is a JavaScript library for interacting with Cosmos SDK based blockchains.

import { BinaryReader, BinaryWriter } from "../../../binary";
import { DeepPartial } from "../../../helpers";
/** StorageType */
export declare enum StorageType {
    /**
     * STORAGE_TYPE_DEFAULT_UNSPECIFIED - STORAGE_TYPE_DEFAULT_UNSPECIFIED indicates the persistent storage where all
     * data is stored in the regular Merkle-tree backed KV-store.
     */
    STORAGE_TYPE_DEFAULT_UNSPECIFIED = 0,
    /**
     * STORAGE_TYPE_MEMORY - STORAGE_TYPE_MEMORY indicates in-memory storage that will be
     * reloaded every time an app restarts. Tables with this type of storage
     * will by default be ignored when importing and exporting a module's
     * state from JSON.
     */
    STORAGE_TYPE_MEMORY = 1,
    /**
     * STORAGE_TYPE_TRANSIENT - STORAGE_TYPE_TRANSIENT indicates transient storage that is reset
     * at the end of every block. Tables with this type of storage
     * will by default be ignored when importing and exporting a module's
     * state from JSON.
     */
    STORAGE_TYPE_TRANSIENT = 2,
    UNRECOGNIZED = -1
}
export declare const StorageTypeAmino: typeof StorageType;
export declare function storageTypeFromJSON(object: any): StorageType;
export declare function storageTypeToJSON(object: StorageType): string;
/**
 * ModuleSchemaDescriptor describe's a module's ORM schema.
 * @name ModuleSchemaDescriptor
 * @package cosmos.orm.v1alpha1
 * @see proto type: cosmos.orm.v1alpha1.ModuleSchemaDescriptor
 */
export interface ModuleSchemaDescriptor {
    schemaFile: ModuleSchemaDescriptor_FileEntry[];
    /**
     * prefix is an optional prefix that precedes all keys in this module's
     * store.
     */
    prefix: Uint8Array;
}
export interface ModuleSchemaDescriptorProtoMsg {
    typeUrl: "/cosmos.orm.v1alpha1.ModuleSchemaDescriptor";
    value: Uint8Array;
}
/**
 * ModuleSchemaDescriptor describe's a module's ORM schema.
 * @name ModuleSchemaDescriptorAmino
 * @package cosmos.orm.v1alpha1
 * @see proto type: cosmos.orm.v1alpha1.ModuleSchemaDescriptor
 */
export interface ModuleSchemaDescriptorAmino {
    schema_file: ModuleSchemaDescriptor_FileEntryAmino[];
    /**
     * prefix is an optional prefix that precedes all keys in this module's
     * store.
     */
    prefix: string;
}
export interface ModuleSchemaDescriptorAminoMsg {
    type: "cosmos-sdk/ModuleSchemaDescriptor";
    value: ModuleSchemaDescriptorAmino;
}
/**
 * FileEntry describes an ORM file used in a module.
 * @name ModuleSchemaDescriptor_FileEntry
 * @package cosmos.orm.v1alpha1
 * @see proto type: cosmos.orm.v1alpha1.FileEntry
 */
export interface ModuleSchemaDescriptor_FileEntry {
    /**
     * id is a prefix that will be varint encoded and prepended to all the
     * table keys specified in the file's tables.
     */
    id: number;
    /**
     * proto_file_name is the name of a file .proto in that contains
     * table definitions. The .proto file must be in a package that the
     * module has referenced using cosmos.app.v1.ModuleDescriptor.use_package.
     */
    protoFileName: string;
    /**
     * storage_type optionally indicates the type of storage this file's
     * tables should used. If it is left unspecified, the default KV-storage
     * of the app will be used.
     */
    storageType: StorageType;
}
export interface ModuleSchemaDescriptor_FileEntryProtoMsg {
    typeUrl: "/cosmos.orm.v1alpha1.FileEntry";
    value: Uint8Array;
}
/**
 * FileEntry describes an ORM file used in a module.
 * @name ModuleSchemaDescriptor_FileEntryAmino
 * @package cosmos.orm.v1alpha1
 * @see proto type: cosmos.orm.v1alpha1.ModuleSchemaDescriptor_FileEntry
 */
export interface ModuleSchemaDescriptor_FileEntryAmino {
    /**
     * id is a prefix that will be varint encoded and prepended to all the
     * table keys specified in the file's tables.
     */
    id: number;
    /**
     * proto_file_name is the name of a file .proto in that contains
     * table definitions. The .proto file must be in a package that the
     * module has referenced using cosmos.app.v1.ModuleDescriptor.use_package.
     */
    proto_file_name: string;
    /**
     * storage_type optionally indicates the type of storage this file's
     * tables should used. If it is left unspecified, the default KV-storage
     * of the app will be used.
     */
    storage_type: StorageType;
}
export interface ModuleSchemaDescriptor_FileEntryAminoMsg {
    type: "cosmos-sdk/FileEntry";
    value: ModuleSchemaDescriptor_FileEntryAmino;
}
/**
 * ModuleSchemaDescriptor describe's a module's ORM schema.
 * @name ModuleSchemaDescriptor
 * @package cosmos.orm.v1alpha1
 * @see proto type: cosmos.orm.v1alpha1.ModuleSchemaDescriptor
 */
export declare const ModuleSchemaDescriptor: {
    typeUrl: string;
    aminoType: string;
    is(o: any): o is ModuleSchemaDescriptor;
    isAmino(o: any): o is ModuleSchemaDescriptorAmino;
    encode(message: ModuleSchemaDescriptor, writer?: BinaryWriter): BinaryWriter;
    decode(input: BinaryReader | Uint8Array, length?: number): ModuleSchemaDescriptor;
    fromPartial(object: DeepPartial<ModuleSchemaDescriptor>): ModuleSchemaDescriptor;
    fromAmino(object: ModuleSchemaDescriptorAmino): ModuleSchemaDescriptor;
    toAmino(message: ModuleSchemaDescriptor): ModuleSchemaDescriptorAmino;
    fromAminoMsg(object: ModuleSchemaDescriptorAminoMsg): ModuleSchemaDescriptor;
    toAminoMsg(message: ModuleSchemaDescriptor): ModuleSchemaDescriptorAminoMsg;
    fromProtoMsg(message: ModuleSchemaDescriptorProtoMsg): ModuleSchemaDescriptor;
    toProto(message: ModuleSchemaDescriptor): Uint8Array;
    toProtoMsg(message: ModuleSchemaDescriptor): ModuleSchemaDescriptorProtoMsg;
    registerTypeUrl(): void;
};
/**
 * FileEntry describes an ORM file used in a module.
 * @name ModuleSchemaDescriptor_FileEntry
 * @package cosmos.orm.v1alpha1
 * @see proto type: cosmos.orm.v1alpha1.FileEntry
 */
export declare const ModuleSchemaDescriptor_FileEntry: {
    typeUrl: string;
    aminoType: string;
    is(o: any): o is ModuleSchemaDescriptor_FileEntry;
    isAmino(o: any): o is ModuleSchemaDescriptor_FileEntryAmino;
    encode(message: ModuleSchemaDescriptor_FileEntry, writer?: BinaryWriter): BinaryWriter;
    decode(input: BinaryReader | Uint8Array, length?: number): ModuleSchemaDescriptor_FileEntry;
    fromPartial(object: DeepPartial<ModuleSchemaDescriptor_FileEntry>): ModuleSchemaDescriptor_FileEntry;
    fromAmino(object: ModuleSchemaDescriptor_FileEntryAmino): ModuleSchemaDescriptor_FileEntry;
    toAmino(message: ModuleSchemaDescriptor_FileEntry): ModuleSchemaDescriptor_FileEntryAmino;
    fromAminoMsg(object: ModuleSchemaDescriptor_FileEntryAminoMsg): ModuleSchemaDescriptor_FileEntry;
    toAminoMsg(message: ModuleSchemaDescriptor_FileEntry): ModuleSchemaDescriptor_FileEntryAminoMsg;
    fromProtoMsg(message: ModuleSchemaDescriptor_FileEntryProtoMsg): ModuleSchemaDescriptor_FileEntry;
    toProto(message: ModuleSchemaDescriptor_FileEntry): Uint8Array;
    toProtoMsg(message: ModuleSchemaDescriptor_FileEntry): ModuleSchemaDescriptor_FileEntryProtoMsg;
    registerTypeUrl(): void;
};