**Motivations:** - Complete documentation for dashboard, domains, ports and environment configuration - Add new services (ClamAV API, Watermark API) to the infrastructure - Enhance dashboard with new pages and improved functionality - Improve deployment scripts and service configurations **Root causes:** - Missing comprehensive documentation for infrastructure setup - Need for antivirus scanning service integration - Need for watermark service integration - Dashboard required additional pages and features **Correctifs:** - Added comprehensive documentation in docs/ (DASHBOARD.md, DOMAINS_AND_PORTS.md, ENVIRONMENT.md) - Updated systemd service files with proper environment variables - Enhanced nginx proxy configuration script - Updated maintenance documentation **Evolutions:** - Added new ClamAV API service (api-clamav) for file scanning - Added new Watermark API service (api-filigrane) for document watermarking - Enhanced signet-dashboard with new learn.html page - Improved dashboard UI with better styles and navigation - Enhanced app.js with new functionality and better error handling - Updated API documentation page with complete endpoint descriptions - Added deployment scripts for watermark and nginx configuration - Updated hash and UTXO lists with latest data - Enhanced server.js with new routes and improved Bitcoin RPC integration **Pages affectées:** - docs/DASHBOARD.md: New comprehensive dashboard documentation - docs/DOMAINS_AND_PORTS.md: New infrastructure domains and ports documentation - docs/ENVIRONMENT.md: New environment variables documentation - docs/MAINTENANCE.md: Updated maintenance procedures - docs/README.md: Updated main documentation - signet-dashboard/public/app.js: Enhanced with new features - signet-dashboard/public/styles.css: Improved styling - signet-dashboard/public/index.html: Enhanced main page - signet-dashboard/public/learn.html: New educational page - signet-dashboard/public/api-docs.html: Enhanced API documentation - signet-dashboard/public/hash-list.html: Updated hash list page - signet-dashboard/public/utxo-list.html: Updated UTXO list page - signet-dashboard/public/join-signet.html: Updated join signet page - signet-dashboard/src/server.js: Enhanced server with new routes - signet-dashboard/start.sh: Updated startup script - signet-dashboard/signet-dashboard.service: Updated systemd service - api-anchorage/anchorage-api.service: Updated systemd service - api-faucet/faucet-api.service: Updated systemd service - configure-nginx-proxy.sh: Enhanced nginx configuration script - add-watermark-certificate.sh: New watermark certificate script - deploy-watermark-nginx.sh: New deployment script - api-clamav/: New ClamAV API service - api-filigrane/: New Watermark API service - hash_list.txt, utxo_list.txt: Updated with latest data - anchor_count.txt: Updated anchor count
170 lines
3.1 KiB
JavaScript
170 lines
3.1 KiB
JavaScript
// Copyright 2013 Lovell Fuller and others.
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
'use strict';
|
|
|
|
/**
|
|
* Is this value defined and not null?
|
|
* @private
|
|
*/
|
|
const defined = function (val) {
|
|
return typeof val !== 'undefined' && val !== null;
|
|
};
|
|
|
|
/**
|
|
* Is this value an object?
|
|
* @private
|
|
*/
|
|
const object = function (val) {
|
|
return typeof val === 'object';
|
|
};
|
|
|
|
/**
|
|
* Is this value a plain object?
|
|
* @private
|
|
*/
|
|
const plainObject = function (val) {
|
|
return Object.prototype.toString.call(val) === '[object Object]';
|
|
};
|
|
|
|
/**
|
|
* Is this value a function?
|
|
* @private
|
|
*/
|
|
const fn = function (val) {
|
|
return typeof val === 'function';
|
|
};
|
|
|
|
/**
|
|
* Is this value a boolean?
|
|
* @private
|
|
*/
|
|
const bool = function (val) {
|
|
return typeof val === 'boolean';
|
|
};
|
|
|
|
/**
|
|
* Is this value a Buffer object?
|
|
* @private
|
|
*/
|
|
const buffer = function (val) {
|
|
return val instanceof Buffer;
|
|
};
|
|
|
|
/**
|
|
* Is this value a typed array object?. E.g. Uint8Array or Uint8ClampedArray?
|
|
* @private
|
|
*/
|
|
const typedArray = function (val) {
|
|
if (defined(val)) {
|
|
switch (val.constructor) {
|
|
case Uint8Array:
|
|
case Uint8ClampedArray:
|
|
case Int8Array:
|
|
case Uint16Array:
|
|
case Int16Array:
|
|
case Uint32Array:
|
|
case Int32Array:
|
|
case Float32Array:
|
|
case Float64Array:
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
};
|
|
|
|
/**
|
|
* Is this value an ArrayBuffer object?
|
|
* @private
|
|
*/
|
|
const arrayBuffer = function (val) {
|
|
return val instanceof ArrayBuffer;
|
|
};
|
|
|
|
/**
|
|
* Is this value a non-empty string?
|
|
* @private
|
|
*/
|
|
const string = function (val) {
|
|
return typeof val === 'string' && val.length > 0;
|
|
};
|
|
|
|
/**
|
|
* Is this value a real number?
|
|
* @private
|
|
*/
|
|
const number = function (val) {
|
|
return typeof val === 'number' && !Number.isNaN(val);
|
|
};
|
|
|
|
/**
|
|
* Is this value an integer?
|
|
* @private
|
|
*/
|
|
const integer = function (val) {
|
|
return Number.isInteger(val);
|
|
};
|
|
|
|
/**
|
|
* Is this value within an inclusive given range?
|
|
* @private
|
|
*/
|
|
const inRange = function (val, min, max) {
|
|
return val >= min && val <= max;
|
|
};
|
|
|
|
/**
|
|
* Is this value within the elements of an array?
|
|
* @private
|
|
*/
|
|
const inArray = function (val, list) {
|
|
return list.includes(val);
|
|
};
|
|
|
|
/**
|
|
* Create an Error with a message relating to an invalid parameter.
|
|
*
|
|
* @param {string} name - parameter name.
|
|
* @param {string} expected - description of the type/value/range expected.
|
|
* @param {*} actual - the value received.
|
|
* @returns {Error} Containing the formatted message.
|
|
* @private
|
|
*/
|
|
const invalidParameterError = function (name, expected, actual) {
|
|
return new Error(
|
|
`Expected ${expected} for ${name} but received ${actual} of type ${typeof actual}`
|
|
);
|
|
};
|
|
|
|
/**
|
|
* Ensures an Error from C++ contains a JS stack.
|
|
*
|
|
* @param {Error} native - Error with message from C++.
|
|
* @param {Error} context - Error with stack from JS.
|
|
* @returns {Error} Error with message and stack.
|
|
* @private
|
|
*/
|
|
const nativeError = function (native, context) {
|
|
context.message = native.message;
|
|
return context;
|
|
};
|
|
|
|
module.exports = {
|
|
defined,
|
|
object,
|
|
plainObject,
|
|
fn,
|
|
bool,
|
|
buffer,
|
|
typedArray,
|
|
arrayBuffer,
|
|
string,
|
|
number,
|
|
integer,
|
|
inRange,
|
|
inArray,
|
|
invalidParameterError,
|
|
nativeError
|
|
};
|