2.3.0-0.1.0: [FEAT] - Prism plugin UI

package.json

@@ -1,6 +1,6 @@
 {
   "name": "remote",
-  "version": "2.3.0",
+  "version": "2.3.0-0.1.0",
   "scripts": {
     "dev": "vite dev",
     "dev-https": "vite dev --mode https",

src/lib/@types/plugins.ts

@@ -9,6 +9,9 @@ export type Plugin = {
   dynamic: boolean
 }
 
+/* ----- 
+CLBOSS
+----- */
 export type ClbossStatus = {
   channel_candidates: {
     id: string
@@ -52,3 +55,103 @@ export type ClbossStatus = {
     [key: string]: string
   }
 }
+
+/* -----
+Prism
+----- */
+export type PrismMember = {
+  member_id?: string
+  description: string
+  destination: string
+  split: number
+  fees_incurred_by: 'local' | 'remote' | string
+  payout_threshold_msat: number
+}
+
+export type PrismType = {
+  id?: string // prism_id
+  prism_id: string
+  description: string
+  timestamp: number
+  outlay_factor: number
+  prism_members: PrismMember[]
+}
+
+export interface ListPrismsResponse {
+  prisms: PrismType[]
+}
+
+export type DeletedPrism = {
+  key: string[] // Array of strings representing key elements
+  generation: number // Generation number (possibly version control?)
+  hex: string // Hexadecimal representation of some data
+  string: string // Stringified JSON object (containing prism details)
+}
+
+export interface DeletePrismResponse {
+  deleted: DeletedPrism
+}
+
+export type PrismBinding = {
+  id?: string // prism_id
+  offer_id: string
+  prism_id: string
+  timestamp: number
+  member_outlays: [
+    {
+      member_id: string
+      outlay_msat: number
+    },
+    {
+      member_id: string
+      outlay_msat: number
+    },
+    {
+      member_id: string
+      outlay_msat: number
+    }
+  ]
+}
+
+export interface ListPrismBindingsResponse {
+  bolt12_prism_bindings: PrismBinding[]
+}
+
+export type CreateBindingResponse = {
+  status: 'must-replace' | string
+  timestamp: 1726125745
+  offer_id: string
+  prism_id: string
+  prism_binding_key: string[]
+  prism_members: PrismMember[]
+}
+
+export type DeletedBinding = {
+  key: string[]
+  generation: number
+  hex: string
+  string: string // JSON object
+}
+
+export type DeleteBindingResponse = {
+  binding_removed: DeletedBinding
+}
+
+type Payout = {
+  destination: string
+  payment_hash: string
+  created_at: number
+  parts: number
+  amount_msat: number
+  amount_sent_msat: number
+  payment_preimage: string
+  status: string
+}
+
+export type PrismMemberPayouts = {
+  [key: string]: Payout
+}
+
+export interface PrismPayResponse {
+  prism_member_payouts: PrismMemberPayouts
+}

src/lib/components/TextInput.svelte

@@ -39,7 +39,7 @@
 <div style="width: {width};" class="flex flex-col relative">
   {#if label}
     <label
-      class="{micro ? 'text-xs' : 'text-sm'} w-1/2 text-inherit text-neutral-300 mb-2 font-semibold"
+      class="{micro ? 'text-xs' : 'text-sm'} w-3/4 text-inherit text-neutral-300 mb-2 font-semibold"
       for={name}
     >
       {label}

src/lib/components/Toggle.svelte

@@ -3,6 +3,7 @@
 
   export let toggled = false
   export let large = false
+  export let disabled = false
 
   const roundedStyles = large
     ? 'peer-checked:before:translate-x-6 before:h-5 before:w-5 before:left-[2px] before:bottom-[2px]'
@@ -24,7 +25,13 @@
   <!-- svelte-ignore a11y-click-events-have-key-events -->
   <!-- svelte-ignore a11y-no-noninteractive-element-interactions -->
   <label on:click|stopPropagation class="relative inline-block m-0 {sliderStyles}">
-    <input bind:checked={toggled} on:change class="opacity-0 w-0 h-0 peer" type="checkbox" />
+    <input
+      {disabled}
+      bind:checked={toggled}
+      on:change
+      class="opacity-0 w-0 h-0 peer"
+      type="checkbox"
+    />
     <span
       class="absolute cursor-pointer top-0 left-0 right-0 bottom-0 bg-neutral-300 peer-checked:bg-purple-500 transition-all rounded-full before:absolute before:bg-white before:transition-all before:rounded-full before:shadow-md {roundedStyles}"
     />

src/lib/db/index.ts

@@ -13,6 +13,7 @@ import type { ExchangeRate } from '../@types/exchange-rates.js'
 import type { Node } from '../@types/nodes.js'
 import type { Payment } from '$lib/@types/payments.js'
 import type { Tag } from '$lib/@types/metadata.js'
+import type { PrismBinding, PrismType } from '$lib/@types/plugins.js'
 
 class DB extends Dexie {
   channels!: Table<Channel>
@@ -29,11 +30,13 @@ class DB extends Dexie {
   utxos!: Table<Utxo>
   wallets!: Table<Wallet>
   withdrawals!: Table<Withdrawal>
+  prisms!: Table<PrismType>
+  prismBindings!: Table<PrismBinding>
 
   constructor() {
     super('Clams Remote')
 
-    this.version(1).stores({
+    this.version(2).stores({
       channels:
         '&[id+walletId], id, walletId, shortId, balanceLocal, balanceRemote, peerId, status, opener, [id+opener], [fundingTransactionId+fundingOutput], [fundingTransactionId+fundingOutput+walletId], closeTo, *metadata.tags, metadata.contact',
       contacts: '&id, name, npub',
@@ -53,7 +56,9 @@ class DB extends Dexie {
       utxos: '&id, walletId, txid, timestamp, spendingTxid, *metadata.tags, metadata.contact',
       wallets: '&id, type, label, nodeId, *metadata.tags, metadata.contact, createdAt',
       withdrawals:
-        '&id, walletId, destination, timestamp, amount, fee, *metadata.tags, metadata.contact'
+        '&id, walletId, destination, timestamp, amount, fee, *metadata.tags, metadata.contact',
+      prisms: `&id, prism_id, description, timestamp, outlay_factor, prism_members`,
+      prismBindings: `&id, prism_id, offer_id, timestamp, member_outlays`
     })
   }
 }

src/lib/filters.ts

@@ -383,6 +383,15 @@ export const routeSorters = (route: string): Sorters => {
         options: [timestamp]
       }
     }
+    case 'prisms': {
+      const timestamp = timestampSorter()
+
+      return {
+        applied: { key: timestamp.key, direction: timestamp.direction },
+        options: [timestamp]
+      }
+    }
+
     default: {
       throw new Error(`Unknown route: ${route}`)
     }

src/lib/i18n/en.json

@@ -40,6 +40,12 @@
     "/plugins/clboss": {
       "title": "CLBOSS"
     },
+    "/plugins/prism": {
+      "title": "Prisms"
+    },
+    "/plugins/prism/create": {
+      "title": "Create Prism"
+    },
     "/settings": {
       "title": "Settings"
     },
@@ -241,6 +247,8 @@
     "no_forwards_filtered": "No forwards match your current filters.",
     "no_wallets": "No wallets here, add a wallet to get started.",
     "no_wallets_filtered": "No wallets match your current filters.",
+    "no_prisms": "No prisms here, create a prism to get started.",
+    "no_prisms_filtered": "No prisms march your current filters",
     "destination": "Destination",
     "unconfirmed": "Spendable (unconfirmed)",
     "confirmed": "Spendable",
@@ -535,7 +543,23 @@
     "ignoring_onchain_funds_until": "Ignoring onchain funds until",
     "toggle_clboss_permissions": "Toggle CLBOSS permissions on a per channel basis",
     "node_id": "Node ID",
-    "permissions": "Permissions"
+    "permissions": "Permissions",
+    "prism": "Prism",
+    "offer_bound": "offer bound",
+    "name": "Name",
+    "outlay_factor": "Outlay factor",
+    "split": "Split",
+    "payout_threshold": "Payout threshold (msats)",
+    "fees_incurred_by": "Fees incurred by",
+    "binding": "Binding",
+    "member": "Member",
+    "members": "Members",
+    "offers": "Offers",
+    "delete_prism_warning": "Are you sure you want to delete this Prism?",
+    "no_active_offers_found": "No active offers found",
+    "create_one": "create one",
+    "prism_name_placeholder": "Tips for the band",
+    "member_destination_placeholder": "BOLT12 offer or node pubkey"
   },
   "messages": {
     "closing_channel": "Closing a channel will publish an onchain transaction and settle the current channel balances.",

src/lib/i18n/es.json

@@ -40,6 +40,12 @@
     "/plugins/clboss": {
       "title": "CLBOSS"
     },
+    "/plugins/prism": {
+      "title": "Prisms"
+    },
+    "/plugins/prism/create": {
+      "title": "Crear Prism"
+    },
     "/settings": {
       "title": "Configuración"
     },
@@ -240,6 +246,8 @@
     "no_forwards_filtered": "No hay reenvios que coincidan con tus filtros actuales.",
     "no_wallets": "No hay billeteras aquí, agrega una billetera para comenzar.",
     "no_wallets_filtered": "No hay billeteras que coincidan con tus filtros actuales.",
+    "no_prisms": "No hay Prisms aquí, crea un Prism para comenzar.",
+    "no_prisms_filtered": "No hay Prisms que coincidan con tus filtros actuales.",
     "destination": "Destino",
     "unconfirmed": "Para gastar (sin confirmar)",
     "confirmed": "Para gastar",
@@ -534,7 +542,23 @@
     "ignoring_onchain_funds_until": "Ignorando fondos en cadena hasta",
     "toggle_clboss_permissions": "Alternar permisos de CLBOSS por canal",
     "node_id": "ID del nodo",
-    "permissions": "Permisos"
+    "permissions": "Permisos",
+    "prism": "Prism",
+    "offer_bound": "límite de oferta",
+    "name": "Nombre",
+    "outlay_factor": "Factor de desembolso",
+    "split": "División",
+    "payout_threshold": "Umbral de pago (msats)",
+    "fees_incurred_by": "Comisiones asumidas por",
+    "binding": "Vinculante",
+    "member": "Miembro",
+    "members": "Miembros",
+    "offers": "Ofertas",
+    "delete_prism_warning": "¿Estás seguro de que deseas eliminar este Prism?",
+    "no_active_offers_found": "No se encontraron ofertas activas",
+    "create_one": "crear una",
+    "prism_name_placeholder": "Consejos para la banda",
+    "member_destination_placeholder": "Oferta BOLT12 o clave pública del nodo"
   },
   "messages": {
     "closing_channel": "Cerrar un canal publicará una transacción en la cadena y liquidará los saldos actuales del canal.",

src/lib/icons/prism.ts

@@ -0,0 +1,4 @@
+export default `<svg width="100%" height="100%" viewBox="0 0 73 71" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M69.2636 54.6851L38.6934 68.5069C37.2612 69.1542 35.6195 69.1542 34.1875 68.5058L3.60725 54.6681C2.06943 53.9722 1.52367 52.0625 2.46153 50.6591L34.167 3.21462C35.2495 1.59485 37.6306 1.59518 38.7126 3.21528L70.4105 50.6765C71.348 52.0802 70.8014 53.9897 69.2636 54.6851Z" stroke="currentColor" stroke-width="2.5" stroke-linecap="round" stroke-linejoin="round"/>
+<path d="M36.4375 2.71703V69" stroke="currentColor" stroke-width="2.5" stroke-linecap="round" stroke-linejoin="round"/>
+</svg>`

src/lib/wallets/coreln/index.ts

@@ -17,6 +17,7 @@ import { parseNodeAddress } from '$lib/address.js'
 import handleError from './error.js'
 import Network from './network.js'
 import Clboss from './clboss.js'
+import Prism from './prism.js'
 import { createSocket } from './worker.js'
 
 import type {
@@ -40,7 +41,8 @@ import type {
   NetworkInterface,
   ConnectionStatus,
   PluginsInterface,
-  ClbossInterface
+  ClbossInterface,
+  PrismInterface
 } from '../interfaces.js'
 import Plugins from './plugins.js'
 
@@ -69,6 +71,7 @@ class CoreLightning implements CorelnConnectionInterface {
   network: NetworkInterface
   plugins: PluginsInterface
   clboss: ClbossInterface
+  prism: PrismInterface
 
   constructor(
     walletId: string,
@@ -181,6 +184,7 @@ class CoreLightning implements CorelnConnectionInterface {
     this.network = new Network(this)
     this.plugins = new Plugins(this)
     this.clboss = new Clboss(this)
+    this.prism = new Prism(this)
   }
 
   updateToken(token: string): void {