SPECIFICATION.md

Table of Contents

• Overview
• Use Cases
  • Airdrop
    • Core Functionality
      • constructor()
      • claim()
    • State Checks
      • claim_data()
      • end_block()
      • merkle_root()
  • Sequence Diagram

Overview

This document provides an overview of the application.

It outlines the use cases, i.e. desirable functionality, in addition to requirements for the smart contract and the user interface.

This application inherits the specification from the Binary Merkle Proof Verification Library specification.

Use Cases

This section contains general information about the functionality of the application and thus does not touch upon any technical aspects.

If you are interested in a functional overview then this is the section for you.

Airdrop

Core Functionality

constructor()

1. Allows the airdrop to begin and requires
   1. A duration for when a user can claim the airdrop
   2. An asset that a user can claim
   3. A pre-computed Merkle root

claim()

1. Allows a user to claim the asset they have been allotted if
   1. They have provided a valid Merkle Proof
   2. The deadline has not passed

State Checks

claim_data()

1. Returns information of the user's interaction with the airdrop contract
   1. If the user has claimed the airdrop
   2. Contains the amount of asset that a user has claimed

end_block()

1. Returns the block at which the airdrop expires

merkle_root()

1. Returns the stored merkle root used for claim validation

Sequence Diagram