Skip to content
This repository was archived by the owner on Jul 14, 2020. It is now read-only.
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cardano-components/adrestia/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Internal
--------

.. warning::
Here be dragons. These tools are used internally by other tools and does not benefit from the same care in documentation thanother tools above.
Here be dragons. These tools are used internally by other tools and does not benefit from the same care in documentation than other tools above.


+-------------------+--------------------------------------------------+
Expand Down
2 changes: 1 addition & 1 deletion cardano-components/adrestia/doc/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ More recently, `cardano-wallet` has been using sequential derivation which follo

There are two sides to this question. Either, you are referring to accounts as in Ethereum accounts, or you may refer to accounts of hierarchical deterministic wallets.

In the first scenario, assets in the form of accounts are only supported in the Shelley era of Cardano and only for a specific use-case: rewards. Rewards are indeed implicitely published on the blockchain to mitigate the risk of flooding the network at the end of every epoch with rewards payouts! Hence, each core node keeps track of the current value of each reward account in a Ledger. Money can be withdrawn from this account and is then turned as a UTxO. Please note that funds can never be manually sent to a reward account. The creation of a reward account is done when registering a staking key, via a specific type of transaction.
In the first scenario, assets in the form of accounts are only supported in the Shelley era of Cardano and only for a specific use-case: rewards. Rewards are indeed implicitly published on the blockchain to mitigate the risk of flooding the network at the end of every epoch with rewards payouts! Hence, each core node keeps track of the current value of each reward account in a Ledger. Money can be withdrawn from this account and is then turned as a UTxO. Please note that funds can never be manually sent to a reward account. The creation of a reward account is done when registering a staking key, via a specific type of transaction.
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

implicitely -> implicitly


In the second case, please refer to the [HD wallets](key-concepts/hierarchical-deterministic-wallets.md) section in the _Key concepts_. Cardano wallets typically follow an HD tree of derivation as described in this section.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Building Cardano Node from Source

## Installing dependancies
## Installing dependencies
By building and running a node directly from the source code, you can ensure that you get all the latest code updates.

The following instructions presume that you will be running your node on a Linux system and are using cabal. For more information, see the [supported platforms](shelley/about/supported-platforms/) page. You can run a node on any platform by [using a virtual machine](/shelley/get-started/installing-and-running-the-cardano-node/running-the-node-on-an-aws-instance/).
Expand All @@ -11,7 +11,7 @@ To build and run a node from source, you need the following packages and tools:
* the version control system git
* the gcc C-compiler
* C++ support for gcc
* developer libraries for the the arbitrary precision library gmp
* developer libraries for the arbitrary precision library gmp
* developer libraries for the compression library zlib
* developer libraries for systemd and ncurses

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Transaction states

![State Diagram](./controllers_brief.svg)<img src="state_diagram.svg">
![State Diagram](./state_diagram.svg)<img src="state_diagram.svg">

### About `forget`

Expand All @@ -20,4 +20,4 @@ may be discovered directly in blocks.

## Submitting a transaction

![Sequence Diagram](./controllers_brief.svg)<img src="sequence_diagram.svg">
![Sequence Diagram](./sequence_diagram.svg)<img src="sequence_diagram.svg">
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ e.g.

Authors Don’t | Authors Do
--- | ---
That makes sense in some cases butnot here. | I added a comment about why it’s implemented that way.
That makes sense in some cases but not here. | I added a comment about why it’s implemented that way.

### DO: When disagreeing with feedback, explain the advantage of your approach.

Expand Down
12 changes: 6 additions & 6 deletions cardano-components/cardano-wallet/doc/Coding-Standards.md
Original file line number Diff line number Diff line change
Expand Up @@ -523,7 +523,7 @@ lints at a function site using a proper annotation:
> **Why**
>
> Linters are common practices in software development and help maintaining consistency across a large codebase with
> many developers. Hlint is de de-facto linter in Haskell and comes with a lot of different rules and features that
> many developers. Hlint is the de-facto linter in Haskell and comes with a lot of different rules and features that
> are _most of the time_ rather relevant and convey good practices, agreed upon and shared across the team.

e.g.
Expand Down Expand Up @@ -636,14 +636,14 @@ The comments might answer the question _why?_ They _might_:
2. Explain the relation to business functionality
3. Provide some other good-to-know information

We should keep an eye out out-of-date comments. For instance when creating and reviewing PRs.
We should keep an eye out for out-of-date comments. For instance when creating and reviewing PRs.

