Zeus Getting Started¶

Overview¶

Zeus-cmd is an extensible command line tool. SDK extensions come packaged in “boxes” and are served through IPFS. Zeus is currently in alpha. As a note, all Zeus commands must be run within the root directory of the package that was unboxed.

Features:¶

Smart contract templating with a single command
Install nodeos, keosd, cleos, and eosio.cdt with a single command
Simulate a blockchain node with a single command
Test, compile, and deploy smart contracts
Easily migrate a contract to a different EOSIO chain such as the Kylin and Jungle testnets or the mainnet
Design fluid dApp frontends
Cross-platform (Windows, OS X, Linux)
Easily install necessary libraries with a package manager
Truffle-like interface
Manage development lifecycle with version control
Open source (BSD License)
And more…

Gitpod Zeus-IDE ¶

If you want to be up and running with Zeus quickly, you can use our cloud based Zeus-IDE, all you need is a Github account! Try it here!

dapp-client library ¶

The dapp-client library makes it easier to interact with the DAPP Network’s core smart contracts and services, read more here.

Hardware Requirements¶

16GB RAM
2 CPU Cores

Prerequisites¶

node version 10.16.3 is recommended (nvm recommended, install at bottom of doc)
curl
cmake
make

Use node version manager to install node¶

curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.34.0/install.sh | bash
# use install instructions provided to set PATH
nvm install 10.16.3
nvm use 10.16.3

Recommended eosio.cdt and eosio versions¶

Automatically installed with zeus unbox helloworld

Install Zeus¶

npm install -g @liquidapps/zeus-cmd

Update¶

npm update -g @liquidapps/zeus-cmd

Test¶

zeus unbox helloworld
cd helloworld
zeus test

Create your own contract¶

This box supports all DAPP Services and unit tests and is built to integrate your own DAPP Network logic. When you run the command a sample unit test and smart contract will be created.

mkdir mydapp; cd mydapp
zeus unbox dapp --no-create-dir
zeus create contract mycontract

Try out LiquidApps’s take on Elemental Battles:¶

http://elemental.liquidapps.io/ | code

The game incorporates:

vRAM - light-weight caching solution for EOSIO based RAM
LiquidAccounts - EOSIO accounts that live in vRAM instead of RAM
LiquidDNS - DNS service on the blockchain | contract table
Frontend stored on IPFS
user data is stored in the vRAM dapp::multi_index table (vRAM) | code
keys stored in dapp::multi_index table | code
keys created using the account name and password as seed phrases | code
eosjs-ecc’s seedPrivate method is used to create the keypair | code
logic to create LiquidAccount transactions | code

To launch locally:

zeus unbox cardgame
cd cardgame
zeus migrate
zeus run frontend main

Try out vCPU with our LiquidChess game:¶

https://chess.liquidapps.io/ | code

The game incorporates:

vRAM - light-weight caching solution for EOSIO based RAM
LiquidAccounts - EOSIO accounts that live in vRAM instead of RAM
LiquidDNS - DNS service on the blockchain
vCPU - a solution to scale blockchain processing power horizontally

To launch locally:

zeus unbox chess
cd chess
zeus migrate
zeus run frontend main

Try out LiquidPortfolio¶

LiquidPortfolio is a portfolio tracking tool for BTC, ETH (and tokens), and EOS (and tokens). The tool displays the total current value of the portfolio while also encrypting all user account info with the LiquidAccount’s private key.

The game incorporates:

vRAM - light-weight caching solution for EOSIO based RAM
LiquidAccounts - EOSIO accounts that live in vRAM instead of RAM
LiquidHarmony - oracle service for fetching prices
LiquidDNS - DNS service on the blockchain
Encryption/Decryption locally of account data using LiquidAccount private key

To launch locally:

zeus unbox portfolio
cd portfolio
zeus migrate
zeus run frontend main

Samples Boxes¶

zeus unbox <INSERT_BOX>

vRAM Boxes¶

coldtoken - vRAM based eosio.token
deepfreeze - vRAM based cold storage contract
vgrab - vRAM based airgrab for eosio.token
registry - vRAM based item registration

Zeus Extension Boxes¶

contract-migrations-extensions - contract create/deployment command template, deploy contract and allocate DAPP tokens
test-extensions - provides logic to test smart contract with unit tests
eos-extensions - install eos/eosio.cdt, launch local nodeos, launch system contracts
unbox-extensions - logic to unbox zeus boxes, list all boxes, and deploy a new box
demux - install EOSIO’s demux backend to capture events for contracts using the state-history plugin

