Merge pull request #963 from graphprotocol/mde/add-data-edge-contracts

chore: add DataEdge contracts

Author: Maikol

.github/workflows/ci-data-edge.yml

@@ -0,0 +1,26 @@
+name: CI - packages/data-edge
+
+env:
+  CI: true
+
+on:
+  push:
+    branches: "*"
+    paths:
+      - packages/data-edge/**
+  pull_request:
+    branches: "*"
+    paths:
+      - packages/data-edge/**
+  workflow_dispatch:
+
+jobs:
+  test-ci:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up environment
+        uses: ./.github/actions/setup
+      - name: Run tests
+        run: yarn test

.husky/pre-commit

@@ -2,5 +2,11 @@
 . "$(dirname -- "$0")/_/husky.sh"
 
 # contracts
-cd packages/contracts
+pushd packages/contracts
 npx --no-install lint-staged
+popd
+
+# data-edge
+pushd packages/data-edge
+npx --no-install lint-staged
+popd

package.json

@@ -8,6 +8,7 @@
   "packageManager": "[email protected]",
   "workspaces": [
     "packages/contracts",
+    "packages/data-edge",
     "packages/eslint-graph-config",
     "packages/sdk",
     "packages/solhint-graph-config",

packages/data-edge/.env.sample

@@ -0,0 +1,4 @@
+MNEMONIC=
+INFURA_KEY=
+ETHERSCAN_API_KEY=
+ARBISCAN_API_KEY=

packages/data-edge/.prettierignore

@@ -0,0 +1,10 @@
+const skipFiles = ['']
+
+module.exports = {
+  providerOptions: {
+    mnemonic: 'myth like bonus scare over problem client lizard pioneer submit female collect',
+    network_id: 1337,
+  },
+  skipFiles,
+  istanbulFolder: './reports/coverage',
+}

packages/data-edge/.solcover.js

@@ -0,0 +1,20 @@
+# Data Edge
+
+A DataEdge contract is used to store arbitrary data on-chain on any EVM compatible blockchain. A subgraph can then read all the calldata sent to a particular contract, decode it and update the subgraph state accordingly.
+
+The DataEdge accepts any function call by using a fallback function that will not revert. It is up to the implementor to define the calldata format as well as how to decode it.
+
+### Additional Considerations
+
+- Fallback is not payable to avoid anyone sending ETH by mistake as the main purpose is to store calldata.
+
+# Deploying
+
+Setup a `.env` file with the keys you want to use for deployments. You can use `.env.sample` as a guide.
+Deploy a `DataEdge` contract by running `yarn deploy -- --network <network-name>`
+
+# Copyright
+
+Copyright &copy; 2022 The Graph Foundation
+
+Licensed under [GPL license](LICENSE).

packages/data-edge/LICENSE

@@ -0,0 +1,10 @@
+{
+  "421614": {
+    "DataEdge": "0x17f1fcD16E2A9fF2a55c63C97a778D96Fa473548",
+    "EventfulDataEdge": "0x9b9402939133F27c6eba81a321dfBFa1feE6714E"
+  },
+  "11155111": {
+    "DataEdge": "0x00C602A72363917Bc30a793593731F93352eB85d",
+    "EventfulDataEdge": "0xEFC8D47673777b899f2FB597C6FC0E87ecce98Cb"
+  }
+}

packages/data-edge/README.md

@@ -0,0 +1,13 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+pragma solidity ^0.8.12;
+
+/// @title Data Edge contract is only used to store on-chain data, it does not
+///        perform execution. On-chain client services can read the data
+///        and decode the payload for different purposes.
+contract DataEdge {
+    /// @dev Fallback function, accepts any payload
+    fallback() external payable {
+        // no-op
+    }
+}