Perun Ethereum Demo CLI

perun-eth-demo allows you to interact with perun Payment-Channels over a CLI powered by go-perun. You can open a Payment-Channel, send off-chain payments and close it, whereby all interaction with the Ethereum blockchain is handled by go-perun. Give it a try and be amazed by Perun Network 🚀 🌔 !

Security Disclaimer

The authors take no responsibility for any loss of digital assets or other damage caused by the use of this software. Do not use this software with real funds.

Getting Started

Running perun-eth-demo requires a working Go distribution, see go.mod for the required version. To follow the walkthrough we recommend to also install ganache-cli, but perun-eth-demo works with any ethereum node.

# Clone the repository into a directory of your choice
git clone https://github.com/perun-network/perun-eth-demo
cd perun-eth-demo
# Compile with
go build
# Check that the binary works
./perun-eth-demo

Smart Contract Compilation

Install the solidity compiler:

sudo npm i -g solc@0.7.6

To compile the smart contracts and generate the go bindings, run:

solcjs FL.sol --abi --base-path ./ -o abi --bin --optimize
abigen --pkg FLApp --abi abi/FL_sol_FLApp.abi --bin abi/FL_sol_FLApp.bin --out ./generated/FLApp/FLApp.go

Demo

Currently, the only available sub-command of perun-eth-demo is demo, which starts the CLI node. The node's configuration file can be chosen with the --config flag. Two sample configurations alice.yaml and bob.yaml are provided. A default network configuration for Alice and Bob is provided in file network.yaml.

Example Walkthrough

In a first terminal, start a ganache-cli development blockchain, prefunding the accounts of Alice and Bob derived from the mnemonic seed:

ganache-cli -m "pistol kiwi shrug future ozone ostrich match remove crucial oblige cream critic" --block-time 5 -e 1000

In a second terminal, start the node of Alice with

./perun-eth-demo demo --config alice.yaml

and in a third terminal, start the node of Bob with

./perun-eth-demo demo --config bob.yaml

It is important to start Alice first as she is the one deploying the channel contracts. Bob validates the contracts at startup and quits if the contracts have not been deployed correctly. You can see two transactions in the ganache terminal corresponding to the deployment of the AssetHolder and Adjudicator contracts.

Once both CLIs are running, e.g. in Alice's terminal, propose a payment channel to Bob with 100 ETH deposit from both sides via the following command.

> open bob 100 100

In Alice's terminal, accept the appearing channel proposal.

🔁 Incoming channel proposal from alice with funding [My: 100 Ξ, Peer: 100 Ξ].
Accept (y/n)? > y

In the ganache terminal, you can see two new transactions, which correspond to the funding transactions by Alice and Bob.

Now you can execute off-chain payments, e.g. in Bob's terminal with

> send alice 10

The updated balance will immediately be printed in both terminals, but no transaction will be visible in the ganache's terminal.

You may always check the current status with command info.

You can also run a performance benchmark with command

> benchmark alice 10 100

which will send 10 ETH in 100 micro-transactions from Bob to Alice. Transaction performance will be printed in a table.

Finally, you can settle the channel on either side with

> close alice

which will send one concludeFinal and two withdrawal transactions to the ganache blockchain.

Now you can exit the CLI with command exit.

Copyright

Copyright © 2021 Chair of Applied Cryptography, Technische Universität Darmstadt, Germany. All rights reserved. Use of the source code is governed by the Apache 2.0 license that can be found in the LICENSE file.

Contact us at info@perun.network.