Skip to content

Commit a477c02

Browse files
authored
feat: merge-train/docs (#20490)
BEGIN_COMMIT_OVERRIDE fix(docs): sort stable versions newest-first in versions.json (#20405) feat(docs): validate links to auto-generated API reference docs (#20459) feat(docs): add Slack alerting for API ref link validation (#20498) fix(docs): fix broken API reference links and add version-aware validation (#20500) END_COMMIT_OVERRIDE
2 parents c0fb6cb + a158d3f commit a477c02

File tree

7 files changed

+500
-65
lines changed

7 files changed

+500
-65
lines changed

docs/developer_versioned_docs/version-v3.0.0-devnet.6-patch.1/docs/aztec-nr/framework-description/state_variables.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -106,9 +106,9 @@ Below is a table comparing the key properties of the different public state vari
106106

107107
| State variable | Mutable? | Readable in private? | Writable in private? | Example use case |
108108
| ------------------------------------------------------------------------------------------------ | ------------------- | -------------------- | -------------------- | ---------------------------------------------------------------------------------- |
109-
| [`PublicMutable`](pathname:///aztec-nr-api/devnet/noir_aztec/state_vars/struct.publicmutable) | yes | no | no | Configuration of admins, global state (e.g. token total supply, total votes) |
110-
| [`PublicImmutable`](pathname:///aztec-nr-api/devnet/noir_aztec/state_vars/struct.publicimmutable) | no | yes | no | Fixed configuration, one-way actions (e.g. initialization settings for a proposal) |
111-
| [`DelayedPublicMutable`](pathname:///aztec-nr-api/devnet/noir_aztec/state_vars/struct.delayedpublicmutable) | yes (after a delay) | yes | no | Non time sensitive system configuration |
109+
| [`PublicMutable`](pathname:///aztec-nr-api/devnet/noir_aztec/state_vars/public_mutable/struct.PublicMutable) | yes | no | no | Configuration of admins, global state (e.g. token total supply, total votes) |
110+
| [`PublicImmutable`](pathname:///aztec-nr-api/devnet/noir_aztec/state_vars/public_immutable/struct.PublicImmutable) | no | yes | no | Fixed configuration, one-way actions (e.g. initialization settings for a proposal) |
111+
| [`DelayedPublicMutable`](pathname:///aztec-nr-api/devnet/noir_aztec/state_vars/delayed_public_mutable/struct.DelayedPublicMutable) | yes (after a delay) | yes | no | Non time sensitive system configuration |
112112

113113
### PublicMutable
114114

@@ -272,12 +272,12 @@ When working with private state variables, many operations return a `NoteMessage
272272

273273
#### Delivery Methods
274274

275-
Private notes need to be communicated to their recipients so they know the note exists and can use it. The [`NoteMessage`](pathname:///aztec-nr-api/devnet/noir_aztec/note/struct.notemessage) wrapper forces you to make an explicit choice about how this happens:
275+
Private notes need to be communicated to their recipients so they know the note exists and can use it. The [`NoteMessage`](pathname:///aztec-nr-api/devnet/noir_aztec/note/note_message/struct.NoteMessage) wrapper forces you to make an explicit choice about how this happens:
276276
[
277277

278-
- `MessageDelivery.ONCHAIN_CONSTRAINED`](pathname:///aztec-nr-api/devnet/noir_aztec/messages/message_delivery/struct.messagedeliveryenum#structfield.ONCHAIN_UNCONSTRAINED): Verified in the circuit (most secure, but highest cost) - Use when the sender cannot be trusted to deliver correctly (e.g., protocol fees, multisig config updates). **Warning:** Currently [not fully constrained](https://github.com/AztecProtocol/aztec-packages/issues/14565) - the log's tag is unconstrained.
279-
- [`MessageDelivery.ONCHAIN_UNCONSTRAINED`](pathname:///aztec-nr-api/devnet/noir_aztec/messages/message_delivery/struct.messagedeliveryenum#structfield.ONCHAIN_UNCONSTRAINED): Message stored onchain but no guarantees on content - Use when the sender is incentivized to deliver correctly but may not have an offchain channel to the recipient.
280-
- [`MessageDelivery.OFFCHAIN`](pathname:///aztec-nr-api/devnet/noir_aztec/messages/message_delivery/struct.messagedeliveryenum#structfield.OFFCHAIN): Lowest cost, no onchain data - Use when the sender and recipient can communicate and the sender is incentivized to deliver correctly.
278+
- `MessageDelivery.ONCHAIN_CONSTRAINED`](pathname:///aztec-nr-api/devnet/noir_aztec/messages/message_delivery/struct.MessageDeliveryEnum#structfield.ONCHAIN_UNCONSTRAINED): Verified in the circuit (most secure, but highest cost) - Use when the sender cannot be trusted to deliver correctly (e.g., protocol fees, multisig config updates). **Warning:** Currently [not fully constrained](https://github.com/AztecProtocol/aztec-packages/issues/14565) - the log's tag is unconstrained.
279+
- [`MessageDelivery.ONCHAIN_UNCONSTRAINED`](pathname:///aztec-nr-api/devnet/noir_aztec/messages/message_delivery/struct.MessageDeliveryEnum#structfield.ONCHAIN_UNCONSTRAINED): Message stored onchain but no guarantees on content - Use when the sender is incentivized to deliver correctly but may not have an offchain channel to the recipient.
280+
- [`MessageDelivery.OFFCHAIN`](pathname:///aztec-nr-api/devnet/noir_aztec/messages/message_delivery/struct.MessageDeliveryEnum#structfield.OFFCHAIN): Lowest cost, no onchain data - Use when the sender and recipient can communicate and the sender is incentivized to deliver correctly.
281281

282282
#include_code note_delivery /noir-projects/noir-contracts/contracts/app/private_token_contract/src/main.nr rust
283283

@@ -340,9 +340,9 @@ Below is a table comparing certain key properties of the different private state
340340

341341
| State variable | Mutable? | Cost to read? | Writable by third parties? | Example use case |
342342
| ---------------------------------------------------------------------------------------- | -------- | ------------- | -------------------------- | -------------------------------------------------------------------------------------------------------------- |
343-
| [`PrivateMutable`](pathname:///aztec-nr-api/devnet/noir_aztec/state_vars/struct.privatemutable) | yes | yes | no | Mutable user state only accessible by them (e.g. user settings or keys) |
344-
| [`PrivateImmutable`](pathname:///aztec-nr-api/devnet/noir_aztec/state_vars/struct.privateimmutable) | no | no | no | Fixed configuration, one-way actions (e.g. initialization settings for a proposal) |
345-
| [`PrivateSet`](pathname:///aztec-nr-api/devnet/noir_aztec/state_vars/struct.privateset) | yes | yes | yes | Aggregated state others can add to, e.g. token balance (set of amount notes), nft collections (set of nft ids) |
343+
| [`PrivateMutable`](pathname:///aztec-nr-api/devnet/noir_aztec/state_vars/private_mutable/struct.PrivateMutable) | yes | yes | no | Mutable user state only accessible by them (e.g. user settings or keys) |
344+
| [`PrivateImmutable`](pathname:///aztec-nr-api/devnet/noir_aztec/state_vars/private_immutable/struct.PrivateImmutable) | no | no | no | Fixed configuration, one-way actions (e.g. initialization settings for a proposal) |
345+
| [`PrivateSet`](pathname:///aztec-nr-api/devnet/noir_aztec/state_vars/private_set/struct.PrivateSet) | yes | yes | yes | Aggregated state others can add to, e.g. token balance (set of amount notes), nft collections (set of nft ids) |
346346

347347
### Owned State Variables
348348

docs/developer_versioned_docs/version-v4.0.0-nightly.20260213/docs/aztec-nr/framework-description/state_variables.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -106,9 +106,9 @@ Below is a table comparing the key properties of the different public state vari
106106

107107
| State variable | Mutable? | Readable in private? | Writable in private? | Example use case |
108108
| ---------------------- | ------------------- | -------------------- | -------------------- | ---------------------------------------------------------------------------------- |
109-
| [`PublicMutable`](pathname:///aztec-nr-api/nightly/noir_aztec/state_vars/struct.publicmutable) | yes | no | no | Configuration of admins, global state (e.g. token total supply, total votes) |
110-
| [`PublicImmutable`](pathname:///aztec-nr-api/nightly/noir_aztec/state_vars/struct.publicimmutable) | no | yes | no | Fixed configuration, one-way actions (e.g. initialization settings for a proposal) |
111-
| [`DelayedPublicMutable`](pathname:///aztec-nr-api/nightly/noir_aztec/state_vars/struct.delayedpublicmutable) | yes (after a delay) | yes | no | Non time sensitive system configuration |
109+
| [`PublicMutable`](pathname:///aztec-nr-api/nightly/noir_aztec/state_vars/struct.PublicMutable) | yes | no | no | Configuration of admins, global state (e.g. token total supply, total votes) |
110+
| [`PublicImmutable`](pathname:///aztec-nr-api/nightly/noir_aztec/state_vars/struct.PublicImmutable) | no | yes | no | Fixed configuration, one-way actions (e.g. initialization settings for a proposal) |
111+
| [`DelayedPublicMutable`](pathname:///aztec-nr-api/nightly/noir_aztec/state_vars/struct.DelayedPublicMutable) | yes (after a delay) | yes | no | Non time sensitive system configuration |
112112

113113
### PublicMutable
114114

@@ -344,10 +344,10 @@ When working with private state variables, many operations return a `NoteMessage
344344

345345
#### Delivery Methods
346346

347-
Private notes need to be communicated to their recipients so they know the note exists and can use it. The [`NoteMessage`](pathname:///aztec-nr-api/nightly/noir_aztec/note/struct.notemessage) wrapper forces you to make an explicit choice about how this happens:
348-
- [`MessageDelivery.ONCHAIN_CONSTRAINED`](pathname:///aztec-nr-api/nightly/noir_aztec/messages/message_delivery/struct.messagedeliveryenum#structfield.ONCHAIN_UNCONSTRAINED): Verified in the circuit (most secure, but highest cost) - Use when the sender cannot be trusted to deliver correctly (e.g., protocol fees, multisig config updates). **Warning:** Currently [not fully constrained](https://github.com/AztecProtocol/aztec-packages/issues/14565) - the log's tag is unconstrained.
349-
- [`MessageDelivery.ONCHAIN_UNCONSTRAINED`](pathname:///aztec-nr-api/nightly/noir_aztec/messages/message_delivery/struct.messagedeliveryenum#structfield.ONCHAIN_UNCONSTRAINED): Message stored onchain but no guarantees on content - Use when the sender is incentivized to deliver correctly but may not have an offchain channel to the recipient.
350-
- [`MessageDelivery.OFFCHAIN`](pathname:///aztec-nr-api/nightly/noir_aztec/messages/message_delivery/struct.messagedeliveryenum#structfield.OFFCHAIN): Lowest cost, no onchain data - Use when the sender and recipient can communicate and the sender is incentivized to deliver correctly.
347+
Private notes need to be communicated to their recipients so they know the note exists and can use it. The [`NoteMessage`](pathname:///aztec-nr-api/nightly/noir_aztec/note/struct.NoteMessage) wrapper forces you to make an explicit choice about how this happens:
348+
- [`MessageDelivery.ONCHAIN_CONSTRAINED`](pathname:///aztec-nr-api/nightly/noir_aztec/messages/message_delivery/struct.MessageDeliveryEnum#structfield.ONCHAIN_UNCONSTRAINED): Verified in the circuit (most secure, but highest cost) - Use when the sender cannot be trusted to deliver correctly (e.g., protocol fees, multisig config updates). **Warning:** Currently [not fully constrained](https://github.com/AztecProtocol/aztec-packages/issues/14565) - the log's tag is unconstrained.
349+
- [`MessageDelivery.ONCHAIN_UNCONSTRAINED`](pathname:///aztec-nr-api/nightly/noir_aztec/messages/message_delivery/struct.MessageDeliveryEnum#structfield.ONCHAIN_UNCONSTRAINED): Message stored onchain but no guarantees on content - Use when the sender is incentivized to deliver correctly but may not have an offchain channel to the recipient.
350+
- [`MessageDelivery.OFFCHAIN`](pathname:///aztec-nr-api/nightly/noir_aztec/messages/message_delivery/struct.MessageDeliveryEnum#structfield.OFFCHAIN): Lowest cost, no onchain data - Use when the sender and recipient can communicate and the sender is incentivized to deliver correctly.
351351

352352
```rust title="note_delivery" showLineNumbers
353353
#[external("private")]
@@ -433,9 +433,9 @@ Below is a table comparing certain key properties of the different private state
433433

434434
| State variable | Mutable? | Cost to read? | Writable by third parties? | Example use case |
435435
| ------------------ | -------- | ------------- | -------------------------- | -------------------------------------------------------------------------------------------------------------- |
436-
| [`PrivateMutable`](pathname:///aztec-nr-api/nightly/noir_aztec/state_vars/struct.privatemutable) | yes | yes | no | Mutable user state only accessible by them (e.g. user settings or keys) |
437-
| [`PrivateImmutable`](pathname:///aztec-nr-api/nightly/noir_aztec/state_vars/struct.privateimmutable) | no | no | no | Fixed configuration, one-way actions (e.g. initialization settings for a proposal) |
438-
| [`PrivateSet`](pathname:///aztec-nr-api/nightly/noir_aztec/state_vars/struct.privateset) | yes | yes | yes | Aggregated state others can add to, e.g. token balance (set of amount notes), nft collections (set of nft ids) |
436+
| [`PrivateMutable`](pathname:///aztec-nr-api/nightly/noir_aztec/state_vars/struct.PrivateMutable) | yes | yes | no | Mutable user state only accessible by them (e.g. user settings or keys) |
437+
| [`PrivateImmutable`](pathname:///aztec-nr-api/nightly/noir_aztec/state_vars/struct.PrivateImmutable) | no | no | no | Fixed configuration, one-way actions (e.g. initialization settings for a proposal) |
438+
| [`PrivateSet`](pathname:///aztec-nr-api/nightly/noir_aztec/state_vars/struct.PrivateSet) | yes | yes | yes | Aggregated state others can add to, e.g. token balance (set of amount notes), nft collections (set of nft ids) |
439439

440440
### Owned State Variables
441441

0 commit comments

Comments
 (0)