starknet-docs icon indicating copy to clipboard operation
starknet-docs copied to clipboard

Published 20 hours ago • verified publisher icon starknet-io

docs: add messaging_reference.adoc

Open xiaolou86 opened this issue 1 year ago • 20 comments

Description of the Changes

Add messaging_reference.adoc

Closes #1086

PR Preview URL

Messaging reference

Check List

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

This change is Reviewable

xiaolou86 avatar Jan 23 '24 08:01 xiaolou86

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

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

xiaolou86 avatar Jan 24 '24 06:01 xiaolou86

@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?

stoobie avatar Jan 24 '24 08:01 stoobie

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.

xiaolou86 avatar Jan 24 '24 10:01 xiaolou86

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

stoobie avatar Feb 14 '24 15:02 stoobie

@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.

stoobie avatar Feb 26 '24 14:02 stoobie

@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 avatar Feb 27 '24 02:02 xiaolou86

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

xiaolou86 avatar Feb 27 '24 02:02 xiaolou86

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

github-actions[bot] avatar Feb 28 '24 16:02 github-actions[bot]

@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.

stoobie avatar Mar 26 '24 13:03 stoobie

@stoobie Thank you very much.

xiaolou86 avatar Mar 28 '24 01:03 xiaolou86

@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 avatar Apr 02 '24 01:04 xiaolou86

@stoobie @LucasLvy thank you for your reviews.

I have updated the docs:

  1. Adds the functions implemented in StarknetMessaging.sol but not part of the IStarknetMessaging.sol:
l1ToL2MessageCancellations
l1ToL2MessageNonce
l2ToL1Messages
messageCancellationDelay
  1. Adds a link to the messageCancellationDelay function on etherscan to get the real value.

xiaolou86 avatar Apr 07 '24 07:04 xiaolou86

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 avatar May 05 '24 10:05 starknet-bot

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 avatar May 06 '24 07:05 starknet-bot

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 avatar May 06 '24 10:05 starknet-bot

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 avatar May 06 '24 12:05 starknet-bot

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 avatar May 06 '24 15:05 starknet-bot

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 avatar May 07 '24 14:05 starknet-bot

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 avatar May 08 '24 11:05 starknet-bot

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 avatar May 15 '24 12:05 starknet-bot

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 avatar May 19 '24 10:05 starknet-bot

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 avatar May 19 '24 10:05 starknet-bot

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 avatar May 20 '24 12:05 starknet-bot

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 avatar May 22 '24 08:05 starknet-bot

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 avatar May 26 '24 10:05 starknet-bot

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 avatar May 26 '24 10:05 starknet-bot

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 avatar May 26 '24 15:05 starknet-bot

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 avatar May 27 '24 08:05 starknet-bot

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 avatar May 28 '24 08:05 starknet-bot

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 avatar May 30 '24 15:05 starknet-bot