mnsl_pool

This package provides managment tools to run a pool on arkEcosystem mainsail framework. It computes a true block weight (TBW) distribution of reward according to instant participant vote weight.

Ubuntu installation

First read installation script, then:

~$ bash <(wget -qO- https://bit.ly/3U6BI8v)

Setup script creates 9 commands into ~/.bash_aliases file:

  • mnsl_install install a specific version
  • mnsl_deploy takes broadcast ip address and port to create services managed by systemd.
  • dump_prk secures validator private key to sign transactions
  • add_pool takes a validator public key to configure listening subscription on blockchain.
  • set_pool modifies validator TBW pool service parameters.
  • mnsl_venv activates the virtual environment used to run mainsail pool.
  • mnsl_restart restarts pool tasks.
  • log_mnsl_pool shows server logs.
  • log_mnsl_bg shows background tasks logs.

biom

deploy

def deploy(host: str = "127.0.0.1", port: int = 5000)

Deploy pool server

>>> from mnsl_pool import biom
>>> biom.deploy()

~$ mnsl_deploy # use ip address 0.0.0.0 with port `5000`

If you plan to deploy pool server behind a proxy, it is possible to using host and port parameters:

>>> from mnsl_pool import biom
>>> biom.deploy(host="127.0.0.1", port=7542)

~$ mnsl_deploy host=127.0.0.1 port=7542 # use localhost address with port `7542`

add_pool

def add_pool(**kwargs) -> None

Initialize a pool

>>> from mnsl_pool import biom
>>> biom.add_pool(puk="033f786d4875bcae61eb934e6af74090f254d7a0c955263d1ec9c504db")

~$ add_pool puk=033f786d4875bcae61eb934e6af74090f254d7a0c955263d1ec9c504dbba5477ba

INFO:mnsl_pool.biom:grabed options: {'puk': '033f786d4875bcae61eb934e6af74090f254d7a0c955263d1ec9c504dbba5477ba'}
Type or paste your passphrase >
enter pin code to secure secret (only figures)>
provide a network peer API [default=localhost:4003]>
provide your webhook peer [default=localhost:4004]>
provide your target server [default=localhost:5000]>
INFO:mnsl_pool.biom:grabed options: {'prk': [0, 0, 0, 0], 'nethash': '7b9a7c6a14d3f8fb3f47c434b8c6ef0843d5622f6c209ffeec5411aabbf4bf1c', 'webhook': '47f4ede0-1dcb-4653-b9a2-20e766fc31d5', 'puk': '033f786d4875bcae61eb934e6af74090f254d7a0c955263d1ec9c504dbba5477ba'}
INFO:mnsl_pool.biom:delegate 033f786d4875bcae61eb934e6af74090f254d7a0c955263d1ec9c504dbba5477ba set

Check your pool using two endpoints:

http://{ip}:{port}/{puk or username}
http://{ip}:{port}/{puk or username}/forgery

Pool data are stored in ~/.mainsail folder.

set_pool

def set_pool(**kwargs) -> requests.Response

Configure a pool

>>> from mnsl_pool import biom
>>> addresses = [
... "D5Ha4o3UTuTd59vjDw1F26mYhaRdXh7YPv",
... "DTGgFwrVGf5JpvkMSp8QR5seEJ6tCAWFyU"
... ]
>>> biom.set_pool(share=0.7, min_vote=10.0, exlusives=addresses)

$ set_pool --share=0.7 --min-vote=10.0 --exclusives=D5Ha4o3UTuTd59vjDw1F26mYhaRdXh7YPv,DTGgFwrVGf5JpvkMSp8QR5seEJ6tCAWFyU

INFO:pool.biom:grabed options: {'share': 0.7, 'min_vote': 10.0, 'exclusives': 'D5Ha4o3UTuTd59vjDw1F26mYhaRdXh7YPv,DTGgFwrVGf5JpvkMSp8QR5seEJ6tCAWFyU'}
enter validator security pincode>
{'status': 204, 'updated': {'exclusives': ['D5Ha4o3UTuTd59vjDw1F26mYhaRdXh7YPv', 'DTGgFwrVGf5JpvkMSp8QR5seEJ6tCAWFyU'], 'min_vote': 10.0, 'share': 0.7}}

Available pool parameters:

  • share - share rate in float number (0. <= share = 1.0).
  • min_vote - minimum vote to be considered by the pool.
  • max_vote - maximum vote weight caped in the pool.
  • min_share - minimum reward to reach for a vote wallet to be included in payroll.
  • excludes - comma-separated list of wallet to exclude.
  • exclusives - comma-separated list of private pool wallets.
  • block_delay - number of forged block between two payrolls.
  • message - vendorFied message to be set on each payroll transacion.
  • chunck_size - maximum number of recipient for a multipayment.
  • wallet - custom wallet to receive validator share.

Available extra parameters:

  • url - the url of node if domain name is set
  • ip - the ip address of pool service
  • port - the port used by pool service

Those parameters are used to remotly configure pool options. Validator private key have to be secrured on the remote system using dump_prk.

Run a public pool

Voter selection can be donne using min_vote and max_vote options. A more convenient way is possible with excludes list, any address in this list wil be ignored by the TBW process.

Run a private pool

min_vote and max_vote parameters shouldn’t be set but all the addresses granted by the private pool have to be mentioned in exclusive list.

excludes & exclusives lists

List parameters accept a custom action to add or remove item from list.

(excludes|exclusives)[:add|:pop]=coma,separated,list,of,valid,addresses

Define a complete exclusives list:

$ set_pool exclusives=D5Ha4o3UTuTd59vjDw1F26mYhaRdXh7YPv,DTGgFwrVGf5JpvkMSp8QR5seEJ6tCAWFyU

Add DCzk4aCBCeHTDUZ3RnkiK8aqpYYZ9iC51W into exclusives list:

$ set_pool exclusives:add=DCzk4aCBCeHTDUZ3RnkiK8aqpYYZ9iC51W

Remove D5Ha4o3UTuTd59vjDw1F26mYhaRdXh7YPv from exclusives list:

$ set_pool exclusives:pop=D5Ha4o3UTuTd59vjDw1F26mYhaRdXh7YPv