BuildIt is a metaverse project developed for the hackathon. It provides users with the ability to own virtual land within a map, place items on the land they own, and even sell the land to other users. The land is represented as ERC721 tokens, while the items are represented as ERC1155 tokens. All interactions within the metaverse are secured by smart contracts.
You should have Unity, npm, forge and foundry installed.
Go to backend folder and install dependencies
cd backend/
npm installTo run the project:
npm run devVisit localhost:3000 to run the backend api access point.
Go to client folder.
cd client/Open the client folder in Unity. Build the project and save build files in frontend/public directory.
Go to frontend folder and install dependencies
cd frontend/
npm installTo run the project:
npm run devVisit localhost:3000 to play the game.
Go to smart_contracts folder and install foundry and hardhat.
cd smart_contracts/
forge init
npm installTo compile smart contracts:
forge compile --skip test --skip script
# Or If you want to compile test files
forge compile --via-irTo run test on smart contracts:
forge test --via-irTo deploy smart contracts:
npx hardhat deploy --network $ChainName
# example: npx hardhat deploy --network mumbaiTo add destination chain data for cross chain transfer of utils:
Update addresses to the latest deployed contract addresses in script/addChain.js and script/addChainSelector.js
npx hardhat run script/addChain.js --network $ChainName
npx hardhat run script/addChainSelector.js --network $ChainName
# example:
# npx hardhat run script/addChain.js --network mumbai
# npx hardhat run script/addChainSelector.js --network mumbai
Note: Don't forget to make .env file, refer .env.example file.
Website can also be used which is build for webgl and will works on both desktop and mobile.
- Inspiration
- What It Does
- How We Built It
- Challenges We Ran Into
- Accomplishments That We're Proud Of
- What We Learned
- What's Next for BuildIt
The inspiration behind BuildIt comes from the desire to create an immersive metaverse experience where users can explore, own, and customize virtual land. We wanted to empower users to express their creativity and engage with a virtual world where they have control over their own unique space.
BuildIt allows users to:
- Own virtual land within a map represented as ERC721 tokens.
- Place items on their owned land, such as buildings, roads, and other structures, represented as ERC1155 tokens.
- Sell their land to other users, transferring ownership and associated items.
- Connect their wallets (e.g., Metamask, Coinbase, WalletConnect) to interact with the metaverse.
When a user connects their wallet, the game fetches data from the smart contracts and highlights the portion of the map that the user owns. Users can then click the "Edit" button to place or remove items on their land. They have the option to cancel or confirm the changes, which updates the items in the appropriate locations. Smart contract checks ensure that users can only interact with the land they own.
In addition, BuildIt includes a marketplace where users can sell their land through direct listings or auctions. Chainlink automation can be utilized for auction listings, and if the chain supports Chainlink price feeds, the land can be sold in USD. The marketplace provides an easy and secure way for users to trade their land.
Also, users can transfer their util items from one chain to another ( using Polygon LxLy bridge and CCIP ). Polygon LxLy bridge is used to transfer utils items from Polygon ZKEVM Testnet to Goerli and vice versa whereas Chainlink CCIP is used to transfer utils items from Polygon Mumbai to Sepolia and vice versa
While editing the map, user can also save/load private designs which is saved using sprucekit.
In marketplace listing, if seller owns an ENS account then it will display it so that it add more credibility about seller.
BuildIt was built using the following technologies and tools:
- Unity: The game was developed using Unity and built for Webgl.
- Smart Contracts: Five smart contracts were developed using Foundry and Hardhat:
- Map Contract: Responsible for the Lands in the Map, implemented as an ERC721 contract.
- Utils Contract: Represents the items that can be placed on the land, implemented as an ERC1155 contract.
- Faucet Contract: Allows users to obtain items for free initially. It is funded to provide items for judges and other participants.
- Marketplace Contract: Facilitates land sales through direct listings and auctions.
- Forwarder Contract: As all contracts implements ERC2771 context, Forwarder is used to provide gasless transactions for users.
- Map Size: The map size is determined in the smart contract, allowing the deployment of multiple maps with different sizes. The current deployment consists of a map with a size of 15 by 15 tiles, where each land is a 5 by 5 tile.
- Item Minting: Three items are minted in the Utils contract: road, house, and special item.
- Wallet Integration: Users can connect their wallets, such as Metamask, Coinbase, and WalletConnect, to interact with the metaverse.
- Gasless Transactions: All smart contracts implement ERC2771Context, enabling users to perform gasless transactions when the relayer is funded.
- Polygon LxLy bridge is used to transfer utils items from Polygon ZKEVM Testnet to Goerli and vice versa.
- Chainlink CCIP is used to transfer utils items from Polygon Mumbai to Sepolia and vice versa.
- Sprucekit was used to let User Save/Load private designs
- ENS was used to resolve custom name for users in marketplace
During the development of BuildIt, we encountered several challenges, including:
- Integrating Unity with the blockchain and ensuring secure and efficient interactions between the game and smart contracts.
- Implementing ERC721 and ERC1155 token standards and handling the transfer of ownership between users and their land/items.
- Optimizing gas usage and transaction costs in smart contract deployments.
- Developing a user-friendly interface and seamless wallet integration for a smooth user experience.
- Sprucekit sdk was mainly for Reactjs project, so to pass message between game build for wasm to Reactjs was challenging.
Throughout the development process, we achieved several accomplishments that we're proud of, including:
- Successfully integrating the Unity game engine with the Blockchain and smart contracts.
- Creating a metaverse where users can own virtual land and customize it with various items.
- Implementing a marketplace where users can buy and sell land securely through direct listings and auctions.
- Enabling gasless transactions for users by implementing ERC2771Context in all smart contracts.
- Conducting comprehensive testing, including fuzz testing, to ensure the stability and reliability of the application.
The development of BuildIt provided us with valuable learning experiences, including:
- Gaining in-depth knowledge of integrating smart contracts with Unity.
- Understanding the intricacies of token standards like ERC721 and ERC1155.
- Optimizing gas usage and transaction costs in smart contract deployments.
- Enhancing user experience through seamless wallet integration and fetching data from smart contracts.
- Polygon ZKEVM LxLy bridge and Chainlink services.
BuildIt is an ongoing project, and we have exciting plans testnet.bscscan.com
- Adding multiple maps with different sizes to expand the metaverse and accommodate more users.
- Conducting further research on gasless transactions to reduce transaction costs and improve user experience.
- Exploring cross-chain integrations to enable interoperability with other blockchain platforms.
- Enhancing the variety of items and customizations available to users.
- Engaging with the community to gather feedback and implement new features based on user suggestions.
We are dedicated to continuously improving and expanding BuildIt to create a vibrant and immersive metaverse experience for all users.