package octez-libs

  1. Overview
  2. Docs
package octez-libs
Legend:
Library
Module
Module type
Parameter
Class
Class type
type ak = R.ak

Public signature key. Note: if this key is exposed there is privacy loss! Only randomised version of it (rk) are published.

type nk = R.nk

Public nullifier key. Note: if this key is exposed there is privacy loss! Only randomised version of it (rk) are published.

type ivk = R.ivk
type pkd = R.pkd
type ovk = R.ovk
type diversifier = R.diversifier

Used to create an address from a viewing key.

val diversifier_encoding : R.diversifier Data_encoding.encoding
type full_viewing_key = R.full_viewing_key = {
  1. ak : ak;
  2. nk : nk;
  3. ovk : ovk;
}

Full viewing key contains ak, nsk, ovk

val fvk_encoding : full_viewing_key Data_encoding.encoding
type t = R.zip32_full_viewing_key = {
  1. depth : Stdlib.Bytes.t;
  2. parent_fvk_tag : Stdlib.Bytes.t;
  3. child_index : Stdlib.Bytes.t;
  4. chain_code : Stdlib.Bytes.t;
  5. fvk : full_viewing_key;
  6. dk : Stdlib.Bytes.t;
}

Type t additionally contains zip-32 related info

val ovk_of_xfvk : t -> ovk
val encoding : t Data_encoding.t
val to_bytes : R.zip32_full_viewing_key -> Stdlib.Bytes.t
val of_bytes : Stdlib.Bytes.t -> R.zip32_full_viewing_key option
val of_sk : Spending_key.t -> t
type index = R.diversifier_index
val compare_index : R.diversifier_index -> R.diversifier_index -> int
val index_to_int64 : R.diversifier_index -> int64
val index_of_int64 : int64 -> R.diversifier_index
val index_encoding : R.diversifier_index Data_encoding.encoding
val default_index : R.diversifier_index
type address = {
  1. diversifier : diversifier;
  2. pkd : pkd;
}
val address_encoding : address Data_encoding.encoding
val address_b58check_encoding : address Tezos_crypto.Base58.encoding
val to_ivk : t -> R.ivk
val dummy_address : unit -> address
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct