feat: decouple ecpair from tiny-secp256k1 (allow injecting ecc lib) - Githubissues

bitcoinjs / ecpair

The ECPair module for bitcoinjs-lib

MIT License

17 stars 23 forks source link

feat: decouple ecpair from tiny-secp256k1 (allow injecting ecc lib) #4

Closed motorina0 closed 2 years ago

motorina0 commented 2 years ago

Closes: https://github.com/bitcoinjs/ecpair/issues/3

Summary

the changes introduced here follow the pattern from bip32
decouple ecpair from tiny-secp256k1
the ecc lib must be provided by the consumer of ecpair (see tests for details)
the TinySecp256k1Interface interface only exposes the methods required by ecpair
- testecc.ts checks the methos of TinySecp256k1Interface
the class ECPair is no longer directly exported, but instead ECPairInterface is exposed
signSchnorr() and verifySchnorr() have been added

The changes are split in 4 commits which can be cherry picked if needed.

Further comments

[x] update documentation (if this PR is approved)
not sure how/if SignerAsync is used
- signSchnorr() - has been added to this interface

junderw commented 2 years ago

Signer and SignerAsync are interfaces that are being used in bitcoinjs-lib in Psbt etc... so adding more constraints would be a breaking change and we don't want to do that.

Right now, just leave those interfaces alone. Once proper taproot is supported, we will probably add a new interface for schnorr.

junderw commented 2 years ago

linter is failing... (tslint should exclude test files tbh)

motorina0 commented 2 years ago

Updated:

[x] fix lint:tests
- did not removed it from the CI flow tough, the issues it reported were not noise
[x] remove signSchnorr() from SignerAsync
- not removed from Signer since ECPairInterface extends Signer
- adding a new method should not affect existing users
[x] update README
[x] bump version (major - since the public API changed)
[x] update dependencies to latest
- strange enough these deps were already to latest in package-lock.json

junderw commented 2 years ago

Please remove signSchnorr from Signer as well. And add it to ECPairInterface instead.

motorina0 commented 2 years ago

Please remove signSchnorr from Signer as well. And add it to ECPairInterface instead.

Done!

junderw commented 2 years ago

LGTM other than the README stuff.

motorina0 commented 2 years ago

LGTM other than the README stuff.

Great! README file code sample fixed.

junderw commented 2 years ago

Thanks a ton. Published as 2.0.0