feat: initial portal docs + minor cleanups #1469
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Maddiaa0
reviewed
Aug 9, 2023
|
|
||
| | Name | Type | Description | | ||
| | -------------- | ------- | ----------- | | ||
| | Recipient | `L2Actor` | Who is to receive the message. This **MUST** match the rollup version and an Aztec contract that is **attached** to the contract making this call. If the recipient is not attached to the caller, the message cannot be consumed by it. | |
There was a problem hiding this comment.
Is the L2Actor object defined anywhere?
There was a problem hiding this comment.
Not in this. I was thinking that it might be useful to add the DataStructures separately in its own page.
4 tasks
rahul-kothari
requested changes
Aug 11, 2023
|
|
||
| ## `Entry` | ||
|
|
||
| An entry for the messageboxes multi-sets. |
There was a problem hiding this comment.
Suggested change
| An entry for the messageboxes multi-sets. | |
| An entry for the message box (the entry acts like a multi-set, enabling multiple entries for the same message) |
There was a problem hiding this comment.
The entry does not act like a multiset, it is an entry in a multiset.
|
|
||
| ## `L1Actor` | ||
|
|
||
| An entity on L1, specifying the address and the chainid for the entity. Used when specifying sender/recipient with an entity that is on L1. |
There was a problem hiding this comment.
Suggested change
| An entity on L1, specifying the address and the chainid for the entity. Used when specifying sender/recipient with an entity that is on L1. | |
| An entity on L1, specifying the address and the chainId for the entity. Used when specifying sender/recipient with an entity that is on L1. |
There was a problem hiding this comment.
Unsure what exactly we want here, often it is just denoted chainid in solidity docs etc, but I prefer chainId.
|
|
||
| ## `L2Actor` | ||
|
|
||
| An entity on L2, specifying the address and the chainid for the entity. Used when specifying sender/recipient with an entity that is on L2. |
There was a problem hiding this comment.
Suggested change
| An entity on L2, specifying the address and the chainid for the entity. Used when specifying sender/recipient with an entity that is on L2. | |
| An entity on L2, specifying the address and the chainId for the entity. Used when specifying sender/recipient with an entity that is on L2. |
There was a problem hiding this comment.
Oh, chainid should be replaced by version here actually.
| _token, | ||
| _to | ||
| ); | ||
| ``` |
rahul-kothari
approved these changes
Aug 14, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #1439.
Consider serving locally to review in proper format.
Checklist:
Remove the checklist to signal you've completed it. Enable auto-merge if the PR is ready to merge.