DAPPLOY · XYO Foundation Dev Portal

The XYO Foundation provides this source code available in our efforts to advance the understanding of the XYO Procotol and its possible uses. We continue to maintain this software in the interest of developer education. Usage of this source code is not intended for production.

We've gone through the hoops of deploying dApps on the Ethereum Network and have nuked out all of the annoying parts to make dapployment a breeze.

Difficulty Level: Intermediate

Getting Started

Install from source to get access to the sample projects. Remember, 'YARN ALL THE THINGS' from the main project dir by running this:

yarn && cd samples/sample-datavault-react/ && yarn && cd ../sample-datavault-solidity && yarn && cd ../..

OR globally install Dapploy using:

sudo yarn global add tool-dapploy-nodejs
OR
sudo npm install -g tool-dapploy-nodejs --unsafe-perm=true --allow-root

Run dapploy -h to see the options:

 $> dapploy -h
Usage: dapploy [options] [command]

Options:

  -V, --version                                 output the version number
  -t, --projectDir <dir>                        Truffle Project Directory
  -n, --network [network]                       Deploy to network (default: development)
  -c, --config <config>                         Config file (default: .dapploy)
  -o, --contractOutput <dir>                    Contract Output Directory
  -x, --excludeContracts [Contract1,Contract2]  Exclude contracts from the web3 interface (files are still copied)
  -a, --includeContracts [Contract1,Contract2]  Include contracts from the web3 interface (files are still copied)
  -l, --clean                                   Clean contracts before migrating
  -r, --remoteOnly                              Only copy contracts remote
  -p, --pinToIpfs                               Pin contracts to IPFS for remote access
  -k, --bucketName                              Do remote copy of ABI to aws bucket (make sure to setup ~/.aws)
  -y, --copyOnly                                Only do folder copy and S3 copy
  -i, --init                                    Add default config file to current directory
  -h, --help                                    output usage information

  $> dapploy init -h
Usage: init [options] [dir]

Configure a new truffle project from scratch

Options:

  -g, --configOnly                  Create dapploy config file in current directory
  -s, --specifyContract [contract]  Which type of project to create. Supporting: [ERC20, ERC721] (default: ERC20)
  -h, --help                        output usage information

If you did not add dapploy globally with '-g', Add dapploy alias to run from any project in your bash_profile:

echo "alias dapploy=\"/<path_to_project>/tool-dapploy-nodejs/dapploy\""| cat >> .bash_profile

Create a smart contract project

`dapploy init` - create a new smart contract project

Create a new ERC20 project using dapploy:

dapploy init my-first-coin -s ERC20
cd my-first-coin

Make sure Ganache is downloaded, installed and open: Download and install Ganache from their site

Click the Gear Icon thingy ( ⚙️ ) to open Preferences... Make sure that port is set to 8545.

Dapploy from root directory

if you have alias setup for dapploy, just run

  dapploy

otherwise run

  </path/to>/dapploy

Congrats, you just built your first ERC-20 Token! Head on over to Dapper to play with it in a web-ui

Checkout some dapploy samples to get another Dapp built with dapploy that uses IPFS and Dapploy's web3 adapter.

cd samples/sample-datavault-solidity && dapploy

cd ../sample-datavault-react && yarn start

Making your ABI public

dApploy to IPFS

dapploy -p

 $ Contracts stored to IPFS QmZ2Ezv4nsQ5tqGoHz4pUxa9GW88TWKMSzdxdMfxsHerWT
 $ View contracts at https://ipfs.xyo.network/ipfs/QmZ2Ezv4nsQ5tqGoHz4pUxa9GW88TWKMSzdxdMfxsHerWT

Dapploy to public testnet and mainnet

Sign into Metamask and change Network on Metamask to kovan/ropsten/mainnet

Add your metamask wallet and infura data to env.template file:

WALLET=// wallet used to deploy contracts
INFURA_API_KEY=// API key you get from infura
MNENOMIC=// 12 word pass key from derived from your wallet private key

Move env.template to .env (this file is already in your .gitignore)

mv env.template .env

Using kovan, run

dapploy -n kovan

Ropsten:

dapploy -n ropsten

NOTE You don't need to specify -n network if you change .dapploy configuration file in your project from network=development to network=kovan etc.

vi .dapploy

If you are feeling adventurous run a local testnet node:

Ropsten testnet node setup (Geth)

Kovan testnet node setup (Parity)

Multiple Browser Support

Portis

Setup account with portis.io
Add Portis and Infura key to .dapploy

vi .dapploy

Uncomment:

# [Portis]
# portisApiKey=<API_KEY>
# infuraApiKey=<INFURA_API_KEY>

Amazon S3

Confugure your AWS credentials in terminal by creating credentials file. S3 credential instructions here:

  vi ~/.aws/credentials
  [default]
  aws_access_key_id = AKIAIFYQ4UEUUJ6GDH6A
  aws_secret_access_key = FAKEasdfas=aqewrasdfa/sdfasdfasdfasdfFAKE

Configure dapploy

vi .dapploy