@leapwallet/buffer-boba
Version:
Buffer Boba is a library for decoding protocol buffers in the cosmos ecosystem.
649 lines (648 loc) • 24.8 kB
TypeScript
import { Height, HeightAmino, HeightSDKType } from '../../client/v1/client';
import { BinaryReader, BinaryWriter } from '../../../../../binary';
/**
* State defines if a channel is in one of the following states:
* CLOSED, INIT, TRYOPEN, OPEN, FLUSHING, FLUSHCOMPLETE or UNINITIALIZED.
*/
export declare enum State {
/** STATE_UNINITIALIZED_UNSPECIFIED - Default State */
STATE_UNINITIALIZED_UNSPECIFIED = 0,
/** STATE_INIT - A channel has just started the opening handshake. */
STATE_INIT = 1,
/** STATE_TRYOPEN - A channel has acknowledged the handshake step on the counterparty chain. */
STATE_TRYOPEN = 2,
/**
* STATE_OPEN - A channel has completed the handshake. Open channels are
* ready to send and receive packets.
*/
STATE_OPEN = 3,
/**
* STATE_CLOSED - A channel has been closed and can no longer be used to send or receive
* packets.
*/
STATE_CLOSED = 4,
/** STATE_FLUSHING - A channel has just accepted the upgrade handshake attempt and is flushing in-flight packets. */
STATE_FLUSHING = 5,
/** STATE_FLUSHCOMPLETE - A channel has just completed flushing any in-flight packets. */
STATE_FLUSHCOMPLETE = 6,
UNRECOGNIZED = -1
}
export declare const StateSDKType: typeof State;
export declare const StateAmino: typeof State;
export declare function stateFromJSON(object: any): State;
export declare function stateToJSON(object: State): string;
/** Order defines if a channel is ORDERED or UNORDERED */
export declare enum Order {
/** ORDER_NONE_UNSPECIFIED - zero-value for channel ordering */
ORDER_NONE_UNSPECIFIED = 0,
/**
* ORDER_UNORDERED - packets can be delivered in any order, which may differ from the order in
* which they were sent.
*/
ORDER_UNORDERED = 1,
/** ORDER_ORDERED - packets are delivered exactly in the order which they were sent */
ORDER_ORDERED = 2,
UNRECOGNIZED = -1
}
export declare const OrderSDKType: typeof Order;
export declare const OrderAmino: typeof Order;
export declare function orderFromJSON(object: any): Order;
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.
*/
export interface Channel {
/** current state of the channel end */
state: State;
/** whether the channel is ordered or unordered */
ordering: Order;
/** 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 */
version: string;
/**
* upgrade sequence indicates the latest upgrade attempt performed by this channel
* the value of 0 indicates the channel has never been upgraded
*/
upgradeSequence: bigint;
}
export interface ChannelProtoMsg {
typeUrl: '/ibc.core.channel.v1.Channel';
value: Uint8Array;
}
/**
* 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.
*/
export interface ChannelAmino {
/** current state of the channel end */
state?: State;
/** whether the channel is ordered or unordered */
ordering?: Order;
/** 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 */
version?: string;
/**
* upgrade sequence indicates the latest upgrade attempt performed by this channel
* the value of 0 indicates the channel has never been upgraded
*/
upgrade_sequence?: string;
}
export interface ChannelAminoMsg {
type: 'cosmos-sdk/Channel';
value: ChannelAmino;
}
/**
* 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.
*/
export interface ChannelSDKType {
state: State;
ordering: Order;
counterparty: CounterpartySDKType;
connection_hops: string[];
version: string;
upgrade_sequence: bigint;
}
/**
* IdentifiedChannel defines a channel with additional port and channel
* identifier fields.
*/
export interface IdentifiedChannel {
/** current state of the channel end */
state: State;
/** whether the channel is ordered or unordered */
ordering: Order;
/** 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 */
version: string;
/** port identifier */
portId: string;
/** channel identifier */
channelId: string;
/**
* upgrade sequence indicates the latest upgrade attempt performed by this channel
* the value of 0 indicates the channel has never been upgraded
*/
upgradeSequence: bigint;
}
export interface IdentifiedChannelProtoMsg {
typeUrl: '/ibc.core.channel.v1.IdentifiedChannel';
value: Uint8Array;
}
/**
* IdentifiedChannel defines a channel with additional port and channel
* identifier fields.
*/
export interface IdentifiedChannelAmino {
/** current state of the channel end */
state?: State;
/** whether the channel is ordered or unordered */
ordering?: Order;
/** 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 */
version?: string;
/** port identifier */
port_id?: string;
/** channel identifier */
channel_id?: string;
/**
* upgrade sequence indicates the latest upgrade attempt performed by this channel
* the value of 0 indicates the channel has never been upgraded
*/
upgrade_sequence?: string;
}
export interface IdentifiedChannelAminoMsg {
type: 'cosmos-sdk/IdentifiedChannel';
value: IdentifiedChannelAmino;
}
/**
* IdentifiedChannel defines a channel with additional port and channel
* identifier fields.
*/
export interface IdentifiedChannelSDKType {
state: State;
ordering: Order;
counterparty: CounterpartySDKType;
connection_hops: string[];
version: string;
port_id: string;
channel_id: string;
upgrade_sequence: bigint;
}
/** Counterparty defines a channel end counterparty */
export interface Counterparty {
/** port on the counterparty chain which owns the other end of the channel. */
portId: string;
/** 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 */
export interface CounterpartyAmino {
/** port on the counterparty chain which owns the other end of the channel. */
port_id?: string;
/** channel end on the counterparty chain */
channel_id?: string;
}
export interface CounterpartyAminoMsg {
type: 'cosmos-sdk/Counterparty';
value: CounterpartyAmino;
}
/** Counterparty defines a channel end counterparty */
export interface CounterpartySDKType {
port_id: string;
channel_id: string;
}
/** Packet defines a type that carries data across different chains through IBC */
export interface Packet {
/**
* number corresponds to the order of sends and receives, where a Packet
* with an earlier sequence number must be sent and received before a Packet
* with a later sequence number.
*/
sequence: bigint;
/** identifies the port on the sending chain. */
sourcePort: string;
/** identifies the channel end on the sending chain. */
sourceChannel: string;
/** identifies the port on the receiving chain. */
destinationPort: string;
/** identifies the channel end on the receiving chain. */
destinationChannel: string;
/** actual opaque bytes transferred directly to the application module */
data: Uint8Array;
/** block height after which the packet times out */
timeoutHeight: Height;
/** 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 */
export interface PacketAmino {
/**
* number corresponds to the order of sends and receives, where a Packet
* with an earlier sequence number must be sent and received before a Packet
* with a later sequence number.
*/
sequence?: string;
/** identifies the port on the sending chain. */
source_port?: string;
/** identifies the channel end on the sending chain. */
source_channel?: string;
/** identifies the port on the receiving chain. */
destination_port?: string;
/** identifies the channel end on the receiving chain. */
destination_channel?: string;
/** actual opaque bytes transferred directly to the application module */
data?: string;
/** block height after which the packet times out */
timeout_height?: HeightAmino;
/** block timestamp (in nanoseconds) after which the packet times out */
timeout_timestamp?: string;
}
export interface PacketAminoMsg {
type: 'cosmos-sdk/Packet';
value: PacketAmino;
}
/** Packet defines a type that carries data across different chains through IBC */
export interface PacketSDKType {
sequence: bigint;
source_port: string;
source_channel: string;
destination_port: string;
destination_channel: string;
data: Uint8Array;
timeout_height: HeightSDKType;
timeout_timestamp: bigint;
}
/**
* 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.
*/
export interface PacketState {
/** channel port identifier. */
portId: string;
/** channel unique identifier. */
channelId: string;
/** packet sequence. */
sequence: bigint;
/** embedded data that represents packet state. */
data: Uint8Array;
}
export interface PacketStateProtoMsg {
typeUrl: '/ibc.core.channel.v1.PacketState';
value: 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.
*/
export interface PacketStateAmino {
/** channel port identifier. */
port_id?: string;
/** channel unique identifier. */
channel_id?: string;
/** packet sequence. */
sequence?: string;
/** embedded data that represents packet state. */
data?: string;
}
export interface PacketStateAminoMsg {
type: 'cosmos-sdk/PacketState';
value: PacketStateAmino;
}
/**
* 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.
*/
export interface PacketStateSDKType {
port_id: string;
channel_id: string;
sequence: bigint;
data: Uint8Array;
}
/**
* 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
*/
export interface PacketId {
/** channel port identifier */
portId: string;
/** channel unique identifier */
channelId: string;
/** packet sequence */
sequence: bigint;
}
export interface PacketIdProtoMsg {
typeUrl: '/ibc.core.channel.v1.PacketId';
value: Uint8Array;
}
/**
* 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
*/
export interface PacketIdAmino {
/** channel port identifier */
port_id?: string;
/** channel unique identifier */
channel_id?: string;
/** packet sequence */
sequence?: string;
}
export interface PacketIdAminoMsg {
type: 'cosmos-sdk/PacketId';
value: PacketIdAmino;
}
/**
* 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
*/
export interface PacketIdSDKType {
port_id: string;
channel_id: string;
sequence: bigint;
}
/**
* 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
*/
export interface Acknowledgement {
result?: Uint8Array;
error?: string;
}
export interface AcknowledgementProtoMsg {
typeUrl: '/ibc.core.channel.v1.Acknowledgement';
value: Uint8Array;
}
/**
* 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
*/
export interface AcknowledgementAmino {
result?: string;
error?: string;
}
export interface AcknowledgementAminoMsg {
type: 'cosmos-sdk/Acknowledgement';
value: AcknowledgementAmino;
}
/**
* 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
*/
export interface AcknowledgementSDKType {
result?: Uint8Array;
error?: string;
}
/**
* 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).
*/
export interface Timeout {
/** block height after which the packet or upgrade times out */
height: Height;
/** block timestamp (in nanoseconds) after which the packet or upgrade times out */
timestamp: bigint;
}
export interface TimeoutProtoMsg {
typeUrl: '/ibc.core.channel.v1.Timeout';
value: Uint8Array;
}
/**
* 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).
*/
export interface TimeoutAmino {
/** block height after which the packet or upgrade times out */
height?: HeightAmino;
/** block timestamp (in nanoseconds) after which the packet or upgrade times out */
timestamp?: string;
}
export interface TimeoutAminoMsg {
type: 'cosmos-sdk/Timeout';
value: TimeoutAmino;
}
/**
* 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).
*/
export interface TimeoutSDKType {
height: HeightSDKType;
timestamp: bigint;
}
/** Params defines the set of IBC channel parameters. */
export interface Params {
/** the relative timeout after which channel upgrades will time out. */
upgradeTimeout: Timeout;
}
export interface ParamsProtoMsg {
typeUrl: '/ibc.core.channel.v1.Params';
value: Uint8Array;
}
/** Params defines the set of IBC channel parameters. */
export interface ParamsAmino {
/** the relative timeout after which channel upgrades will time out. */
upgrade_timeout?: TimeoutAmino;
}
export interface ParamsAminoMsg {
type: 'cosmos-sdk/Params';
value: ParamsAmino;
}
/** Params defines the set of IBC channel parameters. */
export interface ParamsSDKType {
upgrade_timeout: TimeoutSDKType;
}
export declare const Channel: {
typeUrl: string;
aminoType: string;
is(o: any): o is Channel;
isSDK(o: any): o is ChannelSDKType;
isAmino(o: any): o is ChannelAmino;
encode(message: Channel, writer?: BinaryWriter): BinaryWriter;
decode(input: BinaryReader | Uint8Array, length?: number): Channel;
fromPartial(object: Partial<Channel>): Channel;
fromAmino(object: ChannelAmino): Channel;
toAmino(message: Channel): ChannelAmino;
fromAminoMsg(object: ChannelAminoMsg): Channel;
toAminoMsg(message: Channel): ChannelAminoMsg;
fromProtoMsg(message: ChannelProtoMsg): Channel;
toProto(message: Channel): Uint8Array;
toProtoMsg(message: Channel): ChannelProtoMsg;
};
export declare const IdentifiedChannel: {
typeUrl: string;
aminoType: string;
is(o: any): o is IdentifiedChannel;
isSDK(o: any): o is IdentifiedChannelSDKType;
isAmino(o: any): o is IdentifiedChannelAmino;
encode(message: IdentifiedChannel, writer?: BinaryWriter): BinaryWriter;
decode(input: BinaryReader | Uint8Array, length?: number): IdentifiedChannel;
fromPartial(object: Partial<IdentifiedChannel>): IdentifiedChannel;
fromAmino(object: IdentifiedChannelAmino): IdentifiedChannel;
toAmino(message: IdentifiedChannel): IdentifiedChannelAmino;
fromAminoMsg(object: IdentifiedChannelAminoMsg): IdentifiedChannel;
toAminoMsg(message: IdentifiedChannel): IdentifiedChannelAminoMsg;
fromProtoMsg(message: IdentifiedChannelProtoMsg): IdentifiedChannel;
toProto(message: IdentifiedChannel): Uint8Array;
toProtoMsg(message: IdentifiedChannel): IdentifiedChannelProtoMsg;
};
export declare const Counterparty: {
typeUrl: string;
aminoType: string;
is(o: any): o is Counterparty;
isSDK(o: any): o is CounterpartySDKType;
isAmino(o: any): o is CounterpartyAmino;
encode(message: Counterparty, writer?: BinaryWriter): BinaryWriter;
decode(input: BinaryReader | Uint8Array, length?: number): Counterparty;
fromPartial(object: Partial<Counterparty>): Counterparty;
fromAmino(object: CounterpartyAmino): Counterparty;
toAmino(message: Counterparty): CounterpartyAmino;
fromAminoMsg(object: CounterpartyAminoMsg): Counterparty;
toAminoMsg(message: Counterparty): CounterpartyAminoMsg;
fromProtoMsg(message: CounterpartyProtoMsg): Counterparty;
toProto(message: Counterparty): Uint8Array;
toProtoMsg(message: Counterparty): CounterpartyProtoMsg;
};
export declare const Packet: {
typeUrl: string;
aminoType: string;
is(o: any): o is Packet;
isSDK(o: any): o is PacketSDKType;
isAmino(o: any): o is PacketAmino;
encode(message: Packet, writer?: BinaryWriter): BinaryWriter;
decode(input: BinaryReader | Uint8Array, length?: number): Packet;
fromPartial(object: Partial<Packet>): Packet;
fromAmino(object: PacketAmino): Packet;
toAmino(message: Packet): PacketAmino;
fromAminoMsg(object: PacketAminoMsg): Packet;
toAminoMsg(message: Packet): PacketAminoMsg;
fromProtoMsg(message: PacketProtoMsg): Packet;
toProto(message: Packet): Uint8Array;
toProtoMsg(message: Packet): PacketProtoMsg;
};
export declare const PacketState: {
typeUrl: string;
aminoType: string;
is(o: any): o is PacketState;
isSDK(o: any): o is PacketStateSDKType;
isAmino(o: any): o is PacketStateAmino;
encode(message: PacketState, writer?: BinaryWriter): BinaryWriter;
decode(input: BinaryReader | Uint8Array, length?: number): PacketState;
fromPartial(object: Partial<PacketState>): PacketState;
fromAmino(object: PacketStateAmino): PacketState;
toAmino(message: PacketState): PacketStateAmino;
fromAminoMsg(object: PacketStateAminoMsg): PacketState;
toAminoMsg(message: PacketState): PacketStateAminoMsg;
fromProtoMsg(message: PacketStateProtoMsg): PacketState;
toProto(message: PacketState): Uint8Array;
toProtoMsg(message: PacketState): PacketStateProtoMsg;
};
export declare const PacketId: {
typeUrl: string;
aminoType: string;
is(o: any): o is PacketId;
isSDK(o: any): o is PacketIdSDKType;
isAmino(o: any): o is PacketIdAmino;
encode(message: PacketId, writer?: BinaryWriter): BinaryWriter;
decode(input: BinaryReader | Uint8Array, length?: number): PacketId;
fromPartial(object: Partial<PacketId>): PacketId;
fromAmino(object: PacketIdAmino): PacketId;
toAmino(message: PacketId): PacketIdAmino;
fromAminoMsg(object: PacketIdAminoMsg): PacketId;
toAminoMsg(message: PacketId): PacketIdAminoMsg;
fromProtoMsg(message: PacketIdProtoMsg): PacketId;
toProto(message: PacketId): Uint8Array;
toProtoMsg(message: PacketId): PacketIdProtoMsg;
};
export declare const Acknowledgement: {
typeUrl: string;
aminoType: string;
is(o: any): o is Acknowledgement;
isSDK(o: any): o is AcknowledgementSDKType;
isAmino(o: any): o is AcknowledgementAmino;
encode(message: Acknowledgement, writer?: BinaryWriter): BinaryWriter;
decode(input: BinaryReader | Uint8Array, length?: number): Acknowledgement;
fromPartial(object: Partial<Acknowledgement>): Acknowledgement;
fromAmino(object: AcknowledgementAmino): Acknowledgement;
toAmino(message: Acknowledgement): AcknowledgementAmino;
fromAminoMsg(object: AcknowledgementAminoMsg): Acknowledgement;
toAminoMsg(message: Acknowledgement): AcknowledgementAminoMsg;
fromProtoMsg(message: AcknowledgementProtoMsg): Acknowledgement;
toProto(message: Acknowledgement): Uint8Array;
toProtoMsg(message: Acknowledgement): AcknowledgementProtoMsg;
};
export declare const Timeout: {
typeUrl: string;
aminoType: string;
is(o: any): o is Timeout;
isSDK(o: any): o is TimeoutSDKType;
isAmino(o: any): o is TimeoutAmino;
encode(message: Timeout, writer?: BinaryWriter): BinaryWriter;
decode(input: BinaryReader | Uint8Array, length?: number): Timeout;
fromPartial(object: Partial<Timeout>): Timeout;
fromAmino(object: TimeoutAmino): Timeout;
toAmino(message: Timeout): TimeoutAmino;
fromAminoMsg(object: TimeoutAminoMsg): Timeout;
toAminoMsg(message: Timeout): TimeoutAminoMsg;
fromProtoMsg(message: TimeoutProtoMsg): Timeout;
toProto(message: Timeout): Uint8Array;
toProtoMsg(message: Timeout): TimeoutProtoMsg;
};
export declare const Params: {
typeUrl: string;
aminoType: string;
is(o: any): o is Params;
isSDK(o: any): o is ParamsSDKType;
isAmino(o: any): o is ParamsAmino;
encode(message: Params, writer?: BinaryWriter): BinaryWriter;
decode(input: BinaryReader | Uint8Array, length?: number): Params;
fromPartial(object: Partial<Params>): Params;
fromAmino(object: ParamsAmino): Params;
toAmino(message: Params): ParamsAmino;
fromAminoMsg(object: ParamsAminoMsg): Params;
toAminoMsg(message: Params): ParamsAminoMsg;
fromProtoMsg(message: ParamsProtoMsg): Params;
toProto(message: Params): Uint8Array;
toProtoMsg(message: Params): ParamsProtoMsg;
};