Struct IndexerApi

pub struct IndexerApi<R> {
    pub metrics: Arc<JsonRpcMetrics>,
    /* private fields */
}

Fields

metrics: Arc<JsonRpcMetrics>

Implementations

impl<R: ReadApiServer> IndexerApi<R>

pub fn new( state: Arc<AuthorityState>, read_api: R, transaction_kv_store: Arc<TransactionKeyValueStore>, name_service_config: NameServiceConfig, metrics: Arc<JsonRpcMetrics>, max_subscriptions: Option<usize>, ) -> Self

Trait Implementations

impl<R: ReadApiServer> IndexerApiServer for IndexerApi<R>

fn get_owned_objects<'life0, 'async_trait>( &'life0 self, address: SuiAddress, query: Option<SuiObjectResponseQuery>, cursor: Option<ObjectID>, limit: Option<usize>, ) -> Pin<Box<dyn Future<Output = RpcResult<ObjectsPage>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Return the list of objects owned by an address. Note that if the address owns more than QUERY_MAX_RESULT_LIMIT objects, the pagination is not accurate, because previous page may have been updated when the next page is fetched. Please use suix_queryObjects if this is a concern.

fn query_transaction_blocks<'life0, 'async_trait>( &'life0 self, query: SuiTransactionBlockResponseQuery, cursor: Option<TransactionDigest>, limit: Option<usize>, descending_order: Option<bool>, ) -> Pin<Box<dyn Future<Output = RpcResult<TransactionBlocksPage>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Return list of transactions for a specified query criteria.

fn query_events<'life0, 'async_trait>( &'life0 self, query: EventFilter, cursor: Option<EventID>, limit: Option<usize>, descending_order: Option<bool>, ) -> Pin<Box<dyn Future<Output = RpcResult<EventPage>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Return list of events for a specified query criteria.

fn subscribe_event( &self, sink: PendingSubscriptionSink, filter: EventFilter, ) -> SubscriptionResult

Subscribe to a stream of Sui event

fn subscribe_transaction( &self, sink: PendingSubscriptionSink, filter: TransactionFilter, ) -> SubscriptionResult

Subscribe to a stream of Sui transaction effects

fn get_dynamic_fields<'life0, 'async_trait>( &'life0 self, parent_object_id: ObjectID, cursor: Option<ObjectID>, limit: Option<usize>, ) -> Pin<Box<dyn Future<Output = RpcResult<DynamicFieldPage>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Return the list of dynamic field objects owned by an object.

fn get_dynamic_field_object<'life0, 'async_trait>( &'life0 self, parent_object_id: ObjectID, name: DynamicFieldName, ) -> Pin<Box<dyn Future<Output = RpcResult<SuiObjectResponse>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Return the dynamic field object information for a specified object

fn resolve_name_service_address<'life0, 'async_trait>( &'life0 self, name: String, ) -> Pin<Box<dyn Future<Output = RpcResult<Option<SuiAddress>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Return the resolved address given resolver and name

fn resolve_name_service_names<'life0, 'async_trait>( &'life0 self, address: SuiAddress, _cursor: Option<ObjectID>, _limit: Option<usize>, ) -> Pin<Box<dyn Future<Output = RpcResult<Page<String, ObjectID>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Return the resolved names given address, if multiple names are resolved, the first one is the primary name.

fn into_rpc(self) -> RpcModule<Self>

Collects all the methods and subscriptions defined in the trait and adds them into a single RpcModule.

impl<R: ReadApiServer> SuiRpcModule for IndexerApi<R>

fn rpc(self) -> RpcModule<Self>

fn rpc_doc_module() -> Module