injectivejs 1.11.13 → 1.11.15

package/ibc/core/channel/v1/channel.js

@@ -143,6 +143,14 @@ function createBaseChannel() {
         upgradeSequence: BigInt(0)
     };
 }
+/**
+ * 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
+ */
 exports.Channel = {
     typeUrl: "/ibc.core.channel.v1.Channel",
     aminoType: "cosmos-sdk/Channel",
@@ -290,6 +298,13 @@ function createBaseIdentifiedChannel() {
         upgradeSequence: BigInt(0)
     };
 }
+/**
+ * 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
+ */
 exports.IdentifiedChannel = {
     typeUrl: "/ibc.core.channel.v1.IdentifiedChannel",
     aminoType: "cosmos-sdk/IdentifiedChannel",
@@ -453,6 +468,12 @@ function createBaseCounterparty() {
         channelId: ""
     };
 }
+/**
+ * Counterparty defines a channel end counterparty
+ * @name Counterparty
+ * @package ibc.core.channel.v1
+ * @see proto type: ibc.core.channel.v1.Counterparty
+ */
 exports.Counterparty = {
     typeUrl: "/ibc.core.channel.v1.Counterparty",
     aminoType: "cosmos-sdk/Counterparty",
@@ -548,6 +569,12 @@ function createBasePacket() {
         timeoutTimestamp: BigInt(0)
     };
 }
+/**
+ * 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
+ */
 exports.Packet = {
     typeUrl: "/ibc.core.channel.v1.Packet",
     aminoType: "cosmos-sdk/Packet",
@@ -710,6 +737,15 @@ function createBasePacketState() {
         data: new Uint8Array()
     };
 }
+/**
+ * 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
+ */
 exports.PacketState = {
     typeUrl: "/ibc.core.channel.v1.PacketState",
     aminoType: "cosmos-sdk/PacketState",
@@ -822,6 +858,14 @@ function createBasePacketId() {
         sequence: BigInt(0)
     };
 }
+/**
+ * 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
+ */
 exports.PacketId = {
     typeUrl: "/ibc.core.channel.v1.PacketId",
     aminoType: "cosmos-sdk/PacketId",
@@ -922,6 +966,18 @@ function createBaseAcknowledgement() {
         error: undefined
     };
 }
+/**
+ * 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
+ */
 exports.Acknowledgement = {
     typeUrl: "/ibc.core.channel.v1.Acknowledgement",
     aminoType: "cosmos-sdk/Acknowledgement",
@@ -1011,6 +1067,14 @@ function createBaseTimeout() {
         timestamp: BigInt(0)
     };
 }
+/**
+ * Timeout defines an execution deadline structure for 04-channel handlers.
+ * This includes packet lifecycle handlers as well as the upgrade handshake 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
+ */
 exports.Timeout = {
     typeUrl: "/ibc.core.channel.v1.Timeout",
     aminoType: "cosmos-sdk/Timeout",
@@ -1104,6 +1168,12 @@ function createBaseParams() {
         upgradeTimeout: exports.Timeout.fromPartial({})
     };
 }
+/**
+ * Params defines the set of IBC channel parameters.
+ * @name Params
+ * @package ibc.core.channel.v1
+ * @see proto type: ibc.core.channel.v1.Params
+ */
 exports.Params = {
     typeUrl: "/ibc.core.channel.v1.Params",
     aminoType: "cosmos-sdk/Params",