-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
grammarly and style checklist checked
- Loading branch information
Ilaria Enache
authored and
Ilaria Enache
committed
Jul 26, 2024
1 parent
724164b
commit d3c48ca
Showing
1 changed file
with
33 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,67 +1,70 @@ | ||
<!-- | ||
some links are blank because not all the pages are created yet | ||
also missing the list of blockchains | ||
the rest should be fine for now | ||
--> | ||
Wormhole is a generic **message passing protocol** that enables communication between blockchains. | ||
# Introduction to Wormhole | ||
|
||
<!-- | ||
protocol img here | ||
--> | ||
Wormhole is a generic **message-passing protocol** that enables communication between blockchains. | ||
|
||
![Overview](/wormhole-mkdocs/images/learn/introduction/overview.webp) | ||
|
||
!!! note | ||
The above is an oversimplified illustration of the protocol, details about the architecture and components are available [here](#). | ||
The above is an oversimplified illustration of the protocol; details about the architecture and components are available in the **[architecture page](#){target=\_blank}**. | ||
|
||
|
||
This simple message-passing protocol allows developers and users of cross-chain applications to leverage the advantages of multiple ecosystems. | ||
|
||
### What Isn't Wormhole? | ||
## What Isn't Wormhole? | ||
|
||
- **Wormhole is _not_ a blockchain** - it provides a means of communication between blockchains or rollups | ||
|
||
- **Wormhole is not a blockchain**: It provides a means of communication between blockchains or rollups. | ||
- **Wormhole is not a token bridge**: However, there are [protocols built on Wormhole](https://portalbridge.com/#/transfer) that serve this purpose. | ||
- **Wormhole is _not_ a token bridge** - however, there are **[protocols built on Wormhole](https://portalbridge.com/#/transfer){target=\_blank}** that serve this purpose | ||
|
||
### What Can Wormhole Be Used For? | ||
## What Can Wormhole Be Used For? | ||
|
||
Consider the following examples of potential applications enabled by Wormhole: | ||
|
||
- **Cross-Chain Exchange**: Using [Wormhole Connect](#), developers can build exchanges that allow deposits from any Wormhole-connected chain, significantly increasing liquidity access. | ||
- **Cross-Chain Governance**: NFT collections on different networks can use Wormhole to communicate votes cast on their respective chains to a designated "voting" chain for combined proposals. | ||
- **Cross-Chain Game**: Games can be developed on a performant network like Solana, with rewards issued as NFTs on another network, such as Ethereum. | ||
- **Cross-Chain Exchange** - using **[Wormhole Connect](#){target=\_blank}**, developers can build exchanges that allow deposits from any Wormhole-connected chain, significantly increasing liquidity access | ||
- **Cross-Chain Governance** - NFT collections on different networks can use Wormhole to communicate votes cast on their respective chains to a designated "voting" chain for combined proposals | ||
- **Cross-Chain Game** - games can be developed on a performant network like Solana, with rewards issued as NFTs on another network, such as Ethereum | ||
|
||
### Get Started | ||
## Get Started | ||
|
||
#### Quick Start Tutorials | ||
### Quick Start Tutorials | ||
|
||
Tutorials are available to get started quickly and explain the concepts involved. | ||
|
||
- **Quick Start - Off Chain**: Integrate Wormhole Connect into a new or existing web UI. | ||
- **Quick Start - On Chain**: Send your first cross-chain message. | ||
- **[Quick Start - Off Chain](#){target=\_blank}** - integrate Wormhole Connect into a new or existing web UI | ||
- **[Quick Start - On Chain](#){target=\_blank}** - send your first cross-chain message | ||
|
||
More tutorials are available [here](#). | ||
More tutorials are available **[on github](https://github.com/wormhole-foundation/docs.wormhole.com/blob/main/docs/tutorials/quick-start/README.md){target=\_blank}**. | ||
|
||
### Explore | ||
## Explore | ||
|
||
Discover more about the Wormhole ecosystem, components, and protocols: | ||
|
||
- **Architecture**: Explore the components of the protocol. | ||
- **Protocol Specifications**: Learn about the protocols built on top of Wormhole. | ||
- **[Architecture](#){target=\_blank}** - explore the components of the protocol | ||
- **[Protocol Specifications](https://github.com/wormhole-foundation/wormhole/tree/main/whitepapers){target=\_blank}** - learn about the protocols built on top of Wormhole | ||
|
||
### Demos | ||
## Demos | ||
|
||
Demos offer more realistic implementations than tutorials: | ||
|
||
- **Wormhole Scaffolding**: Quickly set up a project with the Scaffolding repo. | ||
- **xDapp Book Projects**: Run and learn from example programs. | ||
- **[Wormhole Scaffolding](https://github.com/wormhole-foundation/wormhole-scaffolding){target=\_blank}** - quickly set up a project with the Scaffolding repo | ||
- **[xDapp Book Projects](https://github.com/wormhole-foundation/xdapp-book/tree/main/projects){target=\_blank}** - run and learn from example programs | ||
|
||
More demos are available [here](#). | ||
More demos are available in the **[demos page](#){target=\_blank}**. | ||
|
||
!!! note | ||
## Wormhole Integration Complete? | ||
|
||
<!-- in box --> | ||
### Wormhole Integration Complete? | ||
|
||
Let us know so we can list your project in our ecosystem directory and introduce you to our global, multichain community! | ||
Let us know so we can list your project in our ecosystem directory and introduce you to our global, multichain community! | ||
|
||
[Reach out now!](#) | ||
**[Reach out now!](https://forms.clickup.com/45049775/f/1aytxf-10244/JKYWRUQ70AUI99F32Q){target=\_blank}** | ||
|
||
### Supported Blockchains | ||
## Supported Blockchains | ||
|
||
Wormhole supports a growing number of blockchains. | ||
|
||
<!-- List of Blockchains here --> |