publish

Author: waalge

.codespellrc

@@ -0,0 +1,6 @@
+[codespell]
+skip =*.nix,*.po,*.ts,tests/*
+count = 1
+quiet-level = 3
+ignore-words-list =
+    cips

.editorconfig

@@ -0,0 +1,16 @@
+# EditorConfig: https://EditorConfig.org. Provides sensible defaults for
+# non vscode editors.
+
+# top-most EditorConfig file
+root = true
+
+# Every file.
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+
+indent_style = space
+indent_size = 2
+
+trim_trailing_whitespace = true

.envrc

@@ -0,0 +1 @@
+use flake

.github/workflows/pre-commit.yml

@@ -0,0 +1,15 @@
+---
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+      - uses: pre-commit/[email protected]

.gitignore

@@ -0,0 +1,3 @@
+.direnv/
+result/
+exp/

.markdownlint.yaml

@@ -0,0 +1,30 @@
+---
+default: true
+
+# Exceptions, example given, MD045
+# MD045: false # allow image with no tag
+
+# Unordered list indentation
+MD007:
+  # Spaces for indent
+  indent: 4
+# In-line HTML.
+MD033: false
+# List marker space
+## FIXME : Deal with this once prettier is fixed https://github.com/prettier/prettier/pull/15526
+MD030: false
+# MD030:
+#     # Spaces for single-line unordered list items
+#     ul_single: 3
+#     # Spaces for single-line ordered list items
+#     ol_single: 1
+#     # Spaces for multi-line unordered list items
+#     ul_multi: 3
+#     # Spaces for multi-line ordered list items
+#     ol_multi: 1
+# Line lengths
+MD013:
+  line_length: 80
+  tables: false
+# First line in a file should be a top-level heading
+MD041: false

.markdownlintignore

@@ -0,0 +1 @@
+drafts/*

.pre-commit-config.yaml

@@ -0,0 +1,19 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: check-yaml
+      - id: check-json
+      - id: check-toml
+      - id: end-of-file-fixer
+        exclude: ".svg"
+      - id: trailing-whitespace
+      - id: check-case-conflict
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.35.0
+    hooks:
+      - id: markdownlint
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.4
+    hooks:
+      - id: codespell

README.md

@@ -0,0 +1,27 @@
+# Orcfax-staking
+
+A WIP initially focused on the aims of
+[this catalyst proposal](https://milestones.projectcatalyst.io/projects/1200179).
+
+## Repo org
+
+```sample
+$ tree -L 1
+├── aik
+├── docs
+├── flake.lock
+├── flake.nix
+├── js
+├── justfile
+└── README.md
+```
+
+Three top subdirectories
+
+- `docs/` - documentation, specification, notes on design _etc_.
+- `aik/` - on-chain code, an aiken module
+- `js/` - off-chain code, in js using lucid evolution.
+
+To understand more about the project, start at the `./docs`
+
+To begin interacting with the project, go to `./js/packages/jobs`

aik/.github/workflows/continuous-integration.yml

@@ -0,0 +1,18 @@
+name: Continuous Integration
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: aiken-lang/setup-aiken@v1
+        with:
+          version: v1.1.4
+      - run: aiken fmt --check
+      - run: aiken check -D
+      - run: aiken build