allbabel / composable Goto Github PK

To learn more about our ecosystem, vision, and product specifics - visit our mdbook.

We use nix in order to reproducibly build our products. We recommend either installing nix or switching to NixOS. Alternatively, you can run our packages with just docker installed. Our packages support both x86 and ARM architectures.

Once you have nix or NixOS installed, you should enable the following features:

{
  nix = {
    useSandbox = "relaxed";
    extraOptions = ''
      experimental-features = nix-command flakes
    '';
  };
}

Set the contents of ~/.config/nix/nix.conf to

experimental-features = nix-command flakes
sandbox = relaxed

You can now use nix flake show in order to view all of the packages we provide, such as composable-node and devnet-dali.

If you want to run the latest version of devnet-dali, for example, you can simply run the following: (You do not need to clone the repository in order to run this)

nix run "github:ComposableFi/composable#devnet-dali"

If you would like to run an older/pinned version of any package, you can include the commit hash in the package identifier lilke this:

nix run "github:ComposableFi/composable/d735de9#devnet-dali"

If you want to build/run packages based on a local copy of the sources, you can do that like this:

git clone [email protected]:ComposableFi/composable
cd composable
nix run ".#devnet-dali"

Do you not feel like installing nix? You can also use nix within docker like this:

docker volume create nix # cache builds

docker run -v nix:/nix -p 9988:9988 -it nixos/nix bash -c "nix run github:ComposableFi/composable#devnet-dali --extra-experimental-features nix-command --extra-experimental-features flakes"