Skip to content

docs/adr: fix typos and wording in ADRs #420

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

Open
radik878 wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs/adr: fix typos and wording in ADRs #420

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d7803bc
Update adr-001-checkpoint-snarks.md
radik878 Aug 26, 2025
1122245
Update adr-002-create-account-op.md
radik878 Aug 26, 2025
f6299a7
Update adr-003-service-registration.md
radik878 Aug 26, 2025
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
2 changes: 1 addition & 1 deletion adr/adr-001-checkpoint-snarks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@ pub fn new(
}
```

We also need to implemented a find_and_verify_latest_checkpoint method to scan backwards from the current height to find and verify the latest checkpoint SNARK.
We also need to implement a find_and_verify_latest_checkpoint method to scan backwards from the current height to find and verify the latest checkpoint SNARK.

```rust
async fn find_and_verify_latest_checkpoint(&mut self, start: u64, end: u64) -> Result<()> {
Expand Down
2 changes: 1 addition & 1 deletion adr/adr-002-create-account-op.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Once a new user is added to the IMT, we know that all updates to a hashchain are

## Status Quo

The de facto solution to this problem is by centralizing the account creation - a service exists that signs off on an account creation event after a user verifies to the central entity that they own some resource, i.e. a phone number via a OTP.
The de facto solution to this problem is by centralizing the account creation - a service exists that signs off on an account creation event after a user verifies to the central entity that they own some resource, i.e. a phone number via an OTP.

This creates cause for concern:

Expand Down
2 changes: 1 addition & 1 deletion adr/adr-003-service-registration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ pub struct NoteOperationArgs {

```

This differs from the existing implementation significantly, whose only account source is a SignedBySequencer. Futher adjustments were made to AddKey and RevokeKey to enable hashchain verification using a SignatureBundle as originally intended.
This differs from the existing implementation significantly, whose only account source is a SignedBySequencer. Further adjustments were made to AddKey and RevokeKey to enable hashchain verification using a SignatureBundle as originally intended.

## Effects

Expand Down