Use LockedAmount type for locked_amounts

karlb · karlb · commit 5b796794c815 · 2020-01-28T14:43:21.000+01:00
diff --git a/raiden/messages/transfers.py b/raiden/messages/transfers.py
@@ -29,6 +29,7 @@
     ChannelID,
     ClassVar,
     InitiatorAddress,
+    LockedAmount,
     Locksroot,
     Nonce,
     PaymentAmount,
@@ -47,7 +48,7 @@ def assert_envelope_values(
     nonce: int,
     channel_identifier: ChannelID,
     transferred_amount: TokenAmount,
-    locked_amount: TokenAmount,
+    locked_amount: LockedAmount,
     locksroot: Locksroot,
 ) -> None:
     if nonce <= 0:
@@ -163,7 +164,7 @@ class EnvelopeMessage(SignedRetrieableMessage):
     chain_id: ChainID
     nonce: Nonce
     transferred_amount: TokenAmount
-    locked_amount: TokenAmount
+    locked_amount: LockedAmount
     locksroot: Locksroot
     channel_identifier: ChannelID
     token_network_address: TokenNetworkAddress
diff --git a/raiden/network/proxies/payment_channel.py b/raiden/network/proxies/payment_channel.py
@@ -11,6 +11,7 @@
     BlockSpecification,
     BlockTimeout,
     ChannelID,
+    LockedAmount,
     Locksroot,
     Nonce,
     Signature,
