CapsuleMinter.sol
The CapsuleMinter contract is an intermediary contract that holds tokens, assigns user holdings, and prevents abuse. This contract is responsible for the mintage of all Capsules. Nearly any token can be incorporated in the Capsule Protocol, with the exception of deflationary and rebasing tokens. Deflationary tokens are prohibited because the Capsule Protocol performs a check that the exact amount of token deposited is found at the contract post-transfer. Rebasing tokens are prohibited because their amount will change within the contract.
Capsule NFTs’ mint and burn functions are only callable through the CapsuleMinter. While this has no impact on the end functionality of the Capsule NFT (the methods work exactly as expected, simply through an intermediary), it prevents users from abusing contracts. You can think of the routing of NFT methods through the CapsuleMinter as a security blanket to ensure that no one can cheat the Capsule Protocol.
NOTE: It is important to consider that certain tokens, such as rebasing tokens (for example, Ampleforth) will change their amount from within the protocol. As such, refrain from placing such tokens directly into Capsule NFTs unless you wrap the token first (for example, Wrapped Ampleforth).
NOTE: The Capsule Protocol supports deflationary tokens, but note that two 'deflation events' (placing into a Capsule NFT and redeeming from a Capsule NFT) occur when interacting with such.
function mintSimpleCapsule(address _capsule, string _uri, address _receiver) external payable
Usage: (External) Create a simple Capsule (normal compatible ERC-721 NFT) from collection
_capsule with passed in _uri.Parameters:
_capsule: (address) - the address of the Capsule Collection_uri: (string) - the NFT tokenURI_receiver: (address) - the address which will receive the NFT (can be a contract)
Returns: (Nothing)
function burnSimpleCapsule(address _capsule, uint256 _id) external
Usage: (External) Burn a simple Capsule from collection
_capsule (normally, there is no incentive to do so).Parameters:
_capsule: (address) - the address of the Capsule Collection_id: (uint256) - the Simple Capsule NFT id
Returns: (Nothing)
function mintSingleERC20Capsule(address _capsule, address _token, uint256 _amount, string _uri, address _receiver) external payable
Usage: (External) Create an ERC-721 Capsule from collection
_capsule which holds an _amount of one token at address _token, with passed in _uri.Parameters:
_capsule: (address) - the address of the Capsule Collection_token: (address) - the token address to be deposited alongside creation of the Capsule_amount: (uint256) - the amount of token to be deposited alongside creation of the Capsule_uri: (string) - the NFT URI (IPFS hashes commonly used)
Returns: (Nothing)
function burnSingleERC20Capsule(address _capsule, uint256 _id) external
Usage: (External) Burn a Capsule from collection
_capsule at _id. (This will return the amount of token at address token which is attached to that Capsule to the owner)Parameters:
_capsule: (address) - the address of the Capsule Collection_id: (uint256) - the Capsule token id to burn
Returns: (Nothing)
function mintSingleERC721Capsule(address _capsule, address _token, uint256 _id, string _uri, address _receiver) external payable
Usage: (External) Create an ERC-721 Capsule from collection
_capsule which holds one ERC-721 compatible token at address _token and _id, with passed in _uri.Parameters:
_capsule: (address) - the address of the Capsule Collection_token: (address) - the token address to be deposited alongside creation of the Capsule_id: (uint256) - the id of token to be deposited alongside creation of the Capsule_uri: (string) - the NFT URI (IPFS hashes commonly used)
Returns: (Nothing)
function burnSingleERC721Capsule(address _capsule, uint256 _id) external
Usage: (External) Burn a Capsule from collection
_capsule at _id. This will return the ERC-721 token at address token which is attached to that Capsule to the sender.Parameters:
_capsule: (address) - the address of the Capsule Collection_id: (uint256) - the Capsule token id to burn
Returns: (Nothing)
function mintMultiERC20Capsule(address _capsule, address[] _tokens, uint256[] _amounts, string _uri, address _receiver) external payable
Usage: (External) Create an ERC-721 Capsule from collection
_capsule which holds multiple _amounts of multiple tokens at address _tokens, with passed in _uri. _tokens is passed in as an array, of which each token is matched by an amount in the _amounts array.For example - a call should be formatted like so:
_capsule: your Capsule Collection address_tokens:[ <token-address-1>, <token-address-2]_amounts:[ <token-amount-of-token-address-1>, <token-amount-of-token-address-2> ]_uri: your URI
To which, two token transfers are required, and one Capsule is returned to the user.
Parameters:
_capsule: (address) - the address of the Capsule Collection_tokens: (address[]) - the token addresses to be deposited alongside creation of the Capsule_amounts: (uint256[]) - the amounts of each token to be deposited alongside creation of the Capsule_uri: (string) - the NFT URI (IPFS hashes commonly used)
Returns: (Nothing)
function burnMultiERC20Capsule(address _capsule, uint256 _id) external
Usage: (External) Burn an ERC-721 Capsule from collection
_capsule at _id. This will return the amounts of token at addresses tokens which is attached to that Capsule to the sender.For example - a multi ERC20 Capsule which holds 1 WBTC and 1 WETH returns both tokens to the sender, and burns the Capsule.
Parameters:
_capsule: (address) - the address of the Capsule Collection_id: (uint256) - the Capsule token id to burn
Returns: (Nothing)
function mintMultiERC721Capsule(address _capsule, address[] _tokens, uint256[] _ids, string _uri, address _receiver) external payable
Usage: (External) Create an ERC-721 Capsule from collection
_capsule which holds multiple ERC-721 tokens at address _tokens (with corresponding _ids) with passed in _uri. _tokens is passed in as an array, of which each token is matched by an amount in the _ids array.For example - a call should be formatted like so:
_capsule: (address) - the address of the Capsule Collection_tokens:[ <token-address-1>, <token-address-2]_ids:[ <token-id-of-token-address-1>, <token-id-of-token-address-2> ]_uri: your URI
To which, two ERC-721 token transfers are required, and one Capsule is returned to the user.
Parameters:
_capsule: (address) - the address of the Capsule Collection_tokens: (address[]) - the token addresses to be deposited alongside creation of the Capsule_ids: (uint256[]) - the ids of each ERC-721 token_uri: (string) - the NFT URI (IPFS hashes commonly used)
Returns: (Nothing)
function burnMultiERC721Capsule(address _capsule, uint256 _id) external
Usage: (External) Burn an ERC-721 Capsule from collection
_capsule at _id. This will return the token at addresses tokens which is attached to that Capsule to the sender.For example - a multi ERC721 Capsule which holds 1 Rare Pepe and 1 Polkamon returns both tokens to the sender, and burns the Capsule.
Parameters:
_capsule: (address) - the address of the Capsule Collection_id: (uint256) - the Capsule token id to burn
Returns: (Nothing)
function getMultiERC20CapsuleData(address _capsule, uint256 _id) external view returns (struct CapsuleMinterStorage.MultiERC20Capsule _data)
Usage: (External) Get a struct holding:
- array of addresses
- array of amounts of a multi-ERC20 Capsule from collection
_capsule, at_id.
Parameters:
_capsule: (address) - the address of the Capsule Collection_id: (uint256) - the NFT id
Returns: (Struct: {address[], uint256[]}) - the token ids
function getMultiERC721CapsuleData(address _capsule, uint256 _id) external view returns (struct CapsuleMinterStorage.MultiERC721Capsule _data)
Usage: (External) Get a struct holding:
- array of addresses
- array of ids of a multi-ERC721 Capsule from collection
_capsule, at_id.
Parameters:
_capsule: (address) - the address of the Capsule Collection_id: (uint256) - the NFT id
Returns: (Struct: {address[], uint256[]}) - the token ids
function getCapsuleOwner(address _capsule, uint256 _id) external view returns (address)
Usage: (External) Get the owner of a certain Capsule from collection
_capsule at _id.Parameters:
_capsule: (address) - the address of the Capsule Collection_id: (uint256) - the Capsule id
Returns: (address) - the owner of the Capsule
function addToWhitelist(address _user) external
function removeFromWhitelist(address _user) external
function getMintWhitelist() external view returns (address[])
function isMintWhitelisted(address _user) external view returns (bool)
function flushTaxAmount() external
function updateCapsuleMintTax(uint256 _newTax) external
function initialize(address _factory) external
function onERC721Received(address, address, uint256, bytes) external pure returns (bytes4)
function _depositToken(contract IERC20 _token, address _depositor, uint256 _amount) internal returns (uint256 _actualAmount)
event CapsuleMintTaxUpdated(uint256 oldMintTax, uint256 newMintTax)
event SimpleCapsuleMinted(address account, address capsule, string uri)
event SimpleCapsuleBurnt(address account, address capsule, string uri)
event SingleERC20CapsuleMinted(address account, address capsule, address token, uint256 amount, string uri)
event SingleERC20CapsuleBurnt(address account, address capsule, address token, uint256 amount, string uri)
event SingleERC721CapsuleMinted(address account, address capsule, address token, uint256 id, string uri)
event SingleERC721CapsuleBurnt(address account, address capsule, address token, uint256 id, string uri)
event MultiERC20CapsuleMinted(address account, address capsule, address[] tokens, uint256[] amounts, string uri)
event MultiERC20CapsuleBurnt(address account, address capsule, address[] tokens, uint256[] amounts, string uri)
event MultiERC721CapsuleMinted(address account, address capsule, address[] tokens, uint256[] ids, string uri)
event MultiERC721CapsuleBurnt(address account, address capsule, address[] tokens, uint256[] ids, string uri)
modifier checkStatus()
modifier onlyValidCapsuleCollections(address _capsule)
modifier onlyCollectionMinter(address _capsule)
struct SingleERC20Capsule {
address tokenAddress;
uint256 tokenAmount;
}
struct MultiERC20Capsule {
address[] tokenAddresses;
uint256[] tokenAmounts;
}
struct SingleERC721Capsule {
address tokenAddress;
uint256 id;
}
struct MultiERC721Capsule {
address[] tokenAddresses;
uint256[] ids;
}
contract ICapsuleFactory factory
uint256 capsuleMintTax
mapping(address => mapping(uint256 => bool)) isSimpleCapsule
mapping(address => mapping(uint256 => struct CapsuleMinterStorage.SingleERC20Capsule)) singleERC20Capsule
mapping(address => mapping(uint256 => struct CapsuleMinterStorage.SingleERC721Capsule)) singleERC721Capsule
mapping(address => mapping(uint256 => struct CapsuleMinterStorage.MultiERC20Capsule)) multiERC20Capsule
mapping(address => mapping(uint256 => struct CapsuleMinterStorage.MultiERC721Capsule)) multiERC721Capsule
struct EnumerableSet.AddressSet mintWhitelist
Last modified 10mo ago