v12.0.0 - initial commit

This commit is contained in:
padreug 2025-12-31 19:04:13 +01:00
commit e2c49ea43c
1145 changed files with 97211 additions and 0 deletions

View file

@ -0,0 +1,473 @@
const { skip2fa, getCustomTextEntries } = require('../environment-helper')
const _ = require('lodash/fp')
const nmd = require('nano-markdown')
const plugins = require('../plugins')
const configManager = require('../new-config-manager')
const {
batchGetCustomInfoRequest,
getCustomInfoRequests,
} = require('../new-admin/services/customInfoRequests')
const state = require('../middlewares/state')
const { getMachine } = require('../machine-loader')
const VERSION = require('../../package.json').version
const urlsToPing = [
`us.archive.ubuntu.com`,
`uk.archive.ubuntu.com`,
`za.archive.ubuntu.com`,
`cn.archive.ubuntu.com`,
]
const speedtestFiles = [
{
url: 'https://github.com/lamassu/speed-test-assets/raw/main/python-defaults_2.7.18-3.tar.gz',
size: 44668,
},
]
const addDefaults = (dflts, obj) => {
if (!obj) return obj
const ret = Object.assign({}, obj)
Object.entries(dflts).forEach(([key, dflt]) => {
ret[key] = ret[key] ?? dflt
})
return ret
}
const addSmthInfo = (dstField, srcFields) => smth =>
smth && smth.active ? _.set(dstField, _.pick(srcFields, smth)) : _.identity
const addOperatorInfo = addSmthInfo('operatorInfo', [
'name',
'phone',
'email',
'website',
'companyNumber',
])
const addReceiptInfo = receiptInfo => ret => {
if (!receiptInfo) return ret
const fields = [
'automaticPrint',
'paper',
'sms',
'operatorWebsite',
'operatorEmail',
'operatorPhone',
'companyNumber',
'machineLocation',
'customerNameOrPhoneNumber',
'exchangeRate',
'addressQRCode',
]
const defaults = _.fromPairs(_.map(field => [field, false], fields))
receiptInfo = _.flow(
o => _.set('paper', !!o.active, o),
_.assign(defaults),
_.pick(fields),
)(receiptInfo)
return receiptInfo.paper || receiptInfo.sms
? _.set('receiptInfo', receiptInfo, ret)
: ret
}
const addMachineScreenOpts = smth =>
_.update(
'screenOptions',
_.flow(
addSmthInfo('rates', ['active'])(smth.rates),
_.set('customText', getCustomTextEntries()),
),
)
const buildTriggers = allTriggers => {
// BACKWARDS_COMPATIBILITY 11
// requirement was renamed to requirementType in v12
allTriggers = allTriggers.map(t =>
Object.assign({}, t, { requirement: t.requirementType }),
)
const isCustomTrigger = ({ requirementType, customInfoRequestId }) =>
requirementType === 'custom' &&
customInfoRequestId &&
typeof customInfoRequestId === 'string'
const [customTriggers, normalTriggers] = _.partition(
isCustomTrigger,
allTriggers,
)
const addCustomInfoRequestDetails = (customInfoRequest, idx) => {
const trigger = customTriggers[idx]
// make sure we aren't attaching the details to the wrong trigger
return trigger.customInfoRequestId === customInfoRequest.id
? [Object.assign({}, trigger, { customInfoRequest })]
: []
}
return batchGetCustomInfoRequest(
customTriggers.map(({ customInfoRequestId }) => customInfoRequestId),
).then(customInfoRequests => {
const customTriggersWithDetails = customInfoRequests.flatMap(
addCustomInfoRequestDetails,
)
return [...normalTriggers, ...customTriggersWithDetails]
})
}
const staticConfig = ({
currentConfigVersion,
deviceId,
deviceName,
pq,
settings,
machineSettings,
}) => {
const massageCoins = _.map(
_.pick([
'batchable',
'cashInCommission',
'cashInFee',
'cashOutCommission',
'cashOutFee',
'cryptoCode',
'cryptoCodeDisplay',
'cryptoNetwork',
'cryptoUnits',
'display',
'minimumTx',
'isCashInOnly',
]),
)
const staticConf = _.flow(
_.pick(['coins', 'timezone', 'screenOptions']),
_.update('coins', massageCoins),
_.set('serverVersion', VERSION),
_.set('configVersion', settings.version),
)(pq)
return Promise.all([
!!configManager.getCompliance(settings.config).enablePaperWalletOnly,
configManager.getTriggersAutomation(
getCustomInfoRequests(true),
settings.config,
),
buildTriggers(machineSettings.complianceTriggers),
configManager.getWalletSettings('BTC', settings.config).layer2 !==
'no-layer2',
configManager.getLocale(deviceId, settings.config),
configManager.getOperatorInfo(settings.config),
configManager.getReceipt(settings.config),
configManager.getAllMachineScreenOpts(settings.config),
!!configManager.getCashOut(deviceId, settings.config).active,
getMachine(deviceId, currentConfigVersion),
configManager.getCustomerAuthenticationMethod(settings.config),
]).then(
([
enablePaperWalletOnly,
triggersAutomation,
triggers,
hasLightning,
localeInfo,
operatorInfo,
receiptInfo,
machineScreenOpts,
twoWayMode,
{ numberOfCassettes, numberOfRecyclers },
customerAuthentication,
]) =>
currentConfigVersion && currentConfigVersion >= staticConf.configVersion
? null
: _.flow(
_.assign({
enablePaperWalletOnly,
triggersAutomation,
triggers,
hasLightning,
localeInfo: {
country: localeInfo.country,
languages: localeInfo.languages,
fiatCode: localeInfo.fiatCurrency,
},
machineInfo: {
deviceId,
deviceName,
numberOfCassettes,
numberOfRecyclers,
},
twoWayMode,
customerAuthentication,
speedtestFiles,
urlsToPing,
}),
addOperatorInfo(addDefaults({ phone: '' }, operatorInfo)),
addReceiptInfo(receiptInfo),
addMachineScreenOpts(machineScreenOpts),
)(staticConf),
)
}
const setZeroConfLimit = config => coin =>
_.set(
'zeroConfLimit',
configManager.getWalletSettings(coin.cryptoCode, config).zeroConfLimit ?? 0,
coin,
)
const dynamicConfig = ({ deviceId, operatorId, pid, pq, settings }) => {
const massageCassettes = cassettes =>
cassettes
? _.flow(
cassettes =>
_.set('physical', _.get('cassettes', cassettes), cassettes),
cassettes =>
_.set('virtual', _.get('virtualCassettes', cassettes), cassettes),
_.unset('cassettes'),
_.unset('virtualCassettes'),
)(cassettes)
: null
const massageRecyclers = recyclers =>
recyclers
? _.flow(
recyclers =>
_.set('physical', _.get('recyclers', recyclers), recyclers),
recyclers =>
_.set('virtual', _.get('virtualRecyclers', recyclers), recyclers),
_.unset('recyclers'),
_.unset('virtualRecyclers'),
)(recyclers)
: null
state.pids = _.update(
operatorId,
_.set(deviceId, { pid, ts: Date.now() }),
state.pids,
)
const res = _.flow(
_.pick([
'areThereAvailablePromoCodes',
'balances',
'cassettes',
'recyclers',
'coins',
'rates',
]),
_.update('cassettes', massageCassettes),
_.update('recyclers', massageRecyclers),
/* [{ cryptoCode, rates }, ...] => [[cryptoCode, rates], ...] */
_.update(
'coins',
_.map(({ cryptoCode, rates }) => [cryptoCode, rates]),
),
/* [{ cryptoCode: balance }, ...] => [[cryptoCode, { balance }], ...] */
_.update(
'balances',
_.flow(
_.toPairs,
_.map(([cryptoCode, balance]) => [cryptoCode, { balance }]),
),
),
/* Group the separate objects by cryptoCode */
/* { balances, coins, rates } => { cryptoCode: { balance, ask, bid, cashIn, cashOut }, ... } */
({
areThereAvailablePromoCodes,
balances,
cassettes,
recyclers,
coins,
rates,
}) => ({
areThereAvailablePromoCodes,
cassettes,
recyclers,
coins: _.flow(
_.reduce(
(ret, [cryptoCode, obj]) => _.update(cryptoCode, _.assign(obj), ret),
rates,
),
/* { cryptoCode: { balance, ask, bid, cashIn, cashOut }, ... } => [[cryptoCode, { balance, ask, bid, cashIn, cashOut }], ...] */
_.toPairs,
/* [[cryptoCode, { balance, ask, bid, cashIn, cashOut }], ...] => [{ cryptoCode, balance, ask, bid, cashIn, cashOut }, ...] */
_.map(([cryptoCode, obj]) => _.set('cryptoCode', cryptoCode, obj)),
/* Only send coins which have all information needed by the machine. This prevents the machine going down if there's an issue with the coin node */
_.filter(coin =>
['ask', 'bid', 'balance', 'cashIn', 'cashOut', 'cryptoCode'].every(
it => it in coin,
),
),
)(_.concat(balances, coins)),
}),
_.update('coins', _.map(setZeroConfLimit(settings.config))),
_.set('skip2fa', skip2fa),
_.set('reboot', !!pid && state.reboots?.[operatorId]?.[deviceId] === pid),
_.set(
'shutdown',
!!pid && state.shutdowns?.[operatorId]?.[deviceId] === pid,
),
_.set(
'restartServices',
!!pid && state.restartServicesMap?.[operatorId]?.[deviceId] === pid,
),
_.set(
'emptyUnit',
!!pid && state.emptyUnit?.[operatorId]?.[deviceId] === pid,
),
_.set(
'refillUnit',
!!pid && state.refillUnit?.[operatorId]?.[deviceId] === pid,
),
_.set(
'diagnostics',
!!pid && state.diagnostics?.[operatorId]?.[deviceId] === pid,
),
)(pq)
// Clean up the state middleware and prevent commands from being issued more than once
if (!_.isNil(state.emptyUnit?.[operatorId]?.[deviceId])) {
delete state.emptyUnit?.[operatorId]?.[deviceId]
}
if (!_.isNil(state.refillUnit?.[operatorId]?.[deviceId])) {
delete state.refillUnit?.[operatorId]?.[deviceId]
}
if (!_.isNil(state.diagnostics?.[operatorId]?.[deviceId])) {
delete state.diagnostics?.[operatorId]?.[deviceId]
}
return res
}
const configs = (
parent,
{ currentConfigVersion },
{ deviceId, deviceName, operatorId, pid, settings, machineSettings },
) =>
plugins(settings, deviceId)
.pollQueries()
.then(pq => ({
static: staticConfig({
currentConfigVersion,
deviceId,
deviceName,
pq,
settings,
machineSettings,
}),
dynamic: dynamicConfig({
deviceId,
operatorId,
pid,
pq,
settings,
}),
}))
const machineSettings = (
parent,
{ currentSettingsVersion },
{ deviceId, machineSettings },
) => {
if (!machineSettings)
throw new Error(`No cached settings found for machine ${deviceId}`)
currentSettingsVersion = parseInt(currentSettingsVersion, 10)
if (
!isNaN(currentSettingsVersion) &&
currentSettingsVersion >= machineSettings.settingsVersion
)
return null // The machine is up to date
return Object.assign({}, machineSettings, {
complianceTriggers: buildTriggers(machineSettings.complianceTriggers),
})
}
const massageTerms = terms =>
terms.active && terms.text
? {
tcPhoto: Boolean(terms.tcPhoto),
delay: Boolean(terms.delay),
title: terms.title,
text: nmd(terms.text),
accept: terms.acceptButtonText,
cancel: terms.cancelButtonText,
}
: null
/*
* The type of the result of `configManager.getTermsConditions()` is more or
* less `Maybe (Maybe Hash, Maybe TC)`. Each case has a specific meaning to the
* machine:
*
* Nothing => Nothing
* There are no T&C or they've been removed/disabled.
*
* Just (Nothing, _) => Nothing
* Shouldn't happen! Treated as if there were no T&C.
*
* Just (Just hash, Nothing) => Nothing
* May happen (after `massageTerms`) if T&C are disabled.
*
* Just (Just hash, Just tc) => Just (hash, Nothing, Nothing)
* If both the `hash` and the `configVersion` are the same as `currentHash`
* and `currentConfigVersion`, respectively, then there's no need to send
* `text` nor `details`.
*
* Just (Just hash, Just tc) => Just (hash, Nothing, Just details)
* If `configVersion` differs from `currentConfigVersion` but the `hash` is
* the same, then only the details have to be updated.
*
* Just (Just hash, Just tc) => Just (hash, Just text, Just details)
* If the `hash` differs from `currentHash` then everything is resent (to
* simplify machine implementation).
*/
const terms = (parent, { currentConfigVersion, currentHash }, { settings }) => {
const isNone = x => _.isNil(x) || _.isEmpty(x)
let latestTerms = configManager.getTermsConditions(settings.config)
if (isNone(latestTerms)) return null
const hash = latestTerms.hash
if (!_.isString(hash)) return null
latestTerms = massageTerms(latestTerms)
if (isNone(latestTerms)) return null
const isHashNew = hash !== currentHash
const text = isHashNew ? latestTerms.text : null
const isVersionNew =
isHashNew ||
_.isNil(currentConfigVersion) ||
currentConfigVersion < settings.version
const details = isVersionNew ? _.omit(['text'], latestTerms) : null
return { hash, details, text }
}
module.exports = {
Query: {
configs,
machineSettings,
terms,
},
}

