Коротко о проекте

Проект - мини-игра с большим количеством участвующих токенов:

Ресурсы - обычные ERC-20 токены трех типов - ягода, золото, дерево.
Инструменты - ERC-1155 токены. Их можно крафтить с помощью определенного количества ресурсов - золота и дерева. На смарт инструментов отправляются токены ресурсов, которые затем сжигаются. Взамен пользователь получает токен инструмента.
Смарт добычи. Пользователь отправляет на него инструмент и токены ягод. Ягоды сжигаются. Инструмент лочится на определенное время. По окончанию этого времени пользователь может вывести обратно из контракта свой инструмент + награду - некоторое количество ресурсов и количество артефактов (от 0 до 2). При этом у инструмента понижается параметр прочности.
Артефакты. ERC-1155 токены. Также могут выпасть пользователю с некоторой вероятностью в процессе добычи (предыдущий пункт).
Смарт ремонта. Пользователь на него отправляет токены золота и указывает инструмент, который нужно отремонтировать.

Более подробное описание здесь - [BSC NFT-game_Requirements]

Описание контрактов

Artifacts

Коллекция ERC-1155, токены взаимозаменяемые. После деплоя необходимо вызвать функцию

setToolsAddress(address)

, в параметры передать адрес развернутого контракта Tools.

Контракт содержит функцию

addNewArtifact()

, которую необходимо также вызвать после деплоя для добавления новых типов артефактов в коллекцию.

Tools

Коллекция ERC-1155, токены невзаимозаменяемые. После деплоя необходимо вызвать функции

setArtifactsAddress(address artifactsAddress)
setMiningAddress(address miningAddress)

Для установления URI метаданных используются следующие функции

function setBaseURI(string calldata baseURI)
function setURI(uint256 toolType, string calldata newURI)

Функция для создания новых типов инструментов

function addTool(
        uint32 maxStrength,
        uint32 miningDuration,
        uint32 energyCost,
        uint32 strengthCost,
        uint256 resourcesAmount,
        uint256[] calldata artifactsAmount,
        string calldata newURI
    )

Принимает в себя следующие параметры:

максимальная прочность инструмента
время добычи
трата энергии
трата прочности
количество добываемых ресурсов этим инструментом
количество добываемых артефактов этим инструментом
новая ссылка на инструмент в ipfs

После вызова этой функции создаются события:

event AddTool(uint256 toolType);

event RecipeCreatedOrUpdated(uint256 toolType, uint256 resourcesAmount, uint256[] artifactsAmount);

Первое событие содержит в себе тип добавленного инструмента.

Второе событие содержит в себе тип инструмента, количестсво ресурсов и артефактов, необходимых для его крафта.

Чеканить новые токены в этом контракте может только владелец, для этого вызываются следующие функции

function mint(
        address to,
        uint128 toolType,
        uint256 amount
    )

function mintBatch(
        address to,
        uint256[] calldata toolTypes,
        uint256[] calldata amounts,
        bytes calldata data
    )

Передаваемые параметры:

to - адрес, которому будет присвоен новый токен
toolType(toolTypes) - тип инструмента (для чеканки нескольких токенов передается массив типов)
amounts - количество токенов (во втором случае передается массив чисел)

Функция обновления рецептов для крафта

function setRecipe(
        uint256 toolType,
        uint256 resourcesAmount,
        uint256[] calldata artifactsAmount
    )

Принимает тип инструмента, количество ресурсов (Золота), количество артефактов. Генерирует событие

event RecipeCreatedOrUpdated(uint256 toolType, uint256 resourcesAmount, uint256[] artifactsAmount);

Событие содержит в себе тип инструмента у которого был обновлен рецепт, количестсво ресурсов и артефактов, необходимых для его крафта.

Mining

Контракт добычи ресурсов.

После того, как игрок вызвал функцию startMining(uint256 toolId, address user, uint256[] memory resourcesAmount, uint256[] memory artifactsAmount), производится мультиподпись от лица овнера. Награды сетит бэк через этот же метод. Генерируется событие:

event MiningStarted(address user, MiningSession session)

Событие передает адрес игрока и параметры сессии добычи (тип инструмента, время окончания добычи и тд).

Для завершения добычи ресурсов игрок вызывает функцию function endMining(uint256 toolId), функция генерирует событие

event MiningEnded(address user, MiningSession session);

После этого игроку становится доступным вывод награды через функцию function getRewards()

BlackList

Контракт черного списка.

Доступны 3 функции: проверка юзера на нахождение в черном списке, добавление и удаления.

    function check(address user) external view returns(bool)

    function addToBlacklist(address user) external onlyOwner

    function removeFromBlacklist(address user) external onlyOwner

Инструкция к деплою

Установить все зависимости через npm

npm i

Создать в корне проекта файл .env
Заполнить файл конфигурации по шаблону

# hardhat.confing
REPORT_GAS=true

# BSC URL's
TESTNET_URL=https://data-seed-prebsc-1-s1.binance.org:8545/
MAINNET_URL= https://bsc-dataseed.binance.org/

BASE_URI=https://123.com/

PRIVATE_KEY=21dfd98724dd553c110e1959ad892a213113e1a4e137cec739d29af909b96ec
ACC_ADDRESS=0xf8139f9d650B321c07239Ef6290ce33cC6A4B507
API_KEY=IMGMLKIH9FB2ECPBABB771T3AF5WT87KAA

PANCAKE_ROUTER_ADDRESS=0xD99D1c33F9fC3444f8101754aBC46c52416550D1

Запуск деплоя в тестовую сеть

npx hardhat run script/deploy.js --network testnet

TODO

При деплое в мейннет (bsc_mainnet) закоментить части скрипта деплоя с верификацией кода контрактов на BSCScan. Код *НЕ_ должен быть виден на сканерах
При деплое в мейннет (bsc*mainnet) в .env файл поместить *реальный_ BASE_URI

CREESTL / BscNftGame