initial commit

Author: 0xalbert

.eslintrc.js

@@ -0,0 +1,23 @@
+module.exports = {
+  env: {
+    browser: true,
+    es2021: true,
+  },
+  extends: [
+    'eslint:recommended',
+    'plugin:react/recommended',
+    'plugin:@typescript-eslint/recommended',
+  ],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaFeatures: {
+      jsx: true,
+    },
+    ecmaVersion: 12,
+    sourceType: 'module',
+  },
+  plugins: ['react', '@typescript-eslint'],
+  rules: {
+    'react/prop-types': 0,
+  },
+}

.github/workflows/PR-build.yml

@@ -0,0 +1,21 @@
+name: Gatsby PR build
+
+on:
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '14.x'
+      - name: Get latest npm version
+        run: npm install -g npm@latest
+      - name: Install dependencies
+        run: npm ci --ignore-scripts --no-optional
+      - name: Validate HIP & HCCP frontmatters
+        run: npm test

.gitignore

@@ -0,0 +1,4 @@
+node_modules/
+.cache/
+public
+types/gql.ts

.prettierrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+  semi: false,
+  trailingComma: 'all',
+  singleQuote: true,
+  tabWidth: 2,
+}

ISSUE_TEMPLATE.md

@@ -0,0 +1,12 @@
+
+ATTENTION! If you would like to submit an HIP and it has already been written as a draft (see the [template](https://github.com/hapticDAO/HIPs/blob/master/hip-X.md) for an example), please submit it as a [Pull Request](https://github.com/hapticDAO/HIPs/pulls).
+
+If you are considering a proposal but would like to get some feedback on the idea before submitting a draft, then continue opening an Issue as a thread for discussion.  Note that the more clearly and completely you state your idea the higher the quality of the feedback you are likely to receive.
+
+Keep in mind the following guidelines from [HIP-1](https://hips.haptic.finance/HIPS/hip-1):
+
+> Each HIP must have a champion - someone who writes the HIP using the style and format described below, shepherds the discussions in the appropriate forums, and attempts to build community consensus around the idea. The HIP champion (a.k.a. Author) should first attempt to ascertain whether the idea is HIP-able. Posting to the the Protocol Discussion forum or opening an Issue is the best way to go about this.
+
+> Vetting an idea publicly before going as far as writing a HIP is meant to save the potential author time. Asking the Ethereum community first if an idea is original helps prevent too much time being spent on something that is guaranteed to be rejected based on prior discussions (searching the Internet does not always do the trick). It also helps to make sure the idea is applicable to the entire community and not just the author. Just because an idea sounds good to the author does not mean it will work for most people in most areas where Ethereum is used.
+
+> Once the champion has asked the Ethereum community as to whether an idea has any chance of acceptance, a draft HIP should be presented as a Pull Request. This gives the author a chance to flesh out the draft HIP to make properly formatted, of high quality, and to address initial concerns about the proposal.

PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,8 @@
+When opening a pull request to submit a new HIP, please use the suggested template: https://github.com/hapticDAO/HIPs/blob/master/hip-X.md
+
+We have a GitHub bot that automatically merges some PRs. It will merge yours immediately if certain criteria are met:
+
+ - The PR edits only existing Draft PRs.
+ - The build passes.
+ - Your Github username or email address is listed in the 'author' header of all affected PRs, inside <triangular brackets>.
+ - If matching on email address, the email address is the one publicly listed on your GitHub profile.

README.md

@@ -0,0 +1,45 @@
+# HIP [Discord](https://discord.gg/ahJVRvjyzk) [Twitter](https://twitter.com/Haptic_Finance) [Telegram](https://t.me/HapticFinance)
+
+Haptic Improvement Proposals (HIP) describe standards for the Haptic platform, including core protocol specifications, client APIs, and contract standards.
+
+# Contributing
+
+1.  Review [HIP-1](https://github.com/hapticfinance/HIPss/blob/master/content/hips/hip-1.md).
+2.  Fork the repository by clicking "Fork" in the top right.
+3.  Add your HIP to your fork of the repository. There is a [template HIP here](hip-x.md).
+4.  Submit a Pull Request to Haptic's [HIPs repository](https://github.com/hapticfinance/HIPs).
+
+Your first PR should be a first draft of the final HIP. It must meet the formatting criteria enforced by the build (largely, correct metadata in the header). An editor will manually review the first PR for a new HIP and assign it a number before merging it. Make sure you include a `discussions-to` header with the URL to a new thread on [research.haptic.finance](https://research.haptic.finance) where people can discuss the HIP as a whole.
+
+If your HIP requires images, the image files should be included in a subdirectory of the `assets` folder for that HIP as follow: `assets/hip-X` (for hip **X**). When linking to an image in the HIP, use relative links such as `../assets/hip-X/image.png`.
+
+When you believe your HIP is mature and ready to progress past the Draft phase, you should reach out to a Haptic Council member on discord by searching members with the "Haptic Council" role or finding them within the #governance channel. The Haptic Council will schedule in a call with the HIP author to go through the HIP in more detail.
+
+Once assessed, a HIP is moved into `Feasibility` and a Core Contributor is assigned. The Core Contributor will work with the author to conduct a feasibility study. Once the Author and the Core Contributor are satisfied, a HIP is moved to `HC Review Pending`. Once the Haptic Council has formally reviewed the HIP during the HIP presentation they can either move it to a vote or send it back to `Feasability`. A vote is conducted within the `hapticfinance.eth` snapshot space connected to our [dApp](https://haptic.finance/) . If a vote by the Haptic Council reaches a super majority, the HIP is moved to `Approved`, otherwise it is `Rejected`.
+
+Once the HIP has been implemented by either the protocol DAO or the HIP author and relevant parties, the HIP is assigned the `Implemented` status. There is a 100 pLYS (subject to changes) bounty for proposing a HIP that reaches the `Implemented` phase.
+
+# HIP Statuses
+
+- **Draft** - The initial state of a new HIP before the Haptic Council and core contributors have assessed it.
+- **Feasibility** - a HIP that is being assessed for feasibility with an assigned Core Contributor
+- **EC_Review_Pending** - a HIP that is awaiting a Haptic Council Review after the Author and Core Contributor are satisfied with feasibility
+- **Vote_Pending** - a HIP that is awaiting a vote.
+- **Approved** - a HIP that has successfully reached a super majority Haptic Council vote in favour.
+- **Rejected** - a HIP that has failed to reach a super-majority Haptic Council vote in favour.
+- **Implemented** - a HIP that has been released to main-net.
+
+# Validation
+
+HIPs must pass some validation tests.
+
+It is possible to run the HIP validator locally:
+
+```
+npm install (if not done already)
+npm run test
+```
+
+# Automerger
+
+The HIP repository contains an "auto merge" feature to ease the workload for HIP editors. If a change is made via a PR to a draft HIP, then the authors of the HIP can Github approve the change to have it auto-merged by the [hip-automerger](https://github.com/bakaoh/hip_automerger) bot.

bulkEdit.js

@@ -0,0 +1,15 @@
+const { batch } = require('frontmatter-file-batcher')
+
+;(() => {
+  batch('content/**/*.md', Infinity, async ({ goods, actions }) => {
+    console.log(goods)
+    const { update, save } = actions
+
+    const newData = update({
+      data: { type: { $set: 'Governance' } },
+    })
+
+    await save(newData)
+    console.log('Just saved:', goods.path)
+  })
+})()

ci/checkFrontmatters.js

@@ -0,0 +1,79 @@
+const Yup = require('yup')
+const glob = require('glob')
+const fm = require('front-matter')
+const statuses = require('./statuses')
+const fs = require('fs/promises')
+const { promisify } = require('util')
+const g = promisify(glob)
+
+const snapshotIdRegex = /^https?:\/\/(snapshot.org).*\/([A-z0-9]{7,})$/
+
+const commonValidationSchema = Yup.object().shape({
+  file: Yup.string().required(),
+  title: Yup.string().required(),
+  type: Yup.string().oneOf(['Meta-Governance', 'Governance']).required(),
+  proposal: Yup.string().matches(snapshotIdRegex),
+  status: Yup.string().oneOf(statuses),
+  author: Yup.string().required(),
+  network: Yup.string()
+    .oneOf(['Ethereum', 'Optimism', 'Ethereum & Optimism'])
+    .required(),
+  implementor: Yup.string().nullable(),
+  release: Yup.string().nullable(),
+  created: Yup.date().nullable(),
+  updated: Yup.date().nullable(),
+  requires: Yup.mixed().nullable(),
+  'discussions-to': Yup.string().nullable(),
+})
+
+const hipValidationSchema = commonValidationSchema
+  .concat(
+    Yup.object().shape({
+      hip: Yup.number().required(),
+      network: Yup.string().required(),
+    }),
+  )
+  .noUnknown()
+  .strict()
+
+const hccpValidationSchema = commonValidationSchema
+  .concat(
+    Yup.object().shape({
+      hccp: Yup.number().required(),
+    }),
+  )
+  .noUnknown()
+  .strict()
+
+;(async () => {
+  try {
+    const hips = await g('./content/hips/*.md')
+    const hccp = await g('./content/hccp/*.md')
+
+    // HIP
+    await Promise.all(
+      hips.map(async (file) => {
+        const content = await fs.readFile(file, 'utf-8')
+        const { attributes } = fm(content)
+        const castValues = hipValidationSchema.cast({ file, ...attributes })
+        return await hipValidationSchema.validate(castValues)
+      }),
+    )
+    // HCCP
+    await Promise.all(
+      hccp.map(async (file) => {
+        const content = await fs.readFile(file, 'utf-8')
+        const { attributes } = fm(content)
+        const castValues = hccpValidationSchema.cast({ file, ...attributes })
+        return await hccpValidationSchema.validate(castValues)
+      }),
+    )
+  } catch (error) {
+    console.log(error)
+    console.error({
+      value: error.value,
+      errors: error.errors,
+    })
+    process.exit(1)
+  }
+})()

ci/statuses.js

@@ -0,0 +1,9 @@
+module.exports = [
+  'Draft',
+  'Feasibility',
+  'SC_Review_Pending',
+  'Vote_Pending',
+  'Approved',
+  'Implemented',
+  'Rejected',
+]