mdebray/tvl-depot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
tvl-depot/tvix
History
Florian Klink e64e97ee23 feat(tvix/store): validate nar_sha256 
Change-Id: I4c4dcdb75ea7748f2ab01a0bab218596b90b7b58
Reviewed-on: https://cl.tvl.fyi/c/depot/+/9648
Reviewed-by: edef <edef@edef.eu>
Tested-by: BuildkiteCI
2023-10-11 15:29:08 +00:00
..
.vscode chore(tvix): fix vscode rust-analyzer recommendation 2022-10-15 16:54:28 +00:00
boot refactor(tvix/nar-bridge): mv nar-bridge{,-http} 2023-10-05 06:17:10 +00:00
castore fix(tvix/castore): use bstr for formatting names in errors 2023-10-10 22:40:55 +00:00
cli fix(tvix/cli): don't enable default features for tvix-store 2023-09-26 10:03:38 +00:00
docs docs(tvix/docs): add document about drvPath differences 2023-08-20 22:08:02 +00:00
eval refactor(tvix/eval/tests): migrate to tempfile 2023-10-08 22:47:33 +00:00
nar-bridge docs(tvix/nar-bridge): remove redundant comments 2023-10-11 15:22:22 +00:00
nix-compat feat(tvix/nix-compat): add nar::writer::async 2023-10-10 17:13:27 +00:00
nix_cli refactor(tvix/nix_cli): cargo clippy 2023-08-20 21:51:04 +00:00
proto refactor(tvix): move castore into tvix-castore crate 2023-09-22 12:51:21 +00:00
serde fix(tvix/eval): fix b/281 by adding Value::Catchable 2023-09-24 21:54:10 +00:00
store feat(tvix/store): validate nar_sha256 2023-10-11 15:29:08 +00:00
verify-lang-tests fix(tvix/eval): update identifier quoting to match cppnix 2.17 2023-09-15 00:00:59 +00:00
website feat(tvix/website): add structured data for search engines 2023-10-05 17:14:13 +00:00
.gitignore chore(tvix): add /*.sled to .gitignore 2023-09-24 17:05:48 +00:00
Cargo.lock fix(tvix/castore): use bstr for formatting names in errors 2023-10-10 22:40:55 +00:00
Cargo.nix fix(tvix/castore): use bstr for formatting names in errors 2023-10-10 22:40:55 +00:00
Cargo.toml refactor(tvix): move castore into tvix-castore crate 2023-09-22 12:51:21 +00:00
crate-hashes.json refactor(tvix/castore): move tests to grpc client, rm tonic-mock 2023-10-08 21:53:20 +00:00
default.nix feat(tvix/store/protos): add Export 2023-10-10 18:55:49 +00:00
LICENSE chore(tvix): Bootstrap Tvix folder 2021-03-27 00:09:49 +00:00
logo.webp refactor(tvix): move logo to //tvix:logo 2023-09-10 13:13:14 +00:00
OWNERS chore(gerrit): migrate OWNERS files to code-owners style 2022-09-19 11:13:28 +00:00
README.md feat(tvix/nar-bridge): add nar-bridge-pathinfo command 2023-10-05 15:02:12 +00:00
shell.nix refactor(tvix,views/tvix): move shell into separate file 2023-10-07 05:47:31 +00:00

README.md

Tvix is a new implementation of the Nix language and package manager. See the announcement post for information about the background of this project.

Tvix is developed by TVL in our monorepo, the depot, at //tvix. Code reviews take place on Gerrit, bugs are filed in our issue tracker.

For more information about Tvix, feel free to reach out. We are interested in people who would like to help us review designs, brainstorm and describe requirements that we may not yet have considered.

Most of the discussion around development happens on our IRC channel, which you can join in several ways documented on tvl.fyi, or on our mailing list.

Contributions to Tvix follow the TVL review flow and contribution guidelines.

WARNING: Tvix is not ready for use in production. None of our current APIs should be considered stable in any way.

WARNING: Any other instances of this project or repository are josh-mirrors. We do not accept code contributions or issues outside of the tooling and communication methods outlined above.

Components

This folder contains the following components:

  • //tvix/castore - subtree storage/transfer in a content-addressed fashion
  • //tvix/cli - preliminary REPL & CLI implementation for Tvix
  • //tvix/eval - an implementation of the Nix programming language
  • //tvix/nar-bridge
    • nar-bridge-http: A HTTP webserver providing a Nix HTTP Binary Cache interface in front of a tvix-store
    • nar-bridge-pathinfo: A gRPC server, exposing a Nix HTTP Binary Cache as a tvix-store PathInfoService
  • //tvix/nix-compat - a Rust library for compatibility with C++ Nix, features like encodings and hashing schemes and formats
  • //tvix/serde - a Rust library for using the Nix language for app configuration
  • //tvix/store - a "filesystem" linking Nix store paths and metadata with the content-addressed layer

Some additional folders with auxiliary things exist and can be explored at your leisure.

Building the CLI

The CLI can also be built with standard Rust tooling (i.e. cargo build), as long as you are in a shell with the right dependencies.

  • If you cloned the full monorepo, it can be provided by mg shell //tvix:shell.
  • If you cloned the tvix workspace only (git clone https://code.tvl.fyi/depot.git:workspace=views/tvix.git), nix-shell provides it.

If you're in the TVL monorepo, you can also run mg build //tvix/cli (or mg build from inside that folder) for a more incremental build.

Please follow the depot-wide instructions on how to get mg and use the depot tooling.

Compatibility

Important note: We only use and test Nix builds of our software against Nix 2.3. There are a variety of bugs and subtle problems in newer Nix versions which we do not have the bandwidth to address, builds in newer Nix versions may or may not work.

Rust projects, crate2nix

Some parts of Tvix are written in Rust. To simplify the dependency management on the Nix side of these builds, we use crate2nix in a single Rust workspace in //tvix to maintain the Nix build configuration.

When making changes to Cargo dependency configuration in any of the Rust projects under //tvix, be sure to run mg run //tvix:crate2nixGenerate -- in //tvix itself and commit the changes to the generated Cargo.nix file. This only applies to the full TVL checkout.

License structure

All code implemented for Tvix is licensed under the GPL-3.0, with the exception of the protocol buffer definitions used for communication between services which are available under a more permissive license (MIT).

The idea behind this structure is that any direct usage of our code (e.g. linking to it, embedding the evaluator, etc.) will fall under the terms of the GPL3, but users are free to implement their own components speaking these protocols under the terms of the MIT license.