add integration test for aid to join multisig

.github/workflows/main.yml

@@ -47,25 +47,34 @@ jobs:
         run: npm run build
 
       - name: Upload coverage reports to Codecov
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v4
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
   test:
-    name: Run integration test
-    runs-on: ubuntu-latest
+    name: Run integration test using keria:${{ matrix.keria-version }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: ['ubuntu-latest']
+        keria-version: ['latest']
+        node-version: ['20']
+    env:
+      KERIA_IMAGE_TAG: ${{ matrix.keria-version }}
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4
 
       - uses: actions/setup-node@v4
         with:
-          node-version: '18'
+          node-version: ${{ matrix.node-version }}
           cache: 'npm'
       - name: install deps
         run: npm ci
       - name: Build
         run: npm run build
+      - name: Print docker compose config
+        run: docker compose config
       - name: Start dependencies
         run: docker compose up deps --pull always
       - name: Run integration test

.github/workflows/update-documentation.yml

@@ -4,35 +4,44 @@ on:
     branches:
       - 'main'
   workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
 jobs:
-  update:
-    name: Updater documentation
+  build:
+    name: Build docs
 
     runs-on: ubuntu-latest
 
     steps:
-      - name: Checkout repo
-        uses: actions/checkout@v2
-
-      - uses: actions/setup-node@v2
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Node
+        uses: actions/setup-node@v4
         with:
-          node-version: '18.12.1'
-          cache: 'npm'
-
-      - name: build
+          node-version: "20"
+          cache: "npm"
+      - name: Install dependencies
         run: |
-          git config --local user.email "github-actions[bot]@users.noreply.github.com"
-          git config --local user.name "github-actions[bot]"
-          git checkout docs
-          npm cache clean --force
           npm set registry https://registry.npmjs.org/
-          npm i
-          npx typedoc src/index.ts
-          git add .
-          git commit -a -m "Update documentation"
-
-      - name: Push changes
-        uses: ad-m/github-push-action@master
+          npm ci
+      - name: Build documentation
+        run: npx typedoc src/index.ts
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
         with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          branch: ${{ github.ref }}
+          path: ./docs
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.jsdoc.json

@@ -8,9 +8,7 @@
         "includePattern": ".ts$",
         "excludePattern": "(node_modules/|docs|dist|examples|test)"
     },
-    "plugins": [
-        "plugins/markdown"
-    ],
+    "plugins": ["plugins/markdown"],
     "templates": {
         "cleverLinks": false,
         "monospaceLinks": true,
@@ -24,4 +22,4 @@
         "recurse": true,
         "template": "./node_modules/minami"
     }
-}
+}

.prettierignore

@@ -0,0 +1,5 @@
+diagrams/
+docs/
+package.json
+package-lock.json
+.github/

.prettierrc

@@ -1,7 +1,7 @@
 {
-  "semi": true,
-  "trailingComma": "es5",
-  "singleQuote": true,
-  "printWidth": 80,
-  "tabWidth": 4
-}
+    "semi": true,
+    "trailingComma": "es5",
+    "singleQuote": true,
+    "printWidth": 80,
+    "tabWidth": 4
+}

README.md

@@ -9,7 +9,7 @@ Project Name: signify-ts
 
 ## Signify - KERI Signing at the Edge
 
-Of the five functions in a KERI agent, 
+Of the five functions in a KERI agent,
 
 1. Key generation
 2. Encrypted key storage
