bls12-381-legacy

UNIX version of BLS12-381 primitives. Not implementating the virtual package bls12-381
README

Install

# if you implement a library and you don't need an actual implementation
opam install bls12-381
# to target UNIX
opam insall bls12-381-unix
# to target JavaScript, to be used with jsoo.
opam install bls12-381-js

See below how to use in your project.

Run tests

dune runtest
dune build @test/js/browser/serve # Check _build/default/test/js/browser and run `npm run serve`

To get the coverage (only ok for bls12-381-unix and bls12-381-gen)

dune runtest --instrument-with bisect_ppx --force
bisect-ppx-report html

How to use in my project

If you are developing a library using bls12-381, you only need to add bls12-381 in the dependency list.
However, if you are writing a binary, three packages are relevant:

  • bls12-381-unix: to be used for UNIX

  • bls12-381-js: to be used to target JavaScript. It does rely on the node
    packages listed
    here, version >=
    0.8.1, and suppose this module is loaded before in the global namespace under
    the name _RUSTC_BLS12_381. See test/js/browser/ for an example. You need
    to use the appropriate package depending on the platform you target (Node or a
    bundler for the browser). For instance, if you target Node (resp. a bundler
    like webpack for a browser usage), you must use
    @dannywillems/rustc-bls12-381-node (resp. @dannywillems/rustc-bls12-381).

  • bls12-381-js-gen: if the module is loaded somewhere else than in the global
    namespace like the previous package supposes, you can use this third library
    that provides functors. The functors are expecting a module of the signature:

    sig
      val rust_module : unit -> Jsoo_lib.ESModule.t
    
      val get_wasm_memory_buffer : unit -> Jsoo_lib.Memory.Buffer.t
    end
    

    (note: functions are not directly evaluated values are required because the module might not already be loaded when loading the JavaScript resulting file and the wasm memory buffer being a view over a ArrayBuffer might be invalid if the buffer size is increased at runtime). You can see an example in the src/js.

For more examples, see the test directories.

Run the benchmarks

opam install core_bench
dune exec benchmark/bench_ec.exe
dune exec benchmark/bench_ff.exe
dune exec benchmark/bench_pairing.exe

Documentation

opam install odoc
dune build @doc
Install
Published
17 Dec 2021
Sources
ocaml-bls12-381-0.4.4-legacy.tar.bz2
md5=a2051b5842a2deeb10ad99c57a7ea443
sha512=3e2669baf621304bbe14bcb53ab128d01577b98f13bec497953328c8605c9dc5667c873b680e087dd240362ee77b0f15d1d4bbe60dd67a2dc4b8b64838189d6a
Dependencies
ff-pbt
>= "0.6.0" & < "0.7.0" & with-test
alcotest
with-test
bls12-381-gen
= version
ctypes
>= "0.18.0" & < "0.19.0"
zarith
>= "1.10" & < "2.0"
ff-sig
>= "0.6.1" & < "0.7.0"
dune
>= "2.8.4"
ocaml
>= "4.08"
Reverse Dependencies