docs: add messaging_reference.adoc #1094

xiaolou86 · 2024-01-23T08:04:17Z

Description of the Changes

Add messaging_reference.adoc

Closes #1086

PR Preview URL

Messaging reference

Check List

Changes have been done against main branch, and PR does not conflict
PR title follows the convention: <docs/feat/fix/chore>(optional scope): <description>, e.g: fix: minor typos in code

This change is

xiaolou86 · 2024-01-24T06:10:32Z

@stoobie I finished the doc, please help me to review. Thank you very much.

Failed to generate a preview, it's a little inconvenient.

stoobie · 2024-01-24T08:46:26Z

@stoobie I finished the doc, please help me to review. Thank you very much.

Fantastic! I'll take a look today or tomorrow.

Failed to generate a preview, it's a little inconvenient.

I know. Are you able to generate a preview locally?

xiaolou86 · 2024-01-24T10:03:00Z

Failed to generate a preview, it's a little inconvenient.

I know. Are you able to generate a preview locally?

I tried in my other repo, but it failed. I will try in my forked starknet-docs repo later.

stoobie

Began review. Will continue.

...arknet/modules/architecture_and_concepts/pages/Network_Architecture/messaging_reference.adoc

stoobie · 2024-02-14T15:18:54Z

@xiaolou86 I apologize for not reviewing this more quickly. I'm getting back to this now.

stoobie · 2024-02-26T14:39:29Z

@xiaolou86 Would you please rebase your branch to merge all recent commits to starknet-io:main and commit again?

I want to test your fix to generate a preview from a fork.

xiaolou86 · 2024-02-27T02:22:28Z

@xiaolou86 Would you please rebase your branch to merge all recent commits to starknet-io:main and commit again?

I want to test your fix to generate a preview from a fork.

Preview generated successfully, while Send comment to PR didn't work well :(

xiaolou86 · 2024-02-27T02:31:59Z

I think maybe need to add pull-requests: write permission in the .yml file

github-actions · 2024-02-28T16:04:26Z

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1094/documentation/ .

stoobie · 2024-03-26T13:09:44Z

@xiaolou86 This has taken me a lot longer than I expected to move forward. To be fair to you, I sent you initial compensation just now for the work you've done so far on this, and I'll send more once we finish this.

xiaolou86 · 2024-03-28T01:54:29Z

@stoobie Thank you very much.

...arknet/modules/architecture_and_concepts/pages/Network_Architecture/messaging_reference.adoc

xiaolou86 · 2024-04-02T01:55:12Z

@stoobie grateful for you helping me create a new PR #1209 to edit this messaging_reference.adoc? It's my duty. Thank you very much!

xiaolou86 · 2024-04-07T07:51:00Z

@stoobie @LucasLvy thank you for your reviews.

I have updated the docs:

Adds the functions implemented in StarknetMessaging.sol but not part of the IStarknetMessaging.sol:

l1ToL2MessageCancellations
l1ToL2MessageNonce
l2ToL1Messages
messageCancellationDelay

Adds a link to the messageCancellationDelay function on etherscan to get the real value.

starknet-bot · 2024-05-05T10:06:05Z

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1094/documentation/ .

starknet-bot · 2024-05-06T07:35:56Z

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1094/documentation/ .

starknet-bot · 2024-05-06T10:23:34Z

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1094/documentation/ .

starknet-bot · 2024-05-06T12:04:13Z

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1094/documentation/ .

starknet-bot · 2024-05-06T15:24:43Z

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1094/documentation/ .

starknet-bot · 2024-05-07T14:09:44Z

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1094/documentation/ .

…net_message

…f the IStarknetMessaging.sol

Co-authored-by: xiaolou86 <20718693+xiaolou86@users.noreply.github.com>

…twork_Architecture/messaging_reference.adoc

…ToL2 event.

stoobie · 2024-06-09T14:40:15Z

@xiaolou86 Please do the following:

