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
use anyhow::{bail, Context, Result};
#[cfg(feature = "native")]
use sov_modules_api::macros::CliWalletArg;
use sov_modules_api::CallResponse;
use sov_state::WorkingSet;
use crate::{Amount, Bank, Coins, Token};
/// This enumeration represents the available call messages for interacting with the sov-bank module.
#[cfg_attr(
feature = "native",
derive(serde::Serialize),
derive(serde::Deserialize),
derive(CliWalletArg),
derive(schemars::JsonSchema),
schemars(bound = "C::Address: ::schemars::JsonSchema", rename = "CallMessage")
)]
#[derive(borsh::BorshDeserialize, borsh::BorshSerialize, Debug, PartialEq, Clone)]
pub enum CallMessage<C: sov_modules_api::Context> {
/// Creates a new token with the specified name and initial balance.
CreateToken {
/// Random value use to create a unique token address.
salt: u64,
/// The name of the new token.
token_name: String,
/// The initial balance of the new token.
initial_balance: Amount,
/// The address of the account that the new tokens are minted to.
minter_address: C::Address,
/// Authorized minter list.
authorized_minters: Vec<C::Address>,
},
/// Transfers a specified amount of tokens to the specified address.
Transfer {
/// The address to which the tokens will be transferred.
to: C::Address,
/// The amount of tokens to transfer.
coins: Coins<C>,
},
/// Burns a specified amount of tokens.
Burn {
/// The amount of tokens to burn.
coins: Coins<C>,
},
/// Mints a specified amount of tokens.
Mint {
/// The amount of tokens to mint.
coins: Coins<C>,
/// Address to mint tokens to
minter_address: C::Address,
},
/// Freezes a token so that the supply is frozen
Freeze {
/// Address of the token to be frozen
token_address: C::Address,
},
}
impl<C: sov_modules_api::Context> Bank<C> {
/// Creates a token from a set of configuration parameters.
/// Checks if a token already exists at that address. If so return an error.
#[allow(clippy::too_many_arguments)]
pub fn create_token(
&self,
token_name: String,
salt: u64,
initial_balance: Amount,
minter_address: C::Address,
authorized_minters: Vec<C::Address>,
context: &C,
working_set: &mut WorkingSet<C::Storage>,
) -> Result<C::Address> {
let (token_address, token) = Token::<C>::create(
&token_name,
&[(minter_address, initial_balance)],
&authorized_minters,
context.sender().as_ref(),
salt,
self.tokens.prefix(),
working_set,
)?;
if self.tokens.get(&token_address, working_set).is_some() {
bail!(
"Token {} at {} address already exists",
token_name,
token_address
);
}
self.tokens.set(&token_address, &token, working_set);
Ok(token_address)
}
/// Transfers the set of `coins` to the address specified by `to`.
pub fn transfer(
&self,
to: C::Address,
coins: Coins<C>,
context: &C,
working_set: &mut WorkingSet<C::Storage>,
) -> Result<CallResponse> {
self.transfer_from(context.sender(), &to, coins, working_set)
}
/// Burns the set of `coins`.
///
/// If there is no token at the address specified in the
/// [`Coins`] structure, return an error; on success it updates the total
/// supply of tokens.
pub fn burn(
&self,
coins: Coins<C>,
owner: &C::Address,
working_set: &mut WorkingSet<C::Storage>,
) -> Result<()> {
let context_logger = || format!("Failed to burn coins({}) from owner {}", coins, owner,);
let mut token = self
.tokens
.get_or_err(&coins.token_address, working_set)
.with_context(context_logger)?;
token
.burn(owner, coins.amount, working_set)
.with_context(context_logger)?;
token.total_supply -= coins.amount;
self.tokens.set(&coins.token_address, &token, working_set);
Ok(())
}
/// Burns coins from an externally owned address ("EOA")
pub(crate) fn burn_from_eoa(
&self,
coins: Coins<C>,
context: &C,
working_set: &mut WorkingSet<C::Storage>,
) -> Result<CallResponse> {
self.burn(coins, context.sender(), working_set)?;
Ok(CallResponse::default())
}
/// Mints the `coins`to the address `mint_to_address` using the externally owned account ("EOA") supplied by
/// `context.sender()` as the authorizer.
/// Returns an error if the token address doesn't exist or `context.sender()` is not authorized to mint tokens.
///
/// On success, it updates the `self.tokens` set to store the new balance.
pub fn mint_from_eoa(
&self,
coins: &Coins<C>,
mint_to_address: &C::Address,
context: &C,
working_set: &mut WorkingSet<C::Storage>,
) -> Result<()> {
self.mint(coins, mint_to_address, context.sender(), working_set)
}
/// Mints the `coins` to the address `mint_to_address` if `authorizer` is an allowed minter.
/// Returns an error if the token address doesn't exist or `context.sender()` is not authorized to mint tokens.
///
/// On success, it updates the `self.tokens` set to store the new minted address.
pub fn mint(
&self,
coins: &Coins<C>,
mint_to_address: &C::Address,
authorizer: &C::Address,
working_set: &mut WorkingSet<C::Storage>,
) -> Result<()> {
let context_logger = || {
format!(
"Failed mint coins({}) to {} by authorizer {}",
coins, mint_to_address, authorizer
)
};
let mut token = self
.tokens
.get_or_err(&coins.token_address, working_set)
.with_context(context_logger)?;
token
.mint(authorizer, mint_to_address, coins.amount, working_set)
.with_context(context_logger)?;
self.tokens.set(&coins.token_address, &token, working_set);
Ok(())
}
/// Tries to freeze the token address `token_address`.
/// Returns an error if the token address doesn't exist,
/// otherwise calls the [`Token::freeze`] function, and update the token set upon success.
pub(crate) fn freeze(
&self,
token_address: C::Address,
context: &C,
working_set: &mut WorkingSet<C::Storage>,
) -> Result<CallResponse> {
let context_logger = || {
format!(
"Failed freeze token_address={} by sender {}",
token_address,
context.sender()
)
};
let mut token = self
.tokens
.get_or_err(&token_address, working_set)
.with_context(context_logger)?;
token
.freeze(context.sender())
.with_context(context_logger)?;
self.tokens.set(&token_address, &token, working_set);
Ok(CallResponse::default())
}
}
impl<C: sov_modules_api::Context> Bank<C> {
/// Transfers the set of `coins` from the address `from` to the address `to`.
///
/// Returns an error if the token address doesn't exist.
pub fn transfer_from(
&self,
from: &C::Address,
to: &C::Address,
coins: Coins<C>,
working_set: &mut WorkingSet<C::Storage>,
) -> Result<CallResponse> {
let context_logger = || {
format!(
"Failed transfer from={} to={} of coins({})",
from, to, coins
)
};
let token = self
.tokens
.get_or_err(&coins.token_address, working_set)
.with_context(context_logger)?;
token
.transfer(from, to, coins.amount, working_set)
.with_context(context_logger)?;
Ok(CallResponse::default())
}
/// Helper function used by the rpc method [`balance_of`](Bank::balance_of) to return the balance of the token stored at `token_address`
/// for the user having the address `user_address` from the underlying storage. If the token address doesn't exist, or
/// if the user doesn't have tokens of that type, return `None`. Otherwise, wrap the resulting balance in `Some`.
pub fn get_balance_of(
&self,
user_address: C::Address,
token_address: C::Address,
working_set: &mut WorkingSet<C::Storage>,
) -> Option<u64> {
self.tokens
.get(&token_address, working_set)
.and_then(|token| token.balances.get(&user_address, working_set))
}
/// Get the name of a token by address
pub fn get_token_name(
&self,
token_address: &C::Address,
working_set: &mut WorkingSet<C::Storage>,
) -> Option<String> {
let token = self.tokens.get(token_address, working_set);
token.map(|token| token.name)
}
}
/// Creates a new prefix from an already existing prefix `parent_prefix` and a `token_address`
/// by extending the parent prefix.
pub(crate) fn prefix_from_address_with_parent<C: sov_modules_api::Context>(
parent_prefix: &sov_state::Prefix,
token_address: &C::Address,
) -> sov_state::Prefix {
let mut prefix = parent_prefix.as_aligned_vec().clone().into_inner();
prefix.extend_from_slice(format!("{}", token_address).as_bytes());
sov_state::Prefix::new(prefix)
}