feat: Add funding account to key store schema (#16785)

This PR updates the keystore schema to include funding accounts as per
the updated design doc
AztecProtocol/engineering-designs#81.

The functionality of automatically funding publisher accounts is still
outstanding.

Author: PhilWindle

yarn-project/node-keystore/examples/everything.json

@@ -59,7 +59,8 @@
         "accountCount": 2,
         "addressCount": 1
       },
-      "feeRecipient": "0xabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcd"
+      "feeRecipient": "0xabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcd",
+      "fundingAccount": "0xbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"
     }
   ],
   "prover": {
@@ -81,5 +82,6 @@
         "password": "prover-pass"
       }
     ]
-  }
+  },
+  "fundingAccount": "0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
 }

…ore/examples/prover-with-publishers.json …with-publishers-and-funding-account.jsonyarn-project/node-keystore/examples/prover-with-publishers.json renamed to yarn-project/node-keystore/examples/prover-with-publishers-and-funding-account.json yarn-project/node-keystore/examples/prover-with-publishers.json renamed to yarn-project/node-keystore/examples/prover-with-publishers-and-funding-account.json

@@ -6,5 +6,6 @@
       "0x1234567890123456789012345678901234567890123456789012345678901234",
       "0x1234567890123456789012345678901234567890123456789012345678901234"
     ]
-  }
+  },
+  "fundingAccount": "0xdddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd"
 }

yarn-project/node-keystore/src/schemas.test.ts

@@ -47,14 +47,15 @@ describe('Keystore Schema Validation', () => {
   });
 
   it('should validate prover with publishers example', () => {
-    const keystore = loadExample('prover-with-publishers.json');
+    const keystore = loadExample('prover-with-publishers-and-funding-account.json');
     expect(() => keystoreSchema.parse(keystore)).not.toThrow();
 
     const parsed = keystoreSchema.parse(keystore);
     expect(parsed.schemaVersion).toBe(1);
     expect(typeof parsed.prover).toBe('object');
     expect((parsed.prover as any).id).toBe('0x1234567890123456789012345678901234567890');
     expect((parsed.prover as any).publisher).toHaveLength(2);
+    expect(parsed.fundingAccount).toBe('0xdddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd');
   });
 
   it('should validate prover with single publisher example', () => {

yarn-project/node-keystore/src/schemas.ts

@@ -77,6 +77,7 @@ const validatorKeyStoreSchema = z.object({
   publisher: ethAccountsSchema.nullish(),
   feeRecipient: aztecAddressSchema,
   remoteSigner: remoteSignerConfigSchema.nullish(),
+  fundingAccount: ethAccountSchema.nullish(),
 });
 
 // Main keystore schema
@@ -87,6 +88,7 @@ export const keystoreSchema = z
     slasher: ethAccountsSchema.nullish(),
     remoteSigner: remoteSignerConfigSchema.nullish(),
     prover: proverKeyStoreSchema.nullish(),
+    fundingAccount: ethAccountSchema.nullish(),
   })
   .refine(data => data.validators || data.prover, {
     message: 'Keystore must have at least validators or prover configuration',

yarn-project/node-keystore/src/types.ts

@@ -96,6 +96,10 @@ export type ValidatorKeyStore = {
    * Default remote signer for all accounts in this block.
    */
   remoteSigner?: EthRemoteSignerConfig;
+  /**
+   * Used for automatically funding publisher accounts in this block.
+   */
+  fundingAccount?: EthAccount;
 };
 
 export type KeyStore = {
@@ -109,4 +113,6 @@ export type KeyStore = {
   remoteSigner?: EthRemoteSignerConfig;
   /** Prover configuration. Only one prover configuration is allowed. */
   prover?: ProverKeyStore;
+  /** Used for automatically funding publisher accounts if there is none defined in the corresponding  ValidatorKeyStore*/
+  fundingAccount?: EthAccount;
 };

yarn-project/node-keystore/src/validation.test.ts

@@ -166,7 +166,7 @@ describe('Keystore Duplication Validation', () => {
       'simple-validator.json',
       'multiple-validators-remote.json',
       'simple-prover.json',
-      'prover-with-publishers.json',
+      'prover-with-publishers-and-funding-account.json',
       'everything.json',
     ];
 
@@ -191,6 +191,10 @@ describe('Keystore Duplication Validation', () => {
     // File-level remote signer
     expect(ks.remoteSigner).toBeDefined();
 
+    // File-level funding account
+    expect(ks.fundingAccount).toBeDefined();
+    expect(ks.fundingAccount).toBe('0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa');
+
     // Slasher: array with mixed account types (private key, address, remote signer account, mnemonic)
     expect(ks.slasher).toBeDefined();
     expect(Array.isArray(ks.slasher)).toBe(true);
@@ -214,6 +218,8 @@ describe('Keystore Duplication Validation', () => {
     expect(Array.isArray(v1.attester)).toBe(true);
     expect(v1.publisher).toBeDefined(); // mnemonic config
     expect(v1.feeRecipient).toMatch(/^0x[0-9a-fA-F]{64}$/);
+    expect(v1.fundingAccount).toBeDefined();
+    expect(v1.fundingAccount).toBe('0xbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb');
 
     // Prover complex type
     expect(ks.prover).toBeDefined();