feat: GrumpkinScalar type

circuits/cpp/barretenberg/cpp/src/barretenberg/common/serialize.hpp

@@ -51,8 +51,7 @@ __extension__ using uint128_t = unsigned __int128;
 // NOLINTBEGIN(cppcoreguidelines-pro-type-reinterpret-cast, cert-dcl58-cpp)
 // clang-format on
 
-template <typename T>
-concept IntegralOrEnum = std::integral<T> || std::is_enum_v<T>;
+template <typename T> concept IntegralOrEnum = std::integral<T> || std::is_enum_v<T>;
 
 namespace serialize {
 // Forward declare derived msgpack methods

circuits/cpp/src/aztec3/circuits/abis/c_bind.cpp

@@ -185,7 +185,7 @@ WASM_EXPORT void abis__hash_vk(uint8_t const* vk_data_buf, uint8_t* output)
  * @brief Generates a function tree leaf from its preimage.
  * This is a WASM-export that can be called from Typescript.
  *
- * @details given a `uint8_t const*` buffer representing a function leaf's prieimage,
+ * @details given a `uint8_t const*` buffer representing a function leaf's preimage,
  * construct a FunctionLeafPreimage instance, hash, and return the serialized results
  * in the `output` buffer.
  *

circuits/cpp/src/aztec3/circuits/kernel/private/common.cpp

@@ -140,7 +140,7 @@ void common_update_end_values(DummyBuilder& builder,
 
     const auto& storage_contract_address = private_call_public_inputs.call_context.storage_contract_address;
 
-    // Transient read requests and witnessess are accumulated in public_inputs.end
+    // Transient read requests and witnesses are accumulated in public_inputs.end
     // We silo the read requests (domain separation per contract address)
     {
         for (size_t i = 0; i < read_requests.size(); ++i) {
@@ -193,10 +193,11 @@ void common_update_end_values(DummyBuilder& builder,
         std::array<NT::fr, MAX_NEW_NULLIFIERS_PER_CALL> siloed_nullified_commitments{};
         for (size_t i = 0; i < MAX_NEW_NULLIFIERS_PER_CALL; ++i) {
             siloed_nullified_commitments[i] =
-                nullified_commitments[i] == fr(0) ? fr(0)  // don't silo when empty
-                : nullified_commitments[i] == fr(EMPTY_NULLIFIED_COMMITMENT)
-                    ? fr(EMPTY_NULLIFIED_COMMITMENT)  // don't silo when empty
-                    : silo_commitment<NT>(storage_contract_address, nullified_commitments[i]);
+                nullified_commitments[i] == fr(0)
+                    ? fr(0)  // don't silo when empty
+                    : nullified_commitments[i] == fr(EMPTY_NULLIFIED_COMMITMENT)
+                          ? fr(EMPTY_NULLIFIED_COMMITMENT)  // don't silo when empty
+                          : silo_commitment<NT>(storage_contract_address, nullified_commitments[i]);
         }
 
         push_array_to_array(

circuits/cpp/src/aztec3/circuits/rollup/base/.test.cpp

@@ -475,8 +475,8 @@ TEST_F(base_rollup_tests, native_nullifier_tree_regression)
     DummyCircuitBuilder builder = DummyCircuitBuilder("base_rollup_tests__native_nullifier_tree_regression");
 
     // This test runs after some data has already been inserted into the tree
-    // This test will pre-populate the tree with 6 * KERNEL_NEW_NULLILFIERS_LENGTH values (0 item + 6 *
-    // KERNEL_NEW_NULLILFIERS_LENGTH -1 more) simulating that a rollup inserting two random values has already
+    // This test will pre-populate the tree with 6 * KERNEL_NEW_NULLIFIERS_LENGTH values (0 item + 6 *
+    // KERNEL_NEW_NULLIFIERS_LENGTH -1 more) simulating that a rollup inserting two random values has already
     // succeeded. Note that this corresponds to 3 (1 already initialized and 2 new ones) base rollups. This rollup then
     // adds two further random values that will end up having their low nullifiers point at each other
     std::vector<fr> initial_values(6 * MAX_NEW_NULLIFIERS_PER_TX - 1, 0);

yarn-project/acir-simulator/src/client/client_execution_context.ts

@@ -78,12 +78,14 @@ export class ClientTxExecutionContext {
    * @param contractAddress - The contract address.
    * @param ownerX - The x coordinate of the owner's public key.
    * @param ownerY - The y coordinate of the owner's public key.
-   * @returns The secret key of the owner.
+   * @returns The secret key of the owner as a pair of ACVM fields.
    */
   public async getSecretKey(contractAddress: AztecAddress, ownerX: ACVMField, ownerY: ACVMField) {
-    return toACVMField(
-      (await this.db.getSecretKey(contractAddress, new Point(fromACVMField(ownerX), fromACVMField(ownerY)))).value,
+    const secretKey = await this.db.getSecretKey(
+      contractAddress,
+      new Point(fromACVMField(ownerX), fromACVMField(ownerY)),
     );
+    return [toACVMField(secretKey.high), toACVMField(secretKey.low)];
   }
 
   /**

yarn-project/acir-simulator/src/client/db_oracle.ts

@@ -1,4 +1,4 @@
-import { CompleteAddress, HistoricBlockData, PrivateKey, PublicKey } from '@aztec/circuits.js';
+import { CompleteAddress, GrumpkinPrivateKey, HistoricBlockData, PublicKey } from '@aztec/circuits.js';
 import { FunctionAbi, FunctionDebugMetadata, FunctionSelector } from '@aztec/foundation/abi';
 import { AztecAddress } from '@aztec/foundation/aztec-address';
 import { EthAddress } from '@aztec/foundation/eth-address';
@@ -102,10 +102,10 @@ export interface DBOracle extends CommitmentsDB {
    *
    * @param contractAddress - The contract address. Ignored here. But we might want to return different keys for different contracts.
    * @param pubKey - The public key of an account.
-   * @returns A Promise that resolves to the secret key as a Buffer.
+   * @returns A Promise that resolves to the secret key.
    * @throws An Error if the input address does not match the public key address of the key pair.
    */
-  getSecretKey(contractAddress: AztecAddress, pubKey: PublicKey): Promise<PrivateKey>;
+  getSecretKey(contractAddress: AztecAddress, pubKey: PublicKey): Promise<GrumpkinPrivateKey>;
 
   /**
    * Retrieves a set of notes stored in the database for a given contract address and storage slot.

yarn-project/acir-simulator/src/client/private_execution.test.ts

@@ -9,7 +9,6 @@ import {
   L1_TO_L2_MSG_TREE_HEIGHT,
   MAX_NEW_COMMITMENTS_PER_CALL,
   PRIVATE_DATA_TREE_HEIGHT,
-  PrivateKey,
   PublicCallRequest,
   TxContext,
 } from '@aztec/circuits.js';
@@ -28,7 +27,7 @@ import { asyncMap } from '@aztec/foundation/async-map';
 import { AztecAddress } from '@aztec/foundation/aztec-address';
 import { toBufferBE } from '@aztec/foundation/bigint-buffer';
 import { EthAddress } from '@aztec/foundation/eth-address';
-import { Fr } from '@aztec/foundation/fields';
+import { Fr, GrumpkinScalar } from '@aztec/foundation/fields';
 import { DebugLogger, createDebugLogger } from '@aztec/foundation/log';
 import { AppendOnlyTree, Pedersen, StandardTree, newTree } from '@aztec/merkle-tree';
 import {
@@ -66,7 +65,7 @@ describe('Private Execution test suite', () => {
   let logger: DebugLogger;
 
   const defaultContractAddress = AztecAddress.random();
-  const ownerPk = PrivateKey.fromString('5e30a2f886b4b6a11aea03bf4910fbd5b24e61aa27ea4d05c393b3ab592a8d33');
+  const ownerPk = GrumpkinScalar.fromString('2dcc5485a58316776299be08c78fa3788a1a7961ae30dc747fb1be17692a8d32');
 
   const treeHeights: { [name: string]: number } = {
     privateData: PRIVATE_DATA_TREE_HEIGHT,
@@ -168,7 +167,7 @@ describe('Private Execution test suite', () => {
 
   describe('private token airdrop contract', () => {
     const contractAddress = defaultContractAddress;
-    const recipientPk = PrivateKey.fromString('0c9ed344548e8f9ba8aa3c9f8651eaa2853130f6c1e9c050ccf198f7ea18a7ec');
+    const recipientPk = GrumpkinScalar.fromString('0c9ed344548e8f9ba8aa3c9f8651eaa2853130f6c1e9c050ccf198f7ea18a7ec');
     const mockFirstNullifier = new Fr(1111);
     let owner: AztecAddress;
     let recipient: AztecAddress;
@@ -233,7 +232,11 @@ describe('Private Execution test suite', () => {
       const siloedNoteHash = siloCommitment(circuitsWasm, contractAddress, innerNoteHash);
       const uniqueSiloedNoteHash = computeUniqueCommitment(circuitsWasm, note.nonce, siloedNoteHash);
       const innerNullifier = Fr.fromBuffer(
-        pedersenPlookupCommitInputs(circuitsWasm, [uniqueSiloedNoteHash.toBuffer(), ownerPk.value]),
+        pedersenPlookupCommitInputs(circuitsWasm, [
+          uniqueSiloedNoteHash.toBuffer(),
+          ownerPk.high.toBuffer(),
+          ownerPk.low.toBuffer(),
+        ]),
       );
 
       const result = await acirSimulator.computeNoteHashAndNullifier(
@@ -400,7 +403,7 @@ describe('Private Execution test suite', () => {
 
   describe('private token contract', () => {
     const contractAddress = defaultContractAddress;
-    const recipientPk = PrivateKey.fromString('0c9ed344548e8f9ba8aa3c9f8651eaa2853130f6c1e9c050ccf198f7ea18a7ec');
+    const recipientPk = GrumpkinScalar.fromString('0c9ed344548e8f9ba8aa3c9f8651eaa2853130f6c1e9c050ccf198f7ea18a7ec');
     const mockFirstNullifier = new Fr(1111);
     let owner: AztecAddress;
     let recipient: AztecAddress;
@@ -465,7 +468,11 @@ describe('Private Execution test suite', () => {
       const siloedNoteHash = siloCommitment(circuitsWasm, contractAddress, innerNoteHash);
       const uniqueSiloedNoteHash = computeUniqueCommitment(circuitsWasm, note.nonce, siloedNoteHash);
       const innerNullifier = Fr.fromBuffer(
-        pedersenPlookupCommitInputs(circuitsWasm, [uniqueSiloedNoteHash.toBuffer(), ownerPk.value]),
+        pedersenPlookupCommitInputs(circuitsWasm, [
+          uniqueSiloedNoteHash.toBuffer(),
+          ownerPk.high.toBuffer(),
+          ownerPk.low.toBuffer(),
+        ]),
       );
 
       const result = await acirSimulator.computeNoteHashAndNullifier(
@@ -680,7 +687,7 @@ describe('Private Execution test suite', () => {
 
   describe('consuming messages', () => {
     const contractAddress = defaultContractAddress;
-    const recipientPk = PrivateKey.fromString('0c9ed344548e8f9ba8aa3c9f8651eaa2853130f6c1e9c050ccf198f7ea18a7ec');
+    const recipientPk = GrumpkinScalar.fromString('0c9ed344548e8f9ba8aa3c9f8651eaa2853130f6c1e9c050ccf198f7ea18a7ec');
 
     let recipient: AztecAddress;
 

yarn-project/acir-simulator/src/client/unconstrained_execution.test.ts

@@ -1,8 +1,8 @@
-import { CompleteAddress, FunctionData, HistoricBlockData, PrivateKey } from '@aztec/circuits.js';
+import { CompleteAddress, FunctionData, HistoricBlockData } from '@aztec/circuits.js';
 import { FunctionSelector, encodeArguments } from '@aztec/foundation/abi';
 import { AztecAddress } from '@aztec/foundation/aztec-address';
 import { EthAddress } from '@aztec/foundation/eth-address';
-import { Fr } from '@aztec/foundation/fields';
+import { Fr, GrumpkinScalar } from '@aztec/foundation/fields';
 import { PrivateTokenContractAbi } from '@aztec/noir-contracts/artifacts';
 import { FunctionCall } from '@aztec/types';
 
@@ -21,7 +21,7 @@ describe('Unconstrained Execution test suite', () => {
   });
 
   describe('private token contract', () => {
-    const ownerPk = PrivateKey.fromString('5e30a2f886b4b6a11aea03bf4910fbd5b24e61aa27ea4d05c393b3ab592a8d33');
+    const ownerPk = GrumpkinScalar.fromString('2dcc5485a58316776299be08c78fa3788a1a7961ae30dc747fb1be17692a8d32');
 
     let owner: AztecAddress;
 

yarn-project/acir-simulator/src/utils.ts

@@ -1,4 +1,4 @@
-import { CircuitsWasm, PrivateKey } from '@aztec/circuits.js';
+import { CircuitsWasm, GrumpkinPrivateKey } from '@aztec/circuits.js';
 import { Grumpkin, pedersenPlookupCommitInputs } from '@aztec/circuits.js/barretenberg';
 import { Fr } from '@aztec/foundation/fields';
 
@@ -37,7 +37,7 @@ export function computeSlotForMapping(mappingSlot: Fr, owner: NoirPoint | Fr, bb
  * @param grumpkin - The grumpkin instance.
  * @returns The public key.
  */
-export function toPublicKey(privateKey: PrivateKey, grumpkin: Grumpkin): NoirPoint {
+export function toPublicKey(privateKey: GrumpkinPrivateKey, grumpkin: Grumpkin): NoirPoint {
   const point = grumpkin.mul(Grumpkin.generator, privateKey);
   return {
     x: point.x.value,

yarn-project/aztec-cli/src/index.ts

@@ -3,6 +3,7 @@ import {
   Contract,
   ContractDeployer,
   Fr,
+  GrumpkinScalar,
   Point,
   generatePublicKey,
   getAccountWallets,
@@ -15,7 +16,7 @@ import { DebugLogger, LogFn } from '@aztec/foundation/log';
 import { fileURLToPath } from '@aztec/foundation/url';
 import { compileContract } from '@aztec/noir-compiler/cli';
 import { SchnorrAccountContractAbi } from '@aztec/noir-contracts/artifacts';
-import { CompleteAddress, ContractData, L2BlockL2Logs, PrivateKey, TxHash } from '@aztec/types';
+import { CompleteAddress, ContractData, L2BlockL2Logs, TxHash } from '@aztec/types';
 
 import { Command } from 'commander';
 import { readFileSync } from 'fs';
@@ -94,7 +95,10 @@ export function getProgram(log: LogFn, debugLogger: DebugLogger): Command {
 
   program
     .command('generate-private-key')
-    .description('Generates a 32-byte private key.')
+    .summary('Generates an encryption private key.')
+    .description(
+      'Generates a private key which fits into the scalar field used by Grumpkin curve, can be used as an encryption private key.',
+    )
     .option(
       '-m, --mnemonic',
       'An optional mnemonic string used for the private key generation. If not provided, random private key will be generated.',
@@ -104,11 +108,11 @@ export function getProgram(log: LogFn, debugLogger: DebugLogger): Command {
       let publicKey;
       if (options.mnemonic) {
         const acc = mnemonicToAccount(options.mnemonic);
-        const key = Buffer.from(acc.getHdKey().privateKey!);
-        privKey = key.toString('hex');
-        publicKey = await generatePublicKey(new PrivateKey(key));
+        // TODO(#2052): This reduction is not secure enough. TACKLE THIS ISSUE BEFORE MAINNET.
+        const key = GrumpkinScalar.fromBufferWithReduction(Buffer.from(acc.getHdKey().privateKey!));
+        publicKey = await generatePublicKey(key);
       } else {
-        const key = PrivateKey.random();
+        const key = GrumpkinScalar.random();
         privKey = key.toString();
         publicKey = await generatePublicKey(key);
       }
@@ -130,8 +134,8 @@ export function getProgram(log: LogFn, debugLogger: DebugLogger): Command {
     .action(async options => {
       const client = await createCompatibleClient(options.rpcUrl, debugLogger);
       const privateKey = options.privateKey
-        ? PrivateKey.fromString(stripLeadingHex(options.privateKey))
-        : PrivateKey.random();
+        ? GrumpkinScalar.fromString(stripLeadingHex(options.privateKey))
+        : GrumpkinScalar.random();
 
       const account = getSchnorrAccount(client, privateKey, privateKey, accountCreationSalt);
       const wallet = await account.waitDeploy();
@@ -380,7 +384,7 @@ export function getProgram(log: LogFn, debugLogger: DebugLogger): Command {
         );
       }
 
-      const privateKey = PrivateKey.fromString(stripLeadingHex(options.privateKey));
+      const privateKey = GrumpkinScalar.fromString(stripLeadingHex(options.privateKey));
 
       const client = await createCompatibleClient(options.rpcUrl, debugLogger);
       const wallet = await getAccountWallets(

yarn-project/aztec-rpc/src/aztec_rpc_http/aztec_rpc_http_server.ts

@@ -1,5 +1,5 @@
 import { AztecAddress } from '@aztec/foundation/aztec-address';
-import { Fr, Point } from '@aztec/foundation/fields';
+import { Fr, GrumpkinScalar, Point } from '@aztec/foundation/fields';
 import { JsonRpcServer } from '@aztec/foundation/json-rpc/server';
 import {
   AztecRPC,
@@ -8,7 +8,6 @@ import {
   ExtendedContractData,
   L2BlockL2Logs,
   NotePreimage,
-  PrivateKey,
   Tx,
   TxExecutionRequest,
   TxHash,
@@ -37,8 +36,8 @@ export function getHttpRpcServer(aztecRpcServer: AztecRPC): JsonRpcServer {
       TxHash,
       EthAddress,
       Point,
-      PrivateKey,
       Fr,
+      GrumpkinScalar,
       NotePreimage,
     },
     { Tx, TxReceipt, L2BlockL2Logs },

yarn-project/aztec-rpc/src/aztec_rpc_server/aztec_rpc_server.ts

@@ -10,10 +10,10 @@ import {
   CompleteAddress,
   EthAddress,
   FunctionData,
+  GrumpkinPrivateKey,
   KernelCircuitPublicInputsFinal,
   MAX_PUBLIC_CALL_STACK_LENGTH_PER_TX,
   PartialAddress,
-  PrivateKey,
   PublicCallRequest,
 } from '@aztec/circuits.js';
 import { encodeArguments } from '@aztec/foundation/abi';
@@ -104,7 +104,7 @@ export class AztecRPCServer implements AztecRPC {
     this.log.info('Stopped');
   }
 
-  public async registerAccount(privKey: PrivateKey, partialAddress: PartialAddress) {
+  public async registerAccount(privKey: GrumpkinPrivateKey, partialAddress: PartialAddress) {
     const completeAddress = await CompleteAddress.fromPrivateKeyAndPartialAddress(privKey, partialAddress);
     const wasAdded = await this.db.addCompleteAddress(completeAddress);
     if (wasAdded) {

yarn-project/aztec-rpc/src/kernel_prover/kernel_prover.ts

@@ -2,6 +2,7 @@ import { ExecutionResult, NewNoteData } from '@aztec/acir-simulator';
 import {
   AztecAddress,
   CONTRACT_TREE_HEIGHT,
+  EMPTY_NULLIFIED_COMMITMENT,
   Fr,
   MAX_NEW_COMMITMENTS_PER_TX,
   MAX_NEW_NULLIFIERS_PER_TX,
@@ -23,7 +24,6 @@ import {
   makeEmptyProof,
   makeTuple,
 } from '@aztec/circuits.js';
-import { EMPTY_NULLIFIED_COMMITMENT } from '@aztec/circuits.js';
 import { Tuple, assertLength } from '@aztec/foundation/serialize';
 
 import { KernelProofCreator, ProofCreator, ProofOutput, ProofOutputFinal } from './proof_creator.js';

yarn-project/aztec-rpc/src/simulator_oracle/index.ts

@@ -11,8 +11,8 @@ import {
   EthAddress,
   Fr,
   FunctionSelector,
+  GrumpkinPrivateKey,
   HistoricBlockData,
-  PrivateKey,
   PublicKey,
 } from '@aztec/circuits.js';
 import { siloCommitment } from '@aztec/circuits.js/abis';
@@ -33,7 +33,7 @@ export class SimulatorOracle implements DBOracle {
     private dataTreeProvider: DataCommitmentProvider,
   ) {}
 
-  getSecretKey(_contractAddress: AztecAddress, pubKey: PublicKey): Promise<PrivateKey> {
+  getSecretKey(_contractAddress: AztecAddress, pubKey: PublicKey): Promise<GrumpkinPrivateKey> {
     return this.keyStore.getAccountPrivateKey(pubKey);
   }
 

yarn-project/aztec-rpc/src/synchroniser/synchroniser.test.ts

@@ -1,4 +1,4 @@
-import { CompleteAddress, Fr, HistoricBlockData, PrivateKey } from '@aztec/circuits.js';
+import { CompleteAddress, Fr, GrumpkinScalar, HistoricBlockData } from '@aztec/circuits.js';
 import { Grumpkin } from '@aztec/circuits.js/barretenberg';
 import { TestKeyStore } from '@aztec/key-store';
 import { AztecNode, L2Block, MerkleTreeId } from '@aztec/types';
@@ -103,7 +103,7 @@ describe('Synchroniser', () => {
 
     // Manually adding account to database so that we can call synchroniser.isAccountStateSynchronised
     const keyStore = new TestKeyStore(await Grumpkin.new());
-    const privateKey = PrivateKey.random();
+    const privateKey = GrumpkinScalar.random();
     keyStore.addAccount(privateKey);
     const completeAddress = await CompleteAddress.fromPrivateKeyAndPartialAddress(privateKey, Fr.random());
     await database.addCompleteAddress(completeAddress);

yarn-project/aztec-sandbox/src/examples/private_token_contract.ts

@@ -1,11 +1,19 @@
-import { AztecAddress, Contract, Fr, PrivateKey, Wallet, createAccounts, createAztecRpcClient } from '@aztec/aztec.js';
+import {
+  AztecAddress,
+  Contract,
+  Fr,
+  GrumpkinScalar,
+  Wallet,
+  createAccounts,
+  createAztecRpcClient,
+} from '@aztec/aztec.js';
 import { createDebugLogger } from '@aztec/foundation/log';
 import { SchnorrSingleKeyAccountContractAbi } from '@aztec/noir-contracts/artifacts';
 import { PrivateTokenContract } from '@aztec/noir-contracts/types';
 
 const logger = createDebugLogger('aztec:http-rpc-client');
 
-export const privateKey = PrivateKey.fromString('ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80');
+export const privateKey = GrumpkinScalar.fromString('ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80');
 
 const url = 'http://localhost:8080';