ligo/src/utils/crypto_box.mli

(**************************************************************************)
(*                                                                        *)
(*    Copyright (c) 2014 - 2016.                                          *)
(*    Dynamic Ledger Solutions, Inc. <contact@tezos.com>                  *)
(*                                                                        *)
(*    All rights reserved. No warranty, explicit or implicit, provided.   *)
(*                                                                        *)
(**************************************************************************)

(** Tezos - X25519/XSalsa20-Poly1305 cryptography *)

type nonce

val random_nonce : unit -> nonce
val increment_nonce : ?step:int -> nonce -> nonce
val nonce_encoding : nonce Data_encoding.t

type target
val compare_target : MBytes.t list -> target -> bool
val validate_target : target -> unit

type secret_key
type public_key

val public_key_encoding : public_key Data_encoding.t
val secret_key_encoding : secret_key Data_encoding.t

val random_keypair : unit -> secret_key * public_key

val box : secret_key -> public_key -> MBytes.t -> nonce -> MBytes.t

val box_open : secret_key -> public_key -> MBytes.t -> nonce -> MBytes.t option

val check_proof_of_work : public_key -> nonce -> target -> bool
val generate_proof_of_work : public_key -> target -> nonce
crypto box initial utility functions for encrypted communication using crypto box (X25519/XSalsa20-Poly1305) 2016-11-03 22:15:31 +04:00			`(**************************************************************************)`
			`(* *)`
			`(* Copyright (c) 2014 - 2016. *)`
			`(* Dynamic Ledger Solutions, Inc. <contact@tezos.com> *)`
			`(* *)`
			`(* All rights reserved. No warranty, explicit or implicit, provided. *)`
			`(* *)`
			`(**************************************************************************)`

			`(** Tezos - X25519/XSalsa20-Poly1305 cryptography *)`

			`type nonce`

			`val random_nonce : unit -> nonce`
			`val increment_nonce : ?step:int -> nonce -> nonce`
Merge remote-tracking branch 'ocp/crypto-box' 2016-11-16 04:19:13 +04:00			`val nonce_encoding : nonce Data_encoding.t`

use 256 bit target for proof of work * SHA256 produces 256 bits pseudo-randomly uniformly, so you may compare to a 256 bit target to get a proof of work * If you pretend that the hash and targets are both integers between 0 and 2^256 - 1, then the target partitions the range into passing and failing segments. * In order to match the use of the `get_uint16` function from `ocplib-endian`, the easiest way to encode `target` is as a `int list` which works if not ideal * This seems like the same thing bitcoin does; difficulty there is actually not a primary notion but is calculated from a 256 bit target, which is what gets adjusted over time 2016-11-18 00:02:32 +04:00			`type target`
			`val compare_target : MBytes.t list -> target -> bool`
			`val validate_target : target -> unit`

Merge remote-tracking branch 'ocp/crypto-box' 2016-11-16 04:19:13 +04:00			`type secret_key`
			`type public_key`

			`val public_key_encoding : public_key Data_encoding.t`
			`val secret_key_encoding : secret_key Data_encoding.t`

			`val random_keypair : unit -> secret_key * public_key`

crypto box initial utility functions for encrypted communication using crypto box (X25519/XSalsa20-Poly1305) 2016-11-03 22:15:31 +04:00			`val box : secret_key -> public_key -> MBytes.t -> nonce -> MBytes.t`
Merge remote-tracking branch 'ocp/crypto-box' 2016-11-16 04:19:13 +04:00
handle decryption exceptions 2016-11-08 02:38:02 +04:00			`val box_open : secret_key -> public_key -> MBytes.t -> nonce -> MBytes.t option`
Merge remote-tracking branch 'ocp/crypto-box' 2016-11-16 04:19:13 +04:00
use 256 bit target for proof of work * SHA256 produces 256 bits pseudo-randomly uniformly, so you may compare to a 256 bit target to get a proof of work * If you pretend that the hash and targets are both integers between 0 and 2^256 - 1, then the target partitions the range into passing and failing segments. * In order to match the use of the `get_uint16` function from `ocplib-endian`, the easiest way to encode `target` is as a `int list` which works if not ideal * This seems like the same thing bitcoin does; difficulty there is actually not a primary notion but is calculated from a 256 bit target, which is what gets adjusted over time 2016-11-18 00:02:32 +04:00			`val check_proof_of_work : public_key -> nonce -> target -> bool`
			`val generate_proof_of_work : public_key -> target -> nonce`