Skip to content

chore: updated docs#13248

Closed
benesjan wants to merge 3 commits into04-03-refactor_renaming_unconstrained_to_utility_in_registererfrom
04-02-chore_updated_docs
Closed

chore: updated docs#13248
benesjan wants to merge 3 commits into04-03-refactor_renaming_unconstrained_to_utility_in_registererfrom
04-02-chore_updated_docs

Conversation

@benesjan
Copy link
Contributor

@benesjan benesjan commented Apr 2, 2025

Fixes #12743

In this PR I rename occurrences of top-level unconstrained in docs.

Last PR in the crazy stack of renamings.

Copy link
Contributor Author

benesjan commented Apr 2, 2025

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

This stack of pull requests is managed by Graphite. Learn more about stacking.

@benesjan benesjan changed the base branch from 04-02-refactorunsconstrainedcontext_--_utilitycontext to graphite-base/13248 April 2, 2025 20:50
@benesjan benesjan force-pushed the 04-02-chore_updated_docs branch from ada31fe to 83fd985 Compare April 2, 2025 20:50
@benesjan benesjan changed the base branch from graphite-base/13248 to 04-02-refactor_unconstrainedexecutionoracle_--_utilityexecutionoracle April 2, 2025 20:50
@benesjan benesjan force-pushed the 04-02-chore_updated_docs branch from 83fd985 to 72bab60 Compare April 2, 2025 22:06
@benesjan benesjan force-pushed the 04-02-refactor_unconstrainedexecutionoracle_--_utilityexecutionoracle branch from fe90087 to 2e3073c Compare April 2, 2025 22:06
@benesjan benesjan force-pushed the 04-02-chore_updated_docs branch 2 times, most recently from 7363601 to 7f42a38 Compare April 2, 2025 23:53
@benesjan benesjan force-pushed the 04-02-refactor_unconstrainedexecutionoracle_--_utilityexecutionoracle branch 2 times, most recently from 3d52ce1 to 777e01c Compare April 3, 2025 00:05
@benesjan benesjan force-pushed the 04-02-chore_updated_docs branch from 7f42a38 to 533ee4a Compare April 3, 2025 00:05
@benesjan benesjan force-pushed the 04-02-refactor_unconstrainedexecutionoracle_--_utilityexecutionoracle branch from 777e01c to b3fa010 Compare April 3, 2025 02:34
@benesjan benesjan force-pushed the 04-02-chore_updated_docs branch from 533ee4a to 2c7aa06 Compare April 3, 2025 02:34
@benesjan benesjan force-pushed the 04-02-refactor_unconstrainedexecutionoracle_--_utilityexecutionoracle branch from b3fa010 to d8790ab Compare April 3, 2025 02:47
@benesjan benesjan force-pushed the 04-02-chore_updated_docs branch 2 times, most recently from 01cda96 to 740d2d1 Compare April 3, 2025 15:08
@benesjan benesjan force-pushed the 04-02-refactor_unconstrainedexecutionoracle_--_utilityexecutionoracle branch from d8790ab to 62fe983 Compare April 3, 2025 15:08
@benesjan benesjan force-pushed the 04-02-chore_updated_docs branch from 740d2d1 to bbec5f3 Compare April 3, 2025 18:30
@benesjan benesjan force-pushed the 04-02-refactor_unconstrainedexecutionoracle_--_utilityexecutionoracle branch from 62fe983 to 4d8dbaf Compare April 3, 2025 18:30
@benesjan benesjan force-pushed the 04-02-chore_updated_docs branch 2 times, most recently from 6250c84 to f63fe85 Compare April 3, 2025 19:00
@benesjan benesjan changed the base branch from 04-02-refactor_unconstrainedexecutionoracle_--_utilityexecutionoracle to graphite-base/13248 April 3, 2025 19:01
@benesjan benesjan force-pushed the 04-02-chore_updated_docs branch 2 times, most recently from cfe9160 to 0c62bbc Compare April 3, 2025 19:36
@benesjan benesjan force-pushed the 04-02-chore_updated_docs branch from 0c62bbc to 1096a2a Compare April 3, 2025 20:20
@benesjan benesjan changed the base branch from graphite-base/13248 to 04-03-refactor_renaming_unconstrained_to_utility_in_registerer April 3, 2025 20:20
@benesjan benesjan force-pushed the 04-03-refactor_renaming_unconstrained_to_utility_in_registerer branch from 0d375f2 to 4e15c9c Compare April 3, 2025 20:29
@benesjan benesjan force-pushed the 04-02-chore_updated_docs branch 2 times, most recently from 14a1324 to b6d8d68 Compare April 3, 2025 20:40
@benesjan benesjan force-pushed the 04-03-refactor_renaming_unconstrained_to_utility_in_registerer branch from 4e15c9c to 7c5ea5e Compare April 3, 2025 20:40
@benesjan benesjan force-pushed the 04-02-chore_updated_docs branch 2 times, most recently from d1917ba to 401a7cb Compare April 3, 2025 22:01
@benesjan benesjan force-pushed the 04-03-refactor_renaming_unconstrained_to_utility_in_registerer branch 2 times, most recently from adefe05 to eaa79d3 Compare April 3, 2025 22:50
@benesjan benesjan force-pushed the 04-02-chore_updated_docs branch 2 times, most recently from 2f14438 to 1c37bfa Compare April 4, 2025 01:08
@benesjan benesjan force-pushed the 04-03-refactor_renaming_unconstrained_to_utility_in_registerer branch from eaa79d3 to f8dc57f Compare April 4, 2025 01:08
@benesjan benesjan force-pushed the 04-02-chore_updated_docs branch from 1c37bfa to 6a9309b Compare April 4, 2025 02:06
@benesjan benesjan force-pushed the 04-03-refactor_renaming_unconstrained_to_utility_in_registerer branch from f8dc57f to af15b61 Compare April 4, 2025 02:06
@benesjan benesjan force-pushed the 04-02-chore_updated_docs branch from 6a9309b to fb275c9 Compare April 4, 2025 03:07
@benesjan benesjan requested a review from sklppy88 April 4, 2025 04:19
@benesjan benesjan marked this pull request as ready for review April 4, 2025 04:19
Note that individual public functions are not first-class citizens in the protocol, so the contract entire public function bytecode is stored in the class, unlike private or unconstrained functions which are differentiated individual circuits recognized by the protocol.
Note that individual public functions are not first-class citizens in the protocol, so the contract entire public function bytecode is stored in the class, unlike private or utility functions which are differentiated individual circuits recognized by the protocol.

