Skip to content

Commit 6cf1b8d

Browse files
rkalisrkalis
committed
Improve error handling
- Further specified FailedTransactionError into FailedRequireError, FailedTimeCheckError, FailedSigCheckError - Export Reason enum that contains common error reasons that can be used to catch specific errors
1 parent 7602a0a commit 6cf1b8d

9 files changed

Lines changed: 188 additions & 64 deletions

File tree

‎packages/cashscript/src/Errors.ts‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,56 @@ export class FailedTransactionError extends Error {
1111
super(`Transaction failed with reason: ${reason}\n${meep}`);
1212
}
1313
}
14+
15+
export class FailedRequireError extends FailedTransactionError {}
16+
export class FailedTimeCheckError extends FailedTransactionError {}
17+
export class FailedSigCheckError extends FailedTransactionError {}
18+
19+
// TODO: Expand these reasons with non-script failures (like tx-mempool-conflict)
20+
export enum Reason {
21+
EVAL_FALSE = 'Script evaluated without error but finished with a false/empty top stack element',
22+
VERIFY = 'Script failed an OP_VERIFY operation',
23+
EQUALVERIFY = 'Script failed an OP_EQUALVERIFY operation',
24+
CHECKMULTISIGVERIFY = 'Script failed an OP_CHECKMULTISIGVERIFY operation',
25+
CHECKSIGVERIFY = 'Script failed an OP_CHECKSIGVERIFY operation',
26+
CHECKDATASIGVERIFY = 'Script failed an OP_CHECKDATASIGVERIFY operation',
27+
NUMEQUALVERIFY = 'Script failed an OP_NUMEQUALVERIFY operation',
28+
SCRIPT_SIZE = 'Script is too big',
29+
PUSH_SIZE = 'Push value size limit exceeded',
30+
OP_COUNT = 'Operation limit exceeded',
31+
STACK_SIZE = 'Stack size limit exceeded',
32+
SIG_COUNT = 'Signature count negative or greater than pubkey count',
33+
PUBKEY_COUNT = 'Pubkey count negative or limit exceeded',
34+
INVALID_OPERAND_SIZE = 'Invalid operand size',
35+
INVALID_NUMBER_RANGE = 'Given operand is not a number within the valid range [-2^31...2^31]',
36+
IMPOSSIBLE_ENCODING = 'The requested encoding is impossible to satisfy',
37+
INVALID_SPLIT_RANGE = 'Invalid OP_SPLIT range',
38+
INVALID_BIT_COUNT = 'Invalid number of bit set in OP_CHECKMULTISIG',
39+
BAD_OPCODE = 'Opcode missing or not understood',
40+
DISABLED_OPCODE = 'Attempted to use a disabled opcode',
41+
INVALID_STACK_OPERATION = 'Operation not valid with the current stack size',
42+
INVALID_ALTSTACK_OPERATION = 'Operation not valid with the current altstack size',
43+
OP_RETURN = 'OP_RETURN was encountered',
44+
UNBALANCED_CONDITIONAL = 'Invalid OP_IF construction',
45+
DIV_BY_ZERO = 'Division by zero error',
46+
MOD_BY_ZERO = 'Modulo by zero error',
47+
INVALID_BITFIELD_SIZE = 'Bitfield of unexpected size error',
48+
INVALID_BIT_RANGE = 'Bitfield\'s bit out of the expected range',
49+
NEGATIVE_LOCKTIME = 'Negative locktime',
50+
UNSATISFIED_LOCKTIME = 'Locktime requirement not satisfied',
51+
SIG_HASHTYPE = 'Signature hash type missing or not understood',
52+
SIG_DER = 'Non-canonical DER signature',
53+
MINIMALDATA = 'Data push larger than necessary',
54+
SIG_PUSHONLY = 'Only push operators allowed in signature scripts',
55+
SIG_HIGH_S = 'Non-canonical signature: S value is unnecessarily high',
56+
MINIMALIF = 'OP_IF/NOTIF argument must be minimal',
57+
SIG_NULLFAIL = 'Signature must be zero for failed CHECK(MULTI)SIG operation',
58+
SIG_BADLENGTH = 'Signature cannot be 65 bytes in CHECKMULTISIG',
59+
SIG_NONSCHNORR = 'Only Schnorr signatures allowed in this operation',
60+
DISCOURAGE_UPGRADABLE_NOPS = 'NOPx reserved for soft-fork upgrades',
61+
PUBKEYTYPE = 'Public key is neither compressed or uncompressed',
62+
CLEANSTACK = 'Script did not clean its stack',
63+
NONCOMPRESSED_PUBKEY = 'Using non-compressed public key',
64+
ILLEGAL_FORKID = 'Illegal use of SIGHASH_FORKID',
65+
MUST_USE_FORKID = 'Signature must use SIGHASH_FORKID',
66+
}

