Ilariae/core contracts

.snippets/code/learn/messaging/core-contracts/receiving.js

@@ -0,0 +1 @@
+parseAndVerifyVAA(byte[] VAA)

.snippets/code/learn/messaging/core-contracts/sending.js

@@ -0,0 +1,5 @@
+publishMessage(
+    int nonce,
+    byte[] payload,
+    int consistencyLevel
+) returns int sequenceNumber

learn/.pages

@@ -5,3 +5,4 @@ nav:
  - 'Security': 'security.md'
  - 'Architecture Overview': 'architecture.md'
  - infrastructure
+ - messaging

learn/messaging/.pages

@@ -0,0 +1,6 @@
+title: Messaging
+nav:
+ - index.md
+ - 'Overview': 'overview.md'
+ - 'Core Contracts': 'core-contracts.md'
+ - 'Token and NFT Bridge': 'token-nft-bridge.md'

learn/messaging/core-contracts.md

@@ -0,0 +1,74 @@
+---
+title: Core Contracts
+description: Discover Wormhole's Core Contracts, enabling cross-chain communication with message sending, receiving, and multicast features for efficient synchronization.
+---
+
+# Core Contracts
+
+The Core Contracts are the mechanism by which all Wormhole messages are emitted. All cross-chain applications either interact directly with the Core Contract or interact with another contract that does. Each blockchain in the ecosystem has one Core Contract.  The Guardians are required to observe this group of contracts. The Core Contract is the contract that ultimately emits the messages the [Guardians](/learn/infrastructure/guardians/){target=\_blank} pick up as an [Observation](#){target=\_blank}.
+
+Core Contracts are generally simple and can be divided into sending and receiving sides, each of which will be defined next. 
+
+## Sending
+
+There are no fees to publish a message, except when publishing on Solana, but this is subject to change in the future.
+
+The implementation strategy for `publishMessage` differs by chain. However, the general strategy consists of the Core Contract posting the following items to the blockchain logs:
+- `emitterAddress` of the contract which made the `publishMessage` call
+- `sequenceNumber`
+- `consistencyLevel` 
+
+Once the desired `consistencyLevel` has been reached and the message passes all of the Guardians' optional checks, the Guardian Network will produce the requested Verified Action Approvals [VAAs].
+
+The method signature for publishing messages:
+
+```js
+--8<-- 'code/learn/messaging/core-contracts/sending.js'
+```
+
+#### Parameters
+
+- **payload** - the content of the emitted message is an arbitrary byte array. Due to the constraints of individual blockchains, it may be capped to a certain maximum length
+
+
+- **consistencyLevel** - a numeric enum data type where the value is treated differently for different chains
+
+Some advanced integrators may want to get messages before finality. The `consistency_level` field offers chain-specific flexibility. It describes the required level of finality that must be reached before the Guardians will observe and attest to the emitted event. This is a defense against reorgs and rollbacks since a transaction, once considered `final,` is guaranteed not to have the state changes it caused be rolled back.
+
+
+
+Different chains use different consensus mechanisms, so each one has different finality assumptions. See the options for finality in the [Environments](#){target=\_blank} pages <!-- link to blockchain platforms -->
+
+- **nonce** - A free integer field that can be used however you like. Note that changing the `nonce` will result in a different digest
+
+
+#### Returns
+
+- **sequenceNumber** - a unique number that increments for every message for a given emitter (and implicitly chain). This, combined with the emitter address and emitter chain ID, allows the VAA for this message to be queried from the [APIs](#){target=\_blank}
+
+
+## Receiving
+
+Use the following method signature to receive a message encoded as a VAA:
+
+```js
+--8<-- 'code/learn/messaging/core-contracts/receiving.js'
+```
+
+When a VAA is passed to this function, it will either return the payload and associated metadata for the VAA or throw an exception. An exception should only be thrown if the VAA fails signature verification, an indication the VAA is invalid or inauthentic in some form.
+
+!!! note
+    Take care to make sure this method is called during the execution of a transaction where a VAA is passed to ensure the signatures are checked and verified.
+
+## Multicast
+
+Please note that there is no destination address or chain for these functions.
+
+VAAs are a simple attestation that "this contract on this chain said this thing." Therefore, VAAs are multicast by default and will be verified authentic on any chain where they are used.
+
+This multicast-by-default model makes it easy to synchronize state across the entire ecosystem because a single blockchain can make its data available to every chain in a single action with low latency. This reduces the complexity of the n^2 problems encountered by routing data to a large number of blockchains.
+
+This does not mean an application _cannot_ specify a destination address or chain. For example, the Token Bridge and Standard Relayer contracts require that some destination details be passed and verified on the destination chain.
+
+Because the VAA creation is separate from relaying, the multicast model does not incur an additional cost when a single chain is targeted. If the data isn't needed on a certain blockchain, don't relay it there, and it won't cost anything.
+

learn/messaging/index.md

@@ -0,0 +1,4 @@
+---
+title: TODO
+description: TODO
+---

learn/messaging/overview.md

@@ -0,0 +1,26 @@
+---
+title: Overview
+description: Discover Wormhole's Messaging features, including cross-chain communication, token and NFT bridges, and the Circle Bridge integration.
+---
+
+# Messaging Overview
+
+The Messaging section covers various aspects and services related to communication protocols and systems within the Wormhole platform. Each subsection provides detailed information on components, contracts, and bridges for messaging and data transfer. Topics covered include:
+
+## Core Contracts
+
+The Core Contracts form the backbone of Wormhole's cross-chain communication system, allowing for the emission and receipt of messages across different blockchains. Each blockchain in the ecosystem has its own Core Contract, which Guardians observe to ensure the integrity and synchronization of data. These contracts handle message sending, receiving, and multicast, providing a seamless mechanism for inter-chain communication without additional costs.
+
+## NTT (Native Token Transfers)
+_A description will be added here._
+
+## Token and NFT Bridge
+
+The Token and NFT Bridges facilitate cross-chain transfers of both fungible tokens and non-fungible tokens (NFTs). Utilizing a lock and mint mechanism, the bridge ensures secure and efficient asset movement between blockchains. The Token Bridge allows for token transfers with specific receiver details, while the NFT Bridge handles the transfer of unique digital assets with specialized rules for creating wrapped versions on the destination chain.
+
+## CCTP and Circle Bridge
+
+The CCTP and Circle Bridge support fast and cost-effective native USDC transfers across blockchains using Circle's Cross Chain Transfer Protocol (CCTP). While distinct from Wormhole, this protocol is enhanced by Wormhole's features such as automated relaying, gas payment on the destination chain, and native gas dropoff, making it more user-friendly. The integration can be achieved through the Wormhole Connect Widget or the Connect SDK, providing a seamless experience for developers and users.
+
+## Gateway
+_A description will be added here._

learn/messaging/token-nft-bridge.md

@@ -0,0 +1,21 @@
+---
+title: Token and NFT Bridge 
+description: Learn about Wormhole's Token and NFT Bridge for cross-chain transfers using lock and mint mechanisms, ensuring secure and efficient asset movement.
+---
+
+# Token and NFT Bridge
+
+## Token Bridge
+
+!!! note
+    Before a token transfer can be made, the token being transferred must exist as a wrapped asset on the target chain. This is done by [Attesting](#){target=\_blank} the token details on the target chain. <!-- link to VAAs -->
+
+The Token Bridge contract allows token transfers between blockchains through a lock and mint mechanism, using the [Core Contract](/learn/messaging/core-contracts/){target=\_blank} with a specific [payload](#){target=\_blank} to pass information about the transfer. <!--payload links to VAAs page payloads -->
+
+The Token Bridge also supports sending tokens with some additional data in the form of arbitrary byte payload attached to the token transfer. This type of transfer is referred to as a [Contract Controlled Transfer](#){target=\_blank}. <!-- links to VAAs page token + msg  -->
+
+While the [Core Contract](/learn/messaging/core-contracts/){target=\_blank} has no specific receiver by default, transfers sent through the token bridge do have a specific receiver chain and address to ensure the tokens are minted to the expected recipient.
+
+## NFT Bridge
+
+The NFT Bridge functions similarly to the Token Bridge but with special rules for what may be transferred and how the wrapped version is created on the destination chain.