Skip to content

WAX Blockchain Setup

To set up and use the WAX Blockchain, it's recommended that you use our waxteam - Docker Images. Our docker images provide a fast, fully supported way to run a node in seconds. Refer to Docker Quickstart for more information.

Our production and development Docker images include everything that's available from the WAX Blockchain Source Code Repository, allowing you to run WAX nodes and build and deploy smart contracts.

If you'd like to access our sample contracts and scripts from your local drive or have a need to install the WAX Blockchain instead of using Docker, you can use this guide to download and optionally build the WAX Blockchain source code.


Important: At this time, pre-compiled packages are not available. Support is not available when you build the WAX blockchain from source.

What's Included

The WAX Blockchain is a fork of EOS (Antelope). This WAX Blockchain Source Code Repository includes and installs:

  • WAX Blockchain source code
  • Dependencies
  • Blockchain Tools, including keosd, nodeos, and cleos
  • Sample contracts

You can use these components to manage local wallets, create local accounts, interact with the WAX Blockchain, and more.


EOS Developers: Building the WAX Source Code Repository will overwrite a previous EOS installation.

Docker Quick Deploy

The WAX Source Code Repository includes a Hello World sample to quickly build and deploy WAX smart contracts to the WAX Blockchain. Refer to Docker Quick Deploy for more information.


For a complete list of dependencies, refer to wax-blockchain/scripts and locate the `wax_build_` file for your operating system.

System Requirements

If you're not using our Docker images, you'll need to:

  • Refer to Supported Operating Systems to make sure you meet the operating system requirements.


    Ubuntu 18.04 Users: Refer to Known Issues before you begin the WAX Blockchain Setup.

  • Have at least 7 GB of free RAM.

  • Have at least 20 GB of free hard drive space.