balancemanager.__main__

Module Contents

balancemanager.__main__.logger

balancemanager.__main__.validate_optional_transfer_amount(ctx, param, value)

balancemanager.__main__.validate_transfer_amount(ctx, param, value)

balancemanager.__main__.polyswarm_client(func)

balancemanager.__main__.cli(log, client_log, log_format)

Entrypoint for the balance manager driver

Parameters

• log (str) – Log level for balancemanger module logs

• client_log (str) – Log level for all polyswarmclient module logs

• log_format (str) – Choose either json, or text log format

balancemanager.__main__.deposit(polyswarmd_addr, keyfile, password, api_key, testing, insecure_transport, denomination, all, amount)

Entrypoint to deposit NCT into a sidechain

Parameters

• polyswarmd_addr (str) – Address for the polyswarmd server

• keyfile (str) – Path to the keyfile

• password (str) – Password to unlock keyfile

• api_key (str) – ApiKey to access polyswarmd

• testing (int) – Number of tests to run

• insecure_transport (bool) – Flag to allow use of http instead of https

• denomination (str) – Choose to interpret amount as nct, nct-gwei, or nct-wei

• all (bool) – Choose to deposit the entire homechain balance

• amount (float) – Amount of Nectar (NCT) to transfer

balancemanager.__main__.withdraw(polyswarmd_addr, keyfile, password, api_key, testing, insecure_transport, denomination, all, amount)

Entrypoint to withdraw NCT from a sidechain into the homechain

Parameters

• polyswarmd_addr (str) – Address for the polyswarmd server

• keyfile (str) – Path to the keyfile

• password (str) – Password to unlock keyfile

• api_key (str) – ApiKey to access polyswarmd

• testing (int) – Number of tests to run

• insecure_transport (bool) – Flag to allow use of http instead of https

• denomination (str) – Choose to interpret amount as nct, nct-gwei, or nct-wei

• all (bool) – Choose to withdraw the entire sidechain balance

• amount (float) – Amount of Nectar (NCT) to transfer (if not all)

balancemanager.__main__.maintain(polyswarmd_addr, keyfile, password, api_key, testing, insecure_transport, denomination, maximum, withdraw_target, confirmations, minimum, refill_amount)

Entrypoint to withdraw NCT from a sidechain into the homechain

Parameters

• polyswarmd_addr (str) – Address for the polyswarmd server

• keyfile (str) – Path to the keyfile

• password (str) – Password to unlock keyfile

• api_key (str) – ApiKey to access polyswarmd

• testing (int) – Number of tests to run

• insecure_transport (bool) – Flag to allow use of http instead of https

• denomination (str) – Choose to interpret amount as nct, nct-gwei, or nct-wei

• maximum (int) – Maximum balance to before starting a withdrawal from sidechain

• withdraw_target (int) – Target value after performing a withdrawal

• confirmations (int) – Number of confirmations to wait to confirm a transfer occurred

• minimum (float) – Value of NCT on sidechain where you want to transfer more NCT

• refill_amount (float) – Value of NCT to transfer anytime the balance falls below the minimum