Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: logging deployed contract address to help debug e2e account test #5571

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion yarn-project/aztec.js/src/contract/deploy_method.ts
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,11 @@ 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.pxe, txHashPromise, this.postDeployCtor, this.getInstance(options));
const instance = this.getInstance(options);
this.log(
`Sent deployment tx of ${this.artifact.name} contract with deployment address ${instance.address.toString()}`,
);
return new DeploySentTx(this.pxe, txHashPromise, this.postDeployCtor, instance);
}

/**
Expand Down
4 changes: 4 additions & 0 deletions yarn-project/aztec.js/src/contract/deploy_sent_tx.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { type PXE, type TxHash, type TxReceipt } from '@aztec/circuit-types';
import { type AztecAddress } from '@aztec/circuits.js';
import { createDebugLogger } from '@aztec/foundation/log';
import { type FieldsOf } from '@aztec/foundation/types';
import { type ContractInstanceWithAddress } from '@aztec/types/contracts';

Expand All @@ -24,6 +25,8 @@ 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 {
private log = createDebugLogger('aztec:js:deploy_sent_tx');

constructor(
wallet: PXE | Wallet,
txHashPromise: Promise<TxHash>,
Expand All @@ -41,6 +44,7 @@ export class DeploySentTx<TContract extends Contract = Contract> extends SentTx
*/
public async deployed(opts?: DeployedWaitOpts): Promise<TContract> {
const receipt = await this.wait(opts);
this.log(`Contract ${this.instance.address.toString()} successfully deployed.`);
return receipt.contract;
}

Expand Down
16 changes: 9 additions & 7 deletions yarn-project/end-to-end/src/e2e_account_contracts.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import {
AccountManager,
AccountWallet,
type CompleteAddress,
type DebugLogger,
Fr,
type GrumpkinPrivateKey,
GrumpkinScalar,
Expand All @@ -27,29 +28,30 @@ function itShouldBehaveLikeAnAccountContract(
walletAt: (pxe: PXE, accountContract: AccountContract, address: CompleteAddress) => Promise<Wallet>,
) {
describe(`behaves like an account contract`, () => {
let context: Awaited<ReturnType<typeof setup>>;
let child: ChildContract;
let wallet: Wallet;
let encryptionPrivateKey: GrumpkinPrivateKey;

let pxe: PXE;
let logger: DebugLogger;
let teardown: () => Promise<void>;

beforeEach(async () => {
context = await setup(0);
({ logger, pxe, teardown } = await setup(0));
encryptionPrivateKey = GrumpkinScalar.random();

wallet = await walletSetup(context.pxe, encryptionPrivateKey, getAccountContract(encryptionPrivateKey));
wallet = await walletSetup(pxe, encryptionPrivateKey, getAccountContract(encryptionPrivateKey));
child = await ChildContract.deploy(wallet).send().deployed();
}, 60_000);

afterEach(() => context.teardown());
afterEach(() => teardown());

it('calls a private function', async () => {
const { logger } = context;
logger('Calling private function...');
await child.methods.value(42).send().wait({ interval: 0.1 });
}, 60_000);

it('calls a public function', async () => {
const { logger, pxe } = context;
logger('Calling public function...');
await child.methods.pub_inc_value(42).send().wait({ interval: 0.1 });
const storedValue = await pxe.getPublicStorageAt(child.address, new Fr(1));
Expand All @@ -58,7 +60,7 @@ function itShouldBehaveLikeAnAccountContract(

it('fails to call a function using an invalid signature', async () => {
const accountAddress = wallet.getCompleteAddress();
const invalidWallet = await walletAt(context.pxe, getAccountContract(GrumpkinScalar.random()), accountAddress);
const invalidWallet = await walletAt(pxe, getAccountContract(GrumpkinScalar.random()), accountAddress);
const childWithInvalidWallet = await ChildContract.at(child.address, invalidWallet);
await expect(childWithInvalidWallet.methods.value(42).prove()).rejects.toThrow(/Cannot satisfy constraint.*/);
});
Expand Down
Loading