Rebase from starknet-io/starknet-docs:main. I made a lot of changes to the directory structure and file names, including change the name of this file to messaging-reference.adoc (changed the underscore to a hyphen in the file name.)
Copy the changes over from feat: Starknet messaging function and event reference (based on #1094) #1209.
For each event that is emitted, state which function emits it. For each function that emits an event, add a heading "Emitted event" with the name of the event that emitted it, with a link to the event lower down in the page. For example, see ConsumedMessageToL2 and consumeMessageFromL2 in feat: Starknet messaging function and event reference (based on #1094) #1209.

starknet-bot · 2024-06-13T07:12:16Z

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1094/ .

xiaolou86 · 2024-06-13T07:13:18Z

@xiaolou86 Please do the following:

Rebase from starknet-io/starknet-docs:main. I made a lot of changes to the directory structure and file names, including change the name of this file to messaging-reference.adoc (changed the underscore to a hyphen in the file name.)

Copy the changes over from feat: Starknet messaging function and event reference (based on #1094) #1209.

For each event that is emitted, state which function emits it. For each function that emits an event, add a heading "Emitted event" with the name of the event that emitted it, with a link to the event lower down in the page. For example, see ConsumedMessageToL2 and consumeMessageFromL2 in feat: Starknet messaging function and event reference (based on #1094) #1209.

@stoobie All done. Thank you very much.

starknet-bot · 2024-06-13T07:16:37Z

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1094/ .

starknet-bot · 2024-06-13T07:31:04Z

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1094/ .

stoobie · 2024-06-23T15:01:31Z

This has been reviewed by Lucas and Remo. I believe that I have implemented all their comments. So I am merging this.

stoobie

LGTM.

starknet-bot · 2024-06-23T15:07:24Z

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1094/ .

stoobie · 2024-06-30T13:46:49Z

@xiaolou86 Thank you for the contribution! I sent you a reward on Only Dust.

xiaolou86 · 2024-07-01T02:04:04Z

@stoobie Thank you very much.

* create messaging_reference.adoc * add messaging_reference.adoc to nav * add the functions implemented in StarknetMessaging.sol but not part of the IStarknetMessaging.sol * Explain `deployer_address` * Added links between consumeMessageFromL2 function and ConsumedMessageToL2 event. * Added links between consumeMessageFromL2 function and ConsumedMessageToL2 event. * modify event descriptions and add event heading for functions * fix directory structure * Comment out events from internal `processMessages` function

* doc: compiled class hash * further improvement to the doc * fix: Dir structure changes for SEO (#1261) * Changed /documentation/ to /root/ in antora.yml. * Changed root to ROOT. * Change file names for SEO: * underscores to hyphens * uppercase to lowercase * Change file names for SEO to be match content matter * Added broken links from 3rd party sites * Update messaging-mechanism.adoc to latest on main. * Updated xrefs in messaging-mechanism.adoc. * Updated URL for preview to drop `/documentation/` * fix: Change "cross-chain" to "cross-layer" in L1-L2 Messaging mechanism (#1289) * Change "cross-chain" to "cross-layer" in L1-L2 Messaging mechanism * Apply suggestions from code review * Removed `seo-optimization` branch from playbook. (#1299) * docs: add messaging_reference.adoc (#1094) * create messaging_reference.adoc * add messaging_reference.adoc to nav * add the functions implemented in StarknetMessaging.sol but not part of the IStarknetMessaging.sol * Explain `deployer_address` * Added links between consumeMessageFromL2 function and ConsumedMessageToL2 event. * Added links between consumeMessageFromL2 function and ConsumedMessageToL2 event. * modify event descriptions and add event heading for functions * fix directory structure * Comment out events from internal `processMessages` function * docs: Update Starknet book ToC (#1297) * Update Starknet book ToC: Update outdated information about Starknet book --------- Co-authored-by: Steve Goodman <39279277+stoobie@users.noreply.github.com> * fix typo adding class hashes in tx v3 invoke computation (#1292) * Update playbook.yml to use main branch for ui-bundle.zip (#1306) * Fix hash calculation documentation: change 1 to 0 in v1 (deprecated) hash calculation (#1304) * docs: Update transactions.adoc with txs v3 fee estimation (#1296) * Update transactions.adoc with txs v3 fee estimation * Update transactions.adoc * Update transactions.adoc * Update transactions.adoc --------- Co-authored-by: Steve Goodman <39279277+stoobie@users.noreply.github.com> * Update transaction-life-cycle.adoc with finality status of deploy_account and declare transactions (#1295) * Update transaction-life-cycle.adoc with finality status of deploy_account and declare transactions --------- Co-authored-by: Steve Goodman <39279277+stoobie@users.noreply.github.com> * docs: add validate warnings and refactor the account's functions page (#1302) * add validate warnings and refactor account functions page * fix typo * minor fixes * Update serialization-of-cairo-types.adoc (#1307) * docs: Migrate Provers topic from the Starknet Book (#1270) * Migrating Provers topic from the Starknet Book at https://book.starknet.io/ch03-03-provers.html. * Import sharp.adoc from the Book in order to bring in a commit with multiple contributors. * Edits, and removed sharp.adoc --------- Co-authored-by: Omar U. Espejel <espejelomar@gmail.com> * Update README.adoc * docs: add L1HandlerTransaction table and info on caller address (#1275) * feat: add l1 handler transaction type version * fix: fix typo * fix: fix typo * fix: add a new ref to l1 handler transaction * fix: reword L1HandlerTransaction to L1 handler transaction in normal text * fix: reword for consistent format and better readability * Update components/Starknet/modules/architecture-and-concepts/pages/network-architecture/messaging-mechanism.adoc * Update components/Starknet/modules/architecture-and-concepts/pages/network-architecture/messaging-mechanism.adoc * fix: remove old file * Update components/Starknet/modules/architecture-and-concepts/pages/network-architecture/transactions.adoc Co-authored-by: Steve Goodman <39279277+stoobie@users.noreply.github.com> * fix: reword as suggested --------- Co-authored-by: Steve Goodman <39279277+stoobie@users.noreply.github.com> * Added a link to info on the L1 handler tx type from the tx versions table. (#1312) * Update components/Starknet/modules/architecture-and-concepts/nav.adoc * change file name to use hyphens * implement reviewed changes * Update nav.adoc --------- Co-authored-by: Steve Goodman <39279277+stoobie@users.noreply.github.com> Co-authored-by: xiaolou86 <20718693+xiaolou86@users.noreply.github.com> Co-authored-by: Lauri Peltonen <20242241+microbecode@users.noreply.github.com> Co-authored-by: antiyro <74653697+antiyro@users.noreply.github.com> Co-authored-by: Nnaji Benjamin <60315147+Benjtalkshow@users.noreply.github.com> Co-authored-by: odednaor <odednaor@gmail.com> Co-authored-by: ArielElp <86294909+ArielElp@users.noreply.github.com> Co-authored-by: jumpman <57270771+kkawula@users.noreply.github.com> Co-authored-by: Omar U. Espejel <espejelomar@gmail.com> Co-authored-by: Raz Landau <125185051+LandauRaz@users.noreply.github.com> Co-authored-by: glihm <dev@glihm.net>

xiaolou86 force-pushed the starknet_message branch from a8219aa to e13279d Compare January 23, 2024 08:04

xiaolou86 changed the title ~~[WIP] add messaging_reference.adoc~~ Add messaging_reference.adoc Jan 24, 2024

xiaolou86 changed the title ~~Add messaging_reference.adoc~~ docs: add messaging_reference.adoc Jan 24, 2024

stoobie changed the base branch from main to xiaolou86/starknet_message January 30, 2024 08:09

stoobie changed the base branch from xiaolou86/starknet_message to main January 30, 2024 08:10

stoobie requested changes Jan 30, 2024

View reviewed changes

xiaolou86 mentioned this pull request Feb 28, 2024

fix: workflow for sending comment to PR #1152

Merged

2 tasks

stoobie requested a review from 0xLucqs April 1, 2024 04:01

0xLucqs requested changes Apr 1, 2024

View reviewed changes

stoobie mentioned this pull request Apr 1, 2024

feat: Starknet messaging function and event reference (based on #1094) #1209

Closed

2 tasks

xiaolou86 force-pushed the starknet_message branch 2 times, most recently from b73637d to 268b837 Compare April 7, 2024 07:45

stoobie and others added 10 commits June 9, 2024 17:25

edit messaging_reference.adoc

633fe6f

Edit messaging_reference.adoc, based on xiaolou86/starknet-docs/stark…

37259fc

…net_message

add the functions implemented in StarknetMessaging.sol but not part o…

2f8bd6d

…f the IStarknetMessaging.sol

Apply suggestions from code review

28bbffb

Co-authored-by: xiaolou86 <20718693+xiaolou86@users.noreply.github.com>

Update components/Starknet/modules/architecture_and_concepts/pages/Ne…

f9976eb

…twork_Architecture/messaging_reference.adoc

Apply suggestions from code review

108e3a2

Update components/Starknet/modules/architecture_and_concepts/pages/Ne…

13b166e

…twork_Architecture/messaging_reference.adoc

Explain deployer_address

aea46b3

Added links between consumeMessageFromL2 function and ConsumedMessage…

cb7f932

…ToL2 event.

Added links between consumeMessageFromL2 function and ConsumedMessage…

4671fe2

…ToL2 event.

modify event descriptions and add event heading for functions

35ee88c

xiaolou86 force-pushed the starknet_message branch from 8a1a9fb to 35ee88c Compare June 13, 2024 07:05

fix directory structure

a07de26

fix directory structure

ac5ae8e

Comment out events from internal processMessages function

bf9d6e8

stoobie approved these changes Jun 23, 2024

View reviewed changes

stoobie merged commit 568fda3 into starknet-io:main Jun 23, 2024
1 check was pending

xiaolou86 deleted the starknet_message branch June 24, 2024 02:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add messaging_reference.adoc #1094

docs: add messaging_reference.adoc #1094

xiaolou86 commented Jan 23, 2024 •

edited by stoobie

Loading

xiaolou86 commented Jan 24, 2024 •

edited

Loading

stoobie commented Jan 24, 2024 •

edited

Loading

xiaolou86 commented Jan 24, 2024

stoobie left a comment

stoobie commented Feb 14, 2024

stoobie commented Feb 26, 2024

xiaolou86 commented Feb 27, 2024

xiaolou86 commented Feb 27, 2024

github-actions bot commented Feb 28, 2024

stoobie commented Mar 26, 2024

xiaolou86 commented Mar 28, 2024

xiaolou86 commented Apr 2, 2024

xiaolou86 commented Apr 7, 2024 •

edited

Loading

starknet-bot commented May 5, 2024

starknet-bot commented May 6, 2024

starknet-bot commented May 6, 2024

starknet-bot commented May 6, 2024

starknet-bot commented May 6, 2024

starknet-bot commented May 7, 2024

stoobie commented Jun 9, 2024

starknet-bot commented Jun 13, 2024

xiaolou86 commented Jun 13, 2024

starknet-bot commented Jun 13, 2024

starknet-bot commented Jun 13, 2024

stoobie commented Jun 23, 2024

stoobie left a comment

starknet-bot commented Jun 23, 2024

stoobie commented Jun 30, 2024

xiaolou86 commented Jul 1, 2024

docs: add messaging_reference.adoc #1094

docs: add messaging_reference.adoc #1094

Conversation

xiaolou86 commented Jan 23, 2024 • edited by stoobie Loading

Description of the Changes

PR Preview URL

Check List

xiaolou86 commented Jan 24, 2024 • edited Loading

stoobie commented Jan 24, 2024 • edited Loading

xiaolou86 commented Jan 24, 2024

stoobie left a comment

Choose a reason for hiding this comment

stoobie commented Feb 14, 2024

stoobie commented Feb 26, 2024

xiaolou86 commented Feb 27, 2024

xiaolou86 commented Feb 27, 2024

github-actions bot commented Feb 28, 2024

stoobie commented Mar 26, 2024

xiaolou86 commented Mar 28, 2024

xiaolou86 commented Apr 2, 2024

xiaolou86 commented Apr 7, 2024 • edited Loading

starknet-bot commented May 5, 2024

starknet-bot commented May 6, 2024

starknet-bot commented May 6, 2024

starknet-bot commented May 6, 2024

starknet-bot commented May 6, 2024

starknet-bot commented May 7, 2024

stoobie commented Jun 9, 2024

starknet-bot commented Jun 13, 2024

xiaolou86 commented Jun 13, 2024

starknet-bot commented Jun 13, 2024

starknet-bot commented Jun 13, 2024

stoobie commented Jun 23, 2024

stoobie left a comment

Choose a reason for hiding this comment

starknet-bot commented Jun 23, 2024

stoobie commented Jun 30, 2024

xiaolou86 commented Jul 1, 2024

xiaolou86 commented Jan 23, 2024 •

edited by stoobie

Loading

xiaolou86 commented Jan 24, 2024 •

edited

Loading

stoobie commented Jan 24, 2024 •

edited

Loading

xiaolou86 commented Apr 7, 2024 •

edited

Loading