rename to RequireAuthForPause and require_auth_for_pause

Author: leighmcculloch

soroban-sdk/src/_migrating/v25_contracttrait.rs

@@ -51,33 +51,33 @@
 //! use soroban_sdk::{contract, contractimpl, contracttrait, Address, Env};
 //!
 //! // A regular trait for admin access control - not exported as contract functions
-//! pub trait RequireAdmin {
-//!     fn require_admin(env: &Env);
+//! pub trait RequireAuthForPause {
+//!     fn require_auth_for_pause(env: &Env);
 //! }
 //!
-//! // Define a contracttrait with default implementations that require RequireAdmin
+//! // Define a contracttrait with default implementations that require RequireAuthForPause
 //! #[contracttrait]
-//! pub trait Pausable: RequireAdmin {
+//! pub trait Pausable: RequireAuthForPause {
 //!     fn is_paused(env: &Env) -> bool {
 //!         env.storage().instance().has(&"paused")
 //!     }
 //!
 //!     fn pause(env: &Env) {
-//!         Self::require_admin(env);
+//!         Self::require_auth_for_pause(env);
 //!         env.storage().instance().set(&"paused", &true);
 //!     }
 //!
 //!     fn unpause(env: &Env) {
-//!         Self::require_admin(env);
+//!         Self::require_auth_for_pause(env);
 //!         env.storage().instance().remove(&"paused");
 //!     }
 //! }
 //!
 //! #[contract]
 //! pub struct MyContract;
 //!
-//! impl RequireAdmin for MyContract {
-//!     fn require_admin(env: &Env) {
+//! impl RequireAuthForPause for MyContract {
+//!     fn require_auth_for_pause(env: &Env) {
 //!         let admin: Address = env.storage().instance().get(&"admin").unwrap();
 //!         admin.require_auth();
 //!     }
@@ -146,33 +146,33 @@
 //! use soroban_sdk::{contract, contractimpl, contracttrait, Address, Env};
 //!
 //! // A regular trait for admin access control - not exported as contract functions
-//! pub trait RequireAdmin {
-//!     fn require_admin(env: &Env);
+//! pub trait RequireAuthForPause {
+//!     fn require_auth_for_pause(env: &Env);
 //! }
 //!
-//! // Define a contracttrait with default implementations that require RequireAdmin
+//! // Define a contracttrait with default implementations that require RequireAuthForPause
 //! #[contracttrait]
-//! pub trait Pausable: RequireAdmin {
+//! pub trait Pausable: RequireAuthForPause {
 //!     fn is_paused(env: &Env) -> bool {
 //!         env.storage().instance().has(&"paused")
 //!     }
 //!
 //!     fn pause(env: &Env) {
-//!         Self::require_admin(env);
+//!         Self::require_auth_for_pause(env);
 //!         env.storage().instance().set(&"paused", &true);
 //!     }
 //!
 //!     fn unpause(env: &Env) {
-//!         Self::require_admin(env);
+//!         Self::require_auth_for_pause(env);
 //!         env.storage().instance().remove(&"paused");
 //!     }
 //! }
 //!
 //! #[contract]
 //! pub struct MyContract;
 //!
-//! impl RequireAdmin for MyContract {
-//!     fn require_admin(env: &Env) {
+//! impl RequireAuthForPause for MyContract {
+//!     fn require_auth_for_pause(env: &Env) {
 //!         let admin: Address = env.storage().instance().get(&"admin").unwrap();
 //!         admin.require_auth();
 //!     }
@@ -247,33 +247,33 @@
 //! use soroban_sdk::{contract, contractimpl, contracttrait, Address, Env};
 //!
 //! // A regular trait for admin access control - not exported as contract functions
-//! pub trait RequireAdmin {
-//!     fn require_admin(env: &Env);
+//! pub trait RequireAuthForPause {
+//!     fn require_auth_for_pause(env: &Env);
 //! }
 //!
-//! // Define a contracttrait with default implementations that require RequireAdmin
+//! // Define a contracttrait with default implementations that require RequireAuthForPause
 //! #[contracttrait]
-//! pub trait Pausable: RequireAdmin {
+//! pub trait Pausable: RequireAuthForPause {
 //!     fn is_paused(env: &Env) -> bool {
 //!         env.storage().instance().has(&"paused")
 //!     }
 //!
 //!     fn pause(env: &Env) {
-//!         Self::require_admin(env);
+//!         Self::require_auth_for_pause(env);
 //!         env.storage().instance().set(&"paused", &true);
 //!     }
 //!
 //!     fn unpause(env: &Env) {
-//!         Self::require_admin(env);
+//!         Self::require_auth_for_pause(env);
 //!         env.storage().instance().remove(&"paused");
 //!     }
 //! }
 //!
 //! #[contract]
 //! pub struct MyContract;
 //!
-//! impl RequireAdmin for MyContract {
-//!     fn require_admin(env: &Env) {
+//! impl RequireAuthForPause for MyContract {
+//!     fn require_auth_for_pause(env: &Env) {
 //!         let admin: Address = env.storage().instance().get(&"admin").unwrap();
 //!         admin.require_auth();
 //!     }