_This version of the Wormhole Solidity SDK, configured by ndujaLabs for Hardhat compatibility, incorporates the original SDK as a submodule. It aligns with commit +d9a...7d3f.
All version increase as 0.x.0, as if they potentially break changes because this repo does not verify if that happens._
The purpose of this SDK is to make on-chain integrations with Wormhole on EVM compatible chains as smooth as possible by providing all necessary Solidity interfaces along with useful libraries and tools for testing.
For off-chain code, please refer to the TypeScript SDK and in particular the EVM platform implementation.
This SDK was originally created for integrations with the WormholeRelayer and then expanded to cover all integration.
License Reminder
The code is provided on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
So make sure you check / audit any code you use before deploying to mainnet.
The main branch is considered the nightly version of the SDK. Stick to tagged releases for a stable experience.
Note: The SDK is currently on its way to a version 1.0 . Proceed with extra caution until then.
Foundry and Forge
forge install wormhole-foundation/[email protected]Solc Version
Currently the SDK uses solc version 0.8.19 to avoid issues with PUSH0 which was introduced in 0.8.20 but which is not supported on many EVM chains.
The WormholeRelayer (also sometimes referred to as the automatic or generic relayer) allows integrators to leverage external parties known as delivery providers, to relay messages emitted on a given source chain to the intended target chain.
This frees integrators, who are building a cross-chain app, from the cumbersome and painful task of having to run relaying infrastructure themselves (and thus e.g. dealing with the headache of having to acquire gas tokens for the target chain).
Messages include, but aren't limited to: Wormhole attestations (VAAs), Circle attestations (CCTP)
Delivery providers provide a quote for the cost of a delivery on the source chain and also take payment there. This means the process is not fully trustless (delivery providers can take payment and then fail to perform the delivery), however the state of the respective chains always makes it clear whether a delivery provider has done their duty for a given delivery and delivery providers can't maliciously manipulate the content of a delivery.
HelloWormhole - Simple cross-chain message sending application
HelloToken - Simple cross-chain token sending application
HelloUSDC - Simple cross-chain USDC sending application using CCTP
-
Includes interfaces to interact with contracts in the Wormhole ecosystem (src/interfaces)
-
Includes the base class ‘Base’ with helpers for common actions that will typically need to be done within ‘receiveWormholeMessages’:
-
onlyWormholeRelayer(): Checking that msg.sender is the wormhole relayer contract Sometimes, Cross-chain applications may be set up such that there is one ‘spoke’ contract on every chain, which sends messages to the ‘hub’ contract. If so, we’d ideally only want to allow messages to be sent from these spoke contracts. Included are helpers for this:setRegisteredSender(uint16 sourceChain, bytes32 sourceAddress): Setting the specified sender for ‘sourceChain’ to be ‘sourceAddress’isRegisteredSender(uint16 sourceChain, bytes32 sourceAddress): Checking that the sender who requested the delivery is the registered address for that chain
Look at test/Counter.t.sol for an example usage of Base
-
-
Included are also:
- The ‘TokenSender’ and ‘TokenReceiver’ base classes with helpers for smart contracts that wish to send and receive tokens using Wormhole’s TokenBridge. See ‘HelloToken’ for example usage.
- The ‘CCTPSender’ and ‘CCTPReceiver’ base classes with helpers for smart contracts that wish to send and receive both tokens using Wormhole’s TokenBridge as well as USDC using CCTP. See ‘HelloUSDC’ for example usage.
- Or a combination of both - CCTPAndTokenBase.
- Helpers for setting up a local forge testing environment. See ‘HelloWormhole’ for example usage.
Note: This code is meant to be used as starter / reference code. Feel free to modify for use in your contracts, and also make sure to audit any code used from here as part of your contracts before deploying to mainnet.