Create Aptos Dapp Telegram Clicker Game Mini App Template
This template provides a ready to use clicker game dapp that can be run as a Telegram mini app. You can use this template to build your own Telegram mini app dapp on the Aptos network.
We provide 2 signing experience for the Telegram Mini App, you can choose when you create the dapp using the create-aptos-dapp cli:
- explicit signing - the user needs to sign each transaction, this is powered by Aptos Wallet Adapter similar to other dapps
- seamless signing - the user doesn’t need to sign each transaction because the approval is done in the background, this is powered by Mizu Wallet SDK Core
Getting started
Publish the contract
Run the below command to publish the contract on-chain:
npm run move:publish
This command will:
- Publish the contract to chain.
- Setting the
VITE_MODULE_ADDRESS
in the.env
file to set the contract object address.
Create a Telegram bot
Start a chat with BotFather, use the /newbot
command to create a new bot.
(Optional) Obtain the app ID from Mizu wallet
If you choose the seamless signing experience, you are using @mizuwallet-sdk/core
instead of Aptos Wallet Adapte. You need to obtain a mizu app ID from the Mizu team by filling up their form. Once you have the app ID, set it in the .env
file as VITE_MIZU_WALLET_APP_ID
.
You can learn more about using it in the Mizu doc.
Host the frontend
Host the frontend on Vercel or any other hosting service.
Create a Telegram mini app
Use the /newapp
commend to create a new mini app and link the mini app with the bot you just created. When BotFather asks for the mini app’s URL, provide the URL of the frontend you deployed.
Set the menu button of the bot to open the mini app
Use the /mybots
command to find your bot, choose bot settings
-> menu button
-> configure menu button
, provide the mini app’s name and URL. Now you can access the mini app from your bot’s menu.
Ready for Mainnet
If you started your dapp on testnet, and you are happy with your testing, you will want to get the dapp on mainnet.
To publish the smart contract on mainnet, we need to change some configuration.
- Change the
VITE_APP_NETWORK
value tomainnet
in the.env
file - Run
npm run move:init
to initialize an account to work against Mainnet - If you already have an account you would like to use to publish the contract under, you can pass its private key when the prompt asks for that.
- If you are generating a new account, you need to transfer this account some APT on Aptos Mainnet since the tool can’t fund the account when it is against Mainnet.
- Check: open
.aptos/config.yaml
file and see that you have a profile under the{PROJECT_NAME}-mainnet
name (wherePROJECT_NAME
is specified in your.env
file). In addition, open the.env
file and check theVITE_MODULE_ADDRESS
value is the same as the new profile’s account account address. - Finally, run
npm run move:publish
to publish your move module on Aptos mainnet.