Skip to content

chore: Added docs for artifact files#2362

Merged
sirasistant merged 5 commits into
masterfrom
arv/docs_artifacts
Sep 18, 2023
Merged

chore: Added docs for artifact files#2362
sirasistant merged 5 commits into
masterfrom
arv/docs_artifacts

Conversation

@sirasistant

@sirasistant sirasistant commented Sep 18, 2023

Copy link
Copy Markdown
Contributor

Resolves #2190

Checklist:

Remove the checklist to signal you've completed it. Enable auto-merge if the PR is ready to merge.

  • If the pull request requires a cryptography review (e.g. cryptographic algorithm implementations) I have added the 'crypto' tag.
  • I have reviewed my diff in github, line by line and removed unexpected formatting changes, testing logs, or commented-out code.
  • Every change is related to the PR description.
  • I have linked this pull request to relevant issues (if any exist).

- Open: The function is ran and proved by the sequencer, and its bytecode is published to the network.
- Unconstrained: The function is ran locally by the clients to generate digested information useful for the user. It's not meant to be transacted against.

#### Internal Flag

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can we make the titles the same as the keys in the artifact? Will be easier to find the description :)

@sirasistant sirasistant merged commit 6d3ba3f into master Sep 18, 2023
@sirasistant sirasistant deleted the arv/docs_artifacts branch September 18, 2023 12:40
spypsy pushed a commit that referenced this pull request Sep 18, 2023
🤖 I have created a release *beep* *boop*
---


<details><summary>aztec-packages: 0.7.6</summary>

##
[0.7.6](aztec-packages-v0.7.5...aztec-packages-v0.7.6)
(2023-09-18)


### Features

* New api to get note nonces
([#2327](#2327))
([8f5eb28](8f5eb28))
* Replace private token in testing
([#2304](#2304))
([934ba96](934ba96))


### Bug Fixes

* Exit with error log when COMMIT_TAG is not set properly on canary
([#2371](#2371))
([68fe053](68fe053))
* Preserve public function call ordering in account entrypoint
([#2348](#2348))
([5b2cf75](5b2cf75))
* Return output-debug flag
([#2364](#2364))
([af86580](af86580))
* Revert "fix: strip leading 'v' from dockerhub tags"
([#2367](#2367))
([53bc041](53bc041))
* Stale CLI docs
([#2336](#2336))
([f38873b](f38873b))
* Strip leading 'v' from dockerhub tags
([#2360](#2360))
([a4bb05c](a4bb05c))


### Miscellaneous

* Added docs for artifact files
([#2362](#2362))
([6d3ba3f](6d3ba3f)),
closes
[#2190](#2190)
* **aztec_noir:** Remove inputs from consume l1 to l2 message
([#2354](#2354))
([2235f7c](2235f7c))
* Remove "as unknown" casts for ABIs where possible
([#2331](#2331))
([bf2651e](bf2651e))
* Script to extract tag version
([#2368](#2368))
([4b686b0](4b686b0))
* Share e2e code with canary
([#2299](#2299))
([21224de](21224de))
</details>

<details><summary>barretenberg.js: 0.7.6</summary>

##
[0.7.6](barretenberg.js-v0.7.5...barretenberg.js-v0.7.6)
(2023-09-18)


### Miscellaneous

* **barretenberg.js:** Synchronize aztec-packages versions
</details>

<details><summary>barretenberg: 0.7.6</summary>

##
[0.7.6](barretenberg-v0.7.5...barretenberg-v0.7.6)
(2023-09-18)


### Miscellaneous

* **barretenberg:** Synchronize aztec-packages versions
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

No open projects
Archived in project

Development

Successfully merging this pull request may close these issues.

docs/dev-docs/contracts/artifacts <-- explain the artifacts json file

2 participants