aljaz/plugins
1
0
Fork 0
mirror of https://github.com/aljazceru/plugins.git synced 2025-12-24 08:34:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

rebalance: docstring nits

Browse Source
This commit is contained in:
Michael Schmoock
2021-06-15 09:33:02 +02:00
parent fb9f4688df
commit b51633889a
1 changed files with 10 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
rebalance/rebalance.py
View File

@@ -134,6 +134,9 @@ class NoRouteException(Exception):
def getroute_basic(plugin: Plugin, targetid, fromid, excludes, msatoshi: Millisatoshi):
try:
""" This does not make special assumptions and tries all routes
it gets. Uses less CPU and does not filter any routes.
"""
return plugin.rpc.getroute(targetid,
fromid=fromid,
exclude=excludes,
@@ -148,6 +151,10 @@ def getroute_basic(plugin: Plugin, targetid, fromid, excludes, msatoshi: Millisa
def getroute_iterative(plugin: Plugin, targetid, fromid, excludes, msatoshi: Millisatoshi):
""" This searches for 'shorter and bigger pipes' first in order
to increase likelyhood of success on short timeout.
Can be useful for manual `rebalance`.
"""
try:
return plugin.rpc.getroute(targetid,
fromid=fromid,
@@ -682,10 +689,9 @@ def init(options, configuration, plugin):
plugin.add_option(
"rebalance-getroute",
"iterative",
"Getroute method for route search"
"Can be 'basic' or 'iterative'"
"'basic': Tries all routes sequentially."
"'iterative': Tries shorter and bigger routes first."
"Getroute method for route search can be 'basic' or 'iterative'."
"'basic': Tries all routes sequentially. "
"'iterative': Tries shorter and bigger routes first.",
"string"
)
plugin.add_option(