core-lightning/tests/plugins/openchannel_hook_accepter.py
Rusty Russell 36a2491a89 json: fix up msat amounts in non-_msat fields.
We had json_add_amount_msat_only(), which was designed to be used to
print out msat fields, if we had sats.

However, we misused it, so split it into the three different cases:
1. json_add_amount_sat_msat: We are using it correctly, with a field called
   xxx_msat.
2. json_add_amount_sats_deprecated: We were using it wrong, so deprecate
   the old field and create a new one which does end in _msat.
3. json_add_sats: we were using it to hand sats as a JSON parameter to an
   interface, where "XXXsat".

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
Changelog-Deprecated: Plugins: `rbf_channel` and `openchannel2` hooks `their_funding` (use `their_funding_msat`)
Changelog-Deprecated: Plugins: `openchannel2` hook `dust_limit_satoshis` (use `dust_limit_msat`)
Changelog-Deprecated: Plugins: `openchannel` hook `funding_satoshis` (use `funding_msat`)
Changelog-Deprecated: Plugins: `openchannel` hook `dust_limit_satoshis` (use `dust_limit_msat`)
Changelog-Deprecated: Plugins: `openchannel` hook `channel_reserve_satoshis` (use `channel_reserve_msat`)
Changelog-Deprecated: Plugins: `channel_opened` notification `amount` (use `funding_msat`)
Changelog-Deprecated: JSON-RPC: `listtransactions` `msat` (use `amount_msat`)
Changelog-Deprecated: Plugins: `htlc_accepted` `forward_amount` (use `forward_msat`)
2022-06-21 06:52:35 +09:30

65 lines
2.1 KiB
Python
Executable File

#!/usr/bin/env python3
"""Simple plugin to test the openchannel_hook's
'close_to' address functionality.
If the funding amount is:
- 100005sat: we reject correctly w/o close_to
- 100004sat: we reject invalid by setting a close_to
- 100003sat: we send back a valid address (regtest)
- 100002sat: we send back an empty address
- 100001sat: we send back an address for the wrong chain (mainnet)
- otherwise: we don't include the close_to
"""
from pyln.client import Plugin, Millisatoshi
plugin = Plugin()
def run_openchannel(funding_sats_str, plugin):
# Convert from string to satoshis
funding_sats = Millisatoshi(funding_sats_str).to_satoshi()
# - 100005sat: we reject correctly w/o close_to
if funding_sats == 100005:
msg = "reject for a reason"
plugin.log(msg)
return {'result': 'reject', 'error_message': msg}
# - 100004sat: we reject invalid by setting a close_to
if funding_sats == 100004:
msg = "I am a broken plugin"
plugin.log(msg)
return {'result': 'reject', 'error_message': msg,
'close_to': "bcrt1q7gtnxmlaly9vklvmfj06amfdef3rtnrdazdsvw"}
# - 100003sat: we send back a valid address (regtest)
if funding_sats == 100003:
return {'result': 'continue', 'close_to': 'bcrt1q7gtnxmlaly9vklvmfj06amfdef3rtnrdazdsvw'}
# - 100002sat: we send back an empty address
if funding_sats == 100002:
return {'result': 'continue', 'close_to': ''}
# - 100001sat: we send back an address for the wrong chain (mainnet)
if funding_sats == 100001:
return {'result': 'continue', 'close_to': 'bc1qlq8srqnz64wgklmqvurv7qnr4rvtq2u96hhfg2'}
# - otherwise: accept and don't include the close_to
plugin.log("accept by design")
return {'result': 'continue'}
@plugin.hook('openchannel')
def on_openchannel(openchannel, plugin, **kwargs):
return run_openchannel(openchannel['funding_msat'], plugin)
@plugin.hook('openchannel2')
def on_openchannel2(openchannel2, plugin, **kwargs):
""" Support for v2 channel opens """
return run_openchannel(openchannel2['their_funding_msat'], plugin)
plugin.run()