GameFi, the fusion of gaming and decentralized finance, is reshaping how games are played and monetized. In this guide, I will walk you through creating a GameFi vault where players can deposit their in-game tokens, earn shares proportional to their deposits, accumulate yield over time, and withdraw their funds with accrued rewards. The techniques are those that are found in traditional finance. This tutorial is ideal for Web3 game developers looking to integrate DeFi mechanics into their\u00a0games.<\/p>\n
Our GameFiVault contract is designed to manage deposits, share minting, yield accumulation, and withdrawals for an ERC-20-based in-game currency. Here’s how it\u00a0works:<\/p>\n
ERC-20 Integration<\/strong>: The contract accepts a token that acts as the in-game currency.Tokens and Yield<\/strong>: Players earn tokens based on the value of their deposit, and these shares accumulate yield over\u00a0time.Withdrawal Mechanism<\/strong>: Players can redeem their shares and receive the equivalent amount of tokens, including their accumulated yield.<\/p>\n \/\/ SPDX-License-Identifier: MIT import “@openzeppelin\/contracts\/access\/Ownable.sol”; contract GameFiVault is ReentrancyGuard, Ownable { IERC20 public gameToken; \/\/ In-game currency (ERC-20 token) struct StakerInfo { mapping(address => StakerInfo) public stakers; \/\/ Maps users to their staking info<\/p>\n event Deposit(address indexed user, uint256 amountDeposited, uint256 sharesMinted); \/\/ Constructor to initialize the contract with the game token and call the Ownable constructor \/\/ Function to deposit tokens and mint shares \/\/ Safely transfer tokens from the user to the contract \/\/ Calculate shares to mint using the equation \/\/ Update contract state StakerInfo storage staker = stakers[msg.sender]; emit Deposit(msg.sender, amount, sharesMinted); \/\/ Internal function to calculate yield uint256 stakingDuration = block.timestamp – staker.depositTimestamp; \/\/ Improved precision by rearranging multiplications return yield + staker.accumulatedYield; \/\/ Add this function to GameFiVault for testing purposes only function withdraw(uint256 shares) public nonReentrant { uint256 amountToWithdraw = (shares * vaultBalance) \/ totalShares; \/\/ Get the actual token balance of the contract \/\/ Update contract state before transferring funds if (staker.shares == 0) { \/\/ Safely transfer tokens to the user emit Withdrawal(msg.sender, amountToWithdraw, shares); The equation used to calculate shares minted during a deposit\u00a0is:<\/p>\n s<\/strong>: The number of shares, i.e. game\u00a0tokens.a<\/strong>: The amount the user deposits.T<\/strong>: The total number of shares\/tokens in the vault before the\u00a0deposit.B<\/strong>: The balance of the vault before the\u00a0deposit.<\/p>\n Derivation<\/strong>: This equation ensures that the proportion of new shares minted is consistent with the value of the user\u2019s deposit relative to the total value already in the vault. This mechanism is vital for maintaining fair distribution and aligning the value of shares\/game tokens with the underlying assets in the\u00a0vault.<\/p>\n How Yield Accumulation Works:<\/p>\n Annual Yield Rate<\/strong>: The annualYieldRate variable represents the percentage return users receive over a year (e.g.,\u00a010%).Yield Calculation<\/strong>: The yield is calculated based on the duration the tokens are staked using the\u00a0formula:<\/p>\n This formula calculates the yield accumulated by a user based on the number of shares they hold and the time they have staked\u00a0them.<\/p>\n Initial Deposit Handling<\/strong>: If the vault is empty (totalShares == 0 or vaultBalance == 0), one token is equivalent to one\u00a0share.Non-Reentrant<\/strong>: The use of ReentrancyGuard prevents reentrancy attacks, making the contract\u00a0safer.Share Tracking<\/strong>: The contract maintains a mapping stakers to store user-specific data, including shares, deposit timestamps, and accumulated yield.Events<\/strong>: Emitted for Deposit, Withdrawal, and YieldPaid to help with transparency and\u00a0logging.<\/p>\n Add NFT Rewards<\/strong>: Integrate ERC-721 logic to distribute NFTs to top\u00a0stakers.Governance<\/strong>: Implement a governance model where players can vote on yield rates. Remember to consider potential inflationary problems.Dynamic Yield Rates<\/strong>: Implement logic to change yield rates based on specific criteria (e.g., total value\u00a0locked).<\/p>\n The GameFi vault we built in this guide provides a solid starting point for integrating staking and yield accumulation into Web3 games. While this example is implemented in Solidity for Ethereum-compatible blockchains, the math and logic can easily be adapted to other programming languages and blockchain ecosystems. This makes it a flexible and versatile concept for any developer. However, it\u2019s important to note that this is a simplified version and not production-ready code.<\/p>\n It is an initial framework and foundational idea for Web3 game developers who want to explore and integrate GameFi mechanics into their projects. Further enhancements and security considerations are essential for deploying it in real-world games and applications.<\/p>\n Full Source Code == https:\/\/github.com\/KBryan\/GameFi2<\/a><\/p>\n Check out more Web3 game dev videos at https:\/\/www.youtube.com\/@blockchaingamedev<\/a><\/p>\n Building a Basic GameFi Vault: A Guide for Web3 Game Developers<\/a> was originally published in Coinmonks<\/a> on Medium, where people are continuing the conversation by highlighting and responding to this story.<\/p>","protected":false},"excerpt":{"rendered":" GameFi, the fusion of gaming and decentralized finance, is reshaping how games are played and monetized. In this guide, I will walk you through creating a GameFi vault where players can deposit their in-game tokens, earn shares proportional to their deposits, accumulate yield over time, and withdraw their funds with accrued rewards. The techniques are […]<\/p>\n","protected":false},"author":0,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[2],"tags":[],"class_list":["post-17706","post","type-post","status-publish","format-standard","hentry","category-interesting"],"_links":{"self":[{"href":"https:\/\/mycryptomania.com\/index.php?rest_route=\/wp\/v2\/posts\/17706"}],"collection":[{"href":"https:\/\/mycryptomania.com\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/mycryptomania.com\/index.php?rest_route=\/wp\/v2\/types\/post"}],"replies":[{"embeddable":true,"href":"https:\/\/mycryptomania.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=17706"}],"version-history":[{"count":0,"href":"https:\/\/mycryptomania.com\/index.php?rest_route=\/wp\/v2\/posts\/17706\/revisions"}],"wp:attachment":[{"href":"https:\/\/mycryptomania.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=17706"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/mycryptomania.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=17706"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/mycryptomania.com\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=17706"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}Code Explanation:<\/h3>\n
pragma solidity ^0.8.28;<\/p>\n
import “@openzeppelin\/contracts\/token\/ERC20\/IERC20.sol”;
import “@openzeppelin\/contracts\/token\/ERC20\/utils\/SafeERC20.sol”;
import “@openzeppelin\/contracts\/utils\/ReentrancyGuard.sol”; \/\/ Adding Ownable for admin control<\/p>\n
using SafeERC20 for IERC20;<\/p>\n
uint256 public totalShares; \/\/ Total shares in the vault
uint256 public vaultBalance; \/\/ Total balance in the vault (tracked in game tokens)<\/p>\n
uint256 shares; \/\/ The number of shares owned by the user
uint256 depositTimestamp; \/\/ The timestamp of the last deposit
uint256 accumulatedYield; \/\/ Accumulated yield from staking
}<\/p>\n
event Withdrawal(address indexed user, uint256 amountWithdrawn, uint256 sharesBurned);
event YieldPaid(address indexed user, uint256 yieldAmount);<\/p>\n
constructor(IERC20 _gameToken) Ownable(msg.sender) {
gameToken = _gameToken; \/\/ Assign the in-game currency
}<\/p>\n
\/\/ Function to deposit tokens and mint shares
function deposit(uint256 amount) public nonReentrant {
require(amount > 0, “Deposit amount must be greater than zero”);<\/p>\n
gameToken.safeTransferFrom(msg.sender, address(this), amount);<\/p>\n
uint256 sharesMinted = (totalShares == 0 || vaultBalance == 0) ? amount : (amount * totalShares) \/ vaultBalance;
require(sharesMinted > 0, “Calculated shares must be greater than zero”);<\/p>\n
totalShares += sharesMinted;
vaultBalance += amount;<\/p>\n
if (staker.shares > 0) {
\/\/ Accumulate yield up to this point before adding new shares
staker.accumulatedYield += _calculateYield(msg.sender);
}
staker.shares += sharesMinted;
staker.depositTimestamp = block.timestamp;<\/p>\n
}<\/p>\n
function _calculateYield(address user) internal view returns (uint256) {
StakerInfo storage staker = stakers[user];
if (staker.shares == 0 || staker.depositTimestamp == 0) {
return 0;
}<\/p>\n
uint256 annualYieldRate = 10; \/\/ 10% annual yield rate<\/p>\n
uint256 yield = (staker.shares * annualYieldRate * stakingDuration) \/ (365 days * 100);<\/p>\n
}<\/p>\n
function calculateYieldForUser(address user) public view returns (uint256) {
return _calculateYield(user);
}<\/p>\n
require(shares > 0, “Shares to withdraw must be greater than zero”);
StakerInfo storage staker = stakers[msg.sender];
require(staker.shares >= shares, “Insufficient shares to withdraw”);<\/p>\n
uint256 yield = _calculateYield(msg.sender);<\/p>\n
uint256 actualBalance = gameToken.balanceOf(address(this));
require(actualBalance >= amountToWithdraw + yield, “Insufficient vault balance for withdrawal”);<\/p>\n
totalShares -= shares;
vaultBalance -= amountToWithdraw; \/\/ Deduct only the principal amount
staker.shares -= shares;
staker.accumulatedYield = 0; \/\/ Reset accumulated yield after withdrawal<\/p>\n
staker.depositTimestamp = 0; \/\/ Clear timestamp if no shares remain
}<\/p>\n
gameToken.safeTransfer(msg.sender, amountToWithdraw + yield);<\/p>\n
emit YieldPaid(msg.sender, yield);
}
}<\/p>\nExplanation of the Key Equation:<\/h3>\n
Critical Features to\u00a0Note:<\/h3>\n
Taking this example\u00a0further:<\/h3>\n
Conclusion:<\/h3>\n