balsoft/ligo
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Client: a bit of doc.

Browse Source
This commit is contained in:
Vincent Bernardoff 2017-03-14 16:32:29 +01:00 committed by Benjamin Canou
parent 215bd0e2d2
commit 8962f324d4
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
src/client/embedded/alpha/baker/client_mining_forge.mli
View File

@ -43,6 +43,23 @@ val forge_block:
src_sk:secret_key -> src_sk:secret_key ->
unit -> unit ->
Block_hash.t tzresult Lwt.t Block_hash.t tzresult Lwt.t
(** [forge_block cctxt parent_blk ?force ?operations ?best_effort
?sort ?timestamp ?max_priority ?priority ~seed_nonce ~src_sk
pk_hash] injects a block in the node. In addition of inject_block,
it will:
* Operations: If [?operations] is [None], it will get pending
operations and add them to the block. Otherwise, provided
operations will be used. In both cases, they will be validated.
* Mining priority: If [`Auto] is used, it will be computed from
the public key hash of the specified contract, optionally capped
to a maximum value.
* Timestamp: If [?timestamp] is set, and is compatible with the
computed mining priority, it will be used. Otherwise, it will be
set at the best mining priority.
*)
module State : sig module State : sig
val get_block: val get_block: