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.

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

Jump to bottom

feat(docs): Load current aztec version for aztec.nr dependencies in docs #2440

Merged
merged 3 commits into from
Sep 21, 2023
Merged

feat(docs): Load current aztec version for aztec.nr dependencies in docs #2440

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b38482b
feat(docs): Load current aztec version for aztec.nr
spalladino Sep 20, 2023
a1e3c09
Add missing import
spalladino Sep 20, 2023
927da92
Update rebuild patterns for docs
spalladino Sep 20, 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
17 changes: 9 additions & 8 deletions docs/docs/dev_docs/contracts/syntax/main.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,22 @@ Aztec.nr contains abstractions which remove the need to understand the low-level

To import Aztec.nr into your Aztec contract project, simply include it as a dependency. For example:

```toml
[package]
import { AztecPackagesVersion } from "@site/src/components/Version";

<CodeBlock language="toml">{`[package]
name = "token_contract"
authors = [""]
compiler_version = "0.1"
type = "contract"

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Fun fact: this whitespace is needed or it won't compile!

[dependencies]
# Framework import
aztec = { git="https://github.com/AztecProtocol/aztec-packages/", tag="master", directory="yarn-project/aztec-nr/aztec" }

aztec = { git="https://github.com/AztecProtocol/aztec-packages/", tag="${AztecPackagesVersion()}", directory="yarn-project/aztec-nr/aztec" }
# Utility dependencies
value_note = { git="https://github.com/AztecProtocol/aztec-packages/", tag="master", directory="yarn-project/aztec-nr/value-note"}
safe_math = { git="https://github.com/AztecProtocol/aztec-packages/", tag="master", directory="yarn-project/aztec-nr/safe-math"}
```
value_note = { git="https://github.com/AztecProtocol/aztec-packages/", tag="${AztecPackagesVersion()}", directory="yarn-project/aztec-nr/value-note"}
safe_math = { git="https://github.com/AztecProtocol/aztec-packages/", tag="${AztecPackagesVersion()}", directory="yarn-project/aztec-nr/safe-math"}
`}</CodeBlock>

:::info
Note: currently the dependency name ***MUST*** be `aztec`. The framework expects this namespace to be available when compiling into contracts. This limitation may be removed in the future.
Expand Down
13 changes: 7 additions & 6 deletions docs/docs/dev_docs/dapps/tutorials/contract_deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,13 @@ nargo new --contract token

Then, open the `contracts/token/Nargo.toml` configuration file, and add the `aztec.nr` and `value_note` libraries as dependencies:

```toml
[dependencies]
aztec = { git="https://github.com/AztecProtocol/aztec-nr", tag="master", directory="aztec" }
value_note = { git="https://github.com/AztecProtocol/aztec-nr", tag="master", directory="value-note" }
safe_math = { git="https://github.com/AztecProtocol/aztec-nr", tag="master", directory="safe-math" }
```
import { AztecPackagesVersion } from "@site/src/components/Version";

<CodeBlock language="toml">{`[dependencies]
aztec = { git="https://github.com/AztecProtocol/aztec-packages/", tag="${AztecPackagesVersion()}", directory="yarn-project/aztec-nr/aztec" }
value_note = { git="https://github.com/AztecProtocol/aztec-packages/", tag="${AztecPackagesVersion()}", directory="yarn-project/aztec-nr/value-note"}
safe_math = { git="https://github.com/AztecProtocol/aztec-packages/", tag="${AztecPackagesVersion()}", directory="yarn-project/aztec-nr/safe-math"}
`}</CodeBlock>

Last, copy-paste the code from the `Token` contract into `contracts/token/main.nr`:

Expand Down
9 changes: 5 additions & 4 deletions docs/docs/dev_docs/getting_started/noir_contracts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,16 +59,17 @@ Before writing the contracts, we must add the aztec.nr library. This adds smart

