def test_channel_unlock_with_a_large_expiration(
web3,
custom_token,
token_network,
secret_registry_contract,
create_channel,
channel_deposit,
get_accounts,
close_and_update_channel,
):
(A, B) = get_accounts(2)
settle_timeout = 8
values_A = ChannelValues(
deposit=20,
transferred=5,
locked=0,
locksroot=EMPTY_MERKLE_ROOT,
)
values_B = ChannelValues(
deposit=30,
transferred=40,
)
# Create channel and deposit
create_channel(A, B, settle_timeout)[0]
channel_deposit(A, values_A.deposit, B)
channel_deposit(B, values_B.deposit, A)
# Mock pending transfers data with large expiration date
pending_transfers_tree = get_pending_transfers_tree(web3, [1, 3, 5], [2, 4],
settle_timeout + 100)
locksroot_bytes = get_merkle_root(pending_transfers_tree.merkle_tree)
values_B.locksroot = '0x' + locksroot_bytes.hex()
values_B.locked = get_locked_amount(pending_transfers_tree.transfers)
# Reveal secrets before settlement window ends
for lock in pending_transfers_tree.unlockable:
secret_registry_contract.functions.registerSecret(lock[3]).transact({'from': A})
assert secret_registry_contract.functions.getSecretRevealBlockHeight(
lock[2],
).call() == web3.eth.blockNumber
close_and_update_channel(
A,
values_A,
B,
values_B,
)
# Settle channel after a "long" time
web3.testing.mine(settle_timeout + 50)
call_settle(token_network, A, values_A, B, values_B)
pre_balance_A = custom_token.functions.balanceOf(A).call()
pre_balance_B = custom_token.functions.balanceOf(B).call()
pre_balance_contract = custom_token.functions.balanceOf(token_network.address).call()
# Unlock the tokens must still work
token_network.functions.unlock(
A,
B,
pending_transfers_tree.packed_transfers,
).transact()
balance_A = custom_token.functions.balanceOf(A).call()
balance_B = custom_token.functions.balanceOf(B).call()
balance_contract = custom_token.functions.balanceOf(token_network.address).call()
assert balance_A == pre_balance_A + 9
assert balance_B == pre_balance_B + 6
assert balance_contract == pre_balance_contract - values_B.locked
def test_channel_unlock_before_settlement_fails(
web3,
custom_token,
token_network,
secret_registry_contract,
create_channel,
channel_deposit,
get_accounts,
close_and_update_channel,
):
(A, B) = get_accounts(2)
settle_timeout = 8
values_A = ChannelValues(
deposit=20,
transferred=5,
locked=0,
locksroot=EMPTY_MERKLE_ROOT,
)
values_B = ChannelValues(
deposit=30,
transferred=40,
)
# Create channel and deposit
create_channel(A, B, settle_timeout)[0]
channel_deposit(A, values_A.deposit, B)
channel_deposit(B, values_B.deposit, A)
# Mock pending transfers data
pending_transfers_tree = get_pending_transfers_tree(web3, [1, 3, 5], [2, 4], settle_timeout)
locksroot_bytes = get_merkle_root(pending_transfers_tree.merkle_tree)
values_B.locksroot = '0x' + locksroot_bytes.hex()
values_B.locked = get_locked_amount(pending_transfers_tree.transfers)
# Reveal secrets before settlement window ends
for lock in pending_transfers_tree.unlockable:
secret_registry_contract.functions.registerSecret(lock[3]).transact({'from': A})
assert secret_registry_contract.functions.getSecretRevealBlockHeight(
lock[2],
).call() == web3.eth.blockNumber
close_and_update_channel(
A,
values_A,
B,
values_B,
)
# Unlock fails before settlement window is over and channel is not settled
with pytest.raises(TransactionFailed):
token_network.functions.unlock(
A,
B,
pending_transfers_tree.packed_transfers,
).transact()
# Settlement window must be over before settling the channel
web3.testing.mine(settle_timeout)
# Unlock fails before settle is called
with pytest.raises(TransactionFailed):
token_network.functions.unlock(
A,
B,
pending_transfers_tree.packed_transfers,
).transact()
# settle channel
call_settle(token_network, A, values_A, B, values_B)
pre_balance_A = custom_token.functions.balanceOf(A).call()
pre_balance_B = custom_token.functions.balanceOf(B).call()
pre_balance_contract = custom_token.functions.balanceOf(token_network.address).call()
# Unlock works after channel is settled
token_network.functions.unlock(
A,
B,
pending_transfers_tree.packed_transfers,
).transact()
balance_A = custom_token.functions.balanceOf(A).call()
balance_B = custom_token.functions.balanceOf(B).call()
balance_contract = custom_token.functions.balanceOf(token_network.address).call()
assert balance_A == pre_balance_A + 9
assert balance_B == pre_balance_B + 6
assert balance_contract == pre_balance_contract - values_B.locked
def test_channel_unlock_both_participants(
web3,
custom_token,
token_network,
secret_registry_contract,
create_channel,
channel_deposit,
get_accounts,
close_and_update_channel,
reveal_secrets,
):
(A, B) = get_accounts(2)
settle_timeout = 8
values_A = ChannelValues(
deposit=100,
transferred=5,
)
values_B = ChannelValues(
deposit=100,
transferred=40,
)
# Create channel and deposit
create_channel(A, B, settle_timeout)[0]
channel_deposit(A, values_A.deposit, B)
channel_deposit(B, values_B.deposit, A)
# Mock pending transfers data for A
pending_transfers_tree_A = get_pending_transfers_tree(web3, [1, 3, 5], [2, 4], settle_timeout)
locksroot_bytes = get_merkle_root(pending_transfers_tree_A.merkle_tree)
values_B.locksroot = '0x' + locksroot_bytes.hex()
values_B.locked = get_locked_amount(pending_transfers_tree_A.transfers)
# Reveal A's secrets before settlement window ends
reveal_secrets(A, pending_transfers_tree_A.unlockable)
# Mock pending transfers data for B
pending_transfers_tree_B = get_pending_transfers_tree(web3, [2, 4, 6], [5, 10], settle_timeout)
locksroot_bytes = get_merkle_root(pending_transfers_tree_B.merkle_tree)
values_A.locksroot = '0x' + locksroot_bytes.hex()
values_A.locked = get_locked_amount(pending_transfers_tree_B.transfers)
# Reveal B's secrets before settlement window ends
for lock in pending_transfers_tree_B.unlockable:
secret_registry_contract.functions.registerSecret(lock[3]).transact({'from': B})
assert secret_registry_contract.functions.getSecretRevealBlockHeight(
lock[2],
).call() == web3.eth.blockNumber
close_and_update_channel(
A,
values_A,
B,
values_B,
)
# Settle channel
web3.testing.mine(settle_timeout)
call_settle(token_network, A, values_A, B, values_B)
pre_balance_A = custom_token.functions.balanceOf(A).call()
pre_balance_B = custom_token.functions.balanceOf(B).call()
pre_balance_contract = custom_token.functions.balanceOf(token_network.address).call()
# A unlock's
token_network.functions.unlock(
A,
B,
pending_transfers_tree_A.packed_transfers,
).transact()
# B unlock's
token_network.functions.unlock(
B,
A,
pending_transfers_tree_B.packed_transfers,
).transact()
balance_A = custom_token.functions.balanceOf(A).call()
balance_B = custom_token.functions.balanceOf(B).call()
balance_contract = custom_token.functions.balanceOf(token_network.address).call()
unlockable_A = get_unlocked_amount(
secret_registry_contract,
pending_transfers_tree_A.packed_transfers,
)
expired_A = get_locked_amount(pending_transfers_tree_A.expired)
unlockable_B = get_unlocked_amount(
secret_registry_contract,
pending_transfers_tree_B.packed_transfers,
)
expired_B = get_locked_amount(pending_transfers_tree_B.expired)
# check that A and B both received the expected amounts
assert balance_contract == pre_balance_contract - values_B.locked - values_A.locked
assert balance_A == pre_balance_A + unlockable_A + expired_B
assert balance_B == pre_balance_B + unlockable_B + expired_A
def test_channel_unlock_expired_lock_refunds(
web3,
custom_token,
token_network,
secret_registry_contract,
create_channel,
channel_deposit,
get_accounts,
close_and_update_channel,
):
(A, B) = get_accounts(2)
max_lock_expiration = 3
settle_timeout = 8
values_A = ChannelValues(
deposit=20,
transferred=5,
locked=0,
locksroot=EMPTY_MERKLE_ROOT,
)
values_B = ChannelValues(
deposit=30,
transferred=40,
)
# Create channel and deposit
create_channel(A, B, settle_timeout)[0]
channel_deposit(A, values_A.deposit, B)
channel_deposit(B, values_B.deposit, A)
# Mock pending transfers data
pending_transfers_tree = get_pending_transfers_tree(
web3,
[1, 3, 5],
[2, 4],
min_expiration_delta=max_lock_expiration - 2,
max_expiration_delta=max_lock_expiration,
)
locksroot_bytes = get_merkle_root(pending_transfers_tree.merkle_tree)
values_B.locksroot = '0x' + locksroot_bytes.hex()
values_B.locked = get_locked_amount(pending_transfers_tree.transfers)
# Locks expire
web3.testing.mine(max_lock_expiration)
# Secrets are revealed before settlement window, but after expiration
for lock in pending_transfers_tree.unlockable:
secret_registry_contract.functions.registerSecret(lock[3]).transact({'from': A})
assert secret_registry_contract.functions.getSecretRevealBlockHeight(
lock[2],
).call() == web3.eth.blockNumber
close_and_update_channel(
A,
values_A,
B,
values_B,
)
web3.testing.mine(settle_timeout)
# settle channel
call_settle(token_network, A, values_A, B, values_B)
pre_balance_A = custom_token.functions.balanceOf(A).call()
pre_balance_B = custom_token.functions.balanceOf(B).call()
pre_balance_contract = custom_token.functions.balanceOf(token_network.address).call()
# Unlock works after channel is settled
token_network.functions.unlock(
A,
B,
pending_transfers_tree.packed_transfers,
).transact()
balance_A = custom_token.functions.balanceOf(A).call()
balance_B = custom_token.functions.balanceOf(B).call()
balance_contract = custom_token.functions.balanceOf(token_network.address).call()
# check that all tokens have been refunded, as locks have expired already
assert balance_A == pre_balance_A
assert balance_B == pre_balance_B + values_B.locked
assert balance_contract == pre_balance_contract - values_B.locked
def test_unlock_channel_event(
web3,
token_network,
secret_registry_contract,
create_channel,
channel_deposit,
get_accounts,
close_and_update_channel,
event_handler,
):
(A, B) = get_accounts(2)
settle_timeout = 8
values_A = ChannelValues(
deposit=20,
transferred=5,
locked=0,
locksroot=EMPTY_MERKLE_ROOT,
)
values_B = ChannelValues(
deposit=30,
transferred=40,
)
# Create channel and deposit
channel_identifier = create_channel(A, B, settle_timeout)[0]
channel_deposit(A, values_A.deposit, B)
channel_deposit(B, values_B.deposit, A)
# Mock pending transfers data
pending_transfers_tree = get_pending_transfers_tree(web3, [1, 3, 5], [2, 4],
settle_timeout + 100)
locksroot_bytes = get_merkle_root(pending_transfers_tree.merkle_tree)
values_B.locksroot = '0x' + locksroot_bytes.hex()
values_B.locked = get_locked_amount(pending_transfers_tree.transfers)
# Reveal secrets before settlement window ends
for lock in pending_transfers_tree.unlockable:
secret_registry_contract.functions.registerSecret(lock[3]).transact({'from': A})
assert secret_registry_contract.functions.getSecretRevealBlockHeight(
lock[2],
).call() == web3.eth.blockNumber
close_and_update_channel(
A,
values_A,
B,
values_B,
)
# Settlement window must be over before settling the channel
web3.testing.mine(settle_timeout)
call_settle(token_network, A, values_A, B, values_B)
ev_handler = event_handler(token_network)
# Unlock the tokens
txn_hash = token_network.functions.unlock(
A,
B,
pending_transfers_tree.packed_transfers,
).transact()
unlocked_amount = get_unlocked_amount(
secret_registry_contract,
pending_transfers_tree.packed_transfers,
)
# Add event
ev_handler.add(txn_hash, EVENT_CHANNEL_UNLOCKED, check_channel_unlocked(
channel_identifier,
A,
unlocked_amount,
values_B.locked - unlocked_amount,
))
# Check that event was properly emitted
ev_handler.check()
def test_channel_cycle(
web3,
token_network,
create_channel,
channel_deposit,
secret_registry_contract,
get_accounts,
print_gas,
create_balance_proof,
create_balance_proof_update_signature,
):
(A, B) = get_accounts(2)
settle_timeout = 11
(channel_identifier, txn_hash) = create_channel(A, B, settle_timeout)
print_gas(txn_hash, CONTRACT_TOKEN_NETWORK + '.openChannel')
txn_hash = channel_deposit(channel_identifier, A, 20, B)
txn_hash = channel_deposit(channel_identifier, B, 10, A)
print_gas(txn_hash, CONTRACT_TOKEN_NETWORK + '.setTotalDeposit')
pending_transfers_tree1 = get_pending_transfers_tree(web3, [1, 1, 2, 3], [2, 1])
locksroot1 = get_merkle_root(pending_transfers_tree1.merkle_tree)
locked_amount1 = get_locked_amount(pending_transfers_tree1.transfers)
pending_transfers_tree2 = get_pending_transfers_tree(web3, [3], [], 7)
locksroot2 = get_merkle_root(pending_transfers_tree2.merkle_tree)
locked_amount2 = get_locked_amount(pending_transfers_tree2.transfers)
balance_proof_A = create_balance_proof(
channel_identifier,
A,
10,
locked_amount1,
5,
locksroot1,
)
balance_proof_B = create_balance_proof(
channel_identifier,
B,
5,
locked_amount2,
3,
locksroot2,
)
balance_proof_update_signature_B = create_balance_proof_update_signature(
B,
channel_identifier,
*balance_proof_A,
)
for lock in pending_transfers_tree1.unlockable:
txn_hash = secret_registry_contract.functions.registerSecret(lock[3]).transact({'from': A})
for lock in pending_transfers_tree2.unlockable:
txn_hash = secret_registry_contract.functions.registerSecret(lock[3]).transact({'from': A})
print_gas(txn_hash, CONTRACT_SECRET_REGISTRY + '.registerSecret')
txn_hash = token_network.functions.closeChannel(
channel_identifier,
B,
*balance_proof_B,
).transact({'from': A})
print_gas(txn_hash, CONTRACT_TOKEN_NETWORK + '.closeChannel')
txn_hash = token_network.functions.updateNonClosingBalanceProof(
channel_identifier,
A,
B,
*balance_proof_A,
balance_proof_update_signature_B,
).transact({'from': B})
print_gas(txn_hash, CONTRACT_TOKEN_NETWORK + '.updateNonClosingBalanceProof')
web3.testing.mine(settle_timeout)
txn_hash = token_network.functions.settleChannel(
channel_identifier,
B,
5,
locked_amount2,
locksroot2,
A,
10,
locked_amount1,
locksroot1,
).transact()
print_gas(txn_hash, CONTRACT_TOKEN_NETWORK + '.settleChannel')
txn_hash = token_network.functions.unlock(
channel_identifier,
A,
B,
pending_transfers_tree2.packed_transfers,
).transact()
print_gas(txn_hash, '{0}.unlock {1} locks'.format(
CONTRACT_TOKEN_NETWORK,
len(pending_transfers_tree2.transfers),
))
txn_hash = token_network.functions.unlock(
channel_identifier,
B,
A,
pending_transfers_tree1.packed_transfers,
).transact()
print_gas(txn_hash, '{0}.unlock {1} locks'.format(
CONTRACT_TOKEN_NETWORK,
len(pending_transfers_tree1.transfers),
))
def test_channel_unlock(web3, custom_token, token_network,
secret_registry_contract, create_channel,
channel_deposit, get_accounts, create_balance_proof,
create_balance_proof_update_signature, event_handler):
(A, B) = get_accounts(2)
settle_timeout = 8
deposit_A = 20
deposit_B = 30
additional_hash = fake_hex(32, '02')
locksroot1 = fake_hex(32, '00')
locked_amount1 = 0
# Create channel and deposit
channel_identifier = create_channel(A, B, settle_timeout)[0]
channel_deposit(A, deposit_A, B)
channel_deposit(B, deposit_B, A)
# Mock pending transfers data
pending_transfers_tree = get_pending_transfers_tree(
web3, [1, 3, 5], [2, 4], settle_timeout)
locksroot_bytes = get_merkle_root(pending_transfers_tree.merkle_tree)
locksroot2 = '0x' + locksroot_bytes.hex()
locked_amount2 = get_locked_amount(pending_transfers_tree.transfers)
# Create balance proofs
balance_proof_A = create_balance_proof(channel_identifier, A, 10,
locked_amount1, 5, locksroot1,
additional_hash)
balance_proof_B = create_balance_proof(channel_identifier, B, 5,
locked_amount2, 3, locksroot2,
additional_hash)
balance_proof_update_signature_B = create_balance_proof_update_signature(
B, channel_identifier, *balance_proof_A)
# Reveal secrets before settlement window ends
for lock in pending_transfers_tree.unlockable:
secret_registry_contract.functions.registerSecret(lock[3]).transact(
{'from': A})
assert secret_registry_contract.functions.getSecretRevealBlockHeight(
lock[2]).call() == web3.eth.blockNumber
# Close channel and update balance proofs
token_network.functions.closeChannel(B, *balance_proof_B).transact(
{'from': A})
token_network.functions.updateNonClosingBalanceProof(
A, B, *balance_proof_A,
balance_proof_update_signature_B).transact({'from': B})
# Settlement window must be over before settling the channel
web3.testing.mine(settle_timeout)
# Settle the channel
token_network.functions.settleChannel(A, 10, locked_amount1, locksroot1, B,
5, locked_amount2,
locksroot2).transact({'from': A})
pre_balance_A = custom_token.functions.balanceOf(A).call()
pre_balance_B = custom_token.functions.balanceOf(B).call()
pre_balance_contract = custom_token.functions.balanceOf(
token_network.address).call()
# TODO to be moved to a separate test
ev_handler = event_handler(token_network)
# Unlock the tokens
txn_hash = token_network.functions.unlock(
A, B, pending_transfers_tree.packed_transfers).transact()
unlocked_amount = get_unlocked_amount(
secret_registry_contract, pending_transfers_tree.packed_transfers)
balance_A = custom_token.functions.balanceOf(A).call()
balance_B = custom_token.functions.balanceOf(B).call()
balance_contract = custom_token.functions.balanceOf(
token_network.address).call()
assert balance_A == pre_balance_A + 9
assert balance_B == pre_balance_B + 6
assert balance_contract == pre_balance_contract - locked_amount2
# TODO to be moved to a separate test
ev_handler.add(
txn_hash, EVENT_CHANNEL_UNLOCKED,
check_channel_unlocked(channel_identifier, A, unlocked_amount,
locked_amount2 - unlocked_amount))
ev_handler.check()
def print_gas_channel_cycle(
web3,
token_network,
create_channel,
channel_deposit,
withdraw_channel,
secret_registry_contract,
get_accounts,
print_gas,
create_balance_proof,
create_balance_proof_update_signature,
):
""" Abusing pytest to print gas costs of TokenNetwork's operations """
(A, B, C, D) = get_accounts(4)
settle_timeout = 11
(channel_identifier, txn_hash) = create_channel(A, B, settle_timeout)
print_gas(txn_hash, CONTRACT_TOKEN_NETWORK + ".openChannel")
(_, txn_hash) = create_channel(C, D, settle_timeout)
print_gas(txn_hash, CONTRACT_TOKEN_NETWORK + ".openChannel")
txn_hash = channel_deposit(channel_identifier, A, 20, B)
print_gas(txn_hash, CONTRACT_TOKEN_NETWORK + ".setTotalDeposit")
txn_hash = channel_deposit(channel_identifier, B, 10, A)
print_gas(txn_hash, CONTRACT_TOKEN_NETWORK + ".setTotalDeposit")
txn_hash = withdraw_channel(channel_identifier, A, 5, B)
print_gas(txn_hash, CONTRACT_TOKEN_NETWORK + ".setTotalWithdraw")
pending_transfers_tree1 = get_pending_transfers_tree(
web3, [1, 1, 2, 3], [2, 1])
locksroot1 = get_merkle_root(pending_transfers_tree1.merkle_tree)
locked_amount1 = get_locked_amount(pending_transfers_tree1.transfers)
pending_transfers_tree2 = get_pending_transfers_tree(web3, [3], [], 7)
locksroot2 = get_merkle_root(pending_transfers_tree2.merkle_tree)
locked_amount2 = get_locked_amount(pending_transfers_tree2.transfers)
balance_proof_A = create_balance_proof(channel_identifier, A, 10,
locked_amount1, 5, locksroot1)
balance_proof_B = create_balance_proof(channel_identifier, B, 5,
locked_amount2, 3, locksroot2)
balance_proof_update_signature_B = create_balance_proof_update_signature(
B, channel_identifier, *balance_proof_A)
for lock in pending_transfers_tree1.unlockable:
txn_hash = secret_registry_contract.functions.registerSecret(
lock[3]).call_and_transact({"from": A})
print_gas(txn_hash, CONTRACT_SECRET_REGISTRY + ".registerSecret")
for lock in pending_transfers_tree2.unlockable:
txn_hash = secret_registry_contract.functions.registerSecret(
lock[3]).call_and_transact({"from": A})
print_gas(txn_hash, CONTRACT_SECRET_REGISTRY + ".registerSecret")
txn_hash = token_network.functions.closeChannel(
channel_identifier, B, *balance_proof_B).call_and_transact({"from": A})
print_gas(txn_hash, CONTRACT_TOKEN_NETWORK + ".closeChannel")
txn_hash = token_network.functions.updateNonClosingBalanceProof(
channel_identifier, A, B, *balance_proof_A,
balance_proof_update_signature_B).call_and_transact({"from": B})
print_gas(txn_hash,
CONTRACT_TOKEN_NETWORK + ".updateNonClosingBalanceProof")
web3.testing.mine(settle_timeout)
txn_hash = token_network.functions.settleChannel(
channel_identifier, B, 5, locked_amount2, locksroot2, A, 10,
locked_amount1, locksroot1).call_and_transact()
print_gas(txn_hash, CONTRACT_TOKEN_NETWORK + ".settleChannel")
txn_hash = token_network.functions.unlock(
channel_identifier, A, B,
pending_transfers_tree2.packed_transfers).call_and_transact()
print_gas(
txn_hash,
"{0}.unlock {1} locks".format(CONTRACT_TOKEN_NETWORK,
len(pending_transfers_tree2.transfers)),
)
txn_hash = token_network.functions.unlock(
channel_identifier, B, A,
pending_transfers_tree1.packed_transfers).call_and_transact()
print_gas(
txn_hash,
"{0}.unlock {1} locks".format(CONTRACT_TOKEN_NETWORK,
len(pending_transfers_tree1.transfers)),
)