darkfi_money_contract/model/
token_id.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
/* This file is part of DarkFi (https://dark.fi)
 *
 * Copyright (C) 2020-2024 Dyne.org foundation
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

use darkfi_sdk::{
    crypto::{
        constants::DRK_TOKEN_ID_PERSONALIZATION, pasta_prelude::PrimeField, util::hash_to_base,
    },
    error::ContractError,
    pasta::pallas,
};
use darkfi_serial::{SerialDecodable, SerialEncodable};
use lazy_static::lazy_static;

#[cfg(feature = "client")]
use darkfi_serial::async_trait;

use super::{poseidon_hash, PublicKey, SecretKey};

lazy_static! {
    // Is this even needed? Not used elsewhere except here.
    /// Derivation prefix for `TokenId`
    pub static ref TOKEN_ID_PREFIX: pallas::Base = pallas::Base::from(69);

    /// Native DARK token ID.
    /// It does not correspond to any real commitment since we only rely on this value as
    /// a constant.
    pub static ref DARK_TOKEN_ID: TokenId = TokenId(hash_to_base(&[0x69], &[DRK_TOKEN_ID_PERSONALIZATION]));
}

/// TokenId represents an on-chain identifier for a certain token.
#[derive(Copy, Clone, Debug, Eq, PartialEq, SerialEncodable, SerialDecodable)]
pub struct TokenId(pallas::Base);

impl TokenId {
    /// Derives a `TokenId` from a `SecretKey` (mint authority)
    // TODO: this got deprected from DEP 0003, but why? ain't that mean
    // we don't allow users to hold mint keys with their secret?
    //#[deprecated]
    pub fn derive(mint_authority: SecretKey) -> Self {
        let public_key = PublicKey::from_secret(mint_authority);
        Self::derive_public(public_key)
    }

    /// Derives a `TokenId` from a `PublicKey`
    // TODO: this got deprected from DEP 0003, but why? ain't that mean
    // we don't allow users to hold mint keys with their secret?
    //#[deprecated]
    pub fn derive_public(public_key: PublicKey) -> Self {
        let (x, y) = public_key.xy();
        Self::derive_from(*TOKEN_ID_PREFIX, x, y)
    }

    pub fn derive_from(
        func_id: pallas::Base,
        user_data: pallas::Base,
        blind: pallas::Base,
    ) -> Self {
        let token_id = poseidon_hash([func_id, user_data, blind]);
        Self(token_id)
    }

    /// Get the inner `pallas::Base` element.
    pub fn inner(&self) -> pallas::Base {
        self.0
    }

    /// Create a `TokenId` object from given bytes, erroring if the input
    /// bytes are noncanonical.
    pub fn from_bytes(x: [u8; 32]) -> Result<Self, ContractError> {
        match pallas::Base::from_repr(x).into() {
            Some(v) => Ok(Self(v)),
            None => {
                Err(ContractError::IoError("Failed to instantiate TokenId from bytes".to_string()))
            }
        }
    }

    /// Convert the `TokenId` type into 32 raw bytes
    pub fn to_bytes(&self) -> [u8; 32] {
        self.0.to_repr()
    }
}

use core::str::FromStr;
darkfi_sdk::fp_from_bs58!(TokenId);
darkfi_sdk::fp_to_bs58!(TokenId);
darkfi_sdk::ty_from_fp!(TokenId);