‎packages/cashscript/src/Transaction.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ import {
1919
createOpReturnOutput,
2020
getTxSizeWithoutInputs,
2121
getPreimageSize,
22+
buildError,
2223
} from './util';
2324
import { DUST_LIMIT, P2PKH_OUTPUT_SIZE } from './constants';
24-
import { FailedTransactionError } from './Errors';
2525

2626
const cramer = require('cramer-bch');
2727

@@ -67,7 +67,7 @@ export class Transaction {
6767
const txid = await this.bitbox.RawTransactions.sendRawTransaction(tx.toHex());
6868
return this.getTxDetails(txid);
6969
} catch (e) {
70-
throw new FailedTransactionError(e.error, meep(tx, inputs, this.redeemScript));
70+
throw buildError(e.error, meep(tx, inputs, this.redeemScript));
7171
}
7272
}
7373

‎packages/cashscript/src/util.ts‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,13 @@ import {
66
import { Utxo, OpReturn, OutputForBuilder } from './interfaces';
77
import { ScriptUtil, CryptoUtil } from './BITBOX';
88
import { P2PKH_OUTPUT_SIZE, VERSION_SIZE, LOCKTIME_SIZE } from './constants';
9+
import {
10+
Reason,
11+
FailedTransactionError,
12+
FailedRequireError,
13+
FailedTimeCheckError,
14+
FailedSigCheckError,
15+
} from './Errors';
916

1017
export function getInputSize(script: Buffer): number {
1118
const scriptSize = script.byteLength;
@@ -106,6 +113,31 @@ export function calculateBytesize(script: Script): number {
106113
return ScriptUtil.encode(script).byteLength;
107114
}
108115

116+
export function buildError(reason: string, meepStr: string): FailedTransactionError {
117+
const require = [
118+
Reason.EVAL_FALSE, Reason.VERIFY, Reason.EQUALVERIFY, Reason.CHECKMULTISIGVERIFY,
119+
Reason.CHECKSIGVERIFY, Reason.CHECKDATASIGVERIFY, Reason.NUMEQUALVERIFY,
120+
];
121+
const timeCheck = [Reason.NEGATIVE_LOCKTIME, Reason.UNSATISFIED_LOCKTIME];
122+
const sigCheck = [
123+
Reason.SIG_COUNT, Reason.PUBKEY_COUNT, Reason.SIG_HASHTYPE, Reason.SIG_DER,
124+
Reason.SIG_HIGH_S, Reason.SIG_NULLFAIL, Reason.SIG_BADLENGTH, Reason.SIG_NONSCHNORR,
125+
];
126+
if (toRegExp(require).test(reason)) {
127+
return new FailedRequireError(reason, meepStr);
128+
} else if (toRegExp(timeCheck).test(reason)) {
129+
return new FailedTimeCheckError(reason, meepStr);
130+
} else if (toRegExp(sigCheck).test(reason)) {
131+
return new FailedSigCheckError(reason, meepStr);
132+
} else {
133+
return new FailedTransactionError(reason, meepStr);
134+
}
135+
}
136+
137+
function toRegExp(reasons: string[]): RegExp {
138+
return new RegExp(reasons.join('|').replace(/\(/g, '\\(').replace(/\)/g, '\\)'));
139+
}
140+
109141
// ////////////////////////////////////////////////////////////////////////////
110142
// For encoding OP_RETURN data (doesn't require BIP62.3)
111143
// These functions are a mashup between those found in these libs:

‎packages/cashscript/test/Contract.test.ts‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,6 @@ describe('Contract', () => {
4343

4444
expect(() => {
4545
const artifact = Artifacts.require(path.join(__dirname, 'fixture', 'p2pkh-invalid.json'));
46-
artifact.abi = []; // TODO
4746
Contract.import(artifact);
4847
}).toThrow();
4948
});

‎packages/cashscript/test/e2e/HodlVault.test.ts‎

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import {
77
oracle,
88
} from '../fixture/vars';
99
import { getTxOutputs } from '../test-util';
10-
import { FailedTransactionError } from '../../src/Errors';
10+
import { FailedRequireError, Reason } from '../../src/Errors';
1111

1212
describe('HodlVault', () => {
1313
let hodlVault: Instance;
@@ -25,14 +25,16 @@ describe('HodlVault', () => {
2525
const to = hodlVault.address;
2626
const amount = 10000;
2727

28-
// then
28+
// when
2929
const expectPromise = expect(
3030
hodlVault.functions
3131
.spend(new Sig(alice), wrongSig, message)
3232
.send(to, amount),
3333
);
34-
await expectPromise.rejects.toThrow(FailedTransactionError);
35-
await expectPromise.rejects.toThrow('Script failed an OP_VERIFY operation');
34+
35+
// then
36+
await expectPromise.rejects.toThrow(FailedRequireError);
37+
await expectPromise.rejects.toThrow(Reason.VERIFY);
3638
});
3739

3840
it('should fail when price is too low', async () => {
@@ -42,14 +44,16 @@ describe('HodlVault', () => {
4244
const to = hodlVault.address;
4345
const amount = 10000;
4446

45-
// then
47+
// when
4648
const expectPromise = expect(
4749
hodlVault.functions
4850
.spend(new Sig(alice), oracleSig, message)
4951
.send(to, amount),
5052
);
51-
await expectPromise.rejects.toThrow(FailedTransactionError);
52-
await expectPromise.rejects.toThrow('Script failed an OP_VERIFY operation');
53+
54+
// then
55+
await expectPromise.rejects.toThrow(FailedRequireError);
56+
await expectPromise.rejects.toThrow(Reason.VERIFY);
5357
});
5458

5559
it('should succeed when price is high enough', async () => {
@@ -81,14 +85,16 @@ describe('HodlVault', () => {
8185
{ to: hodlVault.address, amount: 20000 },
8286
];
8387

84-
// then
88+
// when
8589
const expectPromise = expect(
8690
hodlVault.functions
8791
.spend(new Sig(alice), wrongSig, message)
8892
.send(outputs),
8993
);
90-
await expectPromise.rejects.toThrow(FailedTransactionError);
91-
await expectPromise.rejects.toThrow('Script failed an OP_VERIFY operation');
94+
95+
// then
96+
await expectPromise.rejects.toThrow(FailedRequireError);
97+
await expectPromise.rejects.toThrow(Reason.VERIFY);
9298
});
9399

94100
it('should fail when price is too low', async () => {
@@ -100,14 +106,16 @@ describe('HodlVault', () => {
100106
{ to: hodlVault.address, amount: 20000 },
101107
];
102108

103-
// then
109+
// when
104110
const expectPromise = expect(
105111
hodlVault.functions
106112
.spend(new Sig(alice), oracleSig, message)
107113
.send(outputs),
108114
);
109-
await expectPromise.rejects.toThrow(FailedTransactionError);
110-
await expectPromise.rejects.toThrow('Script failed an OP_VERIFY operation');
115+
116+
// then
117+
await expectPromise.rejects.toThrow(FailedRequireError);
118+
await expectPromise.rejects.toThrow(Reason.VERIFY);
111119
});
112120

113121
it('should succeed when price is high enough', async () => {

‎packages/cashscript/test/e2e/Mecenas.test.ts‎

Lines changed: 31 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import {
99
bobAddress,
1010
} from '../fixture/vars';
1111
import { getTxOutputs } from '../test-util';
12-
import { FailedTransactionError } from '../../src/Errors';
12+
import { FailedRequireError, Reason } from '../../src/Errors';
1313

1414
// Mecenas has tx.age check omitted for testing
1515
describe('Mecenas v1', () => {
@@ -26,44 +26,50 @@ describe('Mecenas v1', () => {
2626
const to = aliceAddress;
2727
const amount = pledge + 10;
2828

29-
// then
29+
// when
3030
const expectPromise = expect(
3131
mecenas.functions
3232
.receive(alicePk, new Sig(alice))
3333
.send(to, amount, { fee: 1000 }),
3434
);
35-
await expectPromise.rejects.toThrow(FailedTransactionError);
36-
await expectPromise.rejects.toThrow('Script evaluated without error but finished with a false/empty top stack element');
35+
36+
// then
37+
await expectPromise.rejects.toThrow(FailedRequireError);
38+
await expectPromise.rejects.toThrow(Reason.EVAL_FALSE);
3739
});
3840

3941
it('should fail when trying to send to wrong person', async () => {
4042
// given
4143
const to = bobAddress;
4244
const amount = pledge;
4345

44-
// then
46+
// when
4547
const expectPromise = expect(
4648
mecenas.functions
4749
.receive(alicePk, new Sig(alice))
4850
.send(to, amount, { fee: 1000 }),
4951
);
50-
await expectPromise.rejects.toThrow(FailedTransactionError);
51-
await expectPromise.rejects.toThrow('Script evaluated without error but finished with a false/empty top stack element');
52+
53+
// then
54+
await expectPromise.rejects.toThrow(FailedRequireError);
55+
await expectPromise.rejects.toThrow(Reason.EVAL_FALSE);
5256
});
5357

5458
it('should fail when trying to send to multiple people', async () => {
5559
// given
5660
const to = aliceAddress;
5761
const amount = pledge;
5862

59-
// then
63+
// when
6064
const expectPromise = expect(
6165
mecenas.functions
6266
.receive(alicePk, new Sig(alice))
6367
.send([{ to, amount }, { to, amount }], { fee: 1000 }),
6468
);
65-
await expectPromise.rejects.toThrow(FailedTransactionError);
66-
await expectPromise.rejects.toThrow('Script evaluated without error but finished with a false/empty top stack element');
69+
70+
// then
71+
await expectPromise.rejects.toThrow(FailedRequireError);
72+
await expectPromise.rejects.toThrow(Reason.EVAL_FALSE);
6773
});
6874

6975
it('should succeed when sending pledge to receiver', async () => {
@@ -98,44 +104,50 @@ describe('Mecenas', () => {
98104
const to = aliceAddress;
99105
const amount = pledge + 10;
100106

101-
// then
107+
// when
102108
const expectPromise = expect(
103109
mecenas.functions
104110
.receive(alicePk, new Sig(alice))
105111
.send(to, amount, { fee: 1000 }),
106112
);
107-
await expectPromise.rejects.toThrow(FailedTransactionError);
108-
await expectPromise.rejects.toThrow('Script failed an OP_EQUALVERIFY operation');
113+
114+
// then
115+
await expectPromise.rejects.toThrow(FailedRequireError);
116+
await expectPromise.rejects.toThrow(Reason.EQUALVERIFY);
109117
});
110118

111119
it('should fail when trying to send to wrong person', async () => {
112120
// given
113121
const to = bobAddress;
114122
const amount = pledge;
115123

116-
// then
124+
// when
117125
const expectPromise = expect(
118126
mecenas.functions
119127
.receive(alicePk, new Sig(alice))
120128
.send(to, amount, { fee: 1000 }),
121129
);
122-
await expectPromise.rejects.toThrow(FailedTransactionError);
123-
await expectPromise.rejects.toThrow('Script failed an OP_EQUALVERIFY operation');
130+
131+
// then
132+
await expectPromise.rejects.toThrow(FailedRequireError);
133+
await expectPromise.rejects.toThrow(Reason.EQUALVERIFY);
124134
});
125135

126136
it('should fail when trying to send to multiple people', async () => {
127137
// given
128138
const to = aliceAddress;
129139
const amount = pledge;
130140

131-
// then
141+
// when
132142
const expectPromise = expect(
133143
mecenas.functions
134144
.receive(alicePk, new Sig(alice))
135145
.send([{ to, amount }, { to, amount }], { fee: 1000 }),
136146
);
137-
await expectPromise.rejects.toThrow(FailedTransactionError);
138-
await expectPromise.rejects.toThrow('Script failed an OP_EQUALVERIFY operation');
147+
148+
// then
149+
await expectPromise.rejects.toThrow(FailedRequireError);
150+
await expectPromise.rejects.toThrow(Reason.EQUALVERIFY);
139151
});
140152

141153
it('should succeed when sending pledge to receiver', async () => {

‎packages/cashscript/test/e2e/P2PKH.test.ts‎

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import {
99
import { getTxOutputs } from '../test-util';
1010
import { isOpReturn } from '../../src/interfaces';
1111
import { createOpReturnOutput } from '../../src/util';
12-
import { FailedTransactionError } from '../../src/Errors';
12+
import { FailedSigCheckError, Reason } from '../../src/Errors';
1313

1414
describe('P2PKH', () => {
1515
let p2pkhInstance: Instance;
@@ -24,14 +24,16 @@ describe('P2PKH', () => {
2424
const to = p2pkhInstance.address;
2525
const amount = 10000;
2626

27-
// then TODO
27+
// when
2828
const expectPromise = expect(
2929
p2pkhInstance.functions
3030
.spend(alicePk, new Sig(bob))
3131
.send(to, amount),
3232
);
33-
await expectPromise.rejects.toThrow(FailedTransactionError);
34-
await expectPromise.rejects.toThrow('Signature must be zero for failed CHECK(MULTI)SIG operation');
33+
34+
// then
35+
await expectPromise.rejects.toThrow(FailedSigCheckError);
36+
await expectPromise.rejects.toThrow(Reason.SIG_NULLFAIL);
3537
});
3638

3739
it('should succeed when using correct function parameters', async () => {
@@ -58,14 +60,16 @@ describe('P2PKH', () => {
5860
{ to: p2pkhInstance.address, amount: 20000 },
5961
];
6062

61-
// then
63+
// when
6264
const expectPromise = expect(
6365
p2pkhInstance.functions
6466
.spend(alicePk, new Sig(bob))
6567
.send(outputs),
6668
);
67-
await expectPromise.rejects.toThrow(FailedTransactionError);
68-
await expectPromise.rejects.toThrow('Signature must be zero for failed CHECK(MULTI)SIG operation');
69+
70+
// then
71+
await expectPromise.rejects.toThrow(FailedSigCheckError);
72+
await expectPromise.rejects.toThrow(Reason.SIG_NULLFAIL);
6973
});
7074

7175
it('should succeed when using correct function parameters', async () => {

0 commit comments

Comments
 (0)