Merge pull request #32 from remcoros/feat/frigate

feat: add Frigate as selectable Electrum server backend

Author: remcoros

startos/actions/config.ts

@@ -58,7 +58,12 @@ export const inputSpec = InputSpec.of({
       server: Value.dynamicUnion(async ({ effects }) => {
         // determine default server type and disabled options
         const installedPackages = await effects.getInstalledPackages()
-        let serverType: 'fulcrum' | 'electrs' | 'bitcoind' | 'public' = 'public'
+        let serverType:
+          | 'frigate'
+          | 'fulcrum'
+          | 'electrs'
+          | 'bitcoind'
+          | 'public' = 'public'
         let disabled: string[] = []
 
         if (installedPackages.includes('bitcoind')) {
@@ -79,12 +84,25 @@ export const inputSpec = InputSpec.of({
           disabled.push('fulcrum')
         }
 
+        // frigate takes priority as default when installed
+        if (installedPackages.includes('frigate')) {
+          serverType = 'frigate'
+        } else {
+          disabled.push('frigate')
+        }
+
         return {
           name: 'Server',
           description: 'Bitcoin/Electrum Server',
           default: serverType,
           disabled: disabled,
           variants: Variants.of({
+            frigate: {
+              name:
+                'Frigate' +
+                (disabled.includes('frigate') ? ' (not installed)' : ''),
+              spec: InputSpec.of({}),
+            },
             fulcrum: {
               name:
                 'Fulcrum (recommended)' +

startos/dependencies.ts

@@ -17,10 +17,12 @@ export const setDependencies = sdk.setupDependencies(async ({ effects }) => {
 
   if (serverType == 'fulcrum') {
     deps['fulcrum'] = { kind: 'exists', versionRange: '>=2.1.0:1' }
+  } else if (serverType == 'frigate') {
+    deps['frigate'] = { kind: 'exists', versionRange: '>=1.5.2:0' }
   } else if (serverType == 'electrs') {
-    deps['electrs'] = { kind: 'exists', versionRange: '>=0.10.9:1-alpha.1' }
+    deps['electrs'] = { kind: 'exists', versionRange: '>=0.11.1:0' }
   } else if (serverType == 'bitcoind') {
-    deps['bitcoind'] = { kind: 'exists', versionRange: '>=28.1:3-alpha.4' }
+    deps['bitcoind'] = { kind: 'exists', versionRange: '>=28.3:0' }
   }
 
   if (proxyType == 'tor') {

startos/fileModels/store.yaml.ts

@@ -11,6 +11,7 @@ const shape = z.object({
     server: z.object({
       type: z
         .union([
+          z.literal('frigate'),
           z.literal('fulcrum'),
           z.literal('electrs'),
           z.literal('bitcoind'),
@@ -46,13 +47,15 @@ export const createDefaultStore = async (effects: T.Effects) => {
   // config file does not exist, create it
   console.log('Sparrow config file does not exist, creating it')
   const installedPackages = await effects.getInstalledPackages()
-  const serverType = installedPackages.includes('fulcrum')
-    ? 'fulcrum'
-    : installedPackages.includes('electrs')
-      ? 'electrs'
-      : installedPackages.includes('bitcoind')
-        ? 'bitcoind'
-        : 'public'
+  const serverType = installedPackages.includes('frigate')
+    ? 'frigate'
+    : installedPackages.includes('fulcrum')
+      ? 'fulcrum'
+      : installedPackages.includes('electrs')
+        ? 'electrs'
+        : installedPackages.includes('bitcoind')
+          ? 'bitcoind'
+          : 'public'
 
   await store.write(effects, {
     title: 'Sparrow on StartOS',

startos/main.ts

@@ -106,6 +106,12 @@ export const main = sdk.setupMain(async ({ effects }) => {
         serverType: 'ELECTRUM_SERVER',
         electrumServer: 'tcp://fulcrum.startos:50001',
       }
+    } else if (conf.sparrow.server.type == 'frigate') {
+      sparrowConfig = {
+        ...sparrowConfig,
+        serverType: 'ELECTRUM_SERVER',
+        electrumServer: 'tcp://frigate.startos:50001',
+      }
     } else if (conf.sparrow.server.type == 'electrs') {
       sparrowConfig = {
         ...sparrowConfig,
@@ -201,7 +207,8 @@ export const main = sdk.setupMain(async ({ effects }) => {
 
           if (
             conf.sparrow.server.type == 'electrs' ||
-            conf.sparrow.server.type == 'fulcrum'
+            conf.sparrow.server.type == 'fulcrum' ||
+            conf.sparrow.server.type == 'frigate'
           ) {
             return {
               message: i18n('Using local electrum server'),

startos/manifest/index.ts

@@ -66,6 +66,14 @@ export const manifest = setupManifest({
         icon: 'https://raw.githubusercontent.com/Start9Labs/fulcrum-startos/master/icon.png',
       },
     },
+    frigate: {
+      description: 'Used to connect to your Bitcoin node.',
+      optional: true,
+      metadata: {
+        title: 'Frigate',
+        icon: 'https://raw.githubusercontent.com/remcoros/frigate-startos/master/icon.png',
+      },
+    },
     tor: {
       description: 'Used to route Sparrow traffic through Tor for privacy.',
       optional: true,

startos/versions/index.ts

@@ -1,10 +1,11 @@
 import { VersionGraph } from '@start9labs/start-sdk'
-import { v2_5_1, SPARROW_VERSION } from './v2_5_1'
+import { v2_5_1_1, SPARROW_VERSION } from './v2_5_1_1'
+import { v2_5_1 } from './v2_5_1'
 import { v2_4_2 } from './v2_4_2'
 
 export const versionGraph = VersionGraph.of({
-  current: v2_5_1,
-  other: [v2_4_2],
+  current: v2_5_1_1,
+  other: [v2_5_1, v2_4_2],
 })
 
 export { SPARROW_VERSION }

startos/versions/v2_5_1_1.ts

@@ -0,0 +1,18 @@
+import { VersionInfo } from '@start9labs/start-sdk'
+
+export const v2_5_1_1 = VersionInfo.of({
+  version: '2.5.1:1',
+  releaseNotes: {
+    en_US: 'Add Frigate as a selectable Electrum server backend',
+    es_ES: 'Añadir Frigate como servidor Electrum seleccionable',
+    de_DE: 'Frigate als auswählbares Electrum-Server-Backend hinzufügen',
+    pl_PL: 'Dodaj Frigate jako wybieralny serwer Electrum',
+    fr_FR: 'Ajouter Frigate comme backend serveur Electrum sélectionnable',
+  },
+  migrations: {
+    up: async ({ effects }) => {},
+    down: async ({ effects }) => {},
+  },
+})
+
+export const SPARROW_VERSION = '2.5.1'