Skip to content

Commit 597dcba

Browse files
committed
add descriptions to modules
1 parent c651f6e commit 597dcba

File tree

6 files changed

+13
-0
lines changed

6 files changed

+13
-0
lines changed

modules/controller.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010

1111
class ControllerModule(MtcModule):
1212

13+
description = 'Liquid staking controllers.'
14+
1315
def do_create_controllers(self):
1416
new_controllers = self.ton.GetControllers()
1517
old_controllers = self.ton.local.db.get("using_controllers", list())

modules/module.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
class MtcModule(ABC):
66

7+
description = ''
8+
79
def __init__(self, ton, local, *args, **kwargs):
810
self.ton: MyTonCore = ton
911
self.local = local

modules/nominator_pool.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77

88
class NominatorPoolModule(PoolModule):
99

10+
description = 'Standard nominator pools.'
11+
1012
def do_create_pool(self, pool_name, validator_reward_share_percent, max_nominators_count, min_validator_stake,
1113
min_nominator_stake):
1214
self.ton.local.add_log("start CreatePool function", "debug")

modules/pool.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
class PoolModule(MtcModule):
88

9+
description = 'Basic pools functions.'
10+
911
def print_pools_list(self, args):
1012
table = list()
1113
table += [["Name", "Status", "Balance", "Version", "Address"]]

modules/single_pool.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88

99
class SingleNominatorModule(PoolModule):
1010

11+
description = 'Orbs\'s single nominator pools.'
12+
1113
def do_create_single_pool(self, pool_name, owner_address):
1214
self.ton.local.add_log("start create_single_pool function", "debug")
1315

modules/validator.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66

77
class ValidatorModule(MtcModule):
88

9+
description = ('Validator functions. Activates participating in elections and staking. '
10+
'If pools and l/s modes are disabled stakes from validator wallet.')
11+
912
def vote_offer(self, args):
1013
if len(args) == 0:
1114
color_print("{red}Bad args. Usage:{endc} vo <offer-hash>")

0 commit comments

Comments
 (0)