Go to file

Ryan X. Charles f6a8878aa2 Varint class ...will be useful in transactions. Note that we already have a primitive understanding of Varints in the BufferReader and BufferWriter classes. However, the new Varint class is a varint object which actually depends on BufferReader and BufferWriter for reading and writing varints. This class is for keeping track of the raw buffer that is read in from a buffer.		2014-09-15 15:05:54 -07:00
browser	rename bundle from privsec to bitcore	2014-09-01 14:59:42 -07:00
examples	fix bug where you can't use isForMe without payloadKeypair	2014-09-12 17:24:00 -07:00
lib	Varint class	2014-09-15 15:05:54 -07:00
test	Varint class	2014-09-15 15:05:54 -07:00
.gitignore	rename bundle from privsec to bitcore	2014-09-01 14:59:42 -07:00
LICENSE.md	refine copyright	2014-08-19 11:57:15 -07:00
README.md	also have keys and messages	2014-09-15 13:35:50 -07:00
index.js	StealthMessage	2014-09-10 14:00:53 -07:00
npm-shrinkwrap.json	npm shrinkwrap	2014-08-30 11:58:33 -07:00
package.json	add bitcoinjs contributors	2014-08-28 20:32:44 -07:00

bitcore2

Bitcore 2 is a rewrite of bitcore. It is alpha quality. It will ultimately be merged into upstream bitcore.

Our goals:

Support ease-of-use by being internally consistent. It should not be necessary to read the source code of a class or function to know how to use it. I.e., where in old bitcore a "privkey" might be anything from a buffer to a hex string to a key to a private key object, in bitcore 2 "privkey" is the same type of object always and everywhere.
Have 100% test coverage so that the library is known to be reliable.
Library objects have an interface suitable for use with a command-line interface and API, in particular having toString, fromString, toObject, fromObject methods.
All standard features of the bitcoin protocol are implemented and saved in lib/. All BIPs are correctly implemented and saved as BIPxx.js in lib/ (since that is their standard name). Any non-standard features (such as SINs and stealtha addresses) are placed in the lib/expmt/ folder and are accessible at bitcore.expmt. Once they are standardized and given a BIP, they are renamed and placed in lib/.
It is always possible to create a new object without using "new".
Compatible with browserify (i.e., using require('bitcore/lib/message') should work both in node, and be automatically work in the browser with used in conjunction with browserify).
Minimize the use of dependencies so that all code can be easily audited.
All instance methods modify the state of the object and return the object. To access the result of an instance method, you must access the object property(s) that it modifies.

Features over bitcore: