@aztec/accounts 0.0.1-commit.d3ec352c → 0.0.1-commit.d58ff9d0

package/src/schnorr/private_immutable/index.ts

@@ -0,0 +1,50 @@
+/**
+ * The `@aztec/accounts/schnorr` export provides an account contract implementation that uses Schnorr signatures with a Grumpkin key for authentication, and a separate Grumpkin key for encryption.
+ * This is the suggested account contract type for most use cases within Aztec.
+ *
+ * @packageDocumentation
+ */
+import { getAccountContractAddress } from '@aztec/aztec.js/account';
+import type { AztecAddress } from '@aztec/aztec.js/addresses';
+import { Fr } from '@aztec/foundation/curves/bn254';
+import { GrumpkinScalar } from '@aztec/foundation/curves/grumpkin';
+import type { ContractArtifact } from '@aztec/stdlib/abi';
+import { loadContractArtifact } from '@aztec/stdlib/abi';
+import type { NoirCompiledContract } from '@aztec/stdlib/noir';
+
+import SchnorrAccountContractJson from '../../../artifacts/SchnorrAccount.json' with { type: 'json' };
+import { deriveSecretKeyFromSigningKey } from '../../utils/key_derivation.js';
+import { SchnorrBaseAccountContract } from '../account_contract.js';
+
+export const SchnorrAccountContractArtifact = loadContractArtifact(SchnorrAccountContractJson as NoirCompiledContract);
+
+/**
+ * Account contract that authenticates transactions using Schnorr signatures
+ * verified against a Grumpkin public key stored in an immutable encrypted note.
+ * Eagerly loads the contract artifact
+ */
+export class SchnorrAccountContract extends SchnorrBaseAccountContract {
+  constructor(signingPrivateKey: GrumpkinScalar) {
+    super(signingPrivateKey);
+  }
+
+  override getContractArtifact(): Promise<ContractArtifact> {
+    return Promise.resolve(SchnorrAccountContractArtifact);
+  }
+}
+
+/**
+ * Compute the address of a schnorr account contract.
+ * @param signingPrivateKey - The account's signing private key.
+ * @param salt - The contract address salt.
+ * @param secretKey - Seed for the account's privacy keys. Derived from the signing key when omitted.
+ */
+export async function getSchnorrAccountContractAddress(
+  signingPrivateKey: GrumpkinScalar,
+  salt: Fr,
+  secretKey?: Fr,
+): Promise<AztecAddress> {
+  const resolvedSecretKey = secretKey ?? (await deriveSecretKeyFromSigningKey(signingPrivateKey));
+  const accountContract = new SchnorrAccountContract(signingPrivateKey);
+  return await getAccountContractAddress(accountContract, resolvedSecretKey, salt);
+}

package/src/schnorr/private_immutable/lazy.ts

