Money Contract Source Code

BZHKGQ26bzmBithTQYTJtjo2QdCqpkR9tjSBopT4yf4o
entrypoint/fee_v1.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
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
/* This file is part of DarkFi (https://dark.fi)
 *
 * Copyright (C) 2020-2025 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::{
        pasta_prelude::*,
        pedersen_commitment_u64, poseidon_hash,
        smt::{
            wasmdb::{SmtWasmDbStorage, SmtWasmFp},
            PoseidonFp, EMPTY_NODES_FP,
        },
        ContractId, MerkleNode, PublicKey,
    },
    dark_tree::DarkLeaf,
    error::{ContractError, ContractResult},
    msg,
    pasta::pallas,
    wasm, ContractCall,
};
use darkfi_serial::{deserialize, serialize, Encodable};

use crate::{
    error::MoneyError,
    model::{MoneyFeeParamsV1, MoneyFeeUpdateV1, DARK_TOKEN_ID},
    MONEY_CONTRACT_COINS_TREE, MONEY_CONTRACT_COIN_MERKLE_TREE, MONEY_CONTRACT_COIN_ROOTS_TREE,
    MONEY_CONTRACT_FEES_TREE, MONEY_CONTRACT_INFO_TREE, MONEY_CONTRACT_LATEST_COIN_ROOT,
    MONEY_CONTRACT_LATEST_NULLIFIER_ROOT, MONEY_CONTRACT_NULLIFIERS_TREE,
    MONEY_CONTRACT_NULLIFIER_ROOTS_TREE, MONEY_CONTRACT_ZKAS_FEE_NS_V1,
};

/// `get_metadata` function for `Money::FeeV1`
pub(crate) fn money_fee_get_metadata_v1(
    _cid: ContractId,
    call_idx: usize,
    calls: Vec<DarkLeaf<ContractCall>>,
) -> Result<Vec<u8>, ContractError> {
    let self_ = &calls[call_idx].data;
    // The first 8 bytes here is the u64 fee, so we get the params from that offset.
    // (Plus 1, which is the function identifier byte)
    let params: MoneyFeeParamsV1 = deserialize(&self_.data[9..])?;

    // Public inputs for the ZK proofs we have to verify
    let mut zk_public_inputs: Vec<(String, Vec<pallas::Base>)> = vec![];
    // Public keys for the transaction signatures we have to verify
    let signature_pubkeys: Vec<PublicKey> = vec![params.input.signature_public];

    // Grab the Pedersen commitments and the signature pubkey from the params
    let input_value_coords = params.input.value_commit.to_affine().coordinates().unwrap();
    let output_value_coords = params.output.value_commit.to_affine().coordinates().unwrap();
    let (sig_x, sig_y) = params.input.signature_public.xy();

    zk_public_inputs.push((
        MONEY_CONTRACT_ZKAS_FEE_NS_V1.to_string(),
        vec![
            params.input.nullifier.inner(),
            *input_value_coords.x(),
            *input_value_coords.y(),
            params.input.token_commit,
            params.input.merkle_root.inner(),
            params.input.user_data_enc,
            sig_x,
            sig_y,
            params.output.coin.inner(),
            *output_value_coords.x(),
            *output_value_coords.y(),
        ],
    ));

    // Serialize everything gathered and return it
    let mut metadata = vec![];
    zk_public_inputs.encode(&mut metadata)?;
    signature_pubkeys.encode(&mut metadata)?;

    Ok(metadata)
}

/// `process_instruction` function for `Money::FeeV1`
pub(crate) fn money_fee_process_instruction_v1(
    cid: ContractId,
    call_idx: usize,
    calls: Vec<DarkLeaf<ContractCall>>,
) -> Result<Vec<u8>, ContractError> {
    let self_ = &calls[call_idx];
    let fee: u64 = deserialize(&self_.data.data[1..9])?;
    let params: MoneyFeeParamsV1 = deserialize(&self_.data.data[9..])?;

    // We should have _some_ fee paid...
    if fee == 0 {
        msg!("[FeeV1] Error: Paid fee is 0");
        return Err(MoneyError::InsufficientFee.into())
    }

    // Access the necessary databases where there is information to
    // validate this state transition.
    let coins_db = wasm::db::db_lookup(cid, MONEY_CONTRACT_COINS_TREE)?;
    let nullifiers_db = wasm::db::db_lookup(cid, MONEY_CONTRACT_NULLIFIERS_TREE)?;
    let coin_roots_db = wasm::db::db_lookup(cid, MONEY_CONTRACT_COIN_ROOTS_TREE)?;
    let fees_db = wasm::db::db_lookup(cid, MONEY_CONTRACT_FEES_TREE)?;

    // Fees can only be paid using the native token, so we'll compare
    // the token commitments with this one:
    let native_token_commit = poseidon_hash([DARK_TOKEN_ID.inner(), params.token_blind.inner()]);

    // ===================================
    // Perform the actual state transition
    // ===================================
    if params.input.token_commit != native_token_commit {
        msg!("[FeeV1] Error: Input token commitment is not the native token");
        return Err(MoneyError::TokenMismatch.into())
    }

    // Verify that the token commitment matches
    if params.output.token_commit != native_token_commit {
        msg!("[FeeV1] Error: Output token commitment is not native token");
        return Err(MoneyError::TokenMismatch.into())
    }

    // The Merkle root is used to know whether this is a coin that
    // existed in a previous state.
    if !wasm::db::db_contains_key(coin_roots_db, &serialize(&params.input.merkle_root))? {
        msg!("[FeeV1] Error: Input Merkle root not found in previous state");
        return Err(MoneyError::CoinMerkleRootNotFound.into())
    }

    let hasher = PoseidonFp::new();
    let empty_leaf = pallas::Base::ZERO;
    let smt_store = SmtWasmDbStorage::new(nullifiers_db);
    let smt = SmtWasmFp::new(smt_store, hasher, &EMPTY_NODES_FP);

    // The nullifiers should not already exist. It is the double-spend protection.
    if smt.get_leaf(&params.input.nullifier.inner()) != empty_leaf {
        msg!("[FeeV1] Error: Duplicate nullifier found");
        return Err(MoneyError::DuplicateNullifier.into())
    }

    // The new coin should not exist
    if wasm::db::db_contains_key(coins_db, &serialize(&params.output.coin))? {
        msg!("[FeeV1] Error: Duplicate coin found");
        return Err(MoneyError::DuplicateCoin.into())
    }

    // Accumulator for the value commitments. We add inputs to it, and
    // subtract the outputs and the fee from it. For the commitments to
    // be valid, the accumulatior must be in its initial state after
    // performing the arithmetics.
    let mut valcom_total = pallas::Point::identity();

    // Accumulate the input value commitment.
    valcom_total += params.input.value_commit;

    // Subtract the output value commitment
    valcom_total -= params.output.value_commit;

    // Now subtract the fee from the accumulator
    valcom_total -= pedersen_commitment_u64(fee, params.fee_value_blind);

    // If the accumulator is not back in its initial; state, that means there
    // is a value mismatch betweeen inputs and outputs.
    if valcom_total != pallas::Point::identity() {
        msg!("[FeeV1] Error: Value commitments do not result in identity");
        return Err(MoneyError::ValueMismatch.into())
    }

    // Accumulate the height paid fee
    let verifying_block_height = wasm::util::get_verifying_block_height()?;
    let mut paid_fee: u64 =
        deserialize(&wasm::db::db_get(fees_db, &serialize(&verifying_block_height))?.unwrap())?;
    paid_fee += fee;

    // At this point the state transition has passed, so we create a state update.
    let update = MoneyFeeUpdateV1 {
        nullifier: params.input.nullifier,
        coin: params.output.coin,
        height: verifying_block_height,
        fee: paid_fee,
    };
    // and return it
    Ok(serialize(&update))
}

/// `process_update` function for `Money::FeeV1`
pub(crate) fn money_fee_process_update_v1(
    cid: ContractId,
    update: MoneyFeeUpdateV1,
) -> ContractResult {
    // Grab all necessary db handles for where we want to write
    let info_db = wasm::db::db_lookup(cid, MONEY_CONTRACT_INFO_TREE)?;
    let coins_db = wasm::db::db_lookup(cid, MONEY_CONTRACT_COINS_TREE)?;
    let nullifiers_db = wasm::db::db_lookup(cid, MONEY_CONTRACT_NULLIFIERS_TREE)?;
    let coin_roots_db = wasm::db::db_lookup(cid, MONEY_CONTRACT_COIN_ROOTS_TREE)?;
    let nullifier_roots_db = wasm::db::db_lookup(cid, MONEY_CONTRACT_NULLIFIER_ROOTS_TREE)?;
    let fees_db = wasm::db::db_lookup(cid, MONEY_CONTRACT_FEES_TREE)?;

    wasm::db::db_set(fees_db, &serialize(&update.height), &serialize(&update.fee))?;

    wasm::merkle::sparse_merkle_insert_batch(
        info_db,
        nullifiers_db,
        nullifier_roots_db,
        MONEY_CONTRACT_LATEST_NULLIFIER_ROOT,
        &[update.nullifier.inner()],
    )?;

    wasm::db::db_set(coins_db, &serialize(&update.coin), &[])?;

    wasm::merkle::merkle_add(
        info_db,
        coin_roots_db,
        MONEY_CONTRACT_LATEST_COIN_ROOT,
        MONEY_CONTRACT_COIN_MERKLE_TREE,
        &[MerkleNode::from(update.coin.inner())],
    )?;

    Ok(())
}