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
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

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

/// Options provided when registering a credential definition on the ledger
#[derive(Debug, Deserialize, Serialize, Default)]
pub struct CredentialDefinitionCreateOptions {
    /// Schema id that the credential definition will be linked to
    pub schema_id: String,

    /// Optional tag used for the credential
    /// If none is supplied `default` will be used
    pub tag: String,

    /// Whether the credential definition supports revocation
    pub support_revocation: bool,

    /// The size of the revocation registry, how many credentials
    /// fit in the revocation registry
    #[serde(skip_serializing_if = "Option::is_none")]
    pub revocation_registry_size: Option<i32>,
}

/// Response from the cloudagent when creating a credential definition
#[derive(Debug, Deserialize, Serialize)]
pub struct CredentialDefinitionCreateResponse {
    /// Id of the credential definition
    #[serde(alias = "id")]
    pub credential_definition_id: String,
}

/// Response from the cloudagent when requesting a credential definition
/// by id
#[derive(Debug, Serialize, Deserialize)]
pub struct CredentialDefinitionGetByIdResponse {
    /// The credential definition requested
    pub credential_definition: CredentialDefinition,
}

/// A credential definition structure
#[derive(Debug, Serialize, Deserialize)]
pub struct CredentialDefinition {
    /// Version of the credential definition
    pub ver: String,

    /// Id of the credential definition
    pub id: String,

    /// Schema id on which the credential definintion is based
    #[serde(alias = "schemaId")]
    pub schema_id: String,

    /// The type of the credential definition
    #[serde(rename = "type")]
    pub type_field: String,

    /// Tag used by the credential definition
    /// default is `default`
    pub tag: String,

    /// TODO
    pub value: Value,
}

/// Response from the cloudagent when requesting all the credential definitions
#[derive(Debug, Serialize, Deserialize)]
pub struct CredentialDefinitionGetAllResponse {
    /// List of credential definitions registered by the cloudagent
    pub credential_definition_ids: Vec<String>,
}

/// Generic cloudagent credential definition module
#[async_trait]
pub trait CredentialDefinitionModule {
    /// Register a credential definition on the ledger
    async fn create(
        &self,
        options: CredentialDefinitionCreateOptions,
    ) -> Result<CredentialDefinitionCreateResponse>;

    /// Get the registered credential definition by id
    async fn get_by_id(&self, id: String) -> Result<CredentialDefinition>;

    /// Get all the registered credential definitions
    async fn get_all(&self) -> Result<CredentialDefinitionGetAllResponse>;
}