@@ -0,0 +1,60 @@
+/**
+ * The `@aztec/accounts/schnorr` export provides an account contract implementation that uses Schnorr signatures with a Grumpkin key for authentication, and a separate Grumpkin key for encryption.
+ * This is the suggested account contract type for most use cases within Aztec.
+ *
+ * @packageDocumentation
+ */
+import { getAccountContractAddress } from '@aztec/aztec.js/account';
+import { Fr } from '@aztec/foundation/curves/bn254';
+import { GrumpkinScalar } from '@aztec/foundation/curves/grumpkin';
+import type { ContractArtifact } from '@aztec/stdlib/abi';
+import { loadContractArtifact } from '@aztec/stdlib/abi';
+import type { AztecAddress } from '@aztec/stdlib/aztec-address';
+
+import { deriveSecretKeyFromSigningKey } from '../../utils/key_derivation.js';
+import { SchnorrBaseAccountContract } from '../account_contract.js';
+
+/**
+ * Lazily loads the contract artifact
+ * @returns The contract artifact for the schnorr account contract
+ */
+export async function getSchnorrAccountContractArtifact() {
+  // Cannot assert this import as it's incompatible with bundlers like vite
+  // https://github.com/vitejs/vite/issues/19095#issuecomment-2566074352
+  // Even if now supported by all major browsers, the MIME type is replaced with
+  // "text/javascript"
+  // In the meantime, this lazy import is INCOMPATIBLE WITH NODEJS
+  const { default: schnorrAccountContractJson } = await import('../../../artifacts/SchnorrAccount.json');
+  return loadContractArtifact(schnorrAccountContractJson);
+}
+
+/**
+ * Account contract that authenticates transactions using Schnorr signatures
+ * verified against a Grumpkin public key stored in an immutable encrypted note.
+ * Lazily loads the contract artifact
+ */
+export class SchnorrAccountContract extends SchnorrBaseAccountContract {
+  constructor(signingPrivateKey: GrumpkinScalar) {
+    super(signingPrivateKey);
+  }
+
+  override getContractArtifact(): Promise<ContractArtifact> {
+    return getSchnorrAccountContractArtifact();
+  }
+}
+
+/**
+ * Compute the address of a schnorr account contract.
+ * @param signingPrivateKey - The account's signing private key.
+ * @param salt - The contract address salt.
+ * @param secretKey - Seed for the account's privacy keys. Derived from the signing key when omitted.
+ */
+export async function getSchnorrAccountContractAddress(
+  signingPrivateKey: GrumpkinScalar,
+  salt: Fr,
+  secretKey?: Fr,
+): Promise<AztecAddress> {
+  const resolvedSecretKey = secretKey ?? (await deriveSecretKeyFromSigningKey(signingPrivateKey));
+  const accountContract = new SchnorrAccountContract(signingPrivateKey);
+  return await getAccountContractAddress(accountContract, resolvedSecretKey, salt);
+}

package/src/schnorr/stub/index.ts

@@ -0,0 +1,30 @@
+import { BaseAccount } from '@aztec/aztec.js/account';
+import type { CompleteAddress } from '@aztec/aztec.js/addresses';
+import { DefaultAccountEntrypoint } from '@aztec/entrypoints/account';
+import { loadContractArtifact } from '@aztec/stdlib/abi';
+import type { NoirCompiledContract } from '@aztec/stdlib/noir';
+
+import SimulatedSchnorrAccountJson from '../../../artifacts/SimulatedSchnorrAccount.json' with { type: 'json' };
+import { StubBaseAccountContract } from '../../defaults/stub_account_contract.js';
+
+export const StubSchnorrAccountContractArtifact = loadContractArtifact(
+  SimulatedSchnorrAccountJson as NoirCompiledContract,
+);
+
+/** Stub account contract for Schnorr accounts. Eagerly loads the contract artifact. */
+export class StubSchnorrAccountContract extends StubBaseAccountContract {
+  override getContractArtifact() {
+    return Promise.resolve(StubSchnorrAccountContractArtifact);
+  }
+}
+
+/** Creates a Schnorr stub account that impersonates the one with the provided address. */
+export function createStubSchnorrAccount(originalAddress: CompleteAddress) {
+  const accountContract = new StubSchnorrAccountContract();
+  const authWitnessProvider = accountContract.getAuthWitnessProvider(originalAddress);
+  return new BaseAccount(
+    new DefaultAccountEntrypoint(originalAddress.address, authWitnessProvider),
+    authWitnessProvider,
+    originalAddress,
+  );
+}

package/src/schnorr/stub/lazy.ts

@@ -0,0 +1,34 @@
+import { BaseAccount } from '@aztec/aztec.js/account';
+import type { CompleteAddress } from '@aztec/aztec.js/addresses';
+import { DefaultAccountEntrypoint } from '@aztec/entrypoints/account';
+import { loadContractArtifact } from '@aztec/stdlib/abi';
+
+import { StubBaseAccountContract } from '../../defaults/stub_account_contract.js';
+
+/**
+ * Lazily loads the Schnorr stub contract artifact (browser-compatible).
+ */
+export async function getStubSchnorrAccountContractArtifact() {
+  // Cannot assert this import as it's incompatible with bundlers like vite
+  // https://github.com/vitejs/vite/issues/19095#issuecomment-2566074352
+  const { default: json } = await import('../../../artifacts/SimulatedSchnorrAccount.json');
+  return loadContractArtifact(json);
+}
+
+/** Stub account contract for Schnorr accounts. Lazily loads the contract artifact. */
+export class StubSchnorrAccountContract extends StubBaseAccountContract {
+  override getContractArtifact() {
+    return getStubSchnorrAccountContractArtifact();
+  }
+}
+
+/** Creates a Schnorr stub account that impersonates the one with the provided address. */
+export function createStubSchnorrAccount(originalAddress: CompleteAddress) {
+  const accountContract = new StubSchnorrAccountContract();
+  const authWitnessProvider = accountContract.getAuthWitnessProvider(originalAddress);
+  return new BaseAccount(
+    new DefaultAccountEntrypoint(originalAddress.address, authWitnessProvider),
+    authWitnessProvider,
+    originalAddress,
+  );
+}

