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

// Copyright (C) 2019-2023 Aleo Systems Inc.
// 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.

#![forbid(unsafe_code)]
#![cfg_attr(test, allow(clippy::assertions_on_result_states))]

mod helpers;

mod compare;
mod equal;
mod ternary;

#[cfg(test)]
use console::{TestRng, Uniform};
#[cfg(test)]
use snarkvm_circuit_environment::{assert_count, assert_output_mode, assert_scope, count, output_mode};

use snarkvm_circuit_environment::prelude::*;
use snarkvm_circuit_types_boolean::Boolean;
use snarkvm_circuit_types_field::Field;
use snarkvm_circuit_types_group::Group;
use snarkvm_circuit_types_scalar::Scalar;

use core::str::FromStr;

#[derive(Clone)]
pub struct Address<E: Environment>(Group<E>);

impl<E: Environment> AddressTrait for Address<E> {}

#[cfg(console)]
impl<E: Environment> Inject for Address<E> {
    type Primitive = console::Address<E::Network>;

    /// Initializes a new instance of an address.
    fn new(mode: Mode, address: Self::Primitive) -> Self {
        Self(Group::new(mode, *address))
    }
}

#[cfg(console)]
impl<E: Environment> Eject for Address<E> {
    type Primitive = console::Address<E::Network>;

    /// Ejects the mode of the address.
    fn eject_mode(&self) -> Mode {
        self.0.eject_mode()
    }

    /// Ejects the address.
    fn eject_value(&self) -> Self::Primitive {
        Self::Primitive::new(self.0.eject_value())
    }
}

#[cfg(console)]
impl<E: Environment> Parser for Address<E> {
    /// Parses a string into an address circuit.
    #[inline]
    fn parse(string: &str) -> ParserResult<Self> {
        // Parse the address from the string.
        let (string, address) = console::Address::parse(string)?;
        // Parse the mode from the string.
        let (string, mode) = opt(pair(tag("."), Mode::parse))(string)?;

        match mode {
            Some((_, mode)) => Ok((string, Address::new(mode, address))),
            None => Ok((string, Address::new(Mode::Constant, address))),
        }
    }
}

#[cfg(console)]
impl<E: Environment> FromStr for Address<E> {
    type Err = Error;

    /// Parses a string into a address.
    #[inline]
    fn from_str(string: &str) -> Result<Self> {
        match Self::parse(string) {
            Ok((remainder, object)) => {
                // Ensure the remainder is empty.
                ensure!(remainder.is_empty(), "Failed to parse string. Found invalid character in: \"{remainder}\"");
                // Return the object.
                Ok(object)
            }
            Err(error) => bail!("Failed to parse string. {error}"),
        }
    }
}

#[cfg(console)]
impl<E: Environment> TypeName for Address<E> {
    /// Returns the type name of the circuit as a string.
    #[inline]
    fn type_name() -> &'static str {
        console::Address::<E::Network>::type_name()
    }
}

#[cfg(console)]
impl<E: Environment> Debug for Address<E> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        Display::fmt(self, f)
    }
}

#[cfg(console)]
impl<E: Environment> Display for Address<E> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{}.{}", self.eject_value(), self.eject_mode())
    }
}

impl<E: Environment> From<Address<E>> for LinearCombination<E::BaseField> {
    fn from(address: Address<E>) -> Self {
        From::from(&address)
    }
}

impl<E: Environment> From<&Address<E>> for LinearCombination<E::BaseField> {
    fn from(address: &Address<E>) -> Self {
        From::from(address.to_field())
    }
}

#[cfg(all(test, console))]
mod tests {
    use super::*;
    use snarkvm_circuit_environment::Circuit;

    #[test]
    fn test_address_parse() {
        let expected = "aleo1d5hg2z3ma00382pngntdp68e74zv54jdxy249qhaujhks9c72yrs33ddah.public";
        let address = Address::<Circuit>::parse(expected).unwrap().1;
        assert_eq!(expected, &format!("{address}"));
    }
}