@@ -216,10 +217,10 @@ def unlock(
     def settle(
         self,
         transferred_amount: TokenAmount,
-        locked_amount: TokenAmount,
+        locked_amount: LockedAmount,
         locksroot: Locksroot,
         partner_transferred_amount: TokenAmount,
-        partner_locked_amount: TokenAmount,
+        partner_locked_amount: LockedAmount,
         partner_locksroot: Locksroot,
         block_identifier: BlockSpecification,
     ) -> None:
diff --git a/raiden/network/proxies/token_network.py b/raiden/network/proxies/token_network.py
@@ -58,6 +58,7 @@
     ChainID,
     ChannelID,
     Dict,
+    LockedAmount,
     Locksroot,
     NamedTuple,
     Nonce,
@@ -112,7 +113,7 @@ class ParticipantDetails(NamedTuple):
     balance_hash: BalanceHash
     nonce: Nonce
     locksroot: Locksroot
-    locked_amount: TokenAmount
+    locked_amount: LockedAmount
 
 
 class ParticipantsDetails(NamedTuple):
@@ -2319,11 +2320,11 @@ def settle(
         self,
         channel_identifier: ChannelID,
         transferred_amount: TokenAmount,
-        locked_amount: TokenAmount,
+        locked_amount: LockedAmount,
         locksroot: Locksroot,
         partner: Address,
         partner_transferred_amount: TokenAmount,
-        partner_locked_amount: TokenAmount,
+        partner_locked_amount: LockedAmount,
         partner_locksroot: Locksroot,
         given_block_identifier: BlockSpecification,
     ) -> None:
@@ -2430,11 +2431,11 @@ def _settle(
         self,
         channel_identifier: ChannelID,
         transferred_amount: TokenAmount,
-        locked_amount: TokenAmount,
+        locked_amount: LockedAmount,
         locksroot: Locksroot,
         partner: Address,
         partner_transferred_amount: TokenAmount,
-        partner_locked_amount: TokenAmount,
+        partner_locked_amount: LockedAmount,
         partner_locksroot: Locksroot,
         log_details: Dict[Any, Any],
     ) -> None:
diff --git a/raiden/tests/integration/network/proxies/__init__.py b/raiden/tests/integration/network/proxies/__init__.py
@@ -2,7 +2,14 @@
 
 from raiden.constants import LOCKSROOT_OF_NO_LOCKS, UINT256_MAX
 from raiden.transfer.utils import hash_balance_data
-from raiden.utils.typing import BalanceHash, ChannelID, Locksroot, TokenAmount, TokenNetworkAddress
+from raiden.utils.typing import (
+    BalanceHash,
+    ChannelID,
+    LockedAmount,
+    Locksroot,
+    TokenAmount,
+    TokenNetworkAddress,
+)
 from raiden_contracts.constants import MessageTypeId
 
 LOCKSROOT_OF_NO_LOCKS_AS_STRING = encode_hex(LOCKSROOT_OF_NO_LOCKS)
@@ -28,7 +35,7 @@ def __init__(
         chain_id: int = 1,
         signature: str = None,
         transferred_amount: TokenAmount = None,
-        locked_amount: TokenAmount = TokenAmount(0),  # noqa
+        locked_amount: LockedAmount = LockedAmount(0),  # noqa
         locksroot: Locksroot = LOCKSROOT_OF_NO_LOCKS,
     ):
         self.channel_identifier = channel_identifier
@@ -80,6 +87,6 @@ def balance_hash(self, value) -> None:
 
     @staticmethod
     def hash_balance_data(
-        transferred_amount: TokenAmount, locked_amount: TokenAmount, locksroot: Locksroot
+        transferred_amount: TokenAmount, locked_amount: LockedAmount, locksroot: Locksroot
     ) -> BalanceHash:
         return hash_balance_data(transferred_amount, locked_amount, locksroot)
diff --git a/raiden/tests/integration/network/proxies/test_payment_channel.py b/raiden/tests/integration/network/proxies/test_payment_channel.py
@@ -1,5 +1,4 @@
 import pytest
-from eth_utils import encode_hex
 from web3 import Web3
 
 from raiden.blockchain.events import get_all_netting_channel_events
@@ -23,7 +22,15 @@
 from raiden.transfer.identifiers import CanonicalIdentifier
 from raiden.utils.keys import privatekey_to_address
 from raiden.utils.signer import LocalSigner
-from raiden.utils.typing import BlockNumber, ChainID, List, Nonce, PrivateKey, TokenAmount
+from raiden.utils.typing import (
+    BlockNumber,
+    ChainID,
+    List,
+    LockedAmount,
+    Nonce,
+    PrivateKey,
+    TokenAmount,
+)
 from raiden_contracts.constants import TEST_SETTLE_TIMEOUT_MIN, MessageTypeId
 from raiden_contracts.contract_manager import ContractManager
 
@@ -93,10 +100,10 @@ def test_payment_channel_proxy_basics(
     empty_balance_proof = BalanceProof(
         channel_identifier=channel_proxy_1.channel_identifier,
         token_network_address=token_network_address,
-        balance_hash=encode_hex(EMPTY_BALANCE_HASH),
+        balance_hash=EMPTY_BALANCE_HASH,
         nonce=0,
         chain_id=chain_id,
-        transferred_amount=0,
+        transferred_amount=TokenAmount(0),
     )
     closing_data = (
         empty_balance_proof.serialize_bin(msg_type=MessageTypeId.BALANCE_PROOF) + EMPTY_SIGNATURE
@@ -133,10 +140,10 @@ def test_payment_channel_proxy_basics(
 
     channel_proxy_1.settle(
         transferred_amount=TokenAmount(0),
-        locked_amount=TokenAmount(0),
+        locked_amount=LockedAmount(0),
         locksroot=LOCKSROOT_OF_NO_LOCKS,
         partner_transferred_amount=TokenAmount(0),
-        partner_locked_amount=TokenAmount(0),
+        partner_locked_amount=LockedAmount(0),
         partner_locksroot=LOCKSROOT_OF_NO_LOCKS,
         block_identifier="latest",
     )
diff --git a/raiden/tests/integration/test_balance_proof_check.py b/raiden/tests/integration/test_balance_proof_check.py
@@ -1,5 +1,4 @@
 import pytest
-from eth_utils import encode_hex
 
 from raiden import waiting
 from raiden.api.python import RaidenAPI
@@ -12,7 +11,7 @@
 from raiden.tests.utils.transfer import get_channelstate, transfer
 from raiden.transfer import views
 from raiden.transfer.state_change import ContractReceiveChannelSettled
-from raiden.utils.typing import Nonce, PaymentAmount, PaymentID, TokenNetworkAddress
+from raiden.utils.typing import Nonce, PaymentAmount, PaymentID, TokenAmount, TokenNetworkAddress
 from raiden_contracts.constants import MessageTypeId
 
 
@@ -64,10 +63,10 @@ def test_node_can_settle_if_close_didnt_use_any_balance_proof(
     empty_balance_proof = BalanceProof(
         channel_identifier=channel_identifier,
         token_network_address=TokenNetworkAddress(token_network_contract.address),
-        balance_hash=encode_hex(EMPTY_BALANCE_HASH),
+        balance_hash=EMPTY_BALANCE_HASH,
         nonce=Nonce(0),
         chain_id=chain_state.chain_id,
-        transferred_amount=0,
+        transferred_amount=TokenAmount(0),
     )
     closing_data = (
         empty_balance_proof.serialize_bin(msg_type=MessageTypeId.BALANCE_PROOF) + EMPTY_SIGNATURE
diff --git a/raiden/tests/integration/test_regression.py b/raiden/tests/integration/test_regression.py
@@ -26,6 +26,7 @@
     BlockExpiration,
     InitiatorAddress,
     List,
+    LockedAmount,
     Locksroot,
     Nonce,
     PaymentAmount,
@@ -176,7 +177,7 @@ def test_regression_multiple_revealsecret(
         token=token,
         channel_identifier=channelstate_0_1.identifier,
         transferred_amount=transferred_amount,
-        locked_amount=TokenAmount(lock_amount),
+        locked_amount=LockedAmount(lock_amount),
         recipient=app1.raiden.address,
         locksroot=Locksroot(lock.lockhash),
         lock=lock,
@@ -204,7 +205,7 @@ def test_regression_multiple_revealsecret(
         token_network_address=token_network_address,
         channel_identifier=channelstate_0_1.identifier,
         transferred_amount=TokenAmount(lock_amount),
-        locked_amount=TokenAmount(0),
+        locked_amount=LockedAmount(0),
         locksroot=LOCKSROOT_OF_NO_LOCKS,
         secret=secret,
         signature=EMPTY_SIGNATURE,
diff --git a/raiden/tests/integration/transfer/test_mediatedtransfer_invalid.py b/raiden/tests/integration/transfer/test_mediatedtransfer_invalid.py
@@ -27,6 +27,7 @@
 from raiden.utils.signer import LocalSigner
 from raiden.utils.typing import (
     InitiatorAddress,
+    LockedAmount,
     Nonce,
     PaymentAmount,
     PaymentID,
@@ -114,7 +115,7 @@ def test_receive_lockedtransfer_invalidnonce(
         token=token_address,
         channel_identifier=channel0.identifier,
         transferred_amount=TokenAmount(amount),
-        locked_amount=TokenAmount(amount),
+        locked_amount=LockedAmount(amount),
         recipient=app1.raiden.address,
         locksroot=make_locksroot(),
         lock=Lock(
@@ -158,7 +159,7 @@ def test_receive_lockedtransfer_invalidsender(
     )
     assert token_network_address
     channel0 = get_channelstate(app0, app1, token_network_address)
-    lock_amount = TokenAmount(10)
+    lock_amount = LockedAmount(10)
     expiration = reveal_timeout * 2
     mediated_transfer_message = LockedTransfer(
         chain_id=UNIT_CHAIN_ID,
@@ -204,7 +205,7 @@ def test_receive_lockedtransfer_invalidrecipient(
 
     payment_identifier = PaymentID(1)
     invalid_recipient = make_address()
-    lock_amount = TokenAmount(10)
+    lock_amount = LockedAmount(10)
     expiration = reveal_timeout * 2
     mediated_transfer_message = LockedTransfer(
         chain_id=UNIT_CHAIN_ID,
@@ -257,7 +258,7 @@ def test_received_lockedtransfer_closedchannel(
     )
 
     # Now receive one mediated transfer for the closed channel
-    lock_amount = TokenAmount(10)
+    lock_amount = LockedAmount(10)
     payment_identifier = PaymentID(1)
     expiration = reveal_timeout * 2
     mediated_transfer_message = LockedTransfer(
diff --git a/raiden/tests/integration/transfer/test_refund_invalid.py b/raiden/tests/integration/transfer/test_refund_invalid.py
@@ -15,7 +15,14 @@
 from raiden.tests.utils.transfer import sign_and_inject
 from raiden.transfer import views
 from raiden.utils.signer import LocalSigner
-from raiden.utils.typing import Locksroot, Nonce, PaymentAmount, PaymentID, TokenAmount
+from raiden.utils.typing import (
+    LockedAmount,
+    Locksroot,
+    Nonce,
+    PaymentAmount,
+    PaymentID,
+    TokenAmount,
+)
 
 
 @raise_on_failure
@@ -61,7 +68,7 @@ def test_receive_secrethashtransfer_unknown(raiden_network, token_addresses):
         channel_identifier=canonical_identifier.channel_identifier,
         token_network_address=token_network_address,
         transferred_amount=amount,
-        locked_amount=TokenAmount(0),
+        locked_amount=LockedAmount(0),
         locksroot=locksroot,
         secret=UNIT_SECRET,
         signature=EMPTY_SIGNATURE,
diff --git a/raiden/tests/unit/test_raiden_event_handler.py b/raiden/tests/unit/test_raiden_event_handler.py
@@ -28,6 +28,7 @@
     Address,
     ChannelID,
     List,
+    LockedAmount,
     Nonce,
     Optional,
     PaymentAmount,
@@ -70,7 +71,7 @@ def test_handle_contract_send_channelunlock_already_unlocked():
 
     def detail_participants(_participant1, _participant2, _block_identifier, _channel_identifier):
         transferred_amount = TokenAmount(1)
-        locked_amount = TokenAmount(1)
+        locked_amount = LockedAmount(1)
         locksroot = make_locksroot()
         balance_hash = hash_balance_data(transferred_amount, locked_amount, locksroot)
         our_details = ParticipantDetails(
@@ -85,7 +86,7 @@ def detail_participants(_participant1, _participant2, _block_identifier, _channe
         )
 
         transferred_amount = TokenAmount(1)
-        locked_amount = TokenAmount(1)
+        locked_amount = LockedAmount(1)
         # Let's mock here that partner locksroot is 0x0
         balance_hash = hash_balance_data(transferred_amount, locked_amount, locksroot)
         partner_details = ParticipantDetails(
diff --git a/raiden/tests/utils/transfer.py b/raiden/tests/utils/transfer.py
@@ -975,7 +975,7 @@ def make_receive_transfer_mediated(
         token=channel_state.token_address,
         channel_identifier=channel_state.identifier,
         transferred_amount=transferred_amount,
-        locked_amount=TokenAmount(locked_amount),
+        locked_amount=LockedAmount(locked_amount),
         recipient=channel_state.partner_state.address,
         locksroot=locksroot,
         lock=Lock(amount=lock.amount, expiration=lock.expiration, secrethash=lock.secrethash),
@@ -1031,7 +1031,7 @@ def make_receive_expired_lock(
         nonce=nonce,
         message_identifier=make_message_identifier(),
         transferred_amount=transferred_amount,
-        locked_amount=TokenAmount(locked_amount),
+        locked_amount=LockedAmount(locked_amount),
         locksroot=locksroot,
         channel_identifier=channel_state.identifier,
         token_network_address=channel_state.token_network_address,
diff --git a/raiden/transfer/architecture.py b/raiden/transfer/architecture.py
@@ -23,6 +23,7 @@
     ChannelID,
     Generic,
     List,
+    LockedAmount,
     Locksroot,
     MessageID,
     Nonce,
@@ -32,6 +33,7 @@
     T_BlockHash,
     T_BlockNumber,
     T_Keccak256,
+    T_LockedAmount,
     T_Signature,
     T_TokenAmount,
     TokenAmount,
@@ -298,7 +300,7 @@ class BalanceProofUnsignedState(State):
 
     nonce: Nonce
     transferred_amount: TokenAmount
-    locked_amount: TokenAmount
+    locked_amount: LockedAmount
     locksroot: Locksroot
     canonical_identifier: CanonicalIdentifier
     balance_hash: BalanceHash = field(default=EMPTY_BALANCE_HASH)
@@ -353,7 +355,7 @@ class BalanceProofSignedState(State):
 
     nonce: Nonce
     transferred_amount: TokenAmount
-    locked_amount: TokenAmount
+    locked_amount: LockedAmount
     locksroot: Locksroot
     message_hash: AdditionalHash
     signature: Signature
@@ -364,7 +366,7 @@ class BalanceProofSignedState(State):
     def __post_init__(self) -> None:
         typecheck(self.nonce, int)
         typecheck(self.transferred_amount, T_TokenAmount)
-        typecheck(self.locked_amount, T_TokenAmount)
+        typecheck(self.locked_amount, T_LockedAmount)
         typecheck(self.locksroot, T_Keccak256)
         typecheck(self.message_hash, T_Keccak256)
         typecheck(self.signature, T_Signature)
diff --git a/raiden/transfer/channel.py b/raiden/transfer/channel.py
diff --git a/raiden/transfer/utils.py b/raiden/transfer/utils.py
diff --git a/tools/gas_cost_measures.py b/tools/gas_cost_measures.py
