https://github.com/ferrriii/btc-address

a simple js library for generating Bitcoin paper wallet
https://github.com/ferrriii/btc-address

bitcoin js-library npm-package

Last synced: 3 days ago
JSON representation

a simple js library for generating Bitcoin paper wallet

• Host: GitHub
• URL: https://github.com/ferrriii/btc-address
• Owner: ferrriii
• License: mit
• Created: 2020-03-19T11:47:48.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-02T23:00:49.000Z (almost 2 years ago)
• Last Synced: 2024-10-31T18:59:08.211Z (18 days ago)
• Topics: bitcoin, js-library, npm-package
• Language: JavaScript
• Homepage:
• Size: 45.9 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Bitcoin Address Generator

        

a simple js library for generating Bitcoin paper wallet

## Features

* Tested

* Generates compressed WIF and Hex output

* Minimum dependencies

* Can generate prefixed addresses

## Install

```

npm install btcaddressgen

```

## Usage

```JavaScript

const BTCAddress = require('btcaddressgen')

let address = BTCAddress.generate()

console.log(address)

```

Output:

```JavaScript

{

  // private key in WIF format

  private: '5Hy5wbRdtv57RMZxhh518tV5CT8sXy8RyMH1XaiN5pDN88gC4GG',

  // public address in WIF format

  public: '1DRJZWjfxWo2Y7oaNbhP4KqRWzUAYZSAc6',

  // public address in hex

  publicHex: '03390DBDE81F0397C65681887571E1C4D9B77956A7882945D07DE90C16865D755D',

  // private address in hex

  privateHex: '13FADCE55428817FE93F5B8DEBCD8B85259527354A6DC3290D53EE2C6FE17902'

}

```

### Usage with options

You can pass an object to control address generation. Possible options are describe in below table.

| Property | Description |

| -------- | ------------ |

| privateKeyHex | If you pass a valid hex private key, it will be used to generate public key. |

| prefix | If you pass a string starting with '1', public key will be generated with this prefix. |

| prefixCaseSensitive | By default the prefix is not case-sensitive. If you want it to be case sensitive pass this property in options. |

### Examples

Generating an address for the provided private key:

```JavaScript

const BTCAddress = require('btcaddressgen')

BTCAddress.generate({ privateKeyHex: '58257552f213f449f03b3d0c7684d7bfa48cceba4f739913d28bda33ae64ac49' })

```

Generating address with prefix:

```JavaScript

const BTCAddress = require('btcaddressgen')

BTCAddress.generate({ prefix: '1omg' }) // valid addresses start with 1

```

## Test

```

npm run test

```