@aztec/key-store 0.77.0-testnet-ignition.28 → 0.77.0-testnet-ignition.30

package/dest/index.d.ts

@@ -0,0 +1,2 @@
+export * from './key_store.js';
+//# sourceMappingURL=index.d.ts.map

package/dest/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC"}

package/dest/key_store.d.ts

@@ -0,0 +1,98 @@
+import { Fr, GrumpkinScalar } from '@aztec/foundation/fields';
+import { type Bufferable } from '@aztec/foundation/serialize';
+import type { AztecAsyncKVStore } from '@aztec/kv-store';
+import { AztecAddress } from '@aztec/stdlib/aztec-address';
+import { CompleteAddress, type PartialAddress } from '@aztec/stdlib/contract';
+import { KeyValidationRequest } from '@aztec/stdlib/kernel';
+import { type KeyPrefix, type PublicKey } from '@aztec/stdlib/keys';
+/**
+ * Used for managing keys. Can hold keys of multiple accounts.
+ */
+export declare class KeyStore {
+    #private;
+    constructor(database: AztecAsyncKVStore);
+    /**
+     * Creates a new account from a randomly generated secret key.
+     * @returns A promise that resolves to the newly created account's CompleteAddress.
+     */
+    createAccount(): Promise<CompleteAddress>;
+    /**
+     * Adds an account to the key store from the provided secret key.
+     * @param sk - The secret key of the account.
+     * @param partialAddress - The partial address of the account.
+     * @returns The account's complete address.
+     */
+    addAccount(sk: Fr, partialAddress: PartialAddress): Promise<CompleteAddress>;
+    /**
+     * Retrieves addresses of accounts stored in the key store.
+     * @returns A Promise that resolves to an array of account addresses.
+     */
+    getAccounts(): Promise<AztecAddress[]>;
+    /**
+     * Gets the key validation request for a given master public key hash and contract address.
+     * @throws If the account corresponding to the master public key hash does not exist in the key store.
+     * @param pkMHash - The master public key hash.
+     * @param contractAddress - The contract address to silo the secret key in the key validation request with.
+     * @returns The key validation request.
+     */
+    getKeyValidationRequest(pkMHash: Fr, contractAddress: AztecAddress): Promise<KeyValidationRequest>;
+    /**
+     * Gets the master nullifier public key for a given account.
+     * @throws If the account does not exist in the key store.
+     * @param account - The account address for which to retrieve the master nullifier public key.
+     * @returns The master nullifier public key for the account.
+     */
+    getMasterNullifierPublicKey(account: AztecAddress): Promise<PublicKey>;
+    /**
+     * Gets the master incoming viewing public key for a given account.
+     * @throws If the account does not exist in the key store.
+     * @param account - The account address for which to retrieve the master incoming viewing public key.
+     * @returns The master incoming viewing public key for the account.
+     */
+    getMasterIncomingViewingPublicKey(account: AztecAddress): Promise<PublicKey>;
+    /**
+     * Retrieves the master outgoing viewing public key.
+     * @throws If the account does not exist in the key store.
+     * @param account - The account to retrieve the master outgoing viewing key for.
+     * @returns A Promise that resolves to the master outgoing viewing key.
+     */
+    getMasterOutgoingViewingPublicKey(account: AztecAddress): Promise<PublicKey>;
+    /**
+     * Retrieves the master tagging public key.
+     * @throws If the account does not exist in the key store.
+     * @param account - The account to retrieve the master tagging key for.
+     * @returns A Promise that resolves to the master tagging key.
+     */
+    getMasterTaggingPublicKey(account: AztecAddress): Promise<PublicKey>;
+    /**
+     * Retrieves master incoming viewing secret key.
+     * @throws If the account does not exist in the key store.
+     * @param account - The account to retrieve the master incoming viewing secret key for.
+     * @returns A Promise that resolves to the master incoming viewing secret key.
+     */
+    getMasterIncomingViewingSecretKey(account: AztecAddress): Promise<GrumpkinScalar>;
+    /**
+     * Retrieves application outgoing viewing secret key.
+     * @throws If the account does not exist in the key store.
+     * @param account - The account to retrieve the application outgoing viewing secret key for.
+     * @param app - The application address to retrieve the outgoing viewing secret key for.
+     * @returns A Promise that resolves to the application outgoing viewing secret key.
+     */
+    getAppOutgoingViewingSecretKey(account: AztecAddress, app: AztecAddress): Promise<Fr>;
+    /**
+     * Retrieves the sk_m corresponding to the pk_m.
+     * @throws If the provided public key is not associated with any of the registered accounts.
+     * @param pkM - The master public key to get secret key for.
+     * @returns A Promise that resolves to sk_m.
+     * @dev Used when feeding the sk_m to the kernel circuit for keys verification.
+     */
+    getMasterSecretKey(pkM: PublicKey): Promise<GrumpkinScalar>;
+    /**
+     * Gets the key prefix and account address for a given value.
+     * @returns A tuple containing the key prefix and account address.
+     * @dev Note that this is quite inefficient but it should not matter because there should never be too many keys
+     * in the key store.
+     */
+    getKeyPrefixAndAccount(value: Bufferable): Promise<[KeyPrefix, AztecAddress]>;
+}
+//# sourceMappingURL=key_store.d.ts.map

