bitmessage-js/README.md

# bitmessage [![Build Status](https://travis-ci.org/bitchan/bitmessage.svg?branch=master)](https://travis-ci.org/bitchan/bitmessage)

[![NPM](https://nodei.co/npm/bitmessage.png)](https://www.npmjs.com/package/bitmessage)

JavaScript Bitmessage library for both browserify and node. The goal of this project is to implement Bitmessage protocol v3 for both platforms at the maximum possible level (we still can't create TCP connections or listen for incoming connections in the Browser but the Proof of work and crypto is fully doable).

Public library API is currently in alpha stage, breaking changes are very likely to happen.

API documentation is available [here](https://bitchan.github.io/bitmessage/docs/).

## References

* [Bitmessage wiki](https://bitmessage.org/wiki/Main_Page)
* [Protocol specification](https://bitmessage.org/wiki/Protocol_specification)
* [Whitepaper](https://bitmessage.org/bitmessage.pdf)

## Feature matrix (both Browser and Node)

- [x] Crypto
  - [x] SHA-1
  - [x] SHA-256
  - [x] SHA-512
  - [x] RIPEMD-160
  - [x] PRNG
  - [x] ECC keys manipulation
  - [x] ECDSA
  - [x] ECDH
  - [x] ECIES
  - [x] AES-256-CBC
  - [x] HMAC-SHA-256
- [x] Common structures
  - [x] message
  - [x] object
  - [x] var_int
  - [x] var_str
  - [x] var_int_list
  - [x] net_addr
  - [x] inv_vect
  - [x] encrypted
  - [x] service features
  - [x] pubkey features
- [x] Message types
  - [x] version
  - [x] verack
  - [x] addr
  - [x] inv
  - [x] getdata
  - [x] error
- [ ] Object types
  - [x] getpubkey
  - [x] pubkey
  - [ ] msg
  - [ ] broadcast
- [x] WIF
- [x] POW
- [x] High-level classes
  - [x] Address
  - [x] UserAgent
- [ ] Parse PyBitmessage configs
  - [ ] keys.dat
  - [ ] knownnodes.dat
  - [ ] messages.dat

## Feature matrix (Node.js only)

- [ ] Network
  - [ ] Bootstrap
  - [ ] Connect to the network
  - [ ] Accept connections

## Usage

### Address

```js
var Address = require("bitmessage").Address;

// Generate a new random Bitmessage identity.
var addr1 = Address.fromRandom();
console.log("New random Bitmessage address:", addr1.encode());

// Or create it from passphrase.
var addr2 = Address.fromPassphrase("test");
console.log("Deterministic Bitmessage address:", addr2.encode());
```

## License

bitmessage - JavaScript Bitmessage library

Written in 2014 by Kagami Hiiragi <kagami@genshiken.org>

To the extent possible under law, the author(s) have dedicated all copyright and related and neighboring rights to this software to the public domain worldwide. This software is distributed without any warranty.

You should have received a copy of the CC0 Public Domain Dedication along with this software. If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
Fix repo path 2014-12-17 11:08:42 +00:00			`# bitmessage [![Build Status](https://travis-ci.org/bitchan/bitmessage.svg?branch=master)](https://travis-ci.org/bitchan/bitmessage)`
Initial commit 2014-12-11 17:57:42 +00:00
Add npm image to readme 2015-01-21 00:19:35 +00:00			`[![NPM](https://nodei.co/npm/bitmessage.png)](https://www.npmjs.com/package/bitmessage)`

Readme fixes 2014-12-28 17:08:41 +00:00			`JavaScript Bitmessage library for both browserify and node. The goal of this project is to implement Bitmessage protocol v3 for both platforms at the maximum possible level (we still can't create TCP connections or listen for incoming connections in the Browser but the Proof of work and crypto is fully doable).`

			`Public library API is currently in alpha stage, breaking changes are very likely to happen.`
Add info to readme 2014-12-28 16:59:57 +00:00
Typo 2014-12-30 18:30:12 +00:00			`API documentation is available [here](https://bitchan.github.io/bitmessage/docs/).`
Documentation with jsdoc 2014-12-30 17:00:28 +00:00
Add info to readme 2014-12-28 16:59:57 +00:00			`## References`

Readme fix 2015-01-03 16:49:20 +00:00			`* [Bitmessage wiki](https://bitmessage.org/wiki/Main_Page)`
Add info to readme 2014-12-28 16:59:57 +00:00			`* [Protocol specification](https://bitmessage.org/wiki/Protocol_specification)`
			`* [Whitepaper](https://bitmessage.org/bitmessage.pdf)`

			`## Feature matrix (both Browser and Node)`

Implement inv_vect, inv 2015-01-15 21:00:27 +00:00			`- [x] Crypto`
Add SHA-1 (used for signing) 2015-01-16 15:35:40 +00:00			`- [x] SHA-1`
Add info to readme 2014-12-28 16:59:57 +00:00			`- [x] SHA-256`
Add SHA-1 (used for signing) 2015-01-16 15:35:40 +00:00			`- [x] SHA-512`
Add info to readme 2014-12-28 16:59:57 +00:00			`- [x] RIPEMD-160`
			`- [x] PRNG`
			`- [x] ECC keys manipulation`
			`- [x] ECDSA`
Newer eccrypto 2015-01-13 23:36:07 +00:00			`- [x] ECDH`
			`- [x] ECIES`
			`- [x] AES-256-CBC`
			`- [x] HMAC-SHA-256`
Encrypted encode/decode 2015-01-11 13:59:43 +00:00			`- [x] Common structures`
Constants 2015-01-04 20:59:14 +00:00			`- [x] message`
Huge commit with partial objects.getpubkey impl 2015-01-22 00:00:58 +00:00			`- [x] object`
Add info to readme 2014-12-28 16:59:57 +00:00			`- [x] var_int`
Implement var_int_list 2015-01-02 14:27:03 +00:00			`- [x] var_str`
			`- [x] var_int_list`
Implement net_addr 2015-01-05 23:32:10 +00:00			`- [x] net_addr`
Implement inv_vect, inv 2015-01-15 21:00:27 +00:00			`- [x] inv_vect`
Encrypted encode/decode 2015-01-11 13:59:43 +00:00			`- [x] encrypted`
Bitfields encoding/decoding 2015-01-04 23:40:52 +00:00			`- [x] service features`
			`- [x] pubkey features`
Implement messages.error 2015-01-16 00:08:56 +00:00			`- [x] Message types`
Implement messages.version 2015-01-15 17:13:02 +00:00			`- [x] version`
Implement messages.addr 2015-01-15 18:11:33 +00:00			`- [x] verack`
			`- [x] addr`
Implement inv_vect, inv 2015-01-15 21:00:27 +00:00			`- [x] inv`
Link getdata to inv 2015-01-15 21:07:49 +00:00			`- [x] getdata`
Implement messages.error 2015-01-16 00:08:56 +00:00			`- [x] error`
Expand feature matrix, improve consistency 2015-01-02 21:24:36 +00:00			`- [ ] Object types`
Implement getpubkey 2015-01-18 11:37:09 +00:00			`- [x] getpubkey`
Huge commit with partial objects.getpubkey impl 2015-01-22 00:00:58 +00:00			`- [x] pubkey`
Expand feature matrix, improve consistency 2015-01-02 21:24:36 +00:00			`- [ ] msg`
			`- [ ] broadcast`
			`- [x] WIF`
Do a POW (Node) 2015-01-09 21:36:42 +00:00			`- [x] POW`
Address.fromPassphrase 2015-01-18 12:34:02 +00:00			`- [x] High-level classes`
			`- [x] Address`
Link getdata to inv 2015-01-15 21:07:49 +00:00			`- [x] UserAgent`
Add info to readme 2014-12-28 16:59:57 +00:00			`- [ ] Parse PyBitmessage configs`
Readme fix 2015-01-02 21:56:54 +00:00			`- [ ] keys.dat`
			`- [ ] knownnodes.dat`
			`- [ ] messages.dat`
Add info to readme 2014-12-28 16:59:57 +00:00
Readme fixes 2014-12-28 17:08:41 +00:00			`## Feature matrix (Node.js only)`
Add info to readme 2014-12-28 16:59:57 +00:00
			`- [ ] Network`
			`- [ ] Bootstrap`
			`- [ ] Connect to the network`
			`- [ ] Accept connections`
Initial commit 2014-12-11 17:57:42 +00:00
Add usage stub 2014-12-13 18:59:48 +00:00			`## Usage`

Improve Address API 2015-01-19 12:08:56 +00:00			`### Address`

Add usage stub 2014-12-13 18:59:48 +00:00			```js
Add info to readme 2014-12-28 16:59:57 +00:00			`var Address = require("bitmessage").Address;`
Improve Address API 2015-01-19 12:08:56 +00:00
			`// Generate a new random Bitmessage identity.`
			`var addr1 = Address.fromRandom();`
			`console.log("New random Bitmessage address:", addr1.encode());`

			`// Or create it from passphrase.`
			`var addr2 = Address.fromPassphrase("test");`
			`console.log("Deterministic Bitmessage address:", addr2.encode());`
Add usage stub 2014-12-13 18:59:48 +00:00			```

Initial commit 2014-12-11 17:57:42 +00:00			`## License`

			`bitmessage - JavaScript Bitmessage library`

			`Written in 2014 by Kagami Hiiragi <kagami@genshiken.org>`

			`To the extent possible under law, the author(s) have dedicated all copyright and related and neighboring rights to this software to the public domain worldwide. This software is distributed without any warranty.`

			`You should have received a copy of the CC0 Public Domain Dedication along with this software. If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.`