Fixes for various formatting issues and typos.
This commit is contained in:
parent
f77da04464
commit
8ff26bb260
@ -104,7 +104,7 @@ Run all the tests:
|
|||||||
gulp test
|
gulp test
|
||||||
```
|
```
|
||||||
|
|
||||||
You can also run just the NodeJS tests with `gulp test:node`, just the browser tests with `gulp test:browser`
|
You can also run just the Node.js tests with `gulp test:node`, just the browser tests with `gulp test:browser`
|
||||||
or create a test coverage report (you can open `coverage/lcov-report/index.html` to visualize it) with `gulp coverage`.
|
or create a test coverage report (you can open `coverage/lcov-report/index.html` to visualize it) with `gulp coverage`.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|||||||
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
## Principles
|
## Principles
|
||||||
|
|
||||||
Bitcoin is a powerful new peer-to-peer platform for the next generation of financial technology. The decentralized nature of the Bitcoin network allows for highly resilient bitcoin infrastructure, and the developer community needs reliable, open-source tools to implement bitcoin apps and services. Bitcore provides a reliable API for javascript apps that need to interface with Bitcoin.
|
Bitcoin is a powerful new peer-to-peer platform for the next generation of financial technology. The decentralized nature of the Bitcoin network allows for highly resilient bitcoin infrastructure, and the developer community needs reliable, open-source tools to implement bitcoin apps and services. Bitcore provides a reliable API for JavaScript apps that need to interface with Bitcoin.
|
||||||
|
|
||||||
To get started, just `npm install bitcore` or `bower install bitcore`.
|
To get started, just `npm install bitcore` or `bower install bitcore`.
|
||||||
|
|
||||||
|
|||||||
@ -143,7 +143,7 @@ To remove all outputs, you can use `clearOutputs()`, which preserves change outp
|
|||||||
|
|
||||||
There are a series of methods used for serialization:
|
There are a series of methods used for serialization:
|
||||||
|
|
||||||
* `toObject`: Returns a plain javascript object with no methods and enough information to fully restore the state of this transaction. Using other serialization methods (except for `toJSON`) will cause a some information to be lost.
|
* `toObject`: Returns a plain JavaScript object with no methods and enough information to fully restore the state of this transaction. Using other serialization methods (except for `toJSON`) will cause a some information to be lost.
|
||||||
* `toJSON`: Returns a string with a JSON-encoded version of the output for `toObject`.
|
* `toJSON`: Returns a string with a JSON-encoded version of the output for `toObject`.
|
||||||
* `toString` or `uncheckedSerialize`: Returns an hexadecimal serialization of the transaction, in the [serialization format for bitcoin](https://bitcoin.org/en/developer-reference#raw-transaction-format).
|
* `toString` or `uncheckedSerialize`: Returns an hexadecimal serialization of the transaction, in the [serialization format for bitcoin](https://bitcoin.org/en/developer-reference#raw-transaction-format).
|
||||||
* `serialize`: Does a series of checks before serializing the transaction
|
* `serialize`: Does a series of checks before serializing the transaction
|
||||||
|
|||||||
@ -62,7 +62,7 @@ Block._fromJSON = function _fromJSON(data) {
|
|||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {Object} - A plain javascript object
|
* @param {Object} - A plain JavaScript object
|
||||||
* @returns {Object} - An object representing block data
|
* @returns {Object} - An object representing block data
|
||||||
* @private
|
* @private
|
||||||
*/
|
*/
|
||||||
@ -92,7 +92,7 @@ Block.fromJSON = function fromJSON(json) {
|
|||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {Object} - A plain javascript object
|
* @param {Object} - A plain JavaScript object
|
||||||
* @returns {Block} - An instance of block
|
* @returns {Block} - An instance of block
|
||||||
*/
|
*/
|
||||||
Block.fromObject = function fromObject(obj) {
|
Block.fromObject = function fromObject(obj) {
|
||||||
|
|||||||
@ -93,7 +93,7 @@ BlockHeader.fromJSON = function fromJSON(json) {
|
|||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {Object} - A plain javascript object
|
* @param {Object} - A plain JavaScript object
|
||||||
* @returns {BlockHeader} - An instance of block header
|
* @returns {BlockHeader} - An instance of block header
|
||||||
*/
|
*/
|
||||||
BlockHeader.fromObject = function fromObject(obj) {
|
BlockHeader.fromObject = function fromObject(obj) {
|
||||||
|
|||||||
@ -28,7 +28,7 @@ module.exports = [{
|
|||||||
}
|
}
|
||||||
}, {
|
}, {
|
||||||
name: 'AbstractMethodInvoked',
|
name: 'AbstractMethodInvoked',
|
||||||
message: 'Abstract Method Invokation: {0}'
|
message: 'Abstract Method Invocation: {0}'
|
||||||
}, {
|
}, {
|
||||||
name: 'InvalidArgumentType',
|
name: 'InvalidArgumentType',
|
||||||
message: function() {
|
message: function() {
|
||||||
|
|||||||
@ -391,7 +391,7 @@ HDPublicKey.prototype.inspect = function() {
|
|||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns a plain javascript object with information to reconstruct a key.
|
* Returns a plain JavaScript object with information to reconstruct a key.
|
||||||
*
|
*
|
||||||
* Fields are: <ul>
|
* Fields are: <ul>
|
||||||
* <li> network: 'livenet' or 'testnet'
|
* <li> network: 'livenet' or 'testnet'
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user