package octez-protocol-017-PtNairob-libs

You can search for identifiers within the package.

in-package search v0.2.0

Octez protocol 017-PtNairob libraries

Install

Dune Dependency

www.tezos.com Readme Edit opam file Versions (5)

Authors

T

Tezos devteam

Maintainers

C

contact@tezos.com

Sources

octez-19.1.tar.gz

sha256=55ea1fb8bb3273a7fc270ca8f650d45c56449665619482aad9bc12f3ea736b7e

sha512=fec850fc2d17d7490bbabd5147d62aad13b3aaed8774270f8a38ab419670ed03e0fd30cf8642a97984eca5c2446726fe590ad99c015f7ec50919dc7652f25053

doc/octez-protocol-017-PtNairob-libs.baking/Tezos_baking_017_PtNairob/Liquidity_baking_vote/index.html

Module `Tezos_baking_017_PtNairob.Liquidity_baking_vote`Source

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.

Sourcetype Tezos_base.TzPervasives.error +=

| Block_vote_file_not_found of string

Sourcetype Tezos_base.TzPervasives.error +=

| Block_vote_file_invalid of string

Sourcetype Tezos_base.TzPervasives.error +=

| Block_vote_file_wrong_content of string

Sourcetype Tezos_base.TzPervasives.error +=

| Block_vote_file_missing_liquidity_baking_toggle_vote of string

Sourcetype Tezos_base.TzPervasives.error +=

| Missing_vote_on_startup

Sourceval default_vote_json_filename : string

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.t

Reads 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.t

Load 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.