guardian-shared 0.14.4

Shared types and utilities for Guardian
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
use base64::Engine;
use miden_protocol::account::Account;
use miden_protocol::account::auth::Signature as AccountSignature;
use miden_protocol::crypto::dsa::ecdsa_k256_keccak;
use miden_protocol::crypto::dsa::falcon512_poseidon2::Signature as FalconSignature;
use miden_protocol::transaction::TransactionSummary;
use miden_protocol::utils::serde::{Deserializable, Serializable};
use miden_protocol::{Felt, Hasher, Word};
use serde::{Deserialize, Serialize};

pub mod auth;
pub mod auth_request_message;
pub mod auth_request_payload;
pub mod hex;

use crate::hex::FromHex;

/// Supported signature schemes
#[derive(Serialize, Deserialize, Clone, Copy, Debug, PartialEq, Eq)]
#[serde(rename_all = "snake_case")]
pub enum SignatureScheme {
    Falcon,
    Ecdsa,
}

impl SignatureScheme {
    pub fn from(ack_scheme: &str) -> Result<Self, String> {
        match ack_scheme {
            value if value.eq_ignore_ascii_case("falcon") => Ok(Self::Falcon),
            value if value.eq_ignore_ascii_case("ecdsa") => Ok(Self::Ecdsa),
            value => Err(format!("unsupported signature scheme: {}", value)),
        }
    }

    pub const fn as_str(self) -> &'static str {
        match self {
            Self::Falcon => "falcon",
            Self::Ecdsa => "ecdsa",
        }
    }

    pub fn parse_signature_hex(self, signature_hex: &str) -> Result<AccountSignature, String> {
        match self {
            Self::Falcon => {
                let signature = FalconSignature::from_hex(&ensure_hex_prefix(signature_hex))
                    .map_err(|e| format!("failed to parse Falcon signature: {}", e))?;
                Ok(AccountSignature::from(signature))
            }
            Self::Ecdsa => {
                let signature_bytes = ::hex::decode(signature_hex.trim_start_matches("0x"))
                    .map_err(|e| format!("invalid ECDSA signature hex: {}", e))?;
                let signature = ecdsa_k256_keccak::Signature::read_from_bytes(&signature_bytes)
                    .map_err(|e| format!("failed to parse ECDSA signature: {}", e))?;
                Ok(AccountSignature::EcdsaK256Keccak(signature))
            }
        }
    }

    pub fn build_signature_advice_entry(
        self,
        pubkey_commitment: Word,
        message: Word,
        signature: &AccountSignature,
        public_key_hex: Option<&str>,
    ) -> Result<(Word, Vec<Felt>), String> {
        let key = signature_advice_key(pubkey_commitment, message);

        let values = match (self, signature) {
            (Self::Falcon, AccountSignature::Falcon512Poseidon2(_)) => {
                signature.to_prepared_signature(message)
            }
            (Self::Falcon, _) => {
                return Err("expected Falcon signature for falcon scheme".to_string());
            }
            (Self::Ecdsa, AccountSignature::EcdsaK256Keccak(ecdsa_signature)) => {
                let public_key_hex = public_key_hex.ok_or_else(|| {
                    "ECDSA signature requires public key for advice preparation".to_string()
                })?;
                let public_key = parse_ecdsa_public_key_hex(public_key_hex)?;
                let actual_commitment = public_key.to_commitment();
                if actual_commitment != pubkey_commitment {
                    return Err(format!(
                        "ECDSA public key commitment mismatch: expected {}, got {}",
                        word_to_hex(pubkey_commitment),
                        word_to_hex(actual_commitment)
                    ));
                }
                AccountSignature::EcdsaK256Keccak(ecdsa_signature.clone())
                    .to_prepared_signature(message)
            }
            (Self::Ecdsa, _) => {
                return Err("expected ECDSA signature for ecdsa scheme".to_string());
            }
        };

        Ok((key, values))
    }
}

impl std::fmt::Display for SignatureScheme {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(self.as_str())
    }
}

fn ensure_hex_prefix(hex: &str) -> String {
    if hex.starts_with("0x") {
        hex.to_string()
    } else {
        format!("0x{}", hex)
    }
}

fn word_to_hex(word: Word) -> String {
    format!("0x{}", ::hex::encode(word.to_bytes()))
}

fn signature_advice_key(pubkey_commitment: Word, message: Word) -> Word {
    let mut elements = Vec::with_capacity(8);
    elements.extend_from_slice(pubkey_commitment.as_elements());
    elements.extend_from_slice(message.as_elements());
    Hasher::hash_elements(&elements)
}

fn parse_ecdsa_public_key_hex(
    public_key_hex: &str,
) -> Result<ecdsa_k256_keccak::PublicKey, String> {
    let public_key_bytes = ::hex::decode(public_key_hex.trim_start_matches("0x"))
        .map_err(|e| format!("invalid ECDSA public key hex: {}", e))?;
    ecdsa_k256_keccak::PublicKey::read_from_bytes(&public_key_bytes)
        .map_err(|e| format!("failed to deserialize ECDSA public key: {}", e))
}

