Skip to content
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.

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

Update doc #12

Merged
merged 3 commits into from
Jun 18, 2024
Merged

Update doc #12

merged 3 commits into from
Jun 18, 2024

Conversation

garyghayrat
Copy link
Member

No description provided.

Copy link
Contributor

@marcomariscal marcomariscal left a comment

Choose a reason for hiding this comment

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

looks beautiful; just a couple of nits


### Announcement

The `Announcement` event is emitted to when the `announce` function is called. Here are the key components of this event:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The `Announcement` event is emitted to when the `announce` function is called. Here are the key components of this event:
The `Announcement` event is emitted when the `announce` function is called. Here are the key components of this event:

Copy link
Member Author

Choose a reason for hiding this comment

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

) external
```

### Description
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
### Description
#### Description

Copy link
Member Author

Choose a reason for hiding this comment

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


The `StealthMetaAddressSet` event is emitted when a registrant updates their stealth meta-address.

- **registrant** (`address`): The account that the registered the stealth meta-address belongs to.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- **registrant** (`address`): The account that the registered the stealth meta-address belongs to.
- **registrant** (`address`): The account the registered stealth meta-address belongs to.

Copy link
Member Author

Choose a reason for hiding this comment

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

);
```

### NonceIncremented
Copy link
Contributor

Choose a reason for hiding this comment

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

maybe events, errors, and funcs can be code to differentiate between other headers

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
### NonceIncremented
### `NonceIncremented`

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed in f98ca20

@garyghayrat garyghayrat merged commit 0154774 into main Jun 18, 2024
1 check passed
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.

2 participants