View file

@ -0,0 +1,29 @@
const logger = require('../logger')
const { ApolloServer } = require('@apollo/server')
const devMode = !!require('minimist')(process.argv.slice(2)).dev
const context = ({ req, res }) => ({
deviceId: req.deviceId /* lib/middlewares/populateDeviceId.js */,
deviceName: req.deviceName /* lib/middlewares/authorize.js */,
operatorId: res.locals.operatorId /* lib/middlewares/operatorId.js */,
pid: req.query.pid,
settings: req.settings /* lib/middlewares/populateSettings.js */,
machineSettings:
req.machineSettings /* lib/middlewares/populateMachineSettings.js */,
})
const graphQLServer = new ApolloServer({
typeDefs: require('./types'),
resolvers: require('./resolvers'),
introspection: false,
formatError: error => {
logger.error(error)
return error
},
includeStacktraceInErrorResponses: devMode,
logger,
})
module.exports = { graphQLServer, context }

View file

@ -0,0 +1,250 @@
const gql = require('graphql-tag')
module.exports = gql`
type Coin {
cryptoCode: String!
cryptoCodeDisplay: String!
display: String!
minimumTx: String!
cashInFee: String!
cashOutFee: String!
cashInCommission: String!
cashOutCommission: String!
cryptoNetwork: String!
cryptoUnits: String!
batchable: Boolean!
isCashInOnly: Boolean!
}
type LocaleInfo {
country: String!
fiatCode: String!
languages: [String!]!
}
type OperatorInfo {
name: String!
phone: String!
email: String!
website: String!
companyNumber: String!
}
type MachineInfo {
deviceId: String! @deprecated(reason: "unused by the machine")
deviceName: String
numberOfCassettes: Int
numberOfRecyclers: Int
}
type ReceiptInfo {
paper: Boolean!
automaticPrint: Boolean!
sms: Boolean!
operatorWebsite: Boolean!
operatorEmail: Boolean!
operatorPhone: Boolean!
companyNumber: Boolean!
machineLocation: Boolean!
customerNameOrPhoneNumber: Boolean!
exchangeRate: Boolean!
addressQRCode: Boolean!
}
type MachineScreenOptions {
rates: RateScreenOptions!
customText: [CustomText!]!
}
type RateScreenOptions {
active: Boolean!
}
type SpeedtestFile {
url: String!
size: Int!
}
enum TriggerAutomationType {
Automatic
Manual
}
type CustomTriggersAutomation {
id: ID!
type: TriggerAutomationType!
}
type TriggersAutomation {
sanctions: TriggerAutomationType!
idCardPhoto: TriggerAutomationType!
idCardData: TriggerAutomationType!
facephoto: TriggerAutomationType!
usSsn: TriggerAutomationType!
custom: [CustomTriggersAutomation]!
}
type CustomScreen {
text: String!
title: String!
}
type CustomInput {
type: String!
constraintType: String!
label1: String
label2: String
choiceList: [String]
}
type CustomRequest {
name: String!
input: CustomInput!
disablePermissionScreen: Boolean!
screen1: CustomScreen!
screen2: CustomScreen!
}
type CustomInfoRequest {
id: String!
enabled: Boolean!
customRequest: CustomRequest!
}
type CustomText {
id: String!
text: String!
}
type Trigger {
id: String!
direction: String!
requirement: String! @deprecated(reason: "use requirementType")
requirementType: String!
triggerType: String!
suspensionDays: Float
threshold: Int
thresholdDays: Int
customInfoRequestId: String @deprecated(reason: "use customInfoRequest.id")
customInfoRequest: CustomInfoRequest
externalService: String
}
type TermsDetails {
tcPhoto: Boolean!
delay: Boolean!
title: String!
accept: String!
cancel: String!
}
type Terms {
hash: String!
text: String
details: TermsDetails
}
enum CustomerAuthentication {
EMAIL
SMS
}
type StaticConfig {
configVersion: Int!
coins: [Coin!]!
enablePaperWalletOnly: Boolean!
hasLightning: Boolean!
serverVersion: String!
timezone: Int!
twoWayMode: Boolean!
customerAuthentication: CustomerAuthentication!
localeInfo: LocaleInfo!
operatorInfo: OperatorInfo
machineInfo: MachineInfo!
receiptInfo: ReceiptInfo
screenOptions: MachineScreenOptions
speedtestFiles: [SpeedtestFile!]!
urlsToPing: [String!]!
triggersAutomation: TriggersAutomation!
triggers: [Trigger!]!
@deprecated(reason: "moved to machineSettings.complianceTriggers")
}
type MachineSettings {
settingsVersion: String!
complianceTriggers: [Trigger!]!
}
type DynamicCoinValues {
# NOTE: Doesn't seem to be used anywhere outside of lib/plugins.js.
# However, it can be used to generate the cache key, if we ever move to an
# actual caching mechanism.
#timestamp: String!
cryptoCode: String!
balance: String!
# Raw rates
ask: String!
bid: String!
# Rates with commissions applied
cashIn: String!
cashOut: String!
zeroConfLimit: Int!
}
type PhysicalCassette {
name: String!
denomination: Int!
count: Int!
}
type PhysicalRecycler {
name: String!
number: Int!
denomination: Int!
count: Int!
}
type Cassettes {
physical: [PhysicalCassette!]!
virtual: [Int!]!
}
type Recyclers {
physical: [PhysicalRecycler!]!
virtual: [Int!]!
}
type DynamicConfig {
areThereAvailablePromoCodes: Boolean!
cassettes: Cassettes
recyclers: Recyclers
coins: [DynamicCoinValues!]!
reboot: Boolean!
shutdown: Boolean!
restartServices: Boolean!
emptyUnit: Boolean!
refillUnit: Boolean!
diagnostics: Boolean!
skip2fa: Boolean!
}
type Configs {
static: StaticConfig
dynamic: DynamicConfig!
}
type Query {
configs(currentConfigVersion: Int): Configs!
machineSettings(currentSettingsVersion: String): MachineSettings
terms(currentHash: String, currentConfigVersion: Int): Terms
}
`