@sparkdreamnft/sparkdreamjs 0.0.6 → 0.0.7

package/ibc/core/channel/v2/packet.d.ts

@@ -15,7 +15,12 @@ export declare enum PacketStatus {
 export declare const PacketStatusAmino: typeof PacketStatus;
 export declare function packetStatusFromJSON(object: any): PacketStatus;
 export declare function packetStatusToJSON(object: PacketStatus): string;
-/** 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.v2
+ * @see proto type: ibc.core.channel.v2.Packet
+ */
 export interface Packet {
     /**
      * number corresponds to the order of sends and receives, where a Packet
@@ -23,20 +28,33 @@ export interface Packet {
      * with a later sequence number.
      */
     sequence: bigint;
-    /** identifies the sending client on the sending chain. */
+    /**
+     * identifies the sending client on the sending chain.
+     */
     sourceClient: string;
-    /** identifies the receiving client on the receiving chain. */
+    /**
+     * identifies the receiving client on the receiving chain.
+     */
     destinationClient: string;
-    /** timeout timestamp in seconds after which the packet times out. */
+    /**
+     * timeout timestamp in seconds after which the packet times out.
+     */
     timeoutTimestamp: bigint;
-    /** a list of payloads, each one for a specific application. */
+    /**
+     * a list of payloads, each one for a specific application.
+     */
     payloads: Payload[];
 }
 export interface PacketProtoMsg {
     typeUrl: "/ibc.core.channel.v2.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.v2
+ * @see proto type: ibc.core.channel.v2.Packet
+ */
 export interface PacketAmino {
     /**
      * number corresponds to the order of sends and receives, where a Packet
@@ -44,47 +62,85 @@ export interface PacketAmino {
      * with a later sequence number.
      */
     sequence?: string;
-    /** identifies the sending client on the sending chain. */
+    /**
+     * identifies the sending client on the sending chain.
+     */
     source_client?: string;
-    /** identifies the receiving client on the receiving chain. */
+    /**
+     * identifies the receiving client on the receiving chain.
+     */
     destination_client?: string;
-    /** timeout timestamp in seconds after which the packet times out. */
+    /**
+     * timeout timestamp in seconds after which the packet times out.
+     */
     timeout_timestamp?: string;
-    /** a list of payloads, each one for a specific application. */
+    /**
+     * a list of payloads, each one for a specific application.
+     */
     payloads?: PayloadAmino[];
 }
 export interface PacketAminoMsg {
     type: "cosmos-sdk/Packet";
     value: PacketAmino;
 }
-/** Payload contains the source and destination ports and payload for the application (version, encoding, raw bytes) */
+/**
+ * Payload contains the source and destination ports and payload for the application (version, encoding, raw bytes)
+ * @name Payload
+ * @package ibc.core.channel.v2
+ * @see proto type: ibc.core.channel.v2.Payload
+ */
 export interface Payload {
-    /** specifies the source port of the packet. */
+    /**
+     * specifies the source port of the packet.
+     */
     sourcePort: string;
-    /** specifies the destination port of the packet. */
+    /**
+     * specifies the destination port of the packet.
+     */
     destinationPort: string;
-    /** version of the specified application. */
+    /**
+     * version of the specified application.
+     */
     version: string;
-    /** the encoding used for the provided value. */
+    /**
+     * the encoding used for the provided value.
+     */
     encoding: string;
-    /** the raw bytes for the payload. */
+    /**
+     * the raw bytes for the payload.
+     */
     value: Uint8Array;
 }
 export interface PayloadProtoMsg {
     typeUrl: "/ibc.core.channel.v2.Payload";
     value: Uint8Array;
 }
-/** Payload contains the source and destination ports and payload for the application (version, encoding, raw bytes) */
+/**
+ * Payload contains the source and destination ports and payload for the application (version, encoding, raw bytes)
+ * @name PayloadAmino
+ * @package ibc.core.channel.v2
+ * @see proto type: ibc.core.channel.v2.Payload
+ */
 export interface PayloadAmino {
-    /** specifies the source port of the packet. */
+    /**
+     * specifies the source port of the packet.
+     */
     source_port?: string;
-    /** specifies the destination port of the packet. */
+    /**
+     * specifies the destination port of the packet.
+     */
     destination_port?: string;
-    /** version of the specified application. */
+    /**
+     * version of the specified application.
+     */
     version?: string;
-    /** the encoding used for the provided value. */
+    /**
+     * the encoding used for the provided value.
+     */
     encoding?: string;
-    /** the raw bytes for the payload. */
+    /**
+     * the raw bytes for the payload.
+     */
     value?: string;
 }
 export interface PayloadAminoMsg {
@@ -98,6 +154,9 @@ export interface PayloadAminoMsg {
  * in the packet.
  * If the receive is not successful, the acknowledgement will contain a single app acknowledgment
  * which will be a constant error acknowledgment as defined by the IBC v2 protocol.
+ * @name Acknowledgement
+ * @package ibc.core.channel.v2
+ * @see proto type: ibc.core.channel.v2.Acknowledgement
  */
 export interface Acknowledgement {
     appAcknowledgements: Uint8Array[];
@@ -113,6 +172,9 @@ export interface AcknowledgementProtoMsg {
  * in the packet.
  * If the receive is not successful, the acknowledgement will contain a single app acknowledgment
  * which will be a constant error acknowledgment as defined by the IBC v2 protocol.
+ * @name AcknowledgementAmino
+ * @package ibc.core.channel.v2
+ * @see proto type: ibc.core.channel.v2.Acknowledgement
  */
 export interface AcknowledgementAmino {
     app_acknowledgements?: string[];
@@ -121,28 +183,52 @@ export interface AcknowledgementAminoMsg {
     type: "cosmos-sdk/Acknowledgement";
     value: AcknowledgementAmino;
 }
-/** RecvPacketResult speecifies the status of a packet as well as the acknowledgement bytes. */
+/**
+ * RecvPacketResult speecifies the status of a packet as well as the acknowledgement bytes.
+ * @name RecvPacketResult
+ * @package ibc.core.channel.v2
+ * @see proto type: ibc.core.channel.v2.RecvPacketResult
+ */
 export interface RecvPacketResult {
-    /** status of the packet */
+    /**
+     * status of the packet
+     */
     status: PacketStatus;
-    /** acknowledgement of the packet */
+    /**
+     * acknowledgement of the packet
+     */
     acknowledgement: Uint8Array;
 }
 export interface RecvPacketResultProtoMsg {
     typeUrl: "/ibc.core.channel.v2.RecvPacketResult";
     value: Uint8Array;
 }
-/** RecvPacketResult speecifies the status of a packet as well as the acknowledgement bytes. */
+/**
+ * RecvPacketResult speecifies the status of a packet as well as the acknowledgement bytes.
+ * @name RecvPacketResultAmino
+ * @package ibc.core.channel.v2
+ * @see proto type: ibc.core.channel.v2.RecvPacketResult
+ */
 export interface RecvPacketResultAmino {
-    /** status of the packet */
+    /**
+     * status of the packet
+     */
     status?: PacketStatus;
-    /** acknowledgement of the packet */
+    /**
+     * acknowledgement of the packet
+     */
     acknowledgement?: string;
 }
 export interface RecvPacketResultAminoMsg {
     type: "cosmos-sdk/RecvPacketResult";
     value: RecvPacketResultAmino;
 }
+/**
+ * Packet defines a type that carries data across different chains through IBC
+ * @name Packet
+ * @package ibc.core.channel.v2
+ * @see proto type: ibc.core.channel.v2.Packet
+ */
 export declare const Packet: {
     typeUrl: string;
     aminoType: string;
@@ -157,6 +243,12 @@ export declare const Packet: {
     toProto(message: Packet): Uint8Array;
     toProtoMsg(message: Packet): PacketProtoMsg;
 };
+/**
+ * Payload contains the source and destination ports and payload for the application (version, encoding, raw bytes)
+ * @name Payload
+ * @package ibc.core.channel.v2
+ * @see proto type: ibc.core.channel.v2.Payload
+ */
 export declare const Payload: {
     typeUrl: string;
     aminoType: string;
@@ -171,6 +263,17 @@ export declare const Payload: {
     toProto(message: Payload): Uint8Array;
     toProtoMsg(message: Payload): PayloadProtoMsg;
 };
+/**
+ * Acknowledgement contains a list of all ack results associated with a single packet.
+ * In the case of a successful receive, the acknowledgement will contain an app acknowledgement
+ * for each application that received a payload in the same order that the payloads were sent
+ * in the packet.
+ * If the receive is not successful, the acknowledgement will contain a single app acknowledgment
+ * which will be a constant error acknowledgment as defined by the IBC v2 protocol.
+ * @name Acknowledgement
+ * @package ibc.core.channel.v2
+ * @see proto type: ibc.core.channel.v2.Acknowledgement
+ */
 export declare const Acknowledgement: {
     typeUrl: string;
     aminoType: string;
@@ -185,6 +288,12 @@ export declare const Acknowledgement: {
     toProto(message: Acknowledgement): Uint8Array;
     toProtoMsg(message: Acknowledgement): AcknowledgementProtoMsg;
 };
+/**
+ * RecvPacketResult speecifies the status of a packet as well as the acknowledgement bytes.
+ * @name RecvPacketResult
+ * @package ibc.core.channel.v2
+ * @see proto type: ibc.core.channel.v2.RecvPacketResult
+ */
 export declare const RecvPacketResult: {
     typeUrl: string;
     aminoType: string;

package/ibc/core/channel/v2/packet.js

@@ -64,6 +64,12 @@ function createBasePacket() {
         payloads: []
     };
 }
+/**
+ * Packet defines a type that carries data across different chains through IBC
+ * @name Packet
+ * @package ibc.core.channel.v2
+ * @see proto type: ibc.core.channel.v2.Packet
+ */
 exports.Packet = {
     typeUrl: "/ibc.core.channel.v2.Packet",
     aminoType: "cosmos-sdk/Packet",
@@ -185,6 +191,12 @@ function createBasePayload() {
         value: new Uint8Array()
     };
 }
+/**
+ * Payload contains the source and destination ports and payload for the application (version, encoding, raw bytes)
+ * @name Payload
+ * @package ibc.core.channel.v2
+ * @see proto type: ibc.core.channel.v2.Payload
+ */
 exports.Payload = {
     typeUrl: "/ibc.core.channel.v2.Payload",
     aminoType: "cosmos-sdk/Payload",
@@ -299,6 +311,17 @@ function createBaseAcknowledgement() {
         appAcknowledgements: []
     };
 }
+/**
+ * Acknowledgement contains a list of all ack results associated with a single packet.
+ * In the case of a successful receive, the acknowledgement will contain an app acknowledgement
+ * for each application that received a payload in the same order that the payloads were sent
+ * in the packet.
+ * If the receive is not successful, the acknowledgement will contain a single app acknowledgment
+ * which will be a constant error acknowledgment as defined by the IBC v2 protocol.
+ * @name Acknowledgement
+ * @package ibc.core.channel.v2
+ * @see proto type: ibc.core.channel.v2.Acknowledgement
+ */
 exports.Acknowledgement = {
     typeUrl: "/ibc.core.channel.v2.Acknowledgement",
     aminoType: "cosmos-sdk/Acknowledgement",
@@ -373,6 +396,12 @@ function createBaseRecvPacketResult() {
         acknowledgement: new Uint8Array()
     };
 }
+/**
+ * RecvPacketResult speecifies the status of a packet as well as the acknowledgement bytes.
+ * @name RecvPacketResult
+ * @package ibc.core.channel.v2
+ * @see proto type: ibc.core.channel.v2.RecvPacketResult
+ */
 exports.RecvPacketResult = {
     typeUrl: "/ibc.core.channel.v2.RecvPacketResult",
     aminoType: "cosmos-sdk/RecvPacketResult",