ref: add IPausable trait

Refers #336
OpenZeppelin · Oct 15, 2024 · bb8696b · bb8696b
1 parent 4106d03
commit bb8696b
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 7 deletions.
diff --git a/contracts/src/token/erc20/mod.rs b/contracts/src/token/erc20/mod.rs
@@ -580,10 +580,7 @@ mod tests {
     use stylus_sdk::msg;
 
     use super::{Erc20, Error, IErc20};
-    use crate::{
-        token::erc721::{Erc721, IErc721},
-        utils::introspection::erc165::IErc165,
-    };
+    use crate::utils::introspection::erc165::IErc165;
 
     #[motsu::test]
     fn reads_balance(contract: Erc20) {

diff --git a/contracts/src/utils/pausable.rs b/contracts/src/utils/pausable.rs
@@ -61,13 +61,23 @@ sol_storage! {
     }
 }
 
-#[public]
-impl Pausable {
+/// Required interface of a [`Pausable`] compliant contract.
+pub trait IPausable {
+    /// The error type associated to the trait implementation.
+    type Error: Into<alloc::vec::Vec<u8>>;
+
     /// Returns true if the contract is paused, and false otherwise.
     ///
     /// # Arguments
     ///
     /// * `&self` - Read access to the contract's state.
+    fn paused(&self) -> bool;
+}
+
+#[public]
+impl IPausable for Pausable {
+    type Error = Error;
+
     fn paused(&self) -> bool {
         self._paused.get()
     }
@@ -147,7 +157,7 @@ impl Pausable {
 
 #[cfg(all(test, feature = "std"))]
 mod tests {
-    use crate::utils::pausable::{Error, Pausable};
+    use crate::utils::pausable::{Error, IPausable, Pausable};
 
     #[motsu::test]
     fn paused_works(contract: Pausable) {