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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

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

/// Options that are supplied when querying a wallet for DIDs
#[derive(Debug, Deserialize, Serialize)]
pub struct Did {
    /// The DID of interest
    pub did: Option<String>,

    // TODO: enum
    /// The key type to query for eg. ed25519, bls12381g2
    pub key_type: Option<String>,

    // TODO: enum
    /// DID method to query for. e.g. sov to only fetch indy/sov DIDs Available values : key, sov
    pub method: Option<String>,

    // TODO: enum
    /// The DID posture specifying whether the DID is
    /// the current public DID,
    /// posted to ledger but current public DID,
    /// or local to the wallet
    /// Available values : public, posted, wallet_only
    pub posture: Option<String>,

    /// The verification key of interest
    pub verkey: Option<String>,
}

/// Response from the cloudagent when requesting info about dids
/// of a wallet
#[derive(Debug, Deserialize, Serialize)]
pub struct DidList(Vec<Did>);

/// Response from the cloudagent when requesting info about dids
/// of a wallet
#[derive(Debug, Deserialize, Serialize)]
pub struct DidResult(Did);

/// Key type in a JSON format k,v pair
#[derive(Debug, Deserialize, Serialize)]
pub struct KeyType {
    // TODO: enum
    /// The key type to query for eg. ed25519, bls12381g2
    pub key_type: String,
}

/// Options that are supplied when querying a wallet for DIDs
#[derive(Debug, Deserialize, Serialize)]
pub struct CreateLocalDidOptions {
    /// DID method to query for. e.g. sov to only fetch indy/sov DIDs Available values : key, sov
    pub method: String,

    /// The key type to query for eg. ed25519, bls12381g2
    pub options: KeyType,
}

/// Options that are supplied when querying a wallet for DIDs
#[derive(Debug, Deserialize, Serialize)]
pub struct DidEndpoint {
    /// The DID of interest
    pub did: String,

    /// The endpoint url
    pub endpoint: String,
}

/// Options that are supplied when querying a wallet for DIDs
#[derive(Debug, Deserialize, Serialize)]
pub struct SetDidEndpointOptions {
    /// The DID of interest
    pub did: String,

    /// The endpoint url
    pub endpoint: String,

    ///The endpoint type eg. 'Endpoint'
    pub endpoint_type: String,
}

/// Generic cloudagent basic message module
#[async_trait]
pub trait WalletModule {
    /// Query a wallet for DIDs
    async fn get_wallet_dids(&self, options: Did) -> Result<DidList>;

    /// Create a local DID
    async fn create_local_did(&self, options: CreateLocalDidOptions) -> Result<Did>;

    /// Rotate key pair
    async fn rotate_keypair(&self, did: String) -> Result<()>;

    /// Fetch public did
    async fn fetch_public_did(&self) -> Result<Did>;

    /// Assign the current public DID
    async fn assign_public_did(&self, did: String) -> Result<Did>;

    /// Query DID endpoint of wallet
    async fn fetch_did_endpoint(&self, did: String) -> Result<DidEndpoint>;

    /// Set DID endpoint of wallet
    async fn set_did_endpoint(&self, options: SetDidEndpointOptions) -> Result<()>;
}