fix it up

2026-03-26 02:11:56 +00:00 · 2023-03-27 14:58:46 -06:00
parent 736395d25e
commit 07e92913ac
5 changed files with 179 additions and 191 deletions
--- a/lib/config/builder/list.ts
+++ b/lib/config/builder/list.ts
@@ -1,7 +1,5 @@
 import { BuilderExtract, IBuilder } from "./builder";
 import { Config } from "./config";
-import { Default, NumberSpec, StringSpec } from "./value";
-import { Description } from "./value";
 import { Variants } from "./variants";
 import {
  InputSpec,
@@ -34,10 +32,19 @@ import {
 */
 export class List<A extends ValueSpecList> extends IBuilder<A> {
  static string<
-    A extends Description &
-    Default<string[]> & {
+    A extends {
+      name: string;
+      description: string | null;
+      warning: string | null;
+      default: string[]
      range: string;
-      spec: StringSpec;
+      spec: {
+        masked: boolean | null;
+        placeholder: string | null;
+        pattern: string | null;
+        patternDescription: string | null;
+        textarea: boolean | null;
+      };
    }
  >(a: A) {
    return new List({
@@ -47,10 +54,18 @@ export class List<A extends ValueSpecList> extends IBuilder<A> {
    } as ValueSpecListOf<"string">);
  }
  static number<
-    A extends Description &
-    Default<number[]> & {
+    A extends {
+      name: string;
+      description: string | null;
+      warning: string | null;
+      default: string[]
      range: string;
-      spec: NumberSpec;
+      spec: {
+        range: string;
+        integral: boolean;
+        units: string | null;
+        placeholder: string | null;
+      };
    }
  >(a: A) {
    return new List({
@@ -60,8 +75,11 @@ export class List<A extends ValueSpecList> extends IBuilder<A> {
    });
  }
  static obj<
-    A extends Description &
-    Default<Record<string, unknown>[]> & {
+    A extends {
+      name: string;
+      description: string | null;
+      warning: string | null;
+      default: Record<string, unknown>[]
      range: string;
      spec: {
        spec: Config<InputSpec>;
@@ -90,13 +108,13 @@ export class List<A extends ValueSpecList> extends IBuilder<A> {
    });
  }
  static union<
-    A extends Description &
-    Default<string[]> & {
+    A extends {
+      name: string;
+      description: string | null;
+      warning: string | null;
+      default: Record<string, unknown>[]
      range: string;
      spec: {
-        name: string;
-        description: null | string;
-        warning: null | string;
        variants: Variants<{ [key: string]: { name: string, spec: InputSpec } }>;
        displayAs: null | string;
        uniqueBy: UniqueBy;
--- a/lib/config/builder/value.ts
+++ b/lib/config/builder/value.ts
@@ -4,7 +4,6 @@ import { List } from "./list";
 import { Variants } from "./variants";
 import {
  InputSpec,
-  UniqueBy,
  ValueSpec,
  ValueSpecList,
  ValueSpecNumber,
@@ -17,34 +16,6 @@ export type DefaultString =
    charset: string | null | undefined;
    len: number;
  };
-export type Description = {
-  name: string;
-  description: string | null;
-  warning: string | null;
-};
-export type Default<A> = {
-  default: A;
-};
-export type NullableDefault<A> = {
-  default: null | A;
-};
-
-export type StringSpec = {
-  masked: boolean | null;
-  placeholder: string | null;
-  pattern: null | string;
-  patternDescription: null | string;
-  textarea: boolean | null;
-};
-export type NumberSpec = {
-  range: string;
-  integral: boolean;
-  units: string | null;
-  placeholder: string | null;
-};
-export type Nullable = {
-  nullable: boolean;
-};

 /**
 * A value is going to be part of the form in the FE of the OS.
@@ -70,17 +41,32 @@ export type Nullable = {
 ```
 */
 export class Value<A extends ValueSpec> extends IBuilder<A> {
-  static boolean<A extends Description & Default<boolean>>(a: A) {
+  static boolean<
+    A extends {
+      name: string,
+      description: string | null
+      warning: string | null
+      default: boolean | null
+    }
+  >(a: A) {
    return new Value({
      type: "boolean" as const,
      ...a,
    });
  }
  static string<
-    A extends Description &
-    NullableDefault<DefaultString> &
-    Nullable &
-    StringSpec
+    A extends {
+      name: string,
+      description: string | null
+      warning: string | null
+      nullable: boolean
+      default: DefaultString | null
+      masked: boolean | null;
+      placeholder: string | null;
+      pattern: string | null;
+      patternDescription: string | null;
+      textarea: boolean | null;
+    }
  >(a: A) {
    return new Value({
      type: "string" as const,
@@ -88,7 +74,17 @@ export class Value<A extends ValueSpec> extends IBuilder<A> {
    } as ValueSpecString);
  }
  static number<
-    A extends Description & NullableDefault<number> & Nullable & NumberSpec
+    A extends {
+      name: string
+      description: string | null
+      warning: string | null
+      nullable: boolean
+      default: number | null
+      range: string;
+      integral: boolean;
+      units: string | null;
+      placeholder: string | null;
+    }
  >(a: A) {
    return new Value({
      type: "number" as const,
@@ -96,8 +92,12 @@ export class Value<A extends ValueSpec> extends IBuilder<A> {
    } as ValueSpecNumber);
  }
  static select<
-    A extends Description &
-    Default<string> & {
+    A extends {
+      name: string
+      description: string | null
+      warning: string | null
+      nullable: boolean
+      default: string | null
      values: Record<string, string>;
    }
  >(a: A) {
@@ -106,16 +106,28 @@ export class Value<A extends ValueSpec> extends IBuilder<A> {
      ...a,
    });
  }
+  static multiselect<
+    A extends {
+      name: string
+      description: string | null
+      warning: string | null
+      default: string[]
+      values: Record<string, string>;
+      range: string
+    }
+  >(a: A) {
+    return new Value({
+      type: "multiselect" as const,
+      ...a,
+    });
+  }
  static object<
    A extends {
      name: string;
      description: string | null;
      warning: string | null;
      default: null | { [k: string]: unknown };
-      displayAs: null | string;
-      uniqueBy: null | string;
      spec: Config<InputSpec>;
-      valueNames: Record<string, string>;
    }
  >(a: A) {
    const { spec: previousSpec, ...rest } = a;
@@ -127,14 +139,12 @@ export class Value<A extends ValueSpec> extends IBuilder<A> {
    });
  }
  static union<
-    A extends Description &
-    Default<string> & {
+    A extends  {
      name: string;
      description: string | null;
      warning: string | null;
      variants: Variants<{ [key: string]: { name: string, spec: InputSpec } }>;
-      displayAs: string | null;
-      uniqueBy: UniqueBy;
+      default: string;
    }
  >(a: A) {
    const { variants: previousVariants, ...rest } = a;
--- a/lib/scripts/oldSpecToBuilder.ts
+++ b/lib/scripts/oldSpecToBuilder.ts
@@ -113,6 +113,7 @@ export default async function makeFileContent(
            description: value.description || null,
            warning: value.warning || null,
            default: value.default || null,
+            nullable: false,
            values,
          },
          null,
@@ -129,35 +130,21 @@ export default async function makeFileContent(
        description: ${JSON.stringify(value.description || null)},
        warning: ${JSON.stringify(value.warning || null)},
        default: ${JSON.stringify(value.default || null)},
-        displayAs: ${JSON.stringify(value["display-as"] || null)},
-        uniqueBy: ${JSON.stringify(value["unique-by"] || null)},
        spec: ${specName},
-        valueNames: ${JSON.stringify(value["value-names"] || {})},
      })`;
      }
      case "union": {
        const variants = newConst(
          value.name + "_variants",
-          convertVariants(value.variants)
+          convertVariants(value.variants, value["variant-names"] || {})
        );
+
        return `Value.union({
        name: ${JSON.stringify(value.name || null)},
        description: ${JSON.stringify(value.description || null)},
        warning: ${JSON.stringify(value.warning || null)},
        default: ${JSON.stringify(value.default || null)},
        variants: ${variants},
-        tag: ${JSON.stringify({
-          id: value?.tag?.id || null,
-          name: value?.tag?.name || null,
-          description: value?.tag?.description || null,
-          warning: value?.tag?.warning || null,
-          variantNames: value?.tag?.["variant-names"] || {},
-        })},
-        displayAs: ${JSON.stringify(value["display-as"] || null)},
-        uniqueBy: ${JSON.stringify(value["unique-by"] || null)},
-        variantNames: ${JSON.stringify(
-          (value["variant-names"] as any) || null
-        )},
      })`;
      }
      case "list": {
@@ -259,14 +246,13 @@ export default async function makeFileContent(
      case "union": {
        const variants = newConst(
          value.name + "_variants",
-          convertInputSpec(value.spec.variants)
+          convertVariants(value.spec.variants, value.spec['variant-names'] || {})
        );
        return `List.union(
        {
            name:${JSON.stringify(value.name || null)},
            range:${JSON.stringify(value.range || null)},
            spec: {
-                
                variants: ${variants},
                displayAs: ${JSON.stringify(
          value?.spec?.["display-as"] || null
@@ -286,11 +272,11 @@ export default async function makeFileContent(
    throw new Error(`Unknown subtype "${value.subtype}"`);
  }

-  function convertVariants(variants: any) {
+  function convertVariants(variants: Record<string, unknown>, variantNames: Record<string, string>): string {
    let answer = "Variants.of({";
    for (const [key, value] of Object.entries(variants)) {
-      const variableName = newConst(key, convertInputSpec(value));
-      answer += `"${key}": ${variableName},`;
+      const variantSpec = newConst(key, convertInputSpec(value));
+      answer += `"${key}": {name: ${variantNames[key] || key}, spec: ${variantSpec}},`;
    }
    return `${answer}})`;
  }
--- a/lib/types/config-types.ts
+++ b/lib/types/config-types.ts
@@ -48,7 +48,8 @@ export interface ValueSpecNumber extends ListValueSpecNumber, WithStandalone {

 export interface ValueSpecSelect extends SelectBase, WithStandalone {
  type: "select";
-  default: string;
+  nullable: boolean
+  default: null | string;

 }

@@ -61,13 +62,13 @@ export interface ValueSpecMultiselect extends SelectBase, WithStandalone {

 export interface ValueSpecBoolean extends WithStandalone {
  type: "boolean";
-  default: boolean;
+  default: null | boolean;
 }

 export interface ValueSpecUnion extends WithStandalone {
  type: "union";
  variants: { [key: string]: { name: string, spec: InputSpec } };
-  default: string;
+  default: null | string;
 }

 export interface ValueSpecFile extends WithStandalone {
@@ -170,7 +171,7 @@ export interface ListValueSpecUnion {
  displayAs: null | string;
  uniqueBy: UniqueBy;
  /** this should be the variantName which one prefers a user to start with by default when creating a new union instance in a list*/
-  default: string;
+  default: null | string;
 }

 export type DefaultString = string | { charset: string; len: number };
--- a/lib/util/artifacts/output.ts
+++ b/lib/util/artifacts/output.ts
@@ -1,5 +1,5 @@

-import { Config, Value, List, Variants } from '../../config/builder';
+  import {Config, Value, List, Variants} from '../../config/builder';

 export const enable = Value.boolean({
  "name": "Enable",
@@ -54,6 +54,7 @@ export const serialversion = Value.select({
  "description": "Return raw transaction or block hex with Segwit or non-SegWit serialization.",
  "warning": null,
  "default": "segwit",
+  "nullable": false,
  "values": {}
 });
 export const servertimeout = Value.number({
@@ -89,28 +90,22 @@ export const workqueue = Value.number({
  "units": "requests",
  "placeholder": null
 });
-export const advancedSpec = Config.of({ "auth": auth, "serialversion": serialversion, "servertimeout": servertimeout, "threads": threads, "workqueue": workqueue, });;
+export const advancedSpec = Config.of({"auth": auth,"serialversion": serialversion,"servertimeout": servertimeout,"threads": threads,"workqueue": workqueue,});;
 export const advanced = Value.object({
-  name: "Advanced",
-  description: "Advanced RPC Settings",
-  warning: null,
-  default: null,
-  displayAs: null,
-  uniqueBy: null,
-  spec: advancedSpec,
-  valueNames: {},
-});
-export const rpcSettingsSpec = Config.of({ "enable": enable, "username": username, "password": password, "advanced": advanced, });;
+        name: "Advanced",
+        description: "Advanced RPC Settings",
+        warning: null,
+        default: null,
+        spec: advancedSpec,
+      });
+export const rpcSettingsSpec = Config.of({"enable": enable,"username": username,"password": password,"advanced": advanced,});;
 export const rpc = Value.object({
-  name: "RPC Settings",
-  description: "RPC configuration options.",
-  warning: null,
-  default: null,
-  displayAs: null,
-  uniqueBy: null,
-  spec: rpcSettingsSpec,
-  valueNames: {},
-});
+        name: "RPC Settings",
+        description: "RPC configuration options.",
+        warning: null,
+        default: null,
+        spec: rpcSettingsSpec,
+      });
 export const zmqEnabled = Value.boolean({
  "name": "ZeroMQ Enabled",
  "default": true,
@@ -146,17 +141,14 @@ export const discardfee = Value.number({
  "units": "BTC/kB",
  "placeholder": null
 });
-export const walletSpec = Config.of({ "enable": enable1, "avoidpartialspends": avoidpartialspends, "discardfee": discardfee, });;
+export const walletSpec = Config.of({"enable": enable1,"avoidpartialspends": avoidpartialspends,"discardfee": discardfee,});;
 export const wallet = Value.object({
-  name: "Wallet",
-  description: "Wallet Settings",
-  warning: null,
-  default: null,
-  displayAs: null,
-  uniqueBy: null,
-  spec: walletSpec,
-  valueNames: {},
-});
+        name: "Wallet",
+        description: "Wallet Settings",
+        warning: null,
+        default: null,
+        spec: walletSpec,
+      });
 export const mempoolfullrbf = Value.boolean({
  "name": "Enable Full RBF",
  "default": false,
@@ -191,17 +183,14 @@ export const mempoolexpiry = Value.number({
  "units": "Hr",
  "placeholder": null
 });
-export const mempoolSpec = Config.of({ "mempoolfullrbf": mempoolfullrbf, "persistmempool": persistmempool, "maxmempool": maxmempool, "mempoolexpiry": mempoolexpiry, });;
+export const mempoolSpec = Config.of({"mempoolfullrbf": mempoolfullrbf,"persistmempool": persistmempool,"maxmempool": maxmempool,"mempoolexpiry": mempoolexpiry,});;
 export const mempool = Value.object({
-  name: "Mempool",
-  description: "Mempool Settings",
-  warning: null,
-  default: null,
-  displayAs: null,
-  uniqueBy: null,
-  spec: mempoolSpec,
-  valueNames: {},
-});
+        name: "Mempool",
+        description: "Mempool Settings",
+        warning: null,
+        default: null,
+        spec: mempoolSpec,
+      });
 export const listen = Value.boolean({
  "name": "Make Public",
  "default": true,
@@ -243,31 +232,28 @@ export const port = Value.number({
  "units": null,
  "placeholder": null
 });
-export const addNodesSpec = Config.of({ "hostname": hostname, "port": port, });;
+export const addNodesSpec = Config.of({"hostname": hostname,"port": port,});;
 export const addNodesList = List.obj({
-  name: "Add Nodes",
-  range: "[0,*)",
-  spec: {
-    spec: addNodesSpec,
-    displayAs: null,
-    uniqueBy: null,
-  },
-  default: [],
-  description: "Add addresses of nodes to connect to.",
-  warning: null,
-});
+        name: "Add Nodes",
+        range: "[0,*)",
+        spec: {
+            spec: addNodesSpec,
+            displayAs: null,
+            uniqueBy: null,
+        },
+        default: [],
+        description: "Add addresses of nodes to connect to.",
+        warning: null,
+      });
 export const addnode = Value.list(addNodesList);
-export const peersSpec = Config.of({ "listen": listen, "onlyconnect": onlyconnect, "onlyonion": onlyonion, "addnode": addnode, });;
+export const peersSpec = Config.of({"listen": listen,"onlyconnect": onlyconnect,"onlyonion": onlyonion,"addnode": addnode,});;
 export const peers = Value.object({
-  name: "Peers",
-  description: "Peer Connection Settings",
-  warning: null,
-  default: null,
-  displayAs: null,
-  uniqueBy: null,
-  spec: peersSpec,
-  valueNames: {},
-});
+        name: "Peers",
+        description: "Peer Connection Settings",
+        warning: null,
+        default: null,
+        spec: peersSpec,
+      });
 export const dbcache = Value.number({
  "name": "Database Cache",
  "default": null,
@@ -291,7 +277,7 @@ export const size = Value.number({
  "units": "MiB",
  "placeholder": null
 });
-export const automatic = Config.of({ "size": size, });;
+export const automatic = Config.of({"size": size,});;
 export const size1 = Value.number({
  "name": "Failsafe Chain Size",
  "default": 65536,
@@ -303,19 +289,15 @@ export const size1 = Value.number({
  "units": "MiB",
  "placeholder": null
 });
-export const manual = Config.of({ "size": size1, });;
-export const pruningSettingsVariants = Variants.of({ "disabled": disabled, "automatic": automatic, "manual": manual, });
+export const manual = Config.of({"size": size1,});;
+export const pruningSettingsVariants = Variants.of({"disabled": {name: disabled, spec: disabled},"automatic": {name: automatic, spec: automatic},"manual": {name: manual, spec: manual},});
 export const pruning = Value.union({
-  name: "Pruning Settings",
-  description: "Blockchain Pruning Options\nReduce the blockchain size on disk\n",
-  warning: "If you set pruning to Manual and your disk is smaller than the total size of the blockchain, you MUST have something running that prunes these blocks or you may overfill your disk!\nDisabling pruning will convert your node into a full archival node. This requires a resync of the entire blockchain, a process that may take several days. Make sure you have enough free disk space or you may fill up your disk.\n",
-  default: "disabled",
-  variants: pruningSettingsVariants,
-  tag: { "id": "mode", "name": "Pruning Mode", "description": "- Disabled: Disable pruning\n- Automatic: Limit blockchain size on disk to a certain number of megabytes\n- Manual: Prune blockchain with the \"pruneblockchain\" RPC\n", "warning": null, "variantNames": { "disabled": "Disabled", "automatic": "Automatic", "manual": "Manual" } },
-  displayAs: null,
-  uniqueBy: null,
-  variantNames: null,
-});
+        name: "Pruning Settings",
+        description: "Blockchain Pruning Options\nReduce the blockchain size on disk\n",
+        warning: "If you set pruning to Manual and your disk is smaller than the total size of the blockchain, you MUST have something running that prunes these blocks or you may overfill your disk!\nDisabling pruning will convert your node into a full archival node. This requires a resync of the entire blockchain, a process that may take several days. Make sure you have enough free disk space or you may fill up your disk.\n",
+        default: "disabled",
+        variants: pruningSettingsVariants,
+      });
 export const blockfilterindex = Value.boolean({
  "name": "Compute Compact Block Filters (BIP158)",
  "default": true,
@@ -328,45 +310,36 @@ export const peerblockfilters = Value.boolean({
  "description": "Serve Compact Block Filters as a peer service to other nodes on the network. This is useful if you wish to connect an SPV client to your node to make it efficient to scan transactions without having to download all block data.  'Compute Compact Block Filters (BIP158)' is required.",
  "warning": null
 });
-export const blockFiltersSpec = Config.of({ "blockfilterindex": blockfilterindex, "peerblockfilters": peerblockfilters, });;
+export const blockFiltersSpec = Config.of({"blockfilterindex": blockfilterindex,"peerblockfilters": peerblockfilters,});;
 export const blockfilters = Value.object({
-  name: "Block Filters",
-  description: "Settings for storing and serving compact block filters",
-  warning: null,
-  default: null,
-  displayAs: null,
-  uniqueBy: null,
-  spec: blockFiltersSpec,
-  valueNames: {},
-});
+        name: "Block Filters",
+        description: "Settings for storing and serving compact block filters",
+        warning: null,
+        default: null,
+        spec: blockFiltersSpec,
+      });
 export const peerbloomfilters = Value.boolean({
  "name": "Serve Bloom Filters to Peers",
  "default": false,
  "description": "Peers have the option of setting filters on each connection they make after the version handshake has completed. Bloom filters are for clients implementing SPV (Simplified Payment Verification) that want to check that block headers  connect together correctly, without needing to verify the full blockchain.  The client must trust that the transactions in the chain are in fact valid.  It is highly recommended AGAINST using for anything except Bisq integration.",
  "warning": "This is ONLY for use with Bisq integration, please use Block Filters for all other applications."
 });
-export const bloomFiltersBip37Spec = Config.of({ "peerbloomfilters": peerbloomfilters, });;
+export const bloomFiltersBip37Spec = Config.of({"peerbloomfilters": peerbloomfilters,});;
 export const bloomfilters = Value.object({
-  name: "Bloom Filters (BIP37)",
-  description: "Setting for serving Bloom Filters",
-  warning: null,
-  default: null,
-  displayAs: null,
-  uniqueBy: null,
-  spec: bloomFiltersBip37Spec,
-  valueNames: {},
-});
-export const advancedSpec1 = Config.of({ "mempool": mempool, "peers": peers, "dbcache": dbcache, "pruning": pruning, "blockfilters": blockfilters, "bloomfilters": bloomfilters, });;
+        name: "Bloom Filters (BIP37)",
+        description: "Setting for serving Bloom Filters",
+        warning: null,
+        default: null,
+        spec: bloomFiltersBip37Spec,
+      });
+export const advancedSpec1 = Config.of({"mempool": mempool,"peers": peers,"dbcache": dbcache,"pruning": pruning,"blockfilters": blockfilters,"bloomfilters": bloomfilters,});;
 export const advanced1 = Value.object({
-  name: "Advanced",
-  description: "Advanced Settings",
-  warning: null,
-  default: null,
-  displayAs: null,
-  uniqueBy: null,
-  spec: advancedSpec1,
-  valueNames: {},
-});
-export const inputSpec = Config.of({ "rpc": rpc, "zmq-enabled": zmqEnabled, "txindex": txindex, "wallet": wallet, "advanced": advanced1, });;
+        name: "Advanced",
+        description: "Advanced Settings",
+        warning: null,
+        default: null,
+        spec: advancedSpec1,
+      });
+export const inputSpec = Config.of({"rpc": rpc,"zmq-enabled": zmqEnabled,"txindex": txindex,"wallet": wallet,"advanced": advanced1,});;
 export const matchInputSpec = inputSpec.validator();
 export type InputSpec = typeof matchInputSpec._TYPE;