ERC-20 Capped
Extension of ERC-20 that adds a cap to the supply of tokens.
Usage
In order to make ERC-20 Capped
methods supervising the supply of tokens, you need to add them by yourself for your final contract as follows:
use openzeppelin_stylus::token::erc20::{
self,
extensions::{capped, Capped, ICapped},
Erc20, IErc20,
};
#[derive(SolidityError, Debug)]
enum Error {
ExceededCap(capped::ERC20ExceededCap),
InvalidCap(capped::ERC20InvalidCap),
InsufficientBalance(erc20::ERC20InsufficientBalance),
InvalidSender(erc20::ERC20InvalidSender),
InvalidReceiver(erc20::ERC20InvalidReceiver),
InsufficientAllowance(erc20::ERC20InsufficientAllowance),
InvalidSpender(erc20::ERC20InvalidSpender),
InvalidApprover(erc20::ERC20InvalidApprover),
}
impl From<capped::Error> for Error {
fn from(value: capped::Error) -> Self {
match value {
capped::Error::ExceededCap(e) => Error::ExceededCap(e),
capped::Error::InvalidCap(e) => Error::InvalidCap(e),
}
}
}
impl From<erc20::Error> for Error {
fn from(value: erc20::Error) -> Self {
match value {
erc20::Error::InsufficientBalance(e) => {
Error::InsufficientBalance(e)
}
erc20::Error::InvalidSender(e) => Error::InvalidSender(e),
erc20::Error::InvalidReceiver(e) => Error::InvalidReceiver(e),
erc20::Error::InsufficientAllowance(e) => {
Error::InsufficientAllowance(e)
}
erc20::Error::InvalidSpender(e) => Error::InvalidSpender(e),
erc20::Error::InvalidApprover(e) => Error::InvalidApprover(e),
}
}
}
#[entrypoint]
#[storage]
struct Erc20Example {
erc20: Erc20,
capped: Capped,
}
#[public]
#[implements(IErc20<Error = Error>, ICapped)]
impl Erc20Example {
#[constructor]
fn constructor(&mut self, cap: U256) -> Result<(), Error> {
Ok(self.capped.constructor(cap)?)
}
// Add token minting feature.
//
// Make sure to handle `Capped` properly. You should not call
// [`Erc20::_update`] to mint tokens -- it will break the `Capped`
// mechanism.
fn mint(
&mut self,
account: Address,
value: U256,
) -> Result<(), Error> {
let max_supply = self.capped.cap();
// Overflow check required.
let supply = self
.erc20
.total_supply()
.checked_add(value)
.expect("new supply should not exceed `U256::MAX`");
if supply > max_supply {
return Err(capped::Error::ExceededCap(
capped::ERC20ExceededCap {
increased_supply: supply,
cap: max_supply,
},
))?;
}
self.erc20._mint(account, value)?;
Ok(())
}
}
#[public]
impl ICapped for Erc20Example {
fn cap(&self) -> U256 {
self.capped.cap()
}
}
#[public]
impl IErc20 for Erc20Example {
type Error = Error;
fn total_supply(&self) -> U256 {
self.erc20.total_supply()
}
fn balance_of(&self, account: Address) -> U256 {
self.erc20.balance_of(account)
}
fn transfer(
&mut self,
to: Address,
value: U256,
) -> Result<bool, Self::Error> {
Ok(self.erc20.transfer(to, value)?)
}
fn allowance(&self, owner: Address, spender: Address) -> U256 {
self.erc20.allowance(owner, spender)
}
fn approve(
&mut self,
spender: Address,
value: U256,
) -> Result<bool, Self::Error> {
Ok(self.erc20.approve(spender, value)?)
}
fn transfer_from(
&mut self,
from: Address,
to: Address,
value: U256,
) -> Result<bool, Self::Error> {
Ok(self.erc20.transfer_from(from, to, value)?)
}
}