gmp

.snippets/code/builders/ethereum/precompiles/interoperability/gmp/gmp.sol

@@ -0,0 +1,26 @@
+// SPDX-License-Identifier: GPL-3.0-only
+pragma solidity >=0.8.3;
+
+/// @dev The Gmp contract's address.
+address constant GMP_ADDRESS = 0x0000000000000000000000000000000000000816;
+
+/// @dev The Gmp contract's instance.
+Gmp constant GMP_CONTRACT = Gmp(GMP_ADDRESS);
+
+/// @author The Moonbeam Team
+/// @title Gmp precompile
+/// @dev Provides an endpoint to Gmp protocols which can automatically forward to XCM
+/// @custom:address 0x0000000000000000000000000000000000000816
+interface Gmp {
+    // TODO: Here we would specify the endpoints for each GMP protocol on a case by case basis.
+    //       These endpoints are basically the hand offs for each protocol -- where they delegate to
+    //       the target contract.
+    //
+    //       This design should allow users to interact with this precompile with no changes to the
+    //       underlying GMP protocols by simply specifying the correct precompile as the target.
+
+    /// Receive a wormhole VAA and process it
+    ///
+    /// @custom:selector f53774ab
+    function wormholeTransferERC20(bytes memory vaa) external;
+}

builders/ethereum/precompiles/interoperability/gmp.md

@@ -36,19 +36,27 @@ In practice, it is unlikely that a developer will have to directly interact with
 
 ## The GMP Solidity Interface {: #the-gmp-solidity-interface }
 
-[`Gmp.sol`](https://github.com/moonbeam-foundation/moonbeam/blob/master/precompiles/gmp/Gmp.sol){target=\_blank} is a Solidity interface that allows developers to interact with the precompile:  
+[`Gmp.sol`](https://github.com/moonbeam-foundation/moonbeam/blob/master/precompiles/gmp/Gmp.sol){target=\_blank} is a Solidity interface that allows developers to interact with the precompile.   
 
-- **wormholeTransferERC20**(*bytes memory* vaa) - receives a Wormhole bridge transfer [verified action approval (VAA)](https://docs.wormhole.com/wormhole/explore-wormhole/vaa){target=\_blank}, mints tokens via the Wormhole token bridge, and forwards the liquidity to the custom payload’s [multilocation](/builders/interoperability/xcm/core-concepts/multilocations/){target=\_blank}. The payload is expected to be a precompile-specific SCALE encoded object, as explained in this guide's [Building the Payload for Wormhole](#building-the-payload-for-wormhole) section
+??? code "Gmp.sol"
 
-VAAs are payload-containing packages generated after origin-chain transactions and are discovered by Wormhole [Guardian Network spies](https://docs.wormhole.com/wormhole/explore-wormhole/guardian){target=\_blank}.
+    ```solidity
+    --8<-- 'code/builders/ethereum/precompiles/interoperability/gmp/gmp.sol'
+    ```
+
+The GMP precompile has one method: 
+
+- **wormholeTransferERC20**(*bytes memory* vaa) - receives a Wormhole bridge transfer [verified action approval (VAA)](https://wormhole.com/docs/learn/infrastructure/vaas/){target=\_blank}, mints tokens via the Wormhole token bridge, and forwards the liquidity to the custom payload’s [multilocation](/builders/interoperability/xcm/core-concepts/multilocations/){target=\_blank}. The payload is expected to be a precompile-specific SCALE encoded object, as explained in this guide's [Building the Payload for Wormhole](#building-the-payload-for-wormhole) section
+
+VAAs are payload-containing packages generated after origin-chain transactions and are discovered by Wormhole [Guardians](https://wormhole.com/docs/learn/infrastructure/guardians/){target=\_blank}.
 
 The most common instance that a user will have to interact with the precompile is in the case of a recovery, where a relayer doesn’t complete an MRL transaction. For example, a user would have to search for the VAA that comes with their origin chain transaction and then manually invoke the `wormholeTransferERC20` function.
 
 ## Building the Payload for Wormhole {: #building-the-payload-for-wormhole }
 
 Currently the GMP precompile only supports sending liquidity with Wormhole, through Moonbeam, and into other parachains. The GMP precompile does not assist with a route from parachains back to Moonbeam and subsequently Wormhole connected chains.  
 
-To send liquidity from a Wormhole-connected origin chain like Ethereum, users must invoke the [`transferTokensWithPayload` method](https://docs.wormhole.com/wormhole/explore-wormhole/vaa#token--message){target=\_blank} on the [origin-chain's deployment](https://docs.wormhole.com/wormhole/explore-wormhole/core-contracts#token-bridge){target=\_blank} of the [WormholeTokenBridge smart contract](https://github.com/wormhole-foundation/wormhole/blob/main/ethereum/contracts/bridge/interfaces/ITokenBridge.sol){target=\_blank}. This function requires a bytes payload, which must be formatted as a SCALE encoded multilocation object wrapped within [another precompile-specific versioned type](https://github.com/moonbeam-foundation/moonbeam/blob/{{ networks.moonbase.spec_version }}/precompiles/gmp/src/types.rs#L25-L48){target=\_blank}.
+To send liquidity from a Wormhole-connected origin chain like Ethereum, users must invoke the [`transferTokensWithPayload` method](https://wormhole.com/docs/learn/infrastructure/vaas/#token--message){target=\_blank} on the [origin-chain's deployment](https://wormhole.com/docs/learn/infrastructure/core-contracts/#token-bridge){target=\_blank} of the [WormholeTokenBridge smart contract](https://github.com/wormhole-foundation/wormhole/blob/main/ethereum/contracts/bridge/interfaces/ITokenBridge.sol){target=\_blank}. This function requires a bytes payload, which must be formatted as a SCALE encoded multilocation object wrapped within [another precompile-specific versioned type](https://github.com/moonbeam-foundation/moonbeam/blob/{{ networks.moonbase.spec_version }}/precompiles/gmp/src/types.rs#L25-L48){target=\_blank}.
 
 You may be unfamiliar with both SCALE encoding and multilocations if you are not familiar with the Polkadot ecosystem. [SCALE encoding](https://docs.substrate.io/reference/scale-codec){target=\_blank} is a compact form of encoding that Polkadot uses. The [`MultiLocation` type](https://wiki.polkadot.network/docs/learn-xcvm){target=\_blank} is used to define a relative point in Polkadot, such as a specific account on a specific parachain (Polkadot blockchain).