-
Notifications
You must be signed in to change notification settings - Fork 266
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
fix: Update aztec sandbox getting started markdown #2374
Conversation
@@ -107,6 +99,7 @@ describe('e2e_sandbox_example', () => { | |||
// Create the contract abstraction and link to Alice's wallet for future signing | |||
const tokenContractAlice = await TokenContract.at(contract.address, await accounts[0].getWallet()); | |||
|
|||
// Initialize the contract and add Bob as a minter |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would it be cleaner to use withWallet()
on tokenContract
instead of what this file does here (instantiating tokenContract twice (for Alice and Bob each)?
@@ -180,6 +180,7 @@ contract Token { | |||
1 | |||
} | |||
|
|||
// docs:start:transfer | |||
#[aztec(public)] | |||
fn transfer_public( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
getting started talks about sending tokens privately. Looks like here we are showing the public transfer though?
buffer: <Buffer cf 7e d3 ac ca 5a 46 7e 9e 70 4c 70 3e 8d 87 f6 34 fb 0f c9> | ||
}, | ||
client: '[email protected]', | ||
compatibleNargoVersion: '0.11.1-aztec.0' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we want this to be fixed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not really. Would want it to be depending on the tests, but not sure what the best way is for that right now and just wanted it fixed in this case as people need it shortly
1. The sender. | ||
2. The recipient. | ||
3. The quantity of tokens to be transferred. | ||
4. The nonce for the AuthWit, or 0 if msg.sender equal sender. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remember to link to AuthWit docs if there are any, or use the full Auth Witness, this is a tutorial and i have no context to what this is yet
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Expanded it for authentication witness and added a link.
🤖 I have created a release *beep* *boop* --- <details><summary>aztec-packages: 0.7.8</summary> ## [0.7.8](aztec-packages-v0.7.7...aztec-packages-v0.7.8) (2023-09-19) ### Features * `NodeInfo` cleanup ([#2370](#2370)) ([89fe978](89fe978)) * Allow custom ports in sandbox ([#2393](#2393)) ([41ef378](41ef378)) * Allow tracing build system with [debug ci] ([#2389](#2389)) ([ce311a9](ce311a9)) * **docs:** Show current noir version for aztec in docs ([#2379](#2379)) ([5c7b2ab](5c7b2ab)) ### Bug Fixes * Build script exiting on failed grep ([#2384](#2384)) ([e70a781](e70a781)) * Bump e2e_sandbox_example.test.ts timeout ([#2391](#2391)) ([9a1bb62](9a1bb62)) * Compile script for the unboxed project ([#2380](#2380)) ([2801da2](2801da2)) * Force_deploy_build error ([#2375](#2375)) ([4d1cbf9](4d1cbf9)) * Update aztec sandbox getting started markdown ([#2374](#2374)) ([a3c6bcf](a3c6bcf)) ### Miscellaneous * Adds on-brand design to private token project ([#2355](#2355)) ([072e313](072e313)) * Docs restructure ([#2322](#2322)) ([1368b55](1368b55)) ### Documentation * Updated noirup command ([#2339](#2339)) ([5308c21](5308c21)) </details> <details><summary>barretenberg.js: 0.7.8</summary> ## [0.7.8](barretenberg.js-v0.7.7...barretenberg.js-v0.7.8) (2023-09-19) ### Miscellaneous * **barretenberg.js:** Synchronize aztec-packages versions </details> <details><summary>barretenberg: 0.7.8</summary> ## [0.7.8](barretenberg-v0.7.7...barretenberg-v0.7.8) (2023-09-19) ### Features * Allow tracing build system with [debug ci] ([#2389](#2389)) ([ce311a9](ce311a9)) </details> --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
Half the snippets were stale or pointing to wrong files.
Checklist:
Remove the checklist to signal you've completed it. Enable auto-merge if the PR is ready to merge.