Welcome, this repository contains guides and examples to get started building on EVE Frontier. For more information, you can visit https://docs.evefrontier.com/.
To start building, follow the steps below to setup your local development tools and environment. If you already have the tools, make sure they are the correct version as otherwise you may have difficulties running the examples and building.
Before you get started you need to either install, or make sure you have the required tools. Install these tools for Linux, if you use a different OS then visit https://docs.evefrontier.com/Tools and follow the guide for your operating system.
Install Git through https://git-scm.com/book/en/v2/Getting-Started-Installing-Git.
To confirm Git has been installed run:
git --versionInstall NVM using this command:
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh | bash && source ~/.bashrcInstall Node version 18 by using this command:
nvm install 18Install PNPM, which is used as a more efficient version of NPM with:
npm install -g pnpmInstall foundry and restart the shell with:
curl -L https://foundry.paradigm.xyz | bash && source ~/.bashrcRun the below command to install forge, cast, anvil and chisel:
foundryupThis guide will walk you through setting up a local environment for running a local Anvil node, deploying world contracts using Docker, and pulling ABIs.
Ensure you have Docker installed on your system: Installation Guide
We have provided a docker compose file which bundles the running of the local node/world and deploying the world chain contracts to simulate the existing world. Run that with the command:
docker compose up -d
Monitor the progress of the world deployment with:
docker compose logs -f world-deployerOnce deployment is complete, you should see an output similar to the one below. Make sure to copy the world contract address and save it for future reference.
You can also retrieve the world abis and save them to the root directory from the deployment by running:
docker compose cp world-deployer:/monorepo/abis .Now that your local tools and development environment is set up, you're ready to start building!
To begin, navigate to the desired example directory then follow the instructions outlined in its README file. For more information on Smart Assemblies you can visit the Smart Assemblies Documentation.
cd smart-storage-unit
cat readme.mdRun the local indexer, explore, interact and observe the state changes using world explorer
From any of the example root folder for example (builder-examples/smart-storage-unit/) run the below command to run a local world explorer to see all changes in realtime:
pnpm explorer <worldAddress>eg: pnpm explorer 0x8a791620dd6260079bf849dc5567adc3f2fdc318
The command should then output something like this:
You can view the state of MUD tables by using the explore tab
You can interact with smart contract functions with the interact tab
Create a SSU vending machine for item trading
Configure a Smart Turret with a custom strategy
Control access to a Smart Gate based on corporation membership
