def load_config_file(wllt_clnt_mngr, network_config, master_cfg):
provider_factory = ProviderFactory(args.reward_data_provider)
parser = BakingYamlConfParser(None,
wllt_clnt_mngr,
provider_factory,
network_config,
args.node_addr,
api_base_url=args.api_base_url)
parser.parse()
parser.validate()
parser.process()
cfg_dict = parser.get_conf_obj()
# dictionary to BakingConf object, for a bit of type safety
cfg = BakingConf(cfg_dict, master_cfg)
logger.info("Baking Configuration {}".format(cfg))
baking_address = cfg.get_baking_address()
payment_address = cfg.get_payment_address()
logger.info(LINER)
logger.info("BAKING ADDRESS is {}".format(baking_address))
logger.info("PAYMENT ADDRESS is {}".format(payment_address))
logger.info(LINER)
# 7- get reporting directories
reports_dir = os.path.expanduser(args.reports_base)
reports_dir = os.path.join(reports_dir, baking_address)
payments_root = get_payment_root(reports_dir, create=True)
get_successful_payments_dir(payments_root, create=True)
get_failed_payments_dir(payments_root, create=True)
def test_validate_pymnt_alias(self):
data_no_founders = """
version : 1.0
baking_address : tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj
payment_address : ktPay
owners_map : {'KT2Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj':0.5,'KT3Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj':0.5}
service_fee : 4.5
min_delegation_amt : 100
"""
managers_map = {
'tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj':
'tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj',
'KT1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj':
'tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj'
}
contr_dict_by_alias = {'ktPay': 'KT1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj'}
addr_dict_by_pkh = {
"tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj": {
"pkh": "tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj",
"originated": False,
"alias": "ktPay",
"sk": True,
"manager": "tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj"
}
}
wallet_client_manager = WalletClientManager(
client_path=None,
addr_dict_by_pkh=addr_dict_by_pkh,
contr_dict_by_alias=contr_dict_by_alias,
managers=managers_map)
cnf_prsr = BakingYamlConfParser(data_no_founders,
wallet_client_manager)
cnf_prsr.parse()
cnf_prsr.validate()
self.assertEqual(cnf_prsr.get_conf_obj_attr('baking_address'),
'tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj')
self.assertEqual(cnf_prsr.get_conf_obj_attr('payment_address'),
'ktPay')
self.assertEqual(cnf_prsr.get_conf_obj_attr('payment_address_pkh'),
'KT1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj')
self.assertEqual(cnf_prsr.get_conf_obj_attr('payment_address_manager'),
'tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj')
self.assertEqual(cnf_prsr.get_conf_obj_attr('payment_address_type'),
AddrType.KTALS)
self.assertEqual(cnf_prsr.get_conf_obj_attr('founders_map'), dict())
self.assertEqual(cnf_prsr.get_conf_obj_attr('specials_map'), dict())
self.assertEqual(cnf_prsr.get_conf_obj_attr('supporters_set'), set())
self.assertEqual(cnf_prsr.get_conf_obj_attr('excluded_delegators_set'),
set())
self.assertEqual(100, cnf_prsr.get_conf_obj_attr('min_delegation_amt'))
self.assertEqual(cnf_prsr.get_conf_obj_attr('prcnt_scale'), None)
self.assertEqual(cnf_prsr.get_conf_obj_attr('pymnt_scale'), None)
def test_validate_no_founders_map(self):
data_no_founders = """
version : 1.0
baking_address : dn1VWnJRnF3vsa3tkYp3PqoCbV1eBRc5vJ2x
payment_address : dn1VWnJRnF3vsa3tkYp3PqoCbV1eBRc5vJ2x
owners_map : {'KT2Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj':0.5,'KT3Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj':0.5}
service_fee : 4.5
"""
managers_map = {
'dn1VWnJRnF3vsa3tkYp3PqoCbV1eBRc5vJ2x':
'dn1VWnJRnF3vsa3tkYp3PqoCbV1eBRc5vJ2x'
}
contr_dict_by_alias = {}
addr_dict_by_pkh = {
"dn1VWnJRnF3vsa3tkYp3PqoCbV1eBRc5vJ2x": {
"pkh": "dn1VWnJRnF3vsa3tkYp3PqoCbV1eBRc5vJ2x",
"originated": False,
"alias": "main1",
"sk": True,
"manager": "dn1VWnJRnF3vsa3tkYp3PqoCbV1eBRc5vJ2x"
}
}
wallet_client_manager = WalletClientManager(
client_path=None,
addr_dict_by_pkh=addr_dict_by_pkh,
contr_dict_by_alias=contr_dict_by_alias,
managers=managers_map)
mirror_selector = DunScanMirrorSelector(network)
mirror_selector.initialize()
block_api = DunScanBlockApiImpl(network, mirror_selector)
cnf_prsr = BakingYamlConfParser(data_no_founders,
wallet_client_manager,
provider_factory=None,
network_config=network,
node_url=mainnet_public_node_url,
block_api=block_api)
cnf_prsr.parse()
cnf_prsr.validate()
self.assertEqual(cnf_prsr.get_conf_obj_attr('baking_address'),
'dn1VWnJRnF3vsa3tkYp3PqoCbV1eBRc5vJ2x')
self.assertEqual(cnf_prsr.get_conf_obj_attr('payment_address'),
'dn1VWnJRnF3vsa3tkYp3PqoCbV1eBRc5vJ2x')
self.assertEqual(cnf_prsr.get_conf_obj_attr('__payment_address_pkh'),
'dn1VWnJRnF3vsa3tkYp3PqoCbV1eBRc5vJ2x')
self.assertEqual(
cnf_prsr.get_conf_obj_attr('__payment_address_manager'),
'dn1VWnJRnF3vsa3tkYp3PqoCbV1eBRc5vJ2x')
self.assertEqual(cnf_prsr.get_conf_obj_attr('__payment_address_type'),
AddrType.DN)
self.assertEqual(cnf_prsr.get_conf_obj_attr('founders_map'), dict())
self.assertEqual(cnf_prsr.get_conf_obj_attr('specials_map'), dict())
self.assertEqual(cnf_prsr.get_conf_obj_attr('supporters_set'), set())
self.assertEqual(0, cnf_prsr.get_conf_obj_attr('min_delegation_amt'))
def test_validate_no_founders_map(self):
data_no_founders = """
version : 1.0
baking_address : tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj
payment_address : tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj
owners_map : {'KT2Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj':0.5,'KT3Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj':0.5}
service_fee : 4.5
"""
managers_map = {
'tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj':
'tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj'
}
contr_dict_by_alias = {}
addr_dict_by_pkh = {
"tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj": {
"pkh": "tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj",
"originated": False,
"alias": "main1",
"sk": True,
"manager": "tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj"
}
}
wallet_client_manager = WalletClientManager(
client_path=None,
node_addr=None,
addr_dict_by_pkh=addr_dict_by_pkh,
contr_dict_by_alias=contr_dict_by_alias,
managers=managers_map)
block_api = RpcBlockApiImpl(network, mainnet_public_node_url)
cnf_prsr = BakingYamlConfParser(data_no_founders,
wallet_client_manager,
provider_factory=None,
network_config=network,
node_url=mainnet_public_node_url,
block_api=block_api)
cnf_prsr.parse()
cnf_prsr.validate()
self.assertEqual(cnf_prsr.get_conf_obj_attr('baking_address'),
'tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj')
self.assertEqual(cnf_prsr.get_conf_obj_attr('payment_address'),
'tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj')
self.assertEqual(cnf_prsr.get_conf_obj_attr('__payment_address_pkh'),
'tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj')
self.assertEqual(
cnf_prsr.get_conf_obj_attr('__payment_address_manager'),
'tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj')
self.assertEqual(cnf_prsr.get_conf_obj_attr('__payment_address_type'),
AddrType.TZ)
self.assertEqual(cnf_prsr.get_conf_obj_attr('founders_map'), dict())
self.assertEqual(cnf_prsr.get_conf_obj_attr('specials_map'), dict())
self.assertEqual(cnf_prsr.get_conf_obj_attr('supporters_set'), set())
self.assertEqual(0, cnf_prsr.get_conf_obj_attr('min_delegation_amt'))
def test_validate_no_founders_map(self):
data_no_founders = """
version: 1.0
baking_address: tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj
payment_address: tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj
owners_map: {'KT2Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj': 0.5,'KT3Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj': 0.5}
supporters_set: None
service_fee: 4.5
reactivate_zeroed: False
delegator_pays_ra_fee: True
rewards_type:
plugins:
enabled:
"""
wallet_client_manager = ClientManager('', '')
block_api = RpcBlockApiImpl(network, self.mainnet_public_node_url)
cnf_prsr = BakingYamlConfParser(data_no_founders,
wallet_client_manager,
provider_factory=None,
network_config=network,
node_url=self.mainnet_public_node_url,
block_api=block_api)
cnf_prsr.parse()
cnf_prsr.validate()
self.assertEqual(cnf_prsr.get_conf_obj_attr('baking_address'),
'tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj')
self.assertEqual(cnf_prsr.get_conf_obj_attr('payment_address'),
'tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj')
self.assertEqual(cnf_prsr.get_conf_obj_attr('__payment_address_pkh'),
'tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj')
self.assertEqual(
cnf_prsr.get_conf_obj_attr('__payment_address_manager'),
'tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj')
self.assertEqual(cnf_prsr.get_conf_obj_attr('__payment_address_type'),
AddrType.TZ)
self.assertEqual(cnf_prsr.get_conf_obj_attr('founders_map'), dict())
self.assertEqual(cnf_prsr.get_conf_obj_attr('specials_map'), dict())
self.assertEqual(cnf_prsr.get_conf_obj_attr('supporters_set'), set())
self.assertEqual(cnf_prsr.get_conf_obj_attr('min_delegation_amt'), 0)
self.assertEqual(cnf_prsr.get_conf_obj_attr('reactivate_zeroed'),
False)
self.assertEqual(cnf_prsr.get_conf_obj_attr('delegator_pays_ra_fee'),
True)
self.assertEqual(cnf_prsr.get_conf_obj_attr('rewards_type'),
RewardsType.ACTUAL)
plugins = cnf_prsr.get_conf_obj_attr('plugins')
self.assertIsInstance(plugins, dict)
self.assertIsNone(plugins['enabled'], None)
def test_validate_scales(self):
data_fine = """
version : 1.0
baking_address : tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj
payment_address : tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj
founders_map : {'KT2Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj':0.5,'KT3Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj':0.5}
owners_map : {'KT2Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj':0.5,'KT3Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj':0.5}
service_fee : 4.5
pymnt_scale : 3
prcnt_scale : 5
"""
managers = {
'tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj':
'tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj',
'KT1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj':
'tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj'
}
contr_dict_by_alias = {}
addr_dict_by_pkh = {
"tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj": {
"pkh": "tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj",
"originated": False,
"alias": "main1",
"sk": True,
"manager": "tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj"
}
}
wallet_client_manager = WalletClientManager(
client_path=None,
addr_dict_by_pkh=addr_dict_by_pkh,
contr_dict_by_alias=contr_dict_by_alias,
managers=managers)
cnf_prsr = BakingYamlConfParser(data_fine, wallet_client_manager)
cnf_prsr.parse()
cnf_prsr.validate()
self.assertEqual(cnf_prsr.get_conf_obj_attr('baking_address'),
'tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj')
self.assertEqual(cnf_prsr.get_conf_obj_attr('payment_address'),
'tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj')
self.assertEqual(cnf_prsr.get_conf_obj_attr('payment_address_pkh'),
'tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj')
self.assertEqual(cnf_prsr.get_conf_obj_attr('payment_address_manager'),
'tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj')
self.assertEqual(cnf_prsr.get_conf_obj_attr('payment_address_type'),
AddrType.TZ)
self.assertEqual(0, cnf_prsr.get_conf_obj_attr('min_delegation_amt'))
self.assertEqual(cnf_prsr.get_conf_obj_attr('excluded_delegators_set'),
set())
self.assertEqual(cnf_prsr.get_conf_obj_attr('prcnt_scale'), 5)
self.assertEqual(cnf_prsr.get_conf_obj_attr('pymnt_scale'), 3)
def test_validate(self):
data_fine = """
version: 1.0
baking_address: tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj
payment_address: tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj
founders_map: {'KT2Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj': 0.5,'KT3Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj': 0.5}
owners_map: {'KT2Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj': 0.5,'KT3Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj': 0.5}
service_fee: 4.53
reactivate_zeroed: False
delegator_pays_ra_fee: True
"""
managers = {'tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj': 'tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj',
'KT1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj': 'tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj'}
contr_dict_by_alias = {}
addr_dict_by_pkh = {
"tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj": {"pkh": "tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj", "originated": False,
"alias": "main1", "sk": True, "revealed": True,
"manager": "tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj"},
"KT1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj": {"pkh": "KT1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj", "originated": True,
"alias": "kt1", "sk": True, "revealed": True,
"manager": "tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj"}
}
wallet_client_manager = WalletClientManager(client_path=None, node_addr=None,
addr_dict_by_pkh=addr_dict_by_pkh,
contr_dict_by_alias=contr_dict_by_alias,
managers=managers)
block_api = RpcBlockApiImpl(network, self.mainnet_public_node_url)
cnf_prsr = BakingYamlConfParser(data_fine, wallet_client_manager, provider_factory=None,
network_config=network, node_url=self.mainnet_public_node_url,
block_api=block_api)
cnf_prsr.parse()
cnf_prsr.validate()
self.assertEqual(cnf_prsr.get_conf_obj_attr('baking_address'), 'tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj')
self.assertEqual(cnf_prsr.get_conf_obj_attr('payment_address'), 'tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj')
self.assertEqual(cnf_prsr.get_conf_obj_attr('__payment_address_pkh'), 'tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj')
self.assertEqual(cnf_prsr.get_conf_obj_attr('__payment_address_manager'), 'tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj')
self.assertEqual(cnf_prsr.get_conf_obj_attr('__payment_address_type'), AddrType.TZ)
self.assertEqual(cnf_prsr.get_conf_obj_attr('min_delegation_amt'), 0)
self.assertEqual(cnf_prsr.get_conf_obj_attr('reactivate_zeroed'), False)
self.assertEqual(cnf_prsr.get_conf_obj_attr('delegator_pays_ra_fee'), True)
def main(args):
logger.info("TRD version {} is running in {} mode.".format(
version.version,
"daemon" if args.background_service else "interactive"))
logger.info("Arguments Configuration = {}".format(
json.dumps(args.__dict__, indent=1)))
# 1- find where configuration is
config_dir = os.path.expanduser(args.config_dir)
# create configuration directory if it is not present
# so that user can easily put his configuration there
if config_dir and not os.path.exists(config_dir):
os.makedirs(config_dir)
# 2- Load master configuration file if it is present
master_config_file_path = os.path.join(config_dir, "master.yaml")
master_cfg = {}
if os.path.isfile(master_config_file_path):
logger.debug("Loading master configuration file {}".format(
master_config_file_path))
master_parser = YamlConfParser(
ConfigParser.load_file(master_config_file_path))
master_cfg = master_parser.parse()
else:
logger.debug("master configuration file not present.")
managers = None
contracts_by_alias = None
addresses_by_pkh = None
if 'managers' in master_cfg:
managers = master_cfg['managers']
if 'contracts_by_alias' in master_cfg:
contracts_by_alias = master_cfg['contracts_by_alias']
if 'addresses_by_pkh' in master_cfg:
addresses_by_pkh = master_cfg['addresses_by_pkh']
# 3- get client path
client_path = get_client_path(
[x.strip() for x in args.executable_dirs.split(',')], args.docker,
args.network, args.verbose)
logger.debug("Dune client path is {}".format(client_path))
# 4. get network config
config_client_manager = SimpleClientManager(client_path)
network_config_map = init_network_config(args.network,
config_client_manager,
args.node_addr)
network_config = network_config_map[args.network]
logger.debug("Network config {}".format(network_config))
# 5- load baking configuration file
config_file_path = get_baking_configuration_file(config_dir)
logger.info(
"Loading baking configuration file {}".format(config_file_path))
wllt_clnt_mngr = WalletClientManager(client_path,
contracts_by_alias,
addresses_by_pkh,
managers,
verbose=args.verbose)
provider_factory = ProviderFactory(args.reward_data_provider,
verbose=args.verbose)
parser = BakingYamlConfParser(ConfigParser.load_file(config_file_path),
wllt_clnt_mngr,
provider_factory,
network_config,
args.node_addr,
verbose=args.verbose)
parser.parse()
parser.validate()
parser.process()
cfg_dict = parser.get_conf_obj()
# dictionary to BakingConf object, for a bit of type safety
cfg = BakingConf(cfg_dict, master_cfg)
logger.info("Baking Configuration {}".format(cfg))
baking_address = cfg.get_baking_address()
payment_address = cfg.get_payment_address()
logger.info(LINER)
logger.info("BAKING ADDRESS is {}".format(baking_address))
logger.info("PAYMENT ADDRESS is {}".format(payment_address))
logger.info(LINER)
# 6- is it a reports run
dry_run = args.dry_run_no_consumers or args.dry_run
if args.dry_run_no_consumers:
global NB_CONSUMERS
NB_CONSUMERS = 0
# 7- get reporting directories
reports_base = os.path.expanduser(args.reports_base)
# if in reports run mode, do not create consumers
# create reports in reports directory
if dry_run:
reports_base = os.path.expanduser("./reports")
reports_dir = os.path.join(reports_base, baking_address)
payments_root = get_payment_root(reports_dir, create=True)
calculations_root = get_calculations_root(reports_dir, create=True)
get_successful_payments_dir(payments_root, create=True)
get_failed_payments_dir(payments_root, create=True)
# 8- start the life cycle
life_cycle.start(not dry_run)
# 9- service fee calculator
srvc_fee_calc = ServiceFeeCalculator(cfg.get_full_supporters_set(),
cfg.get_specials_map(),
cfg.get_service_fee())
if args.initial_cycle is None:
recent = get_latest_report_file(payments_root)
# if payment logs exists set initial cycle to following cycle
# if payment logs does not exists, set initial cycle to 0, so that payment starts from last released rewards
args.initial_cycle = 0 if recent is None else int(recent) + 1
logger.info("initial_cycle set to {}".format(args.initial_cycle))
p = PaymentProducer(name='producer',
initial_payment_cycle=args.initial_cycle,
network_config=network_config,
payments_dir=payments_root,
calculations_dir=calculations_root,
run_mode=RunMode(args.run_mode),
service_fee_calc=srvc_fee_calc,
release_override=args.release_override,
payment_offset=args.payment_offset,
baking_cfg=cfg,
life_cycle=life_cycle,
payments_queue=payments_queue,
dry_run=dry_run,
wllt_clnt_mngr=wllt_clnt_mngr,
node_url=args.node_addr,
provider_factory=provider_factory,
verbose=args.verbose)
p.start()
publish_stats = not args.do_not_publish_stats
for i in range(NB_CONSUMERS):
c = PaymentConsumer(
name='consumer' + str(i),
payments_dir=payments_root,
key_name=payment_address,
client_path=client_path,
payments_queue=payments_queue,
node_addr=args.node_addr,
wllt_clnt_mngr=wllt_clnt_mngr,
args=args,
verbose=args.verbose,
dry_run=dry_run,
delegator_pays_xfer_fee=cfg.get_delegator_pays_xfer_fee(),
dest_map=cfg.get_dest_map(),
network_config=network_config,
publish_stats=publish_stats)
time.sleep(1)
c.start()
logger.info("Application start completed")
logger.info(LINER)
try:
while life_cycle.is_running():
time.sleep(10)
except KeyboardInterrupt:
logger.info("Interrupted.")
life_cycle.stop()
def main(args):
logger.info("Arguments Configuration = {}".format(
json.dumps(args.__dict__, indent=1)))
# 1- find where configuration is
config_dir = os.path.expanduser(args.config_dir)
# create configuration directory if it is not present
# so that user can easily put his configuration there
if config_dir and not os.path.exists(config_dir):
os.makedirs(config_dir)
# 2- Load master configuration file if it is present
master_config_file_path = os.path.join(config_dir, "master.yaml")
master_cfg = {}
if os.path.isfile(master_config_file_path):
logger.info("Loading master configuration file {}".format(
master_config_file_path))
master_parser = YamlConfParser(
ConfigParser.load_file(master_config_file_path))
master_cfg = master_parser.parse()
else:
logger.info("master configuration file not present.")
managers = None
contracts_by_alias = None
addresses_by_pkh = None
if 'managers' in master_cfg:
managers = master_cfg['managers']
if 'contracts_by_alias' in master_cfg:
contracts_by_alias = master_cfg['contracts_by_alias']
if 'addresses_by_pkh' in master_cfg:
addresses_by_pkh = master_cfg['addresses_by_pkh']
# 3- get client path
client_path = get_client_path(
[x.strip() for x in args.executable_dirs.split(',')], args.docker,
args.network, args.verbose)
logger.debug("Tezos client path is {}".format(client_path))
# 4. get network config
config_client_manager = SimpleClientManager(client_path, args.node_addr)
network_config_map = init_network_config(args.network,
config_client_manager,
args.node_addr)
network_config = network_config_map[args.network]
# 5- load baking configuration file
config_file_path = get_baking_configuration_file(config_dir)
logger.info(
"Loading baking configuration file {}".format(config_file_path))
wllt_clnt_mngr = WalletClientManager(client_path,
contracts_by_alias,
addresses_by_pkh,
managers,
verbose=args.verbose)
provider_factory = ProviderFactory(args.reward_data_provider,
verbose=args.verbose)
parser = BakingYamlConfParser(ConfigParser.load_file(config_file_path),
wllt_clnt_mngr,
provider_factory,
network_config,
args.node_addr,
verbose=args.verbose,
api_base_url=args.api_base_url)
parser.parse()
parser.validate()
parser.process()
cfg_dict = parser.get_conf_obj()
# dictionary to BakingConf object, for a bit of type safety
cfg = BakingConf(cfg_dict, master_cfg)
logger.info("Baking Configuration {}".format(cfg))
baking_address = cfg.get_baking_address()
payment_address = cfg.get_payment_address()
logger.info(LINER)
logger.info("BAKING ADDRESS is {}".format(baking_address))
logger.info("PAYMENT ADDRESS is {}".format(payment_address))
logger.info(LINER)
# 6- is it a reports run
dry_run = args.dry_run_no_consumers or args.dry_run
if args.dry_run_no_consumers:
global NB_CONSUMERS
NB_CONSUMERS = 0
# 7- get reporting directories
reports_dir = os.path.expanduser(args.reports_base)
# if in reports run mode, do not create consumers
# create reports in reports directory
if dry_run:
reports_dir = os.path.expanduser("./reports")
reports_dir = os.path.join(reports_dir, baking_address)
payments_root = get_payment_root(reports_dir, create=True)
calculations_root = get_calculations_root(reports_dir, create=True)
get_successful_payments_dir(payments_root, create=True)
get_failed_payments_dir(payments_root, create=True)
# 8- start the life cycle
life_cycle.start(False)
# 9- service fee calculator
srvc_fee_calc = ServiceFeeCalculator(cfg.get_full_supporters_set(),
cfg.get_specials_map(),
cfg.get_service_fee())
try:
p = PaymentProducer(name='producer',
initial_payment_cycle=None,
network_config=network_config,
payments_dir=payments_root,
calculations_dir=calculations_root,
run_mode=RunMode.ONETIME,
service_fee_calc=srvc_fee_calc,
release_override=0,
payment_offset=0,
baking_cfg=cfg,
life_cycle=life_cycle,
payments_queue=payments_queue,
dry_run=dry_run,
wllt_clnt_mngr=wllt_clnt_mngr,
node_url=args.node_addr,
provider_factory=provider_factory,
verbose=args.verbose,
api_base_url=args.api_base_url)
p.retry_failed_payments(args.retry_injected)
c = PaymentConsumer(
name='consumer_retry_failed',
payments_dir=payments_root,
key_name=payment_address,
client_path=client_path,
payments_queue=payments_queue,
node_addr=args.node_addr,
wllt_clnt_mngr=wllt_clnt_mngr,
verbose=args.verbose,
dry_run=dry_run,
delegator_pays_xfer_fee=cfg.get_delegator_pays_xfer_fee(),
network_config=network_config)
time.sleep(1)
c.start()
p.exit()
c.join()
logger.info("Application start completed")
logger.info(LINER)
sleep(5)
except KeyboardInterrupt:
logger.info("Interrupted.")
class ConfigLifeCycle:
def __init__(self, args, nw_cfg, node_client, callback):
self.__args = args
self.__nw_cfg = nw_cfg
self.__node_client = node_client
self.__config_text = None
self.__parser = None
self.__callback = callback
self.fsm = self.get_fsm_builder().build()
def get_fsm_builder(self):
fsm_builder = TransitionsFsmBuilder()
fsm_builder.add_initial_state(
ConfigState.INITIAL,
on_leave=lambda e: logger.debug(
"Loading baking configuration file ..."),
)
fsm_builder.add_state(ConfigState.READ,
on_enter=self.do_read_configuration_file)
fsm_builder.add_state(ConfigState.BUILT, on_enter=self.do_build_parser)
fsm_builder.add_state(ConfigState.PARSED, on_enter=self.do_parse_cfg)
fsm_builder.add_state(ConfigState.VALIDATED,
on_enter=self.do_validate_cfg)
fsm_builder.add_state(ConfigState.PROCESSED,
on_enter=self.do_process_cfg)
fsm_builder.add_final_state(
ConfigState.COMPLETED,
on_enter=lambda e: self.__callback(self.get_conf()))
fsm_builder.add_transition(ConfigEvent.READ, ConfigState.INITIAL,
ConfigState.READ)
fsm_builder.add_transition(ConfigEvent.BUILD, ConfigState.READ,
ConfigState.BUILT)
fsm_builder.add_transition(ConfigEvent.PARSE, ConfigState.BUILT,
ConfigState.PARSED)
fsm_builder.add_transition(ConfigEvent.VALIDATE, ConfigState.PARSED,
ConfigState.VALIDATED)
fsm_builder.add_transition(ConfigEvent.PROCESS, ConfigState.VALIDATED,
ConfigState.PROCESSED)
fsm_builder.add_transition(ConfigEvent.COMPLETE, ConfigState.PROCESSED,
ConfigState.COMPLETED)
return fsm_builder
def start(self):
self.fsm.trigger_event(ConfigEvent.READ)
self.fsm.trigger_event(ConfigEvent.BUILD)
self.fsm.trigger_event(ConfigEvent.PARSE)
self.fsm.trigger_event(ConfigEvent.VALIDATE)
self.fsm.trigger_event(ConfigEvent.PROCESS)
self.fsm.trigger_event(ConfigEvent.COMPLETE)
def do_read_configuration_file(self, e):
config_dir = os.path.join(
os.path.expanduser(os.path.normpath(self.args.base_directory)),
CONFIG_DIR,
"",
)
# create configuration directory if it is not present
# so that user can easily put his configuration there
if config_dir and not os.path.exists(config_dir):
logger.debug("Creating path '{}'".format(config_dir))
os.makedirs(config_dir)
config_file_path = self.get_baking_cfg_file(config_dir)
logger.info(
"Loading baking configuration file {}".format(config_file_path))
self.__config_text = ConfigParser.load_file(config_file_path)
def do_build_parser(self, e):
provider_factory = ProviderFactory(self.args.reward_data_provider)
self.__parser = BakingYamlConfParser(
yaml_text=self.__config_text,
clnt_mngr=self.__node_client,
provider_factory=provider_factory,
network_config=self.__nw_cfg,
node_url=self.args.node_endpoint,
api_base_url=self.args.api_base_url,
)
def do_parse_cfg(self, e):
self.__parser.parse()
def do_validate_cfg(self, e):
self.__parser.validate()
def do_process_cfg(self, e):
self.__parser.process()
def get_conf(self):
cfg_dict = self.__parser.get_conf_obj()
return BakingConf(cfg_dict)
@property
def args(self):
return self.__args
@staticmethod
def get_baking_cfg_file(cfg_dir):
cfg_file = None
for file in os.listdir(cfg_dir):
if file.endswith(".yaml") and not file.startswith("master"):
if cfg_file:
raise Exception(
"Application only supports one baking configuration file. Found at least 2 {}, {}"
.format(cfg_file, file))
cfg_file = file
if cfg_file is None:
raise Exception(
"Unable to find any '.yaml' configuration files inside configuration directory({})"
.format(cfg_dir))
return os.path.join(cfg_dir, cfg_file)
def test_validate_empty(self):
data_fine = """
version : 1.0
baking_address : tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj
payment_address : KT1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj
service_fee : 4.5
founders_map : {}
owners_map : {}
specials_map : {}
supporters_set : {}
min_delegation_amt : 0
"""
managers = {
'tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj':
'tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj',
'KT1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj':
'tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj'
}
contr_dict_by_alias = {}
addr_dict_by_pkh = {
"tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj": {
"pkh": "tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj",
"originated": False,
"alias": "main1",
"sk": True,
"manager": "tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj"
},
"KT1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj": {
"pkh": "tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj",
"originated": True,
"alias": "kt1",
"sk": True,
"manager": "tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj"
}
}
wallet_client_manager = WalletClientManager(
client_path=None,
addr_dict_by_pkh=addr_dict_by_pkh,
contr_dict_by_alias=contr_dict_by_alias,
managers=managers)
cnf_prsr = BakingYamlConfParser(data_fine,
wallet_client_manager,
network_config=network)
cnf_prsr.parse()
cnf_prsr.validate()
self.assertEqual(cnf_prsr.get_conf_obj_attr('baking_address'),
'tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj')
self.assertEqual(cnf_prsr.get_conf_obj_attr('payment_address'),
'KT1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj')
self.assertEqual(cnf_prsr.get_conf_obj_attr('payment_address_pkh'),
'KT1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj')
self.assertEqual(cnf_prsr.get_conf_obj_attr('payment_address_manager'),
'tz1Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj')
self.assertEqual(cnf_prsr.get_conf_obj_attr('payment_address_type'),
AddrType.KT)
self.assertEqual(0, cnf_prsr.get_conf_obj_attr('min_delegation_amt'))
self.assertEqual(cnf_prsr.get_conf_obj_attr('supporters_set'), set())
def main(args):
logger.info("TRD version {} is running in {} mode.".format(
VERSION, "daemon" if args.background_service else "interactive"))
logger.info("Arguments Configuration = {}".format(
json.dumps(args.__dict__, indent=1)))
publish_stats = not args.do_not_publish_stats
logger.info(
"Anonymous statistics {} be collected. See docs/statistics.rst for more information."
.format("will" if publish_stats else "will not"))
# 1- find where configuration is
config_dir = os.path.expanduser(args.config_dir)
# create configuration directory if it is not present
# so that user can easily put his configuration there
if config_dir and not os.path.exists(config_dir):
os.makedirs(config_dir)
# 4. get network config
client_manager = ClientManager(node_endpoint=args.node_endpoint,
signer_endpoint=args.signer_endpoint)
network_config_map = init_network_config(args.network, client_manager)
network_config = network_config_map[args.network]
logger.debug("Network config {}".format(network_config))
# Setup provider to fetch RPCs
provider_factory = ProviderFactory(args.reward_data_provider)
# 5- load and verify baking configuration file
config_file_path = None
try:
config_file_path = get_baking_configuration_file(config_dir)
logger.info(
"Loading baking configuration file {}".format(config_file_path))
parser = BakingYamlConfParser(
yaml_text=ConfigParser.load_file(config_file_path),
clnt_mngr=client_manager,
provider_factory=provider_factory,
network_config=network_config,
node_url=args.node_endpoint,
api_base_url=args.api_base_url)
parser.parse()
parser.validate()
parser.process()
# dictionary to BakingConf object, for a bit of type safety
cfg_dict = parser.get_conf_obj()
cfg = BakingConf(cfg_dict)
except ConfigurationException as e:
logger.info(
"Unable to parse '{}' config file.".format(config_file_path))
logger.info(e)
sys.exit(1)
logger.info("Baking Configuration {}".format(cfg))
baking_address = cfg.get_baking_address()
payment_address = cfg.get_payment_address()
logger.info(LINER)
logger.info("BAKING ADDRESS is {}".format(baking_address))
logger.info("PAYMENT ADDRESS is {}".format(payment_address))
logger.info(LINER)
# 6- is it a reports run
dry_run = args.dry_run_no_consumers or args.dry_run
if args.dry_run_no_consumers:
global NB_CONSUMERS
NB_CONSUMERS = 0
# 7- get reporting directories
reports_base = os.path.expanduser(args.reports_base)
# if in reports run mode, do not create consumers
# create reports in reports directory
if dry_run:
reports_base = os.path.expanduser("./reports")
reports_dir = os.path.join(reports_base, baking_address)
payments_root = get_payment_root(reports_dir, create=True)
calculations_root = get_calculations_root(reports_dir, create=True)
get_successful_payments_dir(payments_root, create=True)
get_failed_payments_dir(payments_root, create=True)
# 8- start the life cycle
life_cycle.start(not dry_run)
# 9- service fee calculator
srvc_fee_calc = ServiceFeeCalculator(cfg.get_full_supporters_set(),
cfg.get_specials_map(),
cfg.get_service_fee())
if args.initial_cycle is None:
recent = get_latest_report_file(payments_root)
# if payment logs exists set initial cycle to following cycle
# if payment logs does not exists, set initial cycle to 0, so that payment starts from last released rewards
args.initial_cycle = 0 if recent is None else int(recent) + 1
logger.info("initial_cycle set to {}".format(args.initial_cycle))
# 10- load plugins
plugins_manager = plugins.PluginManager(cfg.get_plugins_conf(), dry_run)
# 11- Start producer and consumer
p = PaymentProducer(name='producer',
initial_payment_cycle=args.initial_cycle,
network_config=network_config,
payments_dir=payments_root,
calculations_dir=calculations_root,
run_mode=RunMode(args.run_mode),
service_fee_calc=srvc_fee_calc,
release_override=args.release_override,
payment_offset=args.payment_offset,
baking_cfg=cfg,
life_cycle=life_cycle,
payments_queue=payments_queue,
dry_run=dry_run,
client_manager=client_manager,
node_url=args.node_endpoint,
provider_factory=provider_factory,
node_url_public=args.node_addr_public,
api_base_url=args.api_base_url,
retry_injected=args.retry_injected)
p.start()
for i in range(NB_CONSUMERS):
c = PaymentConsumer(
name='consumer' + str(i),
payments_dir=payments_root,
key_name=payment_address,
payments_queue=payments_queue,
node_addr=args.node_endpoint,
client_manager=client_manager,
plugins_manager=plugins_manager,
rewards_type=cfg.get_rewards_type(),
args=args,
dry_run=dry_run,
reactivate_zeroed=cfg.get_reactivate_zeroed(),
delegator_pays_ra_fee=cfg.get_delegator_pays_ra_fee(),
delegator_pays_xfer_fee=cfg.get_delegator_pays_xfer_fee(),
dest_map=cfg.get_dest_map(),
network_config=network_config,
publish_stats=publish_stats)
sleep(1)
c.start()
logger.info("Application start completed")
logger.info(LINER)
# Run forever
try:
while life_cycle.is_running():
sleep(10)
except KeyboardInterrupt:
logger.info("Interrupted.")
life_cycle.stop()
def test_validate_no_founders_map(self):
data_no_founders = """
version: 1.0
baking_address: tz1g8vkmcde6sWKaG2NN9WKzCkDM6Rziq194
payment_address: tz1g8vkmcde6sWKaG2NN9WKzCkDM6Rziq194
owners_map: {'KT2Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj': 0.5,'KT3Z1tMai15JWUWeN2PKL9faXXVPMuWamzJj': 0.5}
supporters_set: None
service_fee: 4.5
reactivate_zeroed: False
delegator_pays_ra_fee: True
rewards_type:
plugins:
enabled:
"""
wallet_client_manager = ClientManager(self.mainnet_public_node_url,
self.signer_endpoint)
block_api = RpcBlockApiImpl(network, self.mainnet_public_node_url)
cnf_prsr = BakingYamlConfParser(
data_no_founders,
wallet_client_manager,
provider_factory=None,
network_config=network,
node_url=self.mainnet_public_node_url,
block_api=block_api,
)
cnf_prsr.parse()
cnf_prsr.validate()
self.assertEqual(
cnf_prsr.get_conf_obj_attr("baking_address"),
"tz1g8vkmcde6sWKaG2NN9WKzCkDM6Rziq194",
)
self.assertEqual(
cnf_prsr.get_conf_obj_attr("payment_address"),
"tz1g8vkmcde6sWKaG2NN9WKzCkDM6Rziq194",
)
self.assertEqual(
cnf_prsr.get_conf_obj_attr("__payment_address_pkh"),
"tz1g8vkmcde6sWKaG2NN9WKzCkDM6Rziq194",
)
self.assertEqual(
cnf_prsr.get_conf_obj_attr("__payment_address_manager"),
"tz1g8vkmcde6sWKaG2NN9WKzCkDM6Rziq194",
)
self.assertEqual(cnf_prsr.get_conf_obj_attr("__payment_address_type"),
AddrType.TZ)
self.assertEqual(cnf_prsr.get_conf_obj_attr("founders_map"), dict())
self.assertEqual(cnf_prsr.get_conf_obj_attr("specials_map"), dict())
self.assertEqual(cnf_prsr.get_conf_obj_attr("supporters_set"), set())
self.assertEqual(cnf_prsr.get_conf_obj_attr("min_delegation_amt"), 0)
self.assertEqual(cnf_prsr.get_conf_obj_attr("reactivate_zeroed"),
False)
self.assertEqual(cnf_prsr.get_conf_obj_attr("delegator_pays_ra_fee"),
True)
self.assertEqual(cnf_prsr.get_conf_obj_attr("rewards_type"),
RewardsType.ACTUAL)
plugins = cnf_prsr.get_conf_obj_attr("plugins")
self.assertIsInstance(plugins, dict)
self.assertIsNone(plugins["enabled"], None)