proposal_v1.rs 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359
  1. /* This file is part of DarkFi (https://dark.fi)
  2. *
  3. * Copyright (C) 2020-2023 Dyne.org foundation
  4. *
  5. * This program is free software: you can redistribute it and/or modify
  6. * it under the terms of the GNU Affero General Public License as
  7. * published by the Free Software Foundation, either version 3 of the
  8. * License, or (at your option) any later version.
  9. *
  10. * This program is distributed in the hope that it will be useful,
  11. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13. * GNU Affero General Public License for more details.
  14. *
  15. * You should have received a copy of the GNU Affero General Public License
  16. * along with this program. If not, see <https://www.gnu.org/licenses/>.
  17. */
  18. //! This API is crufty. Please rework it into something nice to read and nice to use.
  19. use darkfi::{
  20. error::Error::CoinIsNotSlotProducer,
  21. zk::{halo2::Value, Proof, ProvingKey, Witness, ZkCircuit},
  22. zkas::ZkBinary,
  23. Result,
  24. };
  25. use darkfi_money_contract::{
  26. client::{ConsensusNote, ConsensusOwnCoin},
  27. model::{Coin, ConsensusInput, ConsensusOutput, POW_REWARD},
  28. };
  29. use darkfi_sdk::{
  30. blockchain::Slot,
  31. bridgetree::Hashable,
  32. crypto::{
  33. ecvrf::VrfProof, note::AeadEncryptedNote, pasta_prelude::*, pedersen_commitment_u64,
  34. poseidon_hash, Keypair, MerkleNode, MerkleTree, Nullifier, PublicKey, SecretKey,
  35. },
  36. pasta::{group::ff::FromUniformBytes, pallas},
  37. };
  38. use log::{debug, error, info};
  39. use rand::rngs::OsRng;
  40. use crate::{
  41. client::common::{ConsensusBurnInputInfo, ConsensusMintOutputInfo},
  42. model::{
  43. ConsensusProposalParamsV1, HEADSTART, MU_RHO_PREFIX, MU_Y_PREFIX, SECRET_KEY_PREFIX,
  44. SEED_PREFIX, SERIAL_PREFIX,
  45. },
  46. };
  47. pub struct ConsensusProposalCallDebris {
  48. /// Payload params
  49. pub params: ConsensusProposalParamsV1,
  50. /// ZK proofs
  51. pub proofs: Vec<Proof>,
  52. /// The new output keypair (used in the minted coin)
  53. pub keypair: Keypair,
  54. /// Secret key used to sign the transaction
  55. pub signature_secret: SecretKey,
  56. }
  57. pub struct ConsensusProposalRevealed {
  58. pub nullifier: Nullifier,
  59. pub epoch: u64,
  60. pub public_key: PublicKey,
  61. pub merkle_root: MerkleNode,
  62. pub input_value_commit: pallas::Point,
  63. pub reward: u64,
  64. pub output_value_commit: pallas::Point,
  65. pub output_coin: Coin,
  66. pub vrf_proof: VrfProof,
  67. pub mu_y: pallas::Base,
  68. pub y: pallas::Base,
  69. pub mu_rho: pallas::Base,
  70. pub rho: pallas::Base,
  71. pub sigma1: pallas::Base,
  72. pub sigma2: pallas::Base,
  73. pub headstart: pallas::Base,
  74. }
  75. impl ConsensusProposalRevealed {
  76. fn to_vec(&self) -> Vec<pallas::Base> {
  77. let (pub_x, pub_y) = self.public_key.xy();
  78. let input_value_coords = self.input_value_commit.to_affine().coordinates().unwrap();
  79. let output_value_coords = self.output_value_commit.to_affine().coordinates().unwrap();
  80. // NOTE: It's important to keep these in the same order
  81. // as the `constrain_instance` calls in the zkas code.
  82. vec![
  83. self.nullifier.inner(),
  84. pallas::Base::from(self.epoch),
  85. pub_x,
  86. pub_y,
  87. self.merkle_root.inner(),
  88. *input_value_coords.x(),
  89. *input_value_coords.y(),
  90. pallas::Base::from(self.reward),
  91. *output_value_coords.x(),
  92. *output_value_coords.y(),
  93. self.output_coin.inner(),
  94. self.mu_y,
  95. self.y,
  96. self.mu_rho,
  97. self.rho,
  98. self.sigma1,
  99. self.sigma2,
  100. self.headstart,
  101. ]
  102. }
  103. }
  104. /// Struct holding necessary information to build a proposal transaction.
  105. pub struct ConsensusProposalCallBuilder {
  106. /// `ConsensusOwnCoin` we're given to use in this builder
  107. pub owncoin: ConsensusOwnCoin,
  108. /// Rewarded slot
  109. pub slot: Slot,
  110. /// Extending fork last proposal/block hash
  111. pub fork_hash: blake3::Hash,
  112. /// Extending fork second to last proposal/block hash
  113. pub fork_previous_hash: blake3::Hash,
  114. /// Merkle tree of coins used to create inclusion proofs
  115. pub merkle_tree: MerkleTree,
  116. /// `Proposal_V1` zkas circuit ZkBinary
  117. pub proposal_zkbin: ZkBinary,
  118. /// Proving key for the `Proposal_V1` zk circuit
  119. pub proposal_pk: ProvingKey,
  120. }
  121. impl ConsensusProposalCallBuilder {
  122. pub fn build(&self) -> Result<ConsensusProposalCallDebris> {
  123. let input_value_blind = pallas::Scalar::random(&mut OsRng);
  124. let output_reward_blind = pallas::Scalar::random(&mut OsRng);
  125. self.build_with_params(input_value_blind, output_reward_blind)
  126. }
  127. pub fn build_with_params(
  128. &self,
  129. input_value_blind: pallas::Scalar,
  130. output_reward_blind: pallas::Scalar,
  131. ) -> Result<ConsensusProposalCallDebris> {
  132. info!("Building Consensus::ProposalBurnV1 contract call");
  133. assert!(self.owncoin.note.value != 0);
  134. debug!("Building Consensus::ProposalV1 anonymous input");
  135. let merkle_path = self.merkle_tree.witness(self.owncoin.leaf_position, 0).unwrap();
  136. let input = ConsensusBurnInputInfo {
  137. leaf_position: self.owncoin.leaf_position,
  138. merkle_path,
  139. secret: self.owncoin.secret,
  140. note: self.owncoin.note.clone(),
  141. value_blind: input_value_blind,
  142. };
  143. debug!("Building Consensus::ProposalV1 anonymous output");
  144. let output_value_blind = input.value_blind + output_reward_blind;
  145. // The output's secret key is derived from the old secret key
  146. let output_secret_key = poseidon_hash([SECRET_KEY_PREFIX, self.owncoin.secret.inner()]);
  147. let output_keypair = Keypair::new(SecretKey::from(output_secret_key));
  148. // The output's serial is derived from the old serial
  149. let output_serial =
  150. poseidon_hash([SERIAL_PREFIX, self.owncoin.secret.inner(), self.owncoin.note.serial]);
  151. let output = ConsensusMintOutputInfo {
  152. value: self.owncoin.note.value + POW_REWARD,
  153. epoch: 0, // We set the epoch as 0 here to eliminate a potential timelock
  154. public_key: output_keypair.public,
  155. value_blind: output_value_blind,
  156. serial: output_serial,
  157. };
  158. info!("Building Consensus::ProposalV1 VRF proof");
  159. let mut vrf_input = Vec::with_capacity(32 + blake3::OUT_LEN + 32);
  160. vrf_input.extend_from_slice(&self.slot.last_nonce.to_repr());
  161. vrf_input.extend_from_slice(self.fork_previous_hash.as_bytes());
  162. vrf_input.extend_from_slice(&pallas::Base::from(self.slot.id).to_repr());
  163. let vrf_proof = VrfProof::prove(input.secret, &vrf_input, &mut OsRng);
  164. info!("Building Consensus::ProposalV1 ZK proof");
  165. let (proof, public_inputs) = create_proposal_proof(
  166. &self.proposal_zkbin,
  167. &self.proposal_pk,
  168. &input,
  169. &output,
  170. &self.slot,
  171. &vrf_proof,
  172. )?;
  173. let tx_input = ConsensusInput {
  174. epoch: input.note.epoch,
  175. value_commit: public_inputs.input_value_commit,
  176. nullifier: public_inputs.nullifier,
  177. merkle_root: public_inputs.merkle_root,
  178. signature_public: public_inputs.public_key,
  179. };
  180. // Output's encrypted note
  181. let note = ConsensusNote {
  182. serial: output.serial,
  183. value: output.value,
  184. epoch: output.epoch,
  185. value_blind: output.value_blind,
  186. reward: POW_REWARD,
  187. reward_blind: output_reward_blind,
  188. };
  189. let encrypted_note = AeadEncryptedNote::encrypt(&note, &output.public_key, &mut OsRng)?;
  190. let tx_output = ConsensusOutput {
  191. value_commit: public_inputs.output_value_commit,
  192. coin: public_inputs.output_coin,
  193. note: encrypted_note,
  194. };
  195. // Construct params
  196. let params = ConsensusProposalParamsV1 {
  197. input: tx_input,
  198. output: tx_output,
  199. reward: POW_REWARD,
  200. reward_blind: output_reward_blind,
  201. fork_hash: self.fork_hash,
  202. fork_previous_hash: self.fork_previous_hash,
  203. vrf_proof,
  204. y: public_inputs.y,
  205. rho: public_inputs.rho,
  206. };
  207. // Construct debris
  208. let debris = ConsensusProposalCallDebris {
  209. params,
  210. proofs: vec![proof],
  211. keypair: output_keypair,
  212. signature_secret: input.secret,
  213. };
  214. Ok(debris)
  215. }
  216. }
  217. fn create_proposal_proof(
  218. zkbin: &ZkBinary,
  219. pk: &ProvingKey,
  220. input: &ConsensusBurnInputInfo,
  221. output: &ConsensusMintOutputInfo,
  222. slot: &Slot,
  223. vrf_proof: &VrfProof,
  224. ) -> Result<(Proof, ConsensusProposalRevealed)> {
  225. // TODO: fork_hash to be used as part of rank constrain in the proof
  226. // Calculate lottery parameters
  227. let seed = poseidon_hash([SEED_PREFIX, input.note.serial]);
  228. let mut eta = [0u8; 64];
  229. eta[..blake3::OUT_LEN].copy_from_slice(vrf_proof.hash_output().as_bytes());
  230. let eta = pallas::Base::from_uniform_bytes(&eta);
  231. let mu_y = poseidon_hash([MU_Y_PREFIX, eta, pallas::Base::from(slot.id)]);
  232. let y = poseidon_hash([seed, mu_y]);
  233. let mu_rho = poseidon_hash([MU_RHO_PREFIX, eta, pallas::Base::from(slot.id)]);
  234. let rho = poseidon_hash([seed, mu_rho]);
  235. // Verify coin is the slot block producer
  236. let value_pallas = pallas::Base::from(input.note.value);
  237. let shifted_target =
  238. slot.pid.sigma1 * value_pallas + slot.pid.sigma2 * value_pallas * value_pallas + HEADSTART;
  239. if y >= shifted_target {
  240. error!("MU_Y: {:?}", mu_y);
  241. error!("Y: {:?}", y);
  242. error!("TARGET: {:?}", shifted_target);
  243. return Err(CoinIsNotSlotProducer)
  244. }
  245. // Derive the input's nullifier
  246. let nullifier = Nullifier::from(poseidon_hash([input.secret.inner(), input.note.serial]));
  247. // Create the value commitment for the input
  248. let input_value_commit = pedersen_commitment_u64(input.note.value, input.value_blind);
  249. // Merkle inclusion proof for the input
  250. let public_key = PublicKey::from_secret(input.secret);
  251. let (pub_x, pub_y) = public_key.xy();
  252. let coin = poseidon_hash([
  253. pub_x,
  254. pub_y,
  255. pallas::Base::from(input.note.value),
  256. pallas::Base::from(input.note.epoch),
  257. input.note.serial,
  258. ]);
  259. let merkle_root = {
  260. let position: u64 = input.leaf_position.into();
  261. let mut current = MerkleNode::from(coin);
  262. for (level, sibling) in input.merkle_path.iter().enumerate() {
  263. let level = level as u8;
  264. current = if position & (1 << level) == 0 {
  265. MerkleNode::combine(level.into(), &current, sibling)
  266. } else {
  267. MerkleNode::combine(level.into(), sibling, &current)
  268. };
  269. }
  270. current
  271. };
  272. // Derive the new output coin
  273. let (output_x, output_y) = output.public_key.xy();
  274. let output_coin = Coin::from(poseidon_hash([
  275. output_x,
  276. output_y,
  277. pallas::Base::from(output.value),
  278. pallas::Base::from(output.epoch),
  279. output.serial,
  280. ]));
  281. // Create the ZK proof
  282. let public_inputs = ConsensusProposalRevealed {
  283. nullifier,
  284. epoch: input.note.epoch,
  285. public_key,
  286. merkle_root,
  287. input_value_commit,
  288. reward: POW_REWARD,
  289. output_value_commit: pedersen_commitment_u64(output.value, output.value_blind),
  290. output_coin,
  291. vrf_proof: *vrf_proof,
  292. mu_y,
  293. y,
  294. mu_rho,
  295. rho,
  296. sigma1: slot.pid.sigma1,
  297. sigma2: slot.pid.sigma2,
  298. headstart: HEADSTART,
  299. };
  300. let prover_witnesses = vec![
  301. Witness::Base(Value::known(input.secret.inner())),
  302. Witness::Base(Value::known(input.note.serial)),
  303. Witness::Base(Value::known(pallas::Base::from(input.note.value))),
  304. Witness::Base(Value::known(pallas::Base::from(input.note.epoch))),
  305. Witness::Base(Value::known(pallas::Base::from(POW_REWARD))),
  306. Witness::Scalar(Value::known(input.value_blind)),
  307. Witness::Uint32(Value::known(u64::from(input.leaf_position).try_into().unwrap())),
  308. Witness::MerklePath(Value::known(input.merkle_path.clone().try_into().unwrap())),
  309. Witness::Scalar(Value::known(output.value_blind)),
  310. Witness::Base(Value::known(public_inputs.mu_y)),
  311. Witness::Base(Value::known(public_inputs.mu_rho)),
  312. Witness::Base(Value::known(public_inputs.sigma1)),
  313. Witness::Base(Value::known(public_inputs.sigma2)),
  314. Witness::Base(Value::known(public_inputs.headstart)),
  315. ];
  316. let circuit = ZkCircuit::new(prover_witnesses, zkbin);
  317. let proof = Proof::create(pk, &[circuit], &public_inputs.to_vec(), &mut OsRng)?;
  318. Ok((proof, public_inputs))
  319. }