trellis-rs 0.10.7

Curated public Rust facade for Trellis clients and services.
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
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
use std::future::Future;
use std::marker::PhantomData;

use serde::{de::DeserializeOwned, Deserialize, Serialize};
use serde_json::{Map, Value};
use trellis_contracts::PageResponse;

use crate::client::{TrellisClient, TrellisClientError};

const GET_SUBJECT: &str = "rpc.v1.State.Get";
const PUT_SUBJECT: &str = "rpc.v1.State.Put";
const DELETE_SUBJECT: &str = "rpc.v1.State.Delete";
const LIST_SUBJECT: &str = "rpc.v1.State.List";

/// Transport used by typed state store helpers.
pub trait StateTransport {
    /// Send one JSON request to a Trellis-owned state RPC subject.
    fn request_state_json<'a>(
        &'a self,
        subject: &'static str,
        body: Value,
    ) -> impl Future<Output = Result<Value, TrellisClientError>> + Send + 'a;
}

impl StateTransport for TrellisClient {
    async fn request_state_json(
        &self,
        subject: &'static str,
        body: Value,
    ) -> Result<Value, TrellisClientError> {
        self.request_json_value(subject, &body).await
    }
}

/// Expected revision behavior for state puts.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ExpectedPutRevision {
    /// Omit `expectedRevision` for unconditional create-or-overwrite.
    Unconditional,
    /// Send `expectedRevision: null` for create-if-absent.
    CreateIfAbsent,
    /// Send a concrete revision for update-if-current-revision-matches.
    Revision(String),
}

impl Default for ExpectedPutRevision {
    fn default() -> Self {
        Self::Unconditional
    }
}

/// Options for state put requests.
#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub struct PutStateOptions {
    pub ttl_ms: Option<u64>,
    pub expected_revision: ExpectedPutRevision,
}

/// Options for state delete requests.
#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub struct DeleteStateOptions {
    pub expected_revision: Option<String>,
}

/// Options for map state list requests.
#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub struct ListStateOptions {
    pub offset: Option<u64>,
    pub limit: Option<u64>,
}

/// One current state entry.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct StateEntry<TValue = Value> {
    pub value: TValue,
    pub revision: String,
    pub updated_at: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub expires_at: Option<String>,
}

/// One current map state entry.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct MapStateEntry<TValue = Value> {
    pub key: String,
    pub value: TValue,
    pub revision: String,
    pub updated_at: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub expires_at: Option<String>,
}

/// Current or migration-required state value.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(untagged)]
pub enum StateValue<TEntry, TMigrationEntry = StateEntry<Value>> {
    Current(TEntry),
    MigrationRequired(StateMigrationRequired<TMigrationEntry>),
}

/// State entry that must be migrated by the caller before it is current.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct StateMigrationRequired<TEntry = StateEntry<Value>> {
    pub migration_required: bool,
    pub entry: TEntry,
    pub state_version: String,
    pub current_state_version: String,
    pub writer_contract_digest: String,
}

/// Result returned by state get requests.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(untagged)]
pub enum StateGetResult<TEntry, TMigrationEntry = StateEntry<Value>> {
    Found {
        #[serde(deserialize_with = "deserialize_true")]
        found: bool,
        entry: TEntry,
    },
    Missing {
        #[serde(deserialize_with = "deserialize_false")]
        found: bool,
    },
    MigrationRequired(StateMigrationRequired<TMigrationEntry>),
}

/// Result returned by state put requests.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct StatePutResult<TEntry, TMigrationEntry = StateEntry<Value>> {
    pub applied: bool,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub found: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub entry: Option<StateValue<TEntry, TMigrationEntry>>,
}

/// Result returned by state delete requests.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct StateDeleteResult<TEntry, TMigrationEntry = StateEntry<Value>> {
    pub deleted: bool,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub entry: Option<StateValue<TEntry, TMigrationEntry>>,
}

/// Result returned by map state list requests.
pub type MapStateListResult<TValue> =
    PageResponse<StateValue<MapStateEntry<TValue>, MapStateEntry<Value>>>;

/// Typed client for a contract-declared value state store.
#[derive(Debug)]
pub struct ValueStateStore<'a, TTransport, TValue> {
    transport: &'a TTransport,
    store: &'static str,
    _value: PhantomData<TValue>,
}

impl<'a, TTransport, TValue> ValueStateStore<'a, TTransport, TValue> {
    /// Create a typed value state store helper.
    pub fn new(transport: &'a TTransport, store: &'static str) -> Self {
        Self {
            transport,
            store,
            _value: PhantomData,
        }
    }
}

