Skip to content

Latest commit

 

History

History
116 lines (78 loc) · 4 KB

README.md

File metadata and controls

116 lines (78 loc) · 4 KB
Raw

Types of Deposits that can be made to the Raffle contract:

  1. Ticket (an extended ERC-721 token): Players call Ticket.approveAndCall()
  2. Prize Standard ERC-721: The owner calls the standard method ERC721.safeTransferFrom()
  3. Prize AdvancedToken (an extended ERC-20 token implementing approveAndCall()): The owner calls TokenERC20.approveAndCall()
  4. Prize Standard ERC-20: The owner calls the standard ERC20.approve() and Raffle.receiveApproval()
  5. Prize Ether: The owner calls Raffle.depositEther() payable function

=========================================================

Details:

  1. Ticket (an extended ERC-721 token): Players call Ticket.approveAndCall()

1.1 Players call:

Ticket.approveAndCall(
  address to = <raffle contract address>
  uint256 tokenId = <deposited ticket token id>
)

1.2 The Ticket contract automatically notifies the Raffle contract about the deposit via:

Ticket._checkOnTicketReceived(
  address to = <raffle contract address>
  uint256 tokenId = <deposited ticket token id>
)

which calls

ITicketReceiver(to).onTicketReceived(
  address operator = <ticket contract address>
  bytes32 hash = <keccak256 hash of token sender and token id (for security reasons)>
)

Accepted Tickets are stored as hashes (playerToHash map) in the 1st round and as numbers array and numberToPlayer map in the 2nd round.

Check https://medium.com/@promentol/lottery-smart-contract-can-we-generate-random-numbers-in-solidity-4f586a152b27 for more details.

  1. Standard ERC-721: Raffle owner calls the standard method ERC721.safeTransferFrom()

2.1 Owner calls the standard method:

ERC721.safeTransferFrom(
  address from = <raffle owner address>
  address to = <raffle contract address>
)

2.2 The standard ERC721 contract automatically notifies Raffle contract about the deposit via:

ERC721(to)._checkOnERC721Received(
  address from = <raffle owner address>
  address to = <raffle contract address>
  uint256 tokenId = <deposited token id>
  bytes memory data = <some extra data>
)

which calls

IERC721Receiver(to).onERC721Received(
  address operator  = <ticket contract address>
  address from  = <raffle owner address>
  uint256 tokenId = <deposited token id>
  bytes memory data = <some extra data>
)

Accepted ERC721 deposits are stored as prizeERC721 map.

Check the description of safeTransferFrom(address, address, uint256, bytes) at erc721.org for more details.

  1. AdvancedToken (an extended ERC-20 token implementing approveAndCall()): Raffle owner calls TokenERC20.approveAndCall()

3.1 Owner calls:

TokenERC20.approveAndCall(
  address to = <raffle contract address>
  uint256 value = <amount of tokens to deposit>
  bytes memory data = <some extra data>
)

3.2 AdvancedToken contract automatically notifies Raffle contract about the deposit via:

IExtERC20Receiver(to).receiveApproval(
  address from = <raffle owner address>
  uint256 value = <amount of tokens to deposit>
  address operator = <ticket contract address>
  bytes memory data = <some extra data>
)

Check https://ethereum.stackexchange.com/a/43163/50769 for more details.

  1. Standard ERC-20: Raffle owner calls the standard ERC20.approve(), then the owner calls Raffle.receiveApproval()

4.1 Owner calls the standard method:

ERC20.approve(
  address to = <raffle contract address>
  uint256 value = <amount of tokens to deposit>
)

4.2 In order to manually notify the Raffle contract about an ERC20 deposit, owner should call:

Raffle.receiveApproval(
  address operator = <ERC20 token contract address>
  uint256 value = <amount of tokens to deposit>
)

Accepted ERC20 and AdvancedToken deposits are stored as prizeERC20 map.

  1. Ether: Raffle owner calls Raffle.depositEther() payable function

    There is no need to additionally notify the Raffle contract about ETH deposits.

    Accepted deposits can be checked using web3.eth.getBalance() once they are done.