package/src/testing/configuration.ts

@@ -1,4 +1,5 @@
-import { Fr, GrumpkinScalar } from '@aztec/foundation/fields';
+import { Fr } from '@aztec/foundation/curves/bn254';
+import { GrumpkinScalar } from '@aztec/foundation/curves/grumpkin';
 import type { AztecAddress } from '@aztec/stdlib/aztec-address';
 import { deriveMasterIncomingViewingSecretKey } from '@aztec/stdlib/keys';
 
@@ -11,11 +12,20 @@ export const INITIAL_TEST_SECRET_KEYS = [
 export const INITIAL_TEST_ENCRYPTION_KEYS = INITIAL_TEST_SECRET_KEYS.map(secretKey =>
   deriveMasterIncomingViewingSecretKey(secretKey),
 );
-// TODO(#5837): come up with a standard signing key derivation scheme instead of using ivsk_m as signing keys here
-export const INITIAL_TEST_SIGNING_KEYS = INITIAL_TEST_ENCRYPTION_KEYS;
+
+export const INITIAL_TEST_SIGNING_KEYS = [
+  GrumpkinScalar.fromHexString('0102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f'),
+  GrumpkinScalar.fromHexString('202122232425262728292a2b2c2d2e2f303132333435363738393a3b3c3d3e'),
+  GrumpkinScalar.fromHexString('404142434445464748494a4b4c4d4e4f505152535455565758595a5b5c5d5e'),
+];
 
 export const INITIAL_TEST_ACCOUNT_SALTS = [Fr.ZERO, Fr.ZERO, Fr.ZERO];
 
+/**
+ * The schnorr account contract variant a test account uses.
+ */
+export type InitialAccountType = 'schnorr' | 'schnorr_initializerless';
+
 /**
  * Data for generating an initial account.
  */
@@ -36,4 +46,8 @@ export interface InitialAccountData {
    * Address of the schnorr account contract.
    */
   address: AztecAddress;
+  /**
+   * Account contract variant.
+   */
+  type?: InitialAccountType;
 }

package/src/testing/index.ts

@@ -4,15 +4,17 @@
  * @packageDocumentation
  */
 import { Fr } from '@aztec/aztec.js/fields';
-import { deriveSigningKey } from '@aztec/stdlib/keys';
+import { GrumpkinScalar } from '@aztec/foundation/curves/grumpkin';
 
-import { getSchnorrAccountContractAddress } from '../schnorr/index.js';
+import { getSchnorrInitializerlessAccountContractAddress } from '../schnorr/initializerless/index.js';
+import { getSchnorrAccountContractAddress } from '../schnorr/private_immutable/index.js';
+import { deriveSecretKeyFromSigningKey } from '../utils/key_derivation.js';
 import {
   INITIAL_TEST_ACCOUNT_SALTS,
-  INITIAL_TEST_ENCRYPTION_KEYS,
   INITIAL_TEST_SECRET_KEYS,
   INITIAL_TEST_SIGNING_KEYS,
   type InitialAccountData,
+  type InitialAccountType,
 } from './configuration.js';
 
 export {
@@ -21,8 +23,16 @@ export {
   INITIAL_TEST_SECRET_KEYS,
   INITIAL_TEST_SIGNING_KEYS,
   type InitialAccountData,
+  type InitialAccountType,
 } from './configuration.js';
 
+/** Derives the account contract address for the given type */
+function getTestAccountAddress(type: InitialAccountType, signingKey: GrumpkinScalar, salt: Fr, secret?: Fr) {
+  return type === 'schnorr'
+    ? getSchnorrAccountContractAddress(signingKey, salt, secret)
+    : getSchnorrInitializerlessAccountContractAddress(signingKey, salt, secret);
+}
+
 /**
  * Gets the basic information for initial test accounts.
  */
@@ -30,30 +40,36 @@ export function getInitialTestAccountsData(): Promise<InitialAccountData[]> {
   return Promise.all(
     INITIAL_TEST_SECRET_KEYS.map(async (secret, i) => ({
       secret,
-      signingKey: INITIAL_TEST_ENCRYPTION_KEYS[i],
+      signingKey: INITIAL_TEST_SIGNING_KEYS[i],
       salt: INITIAL_TEST_ACCOUNT_SALTS[i],
-      address: await getSchnorrAccountContractAddress(
-        secret,
-        INITIAL_TEST_ACCOUNT_SALTS[i],
+      type: 'schnorr_initializerless' as const,
+      address: await getSchnorrInitializerlessAccountContractAddress(
         INITIAL_TEST_SIGNING_KEYS[i],
+        INITIAL_TEST_ACCOUNT_SALTS[i],
+        secret,
       ),
     })),
   );
 }
 
 /**
- * Generate a fixed amount of random schnorr account contract instance.
+ * Generate a fixed amount of random schnorr account contract instances of the given type
  */
-export async function generateSchnorrAccounts(numberOfAccounts: number): Promise<Promise<InitialAccountData[]>> {
-  const secrets = Array.from({ length: numberOfAccounts }, () => Fr.random());
+export async function generateSchnorrAccounts(
+  numberOfAccounts: number,
+  type: InitialAccountType = 'schnorr_initializerless',
+): Promise<InitialAccountData[]> {
+  const signingKeys = Array.from({ length: numberOfAccounts }, () => GrumpkinScalar.random());
   return await Promise.all(
-    secrets.map(async secret => {
+    signingKeys.map(async signingKey => {
       const salt = Fr.random();
+      const secret = await deriveSecretKeyFromSigningKey(signingKey);
       return {
         secret,
-        signingKey: deriveSigningKey(secret),
+        signingKey,
         salt,
-        address: await getSchnorrAccountContractAddress(secret, salt),
+        type,
+        address: await getTestAccountAddress(type, signingKey, salt, secret),
       };
     }),
   );

package/src/testing/lazy.ts

@@ -4,19 +4,28 @@
  * @packageDocumentation
  */
 import { Fr } from '@aztec/aztec.js/fields';
-import { deriveSigningKey } from '@aztec/stdlib/keys';
+import { GrumpkinScalar } from '@aztec/foundation/curves/grumpkin';
 
-import { getSchnorrAccountContractAddress } from '../schnorr/lazy.js';
+import { getSchnorrInitializerlessAccountContractAddress } from '../schnorr/initializerless/lazy.js';
+import { getSchnorrAccountContractAddress } from '../schnorr/private_immutable/lazy.js';
+import { deriveSecretKeyFromSigningKey } from '../utils/key_derivation.js';
 import {
   INITIAL_TEST_ACCOUNT_SALTS,
-  INITIAL_TEST_ENCRYPTION_KEYS,
   INITIAL_TEST_SECRET_KEYS,
   INITIAL_TEST_SIGNING_KEYS,
   type InitialAccountData,
+  type InitialAccountType,
 } from './configuration.js';
 
 export { INITIAL_TEST_ACCOUNT_SALTS, INITIAL_TEST_SECRET_KEYS } from './configuration.js';
 
+/** Derives the account contract address for the given type */
+function getTestAccountAddress(type: InitialAccountType, signingKey: GrumpkinScalar, salt: Fr, secret?: Fr) {
+  return type === 'schnorr'
+    ? getSchnorrAccountContractAddress(signingKey, salt, secret)
+    : getSchnorrInitializerlessAccountContractAddress(signingKey, salt, secret);
+}
+
 /**
  * Gets the basic information for initial test accounts.
  */
@@ -24,30 +33,36 @@ export function getInitialTestAccountsData(): Promise<InitialAccountData[]> {
   return Promise.all(
     INITIAL_TEST_SECRET_KEYS.map(async (secret, i) => ({
       secret,
-      signingKey: INITIAL_TEST_ENCRYPTION_KEYS[i],
+      signingKey: INITIAL_TEST_SIGNING_KEYS[i],
       salt: INITIAL_TEST_ACCOUNT_SALTS[i],
-      address: await getSchnorrAccountContractAddress(
-        secret,
-        INITIAL_TEST_ACCOUNT_SALTS[i],
+      type: 'schnorr_initializerless' as const,
+      address: await getSchnorrInitializerlessAccountContractAddress(
         INITIAL_TEST_SIGNING_KEYS[i],
+        INITIAL_TEST_ACCOUNT_SALTS[i],
+        secret,
       ),
     })),
   );
 }
 
 /**
- * Generate a fixed amount of random schnorr account contract instance.
+ * Generate a fixed amount of random schnorr account contract instances of the given type
  */
-export async function generateSchnorrAccounts(numberOfAccounts: number): Promise<InitialAccountData[]> {
-  const secrets = Array.from({ length: numberOfAccounts }, () => Fr.random());
+export async function generateSchnorrAccounts(
+  numberOfAccounts: number,
+  type: InitialAccountType = 'schnorr_initializerless',
+): Promise<InitialAccountData[]> {
+  const signingKeys = Array.from({ length: numberOfAccounts }, () => GrumpkinScalar.random());
   return await Promise.all(
-    secrets.map(async secret => {
+    signingKeys.map(async signingKey => {
       const salt = Fr.random();
+      const secret = await deriveSecretKeyFromSigningKey(signingKey);
       return {
         secret,
-        signingKey: deriveSigningKey(secret),
+        signingKey,
         salt,
-        address: await getSchnorrAccountContractAddress(secret, salt),
+        type,
+        address: await getTestAccountAddress(type, signingKey, salt, secret),
       };
     }),
   );

package/src/utils/index.ts

@@ -1 +1,2 @@
+export * from './key_derivation.js';
 export * from './ssh_agent.js';

package/src/utils/key_derivation.ts

@@ -0,0 +1,15 @@
+import { poseidon2Hash } from '@aztec/foundation/crypto/poseidon';
+import { sha256ToField } from '@aztec/foundation/crypto/sha256';
+import type { Fr } from '@aztec/foundation/curves/bn254';
+import type { GrumpkinScalar } from '@aztec/foundation/curves/grumpkin';
+
+const SIGNING_KEY_TO_SECRET_KEY_SEPARATOR = sha256ToField([Buffer.from('@aztec/accounts/signing_key_to_secret_key')]);
+
+/**
+ * Derives the privacy secret key (the seed for the viewing/nullifier keyset that PXE holds) from the account's signing
+ * key. The signing key is the ownership root the user controls; the privacy keyset hangs off it through this one-way
+ * hash, so a value handled by PXE can never be used to recover the signing key.
+ */
+export function deriveSecretKeyFromSigningKey(signingKey: GrumpkinScalar): Promise<Fr> {
+  return poseidon2Hash([SIGNING_KEY_TO_SECRET_KEY_SEPARATOR, signingKey.hi, signingKey.lo]);
+}

package/src/utils/ssh_agent.ts

@@ -41,6 +41,7 @@ type StoredKey = {
 export function getIdentities(): Promise<StoredKey[]> {
   return new Promise((resolve, reject) => {
     const stream = connectToAgent();
+    stream.on('error', reject);
     stream.on('connect', () => {
       const request = Buffer.concat([
         Buffer.from([0, 0, 0, 5 + 4]), // length
@@ -96,6 +97,7 @@ export function getIdentities(): Promise<StoredKey[]> {
 export function signWithAgent(keyType: Buffer, curveName: Buffer, publicKey: Buffer, data: Buffer) {
   return new Promise<Buffer>((resolve, reject) => {
     const stream = connectToAgent();
+    stream.on('error', reject);
     stream.on('connect', () => {
       // Construct the key blob
       const keyBlob = Buffer.concat([