Aztec TypeScript Integration

Generate TypeScript code for interacting with Aztec contracts.

Subskills

• Contract Client - Type-safe contract interaction wrapper
• Wallet Setup - Wallet and node connection patterns
• PXE Sync - PXE internals, registerContract/registerSender, setup ordering, common pitfalls
• Transaction Patterns - Common transaction patterns
• AuthWit Frontend - Client-side authorization witness implementation

Quick Start: Contract Interaction

import { MyContract } from "../artifacts/MyContract.js";
import { SponsoredFeePaymentMethod } from "@aztec/aztec.js/fee";

// Get contract instance
const contract = MyContract.at(contractAddress, wallet);

// Call a method
await contract.methods.myMethod(arg1, arg2).simulate({ from: account.address });
const tx = await contract.methods.myMethod(arg1, arg2).send({
    from: account.address,
    fee: { paymentMethod },
    wait: { timeout: 600 }
});

console.log('Transaction successful');

Generated Artifacts

After running aztec codegen, you get TypeScript bindings:

// src/artifacts/MyContract.ts
import { MyContractContract } from "../artifacts/MyContract.js";

// Available methods
MyContractContract.deploy(wallet, ...args)  // Deploy new contract
MyContractContract.at(address, wallet)       // Connect to existing
contract.methods.myFunction(args)            // Call contract method

Key Imports

// Contract and wallet
import { Wallet } from "@aztec/aztec.js/wallet";
import { AztecAddress } from "@aztec/aztec.js/addresses";

// Transaction handling
import { TxReceipt } from "@aztec/stdlib/tx";

// Fee payment
import { SponsoredFeePaymentMethod } from "@aztec/aztec.js/fee";

// Fields and types
import { Fr, GrumpkinScalar } from "@aztec/aztec.js/fields";

// Logging
import { type Logger, createLogger } from "@aztec/foundation/log";

Transaction Flow

1. Get contract instance (at() or deploy())
2. Call method via contract.methods.xxx()
3. Simulate first to catch errors .simulate({ from })
4. Send with fee payment and wait .send({ from, fee, wait: { timeout } })
5. Transaction resolves when confirmed