3. Add aztec.nr library as a dependency to your noir project. Open Nargo.toml that is in the `contracts/example_contract` folder, and add the dependency section as follows:

```
[package]
import { AztecPackagesVersion } from "@site/src/components/Version";

<CodeBlock language="toml">{`[package]
name = "example_contract"
authors = [""]
compiler_version = "0.1"
type = "contract"
[dependencies]
aztec = { git="https://github.com/AztecProtocol/aztec-packages/", tag="master", directory="yarn-project/aztec-nr/aztec" }
```
`}</CodeBlock>

:::note
You may need to update your dependencies depending on the contract that you are writing. For example, the token contract [imports more](../getting_started/token_contract_tutorial#project-setup).
Expand Down
15 changes: 8 additions & 7 deletions docs/docs/dev_docs/getting_started/token_contract_tutorial.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,18 +80,19 @@ Your project should look like this:

Add the following dependencies to your Nargo.toml file, below the package information:

```toml
[package]
import { AztecPackagesVersion } from "@site/src/components/Version";

<CodeBlock language="toml">{`[package]
name = "token_contract"
authors = [""]
compiler_version = "0.1"
type = "contract"

[dependencies]
aztec = { git="https://github.com/AztecProtocol/aztec-packages/", tag="master", directory="yarn-project/aztec-nr/aztec" }
value_note = { git="https://github.com/AztecProtocol/aztec-packages/", tag="master", directory="yarn-project/aztec-nr/value-note"}
safe_math = { git="https://github.com/AztecProtocol/aztec-packages/", tag="master", directory="yarn-project/aztec-nr/safe-math"}
```
aztec = { git="https://github.com/AztecProtocol/aztec-packages/", tag="${AztecPackagesVersion()}", directory="yarn-project/aztec-nr/aztec" }
value_note = { git="https://github.com/AztecProtocol/aztec-packages/", tag="${AztecPackagesVersion()}", directory="yarn-project/aztec-nr/value-note"}
safe_math = { git="https://github.com/AztecProtocol/aztec-packages/", tag="${AztecPackagesVersion()}", directory="yarn-project/aztec-nr/safe-math"}
`}</CodeBlock>

## Contract Interface

Expand Down
23 changes: 22 additions & 1 deletion docs/docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,17 @@ const config = {
const noirVersion = JSON.parse(
fs.readFileSync(noirVersionPath).toString()
).tag;
return { noir: noirVersion };
const aztecVersionPath = path.resolve(
__dirname,
"../.release-please-manifest.json"
);
const aztecVersion = JSON.parse(
fs.readFileSync(aztecVersionPath).toString()
)["."];
return {
noir: noirVersion,
"aztec-packages": `aztec-packages-v${aztecVersion}`,
};
} catch (err) {
throw new Error(
`Error loading Noir version from noir-compiler in docusaurus build. Check load-versions in docusaurus.config.js.\n${err}`
Expand Down Expand Up @@ -236,6 +246,17 @@ const config = {
className: "code-block-error-line",
line: "this-will-error",
},
// This could be used to have release-please modify the current version in code blocks.
// However doing so requires to manually add each md file to release-please-config.json/extra-files
// which is easy to forget an error prone, so instead we rely on the AztecPackagesVersion() function.
{
line: "x-release-please-version",
block: {
start: "x-release-please-start-version",
end: "x-release-please-end",
},
className: "not-allowed-to-be-empty",
},
],
},
}),
Expand Down
1 change: 1 addition & 0 deletions docs/src/components/Version/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ export default function Version({ what }) {
}

export const NoirVersion = () => Versions()["noir"];
export const AztecPackagesVersion = () => Versions()["aztec-packages"];
1 change: 1 addition & 0 deletions docs/src/theme/MDXComponents.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ export default {
...MDXComponents,
Version,
NoirVersion,
AztecPackagesVersion,
InstallNargoInstructions,
CodeBlock,
};