{"id":19206587,"url":"https://github.com/concordium/concordium-node","last_synced_at":"2025-04-07T10:20:17.929Z","repository":{"id":36963294,"uuid":"352905367","full_name":"Concordium/concordium-node","owner":"Concordium","description":"The main concordium node implementation.","archived":false,"fork":false,"pushed_at":"2025-04-01T08:46:29.000Z","size":38896,"stargazers_count":50,"open_issues_count":88,"forks_count":22,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-04-01T09:33:14.249Z","etag":null,"topics":["blockchain","blockchain-node","concordium","haskell","rust"],"latest_commit_sha":null,"homepage":"","language":"Haskell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Concordium.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-03-30T07:12:50.000Z","updated_at":"2025-04-01T08:44:48.000Z","dependencies_parsed_at":"2023-09-29T08:19:37.548Z","dependency_job_id":"cdf040e7-5350-457f-850d-31c200293581","html_url":"https://github.com/Concordium/concordium-node","commit_stats":null,"previous_names":[],"tags_count":142,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Concordium%2Fconcordium-node","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Concordium%2Fconcordium-node/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Concordium%2Fconcordium-node/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Concordium%2Fconcordium-node/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Concordium","download_url":"https://codeload.github.com/Concordium/concordium-node/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247631833,"owners_count":20970069,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blockchain","blockchain-node","concordium","haskell","rust"],"created_at":"2024-11-09T13:16:21.570Z","updated_at":"2025-04-07T10:20:17.902Z","avatar_url":"https://github.com/Concordium.png","language":"Haskell","readme":"# concordium-node\n\n- [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](https://github.com/Concordium/.github/blob/main/.github/CODE_OF_CONDUCT.md)\n\n- ![Build and test](https://github.com/Concordium/concordium-node/actions/workflows/build-test.yaml/badge.svg)\n\nThis repository contains the implementation of the concordium p2p node with its\ndependencies and auxiliaries. The node is split into two parts\n\n- [concordium-consensus](./concordium-consensus/)\n  is a Haskell package that contains the implementation of the consensus with\n  its dependencies. This includes basic consensus, finalization, scheduler,\n  implementations of block and tree storage, and auxiliaries.\n- [concordium-node](./concordium-node/)\n  is a Rust package containing a number of executables, the chief among them\n  being [concordium-node.rs](./concordium-node/src/bin/cli.rs) which is the\n  program that participates in the Concordium network and runs consensus,\n  finalization, and other components. It uses\n  [concordium-consensus](./concordium-consensus/) as a package, either linked\n  dynamically or statically, depending on the build configuration. The main\n  feature added by the [concordium-node](./concordium-node/) is the network layer.\n\nThe auxiliary packages are the\n- [collector](./collector) The collector is a service that queries the node for\n  some information and publishes data to the `collector-backend`. The collector\n  runs alongside the node.\n- [collector-backend](./collector-backend) The collector backend listens for\n  data from the collectors and serves a summary of it. This component is used by\n  the\n  [concordium-network-dashboard](https://github.com/Concordium/concordium-network-dashboard)\n  to display the network overview.\n- [macos_logger_wrapper](./macos_logger_wrapper/) provides an interface to the\n  macOS logging interface using `os_log_create`. This is used by both the node\n  and the collector so that the mac distribution package logs to the system\n  logging service.\n\n## Submodules\n\nThe [concordium-base](./concordium-base/) is a direct dependency of both\n[concordium-consensus/](./concordium-consensus/) and\n[concordium-node](./concordium-node/). Because\n[concordium-base](./concordium-base/) is also used by other components it is a\nseparate repository brought in as a submodule.\n\nThe [concordium-grpc-api](./concordium-grpc-api/) is a simple repository that\ndefines the external GRPC API of the node. This is in term of the `.proto` file.\nBecause this is used by other components it is also a small separate repository\nbrought in as a submodule.\n\nDo remember to clone recursively or use `git submodule update --init --recursive` after\ncloning this repository, or after changing branches.\n\n## Configurations and scripts\n\n- The [scripts](./scripts/) directory contains a variety of bash scripts,\n  Dockerfiles, and similar, to build different configurations of the node for\n  testing and deployment.\n\n## Building the node\n\nSee [concordium-node/README.md](./concordium-node/README.md).\n\n# Contributing\n\nTo contribute start a new branch starting from `main`, make changes, and make a\nmerge request. A person familiar with the codebase should be asked to review the\nchanges before they are merged.\n\n## Haskell workflow\n\nWe typically use [stack](https://docs.haskellstack.org/en/stable/README/) to\nbuild, run, and test the code. In order to build the haskell libraries the rust\ndependencies must be pre-build, which is done automatically by the cabal setup\nscript.\n\nCode should be formatted using [`fourmolu`](https://github.com/fourmolu/fourmolu)\nversion `0.13.1.0` and using the config `fourmolu.yaml` found in the project root.\nThe CI is setup to ensure the code follows this style.\n\nTo check the formatting locally run the following command from the project root:\n\n**On unix-like systems**:\n\n```\n$ fourmolu --mode check $(git ls-files '*.hs')\n```\n\nTo format run the following command from the project root:\n\n**On unix-like systems**:\n\n```\n$ fourmolu --mode inplace $(git ls-files '*.hs')\n```\n\nLines should strive to be at most 100 characters, naming and code style should\nfollow the scheme that already exists.\n\nWe do not use any linting tool on the CI. Running hlint might uncover common\nissues.\n\n## Rust workflow\n\nWe use **stable version** of rust, 1.82, to compile the code.\n\nThe CI is configured to check two things\n- the [clippy](https://github.com/rust-lang/rust-clippy) tool is run to check\n  for common mistakes and issues. We try to have no clippy warnings. Sometimes\n  what clippy thinks is not reasonable is necessary, in which case you should\n  explicitly disable the warning on that site (a function or module), such as\n  `#[allow(clippy::too_many_arguments)]`, but that is a method of last resort.\n  Try to resolve the issue in a different way first.\n\n- the [rust fmt](https://github.com/rust-lang/rustfmt) tool is run to check the\n  formatting. Unfortunately the stable version of the tool is quite outdated, so\n  we use a nightly version, which is updated a few times a year. Thus in order\n  for the CI to pass you will need to install the relevant nightly version, see\n  the `rustfmt` job in the file [.github/workflows/build-test.yaml](.github/workflows/build-test.yaml),\n  look for `nightly-...`).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconcordium%2Fconcordium-node","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fconcordium%2Fconcordium-node","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconcordium%2Fconcordium-node/lists"}