Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update links from input-output-hk to intersectmbo #38

Merged
merged 1 commit into from
Jan 12, 2024
Merged
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 docs/ADR-0-Documenting-Architecture-Decisions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

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

# Context

In a project with multiple packages, there is a need to control version bounds of the dependencies used to provide stable and reproducible builds. This is achieved by entering version bounds into the `.cabal` file, as described in [Cabal documentation](https://cabal.readthedocs.io/en/latest/cabal-package.html#pkg-field-build-depends).
In a project with multiple packages, there is a need to control version bounds of the dependencies used to provide stable and reproducible builds. This is achieved by entering version bounds into the `.cabal` file, as described in [Cabal documentation](https://cabal.readthedocs.io/en/latest/cabal-package-description-file.html#pkg-field-build-depends).

Let's consider an example where multiple package *components* (eg, libraries, internal libraries, test-suites,
executables) form a more complex dependency graph like the following one:
Expand Down Expand Up @@ -88,7 +88,7 @@ This will allow for less error-prone dependency management.

# References

1. https://cabal.readthedocs.io/en/latest/cabal-package.html#pkg-field-build-depends
1. https://cabal.readthedocs.io/en/latest/cabal-package-description-file.html#pkg-field-build-depends
1. [Per-cabal-file `constraints` - Issue in haskell/cabal](https://github.com/haskell/cabal/issues/8912)
1. https://input-output-hk.github.io/cardano-engineering-handbook/policy/haskell/packaging/versioning.html

Expand Down
28 changes: 14 additions & 14 deletions docs/Benchmarking-Hacking.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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'.
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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

Expand All @@ -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
Expand All @@ -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
Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/Byron-Rewrite-Node-Demo-#1.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/Byron-Rewrite-Node-Demo-#2.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand Down
2 changes: 1 addition & 1 deletion docs/Byron-Rewrite-Node-Demo-#3.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand Down
2 changes: 1 addition & 1 deletion docs/Cardano-Haskell-Node-(Byron-Re-Write)-Status.md
Original file line number Diff line number Diff line change
@@ -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**_.

Expand Down
2 changes: 1 addition & 1 deletion docs/Cardano-node-required-checks.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
6 changes: 3 additions & 3 deletions docs/Debugging-cardano-cli-errors-on-a-testnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

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.

Clone [cardano-world](https://github.com/input-output-hk/cardano-world) and check out the testnet branch (eg `sanchonet`).
Clone [cardano-world](https://github.com/intersectmbo/cardano-world) and check out the testnet branch (eg `sanchonet`).

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`:
Expand Down
2 changes: 1 addition & 1 deletion docs/Docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand Down
6 changes: 3 additions & 3 deletions docs/Git-submodules-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The official way to integrate multiple components in Cardano software is to
maintain the code in `git` as separate repositories and publish releases to
[Cardano Haskell Packages (CHaP)](https://github.com/input-output-hk/cardano-haskell-packages).
[Cardano Haskell Packages (CHaP)](https://github.com/intersectmbo/cardano-haskell-packages).

All published components must operate in this manner.

Expand Down Expand Up @@ -86,11 +86,11 @@ $ git checkout newhoggy/test-submodules
$ cat .gitmodules
[submodule "cardano-api"]
path = cardano-api
url = [email protected]:input-output-hk/cardano-api.git
url = [email protected]:intersectmbo/cardano-api.git
branch = newhoggy/use-tag-script-from-cardano-dev-instead
[submodule "cardano-cli"]
path = cardano-cli
url = [email protected]:input-output-hk/cardano-cli.git
url = [email protected]:intersectmbo/cardano-cli.git
branch = main
```

Expand Down
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
8 changes: 4 additions & 4 deletions docs/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 [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.:

Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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)
Loading