> **Why**
>
> Even if individual functions are well-documented, it can be difficult to grasp how it all fits together.
>
> In the legacy code-base, it was common to have multiple functions with the same or similar names, in different modules.
> Try seaching for `applyBlocks` or `switchToFork`. What is the difference between `DB.Spec.Update.switchToFork` and `DB.AcidState.switchToFork`?
> Try searching for `applyBlocks` or `switchToFork`. What is the difference between `DB.Spec.Update.switchToFork` and `DB.AcidState.switchToFork`?
>
> Having a comment at the top of each module would be an easy-to-follow rule to better document this. It is also very appropriate for
> our [haddock docs](https://input-output-hk.github.io/cardano-wallet/haddock/).
Expand Down Expand Up @@ -755,7 +755,7 @@ instance Arbitrary HumanReadableChar where
When pattern-matching on sum types or finite structures, we should avoid
the use of the wildcard `_` as much as possible, and instead favor explicit
handling of all branches. This way, we get compiler errors when extending
the underlying ADT and avoid silently handling (probably incorretly) some
the underlying ADT and avoid silently handling (probably incorrectly) some
of the new branches.

> **Why**
Expand Down Expand Up @@ -918,7 +918,7 @@ that are typically hard to read through their standard `Show` instance. For mona
> when printed out to the console using only the stock `Show` instance. On the other hand, we
> want to keep using the stock `Show` instance in order to be able to easily copy-paste failing
> cases and turn them into regression tests. QuickCheck however provides a good set of tools to
> display counter examples on failures to ease debbugging.
> display counter examples on failures to ease debugging.

<details>
<summary>See examples</summary>
Expand Down Expand Up @@ -957,7 +957,7 @@ inputs or results of a property. These should be used in properties dealing with
> coverage. QuickCheck default generators are typically skewed towards certain edge values to favor bug finding but this
> is sometimes counter-intuitive. For example, when testing with lists or maps, it often happens that most of the test cases
> are actually testing on empty values. In order to make sure that some interesting test cases are still covered, it is
> necessary to instrument properties so that they can mesure how often certain cases appear in a particular property.
> necessary to instrument properties so that they can measure how often certain cases appear in a particular property.

<details>
<summary>See Examples</summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ The team's process is derived from [extreme programming][xp] and adapted for rem
- During recovery weeks, the team has a dedicated moment to tackle some of the technical debts. This includes:
- Reviewing and extending code documentation
- Refactoring some potentially entangled parts of the code
- Re-organizing modules and folder achitecture
- Re-organizing modules and folder architecture
- Fix small `TODOs` or `FIXMEs`, or, turn them into U/S
- Identify areas of the source code which needs improvement
- Recovery weeks happen instead of a sprint, and start with a retrospective meeting about the last 3 sprints.
Expand Down
2 changes: 1 addition & 1 deletion cardano-components/cardano-wallet/doc/Release-Checklist.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Release Checklist

## Preparing the release
- [ ] Make sure `cardano-wallet` points to correct revisions of dependent low-level libs (verify on target repositories if [stack.yaml](https://github.com/input-output-hk/cardano-wallet/blob/master/stack.yaml#L34-L42) points to appopriate revisions for `persistent`, `cardano-addresses`...). Also verify that the stack resolver corresponds to the `cardano-node` version.
- [ ] Make sure `cardano-wallet` points to correct revisions of dependent low-level libs (verify on target repositories if [stack.yaml](https://github.com/input-output-hk/cardano-wallet/blob/master/stack.yaml#L34-L42) points to appropriate revisions for `persistent`, `cardano-addresses`...). Also verify that the stack resolver corresponds to the `cardano-node` version.

- [ ] Fetch the tip of `master`:

Expand Down
2 changes: 1 addition & 1 deletion cardano-components/cardano-wallet/doc/Resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Wallet
- [Formal Specification for a Cardano Wallet](https://github.com/input-output-hk/cardano-wallet/blob/master/specifications/wallet/formal-specification-for-a-cardano-wallet.pdf)
- [[Byron] About Address Format](https://github.com/input-output-hk/cardano-wallet/wiki/About-Address-Format---Byron)
- [HD Chimeric wallets](https://github.com/input-output-hk/implementation-decisions/blob/e2d1bed5e617f0907bc5e12cf1c3f3302a4a7c42/text/1852-hd-chimeric.md)
- [About Transactions Lifecyle](https://github.com/input-output-hk/cardano-wallet/wiki/About-Transactions-Lifecycle)
- [About Transactions Lifecycle](https://github.com/input-output-hk/cardano-wallet/wiki/About-Transactions-Lifecycle)

Jörmungandr
------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ $ cardano-wallet wallet get 2512a00e9653fe49a44a5886202e24d77eeb998f

> `cardano-wallet wallet utxo [--port=INT] WALLET_ID`

Visualize a wallet's UTxO distribution in the form of an histrogram with a logarithmic scale.
Visualize a wallet's UTxO distribution in the form of an histogram with a logarithmic scale.
The distribution's data is returned by the API in a JSON format, e.g.:

```json
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@ one database file per wallet.

##### --genesis-block-hash

This is a hash of the the genesis block file which can obtained using Jörmungandr's tool command-line `jcli` as follows:
This is a hash of the genesis block file which can obtained using Jörmungandr's tool command-line `jcli` as follows:

```
$ jcli genesis hash --input block0.bin
Expand Down Expand Up @@ -393,7 +393,7 @@ $ cardano-wallet wallet get 2512a00e9653fe49a44a5886202e24d77eeb998f

> `cardano-wallet wallet utxo [--port=INT] WALLET_ID`

Visualize a wallet's UTxO distribution in the form of an histrogram with a logarithmic scale.
Visualize a wallet's UTxO distribution in the form of an histogram with a logarithmic scale.
The distribution's data is returned by the API in a JSON format, e.g.:

```json
Expand Down
4 changes: 2 additions & 2 deletions cardano-tutorials/Shelley-testnet/Exercise-2.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ As before, if you have any questions or encounter any problems, please feel free

### Exercises

In this excercise we will be following steps from [Creating a Simple Transaction tutorial](../node-setup/040_transactions.md)
In this exercise we will be following steps from [Creating a Simple Transaction tutorial](../node-setup/040_transactions.md)

1. If you are not on the correct version of the node, then some of these commands may not work.
It may be frustrating to stop and restart a working system, but it is better than discovering that
Expand Down Expand Up @@ -134,7 +134,7 @@ Note that there are two outputs. First is the amount sent to account B, second i

We are now ready to sign the transaction and submit it to the chain.

4. Sign your transaction in *txbody* using the signing key for *payment.addr* (created in Excercise 1) :
4. Sign your transaction in *txbody* using the signing key for *payment.addr* (created in Exercise 1) :

```bash
cardano-cli shelley transaction sign \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ We need the following packages and tools on our Linux system to download the sou
- the version control system ``git``,
- the ``gcc`` C-compiler,
- C++ support for ``gcc``,
- developer libraries for the the arbitrary precision library ``gmp``,
- developer libraries for the arbitrary precision library ``gmp``,
- developer libraries for the compression library ``zlib``,
- developer libraries for ``systemd``,
- developer libraries for ``ncurses``,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Let's create a second __payment key pair__ and __address__ (You should have crea
--verification-key-file payment2.vkey \
--signing-key-file payment2.skey

This has created two files containging our signing key and our verification key, let's take a look.
This has created two files containing our signing key and our verification key, let's take a look.

$ cat payment2.skey

Expand Down Expand Up @@ -124,7 +124,7 @@ We also need the UTXO details of the __payment.addr__ that will send the funds.

Sending funds to our new `payment2.addr`requires five (5) simple steps.

1. Determine the appropiate TTL (Time to live)
1. Determine the appropriate TTL (Time to live)
2. Calculate the fee
3. Build the transaction
4. Sign the transaction
Expand Down Expand Up @@ -163,7 +163,7 @@ Now we need to make some quick math, lets say we want to send 100 tADA to `payme
$ expr 499498404313 - 100000000 - 167965
499398236348

The result is the ammount we need to send back to our own `payment.addr`
The result is the amount we need to send back to our own `payment.addr`

**BUILD TRANSACTION**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ First, we need to setup our __block-producing node__. You can build the node fro
### Basic block-producing node firewall configuration:

* Make sure you can only login with SSH Keys, not password.
* Make sure to setup SSH connections in a port different than the the default 22
* Make sure to setup SSH connections in a port different than the default 22
* Make sure to configure the firewall to only allow connections from your relay nodes by setting up their ip addresses.

### Basic relay node firewall configuration:
Expand Down Expand Up @@ -78,7 +78,7 @@ Look for Tip `unSlotNo` value. In this example we are on slot 432571. So in this
expr 432571 / 3600
> 120

With this information we can generate our opertional certificate:
With this information we can generate our operational certificate:

cardano-cli shelley node issue-op-cert \
--kes-verification-key-file kes.vkey \
Expand Down Expand Up @@ -120,7 +120,7 @@ And verify that they are gone:

### Configure topology files for block-producing and relay nodes.

Get the configuration files for your block-producing node if you dont have them already:
Get the configuration files for your block-producing node if you don't have them already:

mkdir config-files
cd config-files
Expand Down
2 changes: 1 addition & 1 deletion cardano-tutorials/node-setup/000_AWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ To do so, please follow the steps below:

![Volume Actions.](images/volume_actions.png)

7. In the _Modify Volume_ diaglog, select a size of 24 and click _Modify_, then confirm in the next dialog.
7. In the _Modify Volume_ dialog, select a size of 24 and click _Modify_, then confirm in the next dialog.

![Modify Volume.](images/modify_volume.png)

Expand Down
2 changes: 1 addition & 1 deletion cardano-tutorials/node-setup/000_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ We need the following packages and tools on our Linux system to download the sou
- the version control system ``git``,
- the ``gcc`` C-compiler,
- C++ support for ``gcc``,
- developer libraries for the the arbitrary precision library ``gmp``,
- developer libraries for the arbitrary precision library ``gmp``,
- developer libraries for the compression library ``zlib``,
- developer libraries for ``systemd``,
- developer libraries for ``ncurses``,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Or with the command line using:
wget https://hydra.iohk.io/job/Cardano/cardano-node/cardano-deployment/latest-finished/download/1/shelley_testnet-genesis.json
wget https://hydra.iohk.io/job/Cardano/cardano-node/cardano-deployment/latest-finished/download/1/shelley_testnet-topology.json

Starting the the node uses the command `cardano-node run` and a set of options.
Starting the node uses the command `cardano-node run` and a set of options.

You can get the complete list of available options with `cardano-node run --help`

Expand Down
12 changes: 6 additions & 6 deletions cardano-tutorials/node-setup/012_understanding-config-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ Here is a brief description of each parameter. You can learn more in the [spec](

The default `config.json` file that we downloaded is shown below.

This file has __4__ sections that allow you to have full control on what your node does and how the informtion is presented.
This file has __4__ sections that allow you to have full control on what your node does and how the information is presented.

__NOTE Due to how the config.json file is generated, fields on the real file are shown in a different (less coherent) order. Here we present them in a more structured way__

Expand All @@ -161,9 +161,9 @@ Note that in this example we are using the SimpleView. This will send the output
"GenesisFile": "shelley_testnet-genesis.json",
"RequiresNetworkMagic": "RequiresMagic",

### 2 Update parameteres
### 2 Update parameters

This protocol version number gets used by block producing nodes as part of the system for agreeing on and synchronising protocol updates.You just need to be aware of the latest version supported by the network. You dont need to change anything here.
This protocol version number gets used by block producing nodes as part of the system for agreeing on and synchronising protocol updates.You just need to be aware of the latest version supported by the network. You don't need to change anything here.

"ApplicationName": "cardano-sl",
"ApplicationVersion": 0,
Expand All @@ -174,15 +174,15 @@ This protocol version number gets used by block producing nodes as part of the s

### 3 Tracing

`Tracers` tell your node what information you are interested in when logging. Like switches that you can turn ON or OFF according the type and quantity of information that you are interesetd in. This provides fairly coarse grained control, but it is relatively efficient at filtering out unwanted trace output.
`Tracers` tell your node what information you are interested in when logging. Like switches that you can turn ON or OFF according the type and quantity of information that you are interested in. This provides fairly coarse grained control, but it is relatively efficient at filtering out unwanted trace output.

The node can run in either the `SimpleView` or `LiveView`. The `SimpleView` just uses standard output, optionally with log output. The `LiveView` is a text console with a live view of various node metrics.

`TurnOnLogging`: Enbles or disables logging overall.
`TurnOnLogging`: Enables or disables logging overall.

`TurnOnLogMetrics`: Enable the collection of various OS metrics such as memory and CPU use. These metrics can be directed to the logs or monitoring backends.

`setupBackends`, `defaultBackends`, `hasEKG`and `hasPrometheus`: The system supports a number of backends for logging and monitoring. This settings list the the backends available to use in the configuration. The logging backend is called `Katip`.
`setupBackends`, `defaultBackends`, `hasEKG`and `hasPrometheus`: The system supports a number of backends for logging and monitoring. This settings lists the backends available to use in the configuration. The logging backend is called `Katip`.
Also enable the EKG backend if you want to use the EKG or Prometheus monitoring interfaces.

`setupScribes` and `defaultScribes`: For the Katip logging backend we must set up outputs (called scribes) The available types of scribe are:
Expand Down
Loading