Core/grin
0
0
Fork 0
mirror of https://github.com/mimblewimble/grin.git synced 2025-02-01 17:01:09 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

various typos in docs (#95)

Browse source 
* various typos in docs
* fix a number in comments
This commit is contained in:
Riccardo Casatta 2017-08-21 18:56:26 +02:00 committed by Ignotus Peverell
parent b61c0607c2
commit 6772d9f516
5 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
core/src/core/pmmr.rs
View file

@ -380,7 +380,7 @@ fn peaks(num: u64) -> Vec<u64> {
/// To get the height of any node (say 1101), we need to travel left in the /// To get the height of any node (say 1101), we need to travel left in the
/// tree, get the leftmost node and count the ones. To travel left, we just /// tree, get the leftmost node and count the ones. To travel left, we just
/// need to subtract the position by it's most significant bit, mins one. For /// need to subtract the position by it's most significant bit, mins one. For
/// example to get from 1101 to 110 we subtract it by (1000-1) (`13-(8-1)=5`). /// example to get from 1101 to 110 we subtract it by (1000-1) (`13-(8-1)=6`).
/// Then to to get 110 to 11, we subtract it by (100-1) ('6-(4-1)=3`). /// Then to to get 110 to 11, we subtract it by (100-1) ('6-(4-1)=3`).
/// ///
/// By applying this operation recursively, until we get a number that, in /// By applying this operation recursively, until we get a number that, in

6
doc/build.md
View file

@ -46,11 +46,11 @@ For the sake of example, we're going to run three nodes with varying setups. Cre
As before, node 1 will create the blockchain and begin mining. As we'll be running many servers from the same machine, we'll configure specific ports for other servers to explicitly connect to. As before, node 1 will create the blockchain and begin mining. As we'll be running many servers from the same machine, we'll configure specific ports for other servers to explicitly connect to.
First, we run a wallet server to recieve rewards on port 15000 (we'll log in debug mode for more information about what's happening) First, we run a wallet server to receive rewards on port 15000 (we'll log in debug mode for more information about what's happening)
node1$ RUST_LOG=grin=debug grin wallet -p "password" -r 15000 receive node1$ RUST_LOG=grin=debug grin wallet -p "password" -r 15000 receive
Then we start node 1 mining with its P2P server bound to port 10000 and its api server at 10001. We also provide our wallet address where we'll recieve mining rewards. In another terminal: Then we start node 1 mining with its P2P server bound to port 10000 and its api server at 10001. We also provide our wallet address where we'll receive mining rewards. In another terminal:
node1$ RUST_LOG=grin=debug grin server -m -p 10000 -a 10001 -w "http://127.0.0.1:15000" run node1$ RUST_LOG=grin=debug grin server -m -p 10000 -a 10001 -w "http://127.0.0.1:15000" run
@ -79,7 +79,7 @@ who will add a blinding factor before posting it to the blockchain. The above co
### Node 1 - Send money to node 3 ### Node 1 - Send money to node 3
With all of your severs happily running and your terminals scrolling away, let's spend some of the coins mined in node 1 by sending them to node 3's listening wallet. With all of your servers happily running and your terminals scrolling away, let's spend some of the coins mined in node 1 by sending them to node 3's listening wallet.
In yet another terminal in node 1's directory, create a new partial transaction spending 20000 coins and send them on to node 3's wallet listener. We'll also specify that we'll In yet another terminal in node 1's directory, create a new partial transaction spending 20000 coins and send them on to node 3's wallet listener. We'll also specify that we'll
use node 2's API listener to validate our transaction inputs before sending: use node 2's API listener to validate our transaction inputs before sending:

2
doc/chainsync.md
View file

@ -63,7 +63,7 @@ With this information it can verify:
* the total difficulty on that chain (present in all block headers) * the total difficulty on that chain (present in all block headers)
* the sum of all UTXO commitments equals the expected money supply * the sum of all UTXO commitments equals the expected money supply
* the root hash of all UTXOs match the rooth hash in the block header * the root hash of all UTXOs match the root hash in the block header
Once the validation done, the peer can download and validate the blocks content Once the validation done, the peer can download and validate the blocks content
from the horizon up to the head. from the horizon up to the head.

2
doc/intro.md
View file

@ -19,7 +19,7 @@ The main goal and characteristics of the Grin project are:
* Strong and proven cryptography. MimbleWimble only relies on Elliptic Curve * Strong and proven cryptography. MimbleWimble only relies on Elliptic Curve
Cryptography which has been tried and tested for decades. Cryptography which has been tried and tested for decades.
* Design simplicity that makes it easy to audit and maintain over time. * Design simplicity that makes it easy to audit and maintain over time.
* Community driven, using an asic-resistent mining algorithm (Cuckoo Cycle) * Community driven, using an asic-resistant mining algorithm (Cuckoo Cycle)
encouraging mining decentralization. encouraging mining decentralization.
# Tongue Tying for Everyone # Tongue Tying for Everyone

2
doc/merkle.md
View file

@ -233,7 +233,7 @@ easily, in the background, apply it as a whole on affected chunks.
Note that our sum MMR never actually fully deletes a key (i.e. output Note that our sum MMR never actually fully deletes a key (i.e. output
commitment) as subsequent leaf nodes aren't shifted and parents don't need commitment) as subsequent leaf nodes aren't shifted and parents don't need
rebalancing. Deleting a node just makes its storage in the tree unecessary, rebalancing. Deleting a node just makes its storage in the tree unnecessary,
allowing for potential additional pruning of parent nodes. allowing for potential additional pruning of parent nodes.
### Key to Tree Insertion Position Index ### Key to Tree Insertion Position Index