fix(noir-contracts): remove easy reference from private token contract (#16624)

This is part of addressing Zac's feedback on Slack.

Author: AztecBot

docs/docs/developers/reference/environment_reference/sandbox-reference.md

@@ -118,7 +118,7 @@ ContractInstanceRegistryContractArtifact
 CounterContractArtifact
 CrowdfundingContractArtifact
 DocsExampleContractArtifact
-EasyPrivateTokenContractArtifact
+PrivateTokenContractArtifact
 PrivateVotingContractArtifact
 EcdsaAccountContractArtifact
 EscrowContractArtifact

noir-projects/noir-contracts/Nargo.toml

@@ -12,7 +12,7 @@ members = [
     "contracts/app/card_game_contract",
     "contracts/app/claim_contract",
     "contracts/app/crowdfunding_contract",
-    "contracts/app/easy_private_token_contract",
+    "contracts/app/private_token_contract",
     "contracts/app/private_voting_contract",
     "contracts/app/escrow_contract",
     "contracts/app/lending_contract",

…p/easy_private_token_contract/Nargo.toml …ts/app/private_token_contract/Nargo.tomlnoir-projects/noir-contracts/contracts/app/easy_private_token_contract/Nargo.toml renamed to noir-projects/noir-contracts/contracts/app/private_token_contract/Nargo.toml noir-projects/noir-contracts/contracts/app/easy_private_token_contract/Nargo.toml renamed to noir-projects/noir-contracts/contracts/app/private_token_contract/Nargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "easy_private_token_contract"
+name = "private_token_contract"
 authors = [""]
 compiler_version = ">=0.25.0"
 type = "contract"

…/easy_private_token_contract/src/main.nr …s/app/private_token_contract/src/main.nrnoir-projects/noir-contracts/contracts/app/easy_private_token_contract/src/main.nr renamed to noir-projects/noir-contracts/contracts/app/private_token_contract/src/main.nr noir-projects/noir-contracts/contracts/app/easy_private_token_contract/src/main.nr renamed to noir-projects/noir-contracts/contracts/app/private_token_contract/src/main.nr

@@ -1,8 +1,8 @@
-// docs:start:easy_private_token_contract
+// docs:start:private_token_contract
 use dep::aztec::macros::aztec;
 
 #[aztec]
-pub contract EasyPrivateToken {
+pub contract PrivateToken {
     use dep::aztec::macros::{functions::{initializer, private, utility}, storage::storage};
     use dep::aztec::{protocol_types::address::AztecAddress, state_vars::Map};
     use dep::easy_private_state::EasyPrivateUint;
@@ -46,4 +46,4 @@ pub contract EasyPrivateToken {
         storage.balances.at(owner).get_value()
     }
 }
-// docs:end:easy_private_token_contract
+// docs:end:private_token_contract

yarn-project/bot/src/bot.ts

@@ -1,6 +1,6 @@
 import { type AztecAddress, BatchCall, SentTx, type Wallet } from '@aztec/aztec.js';
 import { times } from '@aztec/foundation/collection';
-import type { EasyPrivateTokenContract } from '@aztec/noir-contracts.js/EasyPrivateToken';
+import type { PrivateTokenContract } from '@aztec/noir-contracts.js/PrivateToken';
 import type { TokenContract } from '@aztec/noir-contracts.js/Token';
 import type { AztecNode, AztecNodeAdmin, PXE } from '@aztec/stdlib/interfaces/client';
 
@@ -16,7 +16,7 @@ export class Bot extends BaseBot {
     pxe: PXE,
     wallet: Wallet,
     defaultAccountAddress: AztecAddress,
-    public readonly token: TokenContract | EasyPrivateTokenContract,
+    public readonly token: TokenContract | PrivateTokenContract,
     public readonly recipient: AztecAddress,
     config: BotConfig,
   ) {

yarn-project/bot/src/config.ts

@@ -22,7 +22,7 @@ type BotFollowChain = (typeof BotFollowChain)[number];
 
 export enum SupportedTokenContracts {
   TokenContract = 'TokenContract',
-  EasyPrivateTokenContract = 'EasyPrivateTokenContract',
+  PrivateTokenContract = 'PrivateTokenContract',
 }
 
 export type BotConfig = {

yarn-project/bot/src/factory.ts

@@ -19,7 +19,7 @@ import { createEthereumChain, createExtendedL1Client } from '@aztec/ethereum';
 import { Fr } from '@aztec/foundation/fields';
 import { Timer } from '@aztec/foundation/timer';
 import { AMMContract } from '@aztec/noir-contracts.js/AMM';
-import { EasyPrivateTokenContract } from '@aztec/noir-contracts.js/EasyPrivateToken';
+import { PrivateTokenContract } from '@aztec/noir-contracts.js/PrivateToken';
 import { TokenContract } from '@aztec/noir-contracts.js/Token';
 import type { AztecNode, AztecNodeAdmin } from '@aztec/stdlib/interfaces/client';
 import { deriveSigningKey } from '@aztec/stdlib/keys';
@@ -189,20 +189,17 @@ export class BotFactory {
    * @param wallet - Wallet to deploy the token contract from.
    * @returns The TokenContract instance.
    */
-  private async setupToken(
-    wallet: AccountWallet,
-    sender: AztecAddress,
-  ): Promise<TokenContract | EasyPrivateTokenContract> {
-    let deploy: DeployMethod<TokenContract | EasyPrivateTokenContract>;
+  private async setupToken(wallet: AccountWallet, sender: AztecAddress): Promise<TokenContract | PrivateTokenContract> {
+    let deploy: DeployMethod<TokenContract | PrivateTokenContract>;
     const deployOpts: DeployOptions = {
       from: sender,
       contractAddressSalt: this.config.tokenSalt,
       universalDeploy: true,
     };
     if (this.config.contract === SupportedTokenContracts.TokenContract) {
       deploy = TokenContract.deploy(wallet, sender, 'BotToken', 'BOT', 18);
-    } else if (this.config.contract === SupportedTokenContracts.EasyPrivateTokenContract) {
-      deploy = EasyPrivateTokenContract.deploy(wallet, MINT_BALANCE, sender);
+    } else if (this.config.contract === SupportedTokenContracts.PrivateTokenContract) {
+      deploy = PrivateTokenContract.deploy(wallet, MINT_BALANCE, sender);
       deployOpts.skipInstancePublication = true;
       deployOpts.skipClassPublication = true;
       deployOpts.skipInitialization = false;
@@ -358,7 +355,7 @@ export class BotFactory {
    * Mints private and public tokens for the sender if their balance is below the minimum.
    * @param token - Token contract.
    */
-  private async mintTokens(token: TokenContract | EasyPrivateTokenContract, minter: AztecAddress) {
+  private async mintTokens(token: TokenContract | PrivateTokenContract, minter: AztecAddress) {
     const isStandardToken = isStandardTokenContract(token);
     let privateBalance = 0n;
     let publicBalance = 0n;

yarn-project/bot/src/utils.ts

@@ -1,6 +1,6 @@
 import type { ContractBase } from '@aztec/aztec.js';
 import type { AMMContract } from '@aztec/noir-contracts.js/AMM';
-import type { EasyPrivateTokenContract } from '@aztec/noir-contracts.js/EasyPrivateToken';
+import type { PrivateTokenContract } from '@aztec/noir-contracts.js/PrivateToken';
 import type { TokenContract } from '@aztec/noir-contracts.js/Token';
 import type { AztecAddress } from '@aztec/stdlib/aztec-address';
 
@@ -19,7 +19,7 @@ export async function getBalances(
   return { privateBalance, publicBalance };
 }
 
-export async function getPrivateBalance(token: EasyPrivateTokenContract, who: AztecAddress): Promise<bigint> {
+export async function getPrivateBalance(token: PrivateTokenContract, who: AztecAddress): Promise<bigint> {
   const privateBalance = await token.methods.get_balance(who).simulate({ from: who });
   return privateBalance;
 }

yarn-project/end-to-end/src/e2e_bot.test.ts

@@ -58,11 +58,11 @@ describe('e2e_bot', () => {
       expect(bot2.recipient.toString()).toEqual(recipient.toString());
     });
 
-    it('sends token from the bot using EasyPrivateToken', async () => {
+    it('sends token from the bot using PrivateToken', async () => {
       const easyBot = await Bot.create(
         {
           ...config,
-          contract: SupportedTokenContracts.EasyPrivateTokenContract,
+          contract: SupportedTokenContracts.PrivateTokenContract,
         },
         { pxe },
       );

yarn-project/end-to-end/src/e2e_public_testnet/e2e_public_testnet_transfer.test.ts

@@ -1,5 +1,5 @@
 import type { AccountWalletWithSecretKey, AztecAddress, Logger } from '@aztec/aztec.js';
-import { EasyPrivateTokenContract } from '@aztec/noir-contracts.js/EasyPrivateToken';
+import { PrivateTokenContract } from '@aztec/noir-contracts.js/PrivateToken';
 
 import { foundry, sepolia } from 'viem/chains';
 
@@ -47,7 +47,7 @@ describe(`deploys and transfers a private only token`, () => {
     const initialBalance = 100_000_000_000n;
     const transferValue = 5n;
 
-    const token = await EasyPrivateTokenContract.deploy(deployerWallet, initialBalance, deployerAddress)
+    const token = await PrivateTokenContract.deploy(deployerWallet, initialBalance, deployerAddress)
       .send({
         from: deployerAddress,
         universalDeploy: true,