@sparkdreamnft/sparkdreamjs 0.0.5 → 0.0.7

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

@@ -47,20 +47,31 @@ export declare function orderToJSON(object: Order): string;
  * Channel defines pipeline for exactly-once packet delivery between specific
  * modules on separate blockchains, which has at least one end capable of
  * sending packets and one end capable of receiving packets.
+ * @name Channel
+ * @package ibc.core.channel.v1
+ * @see proto type: ibc.core.channel.v1.Channel
  */
 export interface Channel {
-    /** current state of the channel end */
+    /**
+     * current state of the channel end
+     */
     state: State;
-    /** whether the channel is ordered or unordered */
+    /**
+     * whether the channel is ordered or unordered
+     */
     ordering: Order;
-    /** counterparty channel end */
+    /**
+     * counterparty channel end
+     */
     counterparty: Counterparty;
     /**
      * list of connection identifiers, in order, along which packets sent on
      * this channel will travel
      */
     connectionHops: string[];
-    /** opaque channel version, which is agreed upon during the handshake */
+    /**
+     * opaque channel version, which is agreed upon during the handshake
+     */
     version: string;
 }
 export interface ChannelProtoMsg {
@@ -71,20 +82,31 @@ export interface ChannelProtoMsg {
  * Channel defines pipeline for exactly-once packet delivery between specific
  * modules on separate blockchains, which has at least one end capable of
  * sending packets and one end capable of receiving packets.
+ * @name ChannelAmino
+ * @package ibc.core.channel.v1
+ * @see proto type: ibc.core.channel.v1.Channel
  */
 export interface ChannelAmino {
-    /** current state of the channel end */
+    /**
+     * current state of the channel end
+     */
     state?: State;
-    /** whether the channel is ordered or unordered */
+    /**
+     * whether the channel is ordered or unordered
+     */
     ordering?: Order;
-    /** counterparty channel end */
+    /**
+     * counterparty channel end
+     */
     counterparty?: CounterpartyAmino;
     /**
      * list of connection identifiers, in order, along which packets sent on
      * this channel will travel
      */
     connection_hops?: string[];
-    /** opaque channel version, which is agreed upon during the handshake */
+    /**
+     * opaque channel version, which is agreed upon during the handshake
+     */
     version?: string;
 }
 export interface ChannelAminoMsg {
@@ -94,24 +116,39 @@ export interface ChannelAminoMsg {
 /**
  * IdentifiedChannel defines a channel with additional port and channel
  * identifier fields.
+ * @name IdentifiedChannel
+ * @package ibc.core.channel.v1
+ * @see proto type: ibc.core.channel.v1.IdentifiedChannel
  */
 export interface IdentifiedChannel {
-    /** current state of the channel end */
+    /**
+     * current state of the channel end
+     */
     state: State;
-    /** whether the channel is ordered or unordered */
+    /**
+     * whether the channel is ordered or unordered
+     */
     ordering: Order;
-    /** counterparty channel end */
+    /**
+     * counterparty channel end
+     */
     counterparty: Counterparty;
     /**
      * list of connection identifiers, in order, along which packets sent on
      * this channel will travel
      */
     connectionHops: string[];
-    /** opaque channel version, which is agreed upon during the handshake */
+    /**
+     * opaque channel version, which is agreed upon during the handshake
+     */
     version: string;
-    /** port identifier */
+    /**
+     * port identifier
+     */
     portId: string;
-    /** channel identifier */
+    /**
+     * channel identifier
+     */
     channelId: string;
 }
 export interface IdentifiedChannelProtoMsg {
@@ -121,53 +158,91 @@ export interface IdentifiedChannelProtoMsg {
 /**
  * IdentifiedChannel defines a channel with additional port and channel
  * identifier fields.
+ * @name IdentifiedChannelAmino
+ * @package ibc.core.channel.v1
+ * @see proto type: ibc.core.channel.v1.IdentifiedChannel
  */
 export interface IdentifiedChannelAmino {
-    /** current state of the channel end */
+    /**
+     * current state of the channel end
+     */
     state?: State;
-    /** whether the channel is ordered or unordered */
+    /**
+     * whether the channel is ordered or unordered
+     */
     ordering?: Order;
-    /** counterparty channel end */
+    /**
+     * counterparty channel end
+     */
     counterparty?: CounterpartyAmino;
     /**
      * list of connection identifiers, in order, along which packets sent on
      * this channel will travel
      */
     connection_hops?: string[];
-    /** opaque channel version, which is agreed upon during the handshake */
+    /**
+     * opaque channel version, which is agreed upon during the handshake
+     */
     version?: string;
-    /** port identifier */
+    /**
+     * port identifier
+     */
     port_id?: string;
-    /** channel identifier */
+    /**
+     * channel identifier
+     */
     channel_id?: string;
 }
 export interface IdentifiedChannelAminoMsg {
     type: "cosmos-sdk/IdentifiedChannel";
     value: IdentifiedChannelAmino;
 }
-/** Counterparty defines a channel end counterparty */
+/**
+ * Counterparty defines a channel end counterparty
+ * @name Counterparty
+ * @package ibc.core.channel.v1
+ * @see proto type: ibc.core.channel.v1.Counterparty
+ */
 export interface Counterparty {
-    /** port on the counterparty chain which owns the other end of the channel. */
+    /**
+     * port on the counterparty chain which owns the other end of the channel.
+     */
     portId: string;
-    /** channel end on the counterparty chain */
+    /**
+     * channel end on the counterparty chain
+     */
     channelId: string;
 }
 export interface CounterpartyProtoMsg {
     typeUrl: "/ibc.core.channel.v1.Counterparty";
     value: Uint8Array;
 }
-/** Counterparty defines a channel end counterparty */
+/**
+ * Counterparty defines a channel end counterparty
+ * @name CounterpartyAmino
+ * @package ibc.core.channel.v1
+ * @see proto type: ibc.core.channel.v1.Counterparty
+ */
 export interface CounterpartyAmino {
-    /** port on the counterparty chain which owns the other end of the channel. */
+    /**
+     * port on the counterparty chain which owns the other end of the channel.
+     */
     port_id?: string;
-    /** channel end on the counterparty chain */
+    /**
+     * channel end on the counterparty chain
+     */
     channel_id?: string;
 }
 export interface CounterpartyAminoMsg {
     type: "cosmos-sdk/Counterparty";
     value: CounterpartyAmino;
 }
-/** Packet defines a type that carries data across different chains through IBC */
+/**
+ * Packet defines a type that carries data across different chains through IBC
+ * @name Packet
+ * @package ibc.core.channel.v1
+ * @see proto type: ibc.core.channel.v1.Packet
+ */
 export interface Packet {
     /**
      * number corresponds to the order of sends and receives, where a Packet
@@ -175,26 +250,45 @@ export interface Packet {
      * with a later sequence number.
      */
     sequence: bigint;
-    /** identifies the port on the sending chain. */
+    /**
+     * identifies the port on the sending chain.
+     */
     sourcePort: string;
-    /** identifies the channel end on the sending chain. */
+    /**
+     * identifies the channel end on the sending chain.
+     */
     sourceChannel: string;
-    /** identifies the port on the receiving chain. */
+    /**
+     * identifies the port on the receiving chain.
+     */
     destinationPort: string;
-    /** identifies the channel end on the receiving chain. */
+    /**
+     * identifies the channel end on the receiving chain.
+     */
     destinationChannel: string;
-    /** actual opaque bytes transferred directly to the application module */
+    /**
+     * actual opaque bytes transferred directly to the application module
+     */
     data: Uint8Array;
-    /** block height after which the packet times out */
+    /**
+     * block height after which the packet times out
+     */
     timeoutHeight: Height;
-    /** block timestamp (in nanoseconds) after which the packet times out */
+    /**
+     * block timestamp (in nanoseconds) after which the packet times out
+     */
     timeoutTimestamp: bigint;
 }
 export interface PacketProtoMsg {
     typeUrl: "/ibc.core.channel.v1.Packet";
     value: Uint8Array;
 }
-/** Packet defines a type that carries data across different chains through IBC */
+/**
+ * Packet defines a type that carries data across different chains through IBC
+ * @name PacketAmino
+ * @package ibc.core.channel.v1
+ * @see proto type: ibc.core.channel.v1.Packet
+ */
 export interface PacketAmino {
     /**
      * number corresponds to the order of sends and receives, where a Packet
@@ -202,19 +296,33 @@ export interface PacketAmino {
      * with a later sequence number.
      */
     sequence?: string;
-    /** identifies the port on the sending chain. */
+    /**
+     * identifies the port on the sending chain.
+     */
     source_port?: string;
-    /** identifies the channel end on the sending chain. */
+    /**
+     * identifies the channel end on the sending chain.
+     */
     source_channel?: string;
-    /** identifies the port on the receiving chain. */
+    /**
+     * identifies the port on the receiving chain.
+     */
     destination_port?: string;
-    /** identifies the channel end on the receiving chain. */
+    /**
+     * identifies the channel end on the receiving chain.
+     */
     destination_channel?: string;
-    /** actual opaque bytes transferred directly to the application module */
+    /**
+     * actual opaque bytes transferred directly to the application module
+     */
     data?: string;
-    /** block height after which the packet times out */
+    /**
+     * block height after which the packet times out
+     */
     timeout_height?: HeightAmino;
-    /** block timestamp (in nanoseconds) after which the packet times out */
+    /**
+     * block timestamp (in nanoseconds) after which the packet times out
+     */
     timeout_timestamp?: string;
 }
 export interface PacketAminoMsg {
@@ -226,15 +334,26 @@ export interface PacketAminoMsg {
  * packet commitments, acknowledgements, and receipts.
  * Caller is responsible for knowing the context necessary to interpret this
  * state as a commitment, acknowledgement, or a receipt.
+ * @name PacketState
+ * @package ibc.core.channel.v1
+ * @see proto type: ibc.core.channel.v1.PacketState
  */
 export interface PacketState {
-    /** channel port identifier. */
+    /**
+     * channel port identifier.
+     */
     portId: string;
-    /** channel unique identifier. */
+    /**
+     * channel unique identifier.
+     */
     channelId: string;
-    /** packet sequence. */
+    /**
+     * packet sequence.
+     */
     sequence: bigint;
-    /** embedded data that represents packet state. */
+    /**
+     * embedded data that represents packet state.
+     */
     data: Uint8Array;
 }
 export interface PacketStateProtoMsg {
@@ -246,15 +365,26 @@ export interface PacketStateProtoMsg {
  * packet commitments, acknowledgements, and receipts.
  * Caller is responsible for knowing the context necessary to interpret this
  * state as a commitment, acknowledgement, or a receipt.
+ * @name PacketStateAmino
+ * @package ibc.core.channel.v1
+ * @see proto type: ibc.core.channel.v1.PacketState
  */
 export interface PacketStateAmino {
-    /** channel port identifier. */
+    /**
+     * channel port identifier.
+     */
     port_id?: string;
-    /** channel unique identifier. */
+    /**
+     * channel unique identifier.
+     */
     channel_id?: string;
-    /** packet sequence. */
+    /**
+     * packet sequence.
+     */
     sequence?: string;
-    /** embedded data that represents packet state. */
+    /**
+     * embedded data that represents packet state.
+     */
     data?: string;
 }
 export interface PacketStateAminoMsg {
@@ -265,13 +395,22 @@ export interface PacketStateAminoMsg {
  * PacketId is an identifier for a unique Packet
  * Source chains refer to packets by source port/channel
  * Destination chains refer to packets by destination port/channel
+ * @name PacketId
+ * @package ibc.core.channel.v1
+ * @see proto type: ibc.core.channel.v1.PacketId
  */
 export interface PacketId {
-    /** channel port identifier */
+    /**
+     * channel port identifier
+     */
     portId: string;
-    /** channel unique identifier */
+    /**
+     * channel unique identifier
+     */
     channelId: string;
-    /** packet sequence */
+    /**
+     * packet sequence
+     */
     sequence: bigint;
 }
 export interface PacketIdProtoMsg {
@@ -282,13 +421,22 @@ export interface PacketIdProtoMsg {
  * PacketId is an identifier for a unique Packet
  * Source chains refer to packets by source port/channel
  * Destination chains refer to packets by destination port/channel
+ * @name PacketIdAmino
+ * @package ibc.core.channel.v1
+ * @see proto type: ibc.core.channel.v1.PacketId
  */
 export interface PacketIdAmino {
-    /** channel port identifier */
+    /**
+     * channel port identifier
+     */
     port_id?: string;
-    /** channel unique identifier */
+    /**
+     * channel unique identifier
+     */
     channel_id?: string;
-    /** packet sequence */
+    /**
+     * packet sequence
+     */
     sequence?: string;
 }
 export interface PacketIdAminoMsg {
@@ -303,6 +451,9 @@ export interface PacketIdAminoMsg {
  * The first byte of any message with this format will be the non-ASCII values
  * `0xaa` (result) or `0xb2` (error). Implemented as defined by ICS:
  * https://github.com/cosmos/ibc/tree/master/spec/core/ics-004-channel-and-packet-semantics#acknowledgement-envelope
+ * @name Acknowledgement
+ * @package ibc.core.channel.v1
+ * @see proto type: ibc.core.channel.v1.Acknowledgement
  */
 export interface Acknowledgement {
     result?: Uint8Array;
@@ -320,6 +471,9 @@ export interface AcknowledgementProtoMsg {
  * The first byte of any message with this format will be the non-ASCII values
  * `0xaa` (result) or `0xb2` (error). Implemented as defined by ICS:
  * https://github.com/cosmos/ibc/tree/master/spec/core/ics-004-channel-and-packet-semantics#acknowledgement-envelope
+ * @name AcknowledgementAmino
+ * @package ibc.core.channel.v1
+ * @see proto type: ibc.core.channel.v1.Acknowledgement
  */
 export interface AcknowledgementAmino {
     result?: string;
@@ -333,11 +487,18 @@ export interface AcknowledgementAminoMsg {
  * Timeout defines an execution deadline structure for 04-channel handlers.
  * This includes packet lifecycle handlers.
  * A valid Timeout contains either one or both of a timestamp and block height (sequence).
+ * @name Timeout
+ * @package ibc.core.channel.v1
+ * @see proto type: ibc.core.channel.v1.Timeout
  */
 export interface Timeout {
-    /** block height after which the packet times out */
+    /**
+     * block height after which the packet times out
+     */
     height: Height;
-    /** block timestamp (in nanoseconds) after which the packet times out */
+    /**
+     * block timestamp (in nanoseconds) after which the packet times out
+     */
     timestamp: bigint;
 }
 export interface TimeoutProtoMsg {
@@ -348,17 +509,32 @@ export interface TimeoutProtoMsg {
  * Timeout defines an execution deadline structure for 04-channel handlers.
  * This includes packet lifecycle handlers.
  * A valid Timeout contains either one or both of a timestamp and block height (sequence).
+ * @name TimeoutAmino
+ * @package ibc.core.channel.v1
+ * @see proto type: ibc.core.channel.v1.Timeout
  */
 export interface TimeoutAmino {
-    /** block height after which the packet times out */
+    /**
+     * block height after which the packet times out
+     */
     height?: HeightAmino;
-    /** block timestamp (in nanoseconds) after which the packet times out */
+    /**
+     * block timestamp (in nanoseconds) after which the packet times out
+     */
     timestamp?: string;
 }
 export interface TimeoutAminoMsg {
     type: "cosmos-sdk/Timeout";
     value: TimeoutAmino;
 }
+/**
+ * Channel defines pipeline for exactly-once packet delivery between specific
+ * modules on separate blockchains, which has at least one end capable of
+ * sending packets and one end capable of receiving packets.
+ * @name Channel
+ * @package ibc.core.channel.v1
+ * @see proto type: ibc.core.channel.v1.Channel
+ */
 export declare const Channel: {
     typeUrl: string;
     aminoType: string;
@@ -373,6 +549,13 @@ export declare const Channel: {
     toProto(message: Channel): Uint8Array;
     toProtoMsg(message: Channel): ChannelProtoMsg;
 };
+/**
+ * IdentifiedChannel defines a channel with additional port and channel
+ * identifier fields.
+ * @name IdentifiedChannel
+ * @package ibc.core.channel.v1
+ * @see proto type: ibc.core.channel.v1.IdentifiedChannel
+ */
 export declare const IdentifiedChannel: {
     typeUrl: string;
     aminoType: string;
@@ -387,6 +570,12 @@ export declare const IdentifiedChannel: {
     toProto(message: IdentifiedChannel): Uint8Array;
     toProtoMsg(message: IdentifiedChannel): IdentifiedChannelProtoMsg;
 };
+/**
+ * Counterparty defines a channel end counterparty
+ * @name Counterparty
+ * @package ibc.core.channel.v1
+ * @see proto type: ibc.core.channel.v1.Counterparty
+ */
 export declare const Counterparty: {
     typeUrl: string;
     aminoType: string;
@@ -401,6 +590,12 @@ export declare const Counterparty: {
     toProto(message: Counterparty): Uint8Array;
     toProtoMsg(message: Counterparty): CounterpartyProtoMsg;
 };
+/**
+ * Packet defines a type that carries data across different chains through IBC
+ * @name Packet
+ * @package ibc.core.channel.v1
+ * @see proto type: ibc.core.channel.v1.Packet
+ */
 export declare const Packet: {
     typeUrl: string;
     aminoType: string;
@@ -415,6 +610,15 @@ export declare const Packet: {
     toProto(message: Packet): Uint8Array;
     toProtoMsg(message: Packet): PacketProtoMsg;
 };
+/**
+ * PacketState defines the generic type necessary to retrieve and store
+ * packet commitments, acknowledgements, and receipts.
+ * Caller is responsible for knowing the context necessary to interpret this
+ * state as a commitment, acknowledgement, or a receipt.
+ * @name PacketState
+ * @package ibc.core.channel.v1
+ * @see proto type: ibc.core.channel.v1.PacketState
+ */
 export declare const PacketState: {
     typeUrl: string;
     aminoType: string;
@@ -429,6 +633,14 @@ export declare const PacketState: {
     toProto(message: PacketState): Uint8Array;
     toProtoMsg(message: PacketState): PacketStateProtoMsg;
 };
+/**
+ * PacketId is an identifier for a unique Packet
+ * Source chains refer to packets by source port/channel
+ * Destination chains refer to packets by destination port/channel
+ * @name PacketId
+ * @package ibc.core.channel.v1
+ * @see proto type: ibc.core.channel.v1.PacketId
+ */
 export declare const PacketId: {
     typeUrl: string;
     aminoType: string;
@@ -443,6 +655,18 @@ export declare const PacketId: {
     toProto(message: PacketId): Uint8Array;
     toProtoMsg(message: PacketId): PacketIdProtoMsg;
 };
+/**
+ * Acknowledgement is the recommended acknowledgement format to be used by
+ * app-specific protocols.
+ * NOTE: The field numbers 21 and 22 were explicitly chosen to avoid accidental
+ * conflicts with other protobuf message formats used for acknowledgements.
+ * The first byte of any message with this format will be the non-ASCII values
+ * `0xaa` (result) or `0xb2` (error). Implemented as defined by ICS:
+ * https://github.com/cosmos/ibc/tree/master/spec/core/ics-004-channel-and-packet-semantics#acknowledgement-envelope
+ * @name Acknowledgement
+ * @package ibc.core.channel.v1
+ * @see proto type: ibc.core.channel.v1.Acknowledgement
+ */
 export declare const Acknowledgement: {
     typeUrl: string;
     aminoType: string;
@@ -457,6 +681,14 @@ export declare const Acknowledgement: {
     toProto(message: Acknowledgement): Uint8Array;
     toProtoMsg(message: Acknowledgement): AcknowledgementProtoMsg;
 };
+/**
+ * Timeout defines an execution deadline structure for 04-channel handlers.
+ * This includes packet lifecycle handlers.
+ * A valid Timeout contains either one or both of a timestamp and block height (sequence).
+ * @name Timeout
+ * @package ibc.core.channel.v1
+ * @see proto type: ibc.core.channel.v1.Timeout
+ */
 export declare const Timeout: {
     typeUrl: string;
     aminoType: string;