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 merkledistributor contract #4375

Draft
wants to merge 2 commits into
base: nkysg/compiler-v2-update
Choose a base branch
from
Draft
Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions contrib-contracts/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ stdlib = { workspace = true }
stest = { workspace = true }
starcoin-move-stdlib = { workspace = true }
tempfile = { workspace = true }
starcoin-logger = { workspace = true }

[package]
authors = { workspace = true }
Expand Down
151 changes: 92 additions & 59 deletions contrib-contracts/modules/MerkleDistributor.move
Original file line number Diff line number Diff line change
@@ -1,44 +1,59 @@
address StarcoinAssociation {
module MerkleDistributorScripts {
module StarcoinAssociation::MerkleDistributorScripts {
use StarcoinAssociation::MerkleDistributor;
use StarcoinFramework::Account;
public(script) fun create<T: store>(signer: signer, merkle_root: vector<u8>, token_amounts: u128, leaves: u64) {
let tokens = Account::withdraw<T>(&signer, token_amounts);
MerkleDistributor::create<T>(&signer, merkle_root, tokens, leaves);
use starcoin_framework::coin;
use starcoin_std::signer;

public entry fun create<T>(signer: signer, merkle_root: vector<u8>, coin_amounts: u128, leaves: u64) {
let coins = coin::withdraw<T>(&signer, (coin_amounts as u64));
MerkleDistributor::create<T>(&signer, merkle_root, coins, leaves);
}

public(script) fun claim_for_address<T: store>(distribution_address: address, index: u64, account: address, amount: u128, merkle_proof: vector<vector<u8>>) {
MerkleDistributor::claim_for_address<T>(distribution_address, index, account, amount, merkle_proof);
public entry fun claim_for_address<T>(
signer: signer,
distribution_address: address,
index: u64,
account: address,
amount: u128,
merkle_proof: vector<vector<u8>>
) {
MerkleDistributor::claim_for_address<T>(&signer, distribution_address, index, account, amount, merkle_proof);
}
public(script) fun claim<T: store>(signer: signer, distribution_address: address, index: u64, amount: u128, merkle_proof: vector<vector<u8>>) {
let tokens = MerkleDistributor::claim<T>(&signer, distribution_address, index, amount, merkle_proof);
Account::deposit_to_self<T>(&signer, tokens);

public entry fun claim<T>(
signer: signer,
distribution_address: address,
index: u64,
amount: u128,
merkle_proof: vector<vector<u8>>
) {
let coins = MerkleDistributor::claim<T>(&signer, distribution_address, index, amount, merkle_proof);
let account_addr = signer::address_of(&signer);
coin::deposit<T>(account_addr, coins);
}
}

module MerkleProof {
use StarcoinFramework::Hash;
use StarcoinFramework::Vector;
use StarcoinFramework::Compare;
module StarcoinAssociation::MerkleProof {
use std::hash;
use std::vector;
use starcoin_std::comparator;

/// verify leaf node with hash of `leaf` with `proof` againest merkle `root`.
/// verify leaf node with hash of `leaf` with `proof` against merkle `root`.
public fun verify(proof: &vector<vector<u8>>, root: &vector<u8>, leaf: vector<u8>): bool {
let computed_hash = leaf;
let i = 0;
let proof_length = vector::length(proof);
while(i < proof_length) {
while (i < proof_length) {
let sibling = vector::borrow(proof, i);
// computed_hash is left.
if (Compare::cmp_bytes(&computed_hash,sibling) < 2) {
if (!comparator::is_greater_than(&comparator::compare_u8_vector(computed_hash, *sibling))) {
let concated = concat(computed_hash, *sibling);
computed_hash = Hash::sha3_256(concated);
computed_hash = hash::sha3_256(concated);
} else {
let concated = concat(*sibling, computed_hash);
computed_hash = Hash::sha3_256(concated);

computed_hash = hash::sha3_256(concated);
};

i = i+1;
i = i + 1;
};
&computed_hash == root
}
Expand All @@ -51,28 +66,28 @@ module MerkleProof {
}



module MerkleDistributor {
use StarcoinFramework::Token::{Token, Self};
module StarcoinAssociation::MerkleDistributor {
use StarcoinAssociation::MerkleProof;
use StarcoinFramework::Vector;
use StarcoinFramework::BCS;
// use StarcoinFramework::BitOperators;
use StarcoinFramework::Account;
use StarcoinFramework::Signer;
use StarcoinFramework::Errors;
use StarcoinFramework::Hash;

struct MerkleDistribution<T: store> has key {
use starcoin_framework::coin;
use std::bcs;
use std::error;
use std::hash;
use std::vector;
use starcoin_std::signer;
use starcoin_std::debug;


struct MerkleDistribution<phantom T> has key {
merkle_root: vector<u8>,
tokens: Token<T>,
coins: coin::Coin<T>,
claimed_bitmap: vector<u128>,
}

const INVALID_PROOF: u64 = 1;
const ALREADY_CLAIMED: u64 = 2;

/// Initialization.
public fun create<T: store>(signer: &signer, merkle_root: vector<u8>, tokens: Token<T>, leaves: u64) {
public fun create<T>(signer: &signer, merkle_root: vector<u8>, coins: coin::Coin<T>, leaves: u64) {
let bitmap_count = leaves / 128;
if (bitmap_count * 128 < leaves) {
bitmap_count = bitmap_count + 1;
Expand All @@ -83,58 +98,77 @@ module MerkleDistributor {
vector::push_back(&mut claimed_bitmap, 0u128);
j = j + 1;
};
let distribution = MerkleDistribution{
let distribution = MerkleDistribution {
merkle_root,
tokens,
claimed_bitmap
coins,
claimed_bitmap,
};
move_to(signer, distribution);
}

/// claim for some address.
public fun claim_for_address<T: store>(distribution_address: address, index: u64, account: address, amount: u128, merkle_proof: vector<vector<u8>>)
acquires MerkleDistribution {
public fun claim_for_address<T>(
signer: &signer,
distribution_address: address,
index: u64,
account: address,
amount: u128,
merkle_proof: vector<vector<u8>>
)
acquires MerkleDistribution {
let distribution = borrow_global_mut<MerkleDistribution<T>>(distribution_address);
let claimed_tokens = internal_claim(distribution, index, account, amount, merkle_proof);
Account::deposit(account, claimed_tokens);
let claimed_coins = internal_claim(signer, distribution, index, account, amount, merkle_proof);
coin::deposit(account, claimed_coins);
}

/// claim by myself.
public fun claim<T: store>(signer: &signer, distribution_address: address, index: u64, amount: u128, merkle_proof: vector<vector<u8>>): Token<T>
acquires MerkleDistribution {
public fun claim<T>(
signer: &signer,
distribution_address: address,
index: u64,
amount: u128,
merkle_proof: vector<vector<u8>>
): coin::Coin<T> acquires MerkleDistribution {
let distribution = borrow_global_mut<MerkleDistribution<T>>(distribution_address);
internal_claim(distribution, index, Signer::address_of(signer), amount, merkle_proof)
internal_claim(signer, distribution, index, signer::address_of(signer), amount, merkle_proof)
}

/// Query whether `index` of `distribution_address` has already claimed.
public fun is_claimed<T: store>(distribution_address: address, index: u64): bool
public fun is_claimed<T>(distribution_address: address, index: u64): bool
acquires MerkleDistribution {
let distribution = borrow_global<MerkleDistribution<T>>(distribution_address);
is_claimed_(distribution, index)
}

fun internal_claim<T: store>(distribution: &mut MerkleDistribution<T>, index: u64, account: address, amount: u128, merkle_proof: vector<vector<u8>>): Token<T> {
let claimed = is_claimed_(distribution, index);
assert!(!claimed, Errors::custom(ALREADY_CLAIMED));
fun internal_claim<T>(
signer: &signer,
distribution: &mut MerkleDistribution<T>,
index: u64,
account: address,
amount: u128,
merkle_proof: vector<vector<u8>>
): coin::Coin<T> {
let claimed = is_claimed_(distribution, index);
assert!(!claimed, error::invalid_argument(ALREADY_CLAIMED));

let leaf_data = encode_leaf(&index, &account, &amount);
let verified = MerkleProof::verify(&merkle_proof, &distribution.merkle_root, Hash::sha3_256(leaf_data));
assert!(verified, Errors::custom(INVALID_PROOF));
let verified = MerkleProof::verify(&merkle_proof, &distribution.merkle_root, hash::sha3_256(leaf_data));
assert!(verified, error::invalid_argument(INVALID_PROOF));

set_claimed_(distribution, index);

Token::withdraw(&mut distribution.tokens, amount)
coin::withdraw(signer, (amount as u64))
}

fun is_claimed_<T: store>(distribution: &MerkleDistribution<T>, index: u64): bool {
fun is_claimed_<T>(distribution: &MerkleDistribution<T>, index: u64): bool {
let claimed_word_index = index / 128;
let claimed_bit_index = ((index % 128) as u8);
let word = vector::borrow(&distribution.claimed_bitmap, claimed_word_index);
let mask = 1u128 << claimed_bit_index;
(*word & mask) == mask
}

fun set_claimed_<T: store>(distribution: &mut MerkleDistribution<T>, index: u64) {
fun set_claimed_<T>(distribution: &mut MerkleDistribution<T>, index: u64) {
let claimed_word_index = index / 128;
let claimed_bit_index = ((index % 128) as u8);
let word = vector::borrow_mut(&mut distribution.claimed_bitmap, claimed_word_index);
Expand All @@ -145,10 +179,9 @@ module MerkleDistributor {

fun encode_leaf(index: &u64, account: &address, amount: &u128): vector<u8> {
let leaf = vector::empty();
vector::append(&mut leaf, BCS::to_bytes(index));
vector::append(&mut leaf, BCS::to_bytes(account));
vector::append(&mut leaf, BCS::to_bytes(amount));
vector::append(&mut leaf, bcs::to_bytes(index));
vector::append(&mut leaf, bcs::to_bytes(account));
vector::append(&mut leaf, bcs::to_bytes(amount));
leaf
}
}
}
7 changes: 5 additions & 2 deletions contrib-contracts/src/merkle_distributor_test.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
use anyhow::Result;
use serde::{Deserialize, Serialize};
use starcoin_executor::execute_readonly_function;
use starcoin_logger::prelude::*;
use starcoin_types::account::Account;
use starcoin_types::account_address::AccountAddress;
use starcoin_types::identifier::Identifier;
Expand All @@ -24,11 +25,9 @@ struct DataProof {
}

// XXX FIXME YSG next pr
#[ignore]
#[stest::test]
fn test_merkle_distributor() -> Result<()> {
let association = Account::new_association();
println!("{}", association.address());
let (chain_state, net) = prepare_genesis();
let merkle_data = include_str!("merkle-test.json");
let merkle_data: serde_json::Value = serde_json::from_str(merkle_data)?;
Expand All @@ -41,7 +40,9 @@ fn test_merkle_distributor() -> Result<()> {
let source = include_str!("../modules/MerkleDistributor.move");
let mut dep_libs = starcoin_move_stdlib::move_stdlib_files();
let starcoin_stdlib_files = starcoin_move_stdlib::starcoin_stdlib_files();
let starcoin_framework_files = starcoin_move_stdlib::starcoin_framework_files();
dep_libs.extend(starcoin_stdlib_files);
dep_libs.extend(starcoin_framework_files);
let modules = compile_modules_with_address_ext(association_address(), source, &dep_libs);

let package = Package::new(modules, None)?;
Expand Down Expand Up @@ -78,6 +79,7 @@ fn test_merkle_distributor() -> Result<()> {
&chain_state,
TransactionPayload::EntryFunction(script_function),
)?;
info!("create merkle distributor");
}

// check I'm not claimed.
Expand All @@ -101,6 +103,7 @@ fn test_merkle_distributor() -> Result<()> {
)?;
let is_claimed: bool = bcs_ext::from_bytes(ret[0].as_slice()).unwrap();
assert!(!is_claimed, "should not claimed");
info!("should not claimed");
}

// claim more than what you get should error.
Expand Down
9 changes: 9 additions & 0 deletions vm/framework/move-stdlib/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,21 @@ pub static STARCOIN_STDLIB_SOURCE_FILES: Lazy<SourceFiles> = Lazy::new(|| {
restore_sources(STARCOIN_STDLIB_SOURCES_DIR, "starcoin-stdlib")
.expect("Restore source file error")
});
pub const STARCOIN_FRAMEWORK_SOURCES_DIR: Dir = include_dir!("../starcoin-framework/sources");
pub static STARCOIN_FRAMEWORK_SOURCE_FILES: Lazy<SourceFiles> = Lazy::new(|| {
restore_sources(STARCOIN_FRAMEWORK_SOURCES_DIR, "starcoin-framework")
.expect("Restore source file error")
});
pub fn move_stdlib_files() -> Vec<String> {
MOVE_STDLIB_SOURCE_FILES.files.clone()
}
pub fn starcoin_stdlib_files() -> Vec<String> {
STARCOIN_STDLIB_SOURCE_FILES.files.clone()
}
pub fn starcoin_framework_files() -> Vec<String> {
STARCOIN_FRAMEWORK_SOURCE_FILES.files.clone()
}

//restore the sources files to a tempdir
fn restore_sources(dir: Dir, path: &str) -> anyhow::Result<SourceFiles> {
let temp_dir = tempfile::tempdir()?;
Expand Down
Loading