Skip to content

Commit

Permalink
Merge pull request #4882 from input-output-hk/newhoggy/fix-some-markd…
Browse files Browse the repository at this point in the history
…own-links

Fix some markdown links
  • Loading branch information
newhoggy authored Feb 23, 2023
2 parents c731312 + 4500e1b commit 336d72f
Show file tree
Hide file tree
Showing 15 changed files with 36 additions and 20 deletions.
2 changes: 1 addition & 1 deletion cardano-node/ChangeLog.md
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@ None
- Remove ledger-based validation of `Datum`. This is now done entirely by Plutus
on deserialisation. (#2757)
- Add documentation on all ledger events. This can be found at
https://github.com/input-output-hk/cardano-ledger/blob/master/docs/LedgerEvents.md(#2778)
https://github.com/input-output-hk/cardano-ledger/blob/master/docs/LedgerEvents.md (#2778)
- In the Alonzo era, extend the epoch info provided by Plutus to allow time
translation arbitrarily into the future. This pertains to a bug in consensus
which was allowing arbitrarily distant translation only in the last era. This
Expand Down
2 changes: 1 addition & 1 deletion cardano-tracer/docs/cardano-rtview.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ $ ./cardano-tracer -c minimal-example-rtview.json

## Node's Side

Now, open your node's configuration file (if you took it from [Hydra](https://hydra.iohk.io/job/Cardano/cardano-node/cardano-deployment/latest-finished/download/1/index.html), it's `mainnet-config.json`) and add the following lines in it:
Now, open your node's configuration file (if you took it from the [Cardano World Repository](https://book.world.dev.cardano.org/environments.html), it's `config.json`) and add the following lines in it:

```
"UseTraceDispatcher": true,
Expand Down
4 changes: 2 additions & 2 deletions cardano-tracer/docs/cardano-tracer.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Please note that `cardano-tracer` can work as an aggregator as well: _one_ `card

# Build and run

