-
Notifications
You must be signed in to change notification settings - Fork 333
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
chore(docs): starting a migration notes section #3853
Merged
Merged
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
cadb3f3
chore(docs): starting a migration notes section
signorecello e905435
add migration notes
critesjosh f43b60f
consistent formatting
critesjosh f077b89
chore(docs): adding another breaking change from #3844, thanks Palla
signorecello dd0162f
add more migration notes
rahul-kothari File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
--- | ||
title: Migration notes | ||
description: Read about migration notes from previous versions, which could solve problems while updating | ||
keywords: [sandbox, cli, aztec, notes, migration, updating, upgrading] | ||
--- | ||
|
||
Aztec is in full-speed development. Literally every version breaks compatibility with the previous ones. This page attempts to target errors and difficulties you might encounter when upgrading, and how to resolve them. | ||
|
||
## ≥0.17 | ||
|
||
### Importing contracts in JS | ||
|
||
Contracts are now imported from a file with the type's name. | ||
|
||
For example: | ||
|
||
```js | ||
import { TokenContract } from "@aztec/noir-contracts/Token"; | ||
``` | ||
|
||
instead of | ||
|
||
```js | ||
import { TokenContract } from "@aztec/noir-contracts/types"; | ||
``` | ||
|
||
### Importing contracts in Nargo.toml | ||
|
||
Aztec contracts are now moved outside of the `src` folder, so you need to update your imports. | ||
|
||
For example, for `easy_private_token_contract`, you'd import them like this: | ||
|
||
```rust | ||
easy_private_token_contract = {git = "https://github.com/AztecProtocol/aztec-packages/", tag ="v0.16.9", directory = "yarn-project/noir-contracts/src/contracts/easy_private_token_contract"} | ||
``` | ||
|
||
Now, just remove the `src` folder, as such: | ||
|
||
```rust | ||
easy_private_token_contract = {git = "https://github.com/AztecProtocol/aztec-packages/", tag ="v0.17.0", directory = "yarn-project/noir-contracts/contracts/easy_private_token_contract"} | ||
``` | ||
|
||
## New `@aztec/accounts` package | ||
|
||
When previously you would get the default accounts using the `getAccount` method from the `aztec.js` package: | ||
|
||
```js | ||
import { getSchnorrAccount } from "@aztec/aztec.js" | ||
``` | ||
|
||
You should now import them from the new package `@aztec/accounts` | ||
|
||
```js | ||
import { getSchnorrAccount } from "@aztec/accounts" | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.