Campaign

Search…
Campaign
The Campaign Contract manages campaign information, reward information, and participation history. In addition, participation in the campaign and payment of rewards are also made in the Campaign Contract. Rewards are divided into participation rewards and referral rewards, and VKR is used for referral rewards by default.
To set participation conditions except deposit, you must use qualifier. For the implementation of Qualifier, refer to next document.
When instantiating a Campaign Contract, the CampaignManager's CampaignInstatntiateMsg is used
CampaignConfigMsg
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
2
pub struct CampaignConfigMsg {
3
    pub title: String,
4
    pub description: String,
5
    pub url: String,
6
    pub parameter_key: String,
7
    pub participation_reward_denom: Denom,
8
    pub participation_reward_amount: Uint128,
9
    pub referral_reward_amounts: Vec<Uint128>,
10
}
Copied!
1
{
2
  "title": "...",
3
  "description": "...",
4
  "url": "...",  
5
  "parameter_key": "...",
6
  "participation_reward_denom": {
7
      "native":"..",
8
      "token":"...",
9
    },
10
  "participation_reward_amount":[1000]
11
  "referral_reward_amounts":[200,100]
12
}
Copied!
Key
Type
Description
title
String
Campaign title
description
String
Campaign description
url
String
Campaign site url
parameter_key
String
Query parameter key to contain referral information
participation_reward_denom
Denom
Participation reward denom
participation_reward_amount
Uint128
Participation reward quantity
referral_reward_amount
Vec<Uint128>
Referral reward scheme
ExecuteMsg
UpdateCampaignInfo
Updates the configuration for the Campaign information (title, url, description)
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
2
#[serde(rename_all = "snake_case")]
3
pub enum ExecuteMsg {
4
    UpdateCampaignConfig {
5
        title: Option<String>,
6
        description: Option<String>,
7
        url: Option<String>,
8
        parameter_key: Option<String>,
9
        deposit_amount: Option<Uint128>,
10
        deposit_lock_period: Option<u64>,
11
        qualifier: Option<String>,
12
        qualification_description: Option<String>,        
13
        executions: Option<Vec<ExecutionMsg>>,
14
        admin: Option<String>,
15
    }
16
}
Copied!
1
{
2
  "update_campaign_info": {
3
      "title":"..."
4
      "description": "...",
5
      "url":"https://...:",
6
      "parameter_key":"...",
7
      "deposit_amount":100,
8
      "deposit_lock_period":7,
9
      "qualifier":"terra1...",
10
      "qualification_description":"this is..",
11
      "executions":[ ],
12
      "admin":"terra1..."                
13
  }
14
}
Copied!
Key
Type
Description
title*
String
Campaign title
description*
String
Campaign description
url*
String
Campaign site url
parameter_key*
String
Query parameter key to contain referral information
deposit_amount*
Uint128
The amount of deposit required to participate in the campaign
deposit_lock_period*
u64
The period from participate in the campaign until withdraw
qualifier*
String
The qualifier contract address used for validation in the campaign
qualification_description
String
Campaign participation conditions text description
executions*
Vec<ExecutionMsg>
Messages to be executed when participating in the campaign
admin*
String
The admin address with the right to edit the settings for the campaign
* = optional
UpdateRewardConfig
One can configure the participation and referral rewards scheme
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
2
#[serde(rename_all = "snake_case")]
3
pub enum ExecuteMsg {
4
    UpdateRewardConfig {
5
        participation_reward_amount: Option<Uint128>,
6
        referral_reward_amounts: Option<Vec<Uint128>>,
7
    }
8
}
Copied!
1
{
2
  "update_reward_config": {
3
    "participation_reward_amount": 1000,
4
    "referral_reward_amounts":[50,30]
5
  }
6
}
Copied!
Key
Type
Description
participation_reward_amount*
Uint128
Participation reward amount
referral_reward_amount*
Vec<Uint128>
Referral reward scheme
* = optional
UpdateActivation
..
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
2
#[serde(rename_all = "snake_case")]
3
pub enum ExecuteMsg {
4
    UpdateActivation {
5
        active: bool,
6
    }
7
}
Copied!
1
{
2
  "update_activation": {
3
    "active": true
4
  }
5
}
Copied!
Key
Type
Description
active
bool
Campaign activation change
SetNoQulification
Set when there is no Qualification Contract
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
2
#[serde(rename_all = "snake_case")]
3
pub enum ExecuteMsg {
4
    SetNoQualification {},
5
}
Copied!
1
{
2
  "set_no_qualification": {}
3
}
Copied!
AddRewardPool
A message to add a reward to the campaign pool. a minimum Referral rewards ratio 20% must be maintained on the contract. **When executing the message, 1% of the total additional rewards (participation reward + shared reward) is used as a commission..**(Approximate value in UST)
CW20 executes AddRewardPool Message after granting permission with Allowance without sending with Send/Transfer.
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
2
#[serde(rename_all = "snake_case")]
3
pub enum ExecuteMsg {
4
   AddRewardPool {
5
        participation_reward_amount: Uint128,
6
        referral_reward_amount: Uint128,
7
    }
8
}
Copied!
1
{
2
  "add_reward_pool": {
3
    "participation_reward_amount": 1000,
4
    "referral_reward_amounts":200
5
  }
6
}
Copied!
Key
Type
Description
participation_reward_amount
Uint128
Participation reward amount
referral_reward_amount
Uint128
Referral reward amount
RemoveRewardPool
A message that subtracts the added reward with the AddRewardPool message. A fee of 10% is applied when removing
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
2
#[serde(rename_all = "snake_case")]
3
pub enum ExecuteMsg {
4
    RemoveRewardPool {
5
        denom: Denom,
6
        amount: Option<Uint128>,
7
    },
8
}
Copied!
1
{
2
  "remove_reward_pool": {
3
    "denom": {
4
      "native":"..",
5
      "token":"...",
6
    },
7
    "amount": 100
8
  }
9
}
Copied!
Key
Type
Description
denom
Denom
The denomination of the token requesting withdrawal
amount*
Uint128
The withdrawal amount (default = [withdrawable_balance])
* = optional
RemoveIrregularRewardPool
Used when withdrawing deposit errors
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
2
#[serde(rename_all = "snake_case")]
3
pub enum ExecuteMsg {
4
    RemoveIrregularRewardPool {
5
        denom: Denom,
6
    },
7
}
Copied!
1
{
2
  "remove_irregular_reward_pool": {
3
    "denom": {
4
      "native":"..",
5
      "token":"...",
6
    }
7
  }
8
}
Copied!
Key
Type
Description
denom
Denom
Destination address of withdrawing request
ClaimParticipationReward
When Users claim their participation reward
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
2
#[serde(rename_all = "snake_case")]
3
pub enum ExecuteMsg {
4
     ClaimParticipationReward {},
5
}
Copied!
1
{
2
  "claim_participation_reward": {}
3
}
Copied!
ClaimReferralReward
When Users claim their referral reward
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
2
#[serde(rename_all = "snake_case")]
3
pub enum ExecuteMsg {
4
    ClaimReferralReward {}
5
}
Copied!
1
{
2
  "claim_referral_reward": {}
3
}
Copied!
Participate
Participation Message
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
2
#[serde(rename_all = "snake_case")]
3
pub enum ExecuteMsg {
4
    Participate {
5
        actor: String,
6
        referrer: Option<Referrer>,
7
    },
8
}
9
​
10
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
11
#[serde(rename_all = "snake_case")]
12
pub enum Referrer {
13
    Address(String),
14
    Compressed(String),
15
}
Copied!
1
{
2
  "participate": {
3
    "actor":"terra1..."
4
    "referrer": {
5
      "address":"terra1...",
6
      "compressed":"...",
7
    },
8
  }
9
}
Copied!
Key
Type
Description
actor
String
User wallet address
referrer*
Referrer
Referrer's wallet address
* = optional
Deposit
When you deposit and participate in the tokens used to participate in the campaign, you are locked by lock_period.
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
2
#[serde(rename_all = "snake_case")]
3
pub enum ExecuteMsg {
4
    Deposit {},
5
}
Copied!
1
{
2
  "deposit": {}
3
}
Copied!
Withdraw
Withdrawal (only unlocked amount)
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
2
#[serde(rename_all = "snake_case")]
3
pub enum ExecuteMsg {
4
    Withdraw {
5
        amount: Uint128,
6
    },
7
}
Copied!
1
{
2
  "withdraw": {
3
    "amount" : 100
4
  }
5
}
Copied!
Key
Type
Description
amount
Uint128
Withdrawal amount
Receive Hooks
Deposit
Message used to deposit when using CW20 tokens as deposit
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
2
#[serde(rename_all = "snake_case")]
3
pub enum Cw20HookMsg {
4
    Deposit {}
5
}
Copied!
1
{
2
  "deposit": {}
3
}
Copied!
QueryMsg
CampaignConfig
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
2
#[serde(rename_all = "snake_case")]
3
pub enum QueryMsg {
4
    CampaignConfig {}
5
}
Copied!
1
{
2
  "campaign_config": {}
3
}
Copied!
Response
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, PartialEq, JsonSchema)]
2
pub struct CampaignConfigResponse {
3
    pub governance: String,
4
    pub campaign_manager: String,
5
    pub title: String,
6
    pub description: String,
7
    pub url: String,
8
    pub parameter_key: String,
9
    pub deposit_denom: Option<Denom>,
10
    pub deposit_amount: Uint128,
11
    pub deposit_lock_period: u64,
12
    pub qualifier: Option<String>,
13
    pub qualification_description: Option<String>,
14
    pub executions: Vec<ExecutionMsg>,
15
    pub admin: String,
16
    pub creator: String,
17
    pub created_at: Timestamp,
18
}
Copied!
1
{
2
    "config_response": {
3
        "governance":"terra1...",
4
        "campaign_manager":"terra1",
5
        "title": "test",
6
        "description": "descripton",
7
        "url": "https://event.valkyrieprotocol.io",
8
        "parameter_key": "ref",
9
        "deposit_denom": {
10
          "native":"..",
11
          "token":"...",
12
        },
13
        "deposit_amount":100,
14
        "deposit_lock_period":7,
15
        "qualifier": 10,
16
        "qualification_description": "This is...",
17
        "executions":["terra1..."],
18
        "admin": "terra1....",
19
        "creator": "terra1....",
20
        "created_at": 231234512,
21
    }
22
}
Copied!
Key
Type
Description
governance
String
Contract address of governance
campaign_manager
String
Contract address of campaign-manager
title
String
Campaign title
description
String
Campaign description
url
String
Campaign site url
parameter_key
String
Query parameter key to contain referral information
deposit_denom*
Denom
Deposit required to participate in the campaign denom
deposit_amount
Uint128
The amount of amount required to participate in the campaign
deposit_lock_period
u64
The period from participate in the campaign until withdraw
qualifier
String
The qualifier contract address used for validation in the campaign
qualification_description
String
Campaign participation conditions text description
executions
Vec<ExecutionMsg>
Messages to be executed when participating in the campaign
admin
String
The admin address with the right to edit the settings for the campaign
creator
String
Wallet address where the campaign was created
created_at
Timestamp
Campaign creation time
RewardConfig
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
2
#[serde(rename_all = "snake_case")]
3
pub enum QueryMsg {
4
    RewardConfig {}
5
}
Copied!
1
{
2
  "reward_config": {}
3
}
Copied!
Response
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, PartialEq, JsonSchema)]
2
pub struct RewardConfigResponse {
3
    pub participation_reward_denom: Denom,
4
    pub participation_reward_amount: Uint128,
5
    pub referral_reward_token: String,
6
    pub referral_reward_amounts: Vec<Uint128>,
7
}
Copied!
1
{
2
    "reward_config_response": {
3
        "participation_reward_denom":{
4
          "native":"..",
5
          "token":"...",
6
        },
7
        "participation_reward_amount":1000,
8
        "referral_reward_token": "terra1...."
9
        "referral_reward_amounts": [100,50]
10
    }
11
}
Copied!
Key
Type
Description
participation_reward_denom
Denom
Participation reward denom
participation_reward_amount
Uint128
Participation reward amount
referral_reward_token
String
Referral reward token address
referral_reward_amount
Vec<Uint128>
Referral reward scheme
CampaignState
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
2
#[serde(rename_all = "snake_case")]
3
pub enum QueryMsg {
4
    CampaignState {}
5
}
Copied!
1
{
2
  "campaign_state": {}
3
}
Copied!
Response
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, PartialEq, JsonSchema)]
2
pub struct CampaignStateResponse {
3
    pub actor_count: u64,
4
    pub participation_count: u64,
5
    pub cumulative_participation_reward_amount: Uint128,
6
    pub cumulative_referral_reward_amount: Uint128,
7
    pub locked_balances: Vec<(Denom, Uint128)>,
8
    pub balances: Vec<(Denom, Uint128)>,
9
    pub is_active: bool,
10
    pub is_pending: bool,
11
}R
Copied!
1
{
2
    "campaign_state_response": {
3
        "actor_count":48,
4
        "participation_count":100,
5
        "cumulative_participation_reward_amount": 10000,
6
        "cumulative_referral_reward_amount": 10000,
7
        "locked_balances": [(ust,1000),(VKR,100)],
8
        "balances": [(ust,1000),(VKR,100)],
9
        "is_active": "yes",
10
        "is_pending": "no"
11
    }
12
}
Copied!
Key
Type
Description
actor_count
u64
Participant count
participation_count
u64
Participation count
cumulative_participation_reward_amount
Uint128
Cumulative participation reward sum
cumulative_referral_reward_amount
Uint128
Cumulative shared referral sum
locked_balances
Vec<(Denom, Uint128)>
Amount that cannot be withdrawn due to unrecoverable rewards, etc.
balances
Vec<(Denom, Uint128)>
Contract balance deposited with normal addRewardPool message
is_active
bool
Active state
is_pending
bool
Whether on standby
*Standby = never active
ShareUrl
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
2
#[serde(rename_all = "snake_case")]
3
pub enum QueryMsg {
4
    ShareUrl {
5
        address: String,
6
    }
7
}
Copied!
1
{
2
  "share_url": {
3
    "address" : "terra1..."
4
  }
5
}
Copied!
Key
Type
Description
address
String
Wallet address of actor
Response
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, PartialEq, JsonSchema)]
2
pub struct ShareUrlResponse {
3
    pub address: String,
4
    pub compressed: String,
5
    pub url: String,
6
}
Copied!
1
{
2
    "share_url_response": {
3
        "address":"terra1...",
4
        "compressed":"....",
5
        "url": "https://...",        
6
    }
7
}
Copied!
Key
Type
Description
address
String
Wallet address
compressed
String
Compressed user address
url
Uint128
Share url
GetAddressFromReferrer
QueryMsg to get the original wallet address if not Referrer::Address
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
2
#[serde(rename_all = "snake_case")]
3
pub enum QueryMsg {
4
    GetAddressFromReferrer {
5
        referrer: Referrer,
6
    }
7
}
Copied!
1
{
2
  "get_address_from_referrer": {
3
      "referrer" : {
4
          "address":"terra1...",
5
          "compressed":"...",
6
      }
7
  }
8
}
Copied!
Key
Type
Description
referrer
Referrer
Referrer
Response
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, PartialEq, JsonSchema)]
2
pub struct GetAddressFromReferrerResponse {
3
    pub address: String,
4
}
Copied!
1
{
2
    "get_address_from_referrer_response": {
3
        "address":"terra1..."
4
    }
5
}
Copied!
Key
Type
Description
address
String
Wallet address of User
ReferralRewardLimitAmount
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
2
#[serde(rename_all = "snake_case")]
3
pub enum QueryMsg {
4
    ReferralRewardLimitAmount {
5
        address: String,
6
    },
7
}
Copied!
1
{
2
  "referral_reward_limit_amount": {
3
      "address" : "terra1..."
4
  }
5
}
Copied!
Key
Type
Description
address
String
Wallet address of User
Response
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, PartialEq, JsonSchema)]
2
pub struct ReferralRewardLimitAmount {
3
    pub address: String,
4
    pub limit_amount: Uint128,
5
    pub base_limit_amount: Uint128,
6
    pub actor_limit_amount: Uint128,
7
}
Copied!
1
{
2
    "referral_reward_limit_amount_response": {
3
        "address":"terra1...",
4
        "limit_amount":100,
5
        "base_limit_amount":100,
6
        "actor_limit_amount":1000,                
7
    }
8
}
Copied!
Key
Type
Description
address
String
Wallet address
limit_amount
Uint128
Applied limit
base_limit_amount
Uint128
Minimum limit
actor_limit_amount
Uint128
Original limit
Actor
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
2
#[serde(rename_all = "snake_case")]
3
pub enum QueryMsg {
4
    Actor {
5
        address: String,
6
    }
7
}
Copied!
1
{
2
  "actor": {
3
      "address" : "terra1..."
4
  }
5
}
Copied!
Key
Type
Description
address
String
Wallet address of actor
Response
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, PartialEq, JsonSchema)]
2
pub struct ActorResponse {
3
    pub address: String,
4
    pub referrer_address: Option<String>,
5
    pub participation_reward_amount: Uint128,
6
    pub referral_reward_amount: Uint128,
7
    pub cumulative_participation_reward_amount: Uint128,
8
    pub cumulative_referral_reward_amount: Uint128,    
9
    pub participation_count: u64,
10
    pub referral_count: u64,
11
    pub last_participated_at: Timestamp,
12
}
Copied!
1
{
2
    "actor_response": {
3
        "address":"terra1...",
4
        "referrer_address":"terra1...",
5
        "participation_reward_amount":74,
6
        "referral_reward_amount":100,
7
        "cumulative_participation_reward_amount":10000,
8
        "cumulative_referral_reward_amount":10000,                
9
        "participation_count":7,
10
        "referral_count":5,
11
        "last_participated_at":"",
12
    }
13
}
Copied!
Key
Type
Description
address
String
Wallet address of actor
referrer_address*
String
Wallet address of Referrer
participation_reward_amount
Uint128
Amount of recoverable rewards received by participating
referral_reward_amount
Uint128
Amount of recoverable rewards received through referrals
cumulative_participation_reward_amount
Uint128
Cumulative Participation Rewards
cumulative_referral_reward_amount
Uint128
Cumulative Referral Rewards
participation_count
u64
Participation count
referral_count
u64
Number of referrals
last_participated_at
Timestamp
Last participation time
Actors
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
2
#[serde(rename_all = "snake_case")]
3
pub enum QueryMsg {
4
    Actors {
5
        start_after: Option<String>,
6
        limit: Option<u32>,
7
        order_by: Option<OrderBy>,
8
    }
9
}
Copied!
1
{
2
  "actors": {
3
      "start_after" : {},
4
      "limit":20,
5
      "order_by":"dec"
6
  }
7
}
Copied!
Key
Type
Description
start_after*
String
Wallet address to start query at
limit*
u32
Maximum number of query entries
order_by*
OrderBy
Order to make query
Response
Rust
JSON
1
#[derive(Serialize, Deserialize, Clone, PartialEq, JsonSchema)]
2
pub struct ActorsResponse {
3
    pub actors: Vec<ActorResponse>,
4
}
Copied!
1
{
2
    "actors": [{
3
        "address":"terra1...",
4
        "referrer_address":"terra1...",
5
        "partic