@xpla/xplajs 1.7.0 → 1.8.0-rc.0

package/tendermint/types/types.d.ts

@@ -16,7 +16,12 @@ export declare enum SignedMsgType {
 export declare const SignedMsgTypeAmino: typeof SignedMsgType;
 export declare function signedMsgTypeFromJSON(object: any): SignedMsgType;
 export declare function signedMsgTypeToJSON(object: SignedMsgType): string;
-/** PartsetHeader */
+/**
+ * PartsetHeader
+ * @name PartSetHeader
+ * @package tendermint.types
+ * @see proto type: tendermint.types.PartSetHeader
+ */
 export interface PartSetHeader {
     total: number;
     hash: Uint8Array;
@@ -25,7 +30,12 @@ export interface PartSetHeaderProtoMsg {
     typeUrl: "/tendermint.types.PartSetHeader";
     value: Uint8Array;
 }
-/** PartsetHeader */
+/**
+ * PartsetHeader
+ * @name PartSetHeaderAmino
+ * @package tendermint.types
+ * @see proto type: tendermint.types.PartSetHeader
+ */
 export interface PartSetHeaderAmino {
     total: number;
     hash: string;
@@ -34,6 +44,11 @@ export interface PartSetHeaderAminoMsg {
     type: "/tendermint.types.PartSetHeader";
     value: PartSetHeaderAmino;
 }
+/**
+ * @name Part
+ * @package tendermint.types
+ * @see proto type: tendermint.types.Part
+ */
 export interface Part {
     index: number;
     bytes: Uint8Array;
@@ -43,6 +58,11 @@ export interface PartProtoMsg {
     typeUrl: "/tendermint.types.Part";
     value: Uint8Array;
 }
+/**
+ * @name PartAmino
+ * @package tendermint.types
+ * @see proto type: tendermint.types.Part
+ */
 export interface PartAmino {
     index: number;
     bytes: string;
@@ -52,7 +72,12 @@ export interface PartAminoMsg {
     type: "/tendermint.types.Part";
     value: PartAmino;
 }
-/** BlockID */
+/**
+ * BlockID
+ * @name BlockID
+ * @package tendermint.types
+ * @see proto type: tendermint.types.BlockID
+ */
 export interface BlockID {
     hash: Uint8Array;
     partSetHeader: PartSetHeader;
@@ -61,7 +86,12 @@ export interface BlockIDProtoMsg {
     typeUrl: "/tendermint.types.BlockID";
     value: Uint8Array;
 }
-/** BlockID */
+/**
+ * BlockID
+ * @name BlockIDAmino
+ * @package tendermint.types
+ * @see proto type: tendermint.types.BlockID
+ */
 export interface BlockIDAmino {
     hash: string;
     part_set_header: PartSetHeaderAmino;
@@ -70,71 +100,130 @@ export interface BlockIDAminoMsg {
     type: "/tendermint.types.BlockID";
     value: BlockIDAmino;
 }
-/** Header defines the structure of a block header. */
+/**
+ * Header defines the structure of a block header.
+ * @name Header
+ * @package tendermint.types
+ * @see proto type: tendermint.types.Header
+ */
 export interface Header {
-    /** basic block info */
+    /**
+     * basic block info
+     */
     version: Consensus;
     chainId: string;
     height: bigint;
     time: Date;
-    /** prev block info */
+    /**
+     * prev block info
+     */
     lastBlockId: BlockID;
-    /** hashes of block data */
+    /**
+     * hashes of block data
+     */
     lastCommitHash: Uint8Array;
-    /** transactions */
+    /**
+     * transactions
+     */
     dataHash: Uint8Array;
-    /** hashes from the app output from the prev block */
+    /**
+     * hashes from the app output from the prev block
+     */
     validatorsHash: Uint8Array;
-    /** validators for the next block */
+    /**
+     * validators for the next block
+     */
     nextValidatorsHash: Uint8Array;
-    /** consensus params for current block */
+    /**
+     * consensus params for current block
+     */
     consensusHash: Uint8Array;
-    /** state after txs from the previous block */
+    /**
+     * state after txs from the previous block
+     */
     appHash: Uint8Array;
-    /** root hash of all results from the txs from the previous block */
+    /**
+     * root hash of all results from the txs from the previous block
+     */
     lastResultsHash: Uint8Array;
-    /** consensus info */
+    /**
+     * consensus info
+     */
     evidenceHash: Uint8Array;
-    /** original proposer of the block */
+    /**
+     * original proposer of the block
+     */
     proposerAddress: Uint8Array;
 }
 export interface HeaderProtoMsg {
     typeUrl: "/tendermint.types.Header";
     value: Uint8Array;
 }
-/** Header defines the structure of a block header. */
+/**
+ * Header defines the structure of a block header.
+ * @name HeaderAmino
+ * @package tendermint.types
+ * @see proto type: tendermint.types.Header
+ */
 export interface HeaderAmino {
-    /** basic block info */
+    /**
+     * basic block info
+     */
     version: ConsensusAmino;
     chain_id: string;
     height: string;
     time: string;
-    /** prev block info */
+    /**
+     * prev block info
+     */
     last_block_id: BlockIDAmino;
-    /** hashes of block data */
+    /**
+     * hashes of block data
+     */
     last_commit_hash: string;
-    /** transactions */
+    /**
+     * transactions
+     */
     data_hash: string;
-    /** hashes from the app output from the prev block */
+    /**
+     * hashes from the app output from the prev block
+     */
     validators_hash: string;
-    /** validators for the next block */
+    /**
+     * validators for the next block
+     */
     next_validators_hash: string;
-    /** consensus params for current block */
+    /**
+     * consensus params for current block
+     */
     consensus_hash: string;
-    /** state after txs from the previous block */
+    /**
+     * state after txs from the previous block
+     */
     app_hash: string;
-    /** root hash of all results from the txs from the previous block */
+    /**
+     * root hash of all results from the txs from the previous block
+     */
     last_results_hash: string;
-    /** consensus info */
+    /**
+     * consensus info
+     */
     evidence_hash: string;
-    /** original proposer of the block */
+    /**
+     * original proposer of the block
+     */
     proposer_address: string;
 }
 export interface HeaderAminoMsg {
     type: "/tendermint.types.Header";
     value: HeaderAmino;
 }
-/** Data contains the set of transactions included in the block */
+/**
+ * Data contains the set of transactions included in the block
+ * @name Data
+ * @package tendermint.types
+ * @see proto type: tendermint.types.Data
+ */
 export interface Data {
     /**
      * Txs that will be applied by state @ block.Height+1.
@@ -147,7 +236,12 @@ export interface DataProtoMsg {
     typeUrl: "/tendermint.types.Data";
     value: Uint8Array;
 }
-/** Data contains the set of transactions included in the block */
+/**
+ * Data contains the set of transactions included in the block
+ * @name DataAmino
+ * @package tendermint.types
+ * @see proto type: tendermint.types.Data
+ */
 export interface DataAmino {
     /**
      * Txs that will be applied by state @ block.Height+1.
@@ -163,12 +257,17 @@ export interface DataAminoMsg {
 /**
  * Vote represents a prevote or precommit vote from validators for
  * consensus.
+ * @name Vote
+ * @package tendermint.types
+ * @see proto type: tendermint.types.Vote
  */
 export interface Vote {
     type: SignedMsgType;
     height: bigint;
     round: number;
-    /** zero if vote is nil. */
+    /**
+     * zero if vote is nil.
+     */
     blockId: BlockID;
     timestamp: Date;
     validatorAddress: Uint8Array;
@@ -197,12 +296,17 @@ export interface VoteProtoMsg {
 /**
  * Vote represents a prevote or precommit vote from validators for
  * consensus.
+ * @name VoteAmino
+ * @package tendermint.types
+ * @see proto type: tendermint.types.Vote
  */
 export interface VoteAmino {
     type: SignedMsgType;
     height: string;
     round: number;
-    /** zero if vote is nil. */
+    /**
+     * zero if vote is nil.
+     */
     block_id: BlockIDAmino;
     timestamp: string;
     validator_address: string;
@@ -228,7 +332,12 @@ export interface VoteAminoMsg {
     type: "/tendermint.types.Vote";
     value: VoteAmino;
 }
-/** Commit contains the evidence that a block was committed by a set of validators. */
+/**
+ * Commit contains the evidence that a block was committed by a set of validators.
+ * @name Commit
+ * @package tendermint.types
+ * @see proto type: tendermint.types.Commit
+ */
 export interface Commit {
     height: bigint;
     round: number;
@@ -239,7 +348,12 @@ export interface CommitProtoMsg {
     typeUrl: "/tendermint.types.Commit";
     value: Uint8Array;
 }
-/** Commit contains the evidence that a block was committed by a set of validators. */
+/**
+ * Commit contains the evidence that a block was committed by a set of validators.
+ * @name CommitAmino
+ * @package tendermint.types
+ * @see proto type: tendermint.types.Commit
+ */
 export interface CommitAmino {
     height: string;
     round: number;
@@ -250,7 +364,12 @@ export interface CommitAminoMsg {
     type: "/tendermint.types.Commit";
     value: CommitAmino;
 }
-/** CommitSig is a part of the Vote included in a Commit. */
+/**
+ * CommitSig is a part of the Vote included in a Commit.
+ * @name CommitSig
+ * @package tendermint.types
+ * @see proto type: tendermint.types.CommitSig
+ */
 export interface CommitSig {
     blockIdFlag: BlockIDFlag;
     validatorAddress: Uint8Array;
@@ -261,7 +380,12 @@ export interface CommitSigProtoMsg {
     typeUrl: "/tendermint.types.CommitSig";
     value: Uint8Array;
 }
-/** CommitSig is a part of the Vote included in a Commit. */
+/**
+ * CommitSig is a part of the Vote included in a Commit.
+ * @name CommitSigAmino
+ * @package tendermint.types
+ * @see proto type: tendermint.types.CommitSig
+ */
 export interface CommitSigAmino {
     block_id_flag: BlockIDFlag;
     validator_address: string;
@@ -272,6 +396,11 @@ export interface CommitSigAminoMsg {
     type: "/tendermint.types.CommitSig";
     value: CommitSigAmino;
 }
+/**
+ * @name ExtendedCommit
+ * @package tendermint.types
+ * @see proto type: tendermint.types.ExtendedCommit
+ */
 export interface ExtendedCommit {
     height: bigint;
     round: number;
@@ -282,6 +411,11 @@ export interface ExtendedCommitProtoMsg {
     typeUrl: "/tendermint.types.ExtendedCommit";
     value: Uint8Array;
 }
+/**
+ * @name ExtendedCommitAmino
+ * @package tendermint.types
+ * @see proto type: tendermint.types.ExtendedCommit
+ */
 export interface ExtendedCommitAmino {
     height: string;
     round: number;
@@ -296,15 +430,22 @@ export interface ExtendedCommitAminoMsg {
  * ExtendedCommitSig retains all the same fields as CommitSig but adds vote
  * extension-related fields. We use two signatures to ensure backwards compatibility.
  * That is the digest of the original signature is still the same in prior versions
+ * @name ExtendedCommitSig
+ * @package tendermint.types
+ * @see proto type: tendermint.types.ExtendedCommitSig
  */
 export interface ExtendedCommitSig {
     blockIdFlag: BlockIDFlag;
     validatorAddress: Uint8Array;
     timestamp: Date;
     signature: Uint8Array;
-    /** Vote extension data */
+    /**
+     * Vote extension data
+     */
     extension: Uint8Array;
-    /** Vote extension signature */
+    /**
+     * Vote extension signature
+     */
     extensionSignature: Uint8Array;
 }
 export interface ExtendedCommitSigProtoMsg {
@@ -315,21 +456,33 @@ export interface ExtendedCommitSigProtoMsg {
  * ExtendedCommitSig retains all the same fields as CommitSig but adds vote
  * extension-related fields. We use two signatures to ensure backwards compatibility.
  * That is the digest of the original signature is still the same in prior versions
+ * @name ExtendedCommitSigAmino
+ * @package tendermint.types
+ * @see proto type: tendermint.types.ExtendedCommitSig
  */
 export interface ExtendedCommitSigAmino {
     block_id_flag: BlockIDFlag;
     validator_address: string;
     timestamp: string;
     signature: string;
-    /** Vote extension data */
+    /**
+     * Vote extension data
+     */
     extension: string;
-    /** Vote extension signature */
+    /**
+     * Vote extension signature
+     */
     extension_signature: string;
 }
 export interface ExtendedCommitSigAminoMsg {
     type: "/tendermint.types.ExtendedCommitSig";
     value: ExtendedCommitSigAmino;
 }
+/**
+ * @name Proposal
+ * @package tendermint.types
+ * @see proto type: tendermint.types.Proposal
+ */
 export interface Proposal {
     type: SignedMsgType;
     height: bigint;
@@ -343,6 +496,11 @@ export interface ProposalProtoMsg {
     typeUrl: "/tendermint.types.Proposal";
     value: Uint8Array;
 }
+/**
+ * @name ProposalAmino
+ * @package tendermint.types
+ * @see proto type: tendermint.types.Proposal
+ */
 export interface ProposalAmino {
     type: SignedMsgType;
     height: string;
@@ -356,6 +514,11 @@ export interface ProposalAminoMsg {
     type: "/tendermint.types.Proposal";
     value: ProposalAmino;
 }
+/**
+ * @name SignedHeader
+ * @package tendermint.types
+ * @see proto type: tendermint.types.SignedHeader
+ */
 export interface SignedHeader {
     header?: Header;
     commit?: Commit;
@@ -364,6 +527,11 @@ export interface SignedHeaderProtoMsg {
     typeUrl: "/tendermint.types.SignedHeader";
     value: Uint8Array;
 }
+/**
+ * @name SignedHeaderAmino
+ * @package tendermint.types
+ * @see proto type: tendermint.types.SignedHeader
+ */
 export interface SignedHeaderAmino {
     header?: HeaderAmino;
     commit?: CommitAmino;
@@ -372,6 +540,11 @@ export interface SignedHeaderAminoMsg {
     type: "/tendermint.types.SignedHeader";
     value: SignedHeaderAmino;
 }
+/**
+ * @name LightBlock
+ * @package tendermint.types
+ * @see proto type: tendermint.types.LightBlock
+ */
 export interface LightBlock {
     signedHeader?: SignedHeader;
     validatorSet?: ValidatorSet;
@@ -380,6 +553,11 @@ export interface LightBlockProtoMsg {
     typeUrl: "/tendermint.types.LightBlock";
     value: Uint8Array;
 }
+/**
+ * @name LightBlockAmino
+ * @package tendermint.types
+ * @see proto type: tendermint.types.LightBlock
+ */
 export interface LightBlockAmino {
     signed_header?: SignedHeaderAmino;
     validator_set?: ValidatorSetAmino;
@@ -388,6 +566,11 @@ export interface LightBlockAminoMsg {
     type: "/tendermint.types.LightBlock";
     value: LightBlockAmino;
 }
+/**
+ * @name BlockMeta
+ * @package tendermint.types
+ * @see proto type: tendermint.types.BlockMeta
+ */
 export interface BlockMeta {
     blockId: BlockID;
     blockSize: bigint;
@@ -398,6 +581,11 @@ export interface BlockMetaProtoMsg {
     typeUrl: "/tendermint.types.BlockMeta";
     value: Uint8Array;
 }
+/**
+ * @name BlockMetaAmino
+ * @package tendermint.types
+ * @see proto type: tendermint.types.BlockMeta
+ */
 export interface BlockMetaAmino {
     block_id: BlockIDAmino;
     block_size: string;
@@ -408,7 +596,12 @@ export interface BlockMetaAminoMsg {
     type: "/tendermint.types.BlockMeta";
     value: BlockMetaAmino;
 }
-/** TxProof represents a Merkle proof of the presence of a transaction in the Merkle tree. */
+/**
+ * TxProof represents a Merkle proof of the presence of a transaction in the Merkle tree.
+ * @name TxProof
+ * @package tendermint.types
+ * @see proto type: tendermint.types.TxProof
+ */
 export interface TxProof {
     rootHash: Uint8Array;
     data: Uint8Array;
@@ -418,7 +611,12 @@ export interface TxProofProtoMsg {
     typeUrl: "/tendermint.types.TxProof";
     value: Uint8Array;
 }
-/** TxProof represents a Merkle proof of the presence of a transaction in the Merkle tree. */
+/**
+ * TxProof represents a Merkle proof of the presence of a transaction in the Merkle tree.
+ * @name TxProofAmino
+ * @package tendermint.types
+ * @see proto type: tendermint.types.TxProof
+ */
 export interface TxProofAmino {
     root_hash: string;
     data: string;
@@ -428,6 +626,12 @@ export interface TxProofAminoMsg {
     type: "/tendermint.types.TxProof";
     value: TxProofAmino;
 }
+/**
+ * PartsetHeader
+ * @name PartSetHeader
+ * @package tendermint.types
+ * @see proto type: tendermint.types.PartSetHeader
+ */
 export declare const PartSetHeader: {
     typeUrl: string;
     is(o: any): o is PartSetHeader;
@@ -443,6 +647,11 @@ export declare const PartSetHeader: {
     toProtoMsg(message: PartSetHeader): PartSetHeaderProtoMsg;
     registerTypeUrl(): void;
 };
+/**
+ * @name Part
+ * @package tendermint.types
+ * @see proto type: tendermint.types.Part
+ */
 export declare const Part: {
     typeUrl: string;
     is(o: any): o is Part;
@@ -458,6 +667,12 @@ export declare const Part: {
     toProtoMsg(message: Part): PartProtoMsg;
     registerTypeUrl(): void;
 };
+/**
+ * BlockID
+ * @name BlockID
+ * @package tendermint.types
+ * @see proto type: tendermint.types.BlockID
+ */
 export declare const BlockID: {
     typeUrl: string;
     is(o: any): o is BlockID;
@@ -473,6 +688,12 @@ export declare const BlockID: {
     toProtoMsg(message: BlockID): BlockIDProtoMsg;
     registerTypeUrl(): void;
 };
+/**
+ * Header defines the structure of a block header.
+ * @name Header
+ * @package tendermint.types
+ * @see proto type: tendermint.types.Header
+ */
 export declare const Header: {
     typeUrl: string;
     is(o: any): o is Header;
@@ -488,6 +709,12 @@ export declare const Header: {
     toProtoMsg(message: Header): HeaderProtoMsg;
     registerTypeUrl(): void;
 };
+/**
+ * Data contains the set of transactions included in the block
+ * @name Data
+ * @package tendermint.types
+ * @see proto type: tendermint.types.Data
+ */
 export declare const Data: {
     typeUrl: string;
     is(o: any): o is Data;
@@ -503,6 +730,13 @@ export declare const Data: {
     toProtoMsg(message: Data): DataProtoMsg;
     registerTypeUrl(): void;
 };
+/**
+ * Vote represents a prevote or precommit vote from validators for
+ * consensus.
+ * @name Vote
+ * @package tendermint.types
+ * @see proto type: tendermint.types.Vote
+ */
 export declare const Vote: {
     typeUrl: string;
     is(o: any): o is Vote;
@@ -518,6 +752,12 @@ export declare const Vote: {
     toProtoMsg(message: Vote): VoteProtoMsg;
     registerTypeUrl(): void;
 };
+/**
+ * Commit contains the evidence that a block was committed by a set of validators.
+ * @name Commit
+ * @package tendermint.types
+ * @see proto type: tendermint.types.Commit
+ */
 export declare const Commit: {
     typeUrl: string;
     is(o: any): o is Commit;
@@ -533,6 +773,12 @@ export declare const Commit: {
     toProtoMsg(message: Commit): CommitProtoMsg;
     registerTypeUrl(): void;
 };
+/**
+ * CommitSig is a part of the Vote included in a Commit.
+ * @name CommitSig
+ * @package tendermint.types
+ * @see proto type: tendermint.types.CommitSig
+ */
 export declare const CommitSig: {
     typeUrl: string;
     is(o: any): o is CommitSig;
@@ -548,6 +794,11 @@ export declare const CommitSig: {
     toProtoMsg(message: CommitSig): CommitSigProtoMsg;
     registerTypeUrl(): void;
 };
+/**
+ * @name ExtendedCommit
+ * @package tendermint.types
+ * @see proto type: tendermint.types.ExtendedCommit
+ */
 export declare const ExtendedCommit: {
     typeUrl: string;
     is(o: any): o is ExtendedCommit;
@@ -563,6 +814,14 @@ export declare const ExtendedCommit: {
     toProtoMsg(message: ExtendedCommit): ExtendedCommitProtoMsg;
     registerTypeUrl(): void;
 };
+/**
+ * ExtendedCommitSig retains all the same fields as CommitSig but adds vote
+ * extension-related fields. We use two signatures to ensure backwards compatibility.
+ * That is the digest of the original signature is still the same in prior versions
+ * @name ExtendedCommitSig
+ * @package tendermint.types
+ * @see proto type: tendermint.types.ExtendedCommitSig
+ */
 export declare const ExtendedCommitSig: {
     typeUrl: string;
     is(o: any): o is ExtendedCommitSig;
@@ -578,6 +837,11 @@ export declare const ExtendedCommitSig: {
     toProtoMsg(message: ExtendedCommitSig): ExtendedCommitSigProtoMsg;
     registerTypeUrl(): void;
 };
+/**
+ * @name Proposal
+ * @package tendermint.types
+ * @see proto type: tendermint.types.Proposal
+ */
 export declare const Proposal: {
     typeUrl: string;
     is(o: any): o is Proposal;
@@ -593,6 +857,11 @@ export declare const Proposal: {
     toProtoMsg(message: Proposal): ProposalProtoMsg;
     registerTypeUrl(): void;
 };
+/**
+ * @name SignedHeader
+ * @package tendermint.types
+ * @see proto type: tendermint.types.SignedHeader
+ */
 export declare const SignedHeader: {
     typeUrl: string;
     is(o: any): o is SignedHeader;
@@ -608,6 +877,11 @@ export declare const SignedHeader: {
     toProtoMsg(message: SignedHeader): SignedHeaderProtoMsg;
     registerTypeUrl(): void;
 };
+/**
+ * @name LightBlock
+ * @package tendermint.types
+ * @see proto type: tendermint.types.LightBlock
+ */
 export declare const LightBlock: {
     typeUrl: string;
     is(o: any): o is LightBlock;
@@ -623,6 +897,11 @@ export declare const LightBlock: {
     toProtoMsg(message: LightBlock): LightBlockProtoMsg;
     registerTypeUrl(): void;
 };
+/**
+ * @name BlockMeta
+ * @package tendermint.types
+ * @see proto type: tendermint.types.BlockMeta
+ */
 export declare const BlockMeta: {
     typeUrl: string;
     is(o: any): o is BlockMeta;
@@ -638,6 +917,12 @@ export declare const BlockMeta: {
     toProtoMsg(message: BlockMeta): BlockMetaProtoMsg;
     registerTypeUrl(): void;
 };
+/**
+ * TxProof represents a Merkle proof of the presence of a transaction in the Merkle tree.
+ * @name TxProof
+ * @package tendermint.types
+ * @see proto type: tendermint.types.TxProof
+ */
 export declare const TxProof: {
     typeUrl: string;
     is(o: any): o is TxProof;