@inco/js 0.2.15 → 0.2.17

package/dist/esm/generated/ts/cometbft/types/v1/params.d.ts

@@ -0,0 +1,179 @@
+import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
+import { Duration } from "../../../google/protobuf/duration";
+export declare const protobufPackage = "cometbft.types.v1";
+/**
+ * ConsensusParams contains consensus critical parameters that determine the
+ * validity of blocks.
+ */
+export interface ConsensusParams {
+    block: BlockParams | undefined;
+    evidence: EvidenceParams | undefined;
+    validator: ValidatorParams | undefined;
+    version: VersionParams | undefined;
+    /**
+     * Use FeatureParams.vote_extensions_enable_height instead
+     *
+     * @deprecated
+     */
+    abci: ABCIParams | undefined;
+    synchrony: SynchronyParams | undefined;
+    feature: FeatureParams | undefined;
+}
+/** BlockParams define limits on the block size and gas. */
+export interface BlockParams {
+    /**
+     * Maximum size of a block, in bytes.
+     *
+     * Must be greater or equal to -1 and cannot be greater than the hard-coded
+     * maximum block size, which is 100MB.
+     *
+     * If set to -1, the limit is the hard-coded maximum block size.
+     */
+    maxBytes: number;
+    /**
+     * Maximum gas wanted by transactions included in a block.
+     *
+     * Must be greater or equal to -1. If set to -1, no limit is enforced.
+     */
+    maxGas: number;
+}
+/** EvidenceParams determine the validity of evidences of Byzantine behavior. */
+export interface EvidenceParams {
+    /**
+     * Maximum age of evidence, in blocks.
+     *
+     * The recommended formula for calculating it is max_age_duration / {average
+     * block time}.
+     */
+    maxAgeNumBlocks: number;
+    /**
+     * Maximum age of evidence, in time.
+     *
+     * The recommended value of is should correspond to the application's
+     * "unbonding period" or other similar mechanism for handling
+     * Nothing-At-Stake attacks.
+     * See: https://github.com/ethereum/wiki/wiki/Proof-of-Stake-FAQ#what-is-the-nothing-at-stake-problem-and-how-can-it-be-fixed.
+     */
+    maxAgeDuration: Duration | undefined;
+    /**
+     * Maximum size in bytes of evidence allowed to be included in a block.
+     *
+     * It should fall comfortably under the maximum size of a block.
+     */
+    maxBytes: number;
+}
+/**
+ * ValidatorParams restrict the public key types validators can use.
+ *
+ * NOTE: uses ABCI public keys naming, not Amino names.
+ */
+export interface ValidatorParams {
+    pubKeyTypes: string[];
+}
+/** VersionParams contain the version of specific components of CometBFT. */
+export interface VersionParams {
+    /**
+     * The ABCI application version.
+     *
+     * It was named app_version in CometBFT 0.34.
+     */
+    app: number;
+}
+/**
+ * HashedParams is a subset of ConsensusParams.
+ *
+ * It is hashed into the Header.ConsensusHash.
+ */
+export interface HashedParams {
+    blockMaxBytes: number;
+    blockMaxGas: number;
+}
+/**
+ * SynchronyParams determine the validity of block timestamps.
+ *
+ * These parameters are part of the Proposer-Based Timestamps (PBTS) algorithm.
+ * For more information on the relationship of the synchrony parameters to
+ * block timestamps validity, refer to the PBTS specification:
+ * https://github.com/tendermint/spec/blob/master/spec/consensus/proposer-based-timestamp/README.md
+ */
+export interface SynchronyParams {
+    /**
+     * Bound for how skewed a proposer's clock may be from any validator on the
+     * network while still producing valid proposals.
+     */
+    precision: Duration | undefined;
+    /**
+     * Bound for how long a proposal message may take to reach all validators on
+     * a network and still be considered valid.
+     */
+    messageDelay: Duration | undefined;
+}
+/** FeatureParams configure the height from which features of CometBFT are enabled. */
+export interface FeatureParams {
+    /**
+     * First height during which vote extensions will be enabled.
+     *
+     * During the specified height, and for all subsequent heights, precommit
+     * messages that do not contain valid extension data will be considered
+     * invalid. Prior to this height, or when this height is set to 0, vote
+     * extensions will not be used or accepted by validators on the network.
+     *
+     * Once enabled, vote extensions will be created by the application in
+     * ExtendVote, validated by the application in VerifyVoteExtension, and
+     * used by the application in PrepareProposal, when proposing the next block.
+     *
+     * Cannot be set to heights lower or equal to the current blockchain height.
+     */
+    voteExtensionsEnableHeight: number | undefined;
+    /**
+     * Height at which Proposer-Based Timestamps (PBTS) will be enabled.
+     *
+     * From the specified height, and for all subsequent heights, the PBTS
+     * algorithm will be used to produce and validate block timestamps. Prior to
+     * this height, or when this height is set to 0, the legacy BFT Time
+     * algorithm is used to produce and validate timestamps.
+     *
+     * Cannot be set to heights lower or equal to the current blockchain height.
+     */
+    pbtsEnableHeight: number | undefined;
+}
+/**
+ * ABCIParams is deprecated and its contents moved to FeatureParams
+ *
+ * @deprecated
+ */
+export interface ABCIParams {
+    /**
+     * vote_extensions_enable_height has been deprecated.
+     * Instead, use FeatureParams.vote_extensions_enable_height.
+     */
+    voteExtensionsEnableHeight: number;
+}
+export declare const ConsensusParams: MessageFns<ConsensusParams>;
+export declare const BlockParams: MessageFns<BlockParams>;
+export declare const EvidenceParams: MessageFns<EvidenceParams>;
+export declare const ValidatorParams: MessageFns<ValidatorParams>;
+export declare const VersionParams: MessageFns<VersionParams>;
+export declare const HashedParams: MessageFns<HashedParams>;
+export declare const SynchronyParams: MessageFns<SynchronyParams>;
+export declare const FeatureParams: MessageFns<FeatureParams>;
+export declare const ABCIParams: MessageFns<ABCIParams>;
+type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
+export type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : Partial<T>;
+type KeysOfUnion<T> = T extends T ? keyof T : never;
+export type Exact<P, I extends P> = P extends Builtin ? P : P & {
+    [K in keyof P]: Exact<P[K], I[K]>;
+} & {
+    [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
+};
+export interface MessageFns<T> {
+    encode(message: T, writer?: BinaryWriter): BinaryWriter;
+    decode(input: BinaryReader | Uint8Array, length?: number): T;
+    fromJSON(object: any): T;
+    toJSON(message: T): unknown;
+    create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
+    fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
+}
+export {};