https://github.com/osmosis-labs/claims

Airdrop facilitation software
https://github.com/osmosis-labs/claims

Last synced: about 1 month ago
JSON representation

Airdrop facilitation software

• Host: GitHub
• URL: https://github.com/osmosis-labs/claims
• Owner: osmosis-labs
• Created: 2022-02-21T22:28:04.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-02-21T23:26:03.000Z (almost 3 years ago)
• Last Synced: 2024-04-14T04:06:27.885Z (8 months ago)
• Language: Go
• Size: 2.13 MB
• Stars: 3
• Watchers: 5
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Claims module

## Abstract

The Osmosis claims module has users begin with a portion of their total airdrop allocation,

and then be able to automatically claim higher percentages as they perform certain tasks on-chain.

Furthermore, these claimable assets 'expire' if not claimed.

Users have two months (`DurationUntilDecay`) to claim their full airdrop amount.

After two months, the reward amount available will decline over 4 months (`DurationOfDecay`) in real time, until it hits `0%` at 6 months from launch (`DurationUntilDecay + DurationOfDecay`).

After 6 months from launch, all unclaimed tokens get sent to the community pool.

## Contents

1. **[Concept](01_concepts.md)**

2. **[State](02_state.md)**

3. **[Events](03_events.md)**

4. **[Keeper](04_keeper.md)**  

5. **[React Hooks](05_react_hooks.md)**  

6. **[Queries](06_queries.md)**  

7. **[Params](07_params.md)**

## Genesis State

## Actions

All accounts start out with 20% of their entire airdrop allocation.

There are 4 types of actions, each of which release another 20% of the airdrop allocation.

The 4 actions are as follows:

```golang

ActionAddLiquidity  Action = 0

ActionSwap          Action = 1

ActionVote          Action = 2

ActionDelegateStake Action = 3

```

These actions are monitored by registring claim **hooks** to the governance, staking, gamm, and lockup modules.

This means that when you perform an action, the claims module will immediately unlock those coins if they are applicable.

These actions can be performed in any order.

The code is structured by separating out a segment of the tokens as "claimable", indexed by each action type.

So if Alice delegates tokens, the claims module will move the 20% of the claimables associated with staking to her liquid balance.

If she delegates again, there will not be additional tokens given, as the relevant action has already been performed.

Every action must be performed to claim the full amount.

## ClaimRecords

A claim record is a struct that contains data about the claims process of each airdrop recipient.

It contains an address, the initial claimable airdrop amount, and an array of bools representing 

whether each action has been completed. The position in the array refers to enum number of the action.

So for example, `[false, true, true, false]` means that `ActionSwap` and `ActionVote` are completed.

```golang

type ClaimRecord struct {

    // address of claim user

    Address string `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty" yaml:"address"`

    // total initial claimable amount for the user

    InitialClaimableAmount sdk.Coins

    

    // true if action is completed

    // index of bool in array refers to action enum #

    ActionCompleted []bool

}

```

## Params

The airdrop logic has 4 parameters:

```golang

type Params struct {

    // Time that marks the beginning of the airdrop disbursal,

    // should be set to chain launch time.

    AirdropStartTime   time.Time

    DurationUntilDecay time.Duration

    DurationOfDecay    time.Duration

    // denom of claimable asset

    ClaimDenom string

}

```