@sparkdreamnft/sparkdreamjs 0.0.6 → 0.0.7

package/ibc/core/client/v1/client.d.ts

@@ -4,11 +4,18 @@ import { DeepPartial } from "../../../../helpers";
 /**
  * IdentifiedClientState defines a client state with an additional client
  * identifier field.
+ * @name IdentifiedClientState
+ * @package ibc.core.client.v1
+ * @see proto type: ibc.core.client.v1.IdentifiedClientState
  */
 export interface IdentifiedClientState {
-    /** client identifier */
+    /**
+     * client identifier
+     */
     clientId: string;
-    /** client state */
+    /**
+     * client state
+     */
     clientState?: Any;
 }
 export interface IdentifiedClientStateProtoMsg {
@@ -18,11 +25,18 @@ export interface IdentifiedClientStateProtoMsg {
 /**
  * IdentifiedClientState defines a client state with an additional client
  * identifier field.
+ * @name IdentifiedClientStateAmino
+ * @package ibc.core.client.v1
+ * @see proto type: ibc.core.client.v1.IdentifiedClientState
  */
 export interface IdentifiedClientStateAmino {
-    /** client identifier */
+    /**
+     * client identifier
+     */
     client_id?: string;
-    /** client state */
+    /**
+     * client state
+     */
     client_state?: AnyAmino;
 }
 export interface IdentifiedClientStateAminoMsg {
@@ -32,11 +46,18 @@ export interface IdentifiedClientStateAminoMsg {
 /**
  * ConsensusStateWithHeight defines a consensus state with an additional height
  * field.
+ * @name ConsensusStateWithHeight
+ * @package ibc.core.client.v1
+ * @see proto type: ibc.core.client.v1.ConsensusStateWithHeight
  */
 export interface ConsensusStateWithHeight {
-    /** consensus state height */
+    /**
+     * consensus state height
+     */
     height: Height;
-    /** consensus state */
+    /**
+     * consensus state
+     */
     consensusState?: Any;
 }
 export interface ConsensusStateWithHeightProtoMsg {
@@ -46,11 +67,18 @@ export interface ConsensusStateWithHeightProtoMsg {
 /**
  * ConsensusStateWithHeight defines a consensus state with an additional height
  * field.
+ * @name ConsensusStateWithHeightAmino
+ * @package ibc.core.client.v1
+ * @see proto type: ibc.core.client.v1.ConsensusStateWithHeight
  */
 export interface ConsensusStateWithHeightAmino {
-    /** consensus state height */
+    /**
+     * consensus state height
+     */
     height?: HeightAmino;
-    /** consensus state */
+    /**
+     * consensus state
+     */
     consensus_state?: AnyAmino;
 }
 export interface ConsensusStateWithHeightAminoMsg {
@@ -60,11 +88,18 @@ export interface ConsensusStateWithHeightAminoMsg {
 /**
  * ClientConsensusStates defines all the stored consensus states for a given
  * client.
+ * @name ClientConsensusStates
+ * @package ibc.core.client.v1
+ * @see proto type: ibc.core.client.v1.ClientConsensusStates
  */
 export interface ClientConsensusStates {
-    /** client identifier */
+    /**
+     * client identifier
+     */
     clientId: string;
-    /** consensus states and their heights associated with the client */
+    /**
+     * consensus states and their heights associated with the client
+     */
     consensusStates: ConsensusStateWithHeight[];
 }
 export interface ClientConsensusStatesProtoMsg {
@@ -74,11 +109,18 @@ export interface ClientConsensusStatesProtoMsg {
 /**
  * ClientConsensusStates defines all the stored consensus states for a given
  * client.
+ * @name ClientConsensusStatesAmino
+ * @package ibc.core.client.v1
+ * @see proto type: ibc.core.client.v1.ClientConsensusStates
  */
 export interface ClientConsensusStatesAmino {
-    /** client identifier */
+    /**
+     * client identifier
+     */
     client_id?: string;
-    /** consensus states and their heights associated with the client */
+    /**
+     * consensus states and their heights associated with the client
+     */
     consensus_states?: ConsensusStateWithHeightAmino[];
 }
 export interface ClientConsensusStatesAminoMsg {
@@ -99,11 +141,18 @@ export interface ClientConsensusStatesAminoMsg {
  *
  * Please note that json tags for generated Go code are overridden to explicitly exclude the omitempty jsontag.
  * This enforces the Go json marshaller to always emit zero values for both revision_number and revision_height.
+ * @name Height
+ * @package ibc.core.client.v1
+ * @see proto type: ibc.core.client.v1.Height
  */
 export interface Height {
-    /** the revision that the client is currently on */
+    /**
+     * the revision that the client is currently on
+     */
     revisionNumber: bigint;
-    /** the height within the given revision */
+    /**
+     * the height within the given revision
+     */
     revisionHeight: bigint;
 }
 export interface HeightProtoMsg {
@@ -124,18 +173,30 @@ export interface HeightProtoMsg {
  *
  * Please note that json tags for generated Go code are overridden to explicitly exclude the omitempty jsontag.
  * This enforces the Go json marshaller to always emit zero values for both revision_number and revision_height.
+ * @name HeightAmino
+ * @package ibc.core.client.v1
+ * @see proto type: ibc.core.client.v1.Height
  */
 export interface HeightAmino {
-    /** the revision that the client is currently on */
+    /**
+     * the revision that the client is currently on
+     */
     revision_number: string;
-    /** the height within the given revision */
+    /**
+     * the height within the given revision
+     */
     revision_height: string;
 }
 export interface HeightAminoMsg {
     type: "cosmos-sdk/Height";
     value: HeightAmino;
 }
-/** Params defines the set of IBC light client parameters. */
+/**
+ * Params defines the set of IBC light client parameters.
+ * @name Params
+ * @package ibc.core.client.v1
+ * @see proto type: ibc.core.client.v1.Params
+ */
 export interface Params {
     /**
      * allowed_clients defines the list of allowed client state types which can be created
@@ -148,7 +209,12 @@ export interface ParamsProtoMsg {
     typeUrl: "/ibc.core.client.v1.Params";
     value: Uint8Array;
 }
-/** Params defines the set of IBC light client parameters. */
+/**
+ * Params defines the set of IBC light client parameters.
+ * @name ParamsAmino
+ * @package ibc.core.client.v1
+ * @see proto type: ibc.core.client.v1.Params
+ */
 export interface ParamsAmino {
     /**
      * allowed_clients defines the list of allowed client state types which can be created
@@ -161,6 +227,13 @@ export interface ParamsAminoMsg {
     type: "cosmos-sdk/Params";
     value: ParamsAmino;
 }
+/**
+ * IdentifiedClientState defines a client state with an additional client
+ * identifier field.
+ * @name IdentifiedClientState
+ * @package ibc.core.client.v1
+ * @see proto type: ibc.core.client.v1.IdentifiedClientState
+ */
 export declare const IdentifiedClientState: {
     typeUrl: string;
     aminoType: string;
@@ -175,6 +248,13 @@ export declare const IdentifiedClientState: {
     toProto(message: IdentifiedClientState): Uint8Array;
     toProtoMsg(message: IdentifiedClientState): IdentifiedClientStateProtoMsg;
 };
+/**
+ * ConsensusStateWithHeight defines a consensus state with an additional height
+ * field.
+ * @name ConsensusStateWithHeight
+ * @package ibc.core.client.v1
+ * @see proto type: ibc.core.client.v1.ConsensusStateWithHeight
+ */
 export declare const ConsensusStateWithHeight: {
     typeUrl: string;
     aminoType: string;
@@ -189,6 +269,13 @@ export declare const ConsensusStateWithHeight: {
     toProto(message: ConsensusStateWithHeight): Uint8Array;
     toProtoMsg(message: ConsensusStateWithHeight): ConsensusStateWithHeightProtoMsg;
 };
+/**
+ * ClientConsensusStates defines all the stored consensus states for a given
+ * client.
+ * @name ClientConsensusStates
+ * @package ibc.core.client.v1
+ * @see proto type: ibc.core.client.v1.ClientConsensusStates
+ */
 export declare const ClientConsensusStates: {
     typeUrl: string;
     aminoType: string;
@@ -203,6 +290,24 @@ export declare const ClientConsensusStates: {
     toProto(message: ClientConsensusStates): Uint8Array;
     toProtoMsg(message: ClientConsensusStates): ClientConsensusStatesProtoMsg;
 };
+/**
+ * Height is a monotonically increasing data type
+ * that can be compared against another Height for the purposes of updating and
+ * freezing clients
+ *
+ * Normally the RevisionHeight is incremented at each height while keeping
+ * RevisionNumber the same. However some consensus algorithms may choose to
+ * reset the height in certain conditions e.g. hard forks, state-machine
+ * breaking changes In these cases, the RevisionNumber is incremented so that
+ * height continues to be monitonically increasing even as the RevisionHeight
+ * gets reset
+ *
+ * Please note that json tags for generated Go code are overridden to explicitly exclude the omitempty jsontag.
+ * This enforces the Go json marshaller to always emit zero values for both revision_number and revision_height.
+ * @name Height
+ * @package ibc.core.client.v1
+ * @see proto type: ibc.core.client.v1.Height
+ */
 export declare const Height: {
     typeUrl: string;
     aminoType: string;
@@ -217,6 +322,12 @@ export declare const Height: {
     toProto(message: Height): Uint8Array;
     toProtoMsg(message: Height): HeightProtoMsg;
 };
+/**
+ * Params defines the set of IBC light client parameters.
+ * @name Params
+ * @package ibc.core.client.v1
+ * @see proto type: ibc.core.client.v1.Params
+ */
 export declare const Params: {
     typeUrl: string;
     aminoType: string;

package/ibc/core/client/v1/client.js

@@ -10,6 +10,13 @@ function createBaseIdentifiedClientState() {
         clientState: undefined
     };
 }
+/**
+ * IdentifiedClientState defines a client state with an additional client
+ * identifier field.
+ * @name IdentifiedClientState
+ * @package ibc.core.client.v1
+ * @see proto type: ibc.core.client.v1.IdentifiedClientState
+ */
 exports.IdentifiedClientState = {
     typeUrl: "/ibc.core.client.v1.IdentifiedClientState",
     aminoType: "cosmos-sdk/IdentifiedClientState",
@@ -92,6 +99,13 @@ function createBaseConsensusStateWithHeight() {
         consensusState: undefined
     };
 }
+/**
+ * ConsensusStateWithHeight defines a consensus state with an additional height
+ * field.
+ * @name ConsensusStateWithHeight
+ * @package ibc.core.client.v1
+ * @see proto type: ibc.core.client.v1.ConsensusStateWithHeight
+ */
 exports.ConsensusStateWithHeight = {
     typeUrl: "/ibc.core.client.v1.ConsensusStateWithHeight",
     aminoType: "cosmos-sdk/ConsensusStateWithHeight",
@@ -174,6 +188,13 @@ function createBaseClientConsensusStates() {
         consensusStates: []
     };
 }
+/**
+ * ClientConsensusStates defines all the stored consensus states for a given
+ * client.
+ * @name ClientConsensusStates
+ * @package ibc.core.client.v1
+ * @see proto type: ibc.core.client.v1.ClientConsensusStates
+ */
 exports.ClientConsensusStates = {
     typeUrl: "/ibc.core.client.v1.ClientConsensusStates",
     aminoType: "cosmos-sdk/ClientConsensusStates",
@@ -259,6 +280,24 @@ function createBaseHeight() {
         revisionHeight: BigInt(0)
     };
 }
+/**
+ * Height is a monotonically increasing data type
+ * that can be compared against another Height for the purposes of updating and
+ * freezing clients
+ *
+ * Normally the RevisionHeight is incremented at each height while keeping
+ * RevisionNumber the same. However some consensus algorithms may choose to
+ * reset the height in certain conditions e.g. hard forks, state-machine
+ * breaking changes In these cases, the RevisionNumber is incremented so that
+ * height continues to be monitonically increasing even as the RevisionHeight
+ * gets reset
+ *
+ * Please note that json tags for generated Go code are overridden to explicitly exclude the omitempty jsontag.
+ * This enforces the Go json marshaller to always emit zero values for both revision_number and revision_height.
+ * @name Height
+ * @package ibc.core.client.v1
+ * @see proto type: ibc.core.client.v1.Height
+ */
 exports.Height = {
     typeUrl: "/ibc.core.client.v1.Height",
     aminoType: "cosmos-sdk/Height",
@@ -336,6 +375,12 @@ function createBaseParams() {
         allowedClients: []
     };
 }
+/**
+ * Params defines the set of IBC light client parameters.
+ * @name Params
+ * @package ibc.core.client.v1
+ * @see proto type: ibc.core.client.v1.Params
+ */
 exports.Params = {
     typeUrl: "/ibc.core.client.v1.Params",
     aminoType: "cosmos-sdk/Params",

package/ibc/core/client/v1/genesis.d.ts

@@ -1,44 +1,70 @@
 import { IdentifiedClientState, IdentifiedClientStateAmino, ClientConsensusStates, ClientConsensusStatesAmino, Params, ParamsAmino } from "./client";
 import { BinaryReader, BinaryWriter } from "../../../../binary";
 import { DeepPartial } from "../../../../helpers";
-/** GenesisState defines the ibc client submodule's genesis state. */
+/**
+ * GenesisState defines the ibc client submodule's genesis state.
+ * @name GenesisState
+ * @package ibc.core.client.v1
+ * @see proto type: ibc.core.client.v1.GenesisState
+ */
 export interface GenesisState {
-    /** client states with their corresponding identifiers */
+    /**
+     * client states with their corresponding identifiers
+     */
     clients: IdentifiedClientState[];
-    /** consensus states from each client */
+    /**
+     * consensus states from each client
+     */
     clientsConsensus: ClientConsensusStates[];
-    /** metadata from each client */
+    /**
+     * metadata from each client
+     */
     clientsMetadata: IdentifiedGenesisMetadata[];
     params: Params;
     /**
      * Deprecated: create_localhost has been deprecated.
      * The localhost client is automatically created at genesis.
+     * @deprecated
      */
-    /** @deprecated */
     createLocalhost: boolean;
-    /** the sequence for the next generated client identifier */
+    /**
+     * the sequence for the next generated client identifier
+     */
     nextClientSequence: bigint;
 }
 export interface GenesisStateProtoMsg {
     typeUrl: "/ibc.core.client.v1.GenesisState";
     value: Uint8Array;
 }
-/** GenesisState defines the ibc client submodule's genesis state. */
+/**
+ * GenesisState defines the ibc client submodule's genesis state.
+ * @name GenesisStateAmino
+ * @package ibc.core.client.v1
+ * @see proto type: ibc.core.client.v1.GenesisState
+ */
 export interface GenesisStateAmino {
-    /** client states with their corresponding identifiers */
+    /**
+     * client states with their corresponding identifiers
+     */
     clients?: IdentifiedClientStateAmino[];
-    /** consensus states from each client */
+    /**
+     * consensus states from each client
+     */
     clients_consensus?: ClientConsensusStatesAmino[];
-    /** metadata from each client */
+    /**
+     * metadata from each client
+     */
     clients_metadata?: IdentifiedGenesisMetadataAmino[];
     params?: ParamsAmino;
     /**
      * Deprecated: create_localhost has been deprecated.
      * The localhost client is automatically created at genesis.
+     * @deprecated
      */
-    /** @deprecated */
     create_localhost?: boolean;
-    /** the sequence for the next generated client identifier */
+    /**
+     * the sequence for the next generated client identifier
+     */
     next_client_sequence?: string;
 }
 export interface GenesisStateAminoMsg {
@@ -48,11 +74,18 @@ export interface GenesisStateAminoMsg {
 /**
  * GenesisMetadata defines the genesis type for metadata that will be used
  * to export all client store keys that are not client or consensus states.
+ * @name GenesisMetadata
+ * @package ibc.core.client.v1
+ * @see proto type: ibc.core.client.v1.GenesisMetadata
  */
 export interface GenesisMetadata {
-    /** store key of metadata without clientID-prefix */
+    /**
+     * store key of metadata without clientID-prefix
+     */
     key: Uint8Array;
-    /** metadata value */
+    /**
+     * metadata value
+     */
     value: Uint8Array;
 }
 export interface GenesisMetadataProtoMsg {
@@ -62,11 +95,18 @@ export interface GenesisMetadataProtoMsg {
 /**
  * GenesisMetadata defines the genesis type for metadata that will be used
  * to export all client store keys that are not client or consensus states.
+ * @name GenesisMetadataAmino
+ * @package ibc.core.client.v1
+ * @see proto type: ibc.core.client.v1.GenesisMetadata
  */
 export interface GenesisMetadataAmino {
-    /** store key of metadata without clientID-prefix */
+    /**
+     * store key of metadata without clientID-prefix
+     */
     key?: string;
-    /** metadata value */
+    /**
+     * metadata value
+     */
     value?: string;
 }
 export interface GenesisMetadataAminoMsg {
@@ -76,6 +116,9 @@ export interface GenesisMetadataAminoMsg {
 /**
  * IdentifiedGenesisMetadata has the client metadata with the corresponding
  * client id.
+ * @name IdentifiedGenesisMetadata
+ * @package ibc.core.client.v1
+ * @see proto type: ibc.core.client.v1.IdentifiedGenesisMetadata
  */
 export interface IdentifiedGenesisMetadata {
     clientId: string;
@@ -88,6 +131,9 @@ export interface IdentifiedGenesisMetadataProtoMsg {
 /**
  * IdentifiedGenesisMetadata has the client metadata with the corresponding
  * client id.
+ * @name IdentifiedGenesisMetadataAmino
+ * @package ibc.core.client.v1
+ * @see proto type: ibc.core.client.v1.IdentifiedGenesisMetadata
  */
 export interface IdentifiedGenesisMetadataAmino {
     client_id?: string;
@@ -97,6 +143,12 @@ export interface IdentifiedGenesisMetadataAminoMsg {
     type: "cosmos-sdk/IdentifiedGenesisMetadata";
     value: IdentifiedGenesisMetadataAmino;
 }
+/**
+ * GenesisState defines the ibc client submodule's genesis state.
+ * @name GenesisState
+ * @package ibc.core.client.v1
+ * @see proto type: ibc.core.client.v1.GenesisState
+ */
 export declare const GenesisState: {
     typeUrl: string;
     aminoType: string;
@@ -111,6 +163,13 @@ export declare const GenesisState: {
     toProto(message: GenesisState): Uint8Array;
     toProtoMsg(message: GenesisState): GenesisStateProtoMsg;
 };
+/**
+ * GenesisMetadata defines the genesis type for metadata that will be used
+ * to export all client store keys that are not client or consensus states.
+ * @name GenesisMetadata
+ * @package ibc.core.client.v1
+ * @see proto type: ibc.core.client.v1.GenesisMetadata
+ */
 export declare const GenesisMetadata: {
     typeUrl: string;
     aminoType: string;
@@ -125,6 +184,13 @@ export declare const GenesisMetadata: {
     toProto(message: GenesisMetadata): Uint8Array;
     toProtoMsg(message: GenesisMetadata): GenesisMetadataProtoMsg;
 };
+/**
+ * IdentifiedGenesisMetadata has the client metadata with the corresponding
+ * client id.
+ * @name IdentifiedGenesisMetadata
+ * @package ibc.core.client.v1
+ * @see proto type: ibc.core.client.v1.IdentifiedGenesisMetadata
+ */
 export declare const IdentifiedGenesisMetadata: {
     typeUrl: string;
     aminoType: string;

package/ibc/core/client/v1/genesis.js

@@ -15,6 +15,12 @@ function createBaseGenesisState() {
         nextClientSequence: BigInt(0)
     };
 }
+/**
+ * GenesisState defines the ibc client submodule's genesis state.
+ * @name GenesisState
+ * @package ibc.core.client.v1
+ * @see proto type: ibc.core.client.v1.GenesisState
+ */
 exports.GenesisState = {
     typeUrl: "/ibc.core.client.v1.GenesisState",
     aminoType: "cosmos-sdk/GenesisState",
@@ -150,6 +156,13 @@ function createBaseGenesisMetadata() {
         value: new Uint8Array()
     };
 }
+/**
+ * GenesisMetadata defines the genesis type for metadata that will be used
+ * to export all client store keys that are not client or consensus states.
+ * @name GenesisMetadata
+ * @package ibc.core.client.v1
+ * @see proto type: ibc.core.client.v1.GenesisMetadata
+ */
 exports.GenesisMetadata = {
     typeUrl: "/ibc.core.client.v1.GenesisMetadata",
     aminoType: "cosmos-sdk/GenesisMetadata",
@@ -232,6 +245,13 @@ function createBaseIdentifiedGenesisMetadata() {
         clientMetadata: []
     };
 }
+/**
+ * IdentifiedGenesisMetadata has the client metadata with the corresponding
+ * client id.
+ * @name IdentifiedGenesisMetadata
+ * @package ibc.core.client.v1
+ * @see proto type: ibc.core.client.v1.IdentifiedGenesisMetadata
+ */
 exports.IdentifiedGenesisMetadata = {
     typeUrl: "/ibc.core.client.v1.IdentifiedGenesisMetadata",
     aminoType: "cosmos-sdk/IdentifiedGenesisMetadata",