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

// Copyright 2021 Centrifuge Foundation (centrifuge.io).
// This file is part of Centrifuge chain project.

// Centrifuge is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version (see http://www.gnu.org/licenses).

// Centrifuge is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

use cfg_traits::rewards::RewardIssuance;
use frame_support::traits::{fungibles::Mutate, tokens::Preservation};
use parity_scale_codec::{Decode, Encode};
use sp_runtime::{traits::Get, DispatchResult};
use sp_std::{cmp::Eq, marker::PhantomData};

/// Enables rewarding out of thin air, e.g. via minting.
pub struct MintReward<AccountId, Balance, CurrencyId, Currency>(
	PhantomData<(AccountId, Balance, CurrencyId, Currency)>,
);

impl<AccountId, Balance, CurrencyId, Currency> RewardIssuance
	for MintReward<AccountId, Balance, CurrencyId, Currency>
where
	AccountId: Encode + Decode + Eq,
	Currency: Mutate<AccountId, AssetId = CurrencyId, Balance = Balance>,
{
	type AccountId = AccountId;
	type Balance = Balance;
	type CurrencyId = CurrencyId;

	fn issue_reward(
		currency_id: Self::CurrencyId,
		beneficiary: &Self::AccountId,
		amount: Self::Balance,
	) -> DispatchResult {
		Currency::mint_into(currency_id, beneficiary, amount).map(|_| ())
	}
}

/// Enables rewarding from an account address, e.g. the Treasury.
pub struct TransferReward<AccountId, Balance, CurrencyId, Currency, SourceAddress>(
	PhantomData<(AccountId, Balance, CurrencyId, Currency, SourceAddress)>,
);

impl<AccountId, Balance, CurrencyId, Currency, SourceAddress> RewardIssuance
	for TransferReward<AccountId, Balance, CurrencyId, Currency, SourceAddress>
where
	AccountId: Encode + Decode + Eq,
	Currency: Mutate<AccountId, AssetId = CurrencyId, Balance = Balance>,
	SourceAddress: Get<AccountId>,
{
	type AccountId = AccountId;
	type Balance = Balance;
	type CurrencyId = CurrencyId;

	fn issue_reward(
		currency_id: Self::CurrencyId,
		beneficiary: &Self::AccountId,
		amount: Self::Balance,
	) -> DispatchResult {
		Currency::transfer(
			currency_id,
			&SourceAddress::get(),
			beneficiary,
			amount,
			Preservation::Protect,
		)
		.map(|_| ())
	}
}

#[cfg(test)]
mod tests {
	use frame_support::{assert_err, assert_ok};
	use orml_traits::MultiCurrency;

	use super::*;
	use crate::mock::{
		new_test_ext, CurrencyId, Runtime, Tokens, REWARD_SOURCE, USER_A as BENEFICIARY,
		USER_INITIAL_BALANCE,
	};

	type Balance = u64;
	type AccountId = u64;

	frame_support::parameter_types! {
		pub const Source: u64 = REWARD_SOURCE;
		pub const InsufficientFunds: u64 = REWARD_SOURCE - 1;
	}

	const CURRENCY_ID: CurrencyId = CurrencyId::Reward;
	const REWARD_AMOUNT: Balance = 1234;

	#[test]
	fn mint_reward_works() {
		new_test_ext().execute_with(|| {
			assert_eq!(Tokens::free_balance(CURRENCY_ID, &BENEFICIARY), 0);
			assert_eq!(Tokens::total_issuance(CURRENCY_ID), USER_INITIAL_BALANCE);

			assert_ok!(
				MintReward::<AccountId, Balance, CurrencyId, Tokens>::issue_reward(
					CURRENCY_ID,
					&BENEFICIARY,
					REWARD_AMOUNT,
				),
			);
			assert_eq!(
				Tokens::free_balance(CURRENCY_ID, &BENEFICIARY),
				REWARD_AMOUNT
			);
			assert_eq!(
				Tokens::total_issuance(CURRENCY_ID),
				USER_INITIAL_BALANCE + REWARD_AMOUNT
			);
		})
	}

	#[test]
	fn transfer_reward_works() {
		new_test_ext().execute_with(|| {
			let issuance_before = Tokens::total_issuance(CURRENCY_ID);
			assert_eq!(Tokens::free_balance(CURRENCY_ID, &BENEFICIARY), 0);
			assert_eq!(
				Tokens::free_balance(CURRENCY_ID, &REWARD_SOURCE),
				USER_INITIAL_BALANCE
			);

			assert_ok!(TransferReward::<
				AccountId,
				Balance,
				CurrencyId,
				Tokens,
				Source,
			>::issue_reward(CURRENCY_ID, &BENEFICIARY, REWARD_AMOUNT));
			assert_eq!(
				Tokens::free_balance(CURRENCY_ID, &BENEFICIARY),
				REWARD_AMOUNT
			);
			assert_eq!(
				Tokens::free_balance(CURRENCY_ID, &REWARD_SOURCE),
				USER_INITIAL_BALANCE - REWARD_AMOUNT
			);
			assert_eq!(Tokens::total_issuance(CURRENCY_ID), issuance_before);
		})
	}

	#[test]
	fn transfer_reward_missing_funds_throws() {
		new_test_ext().execute_with(|| {
			assert_err!(TransferReward::<
				AccountId,
				Balance,
				CurrencyId,
				Tokens,
				InsufficientFunds,
			>::issue_reward(CURRENCY_ID, &BENEFICIARY, REWARD_AMOUNT), orml_tokens::Error::<Runtime>::BalanceTooLow);
		})
	}
}