sui-rpc 0.3.2

RPC interface definitions and client for the Sui Sdk
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
pub(crate) mod _field_impls {
    #![allow(clippy::wrong_self_convention)]
    use super::*;
    use crate::field::MessageFields;
    use crate::field::MessageField;
    impl MerkleNode {
        pub const EMPTY_FIELD: &'static MessageField = &MessageField {
            name: "empty",
            json_name: "empty",
            number: 1i32,
            message_fields: None,
        };
        pub const DIGEST_FIELD: &'static MessageField = &MessageField {
            name: "digest",
            json_name: "digest",
            number: 2i32,
            message_fields: None,
        };
    }
    impl MessageFields for MerkleNode {
        const FIELDS: &'static [&'static MessageField] = &[
            Self::EMPTY_FIELD,
            Self::DIGEST_FIELD,
        ];
    }
    impl MerkleNode {
        pub fn path_builder() -> MerkleNodeFieldPathBuilder {
            MerkleNodeFieldPathBuilder::new()
        }
    }
    pub struct MerkleNodeFieldPathBuilder {
        path: Vec<&'static str>,
    }
    impl MerkleNodeFieldPathBuilder {
        #[allow(clippy::new_without_default)]
        pub fn new() -> Self {
            Self { path: Default::default() }
        }
        #[doc(hidden)]
        pub fn new_with_base(base: Vec<&'static str>) -> Self {
            Self { path: base }
        }
        pub fn finish(self) -> String {
            self.path.join(".")
        }
        pub fn empty(mut self) -> String {
            self.path.push(MerkleNode::EMPTY_FIELD.name);
            self.finish()
        }
        pub fn digest(mut self) -> String {
            self.path.push(MerkleNode::DIGEST_FIELD.name);
            self.finish()
        }
    }
    impl MerkleProof {
        pub const PATH_FIELD: &'static MessageField = &MessageField {
            name: "path",
            json_name: "path",
            number: 1i32,
            message_fields: Some(MerkleNode::FIELDS),
        };
    }
    impl MessageFields for MerkleProof {
        const FIELDS: &'static [&'static MessageField] = &[Self::PATH_FIELD];
    }
    impl MerkleProof {
        pub fn path_builder() -> MerkleProofFieldPathBuilder {
            MerkleProofFieldPathBuilder::new()
        }
    }
    pub struct MerkleProofFieldPathBuilder {
        path: Vec<&'static str>,
    }
    impl MerkleProofFieldPathBuilder {
        #[allow(clippy::new_without_default)]
        pub fn new() -> Self {
            Self { path: Default::default() }
        }
        #[doc(hidden)]
        pub fn new_with_base(base: Vec<&'static str>) -> Self {
            Self { path: base }
        }
        pub fn finish(self) -> String {
            self.path.join(".")
        }
        pub fn path(mut self) -> MerkleNodeFieldPathBuilder {
            self.path.push(MerkleProof::PATH_FIELD.name);
            MerkleNodeFieldPathBuilder::new_with_base(self.path)
        }
    }
    impl MerkleNonInclusionProof {
        pub const INDEX_FIELD: &'static MessageField = &MessageField {
            name: "index",
            json_name: "index",
            number: 1i32,
            message_fields: None,
        };
        pub const LEFT_LEAF_FIELD: &'static MessageField = &MessageField {
            name: "left_leaf",
            json_name: "leftLeaf",
            number: 2i32,
            message_fields: Some(MerkleNeighbourLeaf::FIELDS),
        };
        pub const RIGHT_LEAF_FIELD: &'static MessageField = &MessageField {
            name: "right_leaf",
            json_name: "rightLeaf",
            number: 3i32,
            message_fields: Some(MerkleNeighbourLeaf::FIELDS),
        };
    }
    impl MessageFields for MerkleNonInclusionProof {
        const FIELDS: &'static [&'static MessageField] = &[
            Self::INDEX_FIELD,
            Self::LEFT_LEAF_FIELD,
            Self::RIGHT_LEAF_FIELD,
        ];
    }
    impl MerkleNonInclusionProof {
        pub fn path_builder() -> MerkleNonInclusionProofFieldPathBuilder {
            MerkleNonInclusionProofFieldPathBuilder::new()
        }
    }
    pub struct MerkleNonInclusionProofFieldPathBuilder {
        path: Vec<&'static str>,
    }
    impl MerkleNonInclusionProofFieldPathBuilder {
        #[allow(clippy::new_without_default)]
        pub fn new() -> Self {
            Self { path: Default::default() }
        }
        #[doc(hidden)]
        pub fn new_with_base(base: Vec<&'static str>) -> Self {
            Self { path: base }
        }
        pub fn finish(self) -> String {
            self.path.join(".")
        }
        pub fn index(mut self) -> String {
            self.path.push(MerkleNonInclusionProof::INDEX_FIELD.name);
            self.finish()
        }
        pub fn left_leaf(mut self) -> MerkleNeighbourLeafFieldPathBuilder {
            self.path.push(MerkleNonInclusionProof::LEFT_LEAF_FIELD.name);
            MerkleNeighbourLeafFieldPathBuilder::new_with_base(self.path)
        }
        pub fn right_leaf(mut self) -> MerkleNeighbourLeafFieldPathBuilder {
            self.path.push(MerkleNonInclusionProof::RIGHT_LEAF_FIELD.name);
            MerkleNeighbourLeafFieldPathBuilder::new_with_base(self.path)
        }
    }
    impl MerkleNeighbourLeaf {
        pub const LEAF_FIELD: &'static MessageField = &MessageField {
            name: "leaf",
            json_name: "leaf",
            number: 1i32,
            message_fields: Some(ObjectReference::FIELDS),
        };
        pub const MERKLE_PROOF_FIELD: &'static MessageField = &MessageField {
            name: "merkle_proof",
            json_name: "merkleProof",
            number: 2i32,
            message_fields: Some(MerkleProof::FIELDS),
        };
    }
    impl MessageFields for MerkleNeighbourLeaf {
        const FIELDS: &'static [&'static MessageField] = &[
            Self::LEAF_FIELD,
            Self::MERKLE_PROOF_FIELD,
        ];
    }
    impl MerkleNeighbourLeaf {
        pub fn path_builder() -> MerkleNeighbourLeafFieldPathBuilder {
            MerkleNeighbourLeafFieldPathBuilder::new()
        }
    }
    pub struct MerkleNeighbourLeafFieldPathBuilder {
        path: Vec<&'static str>,
    }
    impl MerkleNeighbourLeafFieldPathBuilder {
        #[allow(clippy::new_without_default)]
        pub fn new() -> Self {
            Self { path: Default::default() }
        }
        #[doc(hidden)]
        pub fn new_with_base(base: Vec<&'static str>) -> Self {
            Self { path: base }
        }
        pub fn finish(self) -> String {
            self.path.join(".")
        }
        pub fn leaf(mut self) -> ObjectReferenceFieldPathBuilder {
            self.path.push(MerkleNeighbourLeaf::LEAF_FIELD.name);
            ObjectReferenceFieldPathBuilder::new_with_base(self.path)
        }
        pub fn merkle_proof(mut self) -> MerkleProofFieldPathBuilder {
            self.path.push(MerkleNeighbourLeaf::MERKLE_PROOF_FIELD.name);
            MerkleProofFieldPathBuilder::new_with_base(self.path)
        }
    }
    impl OcsInclusionProof {
        pub const OBJECT_REF_FIELD: &'static MessageField = &MessageField {
            name: "object_ref",
            json_name: "objectRef",
            number: 1i32,
            message_fields: Some(ObjectReference::FIELDS),
        };
        pub const MERKLE_PROOF_FIELD: &'static MessageField = &MessageField {
            name: "merkle_proof",
            json_name: "merkleProof",
            number: 2i32,
            message_fields: Some(MerkleProof::FIELDS),
        };
        pub const LEAF_INDEX_FIELD: &'static MessageField = &MessageField {
            name: "leaf_index",
            json_name: "leafIndex",
            number: 3i32,
            message_fields: None,
        };
        pub const TREE_ROOT_FIELD: &'static MessageField = &MessageField {
            name: "tree_root",
            json_name: "treeRoot",
            number: 4i32,
            message_fields: None,
        };
        pub const OBJECT_DATA_FIELD: &'static MessageField = &MessageField {
            name: "object_data",
            json_name: "objectData",
            number: 5i32,
            message_fields: None,
        };
    }
    impl MessageFields for OcsInclusionProof {
        const FIELDS: &'static [&'static MessageField] = &[
            Self::OBJECT_REF_FIELD,
            Self::MERKLE_PROOF_FIELD,
            Self::LEAF_INDEX_FIELD,
            Self::TREE_ROOT_FIELD,
            Self::OBJECT_DATA_FIELD,
        ];
    }
    impl OcsInclusionProof {
        pub fn path_builder() -> OcsInclusionProofFieldPathBuilder {
            OcsInclusionProofFieldPathBuilder::new()
        }
    }
    pub struct OcsInclusionProofFieldPathBuilder {
        path: Vec<&'static str>,
    }
    impl OcsInclusionProofFieldPathBuilder {
        #[allow(clippy::new_without_default)]
        pub fn new() -> Self {
            Self { path: Default::default() }
        }
        #[doc(hidden)]
        pub fn new_with_base(base: Vec<&'static str>) -> Self {
            Self { path: base }
        }
        pub fn finish(self) -> String {
            self.path.join(".")
        }
        pub fn object_ref(mut self) -> ObjectReferenceFieldPathBuilder {
            self.path.push(OcsInclusionProof::OBJECT_REF_FIELD.name);
            ObjectReferenceFieldPathBuilder::new_with_base(self.path)
        }
        pub fn merkle_proof(mut self) -> MerkleProofFieldPathBuilder {
            self.path.push(OcsInclusionProof::MERKLE_PROOF_FIELD.name);
            MerkleProofFieldPathBuilder::new_with_base(self.path)
        }
        pub fn leaf_index(mut self) -> String {
            self.path.push(OcsInclusionProof::LEAF_INDEX_FIELD.name);
            self.finish()
        }
        pub fn tree_root(mut self) -> String {
            self.path.push(OcsInclusionProof::TREE_ROOT_FIELD.name);
            self.finish()
        }
        pub fn object_data(mut self) -> String {
            self.path.push(OcsInclusionProof::OBJECT_DATA_FIELD.name);
            self.finish()
        }
    }
    impl OcsNonInclusionProof {
        pub const NON_INCLUSION_PROOF_FIELD: &'static MessageField = &MessageField {
            name: "non_inclusion_proof",
            json_name: "nonInclusionProof",
            number: 1i32,
            message_fields: Some(MerkleNonInclusionProof::FIELDS),
        };
        pub const TREE_ROOT_FIELD: &'static MessageField = &MessageField {
            name: "tree_root",
            json_name: "treeRoot",
            number: 2i32,
            message_fields: None,
        };
    }
    impl MessageFields for OcsNonInclusionProof {
        const FIELDS: &'static [&'static MessageField] = &[
            Self::NON_INCLUSION_PROOF_FIELD,
            Self::TREE_ROOT_FIELD,
        ];
    }
    impl OcsNonInclusionProof {
        pub fn path_builder() -> OcsNonInclusionProofFieldPathBuilder {
            OcsNonInclusionProofFieldPathBuilder::new()
        }
    }
    pub struct OcsNonInclusionProofFieldPathBuilder {
        path: Vec<&'static str>,
    }
    impl OcsNonInclusionProofFieldPathBuilder {
        #[allow(clippy::new_without_default)]
        pub fn new() -> Self {
            Self { path: Default::default() }
        }
        #[doc(hidden)]
        pub fn new_with_base(base: Vec<&'static str>) -> Self {
            Self { path: base }
        }
        pub fn finish(self) -> String {
            self.path.join(".")
        }
        pub fn non_inclusion_proof(mut self) -> MerkleNonInclusionProofFieldPathBuilder {
            self.path.push(OcsNonInclusionProof::NON_INCLUSION_PROOF_FIELD.name);
            MerkleNonInclusionProofFieldPathBuilder::new_with_base(self.path)
        }
        pub fn tree_root(mut self) -> String {
            self.path.push(OcsNonInclusionProof::TREE_ROOT_FIELD.name);
            self.finish()
        }
    }
    impl GetCheckpointObjectProofRequest {
        pub const OBJECT_ID_FIELD: &'static MessageField = &MessageField {
            name: "object_id",
            json_name: "objectId",
            number: 1i32,
            message_fields: None,
        };
        pub const CHECKPOINT_FIELD: &'static MessageField = &MessageField {
            name: "checkpoint",
            json_name: "checkpoint",
            number: 2i32,
            message_fields: None,
        };
    }
    impl MessageFields for GetCheckpointObjectProofRequest {
        const FIELDS: &'static [&'static MessageField] = &[
            Self::OBJECT_ID_FIELD,
            Self::CHECKPOINT_FIELD,
        ];
    }
    impl GetCheckpointObjectProofRequest {
        pub fn path_builder() -> GetCheckpointObjectProofRequestFieldPathBuilder {
            GetCheckpointObjectProofRequestFieldPathBuilder::new()
        }
    }
    pub struct GetCheckpointObjectProofRequestFieldPathBuilder {
        path: Vec<&'static str>,
    }
    impl GetCheckpointObjectProofRequestFieldPathBuilder {
        #[allow(clippy::new_without_default)]
        pub fn new() -> Self {
            Self { path: Default::default() }
        }
        #[doc(hidden)]
        pub fn new_with_base(base: Vec<&'static str>) -> Self {
            Self { path: base }
        }
        pub fn finish(self) -> String {
            self.path.join(".")
        }
        pub fn object_id(mut self) -> String {
            self.path.push(GetCheckpointObjectProofRequest::OBJECT_ID_FIELD.name);
            self.finish()
        }
        pub fn checkpoint(mut self) -> String {
            self.path.push(GetCheckpointObjectProofRequest::CHECKPOINT_FIELD.name);
            self.finish()
        }
    }
    impl GetCheckpointObjectProofResponse {
        pub const CHECKPOINT_SUMMARY_FIELD: &'static MessageField = &MessageField {
            name: "checkpoint_summary",
            json_name: "checkpointSummary",
            number: 1i32,
            message_fields: None,
        };
        pub const INCLUSION_FIELD: &'static MessageField = &MessageField {
            name: "inclusion",
            json_name: "inclusion",
            number: 2i32,
            message_fields: Some(OcsInclusionProof::FIELDS),
        };
        pub const NON_INCLUSION_FIELD: &'static MessageField = &MessageField {
            name: "non_inclusion",
            json_name: "nonInclusion",
            number: 3i32,
            message_fields: Some(OcsNonInclusionProof::FIELDS),
        };
    }
    impl MessageFields for GetCheckpointObjectProofResponse {
        const FIELDS: &'static [&'static MessageField] = &[
            Self::CHECKPOINT_SUMMARY_FIELD,
            Self::INCLUSION_FIELD,
            Self::NON_INCLUSION_FIELD,
        ];
    }
    impl GetCheckpointObjectProofResponse {
        pub fn path_builder() -> GetCheckpointObjectProofResponseFieldPathBuilder {
            GetCheckpointObjectProofResponseFieldPathBuilder::new()
        }
    }
    pub struct GetCheckpointObjectProofResponseFieldPathBuilder {
        path: Vec<&'static str>,
    }
    impl GetCheckpointObjectProofResponseFieldPathBuilder {
        #[allow(clippy::new_without_default)]
        pub fn new() -> Self {
            Self { path: Default::default() }
        }
        #[doc(hidden)]
        pub fn new_with_base(base: Vec<&'static str>) -> Self {
            Self { path: base }
        }
        pub fn finish(self) -> String {
            self.path.join(".")
        }
        pub fn checkpoint_summary(mut self) -> String {
            self.path
                .push(GetCheckpointObjectProofResponse::CHECKPOINT_SUMMARY_FIELD.name);
            self.finish()
        }
        pub fn inclusion(mut self) -> OcsInclusionProofFieldPathBuilder {
            self.path.push(GetCheckpointObjectProofResponse::INCLUSION_FIELD.name);
            OcsInclusionProofFieldPathBuilder::new_with_base(self.path)
        }
        pub fn non_inclusion(mut self) -> OcsNonInclusionProofFieldPathBuilder {
            self.path.push(GetCheckpointObjectProofResponse::NON_INCLUSION_FIELD.name);
            OcsNonInclusionProofFieldPathBuilder::new_with_base(self.path)
        }
    }
}