@xpla/xplajs 1.7.0 → 1.8.0-rc.0

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

@@ -1,15 +1,21 @@
 import { Any, AnyAmino } from "../../../../google/protobuf/any";
-import { Plan, PlanAmino } from "../../../../cosmos/upgrade/v1beta1/upgrade";
 import { BinaryReader, BinaryWriter } from "../../../../binary";
 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 {
@@ -19,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 {
@@ -33,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 {
@@ -47,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 {
@@ -61,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 {
@@ -75,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 {
@@ -97,11 +138,21 @@ export interface ClientConsensusStatesAminoMsg {
  * 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 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 {
@@ -119,18 +170,33 @@ export interface HeightProtoMsg {
  * 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 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
@@ -143,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
@@ -157,107 +228,12 @@ export interface ParamsAminoMsg {
     value: ParamsAmino;
 }
 /**
- * ClientUpdateProposal is a legacy governance proposal. If it passes, the substitute
- * client's latest consensus state is copied over to the subject client. The proposal
- * handler may fail if the subject and the substitute do not match in client and
- * chain parameters (with exception to latest height, frozen height, and chain-id).
- *
- * Deprecated: Please use MsgRecoverClient in favour of this message type.
- */
-/** @deprecated */
-export interface ClientUpdateProposal {
-    /** the title of the update proposal */
-    title: string;
-    /** the description of the proposal */
-    description: string;
-    /** the client identifier for the client to be updated if the proposal passes */
-    subjectClientId: string;
-    /**
-     * the substitute client identifier for the client standing in for the subject
-     * client
-     */
-    substituteClientId: string;
-}
-export interface ClientUpdateProposalProtoMsg {
-    typeUrl: "/ibc.core.client.v1.ClientUpdateProposal";
-    value: Uint8Array;
-}
-/**
- * ClientUpdateProposal is a legacy governance proposal. If it passes, the substitute
- * client's latest consensus state is copied over to the subject client. The proposal
- * handler may fail if the subject and the substitute do not match in client and
- * chain parameters (with exception to latest height, frozen height, and chain-id).
- *
- * Deprecated: Please use MsgRecoverClient in favour of this message type.
- */
-/** @deprecated */
-export interface ClientUpdateProposalAmino {
-    /** the title of the update proposal */
-    title: string;
-    /** the description of the proposal */
-    description: string;
-    /** the client identifier for the client to be updated if the proposal passes */
-    subject_client_id: string;
-    /**
-     * the substitute client identifier for the client standing in for the subject
-     * client
-     */
-    substitute_client_id: string;
-}
-export interface ClientUpdateProposalAminoMsg {
-    type: "cosmos-sdk/ClientUpdateProposal";
-    value: ClientUpdateProposalAmino;
-}
-/**
- * UpgradeProposal is a gov Content type for initiating an IBC breaking
- * upgrade.
- *
- * Deprecated: Please use MsgIBCSoftwareUpgrade in favour of this message type.
- */
-/** @deprecated */
-export interface UpgradeProposal {
-    title: string;
-    description: string;
-    plan: Plan;
-    /**
-     * An UpgradedClientState must be provided to perform an IBC breaking upgrade.
-     * This will make the chain commit to the correct upgraded (self) client state
-     * before the upgrade occurs, so that connecting chains can verify that the
-     * new upgraded client is valid by verifying a proof on the previous version
-     * of the chain. This will allow IBC connections to persist smoothly across
-     * planned chain upgrades
-     */
-    upgradedClientState?: Any;
-}
-export interface UpgradeProposalProtoMsg {
-    typeUrl: "/ibc.core.client.v1.UpgradeProposal";
-    value: Uint8Array;
-}
-/**
- * UpgradeProposal is a gov Content type for initiating an IBC breaking
- * upgrade.
- *
- * Deprecated: Please use MsgIBCSoftwareUpgrade in favour of this message type.
+ * 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
  */
-/** @deprecated */
-export interface UpgradeProposalAmino {
-    title: string;
-    description: string;
-    plan: PlanAmino;
-    /**
-     * An UpgradedClientState must be provided to perform an IBC breaking upgrade.
-     * This will make the chain commit to the correct upgraded (self) client state
-     * before the upgrade occurs, so that connecting chains can verify that the
-     * new upgraded client is valid by verifying a proof on the previous version
-     * of the chain. This will allow IBC connections to persist smoothly across
-     * planned chain upgrades
-     */
-    upgraded_client_state?: AnyAmino;
-}
-export interface UpgradeProposalAminoMsg {
-    type: "cosmos-sdk/UpgradeProposal";
-    value: UpgradeProposalAmino;
-}
 export declare const IdentifiedClientState: {
     typeUrl: string;
     aminoType: string;
@@ -275,6 +251,13 @@ export declare const IdentifiedClientState: {
     toProtoMsg(message: IdentifiedClientState): IdentifiedClientStateProtoMsg;
     registerTypeUrl(): void;
 };
+/**
+ * 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;
@@ -292,6 +275,13 @@ export declare const ConsensusStateWithHeight: {
     toProtoMsg(message: ConsensusStateWithHeight): ConsensusStateWithHeightProtoMsg;
     registerTypeUrl(): void;
 };
+/**
+ * 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;
@@ -309,6 +299,24 @@ export declare const ClientConsensusStates: {
     toProtoMsg(message: ClientConsensusStates): ClientConsensusStatesProtoMsg;
     registerTypeUrl(): void;
 };
+/**
+ * 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;
@@ -326,6 +334,12 @@ export declare const Height: {
     toProtoMsg(message: Height): HeightProtoMsg;
     registerTypeUrl(): void;
 };
+/**
+ * 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;
@@ -343,37 +357,3 @@ export declare const Params: {
     toProtoMsg(message: Params): ParamsProtoMsg;
     registerTypeUrl(): void;
 };
-export declare const ClientUpdateProposal: {
-    typeUrl: string;
-    aminoType: string;
-    is(o: any): o is ClientUpdateProposal;
-    isAmino(o: any): o is ClientUpdateProposalAmino;
-    encode(message: ClientUpdateProposal, writer?: BinaryWriter): BinaryWriter;
-    decode(input: BinaryReader | Uint8Array, length?: number): ClientUpdateProposal;
-    fromPartial(object: DeepPartial<ClientUpdateProposal>): ClientUpdateProposal;
-    fromAmino(object: ClientUpdateProposalAmino): ClientUpdateProposal;
-    toAmino(message: ClientUpdateProposal): ClientUpdateProposalAmino;
-    fromAminoMsg(object: ClientUpdateProposalAminoMsg): ClientUpdateProposal;
-    toAminoMsg(message: ClientUpdateProposal): ClientUpdateProposalAminoMsg;
-    fromProtoMsg(message: ClientUpdateProposalProtoMsg): ClientUpdateProposal;
-    toProto(message: ClientUpdateProposal): Uint8Array;
-    toProtoMsg(message: ClientUpdateProposal): ClientUpdateProposalProtoMsg;
-    registerTypeUrl(): void;
-};
-export declare const UpgradeProposal: {
-    typeUrl: string;
-    aminoType: string;
-    is(o: any): o is UpgradeProposal;
-    isAmino(o: any): o is UpgradeProposalAmino;
-    encode(message: UpgradeProposal, writer?: BinaryWriter): BinaryWriter;
-    decode(input: BinaryReader | Uint8Array, length?: number): UpgradeProposal;
-    fromPartial(object: DeepPartial<UpgradeProposal>): UpgradeProposal;
-    fromAmino(object: UpgradeProposalAmino): UpgradeProposal;
-    toAmino(message: UpgradeProposal): UpgradeProposalAmino;
-    fromAminoMsg(object: UpgradeProposalAminoMsg): UpgradeProposal;
-    toAminoMsg(message: UpgradeProposal): UpgradeProposalAminoMsg;
-    fromProtoMsg(message: UpgradeProposalProtoMsg): UpgradeProposal;
-    toProto(message: UpgradeProposal): Uint8Array;
-    toProtoMsg(message: UpgradeProposal): UpgradeProposalProtoMsg;
-    registerTypeUrl(): void;
-};