1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
use crate::arithmetic; use codec::{Codec, FullCodec}; pub use frame_support::traits::{BalanceStatus, LockIdentifier}; use sp_runtime::{ traits::{AtLeast32BitUnsigned, MaybeSerializeDeserialize}, DispatchError, DispatchResult, }; use sp_std::{ cmp::{Eq, PartialEq}, convert::{TryFrom, TryInto}, fmt::Debug, result, }; /// Abstraction over a fungible multi-stable-currency system. pub trait Stp258Currency<AccountId> { /// The currency identifier. type CurrencyId: FullCodec + Eq + PartialEq + Copy + MaybeSerializeDeserialize + Debug; /// The balance of an account. type Balance: AtLeast32BitUnsigned + FullCodec + Copy + MaybeSerializeDeserialize + Debug + Default; // Public immutables /// Existential deposit of `currency_id`. fn minimum_balance(currency_id: Self::CurrencyId) -> Self::Balance; /// The total amount of issuance of `currency_id`. fn total_issuance(currency_id: Self::CurrencyId) -> Self::Balance; // The combined balance of `who` under `currency_id`. fn total_balance(currency_id: Self::CurrencyId, who: &AccountId) -> Self::Balance; // The free balance of `who` under `currency_id`. fn free_balance(currency_id: Self::CurrencyId, who: &AccountId) -> Self::Balance; /// A dry-run of `withdraw`. Returns `Ok` iff the account is able to make a /// withdrawal of the given amount. fn ensure_can_withdraw(currency_id: Self::CurrencyId, who: &AccountId, amount: Self::Balance) -> DispatchResult; // Public mutables /// Transfer some amount from one account to another. fn transfer( currency_id: Self::CurrencyId, from: &AccountId, to: &AccountId, amount: Self::Balance, ) -> DispatchResult; /// Add `amount` to the balance of `who` under `currency_id` and increase /// total issuance. fn deposit(currency_id: Self::CurrencyId, who: &AccountId, amount: Self::Balance) -> DispatchResult; /// Remove `amount` from the balance of `who` under `currency_id` and reduce /// total issuance. fn withdraw(currency_id: Self::CurrencyId, who: &AccountId, amount: Self::Balance) -> DispatchResult; /// Same result as `slash(currency_id, who, value)` (but without the /// side-effects) assuming there are no balance changes in the meantime and /// only the reserved balance is not taken into account. fn can_slash(currency_id: Self::CurrencyId, who: &AccountId, value: Self::Balance) -> bool; /// Deduct the balance of `who` by up to `amount`. /// /// As much funds up to `amount` will be deducted as possible. If this is /// less than `amount`,then a non-zero value will be returned. fn slash(currency_id: Self::CurrencyId, who: &AccountId, amount: Self::Balance) -> Self::Balance; } /// Extended `Stp258Currency` with additional helper types and methods. pub trait Stp258CurrencyExtended<AccountId>: Stp258Currency<AccountId> { /// The type for balance related operations, typically signed int. type Amount: arithmetic::Signed + TryInto<Self::Balance> + TryFrom<Self::Balance> + arithmetic::SimpleArithmetic + Codec + Copy + MaybeSerializeDeserialize + Debug + Default; /// Add or remove abs(`by_amount`) from the balance of `who` under /// `currency_id`. If positive `by_amount`, do add, else do remove. fn update_balance(currency_id: Self::CurrencyId, who: &AccountId, by_amount: Self::Amount) -> DispatchResult; } /// A fungible multi-stable-currency system whose accounts can have liquidity /// restrictions. pub trait Stp258CurrencyLockable<AccountId>: Stp258Currency<AccountId> { /// The quantity used to denote time; usually just a `BlockNumber`. type Moment; /// Create a new balance lock on account `who`. /// /// If the new lock is valid (i.e. not already expired), it will push the /// struct to the `Locks` vec in storage. Note that you can lock more funds /// than a user has. /// /// If the lock `lock_id` already exists, this will update it. fn set_lock( lock_id: LockIdentifier, currency_id: Self::CurrencyId, who: &AccountId, amount: Self::Balance, ) -> DispatchResult; /// Changes a balance lock (selected by `lock_id`) so that it becomes less /// liquid in all parameters or creates a new one if it does not exist. /// /// Calling `extend_lock` on an existing lock `lock_id` differs from /// `set_lock` in that it applies the most severe constraints of the two, /// while `set_lock` replaces the lock with the new parameters. As in, /// `extend_lock` will set: /// - maximum `amount` fn extend_lock( lock_id: LockIdentifier, currency_id: Self::CurrencyId, who: &AccountId, amount: Self::Balance, ) -> DispatchResult; /// Remove an existing lock. fn remove_lock(lock_id: LockIdentifier, currency_id: Self::CurrencyId, who: &AccountId) -> DispatchResult; } /// A fungible multi-stable-currency system where funds can be reserved from the user. pub trait Stp258CurrencyReservable<AccountId>: Stp258Currency<AccountId> { /// Same result as `reserve(who, value)` (but without the side-effects) /// assuming there are no balance changes in the meantime. fn can_reserve(currency_id: Self::CurrencyId, who: &AccountId, value: Self::Balance) -> bool; /// Deducts up to `value` from reserved balance of `who`. This function /// cannot fail. /// /// As much funds up to `value` will be deducted as possible. If the reserve /// balance of `who` is less than `value`, then a non-zero second item will /// be returned. fn slash_reserved(currency_id: Self::CurrencyId, who: &AccountId, value: Self::Balance) -> Self::Balance; /// The amount of the balance of a given account that is externally /// reserved; this can still get slashed, but gets slashed last of all. /// /// This balance is a 'reserve' balance that other subsystems use in order /// to set aside tokens that are still 'owned' by the account holder, but /// which are suspendable. fn reserved_balance(currency_id: Self::CurrencyId, who: &AccountId) -> Self::Balance; /// Moves `value` from balance to reserved balance. /// /// If the free balance is lower than `value`, then no funds will be moved /// and an `Err` will be returned to notify of this. This is different /// behavior than `unreserve`. fn reserve(currency_id: Self::CurrencyId, who: &AccountId, value: Self::Balance) -> DispatchResult; /// Moves up to `value` from reserved balance to free balance. This function /// cannot fail. /// /// As much funds up to `value` will be moved as possible. If the reserve /// balance of `who` is less than `value`, then the remaining amount will be /// returned. /// /// # NOTES /// /// - This is different from `reserve`. fn unreserve(currency_id: Self::CurrencyId, who: &AccountId, value: Self::Balance) -> Self::Balance; /// Moves up to `value` from reserved balance of account `slashed` to /// balance of account `beneficiary`. `beneficiary` must exist for this to /// succeed. If it does not, `Err` will be returned. Funds will be placed in /// either the `free` balance or the `reserved` balance, depending on the /// `status`. /// /// As much funds up to `value` will be deducted as possible. If this is /// less than `value`, then `Ok(non_zero)` will be returned. fn repatriate_reserved( currency_id: Self::CurrencyId, slashed: &AccountId, beneficiary: &AccountId, value: Self::Balance, status: BalanceStatus, ) -> result::Result<Self::Balance, DispatchError>; } /// Abstraction over a fungible (single) currency system. pub trait Stp258Asset<AccountId> { /// The balance of an account. type Balance: AtLeast32BitUnsigned + FullCodec + Copy + MaybeSerializeDeserialize + Debug + Default; // Public immutables /// Existential deposit. fn minimum_balance() -> Self::Balance; /// The total amount of issuance. fn total_issuance() -> Self::Balance; /// The combined balance of `who`. fn total_balance(who: &AccountId) -> Self::Balance; /// The free balance of `who`. fn free_balance(who: &AccountId) -> Self::Balance; /// A dry-run of `withdraw`. Returns `Ok` iff the account is able to make a /// withdrawal of the given amount. fn ensure_can_withdraw(who: &AccountId, amount: Self::Balance) -> DispatchResult; // Public mutables /// Transfer some amount from one account to another. fn transfer(from: &AccountId, to: &AccountId, amount: Self::Balance) -> DispatchResult; /// Add `amount` to the balance of `who` and increase total issuance. fn deposit(who: &AccountId, amount: Self::Balance) -> DispatchResult; /// Remove `amount` from the balance of `who` and reduce total issuance. fn withdraw(who: &AccountId, amount: Self::Balance) -> DispatchResult; /// Same result as `slash(who, value)` (but without the side-effects) /// assuming there are no balance changes in the meantime and only the /// reserved balance is not taken into account. fn can_slash(who: &AccountId, value: Self::Balance) -> bool; /// Deduct the balance of `who` by up to `amount`. /// /// As much funds up to `amount` will be deducted as possible. If this is /// less than `amount`,then a non-zero value will be returned. fn slash(who: &AccountId, amount: Self::Balance) -> Self::Balance; } /// Extended `Stp258Asset` with additional helper types and methods. pub trait Stp258AssetExtended<AccountId>: Stp258Asset<AccountId> { /// The signed type for balance related operations, typically signed int. type Amount: arithmetic::Signed + TryInto<Self::Balance> + TryFrom<Self::Balance> + arithmetic::SimpleArithmetic + Codec + Copy + MaybeSerializeDeserialize + Debug + Default; /// Add or remove abs(`by_amount`) from the balance of `who`. If positive /// `by_amount`, do add, else do remove. fn update_balance(who: &AccountId, by_amount: Self::Amount) -> DispatchResult; } /// A fungible single currency system whose accounts can have liquidity /// restrictions. pub trait Stp258AssetLockable<AccountId>: Stp258Asset<AccountId> { /// The quantity used to denote time; usually just a `BlockNumber`. type Moment; /// Create a new balance lock on account `who`. /// /// If the new lock is valid (i.e. not already expired), it will push the /// struct to the `Locks` vec in storage. Note that you can lock more funds /// than a user has. /// /// If the lock `lock_id` already exists, this will update it. fn set_lock(lock_id: LockIdentifier, who: &AccountId, amount: Self::Balance) -> DispatchResult; /// Changes a balance lock (selected by `lock_id`) so that it becomes less /// liquid in all parameters or creates a new one if it does not exist. /// /// Calling `extend_lock` on an existing lock `lock_id` differs from /// `set_lock` in that it applies the most severe constraints of the two, /// while `set_lock` replaces the lock with the new parameters. As in, /// `extend_lock` will set: /// - maximum `amount` fn extend_lock(lock_id: LockIdentifier, who: &AccountId, amount: Self::Balance) -> DispatchResult; /// Remove an existing lock. fn remove_lock(lock_id: LockIdentifier, who: &AccountId) -> DispatchResult; } /// A fungible single currency system where funds can be reserved from the user. pub trait Stp258AssetReservable<AccountId>: Stp258Asset<AccountId> { /// Same result as `reserve(who, value)` (but without the side-effects) /// assuming there are no balance changes in the meantime. fn can_reserve(who: &AccountId, value: Self::Balance) -> bool; /// Deducts up to `value` from reserved balance of `who`. This function /// cannot fail. /// /// As much funds up to `value` will be deducted as possible. If the reserve /// balance of `who` is less than `value`, then a non-zero second item will /// be returned. fn slash_reserved(who: &AccountId, value: Self::Balance) -> Self::Balance; /// The amount of the balance of a given account that is externally /// reserved; this can still get slashed, but gets slashed last of all. /// /// This balance is a 'reserve' balance that other subsystems use in order /// to set aside tokens that are still 'owned' by the account holder, but /// which are suspendable. fn reserved_balance(who: &AccountId) -> Self::Balance; /// Moves `value` from balance to reserved balance. /// /// If the free balance is lower than `value`, then no funds will be moved /// and an `Err` will be returned to notify of this. This is different /// behavior than `unreserve`. fn reserve(who: &AccountId, value: Self::Balance) -> DispatchResult; /// Moves up to `value` from reserved balance to free balance. This function /// cannot fail. /// /// As much funds up to `value` will be moved as possible. If the reserve /// balance of `who` is less than `value`, then the remaining amount will be /// returned. /// /// # NOTES /// /// - This is different from `reserve`. fn unreserve(who: &AccountId, value: Self::Balance) -> Self::Balance; /// Moves up to `value` from reserved balance of account `slashed` to /// balance of account `beneficiary`. `beneficiary` must exist for this to /// succeed. If it does not, `Err` will be returned. Funds will be placed in /// either the `free` balance or the `reserved` balance, depending on the /// `status`. /// /// As much funds up to `value` will be deducted as possible. If this is /// less than `value`, then `Ok(non_zero)` will be returned. fn repatriate_reserved( slashed: &AccountId, beneficiary: &AccountId, value: Self::Balance, status: BalanceStatus, ) -> result::Result<Self::Balance, DispatchError>; } /// Handler for account which has dust, need to burn or recycle it pub trait OnDust<AccountId, CurrencyId, Balance> { fn on_dust(who: &AccountId, currency_id: CurrencyId, amount: Balance); } impl<AccountId, CurrencyId, Balance> OnDust<AccountId, CurrencyId, Balance> for () { fn on_dust(_: &AccountId, _: CurrencyId, _: Balance) {} }