@mysten/sui 1.40.0 → 1.41.0

package/src/grpc/proto/sui/rpc/v2beta2/checkpoint_summary.ts

@@ -0,0 +1,295 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+// @generated by protobuf-ts 2.9.6 with parameter force_server_none,optimize_code_size,ts_nocheck
+// @generated from protobuf file "sui/rpc/v2beta2/checkpoint_summary.proto" (package "sui.rpc.v2beta2", syntax proto3)
+// tslint:disable
+// @ts-nocheck
+//
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+//
+import { MessageType } from '@protobuf-ts/runtime';
+import { ValidatorCommitteeMember } from './signature.js';
+import { Timestamp } from '../../../google/protobuf/timestamp.js';
+import { GasCostSummary } from './gas_cost_summary.js';
+import { Bcs } from './bcs.js';
+/**
+ * A header for a checkpoint on the Sui blockchain.
+ *
+ * On the Sui network, checkpoints define the history of the blockchain. They are quite similar to
+ * the concept of blocks used by other blockchains like Bitcoin or Ethereum. The Sui blockchain,
+ * however, forms checkpoints after transaction execution has already happened to provide a
+ * certified history of the chain, instead of being formed before execution.
+ *
+ * Checkpoints commit to a variety of state, including but not limited to:
+ * - The hash of the previous checkpoint.
+ * - The set of transaction digests, their corresponding effects digests, as well as the set of
+ *   user signatures that authorized its execution.
+ * - The objects produced by a transaction.
+ * - The set of live objects that make up the current state of the chain.
+ * - On epoch transitions, the next validator committee.
+ *
+ * `CheckpointSummary`s themselves don't directly include all of the previous information but they
+ * are the top-level type by which all the information is committed to transitively via cryptographic
+ * hashes included in the summary. `CheckpointSummary`s are signed and certified by a quorum of
+ * the validator committee in a given epoch to allow verification of the chain's state.
+ *
+ * @generated from protobuf message sui.rpc.v2beta2.CheckpointSummary
+ */
+export interface CheckpointSummary {
+	/**
+	 * This CheckpointSummary serialized as BCS.
+	 *
+	 * @generated from protobuf field: optional sui.rpc.v2beta2.Bcs bcs = 1;
+	 */
+	bcs?: Bcs;
+	/**
+	 * The digest of this CheckpointSummary.
+	 *
+	 * @generated from protobuf field: optional string digest = 2;
+	 */
+	digest?: string;
+	/**
+	 * Epoch that this checkpoint belongs to.
+	 *
+	 * @generated from protobuf field: optional uint64 epoch = 3;
+	 */
+	epoch?: bigint;
+	/**
+	 * The height of this checkpoint.
+	 *
+	 * @generated from protobuf field: optional uint64 sequence_number = 4;
+	 */
+	sequenceNumber?: bigint;
+	/**
+	 * Total number of transactions committed since genesis, including those in this
+	 * checkpoint.
+	 *
+	 * @generated from protobuf field: optional uint64 total_network_transactions = 5;
+	 */
+	totalNetworkTransactions?: bigint;
+	/**
+	 * The hash of the `CheckpointContents` for this checkpoint.
+	 *
+	 * @generated from protobuf field: optional string content_digest = 6;
+	 */
+	contentDigest?: string;
+	/**
+	 * The hash of the previous `CheckpointSummary`.
+	 *
+	 * This will be `None` only for the first, or genesis, checkpoint.
+	 *
+	 * @generated from protobuf field: optional string previous_digest = 7;
+	 */
+	previousDigest?: string;
+	/**
+	 * The running total gas costs of all transactions included in the current epoch so far
+	 * until this checkpoint.
+	 *
+	 * @generated from protobuf field: optional sui.rpc.v2beta2.GasCostSummary epoch_rolling_gas_cost_summary = 8;
+	 */
+	epochRollingGasCostSummary?: GasCostSummary;
+	/**
+	 * Timestamp of the checkpoint - number of milliseconds from the Unix epoch
+	 * Checkpoint timestamps are monotonic, but not strongly monotonic - subsequent
+	 * checkpoints can have the same timestamp if they originate from the same underlining consensus commit.
+	 *
+	 * @generated from protobuf field: optional google.protobuf.Timestamp timestamp = 9;
+	 */
+	timestamp?: Timestamp;
+	/**
+	 * Commitments to checkpoint-specific state.
+	 *
+	 * @generated from protobuf field: repeated sui.rpc.v2beta2.CheckpointCommitment commitments = 10;
+	 */
+	commitments: CheckpointCommitment[];
+	/**
+	 * Extra data only present in the final checkpoint of an epoch.
+	 *
+	 * @generated from protobuf field: optional sui.rpc.v2beta2.EndOfEpochData end_of_epoch_data = 11;
+	 */
+	endOfEpochData?: EndOfEpochData;
+	/**
+	 * `CheckpointSummary` is not an evolvable structure - it must be readable by any version of
+	 * the code. Therefore, to allow extensions to be added to `CheckpointSummary`,
+	 * opaque data can be added to checkpoints, which can be deserialized based on the current
+	 * protocol version.
+	 *
+	 * @generated from protobuf field: optional bytes version_specific_data = 12;
+	 */
+	versionSpecificData?: Uint8Array;
+}
+/**
+ * Data, which when included in a `CheckpointSummary`, signals the end of an `Epoch`.
+ *
+ * @generated from protobuf message sui.rpc.v2beta2.EndOfEpochData
+ */
+export interface EndOfEpochData {
+	/**
+	 * The set of validators that will be in the `ValidatorCommittee` for the next epoch.
+	 *
+	 * @generated from protobuf field: repeated sui.rpc.v2beta2.ValidatorCommitteeMember next_epoch_committee = 1;
+	 */
+	nextEpochCommittee: ValidatorCommitteeMember[];
+	/**
+	 * The protocol version that is in effect during the next epoch.
+	 *
+	 * @generated from protobuf field: optional uint64 next_epoch_protocol_version = 2;
+	 */
+	nextEpochProtocolVersion?: bigint;
+	/**
+	 * Commitments to epoch specific state (live object set)
+	 *
+	 * @generated from protobuf field: repeated sui.rpc.v2beta2.CheckpointCommitment epoch_commitments = 3;
+	 */
+	epochCommitments: CheckpointCommitment[];
+}
+/**
+ * A commitment made by a checkpoint.
+ *
+ * @generated from protobuf message sui.rpc.v2beta2.CheckpointCommitment
+ */
+export interface CheckpointCommitment {
+	/**
+	 * @generated from protobuf field: optional sui.rpc.v2beta2.CheckpointCommitment.CheckpointCommitmentKind kind = 1;
+	 */
+	kind?: CheckpointCommitment_CheckpointCommitmentKind;
+	/**
+	 * @generated from protobuf field: optional string digest = 2;
+	 */
+	digest?: string;
+}
+/**
+ * @generated from protobuf enum sui.rpc.v2beta2.CheckpointCommitment.CheckpointCommitmentKind
+ */
+export enum CheckpointCommitment_CheckpointCommitmentKind {
+	/**
+	 * @generated from protobuf enum value: CHECKPOINT_COMMITMENT_KIND_UNKNOWN = 0;
+	 */
+	CHECKPOINT_COMMITMENT_KIND_UNKNOWN = 0,
+	/**
+	 * An elliptic curve multiset hash attesting to the set of objects that
+	 * comprise the live state of the Sui blockchain.
+	 *
+	 * @generated from protobuf enum value: ECMH_LIVE_OBJECT_SET = 1;
+	 */
+	ECMH_LIVE_OBJECT_SET = 1,
+	/**
+	 * Digest of the checkpoint artifacts.
+	 *
+	 * @generated from protobuf enum value: CHECKPOINT_ARTIFACTS = 2;
+	 */
+	CHECKPOINT_ARTIFACTS = 2,
+}
+// @generated message type with reflection information, may provide speed optimized methods
+class CheckpointSummary$Type extends MessageType<CheckpointSummary> {
+	constructor() {
+		super('sui.rpc.v2beta2.CheckpointSummary', [
+			{ no: 1, name: 'bcs', kind: 'message', T: () => Bcs },
+			{ no: 2, name: 'digest', kind: 'scalar', opt: true, T: 9 /*ScalarType.STRING*/ },
+			{
+				no: 3,
+				name: 'epoch',
+				kind: 'scalar',
+				opt: true,
+				T: 4 /*ScalarType.UINT64*/,
+				L: 0 /*LongType.BIGINT*/,
+			},
+			{
+				no: 4,
+				name: 'sequence_number',
+				kind: 'scalar',
+				opt: true,
+				T: 4 /*ScalarType.UINT64*/,
+				L: 0 /*LongType.BIGINT*/,
+			},
+			{
+				no: 5,
+				name: 'total_network_transactions',
+				kind: 'scalar',
+				opt: true,
+				T: 4 /*ScalarType.UINT64*/,
+				L: 0 /*LongType.BIGINT*/,
+			},
+			{ no: 6, name: 'content_digest', kind: 'scalar', opt: true, T: 9 /*ScalarType.STRING*/ },
+			{ no: 7, name: 'previous_digest', kind: 'scalar', opt: true, T: 9 /*ScalarType.STRING*/ },
+			{ no: 8, name: 'epoch_rolling_gas_cost_summary', kind: 'message', T: () => GasCostSummary },
+			{ no: 9, name: 'timestamp', kind: 'message', T: () => Timestamp },
+			{
+				no: 10,
+				name: 'commitments',
+				kind: 'message',
+				repeat: 1 /*RepeatType.PACKED*/,
+				T: () => CheckpointCommitment,
+			},
+			{ no: 11, name: 'end_of_epoch_data', kind: 'message', T: () => EndOfEpochData },
+			{
+				no: 12,
+				name: 'version_specific_data',
+				kind: 'scalar',
+				opt: true,
+				T: 12 /*ScalarType.BYTES*/,
+			},
+		]);
+	}
+}
+/**
+ * @generated MessageType for protobuf message sui.rpc.v2beta2.CheckpointSummary
+ */
+export const CheckpointSummary = new CheckpointSummary$Type();
+// @generated message type with reflection information, may provide speed optimized methods
+class EndOfEpochData$Type extends MessageType<EndOfEpochData> {
+	constructor() {
+		super('sui.rpc.v2beta2.EndOfEpochData', [
+			{
+				no: 1,
+				name: 'next_epoch_committee',
+				kind: 'message',
+				repeat: 1 /*RepeatType.PACKED*/,
+				T: () => ValidatorCommitteeMember,
+			},
+			{
+				no: 2,
+				name: 'next_epoch_protocol_version',
+				kind: 'scalar',
+				opt: true,
+				T: 4 /*ScalarType.UINT64*/,
+				L: 0 /*LongType.BIGINT*/,
+			},
+			{
+				no: 3,
+				name: 'epoch_commitments',
+				kind: 'message',
+				repeat: 1 /*RepeatType.PACKED*/,
+				T: () => CheckpointCommitment,
+			},
+		]);
+	}
+}
+/**
+ * @generated MessageType for protobuf message sui.rpc.v2beta2.EndOfEpochData
+ */
+export const EndOfEpochData = new EndOfEpochData$Type();
+// @generated message type with reflection information, may provide speed optimized methods
+class CheckpointCommitment$Type extends MessageType<CheckpointCommitment> {
+	constructor() {
+		super('sui.rpc.v2beta2.CheckpointCommitment', [
+			{
+				no: 1,
+				name: 'kind',
+				kind: 'enum',
+				opt: true,
+				T: () => [
+					'sui.rpc.v2beta2.CheckpointCommitment.CheckpointCommitmentKind',
+					CheckpointCommitment_CheckpointCommitmentKind,
+				],
+			},
+			{ no: 2, name: 'digest', kind: 'scalar', opt: true, T: 9 /*ScalarType.STRING*/ },
+		]);
+	}
+}
+/**
+ * @generated MessageType for protobuf message sui.rpc.v2beta2.CheckpointCommitment
+ */
+export const CheckpointCommitment = new CheckpointCommitment$Type();