bls12-381-js-gen

Functors to generate BLS12-381 JavaScript primitives based on stubs
README

Encoding

Scalar

The scalar field is Fr = GF(0x73eda753299d7d483339d80809a1d80553bda402fffe5bfeffffffff00000001), encoded on 32 bytes in little endian.

Groups

For G1, the base field is Fq: GF(0x1a0111ea397fe69a4b1ba7b6434bacd764774b84f38512bf6730d2a0f6b0f6241eabfffeb153ffffb9feffffffffaaab)
and E(Fq) := y^2 = x^3 + 4. An element of the base field can be encoded on 48 bytes (using only
381 bits, leaving 3 bits unused).

For G2, the base field is Fq2 := Fq[Z]/(X^2 + 1) and E(Fq2) := y^2 = x^3 + 4 (Z + 1). An element of the base field can be encoded on 2 * 48 bytes
representing each coefficient of the polynomial. 3 bits of each coefficient
encoding are unused.

The « uncompressed » form (x, y) of G1 and G2 is the concatenation of the elements x and y encoded in big endian.

The « compressed » form uses the first 3 most significant (and unused) bits of
the coordinate x.

  • the first most significant bit is always set to 1 to carry the information it
    is the compressed encoding of a point.

  • the second most significant bit is set to 1 if the element is the identity of the curve.

  • the third most significant bit is the sign of y. It is set to 1 if y is
    lexicographically larger than -y.

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 Jun 2021
Sources
ocaml-bls12-381-0.5.0.tar.bz2
md5=5e550e69578c3b991b661c16f012a644
sha512=593051b6de70b8aa433161e8e49f9067cfafb9bbabc0c979958d0f7e1ebd6dd8f95cbb525343b7182a773e44da8d466e7b192578a579442eb58416855362ab77
Dependencies
hex
with-test
alcotest
with-test
bls12-381
= version
bls12-381-gen
= version
js_of_ocaml
>= "3.7.1"
zarith
>= "1.10" & < "1.12"
ff-sig
>= "0.6.1" & < "0.7.0"
dune
>= "2.8.4"
ocaml
>= "4.08"
Reverse Dependencies
bls12-381-js
>= "0.5.0"