https://github.com/edunuzzi/go-bip44
A Golang implementation of the BIP44 for Hierarchical Deterministic (HD) addresses.
https://github.com/edunuzzi/go-bip44
bip32 bip44 bitcoin cryptocurrency golang golang-lib golang-library library
Last synced: 10 days ago
JSON representation
A Golang implementation of the BIP44 for Hierarchical Deterministic (HD) addresses.
- Host: GitHub
- URL: https://github.com/edunuzzi/go-bip44
- Owner: edunuzzi
- License: mit
- Created: 2018-04-20T17:17:20.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-10-21T17:09:21.000Z (over 3 years ago)
- Last Synced: 2024-06-21T18:14:55.512Z (over 1 year ago)
- Topics: bip32, bip44, bitcoin, cryptocurrency, golang, golang-lib, golang-library, library
- Language: Go
- Homepage:
- Size: 27.3 KB
- Stars: 25
- Watchers: 2
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Go-BIP44 (Unmaintained!!!)
[](https://goreportcard.com/report/github.com/Swipecoin/go-bip44)
A Golang implementation of the [BIP44](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) for Hierarchical Deterministic (HD) addresses.
It currently only supports Bitcoin.
Released under the terms of the [MIT LICENSE](LICENSE).
## Should I use this in production?
This library is in very early stages. Please be aware that some bugs may exist.
## Can I trust this code?
> Do not trust. Verify.
Since this lib is in its early days, we recommend every user of this library audit and verify any underlying code for its validity and suitability.
You can do so by using [this tool](https://iancoleman.io/bip39/).
## Installation
```bash
go get -u github.com/edunuzzi/go-bip44
```
## Usage
### New 24-word Mnemonic and Seed
```golang
// bitSize must be a multiple of 32
bitSize := 256
mnemonic, _ := bip44.NewMnemonic(bitSize)
seedBytes := m.NewSeed("my password")
```
### Master key From Seed Hex - (Unstable yet)
```golang
xKey, _ := bip44.NewKeyFromSeedHex("your secret seed in hex format", bip44.MAINNET)
```
### Master key From Seed bytes - (Unstable yet)
```golang
xKey, _ := bip44.NewKeyFromSeedBytes(seedBytes, bip44.MAINNET)
```
### From base58-encoded Extended Key
```golang
ak, _ := bip44.NewAccountKeyFromXPubKey(xPubKey)
externalAddress, _ := accountKey.DeriveP2PKAddress(bip44.ExternalChangeType, 0, bip44.MAINNET)
internalAddress, _ := accountKey.DeriveP2PKAddress(bip44.InternalChangeType, 0, bip44.MAINNET)
```
### Deriving P2PK addresses
| coin | account | chain | address | path |
| ------- | ------- | -------- | ------- | ------------------------- |
| Bitcoin | first | external | first | m / 44' / 0' / 0' / 0 / 0 |
```golang
xKey, _ := bip44.NewKeyFromSeedHex("your secret seed in hex format", bip44.MAINNET)
accountKey, _ := xKey.BIP44AccountKey(bip44.BitcoinCoinType, 0, true)
externalAddress, _ := accountKey.DeriveP2PKAddress(bip44.ExternalChangeType, 0, bip44.MAINNET)
```
---
| coin | account | chain | address | path |
| ------- | ------- | -------- | ------- | ------------------------- |
| Bitcoin | first | external | second | m / 44' / 0' / 0' / 0 / 1 |
```golang
xKey, _ := bip44.NewKeyFromSeedHex("your secret seed in hex format", bip44.MAINNET)
accountKey, _ := xKey.BIP44AccountKey(bip44.BitcoinCoinType, 0, true)
externalAddress, _ := accountKey.DeriveP2PKAddress(bip44.ExternalChangeType, 1, bip44.MAINNET)
```
---
| coin | account | chain | address | path |
| --------------- | -------- | -------- | ------- | ------------------------- |
| Bitcoin Testnet | second | internal | first | m / 44' / 1' / 1' / 1 / 0 |
```golang
xKey, _ := bip44.NewKeyFromSeedHex("your secret seed in hex format", bip44.TESTNET3)
accountKey, _ := xKey.BIP44AccountKey(bip44.TestnetCoinType, 1, true)
externalAddress, _ := accountKey.DeriveP2PKAddress(bip44.InternalChangeType, 0, bip44.TESTNET3)
```
## TODO
- [X] Report badge
- [ ] Unit Tests
- [ ] Create GoDoc
- [ ] Stellar
- [ ] Ethereum
## Contribution
Please feel free to contribute with both suggestions and pull requests :D