snarkvm_circuit_account/private_key/
mod.rs

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
// Copyright 2024 Aleo Network Foundation
// This file is part of the snarkVM library.

// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at:

// http://www.apache.org/licenses/LICENSE-2.0

// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

mod to_compute_key;
mod to_view_key;

#[cfg(test)]
use snarkvm_circuit_types::environment::assert_scope;

use crate::{ComputeKey, ViewKey};
use snarkvm_circuit_network::Aleo;
use snarkvm_circuit_types::{Scalar, environment::prelude::*};

pub struct PrivateKey<A: Aleo> {
    /// The signature secret key.
    sk_sig: Scalar<A>,
    /// The signature secret randomizer.
    r_sig: Scalar<A>,
}

#[cfg(feature = "console")]
impl<A: Aleo> Inject for PrivateKey<A> {
    type Primitive = console::PrivateKey<A::Network>;

    /// Initializes an account private key from the given mode and native private key.
    fn new(mode: Mode, private_key: Self::Primitive) -> Self {
        Self { sk_sig: Scalar::new(mode, private_key.sk_sig()), r_sig: Scalar::new(mode, private_key.r_sig()) }
    }
}

impl<A: Aleo> PrivateKey<A> {
    /// Returns the signature secret key.
    pub const fn sk_sig(&self) -> &Scalar<A> {
        &self.sk_sig
    }

    /// Returns the signature randomizer.
    pub const fn r_sig(&self) -> &Scalar<A> {
        &self.r_sig
    }
}

#[cfg(feature = "console")]
impl<A: Aleo> Eject for PrivateKey<A> {
    type Primitive = (console::Scalar<A::Network>, console::Scalar<A::Network>);

    /// Ejects the mode of the account private key.
    fn eject_mode(&self) -> Mode {
        (&self.sk_sig, &self.r_sig).eject_mode()
    }

    /// Ejects the account private key as `(sk_sig, r_sig)`.
    fn eject_value(&self) -> Self::Primitive {
        (&self.sk_sig, &self.r_sig).eject_value()
    }
}

#[cfg(all(test, feature = "console"))]
mod tests {
    use super::*;
    use crate::{Circuit, helpers::generate_account};

    use anyhow::Result;

    const ITERATIONS: u64 = 500;

    fn check_new(
        mode: Mode,
        num_constants: u64,
        num_public: u64,
        num_private: u64,
        num_constraints: u64,
    ) -> Result<()> {
        for _ in 0..ITERATIONS {
            // Generate a private key, compute key, view key, and address.
            let (private_key, _compute_key, _view_key, _address) = generate_account()?;

            // Retrieve the native private key components.
            let sk_sig = private_key.sk_sig();
            let r_sig = private_key.r_sig();

            Circuit::scope(format!("New {mode}"), || {
                let candidate = PrivateKey::<Circuit>::new(mode, private_key);
                assert_eq!(mode, candidate.eject_mode());
                assert_eq!((sk_sig, r_sig), candidate.eject_value());
                assert_scope!(num_constants, num_public, num_private, num_constraints);
            });
            Circuit::reset();
        }
        Ok(())
    }

    #[test]
    fn test_private_key_new_constant() -> Result<()> {
        check_new(Mode::Constant, 2, 0, 0, 0)
    }

    #[test]
    fn test_private_key_new_public() -> Result<()> {
        check_new(Mode::Public, 0, 2, 0, 0)
    }

    #[test]
    fn test_private_key_new_private() -> Result<()> {
        check_new(Mode::Private, 0, 0, 2, 0)
    }
}