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

Ilariae/architecture #3

Merged
merged 16 commits into from
Jul 31, 2024
Binary file added images/learn/introduction/simple-overview.webp
Binary file not shown.
1 change: 1 addition & 0 deletions learn/.pages
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@ nav:
- index.md
- 'Introduction to Wormhole': 'introduction.md'
- 'Security': security.md
- 'Architecture Overview': architecture.md
- infrastructure
33 changes: 33 additions & 0 deletions learn/architecture.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: Architecture
description: Overview of Wormhole's architecture, detailing key on-chain and off-chain components like the Core Contract, Guardian Network, and relayers.
---
<!--
need to link this page in the introduction page once its merged
need to add links
-->
# Architecture Overview

## Architecture

Wormhole has several noteworthy components. Before we discuss each component in depth, let's discuss the names of the major pieces and how they fit together.

![Wormhole architecture detailed diagram: source to target chain communication.](/images/learn/architecture/overview.webp)

## On-Chain Components

- **Emitter** - a contract that calls the publish message method on the Core Contract. The core contract will write an event to the Transaction Logs with details about the emitter and sequence number to identify the message. This may be your [xDapp](#){target=\_blank} or an existing ecosystem protocol <!-- link to glossary xDapp -->
- **[Wormhole core contract](#){target=\_blank}** - primary contract, this is the contract which the Guardians observe and which fundamentally allows for cross-chain communication <!-- link to core contracts page -->
- **Transaction Log** - blockchain-specific logs that allow the Guardians to observe messages emitted by the core contract

## Off-Chain Components

- **Guardian Network** - validators that exist in their own P2P network. Guardians observe and validate the messages emitted by the Core Contract on each supported chain to produce VAAs (signed messages)
- **[Guardian](#){target=\_blank}** - one of 19 validators in the Guardian Network that contributes to the VAA multi-sig
- **[Spy](#){target=\_blank}** - a daemon that subscribes to messages published within the Guardian Network. A Spy can observe and forward network traffic, which helps scale up VAA distribution
- **[API](#){target=\_blank}** - a REST server to retrieve details for a VAA or the guardian network
- **[VAAs](/learn/infrastructure/vaas/){target=\_blank}** - verifiable Action Approvals (VAAs) are the signed attestation of an observed message from the wormhole core contract.
- **[Relayer](#){target=\_blank}** - any off-chain process that relays a VAA to the target chain
- **Standard Relayers** - a decentralized relayer network that delivers messages that are requested on-chain via the Wormhole Relay Contract. Also referred to as Generic Relayers
- **Specialized Relayers** - relayers that only handle VAAs for a specific protocol or cross-chain application. They can execute custom logic off-chain, reducing gas costs and increasing cross-chain compatibility. Currently, cross-chain application developers are responsible for developing and hosting specialized relayers

70 changes: 0 additions & 70 deletions learn/introduction.md

This file was deleted.

112 changes: 0 additions & 112 deletions learn/security.md

This file was deleted.

Loading