impl<TTransport, TValue> ValueStateStore<'_, TTransport, TValue>
where
    TTransport: StateTransport,
    TValue: Serialize + DeserializeOwned,
{
    /// Read the current value state entry.
    pub async fn get(&self) -> Result<StateGetResult<StateEntry<TValue>>, TrellisClientError> {
        let response = self
            .transport
            .request_state_json(GET_SUBJECT, request_with_store(self.store))
            .await?;
        Ok(serde_json::from_value(response)?)
    }

    /// Write the value state entry unconditionally.
    pub async fn put(
        &self,
        value: &TValue,
    ) -> Result<StatePutResult<StateEntry<TValue>>, TrellisClientError> {
        self.put_with_options(value, &PutStateOptions::default())
            .await
    }

    /// Write the value state entry with TTL and revision options.
    pub async fn put_with_options(
        &self,
        value: &TValue,
        options: &PutStateOptions,
    ) -> Result<StatePutResult<StateEntry<TValue>>, TrellisClientError> {
        let response = self
            .transport
            .request_state_json(PUT_SUBJECT, put_request(self.store, None, value, options)?)
            .await?;
        Ok(serde_json::from_value(response)?)
    }

    /// Delete the value state entry.
    pub async fn delete(
        &self,
    ) -> Result<StateDeleteResult<StateEntry<TValue>>, TrellisClientError> {
        self.delete_with_options(&DeleteStateOptions::default())
            .await
    }

    /// Delete the value state entry with revision options.
    pub async fn delete_with_options(
        &self,
        options: &DeleteStateOptions,
    ) -> Result<StateDeleteResult<StateEntry<TValue>>, TrellisClientError> {
        let response = self
            .transport
            .request_state_json(DELETE_SUBJECT, delete_request(self.store, None, options))
            .await?;
        Ok(serde_json::from_value(response)?)
    }
}

/// Typed client for a contract-declared map state store.
#[derive(Debug)]
pub struct MapStateStore<'a, TTransport, TValue> {
    transport: &'a TTransport,
    store: &'static str,
    prefix: String,
    _value: PhantomData<TValue>,
}

impl<'a, TTransport, TValue> MapStateStore<'a, TTransport, TValue> {
    /// Create a typed map state store helper.
    pub fn new(transport: &'a TTransport, store: &'static str) -> Self {
        Self {
            transport,
            store,
            prefix: String::new(),
            _value: PhantomData,
        }
    }

    /// Return a view of this map store rooted at a composed path prefix.
    pub fn prefix(&self, path: &str) -> Self {
        Self {
            transport: self.transport,
            store: self.store,
            prefix: join_state_path(&self.prefix, path),
            _value: PhantomData,
        }
    }
}

impl<TTransport, TValue> MapStateStore<'_, TTransport, TValue>
where
    TTransport: StateTransport,
    TValue: Serialize + DeserializeOwned,
{
    /// Read one map state entry by key.
    pub async fn get(
        &self,
        key: &str,
    ) -> Result<StateGetResult<MapStateEntry<TValue>, MapStateEntry<Value>>, TrellisClientError>
    {
        let response = self
            .transport
            .request_state_json(GET_SUBJECT, key_request(self.store, &self.prefix, key))
            .await?;
        Ok(serde_json::from_value(response)?)
    }

    /// Write one map state entry unconditionally.
    pub async fn put(
        &self,
        key: &str,
        value: &TValue,
    ) -> Result<StatePutResult<MapStateEntry<TValue>, MapStateEntry<Value>>, TrellisClientError>
    {
        self.put_with_options(key, value, &PutStateOptions::default())
            .await
    }

    /// Write one map state entry with TTL and revision options.
    pub async fn put_with_options(
        &self,
        key: &str,
        value: &TValue,
        options: &PutStateOptions,
    ) -> Result<StatePutResult<MapStateEntry<TValue>, MapStateEntry<Value>>, TrellisClientError>
    {
        let composed_key = join_state_path(&self.prefix, key);
        let response = self
            .transport
            .request_state_json(
                PUT_SUBJECT,
                put_request(self.store, Some(&composed_key), value, options)?,
            )
            .await?;
        Ok(serde_json::from_value(response)?)
    }

    /// Delete one map state entry.
    pub async fn delete(
        &self,
        key: &str,
    ) -> Result<StateDeleteResult<MapStateEntry<TValue>, MapStateEntry<Value>>, TrellisClientError>
    {
        self.delete_with_options(key, &DeleteStateOptions::default())
            .await
    }

    /// Delete one map state entry with revision options.
    pub async fn delete_with_options(
        &self,
        key: &str,
        options: &DeleteStateOptions,
    ) -> Result<StateDeleteResult<MapStateEntry<TValue>, MapStateEntry<Value>>, TrellisClientError>
    {
        let composed_key = join_state_path(&self.prefix, key);
        let response = self
            .transport
            .request_state_json(
                DELETE_SUBJECT,
                delete_request(self.store, Some(&composed_key), options),
            )
            .await?;
        Ok(serde_json::from_value(response)?)
    }

    /// List map entries under the current prefix.
    pub async fn list(
        &self,
        options: &ListStateOptions,
    ) -> Result<MapStateListResult<TValue>, TrellisClientError> {
        let response = self
            .transport
            .request_state_json(
                LIST_SUBJECT,
                list_request(self.store, &self.prefix, options),
            )
            .await?;
        Ok(serde_json::from_value(response)?)
    }
}

