Coordinator descriptors

.changeset/beige-chefs-poke.md

@@ -0,0 +1,5 @@
+---
+"@caravan/clients": patch
+---
+
+make sure build files are included in publication

.changeset/light-goats-tan.md

@@ -0,0 +1,5 @@
+---
+"@caravan/coordinator": minor
+---
+
+Implements a UI for using @caravan/descriptors in the coordinator for importing and exporting descriptors. Includes some cleanup to some build processes.

.github/workflows/ci.yml

@@ -3,7 +3,7 @@ name: Test
 on: [push, pull_request]
 
 jobs:
-  build:
+  ci:
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -21,17 +21,11 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: 20
-
-      - name: Install wasm-pack
-        uses: jetli/[email protected]
-        with:
-          # Optional version of wasm-pack to install(eg. 'v0.9.1', 'latest')
-          version: 'latest'
+          cache: 'npm'
 
       - name: Install Dependencies
         run: npm install
 
-
       - name: Run tests
         run: |
           npx turbo run ci

.github/workflows/deploy.yml

@@ -1,6 +1,7 @@
 name: Deploy GH Pages
 
 on:
+  workflow_dispatch:
   push:
     tags:
       - '@caravan/coordinator**'
@@ -21,23 +22,11 @@ jobs:
       - name: Checkout Repo
         uses: actions/checkout@v3
 
-      - name: Cache Dependencies ...
-        uses: actions/cache@v1
-        with:
-          path: ~/.npm
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: ${{ runner.os }}-node-
-
       - name: Setup Node.js 20
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: 20
-
-      - name: Install wasm-pack
-        uses: jetli/[email protected]
-        with:
-          # Optional version of wasm-pack to install(eg. 'v0.9.1', 'latest')
-          version: 'latest'
+          cache: 'npm'
 
       - name: Install dependencies
         run: npm install

.github/workflows/release.yml

@@ -29,6 +29,7 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: 20
+          cache: 'npm'
 
       - name: Creating .npmrc
         run: |
@@ -38,12 +39,6 @@ jobs:
         env:
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
 
-      - name: Install wasm-pack
-        uses: jetli/[email protected]
-        with:
-          # Optional version of wasm-pack to install(eg. 'v0.9.1', 'latest')
-          version: 'latest'
-
       - name: Install Dependencies
         run: npm install
 

.github/workflows/vercel.yml

@@ -1,34 +1,34 @@
 name: Deploy Vercel
 
-on: [ push, pull_request ]
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+  pull_request:
+    types:
+      - opened
+      - synchronize
+    branches:
+      - main
+    paths-ignore:
+      - '**'
 
 jobs:
   vercel:
     name: Deploy Vercel
     runs-on: ubuntu-latest
-    if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.event.pull_request.base.repo.full_name
+    if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.event.pull_request.base.repo.full_name
 
     steps:
       - name: Checkout Repo
         uses: actions/checkout@v3
 
-      - name: Cache Dependencies ...
-        uses: actions/cache@v1
-        with:
-          path: ~/.npm
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: ${{ runner.os }}-node-
-
       - name: Setup Node.js 20
         uses: actions/setup-node@v3
         with:
           node-version: 20
-
-      - name: Install wasm-pack
-        uses: jetli/[email protected]
-        with:
-          # Optional version of wasm-pack to install (eg. 'v0.9.1', 'latest')
-          version: 'latest'
+          cache: 'npm'
 
       - name: Install dependencies
         run: npm ci
@@ -40,7 +40,7 @@ jobs:
         # forcing a build to avoid the cache. Probably unnecessary
         # but useful in case any environment variables change that might
         # impact the build
-        run: npx turbo run build --force
+        run: npx turbo run build
 
 
       - name: Deploy to Staging ...

README.md

@@ -102,6 +102,9 @@ And another good resource for what the workflow should look like [here](https://
 
 Clone the repo, install all dependencies, and run dev instances of
 everything.
+
+(Checkout the README for caravan/descriptors to make sure you can build the wasm dependencies.)
+
 ```shell
 $ npm install turbo --global
 $ git clone https://github.com/caravan-bitcoin/caravan.git

apps/coordinator/README.md

@@ -17,7 +17,7 @@ safekeep the addresses (and redeem scripts & BIP32 paths) you create.
 Caravan is a stateless pure HTML & JavaScript web application. It can
 be run in any web browser from a local or remote installation.
 
-### Unchained Capital GitHub
+### Caravan Bitcoin Github
 
 The simplest way to use Caravan is to visit
 [https://caravan-bitcoin.github.io/caravan](https://caravan-bitcoin.github.io/caravan),
@@ -58,7 +58,7 @@ $ git clone https://github.com/caravan-bitcoin/caravan
 $ cd caravan
 $ npm install
 ...
-$ npm run dev
+$ npm run dev:coordinator
 ...
 ```
 
@@ -73,7 +73,7 @@ application for a production deployment and then host the contents of
 the resulting `build` directory via a webserver such as `nginx`.
 
 ```bash
-$ npm run build
+$ npm run build:coordinator
 ...
 ```