@aztec/aztec.js 0.74.0 → 0.75.0

package/src/{utils → api/ethereum}/portal_manager.ts

@@ -1,14 +1,9 @@
-import {
-  type AztecAddress,
-  EthAddress,
-  Fr,
-  type Logger,
-  type PXE,
-  type SiblingPath,
-  computeSecretHash,
-} from '@aztec/aztec.js';
+import { type PXE, type SiblingPath } from '@aztec/circuit-types';
+import { type AztecAddress, EthAddress, Fr } from '@aztec/circuits.js';
+import { computeSecretHash } from '@aztec/circuits.js/hash';
 import { extractEvent } from '@aztec/ethereum/utils';
 import { sha256ToField } from '@aztec/foundation/crypto';
+import { type Logger } from '@aztec/foundation/log';
 import { FeeJuicePortalAbi, OutboxAbi, TestERC20Abi, TokenPortalAbi } from '@aztec/l1-artifacts';
 
 import {

package/src/api/log.ts

@@ -0,0 +1 @@
+export { createLogger, type Logger } from '@aztec/foundation/log';

package/src/contract/index.ts

@@ -1,7 +1,7 @@
 /**
  * The `contract` module provides utilities for deploying and interacting with contracts, based on a
  * `Wallet` instance and a compiled artifact. Refer to the {@link account} module for how to obtain a valid
- * `Wallet` instance, and to the {@link https://docs.aztec.network/developers/contracts/compiling | Compiling contracts}
+ * `Wallet` instance, and to the {@link https://docs.aztec.network/developers/guides/smart_contracts/how_to_compile_contract | Compiling contracts}
  * section of the documentation for how to generate an artifact out of your Noir source code.
  *
  * The {@link Contract} class is the main class in this module, and provides static methods for deploying
@@ -30,7 +30,7 @@
  * has synchronized its changes.
  *
  * @remarks If you are using typescript, consider using the
- * {@link https://docs.aztec.network/developers/contracts/compiling#typescript-interfaces | autogenerated type-safe interfaces}
+ * {@link https://docs.aztec.network/developers/guides/smart_contracts/how_to_compile_contract#typescript-interfaces | autogenerated type-safe interfaces}
  * for interacting with your contracts.
  *
  * @packageDocumentation

package/src/entrypoint/default_multi_call_entrypoint.ts

@@ -1,9 +1,10 @@
-import { type EntrypointInterface, EntrypointPayload, type ExecutionRequestInit } from '@aztec/aztec.js/entrypoint';
 import { HashedValues, TxExecutionRequest } from '@aztec/circuit-types';
 import { type AztecAddress, TxContext } from '@aztec/circuits.js';
 import { type FunctionAbi, FunctionSelector, encodeArguments } from '@aztec/foundation/abi';
 import { ProtocolContractAddress } from '@aztec/protocol-contracts';
 
+import { type EntrypointInterface, EntrypointPayload, type ExecutionRequestInit } from './entrypoint.js';
+
 /**
  * Implementation for an entrypoint interface that can execute multiple function calls in a single transaction
  */

package/src/fee/fee_juice_payment_method_with_claim.ts

@@ -4,7 +4,7 @@ import { FunctionType, U128 } from '@aztec/foundation/abi';
 import { ProtocolContractAddress } from '@aztec/protocol-contracts';
 import { getCanonicalFeeJuice } from '@aztec/protocol-contracts/fee-juice';
 
-import { type L2AmountClaim } from '../utils/portal_manager.js';
+import { type L2AmountClaim } from '../api/ethereum/portal_manager.js';
 import { FeeJuicePaymentMethod } from './fee_juice_payment_method.js';
 
 /**

package/src/index.ts

@@ -22,34 +22,6 @@
 
 export { ContractDeployer } from './deployment/index.js';
 
-export {
-  AnvilTestWatcher,
-  CheatCodes,
-  L1FeeJuicePortalManager,
-  L1ToL2TokenPortalManager,
-  L1TokenManager,
-  L1TokenPortalManager,
-  computeAuthWitMessageHash,
-  computeInnerAuthWitHash,
-  computeInnerAuthWitHashFromAction,
-  generateClaimSecret,
-  generatePublicKey,
-  readFieldCompressedString,
-  waitForPXE,
-  waitForNode,
-  type AztecAddressLike,
-  type EthAddressLike,
-  type EventSelectorLike,
-  type FieldLike,
-  type FunctionSelectorLike,
-  type L2AmountClaim,
-  type L2AmountClaimWithRecipient,
-  type L2Claim,
-  type U128Like,
-  type WrappedFieldLike,
-  type IntentAction,
-} from './utils/index.js';
-
 export { NoteSelector } from '@aztec/foundation/abi';
 
 export { createCompatibleClient, createPXEClient } from './rpc_clients/index.js';
@@ -120,12 +92,10 @@ export {
   TxStatus,
   UnencryptedL2Log,
   UniqueNote,
-  createAztecNodeClient,
   getTimestampRangeForEpoch,
   merkleTreeIds,
   mockEpochProofQuote,
   mockTx,
-  type AztecNode,
   type LogFilter,
   type PXE,
   type PartialAddress,
@@ -139,7 +109,6 @@ export { decodeFromAbi, encodeArguments, type AbiType } from '@aztec/foundation/
 export { toBigIntBE } from '@aztec/foundation/bigint-buffer';
 export { sha256 } from '@aztec/foundation/crypto';
 export { makeFetch } from '@aztec/foundation/json-rpc/client';
-export { createLogger, type Logger } from '@aztec/foundation/log';
 export { retry, retryUntil } from '@aztec/foundation/retry';
 export { to2Fields, toBigInt } from '@aztec/foundation/serialize';
 export { sleep } from '@aztec/foundation/sleep';
@@ -151,8 +120,11 @@ export { fileURLToPath } from '@aztec/foundation/url';
 // Here you *can* do `export *` as the granular api defacto exports things explicitly.
 // This entire index file will be deprecated at some point after we're satisfied.
 export * from './api/abi.js';
+export * from './api/cheat_codes.js';
 export * from './api/fee.js';
 export * from './api/addresses.js';
-export * from './api/ethereum.js';
+export * from './api/ethereum/index.js';
+export * from './api/log.js';
 // Granular export, even if not in the api folder
 export * from './contract/index.js';
+export * from './utils/index.js';

package/src/utils/aztec_cheatcodes.ts

@@ -0,0 +1,75 @@
+import { type Note, type PXE } from '@aztec/circuit-types';
+import { type AztecAddress, Fr } from '@aztec/circuits.js';
+import { deriveStorageSlotInMap } from '@aztec/circuits.js/hash';
+import { createLogger } from '@aztec/foundation/log';
+
+/**
+ * A class that provides utility functions for interacting with the aztec chain.
+ */
+export class AztecCheatCodes {
+  constructor(
+    /**
+     * The PXE Service to use for interacting with the chain
+     */
+    public pxe: PXE,
+    /**
+     * The logger to use for the aztec cheatcodes
+     */
+    public logger = createLogger('aztecjs:cheat_codes'),
+  ) {}
+
+  /**
+   * Computes the slot value for a given map and key.
+   * @param mapSlot - The slot of the map (specified in Aztec.nr contract)
+   * @param key - The key to lookup in the map
+   * @returns The storage slot of the value in the map
+   */
+  public computeSlotInMap(mapSlot: Fr | bigint, key: Fr | bigint | AztecAddress): Promise<Fr> {
+    const keyFr = typeof key === 'bigint' ? new Fr(key) : key.toField();
+    return deriveStorageSlotInMap(mapSlot, keyFr);
+  }
+
+  /**
+   * Get the current blocknumber
+   * @returns The current block number
+   */
+  public async blockNumber(): Promise<number> {
+    return await this.pxe.getBlockNumber();
+  }
+
+  /**
+   * Get the current timestamp
+   * @returns The current timestamp
+   */
+  public async timestamp(): Promise<number> {
+    const res = await this.pxe.getBlock(await this.blockNumber());
+    return res?.header.globalVariables.timestamp.toNumber() ?? 0;
+  }
+
+  /**
+   * Loads the value stored at the given slot in the public storage of the given contract.
+   * @param who - The address of the contract
+   * @param slot - The storage slot to lookup
+   * @returns The value stored at the given slot
+   */
+  public async loadPublic(who: AztecAddress, slot: Fr | bigint): Promise<Fr> {
+    const storageValue = await this.pxe.getPublicStorageAt(who, new Fr(slot));
+    return storageValue;
+  }
+
+  /**
+   * Loads the value stored at the given slot in the private storage of the given contract.
+   * @param contract - The address of the contract
+   * @param owner - The owner for whom the notes are encrypted
+   * @param slot - The storage slot to lookup
+   * @returns The notes stored at the given slot
+   */
+  public async loadPrivate(owner: AztecAddress, contract: AztecAddress, slot: Fr | bigint): Promise<Note[]> {
+    const extendedNotes = await this.pxe.getNotes({
+      owner,
+      contractAddress: contract,
+      storageSlot: new Fr(slot),
+    });
+    return extendedNotes.map(extendedNote => extendedNote.note);
+  }
+}

package/src/utils/index.ts

@@ -1,11 +1,19 @@
-export * from './pub_key.js';
-export * from './l1_contracts.js';
-export * from './abi_types.js';
-export * from './cheat_codes.js';
-export * from './authwit.js';
-export * from './pxe.js';
-export * from './node.js';
-export * from './anvil_test_watcher.js';
-export * from './field_compressed_string.js';
-export * from './portal_manager.js';
-export * from './chain_monitor.js';
+export { generatePublicKey } from './pub_key.js';
+export {
+  type AztecAddressLike,
+  type EthAddressLike,
+  type EventSelectorLike,
+  type FieldLike,
+  type FunctionSelectorLike,
+  type U128Like,
+  type WrappedFieldLike,
+} from './abi_types.js';
+export {
+  computeAuthWitMessageHash,
+  computeInnerAuthWitHash,
+  computeInnerAuthWitHashFromAction,
+  type IntentAction,
+} from './authwit.js';
+export { waitForPXE } from './pxe.js';
+export { waitForNode, createAztecNodeClient, AztecNode } from './node.js';
+export { readFieldCompressedString } from './field_compressed_string.js';

package/src/utils/node.ts

@@ -15,3 +15,5 @@ export const waitForNode = async (node: AztecNode, logger?: Logger) => {
     return undefined;
   }, 'RPC Get Node Info');
 };
