Start9/start-os
2
0
Fork 0
mirror of https://github.com/Start9Labs/start-os.git synced 2026-03-31 04:23:40 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
8d01ebe8b2fd9d5f84723b10458eeabbddfa8d3a
start-os/ui/src/app/services/api/mock-app-fixures.ts
Aaron Greenspan 8d01ebe8b2 0.3.0 refactor 
ui: adds overlay layer to patch-db-client

ui: getting towards mocks

ui: cleans up factory init

ui: nice type hack

ui: live api for patch

ui: api service source + http

starts up

ui: api source + http

ui: rework patchdb config, pass stashTimeout into patchDbModel

wires in temp patching into api service

ui: example of wiring patchdbmodel into page

begin integration

remove unnecessary method

linting

first data rendering

rework app initialization

http source working for ssh delete call

temp patches working

entire Embassy tab complete

not in kansas anymore

ripping, saving progress

progress for API request response types and endoint defs

Update data-model.ts

shambles, but in a good way

progress

big progress

progress

installed list working

big progress

progress

progress

begin marketplace redesign

Update api-types.ts

Update api-types.ts

marketplace improvements

cosmetic

dependencies and recommendations

begin nym auth approach

install wizard

restore flow and donations
2021-08-09 13:50:02 -06:00

1405 lines
40 KiB
TypeScript
Raw Blame History

