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.

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

Jump to bottom

New section for Router Protocol #974

Merged
merged 2 commits into from
Oct 10, 2024
Merged

New section for Router Protocol #974

merged 2 commits into from
Oct 10, 2024

Conversation

rube-de
Copy link
Contributor

@rube-de rube-de commented Oct 7, 2024 •
edited by matevz
Loading

@netlify Netlify
Copy link

netlify bot commented Oct 7, 2024 •
edited
Loading

✅ Deploy Preview for oasisprotocol-docs ready!

Name Link
🔨 Latest commit 1b32acf
🔍 Latest deploy log https://app.netlify.com/sites/oasisprotocol-docs/deploys/6707e76e553b770008cc98f3
😎 Deploy Preview https://deploy-preview-974--oasisprotocol-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@rube-de rube-de force-pushed the rube/router-newsection branch from 3aa3289 to a72d62f Compare October 8, 2024 11:41
@rube-de rube-de requested review from aefhm, matevz and CedarMist October 8, 2024 12:05
@rube-de rube-de marked this pull request as ready for review October 8, 2024 12:36
@rube-de rube-de self-assigned this Oct 8, 2024
@rube-de rube-de mentioned this pull request Oct 9, 2024
Closed
matevz
matevz reviewed Oct 9, 2024
View reviewed changes
Copy link
Member

@matevz matevz left a comment

Choose a reason for hiding this comment

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

First pass.

docs/dapp/opl/router-protocol/README.mdx Outdated Show resolved Hide resolved
docs/dapp/opl/router-protocol/README.mdx Outdated Show resolved Hide resolved
docs/dapp/opl/router-protocol/README.mdx Outdated Show resolved Hide resolved
docs/dapp/opl/router-protocol/README.mdx Outdated Show resolved Hide resolved
docs/dapp/opl/router-protocol/README.mdx Outdated Show resolved Hide resolved
docs/dapp/opl/router-protocol/README.mdx Outdated Show resolved Hide resolved
docs/dapp/opl/router-protocol/README.mdx Outdated Show resolved Hide resolved
docs/dapp/opl/router-protocol/pingpong/README.md Outdated Show resolved Hide resolved
docs/dapp/opl/router-protocol/pingpong/deploy.md Outdated Show resolved Hide resolved
docs/dapp/images/opl/router-architecture.png Outdated Show resolved Hide resolved
@rube-de rube-de force-pushed the rube/router-newsection branch from a72d62f to 955e373 Compare October 9, 2024 11:10
CedarMist
CedarMist suggested changes Oct 9, 2024
View reviewed changes
docs/dapp/opl/router-protocol/pingpong/README.md Outdated Show resolved Hide resolved
docs/dapp/opl/router-protocol/README.mdx Outdated Show resolved Hide resolved
@CedarMist CedarMist self-requested a review October 9, 2024 17:24
CedarMist
CedarMist approved these changes Oct 9, 2024
View reviewed changes
Copy link
Contributor

@CedarMist CedarMist left a comment

Choose a reason for hiding this comment

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

Looks good

Not sure if @matevz has any objections before merging.

Also, remember to update https://github.com/oasisprotocol/sapphire-paratime/blob/main/docs/addresses.md with the addresses for all the pertinent Router protocol contracts on Testnet & Mainnet.

@CedarMist
Copy link
Contributor

It's worth including the source for any flow diagrams too btw. e.g. docs/dapp/diagrams/opl-contract-flow.mmd so they can be updated easily if needed in future.

@rube-de
Copy link
Contributor Author

rube-de commented Oct 9, 2024

Also, remember to update https://github.com/oasisprotocol/sapphire-paratime/blob/main/docs/addresses.md with the addresses for all the pertinent Router protocol contracts on Testnet & Mainnet.

I opened an issue on sapphire repo: oasisprotocol/sapphire-paratime#432

@rube-de rube-de requested a review from matevz October 9, 2024 23:34
@rube-de rube-de force-pushed the rube/router-newsection branch 3 times, most recently from e4559c6 to a722480 Compare October 10, 2024 12:33
@rube-de rube-de requested a review from matevz October 10, 2024 12:38
@rube-de rube-de force-pushed the rube/router-newsection branch from a722480 to b313a30 Compare October 10, 2024 12:48
matevz
matevz reviewed Oct 10, 2024
View reviewed changes
Copy link
Member

@matevz matevz left a comment

Choose a reason for hiding this comment

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

Maybe put these in new lines so the diagram is not too wide.

docs/dapp/diagrams/opl-router-pingpong-flow.mmd Outdated Show resolved Hide resolved
docs/dapp/diagrams/opl-router-pingpong-flow.mmd Outdated Show resolved Hide resolved
docs/dapp/diagrams/opl-router-pingpong-flow.mmd Outdated Show resolved Hide resolved
matevz
matevz approved these changes Oct 10, 2024
View reviewed changes
Copy link
Member

@matevz matevz left a comment

Choose a reason for hiding this comment

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

Found some more typos. Otherwise looks good!

docs/dapp/opl/router-protocol/pingpong-example.md Outdated Show resolved Hide resolved
docs/dapp/opl/router-protocol/pingpong-example.md Outdated Show resolved Hide resolved
docs/dapp/opl/router-protocol/interface.md Outdated Show resolved Hide resolved
docs/dapp/opl/router-protocol/interface.md Outdated Show resolved Hide resolved
docs/dapp/opl/router-protocol/interface.md Outdated Show resolved Hide resolved
docs/dapp/opl/router-protocol/approve.md Outdated Show resolved Hide resolved
@rube-de rube-de force-pushed the rube/router-newsection branch from 95678b6 to 3690136 Compare October 10, 2024 13:13
@rube-de rube-de force-pushed the rube/router-newsection branch from c62fd87 to 1b32acf Compare October 10, 2024 14:40
@rube-de rube-de merged commit f80485b into main Oct 10, 2024
6 checks passed
@rube-de rube-de deleted the rube/router-newsection branch October 10, 2024 14:47
aefhm
aefhm reviewed Oct 11, 2024
View reviewed changes
docs/dapp/opl/router-protocol/pingpong-example.md
If you're new to Remix, follow our basic guide for using Remix
[here][dapp-remix].

[dapp-remix]: /dapp/emerald/writing-dapps-on-emerald#create-dapp-on-emerald-with-remix---ethereum-ide
Copy link
Contributor

Choose a reason for hiding this comment

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

I suppose this'll likely move over to dapp/tools later.

aefhm
aefhm reviewed Oct 11, 2024
View reviewed changes
docs/dapp/opl/router-protocol/pingpong-example.md
### Key Contract Functions

- `iPing`: Initiates the cross-chain message by calling Router's
`IGateway.iSend`.
Copy link
Contributor

Choose a reason for hiding this comment

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

(unrelated) I do find the new backticked code to not look as nice.

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aefhm aefhm aefhm left review comments

@matevz matevz matevz approved these changes

@CedarMist CedarMist CedarMist approved these changes

Assignees

@rube-de rube-de

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@rube-de @CedarMist @matevz @aefhm