@aztec/accounts 0.0.1-commit.b655e406 → 0.0.1-commit.b8a057fa

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 { deriveSigningKey } from '@aztec/stdlib/keys';
+import type { NoirCompiledContract } from '@aztec/stdlib/noir';
+
+import SchnorrAccountContractJson from '../../../artifacts/SchnorrAccount.json' with { type: 'json' };
+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 secret - A seed for deriving the signing key and public keys.
+ * @param salt - The contract address salt.
+ * @param signingPrivateKey - A specific signing private key that's not derived from the secret.
+ */
+export async function getSchnorrAccountContractAddress(
+  secret: Fr,
+  salt: Fr,
+  signingPrivateKey?: GrumpkinScalar,
+): Promise<AztecAddress> {
+  const signingKey = signingPrivateKey ?? deriveSigningKey(secret);
+  const accountContract = new SchnorrAccountContract(signingKey);
+  return await getAccountContractAddress(accountContract, secret, 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 { deriveSigningKey } from '@aztec/stdlib/keys';
+
+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 secret - A seed for deriving the signing key and public keys.
+ * @param salt - The contract address salt.
+ * @param signingPrivateKey - A specific signing private key that's not derived from the secret.
+ */
+export async function getSchnorrAccountContractAddress(
+  secret: Fr,
+  salt: Fr,
+  signingPrivateKey?: GrumpkinScalar,
+): Promise<AztecAddress> {
+  const signingKey = signingPrivateKey ?? deriveSigningKey(secret);
+  const accountContract = new SchnorrAccountContract(signingKey);
+  return await getAccountContractAddress(accountContract, secret, 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';
 
@@ -16,6 +17,11 @@ export const INITIAL_TEST_SIGNING_KEYS = INITIAL_TEST_ENCRYPTION_KEYS;
 
 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 +42,8 @@ export interface InitialAccountData {
    * Address of the schnorr account contract.
    */
   address: AztecAddress;
+  /**
+   * Account contract variant.
+   */
+  type?: InitialAccountType;
 }

package/src/testing/index.ts

@@ -1,18 +1,21 @@
 /**
- * The `@aztec/accounts/testing` export provides utility methods for testing, in particular in a Sandbox environment.
+ * The `@aztec/accounts/testing` export provides utility methods for testing, in particular in a local network environment.
  *
  * @packageDocumentation
  */
 import { Fr } from '@aztec/aztec.js/fields';
+import type { GrumpkinScalar } from '@aztec/foundation/curves/grumpkin';
 import { deriveSigningKey } from '@aztec/stdlib/keys';
 
-import { getSchnorrAccountContractAddress } from '../schnorr/index.js';
+import { getSchnorrInitializerlessAccountContractAddress } from '../schnorr/initializerless/index.js';
+import { getSchnorrAccountContractAddress } from '../schnorr/private_immutable/index.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 +24,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, secret: Fr, salt: Fr, signingKey?: GrumpkinScalar) {
+  return type === 'schnorr'
+    ? getSchnorrAccountContractAddress(secret, salt, signingKey)
+    : getSchnorrInitializerlessAccountContractAddress(secret, salt, signingKey);
+}
+
 /**
  * Gets the basic information for initial test accounts.
  */
@@ -32,7 +43,8 @@ export function getInitialTestAccountsData(): Promise<InitialAccountData[]> {
       secret,
       signingKey: INITIAL_TEST_ENCRYPTION_KEYS[i],
       salt: INITIAL_TEST_ACCOUNT_SALTS[i],
-      address: await getSchnorrAccountContractAddress(
+      type: 'schnorr_initializerless' as const,
+      address: await getSchnorrInitializerlessAccountContractAddress(
         secret,
         INITIAL_TEST_ACCOUNT_SALTS[i],
         INITIAL_TEST_SIGNING_KEYS[i],
@@ -42,9 +54,12 @@ export function getInitialTestAccountsData(): Promise<InitialAccountData[]> {
 }
 
 /**
- * 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[]>> {
+export async function generateSchnorrAccounts(
+  numberOfAccounts: number,
+  type: InitialAccountType = 'schnorr_initializerless',
+): Promise<InitialAccountData[]> {
   const secrets = Array.from({ length: numberOfAccounts }, () => Fr.random());
   return await Promise.all(
     secrets.map(async secret => {
@@ -53,7 +68,8 @@ export async function generateSchnorrAccounts(numberOfAccounts: number): Promise
         secret,
         signingKey: deriveSigningKey(secret),
         salt,
-        address: await getSchnorrAccountContractAddress(secret, salt),
+        type,
+        address: await getTestAccountAddress(type, secret, salt),
       };
     }),
   );

package/src/testing/lazy.ts

@@ -1,22 +1,32 @@
 /**
- * The `@aztec/accounts/testing/lazy` export provides utility methods for testing, in particular in a Sandbox environment.
+ * The `@aztec/accounts/testing/lazy` export provides utility methods for testing, in particular in a local network environment.
  *
  * @packageDocumentation
  */
 import { Fr } from '@aztec/aztec.js/fields';
+import type { GrumpkinScalar } from '@aztec/foundation/curves/grumpkin';
 import { deriveSigningKey } from '@aztec/stdlib/keys';
 
-import { getSchnorrAccountContractAddress } from '../schnorr/lazy.js';
+import { getSchnorrInitializerlessAccountContractAddress } from '../schnorr/initializerless/lazy.js';
+import { getSchnorrAccountContractAddress } from '../schnorr/private_immutable/lazy.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, secret: Fr, salt: Fr, signingKey?: GrumpkinScalar) {
+  return type === 'schnorr'
+    ? getSchnorrAccountContractAddress(secret, salt, signingKey)
+    : getSchnorrInitializerlessAccountContractAddress(secret, salt, signingKey);
+}
+
 /**
  * Gets the basic information for initial test accounts.
  */
@@ -26,7 +36,8 @@ export function getInitialTestAccountsData(): Promise<InitialAccountData[]> {
       secret,
       signingKey: INITIAL_TEST_ENCRYPTION_KEYS[i],
       salt: INITIAL_TEST_ACCOUNT_SALTS[i],
-      address: await getSchnorrAccountContractAddress(
+      type: 'schnorr_initializerless' as const,
+      address: await getSchnorrInitializerlessAccountContractAddress(
         secret,
         INITIAL_TEST_ACCOUNT_SALTS[i],
         INITIAL_TEST_SIGNING_KEYS[i],
@@ -36,9 +47,12 @@ export function getInitialTestAccountsData(): Promise<InitialAccountData[]> {
 }
 
 /**
- * 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[]> {
+export async function generateSchnorrAccounts(
+  numberOfAccounts: number,
+  type: InitialAccountType = 'schnorr_initializerless',
+): Promise<InitialAccountData[]> {
   const secrets = Array.from({ length: numberOfAccounts }, () => Fr.random());
   return await Promise.all(
     secrets.map(async secret => {
@@ -47,7 +61,8 @@ export async function generateSchnorrAccounts(numberOfAccounts: number): Promise
         secret,
         signingKey: deriveSigningKey(secret),
         salt,
-        address: await getSchnorrAccountContractAddress(secret, salt),
+        type,
+        address: await getTestAccountAddress(type, secret, salt),
       };
     }),
   );

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([