refactor(stdlib)!: rename unsafe AztecAddress constructors to *Unsafe

boxes/boxes/vanilla/app/embedded-wallet.ts

@@ -163,7 +163,7 @@ export class EmbeddedWallet extends EmbeddedWalletBase {
     if (!address) {
       return null;
     }
-    const parsed = AztecAddress.fromString(address);
+    const parsed = AztecAddress.fromStringUnsafe(address);
     this.connectedAccount = parsed;
     return this.connectedAccount;
   }

boxes/boxes/vanilla/app/main.ts

@@ -53,9 +53,9 @@ document.addEventListener('DOMContentLoaded', async () => {
     const instance = await getContractInstanceFromInstantiationParams(
       PrivateVotingContract.artifact,
       {
-        deployer: AztecAddress.fromString(deployerAddress),
+        deployer: AztecAddress.fromStringUnsafe(deployerAddress),
         salt: Fr.fromString(deploymentSalt),
-        constructorArgs: [AztecAddress.fromString(deployerAddress)],
+        constructorArgs: [AztecAddress.fromStringUnsafe(deployerAddress)],
       }
     );
     await wallet.registerContract(instance, PrivateVotingContract.artifact);
@@ -155,7 +155,7 @@ voteButton.addEventListener('click', async (e) => {
 
     // Prepare contract interaction
     const votingContract = PrivateVotingContract.at(
-      AztecAddress.fromString(contractAddress),
+      AztecAddress.fromStringUnsafe(contractAddress),
       wallet
     );
 
@@ -188,7 +188,7 @@ async function updateVoteTally(wallet: Wallet, from: AztecAddress) {
 
   // Prepare contract interaction
   const votingContract = PrivateVotingContract.at(
-    AztecAddress.fromString(contractAddress),
+    AztecAddress.fromStringUnsafe(contractAddress),
     wallet
   );
 

docs/docs-developers/docs/resources/migration_notes.md

@@ -9,6 +9,26 @@ Aztec is in active development. Each version may introduce breaking changes that
 
 ## TBD
 
+### [Aztec.js] Unchecked `AztecAddress` constructors renamed with an `Unsafe` suffix
+
+The synchronous `AztecAddress` constructors that build an address from a raw value do not verify that the value is a valid address (the x-coordinate of a point on the Grumpkin curve, which is what allows it to be encrypted to). An invalid value is accepted silently and only fails later, when a transaction is sent. To make this obvious at the call site, they now carry an `Unsafe` suffix:
+
+| Before | After |
+| --- | --- |
+| `AztecAddress.fromField` | `AztecAddress.fromFieldUnsafe` |
+| `AztecAddress.fromBigInt` | `AztecAddress.fromBigIntUnsafe` |
+| `AztecAddress.fromNumber` | `AztecAddress.fromNumberUnsafe` |
+| `AztecAddress.fromString` | `AztecAddress.fromStringUnsafe` |
+
+**Migration:**
+
+```diff
+- const address = AztecAddress.fromBigInt(123n);
++ const address = AztecAddress.fromBigIntUnsafe(123n);
+```
+
+For a random, genuinely valid address in tests use `AztecAddress.random()`, and to check an untrusted value use `address.isValid()`. The serialization constructors `fromBuffer` and `fromFields` keep their names (they are part of the (de)serialization interface and read addresses from already-validated data), but their docs now note that they perform no validation either.
+
 ### Cross-contract utility calls now have a `msg_sender`
 
 A utility function called by another contract (utility to utility, or private to utility) can read the calling contract's address via `self.msg_sender()`, mirroring private and public functions. A top-level utility call (e.g. invoked directly by a wallet or dapp) has no caller: `self.msg_sender()` panics, and `self.context.maybe_msg_sender()` returns `Option::none()`.

docs/docs-developers/docs/tutorials/js_tutorials/wallet-extension/05-transactions.md

@@ -173,7 +173,7 @@ case 'sendTx': {
 
   // 1. Deserialize the payload
   const payload = deserializeExecutionPayload(executionPayload);
-  const fromAddress = AztecAddress.fromString(from || options.from);
+  const fromAddress = AztecAddress.fromStringUnsafe(from || options.from);
 
   // 2. Call wallet.sendTx (inherited from BaseWallet)
   const result = await wallet.sendTx(payload, {
@@ -297,7 +297,7 @@ For gas estimation or validation, dApps use `simulateTx`:
 case 'simulateTx': {
   const { executionPayload, options } = args;
   const payload = deserializeExecutionPayload(executionPayload);
-  const fromAddress = AztecAddress.fromString(from || options.from);
+  const fromAddress = AztecAddress.fromStringUnsafe(from || options.from);
 
   const result = await wallet.simulateTx(payload, {
     ...options,
@@ -342,7 +342,7 @@ For delegated actions (like approving token spending), the wallet creates auth w
 ```typescript
 case 'createAuthWit': {
   const { from: authFrom, messageHashOrIntent } = args;
-  const fromAddress = AztecAddress.fromString(authFrom);
+  const fromAddress = AztecAddress.fromStringUnsafe(authFrom);
 
   const authWit = await wallet.createAuthWit(fromAddress, messageHashOrIntent);
 

docs/examples/webapp-tutorial/src/components/GameLobby.tsx

@@ -79,7 +79,7 @@ export function GameLobby({ wallet, account, onGameJoined }: GameLobbyProps) {
         return;
       }
 
-      const contractAddr = AztecAddress.fromString(joinContractAddress);
+      const contractAddr = AztecAddress.fromStringUnsafe(joinContractAddress);
       const contract = await attachToContract(
         wallet,
         contractAddr

noir-projects/protocol-fuzzer/wallet-bridge.mjs

@@ -85,7 +85,7 @@ const handlers = {
     const w = await ensureWallet();
     const { result: address, stdout } = await capturing(log =>
       deploy(
-        w, node, AztecAddress.fromString(from), artifact,
+        w, node, AztecAddress.fromStringUnsafe(from), artifact,
         false,                                  /* json */
         undefined,                              /* publicKeys */
         Array.isArray(args) ? args : [],        /* args */
@@ -106,8 +106,8 @@ const handlers = {
 
   '/execute': async ({ verb, method, contract, from, args, artifact }) => {
     const w = await ensureWallet();
-    const sender = AztecAddress.fromString(from);
-    const target = AztecAddress.fromString(contract);
+    const sender = AztecAddress.fromStringUnsafe(from);
+    const target = AztecAddress.fromStringUnsafe(contract);
     const callArgs = args || [];
     const { stdout } = await capturing(log =>
       verb === 'send'

playground/src/components/common/FnParameter.tsx

@@ -74,7 +74,7 @@ export function FunctionParameter({ parameter, required, onParameterChange, defa
       const contacts = await wallet.getAddressBook();
 
       const contracts = (await playgroundDB.listAliases('contracts')).map(
-        ({ alias, item }) => ({ alias, item: AztecAddress.fromString(item) }),
+        ({ alias, item }) => ({ alias, item: AztecAddress.fromStringUnsafe(item) }),
       );
       setAliasedAddresses([...accounts, ...contacts, ...contracts]);
       setLoading(false);

playground/src/components/contract/components/CreateAuthwitDialog.tsx

@@ -62,7 +62,7 @@ export function CreateAuthwitDialog({ open, contract, fnName, args, isPrivate, o
     setCreating(true);
     const call = await contract.methods[fnName](...args).getFunctionCall();
     const intent = {
-      caller: AztecAddress.fromString(caller),
+      caller: AztecAddress.fromStringUnsafe(caller),
       call,
     };
     try {

playground/src/components/contract/components/CreateContractDialog.tsx

@@ -141,7 +141,7 @@ export function CreateContractDialog({
   const registerExistingContract = async () => {
     setIsRegistering(true);
     try {
-      const contract = await node.getContract(AztecAddress.fromString(address));
+      const contract = await node.getContract(AztecAddress.fromStringUnsafe(address));
       if (!contract) {
         throw new Error('Contract with this address was not found in node');
       }

playground/src/components/home/components/Landing.tsx

@@ -352,7 +352,7 @@ export function Landing() {
         const artifactAsString = await playgroundDB.retrieveAlias(`artifacts:${contract.item}`);
         const contractArtifact = loadContractArtifact(parse(artifactAsString));
         if (contractArtifact.name === contractArtifactJSON.name) {
-          deployedContractAddress = AztecAddress.fromString(contract.item);
+          deployedContractAddress = AztecAddress.fromStringUnsafe(contract.item);
           break;
         }
       }

playground/src/components/navbar/components/AccountSelector.tsx

@@ -81,7 +81,7 @@ export function AccountSelector() {
           onClose={() => setIsOpen(false)}
           onChange={e => {
             if (e.target.value !== '') {
-              handleAccountChange(AztecAddress.fromString(e.target.value));
+              handleAccountChange(AztecAddress.fromStringUnsafe(e.target.value));
             }
           }}
           disabled={areAccountsLoading}

playground/src/components/navbar/components/ContractSelector.tsx

@@ -108,7 +108,7 @@ export function ContractSelector() {
       } else {
         const artifactAsString = await playgroundDB.retrieveAlias(`artifacts:${contractValue}`);
         const contractArtifact = loadContractArtifact(parse(artifactAsString));
-        setCurrentContractAddress(AztecAddress.fromString(contractValue));
+        setCurrentContractAddress(AztecAddress.fromStringUnsafe(contractValue));
         setCurrentContractArtifact(contractArtifact);
         setSelectedPredefinedContract(undefined);
         setShowContractInterface(true);

playground/src/utils/contracts.ts

@@ -8,7 +8,7 @@ export async function filterDeployedAliasedContracts(
   const deployed = (
     await Promise.all(
       aliasedContracts.map(async contract => {
-        const { isContractPublished } = await wallet.getContractMetadata(AztecAddress.fromString(contract.item));
+        const { isContractPublished } = await wallet.getContractMetadata(AztecAddress.fromStringUnsafe(contract.item));
         return { ...contract, deployed: isContractPublished };
       }),
     )

playground/src/wallet/components/AddSenderDialog.tsx

@@ -24,7 +24,7 @@ export function AddSendersDialog({
 
   const addSender = async () => {
     try {
-      const parsed = AztecAddress.fromString(sender);
+      const parsed = AztecAddress.fromStringUnsafe(sender);
       onClose(parsed, alias);
     } catch (e) {
       setError('Invalid Aztec address');

yarn-project/archiver/src/store/log_store.test.ts

@@ -40,7 +40,7 @@ async function buildChainedCheckpointsWithLogs(
   return checkpoints;
 }
 
-const CONTRACT = AztecAddress.fromNumber(543254);
+const CONTRACT = AztecAddress.fromNumberUnsafe(543254);
 
 describe('LogStore', () => {
   let blockStore: BlockStore;
@@ -468,7 +468,7 @@ describe('LogStore', () => {
       await logStore.addLogs([ckpt.checkpoint.blocks[0]]);
 
       // Same tag, different contract → no hits.
-      const otherContract = AztecAddress.fromNumber(99);
+      const otherContract = AztecAddress.fromNumberUnsafe(99);
       const [missing] = await logStore.getPublicLogsByTags({ contractAddress: otherContract, tags: [tag] });
       expect(missing).toEqual([]);
 

yarn-project/archiver/src/store/log_store_codec.test.ts

@@ -45,7 +45,7 @@ describe('log_store_codec', () => {
     });
 
     it('strips 0x prefix for AztecAddress', () => {
-      const addr = AztecAddress.fromNumber(12345);
+      const addr = AztecAddress.fromNumberUnsafe(12345);
       const hex = fieldHex(addr);
       expect(hex).toHaveLength(64);
       expect(hex).not.toMatch(/^0x/);
@@ -69,7 +69,7 @@ describe('log_store_codec', () => {
     });
 
     it('round-trips a public-style prefix (contract-tag)', () => {
-      const contractHex = fieldHex(AztecAddress.fromNumber(99));
+      const contractHex = fieldHex(AztecAddress.fromNumberUnsafe(99));
       const tagHex = fieldHex(new Fr(0x5678n));
       const prefix = encodePublicPrefix(contractHex, tagHex);
       const key = encodeKey(prefix, 10, 0, 2);
@@ -242,7 +242,7 @@ describe('log_store_codec', () => {
 
   describe('encodePublicPrefix', () => {
     it('produces contractHex-tagHex', () => {
-      const contractHex = fieldHex(AztecAddress.fromNumber(1));
+      const contractHex = fieldHex(AztecAddress.fromNumberUnsafe(1));
       const tagHex = fieldHex(new Fr(2n));
       expect(encodePublicPrefix(contractHex, tagHex)).toBe(`${contractHex}-${tagHex}`);
     });

yarn-project/archiver/src/test/mock_structs.ts

@@ -269,7 +269,10 @@ export function makePublicLogTag(blockNumber: number, txIndex: number, logIndex:
 }
 
 /** Creates a PublicLog with fields derived from the tag. */
-export function makePublicLog(tag: Tag, contractAddress: AztecAddress = AztecAddress.fromNumber(543254)): PublicLog {
+export function makePublicLog(
+  tag: Tag,
+  contractAddress: AztecAddress = AztecAddress.fromNumberUnsafe(543254),
+): PublicLog {
   return PublicLog.from({
     contractAddress,
     fields: new Array(10).fill(null).map((_, i) => (!i ? tag.value : new Fr(tag.value.toBigInt() + BigInt(i)))),
@@ -281,7 +284,7 @@ export function makePublicLogs(
   blockNumber: number,
   txIndex: number,
   numLogsPerTx: number,
-  contractAddress: AztecAddress = AztecAddress.fromNumber(543254),
+  contractAddress: AztecAddress = AztecAddress.fromNumberUnsafe(543254),
 ): PublicLog[] {
   return times(numLogsPerTx, logIndex => {
     const tag = makePublicLogTag(blockNumber, txIndex, logIndex);

yarn-project/aztec.js/src/authorization/call_authorization_request.ts

@@ -81,8 +81,8 @@ export class CallAuthorizationRequest {
     const request = new CallAuthorizationRequest(
       selector,
       reader.readField(), // inner_hash
-      AztecAddress.fromField(reader.readField()), // on_behalf_of
-      AztecAddress.fromField(reader.readField()), // msg_sender
+      AztecAddress.fromFieldUnsafe(reader.readField()), // on_behalf_of
+      AztecAddress.fromFieldUnsafe(reader.readField()), // msg_sender
       FunctionSelector.fromField(reader.readField()), // fn_selector
       reader.readField(), // args_hash
       reader.readFieldArray(reader.remainingFields()), // args

yarn-project/aztec.js/src/contract/interaction_options.test.ts

@@ -9,7 +9,7 @@ describe('extractOffchainOutput', () => {
 
   const makeEffect = (data: Fr[], contractAddress?: AztecAddress): OffchainEffect => ({
     data,
-    contractAddress: contractAddress ?? AztecAddress.fromField(Fr.random()),
+    contractAddress: contractAddress ?? AztecAddress.fromFieldUnsafe(Fr.random()),
   });
 
   const makeMessageEffect = async (recipient?: AztecAddress, payload?: Fr[], contractAddress?: AztecAddress) =>

yarn-project/aztec.js/src/contract/interaction_options.ts

@@ -191,7 +191,7 @@ export function extractOffchainOutput(effects: OffchainEffect[], anchorBlockTime
   for (const effect of effects) {
     if (effect.data.length >= 2 && effect.data[0].equals(OFFCHAIN_MESSAGE_IDENTIFIER)) {
       offchainMessages.push({
-        recipient: AztecAddress.fromField(effect.data[1]),
+        recipient: AztecAddress.fromFieldUnsafe(effect.data[1]),
         payload: effect.data.slice(2),
         contractAddress: effect.contractAddress,
         anchorBlockTimestamp,

yarn-project/aztec/src/cli/cmds/standby.ts

@@ -23,7 +23,7 @@ const ROLLUP_POLL_INTERVAL_S = 60;
 export async function computeExpectedGenesisRoot(config: GenesisStateConfig, userLog: LogFn) {
   const testAccounts = config.testAccounts ? (await getInitialTestAccountsData()).map(a => a.address) : [];
   const sponsoredFPCAccounts = config.sponsoredFPC ? [await getSponsoredFPCAddress()] : [];
-  const prefundAddresses = (config.prefundAddresses ?? []).map(a => AztecAddress.fromString(a));
+  const prefundAddresses = (config.prefundAddresses ?? []).map(a => AztecAddress.fromStringUnsafe(a));
   const initialFundedAccounts = testAccounts.concat(sponsoredFPCAccounts).concat(prefundAddresses);
 
   userLog(`Initial funded accounts: ${initialFundedAccounts.map(a => a.toString()).join(', ')}`);

yarn-project/aztec/src/local-network/local-network.ts

@@ -166,7 +166,7 @@ export async function createLocalNetwork(config: Partial<LocalNetworkConfig> = {
 
   const bananaFPC = await getBananaFPCAddress(initialAccounts);
   const sponsoredFPC = await getSponsoredFPCAddress();
-  const prefundAddresses = (aztecNodeConfig.prefundAddresses ?? []).map(a => AztecAddress.fromString(a));
+  const prefundAddresses = (aztecNodeConfig.prefundAddresses ?? []).map(a => AztecAddress.fromStringUnsafe(a));
   const fundedAddresses = [
     ...initialAccounts.map(a => a.address),
     ...(initialAccounts.length ? [bananaFPC, sponsoredFPC] : []),

yarn-project/bb-prover/src/avm_proving_tests/avm_check_circuit1.test.ts

@@ -26,7 +26,7 @@ describe('AVM check-circuit – unhappy paths 1', () => {
     tester = await AvmProvingTester.new(worldStateService, /*checkCircuitOnly*/ true);
     avmTestContractInstance = await tester.registerAndDeployContract(
       /*constructorArgs=*/ [],
-      /*deployer=*/ AztecAddress.fromNumber(420),
+      /*deployer=*/ AztecAddress.fromNumberUnsafe(420),
       AvmTestContractArtifact,
     );
   });

yarn-project/bb-prover/src/avm_proving_tests/avm_check_circuit2.test.ts

@@ -10,7 +10,7 @@ import { AvmProvingTester } from './avm_proving_tester.js';
 const TIMEOUT = 30_000;
 
 describe('AVM check-circuit – unhappy paths 2', () => {
-  const sender = AztecAddress.fromNumber(42);
+  const sender = AztecAddress.fromNumberUnsafe(42);
   let avmTestContractInstance: ContractInstanceWithAddress;
   let tester: AvmProvingTester;
   let worldStateService: NativeWorldStateService;
@@ -20,7 +20,7 @@ describe('AVM check-circuit – unhappy paths 2', () => {
     tester = await AvmProvingTester.new(worldStateService, /*checkCircuitOnly*/ true);
     avmTestContractInstance = await tester.registerAndDeployContract(
       /*constructorArgs=*/ [],
-      /*deployer=*/ AztecAddress.fromNumber(420),
+      /*deployer=*/ AztecAddress.fromNumberUnsafe(420),
       AvmTestContractArtifact,
     );
   });

yarn-project/bb-prover/src/avm_proving_tests/avm_check_circuit3.test.ts

@@ -13,7 +13,7 @@ import { AvmProvingTester } from './avm_proving_tester.js';
 const TIMEOUT = 100_000;
 
 describe('AVM check-circuit – unhappy paths 3', () => {
-  const sender = AztecAddress.fromNumber(42);
+  const sender = AztecAddress.fromNumberUnsafe(42);
   let avmTestContractInstance: ContractInstanceWithAddress;
   let tester: AvmProvingTester;
   let worldStateService: NativeWorldStateService;
@@ -23,7 +23,7 @@ describe('AVM check-circuit – unhappy paths 3', () => {
     tester = await AvmProvingTester.new(worldStateService, /*checkCircuitOnly*/ true);
     avmTestContractInstance = await tester.registerAndDeployContract(
       /*constructorArgs=*/ [],
-      /*deployer=*/ AztecAddress.fromNumber(420),
+      /*deployer=*/ AztecAddress.fromNumberUnsafe(420),
       AvmTestContractArtifact,
     );
   });
@@ -137,15 +137,15 @@ describe('AVM check-circuit – unhappy paths 3', () => {
             l2ToL1Msgs: [
               new ScopedL2ToL1Message(
                 new L2ToL1Message(EthAddress.fromNumber(0x1111), new Fr(0xdddd)),
-                AztecAddress.fromNumber(0x1111),
+                AztecAddress.fromNumberUnsafe(0x1111),
               ),
               new ScopedL2ToL1Message(
                 new L2ToL1Message(EthAddress.fromNumber(0x2222), new Fr(0xeeee)),
-                AztecAddress.fromNumber(0x2222),
+                AztecAddress.fromNumberUnsafe(0x2222),
               ),
               new ScopedL2ToL1Message(
                 new L2ToL1Message(EthAddress.fromNumber(0x3333), new Fr(0xffff)),
-                AztecAddress.fromNumber(0x3333),
+                AztecAddress.fromNumberUnsafe(0x3333),
               ),
             ],
           },

yarn-project/bb-prover/src/avm_proving_tests/avm_contract_class_limits.test.ts

@@ -9,7 +9,7 @@ import { AvmProvingTester } from './avm_proving_tester.js';
 const TIMEOUT = 300_000;
 
 describe('AVM check-circuit - contract class limits', () => {
-  const deployer = AztecAddress.fromNumber(42);
+  const deployer = AztecAddress.fromNumberUnsafe(42);
   let instances: ContractInstanceWithAddress[];
   let tester: AvmProvingTester;
   let avmTestContractAddress: AztecAddress;

yarn-project/bb-prover/src/avm_proving_tests/avm_contract_updates.test.ts

@@ -17,7 +17,7 @@ import { AvmProvingTester } from './avm_proving_tester.js';
 const TIMEOUT = 60_000;
 
 describe('AVM check-circuit - contract updates', () => {
-  const sender = AztecAddress.fromNumber(42);
+  const sender = AztecAddress.fromNumberUnsafe(42);
 
   const avmTestContractClassSeed = 0;
   let avmTestContractInstance: ContractInstanceWithAddress;