feat: new hardware installer (#17)

Author: dni

.github/workflows/arduino-report.yml

@@ -0,0 +1,8 @@
+on:
+  schedule:
+    - cron:  '*/5 * * * *'
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: arduino/report-size-deltas@v1

.github/workflows/arduino.yml

@@ -0,0 +1,62 @@
+name: arduino
+on: [ push, pull_request ]
+
+jobs:
+  build-for-esp32:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        fqbn:
+          - esp32:esp32:esp32
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: arduino/compile-sketches@v1
+        with:
+          enable-deltas-report: true
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          fqbn: ${{ matrix.fqbn }}
+          platforms: |
+            - name: esp32:esp32
+              source-url: https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
+          sketch-paths: |
+            - lnpos
+          libraries: |
+            - name: WebSockets
+            - name: ArduinoJson
+            - name: AutoConnect
+            - name: Base64
+            - name: Keypad
+            - name: PageBuilder
+            - name: uBitcoin
+            - source-path: ./libraries/TFT_eSPI
+            - source-path: ./libraries/QRCode
+
+          cli-compile-flags: |
+            - --warnings="none"
+            - --build-property
+            - build.partitions=min_spiffs
+            - --build-property
+            - upload.maximum_size=1966080
+
+      - uses: actions/upload-artifact@v2
+        with:
+          name: sketches-reports
+          path: sketches-reports
+
+
+  report:
+    needs: build-for-esp32
+    if: github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
+    steps:
+      # This step is needed to get the size data produced by the compile jobs
+      - name: Download sketches reports artifact
+        uses: actions/download-artifact@v2
+        with:
+          name: sketches-reports
+          path: sketches-reports
+
+      - uses: arduino/report-size-deltas@v1
+        with:
+          sketches-reports-source: sketches-reports

.github/workflows/release.yml

@@ -0,0 +1,53 @@
+name: release
+
+on:
+  push:
+    tags:
+      - "v[0-9]+.[0-9]+.[0-9]+"
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+    contents: write
+    pages: write
+    id-token: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+
+      - uses: actions/checkout@v3
+        with:
+          ref: main
+
+      - name: update version in repo
+        env:
+          tag: ${{ github.ref_name }}
+        run: |
+          tmp=$(mktemp)
+          jq --arg version $tag '.versions |= [$version] + .' versions.json > "$tmp" && mv "$tmp" versions.json
+          git config --global user.name 'Alan Bits'
+          git config --global user.email '[email protected]'
+          git commit -am "[CHORE] update version to $tag"
+          git push
+          git push --delete origin $tag
+          git tag -fa $tag -m "update via workflow"
+          git push --tags
+
+      - name: Install Arduino CLI
+        uses: arduino/setup-arduino-cli@v1
+
+      - name: build sketch with arduino cli
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          tag: ${{ github.ref_name }}
+        run: |
+          sh build.sh
+
+      - name: Create github release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          tag: ${{ github.ref_name }}
+        run: |
+          gh release create "$tag" --generate-notes ./build/lnpos.ino.bootloader.bin \
+            ./build/lnpos.ino.bin ./build/lnpos.ino.partitions.bin

.github/workflows/static.yml

@@ -0,0 +1,54 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
+
+on:
+    # Runs on pushes targeting the default branch
+    push:
+        branches: ["main"]
+
+    # Allows you to run this workflow manually from the Actions tab
+    workflow_dispatch:
+
+    # Allows you to run this workflow from other workflows
+    workflow_call:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+    contents: read
+    pages: write
+    id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+    group: "pages"
+    cancel-in-progress: false
+
+jobs:
+    deploy:
+        environment:
+            name: github-pages
+            url: ${{ steps.deployment.outputs.page_url }}
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v3
+            - name: Use Node.js
+              uses: actions/setup-node@v3
+              with:
+                node-version: '16.x'
+            - name: build webinstaller
+              run: |
+                sh build-webinstaller.sh
+                cd hardware-installer
+                npm install
+                npx vite build
+            - name: Setup Pages
+              uses: actions/configure-pages@v3
+            - name: Upload artifact
+              uses: actions/upload-pages-artifact@v1
+              with:
+                  path: "hardware-installer/dist"
+            - name: Deploy to GitHub Pages
+              id: deployment
+              uses: actions/deploy-pages@v2

.gitignore

@@ -1,2 +1,3 @@
 tmp
-.vscode
+.vscode
+build

INSTALLER.md

@@ -0,0 +1,21 @@
+<h1>
+LNPoS
+</h1>
+
+## Free and open-source bitcoin point-of-sale
+## Easy setup using browser https://lnbits.github.io/lnpos/installer/
+
+
+LNPoS includes:
+
+- LNPoS (for online LN payments, original <a href="https://github.com/arcbtc/LNPoS">project</a>)
+- LNURLPoS (for offline LN payments, original <a href="https://github.com/arcbtc/LNURLPoS">project</a> )
+- OnChain (for onchain payments)
+- LNURLATM (for making offline LN withdraw links).
+  <br></br>
+
+Original <a href="https://twitter.com/arcbtc/status/1484942260013838336">demo</a>
+
+Video tutorial <a href="https://twitter.com/arcbtc/status/1585605023337168896">https://twitter.com/arcbtc/status/1585605023337168896</a>
+
+Join our telegram group <a href="https://t.me/makerbits">MakerBits</a>

build-webinstaller.sh

@@ -0,0 +1,23 @@
+#!/bin/sh
+PROJECT_NAME=lnpos
+REPO=https://github.com/lnbits/lnpos/releases/download
+INSTALLER_PATH=./hardware-installer/public/firmware
+
+git clone https://github.com/lnbits/hardware-installer
+
+cp INSTALLER.md ./hardware-installer/public/INSTALLER.md
+cp versions.json ./hardware-installer/src/versions.json
+cp installer/config.js ./hardware-installer/src/config.js
+
+sed -i "s/%title%/$PROJECT_NAME/g" ./hardware-installer/index.html
+
+mkdir -p $INSTALLER_PATH
+for device in $(jq -r '.devices[]' ./hardware-installer/src/versions.json); do
+    for version in $(jq -r '.versions[]' ./hardware-installer/src/versions.json); do
+        mkdir -p $INSTALLER_PATH/$device/$version
+        wget $REPO/$version/$PROJECT_NAME.ino.bin
+        wget $REPO/$version/$PROJECT_NAME.ino.partitions.bin
+        wget $REPO/$version/$PROJECT_NAME.ino.bootloader.bin
+        mv $PROJECT_NAME* $INSTALLER_PATH/$device/$version
+    done
+done

build.sh

@@ -0,0 +1,13 @@
+#!/bin/sh
+command -v arduino-cli >/dev/null 2>&1 || { echo >&2 "arduino-cli not found. Aborting."; exit 1; }
+arduino-cli config --additional-urls https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json init
+arduino-cli core update-index
+arduino-cli core install esp32:esp32
+arduino-cli upgrade
+arduino-cli lib install WebSockets ArduinoJson AutoConnect Base64 Keypad PageBuilder uBitcoin
+arduino-cli compile \
+    --build-property "build.partitions=min_spiffs" \
+    --build-property "upload.maximum_size=1966080" \
+    --library ./libraries/TFT_eSPI \
+    --library ./libraries/QRCode \
+    --build-path build --fqbn esp32:esp32:ttgo-lora32 lnpos