From affd0248386dba2ff9cf916867587c459ef2dd93 Mon Sep 17 00:00:00 2001 From: Braydon Fuller Date: Wed, 24 Dec 2014 12:55:02 -0500 Subject: [PATCH] Fixed spelling mistakes, typos, and other documentation adjustments. --- docs/guide/address.md | 2 +- docs/guide/block.md | 6 +++--- docs/guide/crypto.md | 2 +- docs/guide/ecies.md | 2 +- docs/guide/hierarchical.md | 4 ++-- docs/guide/networks.md | 2 +- docs/guide/paymentprotocol.md | 2 +- docs/guide/peer.md | 2 +- docs/guide/pool.md | 4 +--- docs/guide/script.md | 2 +- docs/guide/transaction.md | 4 ++-- docs/guide/unit.md | 4 ++-- docs/guide/uri.md | 2 +- 13 files changed, 18 insertions(+), 20 deletions(-) diff --git a/docs/guide/address.md b/docs/guide/address.md index 8663b4c8f..9718790b1 100644 --- a/docs/guide/address.md +++ b/docs/guide/address.md @@ -5,7 +5,7 @@ description: A simple interface to generate and validate a bitcoin address. ## Description -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. +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 diff --git a/docs/guide/block.md b/docs/guide/block.md index 6d88692b5..764d8f65e 100644 --- a/docs/guide/block.md +++ b/docs/guide/block.md @@ -5,14 +5,14 @@ description: A simple interface to parse and validate a bitcoin blocks. ## Description -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. +A Block instance represents the information of a block in the bitcoin network. Given a hexadecimal 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 // instantiate a new block instance var block = new Block(hexaEncodedBlock); -// will verify that the correspending block transactions match the header +// will verify that the corresponding block transactions match the header assert(block.validMerkleRoot()); // blocks have several properties @@ -27,7 +27,7 @@ For detailed technical information about a block please visit [Blocks](https://e ## Block Header -Each instance of Block has a BlockHeader *(which can be instantiated seperately)*. The header has validation methods, to verify that the block. +Each instance of Block has a BlockHeader *(which can be instantiated separately)*. The header has validation methods, to verify that the block. ```javascript diff --git a/docs/guide/crypto.md b/docs/guide/crypto.md index e5499c87d..14925e744 100644 --- a/docs/guide/crypto.md +++ b/docs/guide/crypto.md @@ -25,4 +25,4 @@ The `bitcore.Crypto.Hash` namespace contains a set of hashes and utilities. Thes ## 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 based on [elliptic.js](https://github.com/indutny/elliptic). diff --git a/docs/guide/ecies.md b/docs/guide/ecies.md index c63f93136..c95879ba7 100644 --- a/docs/guide/ecies.md +++ b/docs/guide/ecies.md @@ -9,7 +9,7 @@ Bitcore implements [Elliptic Curve Integrated Encryption Scheme (ECIES)](http:// For more information refer to the [bitcore-ecies](https://github.com/bitpay/bitcore-ecies) github repo. -## Instalation +## Installation ECIES is implemented as a separate module and you must add it to your dependencies: diff --git a/docs/guide/hierarchical.md b/docs/guide/hierarchical.md index a5edca9c1..fa62370bf 100644 --- a/docs/guide/hierarchical.md +++ b/docs/guide/hierarchical.md @@ -3,9 +3,9 @@ description: Lets you create and derive extended public and private keys accordi --- # HDKeys -## Hierarichically Derived Keys +## Hierarchically Derived Keys -Bitcore provides full support for [BIP32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki), allowing for many key management schemas that benefit from this property. Please be sure to read and understand the basic concepts and the warnings on that BIP before using these classes. +Bitcore provides full support for [BIP32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki), allowing for many key management schemas that benefit from this property. Please be sure to read and understand the basic concepts and the warnings on that BIP before using these classes. ## HDPrivateKey diff --git a/docs/guide/networks.md b/docs/guide/networks.md index b35e4c9b4..905d80594 100644 --- a/docs/guide/networks.md +++ b/docs/guide/networks.md @@ -5,7 +5,7 @@ description: A simple interface to handle livenet and testnet bitcoin networks. ## Description -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. +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. Please avoid creating a deep copy of this object. 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). diff --git a/docs/guide/paymentprotocol.md b/docs/guide/paymentprotocol.md index c9c654556..1412a1a35 100644 --- a/docs/guide/paymentprotocol.md +++ b/docs/guide/paymentprotocol.md @@ -100,7 +100,7 @@ var merchant_data = details.get('merchant_data'); ## Send a Payment -After the request is verified a payment can be sent to the merchant, from the customer's wallet: +After the request is verified a payment can be sent to the merchant from the customer's wallet: ```javascript diff --git a/docs/guide/peer.md b/docs/guide/peer.md index 53ca1270f..ccd73a2c8 100644 --- a/docs/guide/peer.md +++ b/docs/guide/peer.md @@ -1,5 +1,5 @@ title: Peer -description: The Peer class privides a simple interface for connecting to a node in the bitcoin network. +description: The Peer class provides a simple interface for connecting to a node in the bitcoin network. --- # Peer diff --git a/docs/guide/pool.md b/docs/guide/pool.md index 34f1f9f5d..cbcb4dfb0 100644 --- a/docs/guide/pool.md +++ b/docs/guide/pool.md @@ -3,8 +3,6 @@ description: A simple interface to create and maintain a set of connections to b --- # 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. The quickest way to get connected is to run the following: @@ -30,4 +28,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. diff --git a/docs/guide/script.md b/docs/guide/script.md index b88fb3d2f..5c6facd26 100644 --- a/docs/guide/script.md +++ b/docs/guide/script.md @@ -63,7 +63,7 @@ assert(script.toString() === 'OP_2 33 0x022df8750480ad5b26950b25c7ba79d3e37d75f6 Pay to script hash outputs are scripts that contain the hash of another script, called `redeemScript`. To spend bitcoins sent in a p2sh output, the spending transaction must provide a script matching the script hash and data which makes the script evaluate to true. This allows to defer revealing the spending conditions to the moment of spending. It also makes it possible for the receiver to set the conditions to spend those bitcoins. -Most multisig transactions today use p2sh outputs where the redeemScript is a multisig output. +Most multisig transactions today use p2sh outputs where the `redeemScript` is a multisig output. ```javascript // create a p2sh multisig output diff --git a/docs/guide/transaction.md b/docs/guide/transaction.md index 1fb97ef00..2607ede8a 100644 --- a/docs/guide/transaction.md +++ b/docs/guide/transaction.md @@ -7,7 +7,7 @@ description: A robust interface to create, parse and validate bitcoin transactio Bitcore provides a very simple API for creating transactions. We expect this API to be accessible for developers without knowing the working internals of bitcoin in deep detail. What follows is a small introduction to transactions with some basic knowledge required to use this API. -A Transaction contains a set of inputs and a set of outputs. Each input contains a reference to another transaction's output, and a signature that allows the value referenced in that ouput to be used in this transaction. +A Transaction contains a set of inputs and a set of outputs. Each input contains a reference to another transaction's output, and a signature that allows the value referenced in that output to be used in this transaction. Note also that an output can be used only once. That's why there's a concept of "change address" in the bitcoin ecosystem: if an output of 10 BTC is available for me to spend, but I only need to transmit 1 BTC, I'll create a transaction with two outputs, one with 1 BTC that I want to spend, and the other with 9 BTC to a change address, so I can spend this 9 BTC with another private key that I own. @@ -17,7 +17,7 @@ Let's take a look at some very simple transactions: ```javascript var transaction = new Transaction() - .from(utxos) // Feed information about what unspend outputs one can use + .from(utxos) // Feed information about what unspent outputs one can use .to(address, amount) // Add an output with the given amount of satoshis .change(address) // Sets up a change address where the rest of the funds will go .sign(privkeySet) // Signs all the inputs it can diff --git a/docs/guide/unit.md b/docs/guide/unit.md index 825ad2091..b09640f10 100644 --- a/docs/guide/unit.md +++ b/docs/guide/unit.md @@ -5,7 +5,7 @@ description: Utility to easily convert between bitcoin units. ## Description -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. +Unit is a 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 @@ -40,7 +40,7 @@ unit = Unit.fromSatoshis(amount); ## Conversion -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. +Once you have a unit instance, you can check its representation in all the available units. For your convenience the classes expose three ways to accomplish this. Using the `.to(unitCode)` method, using a fixed unit like `.toSatoshis()` or by using the accessors. ```javascript var unit; diff --git a/docs/guide/uri.md b/docs/guide/uri.md index a1b51a345..e679e126a 100644 --- a/docs/guide/uri.md +++ b/docs/guide/uri.md @@ -18,7 +18,7 @@ bitcoin:12A1MyfXbW6RhdRAZEqofac5jCQQjwEPBu?amount=1.2&message=Payment&label=Sato The main use that we expect you'll have for the `URI` class in bitcore is validating and parsing bitcoin URIs. A `URI` instance exposes the address as a bitcore `Address` object and the amount in Satoshis, if present. -The code for validating uris looks like this: +The code for validating URIs looks like this: ```javascript var uriString = 'bitcoin:12A1MyfXbW6RhdRAZEqofac5jCQQjwEPBu?amount=1.2'; var valid = URI.isValid(uriString);