As for unconstrained functions, these are not used standalone within the protocol. They are either inlined within private functions, or called from a PXE as _getters_ for a contract. Calling from a private function to an unconstrained one in a different contract is forbidden, since the caller would have no guarantee of the code run by the callee. Considering this, unconstrained functions are not part of a contract class at the protocol level.
Copy link
Contributor

Choose a reason for hiding this comment

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

Unrelated to your pr but this page is confusing

@benesjan benesjan force-pushed the 04-02-chore_updated_docs branch from fb275c9 to 530a5c6 Compare April 4, 2025 14:18
@benesjan benesjan force-pushed the 04-03-refactor_renaming_unconstrained_to_utility_in_registerer branch from 4f01499 to 1b6bff0 Compare April 4, 2025 14:18
@nventuro
Copy link
Contributor

nventuro commented Apr 4, 2025

Superceded by #13310.

@nventuro nventuro closed this Apr 4, 2025
github-merge-queue bot pushed a commit that referenced this pull request Apr 8, 2025
Replacement for
#13248 to get it out
of the graphite stack.

This PR updates mentions of top-level unconstrained contract fns for the
new 'utility' term. Some instances may be missing, but I think we
covered the vast majority of it. I also updated language in some parts
were explanations were outdated, and tried to remove bits that conflated
Noir unconstrained functions and utility functions. We'll likely want to
expand on this given the apparent confusion.

---------

Co-authored-by: benesjan <janbenes1234@gmail.com>
AztecBot pushed a commit to AztecProtocol/aztec-nr that referenced this pull request Apr 9, 2025
Replacement for
AztecProtocol/aztec-packages#13248 to get it out
of the graphite stack.

This PR updates mentions of top-level unconstrained contract fns for the
new 'utility' term. Some instances may be missing, but I think we
covered the vast majority of it. I also updated language in some parts
were explanations were outdated, and tried to remove bits that conflated
Noir unconstrained functions and utility functions. We'll likely want to
expand on this given the apparent confusion.

---------

Co-authored-by: benesjan <janbenes1234@gmail.com>
signorecello pushed a commit that referenced this pull request Apr 9, 2025
Replacement for
#13248 to get it out
of the graphite stack.

This PR updates mentions of top-level unconstrained contract fns for the
new 'utility' term. Some instances may be missing, but I think we
covered the vast majority of it. I also updated language in some parts
were explanations were outdated, and tried to remove bits that conflated
Noir unconstrained functions and utility functions. We'll likely want to
expand on this given the apparent confusion.

---------

Co-authored-by: benesjan <janbenes1234@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants