on a98284f help sign in
bridge/src/form/validators.js
188 lines 5.8 kB history raw
1import { some } from 'lodash';
3import {
4 validateNotEmpty,
5 validatePatq,
6 validateShard,
7 validateMnemonic,
8 validateHdPath,
9 validatePoint,
10 validateMaximumPatpByteLength,
11 validateOneOf,
12 validateHexString,
13 validateHexLength,
14 validateEthereumAddress,
15 validateGreaterThan,
16 validateLessThan,
17 validateEmail,
18 validateNotNullAddress,
19 validateHexPrefix,
20 validateLength,
21 validateUnique,
22 validatePsbt,
23 validateSignablePsbt,
24} from 'lib/validators';
25import isPromise from 'lib/isPromise';
27const PRIVATE_KEY_CHAR_LENGTH = 64; // 64 hex characters
28const ADDRESS_CHAR_LENGTH = 40; // 40 hex characters
30// iterate over validators, exiting early if there's an error
31const buildValidator = (validators = [], validate) => value => {
32 for (const validator of validators) {
33 try {
34 const error = validator(value);
35 if (error) {
36 return error;
37 }
38 } catch (error) {
39 console.error(error);
40 return error.message;
41 }
42 }
44 if (validate) {
45 // the final validate function can optionally return a promise
46 return validate(value);
47 }
48};
50// maps a validator across an array of values
51export const buildArrayValidator = validator => values => {
52 const errorsOrPromises = values.map(validator);
53 if (some(errorsOrPromises, isPromise)) {
54 return Promise.all(errorsOrPromises);
55 }
57 return errorsOrPromises;
58};
60// error object has errors if some of its fields are
61// 1) an array with any defined values
62// 2) any defined values
63export const hasErrors = iter =>
64 some(iter, v => (Array.isArray(v) ? hasErrors(v) : v !== undefined));
66export const buildPatqValidator = (validators = []) =>
67 buildValidator([validateNotEmpty, validatePatq, ...validators]);
68export const buildShardValidator = (validators = []) =>
69 buildValidator([validateShard, ...validators]);
70export const buildAnyMnemonicValidator = () =>
71 buildValidator([validateNotEmpty]);
72export const buildMnemonicValidator = () =>
73 buildValidator([validateNotEmpty, validateMnemonic]);
74export const buildCheckboxValidator = mustBe =>
75 buildValidator([
76 validateOneOf(mustBe !== undefined ? [mustBe] : [true, false]),
77 ]);
78export const buildPassphraseValidator = () => buildValidator([]);
79// TODO: validate hdpath format
80export const buildHdPathValidator = () => buildValidator([validateHdPath]);
81export const buildPointValidator = (size = 4, validators = []) =>
82 buildValidator([
83 validateNotEmpty,
84 validateMaximumPatpByteLength(size),
85 validatePoint,
86 ...validators,
87 ]);
88export const buildSelectValidator = options =>
89 buildValidator([validateOneOf(options.map(option => option.value))]);
90export const buildHexValidator = length =>
91 buildValidator([
92 validateNotEmpty,
93 validateHexPrefix,
94 validateHexString,
95 validateHexLength(length),
96 ]);
97export const buildPrivateKeyValidator = () =>
98 buildValidator([
99 validateNotEmpty,
100 validateHexString,
101 validateLength(PRIVATE_KEY_CHAR_LENGTH),
102 ]);
103export const buildUploadValidator = () => buildValidator([validateNotEmpty]);
104export const buildAddressValidator = () =>
105 buildValidator([
106 validateNotEmpty,
107 validateHexPrefix,
108 validateHexString,
109 validateHexLength(ADDRESS_CHAR_LENGTH),
110 validateNotNullAddress,
111 validateEthereumAddress,
112 ]);
113export const buildNumberValidator = (min = 0, max = null) => {
114 let validators = [validateGreaterThan(min)];
115 if (max !== null) {
116 validators.push(validateLessThan(max));
117 }
118 return buildValidator(validators);
119};
121export const buildEmailValidator = validate =>
122 buildValidator([validateNotEmpty, validateEmail], validate);
124export const buildEmailArrayValidator = () =>
125 buildValidator([validateUnique, buildArrayValidator(buildEmailValidator())]);
127export const buildPsbtValidator = btcWallet =>
128 buildValidator([validatePsbt, validateSignablePsbt(btcWallet)]);
130// the form validator is the composition of all of the field validators
131// plus an additional form validator function
132export const composeValidator = (
133 fieldValidators = {},
134 // the default form validator just returns field-level validations
135 formValidator = (values, errors) => errors
136) => {
137 const names = Object.keys(fieldValidators);
139 const fieldLevelValidators = names.map(name => value =>
140 fieldValidators[name](value)
141 );
143 // async reduce errors per-field into an errors object
144 const fieldLevelValidator = values => {
145 const errorsOrPromises = names.map((name, i) =>
146 fieldLevelValidators[i](values[name])
147 );
149 const reduce = errors =>
150 names.reduce(
151 (memo, name, i) => ({
152 ...memo,
153 [name]: errors[i],
154 }),
155 {}
156 );
158 if (some(errorsOrPromises, isPromise)) {
159 // if any of these results are a promise, await them all then reduce
160 return Promise.all(errorsOrPromises).then(reduce);
161 }
163 // otherwise return immediately
164 return reduce(errorsOrPromises);
165 };
167 // the final-form `validate` function
168 // NOTE: if we return a Promise to final-form it will toggle the `validating`
169 // state, which is expected. If our promise resolves immediately, however,
170 // that means our `validating` state flickers the UI and it looks pretty bad.
171 // The solution is to conditionally return a promise only when necessary.
172 return values => {
173 // ask for field-level errors
174 const errorsOrPromise = fieldLevelValidator(values);
176 // pass the current values and their validity to the form-level validator
177 // that can implement conditional logic and more complex validations
178 const runFormValidator = errors => formValidator(values, errors);
180 if (isPromise(errorsOrPromise)) {
181 // if promise, promise
182 return errorsOrPromise.then(runFormValidator);
183 }
185 // otherwise, it's an errors object
186 return runFormValidator(errorsOrPromise);
187 };
188};