Welcome to setting up your local machine to use DIRT! Follow these steps before starting the tutorials and examples in other sections.
You need the following to get started:
Developer locally with Docker and Ganache
Ganache is a local Ethereum network you can run on your own local machine that allows you to developer with Ethereum smart contracts. Follow these sets to get setup. You may see comments in the terminal during setup. You can safely ignore them.
git clone https://github.com/dirtprotocol/dirt cd dirt npm run deploy
That's it! The DIRT smart contracts will now be deployed onto your local docker container and you can reference the smart contract address (
0x9938fd03d6d6d65280bf306f640570a8af6ac6fd) to read and write from the dataset locally.
Ganache is running in detached mode so you won't see anything in the terminal. You can check the container is running with
Head to the next section to create your first dataset 🌱
npm run deploy
This will start a docker container running ganache at localhost:8545. It will
also deploy the DIRT smart contracts to this local ganache blockchain. After
the deploy is complete, the address of the root registry will be
You can also run
npm run deploy to re-deploy the contracts after making
npm run pause
This will stop Ganache but still preserve the state of the container so that you don't have to redeploy the smart contracts.
npm run unpause
This will unpause Ganache.
npm run rebuild
After making changes to the code in
/packages, run this command to rebuild
contracts Docker container.