@mysten/sui
Version:
Sui TypeScript API
58 lines (57 loc) • 3.08 kB
text/typescript
import { SubscribeCheckpointsRequest, SubscribeCheckpointsResponse } from "./subscription_service.mjs";
import * as _protobuf_ts_runtime5 from "@protobuf-ts/runtime";
import * as _protobuf_ts_runtime_rpc5 from "@protobuf-ts/runtime-rpc";
import { RpcOptions, RpcTransport, ServerStreamingCall, ServiceInfo } from "@protobuf-ts/runtime-rpc";
//#region src/grpc/proto/sui/rpc/v2/subscription_service.client.d.ts
/**
* @generated from protobuf service sui.rpc.v2.SubscriptionService
*/
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
*/
declare class SubscriptionServiceClient implements ISubscriptionServiceClient, ServiceInfo {
private readonly _transport;
typeName: string;
methods: _protobuf_ts_runtime_rpc5.MethodInfo<any, any>[];
options: {
[extensionName: string]: _protobuf_ts_runtime5.JsonValue;
};
constructor(_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>;
}
//#endregion
export { SubscriptionServiceClient };
//# sourceMappingURL=subscription_service.client.d.mts.map