This is the first TypeScript release on the library (thanks @the-jackalope for the rewrite! ❤️), see PR #93 for the main PR here. The release comes with various breaking changes.
Libray Import / API Documentation
The way submodules are exposed has been changed along the TypeScript rewrite and you will likely have to update your imports. Here is an example for the hdkey submodule:
Together with the switch to TypeScript the previously static documentation has been automated to now being generated with TypeDoc to reflect all latest changes, see PR #98. See the new docs for an overview on the TypeScript based API.
API Changes
The API of the library hasn't been changed intentionally but has become more strict on type input by the explcit type definitions from the TypeScript code in function signatures together with the introduction of the ethereumjs-utilv7 library within the Wallet library, which behaves more strict on type input on the various utility functions.
This leads to cases where some input - while not having been the intended way to use the library - might have been worked before through implicit type conversion and is now not possible any more.
One example for this is the Wallet.fromPublicKey() function, here is the old code of the function:
Wallet.fromPublicKey = function(pub, nonStrict) {
if (nonStrict) {
pub = ethUtil.importPublic(pub)
}
return new Wallet(null, pub)
}
and here the new TypeScript code:
public static fromPublicKey(publicKey: Buffer, nonStrict: boolean = false): Wallet {
if (nonStrict) {
publicKey = importPublic(publicKey)
}
return new Wallet(undefined, publicKey)
}
This function worked in the v0.6.x version also with passing in a string, since the ethereumjs-utilv6importPublic method converted the input implicitly to a Buffer, the v1.0.0 version now directly enforces the fromPublicKey input to be a Buffer first hand.
There will likely be more cases like this in the code since the type input of the library hasn't been documented in the older version. So we recommend here to go through all your function signature usages and see if you uses the correct input types. While a bit annoying this is a one-time task you will never have to do again since you can now profit from the clear TypeScript input types being both documented and enforced by the TypeScript compiler.
Pure JS Crypto Dependencies
This library now uses pure JS crypto dependencies which doesn't bring in the need for native compilation on installation. For scrypt key derivation scrypt-js from @ricmoo is used (see PR #125).
For BIP-32 key derivation the new ethereum-cryptography library is used which is a new Ethereum Foundation backed and formally audited libray to provide pure JS cryptographic primitives within the Ethereum ecosystem (see PR #128).
Removed ProviderEngine
Support for Provider Engine has been removed for security reasons, since the package is not very actively maintained and superseded by json-rpc-engine.
If you need the removed functionality, it should be relatively easily possible to do this integration by adopting the code from provider-engine.ts.
Fixes a bug where salt, iv and/or uuid options - being supplied as strings to Wallet.toV3() - could lead to errors during encryption and/or output that could not be decrypted, PR #95