sui_rpc/headers.rs
1/// Chain ID of the current chain
2pub const X_SUI_CHAIN_ID: &str = "x-sui-chain-id";
3
4/// Chain name of the current chain
5pub const X_SUI_CHAIN: &str = "x-sui-chain";
6
7/// Current checkpoint height
8pub const X_SUI_CHECKPOINT_HEIGHT: &str = "x-sui-checkpoint-height";
9
10/// Lowest available checkpoint for which transaction and checkpoint data can be requested.
11///
12/// Specifically this is the lowest checkpoint for which the following data can be requested:
13/// - checkpoints
14/// - transactions
15/// - effects
16/// - events
17pub const X_SUI_LOWEST_AVAILABLE_CHECKPOINT: &str = "x-sui-lowest-available-checkpoint";
18
19/// Lowest available checkpoint for which object data can be requested.
20///
21/// Specifically this is the lowest checkpoint for which input/output object data will be
22/// available.
23pub const X_SUI_LOWEST_AVAILABLE_CHECKPOINT_OBJECTS: &str =
24 "x-sui-lowest-available-checkpoint-objects";
25
26/// Current epoch of the chain
27pub const X_SUI_EPOCH: &str = "x-sui-epoch";
28
29/// Current timestamp of the chain - represented as number of milliseconds from the Unix epoch
30pub const X_SUI_TIMESTAMP_MS: &str = "x-sui-timestamp-ms";
31
32/// Current timestamp of the chain - encoded in the [RFC 3339] format.
33///
34/// [RFC 3339]: https://www.ietf.org/rfc/rfc3339.txt
35pub const X_SUI_TIMESTAMP: &str = "x-sui-timestamp";
36
37/// Request header carrying the highest protocol version whose types the client can decode.
38///
39/// The server may use it to avoid sending data the client cannot decode.
40pub const X_SUI_CLIENT_PROTOCOL_VERSION: &str = "x-sui-client-protocol-version";
41
42/// Highest Sui protocol version whose on-chain types this SDK can decode, sent as
43/// [`X_SUI_CLIENT_PROTOCOL_VERSION`].
44///
45/// Bump this when the SDK gains support for types introduced in a newer protocol version.
46pub const MAX_PROTOCOL_VERSION: u64 = 138;