snops-common 0.1.0

Common types and utilities for snops
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

use std::str::FromStr;

use indexmap::{IndexMap, IndexSet};
use serde::{Deserialize, Serialize};

use crate::{
    key_source::KeySource,
    node_targets::{NodeTarget, NodeTargets},
    state::{CannonId, DocHeightRequest, InternedId},
};

#[derive(Deserialize, Serialize, Clone)]
pub struct WithTargets<T = ()>
where
    T: Serialize,
{
    pub nodes: NodeTargets,
    #[serde(flatten)]
    pub data: T,
}

impl From<Vec<NodeTarget>> for WithTargets<()> {
    fn from(nodes: Vec<NodeTarget>) -> Self {
        Self {
            nodes: NodeTargets::from(nodes),
            data: (),
        }
    }
}
impl From<NodeTargets> for WithTargets<()> {
    fn from(nodes: NodeTargets) -> Self {
        Self { nodes, data: () }
    }
}

fn committee_0_key() -> KeySource {
    KeySource::Committee(Some(0))
}

fn credits_aleo() -> String {
    "credits.aleo".to_owned()
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub struct ExecuteAction {
    /// The private key to use for the transaction. If not provided, the
    /// transaction will be signed with the committee member 0's key.
    #[serde(default = "committee_0_key")]
    pub private_key: KeySource,
    /// A private key to use for the fee. If not provided, the fee will be paid
    /// from the `private_key`
    pub fee_private_key: Option<KeySource>,
    /// The program to execute. Defaults to `credits.aleo`
    #[serde(default = "credits_aleo")]
    pub program: String,
    /// The function to call
    pub function: String,
    /// The cannon id of who to execute the transaction
    #[serde(default)]
    pub cannon: CannonId,
    /// The inputs to the function
    pub inputs: Vec<AleoValue>,
    /// The optional priority fee
    #[serde(default)]
    pub priority_fee: Option<u64>,
    /// The optional fee record for a private fee
    #[serde(default)]
    pub fee_record: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub struct DeployAction {
    /// The private key to use for the transaction. If not provided, the
    /// transaction will be signed with the committee member 0's key.
    #[serde(default = "committee_0_key")]
    pub private_key: KeySource,
    /// A private key to use for the fee. If not provided, the fee will be paid
    /// from the `private_key`
    pub fee_private_key: Option<KeySource>,
    /// The program to deploy
    pub program: String,
    /// The cannon id of who to execute the transaction
    #[serde(default)]
    pub cannon: CannonId,
    /// The optional priority fee
    #[serde(default)]
    pub priority_fee: Option<u64>,
    /// The optional fee record for a private fee
    #[serde(default)]
    pub fee_record: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum AleoValue {
    // Public keys
    Key(KeySource),
    // Other values (u8, fields, etc.)
    Other(String),
}

impl FromStr for AleoValue {
    type Err = String;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        Ok(KeySource::from_str(s)
            .map(AleoValue::Key)
            .unwrap_or_else(|_| AleoValue::Other(s.to_owned())))
    }
}

#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct Reconfig {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub online: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub height: Option<DocHeightRequest>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub peers: Option<NodeTargets>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub validators: Option<NodeTargets>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub binary: Option<InternedId>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub private_key: Option<KeySource>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub set_env: Option<IndexMap<String, String>>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub del_env: Option<IndexSet<String>>,
}