(* The MIT License (MIT)
 *
 * Copyright (c) 2019-2020 Nomadic Labs <contact@nomadic-labs.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE. *)

open Tezos_sapling.Core.Client

(** Mnemonic of 24 common english words from which a key can be derived.
    The mnemonic follows the BIP-39 spec. *)
module Mnemonic : sig
  val new_random : Bip39.t

  (** Pretty printer for printing a list of words of a mnemonic. *)
  val words_pp : Format.formatter -> string list -> unit
end

(** Add to the wallet a new spending key derived from a mnemonic and identified
    by an alias. The wallet is updated and the corresponding viewing key is
    returned.
    If [force] it will overwrite an existing alias. *)
val register :
  #Client_context.full ->
  ?force:bool ->
  ?unencrypted:bool ->
  Bip39.t ->
  string ->
  Viewing_key.t tzresult Lwt.t

(** [derive parent child index] derives a key with alias [child] from an
    existing key with alias [parent] at [index] using ZIP32.
    If a new index is required the state of the wallet is updated.
    The path and viewing key corresponding to the generated key are returned. *)
val derive :
  #Client_context.full ->
  ?force:bool ->
  ?unencrypted:bool ->
  string ->
  string ->
  int ->
  (string * Viewing_key.t) tzresult Lwt.t

val find_vk : #Client_context.full -> string -> Viewing_key.t tzresult Lwt.t

(** Generate a new address.
    If an optional index is provided, try to derive the address at this index,
    otherwise use the first viable one.
    Not all indexes correspond to a valid address so successive ones are tried.
    Once a valid index is found it is recorded in the wallet.
    Return also the corresponding sk and vk to avoid asking the user multiple
    times for the description password. *)
val new_address :
  #Client_context.full ->
  string ->
  int option ->
  (Spending_key.t * Viewing_key.index * Viewing_key.address) tzresult Lwt.t

val export_vk :
  #Client_context.full -> string -> Data_encoding.Json.json tzresult Lwt.t