diff --git a/docs/ADR-0-Documenting-Architecture-Decisions.md b/docs/ADR-0-Documenting-Architecture-Decisions.md index bcf34b0..fc7c42b 100644 --- a/docs/ADR-0-Documenting-Architecture-Decisions.md +++ b/docs/ADR-0-Documenting-Architecture-Decisions.md @@ -32,7 +32,7 @@ We will keep a collection of records for "architecturally significant" decisions An architecture decision record is a short text file in a format similar to an Alexandrian pattern. (Though the decisions themselves are not necessarily patterns, they share the characteristic balancing of forces.) Each record describes a set of forces and a single decision in response to those forces. Note that the decision is the central piece here, so specific forces may appear in multiple ADRs. -We will keep ADRs in the project wiki under https://github.com/input-output-hk/cardano-node/wiki/Architecture-Decision-Records +We will keep ADRs in the project wiki under https://github.com/input-output-hk/cardano-node-wiki/wiki/Architecture-Decision-Records We should use a lightweight text formatting language like Markdown. diff --git a/docs/Benchmarking-Hacking.md b/docs/Benchmarking-Hacking.md index b175da8..6430214 100644 --- a/docs/Benchmarking-Hacking.md +++ b/docs/Benchmarking-Hacking.md @@ -7,7 +7,7 @@ Clone the GitHub repo: ```console -$ git clone https://github.com/input-output-hk/cardano-node/ +$ git clone https://github.com/intersectmbo/cardano-node/ ... ... $ cd cardano-node @@ -18,7 +18,7 @@ nix bug with ```import-from-derivation```: ```console $ nix flake show -git+file:///home/fmaste/Workspace/GitHub/input-output-hk/cardano-node?ref=master&rev=2df4e4130685f27ad5d9d732b1df266b921c585f +git+file:///home/fmaste/Workspace/GitHub/intersectmbo/cardano-node?ref=master&rev=2df4e4130685f27ad5d9d732b1df266b921c585f ├───apps │ ├───x86_64-darwin trace: To make project.plan-nix for cardano-node a fixed-output derivation but not materialized, set `plan-sha256` to the output of the 'calculateMaterializedSha' script in 'passthru'. @@ -120,7 +120,7 @@ wb-wrapped start --batch-name plain --profile-name default-bage --profile /nix/s And starts multiple cardano nodes as: ```console -/home/fmaste/Workspace/GitHub/input-output-hk/cardano-node/dist-newstyle/build/x86_64-linux/ghc-8.10.7/cardano-node-1.33.0/x/cardano-node/build/cardano-node/cardano-node +RTS -sghc-rts-report.txt -RTS run --config config.json --database-path run/current/node-5/db-testnet --topology topology.json --host-addr 127.0.0.1 --port 30005 --socket-path node.socket --tracer-socket-path-connect ../tracer/tracer.socket --shelley-vrf-key ../genesis/node-keys/node-vrf5.skey --shelley-kes-key ../genesis/node-keys/node-kes5.skey --shelley-operational-certificate ../genesis/node-keys/node5.opcert --shutdown-on-slot-synced 300 +RTS -N2 -I0 -A16m -qg -qb --disable-delayed-os-memory-return -RTS +/home/fmaste/Workspace/GitHub/intersectmbo/cardano-node/dist-newstyle/build/x86_64-linux/ghc-8.10.7/cardano-node-1.33.0/x/cardano-node/build/cardano-node/cardano-node +RTS -sghc-rts-report.txt -RTS run --config config.json --database-path run/current/node-5/db-testnet --topology topology.json --host-addr 127.0.0.1 --port 30005 --socket-path node.socket --tracer-socket-path-connect ../tracer/tracer.socket --shelley-vrf-key ../genesis/node-keys/node-vrf5.skey --shelley-kes-key ../genesis/node-keys/node-kes5.skey --shelley-operational-certificate ../genesis/node-keys/node5.opcert --shutdown-on-slot-synced 300 +RTS -N2 -I0 -A16m -qg -qb --disable-delayed-os-memory-return -RTS ``` ## Infrastructure and code hierarchy @@ -132,9 +132,9 @@ We're currently not using docker or OCI at all, we're using plain regular ### Services -- [nix/nixos/cardano-node.service](https://github.com/input-output-hk/cardano-node/blob/master/nix/nixos/cardano-node-service.nix) -- [nix/nixos/cardano-tracer.service](https://github.com/input-output-hk/cardano-node/blob/master/nix/nixos/cardano-tracer-service.nix) -- [nix/nixos/tx-generator.service](https://github.com/input-output-hk/cardano-node/blob/master/nix/nixos/tx-generator-service.nix) +- [nix/nixos/cardano-node.service](https://github.com/intersectmbo/cardano-node/blob/master/nix/nixos/cardano-node-service.nix) +- [nix/nixos/cardano-tracer.service](https://github.com/intersectmbo/cardano-node/blob/master/nix/nixos/cardano-tracer-service.nix) +- [nix/nixos/tx-generator.service](https://github.com/intersectmbo/cardano-node/blob/master/nix/nixos/tx-generator-service.nix) This services are used for running on three contexts: 1. AWS @@ -148,12 +148,12 @@ Looking at the code you can see how it does 1 (AWS) and 2 (local). ### Workbench Workbench (Links are to master branch but there's a workbench-master branch): -1. [Top-level wb script](https://github.com/input-output-hk/cardano-node/blob/master/nix/workbench/wb) +1. [Top-level wb script](https://github.com/intersectmbo/cardano-node/blob/master/nix/workbench/wb) 1. First thought: Why this scripts starts with ```#!/usr/bin/env bash```, shouldn't it be a ```/nix/store/sdfsjdlhflsdhflsdkjh```? -2. [Profile computation (profile.sh)](https://github.com/input-output-hk/cardano-node/blob/master/nix/workbench/profile/profile.sh) -3. [Run allocation & starting](https://github.com/input-output-hk/cardano-node/blob/master/nix/workbench/run.sh) -4. [Run scenarios](https://github.com/input-output-hk/cardano-node/blob/master/nix/workbench/scenario.sh) +2. [Profile computation (profile.sh)](https://github.com/intersectmbo/cardano-node/blob/master/nix/workbench/profile/profile.sh) +3. [Run allocation & starting](https://github.com/intersectmbo/cardano-node/blob/master/nix/workbench/run.sh) +4. [Run scenarios](https://github.com/intersectmbo/cardano-node/blob/master/nix/workbench/scenario.sh) ### About profile computation @@ -171,7 +171,7 @@ Configuration generation does heavy use of [jq](https://stedolan.github.io/jq/) #### ```profiles.json``` -[```workbench/default.nix```](https://github.com/input-output-hk/cardano-node/blob/master/nix/workbench/default.nix) has the Nix derivation that calls the profile builder: +[```workbench/default.nix```](https://github.com/intersectmbo/cardano-node/blob/master/nix/workbench/default.nix) has the Nix derivation that calls the profile builder: ``` ... ## materialise-profile :: ProfileNix -> BackendProfile -> Profile @@ -182,7 +182,7 @@ profile = materialise-profile backendProfile = backend.materialise-profile { inherit profileNix; }; }; ``` -and [```workbench/profile.nix```](https://github.com/input-output-hk/cardano-node/blob/master/nix/workbench/profile/profile.nix) does at the end: +and [```workbench/profile.nix```](https://github.com/intersectmbo/cardano-node/blob/master/nix/workbench/profile/profile.nix) does at the end: ``` '' mkdir $out @@ -194,9 +194,9 @@ cp $tracerServicePath $out/tracer-service.json wb profile node-specs $out/profile.json > $out/node-specs.json '' ``` -after importing [```workbench/default.nix```](https://github.com/input-output-hk/cardano-node/blob/master/nix/workbench/default.nix). +after importing [```workbench/default.nix```](https://github.com/intersectmbo/cardano-node/blob/master/nix/workbench/default.nix). -The only thing ```wb``` needs is the profile outputs as they are created by [```workbench/profiles/default.nix```](https://github.com/input-output-hk/cardano-node/blob/master/nix/workbench/default.nix). +The only thing ```wb``` needs is the profile outputs as they are created by [```workbench/profiles/default.nix```](https://github.com/intersectmbo/cardano-node/blob/master/nix/workbench/default.nix). ### Modes diff --git a/docs/Byron-Rewrite-Node-Demo-#1.md b/docs/Byron-Rewrite-Node-Demo-#1.md index d89ce14..807d465 100644 --- a/docs/Byron-Rewrite-Node-Demo-#1.md +++ b/docs/Byron-Rewrite-Node-Demo-#1.md @@ -7,7 +7,7 @@ This is a full integration of the three core components, Networking, Ledger, and Independence of nodes is enabled by updates in the networking code that allow the nodes to communicate via TCP. We could run this demo across multiple machines by modifying the topology of the network, however we’re currently limited to local transaction submission. The Consensus layer has added a real mempool containing generalised transactions, i.e. transactions , delegation certificates, or update proposals and votes. We will be able to show submission of these at a later date, but for now we will only be submitting transactions. The Ledger code is mostly the same in terms of functionality as the previous demo of the Consensus Layer. -There are still some features of the node missing that will be included over the coming weeks. For a comprehensive overview of the current capabilities and limitations, see the [this page](https://github.com/input-output-hk/cardano-node/wiki/Cardano-Haskell-Node-Capabilities). +There are still some features of the node missing that will be included over the coming weeks. For a comprehensive overview of the current capabilities and limitations, see the [this page](https://github.com/input-output-hk/cardano-node-wiki/wiki/Cardano-Haskell-Node-Capabilities). # What are we looking at? - We will set up three core nodes, which will be communicating with each other using the full network stack. diff --git a/docs/Byron-Rewrite-Node-Demo-#2.md b/docs/Byron-Rewrite-Node-Demo-#2.md index 69a604c..d4dda0f 100644 --- a/docs/Byron-Rewrite-Node-Demo-#2.md +++ b/docs/Byron-Rewrite-Node-Demo-#2.md @@ -5,7 +5,7 @@ This demo is the second demo of a cluster of independent Cardano nodes in the Sh The previous demo showed the full integration of all the major components. This demo focuses on the consensus chain state functionality. Whereas the previous demo used the mock implementation of this functionality, this time we are using the full implementation. The full implementation uses the on-disk storage components (immutable, volatile and ledger), and provides efficient, concurrent, implementations of the chain state API. -There are still some features of the node missing that will be included over the coming weeks. For a comprehensive overview of the current capabilities and limitations, see the [this page](https://github.com/input-output-hk/cardano-node/wiki/Cardano-Haskell-Node-Capabilities). +There are still some features of the node missing that will be included over the coming weeks. For a comprehensive overview of the current capabilities and limitations, see the [this page](https://github.com/input-output-hk/cardano-node-wiki/wiki/Cardano-Haskell-Node-Capabilities). # What are we looking at? diff --git a/docs/Byron-Rewrite-Node-Demo-#3.md b/docs/Byron-Rewrite-Node-Demo-#3.md index f1c0ea5..d313ed2 100644 --- a/docs/Byron-Rewrite-Node-Demo-#3.md +++ b/docs/Byron-Rewrite-Node-Demo-#3.md @@ -9,7 +9,7 @@ This demo focuses on mainnet compatibility. In this demo we will show our new no We will also demonstrate the Byron network proxy. This is a component that understands both the old Byron network protocols and the new Shelley node network protocols and allows the two to exchange data. In this demo we will show that it can download blocks from Byron mainnet relays nodes and allow Shelley nodes to download blocks from it. In future demos we will show information flowing in the opposite direction, both blocks and transactions. -There are still some features of the node missing that will be included over the coming weeks. For a comprehensive overview of the current capabilities and limitations, see the [this page](https://github.com/input-output-hk/cardano-node/wiki/Cardano-Haskell-Node-Capabilities). +There are still some features of the node missing that will be included over the coming weeks. For a comprehensive overview of the current capabilities and limitations, see the [this page](https://github.com/input-output-hk/cardano-node-wiki/wiki/Cardano-Haskell-Node-Capabilities). # What are we looking at? diff --git a/docs/Cardano-Haskell-Node-(Byron-Re-Write)-Status.md b/docs/Cardano-Haskell-Node-(Byron-Re-Write)-Status.md index ee82c4d..c49763b 100644 --- a/docs/Cardano-Haskell-Node-(Byron-Re-Write)-Status.md +++ b/docs/Cardano-Haskell-Node-(Byron-Re-Write)-Status.md @@ -1,6 +1,6 @@ Hello all, this page will be used to keep a static status of the Byron Re-Write node. -This supports the [Haskell Node Capabilities](https://github.com/input-output-hk/cardano-node/wiki/Cardano-Haskell-Node-Capabilities "Byron Haskell Node Capabilities") page. +This supports the [Haskell Node Capabilities](https://github.com/input-output-hk/cardano-node-wiki/wiki/Cardano-Haskell-Node-Capabilities "Byron Haskell Node Capabilities") page. The work below is that specifically required to make the node _**public test and main net ready**_. diff --git a/docs/Cardano-node-required-checks.md b/docs/Cardano-node-required-checks.md index 7fbe5f4..33f68fd 100644 --- a/docs/Cardano-node-required-checks.md +++ b/docs/Cardano-node-required-checks.md @@ -1,6 +1,6 @@ ## Checks for the `master` branch -These are the agreed-upon required checks for the [`cardano-node` repository](https://github.com/input-output-hk/cardano-node). +These are the agreed-upon required checks for the [`cardano-node` repository](https://github.com/intersectmbo/cardano-node). Whenever there is a variation to this document, the required checks for the `cardano-node` repository should be updated accordingly. diff --git a/docs/Debugging-cardano-cli-errors-on-a-testnet.md b/docs/Debugging-cardano-cli-errors-on-a-testnet.md index 87f385b..0be103a 100644 --- a/docs/Debugging-cardano-cli-errors-on-a-testnet.md +++ b/docs/Debugging-cardano-cli-errors-on-a-testnet.md @@ -2,7 +2,7 @@ This document is intended for Cardano node and `cardano-cli` (CLI) users, as well as Cardano developers that wish to investigate CLI problems. -We recommend making sure the `cardano-node` tests pass before starting to debug a problem. Additionally, take a look at the [Consensus sanity checklist](https://input-output-hk.github.io/ouroboros-consensus/docs/for-developers/SanityChecks). +We recommend making sure the `cardano-node` tests pass before starting to debug a problem. Additionally, take a look at the [Consensus sanity checklist](https://ouroboros-consensus.cardano.intersectmbo.org/docs/for-developers/SanityChecks). Once the node tests successfully pass, and you've read through the Consensus checklist, collect node logs to speed up the process of finding the cause of a problem. Below, we describe the steps to run a node that connects to a given testnet and get access to a `cardano-cli` that can be used to communicate with the node. These instructions work on a Unix environment with `nix` installed. @@ -11,7 +11,7 @@ Clone [cardano-world](https://github.com/input-output-hk/cardano-world) and chec Once inside the `cardano-world` directory, enter a `nix` shell which has `cardano-node` in its path: ```sh -nix shell github:input-output-hk/cardano-node\?ref=8.1.1\#cardano-node +nix shell github:intersectmbo/cardano-node\?ref=8.1.1\#cardano-node ``` where `8.1.1` should be replaced with the version intended to be tested. Once inside the `nix` shell, we can check whether the `cardano-node` executable is in our `PATH`: diff --git a/docs/Docker.md b/docs/Docker.md index ce5164b..160eff5 100644 --- a/docs/Docker.md +++ b/docs/Docker.md @@ -15,7 +15,7 @@ $ docker pull inputoutput/cardano-node:master ​ ## How To Configure ​ -Example configurations are available in the [cardano-node](https://github.com/input-output-hk/cardano-node/tree/master/configuration/defaults) repository: +Example configurations are available in the [cardano-node](https://github.com/intersectmbo/cardano-node/tree/master/configuration/defaults) repository: ​ ``` configuration/ diff --git a/docs/Mixed-Cluster,--Integration-test-of-legacy-Cardano-SL-and-Byron-rewrite-node.md b/docs/Mixed-Cluster,--Integration-test-of-legacy-Cardano-SL-and-Byron-rewrite-node.md index c27b548..ae3aa1a 100644 --- a/docs/Mixed-Cluster,--Integration-test-of-legacy-Cardano-SL-and-Byron-rewrite-node.md +++ b/docs/Mixed-Cluster,--Integration-test-of-legacy-Cardano-SL-and-Byron-rewrite-node.md @@ -1,4 +1,4 @@ -`CI` shall be running for every commit a test on a mixed cluster of legacy Cardano SL nodes (https://github.com/input-output-hk/cardano-sl/) and new nodes from Byron-rewrite (this repo: https://github.com/input-output-hk/cardano-node/). +`CI` shall be running for every commit a test on a mixed cluster of legacy Cardano SL nodes (https://github.com/input-output-hk/cardano-sl/) and new nodes from Byron-rewrite (this repo: https://github.com/intersectmbo/cardano-node/). The two worlds are interconnected using the Byron proxy (https://github.com/input-output-hk/cardano-byron-proxy/). Either side can initiate transactions and mint blocks. diff --git a/docs/New Tracing Quickstart.md b/docs/New Tracing Quickstart.md index 1aeb809..47b1c67 100644 --- a/docs/New Tracing Quickstart.md +++ b/docs/New Tracing Quickstart.md @@ -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 [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/intersectmbo/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.: @@ -97,7 +97,7 @@ Configuration can be written in JSON and YAML, we have shown the examples in YAM ### Configuration and use of cardano-tracer `cardano-tracer` is a part of the new tracing infrastructure. It is a separate service that accepts different messages from the node and handles them. -So it is assumed that if you want to use the new tracing infrastructure - you will use `cardano-tracer`. Please read its [documentation](https://github.com/input-output-hk/cardano-node/blob/master/cardano-tracer/docs/cardano-tracer.md) for more details. +So it is assumed that if you want to use the new tracing infrastructure - you will use `cardano-tracer`. Please read its [documentation](https://github.com/intersectmbo/cardano-node/blob/master/cardano-tracer/docs/cardano-tracer.md) for more details. This example describes the simplest case, when the node and `cardano-tracer` on the same machine. @@ -152,8 +152,8 @@ messages with the current default configuration: This document describes the underlying library trace-dispatcher: -[trace-dispatcher: efficient, simple and flexible program tracing](https://github.com/input-output-hk/cardano-node/blob/master/trace-dispatcher/doc/trace-dispatcher.md) +[trace-dispatcher: efficient, simple and flexible program tracing](https://github.com/intersectmbo/cardano-node/blob/master/trace-dispatcher/doc/trace-dispatcher.md) This document describes a seperate service for logging and monitoring Cardano nodes: -[Cardano Tracer](https://github.com/input-output-hk/cardano-node/blob/master/cardano-tracer/docs/cardano-tracer.md) +[Cardano Tracer](https://github.com/intersectmbo/cardano-node/blob/master/cardano-tracer/docs/cardano-tracer.md) diff --git a/docs/Running-tests.md b/docs/Running-tests.md index 2c8c215..92d3331 100644 --- a/docs/Running-tests.md +++ b/docs/Running-tests.md @@ -6,7 +6,7 @@ cabal test all --enable-tests Many of tests are automatically run in CI in PRs. For an exact list of which tests are run, -please see the "Run tests" step in [haskell.yml](https://github.com/input-output-hk/cardano-node/blob/master/.github/workflows/haskell.yml) Github +please see the "Run tests" step in [haskell.yml](https://github.com/intersectmbo/cardano-node/blob/master/.github/workflows/haskell.yml) Github Actions workflow file. # Types of tests @@ -72,7 +72,7 @@ The annotations can be for things like: * Command line arguments used to run processes * `stdout` and `stderr` of processes that have been run -A walkthrough of the leadership-schedule integration test can be found in this PR: https://github.com/input-output-hk/cardano-node/pull/5082 +A walkthrough of the leadership-schedule integration test can be found in this PR: https://github.com/intersectmbo/cardano-node/pull/5082 # Tips & tricks diff --git a/docs/Style-guide.md b/docs/Style-guide.md index 94f0459..dc17084 100644 --- a/docs/Style-guide.md +++ b/docs/Style-guide.md @@ -18,7 +18,7 @@ General guide lines ### Code linting and formatting tools `stylish-haskell` is used for automatic code formatting and `hlint` for linting. Those are configured using `.stylish-haskell.yml` and `.hlint.yml` files in the repository root. -If you would like to check your changes before committing them, you can use the following [`.git/hooks/pre-commit` hook](https://github.com/input-output-hk/cardano-node/blob/master/scripts/githooks/haskell-style-lint). +If you would like to check your changes before committing them, you can use the following [`.git/hooks/pre-commit` hook](https://github.com/intersectmbo/cardano-node/blob/master/scripts/githooks/haskell-style-lint). It requires `stylish-haskell` and `hlint` to be available in `$PATH` and runs against the staged files. ### Line Length diff --git a/docs/cardano-node-and-DataPoints:-demo.md b/docs/cardano-node-and-DataPoints:-demo.md index a5c2ea1..b5e1f3e 100644 --- a/docs/cardano-node-and-DataPoints:-demo.md +++ b/docs/cardano-node-and-DataPoints:-demo.md @@ -1,4 +1,4 @@ -This document provides a step-by-step example of how to work with [`demo-acceptor`](https://github.com/input-output-hk/cardano-node/blob/master/cardano-tracer/demo/acceptor.hs). +This document provides a step-by-step example of how to work with [`demo-acceptor`](https://github.com/intersectmbo/cardano-node/blob/master/cardano-tracer/demo/acceptor.hs). ## What is it? diff --git a/docs/getting-started/building-the-node-using-nix.md b/docs/getting-started/building-the-node-using-nix.md index c334167..c9f1348 100644 --- a/docs/getting-started/building-the-node-using-nix.md +++ b/docs/getting-started/building-the-node-using-nix.md @@ -35,14 +35,14 @@ EOF Once Nix is installed, log out and then log back in. After that you can build the full node package with Mainnet configuration as follows: ``` -git clone https://github.com/input-output-hk/cardano-node +git clone https://github.com/intersectmbo/cardano-node cd cardano-node nix build .#mainnet/node -o mainnet-node-local ./mainnet-node-local/bin/cardano-node-mainnet ``` or run in in one go: ``` -nix run github:input-output-hk/cardano-node#mainnet/node +nix run github:intersectmbo/cardano-node#mainnet/node ``` If you only want to build just the cardano-node executable, without the configuration bundle: diff --git a/docs/getting-started/install.md b/docs/getting-started/install.md index 0802030..ff6b267 100644 --- a/docs/getting-started/install.md +++ b/docs/getting-started/install.md @@ -1,6 +1,6 @@ # Installing the node from source -The **latest** version of the node may be downloaded from the [cardano-node GitHub Releases](https://github.com/input-output-hk/cardano-node/releases) page. +The **latest** version of the node may be downloaded from the [cardano-node GitHub Releases](https://github.com/intersectmbo/cardano-node/releases) page. #### Prerequisites @@ -246,7 +246,7 @@ cd ~/src Download the Cardano node sources: ```bash -git clone https://github.com/input-output-hk/cardano-node.git +git clone https://github.com/intersectmbo/cardano-node.git ``` Change the working directory to the downloaded source code folder: diff --git a/docs/getting-started/understanding-config-files.md b/docs/getting-started/understanding-config-files.md index df69554..de31a27 100644 --- a/docs/getting-started/understanding-config-files.md +++ b/docs/getting-started/understanding-config-files.md @@ -78,7 +78,7 @@ A minimal version of this file looks like this: - `warmValency` is an optional field, similar to `valency` or `hotValency`, that informs the node about the number of peers it should maintain as established (warm). This field is optional and defaults to the value set in the `valency` or `hotValency` field. If a value is specified for `warmValency`, it should be greater than or equal to the one defined in `valency` or `hotValency`; otherwise, `valency` or `hotValency` will be adjusted to match this value. We recommend users set the `warmValency` value to `hotValency` + 1 to ensure at least one backup peer is available to be promoted to a hot connection in case of unexpected events. - Check [this issue](https://github.com/input-output-hk/ouroboros-network/issues/4565) for more + Check [this issue](https://github.com/intersectmbo/ouroboros-network/issues/4565) for more context on this `WarmValency` addition. * Local root groups shall be non-overlapping. @@ -195,7 +195,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/tree/master/eras/shelley/impl). +Here is a brief description of each parameter. You can learn more in the [spec](https://github.com/intersectmbo/cardano-ledger/tree/master/eras/shelley/impl). | PARAMETER | MEANING | @@ -411,7 +411,7 @@ The following traces can be enabled: governor_. At this point [Haddock -documentation](https://input-output-hk.github.io/ouroboros-network/ouroboros-network/Ouroboros-Network-PeerSelection-Governor.html) +documentation](https://ouroboros-network.cardano.intersectmbo.org/ouroboros-network/Ouroboros-Network-PeerSelection-Governor.html) of the outbound governor is available. #### Peer sharing @@ -470,8 +470,7 @@ peer (its outbound governor). transitions between remote cold, remote warm, and remote hot states. The inbound governor is documented in [The Shelley networking -protocol](https://input-output-hk.github.io/ouroboros-network/pdfs/network-spec) (section -4.5). +protocol](https://ouroboros-network.cardano.intersectmbo.org/pdfs/network-spec) (section 4.5). #### Connection manager @@ -491,8 +490,7 @@ available: connection state changes in the connection manager state machine. The connection manager is documented in [The Shelley networking -protocol](https://input-output-hk.github.io/ouroboros-network/pdfs/network-spec) (section -4). +protocol](https://ouroboros-network.cardano.intersectmbo.org/pdfs/network-spec) (section 4). #### Ledger peers diff --git a/docs/new-tracing/tracers_doc_generated.md b/docs/new-tracing/tracers_doc_generated.md index f823360..9f14599 100644 --- a/docs/new-tracing/tracers_doc_generated.md +++ b/docs/new-tracing/tracers_doc_generated.md @@ -4419,7 +4419,7 @@ Filtered `Invisible` by config value: `Info` ### Forge.Loop.BlockFromFuture -> Leadership check failed: the current chain contains a block from a slot /after/ the current slot This can only happen if the system is under heavy load. We record both the current slot number as well as the slot number of the block at the tip of the chain. See also +> Leadership check failed: the current chain contains a block from a slot /after/ the current slot This can only happen if the system is under heavy load. We record both the current slot number as well as the slot number of the block at the tip of the chain. See also Severity: `Error` @@ -4689,7 +4689,7 @@ Filtered `Visible` by config value: `Info` ### Forge.Loop.SlotIsImmutable -> Leadership check failed: the tip of the ImmutableDB inhabits the current slot This might happen in two cases. 1. the clock moved backwards, on restart we ignored everything from the VolatileDB since it's all in the future, and now the tip of the ImmutableDB points to a block produced in the same slot we're trying to produce a block in 2. k = 0 and we already adopted a block from another leader of the same slot. We record both the current slot number as well as the tip of the ImmutableDB. See also +> Leadership check failed: the tip of the ImmutableDB inhabits the current slot This might happen in two cases. 1. the clock moved backwards, on restart we ignored everything from the VolatileDB since it's all in the future, and now the tip of the ImmutableDB points to a block produced in the same slot we're trying to produce a block in 2. k = 0 and we already adopted a block from another leader of the same slot. We record both the current slot number as well as the tip of the ImmutableDB. See also Severity: `Error` diff --git a/docs/reference/byron-genesis.md b/docs/reference/byron-genesis.md index 2679dcf..62155a4 100644 --- a/docs/reference/byron-genesis.md +++ b/docs/reference/byron-genesis.md @@ -1,6 +1,6 @@ # Byron genesis data format -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. +Please see [the byron ledger spec](https://github.com/intersectmbo/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: @@ -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 1015. 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 1015. 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. +The proportion of ADA that these threshold values (`initThd`,`minThd`,`thdDecrement`) represent is calculated by dividing by 1015. 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 1015. Note that in the specification we only make use of the `minThd`. See [here](https://github.com/intersectmbo/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). @@ -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/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) +- [cardano-ledger - Genesis test](https://github.com/intersectmbo/cardano-ledger/blob/master/eras/byron/ledger/impl/test/Test/Cardano/Chain/Genesis/Json.hs#L69) +- [cardano-ledger - ProtocolMagic](https://github.com/intersectmbo/cardano-ledger/blob/master/eras/byron/crypto/src/Cardano/Crypto/ProtocolMagic.hs) ## heavyDelegation The key `heavyDelegation` contains an information about heavyweight delegation: diff --git a/docs/reference/configuring-a-node-using-yaml.md b/docs/reference/configuring-a-node-using-yaml.md index 8fd6d15..56ade01 100644 --- a/docs/reference/configuring-a-node-using-yaml.md +++ b/docs/reference/configuring-a-node-using-yaml.md @@ -65,4 +65,4 @@ The genesis file is very important, as it sets four key parameters: * `MaxLovelaceSupply`: the total amount of lovelaces in the blockchain. * `startTime`: the time of slot zero. -For details on using the command line interface, stopping and starting the node, and ensuring the node is connected to the Cardano network, please refer to the [README file](https://github.com/input-output-hk/cardano-node/blob/master/README.rst). +For details on using the command line interface, stopping and starting the node, and ensuring the node is connected to the Cardano network, please refer to the [README file](https://github.com/intersectmbo/cardano-node/blob/master/README.rst). diff --git a/docs/reference/native-tokens/01-multi-assets.md b/docs/reference/native-tokens/01-multi-assets.md index 69edcc7..41ce9d5 100644 --- a/docs/reference/native-tokens/01-multi-assets.md +++ b/docs/reference/native-tokens/01-multi-assets.md @@ -1,6 +1,6 @@ # Multi-asset support -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. +From the Mary ledger upgrade and onwards, Cardano supports [multi-assets](https://github.com/intersectmbo/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? diff --git a/docs/reference/native-tokens/02-getting-started.md b/docs/reference/native-tokens/02-getting-started.md index f0760f1..a5898fa 100644 --- a/docs/reference/native-tokens/02-getting-started.md +++ b/docs/reference/native-tokens/02-getting-started.md @@ -1,8 +1,8 @@ Before you start, you should: -- have the [latest version of the node](https://github.com/input-output-hk/cardano-node/releases) +- have the [latest version of the node](https://github.com/intersectmbo/cardano-node/releases) - configure the node to communicate with the [testnet environment](https://book.world.dev.cardano.org/environments.html) -- set up a relay node and [run CLI](https://github.com/input-output-hk/cardano-node#using-cardano-cli) +- set up a relay node and [run CLI](https://github.com/intersectmbo/cardano-node#using-cardano-cli) ### Understanding values @@ -100,7 +100,7 @@ Here’s an example of a very simple minting policy, which grants the right to m } ``` -This minting policy requires any transaction that mints tokens to be witnessed by the key with the hash `fe38d7...599`. More involved examples can be found in the [multi-signature simple scripts documentation](https://github.com/input-output-hk/cardano-node/blob/c6b574229f76627a058a7e559599d2fc3f40575d/doc/reference/simple-scripts.md). +This minting policy requires any transaction that mints tokens to be witnessed by the key with the hash `fe38d7...599`. More involved examples can be found in the [multi-signature simple scripts documentation](https://github.com/intersectmbo/cardano-node/blob/c6b574229f76627a058a7e559599d2fc3f40575d/doc/reference/simple-scripts.md). ### Example: minting a new native token @@ -110,7 +110,7 @@ This section describes how to manually mint a new native token ('melcoin') using #### Pre-requisites -1. Download the latest version of cardano-node from the releases page (https://github.com/input-output-hk/cardano-node/releases) and config files for the public testnet from the Cardano World (https://book.world.dev.cardano.org/environments.html) +1. Download the latest version of cardano-node from the releases page (https://github.com/intersectmbo/cardano-node/releases) and config files for the public testnet from the Cardano World (https://book.world.dev.cardano.org/environments.html) 2. Run the cardano-node: diff --git a/docs/reference/plutus/babbage-certifying-script-example.md b/docs/reference/plutus/babbage-certifying-script-example.md index f553ece..9418cce 100644 --- a/docs/reference/plutus/babbage-certifying-script-example.md +++ b/docs/reference/plutus/babbage-certifying-script-example.md @@ -4,7 +4,7 @@ For an overview of reference script usuage in the Babbage era, please see [here](babbage-script-example.md). -In this example we will delegate stake at a plutus script address to an SPO using a plutus reference script. This is achieved when we run the [register-and-delegate-script-staking-address.sh](https://github.com/input-output-hk/cardano-node/blob/master/scripts/babbage/staking-example/register-and-delegate-script-staking-address.sh) script. Below we will outline the key parts +In this example we will delegate stake at a plutus script address to an SPO using a plutus reference script. This is achieved when we run the [register-and-delegate-script-staking-address.sh](https://github.com/intersectmbo/cardano-node/blob/master/scripts/babbage/staking-example/register-and-delegate-script-staking-address.sh) script. Below we will outline the key parts First we create the reference script at a tx output as usual with the following transaction: diff --git a/docs/reference/plutus/babbage-script-example.md b/docs/reference/plutus/babbage-script-example.md index af2b9e3..0a280be 100644 --- a/docs/reference/plutus/babbage-script-example.md +++ b/docs/reference/plutus/babbage-script-example.md @@ -20,7 +20,7 @@ Return collateral allows us to specify an output with the remainder of our colla ### An example of using a Plutus V2 reference script -Below is an example that shows how to use a reference Plutus spending script with an inline datum and a reference minting script. Here we discuss a [shell script example of how to use a reference script to spend a tx input and a reference minting script to mint tokens](https://github.com/input-output-hk/cardano-node/blob/master/scripts/babbage/example-babbage-script-usage.sh). This is a step-by-step process involving: +Below is an example that shows how to use a reference Plutus spending script with an inline datum and a reference minting script. Here we discuss a [shell script example of how to use a reference script to spend a tx input and a reference minting script to mint tokens](https://github.com/intersectmbo/cardano-node/blob/master/scripts/babbage/example-babbage-script-usage.sh). This is a step-by-step process involving: + the creation of the `Required Redeemer` Plutus txin script + the creation of the `Required Redeemer` Plutus script at a transaction output (creation of the reference script) @@ -28,9 +28,9 @@ 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](https://github.com/input-output-hk/cardano-node/blob/master/scripts/plutus/scripts/v2) at a transaction output. ++ the creation of the reference [minting script](https://github.com/intersectmbo/cardano-node/blob/master/scripts/plutus/scripts/v2) at a transaction output. -In this example we will use the [Required Redeemer](https://github.com/input-output-hk/cardano-node/blob/master/scripts/plutus/scripts/v2/required-redeemer.plutus) Plutus spending script and a [minting script](https://github.com/input-output-hk/cardano-node/blob/master/scripts/plutus/scripts/v2/minting-script.plutus). In order to execute a reference Plutus spending script, we require the following: +In this example we will use the [Required Redeemer](https://github.com/intersectmbo/cardano-node/blob/master/scripts/plutus/scripts/v2/required-redeemer.plutus) Plutus spending script and a [minting script](https://github.com/intersectmbo/cardano-node/blob/master/scripts/plutus/scripts/v2/minting-script.plutus). In order to execute a reference 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. This is the tx output that sits at the Plutus script address. @@ -67,7 +67,7 @@ cabal install cardano-node ``` To start your babbage cluster, you need to run the `example/run/all.sh` shell script. -The remainder of this guide provides a brief walkthrough of the [shell script example](https://github.com/input-output-hk/cardano-node/blob/master/scripts/babbage/example-babbage-script-usage.sh) that automatically creates a reference script and spends the utxo at +The remainder of this guide provides a brief walkthrough of the [shell script example](https://github.com/intersectmbo/cardano-node/blob/master/scripts/babbage/example-babbage-script-usage.sh) that automatically creates a reference script and spends the utxo at the reference script's corresponding script address. #### Creating a reference script at a transaction output, inline datum and diff --git a/docs/reference/plutus/babbage-withdrawing-script-example.md b/docs/reference/plutus/babbage-withdrawing-script-example.md index 408abba..85f1650 100644 --- a/docs/reference/plutus/babbage-withdrawing-script-example.md +++ b/docs/reference/plutus/babbage-withdrawing-script-example.md @@ -4,7 +4,7 @@ For an overview of reference script usuage in the Babbage era, please see [here](babbage-script-example.md). -In this example we will withdraw our rewards from a plutus script address using a plutus reference script. We must first run the [register-and-delegate-script-staking-address.sh](https://github.com/input-output-hk/cardano-node/blob/master/scripts/babbage/staking-example/register-and-delegate-script-staking-address.sh) script in order to register and delegate the stake at our plutus script address. We will briefly walk through the [claim-script-staking-rewards.sh](https://github.com/input-output-hk/cardano-node/blob/master/scripts/babbage/staking-example/claim-script-staking-rewards.sh) script that automatically does this all for us. +In this example we will withdraw our rewards from a plutus script address using a plutus reference script. We must first run the [register-and-delegate-script-staking-address.sh](https://github.com/intersectmbo/cardano-node/blob/master/scripts/babbage/staking-example/register-and-delegate-script-staking-address.sh) script in order to register and delegate the stake at our plutus script address. We will briefly walk through the [claim-script-staking-rewards.sh](https://github.com/intersectmbo/cardano-node/blob/master/scripts/babbage/staking-example/claim-script-staking-rewards.sh) script that automatically does this all for us. Now that we already have our certifying reference script at a tx output so we can use our reference input again to validate the withdrawal of our rewards at our plutus script address with the following tx: diff --git a/docs/reference/plutus/plutus-minting-script-example.md b/docs/reference/plutus/plutus-minting-script-example.md index aa9d4f0..e7e47da 100644 --- a/docs/reference/plutus/plutus-minting-script-example.md +++ b/docs/reference/plutus/plutus-minting-script-example.md @@ -75,6 +75,6 @@ cardano-cli transaction sign \ --out-file "plutusmint.tx" ``` -You can use the [simple-minting-policy.sh](https://github.com/input-output-hk/cardano-node/blob/master/scripts/plutus/simple-minting-policy.sh) in conjunction with the [mkfiles.sh alonzo](https://github.com/input-output-hk/cardano-node/blob/master/scripts/byron-to-alonzo/mkfiles.sh) script to automagically run the `AlwaysSucceeds` minting script. +You can use the [simple-minting-policy.sh](https://github.com/intersectmbo/cardano-node/blob/master/scripts/plutus/simple-minting-policy.sh) in conjunction with the [mkfiles.sh alonzo](https://github.com/intersectmbo/cardano-node/blob/master/scripts/byron-to-alonzo/mkfiles.sh) script to automagically run the `AlwaysSucceeds` minting script. diff --git a/docs/reference/plutus/plutus-spending-script-example.md b/docs/reference/plutus/plutus-spending-script-example.md index 92df819..d50496b 100644 --- a/docs/reference/plutus/plutus-spending-script-example.md +++ b/docs/reference/plutus/plutus-spending-script-example.md @@ -115,5 +115,5 @@ cardano-cli transaction sign \ If there is ADA at `$dummyaddress` then the Plutus script was successfully executed. -You can use the [example-txin-locking-plutus-script.sh](https://github.com/input-output-hk/cardano-node/blob/master/scripts/plutus/example-txin-locking-plutus-script.sh) in conjunction with [mkfiles.sh alonzo](https://github.com/input-output-hk/cardano-node/blob/master/scripts/byron-to-alonzo/mkfiles.sh) script to automagically run the `AlwaysSucceeds` script. +You can use the [example-txin-locking-plutus-script.sh](https://github.com/intersectmbo/cardano-node/blob/master/scripts/plutus/example-txin-locking-plutus-script.sh) in conjunction with [mkfiles.sh alonzo](https://github.com/intersectmbo/cardano-node/blob/master/scripts/byron-to-alonzo/mkfiles.sh) script to automagically run the `AlwaysSucceeds` script. diff --git a/docs/reference/shelley-genesis.md b/docs/reference/shelley-genesis.md index 3cf27c5..0662d5f 100644 --- a/docs/reference/shelley-genesis.md +++ b/docs/reference/shelley-genesis.md @@ -1148,7 +1148,7 @@ After that, you should see the nodes start to alternately create blocks and adopt each others blocks. Remember that we have configured slots to be 1 second long but only 1 in 20 slots will have a block in it. -[Byron mainnet configuration]: https://github.com/input-output-hk/cardano-node/blob/master/configuration/defaults/byron-mainnet/configuration.yaml +[Byron mainnet configuration]: https://github.com/intersectmbo/cardano-node/blob/master/configuration/defaults/byron-mainnet/configuration.yaml ## Querying the node diff --git a/docs/reference/tx-metadata.md b/docs/reference/tx-metadata.md index 85850b7..edde44c 100644 --- a/docs/reference/tx-metadata.md +++ b/docs/reference/tx-metadata.md @@ -43,7 +43,7 @@ transaction_metadata = ## How to create a transaction with metadata using the cardano-cli -To create a transaction with metadata, first ensure that you have installed the [cardano-node](https://github.com/input-output-hk/cardano-node#cardano-node-overview) and follow instructions on how to launch [cardano-CLI](https://github.com/input-output-hk/cardano-cli/tree/master/cardano-cli#cardano-cli). +To create a transaction with metadata, first ensure that you have installed the [cardano-node](https://github.com/intersectmbo/cardano-node#cardano-node-overview) and follow instructions on how to launch [cardano-CLI](https://github.com/input-output-hk/cardano-cli/tree/master/cardano-cli#cardano-cli). To create a transaction with specified metadata, run this command: @@ -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://github.com/input-output-hk/cardano-ledger/releases/latest/download/shelley-delegation.pdf), p 53. ++ Tx metadata motivation and use: [Design Specification for Delegation and Incentives in Cardano](https://github.com/intersectmbo/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). diff --git a/docs/stake-pool-operations/5_register_key.md b/docs/stake-pool-operations/5_register_key.md index b04d36b..9625bdb 100644 --- a/docs/stake-pool-operations/5_register_key.md +++ b/docs/stake-pool-operations/5_register_key.md @@ -28,7 +28,7 @@ For the transaction draft, --tx.out, --invalid-hereafter and --fee can be set to Compute the minimum fee. Note that only one witness is required because -[Chapter 3.3 "we do not require a witness to register a stake address"](https://github.com/input-output-hk/cardano-ledger/releases/latest/download/shelley-delegation.pdf). +[Chapter 3.3 "we do not require a witness to register a stake address"](https://github.com/intersectmbo/cardano-ledger/releases/latest/download/shelley-delegation.pdf). cardano-cli transaction calculate-min-fee \ --tx-body-file tx.draft \