Skip to content

Commit 858710a

Browse files
Ilaria EnacheIlaria Enache
Ilaria Enache
authored and
Ilaria Enache
committed
sync with main
2 parents 655cea3 + 9e5e23c commit 858710a

File tree

2 files changed

+191
-0
lines changed

2 files changed

+191
-0
lines changed

learn/introduction.md

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
---
2+
title: Introduction to Wormhole
3+
description: Wormhole is a protocol for seamless communication between blockchains, enabling cross-chain applications and integrations.
4+
---
5+
<!--
6+
some links are blank because not all the pages are created yet
7+
also missing the list of blockchains
8+
9+
!!! No need to put all links in bold : check the rest
10+
-->
11+
# Introduction to Wormhole
12+
13+
Wormhole is a generic _message-passing protocol_ that enables communication between blockchains.
14+
15+
![Message-passing process in the Wormhole protocol](/images/learn/introduction/simple-overview.webp)
16+
17+
!!! note
18+
The above is an oversimplified illustration of the protocol; details about the architecture and components are available on the [architecture page](#){target=\_blank}.
19+
This simple message-passing protocol allows developers and users of cross-chain applications to leverage the advantages of multiple ecosystems.
20+
21+
## What Isn't Wormhole?
22+
23+
- **Wormhole is _not_ a blockchain** - it provides a means of communication between blockchains or rollups
24+
25+
- **Wormhole is _not_ a token bridge** - however, there are [protocols built on Wormhole](https://portalbridge.com/#/transfer){target=\_blank} that serve this purpose
26+
27+
## What Can Wormhole Be Used For?
28+
29+
Consider the following examples of potential applications enabled by Wormhole:
30+
31+
- **Cross-Chain Exchange** - using [Wormhole Connect](#){target=\_blank}, developers can build exchanges that allow deposits from any Wormhole-connected chain, significantly increasing liquidity access
32+
- **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
33+
- **Cross-Chain Game** - games can be developed on a performant network like Solana, with rewards issued as NFTs on another network, such as Ethereum
34+
35+
## Get Started
36+
37+
### Quick Start Tutorials
38+
39+
Tutorials are available to get started quickly and explain the concepts involved.
40+
41+
- **[Quick Start - Off Chain](#){target=\_blank}** - integrate Wormhole Connect into a new or existing web UI
42+
- **[Quick Start - On Chain](#){target=\_blank}** - send your first cross-chain message
43+
44+
More tutorials are available [on github](#){target=\_blank}. <!-- tutorials will be on the docs site -->
45+
46+
## Explore
47+
48+
Discover more about the Wormhole ecosystem, components, and protocols:
49+
50+
- **[Architecture](#){target=\_blank}** - explore the components of the protocol
51+
- **[Protocol Specifications](https://github.com/wormhole-foundation/wormhole/tree/main/whitepapers){target=\_blank}** - learn about the protocols built on top of Wormhole
52+
53+
## Demos
54+
55+
Demos offer more realistic implementations than tutorials:
56+
57+
- **[Wormhole Scaffolding](https://github.com/wormhole-foundation/wormhole-scaffolding){target=\_blank}** - quickly set up a project with the Scaffolding repo
58+
- **[xDapp Book Projects](https://github.com/wormhole-foundation/xdapp-book/tree/main/projects){target=\_blank}** - run and learn from example programs
59+
60+
More demos are available in the [demos page](#){target=\_blank}.
61+
62+
!!! note
63+
Wormhole Integration Complete?
64+
65+
Let us know so we can list your project in our ecosystem directory and introduce you to our global, multichain community!
66+
67+
**[Reach out now!](https://forms.clickup.com/45049775/f/1aytxf-10244/JKYWRUQ70AUI99F32Q){target=\_blank}**
68+
69+
## Supported Blockchains
70+
71+
Wormhole supports a growing number of blockchains.
72+
73+
<!-- List of Blockchains here -->

learn/security.md

+118
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
---
2+
title: Security
3+
description: Explore Wormhole's security features, including the Guardian network, governance, monitoring, open-source development, and bug bounty programs.
4+
---
5+
<!--
6+
some missing links will need to be added when pages are created
7+
-->
8+
# Security
9+
10+
## Core Security Assumptions
11+
12+
At its core, Wormhole is secured by a network of [Guardian](#){target=\_blank} nodes that validate and sign messages. If a super majority (e.g., 13 out of 19) of Guardians sign the same message, it can be considered valid. A smart contract on the target chain will verify the signatures and format of the message before approving any transaction.
13+
14+
- Wormhole's core security primitive is its signed messages (signed VAAs)
15+
- The Guardian network is currently secured by a collection of 19 of the world's top [validator companies](https://wormhole-foundation.github.io/wormhole-dashboard/#/?endpoint=Mainnet){target=\_blank}
16+
- Guardians produce signed state attestations (signed VAAs) when requested by a Core Contract integrator
17+
- Every Guardian runs full nodes (rather than light nodes) of every blockchain in the Wormhole network, so if a blockchain suffers a consensus attack or hard fork, the blockchain will disconnect from the network rather than potentially produce invalid signed VAAs
18+
- Any Signed VAA can be verified as authentic by the Core Contract of any other chain
19+
- Relayers are considered untrusted in the Wormhole ecosystem
20+
21+
In summary:
22+
23+
- **Core integrators aren't exposed to risk from chains and contracts they don't integrate with**
24+
- By default, you only trust Wormhole's signing process and the core contracts of the chains you're on
25+
- You can expand your contract and chain dependencies as you see fit
26+
27+
Core assumptions aside, many other factors impact the real-world security of decentralized platforms. Here is more information on additional measures that have been put in place to ensure the security of Wormhole.
28+
29+
## Guardian Network
30+
31+
Wormhole is an evolving platform. While the Guardian set currently comprises 19 validators, this is a limitation of current blockchain technology.
32+
33+
### Governance
34+
35+
Governance is the process through which contract upgrades happen. Guardians manually vote on governance proposals that originate inside the Guardian Network and are then submitted to ecosystem contracts.
36+
37+
This means that governance actions are held to the same security standard as the rest of the system. A two-thirds supermajority of the Guardians is required to pass any governance action.
38+
39+
Governance messages can target any of the various wormhole modules, including the core contracts and all currently deployed token bridge contracts. When a Guardian signs such a message, its signature implies a vote on the action in question. Once more than two-thirds of the Guardians have signed, the message and governance action are considered valid.
40+
41+
All governance actions and contract upgrades have been managed via Wormhole's on-chain governance system.
42+
43+
Via governance, the Guardians can:
44+
45+
- Change the current Guardian set
46+
- Expand the Guardian set
47+
- Upgrade ecosystem contract implementations
48+
49+
The governance system is fully open source in the core repository. See the [Open Source section](#){target=\_blank} for contract source.
50+
51+
## Monitoring
52+
53+
A key element of Wormhole's defense-in-depth strategy is that each Guardian is a highly competent validator company with its own in-house processes for running, monitoring, and securing blockchain operations. This heterogeneous approach to monitoring increases the likelihood that fraudulent activity is detected and reduces the number of single failure points in the system.
54+
55+
Guardians are not just running Wormhole validators; they're running validators for every blockchain inside of Wormhole as well, which allows them to perform monitoring holistically across decentralized computing rather than just at a few single points.
56+
57+
Guardians monitor:
58+
59+
- Block production and consensus of each blockchain - if a blockchain's consensus is violated, it will be disconnected from the network until the Guardians resolve the issue
60+
- Smart contract level data - via processes like the Governor, Guardians constantly monitor the circulating supply and token movements across all supported blockchains
61+
- Guardian level activity - the Guardian Network functions as an autonomous decentralized computing network, complete with its blockchain ([Gateway](#){target=\_blank})
62+
63+
## Gateway And Asset Layer Protections
64+
65+
One of the most powerful aspects of the Wormhole ecosystem is that Guardians effectively have the entire state of DeFi available to them.
66+
67+
Gateway is a Cosmos-based blockchain that runs internally to the Guardian network, whereby the Guardians can effectively execute smart contracts against the current state of all blockchains rather than just one blockchain.
68+
69+
This enables additional protection for the Wormhole Asset Layer in addition to the core assumptions:
70+
71+
- **Global Accountant** - the accountant tracks the total circulating supply of all Wormhole assets across all chains and prevents any blockchain from bridging assets which would violate the supply invariant
72+
73+
In addition to the Global Accountant, Guardians may only sign transfers that do not violate the requirements of the Governor. The [Governor](https://github.com/wormhole-foundation/wormhole/blob/main/whitepapers/0007_governor.md){target=\_blank} tracks inflows and outflows of all blockchains and delays suspicious transfers that may indicate an exploit.
74+
75+
## Open Source
76+
77+
Wormhole builds in the open and is always open source.
78+
79+
- **[Wormhole core repository](https://github.com/wormhole-foundation/wormhole){target=\_blank}**
80+
- **[Wormhole Foundation GitHub organization](https://github.com/wormhole-foundation){target=\_blank}**
81+
- **[Wormhole contract deployments](#){target=\_blank}** <!-- link to core contracts page-->
82+
83+
## Audits
84+
85+
Wormhole has been heavily audited, with _29 third-party audits completed_ and more started.
86+
87+
Wormhole has had audits performed by the following firms, and continues to seek more:
88+
89+
- Trail of Bits
90+
- Neodyme
91+
- Kudelski
92+
- OtterSec
93+
- Certik
94+
- Hacken
95+
- Zellic
96+
- Coinspect
97+
- Halborn
98+
99+
[The most up-to-date list of audits, as well as the final reports](https://github.com/wormhole-foundation/wormhole/blob/main/SECURITY.md#3rd-party-security-audits){target=\blank}.
100+
101+
## Bug Bounties
102+
103+
Wormhole has one of the largest bug bounty programs in software development and has repeatedly shown commitment to engaging with the white hat community.
104+
105+
Wormhole hosts two bug bounty programs:
106+
107+
- An [Immunefi](https://immunefi.com/bug-bounty/wormhole/){target=\blank} program
108+
- As well as a [self-hosted program](https://immunefi.com/bug-bounty/wormhole/){target=\blank}
109+
110+
Both platforms have a top payout of _2.5 million dollars_.
111+
112+
If you are interested in contributing to Wormhole security, please look at this section for [Getting Started as a White Hat](https://github.com/wormhole-foundation/wormhole/blob/main/SECURITY.md#white-hat-hacking){target=\blank}, and follow the [Wormhole Contributor Guidelines](https://github.com/wormhole-foundation/wormhole/blob/main/CONTRIBUTING.md){target=\blank}.
113+
114+
For more information about submitting to the bug bounty programs, refer to the [Wormhole Immunefi page](https://immunefi.com/bug-bounty/wormhole/){target=\blank}.
115+
116+
## Learn More
117+
118+
The [SECURITY.md](https://github.com/wormhole-foundation/wormhole/blob/main/SECURITY.md){target=\blank} from the official repository has the latest security policies and updates.

0 commit comments

Comments
 (0)