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

Docs improvements #3368

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

Docs improvements #3368

wants to merge 12 commits into from

Conversation

nnsW3
Copy link

@nnsW3 nnsW3 commented Jun 28, 2024

This PR addresses several typographical errors across various files in the project. The changes improve readability and maintain the professional standard of the documentation and code comments.

Justification
Typographical errors, while minor, can detract from the overall quality of the project. Correcting these errors ensures clarity and professionalism, making the project more accessible and understandable for current and future contributors.

Hope it helps.

Signed-off-by: Elias Rad <146735585+nnsW3@users.noreply.github.com>
Signed-off-by: Elias Rad <146735585+nnsW3@users.noreply.github.com>
Signed-off-by: Elias Rad <146735585+nnsW3@users.noreply.github.com>
Signed-off-by: Elias Rad <146735585+nnsW3@users.noreply.github.com>
Signed-off-by: Elias Rad <146735585+nnsW3@users.noreply.github.com>
Signed-off-by: Elias Rad <146735585+nnsW3@users.noreply.github.com>
@@ -11,7 +11,7 @@
## Introduction
Recent years have witnessed a growing demand for enabling interoperability across independent blockchains. Cross-chain asset exchange is a significant step towards blockchain interoperability. For public blockchains, the most popular application for asset exchange is cryptocurrency exchange. For permissioned blockchains, cross-chain asset exchange can be useful in [Delivery Versus Payment (DvP)](https://www.mas.gov.sg/-/media/MAS/ProjectUbin/Project-Ubin-DvP-on-Distributed-Ledger-Technologies.pdf) and [cross-border payment](https://www.mas.gov.sg/-/media/Jasper-Ubin-Design-Paper.pdf) scenarios. There exist various protocols designed for asset exchange on public blockchains. However, a widely adopted standard for designing such protocols for permissioned blockchains still does not exist. Moreover, most existing protocols are designed for public blockchains and their suitability to be applied to permissioned blockchains is unclear.

In this article, we aim to lay out a set of requirements for designing cross-chain asset exchange protocols between permissioned blockchains. First we present a canonical motivating use case and then list the various patterns that such cases will follow in real-life scenarios. We then present a short survey of existing cross-chain exchange protocols for public blockchains, following which we summarise the building blocks, core mechanisms and security properties commonly involved in the protocol designs. We then analyse the requirements imposed by permissioned blockchains in comparison to public blockchains, and discuss the additional properties with respect to these restrictions.
In this article, we aim to lay out a set of requirements for designing cross-chain asset exchange protocols between permissioned blockchains. First we present a canonical motivating use case and then list the various patterns that such cases will follow in real-life scenarios. We then present a short survey of existing cross-chain exchange protocols for public blockchains, following which we summarise the building blocks, core mechanisms and security properties commonly involved in the protocol designs. We then analyze the requirements imposed by permissioned blockchains in comparison to public blockchains, and discuss the additional properties with respect to these restrictions.
Copy link
Member

Choose a reason for hiding this comment

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

analyse isn't wrong.

@sandeepnRES
Copy link
Member

Also you need to follow the guidelines specified in Contributing.md, there's lots of issues please go through it.

nnsW3 added 2 commits July 3, 2024 12:42
Signed-off-by: Elias Rad <146735585+nnsW3@users.noreply.github.com>
Copy link
Member

@petermetz petermetz left a comment

Choose a reason for hiding this comment

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

Thank you for the contribution @nnsW3! LGTM once the comments from @sandeepnRES have been addressed!

@jagpreetsinghsasan
Copy link
Contributor

Also you need to follow the guidelines specified in Contributing.md, there's lots of issues please go through it.

+1
@nnsW3 please let me know if you are facing issues around this. I can help you fix these.

@nnsW3
Copy link
Author

nnsW3 commented Jul 8, 2024

Also you need to follow the guidelines specified in Contributing.md, there's lots of issues please go through it.

+1 @nnsW3 please let me know if you are facing issues around this. I can help you fix these.
i would like your help, I'm currently working from browser ? could you explain me what shall I do next

@outSH
Copy link
Contributor

outSH commented Jul 9, 2024

@nnsW3 Read the Contributing.md file in root of the project and comply to it's requirements. In particular, you need to squash all the commits into single one, change the commit title and description and include sign-off in the commit. Lint PR / Validate PR title (pull_request_target) should be passing. Consult the file for more details

@RafaelAPB
Copy link
Contributor

@nnsW3 thank you for your contribution! Can you please follow the suggestions of @outSH so we can merge your contribution?

@petermetz
Copy link
Member

@nnsW3 Plus one to the above. Are you still working on this PR? If not, that's OK too I'm just asking for house-keeping purposes, we'd like to not have dangling PRs open for too long if possible. :-)

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.

6 participants