Skip to content

Commit bbf5cda

Browse files
motorina0motorina0
authored
refactor: add explicit initialisation of the ecc library (#5)
* refactor: explicit initialization on the ecc library - remove optional `eccLib` parameter for `p2tr` and `psbt`
1 parent 6ea2f8b commit bbf5cda

File tree

22 files changed

+184
-224
lines changed

22 files changed

+184
-224
lines changed

‎src/address.d.ts‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
/// <reference types="node" />
22
import { Network } from './networks';
3-
import { TinySecp256k1Interface } from './types';
43
export interface Base58CheckResult {
54
hash: Buffer;
65
version: number;
@@ -14,5 +13,5 @@ export declare function fromBase58Check(address: string): Base58CheckResult;
1413
export declare function fromBech32(address: string): Bech32Result;
1514
export declare function toBase58Check(hash: Buffer, version: number): string;
1615
export declare function toBech32(data: Buffer, version: number, prefix: string): string;
17-
export declare function fromOutputScript(output: Buffer, network?: Network, eccLib?: TinySecp256k1Interface): string;
18-
export declare function toOutputScript(address: string, network?: Network, eccLib?: TinySecp256k1Interface): Buffer;
16+
export declare function fromOutputScript(output: Buffer, network?: Network): string;
17+
export declare function toOutputScript(address: string, network?: Network): Buffer;

‎src/address.js‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ function toBech32(data, version, prefix) {
8686
: bech32_1.bech32m.encode(prefix, words);
8787
}
8888
exports.toBech32 = toBech32;
89-
function fromOutputScript(output, network, eccLib) {
89+
function fromOutputScript(output, network) {
9090
// TODO: Network
9191
network = network || networks.bitcoin;
9292
try {
@@ -102,15 +102,15 @@ function fromOutputScript(output, network, eccLib) {
102102
return payments.p2wsh({ output, network }).address;
103103
} catch (e) {}
104104
try {
105-
if (eccLib) return payments.p2tr({ output, network }, { eccLib }).address;
105+
return payments.p2tr({ output, network }).address;
106106
} catch (e) {}
107107
try {
108108
return _toFutureSegwitAddress(output, network);
109109
} catch (e) {}
110110
throw new Error(bscript.toASM(output) + ' has no matching Address');
111111
}
112112
exports.fromOutputScript = fromOutputScript;
113-
function toOutputScript(address, network, eccLib) {
113+
function toOutputScript(address, network) {
114114
network = network || networks.bitcoin;
115115
let decodeBase58;
116116
let decodeBech32;
@@ -135,9 +135,8 @@ function toOutputScript(address, network, eccLib) {
135135
if (decodeBech32.data.length === 32)
136136
return payments.p2wsh({ hash: decodeBech32.data }).output;
137137
} else if (decodeBech32.version === 1) {
138-
if (decodeBech32.data.length === 32 && eccLib)
139-
return payments.p2tr({ pubkey: decodeBech32.data }, { eccLib })
140-
.output;
138+
if (decodeBech32.data.length === 32)
139+
return payments.p2tr({ pubkey: decodeBech32.data }).output;
141140
} else if (
142141
decodeBech32.version >= FUTURE_SEGWIT_MIN_VERSION &&
143142
decodeBech32.version <= FUTURE_SEGWIT_MAX_VERSION &&

‎src/ecc_lib.d.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import { TinySecp256k1Interface } from './types';
2+
export declare function initEccLib(eccLib: TinySecp256k1Interface | undefined): void;
3+
export declare function getEccLib(): TinySecp256k1Interface;

‎src/payments/verifyecc.js‎ renamed to ‎src/ecc_lib.js‎

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
11
'use strict';
22
Object.defineProperty(exports, '__esModule', { value: true });
3-
exports.verifyEcc = void 0;
3+
exports.getEccLib = exports.initEccLib = void 0;
4+
const _ECCLIB_CACHE = {};
5+
function initEccLib(eccLib) {
6+
if (!eccLib) {
7+
// allow clearing the library
8+
_ECCLIB_CACHE.eccLib = eccLib;
9+
} else if (eccLib !== _ECCLIB_CACHE.eccLib) {
10+
// new instance, verify it
11+
verifyEcc(eccLib);
12+
_ECCLIB_CACHE.eccLib = eccLib;
13+
}
14+
}
15+
exports.initEccLib = initEccLib;
16+
function getEccLib() {
17+
if (!_ECCLIB_CACHE.eccLib)
18+
throw new Error(
19+
'No ECC Library provided. You must call initEccLib() with a valid TinySecp256k1Interface instance',
20+
);
21+
return _ECCLIB_CACHE.eccLib;
22+
}
23+
exports.getEccLib = getEccLib;
424
const h = hex => Buffer.from(hex, 'hex');
525
function verifyEcc(ecc) {
626
assert(typeof ecc.isXOnlyPoint === 'function');
@@ -46,7 +66,6 @@ function verifyEcc(ecc) {
4666
}
4767
});
4868
}
49-
exports.verifyEcc = verifyEcc;
5069
function assert(bool) {
5170
if (!bool) throw new Error('ecc library invalid');
5271
}

‎src/index.d.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,4 @@ export { Transaction } from './transaction';
1212
export { Network } from './networks';
1313
export { Payment, PaymentCreator, PaymentOpts, Stack, StackElement, } from './payments';
1414
export { Input as TxInput, Output as TxOutput } from './transaction';
15+
export { initEccLib } from './ecc_lib';

‎src/index.js‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
'use strict';
22
Object.defineProperty(exports, '__esModule', { value: true });
3-
exports.Transaction = exports.opcodes = exports.Psbt = exports.Block = exports.script = exports.payments = exports.networks = exports.crypto = exports.address = void 0;
3+
exports.initEccLib = exports.Transaction = exports.opcodes = exports.Psbt = exports.Block = exports.script = exports.payments = exports.networks = exports.crypto = exports.address = void 0;
44
const address = require('./address');
55
exports.address = address;
66
const crypto = require('./crypto');
@@ -39,3 +39,10 @@ Object.defineProperty(exports, 'Transaction', {
3939
return transaction_1.Transaction;
4040
},
4141
});
42+
var ecc_lib_1 = require('./ecc_lib');
43+
Object.defineProperty(exports, 'initEccLib', {
44+
enumerable: true,
45+
get: function() {
46+
return ecc_lib_1.initEccLib;
47+
},
48+
});

‎src/payments/index.d.ts‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/// <reference types="node" />
22
import { Network } from '../networks';
3-
import { TinySecp256k1Interface, Taptree } from '../types';
3+
import { Taptree } from '../types';
44
import { p2data as embed } from './embed';
55
import { p2ms } from './p2ms';
66
import { p2pk } from './p2pk';
@@ -34,7 +34,6 @@ export declare type PaymentFunction = () => Payment;
3434
export interface PaymentOpts {
3535
validate?: boolean;
3636
allowIncomplete?: boolean;
37-
eccLib?: TinySecp256k1Interface;
3837
}
3938
export declare type StackElement = Buffer | number;
4039
export declare type Stack = StackElement[];

‎src/payments/p2tr.js‎

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ const buffer_1 = require('buffer');
55
const networks_1 = require('../networks');
66
const bscript = require('../script');
77
const types_1 = require('../types');
8+
const ecc_lib_1 = require('../ecc_lib');
89
const taprootutils_1 = require('./taprootutils');
910
const lazy = require('./lazy');
1011
const bech32_1 = require('bech32');
11-
const verifyecc_1 = require('./verifyecc');
1212
const OPS = bscript.OPS;
1313
const TAPROOT_WITNESS_VERSION = 0x01;
1414
const ANNEX_PREFIX = 0x50;
@@ -22,11 +22,6 @@ function p2tr(a, opts) {
2222
)
2323
throw new TypeError('Not enough data');
2424
opts = Object.assign({ validate: true }, opts || {});
25-
const _ecc = lazy.value(() => {
26-
if (!opts.eccLib) throw new Error('ECC Library is missing for p2tr.');
27-
(0, verifyecc_1.verifyEcc)(opts.eccLib);
28-
return opts.eccLib;
29-
});
3025
(0, types_1.typeforce)(
3126
{
3227
address: types_1.typeforce.maybe(types_1.typeforce.String),
@@ -132,7 +127,7 @@ function p2tr(a, opts) {
132127
if (a.output) return a.output.slice(2);
133128
if (a.address) return _address().data;
134129
if (o.internalPubkey) {
135-
const tweakedKey = tweakKey(o.internalPubkey, o.hash, _ecc());
130+
const tweakedKey = tweakKey(o.internalPubkey, o.hash);
136131
if (tweakedKey) return tweakedKey.x;
137132
}
138133
});
@@ -157,7 +152,7 @@ function p2tr(a, opts) {
157152
});
158153
const path = (0, taprootutils_1.findScriptPath)(hashTree, leafHash);
159154
if (!path) return;
160-
const outputKey = tweakKey(a.internalPubkey, hashTree.hash, _ecc());
155+
const outputKey = tweakKey(a.internalPubkey, hashTree.hash);
161156
if (!outputKey) return;
162157
const controlBock = buffer_1.Buffer.concat(
163158
[
@@ -198,13 +193,13 @@ function p2tr(a, opts) {
198193
else pubkey = a.output.slice(2);
199194
}
200195
if (a.internalPubkey) {
201-
const tweakedKey = tweakKey(a.internalPubkey, o.hash, _ecc());
196+
const tweakedKey = tweakKey(a.internalPubkey, o.hash);
202197
if (pubkey.length > 0 && !pubkey.equals(tweakedKey.x))
203198
throw new TypeError('Pubkey mismatch');
204199
else pubkey = tweakedKey.x;
205200
}
206201
if (pubkey && pubkey.length) {
207-
if (!_ecc().isXOnlyPoint(pubkey))
202+
if (!(0, ecc_lib_1.getEccLib)().isXOnlyPoint(pubkey))
208203
throw new TypeError('Invalid pubkey for p2tr');
209204
}
210205
const hashTree = _hashTree();
@@ -267,7 +262,7 @@ function p2tr(a, opts) {
267262
const internalPubkey = controlBlock.slice(1, 33);
268263
if (a.internalPubkey && !a.internalPubkey.equals(internalPubkey))
269264
throw new TypeError('Internal pubkey mismatch');
270-
if (!_ecc().isXOnlyPoint(internalPubkey))
265+
if (!(0, ecc_lib_1.getEccLib)().isXOnlyPoint(internalPubkey))
271266
throw new TypeError('Invalid internalPubkey for p2tr witness');
272267
const leafVersion = controlBlock[0] & types_1.TAPLEAF_VERSION_MASK;
273268
const script = witness[witness.length - 2];
@@ -279,7 +274,7 @@ function p2tr(a, opts) {
279274
controlBlock,
280275
leafHash,
281276
);
282-
const outputKey = tweakKey(internalPubkey, hash, _ecc());
277+
const outputKey = tweakKey(internalPubkey, hash);
283278
if (!outputKey)
284279
// todo: needs test data
285280
throw new TypeError('Invalid outputKey for p2tr witness');
@@ -293,12 +288,12 @@ function p2tr(a, opts) {
293288
return Object.assign(o, a);
294289
}
295290
exports.p2tr = p2tr;
296-
function tweakKey(pubKey, h, eccLib) {
291+
function tweakKey(pubKey, h) {
297292
if (!buffer_1.Buffer.isBuffer(pubKey)) return null;
298293
if (pubKey.length !== 32) return null;
299294
if (h && h.length !== 32) return null;
300295
const tweakHash = (0, taprootutils_1.tapTweakHash)(pubKey, h);
301-
const res = eccLib.xOnlyPointAddTweak(pubKey, tweakHash);
296+
const res = (0, ecc_lib_1.getEccLib)().xOnlyPointAddTweak(pubKey, tweakHash);
302297
if (!res || res.xOnlyPubkey === null) return null;
303298
return {
304299
parity: res.parity,

‎src/payments/verifyecc.d.ts‎

Lines changed: 0 additions & 2 deletions
This file was deleted.

‎src/psbt.d.ts‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ import { Psbt as PsbtBase } from 'bip174';
33
import { KeyValue, PsbtGlobalUpdate, PsbtInput, PsbtInputUpdate, PsbtOutput, PsbtOutputUpdate } from 'bip174/src/lib/interfaces';
44
import { Network } from './networks';
55
import { Transaction } from './transaction';
6-
import { TinySecp256k1Interface } from './types';
76
export interface TransactionInput {
87
hash: string | Buffer;
98
index: number;
@@ -111,7 +110,6 @@ export declare class Psbt {
111110
interface PsbtOptsOptional {
112111
network?: Network;
113112
maximumFeeRate?: number;
114-
eccLib?: TinySecp256k1Interface;
115113
}
116114
interface PsbtInputExtended extends PsbtInput, TransactionInput {
117115
}
@@ -181,8 +179,7 @@ script: Buffer, // The "meaningful" locking script Buffer (redeemScript for P2SH
181179
isSegwit: boolean, // Is it segwit?
182180
isTapscript: boolean, // Is taproot script path?
183181
isP2SH: boolean, // Is it P2SH?
184-
isP2WSH: boolean, // Is it P2WSH?
185-
eccLib?: TinySecp256k1Interface) => {
182+
isP2WSH: boolean) => {
186183
finalScriptSig: Buffer | undefined;
187184
finalScriptWitness: Buffer | Buffer[] | undefined;
188185
};

0 commit comments

Comments
 (0)