Skip to content

Fix watch asset validation and errors #317

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rekmarks merged 2 commits into from
Dec 2, 2020
Merged

Fix watch asset validation and errors #317

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a00b975
Fix watch asset validation and errors
rekmarks Dec 1, 2020
ffd4e79
Lint
rekmarks Dec 1, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions src/util.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { addHexPrefix, isValidAddress, bufferToHex } from 'ethereumjs-util';
import { ethErrors } from 'eth-rpc-errors';
import { TYPED_MESSAGE_SCHEMA, typedSignatureHash } from 'eth-sig-util';
import { Transaction, FetchAllOptions } from './transaction/TransactionController';
import { MessageParams } from './message-manager/MessageManager';
Expand Down Expand Up @@ -340,16 +341,20 @@ export function validateTypedSignMessageDataV3(messageData: TypedMessageParams)
export function validateTokenToWatch(token: Token) {
const { address, symbol, decimals } = token;
if (!address || !symbol || typeof decimals === 'undefined') {
throw new Error(`Cannot suggest token without address, symbol, and decimals`);
throw ethErrors.rpc.invalidParams(`Must specify address, symbol, and decimals.`);
}
if (!(symbol.length < 7)) {
throw new Error(`Invalid symbol ${symbol} more than six characters`);
if (typeof symbol !== 'string') {
Comment thread
estebanmino marked this conversation as resolved.
throw ethErrors.rpc.invalidParams(`Invalid symbol: not a string.`);
}
if (isNaN(decimals) || decimals > 36 || decimals < 0) {
throw new Error(`Invalid decimals ${decimals} must be at least 0, and not over 36`);
if (symbol.length > 6) {
throw ethErrors.rpc.invalidParams(`Invalid symbol "${symbol}": longer than 6 characters.`);
}
const numDecimals = parseInt((decimals as unknown) as string, 10);
if (isNaN(numDecimals) || numDecimals > 36 || numDecimals < 0) {
throw ethErrors.rpc.invalidParams(`Invalid decimals "${decimals}": must be 0 <= 36.`);
}
if (!isValidAddress(address)) {
throw new Error(`Invalid address ${address}`);
throw ethErrors.rpc.invalidParams(`Invalid address "${address}".`);
}
}

Expand Down
24 changes: 17 additions & 7 deletions tests/util.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -371,21 +371,31 @@ describe('util', () => {
decimals: 0,
symbol: 'TKN',
} as any),
).toThrow('Cannot suggest token without address, symbol, and decimals');
).toThrow('Must specify address, symbol, and decimals.');
expect(() =>
util.validateTokenToWatch({
address: '0x1',
decimals: 0,
symbol: undefined,
} as any),
).toThrow('Cannot suggest token without address, symbol, and decimals');
).toThrow('Must specify address, symbol, and decimals.');
expect(() =>
util.validateTokenToWatch({
address: '0x1',
decimals: undefined,
symbol: 'TKN',
} as any),
).toThrow('Cannot suggest token without address, symbol, and decimals');
).toThrow('Must specify address, symbol, and decimals.');
});

it('should throw if symbol is not a string', () => {
expect(() =>
util.validateTokenToWatch({
address: '0xe9f786dfdd9be4d57e830acb52296837765f0e5b',
decimals: 0,
symbol: { foo: 'bar' },
} as any),
).toThrow('Invalid symbol: not a string.');
});

it('should throw if symbol is more than 6 characters long', () => {
Expand All @@ -395,7 +405,7 @@ describe('util', () => {
decimals: 0,
symbol: 'TKNTKNTKN',
} as any),
).toThrow('Invalid symbol TKNTKNTKN more than six characters');
).toThrow('Invalid symbol "TKNTKNTKN": longer than 6 characters.');
});

it('should throw if invalid decimals', () => {
Expand All @@ -412,14 +422,14 @@ describe('util', () => {
decimals: 38,
symbol: 'TKN',
} as any),
).toThrow('Invalid decimals 38 must be at least 0, and not over 36');
).toThrow('Invalid decimals "38": must be 0 <= 36.');
expect(() =>
util.validateTokenToWatch({
address: '0xe9f786dfdd9be4d57e830acb52296837765f0e5b',
decimals: -1,
symbol: 'TKN',
} as any),
).toThrow('Invalid decimals -1 must be at least 0, and not over 36');
).toThrow('Invalid decimals "-1": must be 0 <= 36.');
});

it('should throw if invalid address', () => {
Expand All @@ -429,7 +439,7 @@ describe('util', () => {
decimals: 0,
symbol: 'TKN',
} as any),
).toThrow('Invalid address 0xe9');
).toThrow('Invalid address "0xe9".');
});
});

Expand Down