Merge branch 'main' into staking

.github/workflows/core.yaml

@@ -0,0 +1,109 @@
+name: Core
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "core/**"
+  pull_request:
+
+defaults:
+  run:
+    working-directory: ./core
+
+jobs:
+  core-format:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: "core/.nvmrc"
+          cache: "yarn"
+          cache-dependency-path: "core/yarn.lock"
+
+      - name: Install Dependencies
+        run: yarn install --prefer-offline --frozen-lockfile
+
+      - name: Format
+        run: yarn format
+
+  core-build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: "core/.nvmrc"
+          cache: "yarn"
+          cache-dependency-path: "core/yarn.lock"
+
+      - name: Install Dependencies
+        run: yarn install --prefer-offline --frozen-lockfile
+
+      - name: Build
+        run: yarn build
+
+      - name: Upload Build Artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: core-build
+          path: |
+            core/build/
+            core/typechain/
+          if-no-files-found: error
+
+  core-test:
+    needs: [core-build]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: "core/.nvmrc"
+          cache: "yarn"
+          cache-dependency-path: "core/yarn.lock"
+
+      - name: Install Dependencies
+        run: yarn install --prefer-offline --frozen-lockfile
+
+      - name: Download Build Artifacts
+        uses: actions/download-artifact@v3
+        with:
+          name: core-build
+          path: core/
+
+      - name: Test
+        run: yarn test --no-compile
+
+  core-deploy-dry-run:
+    needs: [core-build]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: "core/.nvmrc"
+          cache: "yarn"
+          cache-dependency-path: "core/yarn.lock"
+
+      - name: Install Dependencies
+        run: yarn install --prefer-offline --frozen-lockfile
+
+      - name: Download Build Artifacts
+        uses: actions/download-artifact@v3
+        with:
+          name: core-build
+          path: core/
+
+      - name: Deploy
+        run: yarn deploy --no-compile

.pre-commit-config.yaml

@@ -0,0 +1,21 @@
+repos:
+  - repo: local
+    hooks:
+      - id: lint-sol
+        name: "lint core sol"
+        entry: /usr/bin/env bash -c "cd core/ && npm run lint:sol"
+        files: '\.sol$'
+        language: script
+        description: "Checks solidity code according to the package's linter configuration"
+      - id: lint-js
+        name: "lint core ts/js"
+        entry: /usr/bin/env bash -c "cd core/ && npm run lint:js"
+        files: '\.(ts|js)$'
+        language: script
+        description: "Checks TS/JS code according to the package's linter configuration"
+      - id: lint-config
+        name: "lint core json/yaml"
+        entry: /usr/bin/env bash -c "cd core/ && npm run lint:config"
+        files: '\.(json|yaml)$'
+        language: script
+        description: "Checks JSON/YAML code according to the package's linter configuration"

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "eslint.workingDirectories": [
+    "./core/",
+  ],
+}

README.md

@@ -1,2 +1,24 @@
-# litmus
+# Acre
+
 Bitcoin Liquid Staking
+
+[![Core](https://github.com/thesis/acre/actions/workflows/core.yaml/badge.svg?branch=main&event=push)](https://github.com/thesis/acre/actions/workflows/core.yaml)
+
+## Development
+
+### Pre-commit Hooks
+
+Developers are encouraged to use [pre-commit](https://pre-commit.com/) hooks to
+automatically discover code issues, before they submit the code.
+
+To setup the hooks follow the steps:
+
+1. Install `pre-commit` tool:
+    ```sh
+    brew install pre-commit
+    ```
+
+2. Install the hooks for the repository:
+    ```sh
+    pre-commit install
+    ```

core/.nvmrc

@@ -0,0 +1 @@
+lts/iron

core/README.md

@@ -1,3 +1,3 @@
-# Litmus
+# Acre
 
-Litmus is a “liquid staking” solution that allows people to earn yield on their Bitcoin via yield farming on Ethereum.
+Acre is a “liquid staking” solution that allows people to earn yield on their Bitcoin via yield farming on Ethereum.

core/contracts/Litmus.sol → core/contracts/Acre.sol

@@ -4,6 +4,6 @@ pragma solidity ^0.8.21;
 // Uncomment this line to use console.log
 // import "hardhat/console.sol";
 
-contract Litmus {
+contract Acre {
     // TODO: add your implementation
 }

core/deploy/01_deploy_litmus.ts → core/deploy/01_deploy_acre.ts

@@ -5,9 +5,9 @@ const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   const { deployments } = hre
   const { log } = deployments
 
-  log("Deploying Litmus contract")
+  log("Deploying Acre contract")
 }
 
 export default func
 
-func.tags = ["Litmus"]
+func.tags = ["Acre"]

core/test/Litmus.test.ts → core/test/Acre.test.ts

@@ -1,4 +1,4 @@
-describe("Litmus", () => {
+describe("Acre", () => {
   describe("Add your tests", () => {
     it("Should validate something", async () => {})
   })