Skip to content

feat: updated emit_unencrypted_log with contract address and topic #2582

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.

Sign up for GitHub

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

Closed
benesjan wants to merge 2 commits into from
Closed

feat: updated emit_unencrypted_log with contract address and topic #2582

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2e6623b
feat: updated emit_unencrypted_log with contract address and topic
benesjan Sep 28, 2023
dc44463
WIP
benesjan Sep 28, 2023
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
8 changes: 6 additions & 2 deletions yarn-project/acir-simulator/src/acvm/oracle/oracle.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,10 +163,14 @@ export class Oracle {
return toACVMField(0);
}

emitUnencryptedLog(message: ACVMField[]): ACVMField {
emitUnencryptedLog([contractAddress]: ACVMField[], [eventSelector]: ACVMField[], message: ACVMField[]): ACVMField {
// https://github.com/AztecProtocol/aztec-packages/issues/885
const log = Buffer.concat(message.map(charBuffer => convertACVMFieldToBuffer(charBuffer).subarray(-1)));
this.typedOracle.emitUnencryptedLog(log);
this.typedOracle.emitUnencryptedLog(
AztecAddress.fromString(contractAddress),
FunctionSelector.fromField(fromACVMField(eventSelector)), // TODO: should we rename FunctionSelector to Selector?
log,
);
return toACVMField(0);
}

Expand Down
2 changes: 1 addition & 1 deletion yarn-project/acir-simulator/src/acvm/oracle/typed_oracle.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ export abstract class TypedOracle {
throw new Error('Not available.');
}

emitUnencryptedLog(_log: Buffer): void {
emitUnencryptedLog(_contractAddress: AztecAddress, _eventSelector: FunctionSelector, _log: Buffer): void {
throw new Error('Not available.');
}

Expand Down
5 changes: 4 additions & 1 deletion yarn-project/acir-simulator/src/client/client_execution_context.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -333,9 +333,12 @@ export class ClientExecutionContext extends ViewDataOracle {

/**
* Emit an unencrypted log.
* @param contractAddress - The address of the contract emitting the log.
* @param eventSelector - The event selector of the log.
* @param log - The unencrypted log to be emitted.
*/
public emitUnencryptedLog(log: Buffer) {
public emitUnencryptedLog(contractAddress: AztecAddress, eventSelector: FunctionSelector, log: Buffer) {
// TODO: #2586, #2587
this.unencryptedLogs.push(log);
this.log(`Emitted unencrypted log: "${log.toString('ascii')}"`);
}
Expand Down
5 changes: 4 additions & 1 deletion yarn-project/acir-simulator/src/public/public_execution_context.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,10 +136,13 @@ export class PublicExecutionContext extends TypedOracle {

/**
* Emit an unencrypted log.
* @param contractAddress - The address of the contract emitting the log.
* @param eventSelector - The event selector of the log.
* @param log - The unencrypted log to be emitted.
*/
public emitUnencryptedLog(log: Buffer) {
public emitUnencryptedLog(contractAddress: AztecAddress, eventSelector: FunctionSelector, log: Buffer) {
// https://github.com/AztecProtocol/aztec-packages/issues/885
// TODO: #2586, #2587
this.unencryptedLogs.push(log);
this.log(`Emitted unencrypted log: "${log.toString('ascii')}"`);
}
Expand Down
22 changes: 19 additions & 3 deletions yarn-project/aztec-nr/aztec/src/log.nr
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
use crate::context::PrivateContext;
use crate::context::{PrivateContext, PublicContext};
use crate::oracle;
use crate::types::point::Point;

Expand All @@ -14,9 +14,25 @@ fn emit_encrypted_log<N>(
}

fn emit_unencrypted_log<T>(
context: &mut PublicContext,
log: T,
) {
let contract_address = context.this_address();
let event_selector = 5; // TODO: compute actual event selector.
let _ = oracle::logs::emit_unencrypted_log(contract_address, event_selector, log);
// context.accumulate_unencrypted_logs(log);
}

// TODO: We might want to remove this since emitting unencrypted logs from private functions is violating privacy.
// --> might be a better approach to force devs to make a public function call that emits the log if needed then
// it would be less easy to accidentally leak information.
// If we decide to keep this function around would make sense to wait for traits and then merge it with emit_unencrypted_log.
fn emit_unencrypted_log_from_private<T>(

@PhilWindle PhilWindle Sep 29, 2023

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you create this function so that it is easy to identify what to remove if we choose to do so?

@benesjan benesjan Sep 29, 2023 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was one of the reasons.

But the main one was that if I wanted to have 1 function for use in both private and public contexts I would have to use the Context wrapper and that seemed like too much of a boilerplate.

I would have to use:
emit_unencrypted_log(Context::public(&mut context), "Coins transferred");
Instead of:
emit_unencrypted_log(&mut context, "Coins transferred");

context: &mut PrivateContext,
log: T,
) {
let _ = oracle::logs::emit_unencrypted_log(log);
context.accumulate_unencrypted_logs(log);
let contract_address = context.this_address();
let event_selector = 5; // TODO: compute actual event selector.
let _ = oracle::logs::emit_unencrypted_log(contract_address, event_selector, log);
// context.accumulate_unencrypted_logs(log);
}
6 changes: 3 additions & 3 deletions yarn-project/aztec-nr/aztec/src/oracle/logs.nr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ unconstrained fn emit_encrypted_log<N>(
}

#[oracle(emitUnencryptedLog)]
fn emit_unencrypted_log_oracle<T>(_message: T) -> Field {}
fn emit_unencrypted_log_oracle<T>(_contract_address: Field, _event_selector: Field, _message: T) -> Field {}

unconstrained fn emit_unencrypted_log<T>(message: T) -> [Field; NUM_FIELDS_PER_SHA256] {
unconstrained fn emit_unencrypted_log<T>(contract_address: Field, event_selector: Field, message: T) -> [Field; NUM_FIELDS_PER_SHA256] {
// https://github.com/AztecProtocol/aztec-packages/issues/885
[emit_unencrypted_log_oracle(message), 0]
[emit_unencrypted_log_oracle(contract_address, event_selector, message), 0]
}
16 changes: 7 additions & 9 deletions yarn-project/noir-contracts/src/contracts/child_contract/src/main.nr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,8 @@ contract Child {
use dep::aztec::{
abi::CallContext,
context::{PrivateContext, PublicContext, Context},
oracle::{
logs::emit_unencrypted_log,
compute_selector::compute_selector,
},
oracle::compute_selector::compute_selector,
log::emit_unencrypted_log,
state_vars::public_state::PublicState,
types::type_serialization::field_serialization::{FieldSerializationMethods, FIELD_SERIALIZED_LEN},
};
Expand Down Expand Up @@ -67,7 +65,7 @@ contract Child {
fn pubSetValue(new_value: Field) -> Field {

storage.current_value.write(new_value);
let _hash = emit_unencrypted_log(new_value);
emit_unencrypted_log(&mut context, new_value);

new_value
}
Expand All @@ -78,7 +76,7 @@ contract Child {

let old_value = storage.current_value.read();
storage.current_value.write(old_value + new_value);
let _hash = emit_unencrypted_log(new_value);
emit_unencrypted_log(&mut context, new_value);

new_value
}
Expand All @@ -90,7 +88,7 @@ contract Child {
check_sender(inputs.call_context);
let old_value = storage.current_value.read();
storage.current_value.write(old_value + new_value);
let _hash = emit_unencrypted_log(new_value);
emit_unencrypted_log(&mut context, new_value);

new_value
}
Expand All @@ -102,14 +100,14 @@ contract Child {


storage.current_value.write(20);
let _hash = emit_unencrypted_log(20);
emit_unencrypted_log(&mut context, 20);
}

#[aztec(public)]
fn setValueTwiceWithNestedLast() {

storage.current_value.write(20);
let _hash = emit_unencrypted_log(20);
emit_unencrypted_log(&mut context, 20);

let pubSetValueSelector = compute_selector("pubSetValue(Field)");
let _ret = context.call_public_function(context.this_address(), pubSetValueSelector, [10]);
Expand Down
4 changes: 2 additions & 2 deletions yarn-project/noir-contracts/src/contracts/private_token_airdrop_contract/src/main.nr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ contract PrivateTokenAirdrop {
note_header::NoteHeader,
utils as note_utils,
},
log::emit_unencrypted_log,
log::emit_unencrypted_log_from_private,
};

use crate::claim_note::{ClaimNote, ClaimNoteMethods, CLAIM_NOTE_LEN};
Expand Down Expand Up @@ -220,7 +220,7 @@ contract PrivateTokenAirdrop {
// In this example, we emit the first output note's commitment to ensure that the unencrypted log
// for each call to this function is distinct. This is done to detect any issues while collecting
// logs when building a transaction. See: https://github.com/AztecProtocol/aztec-packages/issues/987
emit_unencrypted_log(&mut context, context.new_commitments.storage[0]);
emit_unencrypted_log_from_private(&mut context, context.new_commitments.storage[0]);
}

// Helper function to get the balance of a user ("unconstrained" is a Noir alternative of Solidity's "view" function).
Expand Down
6 changes: 3 additions & 3 deletions yarn-project/noir-contracts/src/contracts/public_token_contract/src/main.nr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ contract PublicToken {
use dep::std::option::Option;

// docs:start:unencrypted_import
use dep::aztec::oracle::logs::emit_unencrypted_log;
use dep::aztec::log::emit_unencrypted_log;
// docs:end:unencrypted_import

use dep::aztec::{
Expand Down Expand Up @@ -53,7 +53,7 @@ contract PublicToken {
let new_amount = recipient_balance.read() + amount;
// TODO: Remove return value.
// docs:start:unencrypted_log
let _hash = emit_unencrypted_log("Coins minted");
emit_unencrypted_log(&mut context, "Coins minted");
// docs:end:unencrypted_log
recipient_balance.write(new_amount);

Expand Down Expand Up @@ -81,7 +81,7 @@ contract PublicToken {
if (current_sender_balance as u126 > amount as u126) {
sender_balance.write(current_sender_balance - amount);
// TODO: Compiler complains if we don't assign the result of the write to anything
let _hash = emit_unencrypted_log("Coins transferred");
emit_unencrypted_log(&mut context, "Coins transferred");
let amount = current_recipient_balance + amount;
recipient_balance.write(amount);
return_value = amount;
Expand Down
8 changes: 4 additions & 4 deletions yarn-project/noir-contracts/src/contracts/test_contract/src/main.nr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ contract Test {
oracle::{
get_public_key::get_public_key,
context::get_portal_address,
rand::rand,
logs::emit_unencrypted_log
rand::rand
},
log::emit_unencrypted_log,
types::vec::BoundedVec,
constants_gen::EMPTY_NULLIFIED_COMMITMENT,
};
Expand Down Expand Up @@ -127,8 +127,8 @@ contract Test {
fn emit_unencrypted(
value: Field
) -> Field {
let _hash = emit_unencrypted_log(value);
_hash[0]
emit_unencrypted_log(&mut context, value);
0
}
// docs:end:emit_unencrypted_log

Expand Down