Decentralized Storage
Go to file
Eric 6ff4d30b43
fix(tests/integration): fix bootstrap node spr (#1048)
After a change in PR #1031, bootstrap node sprs may not work when Hardhat nodes are started with the tests. This fixes it by appending all started client's and provider's SPR to a sequence, and using that sequence of SPRs to start the next node. This means all subsequently started nodes will be connected to its previously started peers.

This also fixes the case when bootstrap SPRs would not be present if no clients were started.
2024-12-18 08:10:36 +00:00
.github ci: split nim-matrix workflow (#1041) 2024-12-15 23:31:55 +00:00
benchmarks Pr add prover benchmark tool (#790) 2024-05-23 09:28:17 -07:00
codex refactor(trackedfutures): remove return of future from tracked futures api (#1046) 2024-12-18 07:39:03 +00:00
docker Enables stacktrace in docker images (#1013) 2024-12-02 09:32:53 +00:00
metrics Adding metrics (#203) 2022-08-23 10:11:21 -06:00
nix nix: make derivation and update shell (#1003) 2024-12-09 17:07:01 +00:00
tests fix(tests/integration): fix bootstrap node spr (#1048) 2024-12-18 08:10:36 +00:00
tools/cirdl chore: update dependencies, especially nim-ethers to chronos v4 compatible version (#968) 2024-10-30 10:40:17 +00:00
vendor feat: repair is rewarded (#1022) 2024-12-12 20:19:56 +00:00
.dockerignore Docker build (#354) 2023-03-08 12:45:55 +01:00
.editorconfig Project setup 2021-02-02 19:29:52 +01:00
.gitignore Add MIT/Apache licenses (#861) 2024-08-13 15:38:17 +00:00
.gitmodules Rework circuit downloader (#882) 2024-09-23 14:37:17 +00:00
LICENSE-APACHEv2 Remove extra license file (#876) 2024-08-19 09:48:03 +00:00
LICENSE-MIT Add MIT/Apache licenses (#861) 2024-08-13 15:38:17 +00:00
Makefile nix: make derivation and update shell (#1003) 2024-12-09 17:07:01 +00:00
README.md Remove moved docs (#930) 2024-10-03 08:55:54 +00:00
build.nims Validator historical state restoration (#922) 2024-12-14 05:07:55 +00:00
codecov.yml [ci] disable pull-request comments by codecov 2022-05-19 15:23:35 +02:00
codex.nim Rework circuit downloader (#882) 2024-09-23 14:37:17 +00:00
codex.nimble remove stale and misleading dependency version metadata (#833) 2024-06-17 14:31:10 +00:00
config.nims Chronos v4 Update (v3 Compat Mode) (#814) 2024-07-18 21:04:33 +00:00
env.sh add env.sh shim to project root (#34) 2021-12-20 13:12:18 -06:00
flake.lock nix: make derivation and update shell (#1003) 2024-12-09 17:07:01 +00:00
flake.nix nix: make derivation and update shell (#1003) 2024-12-09 17:07:01 +00:00
openapi.yaml chore(openapi): update the openapi spec for the manifest object (#972) 2024-11-15 13:21:18 +00:00

README.md

Codex Decentralized Durability Engine

The Codex project aims to create a decentralized durability engine that allows persisting data in p2p networks. In other words, it allows storing files and data with predictable durability guarantees for later retrieval.

WARNING: This project is under active development and is considered pre-alpha.

License: Apache License: MIT Stability: experimental CI Docker Codecov Discord Docker Pulls

Build and Run

For detailed instructions on preparing to build nim-codex see Build Codex.

To build the project, clone it and run:

make update && make

The executable will be placed under the build directory under the project root.

Run the client with:

build/codex

Configuration

It is possible to configure a Codex node in several ways:

  1. CLI options
  2. Environment variables
  3. Configuration file

The order of priority is the same as above: CLI options --> Environment variables --> Configuration file.

Please check documentation for more information.

Guides

To get acquainted with Codex, consider:

API

The client exposes a REST API that can be used to interact with the clients. Overview of the API can be found on api.codex.storage.