import { DependencyErrorType, DockerIoFormat, Manifest, PackageDataEntry, PackageMainStatus, PackageState, ServerStatus } from 'src/app/models/patch-db/data-model'
import { NotificationLevel, RR, ServerNotification, ServerNotifications } from './api-types'
import markdown from 'raw-loader!./md-sample.md'
export module Mock {
export const MarketplaceEos: RR.GetMarketplaceEOSRes = {
version: '1.0.0',
headline: 'Our biggest release ever.',
notes: markdown,
}
export const AvailableList: RR.GetAvailableListRes = [
{
id: 'bitcoind',
title: 'Bitcoin Core',
version: '0.21.1',
descriptionShort: 'A Bitcoin full node by Bitcoin Core.',
icon: 'assets/img/service-icons/bitcoind.png',
},
{
id: 'lnd',
title: 'Lightning Network Daemon',
version: '0.11.1',
descriptionShort: 'A BOLT-compliant, lightning network node.',
icon: 'assets/img/service-icons/lnd.png',
},
{
id: 'bitcoin-proxy',
title: 'Bitcoin Proxy',
version: '0.2.2',
descriptionShort: 'A super charger for your Bitcoin node.',
icon: 'assets/img/service-icons/bitcoin-proxy.png',
},
]
export const MockManifestBitcoind: Manifest = {
id: 'bitcoind',
title: 'Bitcoin Core',
version: '0.21.0',
description: {
short: 'A Bitcoin full node by Bitcoin Core.',
long: 'Bitcoin is a decentralized consensus protocol and settlement network.',
},
'release-notes': 'Taproot, Schnorr, and more.',
license: 'MIT',
'wrapper-repo': 'https://github.com/start9labs/bitcoind-wrapper',
'upstream-repo': 'https://github.com/bitcoin/bitcoin',
'support-site': 'https://bitcoin.org',
'marketing-site': 'https://bitcoin.org',
'donation-url': 'https://start9.com',
alerts: {
install: 'Bitcoin can take over a week to sync.',
uninstall: 'Chain state will be lost, as will any funds stored on your Bitcoin Core waller that have not been backed up.',
restore: null,
start: null,
stop: 'Stopping Bitcoin is bad for your health.',
},
main: {
type: 'docker',
image: '',
system: true,
entrypoint: '',
args: [''],
mounts: { },
'io-format': DockerIoFormat.Yaml,
inject: false,
'shm-size': '',
},
'health-check': {
type: 'docker',
image: '',
system: true,
entrypoint: '',
args: [''],
mounts: { },
'io-format': DockerIoFormat.Yaml,
inject: false,
'shm-size': '',
},
config: null,
volumes: { },
'min-os-version': '0.2.12',
interfaces: {
ui: {
name: 'Node Visualizer',
description: 'Web application for viewing information about your node and the Bitcoin network.',
ui: true,
'tor-config': {
'hidden-service-version': 'v3',
'port-mapping': { },
},
'lan-config': { },
protocols: [],
},
rpc: {
name: 'RPC',
description: 'Used by wallets to interact with your Bitcoin Core node.',
ui: false,
'tor-config': {
'hidden-service-version': 'v3',
'port-mapping': { },
},
'lan-config': { },
protocols: [],
},
p2p: {
name: 'P2P',
description: 'Used by other Bitcoin nodes to communicate and interact with your node.',
ui: false,
'tor-config': {
'hidden-service-version': 'v3',
'port-mapping': { },
},
'lan-config': { },
protocols: [],
},
},
backup: {
create: {
type: 'docker',
image: '',
system: true,
entrypoint: '',
args: [''],
mounts: { },
'io-format': DockerIoFormat.Yaml,
inject: false,
'shm-size': '',
},
restore: {
type: 'docker',
image: '',
system: true,
entrypoint: '',
args: [''],
mounts: { },
'io-format': DockerIoFormat.Yaml,
inject: false,
'shm-size': '',
},
},
migrations: null,
actions: {
resync: {
name: 'Resync Blockchain',
description: 'Use this to resync the Bitcoin blockchain from genesis',
warning: 'This will take a couple of days.',
'allowed-statuses': [PackageMainStatus.Running, PackageMainStatus.Stopped],
implementation: {
type: 'docker',
image: '',
system: true,
entrypoint: '',
args: [''],
mounts: { },
'io-format': DockerIoFormat.Yaml,
inject: false,
'shm-size': '',
},
'input-spec': null,
},
},
permissions: { },
dependencies: { },
}
export const MockManifestLnd: Manifest = {
id: 'lnd',
title: 'Lightning Network Daemon',
version: '0.11.1',
description: {
short: 'A bolt spec compliant client.',
long: 'More info about LND. More info about LND. More info about LND.',
},
'release-notes': 'Dual funded channels!',
license: 'MIT',
'wrapper-repo': 'https://github.com/start9labs/lnd-wrapper',
'upstream-repo': 'https://github.com/lightningnetwork/lnd',
'support-site': 'https://lightning.engineering/',
'marketing-site': 'https://lightning.engineering/',
'donation-url': 'https://start9.com',
alerts: {
install: null,
uninstall: null,
restore: 'If this is a duplicate instance of the same LND node, you may loose your funds.',
start: 'Starting LND is good for your health.',
stop: null,
},
main: {
type: 'docker',
image: '',
system: true,
entrypoint: '',
args: [''],
mounts: { },
'io-format': DockerIoFormat.Yaml,
inject: false,
'shm-size': '',
},
'health-check': {
type: 'docker',
image: '',
system: true,
entrypoint: '',
args: [''],
mounts: { },
'io-format': DockerIoFormat.Yaml,
inject: false,
'shm-size': '',
},
config: null,
volumes: { },
'min-os-version': '0.2.12',
interfaces: {
rpc: {
name: 'RPC interface',
description: 'Good for connecting to your node at a distance.',
ui: true,
'tor-config': {
'hidden-service-version': 'v3',
'port-mapping': { },
},
'lan-config': {
44: {
ssl: true,
mapping: 33,
},
},
protocols: [],
},
grpc: {
name: 'GRPC',
description: 'Certain wallet use grpc.',
ui: false,
'tor-config': {
'hidden-service-version': 'v3',
'port-mapping': { },
},
'lan-config': {
66: {
ssl: true,
mapping: 55,
},
},
protocols: [],
},
},
backup: {
create: {
type: 'docker',
image: '',
system: true,
entrypoint: '',
args: [''],
mounts: { },
'io-format': DockerIoFormat.Yaml,
inject: false,
'shm-size': '',
},
restore: {
type: 'docker',
image: '',
system: true,
entrypoint: '',
args: [''],
mounts: { },
'io-format': DockerIoFormat.Yaml,
inject: false,
'shm-size': '',
},
},
migrations: null,
actions: {
resync: {
name: 'Resync Network Graph',
description: 'Your node will resync its network graph.',
warning: 'This will take a couple hours.',
'allowed-statuses': [PackageMainStatus.Running],
implementation: {
type: 'docker',
image: '',
system: true,
entrypoint: '',
args: [''],
mounts: { },
'io-format': DockerIoFormat.Yaml,
inject: false,
'shm-size': '',
},
'input-spec': {
label: {
type: 'string',
name: 'Name of Resync',
nullable: false,
masked: false,
copyable: false,
},
},
},
},
permissions: { },
dependencies: {
'bitcoind': {
version: '=0.21.0',
description: 'LND needs bitcoin to live.',
optional: null,
recommended: true,
config: [],
interfaces: [],
},
'bitcoin-proxy': {
version: '>=0.2.2',
description: 'As long as Bitcoin is pruned, LND needs Bitcoin Proxy to fetch block over the P2P network.',
optional: null,
recommended: true,
config: [],
interfaces: [],
},
},
}
export const MockManifestBitcoinProxy: Manifest = {
id: 'bitcoin-proxy',
title: 'Bitcoin Proxy',
version: '0.2.2',
description: {
short: 'A super charger for your Bitcoin node.',
long: 'More info about Bitcoin Proxy. More info about Bitcoin Proxy. More info about Bitcoin Proxy.',
},
'release-notes': 'Even better support for Bitcoin and wallets!',
license: 'MIT',
'wrapper-repo': 'https://github.com/start9labs/btc-rpc-proxy-wrapper',
'upstream-repo': 'https://github.com/Kixunil/btc-rpc-proxy',
'support-site': '',
'marketing-site': '',
'donation-url': 'https://start9.com',
alerts: {
install: null,
uninstall: null,
restore: null,
start: null,
stop: null,
},
main: {
type: 'docker',
image: '',
system: true,
entrypoint: '',
args: [''],
mounts: { },
'io-format': DockerIoFormat.Yaml,
inject: false,
'shm-size': '',
},
'health-check': {
type: 'docker',
image: '',
system: true,
entrypoint: '',
args: [''],
mounts: { },
'io-format': DockerIoFormat.Yaml,
inject: false,
'shm-size': '',
},
config: null,
volumes: { },
'min-os-version': '0.2.12',
interfaces: {
rpc: {
name: 'RPC interface',
description: 'Good for connecting to your node at a distance.',
ui: true,
'tor-config': {
'hidden-service-version': 'v3',
'port-mapping': { },
},
'lan-config': {
44: {
ssl: true,
mapping: 33,
},
},
protocols: [],
},
},
backup: {
create: {
type: 'docker',
image: '',
system: true,
entrypoint: '',
args: [''],
mounts: { },
'io-format': DockerIoFormat.Yaml,
inject: false,
'shm-size': '',
},
restore: {
type: 'docker',
image: '',
system: true,
entrypoint: '',
args: [''],
mounts: { },
'io-format': DockerIoFormat.Yaml,
inject: false,
'shm-size': '',
},
},
migrations: null,
actions: { },
permissions: { },
dependencies: {
'bitcoind': {
version: '>=0.20.0',
description: 'Bitcoin Proxy requires a Bitcoin node.',
optional: null,
recommended: true,
config: [],
interfaces: [],
},
},
}
export const AvailableShow: {
[id: string]: {
[version: string]: RR.GetAvailableShowRes
}
} = {
'bitcoind': {
'0.19.0': {
icon: 'assets/img/service-icons/bitcoind.png',
manifest: {
...Mock.MockManifestBitcoind,
version: '0.19.0',
'release-notes': 'release notes for Bitcoin 0.19.0',
},
categories: ['bitcoin', 'cryptocurrency'],
versions: ['0.19.0', '0.20.0', '0.21.0'],
'dependency-metadata': { },
},
'0.20.0': {
icon: 'assets/img/service-icons/bitcoind.png',
manifest: {
...Mock.MockManifestBitcoind,
version: '0.20.0',
'release-notes': 'release notes for Bitcoin 0.20.0',
},
categories: ['bitcoin', 'cryptocurrency'],
versions: ['0.19.0', '0.20.0', '0.21.0'],
'dependency-metadata': { },
},
'0.21.0': {
icon: 'assets/img/service-icons/bitcoind.png',
manifest: {
...Mock.MockManifestBitcoind,
version: '0.21.0',
'release-notes': 'release notes for Bitcoin 0.20.0',
},
categories: ['bitcoin', 'cryptocurrency'],
versions: ['0.19.0', '0.20.0', '0.21.0'],
'dependency-metadata': { },
},
'latest': {
icon: 'assets/img/service-icons/bitcoind.png',
manifest: Mock.MockManifestBitcoind,
categories: ['bitcoin', 'cryptocurrency'],
versions: ['0.19.0', '0.20.0', '0.21.0'],
'dependency-metadata': { },
},
},
'lnd': {
'0.11.0': {
icon: 'assets/img/service-icons/lnd.png',
manifest: {
...Mock.MockManifestLnd,
version: '0.11.0',
'release-notes': 'release notes for LND 0.11.0',
},
categories: ['bitcoin', 'lightning', 'cryptocurrency'],
versions: ['0.11.0', '0.11.1'],
'dependency-metadata': {
'bitcoind': {
title: 'Bitcoin Core',
icon: 'assets/img/service-icons/bitcoind.png',
},
'bitcoin-proxy': {
title: 'Bitcoin Proxy',
icon: 'assets/img/service-icons/bitcoin-proxy.png',
},
},
},
'0.11.1': {
icon: 'assets/img/service-icons/lnd.png',
manifest: {
...Mock.MockManifestLnd,
version: '0.11.1',
'release-notes': 'release notes for LND 0.11.0',
},
categories: ['bitcoin', 'lightning', 'cryptocurrency'],
versions: ['0.11.0', '0.11.1'],
'dependency-metadata': {
'bitcoind': {
title: 'Bitcoin Core',
icon: 'assets/img/service-icons/bitcoind.png',
},
'bitcoin-proxy': {
title: 'Bitcoin Proxy',
icon: 'assets/img/service-icons/bitcoin-proxy.png',
},
},
},
'latest': {
icon: 'assets/img/service-icons/lnd.png',
manifest: Mock.MockManifestLnd,
categories: ['bitcoin', 'lightning', 'cryptocurrency'],
versions: ['0.11.0', '0.11.1'],
'dependency-metadata': {
'bitcoind': {
title: 'Bitcoin Core',
icon: 'assets/img/service-icons/bitcoind.png',
},
'bitcoin-proxy': {
title: 'Bitcoin Proxy',
icon: 'assets/img/service-icons/bitcoin-proxy.png',
},
},
},
},
'bitcoin-proxy': {
'latest': {
icon: 'assets/img/service-icons/bitcoin-proxy.png',
manifest: Mock.MockManifestBitcoinProxy,
categories: ['bitcoin'],
versions: ['0.2.2'],
'dependency-metadata': {
'bitcoind': {
title: 'Bitcoin Core',
icon: 'assets/img/service-icons/bitcoind.png',
},
},
},
},
}
export const bitcoind: PackageDataEntry = {
state: PackageState.Installed,
'static-files': {
license: 'licenseURL',
icon: 'assets/img/service-icons/bitcoind.png',
instructions: markdown, // /public/package-data/bitcoind/0.21.1/INSTRUCTIONS.md
},
'temp-manifest': undefined,
installed: {
manifest: {
...MockManifestBitcoind,
version: '0.20.0',
},
status: {
configured: true,
main: {
status: PackageMainStatus.Running,
started: new Date().toISOString(),
health: { },
},
'dependency-errors': { },
},
'interface-info': {
ip: '10.0.0.1',
addresses: {
ui: {
'tor-address': 'bitcoind-ui-address.onion',
'lan-address': 'bitcoind-ui-address.local',
},
rpc: {
'tor-address': 'bitcoind-rpc-address.onion',
'lan-address': 'bitcoind-rpc-address.local',
},
p2p: {
'tor-address': 'bitcoind-p2p-address.onion',
'lan-address': 'bitcoind-p2p-address.local',
},
},
},
'system-pointers': [],
'current-dependents': {
'lnd': {
pointers: [],
'health-checks': [],
},
},
'current-dependencies': { },
},
'install-progress': undefined,
}
export const lnd: PackageDataEntry = {
state: PackageState.Installed,
'static-files': {
license: 'licenseURL',
icon: 'assets/img/service-icons/lnd.png',
instructions: markdown, // /public/package-data/bitcoind/0.21.1/INSTRUCTIONS.md
},
'temp-manifest': undefined,
installed: {
manifest: MockManifestLnd,
status: {
configured: true,
main: {
status: PackageMainStatus.Stopped,
},
'dependency-errors': {
'bitcoin-proxy': {
type: DependencyErrorType.NotInstalled,
title: Mock.MockManifestBitcoinProxy.title,
icon: 'assets/img/service-icons/bitcoin-proxy.png',
},
},
},
'interface-info': {
ip: '10.0.0.1',
addresses: {
rpc: {
'tor-address': 'lnd-rpc-address.onion',
'lan-address': 'lnd-rpc-address.local',
},
grpc: {
'tor-address': 'lnd-grpc-address.onion',
'lan-address': 'lnd-grpc-address.local',
},
},
},
'system-pointers': [],
'current-dependents': { },
'current-dependencies': {
'bitcoind': {
pointers: [],
'health-checks': [],
},
'bitcoin-proxy': {
pointers: [],
'health-checks': [],
},
},
},
'install-progress': undefined,
}
export const bitcoinproxy: PackageDataEntry = {
state: PackageState.Installed,
'static-files': {
license: 'licenseURL',
icon: 'assets/img/service-icons/bitcoin-proxy.png',
instructions: '*These are some instructions.*', // /public/package-data/bitcoinproxy/0.2.2/INSTRUCTIONS.md
},
'temp-manifest': undefined,
installed: {
manifest: MockManifestBitcoinProxy,
status: {
configured: true,
main: {
status: PackageMainStatus.Running,
started: new Date().toISOString(),
health: { },
},
'dependency-errors': { },
},
'interface-info': {
ip: '10.0.0.1',
addresses: {
rpc: {
'tor-address': 'bitcoinproxy-rpc-address.onion',
'lan-address': 'bitcoinproxy-rpc-address.local',
},
},
},
'system-pointers': [],
'current-dependents': {
'lnd': {
pointers: [],
'health-checks': [],
},
},
'current-dependencies': {
'bitcoind': {
pointers: [],
'health-checks': [],
},
},
},
'install-progress': undefined,
}
export const DbDump: RR.GetDumpRes = {
id: 1,
expireId: null,
value: {
'server-info': {
id: 'start9-abcdefgmm',
version: '1.0.0',
status: ServerStatus.Running,
'lan-address': 'start9-abcdefgh.local',
'tor-address': 'myveryownspecialtoraddress.onion',
wifi: {
ssids: ['Goosers', 'Goosers5G'],
selected: 'Goosers5G',
connected: 'Goosers5G',
},
registry: 'https://registry.start9.com',
'unread-notification-count': 4,
specs: {
CPU: 'Cortex-A72: 4 Cores @1500MHz',
Disk: '1TB SSD',
Memory: '8GB',
},
},
'package-data': {
'bitcoind': bitcoind,
'lnd': lnd,
},
ui: {
'server-name': 'My Embassy',
'welcome-ack': '1.0.0',
'auto-check-updates': true,
},
},
}
export const notification1: ServerNotification<1> = {
id: '123e4567-e89b-12d3-a456-426655440000',
'package-id': null,
'created-at': '2019-12-26T14:20:30.872Z',
code: 1,
level: NotificationLevel.Success,
title: 'Backup Complete',
message: 'Embassy and services have been successfully backed up.',
data: {
server: {
attempted: true,
error: null,
},
packages: {
'bitcoind': {
error: null,
},
},
},
}
export const Notifications: ServerNotifications = [
notification1,
{
id: '123e4567-e89b-12d3-a456-426655440001',
'package-id': 'bitcoind',
'created-at': '2019-12-26T14:20:30.872Z',
code: 2,
level: NotificationLevel.Warning,
title: 'SSH Key Added',
message: 'A new SSH key was added. If you did not do this, shit is bad.',
data: null,
},
{
id: '123e4567-e89b-12d3-a456-426655440002',
'package-id': 'bitcoind',
'created-at': '2019-12-26T14:20:30.872Z',
code: 3,
level: NotificationLevel.Info,
title: 'SSH Key Removed',
message: 'A SSH key was removed.',
data: null,
},
{
id: '123e4567-e89b-12d3-a456-426655440003',
'package-id': 'bitcoind',
'created-at': '2019-12-26T14:20:30.872Z',
code: 4,
level: NotificationLevel.Error,
title: 'Service Crashed',
message: 'Bitcoind has crashed.',
data: null,
},
]
export const ServerMetrics: RR.GetServerMetricsRes = {
'Group1': {
'Metric1': {
value: 22.2,
unit: 'mi/b',
},
'Metric2': {
value: 50,
unit: '%',
},
'Metric3': {
value: 10.1,
unit: '%',
},
},
'Group2': {
'Hmmmm1': {
value: 22.2,
unit: 'mi/b',
},
'Hmmmm2': {
value: 50,
unit: '%',
},
'Hmmmm3': {
value: 10.1,
unit: '%',
},
},
}
export const ServerLogs: RR.GetServerLogsRes = [
{
timestamp: '2019-12-26T14:20:30.872Z',
log: '****** START *****',
},
{
timestamp: '2019-12-26T14:21:30.872Z',
log: 'ServerLogs ServerLogs ServerLogs ServerLogs ServerLogs',
},
{
timestamp: '2019-12-26T14:22:30.872Z',
log: '****** FINISH *****',
},
]
export const PackageLogs: RR.GetPackageLogsRes = [
{
timestamp: '2019-12-26T14:20:30.872Z',
log: '****** START *****',
},
{
timestamp: '2019-12-26T14:21:30.872Z',
log: 'PackageLogs PackageLogs PackageLogs PackageLogs PackageLogs',
},
{
timestamp: '2019-12-26T14:22:30.872Z',
log: '****** FINISH *****',
},
]
export const SshKeys: RR.GetSSHKeysRes = {
'28:d2:7e:78:61:b4:bf:g2:de:24:15:96:4e:d4:15:53': {
alg: 'ed25519',
hostname: 'Matt Key',
hash: 'VeryLongHashOfSSHKey1',
},
'12:f8:7e:78:61:b4:bf:e2:de:24:15:96:4e:d4:72:53': {
alg: 'ed25519',
hostname: 'Aiden Key',
hash: 'VeryLongHashOfSSHKey2',
},
}
export const SshKey: RR.AddSSHKeyRes = {
'44:44:7e:78:61:b4:bf:g2:de:24:15:96:4e:d4:15:53': {
alg: 'ed25519',
hostname: 'Lucy Key',
hash: 'VeryLongHashOfSSHKey3',
},
}
export const Disks: RR.GetDisksRes = {
'/dev/sda': {
size: '32GB',
description: 'Samsung',
partitions: {
'sdba2': {
size: null,
'is-mounted': false,
label: 'Matt Stuff',
},
},
},
'/dev/sba': {
size: '64GB',
description: 'small USB stick',
partitions: {
'sdba2': {
size: '16GB',
'is-mounted': true,
label: null,
},
},
},
'/dev/sbd': {
size: '128GB',
description: 'large USB stick',
partitions: {
'sdba1': {
size: '32GB',
'is-mounted': false,
label: 'Partition 1',
},
'sdba2': {
size: null,
'is-mounted': true,
label: 'Partition 2',
},
},
},
}
export const PackageProperties: RR.GetPackagePropertiesRes<2> = {
version: 2,
data: {
'Test': {
type: 'string',
description: 'This is some information about the thing.',
copyable: true,
qr: true,
masked: false,
value: 'lndconnect://udlyfq2mxa4355pt7cqlrdipnvk2tsl4jtsdw7zaeekenufwcev2wlad.onion:10009?cert=MIICJTCCAcugAwIBAgIRAOyq85fqAiA3U3xOnwhH678wCgYIKoZIzj0EAwIwODEfMB0GAkUEChMWbG5kIGF1dG9nZW5lcmF0ZWQgY2VydDEVMBMGA1UEAxMMNTc0OTkwMzIyYzZlMB4XDTIwMTAyNjA3MzEyN1oXDTIxMTIyMTA3MzEyN1owODEfMB0GA1UEChMWbG5kIGF1dG9nZW5lcmF0ZWQgY2VydDEVMBMGA1UEAxMMNTc0OTkwMzIyYzZlMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEKqfhAMMZdY-eFnU5P4bGrQTSx0lo7m8u4V0yYkzUM6jlql_u31_mU2ovLTj56wnZApkEjoPl6fL2yasZA2wiy6OBtTCBsjAOBgNVHQ8BAf8EBAMCAqQwEwYDVR0lBAwwCgYIKwYBBQUHAwEwDwYDVR0TAQH_BAUwAwEB_zAdBgNVHQ4EFgQUYQ9uIO6spltnVCx4rLFL5BvBF9IwWwYDVR0RBFQwUoIMNTc0OTkwMzIyYzZlgglsb2NhbGhvc3SCBHVuaXiCCnVuaXhwYWNrZXSCB2J1ZmNvbm6HBH8AAAGHEAAAAAAAAAAAAAAAAAAAAAGHBKwSAAswCgYIKoZIzj0EAwIDSAAwRQIgVZH2Z2KlyAVY2Q2aIQl0nsvN-OEN49wreFwiBqlxNj4CIQD5_JbpuBFJuf81I5J0FQPtXY-4RppWOPZBb-y6-rkIUQ&macaroon=AgEDbG5kAusBAwoQuA8OUMeQ8Fr2h-f65OdXdRIBMBoWCgdhZGRyZXNzEgRyZWFkEgV3cml0ZRoTCgRpbmZvEgRyZWFkEgV3cml0ZRoXCghpbnZvaWNlcxIEcmVhZBIFd3JpdGUaFAoIbWFjYXJvb24SCGdlbmVyYXRlGhYKB21lc3NhZ2USBHJlYWQSBXdyaXRlGhcKCG9mZmNoYWluEgRyZWFkEgV3cml0ZRoWCgdvbmNoYWluEgRyZWFkEgV3cml0ZRoUCgVwZWVycxIEcmVhZBIFd3JpdGUaGAoGc2lnbmVyEghnZW5lcmF0ZRIEcmVhZAAABiCYsRUoUWuAHAiCSLbBR7b_qULDSl64R8LIU2aqNIyQfA',
},
'Nested': {
type: 'object',
description: 'This is a nested thing metric',
value: {
'Last Name': {
type: 'string',
description: 'The last name of the user',
copyable: true,
qr: true,
masked: false,
value: 'Hill',
},
'Age': {
type: 'string',
description: 'The age of the user',
copyable: false,
qr: false,
masked: false,
value: '35',
},
'Password': {
type: 'string',
description: 'A secret password',
copyable: true,
qr: false,
masked: true,
value: 'password123',
},
},
},
'Another Property': {
type: 'string',
description: 'Some more information about the service.',
copyable: false,
qr: true,
masked: false,
value: 'https://guessagain.com',
},
},
} as any // @TODO why is this necessary?
export const PackageConfig: RR.GetPackageConfigRes = {
// config spec
spec: {
'testnet': {
'name': 'Testnet',
'type': 'boolean',
'description': 'determines whether your node is running on testnet or mainnet',
'changeWarning': 'Chain will have to resync!',
'default': false,
},
'objectList': {
'name': 'Object List',
'type': 'list',
'subtype': 'object',
'description': 'This is a list of objects, like users or something',
'range': '[0,4]',
'default': [
{
'firstName': 'Admin',
'lastName': 'User',
'age': 40,
},
{
'firstName': 'Admin2',
'lastName': 'User',
'age': 40,
},
],
// the outer spec here, at the list level, says that what's inside (the inner spec) pertains to its inner elements.
// it just so happens that ValueSpecObject's have the field { spec: ConfigSpec }
// see 'unionList' below for a different example.
'spec': {
'uniqueBy': 'lastName',
'displayAs': `I'm {{lastName}}, {{firstName}} {{lastName}}`,
'spec': {
'firstName': {
'name': 'First Name',
'type': 'string',
'description': 'User first name',
'nullable': true,
'default': null,
'masked': false,
'copyable': false,
},
'lastName': {
'name': 'Last Name',
'type': 'string',
'description': 'User first name',
'nullable': true,
'default': {
'charset': 'a-g,2-9',
'len': 12,
},
'pattern': '^[a-zA-Z]+$',
'patternDescription': 'must contain only letters.',
'masked': false,
'copyable': true,
},
'age': {
'name': 'Age',
'type': 'number',
'description': 'The age of the user',
'nullable': true,
'default': null,
'integral': false,
'changeWarning': 'User must be at least 18.',
'range': '[18,*)',
},
},
},
},
'unionList': {
'name': 'Union List',
'type': 'list',
'subtype': 'union',
'description': 'This is a sample list of unions',
'changeWarning': 'If you change this, things may work.',
// a list of union selections. e.g. 'summer', 'winter',...
'default': [
'summer',
],
'range': '[0, 2]',
'spec': {
'tag': {
'id': 'preference',
'name': 'Preferences',
'variantNames': {
'summer': 'Summer',
'winter': 'Winter',
'other': 'Other',
},
},
// this default is used to make a union selection when a new list element is first created
'default': 'summer',
'variants': {
'summer': {
'favorite-tree': {
'name': 'Favorite Tree',
'type': 'string',
'nullable': false,
'description': 'What is your favorite tree?',
'default': 'Maple',
'masked': false,
'copyable': false,
},
'favorite-flower': {
'name': 'Favorite Flower',
'type': 'enum',
'description': 'Select your favorite flower',
'valueNames': {
'none': 'Hate Flowers',
'red': 'Red',
'blue': 'Blue',
'purple': 'Purple',
},
'values': [
'none',
'red',
'blue',
'purple',
],
'default': 'none',
},
},
'winter': {
'like-snow': {
'name': 'Like Snow?',
'type': 'boolean',
'description': 'Do you like snow or not?',
'default': true,
},
},
},
'uniqueBy': 'preference',
},
},
'randomEnum': {
'name': 'Random Enum',
'type': 'enum',
'valueNames': {
'null': 'Null',
'option1': 'One 1',
'option2': 'Two 2',
'option3': 'Three 3',
},
'default': 'null',
'description': 'This is not even real.',
'changeWarning': 'Be careful chnaging this!',
'values': [
'null',
'option1',
'option2',
'option3',
],
},
'favoriteNumber': {
'name': 'Favorite Number',
'type': 'number',
'integral': false,
'description': 'Your favorite number of all time',
'changeWarning': 'Once you set this number, it can never be changed without severe consequences.',
'nullable': false,
'default': 7,
'range': '(-100,100]',
'units': 'BTC',
},
'secondaryNumbers': {
'name': 'Unlucky Numbers',
'type': 'list',
'subtype': 'number',
'description': 'Numbers that you like but are not your top favorite.',
'spec': {
'integral': false,
'range': '[-100,200)',
},
'range': '[0,10]',
'default': [
2,
3,
],
},
'rpcsettings': {
'name': 'RPC Settings',
'type': 'object',
'uniqueBy': null,
'description': 'rpc username and password',
'changeWarning': 'Adding RPC users gives them special permissions on your node.',
'nullable': false,
'nullByDefault': false,
'spec': {
'laws': {
'name': 'Laws',
'type': 'object',
'uniqueBy': 'law1',
'description': 'the law of the realm',
'nullable': true,
'nullByDefault': true,
'spec': {
'law1': {
'name': 'First Law',
'type': 'string',
'description': 'the first law',
'nullable': true,
'masked': false,
'copyable': true,
},
'law2': {
'name': 'Second Law',
'type': 'string',
'description': 'the second law',
'nullable': true,
'masked': false,
'copyable': true,
},
},
},
'rulemakers': {
'name': 'Rule Makers',
'type': 'list',
'subtype': 'object',
'description': 'the people who make the rules',
'range': '[0,2]',
'default': [],
'spec': {
'uniqueBy': null,
'spec': {
'rulemakername': {
'name': 'Rulemaker Name',
'type': 'string',
'description': 'the name of the rule maker',
'nullable': false,
'default': {
'charset': 'a-g,2-9',
'len': 12,
},
'masked': false,
'copyable': false,
},
'rulemakerip': {
'name': 'Rulemaker IP',
'type': 'string',
'description': 'the ip of the rule maker',
'nullable': false,
'default': '192.168.1.0',
'pattern': '^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$',
'patternDescription': 'may only contain numbers and periods',
'masked': false,
'copyable': true,
},
},
},
},
'rpcuser': {
'name': 'RPC Username',
'type': 'string',
'description': 'rpc username',
'nullable': false,
'default': 'defaultrpcusername',
'pattern': '^[a-zA-Z]+$',
'patternDescription': 'must contain only letters.',
'masked': false,
'copyable': true,
},
'rpcpass': {
'name': 'RPC User Password',
'type': 'string',
'description': 'rpc password',
'nullable': false,
'default': {
'charset': 'a-z,A-Z,2-9',
'len': 20,
},
'masked': true,
'copyable': true,
},
},
},
'advanced': {
'name': 'Advanced',
'type': 'object',
'uniqueBy': null,
'description': 'Advanced settings',
'nullable': false,
'nullByDefault': false,
'spec': {
'notifications': {
'name': 'Notification Preferences',
'type': 'list',
'subtype': 'enum',
'description': 'how you want to be notified',
'range': '[1,3]',
'default': [
'email',
],
'spec': {
'valueNames': {
'email': 'EEEEmail',
'text': 'Texxxt',
'call': 'Ccccall',
'push': 'PuuuusH',
'webhook': 'WebHooookkeee',
},
'values': [
'email',
'text',
'call',
'push',
'webhook',
],
},
},
},
},
'bitcoinNode': {
'name': 'Bitcoin Node Settings',
'type': 'union',
'uniqueBy': null,
'description': 'The node settings',
'default': 'internal',
'changeWarning': 'Careful changing this',
'tag': {
'id': 'type',
'name': 'Type',
'variantNames': {
'internal': 'Internal',
'external': 'External',
},
},
'variants': {
'internal': {
'lan-address': {
'name': 'LAN Address',
'type': 'pointer',
'subtype': 'app',
'target': 'lan-address',
'app-id': 'bitcoind',
'description': 'the lan address',
},
},
'external': {
'public-domain': {
'name': 'Public Domain',
'type': 'string',
'description': 'the public address of the node',
'nullable': false,
'default': 'bitcoinnode.com',
'pattern': '.*',
'patternDescription': 'anything',
'masked': false,
'copyable': true,
},
},
},
},
'port': {
'name': 'Port',
'type': 'number',
'integral': true,
'description': 'the default port for your Bitcoin node. default: 8333, testnet: 18333, regtest: 18444',
'nullable': false,
'default': 8333,
'range': '[0, 9999]',
},
'favoriteSlogan': {
'name': 'Favorite Slogan',
'type': 'string',
'description': 'You most favorite slogan in the whole world, used for paying you.',
'nullable': true,
'masked': true,
'copyable': true,
},
'rpcallowip': {
'name': 'RPC Allowed IPs',
'type': 'list',
'subtype': 'string',
'description': 'external ip addresses that are authorized to access your Bitcoin node',
'changeWarning': 'Any IP you allow here will have RPC access to your Bitcoin node.',
'range': '[1,10]',
'default': [
'192.168.1.1',
],
'spec': {
'pattern': '((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|((^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]).){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]).){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$)|(^[a-z2-7]{16}\\.onion$)|(^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$))',
'patternDescription': 'must be a valid ipv4, ipv6, or domain name',
},
},
'rpcauth': {
'name': 'RPC Auth',
'type': 'list',
'subtype': 'string',
'description': 'api keys that are authorized to access your Bitcoin node.',
'range': '[0,*)',
'default': [],
'spec': { },
},
},
// actual config
config: {
testnet: undefined,
objectList: undefined,
unionList: undefined,
randomEnum: 'option1',
favoriteNumber: 8,
secondaryNumbers: undefined,
rpcsettings: {
laws: null,
rpcpass: null,
rpcuser: '123',
rulemakers: [],
},
advanced: {
notifications: ['call'],
},
bitcoinNode: undefined,
port: 5959,
maxconnections: null,
rpcallowip: undefined,
rpcauth: ['matt: 8273gr8qwoidm1uid91jeh8y23gdio1kskmwejkdnm'],
},
}
export const mockCupsDependentConfig = {
randomEnum: 'option1',
testnet: false,
favoriteNumber: 8,
secondaryNumbers: [13, 58, 20],
objectList: [],
unionList: [],
rpcsettings: {
laws: null,
rpcpass: null,
rpcuser: '123',
rulemakers: [],
},
advanced: {
notifications: [],
},
bitcoinNode: { type: 'internal' },
port: 5959,
maxconnections: null,
rpcallowip: [],
rpcauth: ['matt: 8273gr8qwoidm1uid91jeh8y23gdio1kskmwejkdnm'],
}
}
Reference in New Issue View Git Blame Copy Permalink