Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update README.md #32

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 37 additions & 3 deletions contracts/cw20-merkle-airdrop/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,9 @@ Uses **SHA256** for merkle root tree construction.

```rust
pub struct InstantiateMsg {
pub owner: String,
pub cw20_token_address: String,
pub owner: Option<String>,
pub cw20_token_address: Option<String>,
pub native_token: Option<String>,
}
```

Expand All @@ -60,15 +61,40 @@ pub struct InstantiateMsg {
```rust
pub enum ExecuteMsg {
UpdateConfig {
owner: Option<String>,
new_owner: Option<String>,
new_cw20_address: Option<String>,
new_native_token: Option<String>,
},
RegisterMerkleRoot {
merkle_root: String,
expiration: Option<Expiration>,
start: Option<Scheduled>,
total_amount: Option<Uint128>,
hrp: Option<String>,
},
Claim {
stage: u8,
amount: Uint128,
proof: Vec<String>,
/// Enables cross chain airdrops.
/// Target wallet proves identity by sending a signed [SignedClaimMsg](SignedClaimMsg)
/// containing the recipient address.
sig_info: Option<SignatureInfo>,
},
Burn {
stage: u8,
},
/// Withdraw the remaining tokens after expire time (only owner)
Withdraw {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With recent PR, we added Pause. WithdrawAll and BurnAll messages. would be good to add them as well

stage: u8,
address: String,
},
Pause {
stage: u8,
},
Resume {
stage: u8,
new_expiration: Option<Expiration>,
},
}
```
Expand All @@ -87,6 +113,14 @@ pub enum QueryMsg {
MerkleRoot { stage: u8 },
LatestStage {},
IsClaimed { stage: u8, address: String },
TotalClaimed { stage: u8 },
AccountMap { stage: u8, external_address: String },
AllAccountMaps {
stage: u8,
start_after: Option<String>,
limit: Option<u32>,
},
IsPaused { stage: u8 },
}
```

Expand Down