fn request_with_store(store: &'static str) -> Value {
    let mut request = Map::new();
    request.insert("store".to_string(), Value::String(store.to_string()));
    Value::Object(request)
}

fn key_request(store: &'static str, prefix: &str, key: &str) -> Value {
    let mut request = Map::new();
    request.insert("store".to_string(), Value::String(store.to_string()));
    request.insert(
        "key".to_string(),
        Value::String(join_state_path(prefix, key)),
    );
    Value::Object(request)
}

fn put_request<TValue: Serialize>(
    store: &'static str,
    key: Option<&str>,
    value: &TValue,
    options: &PutStateOptions,
) -> Result<Value, TrellisClientError> {
    let mut request = Map::new();
    request.insert("store".to_string(), Value::String(store.to_string()));
    if let Some(key) = key {
        request.insert("key".to_string(), Value::String(key.to_string()));
    }
    request.insert("value".to_string(), serde_json::to_value(value)?);
    if let Some(ttl_ms) = options.ttl_ms {
        request.insert("ttlMs".to_string(), Value::from(ttl_ms));
    }
    match &options.expected_revision {
        ExpectedPutRevision::Unconditional => {}
        ExpectedPutRevision::CreateIfAbsent => {
            request.insert("expectedRevision".to_string(), Value::Null);
        }
        ExpectedPutRevision::Revision(revision) => {
            request.insert(
                "expectedRevision".to_string(),
                Value::String(revision.clone()),
            );
        }
    }
    Ok(Value::Object(request))
}

fn delete_request(store: &'static str, key: Option<&str>, options: &DeleteStateOptions) -> Value {
    let mut request = Map::new();
    request.insert("store".to_string(), Value::String(store.to_string()));
    if let Some(key) = key {
        request.insert("key".to_string(), Value::String(key.to_string()));
    }
    if let Some(revision) = &options.expected_revision {
        request.insert(
            "expectedRevision".to_string(),
            Value::String(revision.clone()),
        );
    }
    Value::Object(request)
}

fn list_request(store: &'static str, prefix: &str, options: &ListStateOptions) -> Value {
    let mut request = Map::new();
    request.insert("store".to_string(), Value::String(store.to_string()));
    if !prefix.is_empty() {
        request.insert("prefix".to_string(), Value::String(prefix.to_string()));
    }
    request.insert(
        "offset".to_string(),
        Value::from(options.offset.unwrap_or(0)),
    );
    request.insert(
        "limit".to_string(),
        Value::from(options.limit.unwrap_or(100)),
    );
    Value::Object(request)
}

fn join_state_path(left: &str, right: &str) -> String {
    left.split('/')
        .chain(right.split('/'))
        .filter(|segment| !segment.is_empty())
        .collect::<Vec<_>>()
        .join("/")
}

fn deserialize_true<'de, D>(deserializer: D) -> Result<bool, D::Error>
where
    D: serde::Deserializer<'de>,
{
    let value = bool::deserialize(deserializer)?;
    if value {
        Ok(value)
    } else {
        Err(serde::de::Error::custom("expected true"))
    }
}

fn deserialize_false<'de, D>(deserializer: D) -> Result<bool, D::Error>
where
    D: serde::Deserializer<'de>,
{
    let value = bool::deserialize(deserializer)?;
    if value {
        Err(serde::de::Error::custom("expected false"))
    } else {
        Ok(value)
    }
}