quicksort

README

Overview

This is a simple smartcontract example. The contract itself is designed in solidity.

A client application designed in golang deploy a contract in a ethereum compatible blockchain network (Ganache, test net or GoQuorum). An easy way to test is installing Ganache (mentioned below).

Next, use the local golang client to deploy the contract and run the workload.

Requirements

Ethereum compatible blockchain network

Local development is easier with Ganache. Install it, then use the quickstart button to create the local testing network.

Once you have Ganache (or another ethereum blockchain) working, make sure to get

1. the connection url (http or ws)
2. private key.

Using Ganache, you can easliy get this information from interface by right clicking in one of the generated accounts.

Golang

Make sure you have Go installed. Installing go is beyond the scope of this document. An easy way to install it is using ASDF with Go plugin. Other plugins are available here. We used go version 1.16.7.

You will also need go ethereum source (go-ethereum) and tools (abigen) required to build our client application.

go get -u github.com/ethereum/go-ethereum@v1.10.9

After downloading the code to gopath, you are required to build the tools: find where the source is installed:

go env GOPATH

Access the directory to build the source. (the location below can be slightly different for you)

cd $(go env GOPATH)/pkg/mod/github.com/ethereum/go-ethereum@v1.10.9
make
make devtools

Note: if you find a compilation error, that's likelly permission denied, simply create a bin dir inside build dir.:

mkdir -p $(go env GOPATH)/pkg/mod/github.com/ethereum/go-ethereum@v1.10.9/build/bin

also try to set permissions to it

sudo chmod -R u+rw $(go env GOPATH)/pkg/mod/github.com/ethereum/go-ethereum@v1.10.9 

If it fails (happened in osx big sur), open the path with finder and set permissions using GUI.

After that, the abigen command must be available.

Build the blockchain client

Assuming the steps of Requeriments section was complete, you can create the client by running the build script.

bash buildstubs.sh

Important: Listening to events

You can connect to the endpoints with http and ws sockets. However, tracking events are only supported via websockets.

Deploy the smartcontract

You can connect to the endpoints with http and ws sockets. However, tracking events are only supported via websockets (for that, just replace http with ws and set the correct port).

Since Ganache run locally, you can replace the IP for 127.0.0.1. For Quorum, replace the IP with the corresponding one for the actual server node.

It returns a contract address (use it for printing the counter at the end)

./quicksort deploy --url "http://192.168.10.166:22000" --key "1be3b50b31734be48452c29d714941ba165ef0cbf3ccea8ca16c45e3d8d45fb0"

should output:

INFO[0000] Connecting to ethereum network...
Nonce: 0
Gas price: 20000000000
Transaction address: 0x843ef8f573414ae4631cf63ff95a05be90bd10f57c3b300abd5adcd854fae077
Contract address 0x24C4fbcd6fa5360Cd1AEA2CeD9F1D7a0cdbc1897
Contract deployed

Connecting to Quorum using http:

./quicksort deploy --url "http://192.168.10.166:22000" --key "1be3b50b31734be48452c29d714941ba165ef0cbf3ccea8ca16c45e3d8d45fb0"

Connecting to Quorum using ws (note that the port changes for Quorum)

./quicksort deploy --url "ws://192.168.10.166:23000" --key "1be3b50b31734be48452c29d714941ba165ef0cbf3ccea8ca16c45e3d8d45fb0"

Connecting to Ganache:

Use the same port, only change it to ws to listen to events.

./quicksort deploy --url "ws://localhost:7575" --key "1be3b50b31734be48452c29d714941ba165ef0cbf3ccea8ca16c45e3d8d45fb0"

Run workload

There are three types of workload: deploy, sort, mixed. You can choose the workload using -o.

The deploy workload will issue operations to install contract. Ensure the wallet has enough budget as deplying is one of most expensive operations.

For the sort workload installs one contract and run sort commands. You can tune the size of the array using -s to increase the usage of the CPU/cost of computation. The default size is 100.

The mixed worload altearnates between sorting an array and installing a new contract.

Workloads can be configured to run a certain number of operations -c or duration -d.

./quicksort workload -o sort -c 1000  --url "ws://192.168.10.166:23000" --key "1be3b50b31734be48452c29d714941ba165ef0cbf3ccea8ca16c45e3d8d45fb0"

Contract cost:

Pay attention to the computation cost. If the execution fails, one common source of problems is insufficient budget.

• deploy 510465 gas
• sort 10 elements 116244 gas
• sort 100 elements: 407497 gas
• sort 1000 elements: 3566945 gas
• sort 1500 elements: 6000003 gas, above 1500 elements block gas limit was exceeded in ganache (can be configured)
• sort 2000 elements: 7649148 gas (takes a few seconds)

Documentation

Overview

Copyright © 2021 NAME HERE <EMAIL ADDRESS>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.