From 887c68f052db1b66aa38e4102b4d36bea9f9eb7e Mon Sep 17 00:00:00 2001
From: Alex Gleason <alex@alexgleason.me>
Date: Sat, 26 Aug 2023 11:55:16 -0500
Subject: [PATCH] config: add comments to all config options

---
 src/config.ts | 22 ++++++++++++++++------
 1 file changed, 16 insertions(+), 6 deletions(-)

diff --git a/src/config.ts b/src/config.ts
index f13a407..7add7d8 100644
--- a/src/config.ts
+++ b/src/config.ts
@@ -1,4 +1,4 @@
-import { dotenv, nip19, secp } from '@/deps.ts';
+import { dotenv, getPublicKey, nip19, secp } from '@/deps.ts';
 
 /** Load environment config from `.env` */
 await dotenv.load({
@@ -9,6 +9,7 @@ await dotenv.load({
 
 /** Application-wide configuration. */
 const Conf = {
+  /** Ditto admin secret key in nip19 format. This is the way it's configured by an admin. */
   get nsec() {
     const value = Deno.env.get('DITTO_NSEC');
     if (!value) {
@@ -19,13 +20,15 @@ const Conf = {
     }
     return value as `nsec1${string}`;
   },
+  /** Ditto admin secret key in hex format. */
   get seckey() {
-    const result = nip19.decode(Conf.nsec);
-    if (result.type !== 'nsec') {
-      throw new Error('Invalid DITTO_NSEC');
-    }
-    return result.data;
+    return nip19.decode(Conf.nsec).data;
   },
+  /** Ditto admin public key in hex format. */
+  get pubkey() {
+    return getPublicKey(Conf.seckey);
+  },
+  /** Ditto admin secret key as a Web Crypto key. */
   get cryptoKey() {
     return crypto.subtle.importKey(
       'raw',
@@ -39,24 +42,31 @@ const Conf = {
     const { protocol, host } = Conf.url;
     return `${protocol === 'https:' ? 'wss:' : 'ws:'}//${host}/relay`;
   },
+  /** Domain of the Ditto server, including the protocol. */
   get localDomain() {
     return Deno.env.get('LOCAL_DOMAIN') || 'http://localhost:8000';
   },
+  /** Path to the main SQLite database which stores users, events, and more. */
   get dbPath() {
     return Deno.env.get('DB_PATH') || 'data/db.sqlite3';
   },
+  /** Character limit to enforce for posts made through Mastodon API. */
   get postCharLimit() {
     return Number(Deno.env.get('POST_CHAR_LIMIT') || 5000);
   },
+  /** Admin contact to expose through various endpoints. This information is public. */
   get adminEmail() {
     return Deno.env.get('ADMIN_EMAIL') || 'webmaster@localhost';
   },
+  /** @deprecated Use relays from the database instead. */
   get poolRelays() {
     return (Deno.env.get('RELAY_POOL') || '').split(',').filter(Boolean);
   },
+  /** @deprecated Publish only to the local relay unless users are mentioned, then try to also send to the relay of those users. Deletions should also be fanned out. */
   get publishRelays() {
     return ['wss://relay.mostr.pub'];
   },
+  /** Domain of the Ditto server as a `URL` object, for easily grabbing the `hostname`, etc. */
   get url() {
     return new URL(Conf.localDomain);
   },