chore: owner and a few other methods

Author: encody

README.md

@@ -113,7 +113,7 @@ impl Contract {
     }
 
     pub fn owner_only(&self) {
-        Self::require_owner();
+        self.require_owner();
 
         // ...
     }

macros/src/upgrade.rs

@@ -108,7 +108,7 @@ pub fn expand(meta: UpgradeMeta) -> Result<TokenStream, darling::Error> {
         HookBody::Empty => Some(quote! {}), // empty implementation
         HookBody::Custom => None,           // user-provided implementation
         HookBody::Owner => Some(quote! {
-            <Self as #me::owner::Owner>::require_owner();
+            #me::owner::Owner::require_owner(self);
         }),
         HookBody::Role(role) => Some(quote! {
             #me::rbac::Rbac::require_role(self, &#role);

src/escrow.rs

@@ -57,23 +57,23 @@ pub trait EscrowInternal {
     }
 
     /// Inner function to retrieve the slot keyed by it's `Self::Id`
-    fn locked_slot(&self, id: &Self::Id) -> Slot<Self::State> {
+    fn slot_locked(id: &Self::Id) -> Slot<Self::State> {
         Self::root().field(StorageKey::Locked(id))
     }
 
     /// Read the state from the slot
     fn get_locked(&self, id: &Self::Id) -> Option<Self::State> {
-        self.locked_slot(id).read()
+        Self::slot_locked(id).read()
     }
 
     /// Set the state at `id` to `locked`
     fn set_locked(&mut self, id: &Self::Id, locked: &Self::State) {
-        self.locked_slot(id).write(locked);
+        Self::slot_locked(id).write(locked);
     }
 
     /// Clear the state at `id`
     fn set_unlocked(&mut self, id: &Self::Id) {
-        self.locked_slot(id).remove();
+        Self::slot_locked(id).remove();
     }
 }
 

src/owner.rs

@@ -112,12 +112,7 @@ pub trait Owner {
     /// Updates proposed owner without any checks or emitting events.
     fn update_proposed_unchecked(&mut self, new: Option<AccountId>);
 
-    /// Same as require_owner but as a method.
-    fn assert_owner(&self);
-
-    /// Initializes the contract owner. Can only be called once.
-    ///
-    /// Emits an `OwnerEvent::Transfer` event.
+    /// Rejects if the predecessor is not the current owner.
     ///
     /// # Examples
     ///
@@ -131,19 +126,18 @@ pub trait Owner {
     ///
     /// #[near]
     /// impl Contract {
-    ///     #[init]
-    ///     pub fn new(owner_id: AccountId) -> Self {
-    ///         let mut contract = Self {};
-    ///
-    ///         Owner::init(&mut contract, &owner_id);
+    ///     pub fn owner_only_function(&self) {
+    ///         self.require_owner();
     ///
-    ///         contract
+    ///         // ...
     ///     }
     /// }
     /// ```
-    fn init(&mut self, owner_id: &AccountId);
+    fn require_owner(&self);
 
-    /// Requires the predecessor to be the owner.
+    /// Initializes the contract owner. Can only be called once.
+    ///
+    /// Emits an `OwnerEvent::Transfer` event.
     ///
     /// # Examples
     ///
@@ -157,14 +151,17 @@ pub trait Owner {
     ///
     /// #[near]
     /// impl Contract {
-    ///     pub fn owner_only(&self) {
-    ///         Self::require_owner();
+    ///     #[init]
+    ///     pub fn new(owner_id: AccountId) -> Self {
+    ///         let mut contract = Self {};
     ///
-    ///         // ...
+    ///         Owner::init(&mut contract, &owner_id);
+    ///
+    ///         contract
     ///     }
     /// }
     /// ```
-    fn require_owner();
+    fn init(&mut self, owner_id: &AccountId);
 
     /// Removes the contract's owner. Can only be called by the current owner.
     ///
@@ -226,7 +223,7 @@ impl<T: OwnerInternal> Owner for T {
         proposed_owner.set(new.as_ref());
     }
 
-    fn assert_owner(&self) {
+    fn require_owner(&self) {
         require!(
             &env::predecessor_account_id()
                 == Self::slot_owner()
@@ -253,26 +250,15 @@ impl<T: OwnerInternal> Owner for T {
         .emit();
     }
 
-    fn require_owner() {
-        require!(
-            &env::predecessor_account_id()
-                == Self::slot_owner()
-                    .read()
-                    .as_ref()
-                    .unwrap_or_else(|| env::panic_str(NO_OWNER_FAIL_MESSAGE)),
-            ONLY_OWNER_FAIL_MESSAGE,
-        );
-    }
-
     fn renounce_owner(&mut self) {
-        Self::require_owner();
+        self.require_owner();
 
         self.update_proposed(None);
         self.update_owner(None);
     }
 
     fn propose_owner(&mut self, account_id: Option<AccountId>) {
-        Self::require_owner();
+        self.require_owner();
 
         self.update_proposed(account_id);
     }
@@ -312,7 +298,7 @@ pub mod hooks {
         C: Owner,
     {
         fn hook<R>(contract: &mut C, _args: &A, f: impl FnOnce(&mut C) -> R) -> R {
-            contract.assert_owner();
+            contract.require_owner();
             f(contract)
         }
     }
@@ -377,7 +363,7 @@ mod tests {
         }
 
         pub fn owner_only(&self) {
-            Self::require_owner();
+            self.require_owner();
         }
     }
 

src/standard/nep148.rs

@@ -106,7 +106,7 @@ pub trait Nep148ControllerInternal {
     }
 
     /// Returns the storage slot for NEP-148 metadata.
-    fn metadata() -> Slot<FungibleTokenMetadata> {
+    fn slot_metadata() -> Slot<FungibleTokenMetadata> {
         Self::root().field(StorageKey::Metadata)
     }
 }
@@ -126,13 +126,13 @@ pub trait Nep148Controller {
 
 impl<T: Nep148ControllerInternal> Nep148Controller for T {
     fn get_metadata(&self) -> FungibleTokenMetadata {
-        Self::metadata()
+        Self::slot_metadata()
             .read()
             .unwrap_or_else(|| env::panic_str(ERR_METADATA_UNSET))
     }
 
     fn set_metadata(&mut self, metadata: &FungibleTokenMetadata) {
-        Self::metadata().set(Some(metadata));
+        Self::slot_metadata().set(Some(metadata));
     }
 }
 

tests/macros/mod.rs

@@ -76,7 +76,7 @@ mod integration {
         }
 
         pub fn add_value_setter(&mut self, account_id: AccountId) {
-            Self::require_owner();
+            self.require_owner();
 
             self.add_role(&account_id, &Role::CanSetValue);
 
@@ -140,7 +140,7 @@ struct MigrateIntegration {
 
 impl MigrateHook for MigrateIntegration {
     fn on_migrate(old: Integration) -> Self {
-        Self::require_owner();
+        old.require_owner();
         Self::require_unpaused();
 
         Self {
@@ -153,7 +153,7 @@ impl MigrateHook for MigrateIntegration {
 #[near]
 impl MigrateIntegration {
     pub fn add_value_setter(&mut self, account_id: AccountId) {
-        Self::require_owner();
+        self.require_owner();
 
         self.add_role(&account_id, &Role::CanSetValue);
 

tests/macros/owner.rs

@@ -31,7 +31,7 @@ mod implicit_key {
         }
 
         pub fn set_permissioned_item(&mut self, value: u32) {
-            Self::require_owner();
+            self.require_owner();
 
             self.permissioned_item = value;
         }
@@ -76,7 +76,7 @@ impl OwnedStructExplicitKey {
     }
 
     pub fn set_permissioned_item(&mut self, value: u32) {
-        Self::require_owner();
+        self.require_owner();
 
         self.permissioned_item = value;
     }

workspaces-tests/src/bin/upgrade_old_raw.rs

@@ -1,6 +1,6 @@
 workspaces_tests::predicate!();
 
-use near_sdk::{env, near, PanicOnDefault};
+use near_sdk::{env, near, require, PanicOnDefault};
 use near_sdk_contract_tools::{owner::*, upgrade::PostUpgrade, Owner};
 
 #[derive(Owner, PanicOnDefault)]
@@ -30,9 +30,11 @@ impl ContractOld {
 
 #[no_mangle]
 pub fn upgrade() {
-    near_sdk::env::setup_panic_hook();
+    env::setup_panic_hook();
 
-    ContractOld::require_owner();
+    let predecessor = env::predecessor_account_id();
+    let owner = ContractOld::slot_owner().read();
+    require!(Some(predecessor) == owner, "Owner only");
 
     unsafe {
         near_sdk_contract_tools::upgrade::raw::upgrade(PostUpgrade::default());