sui_rpc_api/grpc/v2/
subscription_service.rs

1// Copyright (c) Mysten Labs, Inc.
2// SPDX-License-Identifier: Apache-2.0
3
4use std::pin::Pin;
5
6use crate::RpcService;
7use sui_rpc::field::FieldMaskTree;
8use sui_rpc::merge::Merge;
9use sui_rpc::proto::sui::rpc::v2::Checkpoint;
10use sui_rpc::proto::sui::rpc::v2::SubscribeCheckpointsRequest;
11use sui_rpc::proto::sui::rpc::v2::SubscribeCheckpointsResponse;
12use sui_rpc::proto::sui::rpc::v2::subscription_service_server::SubscriptionService;
13use sui_types::balance_change::derive_balance_changes_2;
14
15#[tonic::async_trait]
16impl SubscriptionService for RpcService {
17    /// Server streaming response type for the SubscribeCheckpoints method.
18    type SubscribeCheckpointsStream = Pin<
19        Box<
20            dyn tokio_stream::Stream<Item = Result<SubscribeCheckpointsResponse, tonic::Status>>
21                + Send,
22        >,
23    >;
24
25    async fn subscribe_checkpoints(
26        &self,
27        request: tonic::Request<SubscribeCheckpointsRequest>,
28    ) -> Result<tonic::Response<Self::SubscribeCheckpointsStream>, tonic::Status> {
29        let subscription_service_handle = self
30            .subscription_service_handle
31            .as_ref()
32            .ok_or_else(|| tonic::Status::unimplemented("subscription service not enabled"))?;
33        let read_mask = request.into_inner().read_mask.unwrap_or_default();
34        let read_mask = FieldMaskTree::from(read_mask);
35
36        let Some(mut receiver) = subscription_service_handle.register_subscription().await else {
37            return Err(tonic::Status::unavailable(
38                "too many existing subscriptions",
39            ));
40        };
41
42        let response = Box::pin(async_stream::stream! {
43            while let Some(checkpoint) = receiver.recv().await {
44                let cursor = checkpoint.summary.sequence_number;
45
46                let mut checkpoint_message = Checkpoint::merge_from(
47                    checkpoint.as_ref(),
48                    &read_mask
49                );
50
51                if read_mask.contains("transactions.balance_changes") {
52                    for (txn, effects) in checkpoint_message.transactions_mut().iter_mut().zip(
53                        checkpoint
54                            .transactions
55                            .iter()
56                            .map(|t| &t.effects),
57                    ) {
58                        *txn.balance_changes_mut() = derive_balance_changes_2(effects, &checkpoint.object_set)
59                            .into_iter()
60                            .map(Into::into)
61                            .collect();
62                    }
63                }
64
65                let mut response = SubscribeCheckpointsResponse::default();
66                response.cursor = Some(cursor);
67                response.checkpoint = Some(checkpoint_message);
68
69                yield Ok(response);
70            }
71        });
72
73        Ok(tonic::Response::new(response))
74    }
75}
sui_rpc_api/grpc/v2/subscription_service.rs

sui_rpc_api/grpc/v2/
subscription_service.rs