package/dest/key_store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"key_store.d.ts","sourceRoot":"","sources":["../src/key_store.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,EAAE,EAAE,cAAc,EAAS,MAAM,0BAA0B,CAAC;AAErE,OAAO,EAAE,KAAK,UAAU,EAAqB,MAAM,6BAA6B,CAAC;AACjF,OAAO,KAAK,EAAE,iBAAiB,EAAiB,MAAM,iBAAiB,CAAC;AACxE,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAAE,eAAe,EAAE,KAAK,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAC9E,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAEL,KAAK,SAAS,EACd,KAAK,SAAS,EAIf,MAAM,oBAAoB,CAAC;AAE5B;;GAEG;AACH,qBAAa,QAAQ;;gBAGP,QAAQ,EAAE,iBAAiB;IAIvC;;;OAGG;IACI,aAAa,IAAI,OAAO,CAAC,eAAe,CAAC;IAMhD;;;;;OAKG;IACU,UAAU,CAAC,EAAE,EAAE,EAAE,EAAE,cAAc,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IAsCzF;;;OAGG;IACU,WAAW,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;IAOnD;;;;;;OAMG;IACU,uBAAuB,CAAC,OAAO,EAAE,EAAE,EAAE,eAAe,EAAE,YAAY,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAuC/G;;;;;OAKG;IACU,2BAA2B,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,SAAS,CAAC;IAUnF;;;;;OAKG;IACU,iCAAiC,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,SAAS,CAAC;IAUzF;;;;;OAKG;IACU,iCAAiC,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,SAAS,CAAC;IAUzF;;;;;OAKG;IACU,yBAAyB,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,SAAS,CAAC;IAUjF;;;;;OAKG;IACU,iCAAiC,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC;IAU9F;;;;;;OAMG;IACU,8BAA8B,CAAC,OAAO,EAAE,YAAY,EAAE,GAAG,EAAE,YAAY,GAAG,OAAO,CAAC,EAAE,CAAC;IAelG;;;;;;OAMG;IACU,kBAAkB,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAAC,cAAc,CAAC;IAmBxE;;;;;OAKG;IACU,sBAAsB,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;CAe3F"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aztec/key-store",
-  "version": "0.77.0-testnet-ignition.28",
+  "version": "0.77.0-testnet-ignition.30",
   "type": "module",
   "exports": "./dest/index.js",
   "typedocOptions": {
@@ -55,10 +55,10 @@
     ]
   },
   "dependencies": {
-    "@aztec/constants": "0.77.0-testnet-ignition.28",
-    "@aztec/foundation": "0.77.0-testnet-ignition.28",
-    "@aztec/kv-store": "0.77.0-testnet-ignition.28",
-    "@aztec/stdlib": "0.77.0-testnet-ignition.28",
+    "@aztec/constants": "0.77.0-testnet-ignition.30",
+    "@aztec/foundation": "0.77.0-testnet-ignition.30",
+    "@aztec/kv-store": "0.77.0-testnet-ignition.30",
+    "@aztec/stdlib": "0.77.0-testnet-ignition.30",
     "tslib": "^2.4.0"
   },
   "devDependencies": {