Start9/start-sdk
2
0
Fork 0
mirror of https://github.com/Start9Labs/start-sdk.git synced 2026-03-30 12:21:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: Add the wrapperData, bound effects, and sdk

Browse Source
This commit is contained in:
BluJ
2023-04-13 14:44:17 -06:00
parent cff86718f8
commit c9a1c45930
11 changed files with 134 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
lib/health/checkFns/checkWebUrl.ts
View File

@@ -9,8 +9,8 @@ import { timeoutPromise } from "./index";
* @returns
*/
export const checkWebUrl = async (
url: string,
effects: Effects,
url: string,
{
timeout = 1000,
successMessage = `Reached ${url}`,

1
lib/mainFn/Daemons.ts
View File

@@ -74,7 +74,6 @@ export class Daemons<Ids extends string | never> {
const daemonsStarted = {} as Record<Ids, Promise<DaemonReturned>>;
const { effects } = this;
const daemons = this.daemons ?? [];
const _config = await effects.getServiceConfig();
for (const daemon of daemons) {
const requiredPromise = Promise.all(
daemon.requires?.map((id) => daemonsStarted[id]) ?? []

2
lib/mainFn/LocalPort.ts
View File

@@ -2,7 +2,7 @@ import { Effects } from "../types";
import { LocalBinding } from "./LocalBinding";
export class LocalPort {
constructor(readonly id: string, readonly effects: Effects) {}
constructor(readonly effects: Effects, readonly id: string) {}
async bindLan(internalPort: number) {
const [localAddress, ipAddress] = await this.effects.bindLan({
internalPort,

4
lib/mainFn/NetworkBuilder.ts
View File

@@ -9,9 +9,9 @@ export class NetworkBuilder {
private constructor(private effects: Effects) {}
getTorHostName(id: string) {
return new TorHostname(id, this.effects);
return new TorHostname(this.effects, id);
}
getPort(id: string) {
return new LocalPort(id, this.effects);
return new LocalPort(this.effects, id);
}
}

5
lib/mainFn/TorHostname.ts
View File

@@ -2,7 +2,10 @@ import { Effects } from "../types";
import { TorBinding } from "./TorBinding";
export class TorHostname {
constructor(readonly id: string, readonly effects: Effects) {}
constructor(readonly effects: Effects, readonly id: string) {}
static of(effects: Effects, id: string) {
return new TorHostname(effects, id);
}
async bindTor(internalPort: number, externalPort: number) {
const address = await this.effects.bindTor({
internalPort,

42
lib/test/makeOutput.ts
View File

@@ -19,7 +19,8 @@ writeConvertedFile(
tag: {
id: "type",
name: "Type",
description: "- LND: Lightning Network Daemon from Lightning Labs\n- CLN: Core Lightning from Blockstream\n",
description:
"- LND: Lightning Network Daemon from Lightning Labs\n- CLN: Core Lightning from Blockstream\n",
"variant-names": {
lnd: "Lightning Network Daemon (LND)",
"c-lightning": "Core Lightning (CLN)",
@@ -58,7 +59,8 @@ writeConvertedFile(
default: "bitcoin",
masked: true,
pattern: "^[a-zA-Z0-9_]+$",
"pattern-description": "Must be alphanumeric (can contain underscore).",
"pattern-description":
"Must be alphanumeric (can contain underscore).",
},
password: {
type: "string",
@@ -70,7 +72,8 @@ writeConvertedFile(
len: 20,
},
pattern: '^[^\\n"]*$',
"pattern-description": "Must not contain newline or quote characters.",
"pattern-description":
"Must not contain newline or quote characters.",
copyable: true,
masked: true,
},
@@ -82,7 +85,8 @@ writeConvertedFile(
default: "bitcoin",
masked: true,
pattern: "^[a-zA-Z0-9_]+$",
"pattern-description": "Must be alphanumeric (can contain underscore).",
"pattern-description":
"Must be alphanumeric (can contain underscore).",
textarea: true,
},
advanced: {
@@ -98,15 +102,18 @@ writeConvertedFile(
subtype: "string",
default: [],
spec: {
pattern: "^[a-zA-Z0-9_-]+:([0-9a-fA-F]{2})+\\$([0-9a-fA-F]{2})+$",
"pattern-description": 'Each item must be of the form "<USERNAME>:<SALT>$<HASH>".',
pattern:
"^[a-zA-Z0-9_-]+:([0-9a-fA-F]{2})+\\$([0-9a-fA-F]{2})+$",
"pattern-description":
'Each item must be of the form "<USERNAME>:<SALT>$<HASH>".',
masked: false,
},
range: "[0,*)",
},
serialversion: {
name: "Serialization Version",
description: "Return raw transaction or block hex with Segwit or non-SegWit serialization.",
description:
"Return raw transaction or block hex with Segwit or non-SegWit serialization.",
type: "enum",
values: ["non-segwit", "segwit"],
"value-names": {},
@@ -114,7 +121,8 @@ writeConvertedFile(
},
servertimeout: {
name: "Rpc Server Timeout",
description: "Number of seconds after which an uncompleted RPC call will time out.",
description:
"Number of seconds after which an uncompleted RPC call will time out.",
type: "number",
nullable: false,
range: "[5,300]",
@@ -217,7 +225,8 @@ writeConvertedFile(
type: "number",
nullable: false,
name: "Max Mempool Size",
description: "Keep the transaction memory pool below <n> megabytes.",
description:
"Keep the transaction memory pool below <n> megabytes.",
range: "[1,*)",
integral: true,
units: "MiB",
@@ -227,7 +236,8 @@ writeConvertedFile(
type: "number",
nullable: false,
name: "Mempool Expiration",
description: "Do not keep transactions in the mempool longer than <n> hours.",
description:
"Do not keep transactions in the mempool longer than <n> hours.",
range: "[1,*)",
integral: true,
units: "Hr",
@@ -243,7 +253,8 @@ writeConvertedFile(
listen: {
type: "boolean",
name: "Make Public",
description: "Allow other nodes to find your server on the network.",
description:
"Allow other nodes to find your server on the network.",
default: true,
},
onlyconnect: {
@@ -283,7 +294,8 @@ writeConvertedFile(
type: "number",
nullable: true,
name: "Port",
description: "Port that peer is listening on for inbound p2p connections",
description:
"Port that peer is listening on for inbound p2p connections",
range: "[0,65535]",
integral: true,
},
@@ -307,7 +319,8 @@ writeConvertedFile(
pruning: {
type: "union",
name: "Pruning Settings",
description: "Blockchain Pruning Options\nReduce the blockchain size on disk\n",
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",
tag: {
@@ -329,7 +342,8 @@ writeConvertedFile(
nullable: false,
name: "Max Chain Size",
description: "Limit of blockchain size on disk.",
warning: "Increasing this value will require re-syncing your node.",
warning:
"Increasing this value will require re-syncing your node.",
default: 550,
range: "[550,1000000)",
integral: true,

17
lib/types.ts
View File

@@ -231,12 +231,22 @@ export type Effects = {
progress: () => Promise<number>;
};
getServiceConfig(options?: {
/** Get a value in a json like data, can be observed and subscribed */
getWrapperData(options?: {
/** If there is no packageId it is assumed the current package */
packageId?: string;
/** The path defaults to root level, using the [JsonPath](https://jsonpath.com/) */
path?: string;
callback?: (config: unknown, previousConfig: unknown) => void;
callback: (config: unknown, previousConfig: unknown) => void;
}): Promise<unknown>;
/** Used to store values that can be accessed and subscribed to */
setWrapperData(options?: {
/** Sets the value for the wrapper at the path, it will override, using the [JsonPath](https://jsonpath.com/) */
path?: string;
value: unknown;
}): Promise<void>;
getLocalHostname(): Promise<string>;
getIPHostname(): Promise<string>;
/** Get the address for another service for tor interfaces */
@@ -334,6 +344,9 @@ export type Effects = {
status: HealthStatus;
message?: string;
}): Promise<void>;
restart(): void;
shutdown(): void;
};
/* rsync options: https://linux.die.net/man/1/rsync

45
lib/util/getWrapperData.ts Normal file
View File

@@ -0,0 +1,45 @@
import { Parser } from "ts-matches";
import { Effects } from "../types";
export function getWrapperData<A>(
effects: Effects,
validator: Parser<unknown, A>,
options: {
/** Defaults to what ever the package currently in */
packageId?: string | undefined;
/** JsonPath */
path?: string | undefined;
} = {}
) {
return {
const: () =>
effects
.getWrapperData({
...options,
callback: effects.restart,
})
.then(validator.unsafeCast),
first: () =>
effects
.getWrapperData({
...options,
callback: () => {},
})
.then(validator.unsafeCast),
overTime: async function* <A>() {
while (true) {
let callback: () => void;
const waitForNext = new Promise<void>((resolve) => {
callback = resolve;
});
yield await effects
.getWrapperData({
...options,
callback: () => callback(),
})
.then(validator.unsafeCast);
await waitForNext;
}
},
};
}

35
lib/util/index.ts
View File

@@ -1,8 +1,15 @@
import { Parser, string } from "ts-matches";
import * as T from "../types";
import FileHelper from "./fileHelper";
import nullIfEmpty from "./nullIfEmpty";
import { getWrapperData } from "./getWrapperData";
import { checkPortListening, checkWebUrl } from "../health/checkFns";
import { LocalPort, NetworkBuilder, TorHostname } from "../mainFn";
export { guardAll, typeFromProps } from "./propertiesMatcher";
export { default as nullIfEmpty } from "./nullIfEmpty";
export { FileHelper } from "./fileHelper";
export { getWrapperData } from "./getWrapperData";
/** Used to check if the file exists before hand */
export const exists = (
@@ -16,3 +23,31 @@ export const exists = (
export const isKnownError = (e: unknown): e is T.KnownError =>
e instanceof Object && ("error" in e || "error-code" in e);
type Cdr<A> = A extends [unknown, ...infer Cdr] ? Cdr : [];
export const utils = (effects: T.Effects) => ({
readFile: <A>(fileHelper: FileHelper<A>) => fileHelper.read(effects),
writeFile: <A>(fileHelper: FileHelper<A>, data: A) =>
fileHelper.write(data, effects),
exists: (props: { path: string; volumeId: string }) => exists(effects, props),
nullIfEmpty,
getWrapperData: <A>(
validator: Parser<unknown, A>,
options: {
/** Defaults to what ever the package currently in */
packageId?: string | undefined;
/** JsonPath */
path?: string | undefined;
} = {}
) => getWrapperData(effects, validator, options),
setWrapperData: <A>(
value: A,
options: { packageId?: string | undefined; path?: string | undefined } = {}
) => effects.setWrapperData({ ...options, value }),
checkPortListening: checkPortListening.bind(null, effects),
checkWebUrl: checkWebUrl.bind(null, effects),
localPort: LocalPort.bind(null, effects),
networkBuilder: NetworkBuilder.of.bind(null, effects),
torHostName: TorHostname.of.bind(null, effects),
});