Pollinate

A platform agnostic OCaml library for P2P communications using UDP and Bin_prot. Technical documentation is available here.

Building and Running Tests

With esy

Install esy.

# Build
$ esy

# Test
$ esy x dune test

With nix

Make sure you don't have a globally installed dune because it would lead to conflicts since we provide it via nix.

• Install nix.
• Install direnv

Then run the following commands:

# cd to the folder of Pollinate
$ cd pollinate

# Allow direnv to load the nix environment
$ direnv allow

Build

Pollinate is buildable in two different versions of OCaml:

• 4.13
• 5.00

To build a specific version with nix simply run nix build .#pollinate_ocamlPackages_<version>, for example, to build using OCaml 5:

$ nix build .#pollinate_ocamlPackages_5_00

Run tests suite

# Run test
$ dune test

Documentation

A built-in documentation with odoc is available here.

In case you want to rebuild it locally (for example, you made changes and want to see them before pushing):

$ dune build @doc