@aztec/aztec.js 0.8.9 → 0.8.11

package/src/contract/index.ts

@@ -10,12 +10,12 @@
  * or can be queried via `view()`.
  *
  * ```ts
- * const contract = await Contract.deploy(wallet, MyContractAbi, [...constructorArgs]).send().deployed();
+ * const contract = await Contract.deploy(wallet, MyContractArtifact, [...constructorArgs]).send().deployed();
  * console.log(`Contract deployed at ${contract.address}`);
  * ```
  *
  * ```ts
- * const contract = await Contract.at(address, MyContractAbi, wallet);
+ * const contract = await Contract.at(address, MyContractArtifact, wallet);
  * await contract.methods.mint(1000, owner).send().wait();
  * console.log(`Total supply is now ${await contract.methods.totalSupply().view()}`);
  * ```
@@ -27,7 +27,7 @@
  *
  * The result of `send`ing a transaction is a {@link SentTx} object, from which you can get the
  * transaction hash, or simply `wait` until the transaction is mined and the local PXE Service
- * has synchronised its changes.
+ * has synchronized its changes.
  *
  * @remarks If you are using typescript, consider using the
  * {@link https://docs.aztec.network/dev_docs/contracts/compiling#typescript-interfaces | autogenerated type-safe interfaces}

package/src/contract/sent_tx.ts

@@ -1,6 +1,6 @@
 import { FieldsOf } from '@aztec/circuits.js';
 import { retryUntil } from '@aztec/foundation/retry';
-import { PXE, TxHash, TxReceipt, TxStatus } from '@aztec/types';
+import { GetUnencryptedLogsResponse, PXE, TxHash, TxReceipt, TxStatus } from '@aztec/types';
 
 import every from 'lodash.every';
 
@@ -80,6 +80,16 @@ export class SentTx {
     return receipt.status === TxStatus.MINED;
   }
 
+  /**
+   * Gets unencrypted logs emitted by this tx.
+   * @remarks This function will wait for the tx to be mined if it hasn't been already.
+   * @returns The requested logs.
+   */
+  public async getUnencryptedLogs(): Promise<GetUnencryptedLogsResponse> {
+    await this.wait();
+    return this.pxe.getUnencryptedLogs({ txHash: await this.getTxHash() });
+  }
+
   protected async waitForReceipt(opts?: WaitOpts): Promise<TxReceipt> {
     const txHash = await this.getTxHash();
     return await retryUntil(

package/src/contract_deployer/contract_deployer.ts

@@ -1,4 +1,4 @@
-import { ContractAbi } from '@aztec/foundation/abi';
+import { ContractArtifact } from '@aztec/foundation/abi';
 import { Point } from '@aztec/foundation/fields';
 import { PXE, PublicKey } from '@aztec/types';
 
@@ -9,7 +9,7 @@ import { DeployMethod } from './deploy_method.js';
  * @remarks Keeping this around even though we have Aztec.nr contract types because it can be useful for non-TS users.
  */
 export class ContractDeployer {
-  constructor(private abi: ContractAbi, private pxe: PXE, private publicKey?: PublicKey) {}
+  constructor(private artifact: ContractArtifact, private pxe: PXE, private publicKey?: PublicKey) {}
 
   /**
    * Deploy a contract using the provided ABI and constructor arguments.
@@ -21,6 +21,6 @@ export class ContractDeployer {
    * @returns A DeployMethod instance configured with the ABI, PXE, and constructor arguments.
    */
   public deploy(...args: any[]) {
-    return new DeployMethod(this.publicKey ?? Point.ZERO, this.pxe, this.abi, args);
+    return new DeployMethod(this.publicKey ?? Point.ZERO, this.pxe, this.artifact, args);
   }
 }

package/src/contract_deployer/deploy_method.ts

@@ -5,7 +5,7 @@ import {
   TxContext,
   getContractDeploymentInfo,
 } from '@aztec/circuits.js';
-import { ContractAbi, FunctionAbi, encodeArguments } from '@aztec/foundation/abi';
+import { ContractArtifact, FunctionArtifact, encodeArguments } from '@aztec/foundation/abi';
 import { EthAddress } from '@aztec/foundation/eth-address';
 import { Fr } from '@aztec/foundation/fields';
 import { PXE, PackedArguments, PublicKey, Tx, TxExecutionRequest } from '@aztec/types';
@@ -38,13 +38,18 @@ export class DeployMethod<TContract extends ContractBase = Contract> extends Bas
   public completeAddress?: CompleteAddress = undefined;
 
   /** Constructor function to call. */
-  private constructorAbi: FunctionAbi;
-
-  constructor(private publicKey: PublicKey, protected pxe: PXE, private abi: ContractAbi, private args: any[] = []) {
+  private constructorArtifact: FunctionArtifact;
+
+  constructor(
+    private publicKey: PublicKey,
+    protected pxe: PXE,
+    private artifact: ContractArtifact,
+    private args: any[] = [],
+  ) {
     super(pxe);
-    const constructorAbi = abi.functions.find(f => f.name === 'constructor');
-    if (!constructorAbi) throw new Error('Cannot find constructor in the ABI.');
-    this.constructorAbi = constructorAbi;
+    const constructorArtifact = artifact.functions.find(f => f.name === 'constructor');
+    if (!constructorArtifact) throw new Error('Cannot find constructor in the artifact.');
+    this.constructorArtifact = constructorArtifact;
   }
 
   /**
@@ -63,7 +68,7 @@ export class DeployMethod<TContract extends ContractBase = Contract> extends Bas
     const { chainId, protocolVersion } = await this.pxe.getNodeInfo();
 
     const { completeAddress, constructorHash, functionTreeRoot } = await getContractDeploymentInfo(
-      this.abi,
+      this.artifact,
       this.args,
       contractAddressSalt,
       this.publicKey,
@@ -85,8 +90,8 @@ export class DeployMethod<TContract extends ContractBase = Contract> extends Bas
       new Fr(chainId),
       new Fr(protocolVersion),
     );
-    const args = encodeArguments(this.constructorAbi, this.args);
-    const functionData = FunctionData.fromAbi(this.constructorAbi);
+    const args = encodeArguments(this.constructorArtifact, this.args);
+    const functionData = FunctionData.fromAbi(this.constructorArtifact);
     const execution = { args, functionData, to: completeAddress.address };
     const packedArguments = await PackedArguments.fromArgs(execution.args);
 
@@ -103,7 +108,7 @@ export class DeployMethod<TContract extends ContractBase = Contract> extends Bas
     this.completeAddress = completeAddress;
 
     // TODO: Should we add the contracts to the DB here, or once the tx has been sent or mined?
-    await this.pxe.addContracts([{ abi: this.abi, completeAddress, portalContract }]);
+    await this.pxe.addContracts([{ artifact: this.artifact, completeAddress, portalContract }]);
 
     return this.txRequest;
   }
@@ -118,7 +123,7 @@ export class DeployMethod<TContract extends ContractBase = Contract> extends Bas
    */
   public send(options: DeployOptions = {}): DeploySentTx<TContract> {
     const txHashPromise = super.send(options).getTxHash();
-    return new DeploySentTx(this.abi, this.pxe, txHashPromise);
+    return new DeploySentTx(this.artifact, this.pxe, txHashPromise, this.completeAddress);
   }
 
   /**

package/src/contract_deployer/deploy_sent_tx.ts

@@ -1,5 +1,5 @@
-import { FieldsOf } from '@aztec/circuits.js';
-import { ContractAbi } from '@aztec/foundation/abi';
+import { CompleteAddress, FieldsOf } from '@aztec/circuits.js';
+import { ContractArtifact } from '@aztec/foundation/abi';
 import { TxHash, TxReceipt } from '@aztec/types';
 
 import { AztecAddress, Contract, ContractBase, PXE, SentTx, WaitOpts, Wallet } from '../index.js';
@@ -20,7 +20,16 @@ export type DeployTxReceipt<TContract extends ContractBase = Contract> = FieldsO
  * A contract deployment transaction sent to the network, extending SentTx with methods to create a contract instance.
  */
 export class DeploySentTx<TContract extends Contract = Contract> extends SentTx {
-  constructor(private abi: ContractAbi, wallet: PXE | Wallet, txHashPromise: Promise<TxHash>) {
+  constructor(
+    private artifact: ContractArtifact,
+    wallet: PXE | Wallet,
+    txHashPromise: Promise<TxHash>,
+
+    /**
+     * The complete address of the deployed contract
+     */
+    public completeContractAddress?: CompleteAddress,
+  ) {
     super(wallet, txHashPromise);
   }
 
@@ -50,6 +59,6 @@ export class DeploySentTx<TContract extends Contract = Contract> extends SentTx
     const contractWallet = wallet ?? (isWallet(this.pxe) && this.pxe);
     if (!contractWallet) throw new Error(`A wallet is required for creating a contract instance`);
     if (!address) throw new Error(`Contract address is missing from transaction receipt`);
-    return Contract.at(address, this.abi, contractWallet) as Promise<TContract>;
+    return Contract.at(address, this.artifact, contractWallet) as Promise<TContract>;
   }
 }

package/src/index.ts

@@ -7,7 +7,9 @@ export * from './contract_deployer/deploy_method.js';
 export * from './sandbox/index.js';
 export * from './wallet/index.js';
 
-export { AztecAddress, EthAddress, Point, Fr, GrumpkinScalar } from '@aztec/circuits.js';
+// TODO https://github.com/AztecProtocol/aztec-packages/issues/2632 --> FunctionSelector might not need to be exposed
+// here once the issue is resolved.
+export { AztecAddress, EthAddress, Point, Fr, FunctionSelector, GrumpkinScalar } from '@aztec/circuits.js';
 export {
   PXE,
   ContractData,
@@ -15,6 +17,7 @@ export {
   DeployedContract,
   FunctionCall,
   L2BlockL2Logs,
+  LogFilter,
   UnencryptedL2Log,
   NodeInfo,
   NotePreimage,

package/src/pxe_client.ts

@@ -1,11 +1,21 @@
-import { AztecAddress, CompleteAddress, EthAddress, Fr, GrumpkinScalar, Point } from '@aztec/circuits.js';
+import {
+  AztecAddress,
+  CompleteAddress,
+  EthAddress,
+  Fr,
+  FunctionSelector,
+  GrumpkinScalar,
+  Point,
+} from '@aztec/circuits.js';
 import { createJsonRpcClient, makeFetch } from '@aztec/foundation/json-rpc/client';
 import {
   AuthWitness,
   ContractData,
   ExtendedContractData,
+  ExtendedUnencryptedL2Log,
   L2BlockL2Logs,
   L2Tx,
+  LogId,
   NotePreimage,
   PXE,
   Tx,
@@ -21,10 +31,12 @@ export const createPXEClient = (url: string, fetch = makeFetch([1, 2, 3], true))
     url,
     {
       CompleteAddress,
+      FunctionSelector,
       AztecAddress,
       TxExecutionRequest,
       ContractData,
       ExtendedContractData,
+      ExtendedUnencryptedL2Log,
       TxHash,
       EthAddress,
       Point,
@@ -33,6 +45,7 @@ export const createPXEClient = (url: string, fetch = makeFetch([1, 2, 3], true))
       NotePreimage,
       AuthWitness,
       L2Tx,
+      LogId,
     },
     { Tx, TxReceipt, L2BlockL2Logs },
     false,

package/src/sandbox/index.ts

@@ -3,7 +3,7 @@ import { sleep } from '@aztec/foundation/sleep';
 
 import zip from 'lodash.zip';
 
-import SchnorrAccountContractAbi from '../abis/schnorr_account_contract.json' assert { type: 'json' };
+import SchnorrAccountContractArtifact from '../artifacts/schnorr_account_contract.json' assert { type: 'json' };
 import { AccountWalletWithPrivateKey, PXE, createPXEClient, getSchnorrAccount } from '../index.js';
 
 export const INITIAL_SANDBOX_ENCRYPTION_KEYS = [
@@ -16,7 +16,7 @@ export const INITIAL_SANDBOX_SIGNING_KEYS = INITIAL_SANDBOX_ENCRYPTION_KEYS;
 
 export const INITIAL_SANDBOX_SALTS = [Fr.ZERO, Fr.ZERO, Fr.ZERO];
 
-export const INITIAL_SANDBOX_ACCOUNT_CONTRACT_ABI = SchnorrAccountContractAbi;
+export const INITIAL_SANDBOX_ACCOUNT_CONTRACT_ABI = SchnorrAccountContractArtifact;
 
 export const { PXE_URL = 'http://localhost:8080' } = process.env;
 

package/src/utils/authwit.ts

@@ -2,6 +2,7 @@ import { AztecAddress, CircuitsWasm, GeneratorIndex } from '@aztec/circuits.js';
 import { pedersenPlookupCompressWithHashIndex } from '@aztec/circuits.js/barretenberg';
 import { FunctionCall, PackedArguments } from '@aztec/types';
 
+// docs:start:authwit_computeAuthWitMessageHash
 /**
  * Compute an authentication witness message hash from a caller and a request
  * H(caller: AztecAddress, target: AztecAddress, selector: Field, args_hash: Field)
@@ -22,3 +23,4 @@ export const computeAuthWitMessageHash = async (caller: AztecAddress, request: F
     GeneratorIndex.SIGNATURE_PAYLOAD,
   );
 };
+// docs:end:authwit_computeAuthWitMessageHash

package/src/wallet/account_wallet.ts

@@ -1,5 +1,5 @@
 import { Fr, GrumpkinPrivateKey } from '@aztec/circuits.js';
-import { ABIParameterVisibility, FunctionAbiHeader, FunctionType } from '@aztec/foundation/abi';
+import { ABIParameterVisibility, FunctionAbi, FunctionType } from '@aztec/foundation/abi';
 import { AuthWitness, FunctionCall, PXE, TxExecutionRequest } from '@aztec/types';
 
 import { AccountInterface } from '../account/interface.js';
@@ -47,7 +47,7 @@ export class AccountWallet extends BaseWallet {
     return this.getCompleteAddress().address;
   }
 
-  private getSetIsValidStorageAbi(): FunctionAbiHeader {
+  private getSetIsValidStorageAbi(): FunctionAbi {
     return {
       name: 'set_is_valid_storage',
       functionType: 'open' as FunctionType,

package/src/wallet/base_wallet.ts

@@ -5,8 +5,9 @@ import {
   DeployedContract,
   ExtendedContractData,
   FunctionCall,
-  L2BlockL2Logs,
+  GetUnencryptedLogsResponse,
   L2Tx,
+  LogFilter,
   NodeInfo,
   NotePreimage,
   PXE,
@@ -96,8 +97,8 @@ export abstract class BaseWallet implements Wallet {
   getContractData(contractAddress: AztecAddress): Promise<ContractData | undefined> {
     return this.pxe.getContractData(contractAddress);
   }
-  getUnencryptedLogs(from: number, limit: number): Promise<L2BlockL2Logs[]> {
-    return this.pxe.getUnencryptedLogs(from, limit);
+  getUnencryptedLogs(filter: LogFilter): Promise<GetUnencryptedLogsResponse> {
+    return this.pxe.getUnencryptedLogs(filter);
   }
   getBlockNumber(): Promise<number> {
     return this.pxe.getBlockNumber();