MerkleDistributor¶
Calls¶
add_to_create_whitelist¶
See [Pallet::add_to_create_whitelist].
Attributes¶
| Name | Type |
|---|---|
| account | AccountIdOf<T> |
Python¶
call = substrate.compose_call(
'MerkleDistributor', 'add_to_create_whitelist', {'account': 'AccountId'}
)
charge¶
See [Pallet::charge].
Attributes¶
| Name | Type |
|---|---|
| merkle_distributor_id | T::MerkleDistributorId |
Python¶
call = substrate.compose_call(
'MerkleDistributor', 'charge', {'merkle_distributor_id': 'u32'}
)
claim¶
See [Pallet::claim].
Attributes¶
| Name | Type |
|---|---|
| merkle_distributor_id | T::MerkleDistributorId |
| index | u32 |
| account | <T::Lookup as StaticLookup>::Source |
| amount | u128 |
| merkle_proof | Vec<H256> |
Python¶
call = substrate.compose_call(
'MerkleDistributor', 'claim', {
'account': {
'Address20': '[u8; 20]',
'Address32': '[u8; 32]',
'Id': 'AccountId',
'Index': 'u32',
'Raw': 'Bytes',
},
'amount': 'u128',
'index': 'u32',
'merkle_distributor_id': 'u32',
'merkle_proof': ['scale_info::12'],
}
)
create_merkle_distributor¶
See [Pallet::create_merkle_distributor].
Attributes¶
| Name | Type |
|---|---|
| merkle_root | H256 |
| description | Vec<u8> |
| distribute_currency | T::CurrencyId |
| distribute_amount | T::Balance |
Python¶
call = substrate.compose_call(
'MerkleDistributor', 'create_merkle_distributor', {
'description': 'Bytes',
'distribute_amount': 'u128',
'distribute_currency': {
'BLP': 'u32',
'ForeignAsset': 'u32',
'LPToken': (
(
'ASG',
'BNC',
'KUSD',
'DOT',
'KSM',
'ETH',
'KAR',
'ZLK',
'PHA',
'RMRK',
'MOVR',
),
'u8',
(
'ASG',
'BNC',
'KUSD',
'DOT',
'KSM',
'ETH',
'KAR',
'ZLK',
'PHA',
'RMRK',
'MOVR',
),
'u8',
),
'Lend': 'u8',
'Native': (
'ASG',
'BNC',
'KUSD',
'DOT',
'KSM',
'ETH',
'KAR',
'ZLK',
'PHA',
'RMRK',
'MOVR',
),
'Stable': (
'ASG',
'BNC',
'KUSD',
'DOT',
'KSM',
'ETH',
'KAR',
'ZLK',
'PHA',
'RMRK',
'MOVR',
),
'StableLpToken': 'u32',
'Token': (
'ASG',
'BNC',
'KUSD',
'DOT',
'KSM',
'ETH',
'KAR',
'ZLK',
'PHA',
'RMRK',
'MOVR',
),
'Token2': 'u8',
'VSBond': (
(
'ASG',
'BNC',
'KUSD',
'DOT',
'KSM',
'ETH',
'KAR',
'ZLK',
'PHA',
'RMRK',
'MOVR',
),
'u32',
'u32',
'u32',
),
'VSBond2': (
'u8',
'u32',
'u32',
'u32',
),
'VSToken': (
'ASG',
'BNC',
'KUSD',
'DOT',
'KSM',
'ETH',
'KAR',
'ZLK',
'PHA',
'RMRK',
'MOVR',
),
'VSToken2': 'u8',
'VToken': (
'ASG',
'BNC',
'KUSD',
'DOT',
'KSM',
'ETH',
'KAR',
'ZLK',
'PHA',
'RMRK',
'MOVR',
),
'VToken2': 'u8',
},
'merkle_root': 'scale_info::12',
}
)
emergency_withdraw¶
See [Pallet::emergency_withdraw].
Attributes¶
| Name | Type |
|---|---|
| merkle_distributor_id | T::MerkleDistributorId |
| recipient | <T::Lookup as StaticLookup>::Source |
| amount | T::Balance |
Python¶
call = substrate.compose_call(
'MerkleDistributor', 'emergency_withdraw', {
'amount': 'u128',
'merkle_distributor_id': 'u32',
'recipient': {
'Address20': '[u8; 20]',
'Address32': '[u8; 32]',
'Id': 'AccountId',
'Index': 'u32',
'Raw': 'Bytes',
},
}
)
remove_from_create_whitelist¶
See [Pallet::remove_from_create_whitelist].
Attributes¶
| Name | Type |
|---|---|
| account | AccountIdOf<T> |
Python¶
call = substrate.compose_call(
'MerkleDistributor', 'remove_from_create_whitelist', {'account': 'AccountId'}
)
Events¶
AddToWhiteList¶
add account who can create merkle distributor. \ [account]
Attributes¶
| Name | Type | Composition |
|---|---|---|
| None | T::AccountId |
AccountId |
Claim¶
claim reward. [merkle distributor id, account, balance]
Attributes¶
| Name | Type | Composition |
|---|---|---|
| None | T::MerkleDistributorId |
u32 |
| None | T::AccountId |
AccountId |
| None | u128 |
u128 |
Create¶
create a merkle distributor. \ [merkle distributor id, merkle tree root, total reward balance]
Attributes¶
| Name | Type | Composition |
|---|---|---|
| None | T::MerkleDistributorId |
u32 |
| None | H256 |
scale_info::12 |
| None | T::Balance |
u128 |
RemoveFromWhiteList¶
remove account from the set who can create merkle distributor. \ [account]
Attributes¶
| Name | Type | Composition |
|---|---|---|
| None | T::AccountId |
AccountId |
Withdraw¶
withdraw reward. \ [merkle distributor id, account, balance]
Attributes¶
| Name | Type | Composition |
|---|---|---|
| None | T::MerkleDistributorId |
u32 |
| None | T::AccountId |
AccountId |
| None | T::Balance |
u128 |
Storage functions¶
ClaimedBitMap¶
Python¶
result = substrate.query(
'MerkleDistributor', 'ClaimedBitMap', ['u32', 'u32']
)
Return value¶
'u32'
CreateWhiteSet¶
Accounts in the whitelist can create merkle distributor.
Python¶
result = substrate.query(
'MerkleDistributor', 'CreateWhiteSet', []
)
Return value¶
'scale_info::721'
MerkleDistributorMetadata¶
Python¶
result = substrate.query(
'MerkleDistributor', 'MerkleDistributorMetadata', ['u32']
)
Return value¶
{
'charged': 'bool',
'description': 'Bytes',
'distribute_amount': 'u128',
'distribute_currency': {
'BLP': 'u32',
'ForeignAsset': 'u32',
'LPToken': (
(
'ASG',
'BNC',
'KUSD',
'DOT',
'KSM',
'ETH',
'KAR',
'ZLK',
'PHA',
'RMRK',
'MOVR',
),
'u8',
(
'ASG',
'BNC',
'KUSD',
'DOT',
'KSM',
'ETH',
'KAR',
'ZLK',
'PHA',
'RMRK',
'MOVR',
),
'u8',
),
'Lend': 'u8',
'Native': (
'ASG',
'BNC',
'KUSD',
'DOT',
'KSM',
'ETH',
'KAR',
'ZLK',
'PHA',
'RMRK',
'MOVR',
),
'Stable': (
'ASG',
'BNC',
'KUSD',
'DOT',
'KSM',
'ETH',
'KAR',
'ZLK',
'PHA',
'RMRK',
'MOVR',
),
'StableLpToken': 'u32',
'Token': (
'ASG',
'BNC',
'KUSD',
'DOT',
'KSM',
'ETH',
'KAR',
'ZLK',
'PHA',
'RMRK',
'MOVR',
),
'Token2': 'u8',
'VSBond': (
(
'ASG',
'BNC',
'KUSD',
'DOT',
'KSM',
'ETH',
'KAR',
'ZLK',
'PHA',
'RMRK',
'MOVR',
),
'u32',
'u32',
'u32',
),
'VSBond2': ('u8', 'u32', 'u32', 'u32'),
'VSToken': (
'ASG',
'BNC',
'KUSD',
'DOT',
'KSM',
'ETH',
'KAR',
'ZLK',
'PHA',
'RMRK',
'MOVR',
),
'VSToken2': 'u8',
'VToken': (
'ASG',
'BNC',
'KUSD',
'DOT',
'KSM',
'ETH',
'KAR',
'ZLK',
'PHA',
'RMRK',
'MOVR',
),
'VToken2': 'u8',
},
'distribute_holder': 'AccountId',
'merkle_root': 'scale_info::12',
}
NextMerkleDistributorId¶
Python¶
result = substrate.query(
'MerkleDistributor', 'NextMerkleDistributorId', []
)
Return value¶
'u32'
Constants¶
PalletId¶
Value¶
'0x62662f6d6b6c6473'
Python¶
constant = substrate.get_constant('MerkleDistributor', 'PalletId')
StringLimit¶
The maximum length of a merkel description stored on-chain.
Value¶
50
Python¶
constant = substrate.get_constant('MerkleDistributor', 'StringLimit')
Errors¶
AlreadyInWhiteList¶
Account has already in the set who can create merkle distributor
BadChargeAccount¶
BadDescription¶
Invalid metadata given.
Charged¶
The reward is already charged.
Claimed¶
The reward is already distributed.
InvalidMerkleDistributorId¶
The id is not exist.
MerkleVerifyFailed¶
The proof is invalid
NotInWhiteList¶
Account is no in the set who can create merkle distributor
WithdrawAmountExceed¶
Withdraw amount exceed charge amount.