Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/haarts/bitcoin_bip32
A library to generate HD public and private keys according to the BIP32 specification.
https://github.com/haarts/bitcoin_bip32
Last synced: 9 days ago
JSON representation
A library to generate HD public and private keys according to the BIP32 specification.
- Host: GitHub
- URL: https://github.com/haarts/bitcoin_bip32
- Owner: haarts
- License: mit
- Created: 2018-10-30T12:52:46.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-06-30T10:32:44.000Z (over 4 years ago)
- Last Synced: 2024-03-20T13:21:05.848Z (8 months ago)
- Language: Dart
- Size: 54.7 KB
- Stars: 11
- Watchers: 6
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: COPYING
Awesome Lists containing this project
README
# BIP32
[](https://pub.dartlang.org/packages/bitcoin_bip32)
[](https://circleci.com/gh/inapay/bitcoin_bip32)
An implementation of the [BIP32 spec] for Hierarchical Deterministic Bitcoin
addresses. No [superimposing wallet structure] has been defined.
## Examples
You can use this library in two ways; one with a serialized public or private
HD key or with a hex encoded seed.
Look at the tests to see more elaborate uses.
### With a seed
```
Chain chain = Chain.seed(hex.encode(utf8.encode("some seed")));
ExtendedPrivateKey key = chain.forPath("m/0/100");
print(key);
// => xprv9ww7sMFLzJN5LhdyGB9zfhm9MAVZ8P97iTWQtVeAg2rA9MPZfJUESWe6NaSu44zz44QBjWtwH9HNfJ4vFiUwfrTCvf7AGrgYpXe17bfh2Je
```
The `key` has a field called `key` which contains a `BigInt`. This is the actual
key.
### Importing a HD private key
```
Chain chain = Chain.import("xprv9s21ZrQH143K3QTDL4LXw2F7HEK3wJUD2nW2nRk4stbPy6cq3jPPqjiChkVvvNKmPGJxWUtg6LnF5kejMRNNU3TGtRBeJgk33yuGBxrMPHi");
ExtendedPrivateKey childKey = chain.forPath("m/0/100");
```
### Importing a HD public key
```
Chain chain = Chain.import("xpub661MyMwAqRbcFtXgS5sYJABqqG9YLmC4Q1Rdap9gSE8NqtwybGhePY2gZ29ESFjqJoCu1Rupje8YtGqsefD265TMg7usUDFdp6W1EGMcet8");
ExtendedPublic childKey = chain.forPath("M/0/100");
```
The `key` has a field called `q` which contains a [`ECPoint`]. This is the actual
key.
Please note that trying to generate a private key from a public key will throw
an exception.
## Exceptions
There is a tiny chance a child key derivation fails. Please catch the
appropriate exceptions in your code.
These exceptions are:
- `KeyZero`
- `KeyBiggerThanOrder`
- `KeyInfinite`
## Installing
Add it to your `pubspec.yaml`:
```
dependencies:
bip32: ^0.1.0
```
## Licence overview
All files in this repository fall under the license specified in
[COPYING](COPYING). The project is licensed as [AGPL with a lesser
clause](https://www.gnu.org/licenses/agpl-3.0.en.html). It may be used within a
proprietary project, but the core library and any changes to it must be
published online. Source code for this library must always remain free for
everybody to access.
## Thanks
Without the guiding code of [go-bip32] and [money-tree] projects this library would have been a significantly bigger struggle.
[BIP32 spec]: https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki
[superimposing wallet structure]: https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki#specification-wallet-structure
[go-bip32]: https://github.com/tyler-smith/go-bip32/
[money-tree]: https://github.com/GemHQ/money-tree/
[`ECPoint`]: https://pub.dartlang.org/documentation/pointycastle/1.0.0-rc3/pointycastle.api.ecc/ECPoint-class.html