Please make sure you have [Nix installed](https://nixos.org/guides/install-nix.html).
Please make sure you have [Nix installed](https://nixos.org/download.html#download-nix).

First of all, go to Nix shell using the following command (from the root of `cardano-node` repository):

Expand Down Expand Up @@ -250,7 +250,7 @@ Please use `ConnectTo`-based scenario only if you really need it. Otherwise, it

The field `networkMagic` specifies the value of network magic. It is an integer constant from the genesis file, the node uses this value for the network handshake with peers. Since `cardano-tracer` should be connected to the node, it needs that network magic.

The value from the example above, `764824073`, is taken from the Shelley genesis file for [Mainnet](https://hydra.iohk.io/job/Cardano/cardano-node/cardano-deployment/latest-finished/download/1/index.html). Please take this value from the genesis file your nodes are launched with.
The value from the example above, `764824073`, is taken from the Shelley genesis file for [Mainnet](https://book.world.dev.cardano.org/environments.html). Please take this value from the genesis file your nodes are launched with.

## Requests

Expand Down
2 changes: 1 addition & 1 deletion doc/New Tracing Quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ advice to use namespaces for any analysis tools of traces!

### Configuration of new tracing

In Cardano a default configuration is given in the module [Link text Here](https://link-url-here.or [Cardano.Node.Tracing.DefaultTraceConfig](https://github.com/input-output-hk/cardano-node/blob/master/cardano-node/src/Cardano/Node/Tracing/DefaultTraceConfig.hs). In the config file all entries of the default configuration can be overridden. To remove a frequency limiter, define a limiter with maxFrequency 0.0.
In Cardano a default configuration is given in the module [Cardano.Node.Tracing.DefaultTraceConfig](https://github.com/input-output-hk/cardano-node/blob/master/cardano-node/src/Cardano/Node/Tracing/DefaultTraceConfig.hs). In the config file all entries of the default configuration can be overridden. To remove a frequency limiter, define a limiter with maxFrequency 0.0.

1. Specify a filter for the severity of the messages you want to see, e.g.:

Expand Down
2 changes: 1 addition & 1 deletion doc/getting-started/understanding-config-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ The `genesis.json` file looks like the one below.
"securityParam": 2160
}
```
Here is a brief description of each parameter. You can learn more in the [spec](https://github.com/input-output-hk/cardano-ledger-specs/tree/master/shelley/chain-and-ledger/executable-spec).
Here is a brief description of each parameter. You can learn more in the [spec](https://github.com/input-output-hk/cardano-ledger/tree/master/eras/shelley/impl).


| PARAMETER | MEANING |
Expand Down
8 changes: 4 additions & 4 deletions doc/reference/byron-genesis.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Byron genesis data format

Please see [the byron ledger spec](https://hydra.iohk.io/job/Cardano/cardano-ledger-specs/byronLedgerSpec/latest/download-by-type/doc-pdf/ledger-spec) which will describe the changes and deviations of these values in more detail while moving from the Byron era to the OBFT era.
Please see [the byron ledger spec](https://github.com/input-output-hk/cardano-ledger/releases/latest/download/byron-ledger.pdf) which will describe the changes and deviations of these values in more detail while moving from the Byron era to the OBFT era.

Let's start with an example:

Expand Down Expand Up @@ -101,7 +101,7 @@ slot duration, in milliseconds.
#### softforkRule
Values defining softfork resolution rule. When the stake belonging to block issuers, issuing a given block version, is greater than the current softfork resolution threshold, this block version is adopted. The current softfork resolution threshold is determined as follows: If a proposal is confirmed at the `c`-th epoch, softfork resolution threshold at a later `t`-th epoch will be `max minThd (spInitThd - (t - c) * spThdDecrement)`.

The proportion of ADA that these threshold values (`initThd`,`minThd`,`thdDecrement`) represent is calculated by dividing by 10<sup>15</sup>. This is an artifact of the old implementation as it would make more sense if the proportion was calculated by the total amount of circulating ADA which is 45 x 10<sup>15</sup>. Note that in the specification we only make use of the `minThd`. See [here](https://hydra.iohk.io/build/1084792/download/1/ledger-spec.pdf) in section 6.5.4 Adoption threshold.
The proportion of ADA that these threshold values (`initThd`,`minThd`,`thdDecrement`) represent is calculated by dividing by 10<sup>15</sup>. This is an artifact of the old implementation as it would make more sense if the proportion was calculated by the total amount of circulating ADA which is 45 x 10<sup>15</sup>. Note that in the specification we only make use of the `minThd`. See [here](https://github.com/input-output-hk/cardano-ledger/releases/latest/download/byron-ledger.pdf) in section 6.5.4 Adoption threshold.

- `initThd` - Initial threshold (right after proposal is confirmed).
- `minThd` - minimal threshold (i.e. threshold can't become less than this one).
Expand Down Expand Up @@ -146,8 +146,8 @@ The key `protocolMagic` defines the protocol magic number. When the protocol mag
The `protocolMagic` value can either be an object with the two fields described above, or just a plain integer. In the latter case, `requiresNetworkMagic` will take the default value of `RequiresMagic`.

Relevant:
- [cardano-ledger - Genesis test](https://github.com/input-output-hk/cardano-ledger/blob/master/cardano-ledger/test/Test/Cardano/Chain/Genesis/Json.hs#L69)
- [cardano-ledger - ProtocolMagic](https://github.com/input-output-hk/cardano-ledger/blob/master/crypto/src/Cardano/Crypto/ProtocolMagic.hs)
- [cardano-ledger - Genesis test](https://github.com/input-output-hk/cardano-ledger/blob/master/eras/byron/ledger/impl/test/Test/Cardano/Chain/Genesis/Json.hs#L69)
- [cardano-ledger - ProtocolMagic](https://github.com/input-output-hk/cardano-ledger/blob/master/eras/byron/crypto/src/Cardano/Crypto/ProtocolMagic.hs)

## heavyDelegation
The key `heavyDelegation` contains an information about heavyweight delegation:
Expand Down
2 changes: 1 addition & 1 deletion doc/reference/native-tokens/01-multi-assets.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Multi-asset support

From the Mary ledger upgrade and onwards, Cardano supports [multi-assets](https://hydra.iohk.io/job/Cardano/cardano-ledger-specs/specs.shelley-ma/latest/download-by-type/doc-pdf/shelley-ma), also referred to as a *native tokens* feature. This feature extends the ledger’s accounting infrastructure (originally designed for processing ada-only transactions) to accommodate transactions using a range of assets. These assets include ada and a variety of user-defined token types, the mixture of which can be transacted in a single tx output.
From the Mary ledger upgrade and onwards, Cardano supports [multi-assets](https://github.com/input-output-hk/cardano-ledger/releases/download/cardano-ledger-spec-2023-01-18/mary-ledger.pdf), also referred to as a *native tokens* feature. This feature extends the ledger’s accounting infrastructure (originally designed for processing ada-only transactions) to accommodate transactions using a range of assets. These assets include ada and a variety of user-defined token types, the mixture of which can be transacted in a single tx output.

## What is a multi-asset?

Expand Down
2 changes: 1 addition & 1 deletion doc/reference/plutus/babbage-script-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Below is an example that shows how to use a reference Plutus spending script wit
+ sending ada to the Plutus script address
+ spending ada at the Plutus script address using the Plutus reference script
+ creating a read only reference tx output
+ the creation of the reference [minting script](scripts/plutus/scripts/v2) at a transaction output.
+ the creation of the reference [minting script](../../../scripts/plutus/scripts/v2) at a transaction output.

In this example we will use the [Required Redeemer](../../../scripts/plutus/scripts/v2/required-redeemer.plutus) Plutus spending script and a [minting script](../../../scripts/plutus/scripts/v2/minting-script.plutus). In order to execute a reference Plutus spending script, we require the following:

Expand Down
2 changes: 1 addition & 1 deletion doc/reference/plutus/plutus-minting-script-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ process involving:
+ the creation of the `AlwaysSucceeds` Plutus minting script (i.e. anybody can mint)
+ the creation of a transaction that mints multi-assets using the `AlwaysSucceeds` Plutus minting script

In this example we will use the [anyone can mint](../../../plutus-example/plutus-example/src/Cardano/PlutusExample/MintingScript.hs) Plutus minting script. To execute it, we require the following:
In this example we will use the [anyone can mint](https://github.com/input-output-hk/plutus-apps/blob/main/plutus-example/src/PlutusExample/PlutusVersion1/MintingScript.hs) Plutus minting script. To execute it, we require the following:

- Collateral tx input(s) that are provided and forfeited if the Plutus script fails to execute.
- Serialization of the Plutus script in the text envelope format (required for cardano-cli).
Expand Down
2 changes: 1 addition & 1 deletion doc/reference/plutus/plutus-spending-script-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ process involving:
+ sending ADA to the Plutus script address
+ spending ADA at the Plutus script address

In this example we will use the [AlwaysSucceeds](../../../plutus-example/plutus-example/src/Cardano/PlutusExample/AlwaysSucceeds.hs) Plutus spending script. In order to execute a Plutus spending script, we require the following:
In this example we will use the [AlwaysSucceeds](https://github.com/input-output-hk/plutus-apps/blob/main/plutus-example/src/PlutusExample/PlutusVersion1/AlwaysSucceeds.hs) Plutus spending script. In order to execute a Plutus spending script, we require the following:

- Collateral tx input(s) - these are provided and are forfeited in the event the Plutus script fails to execute.
- A Plutus tx output with accompanying datum hash. This is the tx output that sits at the Plutus script address. It must have a datum hash, otherwise, it is unspendable.
Expand Down
2 changes: 1 addition & 1 deletion doc/reference/tx-metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,5 +163,5 @@ Detailed Schema:

Here are some materials for further reading:

+ Tx metadata motivation and use: [Design Specification for Delegation and Incentives in Cardano](https://hydra.iohk.io/build/3744897/download/1/delegation_design_spec.pdf), p 53.
+ Tx metadata motivation and use: [Design Specification for Delegation and Incentives in Cardano](https://github.com/input-output-hk/cardano-ledger/releases/latest/download/shelley-delegation.pdf), p 53.
+ [Tx metadata in wallet-CLI](https://github.com/input-output-hk/cardano-wallet/wiki/TxMetadata).
2 changes: 1 addition & 1 deletion doc/stake-pool-operations/8_register_stakepool.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ After certificate submission, relay nodes will be added to the topology file ena

**Related topics:**

- [Establishing connectivity between nodes](https://docs.cardano.org/en/latest/getting-started/stake-pool-operators/establishing-connectivity-between-the-nodes.html)
- [Establishing connectivity between nodes](https://docs.cardano.org/development-guidelines/operating-a-stake-pool/node-connectivity)

### Generate Stake pool registration certificate

Expand Down
18 changes: 18 additions & 0 deletions mlc_config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"ignorePatterns": [
{
"pattern": "^(http|https)://127.0.0.1"
},
{
"pattern": "https://iohk.myjetbrains.com"
},
{
"pattern": "https://iohk.zendesk.com"
}
],
"retryOn429": true,
"aliveStatusCodes": [
200,
206
]
}
4 changes: 1 addition & 3 deletions scripts/benchmarking/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
if the `dist-newstyle` directory is absent.

Before you can use `--nix`, you'll need to set up Nix -- please see
the `Building under Nix` section [here](https://github.com/input-output-hk/cardano-node/blob/master/doc/building-running.md#building-under-nix)
the `Building cardano-node with Nix` section [here](https://github.com/input-output-hk/cardano-node/blob/master/doc/getting-started/building-the-node-using-nix.md#building-cardano-node-with-nix)

2. using Cabal -- if you already have the development context set up
(dependencies, GHC, etc.), then this is the fastest way to iterate.
Expand Down Expand Up @@ -153,8 +153,6 @@ The `submit-tx.sh` script by default sends the transaction to node with node id

NB: This will submit a tx based on the `configuration/defaults/liveview/config-0.yaml` config file.

See cardano-cli's [Transactions](../cardano-node/README.md#transactions) section for instructions on how to generate a tx.

## Startup testnet with dns

You can run:
Expand Down
2 changes: 1 addition & 1 deletion trace-forward/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# trace-forward

This library specifies two protocols allowing to forward different information from the node to external applications (for example, `cardano-tracer` or `cardano-wallet`). These protocols are built upon [`typed-protocols`](https://github.com/input-output-hk/ouroboros-network/tree/master/typed-protocols).
This library specifies two protocols allowing to forward different information from the node to external applications (for example, `cardano-tracer` or `cardano-wallet`). These protocols are built upon [`typed-protocols`](https://github.com/input-output-hk/typed-protocols).

The first one allows forwarding `TraceObject`s from the node to external applications. You can think of `TraceObject` as a log item, which will be saved in log files.

Expand Down

0 comments on commit 336d72f

Please sign in to comment.