crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

@0x/utils: Make decoding of unknown selectors to RawRevertError optional.

Browse Source
This commit is contained in:
Lawrence Forman
2019-08-28 00:10:20 -04:00
committed by Lawrence Forman
parent f71484c9f0
commit 0542c70d22
3 changed files with 15 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
packages/utils/CHANGELOG.json
View File

@@ -15,7 +15,7 @@
"pr": "TODO"
},
{
"note": "Make `RevertError.decode()` return a `RawRevertError` if the selector is unknown.",
"note": "Make `RevertError.decode()` optionally return a `RawRevertError` if the selector is unknown.",
"pr": "TODO"
}
]

20
packages/utils/src/revert_error.ts
View File

@@ -35,23 +35,25 @@ export function registerRevertErrorType(revertClass: RevertErrorType): void {
* Decode an ABI encoded revert error.
* Throws if the data cannot be decoded as a known RevertError type.
* @param bytes The ABI encoded revert error. Either a hex string or a Buffer.
* @param coerce Coerce unknown selectors into a `RawRevertError` type.
* @return A RevertError object.
*/
export function decodeBytesAsRevertError(bytes: string | Buffer): RevertError {
return RevertError.decode(bytes);
export function decodeBytesAsRevertError(bytes: string | Buffer, coerce: boolean = false): RevertError {
return RevertError.decode(bytes, coerce);
}
/**
* Decode a thrown error.
* Throws if the data cannot be decoded as a known RevertError type.
* @param error Any thrown error.
* @param coerce Coerce unknown selectors into a `RawRevertError` type.
* @return A RevertError object.
*/
export function decodeThrownErrorAsRevertError(error: Error): RevertError {
export function decodeThrownErrorAsRevertError(error: Error, coerce: boolean = false): RevertError {
if (error instanceof RevertError) {
return error;
}
return RevertError.decode(getThrownErrorRevertErrorBytes(error));
return RevertError.decode(getThrownErrorRevertErrorBytes(error), coerce);
}
/**
@@ -64,7 +66,7 @@ export function coerceThrownErrorAsRevertError(error: Error): RevertError {
return error;
}
try {
return decodeThrownErrorAsRevertError(error);
return decodeThrownErrorAsRevertError(error, true);
} catch (err) {
if (isGanacheTransactionRevertError(error)) {
throw err;
@@ -94,14 +96,18 @@ export abstract class RevertError extends Error {
* Decode an ABI encoded revert error.
* Throws if the data cannot be decoded as a known RevertError type.
* @param bytes The ABI encoded revert error. Either a hex string or a Buffer.
* @param coerce Whether to coerce unknown selectors into a `RawRevertError` type.
* @return A RevertError object.
*/
public static decode(bytes: string | Buffer): RevertError {
public static decode(bytes: string | Buffer, coerce: boolean = false): RevertError {
const _bytes = bytes instanceof Buffer ? ethUtil.bufferToHex(bytes) : ethUtil.addHexPrefix(bytes);
// tslint:disable-next-line: custom-no-magic-numbers
const selector = _bytes.slice(2, 10);
if (!(selector in RevertError._typeRegistry)) {
return new RawRevertError(bytes);
if (coerce) {
return new RawRevertError(bytes);
}
throw new Error(`Unknown selector: ${selector}`);
}
const { type, decoder } = RevertError._typeRegistry[selector];
const instance = new type();

2
packages/utils/test/revert_error_test.ts
View File

@@ -150,7 +150,7 @@ describe('RevertError', () => {
});
it('should decode an unknown selector as a `RawRevertError`', () => {
const _encoded = encoded.substr(0, 2) + '00' + encoded.substr(4);
const decoded = RevertError.decode(_encoded);
const decoded = RevertError.decode(_encoded, true);
expect(decoded instanceof RawRevertError).to.be.true();
});
it('should fail to decode a malformed ABI encoded revert error', () => {