@mysten/sui 1.41.0 → 1.42.0

package/src/grpc/proto/sui/rpc/v2/subscription_service.client.ts

@@ -0,0 +1,69 @@
+// 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/v2/subscription_service.proto" (package "sui.rpc.v2", syntax proto3)
+// tslint:disable
+// @ts-nocheck
+//
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+//
+import type { RpcTransport } from "@protobuf-ts/runtime-rpc";
+import type { ServiceInfo } from "@protobuf-ts/runtime-rpc";
+import { SubscriptionService } from "./subscription_service";
+import { stackIntercept } from "@protobuf-ts/runtime-rpc";
+import type { SubscribeCheckpointsResponse } from "./subscription_service";
+import type { SubscribeCheckpointsRequest } from "./subscription_service";
+import type { ServerStreamingCall } from "@protobuf-ts/runtime-rpc";
+import type { RpcOptions } from "@protobuf-ts/runtime-rpc";
+/**
+ * @generated from protobuf service sui.rpc.v2.SubscriptionService
+ */
+export interface ISubscriptionServiceClient {
+    /**
+     * Subscribe to the stream of checkpoints.
+     *
+     * This API provides a subscription to the checkpoint stream for the Sui
+     * blockchain. When a subscription is initialized the stream will begin with
+     * the latest executed checkpoint as seen by the server. Responses are
+     * guaranteed to return checkpoints in-order and without gaps. This enables
+     * clients to know exactly the last checkpoint they have processed and in the
+     * event the subscription terminates (either by the client/server or by the
+     * connection breaking), clients will be able to reinitialize a subscription
+     * and then leverage other APIs in order to request data for the checkpoints
+     * they missed.
+     *
+     * @generated from protobuf rpc: SubscribeCheckpoints(sui.rpc.v2.SubscribeCheckpointsRequest) returns (stream sui.rpc.v2.SubscribeCheckpointsResponse);
+     */
+    subscribeCheckpoints(input: SubscribeCheckpointsRequest, options?: RpcOptions): ServerStreamingCall<SubscribeCheckpointsRequest, SubscribeCheckpointsResponse>;
+}
+/**
+ * @generated from protobuf service sui.rpc.v2.SubscriptionService
+ */
+export class SubscriptionServiceClient implements ISubscriptionServiceClient, ServiceInfo {
+    typeName = SubscriptionService.typeName;
+    methods = SubscriptionService.methods;
+    options = SubscriptionService.options;
+    constructor(private readonly _transport: RpcTransport) {
+    }
+    /**
+     * Subscribe to the stream of checkpoints.
+     *
+     * This API provides a subscription to the checkpoint stream for the Sui
+     * blockchain. When a subscription is initialized the stream will begin with
+     * the latest executed checkpoint as seen by the server. Responses are
+     * guaranteed to return checkpoints in-order and without gaps. This enables
+     * clients to know exactly the last checkpoint they have processed and in the
+     * event the subscription terminates (either by the client/server or by the
+     * connection breaking), clients will be able to reinitialize a subscription
+     * and then leverage other APIs in order to request data for the checkpoints
+     * they missed.
+     *
+     * @generated from protobuf rpc: SubscribeCheckpoints(sui.rpc.v2.SubscribeCheckpointsRequest) returns (stream sui.rpc.v2.SubscribeCheckpointsResponse);
+     */
+    subscribeCheckpoints(input: SubscribeCheckpointsRequest, options?: RpcOptions): ServerStreamingCall<SubscribeCheckpointsRequest, SubscribeCheckpointsResponse> {
+        const method = this.methods[0], opt = this._transport.mergeOptions(options);
+        return stackIntercept<SubscribeCheckpointsRequest, SubscribeCheckpointsResponse>("serverStreaming", this._transport, method, opt, input);
+    }
+}

package/src/grpc/proto/sui/rpc/v2/subscription_service.ts

@@ -0,0 +1,80 @@
+// 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/v2/subscription_service.proto" (package "sui.rpc.v2", syntax proto3)
+// tslint:disable
+// @ts-nocheck
+//
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+//
+import { ServiceType } from "@protobuf-ts/runtime-rpc";
+import { MessageType } from "@protobuf-ts/runtime";
+import { Checkpoint } from "./checkpoint";
+import { FieldMask } from "../../../google/protobuf/field_mask";
+/**
+ * Request message for SubscriptionService.SubscribeCheckpoints
+ *
+ * @generated from protobuf message sui.rpc.v2.SubscribeCheckpointsRequest
+ */
+export interface SubscribeCheckpointsRequest {
+    /**
+     * Optional. Mask for specifying which parts of the
+     * SubscribeCheckpointsResponse should be returned.
+     *
+     * @generated from protobuf field: optional google.protobuf.FieldMask read_mask = 1;
+     */
+    readMask?: FieldMask;
+}
+/**
+ * Response message for SubscriptionService.SubscribeCheckpoints
+ *
+ * @generated from protobuf message sui.rpc.v2.SubscribeCheckpointsResponse
+ */
+export interface SubscribeCheckpointsResponse {
+    /**
+     * Required. The checkpoint sequence number and value of the current cursor
+     * into the checkpoint stream
+     *
+     * @generated from protobuf field: optional uint64 cursor = 1;
+     */
+    cursor?: bigint;
+    /**
+     * The requested data for this checkpoint
+     *
+     * @generated from protobuf field: optional sui.rpc.v2.Checkpoint checkpoint = 2;
+     */
+    checkpoint?: Checkpoint;
+}
+// @generated message type with reflection information, may provide speed optimized methods
+class SubscribeCheckpointsRequest$Type extends MessageType<SubscribeCheckpointsRequest> {
+    constructor() {
+        super("sui.rpc.v2.SubscribeCheckpointsRequest", [
+            { no: 1, name: "read_mask", kind: "message", T: () => FieldMask }
+        ]);
+    }
+}
+/**
+ * @generated MessageType for protobuf message sui.rpc.v2.SubscribeCheckpointsRequest
+ */
+export const SubscribeCheckpointsRequest = new SubscribeCheckpointsRequest$Type();
+// @generated message type with reflection information, may provide speed optimized methods
+class SubscribeCheckpointsResponse$Type extends MessageType<SubscribeCheckpointsResponse> {
+    constructor() {
+        super("sui.rpc.v2.SubscribeCheckpointsResponse", [
+            { no: 1, name: "cursor", kind: "scalar", opt: true, T: 4 /*ScalarType.UINT64*/, L: 0 /*LongType.BIGINT*/ },
+            { no: 2, name: "checkpoint", kind: "message", T: () => Checkpoint }
+        ]);
+    }
+}
+/**
+ * @generated MessageType for protobuf message sui.rpc.v2.SubscribeCheckpointsResponse
+ */
+export const SubscribeCheckpointsResponse = new SubscribeCheckpointsResponse$Type();
+/**
+ * @generated ServiceType for protobuf service sui.rpc.v2.SubscriptionService
+ */
+export const SubscriptionService = new ServiceType("sui.rpc.v2.SubscriptionService", [
+    { name: "SubscribeCheckpoints", serverStreaming: true, options: {}, I: SubscribeCheckpointsRequest, O: SubscribeCheckpointsResponse }
+]);