BTCPrivate
/
bitcore
mirror of https://github.com/BTCPrivate/bitcore.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #836 from braydonf/docs/proof-read 

Documentation Proofread
This commit is contained in:
Manuel Aráoz 2014-12-22 15:32:13 -03:00
parent 5b2ba0971a 3255cef96b
commit fec66dfffa
23 changed files with 90 additions and 212 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -3,6 +3,7 @@ coverage
node_modules node_modules
browser/bitcore.js browser/bitcore.js
browser/tests.js browser/tests.js
docs/api
lib/errors/index.js lib/errors/index.js

127
CONTRIBUTING.md
View File

@ -1,14 +1,9 @@
Contributing to Bitcore Contributing to Bitcore
======= =======
We're working hard to make *bitcore* the easier and most powerful javascript We're working hard to make *bitcore* the most powerful JavaScript library for working with bitcoin. Our goal is to have *bitcore* be a library that can be used by anyone interested in bitcoin, and to level expertise differences with great design and documentation.
library for working with bitcoin. Our goal is to have *bitcore* be a library
that can be used by anyone interested on bitcoin, and level the expertise
differences with a great design and documentation.
We have a pretty strict set of guidelines for contributing. ## Quick Checklist
## Quick checklist
Make sure: Make sure:
@ -18,83 +13,59 @@ Make sure:
## Design Guidelines ## Design Guidelines
These are some global design goals in bitcore that any change must adhere to. These are some global design goals in bitcore that any change must adhere.
### D1 - Naming Matters ### D1 - Naming Matters
We take our time with picking names. Code is going to be written once, and read We take our time with picking names. Code is going to be written once, and read hundreds of times.
hundreds of times.
We were inspired to name this rule first due to Uncle Bob's great work *Clean We were inspired to name this rule first due to Uncle Bob's great work *Clean Code*, which has a whole chapter on this subject.
Code*, which has a whole chapter on this subject.
In particular, you may notice that some names in this library are quite long In particular, you may notice that some names in this library are quite long for the average JavaScript user. That's because we prefer a long but comprehensible name than an abbreviation that might confuse new users.
for the average javascript user. That's because we better have a long but
comprehensible name rather than an abbreviation that might confuse new users.
### D2 - Tests ### D2 - Tests
Write a test for all your code. We encourage Test Driven Development so we know Write a test for all your code. We encourage Test Driven Development so we know when our code is right. We have increased test coverage from 80% to around 95% and are targeting 100% as we move towards our 1.0 release.
when our code is right. We migrated from our original code base with a 80% test
coverage and are targeting 100% as we move towards our 1.0 release.
### D3 - Robustness Principle ### D3 - Robustness Principle
*Be conservative in what you send, be liberal in what you accept.* *Be conservative in what you send, be liberal in what you accept.*
Interfaces accept as much types of arguments as possible, so there's no mental Interfaces should accept as many types of arguments as possible, so there's no mental tax on using them: we want to avoid questions such as "should I use a string here or a buffer?", "what happens if I'm not sure if the type of this variable is an Address instance or a string with it encoded in base-58?" or "what kind of object will I receive after calling this function?".
tax on using them: we want to avoid questions such as "should I use a string
here or a buffer?", "what happens if I'm not sure if the type of this variable
is an Address instance or a string with it encoded in base-58?" or "what kind
of object will I receive after calling this function?".
Accept a wide variety of usages and arguments, always return an internal kind Accept a wide variety of use cases and arguments, always return an internal form of an object. For example, the class `PublicKey` can accept strings or buffers with a DER encoded public key (either compressed or uncompressed), another PublicKey, a PrivateKey, or a Point, an instance of the `elliptic.js` library with the point in bitcoin's elliptic curve that represents the public key.
of object. For example, the class `PublicKey` can accept strings or buffers
with a DER encoded public key (either compressed or uncompressed), another
PublicKey, a PrivateKey, or a Point, an instance of the `elliptic.js` library
with the point in bitcoin's elliptic curve that represents the public key.
### D4 - Consistency Everywhere ### D4 - Consistency Everywhere
Consistency on the way classes are used is paramount to allow an easier Consistency on the way classes are used is paramount to allow an easier understanding of the library.
understanding of the library.
## Style Guidelines ## Style Guidelines
The design guidelines have quite a high abstraction level. These style The design guidelines have quite a high abstraction level. These style guidelines are more concrete and easier to apply, and also more opinionated. The design guidelines mentioned above are the way we think about general software development and we believe they should be present in any software project.
guidelines are easier to detect and apply, and also more opinionated (the
design guidelines mentioned above are the way we think about general software
development and we believe they should be present on any software project).
### G0 - General: Default to felixge's style guide ### G0 - General: Default to Felixge's Style Guide
Follow this Node.js style guide: https://github.com/felixge/node-style-guide#nodejs-style-guide Follow this Node.js Style Guide: https://github.com/felixge/node-style-guide#nodejs-style-guide
### G1 - General: No Magic Numbers ### G1 - General: No Magic Numbers
Avoid constants in the code as much as possible. Magic strings are also magic Avoid constants in the code as much as possible. Magic strings are also magic numbers.
numbers.
### G2 - General: Internal Objects should be Instances ### G2 - General: Internal Objects should be Instances
If a class has a `publicKey` member, for instance, that should be a `PublicKey` If a class has a `publicKey` member, for instance, that should be a `PublicKey` instance.
instance.
### G3 - General: Internal amounts must be integers representing Satoshis ### G3 - General: Internal amounts must be integers representing Satoshis
Avoid representation errors by always dealing with satoshis. For conversion for Avoid representation errors by always dealing with satoshis. For conversion for frontends, use the `Unit` class.
frontends, use the `Unit` class.
### G4 - General: Internal network references must be Network instances ### G4 - General: Internal network references must be Network instances
A special case for [G2](#g2---general-internal-objects-should-be-instances) all A special case for [G2](#g2---general-internal-objects-should-be-instances) all network references must be `Network` instances (see `lib/network.js`), but when returned to the user, its `.name` property should be used.
network references must be `Network` instances (see `lib/network.js`), but when
returned to the user, its `.name` property should be used.
### G5 - General: Objects should display nicely in the console ### G5 - General: Objects should display nicely in the console
Write a `.inspect()` method so an instance can be easily debugged in the Write a `.inspect()` method so an instance can be easily debugged in the console.
console.
### G6 - General: Naming Utility Namespaces ### G6 - General: Naming Utility Namespaces
@ -127,27 +98,18 @@ These should have a matching static method that can be used for instantiation:
We've designed a structure for Errors to follow and are slowly migrating to it. We've designed a structure for Errors to follow and are slowly migrating to it.
Usage: Usage:
* Errors are generated in the file `lib/errors/index.js` by invoking `gulp * Errors are generated in the file `lib/errors/index.js` by invoking `gulp errors`.
errors`.
* The specification for errors is written in the `lib/errors/spec.js` file. * The specification for errors is written in the `lib/errors/spec.js` file.
* Whenever a new class is created, add a generic error for that class in * Whenever a new class is created, add a generic error for that class in `lib/errors/spec.js`.
`lib/errors/spec.js`. * Specific errors for that class should subclass that error. Take a look at the structure in `lib/errors/spec.js`, it should be clear how subclasses are generated from that file.
* Specific errors for that class should subclass that error. Take a look at the
structure in `lib/errors/spec.js`, it should be clear how subclasses are
generated from that file.
### E2 - Errors: Provide a getValidationError static method for classes
### E2 - Errors: Provide a `getValidationError` static method for classes
### I1 - Interface: Make Code that Fails Early ### I1 - Interface: Make Code that Fails Early
In order to deal with javascript's weak typing and confusing errors, we ask our In order to deal with JavaScript's weak typing and confusing errors, we ask our code to fail as soon as possible when an unexpected input was provided.
code to fail as soon as possible when an unexpected input was provided.
There's a module called `util/preconditions`, loosely based on There's a module called `util/preconditions`, loosely based on `preconditions.js`, based on `guava`, that we use for state and argument checking. It should be trivial to use. We recommend using it on all methods, in order to improve robustness and consistency.
`preconditions.js`, based on `guava`, that we use for state and argument
checking. It should be trivial to use. We recommend using it on all methods, in
order to improve robustness and consistency.
```javascript ```javascript
$.checkState(something === anotherthing, 'Expected something to be anotherthing'); $.checkState(something === anotherthing, 'Expected something to be anotherthing');
@ -158,15 +120,11 @@ $.checkArgumentType(something, PrivateKey); // but it's optional (will show up a
### I2 - Interface: Permissive Constructors ### I2 - Interface: Permissive Constructors
Most classes have static methods named `fromBuffer`, `fromString`, `fromJSON`. Most classes have static methods named `fromBuffer`, `fromString`, `fromJSON`. Whenever one of those methods is provided, the constructor for that class should also be able to detect the type of the arguments and call the appropriate method.
Whenever one of those methods is provided, the constructor for that class
should also be able to detect the type of the arguments and call the
appropriate method.
### I3 - Interface: Method Chaining ### I3 - Interface: Method Chaining
For classes that have a mutable state, most of the methods that can be chained For classes that have a mutable state, most of the methods that can be chained *SHOULD* be chained, allowing for interfaces that read well, like:
*SHOULD* be chained, allowing for interfaces that read well, like:
```javascript ```javascript
var transaction = new Transaction() var transaction = new Transaction()
@ -200,8 +158,7 @@ function ImmutableClass(arg) {
### I5 - Interface: No new keyword for Constructors ### I5 - Interface: No new keyword for Constructors
Constructors should not require to be called with `new`. This rule is not Constructors should not require to be called with `new`. This rule is not heavily enforced, but is a "nice to have".
heavily enforced, but is a "nice to have".
```javascript ```javascript
function NoNewRequired(args) { function NoNewRequired(args) {
@ -214,23 +171,17 @@ function NoNewRequired(args) {
### T1 - Testing: Tests Must be Written Elegantly ### T1 - Testing: Tests Must be Written Elegantly
Style guidelines are not relaxed for tests. Tests are a good way to show how to Style guidelines are not relaxed for tests. Tests are a good way to show how to use the library, and maintaining them is extremely necessary.
use the library, and maintaining them is extremely necessary.
Don't write long tests, write helper functions to make them be as short and Don't write long tests, write helper functions to make them be as short and concise as possible (they should take just a few lines each), and use good variable names.
concise as possible (they should take just a few lines each), and use good
variable names.
### T2 - Testing: Tests Must not be Random ### T2 - Testing: Tests Must not be Random
Inputs for tests should not be generated randomly. Also, the type and structure Inputs for tests should not be generated randomly. Also, the type and structure of outputs should be checked.
of outputs should be checked.
### T3 - Testing: Require 'bitcore' and look up classes from there ### T3 - Testing: Require 'bitcore' and look up classes from there
This helps to make tests more useful as examples, and more independent of where This helps to make tests more useful as examples, and more independent of where they are placed. This also helps prevent forgetting to include all submodules in the bitcore object.
they are placed. This also helps prevent forgetting to include all submodules
in the bitcore object.
DO: DO:
```javascript ```javascript
@ -244,9 +195,7 @@ var PublicKey = require('../lib/publickey');
## Pull Request Workflow ## Pull Request Workflow
Our workflow is based on GitHub's pull requests. We use feature branches, Our workflow is based on GitHub's pull requests. We use feature branches, prepended with: `test`, `feature`, `fix`, `refactor`, or `remove` according to the change the branch introduces. Some examples for such branches are:
prepended with: `test`, `feature`, `fix`, `refactor`, or `remove` according to
the change the branch introduces. Some examples for such branches are:
```sh ```sh
git checkout -b test/some-module git checkout -b test/some-module
git checkout -b feature/some-new-stuff git checkout -b feature/some-new-stuff
@ -260,8 +209,7 @@ git remote add bitpay git@github.com:bitpay/bitcore.git
git pull --rebase bitpay master git pull --rebase bitpay master
``` ```
Note that we require rebasing your branch instead of mergeing it, for commit Note that we require rebasing your branch instead of merging it, for commit readability reasons.
readability reasons.
After that, you can push the changes to your fork, by doing: After that, you can push the changes to your fork, by doing:
```sh ```sh
@ -269,14 +217,9 @@ git push origin your_branch_name
git push origin feature/some-new-stuff git push origin feature/some-new-stuff
git push origin fix/some-bug git push origin fix/some-bug
``` ```
Finally go to [github.com/bitpay/bitcore](https://github.com/bitpay/bitcore) in Finally go to [github.com/bitpay/bitcore](https://github.com/bitpay/bitcore) in your web browser and issue a new pull request.
your web browser and issue a new pull request.
Main contributors will review your code and possibly ask for changes before Main contributors will review your code and possibly ask for changes before your code is pulled in to the main repository. We'll check that all tests pass, review the coding style, and check for general code correctness. If everything is OK, we'll merge your pull request and your code will be part of bitcore.
your code is pulled in to the main repository. We'll check that all tests
pass, review the coding style, and check for general code correctness. If
everything is OK, we'll merge your pull request and your code will be part of
bitcore.
If you have any questions feel free to post them to If you have any questions feel free to post them to
[github.com/bitpay/bitcore/issues](https://github.com/bitpay/bitcore/issues). [github.com/bitpay/bitcore/issues](https://github.com/bitpay/bitcore/issues).

8
README.md
View File

@ -5,7 +5,7 @@ Bitcore
[![Build Status](https://img.shields.io/travis/bitpay/bitcore.svg?branch=master&style=flat-square)](https://travis-ci.org/bitpay/bitcore) [![Build Status](https://img.shields.io/travis/bitpay/bitcore.svg?branch=master&style=flat-square)](https://travis-ci.org/bitpay/bitcore)
[![Coverage Status](https://img.shields.io/coveralls/bitpay/bitcore.svg?style=flat-square)](https://coveralls.io/r/bitpay/bitcore) [![Coverage Status](https://img.shields.io/coveralls/bitpay/bitcore.svg?style=flat-square)](https://coveralls.io/r/bitpay/bitcore)
A pure and simple javascript bitcoin API. A pure and simple JavaScript bitcoin API.
## Principles ## Principles
@ -13,13 +13,11 @@ Bitcoin is a powerful new peer-to-peer platform for the next generation of finan
## Get Started ## Get Started
You can run bitcore on any javascript engine. It's distributed through npm, and you can also find compiled single files here: [bitcore.js](https://bitcore.io/bitcore/dist/bitcore.js) and [bitcore.min.js](https://bitcore.io/bitcore/dist/bitcore.min.js).
``` ```
npm install bitcore npm install bitcore
``` ```
Using it on node.js: Using it in Node.js:
```javascript ```javascript
var bitcore = require('bitcore'); var bitcore = require('bitcore');
@ -46,7 +44,7 @@ Bitcore is still under heavy development and not quite ready for "drop-in" produ
Please send pull requests for bug fixes, code optimization, and ideas for improvement. Please send pull requests for bug fixes, code optimization, and ideas for improvement.
## Building the browser bundle ## Building the Browser Bundle
To build bitcore full bundle for the browser: To build bitcore full bundle for the browser:

6
docs/guide/examples.md → docs/api/index.md
View File

@ -1,6 +1,6 @@
# Examples # Examples
## Create a private key ## Create a Private Key
``` ```
var privKey = new bitcore.PrivateKey(); var privKey = new bitcore.PrivateKey();
@ -27,7 +27,7 @@ var paymentInfo = {
var uri = new bitcore.URI(paymentInfo).toString(); var uri = new bitcore.URI(paymentInfo).toString();
``` ```
## Create a transaction ## Create a Transaction
``` ```
var transaction = new Transaction() var transaction = new Transaction()
.from(utxos) // Feed information about what unspend outputs one can use .from(utxos) // Feed information about what unspend outputs one can use
@ -36,7 +36,7 @@ var transaction = new Transaction()
.sign(privkeySet) // Signs all the inputs it can .sign(privkeySet) // Signs all the inputs it can
``` ```
## Connect to the network ## Connect to the Network
``` ```
var peer = new Peer('5.9.85.34'); var peer = new Peer('5.9.85.34');

10
docs/guide/address.md
View File

@ -1,19 +1,19 @@
# > `bitcore.Address` # Address
## Description ## Description
Represents a bitcoin Address. Addresses became the most popular way to make bitcoin transactions. See [the official Bitcoin Wiki](https://en.bitcoin.it/wiki/Address) for more information. Represents a bitcoin Address. Addresses are the most popular way to make bitcoin transactions. See [the official Bitcoin Wiki](https://en.bitcoin.it/wiki/Address) for technical background information.
## Instantiate an Address ## Instantiate an Address
To be able to receive bitcoins an address is needed, but in order to spend them a private key is necessary. Take a look at the [`PrivateKey`](PrivateKey.md) docs for more information about exporting and saving a key. To be able to receive bitcoins an address is needed, but in order to spend them a private key is necessary. Please take a look at the [`PrivateKey`](privatekey.md) docs for more information about exporting and saving a key.
```javascript ```javascript
var privateKey = new PrivateKey(); var privateKey = new PrivateKey();
var address = privateKey.toAddress(); var address = privateKey.toAddress();
``` ```
You can also instantiate an address from a String, [PublicKey](PublicKey.md), or [HDPublicKey](Hierarchical.md), in case you are not the owner of the private key. You can also instantiate an Address from a String, [PublicKey](publickey.md), or [HDPublicKey](hierarchical.md), in case you are not the owner of the private key.
```javascript ```javascript
// from a string // from a string
@ -32,7 +32,7 @@ var address = new Address(publicKey, Networks.testnet);
## Validating an Address ## Validating an Address
The main use that we expect you'll have for the `Address` class in bitcore is validating that an address is a valid one, what type of address it is (you may be interested on knowing if the address is a simple "pay to public key hash" address or a "pay to script hash" address) and what network does the address belong to. The main use that we expect you'll have for the `Address` class in Bitcore is validating that an address is a valid one, what type of address it is (you may be interested on knowing if the address is a simple "pay to public key hash" address or a "pay to script hash" address) and what network does the address belong to.
The code to do these validations looks like this: The code to do these validations looks like this:

6
docs/guide/block.md
View File

@ -1,8 +1,8 @@
# > `bitcore.Block` # Block
## Description ## Description
A Block instance represents the information on a block in the bitcoin network. Given a hexa or base64 string representation of the serialization of a block with its transactions, you can instantiate a Block instance. Methods are provided to calculate and check the merkle root hash (if enough data is provided), but transactions won't necessarily be valid spends, and this class won't validate them. A binary representation as a `Buffer` instance is also valid input for a Block's constructor. A Block instance represents the information of a block in the bitcoin network. Given a hexa or base64 string representation of the serialization of a block with its transactions, you can instantiate a Block instance. Methods are provided to calculate and check the merkle root hash (if enough data is provided), but transactions won't necessarily be valid spends, and this class won't validate them. A binary representation as a `Buffer` instance is also valid input for a Block's constructor.
```javascript ```javascript
@ -47,7 +47,7 @@ For more information about the specific properties of a block header please visi
## Transactions ## Transactions
The set of transactions in a block is an array of instances of [Transaction](Transaction.md) and can be explored by iterating on the block's `transactions` member. The set of transactions in a block is an array of instances of [Transaction](transaction.md) and can be explored by iterating on the block's `transactions` member.
```javascript ```javascript
for (var i in block.txs) { for (var i in block.txs) {

6
docs/guide/crypto.md
View File

@ -1,4 +1,4 @@
# > `bitcore.crypto` # Crypto
## Description ## Description
@ -14,7 +14,7 @@ The `bitcore.Crypto.BN` class contains a wrapper around [bn.js](https://github.c
## Point ## Point
The `bitcore.Crypto.Point` class contains a wrapper around the class Point of [elliptic.js](https://github.com/indutny/elliptic.js), the elliptic curve library used internally in bitcore. The `bitcore.Crypto.Point` class contains a wrapper around the class Point of [elliptic.js](https://github.com/indutny/elliptic), the elliptic curve library used internally in bitcore.
## Hash ## Hash
@ -22,4 +22,4 @@ The `bitcore.Crypto.Hash` namespace contains a set of hashes and utilities. Thes
## ECDSA ## ECDSA
`bitcore.Crypto.ECDSA` contains a pure javascript implementation of the elliptic curve DSA signature scheme. `bitcore.Crypto.ECDSA` contains a pure JavaScript implementation of the elliptic curve DSA signature scheme.

4
docs/guide/ecies.md
View File

@ -1,8 +1,8 @@
# > `bitcore-ecies` # ECIES
## Description ## Description
Bitcore implements [Elliptic Curve Integrated Encryption Scheme (ECIES)](http://en.wikipedia.org/wiki/Integrated_Encryption_Scheme), which is a public key encryption system that performs bulk encryption on data usinc a symmetric cipher and a random key. Bitcore implements [Elliptic Curve Integrated Encryption Scheme (ECIES)](http://en.wikipedia.org/wiki/Integrated_Encryption_Scheme), which is a public key encryption system that performs bulk encryption on data using a symmetric cipher and a random key.
For more information refer to the [bitcore-ecies](https://github.com/bitpay/bitcore-ecies) github repo. For more information refer to the [bitcore-ecies](https://github.com/bitpay/bitcore-ecies) github repo.

2
docs/guide/encoding.md
View File

@ -1,4 +1,4 @@
# > `bitcore.encoding` # Encoding
## Description ## Description

4
docs/guide/hierarchical.md
View File

@ -1,4 +1,4 @@
# > `bitcore.HDKeys` # HDKeys
## Hierarichically Derived Keys ## Hierarichically Derived Keys
@ -6,7 +6,7 @@ Bitcore provides full support for [BIP32](https://github.com/bitcoin/bips/blob/m
## HDPrivateKey ## HDPrivateKey
An instance of a [PrivateKey](PrivateKey.md) that also contains information required to derive child keys. An instance of a [PrivateKey](privatekey.md) that also contains information required to derive child keys.
Sample usage: Sample usage:

28
docs/guide/index.md
View File

@ -1,28 +0,0 @@
# Bitcore v0.8
## Addresses and Key Management
* [Addresses](models/Address.md)
* [Using different networks](helpers/Networks.md)
* [Private Keys](models/PrivateKey.md) and [Public Keys](models/PublicKey.md)
* [Hierarchically-derived Private and Public Keys](models/Hierarchical.md)
## Payment handling
* [Using different Units](helpers/Unit.md)
* [Acknowledging and Requesting payments: Bitcoin URIs](helpers/URI.md)
* [Payment Protocol Support](helpers/PaymentProtocol.md)
* [The Transaction Class](models/Transaction.md)
## Bitcoin internals
* [Scripts](models/Script.md)
* [Block](models/Block.md)
## Networking
* [Interface to the Bitcoin P2P network](networking/Peer.md)
* [Managing a pool of peers](networking/Pool.md)
* [Connecting to a bitcoind instance through JSON-RPC](networking/JSONRPC.md)
## Extra
* [Crypto](helpers/Crypto.md)
* [Encoding](helpers/Encoding.md)
* [ECIES](helpers/ECIES.md)

4
docs/guide/jsonrpc.md
View File

@ -1,8 +1,8 @@
# > `bitcore.transport.RPC` # JSON-RPC
## Description ## Description
Bitcoind provides a direct interface to the bitcoin network and it also exposes a `JSON-RPC` API. This class allows to connect to a local instance of a bitcoind server and make simple or batch RPC calls to it. Bitcoind provides a direct interface to the bitcoin network and it also exposes a `JSON-RPC` API. This class will connect to a local instance of a bitcoind server and make simple or batch RPC calls to it.
## Connection to bitcoind ## Connection to bitcoind

30
docs/guide/navigation.md
View File

@ -1,30 +0,0 @@
# Bitcore
[Index](index.md)
[Models]()
* [Address](models/Address.md)
* [Block](models/Block.md)
* [Hierarchical](models/Hierarchical.md)
* [Private Key](models/PrivateKey.md)
* [Public Key](models/PublicKey.md)
* [Script](models/Script.md)
* [Transaction](models/Transaction.md)
[Helpers]()
* [Crypto](helpers/Crypto.md)
* [Encoding](helpers/Encoding.md)
* [Payment Protocol](helpers/PaymentProtocol.md)
* [Networks](helpers/Networks.md)
* [Unit](helpers/Unit.md)
* [URI](helpers/URI.md)
[Networking]()
* [Peer](networking/Peer.md)
* [Pool](networking/Pool.md)
* [JSON-RPC](networking/JSONRPC.md)
[Examples](examples.md)

8
docs/guide/networks.md
View File

@ -1,14 +1,14 @@
# > `bitcore.Networks` # Networks
## Description ## Description
Bitcore provides support for both the main bitcoin network as well as for `testnet3`, the current test blockchain. We encourage the use of `Networks.livenet` and `Networks.testnet` as constants. Note that the library sometimes may check for equality against this object. Avoid creating a deep copy of this object and using that. Bitcore provides support for the main bitcoin network as well as for `testnet3`, the current test blockchain. We encourage the use of `Networks.livenet` and `Networks.testnet` as constants. Note that the library sometimes may check for equality against this object. Avoid creating a deep copy of this object and using that.
The `Network` namespace has a function, `get(...)` that returns an instance of a `Network` or `undefined`. The only argument to this function is some kind of identifier of the network: either its name, a reference to a Network object, or a number used as a magic constant to identify the network (for example, the value `0` that gives bitcoin addresses the distinctive `'1'` at its beginning on livenet, is a `0x6F` for testnet). The `Network` namespace has a function, `get(...)` that returns an instance of a `Network` or `undefined`. The only argument to this function is some kind of identifier of the network: either its name, a reference to a Network object, or a number used as a magic constant to identify the network (for example, the value `0` that gives bitcoin addresses the distinctive `'1'` at its beginning on livenet, is a `0x6F` for testnet).
## Setting the default network ## Setting the Default Network
Most project will only need to work in one of either networks. The value of `Networks.defaultNetwork` can be set to `Networks.testnet` if the project will needs only to work on testnet (the default is `Networks.livenet`). Most projects will only need to work with one of the networks. The value of `Networks.defaultNetwork` can be set to `Networks.testnet` if the project will need to only to work on testnet (the default is `Networks.livenet`).
## Network constants ## Network constants

2
docs/guide/paymentprotocol.md
View File

@ -1,4 +1,4 @@
# > `bitcore.PaymentProtocol` # Payment Protocol
## Description ## Description

2
docs/guide/peer.md
View File

@ -1,4 +1,4 @@
# > `bitcore.transport.Peer` # Peer
## Description ## Description

6
docs/guide/pool.md
View File

@ -1,8 +1,8 @@
# > `bitcore.transport.Pool` # Pool
## Pool ## Pool
A pool maintains a connection of [Peers](Peer.md). A pool will discover peers via DNS seeds, as well as when peer addresses are announced through the network. A pool maintains a connection of [Peers](peer.md). A pool will discover peers via DNS seeds, as well as when peer addresses are announced through the network.
The quickest way to get connected is to run the following: The quickest way to get connected is to run the following:
@ -27,4 +27,4 @@ pool.disconnect()
``` ```
For more information about Peer events, please read the [Peer](Peer.md) documentation. Peer events are relayed to the pool, a peer event `inv` in the pool would be `peerinv`. When a peer is disconnected the pool will try to connect to the list of known addresses to maintain connection. For more information about Peer events, please read the [Peer](peer.md) documentation. Peer events are relayed to the pool, a peer event `inv` in the pool would be `peerinv`. When a peer is disconnected the pool will try to connect to the list of known addresses to maintain connection.

4
docs/guide/privatekey.md
View File

@ -1,4 +1,4 @@
# > `bitcore.PrivateKey` # Private Key
## Description ## Description
@ -6,7 +6,7 @@ Represents a bitcoin private key and is needed to be able to spend bitcoin and s
## Instantiate a Private Key ## Instantiate a Private Key
Here is how to create a new private key. It will generate a new random number using `window.crypto` or the Node.js 'crypto' library. Here is how to create a new private key. It will generate a new random number using `window.crypto` or the Node.js `crypto` library.
```javascript ```javascript
var privateKey = new PrivateKey(); var privateKey = new PrivateKey();

4
docs/guide/publickey.md
View File

@ -1,8 +1,8 @@
# > `bitcore.PublicKey` # Public Key
## Description ## Description
Represents a bitcoin public key and is needed to be able to receive bitcoin, as is usually represented as a bitcoin [Address](Address.md), see the official [Bitcoin Wiki](https://en.bitcoin.it/wiki/Technical_background_of_version_1_Bitcoin_addresses). A PublicKey in Bitcore is an immutable object and can be instantiated from a [Point](Crypto.md), string, [PrivateKey](PrivateKey.md), Buffer and a [BN](Crypto.md). Represents a bitcoin public key and is needed to be able to receive bitcoin, as is usually represented as a bitcoin [Address](address.md), see the official [Bitcoin Wiki](https://en.bitcoin.it/wiki/Technical_background_of_version_1_Bitcoin_addresses). A PublicKey in Bitcore is an immutable object and can be instantiated from a [Point](crypto.md), string, [PrivateKey](privatekey.md), Buffer and a [BN](crypto.md).
## Instantiate a Public Key ## Instantiate a Public Key

13
docs/guide/script.md
View File

@ -1,4 +1,4 @@
# > `bitcore.Script` # Script
## Description ## Description
@ -83,7 +83,7 @@ var script = Script.buildDataOut(data);
assert(script.toString() === 'OP_RETURN 14 0x68656c6c6f20776f726c64212121' assert(script.toString() === 'OP_RETURN 14 0x68656c6c6f20776f726c64212121'
``` ```
### Custom scripts ### Custom Scripts
To create a custom `Script` instance, you must rely on the lower-level methods `add` and `prepend`. Both methods accept the same parameter types, and insert an opcode or data at the beginning (`prepend`) or end (`add`) of the `Script`. To create a custom `Script` instance, you must rely on the lower-level methods `add` and `prepend`. Both methods accept the same parameter types, and insert an opcode or data at the beginning (`prepend`) or end (`add`) of the `Script`.
@ -97,10 +97,9 @@ var script = Script()
assert(script.toString() === 'OP_2SWAP OP_IF OP_NOT 4 0xbacacafe'); assert(script.toString() === 'OP_2SWAP OP_IF OP_NOT 4 0xbacacafe');
``` ```
## Script Parsing and Identification
## Script parsing and identification `Script` has an easy interface to parse raw scripts from the network or bitcoind, and to extract useful information. An illustrative example (for more options check the API reference)
`Script` has an easy interface to parse raw scripts from the newtwork or bitcoind, and to extract useful information. An illustrative example (for more options check the API reference)
```javascript ```javascript
var raw_script = new Buffer('5221022df8750480ad5b26950b25c7ba79d3e37d75f640f8e5d9bcd5b150a0f85014da2103e3818b65bcc73a7d64064106a859cc1a5a728c4345ff0b641209fba0d90de6e921021f2f6e1e50cb6a953935c3601284925decd3fd21bc445712576873fb8c6ebc1853ae', 'hex'); var raw_script = new Buffer('5221022df8750480ad5b26950b25c7ba79d3e37d75f640f8e5d9bcd5b150a0f85014da2103e3818b65bcc73a7d64064106a859cc1a5a728c4345ff0b641209fba0d90de6e921021f2f6e1e50cb6a953935c3601284925decd3fd21bc445712576873fb8c6ebc1853ae', 'hex');
@ -113,8 +112,7 @@ s.isScriptHashOut() // false
s.isMultisigOut() // true s.isMultisigOut() // true
``` ```
## Script Interpreting and Validation
## Script interpreting and validation
To validate a transaction, the bitcoin network validates all of its inputs and outputs. To validate an input, the input's script is concatenated with the referenced output script, and the result is executed. If at the end of execution the stack contains a 'true' value, then the transaction is valid. To validate a transaction, the bitcoin network validates all of its inputs and outputs. To validate an input, the input's script is concatenated with the referenced output script, and the result is executed. If at the end of execution the stack contains a 'true' value, then the transaction is valid.
You can do this in `bitcore` by using the `Interpreter` class. The entry point (and probably the only interface you'll need for most applications) is the method `Interpreter#verify()`. You can do this in `bitcore` by using the `Interpreter` class. The entry point (and probably the only interface you'll need for most applications) is the method `Interpreter#verify()`.
@ -147,4 +145,3 @@ var scriptSig = Script.buildPublicKeyHashIn(publicKey, signature);
var flags = Interpreter.SCRIPT_VERIFY_P2SH | Interpreter.SCRIPT_VERIFY_STRICTENC; var flags = Interpreter.SCRIPT_VERIFY_P2SH | Interpreter.SCRIPT_VERIFY_STRICTENC;
var verified = Interpreter().verify(scriptSig, scriptPubkey, tx, inputIndex, flags); var verified = Interpreter().verify(scriptSig, scriptPubkey, tx, inputIndex, flags);
``` ```

15
docs/guide/transaction.md
View File

@ -1,4 +1,4 @@
# > `bitcore.Transaction` # Transaction
## Description ## Description
@ -34,15 +34,13 @@ var transaction = new Transaction().fee(1e8); // Generous fee of 1 BTC
## Transaction API ## Transaction API
You can take a look at the javadocs for the [Transaction class here](link missing).
## Input ## Input
Transaction inputs are instances of either [Input](https://github.com/bitpay/bitcore/tree/master/lib/transaction/input) or its subclasses. The internal workings of it can be understood from the [API reference](link missing). Transaction inputs are instances of either [Input](https://github.com/bitpay/bitcore/tree/master/lib/transaction/input) or its subclasses.
## Output ## Output
Transaction outputs are a very thin wrap around the information provided by a transaction output: its script and its output amount. Transaction outputs are a very thin wrapper around the information provided by a transaction output: its script and its output amount.
## Multisig Transactions ## Multisig Transactions
@ -57,13 +55,12 @@ To send a transaction to a multisig address, the API is the same as in the above
var serialized = multiSigTx.serialize(); var serialized = multiSigTx.serialize();
``` ```
This can be serialized and sent to another party, to complete with the needed This can be serialized and sent to another party, to complete with the needed signatures:
signatures:
```javascript ```javascript
var multiSigTx = new Transaction(serialized) var multiSigTx = new Transaction(serialized)
.from(utxo, publicKeys, threshold) // provide info about the multisig output .from(utxo, publicKeys, threshold) // provide info about the multisig output
// (lost on serialization) // (lost on serialization)
.sign(anotherSetOfKeys); .sign(anotherSetOfKeys);
assert(multiSigTx.isFullySigned()); assert(multiSigTx.isFullySigned());
@ -86,7 +83,7 @@ There are a number of data structures being stored internally in a `Transaction`
If you have a larger set of unspent outputs, only some of them will be selected to fulfill the amount. This is done by storing a cache of unspent outputs in a protected member called `_utxos`. When the `to()` method is called, some of these outputs will be selected to pay the requested amount to the appropriate address. If you have a larger set of unspent outputs, only some of them will be selected to fulfill the amount. This is done by storing a cache of unspent outputs in a protected member called `_utxos`. When the `to()` method is called, some of these outputs will be selected to pay the requested amount to the appropriate address.
A nit that you should have in mind is that when the transaction is serialized, this cache can't be included in the serialized form. A detail that you should have in mind is that when the transaction is serialized, this cache can't be included in the serialized form.
## Upcoming changes ## Upcoming changes

6
docs/guide/unit.md
View File

@ -1,8 +1,8 @@
# > `bitcore.Unit` # Unit
## Description ## Description
Unit is an utility for handling and converting bitcoins units. We strongly recommend you to always use satoshis to represent amount inside your application and only convert them to other units in the front-end. Unit is an utility for handling and converting bitcoin units. We strongly recommend to always use satoshis to represent amount inside your application and only convert them to other units in the front-end.
## Supported units ## Supported units
@ -37,7 +37,7 @@ unit = Unit.fromSatoshis(amount);
## Conversion ## Conversion
Once you have a unit instance, you can check it's representantion in all the available units. For your convinience the classes expose three ways to acomplish this. Using the `.to(unitCode)` method, using a fixed unit like `.toSatoshis()` or by using the accessors. Once you have a unit instance, you can check its representantion in all the available units. For your convinience the classes expose three ways to acomplish this. Using the `.to(unitCode)` method, using a fixed unit like `.toSatoshis()` or by using the accessors.
```javascript ```javascript
var unit; var unit;

6
docs/guide/uri.md
View File

@ -1,8 +1,8 @@
# > `bitcore.URI` # URI
## Description ## Description
Represents a bitcoin payment uri. Bitcoin URI strings became the most popular way to share payment request, sometimes as a bitcoin link and others using a QR code. Represents a bitcoin payment URI. Bitcoin URI strings became the most popular way to share payment request, sometimes as a bitcoin link and others using a QR code.
URI Examples: URI Examples:
``` ```
@ -24,7 +24,7 @@ console.log(uri.address.network, uri.amount); // 'livenet', 120000000
``` ```
## URI Parameters ## URI Parameters
All standard parameters can be found as members of the `URI` instance. However a bitcoin uri may contain other non-standard parameters, all those can be found under the `extra` namespace. All standard parameters can be found as members of the `URI` instance. However a bitcoin URI may contain other non-standard parameters, all those can be found under the `extra` namespace.
See [the official BIP21 spec](https://github.com/bitcoin/bips/blob/master/bip-0021.mediawiki) for more information. See [the official BIP21 spec](https://github.com/bitcoin/bips/blob/master/bip-0021.mediawiki) for more information.