Runtime Modules / CapitalDistribution
Spec Version:
Call Functions
Name | Lookup | Parameters | |
|---|---|---|---|
| distribute | 1b00 | 7 | |
| claim | 1b01 | 1 | |
| push_benefit | 1b02 | 2 | |
| reclaim | 1b03 | 1 | |
| remove_distribution | 1b04 | 1 |
Events
Name | Lookup | Attributes | |
|---|---|---|---|
| Created | 1b00 | ["EventDid","CAId","Distribution"] | |
| BenefitClaimed | 1b01 | ["EventDid","EventDid","CAId","Distribution","Balance","Tax"] | |
| Reclaimed | 1b02 | ["EventDid","CAId","Balance"] | |
| Removed | 1b03 | ["EventDid","CAId"] |
Storage Functions
Name | Type | |
|---|---|---|
| Distributions | {"origin":"Map","n_map_type":{"hashers":["Blake2_128Concat"],"key_vec":["pallet_corporate_actions:CAId"],"value":"pallet_corporate_actions:distribution:Distribution","keys_id":158,"value_id":160}} | |
| HolderPaid | {"origin":"Map","n_map_type":{"hashers":["Blake2_128Concat"],"key_vec":["Tuple:pallet_corporate_actions:CAId[U8; 32]"],"value":"Bool","keys_id":628,"value_id":78}} | |
| StorageVersion | {"origin":"PlainType","plain_type":"U8","PlainTypeValue":629} |
Error Types
Name | Docs |
|---|---|
| CANotBenefit | A capital distribution was made for a non-benefit CA. |
| AlreadyExists | A distribution already exists for this CA. |
| ExpiryBeforePayment | A distributions provided expiry date was strictly before its payment date.In other words, everything to distribute would immediately be forfeited. |
| HolderAlreadyPaid | The token holder has already been paid their benefit. |
| NoSuchDistribution | A capital distribution doesn't exist for this CA. |
| CannotClaimBeforeStart | Distribution allotment cannot be claimed as the current time is before start-of-payment. |
| CannotClaimAfterExpiry | Distribution's expiry has passed. DID cannot claim anymore and has forfeited the benefits. |
| BalancePerShareProductOverflowed | Multiplication of the balance with the per share payout amount overflowed. |
| NotDistributionCreator | DID is not the one who created the distribution. |
| AlreadyReclaimed | DID who created the distribution already did reclaim. |
| NotExpired | Distribution had not expired yet, or there's no expiry date. |
| DistributionStarted | A distribution has been activated, as `payment_at <= now` holds. |
| InsufficientRemainingAmount | A distribution has insufficient remaining amount of currency to distribute. |
| DistributionAmountIsZero | Distribution `amount` cannot be zero. |
| DistributionPerShareIsZero | Distribution `per_share` cannot be zero. |