diff --git a/docs/build/use-cases/order-xclearing.md b/docs/build/use-cases/order-xclearing.md index 1e5588f..7968c8c 100644 --- a/docs/build/use-cases/order-xclearing.md +++ b/docs/build/use-cases/order-xclearing.md @@ -2,7 +2,7 @@ Many use cases involve order clearing, such as order book DEXs, swap DEXs, equivalent swap, NFT markets, and more. These use cases can all be extended to cross-chain scenarios. Helix Bridge is one such example. It is a third-party token bridge that allows users to perform cross-chain swaps with liquidity relayers, serving as permissionless order takers and makers, essentially facilitating order based cross-chain equivalent swap. -For example, [Helix Bridge](https://helixbridge.app/) leverages [Msgport](../../learn/index.md) to do settements after users taking orders of liquidity relayer. Msgport can deliver messages indicating that whether liquidity relayer fullfill user's order successfullly or not, where truth of messages are verified by the underlining message protocols Msgport are integrating. +For example, [Helix Bridge](https://helixbridge.app/) leverages [Msgport](../../index.md) to do settements after users taking orders of liquidity relayer. Msgport can deliver messages indicating that whether liquidity relayer fullfill user's order successfullly or not, where truth of messages are verified by the underlining message protocols Msgport are integrating. !!! Quote The advantage of using `Msgport` is that it is very easy to switch between different low-level message layers without making big changes to the code. — Helix Bridge diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..e0d21ca --- /dev/null +++ b/docs/index.md @@ -0,0 +1,26 @@ +# Overview + +In the evolving landscape of blockchain technology, the need for interoperability and seamless communication between diverse blockchains has never been more critical. Msgport, stands at the forefront of this challenge, offering a robust solution for cross-chain messaging. With a focus on facilitating effortless asset and information transfer across blockchains, Msgport is revolutionizing the way applications communicate in web 3.0. + +## Core Components and Innovations + +The Msgport encompasses a collection of smart contracts that outline standardized interfaces for facilitating a cross-chain messaging protocol. + +At the heart of this system is the core interface, [IMessagePort](./learn/interfaces.md#imessageport), which is designed with flexibility to support various implementations. + +![msgport-overview-1](./images/msgport-overview-1.png) + +Highlighting Msgport's versatility are its flagship integrations: + + - [ORMP](./learn/messaging-protocols/ormp.md): Oracle Relayer Messaging Protocol leverages chain-independent components, such as oracles and DApp-preferred relayers, to verify cross-chain messages. This approach integrates diverse verification mechanisms, ensuring robust and flexible cross-chain communication. + - [LCMP](./learn/messaging-protocols/lcmp.md): Light Client Cross-Chain Messaging Protocol employs blockchain consensus mechanisms and light clients as decentralized verifiers. This ensures the integrity and accuracy of message verification across different blockchains, fostering a secure and trustless environment for message passing. + - [XCMP](./learn/messaging-protocols/xcmp.md): Developed by Polkadot, Cross-Consensus Message Passing facilitates seamless messaging between various parachains within the Polkadot network. Messages are exchanged directly by parachains, relayed and verified by the relay chain, exemplifying efficient inter-parachain communication and interoperability. + +These implementations underscore Msgport's commitment to fostering interoperability, ensuring that assets and information can navigate the complex landscape of blockchain technology smoothly. + +## Integration and Understanding +For developers and applications eager to leverage the power of Msgport, the journey begins with the [Msgport Workflow Documentation](./learn/workflow.md) and a series of comprehensive [Tutorials](./build/tutorial/remix-demo.md). These resources are meticulously crafted to demystify the complexities of Msgport, offering a clear path to integration. From foundational knowledge to step-by-step guides, developers can expect a seamless onboarding experience, enabling them to harness the full potential of cross-chain messaging. + +## Embracing the Future + +As the digital world continues to evolve, Msgport stands as a beacon of innovation, guiding the way towards a more interconnected and efficient blockchain ecosystem. Whether you are looking to bridge assets or enhance the capabilities of your blockchain application, Msgport offers the tools and support needed to transcend traditional boundaries and embrace the future of cross-chain communication. \ No newline at end of file diff --git a/docs/learn/index.md b/docs/learn/index.md deleted file mode 100644 index ebdaf7b..0000000 --- a/docs/learn/index.md +++ /dev/null @@ -1,26 +0,0 @@ -# Overview - -In the evolving landscape of blockchain technology, the need for interoperability and seamless communication between diverse blockchains has never been more critical. Msgport, stands at the forefront of this challenge, offering a robust solution for cross-chain messaging. With a focus on facilitating effortless asset and information transfer across blockchains, Msgport is revolutionizing the way applications communicate in web 3.0. - -## Core Components and Innovations - -The Msgport encompasses a collection of smart contracts that outline standardized interfaces for facilitating a cross-chain messaging protocol. - -At the heart of this system is the core interface, [IMessagePort](./interfaces.md#imessageport), which is designed with flexibility to support various implementations. - -![msgport-overview-1](../images/msgport-overview-1.png) - -Highlighting Msgport's versatility are its flagship integrations: - - - [ORMP](./messaging-protocols/ormp.md): Oracle Relayer Messaging Protocol leverages chain-independent components, such as oracles and DApp-preferred relayers, to verify cross-chain messages. This approach integrates diverse verification mechanisms, ensuring robust and flexible cross-chain communication. - - [LCMP](./messaging-protocols/lcmp.md): Light Client Cross-Chain Messaging Protocol employs blockchain consensus mechanisms and light clients as decentralized verifiers. This ensures the integrity and accuracy of message verification across different blockchains, fostering a secure and trustless environment for message passing. - - [XCMP](./messaging-protocols/xcmp.md): Developed by Polkadot, Cross-Consensus Message Passing facilitates seamless messaging between various parachains within the Polkadot network. Messages are exchanged directly by parachains, relayed and verified by the relay chain, exemplifying efficient inter-parachain communication and interoperability. - -These implementations underscore Msgport's commitment to fostering interoperability, ensuring that assets and information can navigate the complex landscape of blockchain technology smoothly. - -## Integration and Understanding -For developers and applications eager to leverage the power of Msgport, the journey begins with the [Msgport Workflow Documentation](./workflow.md) and a series of comprehensive [Tutorials](../build/tutorial/remix-demo.md). These resources are meticulously crafted to demystify the complexities of Msgport, offering a clear path to integration. From foundational knowledge to step-by-step guides, developers can expect a seamless onboarding experience, enabling them to harness the full potential of cross-chain messaging. - -## Embracing the Future - -As the digital world continues to evolve, Msgport stands as a beacon of innovation, guiding the way towards a more interconnected and efficient blockchain ecosystem. Whether you are looking to bridge assets or enhance the capabilities of your blockchain application, Msgport offers the tools and support needed to transcend traditional boundaries and embrace the future of cross-chain communication. diff --git a/docs/learn/messaging-protocols/xcmp.md b/docs/learn/messaging-protocols/xcmp.md index 66592a8..eb94ea0 100644 --- a/docs/learn/messaging-protocols/xcmp.md +++ b/docs/learn/messaging-protocols/xcmp.md @@ -2,6 +2,6 @@ XCMP, or [Cross-Consensus Message Passing](https://wiki.polkadot.network/docs/learn-xcm), is a crucial technology for the Polkadot network. It makes it possible for the different blockchains within Polkadot, known as parachains, to talk to each other securely and without trouble. This is a big win for working together across the network. But sometimes, these parachains want to reach out beyond Polkadot, especially to talk with Ethereum's blockchain. To do this, they can't use XCMP and need a different kind of messaging bridge. -Enter Darwinia. This network is tailored to fill this gap. It understands XCMP for communication within Polkadot and also speaks the language of Ethereum's blockchain (thanks to its compatibility with the EVM - Ethereum Virtual Machine). On top of that, Darwinia uses something called [Msgport](../index.md), which is like an extra feature that makes this cross-chain conversation even smoother. It's like having a translator who's fluent in both communities' languages, making Darwinia the go-to connector for Polkadot parachains that want to interact with Ethereum's world. +Enter Darwinia. This network is tailored to fill this gap. It understands XCMP for communication within Polkadot and also speaks the language of Ethereum's blockchain (thanks to its compatibility with the EVM - Ethereum Virtual Machine). On top of that, Darwinia uses something called [Msgport](../../index.md), which is like an extra feature that makes this cross-chain conversation even smoother. It's like having a translator who's fluent in both communities' languages, making Darwinia the go-to connector for Polkadot parachains that want to interact with Ethereum's world. The support for XCMP within Msgport is a highly anticipated feature that our core development team is actively working on. It's on our to-do list and we plan to roll it out soon, so stay tuned for this promising update. \ No newline at end of file diff --git a/docs/learn/networks.md b/docs/learn/networks.md index 1c9905e..e7b763a 100644 --- a/docs/learn/networks.md +++ b/docs/learn/networks.md @@ -1,5 +1,5 @@ # Supported Network -The [Msgport](./index.md) is a robust and reliable communication protocol that has been deployed on various blockchains, including Ethereum and Arbitrum. This protocol has undergone careful revisions to enhance its developer and user-friendliness. +The [Msgport](./../index.md) is a robust and reliable communication protocol that has been deployed on various blockchains, including Ethereum and Arbitrum. This protocol has undergone careful revisions to enhance its developer and user-friendliness. You can find the comprehensive list of supported networks [here](https://github.com/msgport/msgport/blob/main/SUPPORTED.md). Please note that the specific port contract address is the same across all supported networks. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 2285d56..523a220 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -121,7 +121,7 @@ plugins: nav: - Learn Msgport: - - Overview: "learn/index.md" + - Overview: "index.md" - Glossary: "learn/glossary.md" - Interfaces: "learn/interfaces.md" - Workflow: "learn/workflow.md"