/// Signature type for delta proposals
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq)]
#[serde(tag = "scheme", rename_all = "snake_case")]
pub enum ProposalSignature {
    Falcon {
        /// Hex-encoded Falcon signature
        signature: String,
    },
    Ecdsa {
        /// Hex-encoded ECDSA secp256k1 signature
        signature: String,
        /// Hex-encoded ECDSA public key (required for signature preparation)
        #[serde(default, skip_serializing_if = "Option::is_none")]
        public_key: Option<String>,
    },
}

impl ProposalSignature {
    /// Creates a ProposalSignature from a scheme, hex-encoded signature, and optional public key.
    pub fn from_scheme(
        scheme: SignatureScheme,
        signature: String,
        public_key: Option<String>,
    ) -> Self {
        match scheme {
            SignatureScheme::Falcon => ProposalSignature::Falcon { signature },
            SignatureScheme::Ecdsa => ProposalSignature::Ecdsa {
                signature,
                public_key,
            },
        }
    }

    /// Returns the public key hex if this is an ECDSA signature with a public key.
    pub fn public_key(&self) -> Option<&str> {
        match self {
            ProposalSignature::Ecdsa { public_key, .. } => public_key.as_deref(),
            _ => None,
        }
    }
}

/// Delta payload structure containing transaction summary and signatures
/// This is the standard format for delta_payload in proposals
#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct DeltaPayload {
    pub tx_summary: serde_json::Value,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub signatures: Vec<DeltaSignature>,
}

impl DeltaPayload {
    pub fn new(tx_summary: serde_json::Value) -> Self {
        Self {
            tx_summary,
            signatures: Vec::new(),
        }
    }

    pub fn with_signature(mut self, signature: DeltaSignature) -> Self {
        self.signatures.push(signature);
        self
    }

    pub fn to_json(&self) -> serde_json::Value {
        serde_json::to_value(self).expect("DeltaPayload should always serialize")
    }
}

/// Signature entry in delta payload
#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct DeltaSignature {
    pub signer_id: String,
    pub signature: ProposalSignature,
}

pub trait ToJson {
    fn to_json(&self) -> serde_json::Value;
}

pub trait FromJson: Sized {
    fn from_json(json: &serde_json::Value) -> Result<Self, String>;
}

impl ToJson for Account {
    fn to_json(&self) -> serde_json::Value {
        let bytes = self.to_bytes();
        let encoded = base64::engine::general_purpose::STANDARD.encode(&bytes);
        serde_json::json!({
          "data": encoded,
          "account_id": self.id().to_hex(),
        })
    }
}

impl FromJson for Account {
    fn from_json(json: &serde_json::Value) -> Result<Self, String> {
        let encoded = json
            .get("data")
            .and_then(|v| v.as_str())
            .ok_or("Missing or invalid 'data' field")?;

        let bytes = base64::engine::general_purpose::STANDARD
            .decode(encoded)
            .map_err(|e| format!("Base64 decode error: {e}"))?;

        Account::read_from_bytes(&bytes).map_err(|e| format!("Deserialization error: {e}"))
    }
}

impl ToJson for TransactionSummary {
    fn to_json(&self) -> serde_json::Value {
        let bytes = self.to_bytes();
        let encoded = base64::engine::general_purpose::STANDARD.encode(&bytes);
        serde_json::json!({
          "data": encoded,
        })
    }
}