@@ -19,20 +19,18 @@ Of the five functions in a KERI agent,
 
 Signify-TS splits off two, key generation and event signing into a TypeScript library to provide "signing at the edge".
 It accomplishes this by using [libsodium](https://doc.libsodium.org/) to generate ed25519 key pairs for signing and x25519 key pairs for encrypting the
-private keys, next public keys and salts used to generate the private keys.  The encrypted private key and salts are then stored on a
-remote cloud agent that never has access to the decryption keys.  New key pair sets (current and next) will be generated 
+private keys, next public keys and salts used to generate the private keys. The encrypted private key and salts are then stored on a
+remote cloud agent that never has access to the decryption keys. New key pair sets (current and next) will be generated
 for inception and rotation events with only the public keys and blake3 hash of the next keys made available to the agent.
 
 The communication protocol between a Signify client and [KERI](https://github.com/WebOfTrust/keri) agent will encode all cryptographic primitives as CESR base64
-encoded strings for the initial implementation.  Support for binary CESR can be added in the future.
-
+encoded strings for the initial implementation. Support for binary CESR can be added in the future.
 
 ### Environment Setup
 
 The code is built using Typescript and running code locally requires a Mac or Linux OS.
 
--   Install [Node.js](https://nodejs.org)    
-
+-   Install [Node.js](https://nodejs.org)
 
 -   Install dependencies:
     ```bash
@@ -77,6 +75,22 @@ signify-ts-deps-1  | Dependencies running
 signify-ts-deps-1 exited with code 0
 ```
 
+It is possible to change the keria image by using environment variables. For example, to use weboftrust/keria:0.1.3, do:
+
+```bash
+export KERIA_IMAGE_TAG=0.1.3
+docker compose pull
+docker compose up deps
+```
+
+To use another repository, you can do:
+
+```bash
+export KERIA_IMAGE=gleif/keria
+docker compose pull
+docker compose up deps
+```
+
 **Important!** The integration tests runs on the build output in `dist/` directory. Make sure to run build before running the integration tests.
 
 ```bash
@@ -103,19 +117,10 @@ TEST_ENVIRONMENT=local npx jest examples/integration-scripts/credentials.test.ts
 
 This changes the discovery urls to use `localhost` instead of the hostnames inside the docker network.
 
-### Old integration scripts
-
-To run any of the old integration scripts that has not yet been converted to an integration test. Use `ts-node-esm`
-
-```bash
-npx ts-node-esm examples/integration-scripts/challenge.ts
-```
-
 # Diagrams
 
 Account Creation Workflow
 
 ![Account Creation](/diagrams/account-creation-workflow.png)
 
-
 ![Account Creation Webpage](/diagrams/account-creation-webpage-workflow.png)

codecov.yaml

@@ -1,10 +1,10 @@
 coverage:
-  status:
-    project:
-      default:
-        target: 55
-        paths: ["src"]
-    patch:
-      default:
-        target: 75
-        paths: ["src"]
+    status:
+        project:
+            default:
+                target: 55
+                paths: ['src']
+        patch:
+            default:
+                target: 75
+                paths: ['src']

config/keria.json

@@ -1,17 +1,15 @@
 {
     "dt": "2023-12-01T10:05:25.062609+00:00",
     "keria": {
-      "dt": "2023-12-01T10:05:25.062609+00:00",
-      "curls": [
-        "http://keria:3902/"
-      ]
+        "dt": "2023-12-01T10:05:25.062609+00:00",
+        "curls": ["http://keria:3902/"]
     },
     "iurls": [
-      "http://witness-demo:5642/oobi/BBilc4-L3tFUnfM_wJr4S4OJanAv_VmF_dJNN6vkf2Ha/controller",
-      "http://witness-demo:5643/oobi/BLskRTInXnMxWaGqcpSyMgo0nYbalW99cGZESrz3zapM/controller",
-      "http://witness-demo:5644/oobi/BIKKuvBwpmDVA4Ds-EpL5bt9OqPzWPja2LigFYZN2YfX/controller",
-      "http://witness-demo:5645/oobi/BM35JN8XeJSEfpxopjn5jr7tAHCE5749f0OobhMLCorE/controller",
-      "http://witness-demo:5646/oobi/BIj15u5V11bkbtAxMA7gcNJZcax-7TgaBMLsQnMHpYHP/controller",
-      "http://witness-demo:5647/oobi/BF2rZTW79z4IXocYRQnjjsOuvFUQv-ptCf8Yltd7PfsM/controller"
+        "http://witness-demo:5642/oobi/BBilc4-L3tFUnfM_wJr4S4OJanAv_VmF_dJNN6vkf2Ha/controller",
+        "http://witness-demo:5643/oobi/BLskRTInXnMxWaGqcpSyMgo0nYbalW99cGZESrz3zapM/controller",
+        "http://witness-demo:5644/oobi/BIKKuvBwpmDVA4Ds-EpL5bt9OqPzWPja2LigFYZN2YfX/controller",
+        "http://witness-demo:5645/oobi/BM35JN8XeJSEfpxopjn5jr7tAHCE5749f0OobhMLCorE/controller",
+        "http://witness-demo:5646/oobi/BIj15u5V11bkbtAxMA7gcNJZcax-7TgaBMLsQnMHpYHP/controller",
+        "http://witness-demo:5647/oobi/BF2rZTW79z4IXocYRQnjjsOuvFUQv-ptCf8Yltd7PfsM/controller"
     ]
-  }
+}

docker-compose.yaml

@@ -26,7 +26,7 @@ services:
             - 7723:7723
 
     keria:
-        image: weboftrust/keria:latest
+        image: ${KERIA_IMAGE:-weboftrust/keria}:${KERIA_IMAGE_TAG:-latest}
         environment:
             - KERI_AGENT_CORS=1
             - KERI_URL=http://keria:3902