bitmessage-js/README.md

# bitmessage [![Build Status](https://travis-ci.org/bitchan/bitmessage.svg?branch=master)](https://travis-ci.org/bitchan/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)

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

## Feature matrix (Node.js only)

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

## Usage

```js
// Generate a new random Bitmessage identity.
var Address = require("bitmessage").Address;
var addr = Address.fromRandom();
console.log("New random Bitmessage address:", addr.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
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)`

			`- [ ] crypto`
			`- [x] SHA-512`
			`- [x] SHA-256`
			`- [x] RIPEMD-160`
			`- [x] PRNG`
			`- [x] ECC keys manipulation`
			`- [x] ECDSA`
			`- [ ] ECDH`
			`- [ ] ECIES`
			`- [ ] AES-256-CBC`
			`- [ ] HMAC-SHA-256`
Expand feature matrix, improve consistency 2015-01-02 21:24:36 +00:00			`- [ ] Common structures`
Constants 2015-01-04 20:59:14 +00:00			`- [x] message`
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`
Expand feature matrix, improve consistency 2015-01-02 21:24:36 +00:00			`- [ ] encrypted`
Constants 2015-01-04 20:59:14 +00:00			`- [x] message encodings`
Bitfields encoding/decoding 2015-01-04 23:40:52 +00:00			`- [x] service features`
			`- [x] pubkey features`
Expand feature matrix, improve consistency 2015-01-02 21:24:36 +00:00			`- [ ] Message types`
			`- [ ] version`
			`- [ ] verack`
			`- [ ] addr`
			`- [ ] inv`
			`- [ ] getdata`
Modules stub 2015-01-02 21:45:56 +00:00			`- [ ] error`
Expand feature matrix, improve consistency 2015-01-02 21:24:36 +00:00			`- [ ] object`
			`- [ ] Object types`
			`- [ ] getpubkey`
			`- [ ] pubkey`
			`- [ ] msg`
			`- [ ] broadcast`
			`- [x] WIF`
Do a POW (Node) 2015-01-09 21:36:42 +00:00			`- [x] POW`
Expand feature matrix, improve consistency 2015-01-02 21:24:36 +00:00			`- [ ] High-level classes`
Add info to readme 2014-12-28 16:59:57 +00:00			`- [ ] Address`
			`- [x] encode`
			`- [x] decode`
			`- [x] getRipe`
OOPify 2014-12-29 22:16:51 +00:00			`- [x] fromRandom`
			`- [ ] fromPassphrase`
Implement net_addr 2015-01-05 23:32:10 +00:00			`- [ ] UserAgent`
Add info to readme 2014-12-28 16:59:57 +00:00			`- [ ] Message`
Expand feature matrix, improve consistency 2015-01-02 21:24:36 +00:00			`- [ ] encrypt`
			`- [ ] decrypt`
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`

			```js
Do not use promises in crypto Because sha.js is faster than WebCryptoAPI for POW. 2015-01-03 14:52:27 +00:00			`// Generate a new random Bitmessage identity.`
Add info to readme 2014-12-28 16:59:57 +00:00			`var Address = require("bitmessage").Address;`
Do not use promises in crypto Because sha.js is faster than WebCryptoAPI for POW. 2015-01-03 14:52:27 +00:00			`var addr = Address.fromRandom();`
			`console.log("New random Bitmessage address:", addr.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/>.`