Merge pull request #12 from yearn/metamerge

Metamerge

Author: Majorfi

.github/workflows/check.yml

@@ -0,0 +1,33 @@
+name: Check Files
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out github repository
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 1
+
+      - name: Setup Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.x"
+
+      - uses: actions/cache@v2
+        with:
+          path: ~/.cache/pip
+          key: pip-${{ hashFiles('**/data/meta/_config/requirements.txt') }}
+          restore-keys: |
+            pip-
+      - name: Install test dependencies
+        run: pip install -r data/meta/_config/tests/requirements.txt
+
+      - name: Check address checksum
+        run: python data/meta/_config/tests/check_checksum.py

.github/workflows/lint.yml

@@ -0,0 +1,46 @@
+name: Validation
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+jobs:
+  lint:
+    name: Lint data
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v2
+
+      - name: Use Node 14.x
+        uses: actions/setup-node@v1
+        with:
+          node-version: 14.x
+
+      - name: Install deps (with cache)
+        uses: bahmutov/npm-install@v1
+
+      - name: Lint data
+        run: |
+          npm install -g prettier
+          prettier --check ./data/meta/**/*.json
+
+  verify:
+    name: Verify data
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v2
+
+      - name: Use Node 14.x
+        uses: actions/setup-node@v1
+        with:
+          node-version: 14.x
+
+      - name: Install deps (with cache)
+        uses: bahmutov/npm-install@v1
+
+      - name: Verify data
+        run: node ./data/meta/_config/scripts/verify.mjs

.github/workflows/sync.yml

@@ -0,0 +1,51 @@
+name: Deployment
+on:
+  push:
+    branches:
+      - master
+jobs:
+  sync:
+    name: Verify and sync data to IPFS
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v2
+
+      - name: Use Node 14.x
+        uses: actions/setup-node@v1
+        with:
+          node-version: 14.x
+
+      - name: Install deps (with cache)
+        uses: bahmutov/npm-install@v1
+
+      - name: Verify data
+        run: node ./data/meta/_config/scripts/verify.mjs
+
+      - name: Generate build artifact
+        run: node ./data/meta/_config/scripts/build.mjs
+
+      - name: Upload to IPFS
+        uses: aquiladev/ipfs-action@v0.3.0-alpha.1
+        id: ipfs
+        with:
+          path: './build/'
+          host: ${{ secrets.IPFS_HOST }}
+          port: ${{ secrets.IPFS_PORT }}
+          protocol: http
+
+      - name: Get Timestamp Action
+        uses: nanzm/get-time-action@v1.1
+        id: time
+        with:
+          format: 'YYYYMMDDHHmmss'
+
+      - name: Create Release
+        uses: Hs1r1us/Release-AIO@v1.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: "${{ steps.time.outputs.time }}/${{ steps.ipfs.outputs.hash }}"
+          release_name: ${{ steps.ipfs.outputs.hash }}
+          body: '[ipfs://${{ steps.ipfs.outputs.hash }}](ipfs://${{ steps.ipfs.outputs.hash }}) - [ipfs.io](https://ipfs.io/ipfs/${{ steps.ipfs.outputs.hash }})'

.gitignore

@@ -45,3 +45,5 @@ ystore
 
 # build
 yDaemon
+build
+node_modules

.prettierignore

@@ -0,0 +1,14 @@
+# General
+.DS_STORE
+.prettierignore
+.gitignore
+.gitattributes
+.env
+.env.example
+
+# JS
+node_modules
+yarn.lock
+api/*
+*.go
+*.sol

.prettierrc

@@ -0,0 +1,4 @@
+{
+  "tabWidth": 2,
+  "printWidth": 80
+}

cmd/main.go

@@ -13,7 +13,7 @@ import (
 
 var chains = []uint64{1, 10, 250, 42161}
 
-// var chains = []uint64{10}
+// var chains = []uint64{250}
 
 func waitGroupSummonDaemons(wg *sync.WaitGroup, chainID uint64, delay time.Duration) {
 	daemons.SummonDaemons(chainID, delay)

data/meta/_config/README.md

@@ -0,0 +1,58 @@
+# Yearn metadata storage
+
+[![Validation](https://github.com/yearn/ydaemon/workflows/Validation/badge.svg)](https://github.com/yearn/ydaemon/actions?query=workflow%3AValidation)
+[![Styled With Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io/)
+
+## What?
+
+This repo contains all the metadata of the yearn ecosystem. Contents of the
+[`meta`](./data/meta) directory are synced to IPFS for storage, accessible through
+our gateway [meta.yearn.network](https://meta.yearn.network). Consistency of
+the stored data is verified by smalls scripts and schemas.
+
+## Adding documents
+
+Any document can be added to the [`meta`](./data/meta) directory, but there are some
+special checks to ensure consistency and ease of accessibility:
+
+- All JSON files that share names with the files in the [`schema`](./data/meta/_config/schema)
+  directory must follow the defined schema, otherwise verification will fail.
+- Any folder that begins with `0x` is considered as an address. The address must
+  be checksummed, otherwise verification will fail.
+- All files named `index.json` will be ignored by git and will be
+  overwritten by the indexing process. (see [indexing](#indexes))
+
+
+## Adding schemas
+
+Schemas can be created in the root of the [`schema`](./data/meta/_config/schema) folder. For
+syntax you can take a look at the [JSON schema specs](https://json-schema.org).
+The [AJV](https://github.com/ajv-validator/ajv) library is used to validate the
+data with the provided schemas.
+
+## Syncing with IPFS
+
+After each commit to main, direct or as a result of a merged pull request, a
+sync to IPFS is triggered.
+
+## Indexes
+
+Before each deployment the [`meta`](./data/meta) directory is scanned and an
+`index.json` file is generated inside each directory (root included). The file
+follows the [`index.json` schema](./data/meta/_config/schema/index.json) and will contain
+information about the files and folders stored in that directory. For an example
+see [meta.yearn.network/index.json](https://meta.yearn.network/json)
+
+## Translations
+
+Anything under protocols, strategies, and tokens are able to be translated. In the json files listed, we have locale codes and the English text to be translated. The name (if applicable) and description are what should be translated. If you dont see your locale code, make an issue and it will be added manually. To update new json's with the locale information run the python script `toLocale.py` located in the scripts folder.
+
+## Helpful links
+
+- 🌐 [Live site](https://yearn.network)
+- ⚖️ [Governance forum](https://gov.yearn.finance)
+- 📑 [Documentation](https://docs.yearn.finance)
+
+## Contributing
+
+Code style follows prettier conventions (`yarn format`). Commit messages follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).

data/meta/_config/schema/chain-settings.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "chain-settings.json",
+  "title": "Chain Settings",
+  "description": "Preferences about what services are available for a chain",
+  "type": "object",
+  "properties": {
+    "simulationsEnabled": {
+      "type": "boolean"
+    },
+    "zapsEnabled": {
+      "type": "boolean"
+    }
+  },
+  "required": ["simulationsEnabled", "zapsEnabled"]
+}

data/meta/_config/schema/index.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "index.json",
+  "title": "Meta index",
+  "description": "Filesystem index file",
+  "type": "object",
+  "properties": {
+    "files": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "dirs": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "required": ["files", "dirs"]
+}