Contract Name:
Vyper_contract
Contract Source Code:
File 1 of 1 : Vyper_contract
# @version 0.3.7
# @notice Just a basic ERC721, nothing fancy except for allowlist and bulk minting functionality.
# @dev This would be equivalent to GBC.sol No extra functionality such as tracking how long an NFT has been held, distributing rewards, or tracking how many times someone has locked, that would all be handled off chain. Modified from https://github.com/npc-ers/current-thing
# @author The Llamas
# @license MIT
#
# ___________.__ .____ .__
# \__ ___/| |__ ____ | | | | _____ _____ _____ ______
# | | | | \ _/ __ \ | | | | \__ \ / \ \__ \ / ___/
# | | | Y \\ ___/ | |___ | |__ / __ \_| Y Y \ / __ \_ \___ \
# |____| |___| / \___ > |_______ \|____/(____ /|__|_| /(____ //____ >
# \/ \/ \/ \/ \/ \/ \/
from vyper.interfaces import ERC20
from vyper.interfaces import ERC165
from vyper.interfaces import ERC721
implements: ERC721
implements: ERC165
# Interface for the contract called by safeTransferFrom()
interface ERC721Receiver:
def onERC721Received(
operator: address, sender: address, tokenId: uint256, data: Bytes[1024]
) -> bytes4: nonpayable
# @dev Emits when ownership of any NFT changes by any mechanism.
# This event emits when NFTs are created (`from` == 0) and destroyed (`to` == 0).
# Exception: during contract creation, any number of NFTs may be created and assigned without emitting.
# At the time of any transfer, the approved address for that NFT (if any) is reset to none.
# @param _from Sender of NFT (if address is zero address it indicates token creation).
# @param _to Receiver of NFT (if address is zero address it indicates token destruction).
# @param _tokenId The NFT that got transfered.
event Transfer:
_from: indexed(address)
_to: indexed(address)
_tokenId: indexed(uint256)
# @dev This emits when the approved address for an NFT is changed or reaffirmed.
# The zero address indicates there is no approved address.
# When a Transfer event emits, this also indicates any approved address resets to none.
# @param _owner Owner of NFT.
# @param _approved Address that we are approving.
# @param _tokenId NFT which we are approving.
event Approval:
_owner: indexed(address)
_approved: indexed(address)
_tokenId: indexed(uint256)
# @dev This emits when an operator is enabled or disabled for an owner.
# The operator can manage all NFTs of the owner.
# @param _owner Owner of NFT.
# @param _operator Address to which we are setting operator rights.
# @param _approved Status of operator rights (true if operator rights given, false if revoked).
event ApprovalForAll:
_owner: indexed(address)
_operator: indexed(address)
_approved: bool
IDENTITY_PRECOMPILE: constant(
address
) = 0x0000000000000000000000000000000000000004
# Metadata
symbol: public(String[32])
name: public(String[32])
# Permissions
owner: public(address)
# URI
base_uri: public(String[128])
contract_uri: String[128]
# NFT Data
ids_by_owner: HashMap[address, DynArray[uint256, MAX_SUPPLY]]
id_to_index: HashMap[uint256, uint256]
token_count: uint256
owned_tokens: HashMap[
uint256, address
] # @dev NFT ID to the address that owns it
token_approvals: HashMap[uint256, address] # @dev NFT ID to approved address
operator_approvals: HashMap[
address, HashMap[address, bool]
] # @dev Owner address to mapping of operator addresses
# @dev Static list of supported ERC165 interface ids
SUPPORTED_INTERFACES: constant(bytes4[5]) = [
0x01FFC9A7, # ERC165
0x80AC58CD, # ERC721
0x150B7A02, # ERC721TokenReceiver
0x780E9D63, # ERC721Enumerable
0x5B5E139F, # ERC721Metadata
]
# Custom NFT
revealed: public(bool)
default_uri: public(String[150])
MAX_SUPPLY: constant(uint256) = 1111
MAX_PREMINT: constant(uint256) = 235
MAX_MINT_PER_TX: constant(uint256) = 3
COST: constant(uint256) = as_wei_value(0.1, "ether")
al_mint_started: public(bool)
al_signer: public(address)
minter: public(address)
al_mint_amount: public(HashMap[address, uint256])
@external
def __init__(preminters: address[MAX_PREMINT]):
self.symbol = "LLAMA"
self.name = "The Llamas"
self.owner = msg.sender
self.contract_uri = "https://ivory-fast-planarian-364.mypinata.cloud/ipfs/QmPAS4WmxAcqRnKyUS1KS4pCeWDMmZWyph6N3DzE6rCb7L"
self.default_uri = "https://ivory-fast-planarian-364.mypinata.cloud/ipfs/QmSBtCSpm3HzwfqBYLLYb7d1AkbQ73cvGWu3bbk4vP2PGd"
self.al_mint_started = False
self.al_signer = msg.sender
self.minter = msg.sender
for i in range(MAX_PREMINT):
token_id: uint256 = self.token_count
self._add_token_to(preminters[i], token_id)
self.token_count += 1
log Transfer(empty(address), preminters[i], token_id)
@pure
@external
def supportsInterface(interface_id: bytes4) -> bool:
"""
@notice Query if a contract implements an interface.
@dev Interface identification is specified in ERC-165.
@param interface_id Bytes4 representing the interface.
@return bool True if supported.
"""
return interface_id in SUPPORTED_INTERFACES
### VIEW FUNCTIONS ###
@view
@external
def balanceOf(owner: address) -> uint256:
"""
@notice Count all NFTs assigned to an owner.
@dev Returns the number of NFTs owned by `owner`.
Throws if `owner` is the zero address.
NFTs assigned to the zero address are considered invalid.
@param owner Address for whom to query the balance.
@return The address of the owner of the NFT
"""
assert owner != empty(
address
) # dev: "ERC721: balance query for the zero address"
return len(self.ids_by_owner[owner])
@view
@external
def ownerOf(token_id: uint256) -> address:
"""
@notice Find the owner of an NFT.
@dev Returns the address of the owner of the NFT.
Throws if `token_id` is not a valid NFT.
@param token_id The identifier for an NFT.
@return The address of the owner of the NFT
"""
owner: address = self.owned_tokens[token_id]
assert owner != empty(
address
) # dev: "ERC721: owner query for nonexistent token"
return owner
@view
@external
def getApproved(token_id: uint256) -> address:
"""
@notice Get the approved address for a single NFT
@dev Get the approved address for a single NFT.
Throws if `token_id` is not a valid NFT.
@param token_id ID of the NFT for which to query approval.
@return The approved address for this NFT, or the zero address if there is none
"""
assert self.owned_tokens[token_id] != empty(
address
) # dev: "ERC721: approved query for nonexistent token"
return self.token_approvals[token_id]
@view
@external
def isApprovedForAll(owner: address, operator: address) -> bool:
"""
@notice Query if an address is an authorized operator for another address
@dev Checks if `operator` is an approved operator for `owner`.
@param owner The address that owns the NFTs.
@param operator The address that acts on behalf of the owner.
@return True if `_operator` is an approved operator for `_owner`, false otherwise
"""
return (self.operator_approvals[owner])[operator]
### TRANSFER FUNCTION HELPERS ###
@view
@internal
def _is_approved_or_owner(spender: address, token_id: uint256) -> bool:
"""
@dev Returns whether the given spender can transfer a given token ID
@param spender address of the spender to query
@param token_id uint256 ID of the token to be transferred
@return bool whether the msg.sender is approved for the given token ID,
is an operator of the owner, or is the owner of the token
"""
owner: address = self.owned_tokens[token_id]
spender_is_owner: bool = owner == spender
spender_is_approved: bool = spender == self.token_approvals[token_id]
spender_is_approved_for_all: bool = self.operator_approvals[owner][spender]
return (
spender_is_owner or spender_is_approved
) or spender_is_approved_for_all
@internal
def _add_token_to(_to: address, _token_id: uint256):
"""
@dev Add a NFT to a given address
Throws if `_token_id` is owned by someone.
"""
# Throws if `_token_id` is owned by someone
assert self.owned_tokens[_token_id] == empty(address)
# Change the owner
self.owned_tokens[_token_id] = _to
# Change count tracking
num_ids: uint256 = len(self.ids_by_owner[_to])
self.id_to_index[_token_id] = num_ids
self.ids_by_owner[_to].append(_token_id)
@internal
def _remove_token_from(_from: address, _token_id: uint256):
"""
@dev Remove an NFT from a given address
Throws if `_from` is not the current owner.
"""
# Throws if `_from` is not the current owner
assert self.owned_tokens[_token_id] == _from
# Change the owner
self.owned_tokens[_token_id] = empty(address)
# Update ids list for user
end_index: uint256 = len(self.ids_by_owner[_from]) - 1
id_index: uint256 = self.id_to_index[_token_id]
if end_index == id_index:
# Remove is simple since token is at end of ids list
self.ids_by_owner[_from].pop()
self.id_to_index[_token_id] = 0
else:
# Token is not at end;
# replace it with the end token and then..
end_id: uint256 = self.ids_by_owner[_from][end_index]
self.ids_by_owner[_from][id_index] = end_id
# ... pop!
self.ids_by_owner[_from].pop()
self.id_to_index[_token_id] = 0
self.id_to_index[end_id] = id_index
@internal
def _clear_approval(_owner: address, _token_id: uint256):
"""
@dev Clear an approval of a given address
Throws if `_owner` is not the current owner.
"""
# Throws if `_owner` is not the current owner
assert self.owned_tokens[_token_id] == _owner
if self.token_approvals[_token_id] != empty(address):
# Reset approvals
self.token_approvals[_token_id] = empty(address)
@internal
def _transfer_from(
_from: address, _to: address, _token_id: uint256, _sender: address
):
"""
@dev Execute transfer of a NFT.
Throws unless `msg.sender` is the current owner, an authorized operator, or the approved
address for this NFT. (NOTE: `msg.sender` not allowed in private function so pass `_sender`.)
Throws if `_to` is the zero address.
Throws if `_from` is not the current owner.
Throws if `_token_id` is not a valid NFT.
"""
# Throws if `_to` is the zero address
assert _to != empty(address) # dev : "ERC721: transfer to the zero address"
# Check requirements
assert self._is_approved_or_owner(
_sender, _token_id
) # dev : "ERC721: transfer caller is not owner nor approved"
# Clear approval. Throws if `_from` is not the current owner
self._clear_approval(_from, _token_id)
# Remove NFT. Throws if `_token_id` is not a valid NFT
self._remove_token_from(_from, _token_id)
# Add NFT
self._add_token_to(_to, _token_id)
# Log the transfer
log Transfer(_from, _to, _token_id)
### TRANSFER FUNCTIONS ###
@external
def transferFrom(from_addr: address, to_addr: address, token_id: uint256):
"""
@dev Throws unless `msg.sender` is the current owner, an authorized operato_addrr, or the approved address for this NFT.
Throws if `from_addr` is not the current owner.
Throws if `to_addr` is the zero address.
Throws if `token_id` is not a valid NFT.
@notice The caller is responsible to_addr confirm that `to_addr` is capable of receiving NFTs or else they maybe be permanently lost.
@param from_addr The current owner of the NFT.
@param to_addr The new owner.
@param token_id The NFT to_addr transfer.
"""
self._transfer_from(from_addr, to_addr, token_id, msg.sender)
@external
def safeTransferFrom(
from_addr: address,
to_addr: address,
token_id: uint256,
data: Bytes[1024] = b"",
):
"""
@dev Transfers the ownership of an NFT from one address to another address.
Throws unless `msg.sender` is the current owner, an authorized operator, or the approved address for this NFT.
Throws if `from_addr` is not the current owner.
Throws if `to_addr` is the zero address.
Throws if `token_id` is not a valid NFT.
If `to_addr` is a smart contract, it calls `onERC721Received` on `to_addr` and throws if the return value is not `bytes4(keccak256("onERC721Received(address,address,uint256,bytes)"))`.
NOTE: bytes4 is represented by bytes32 with padding
@param from_addr The current owner of the NFT.
@param to_addr The new owner.
@param token_id The NFT to transfer.
@param data Additional data with no specified format, sent in call to `to_addr`.
"""
self._transfer_from(from_addr, to_addr, token_id, msg.sender)
if to_addr.is_contract: # check if `to_addr` is a contract address
return_value: bytes4 = ERC721Receiver(to_addr).onERC721Received(
msg.sender, from_addr, token_id, data
)
# Throws if transfer destination is a contract which does not implement 'onERC721Received'
assert return_value == method_id(
"onERC721Received(address,address,uint256,bytes)",
output_type=bytes4,
)
@external
def approve(approved: address, token_id: uint256):
"""
@notice Change or reaffirm the approved address for an NFT
@dev Set or reaffirm the approved address for an NFT. The zero address indicates there is no approved address.
Throws unless `msg.sender` is the current NFT owner, or an authorized operator of the current owner.
Throws if `token_id` is not a valid NFT. (NOTE: This is not written the EIP)
Throws if `approved` is the current owner. (NOTE: This is not written the EIP)
@param approved Address to be approved for the given NFT ID.
@param token_id ID of the token to be approved.
"""
owner: address = self.owned_tokens[token_id]
# Throws if `token_id` is not a valid NFT
assert owner != empty(
address
) # dev: "ERC721: owner query for nonexistent token"
# Throws if `approved` is the current owner
assert approved != owner # dev: "ERC721: approval to current owner"
# Check requirements
is_owner: bool = self.owned_tokens[token_id] == msg.sender
is_approved_all: bool = (self.operator_approvals[owner])[msg.sender]
assert (
is_owner or is_approved_all
) # dev: "ERC721: approve caller is not owner nor approved for all"
# Set the approval
self.token_approvals[token_id] = approved
log Approval(owner, approved, token_id)
@external
def setApprovalForAll(operator: address, approved: bool):
"""
@notice notice Enable or disable approval for a third party ("operator") to manage all of `msg.sender`'s assets
@dev Enables or disables approval for a third party ("operator") to manage all of`msg.sender`'s assets. It also emits the ApprovalForAll event.
Throws if `operator` is the `msg.sender`. (NOTE: This is not written the EIP)
This works even if sender doesn't own any tokens at the time.
@param operator Address to add to the set of authorized operators.
@param approved True if the operators is approved, false to revoke approval.
"""
# Throws if `operator` is the `msg.sender`
assert operator != msg.sender
self.operator_approvals[msg.sender][operator] = approved
log ApprovalForAll(msg.sender, operator, approved)
### MINT FUNCTIONS ###
@external
@payable
def allowlistMint(
mint_amount: uint256, approved_amount: uint256, sig: Bytes[65]
):
"""
@notice Function to mint a token for allowlisted users
"""
# Checks
assert self.al_mint_started == True, "AL Mint not active"
assert mint_amount <= MAX_MINT_PER_TX, "Transaction exceeds max mint amount"
assert (
self.checkAlSignature(sig, msg.sender, approved_amount) == True
), "Signature is not valid"
assert (
(self.al_mint_amount[msg.sender] + mint_amount) <= approved_amount
), "Cannot mint over approved amount"
assert msg.value >= COST * mint_amount, "Not enough ether provided"
for i in range(MAX_MINT_PER_TX):
if i >= mint_amount:
break
token_id: uint256 = self.token_count
assert token_id < MAX_SUPPLY
self._add_token_to(msg.sender, token_id)
self.token_count += 1
log Transfer(empty(address), msg.sender, token_id)
self.al_mint_amount[msg.sender] += mint_amount
@external
def mint() -> uint256:
"""
@notice Function to mint a token
"""
# Checks
assert msg.sender == self.minter
token_id: uint256 = self.token_count
assert token_id < MAX_SUPPLY
self._add_token_to(msg.sender, token_id)
self.token_count += 1
log Transfer(empty(address), msg.sender, token_id)
return token_id
### ERC721-URI STORAGE FUNCTIONS ###
@external
@view
def tokenURI(token_id: uint256) -> String[256]:
"""
@notice A distinct Uniform Resource Identifier (URI) for a given asset.
@dev Throws if `_token_id` is not a valid NFT. URIs are defined in RFC 6686. The URI may point to a JSON file that conforms to the "ERC721 Metadata JSON Schema".
"""
if self.owned_tokens[token_id] == empty(address):
raise # dev: "ERC721URIStorage: URI query for nonexistent token"
if self.revealed:
return concat(self.base_uri, uint2str(token_id))
else:
return self.default_uri
@external
@view
def contractURI() -> String[128]:
"""
@notice URI for contract level metadata
@return Contract URI
"""
return self.contract_uri
### ADMIN FUNCTIONS
@external
def set_minter(minter: address):
assert msg.sender == self.owner, "Caller is not the owner"
self.minter = minter
@external
def set_al_signer(al_signer: address):
assert msg.sender == self.owner, "Caller is not the owner"
self.al_signer = al_signer
@external
def set_base_uri(base_uri: String[128]):
"""
@notice Admin function to set a new Base URI for
@dev Globally prepended to token_uri
@param base_uri New URI for the token
"""
assert (
msg.sender == self.owner
), "Caller is not the owner" # dev: Only Admin
self.base_uri = base_uri
@external
def set_contract_uri(new_uri: String[66]):
"""
@notice Admin function to set a new contract URI
@param new_uri New URI for the contract
"""
assert (
msg.sender == self.owner
), "Caller is not the owner" # dev: Only Admin
self.contract_uri = new_uri
@external
def set_owner(new_addr: address):
"""
@notice Admin function to update owner
@param new_addr The new owner address to take over immediately
"""
assert (
msg.sender == self.owner
), "Caller is not the owner" # dev: Only Owner
self.owner = new_addr
@external
def set_revealed(flag: bool):
"""
@notice Admin function to reveal collection. If not revealed, all NFTs show default_uri
@param flag Boolean, True to reveal, False to conceal
"""
assert (
msg.sender == self.owner
), "Caller is not the owner" # dev: Only Owner
self.revealed = flag
@external
def withdraw():
assert (
msg.sender == self.owner
), "Caller is not the owner" # dev: "Admin Only"
send(self.owner, self.balance)
@external
def admin_withdraw_erc20(coin: address, target: address, amount: uint256):
"""
@notice Withdraw ERC20 tokens accidentally sent to contract
@param coin ERC20 address
@param target Address to receive
@param amount Wei
"""
assert (
msg.sender == self.owner
), "Caller is not the owner" # dev: "Admin Only"
ERC20(coin).transfer(target, amount)
@external
def start_al_mint():
assert (
msg.sender == self.owner
), "Caller is not the owner" # dev: "Admin Only"
self.al_mint_started = True
@external
def stop_al_mint():
assert (
msg.sender == self.owner
), "Caller is not the owner" # dev: "Admin Only"
self.al_mint_started = False
## ERC-721 Enumerable Functions
@external
@view
def totalSupply() -> uint256:
"""
@notice Return the total supply
@return The token count
"""
return self.token_count
@external
@view
def tokenByIndex(_index: uint256) -> uint256:
"""
@notice Enumerate valid NFTs
@dev With no burn and direct minting, this is simple
@param _index A counter less than `totalSupply()`
@return The token identifier for the `_index`th NFT,
"""
return _index
@external
@view
def tokenOfOwnerByIndex(owner: address, index: uint256) -> uint256:
"""
@notice Enumerate NFTs assigned to an owner
@dev Throws if `index` >= `balanceOf(owner)` or if `owner` is the zero address, representing invalid NFTs.
@param owner An address where we are interested in NFTs owned by them
@param index A counter less than `balanceOf(owner)`
@return The token identifier for the `index`th NFT assigned to `owner`, (sort order not specified)
"""
assert owner != empty(address)
assert index < len(self.ids_by_owner[owner])
return self.ids_by_owner[owner][index]
@external
@view
def tokensForOwner(owner: address) -> DynArray[uint256, MAX_SUPPLY]:
return self.ids_by_owner[owner]
## SIGNATURE HELPER
@internal
@view
def checkAlSignature(
sig: Bytes[65], sender: address, approved_amount: uint256
) -> bool:
r: uint256 = convert(slice(sig, 0, 32), uint256)
s: uint256 = convert(slice(sig, 32, 32), uint256)
v: uint256 = convert(slice(sig, 64, 1), uint256)
ethSignedHash: bytes32 = keccak256(
concat(
b"\x19Ethereum Signed Message:\n32",
keccak256(_abi_encode("allowlist:", sender, approved_amount)),
)
)
return self.al_signer == ecrecover(ethSignedHash, v, r, s)