Skip to content

1. Getting started

Jump to bottom
Dmitry edited this page Nov 23, 2018 · 2 revisions

Table of Contents

Install

For working with EOSIO and ezeos you need to install:

  1. EOSIO
  2. EOSIO.CDT
  3. Required python modules.

1. EOSIO

Standalone EOSIO

Install EOSIO (v1.4.1) in the ~/eos directory by following the official repository instruction.

Docker EOSIO

For using docker container with EOSIO you have to have docker installed.

  1. If you don't already have docker, you can download it here.

  2. Setup a development diretory.

You're going to need to pick a directory to work from, it's suggested to create a contracts directory somewhere on your local drive.

mkdir /home/username/contracts
cd /home/username/contracts
  1. Get the latest or specific version docker image. The versions you can find here 
# To get the latest version (recommended)
docker pull eosio/eos

# To get the concrete version
docker pull eosio/eos:v1.4.2
  1. Boot container (The following command you are doing only once)
# Boot latest version container (recommended)
docker run --name eos \
  --publish 127.0.0.1:5555:5555 \
  --volume /home/username/contracts:/home/username/contracts \
  --detach \
  eosio/eos \
  /bin/bash -c "keosd --http-server-address=0.0.0.0:5555"

# Boot concrete version container
docker run --name eos \
  --publish 127.0.0.1:5555:5555 \
  --volume /home/username/contracts:/home/username/contracts \
  --detach \
  eosio/eos:v1.4.2 \
  /bin/bash -c "keosd --http-server-address=0.0.0.0:5555"

eos - The required name of the container.

--volume - Alias a work volume on your local drive to the docker container.

  1. Check the container
docker logs --tail 10 eos

You should see some output in the console that looks like this:

info 2018-11-16T18:20:00.189 thread-0  http_plugin.cpp:554  add_handler  ] add api url: /v1/wallet/list_keys
info 2018-11-16T18:20:00.189 thread-0  http_plugin.cpp:554  add_handler  ] add api url: /v1/wallet/list_wallets
info 2018-11-16T18:20:00.189 thread-0  http_plugin.cpp:554  add_handler  ] add api url: /v1/wallet/lock
info 2018-11-16T18:20:00.189 thread-0  http_plugin.cpp:554  add_handler  ] add api url: /v1/wallet/lock_all
info 2018-11-16T18:20:00.189 thread-0  http_plugin.cpp:554  add_handler  ] add api url: /v1/wallet/open
info 2018-11-16T18:20:00.189 thread-0  http_plugin.cpp:554  add_handler  ] add api url: /v1/wallet/remove_key
info 2018-11-16T18:20:00.189 thread-0  http_plugin.cpp:554  add_handler  ] add api url: /v1/wallet/set_timeout
info 2018-11-16T18:20:00.189 thread-0  http_plugin.cpp:554  add_handler  ] add api url: /v1/wallet/sign_digest
info 2018-11-16T18:20:00.189 thread-0  http_plugin.cpp:554  add_handler  ] add api url: /v1/wallet/sign_transaction
info 2018-11-16T18:20:00.189 thread-0  http_plugin.cpp:554  add_handler  ] add api url: /v1/wallet/unlock
  1. Start/Stop your container
docker start eos
docker stop eos
  1. Open the container shell
docker exec -it eos bash

To exit cast exit

  1. Aliases

You don't want to enter into the Docker container's bash every time you need to interact with Cleos, Nodeos or Keosd. A solution to this is to create an aliases.

Add the following lines to your .bashrc or .zshrc or .profile

alias cleos='docker exec -it eos /opt/eosio/bin/cleos
alias nodeos='docker exec -it eos /opt/eosio/bin/nodeos
alias keosd='docker exec -it eos /opt/eosio/bin/keosd

2. EOSIO.CDT

For working with contracts you need to install Contract Development Toolkit. Follow the official installation guide for EOSIO.CDT

3. Required python modules

For using ezeos you nneed to install:

  1. Python 3
  2. pip3 install pillow
  3. pip3 install ttkthemes

Usage

At the root of this project: Run:

python3 ezeos.py

Next step

2. Architecture

Clone this wiki locally