@riocrypto/common-server 1.0.2897 → 1.0.2899

package/build/helpers/get-processor.d.ts

@@ -3,7 +3,7 @@ export declare const getEnvironmentExcludedProcessors: (purpose: ProcessorRoutin
 export type ProcessorSelection = RoutingDecision & {
     processor: Processor;
 };
-export declare const getProcessor: ({ country, fiat, side, isBinanceRFQ, routingConfig, enablement, requireExplicitPayinEnablement, customRioBankAccount, }: {
+export declare const getProcessor: ({ country, fiat, side, isBinanceRFQ, routingConfig, enablement, requireExplicitPayinEnablement, requireExplicitPayoutEnablement, customRioBankAccount, }: {
     country: Country;
     fiat: Fiat;
     side: Side;
@@ -11,6 +11,7 @@ export declare const getProcessor: ({ country, fiat, side, isBinanceRFQ, routing
     routingConfig?: ProcessorRoutingConfig | undefined;
     enablement?: ProcessorEnablementState | undefined;
     requireExplicitPayinEnablement?: boolean | undefined;
+    requireExplicitPayoutEnablement?: boolean | undefined;
     customRioBankAccount?: {
         processor?: Processor | undefined;
     } | undefined;

package/build/helpers/get-processor.js

@@ -27,7 +27,7 @@ const getEnvironmentExcludedProcessors = (purpose) => [
     ...(isSTPAvailable(purpose) ? [] : [common_1.Processor.SPEI_STP]),
 ];
 exports.getEnvironmentExcludedProcessors = getEnvironmentExcludedProcessors;
-const getProcessor = ({ country, fiat, side, isBinanceRFQ, routingConfig, enablement, requireExplicitPayinEnablement, customRioBankAccount, }) => {
+const getProcessor = ({ country, fiat, side, isBinanceRFQ, routingConfig, enablement, requireExplicitPayinEnablement, requireExplicitPayoutEnablement, customRioBankAccount, }) => {
     if (isBinanceRFQ === true) {
         return {
             processor: common_1.Processor.BinanceRFQ,
@@ -56,17 +56,21 @@ const getProcessor = ({ country, fiat, side, isBinanceRFQ, routingConfig, enable
             routingConfig,
             excludedProcessors,
             enablement,
-            requireExplicitEnablement: requireExplicitPayinEnablement,
+            requireExplicitEnablement: side === common_1.Side.Buy
+                ? requireExplicitPayinEnablement
+                : requireExplicitPayoutEnablement,
             customRioBankAccount,
         });
         if (routed.processor) {
             return Object.assign(Object.assign({}, routed), { processor: routed.processor });
         }
-        // The customer has never told us which of these accounts their bank will let
-        // them pay, so there is nothing to route to. Says so in their terms, since
-        // the fix is theirs to make rather than something support has to escalate.
+        // The customer has never told us which of these accounts works for them, so
+        // there is nothing to route to. Says so in their terms, since the fix is
+        // theirs to make rather than something support has to escalate.
         if (routed.reason === common_1.RoutingDecisionReason.NoAcceptedCandidate) {
-            throw new common_1.GenericInputError("You need to turn on a payment account for this currency before you can buy. You can do that from the payment accounts page, once your bank allows transfers to it.");
+            throw new common_1.GenericInputError(side === common_1.Side.Buy
+                ? "You need to turn on a payment account for this currency before you can buy. You can do that from the payment accounts page, once your bank allows transfers to it."
+                : "You need to turn on a payout account for this currency before you can sell. You can do that from the payout accounts page.");
         }
         // Every rail in this corridor is switched off for this direction, so there is
         // nowhere to send them - a rail at zero percent would still have taken the

package/build/helpers/processor-enablement.d.ts

@@ -30,9 +30,10 @@ export declare const setProcessorEnablement: ({ mongoose, userId, country, fiat,
     adminId?: string | undefined;
     requireExplicitEnablement?: boolean | undefined;
 }) => Promise<void>;
-export declare const ensureDefaultPayinEnablement: ({ mongoose, userId, country, fiat, }: {
+export declare const ensureDefaultEnablement: ({ mongoose, userId, country, fiat, side, }: {
     mongoose: Mongoose;
     userId: string;
     country: Country;
     fiat: Fiat;
+    side: Side;
 }) => Promise<Processor | undefined>;

package/build/helpers/processor-enablement.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ensureDefaultPayinEnablement = exports.setProcessorEnablement = exports.getProcessorEnablementState = exports.isProcessorEnabled = void 0;
+exports.ensureDefaultEnablement = exports.setProcessorEnablement = exports.getProcessorEnablementState = exports.isProcessorEnabled = void 0;
 const common_1 = require("@riocrypto/common");
 const processor_readiness_1 = require("../models/processor-readiness");
 const get_processor_1 = require("./get-processor");
@@ -20,22 +20,21 @@ const getPurpose = (side) => side === common_1.Side.Buy
     : common_1.ProcessorRoutingPurpose.Sell;
 // Whether one rail may carry one customer's orders in one direction.
 //
-// The two directions disagree about silence, which is the whole point. A payout
-// needs nothing arranged at the customer's bank, so a rail nobody has spoken
-// about can pay them. A payin asks them to send money to an account their bank
-// has to allow first, so silence means no while payin accounts are opt-in.
-const isProcessorEnabled = ({ enablement, side, requireExplicitEnablement, }) => {
-    var _a, _b;
-    return (_b = (_a = enablement === null || enablement === void 0 ? void 0 : enablement[side]) === null || _a === void 0 ? void 0 : _a.isEnabled) !== null && _b !== void 0 ? _b : (side === common_1.Side.Sell || !requireExplicitEnablement);
-};
+// What silence means is the caller's to decide, by passing the setting for this
+// direction: `requireExplicitPayinEnablement` on a buy and
+// `requireExplicitPayoutEnablement` on a sell. On, a rail nobody has spoken about
+// cannot carry the order; off, it can, which is how both directions behaved before
+// enablement became opt-in.
+const isProcessorEnabled = ({ enablement, side, requireExplicitEnablement, }) => { var _a, _b; return (_b = (_a = enablement === null || enablement === void 0 ? void 0 : enablement[side]) === null || _a === void 0 ? void 0 : _a.isEnabled) !== null && _b !== void 0 ? _b : !requireExplicitEnablement; };
 exports.isProcessorEnabled = isProcessorEnabled;
 // What a customer has said about each rail in one corridor and one direction.
 //
 // Reports the three sets rather than a verdict so that the policy lives in one
 // place, in routing, instead of being decided here and again wherever a page
-// needs to show the same thing. Only rails the corridor currently serves are
-// reported, so a record left behind by a rail we no longer route to is ignored
-// rather than resurrected.
+// needs to show the same thing. Whether an unset rail counts as usable is that
+// policy, and it belongs to the caller with the settings in hand. Only rails the
+// corridor currently serves are reported, so a record left behind by a rail we no
+// longer route to is ignored rather than resurrected.
 const getProcessorEnablementState = ({ mongoose, userId, country, fiat, side, }) => __awaiter(void 0, void 0, void 0, function* () {
     const ProcessorReadiness = (0, processor_readiness_1.buildProcessorReadiness)(mongoose);
     const records = yield ProcessorReadiness.find({
@@ -98,7 +97,7 @@ const setProcessorEnablement = ({ mongoose, userId, country, fiat, side, process
         });
         const stillUsable = [
             ...state.enabled,
-            ...(side === common_1.Side.Sell || !requireExplicitEnablement ? state.unset : []),
+            ...(requireExplicitEnablement ? [] : state.unset),
         ].filter((candidate) => candidate !== processor);
         if (!stillUsable.length) {
             throw new common_1.GenericInputError(side === common_1.Side.Buy
@@ -124,9 +123,9 @@ const setProcessorEnablement = ({ mongoose, userId, country, fiat, side, process
     }, { upsert: true });
 });
 exports.setProcessorEnablement = setProcessorEnablement;
-// Gives a customer with no payin account turned on the one their corridor would
-// have routed them to anyway, so opt-in never leaves somebody unable to be
-// quoted. Called when an onboarding is approved, and by the backfill for accounts
+// Gives a customer with nothing turned on in one direction the rail their corridor
+// would have routed them to anyway, so opt-in never leaves somebody unable to
+// trade. Called when an onboarding is approved, and by the backfill for accounts
 // that predate all of this.
 //
 // Skips anyone who has already turned a rail on, because their answer is better
@@ -135,13 +134,14 @@ exports.setProcessorEnablement = setProcessorEnablement;
 // the corridor's own order, which is the rail routing would have picked for them
 // before opt-in existed. Returns the rail it turned on, or nothing if it left
 // them alone.
-const ensureDefaultPayinEnablement = ({ mongoose, userId, country, fiat, }) => __awaiter(void 0, void 0, void 0, function* () {
+const ensureDefaultEnablement = ({ mongoose, userId, country, fiat, side, }) => __awaiter(void 0, void 0, void 0, function* () {
+    const purpose = getPurpose(side);
     const state = yield (0, exports.getProcessorEnablementState)({
         mongoose,
         userId,
         country,
         fiat,
-        side: common_1.Side.Buy,
+        side,
     });
     if (state.enabled.length) {
         return undefined;
@@ -150,10 +150,10 @@ const ensureDefaultPayinEnablement = ({ mongoose, userId, country, fiat, }) => _
     // seeding a rail this deployment cannot reach would hand the customer an
     // account nothing can route to and read as opt-in having blocked them.
     const unreachable = [
-        ...(0, get_processor_1.getEnvironmentExcludedProcessors)(common_1.ProcessorRoutingPurpose.Buy),
+        ...(0, get_processor_1.getEnvironmentExcludedProcessors)(purpose),
         ...state.disabled,
     ];
-    const seed = (0, common_1.getDefaultProcessor)(country, fiat, common_1.ProcessorRoutingPurpose.Buy, unreachable) ||
+    const seed = (0, common_1.getDefaultProcessor)(country, fiat, purpose, unreachable) ||
         state.unset.find((candidate) => !unreachable.includes(candidate));
     if (!seed || !state.unset.includes(seed)) {
         return undefined;
@@ -163,10 +163,10 @@ const ensureDefaultPayinEnablement = ({ mongoose, userId, country, fiat, }) => _
         userId,
         country,
         fiat,
-        side: common_1.Side.Buy,
+        side,
         processor: seed,
         isEnabled: true,
     });
     return seed;
 });
-exports.ensureDefaultPayinEnablement = ensureDefaultPayinEnablement;
+exports.ensureDefaultEnablement = ensureDefaultEnablement;

package/build/helpers/resolve-processor.js

@@ -27,7 +27,9 @@ const pickByShare = (candidates, position) => {
 // belonging to a corridor with no rule at all still takes their orders when it is
 // the only one available to them, which is why the candidate set comes from the
 // corridor rather than from the rule. What keeps an order away from a rail is the
-// customer, by switching it off or, on buys, by never turning it on.
+// customer, by switching it off or, while that direction is opt-in, by never
+// turning it on. Unless the rule says otherwise: a split set to apply to all
+// users divides the corridor by percentage alone and asks nobody.
 //
 // Does no IO of its own - the routing config and the user's enablement are passed
 // in - and the only nondeterminism is the per-order roll, which a caller can
@@ -110,28 +112,33 @@ const resolveProcessor = ({ country, fiat, purpose, routingConfig, excludedProce
     // can refuse a wire from Bancrea as easily as a SPEI transfer from Fintoc.
     //
     // Verifications are exempt because they are ours to place against an account the
-    // customer gave us, not a rail they have to accept.
+    // customer gave us, not a rail they have to accept. So is a corridor whose split
+    // has been set to apply to everyone, which is the deliberate exception: see
+    // `appliesToAllUsers`.
     const isGated = purpose !== common_1.ProcessorRoutingPurpose.BankAccountVerification;
     const disabled = isGated ? (enablement === null || enablement === void 0 ? void 0 : enablement.disabled) || [] : [];
-    const unset = isGated && requireExplicitEnablement && purpose === common_1.ProcessorRoutingPurpose.Buy
-        ? (enablement === null || enablement === void 0 ? void 0 : enablement.unset) || []
-        : [];
-    const candidates = eligible.filter((processor) => !disabled.includes(processor) && !unset.includes(processor));
+    const unset = isGated && requireExplicitEnablement ? (enablement === null || enablement === void 0 ? void 0 : enablement.unset) || [] : [];
+    // Recorded either way, and only acted on when the split leaves the choice with
+    // the customer. An order routed over their objection is the one that will be
+    // asked about later, so what they had said needs to survive on the decision.
+    const enablementOverridden = isGated && Boolean(rule === null || rule === void 0 ? void 0 : rule.appliesToAllUsers);
+    const candidates = enablementOverridden
+        ? eligible
+        : eligible.filter((processor) => !disabled.includes(processor) && !unset.includes(processor));
+    // What was filtered, carried by every decision below. Kept in one place so a
+    // branch cannot quietly stop reporting one of them, since these sets are the
+    // whole reason a decision can still be explained weeks later.
+    const filtered = Object.assign({ corridor, excluded: excludedProcessors, disabled,
+        unset }, (enablementOverridden ? { enablementOverridden: true } : {}));
     if (!candidates.length) {
-        return {
+        return Object.assign(Object.assign({ 
             // Told apart because they are different conversations. One customer turned
             // their rails off and can turn one back on; the other has never told us
             // which account their bank will let them pay, and needs to whitelist one
             // before anything can be routed.
             reason: unset.length
                 ? common_1.RoutingDecisionReason.NoAcceptedCandidate
-                : common_1.RoutingDecisionReason.NoEnabledCandidate,
-            corridor,
-            excluded: excludedProcessors,
-            disabled,
-            unset,
-            decidedAt,
-        };
+                : common_1.RoutingDecisionReason.NoEnabledCandidate }, filtered), { decidedAt });
     }
     const shares = candidates
         .map((processor) => {
@@ -151,42 +158,18 @@ const resolveProcessor = ({ country, fiat, purpose, routingConfig, excludedProce
     // position gets is predictable rather than rolled.
     if (!shares.length) {
         const fallback = (0, common_1.getDefaultProcessor)(country, fiat, purpose, excludedProcessors);
-        return {
-            processor: fallback && candidates.includes(fallback) ? fallback : candidates[0],
-            reason: common_1.RoutingDecisionReason.EnabledRailWithoutShare,
-            corridor,
-            excluded: excludedProcessors,
-            disabled,
-            unset,
-            decidedAt,
-        };
+        return Object.assign(Object.assign({ processor: fallback && candidates.includes(fallback) ? fallback : candidates[0], reason: common_1.RoutingDecisionReason.EnabledRailWithoutShare }, filtered), { decidedAt });
     }
     if (shares.length === 1) {
-        return {
-            processor: shares[0].processor,
-            reason: common_1.RoutingDecisionReason.OnlyCandidate,
-            corridor,
-            excluded: excludedProcessors,
-            disabled,
-            unset,
-            percentages,
-            decidedAt,
-        };
+        return Object.assign(Object.assign({ processor: shares[0].processor, reason: common_1.RoutingDecisionReason.OnlyCandidate }, filtered), { percentages,
+            decidedAt });
     }
     // Rolled per order, so the realized share converges on the configured
     // percentages by order count. Nothing is persisted here: a caller that needs
     // the same answer twice passes back the seed it used.
     const seed = randomSeed !== null && randomSeed !== void 0 ? randomSeed : Math.random();
-    return {
-        processor: pickByShare(shares, seed),
-        reason: common_1.RoutingDecisionReason.Split,
-        corridor,
-        excluded: excludedProcessors,
-        disabled,
-        unset,
-        percentages,
+    return Object.assign(Object.assign({ processor: pickByShare(shares, seed), reason: common_1.RoutingDecisionReason.Split }, filtered), { percentages,
         seed,
-        decidedAt,
-    };
+        decidedAt });
 };
 exports.resolveProcessor = resolveProcessor;

package/build/models/rio-settings.d.ts

@@ -56,6 +56,7 @@ interface RioSettingsAttrs {
     fxTradingPolicies?: FXTradingPolicies;
     processorRouting?: ProcessorRoutingConfig;
     requireExplicitPayinEnablement?: boolean;
+    requireExplicitPayoutEnablement?: boolean;
     TVFXDataProvider: {
         [key in Fiat]: TVFXDataProvider;
     };
@@ -151,6 +152,7 @@ interface RioSettingsDoc extends mongoose.Document {
     fxTradingPolicies?: FXTradingPolicies;
     processorRouting?: ProcessorRoutingConfig;
     requireExplicitPayinEnablement?: boolean;
+    requireExplicitPayoutEnablement?: boolean;
     TVFXDataProvider: {
         [key in Fiat]: TVFXDataProvider;
     };

package/build/models/rio-settings.js

@@ -62,6 +62,9 @@ const buildRioSettings = (mongoose) => {
         requireExplicitPayinEnablement: {
             type: Boolean,
         },
+        requireExplicitPayoutEnablement: {
+            type: Boolean,
+        },
         TVFXDataProvider: {
             type: Object,
         },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riocrypto/common-server",
-  "version": "1.0.2897",
+  "version": "1.0.2899",
   "description": "",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",
@@ -28,7 +28,7 @@
     "@google-cloud/secret-manager": "^5.6.0",
     "@google-cloud/storage": "^7.19.0",
     "@hyperdx/node-opentelemetry": "^0.10.3",
-    "@riocrypto/common": "1.0.2709",
+    "@riocrypto/common": "1.0.2711",
     "@slack/web-api": "^7.15.0",
     "@types/express": "^4.17.25",
     "axios": "1.18.1",