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

chore(docs): starting a migration notes section #3853

Merged
merged 5 commits into from
Jan 8, 2024
Merged
Show file tree
Hide file tree
Changes from 4 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
55 changes: 55 additions & 0 deletions docs/docs/misc/migration_notes.md
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
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
## New `@aztec/accounts` package
### 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"
```
22 changes: 9 additions & 13 deletions docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,7 @@ const sidebars = {
type: "doc",
id: "concepts/foundation/state_model/main",
},
items: [
"concepts/foundation/state_model/storage_slots"
]
items: ["concepts/foundation/state_model/storage_slots"],
},
{
label: "Accounts",
Expand Down Expand Up @@ -113,8 +111,8 @@ const sidebars = {
id: "concepts/foundation/communication/public_private_calls/main",
},
items: [
"concepts/foundation/communication/public_private_calls/slow_updates_tree"
]
"concepts/foundation/communication/public_private_calls/slow_updates_tree",
],
},
"concepts/foundation/communication/cross_chain_calls",
],
Expand Down Expand Up @@ -324,9 +322,7 @@ const sidebars = {
type: "doc",
id: "dev_docs/contracts/syntax/storage/main",
},
items: [
"dev_docs/contracts/syntax/storage/storage_slots",
]
items: ["dev_docs/contracts/syntax/storage/storage_slots"],
},
"dev_docs/contracts/syntax/events",
"dev_docs/contracts/syntax/functions",
Expand Down Expand Up @@ -361,10 +357,10 @@ const sidebars = {
{
label: "Common Patterns",
type: "category",
link: {
type: "doc",
id: "dev_docs/contracts/resources/common_patterns/main",
},
link: {
type: "doc",
id: "dev_docs/contracts/resources/common_patterns/main",
},
items: [
"dev_docs/contracts/resources/common_patterns/authwit",
// "dev_docs/contracts/resources/common_patterns/sending_tokens_to_user",
Expand Down Expand Up @@ -478,7 +474,7 @@ const sidebars = {
value: "Miscellaneous",
defaultStyle: true,
},

"misc/migration_notes",
"misc/glossary",

{
Expand Down