Skip to content

Commit d2c134f

Browse files
committed
Add mention of Async
1 parent 70ce332 commit d2c134f

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,12 @@ BIP38 is a standard process to encrypt Bitcoin and crypto currency private keys
2929
npm install --save bip38
3030

3131

32+
### Async methods
33+
34+
Async methods are available, but using them will be slower, but free up the event loop in intervals you choose.
35+
36+
For benchmark results, please see the section in the README of the [scryptsy](https://github.com/cryptocoinjs/scryptsy/tree/395c3b09b21e06ea4a6cc2933e046c0984a414c5#benchmarks) library. Increasing the interval will decrease the performance hit, but increase the span between event loop free ups (UI drawing etc.) promiseInterval is the last optional parameter after scryptParams. There is no recommendation currently, as the performance trade off is app specific.
37+
3238
### API
3339
### encrypt(buffer, compressed, passphrase[, progressCallback, scryptParams])
3440

@@ -67,4 +73,3 @@ console.log(wif.encode(0x80, decryptedKey.privateKey, decryptedKey.compressed))
6773
- https://github.com/casascius/Bitcoin-Address-Utility/tree/master/Model
6874
- https://github.com/nomorecoin/python-bip38-testing/blob/master/bip38.py
6975
- https://github.com/pointbiz/bitaddress.org/blob/master/src/ninja.key.js
70-

0 commit comments

Comments
 (0)