package sui.rpc.v2alpha
Get desktop application:
View/edit binary Protocol Buffers messages
message
live_data_service.proto:84Request message for `NodeService.ListDynamicFields`
optional string parent = 1
Required. The `UID` of the parent, which owns the collections of dynamic fields.
optional uint32 page_size = 2
The maximum number of dynamic fields to return. The service may return fewer than this value. If unspecified, at most `50` entries will be returned. The maximum value is `1000`; values above `1000` will be coerced to `1000`.
optional bytes page_token = 3
A page token, received from a previous `ListDynamicFields` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDynamicFields` must match the call that provided the page token.
message
live_data_service.proto:102Response message for `NodeService.ListDynamicFields`
repeated dynamic_fields = 1
Page of dynamic fields owned by the specified parent.
optional bytes next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
message
live_data_service.proto:166optional string owner = 1
Required. The address of the account that owns the objects.
optional string object_type = 4
Optional type filter to limit the types of objects listed. Providing an object type with no type params will return objects of that type with any type parameter, e.g. `0x2::coin::Coin` will return all `Coin<T>` objects regardless of the type parameter `T`. Providing a type with a type param will retrict the returned objects to only those objects that match the provided type parameters, e.g. `0x2::coin::Coin<0x2::sui::SUI>` will only return `Coin<SUI>` objects.
optional uint32 page_size = 2
The maximum number of entries return. The service may return fewer than this value. If unspecified, at most `50` entries will be returned. The maximum value is `1000`; values above `1000` will be coerced to `1000`.
optional bytes page_token = 3
A page token, received from a previous `ListOwnedObjects` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListOwnedObjects` must match the call that provided the page token.
message
live_data_service.proto:193repeated objects = 1
Page of dynamic fields owned by the specified parent.
optional bytes next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
get balance? list balance?
message
live_data_service.proto:25Request message for `NodeService.GetCoinInfo`.
optional string coin_type = 1
The coin type to request information about
message
live_data_service.proto:31Response message for `NodeService.GetCoinInfo`.
optional string coin_type = 1
Required. The coin type.
optional metadata = 2
This field will be populated with information about this coin type's `0x2::coin::CoinMetadata` if it exists and has not been wrapped.
optional treasury = 3
This field will be populated with information about this coin type's `0x2::coin::TreasuryCap` if it exists and has not been wrapped.
optional regulated_metadata = 4
If this coin type is a regulated coin, this field will be populated with information about its `0x2::coin::RegulatedCoinMetadata` object.
message
live_data_service.proto:147optional transaction = 1
optional read_mask = 2
ViewFunction?
message
live_data_service.proto:156optional unresolved_transaction = 1
optional read_mask = 2
message
live_data_service.proto:161optional transaction = 1
optional simulation = 2
rpc SubscribeCheckpoints (, stream )
subscription_service.proto:23Subscribe 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 gaurenteed 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 reinitailize a subscription and then leverage other APIs in order to request data for the checkpoints they missed.
message
subscription_service.proto:27Request message for SubscriptionService.SubscribeCheckpoints
optional read_mask = 1
Optional. Mask for specifiying which parts of the SubscribeCheckpointsResponse should be returned.
message
subscription_service.proto:34Response message for SubscriptionService.SubscribeCheckpoints
optional uint64 cursor = 1
Required. The checkpoint sequence number and value of the current cursor into the checkpoint stream
optional checkpoint = 2
The requested data for this checkpoint
message
live_data_service.proto:50Metadata for a coin type
Used in:
optional string id = 1
ObjectId of the `0x2::coin::CoinMetadata` object.
optional uint32 decimals = 2
Number of decimal places to coin uses.
optional string name = 3
Name for the token
optional string symbol = 4
Symbol for the token
optional string description = 5
Description of the token
optional string icon_url = 6
URL for the token logo
message
live_data_service.proto:66Information about a coin type's `0x2::coin::TreasuryCap` and its total available supply
Used in:
optional string id = 1
ObjectId of the `0x2::coin::TreasuryCap` object.
optional uint64 total_supply = 2
Total available supply for this coin type.
message
live_data_service.proto:111Used in:
optional DynamicField.DynamicFieldKind kind = 1
optional string parent = 2
ObjectId of this dynamic field's parent.
optional string field_id = 3
ObjectId of this dynamic field.
optional string name_type = 4
The type of the dynamic field "name"
optional bytes name_value = 5
The serialized move value of "name"
optional string value_type = 6
The type of the dynamic field "value". If this is a dynamic object field then this is the type of the object itself (which is a child of this field), otherwise this is the type of the value of this field.
optional string dynamic_object_id = 7
The ObjectId of the child object when a child is a dynamic object field. The presence or absence of this field can be used to determine if a child is a dynamic field or a dynamic child object
Used in:
DYNAMIC_FIELD_KIND_UNKNOWN = 0
FIELD = 1
OBJECT = 2
message
live_data_service.proto:202Used in:
optional string object_id = 2
optional uint64 version = 3
optional string digest = 4
optional owner = 5
optional string object_type = 6
optional uint64 balance = 200
Current balance if this object is a `0x2::coin::Coin<T>`
message
live_data_service.proto:74Information about a regulated coin, which indicates that it makes use of the transfer deny list.
Used in:
optional string id = 1
ObjectId of the `0x2::coin::RegulatedCoinMetadata` object.
optional string coin_metadata_object = 2
The ID of the coin's `CoinMetadata` object.
optional string deny_cap_object = 3
The ID of the coin's `DenyCap` object.
message
live_data_service.proto:152Used as response type in: LiveDataService.SimulateTransaction
Used as field type in:
optional transaction = 1