DAPP Services Boxes¶

The DAPP Service boxes allow you to isolate the service that you wish to work with. If you instead would like to use all of the DAPP Services, you may unbox the all-dapp-services box.

ipfs-dapp-service - utilize the dapp::multi_index table to store data in IPFS (vRAM) instead of RAM
cron-dapp-service - schedule CRON tasks on-chain
oracle-dapp-service - provide oracle services
readfn-dapp-service - read a contract function without the need to submit a trx to the chain
vaccounts-dapp-service - EOSIO accounts that live in vRAM instead of RAM
vcpu-dapp-service - scale blockchain processing power horizontally

Miscellaneous Boxes¶

microauctions - twin reverse dutch auctions used in DAPP’s generation event
eos-detective-reports - EOS Detective Reports - by EOSNation - https://eosdetective.io/
helloworld - Hello World
token - Standard eosio.token
airhodl - First ever Air-HODL

Zeus Options¶

please note: zeus commands are directory sensitive, all commands should be performed in root of box

Zeus compile¶

Compile a smart contract. You can either compile all of the contracts within the contracts directory with zeus compile or a specific contract by name, such as zeus compile dappservices

zeus compile <CONTRACT_NAME>

# optional flags:

--all # compile all contracts
# default: true
--chain # chain to work on
# default: eos

Zeus migrate¶

Compile and migrate a smart contract to another network such as the Kylin Testnet, Jungle Testnet, or Mainnet.

Be sure to run the following commands from inside the directory you unboxed, e.g., if you unboxed coldtoken, be in /coldtoken. Also be sure to set the network in the import and migrate commands so Zeus knows what chain the keys / contract is operating on (mainnet, kylin, or jungle).

# keys are stored in ~/.zeus/networks/<NETWORK>/accounts/
zeus key import <CONTRACT_ACCOUNT_NAME> --owner-private-key <KEY> --active-private-key <KEY> --network=kylin
# contract deployment files are stored in ~/<BOX>/models/contract-deployments
zeus create contract-deployment <CONTRACT_FILE_NAME> <CONTRACT_ACCOUNT_NAME>
zeus migrate --network=kylin --creator=<CONTRACT_ACCOUNT_NAME> --creator-key=<ACTIVE_PRIVATE_KEY>

# optional flags:

--compile-all # compile all contracts
# default: true
--wallet # keosd wallet to use
# default: zeus
--creator-key # contract creator private key
# default: (eosio test key) 5KQwrPbwdL6PhXujxW37FSSQZ1JiwsST4cqQzDeyXtP79zkvFD3
--creator # account to set contract to
# default: eosio
--reset # reset testing environment
# default: true
--chain # chain to work on
# default: eos
--network # network to work on (other options, kylin, jungle, mainnet)
# default: development (local)
--verbose-rpc # verbose logs for blockchain communication
# default: false
--storage-path # path for persistent storage',
# default: path.join(require('os').homedir(), '.zeus')
--stake # account EOSIO staking amount
# default: '30.0000'
--no-compile # do not compile contracts
--no-reset # do not reset local testing environment

Zeus test¶

Compile and unit test a smart contract. You can either compile and test all of the contracts within the contracts & test directories with zeus test or a specific contract by name, with zeus test dappservices

zeus test <CONTRACT_NAME>

# optional flags:

--compile # compile contracts
# default: false
# alias: c
--wallet # keosd wallet to use
# default: zeus
# alias: w
--creator-key # contract creator key
# default: (eosio test key) 5KQwrPbwdL6PhXujxW37FSSQZ1JiwsST4cqQzDeyXtP79zkvFD3
--creator # account to set contract to
# default: eosio
# alias: a
--reset # reset testing environment
# default: true
--chain # chain to work on
# default: eos
--network # network to work on (other options, kylin, jungle, mainnet)
# default: development (local)
--verbose-rpc # verbose logs for blockchain communication
# default: false
--storage-path # path for persistent storage',
# default: path.join(require('os').homedir(), '.zeus')
--stake # account EOSIO staking amount
# default: '30.0000'
--no-reset # do not reset local testing environment

Zeus Import/Export Keys¶

Import and export keys to your Zeus wallet. Please note by default keys are imported without encryption.

zeus key import <ACCOUNT_NAME> --owner-private-key <KEY> --active-private-key <KEY>

# optional flags:

