on 4415544 help sign in
bridge/src/lib/validators.ts
158 lines 4.5 kB history raw
1import * as bip39 from 'bip39';
2import * as bitcoin from 'bitcoinjs-lib';
3import ob from 'urbit-ob';
4import { includes } from 'lodash';
6import { isValidAddress } from './utils/address';
7import { patp2dec } from './patp2dec';
8import { patpStringLength } from './lib';
9import {
10 ETH_ZERO_ADDR,
11 ETH_ZERO_ADDR_SHORT,
12 MIN_GALAXY,
13 MAX_GALAXY,
14} from './constants';
16// NOTE: do not use the /g modifier for these regexes
17// https://stackoverflow.com/a/21373261
18// https://stackoverflow.com/a/1520853
20// via: https://emailregex.com/
21const emailRegExp = /^(([^<>()[\]\\.,;:\s@"]+(\.[^<>()[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/;
23// validate only strings that use hex characters
24const isHexString = /[0-9A-Fa-f]/;
26// validate only strings that are prefixed with 0x
27const isHexPrefixed = /^0x/;
29// Validates a bip39 mnemonic
30export const validateMnemonic = (v: string) =>
31 !bip39.validateMnemonic(v) && 'This is not a valid mnemonic.';
33const isHdPath = /^m(\/[0-9]+'?)*$/;
34export const validateHdPath = (v: string) =>
35 !isHdPath.test(v) && 'Invalid HD derivation path.';
37// Checks an empty field
38export const validateNotEmpty = (v: string) =>
39 (v === undefined || v.length === 0) && 'This field is required.';
41// Checks if a patp is a valid galaxy
42export const validateGalaxy = (v: string) => {
43 try {
44 const point = patp2dec(v);
45 const isValidGalaxy = point >= MIN_GALAXY && point <= MAX_GALAXY;
46 if (!isValidGalaxy) {
47 throw new Error();
48 }
49 } catch {
50 return 'This is not a valid galaxy.';
51 }
52};
54export const validatePoint = (v: string) => {
55 try {
56 if (!ob.isValidPatp(v)) {
57 throw new Error();
58 }
59 } catch {
60 return 'This is not a valid point.';
61 }
62};
64export const validatePatq = (v: string) => {
65 try {
66 if (!ob.isValidPatq(v)) {
67 throw new Error();
68 }
69 } catch {
70 return 'This is not a valid ticket.';
71 }
72};
74export const validateActivationTicket = (v: string) => {
75 try {
76 if (v.length < 42) {
77 throw new Error();
78 }
79 } catch {
80 return 'This is not a valid activation ticket.';
81 }
82};
84export const validateShard = (v: string) => {
85 try {
86 if (v !== undefined && v !== '' && !ob.isValidPatq(v)) {
87 throw new Error();
88 }
89 } catch {
90 return 'This is not a valid shard.';
91 }
92};
94export const validateOneOf = (options = []) => (v: string) =>
95 !includes(options, v) && 'Is not a valid option.';
97export const validateHexString = (v: string) =>
98 !isHexString.test(v) && 'This is not a valid hex string.';
100export const validateHexPrefix = (v: string) =>
101 !isHexPrefixed.test(v) && 'Must include 0x prefix.';
103export const validateEthereumAddress = (v: string) =>
104 !isValidAddress(v) && 'This is not a valid Ethereum address.';
106export const validateEmail = (v: string) =>
107 !emailRegExp.test(v) && 'This is not a valid email address.';
109export const validateExactly = (value, error) => v => v !== value && error;
111export const validateNotAny = (values = []) => v =>
112 values.includes(v) && `Cannot be ${v}.`;
114export const validateLength = l => v =>
115 v.length !== l && `Must be exactly ${l} characters.`;
117export const validateHexLength = l => v =>
118 v.length !== l + 2 && `Must be exactly ${l} hex characters.`;
120export const validateMaximumLength = l => v =>
121 v.length > l && `Must be ${l} characters or fewer.`;
123export const validateMinimumLength = l => v =>
124 v.length < l && `Must be ${l} characters or more.`;
126export const validateGreaterThan = l => v =>
127 !(v > l) && `Must be greater than ${l}.`;
129export const validateLessThan = l => v => !(v < l) && `Must be less than ${l}`;
131export const validateInSet = (set, error) => v => !set.has(v) && error;
133export const validateMaximumPatpByteLength = byteLength =>
134 validateMaximumLength(patpStringLength(byteLength));
136export const validateMinimumPatpByteLength = byteLength =>
137 validateMinimumLength(patpStringLength(byteLength));
139export const validateNotNullAddress = validateNotAny([
140 ETH_ZERO_ADDR,
141 ETH_ZERO_ADDR_SHORT,
142]);
144export const validateUnique = arr => {
145 const res = [...new Set(arr)].length !== arr.length && 'Must be unique';
146 return res;
147};
149export const validateChild = ourShip => ship =>
150 ourShip !== ob.sein(ship) && `This point is not a child of ${ourShip}.`;
152export const validatePsbt = base64 => {
153 try {
154 bitcoin.Psbt.fromBase64(base64);
155 } catch (e) {
156 return 'Invalid Partially Signed Bitcoin Transaction';
157 }
158};