siera-agent 0.2.0

Structures and traits related to an Aries agent.
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

use crate::error::Result;
use async_trait::async_trait;
use serde::{Deserialize, Serialize};

/// Schema response from the ledger
#[derive(Debug, Deserialize, Serialize, Default)]
pub struct Schema {
    /// Version of the schema
    pub ver: String,

    /// Id of the schema
    pub id: String,

    /// Name of the schema
    pub name: String,

    /// Version of the schema
    pub version: String,

    /// Names of the attributes registered with the schema
    #[serde(rename(deserialize = "attrNames"))]
    pub attr_names: Vec<String>,

    /// seqNo as on the ledger that is unique to each schema
    #[serde(rename(deserialize = "seqNo"))]
    pub seq_no: Option<i32>,
}

/// Options supplied by the frontend to create a schema
#[derive(Debug, Serialize)]
pub struct SchemaCreateOptions {
    /// The name of the schema
    pub name: String,

    /// The version of the schema
    pub version: String,

    /// The attributed that must be registered with the schema
    pub attributes: Vec<String>,
}

/// Response from the cloudagent when requesting every schema
/// the cloudagent has registered
#[derive(Debug, Deserialize, Serialize)]
pub struct SchemasGetAllResponse {
    /// List of all the ids of every schema that the cloudagent has registered
    pub schema_ids: Vec<String>,
}

/// Generic cloudagent schema module
#[async_trait]
pub trait SchemaModule {
    /// Create a schema on the ledger
    async fn create(&self, options: SchemaCreateOptions) -> Result<Schema>;

    /// Request the schema by the id
    async fn get_by_id(&self, id: String) -> Result<Schema>;

    /// Get all the registerd schemas
    async fn get_all(&self) -> Result<SchemasGetAllResponse>;
}