Add interfaces back. (#61)

Author: haider-rs

src/gmp/.soldeerignore

@@ -0,0 +1,3 @@
+out/
+cache/
+*.json

src/gmp/README.md

@@ -0,0 +1,11 @@
+## Analog GMP Interfaces
+
+This repo contains two interfaces by Analog.
+1. IGateway.sol
+2. IGmpReceiver.sol
+
+### IGateway.sol
+Must be implemented by smart contracts which sends a message to Analog's gmp gateway.
+
+### IGmpReceiver.sol
+Must be implemented by smart contracts which receives a message from Analog's gmp gateway.

src/gmp/foundry.toml

@@ -0,0 +1,3 @@
+[profile.default]
+src = "src"
+out = "out"

src/gmp/src/IGateway.sol

@@ -0,0 +1,59 @@
+// SPDX-License-Identifier: MIT
+// Analog's Contracts (last updated v0.1.0) (src/interfaces/IGateway.sol)
+
+pragma solidity >=0.8.0;
+
+/**
+ * @dev Required interface of an Gateway compliant contract
+ */
+interface IGateway {
+    /**
+     * @dev New GMP submitted by calling the `submitMessage` method.
+     * @param id EIP-712 hash of the `GmpPayload`, which is it's unique identifier
+     * @param source sender account, with an extra flag indicating if it is a contract or an EOA
+     * @param destinationAddress the target address on the destination chain.
+     * @param destinationNetwork the target chain where the contract call will be made.
+     * @param gasLimit the gas limit available for the contract call
+     * @param gasCost the gas limit available for the contract call
+     * @param nonce Sequence number per sender, used to guarantee each message is unique.
+     * @param data message data with no specified format
+     */
+    event GmpCreated(
+        bytes32 indexed id,
+        bytes32 indexed source,
+        address indexed destinationAddress,
+        uint16 destinationNetwork,
+        uint64 gasLimit,
+        uint64 gasCost,
+        uint64 nonce,
+        bytes data
+    );
+
+    function networkId() external view returns (uint16);
+
+    /**
+     * @notice Estimate the gas cost of execute a GMP message.
+     * @dev This function is called on the destination chain before calling the gateway to execute a source contract.
+     * @param networkid The target chain where the contract call will be made
+     * @param messageSize Message size
+     * @param messageSize Message gas limit
+     */
+    function estimateMessageCost(uint16 networkid, uint16 messageSize, uint64 gasLimit)
+        external
+        view
+        returns (uint256);
+
+    /**
+     * @dev Send message from chain A to chain B
+     * @param destinationAddress the target address on the destination chain
+     * @param destinationNetwork the target chain where the contract call will be made
+     * @param executionGasLimit the gas limit available for the contract call
+     * @param data message data with no specified format
+     */
+    function submitMessage(
+        address destinationAddress,
+        uint16 destinationNetwork,
+        uint64 executionGasLimit,
+        bytes calldata data
+    ) external payable returns (bytes32);
+}

src/gmp/src/IGmpReceiver.sol

@@ -0,0 +1,24 @@
+// SPDX-License-Identifier: MIT
+// Analog's Contracts (last updated v0.1.0) (src/interfaces/IGmpReceiver.sol)
+
+pragma solidity >=0.8.0;
+
+/**
+ * @dev Required interface of an GMP compliant contract
+ */
+interface IGmpReceiver {
+    /**
+     * @dev Handles the receipt of a single GMP message.
+     * The contract must verify the msg.sender, it must be the Gateway Contract address.
+     *
+     * @param id The EIP-712 hash of the message payload, used as GMP unique identifier
+     * @param network The chain_id of the source chain who send the message
+     * @param source The pubkey/address which sent the GMP message
+     * @param payload The message payload with no specified format
+     * @return 32 byte result which will be stored together with GMP message
+     */
+    function onGmpReceived(bytes32 id, uint128 network, bytes32 source, uint64 nonce, bytes calldata payload)
+        external
+        payable
+        returns (bytes32);
+}