package octez-protocol-017-PtNairob-libs
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=aa2f5bc99cc4ca2217c52a1af2a2cdfd3b383208cb859ca2e79ca0903396ca1d
sha512=d68bb3eb615e3dcccc845fddfc9901c95b3c6dc8e105e39522ce97637b1308a7fa7aa1d271351d5933febd7476b2819e1694f31198f1f0919681f1f9cc97cb3a
doc/octez-protocol-017-PtNairob-libs.baking/Tezos_baking_017_PtNairob/Liquidity_baking_vote/index.html
Module Tezos_baking_017_PtNairob.Liquidity_baking_voteSource
This module is used to load the baker's liquidity baking vote configurations. When a file is given as configuration, its content is expected to be a valid JSON matching the following examples:
{"liquidity_baking_toggle_vote": "on"}{"liquidity_baking_toggle_vote": "off"}{"liquidity_baking_toggle_vote": "pass"}
Moreover, in order to handle dynamic voting (i.e. change the baker's vote without having to restart it), each time a block is being built, the baker will try and read the vote file present in the config in order to check for updated votes.
Default vote file name that should be looked up when the baker starts.
val read_liquidity_baking_toggle_vote_no_fail :
default_liquidity_baking_vote:
Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Liquidity_baking.liquidity_baking_toggle_vote ->
per_block_vote_file:string ->
Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Liquidity_baking.liquidity_baking_toggle_vote
Lwt.tReads the content of per_block_vote_file and returns a vote. If any error occurs (e.g. Non-existing file, unparsable content, etc.), default_liquidity_baking_vote will be returned.
val load_liquidity_baking_config :
per_block_vote_file_arg:string option ->
toggle_vote_arg:
Tezos_protocol_017_PtNairob.Protocol.Alpha_context.Liquidity_baking.liquidity_baking_toggle_vote
option ->
Baking_configuration.liquidity_baking_config Tezos_base.TzPervasives.tzresult
Lwt.tLoad a liquidity baking configuration given two possible arguments. If neither are provided, it fails. Otherwise, it tries, in priority, to read the per_block_vote_file_arg file if it is given and loads a config using its content. Otherwise, the toggle_vote_arg is used.