Skip to content

docs: initial keys spec#3035

Merged
iAmMichaelConnor merged 3 commits intomasterfrom
mc/initial-keys-spec
Oct 27, 2023
Merged

docs: initial keys spec#3035
iAmMichaelConnor merged 3 commits intomasterfrom
mc/initial-keys-spec

Conversation

@iAmMichaelConnor
Copy link
Contributor

@iAmMichaelConnor iAmMichaelConnor commented Oct 25, 2023 •
edited
Loading

Initial keys requirements and draft spec which attempts to meet those requirements (with some open questions).

It's not a polished doc, yet. It's a WIP that can be iterated on in the coming weeks.

Important Note

You should definitely read the rendered version of this. Unfortunately, docusaurus uses KaTeX, but vscode/github use something like MathJax, and they're annoyingly incompatible, in terms of the syntax I need to write. It's docusaurus that's the odd one out here. My latex vscode plugin/hackmd/github are all able to render one type of syntax, but I had to modify the latex all over the place to render it in a docusaurus page. So if you try to read it any other way, it'll be borked.

So view this thing using docusaurus, in your browser.:
cd yellow-paper
yarn
yarn start:dev (if on the mainframe)
Go to localhost:3000

@iAmMichaelConnor iAmMichaelConnor added the A-documentation Area: relates to documentation label Oct 25, 2023
spalladino
spalladino reviewed Oct 25, 2023
View reviewed changes
Copy link
Contributor

@spalladino spalladino left a comment

Choose a reason for hiding this comment

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

Got through the requirements for now, and ran away scared when I saw the math. I'll go back to it tomorrow!

@iAmMichaelConnor iAmMichaelConnor enabled auto-merge (squash) October 27, 2023 09:13
@iAmMichaelConnor iAmMichaelConnor merged commit 4b24c58 into master Oct 27, 2023
@iAmMichaelConnor iAmMichaelConnor deleted the mc/initial-keys-spec branch October 27, 2023 09:18
@AztecBot AztecBot mentioned this pull request Oct 27, 2023
Merged
rahul-kothari pushed a commit that referenced this pull request Oct 31, 2023
@AztecBot
chore(master): Release 0.13.0 (#3067)
0c0b975 
🤖 I have created a release *beep* *boop*
---


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

##
[0.13.0](aztec-packages-v0.12.0...aztec-packages-v0.13.0)
(2023-10-31)


### ⚠ BREAKING CHANGES

* PXE.getNotes(...) + refactor of note types
([#3051](#3051))

### Features

* `FieldNote`
([#3037](#3037))
([3d1ffd0](3d1ffd0))
* Add Aztec Boxes page to docs
([#2569](#2569))
([997c15c](997c15c))
* Adding structure to Transcript
([#2937](#2937))
([db67aa1](db67aa1))
* Compile noir contracts with noir_wasm
([#2737](#2737))
([524cecf](524cecf))
* Dockerize aztec-cli
([#3031](#3031))
([ec2e3c2](ec2e3c2))
* Efficient ZM quotient computation
([#3016](#3016))
([ebda5fc](ebda5fc))
* **feature_branch:** Private Kernel Circuit
([#2740](#2740))
([f800a36](f800a36))
* Measure plonk rounds
([#3065](#3065))
([c8e1d8b](c8e1d8b))
* Migrate the init kernel CPP tests to noir
([#3091](#3091))
([906429f](906429f))
* New script to output table of benchmarks for README pasting.
([#2780](#2780))
([6c20b45](6c20b45))
* Pedersen in typescript.
([#3111](#3111))
([933f1b2](933f1b2))
* Protogalaxy folding of challenges
([#2935](#2935))
([7ed30e8](7ed30e8))
* PXE.getNotes(...) + refactor of note types
([#3051](#3051))
([16abb5a](16abb5a))
* Zeromorph with concatenation (Goblin Translator part 10)
([#3006](#3006))
([70b0f17](70b0f17))


### Bug Fixes

* Bad contract txs publishing contract data
([#2673](#2673))
([ccd4611](ccd4611))
* Better error message for compute_note_hash_and_nullifier.
([#3097](#3097))
([57bec53](57bec53))
* Broken `FieldNote` test
([#3135](#3135))
([fe78ecf](fe78ecf))
* Docker-compose up, rather than run.
([#3081](#3081))
([242f780](242f780))
* Formatting
([#3070](#3070))
([e1633d3](e1633d3))
* Minor stale naming fix
([#3117](#3117))
([a6786ae](a6786ae))
* Push cli docker image to docker hub
([#3120](#3120))
([ccad50f](ccad50f))
* Remove duplicate terraform resource definition
([#3066](#3066))
([d5abadb](d5abadb))
* Retry request spot
([#3116](#3116))
([82de5f1](82de5f1))


### Miscellaneous

* Add stdlib tests for pedersen commitment
([#3075](#3075))
([87fa621](87fa621))
* Automatic c_binds for commit should return a point instead of an Fr
element
([#3072](#3072))
([2e289a5](2e289a5))
* Cleanup remaining mentions of `compress` with pedersen in cpp and ts
([#3074](#3074))
([52cf383](52cf383))
* E2e on spots [ci rebuild]
([#3068](#3068))
([15db6bf](15db6bf))
* Fix dapp_testing e2e race condition
([#3094](#3094))
([89e7c21](89e7c21))
* Remove docs mirror
([#3122](#3122))
([3fa51e2](3fa51e2))
* Remove endomorphism coefficient from ecc_add_gate
([#3115](#3115))
([d294987](d294987))
* Remove unecessary calls to `pedersen__init`
([#3079](#3079))
([84f8db2](84f8db2))
* Remove unused pedersen c_binds
([#3058](#3058))
([e71e5f9](e71e5f9))
* Removes pedersen commit native pairs method
([#3073](#3073))
([69a34c7](69a34c7))
* Rename private-kernel subpackage to protocol-circuits
([#3134](#3134))
([3e07104](3e07104))


### Documentation

* Initial keys spec
([#3035](#3035))
([4b24c58](4b24c58))
</details>

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

##
[0.13.0](barretenberg.js-v0.12.0...barretenberg.js-v0.13.0)
(2023-10-31)


### Features

* New script to output table of benchmarks for README pasting.
([#2780](#2780))
([6c20b45](6c20b45))


### Miscellaneous

* Automatic c_binds for commit should return a point instead of an Fr
element
([#3072](#3072))
([2e289a5](2e289a5))
* Remove unecessary calls to `pedersen__init`
([#3079](#3079))
([84f8db2](84f8db2))
* Remove unused pedersen c_binds
([#3058](#3058))
([e71e5f9](e71e5f9))
</details>

<details><summary>barretenberg: 0.13.0</summary>

##
[0.13.0](barretenberg-v0.12.0...barretenberg-v0.13.0)
(2023-10-31)


### Features

* Adding structure to Transcript
([#2937](#2937))
([db67aa1](db67aa1))
* Efficient ZM quotient computation
([#3016](#3016))
([ebda5fc](ebda5fc))
* Measure plonk rounds
([#3065](#3065))
([c8e1d8b](c8e1d8b))
* New script to output table of benchmarks for README pasting.
([#2780](#2780))
([6c20b45](6c20b45))
* Pedersen in typescript.
([#3111](#3111))
([933f1b2](933f1b2))
* Protogalaxy folding of challenges
([#2935](#2935))
([7ed30e8](7ed30e8))
* Zeromorph with concatenation (Goblin Translator part 10)
([#3006](#3006))
([70b0f17](70b0f17))


### Miscellaneous

* Add stdlib tests for pedersen commitment
([#3075](#3075))
([87fa621](87fa621))
* Automatic c_binds for commit should return a point instead of an Fr
element
([#3072](#3072))
([2e289a5](2e289a5))
* Cleanup remaining mentions of `compress` with pedersen in cpp and ts
([#3074](#3074))
([52cf383](52cf383))
* Remove endomorphism coefficient from ecc_add_gate
([#3115](#3115))
([d294987](d294987))
* Remove unecessary calls to `pedersen__init`
([#3079](#3079))
([84f8db2](84f8db2))
* Remove unused pedersen c_binds
([#3058](#3058))
([e71e5f9](e71e5f9))
* Removes pedersen commit native pairs method
([#3073](#3073))
([69a34c7](69a34c7))
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
AztecBot added a commit to AztecProtocol/barretenberg that referenced this pull request Nov 7, 2023
@AztecBot
chore(master): Release 0.13.0 (#3067)
0cf7f17 
🤖 I have created a release *beep* *boop*
---


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

##
[0.13.0](AztecProtocol/aztec-packages@aztec-packages-v0.12.0...aztec-packages-v0.13.0)
(2023-10-31)


### ⚠ BREAKING CHANGES

* PXE.getNotes(...) + refactor of note types
([#3051](AztecProtocol/aztec-packages#3051))

### Features

* `FieldNote`
([#3037](AztecProtocol/aztec-packages#3037))
([3d1ffd0](AztecProtocol/aztec-packages@3d1ffd0))
* Add Aztec Boxes page to docs
([#2569](AztecProtocol/aztec-packages#2569))
([997c15c](AztecProtocol/aztec-packages@997c15c))
* Adding structure to Transcript
([#2937](AztecProtocol/aztec-packages#2937))
([db67aa1](AztecProtocol/aztec-packages@db67aa1))
* Compile noir contracts with noir_wasm
([#2737](AztecProtocol/aztec-packages#2737))
([524cecf](AztecProtocol/aztec-packages@524cecf))
* Dockerize aztec-cli
([#3031](AztecProtocol/aztec-packages#3031))
([ec2e3c2](AztecProtocol/aztec-packages@ec2e3c2))
* Efficient ZM quotient computation
([#3016](AztecProtocol/aztec-packages#3016))
([ebda5fc](AztecProtocol/aztec-packages@ebda5fc))
* **feature_branch:** Private Kernel Circuit
([#2740](AztecProtocol/aztec-packages#2740))
([f800a36](AztecProtocol/aztec-packages@f800a36))
* Measure plonk rounds
([#3065](AztecProtocol/aztec-packages#3065))
([c8e1d8b](AztecProtocol/aztec-packages@c8e1d8b))
* Migrate the init kernel CPP tests to noir
([#3091](AztecProtocol/aztec-packages#3091))
([906429f](AztecProtocol/aztec-packages@906429f))
* New script to output table of benchmarks for README pasting.
([#2780](AztecProtocol/aztec-packages#2780))
([6c20b45](AztecProtocol/aztec-packages@6c20b45))
* Pedersen in typescript.
([#3111](AztecProtocol/aztec-packages#3111))
([933f1b2](AztecProtocol/aztec-packages@933f1b2))
* Protogalaxy folding of challenges
([#2935](AztecProtocol/aztec-packages#2935))
([7ed30e8](AztecProtocol/aztec-packages@7ed30e8))
* PXE.getNotes(...) + refactor of note types
([#3051](AztecProtocol/aztec-packages#3051))
([16abb5a](AztecProtocol/aztec-packages@16abb5a))
* Zeromorph with concatenation (Goblin Translator part 10)
([#3006](AztecProtocol/aztec-packages#3006))
([70b0f17](AztecProtocol/aztec-packages@70b0f17))


### Bug Fixes

* Bad contract txs publishing contract data
([#2673](AztecProtocol/aztec-packages#2673))
([ccd4611](AztecProtocol/aztec-packages@ccd4611))
* Better error message for compute_note_hash_and_nullifier.
([#3097](AztecProtocol/aztec-packages#3097))
([57bec53](AztecProtocol/aztec-packages@57bec53))
* Broken `FieldNote` test
([#3135](AztecProtocol/aztec-packages#3135))
([fe78ecf](AztecProtocol/aztec-packages@fe78ecf))
* Docker-compose up, rather than run.
([#3081](AztecProtocol/aztec-packages#3081))
([242f780](AztecProtocol/aztec-packages@242f780))
* Formatting
([#3070](AztecProtocol/aztec-packages#3070))
([e1633d3](AztecProtocol/aztec-packages@e1633d3))
* Minor stale naming fix
([#3117](AztecProtocol/aztec-packages#3117))
([a6786ae](AztecProtocol/aztec-packages@a6786ae))
* Push cli docker image to docker hub
([#3120](AztecProtocol/aztec-packages#3120))
([ccad50f](AztecProtocol/aztec-packages@ccad50f))
* Remove duplicate terraform resource definition
([#3066](AztecProtocol/aztec-packages#3066))
([d5abadb](AztecProtocol/aztec-packages@d5abadb))
* Retry request spot
([#3116](AztecProtocol/aztec-packages#3116))
([82de5f1](AztecProtocol/aztec-packages@82de5f1))


### Miscellaneous

* Add stdlib tests for pedersen commitment
([#3075](AztecProtocol/aztec-packages#3075))
([87fa621](AztecProtocol/aztec-packages@87fa621))
* Automatic c_binds for commit should return a point instead of an Fr
element
([#3072](AztecProtocol/aztec-packages#3072))
([2e289a5](AztecProtocol/aztec-packages@2e289a5))
* Cleanup remaining mentions of `compress` with pedersen in cpp and ts
([#3074](AztecProtocol/aztec-packages#3074))
([52cf383](AztecProtocol/aztec-packages@52cf383))
* E2e on spots [ci rebuild]
([#3068](AztecProtocol/aztec-packages#3068))
([15db6bf](AztecProtocol/aztec-packages@15db6bf))
* Fix dapp_testing e2e race condition
([#3094](AztecProtocol/aztec-packages#3094))
([89e7c21](AztecProtocol/aztec-packages@89e7c21))
* Remove docs mirror
([#3122](AztecProtocol/aztec-packages#3122))
([3fa51e2](AztecProtocol/aztec-packages@3fa51e2))
* Remove endomorphism coefficient from ecc_add_gate
([#3115](AztecProtocol/aztec-packages#3115))
([d294987](AztecProtocol/aztec-packages@d294987))
* Remove unecessary calls to `pedersen__init`
([#3079](AztecProtocol/aztec-packages#3079))
([84f8db2](AztecProtocol/aztec-packages@84f8db2))
* Remove unused pedersen c_binds
([#3058](AztecProtocol/aztec-packages#3058))
([e71e5f9](AztecProtocol/aztec-packages@e71e5f9))
* Removes pedersen commit native pairs method
([#3073](AztecProtocol/aztec-packages#3073))
([69a34c7](AztecProtocol/aztec-packages@69a34c7))
* Rename private-kernel subpackage to protocol-circuits
([#3134](AztecProtocol/aztec-packages#3134))
([3e07104](AztecProtocol/aztec-packages@3e07104))


### Documentation

* Initial keys spec
([#3035](AztecProtocol/aztec-packages#3035))
([4b24c58](AztecProtocol/aztec-packages@4b24c58))
</details>

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

##
[0.13.0](AztecProtocol/aztec-packages@barretenberg.js-v0.12.0...barretenberg.js-v0.13.0)
(2023-10-31)


### Features

* New script to output table of benchmarks for README pasting.
([#2780](AztecProtocol/aztec-packages#2780))
([6c20b45](AztecProtocol/aztec-packages@6c20b45))


### Miscellaneous

* Automatic c_binds for commit should return a point instead of an Fr
element
([#3072](AztecProtocol/aztec-packages#3072))
([2e289a5](AztecProtocol/aztec-packages@2e289a5))
* Remove unecessary calls to `pedersen__init`
([#3079](AztecProtocol/aztec-packages#3079))
([84f8db2](AztecProtocol/aztec-packages@84f8db2))
* Remove unused pedersen c_binds
([#3058](AztecProtocol/aztec-packages#3058))
([e71e5f9](AztecProtocol/aztec-packages@e71e5f9))
</details>

<details><summary>barretenberg: 0.13.0</summary>

##
[0.13.0](AztecProtocol/aztec-packages@barretenberg-v0.12.0...barretenberg-v0.13.0)
(2023-10-31)


### Features

* Adding structure to Transcript
([#2937](AztecProtocol/aztec-packages#2937))
([db67aa1](AztecProtocol/aztec-packages@db67aa1))
* Efficient ZM quotient computation
([#3016](AztecProtocol/aztec-packages#3016))
([ebda5fc](AztecProtocol/aztec-packages@ebda5fc))
* Measure plonk rounds
([#3065](AztecProtocol/aztec-packages#3065))
([c8e1d8b](AztecProtocol/aztec-packages@c8e1d8b))
* New script to output table of benchmarks for README pasting.
([#2780](AztecProtocol/aztec-packages#2780))
([6c20b45](AztecProtocol/aztec-packages@6c20b45))
* Pedersen in typescript.
([#3111](AztecProtocol/aztec-packages#3111))
([933f1b2](AztecProtocol/aztec-packages@933f1b2))
* Protogalaxy folding of challenges
([#2935](AztecProtocol/aztec-packages#2935))
([7ed30e8](AztecProtocol/aztec-packages@7ed30e8))
* Zeromorph with concatenation (Goblin Translator part 10)
([#3006](AztecProtocol/aztec-packages#3006))
([70b0f17](AztecProtocol/aztec-packages@70b0f17))


### Miscellaneous

* Add stdlib tests for pedersen commitment
([#3075](AztecProtocol/aztec-packages#3075))
([87fa621](AztecProtocol/aztec-packages@87fa621))
* Automatic c_binds for commit should return a point instead of an Fr
element
([#3072](AztecProtocol/aztec-packages#3072))
([2e289a5](AztecProtocol/aztec-packages@2e289a5))
* Cleanup remaining mentions of `compress` with pedersen in cpp and ts
([#3074](AztecProtocol/aztec-packages#3074))
([52cf383](AztecProtocol/aztec-packages@52cf383))
* Remove endomorphism coefficient from ecc_add_gate
([#3115](AztecProtocol/aztec-packages#3115))
([d294987](AztecProtocol/aztec-packages@d294987))
* Remove unecessary calls to `pedersen__init`
([#3079](AztecProtocol/aztec-packages#3079))
([84f8db2](AztecProtocol/aztec-packages@84f8db2))
* Remove unused pedersen c_binds
([#3058](AztecProtocol/aztec-packages#3058))
([e71e5f9](AztecProtocol/aztec-packages@e71e5f9))
* Removes pedersen commit native pairs method
([#3073](AztecProtocol/aztec-packages#3073))
([69a34c7](AztecProtocol/aztec-packages@69a34c7))
</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

Reviewers

@spalladino spalladino spalladino left review comments

@PhilWindle PhilWindle PhilWindle approved these changes

Assignees

No one assigned

Labels

A-documentation Area: relates to documentation

Projects

No open projects
A3
Archived in project

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@iAmMichaelConnor @spalladino @PhilWindle