CID}
* /ipfs/{your CID}
* A valid CID directly
* A valid CID path directly
## HTTPS link
If the `uri` method of your NFT collection returns a link to an API, it should be something we can call right away. If you need the link to be concatenated with the token ID or any other kind of processing, contact us.
# Supported metadata structures
How to be sure that your NFT will show up correctly on dokidoki.com
## OpenSea metadata standards
If your NFTs use the [OpenSea metadata standards](https://docs.opensea.io/docs/metadata-standards#metadata-structure), you are already good to go.
## Other structures
If you don't follow the above standards, worry not, you might still be using the following structures:
| Type of data | Key in your metadata | |
| -------------------------------- | ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Image (PNG, JPEG, JPG, GIF only) | image
image\_url
| The image that represents your NFT, we will use that key to generate the preview of your NFT. Any other file format than an image will be rejected. |
| Video (MP4 Only) | animation\_url | Video of your NFT, usually the full resolution display of it. **If your structure contains this key, it MUST also contains the preview in the "image" category.** |
| name | name | The name of your NFT that will be displayed on our site. |
| description | description | The description of your NFT |
| Attributes | attributes
properties
| An array of properties with the following format:
\[
{
"trait\_type": "name of property",
"value": "value of property"
},
{...},
...
]
|
Any other data will not be taken into account.
## My NFTs don't follow any of those structures :(
Worry not! You can still use our gachapons, but the NFTs might not be displayed properly (No preview, no name...).
If you want them to be supported, you can just contact us beforehand on Discord or Telegram. We will do our best so they can be integrated ASAP.
# Solidity Interfaces and ABIs
## IGachapon
### Interface
{% code title="IGachapon.sol" %}
```javascript
pragma solidity ^0.8.6;
/// @title Interface implemented by all gachapons created by the GachaponControlTower
/// @author KirienzoEth for DokiDoki
interface IGachapon {
/// @dev Undefined = Round doesn't exist, Pending = waiting for oracle response, Unclaimed = oracle answered, Completed = Prizes were withdrawn
enum RoundStatus { Undefined, Pending, Unclaimed, Completed, Cancelled }
struct Round {
bytes32 id; // request id
address player; // address of player
RoundStatus status; // status of the round
uint8 times; // how many times of this round
uint256[10] prizes; // Prizes obtained in this round
}
struct Nft {
address collection; // adress of the contract of the collection
uint256 id; // token ID of the nft
uint256 amount; // winnable amount left in the gachapon
}
/// @notice Get the state of a round
function getRound(bytes32 _roundId) external returns (Round memory);
/// @notice Get the token address of the currency used by this gachapon
function currency() external returns (address);
/// @notice Return the number of prizes that are still available
function getRemaningPrizesAmount() external returns(uint256);
/// @notice Get the nft at index `_index`
function getNft(uint256 _index) external returns(Nft memory);
/// @notice The number of different nfts in the gachapon
/// @dev Use this to query `getNft` without going out of bounds, latest index is `nftsAmount() - 1`
function nftsAmount() external view returns(uint256);
/// @notice Play the gachapon `_times` times
function play(uint8 _times) external;
/// @notice Claim the prizes won in a round
function claimPrizes(bytes32 _roundId) external;
/// @notice Transferring ownership also change the artist's address
function transferOwnership(address _newOwner) external;
/// @dev Player paid and oracle was contacted, refer to getRound(_requestId) to check if the prizes were distributed or not
event RoundStarted(bytes32 indexed _requestId, address indexed _player, uint8 _times);
/// @dev Oracle answered and the drawn prizes were stored, numbers in _prizes are indexes of the variable 'nfts'
event RoundCompleted(bytes32 indexed _requestId, address indexed _player, uint8 _times, uint256[10] _prizes);
/// @dev Oracle didn't answer and an operator re-created a round for this player
event RoundCancelled(bytes32 _requestId);
/// @dev Stored prizes were sent to the user
event PrizesClaimed(bytes32 indexed _requestId);
}
```
{% endcode %}
### ABI
```javascript
[
{
"anonymous": false,
"inputs": [
{
"indexed": true,
"internalType": "bytes32",
"name": "_requestId",
"type": "bytes32"
}
],
"name": "PrizesClaimed",
"type": "event"
},
{
"anonymous": false,
"inputs": [
{
"indexed": false,
"internalType": "bytes32",
"name": "_requestId",
"type": "bytes32"
}
],
"name": "RoundCancelled",
"type": "event"
},
{
"anonymous": false,
"inputs": [
{
"indexed": true,
"internalType": "bytes32",
"name": "_requestId",
"type": "bytes32"
},
{
"indexed": true,
"internalType": "address",
"name": "_player",
"type": "address"
},
{
"indexed": false,
"internalType": "uint8",
"name": "_times",
"type": "uint8"
},
{
"indexed": false,
"internalType": "uint256[10]",
"name": "_prizes",
"type": "uint256[10]"
}
],
"name": "RoundCompleted",
"type": "event"
},
{
"anonymous": false,
"inputs": [
{
"indexed": true,
"internalType": "bytes32",
"name": "_requestId",
"type": "bytes32"
},
{
"indexed": true,
"internalType": "address",
"name": "_player",
"type": "address"
},
{
"indexed": false,
"internalType": "uint8",
"name": "_times",
"type": "uint8"
}
],
"name": "RoundStarted",
"type": "event"
},
{
"inputs": [
{
"internalType": "bytes32",
"name": "_roundId",
"type": "bytes32"
}
],
"name": "getRound",
"outputs": [
{
"components": [
{
"internalType": "bytes32",
"name": "id",
"type": "bytes32"
},
{
"internalType": "address",
"name": "player",
"type": "address"
},
{
"internalType": "enum IGachapon.RoundStatus",
"name": "status",
"type": "uint8"
},
{
"internalType": "uint8",
"name": "times",
"type": "uint8"
},
{
"internalType": "uint256[10]",
"name": "prizes",
"type": "uint256[10]"
}
],
"internalType": "struct IGachapon.Round",
"name": "",
"type": "tuple"
}
],
"stateMutability": "nonpayable",
"type": "function"
},
{
"inputs": [],
"name": "currency",
"outputs": [
{
"internalType": "address",
"name": "",
"type": "address"
}
],
"stateMutability": "nonpayable",
"type": "function"
},
{
"inputs": [
{
"internalType": "uint8",
"name": "_times",
"type": "uint8"
}
],
"name": "play",
"outputs": [],
"stateMutability": "nonpayable",
"type": "function"
},
{
"inputs": [
{
"internalType": "bytes32",
"name": "_roundId",
"type": "bytes32"
}
],
"name": "claimPrizes",
"outputs": [],
"stateMutability": "nonpayable",
"type": "function"
},
{
"inputs": [
{
"internalType": "address",
"name": "_newOwner",
"type": "address"
}
],
"name": "transferOwnership",
"outputs": [],
"stateMutability": "nonpayable",
"type": "function"
},
{
"inputs": [
{
"internalType": "uint256",
"name": "_index",
"type": "uint256"
}
],
"name": "getNft",
"outputs": [
{
"components": [
{
"internalType": "address",
"name": "collection",
"type": "address"
},
{
"internalType": "uint256",
"name": "id",
"type": "uint256"
},
{
"internalType": "uint256",
"name": "amount",
"type": "uint256"
}
],
"internalType": "struct IGachapon.Nft",
"name": "",
"type": "tuple"
}
],
"stateMutability": "nonpayable",
"type": "function"
},
{
"inputs": [],
"name": "getRemaningPrizesAmount",
"outputs": [
{
"internalType": "uint256",
"name": "",
"type": "uint256"
}
],
"stateMutability": "nonpayable",
"type": "function"
},
{
"inputs": [],
"name": "nftsAmount",
"outputs": [
{
"internalType": "uint256",
"name": "",
"type": "uint256"
}
],
"stateMutability": "view",
"type": "function"
},
]
```
###
# Brand & Media Kit
### Logo with text
{% file src="/files/-MdQrgrlKC4H1aPowxOX" %}
Logo with text filled BG SVG
{% endfile %}
{% file src="/files/-MdQs6T9KZ00ewQ59d96" %}
Logo with text transparent BG SVG
{% endfile %}
### Logo text only
{% file src="/files/-MdQuI-hxs6H0jrcpXAY" %}
Logo text only filled BG
{% endfile %}
{% file src="/files/-MdQv02zAI3Xs-w08R\_s" %}
Logo text only transparent BG
{% endfile %}
# Disclaimer
Doki Doki is a blockchain-based platform that anyone can use to mint NFTs (Non-fungible tokens), deploy Gacha machines, spend tokens to play Gacha machines to obtain NFTs
Doki Doki is non-custodial and only provides an interface for users to interact directly with smart contracts (Gacha machines, Staking pools) and assets (Tokens, NFTs) which reside on public blockchain networks. Users of Doki Doki should read the documentation carefully be aware of risks which include but are not limited to: losses due to decrease in value of tokens, NFTs or potential smart contract bugs.
Components of the platform such as Gacha machines contain elements of “chance” and thus may potentially be classified as “gambling”. Users are responsible for reviewing and understanding the legal status of Doki Doki in their local jurisdiction, before interacting with the platform.
# Customizations
How to personalize your Gacha machine
# Chainbinders
A first-of-its-kind deflationary set of NFTs backed by real value in $ETH
## Overview
The world of Chainbinders takes place in the near future — a large solar flare brings humanity to the brink of extinction, the ensuing chaos bringing about the destabilization of society. The solar flare kills most of the humans it comes in direct contact with — but a few destined children around the world survive the event, gaining mysterious powers. The focus of the story revolves around fifteen of these children, who come to be known as Chainbinders — named such for their unique and singular appearance. Chainbinders seek their Collectors, individuals with the ability to restore a Chainbinders to their full strength.
{% embed url="" %}
Chainbinders is an original Doki Doki IP product directed by [Roy Blackstone](https://twitter.com/fillbeforeshill) which features:
* A special [Gacha machine](https://dokidoki.com/playgacha/3/0xeFd7b1DC887b79568A59c39e6d35B6F2F2D18f02) with over 110 original NFTs from the Chainbinders universe
* [$BND](https://www.coingecko.com/en/coins/doki-doki-chainbinders), a custom token which is required to play the Chainbinders Gacha
* A [reserve pool](https://polygonscan.com/address/0x36be28fd7ba9a610b1ff3866f2dc9b7807c6ee4e) of ETH which backs the value of the NFTs
* A [dedicated collection page](https://chainbinders.degacha.com/my-collection) where the NFTs can be burned a.k.a "unbound" for ETH
* Rare NFTs are worth more ETH than common NFTs
* Unbinding increases both the scarcity and ETH value of remaining NFTs in the set
* A[ lore page ](https://chainbinders.degacha.com/chainbinders)with short stories for each of the 15 main characters
* A [gallery page](https://chainbinders.degacha.com/universe/gallery) showcasing Chainbinders OST, trailers, and wallpapers
*Like all Doki NFTs, Chainbinder NFTs were minted natively on Ethereum and bridged to Polygon. Using the* [*Doki Doki collection page,*](https://dokidoki.com/collection) *you can transfer the NFTs back to Ethereum L1 for safe-keeping.*
### BND Token
In the beginning, 1,255,206 $BND tokens were minted along with 125,520 NFTs. The Gacha costs 10 $BND per play and the 100% of the tokens are burned, making $BND a hyper-deflationary. The circulating supply of $BND will reach zero once there are no NFTs remaining in the machine. No additional $BND can ever be minted, however you can still experience Chainbinders by purchasing $BND on the open market and playing the Gacha!
* [Purchase BND on Comethswap L2](https://charts.cometh.io/pair/0xb3bed360bec6b70d2604993ab686b3e6fd3dc230)
* [Purchase BND on Uniswap L1](https://v2.info.uniswap.org/token/0X84CD68C3E470ECEE4B8B6212EFCB8C6BCB38DA1D)
As of August 2021, over 700k BND tokens (\~ 55% of the supply) have been locked in the machine contract and removed from circulation. [Source](https://polygonscan.com/address/0xeFd7b1DC887b79568A59c39e6d35B6F2F2D18f02)
## **Unbinding**
Unbinding is the process in which a player sacrifices their Chainbinders NFT along with a small amount of $AZUKI tokens in exchange for ETH. 10% of the extracted value loops back into reserve pool which increases the redeemable ETH value of the other NFTs, rewarding long-term collectors.
## **Rarity Table**
Below table displays the # of copies, roll probabilities, ETH values, and Azuki required to unbind for each Rarity from common to Legendary. The base value (ETH) for each non-binding failed NFT increases over time, as players perform unbinds.
| Rarity | Uniques | Copies/Unique | Total Copies | Base Value (ETH) | Roll % | Azuki |
| -------------- | ------- | ------------- | ------------ | ---------------- | ------ | ----- |
| Legendary | 15 | 60 | 900 | 0.831366 + | 0.72% | 100 |
| Ethereal | 15 | 250 | 3750 | 0.185276 + | 2.99% | 25 |
| Mythic | 20 | 500 | 10000 | 0.053445 + | 7.97% | 6 |
| Rare | 25 | 1200 | 18125 | 0.0221151 + | 14.44% | 3 |
| Common | 25 | 30000 | 1200 | 0.0089075 + | 23.90% | 1 |
| Binding Failed | 14 | \* | 62735 | 0 | 50% | N/A |
| Jackpot | 3 | 3 | 9 | 2.96916 + | 0.007% | 500 |
For up-to-date stats, check the Chainbinders [official collection page](https://chainbinders.degacha.com/my-collection), or [this tracker made](https://q1mrn.csb.app/) by community member Ran.
## Links
* [Chainbinders Website](https://chainbinders.degacha.com/)
* [Chainbinders Twitter](https://twitter.com/chainbinders)
* [Chainbinders playlist on Youtube](https://www.youtube.com/watch?v=OLEVaQv7_kM\&list=PLwWk83tr8mUGDn12_UevEZ756DyMIMjbY\&index=3)
* [Detailed blog post about Chainbinders](https://dokidoki-finance.medium.com/introducing-chainbinders-a-next-generation-nft-gacha-experience-en-4eaaa942f329)
# Unicly (uDOKI)
### **Introduction**
[UNICLY](https://unic.ly/) is a permissionless protocol that lets people convert a NFT collection into “u” tokens, which are tradable ERC20s. uDOKI is a “u” token which represents fractionalized ownership of the official Doki Doki NFT collection on Unicly.
### **How UNICLY and uDOKI works:**
UNICLY has a [Uniswap-like DEX](https://www.app.unic.ly/#/swap) where u-tokens, including uDOKI can be traded. On the [uDOKI collection page](https://www.app.unic.ly/#/utoken-contract/0x7e6c38d007740931e4b419bf15a68c79a0fb0c66), people can bid ETH on individual pieces and uDOKI token holders can vote as a collective in order to “unlock” the collection. 51% of all token holders need to vote for the collection to be unlocked. When a collection is unlocked, NFTs are sold to the highest bidders, and uDOKI holders receive ETH in proportion to the quantity of uDOKI tokens they own.
### **Yield-farming UNIC with uDOKI**
As uDOKI is a whitelisted collection, you can provide and stake liquidity for uDOKI-ETH and uDOKI-UNIC to farm UNIC, the native governance and revenue-sharing token of the UNICLY protocol. Check out this [step by step tutorial](https://docs.unic.ly/tutorials/how-to-liquidity-mine-and-farm-unic) to learn how to get started!
### **uDOKI collection appraisal**
In the beginning, third party appraisal service [Upshot ](https://upshot.io/)valued the uDOKI collection at 75 ETH
As of 7/25/2021, the appraisal has been updated to 90 ETH. **Source:** [**uTOKEN Appraisals Spreadsheet** ](https://docs.google.com/spreadsheets/d/1bGdcv6XJRmg1vaVLDDo8h6XeEqAHJko1s83HuS1hR9w/edit#gid=0)
Additional rare NFTs are added to the uDOKI collection on a regular basis, which aims to increase the value of the uDOKI collection overtime. The collection log below records all the NFTs that have been added since the beginning.
### **uDOKI Tokenomics**
* Max Supply: 1,000,000,000
* Initial Liquidity (50%): 500,000,000
* Farming Rewards (40%): 400,000,000
* Doki Team Treasury(10%): 100,000,000
* Vote required to unlock collection: 51%
### **uDOKI collection log**
| Date | NFT | Notes |
| --------- | ----------------------------- | ------------------- |
| 4-08-2021 | Pixelated Retro Japan X3 | Genesis Set |
| 4-15-2021 | Twilight Tea 3/3 by Seerlight | Donated by Rei |
| 4-15-2021 | Doki Lambo Girl | Donated by Rei |
| 4-15-2021 | Doki Doki Finance | Donated by Lumen |
| 5-16-2021 | Pranksy Airways Ultimate | Donated by Dokilord |
| 5-16-2021 | Streets of Ikebukuro | Donated by Lumen |
| 5-30-2021 | Cometh Spaceship "Anpan" | Donated by Lumen |
To learn more about how Unicly works, read the [Official Unicly Documentation](https://docs.unic.ly/)
Each Gachapon contract address is unique so make sure you have the one that corresponds to yours.
Search the address on [Polygonscan. ](https://polygonscan.com/)You should now arrive at the contract page.
2\. Navigate to contract -> write contract and connect using the same wallet which owns the Gachapon machine
3\. Scroll down to method 8. Remove NFT. Here you will need to input The NFT’s collection address, ID, and quantity you wish to remove. You can find the NFTID and collection address on the expanded details on Doki Doki or Opensea. See below examples
The above are just examples. Make sure you have the right ID and address for the NFTs you want to remove.
4\. Now copy the NFTID and collection address and go back to the Polygonscan page. Paste them into the corresponding input box along with the quantity you wish to remove and click write. Once the transaction confirms, that particular NFT is now removed from the machine and should be transferred back into your wallet.
If your wallet displays contract execution error, usually that means there is a problem with one or more of your inputs. If you need help, reach out to us on Discord for support.
If you wish to remove all NFTs, repeat steps 3-4 until all NFTs have been removed from the machine.
# How to freeze metadata for NFTs minted on Opensea
How to make NFTs minted using Opensea public minter compatible with Gacha
### Context
For NFTs minted using the [Opensea public minter](https://opensea.io/asset/create), you must **Freeze its metadata** before loading into your Gacha for the media to display correctly. Freezing the metadata basically means uploading the content to IPFS, a storage solution that is permanently available and unchangeable. To do this, please refer to the below instructions:
### Instructions
1. Navigate to the Opensea page of your NFT and click the "Edit" button at the top
2\. On the edit page, scroll down to the feature and toggle on "Freeze metadata" then click the "Freeze" button that appears
3\. Confirm the dialog and you're done! Repeat steps 1-3 for each NFT that you wish to load into your Gacha.
With the metadata frozen, the NFTs can now be loaded into your Gacha. You can verify that a particular NFT's metadata is frozen by its snowflake icon at the top left.
{% hint style="info" %}
The snowflake icon is only applicable to NFTs minted using Opensea's public minter. Most custom collections with a fixed URI should be natively compatible with our Gacha so you don't need to freeze the metadata. Contact us on Discord if you are unsure.
{% endhint %}
# How to add special rules to your Gacha using .CSV file
You can add special rules for specific wallet addresses such as **allowlists** to restrict access, **discounted plays,** and **free plays** by uploading a .CSV file with three columns:
* **address** = wallet address of users you wish to apply rule to
* **playcount** = number of times each address can play
* **price** = the price user can play for:
* blank = current set price
* 0 = free
The easiest way to create a .CSV file is to do so in a spreadsheet such as google sheets or Excel.
**Example:**
Once you have filled out your spreadsheet, you can export it as a .CSV file as shown below:
**Google Sheets:** File -> Download -> Comma Separated Values (.CSV)
