Source code for microraiden.client.client

import logging
from typing import List, Optional

import os
from eth_utils import decode_hex, is_same_address, is_hex, remove_0x_prefix, to_checksum_address
from web3 import Web3
from web3.providers.rpc import HTTPProvider

from microraiden.utils import (

from microraiden.config import NETWORK_CFG
from microraiden.constants import WEB3_PROVIDER_DEFAULT
from microraiden.client.context import Context
from import Channel

log = logging.getLogger(__name__)

[docs]class Client:
[docs] def __init__( self, private_key: str = None, key_password_path: str = None, channel_manager_address: str = None, web3: Web3 = None ) -> None: """ Args: private_key: key_password_path: channel_manager_address: web3: """ is_hex_key = is_hex(private_key) and len(remove_0x_prefix(private_key)) == 64 is_path = os.path.exists(private_key) assert is_hex_key or is_path, 'Private key must either be a hex key or a file path.' # Load private key from file if none is specified on command line. if is_path: private_key = get_private_key(private_key, key_password_path) assert private_key is not None, 'Could not load private key from file.' self.channels = [] # type: List[Channel] # Create web3 context if none is provided, either by using the proxies' context or creating # a new one. if not web3: web3 = Web3(HTTPProvider(WEB3_PROVIDER_DEFAULT)) channel_manager_address = to_checksum_address( channel_manager_address or NETWORK_CFG.CHANNEL_MANAGER_ADDRESS ) self.context = Context(private_key, web3, channel_manager_address) self.sync_channels()
[docs] def sync_channels(self): """ Merges locally available channel information, including their current balance signatures, with channel information available on the blockchain to make up for local data loss. Naturally, balance signatures cannot be recovered from the blockchain. """ filters = {'_sender_address': self.context.address} create = get_logs( self.context.channel_manager, 'ChannelCreated', argument_filters=filters ) topup = get_logs( self.context.channel_manager, 'ChannelToppedUp', argument_filters=filters ) close = get_logs( self.context.channel_manager, 'ChannelCloseRequested', argument_filters=filters ) settle = get_logs( self.context.channel_manager, 'ChannelSettled', argument_filters=filters ) channel_key_to_channel = {} def get_channel(event) -> Channel: sender = to_checksum_address(event['args']['_sender_address']) receiver = to_checksum_address(event['args']['_receiver_address']) block = event['args'].get('_open_block_number', event['blockNumber']) assert is_same_address(sender, self.context.address) return channel_key_to_channel.get((sender, receiver, block), None) for c in self.channels: channel_key_to_channel[(c.sender, c.receiver, c.block)] = c for e in create: c = get_channel(e) if c: c.deposit = e['args']['_deposit'] else: c = Channel( self.context, to_checksum_address(e['args']['_sender_address']), to_checksum_address(e['args']['_receiver_address']), e['blockNumber'], e['args']['_deposit'], on_settle=lambda channel: self.channels.remove(channel) ) assert is_same_address(c.sender, self.context.address) channel_key_to_channel[(c.sender, c.receiver, c.block)] = c for e in topup: c = get_channel(e) c.deposit += e['args']['_added_deposit'] for e in close: # Requested closed, not actual closed. c = get_channel(e) c.update_balance(e['args']['_balance']) c.state = Channel.State.settling for e in settle: c = get_channel(e) c.state = Channel.State.closed # Forget closed channels. self.channels = [ c for c in channel_key_to_channel.values() if c.state != Channel.State.closed ] log.debug('Synced a total of {} channels.'.format(len(self.channels)))
[docs] def open_channel(self, receiver_address: str, deposit: int) -> Optional[Channel]: """Open a channel with a receiver and deposit Attempts to open a new channel to the receiver with the given deposit. Blocks until the creation transaction is found in a pending block or timeout is reached. Args: receiver_address: the partner with whom the channel should be opened deposit: the initial deposit for the channel (Should be > 0) Returns: The opened channel, if successful. Otherwise `None` """ assert isinstance(receiver_address, str) assert isinstance(deposit, int) assert deposit > 0 token_balance = if token_balance < deposit: log.error( 'Insufficient tokens available for the specified deposit ({}/{})' .format(token_balance, deposit) ) return None current_block = self.context.web3.eth.blockNumber'Creating channel to {} with an initial deposit of {} @{}'.format( receiver_address, deposit, current_block )) data = decode_hex(self.context.address) + decode_hex(receiver_address) tx = create_signed_contract_transaction( self.context.private_key, self.context.token, 'transfer', [ self.context.channel_manager.address, deposit, data ] ) self.context.web3.eth.sendRawTransaction(tx) log.debug('Waiting for channel creation event on the blockchain...') filters = { '_sender_address': self.context.address, '_receiver_address': receiver_address } event = get_event_blocking( self.context.channel_manager, 'ChannelCreated', from_block=current_block + 1, to_block='latest', argument_filters=filters ) if event: log.debug('Event received. Channel created in block {}.'.format(event['blockNumber'])) assert is_same_address(event['args']['_sender_address'], self.context.address) assert is_same_address(event['args']['_receiver_address'], receiver_address) channel = Channel( self.context, self.context.address, receiver_address, event['blockNumber'], event['args']['_deposit'], on_settle=lambda c: self.channels.remove(c) ) self.channels.append(channel) else: log.error('Error: No event received.') channel = None return channel
[docs] def get_open_channels(self, receiver: str = None) -> List[Channel]: """ Returns all open channels to the given receiver. If no receiver is specified, all open channels are returned. """ return [ c for c in self.channels if is_same_address(c.sender, self.context.address) and (not receiver or is_same_address(c.receiver, receiver)) and c.state == ]
[docs] def get_suitable_channel( self, receiver, value, initial_deposit=lambda x: x, topup_deposit=lambda x: x ) -> Channel: """ Searches stored channels for one that can sustain the given transfer value. If none is found, a possibly open channel is topped up using the topup callable to determine its topup value. If both attempts fail, a new channel is created based on the initial deposit callable. Note: In the realistic case that only one channel is opened per (sender,receiver) pair, this method usually performs like this: 1. Directly return open channel if sufficiently funded. 2. Topup existing open channel if insufficiently funded. 3. Create new channel if no open channel exists. If topping up or creating fails, this method returns None. Channels are topped up just enough so that their remaining capacity equals topup_deposit(value). """ open_channels = self.get_open_channels(receiver) suitable_channels = [c for c in open_channels if c.is_suitable(value)] if suitable_channels: # At least one channel with sufficient funds. if len(suitable_channels) > 1: # This is not impossible but should only happen after bad channel management. log.warning( 'Warning: {} suitable channels found. ' 'Choosing the one with the lowest remaining capacity.' .format(len(suitable_channels)) ) capacity, channel = min( ((c.deposit - c.balance, c) for c in suitable_channels), key=lambda x: x[0] ) log.debug( 'Found suitable open channel, opened at block #{}.'.format(channel.block) ) return channel elif open_channels: # Open channel(s) but insufficient funds. Requires topup. if len(open_channels) > 1: # This is not impossible but should only happen after bad channel management. log.warning( 'Warning: {} open channels for topup found. ' 'Choosing the one with the highest remaining capacity.' .format(len(open_channels)) ) capacity, channel = max( ((c.deposit - c.balance, c) for c in open_channels), key=lambda x: x[0] ) deposit = max(value, topup_deposit(value)) - capacity event = channel.topup(deposit) return channel if event else None else: # No open channels to receiver. Create a new one. deposit = max(value, initial_deposit(value)) return self.open_channel(receiver, deposit)