impl FromJson for TransactionSummary {
    fn from_json(json: &serde_json::Value) -> Result<Self, String> {
        let encoded = json
            .get("data")
            .and_then(|v| v.as_str())
            .ok_or("Missing or invalid 'data' field in delta payload")?;

        let bytes = base64::engine::general_purpose::STANDARD
            .decode(encoded)
            .map_err(|e| format!("Base64 decode error: {e}"))?;

        TransactionSummary::read_from_bytes(&bytes)
            .map_err(|e| format!("AccountDelta deserialization error: {e}"))
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use miden_protocol::{
        account::auth::{AuthScheme, Signature as AccountSignature},
        account::{AccountBuilder, auth::PublicKeyCommitment},
        crypto::dsa::ecdsa_k256_keccak::SecretKey as EcdsaSecretKey,
        crypto::dsa::falcon512_poseidon2::SecretKey,
    };
    use miden_standards::account::{auth::AuthSingleSig, wallets::BasicWallet};

    #[test]
    fn test_account_json_round_trip() {
        // Create a test account
        let secret_key = SecretKey::new();
        let public_key_commitment =
            PublicKeyCommitment::from(secret_key.public_key().to_commitment());
        let account = AccountBuilder::new([0xff; 32])
            .with_auth_component(AuthSingleSig::new(
                public_key_commitment,
                AuthScheme::Falcon512Poseidon2,
            ))
            .with_component(BasicWallet)
            .build()
            .unwrap();

        // Serialize to JSON
        let json = account.to_json();

        // Deserialize from JSON
        let deserialized_account =
            Account::from_json(&json).expect("Failed to deserialize account");

        // Verify round-trip
        assert_eq!(account.id(), deserialized_account.id());
        assert_eq!(account.nonce(), deserialized_account.nonce());
        assert_eq!(
            account.to_commitment(),
            deserialized_account.to_commitment()
        );
        assert_eq!(
            account.storage().to_commitment(),
            deserialized_account.storage().to_commitment()
        );
        assert_eq!(
            account.code().commitment(),
            deserialized_account.code().commitment()
        );
    }

    #[test]
    fn signature_scheme_from_accepts_known_values_case_insensitively() {
        assert_eq!(
            SignatureScheme::from("falcon").unwrap(),
            SignatureScheme::Falcon
        );
        assert_eq!(
            SignatureScheme::from("ECDSA").unwrap(),
            SignatureScheme::Ecdsa
        );
    }

    #[test]
    fn signature_scheme_from_rejects_unknown_values() {
        let error = SignatureScheme::from("unknown").unwrap_err();

        assert!(error.contains("unsupported signature scheme"));
    }

    #[test]
    fn signature_scheme_parse_signature_hex_accepts_falcon_signatures() {
        let secret_key = SecretKey::new();
        let message = Word::from([1u32, 2, 3, 4]);
        let signature = secret_key.sign(message);
        let signature_hex = format!("0x{}", ::hex::encode(signature.to_bytes()));

        let parsed = SignatureScheme::Falcon
            .parse_signature_hex(&signature_hex)
            .unwrap();

        assert!(matches!(parsed, AccountSignature::Falcon512Poseidon2(_)));
    }

    #[test]
    fn signature_scheme_parse_signature_hex_accepts_ecdsa_signatures() {
        let secret_key = EcdsaSecretKey::new();
        let message = Word::from([1u32, 2, 3, 4]);
        let signature = secret_key.sign(message);
        let signature_hex = format!("0x{}", ::hex::encode(signature.to_bytes()));

        let parsed = SignatureScheme::Ecdsa
            .parse_signature_hex(&signature_hex)
            .unwrap();

        assert!(matches!(parsed, AccountSignature::EcdsaK256Keccak(_)));
    }

    #[test]
    fn signature_scheme_build_signature_advice_entry_accepts_falcon_signatures() {
        let secret_key = SecretKey::new();
        let message = Word::from([1u32, 2, 3, 4]);
        let commitment = Word::from([5u32, 6, 7, 8]);
        let signature = AccountSignature::from(secret_key.sign(message));

        let (key, values) = SignatureScheme::Falcon
            .build_signature_advice_entry(commitment, message, &signature, None)
            .unwrap();

        let mut elements = Vec::with_capacity(8);
        elements.extend_from_slice(commitment.as_elements());
        elements.extend_from_slice(message.as_elements());

        assert_eq!(key, Hasher::hash_elements(&elements));
        assert!(!values.is_empty());
    }

    #[test]
    fn signature_scheme_build_signature_advice_entry_accepts_ecdsa_signatures() {
        let secret_key = EcdsaSecretKey::new();
        let public_key = secret_key.public_key();
        let public_key_hex = format!("0x{}", ::hex::encode(public_key.to_bytes()));
        let message = Word::from([1u32, 2, 3, 4]);
        let commitment = public_key.to_commitment();
        let signature = AccountSignature::EcdsaK256Keccak(secret_key.sign(message));

        let (key, values) = SignatureScheme::Ecdsa
            .build_signature_advice_entry(commitment, message, &signature, Some(&public_key_hex))
            .unwrap();

        let mut elements = Vec::with_capacity(8);
        elements.extend_from_slice(commitment.as_elements());
        elements.extend_from_slice(message.as_elements());

        assert_eq!(key, Hasher::hash_elements(&elements));
        assert!(!values.is_empty());
    }

    #[test]
    fn signature_scheme_build_signature_advice_entry_requires_ecdsa_public_key() {
        let secret_key = EcdsaSecretKey::new();
        let message = Word::from([1u32, 2, 3, 4]);
        let commitment = secret_key.public_key().to_commitment();
        let signature = AccountSignature::EcdsaK256Keccak(secret_key.sign(message));

        let error = SignatureScheme::Ecdsa
            .build_signature_advice_entry(commitment, message, &signature, None)
            .unwrap_err();

        assert!(error.contains("requires public key"));
    }

    #[test]
    fn signature_scheme_build_signature_advice_entry_rejects_mismatched_ecdsa_public_key() {
        let secret_key = EcdsaSecretKey::new();
        let other_secret_key = EcdsaSecretKey::new();
        let other_public_key = other_secret_key.public_key();
        let other_public_key_hex = format!("0x{}", ::hex::encode(other_public_key.to_bytes()));
        let message = Word::from([1u32, 2, 3, 4]);
        let commitment = secret_key.public_key().to_commitment();
        let signature = AccountSignature::EcdsaK256Keccak(secret_key.sign(message));

        let error = SignatureScheme::Ecdsa
            .build_signature_advice_entry(
                commitment,
                message,
                &signature,
                Some(&other_public_key_hex),
            )
            .unwrap_err();

        assert!(error.contains("ECDSA public key commitment mismatch"));
    }
}