Bitmessage/bitmessage-js
2
0
Fork 1
Code Issues 1 Pull Requests 1 Actions Packages Releases Activity
JavaScript Bitmessage library
172 Commits 3 Branches 0 Tags 1,010 KiB
JavaScript 95.7%
C++ 3.1%
Python 0.8%
C 0.2%
Dockerfile 0.1%
Other 0.1%
782b7e7d27
Go to file
Kagami Hiiragi 782b7e7d27 docs: structs
2015-02-11 15:18:38 +03:00
lib docs: structs 2015-02-11 15:18:38 +03:00
src Do not use designated initializers 2015-01-31 00:28:42 +03:00
tests Accept Buffer on UserAgent.encode 2015-02-10 17:39:01 +03:00
.gitignore Use webworkify 2015-01-10 16:00:08 +03:00
.jshintignore Use webworkify 2015-01-10 16:00:08 +03:00
.jshintrc Implement address decoding 2014-12-18 19:47:18 +03:00
.npmignore Use webworkify 2015-01-10 16:00:08 +03:00
.travis.yml Fix installing firefox on travis 2014-12-18 23:34:45 +03:00
binding.gyp Fix for nan 1.5 2015-01-15 01:07:03 +03:00
COPYING Initial commit 2014-12-11 20:59:48 +03:00
jsdoc.json Documentation with jsdoc 2014-12-30 20:00:28 +03:00
karma.conf.js Functional tests stub 2015-02-02 18:30:05 +03:00
package.json docs: use optional instead of nullable 2015-02-10 21:23:20 +03:00
README.md WebSocket transport 2015-02-10 00:56:55 +03:00

README.md

bitmessage Build Status

NPM

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.

References

Feature matrix

  • Crypto
    • SHA-1
    • SHA-256
    • SHA-512
    • RIPEMD-160
    • PRNG
    • ECC keys manipulation
    • ECDSA
    • ECDH
    • ECIES
  • Common structures
    • message
    • object
    • var_int
    • var_str
    • var_int_list
    • net_addr
    • inv_vect
    • encrypted
    • service features
    • pubkey features
  • Message types
    • version
    • verack
    • addr
    • inv
    • getdata
    • error
  • Object types
    • getpubkey
    • pubkey
    • msg
    • broadcast
  • WIF
  • POW
  • High-level classes
    • Address
    • UserAgent
  • Network transports
    • TCP (Node.js only)
    • WebSocket
    • WebRTC
  • Parse PyBitmessage configs
    • keys.dat
    • knownnodes.dat
    • messages.dat

Usage

Address

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-2015 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/.