--encrypted # encrypt the account keys with a password
# default: false
--storage # path to the wallet which will store the key
# default: ${home}/.zeus/networks
--network # network to work on (other options, kylin, jungle, mainnet)
# development (local)
--password # password to encrypt the keys with
--vaccount # bool whether account is a LiquidAccount
# default: false

zeus key export <ACCOUNT_NAME>

# optional flags:

--encrypted # exports encrypted key
# default: false
--storage # path to where the key is stored
# default: ${home}/.zeus/networks
--network # network to work on (other options, kylin, jungle, mainnet)
# default: development (local)
--password # password to decrypt the keypair
--vaccount # bool whether account is a LiquidAccount
# default: false

Zeus Deploy¶

Deploy a custom Zeus box to your local working directory. Once deployed, if the --update-mapping flag is used, you may unbox this box like other packages. The --type method can be used to determine what medium to deploy the box to. The default local deploys with the syntax file://${packagePath}/box.zip. The option ipfs deploys to the IPFS network with the syntax ipfs://${hash}.

zeus deploy box

# optional flags:

--update-mapping # updates local mapping.js file with an IPFS URI where the package may be accessed at
# default: true
--type # deploy destination (local, ipfs)
# default: local

Help¶

zeus --help

List Boxes¶

Lists all available zeus boxes that can be unboxed.

zeus list-boxes

Update Boxes¶

Updates zeus boxes for currently unboxed project

zeus update --boxes

Create a new box¶

Creates a new directory with an empty zeus-config.json file.

zeus box create <BOX_NAME>

Add a box to the mapping.js file¶

In order to add a new box to zeus, you either need to edit the mapping.js where Zeus was installed, or you can use the following command:

zeus box add <BOX_NAME> <URI>
# for example: zeus box add liquidx-jungle https://s3.us-east-2.amazonaws.com/liquidapps.artifacts/boxes/0a98835c75debf2f1d875be8be39591501b15352f7c017799d0ebf3342668d2c.zip

Project structure¶

Directory structure¶

    extensions/
    contracts/
    frontends/
    models/
    test/
    migrations/
    utils/
    services/
    zeus-box.json
    zeus-config.js

zeus-box.json¶

Add commands, NPM intalls, ignores, and command hooks

    {
      "ignore": [
        "README.md"
      ],
      "commands": {
        "Compile contracts": "zeus compile",
        "Migrate contracts": "zeus migrate",
        "Test contracts": "zeus test"
      },
      "install":{
          "npm": {
              
          }
      },
      "hooks": {
        "post-unpack": "echo hello",
        "post-install": "git clone ..."
      }
    }

zeus-config.js¶

Configure zeus environments available to interact with. The zeus-config.js file is located in the root of an unboxed directory.

    module.exports = {
        defaultArgs:{
          chain:"eos",
          network:"development"
        },
        chains:{
            eos:{
                networks: {
                    development: {
                        host: "localhost",
                        port: 7545,
                        network_id: "*", // Match any network id
                        secured: false
                    },
                    jungle: {
                        host: "jungle2.cryptolions.io",
                        port: 80,
                        network_id: "*", // Match any network id
                        secured: false
                    },
                    kylin: {
                        host: "api.kylin.eosbeijing.one",
                        port: 80,
                        network_id: "*",
                        secured: false
                    },
                    mainnet:{
                        host: "bp.cryptolions.io",
                        port: 8888,
                        network_id: "*", // Match any network id
                        secured: false
                    }
                }
            }
        }
    };

Zeus Getting Started¶

Overview¶

Features:¶

Gitpod Zeus-IDE¶

dapp-client library¶

Hardware Requirements¶

Prerequisites¶

Use node version manager to install node¶

Recommended eosio.cdt and eosio versions¶

Install Zeus¶

Update¶

Test¶

Create your own contract¶

Try out LiquidApps’s take on Elemental Battles:¶

Try out vCPU with our LiquidChess game:¶

Try out LiquidPortfolio¶

Samples Boxes¶

vRAM Boxes¶

Zeus Extension Boxes¶

DAPP Services Boxes¶

Miscellaneous Boxes¶

Zeus Options¶

Zeus compile¶

Zeus migrate¶

Zeus test¶

Zeus Import/Export Keys¶

Zeus Deploy¶

Help¶

List Boxes¶

Update Boxes¶

Create a new box¶

Add a box to the mapping.js file¶

Project structure¶

Directory structure¶

zeus-box.json¶

zeus-config.js¶

Gitpod Zeus-IDE ¶

dapp-client library ¶