Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/MarkSackerberg/umi-cmv3-ui-inofficial
https://github.com/MarkSackerberg/umi-cmv3-ui-inofficial
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/MarkSackerberg/umi-cmv3-ui-inofficial
- Owner: MarkSackerberg
- Created: 2023-07-15T23:29:28.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-15T19:21:33.000Z (8 months ago)
- Last Synced: 2024-08-01T08:11:57.891Z (4 months ago)
- Language: TypeScript
- Homepage: https://umi-cmv3-ui-inofficial.vercel.app
- Size: 187 KB
- Stars: 49
- Watchers: 1
- Forks: 54
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome - MarkSackerberg/umi-cmv3-ui-inofficial - (TypeScript)
README
[](https://makeapullrequest.com)
# Deploy your own Candy Machine easily
This repository is for Candy Machine V3, Account Version V2. (This is what you have when using the latest sugar version to create the candy machine)
Visible to the user:
- Mint Page:
- Successful mint confirmation:
Visible to the admin:
# What does this repo support?
You can use this repo to deploy your own candy machine UI.
- It supports multiple candy machine groups, but also just using a default group
- It creates a Lookup table for you to allow more active guards at the same time
- The initializer shows you the merkle root for your groups
- The users see NFTs left, start and end countdowns, reasons for not being able to mint and more
- Combining most of these guards is possible since we are lookup tables. For example using `allowlist`,`nftBurn`, `nftPayment`, `solPayment`, `startDate` and `endDate`
- For larger allowlists this UI will automatically split the mint into two transactions to avoid hitting the transaction size limit
- Dynamic Compute Unit calculation to have higher chances to get the mint included into a block
- Priority fees are added. Those are hardcoded to a very small number. As of 15 March 24 all the dynamic solutions are only possibly with specific RPC providers. If you want to have it dynamic you need to implement it yourself.
- It supports most of the existing guards:
- `addressGate`
- `allocation`
- `allowlist`
- `endDate`
- `freezeSolPayment`
- `freezeTokenPayment`
- `mintLimit`
- `nftBurn`
- `nftGate`
- `nftPayment`
- `redeemedAmount`
- `solPayment`
- `startDate`
- `token2022Payment`
- `tokenBurn`
- `tokenGate`
- `tokenPayment`
- Multimint (can be deactivated by adding `NEXT_PUBLIC_MULTIMINT=false` to `.env`)
# How to use
## Prerequisites
- [pnpm](https://pnpm.io/installation) as package manager - I used 8.1.0
- [sugar](https://docs.metaplex.com/developer-tools/sugar/guides/sugar-for-cmv3) to create your candy machine
## How to use
1. Clone this repo
2. Run `pnpm install`
3. copy the `.env.example` file to a new `.env` file and fill in the NEXT_PUBLIC_CANDY_MACHINE_ID value. You should have this value after creating your candy machine with sugar.
3. Run `pnpm run dev`
4. Open your browser at `http://localhost:3000`
5. Connect your wallet which you used to create the candy machine
6. You should see a red `initialize` button. Click it and then click `create LUT`
7. Copy the LUT address that you see in the green success box and paste it into the `.env` file as the value for `NEXT_PUBLIC_LUT`
8. Add your candy machine groups to the `settings.tsx` file. E.g. if one of your groups is called `WL` you should have an entry for it in there, too
9. Deploy your Candy Machine e.g. to Vercel or Cloudflare Pages
Done!
### customization
You can customize the UI by changing the code. If you just want to modify some values you can instead
- modify `settings.tsx` to change the texts and Image.
- `image` is the main image that is shown. You could change it to your project logo.
- `headerText` is the website header. You could change it to your project name.
- Decide if you want to allow multiple mints by a single user at the same time and in your `.env` file set `NEXT_PUBLIC_MULTIMINT` accordingly to `true` or `false`. By default a maximum of 15 NFTs can be minted at the same time this is because of wallet limitations. If you want to have less change `NEXT_PUBLIC_MAXMINTAMOUNT` in `.env`.
- Change Priority fees if you want. By default it is set to the cheapest that is still considered to have priority fees. https://twitter.com/CloakdDev/status/1776661443330339285
### Fees
This ui has a buy me a beer feature. Each mint will transfer a very small amount (0.005) of SOL to a tip wallet. If you do not want to support me feel free to change the NEXT_PUBLIC_BUYMARKBEER variable to false. I would appreachiate it though if you leave it on. 🍻
# To do
- Add NFT Picker of `nftBurn` and `nftPayment` guards
# Contact / Support
If you need help with this repo, you can contact me. Also feel free to create an issue or a pull request.
- [Discord](https://discordapp.com/users/marksackerberg)
- [Twitter](https://twitter.com/MarkSackerberg)
If you want to work together on projects let me know!
# Disclaimer
This is not an official project by the Metaplex team. You can use that code at your own risk. I am not responsible for any losses that you might incur by using this code.
# Thank you!
Thanks to the metaplex team for creating NFTs on Solana, Candy Machine and Umi. Special Thanks to @lorisleiva for creating Umi and being so helpful. Also thanks to @tonyboylehub !