+
+export { createAztecNodeClient, AztecNode } from '@aztec/circuit-types';

package/src/wallet/index.ts

@@ -1,4 +1,4 @@
-import { type PXE } from '@aztec/circuit-types';
+import { type PXE } from '@aztec/circuit-types/interfaces';
 import { type AztecAddress } from '@aztec/foundation/aztec-address';
 
 import { type AccountContract } from '../account/contract.js';

package/dest/api/ethereum.d.ts

@@ -1,3 +0,0 @@
-export { deployL1Contract, deployL1Contracts, DeployL1Contracts } from '@aztec/ethereum/deploy-l1-contracts';
-export { EthCheatCodes } from '@aztec/ethereum/eth-cheatcodes';
-//# sourceMappingURL=ethereum.d.ts.map

package/dest/api/ethereum.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ethereum.d.ts","sourceRoot":"","sources":["../../src/api/ethereum.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAC;AAC7G,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC"}

package/dest/api/ethereum.js

@@ -1,3 +0,0 @@
-export { deployL1Contract, deployL1Contracts } from '@aztec/ethereum/deploy-l1-contracts';
-export { EthCheatCodes } from '@aztec/ethereum/eth-cheatcodes';
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZXRoZXJldW0uanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvYXBpL2V0aGVyZXVtLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxnQkFBZ0IsRUFBRSxpQkFBaUIsRUFBcUIsTUFBTSxxQ0FBcUMsQ0FBQztBQUM3RyxPQUFPLEVBQUUsYUFBYSxFQUFFLE1BQU0sZ0NBQWdDLENBQUMifQ==