Bolt8 transport for electrum protocol #8049
Conversation
- prepare for use in ElectrumX: - use create_server and create_connection - subclass aiorpcx.RSTransport - use random, non-persisted privkey
| connector = self.network.proxy or self.network.asyncio_loop | ||
| protocol_factory = partial(LNTransport, LNSession, self.node_keypair.privkey, peer_addr=peer_addr) | ||
| asyncio_transport, protocol = await connector.create_connection(protocol_factory, peer_addr.host, peer_addr.port) |
There was a problem hiding this comment.
self.network.proxy is an Optional[dict]. it does not have .create_connection.
Something like this might work:
from .util import MySocksProxy
proxy = MySocksProxy.from_proxy_dict(self.network.proxy) if self.network.proxy else None
connector = proxy or self.network.asyncio_loop| connector = self.proxy or self.loop | ||
| protocol_factory = partial(LNTransport, LNSession, privkey, peer_addr=peer_addr) | ||
| asyncio_transport, protocol = await connector.create_connection(protocol_factory, peer_addr.host, peer_addr.port) | ||
| await protocol.handshake_done.wait() | ||
| peer = Peer(self, node_id, transport=client._protocol, is_channel_backup=True) |
There was a problem hiding this comment.
self.proxy, self.loop, and client are all undefined
| await protocol.handshake_done.wait() | ||
| return self.session | ||
|
|
||
| async def __aexit__(self, exc_type, exc_value, traceback): await self.session.close() |
There was a problem hiding this comment.
so much whitespace
we should set the linter to be more strict as it did not complain
| async def read_data(self, len): | ||
| await self._data_received.wait() | ||
| chunk = self._data[0:len] | ||
| self._data = self._data[len:] |
There was a problem hiding this comment.
del self._data[:offset] # much faster than: buffer=buffer[offset:](though atm this method is only used during the handshake, so it's not that performance critical, but better to be consistent imo)
| @@ -327,6 +327,14 @@ async def setconfig(self, key, value): | |||
| self.config.set_key(key, value) | |||
| return True | |||
|
|
|||
| @command('') | |||
| async def create_key_for_server(self, server_pubkey:str) -> str: | |||
There was a problem hiding this comment.
I find this name confusing. Both the client and the server ultimately has keypair(s). So which one is create_key_for_server creating a keypair for?
How about create_userkey_for_server?
| @@ -327,6 +327,14 @@ async def setconfig(self, key, value): | |||
| self.config.set_key(key, value) | |||
| return True | |||
|
|
|||
| @command('') | |||
| async def create_key_for_server(self, server_pubkey:str) -> str: | |||
| " returns a pubkey to add to electrumx, using the 'add_user' RPC" | |||
There was a problem hiding this comment.
Should we add import/export functionality? I guess it would be easier and cleaner not to, but tell users instead to generate new keys instead. Maybe this could be mentioned in the docstring.
However, in time I expect users will ask for it. E.g. consider operating a server for your friends: generating a new key requires user-interaction/cooperation. Anyway, I guess it's easier to ignore this for now.
This is a draft work on bolt8 transport.
There are two branches, one for the server, and this one for the client.
How to run a server:
PUBLIC=1 BOLT8_KEYFILE=~/electrumx.b8 COST_SOFT_LIMIT=0 COST_HARD_LIMIT=0 COIN=BitcoinSegwit SERVICES=bolt8://:51003,rpc:// NET=regtest DAEMON_URL=http://doggman:donkey@127.0.0.1:18554 DB_DIRECTORY=$HOME/electrumx_db ./electrumx_serverHow to run a client:
$alice -s localhost:51003:b:02c51c2a0105d64e5d05fc36e638e77e3d213346e5dd960d263e9fc35af3bbb6ddThe public key of the server is visible in the log:
INFO:SessionManager:bolt8 pubkey 02c51c2a0105d64e5d05fc36e638e77e3d213346e5dd960d263e9fc35af3bbb6ddTwo environment variables are added to electrumx: PUBLIC and WATCHTOWER
They cannot be set at the same time.
If you do not set PUBLIC, the client needs to be whitelisted using electrumx_rpc:
./electrumx_rpc add_user 020f1a5ba32fa3ed098cd0538de5753681f4193c0dd8331415e226c8b8a2220d87