Skip to content

Commit

Permalink
updates to cw-ownable from PR feedback (#2)
Browse files Browse the repository at this point in the history 
* update ownable exports and revert API breaking change

* fully revert update_ownership breaking API change and fix relevant tests
  • Loading branch information
@mintthemoon
mintthemoon authored Aug 13, 2024
1 parent eb4445e commit a094824
Showing 1 changed file with 19 additions and 30 deletions.
49 changes: 19 additions & 30 deletions packages/ownable/src/lib.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
use std::fmt::Display;

use cosmwasm_schema::cw_serde;
use cosmwasm_std::{Addr, Api, Attribute, BlockInfo, StdError, StdResult, Storage};
use cosmwasm_std::{Addr, Api, Attribute, BlockInfo, DepsMut, StdError, StdResult, Storage};
use cw_address_like::AddressLike;
use cw_storage_plus::Item;

Expand Down Expand Up @@ -102,8 +102,7 @@ impl OwnershipStore {
/// Return the updated ownership.
pub fn update_ownership(
&self,
api: &dyn Api,
storage: &mut dyn Storage,
deps: DepsMut,
block: &BlockInfo,
sender: &Addr,
action: Action,
Expand All @@ -112,9 +111,9 @@ impl OwnershipStore {
Action::TransferOwnership {
new_owner,
expiry,
} => self.transfer_ownership(api, storage, sender, &new_owner, expiry),
Action::AcceptOwnership => self.accept_ownership(storage, block, sender),
Action::RenounceOwnership => self.renounce_ownership(storage, sender),
} => self.transfer_ownership(deps.api, deps.storage, sender, &new_owner, expiry),
Action::AcceptOwnership => self.accept_ownership(deps.storage, block, sender),
Action::RenounceOwnership => self.renounce_ownership(deps.storage, sender),
}
}

Expand Down Expand Up @@ -258,8 +257,8 @@ pub enum OwnershipError {
}

/// Storage constant for the contract's ownership
pub const OWNERSHIP_KEY: &str = "ownership";
pub const OWNERSHIP: OwnershipStore = OwnershipStore::new(OWNERSHIP_KEY);
const OWNERSHIP_KEY: &str = "ownership";
const OWNERSHIP: OwnershipStore = OwnershipStore::new(OWNERSHIP_KEY);

/// Set the given address as the contract owner.
///
Expand Down Expand Up @@ -288,13 +287,12 @@ pub fn assert_owner(store: &dyn Storage, sender: &Addr) -> Result<(), OwnershipE
/// Update the contract's ownership info based on the given action.
/// Return the updated ownership.
pub fn update_ownership(
api: &dyn Api,
storage: &mut dyn Storage,
deps: DepsMut,
block: &BlockInfo,
sender: &Addr,
action: Action,
) -> Result<Ownership<Addr>, OwnershipError> {
OWNERSHIP.update_ownership(api, storage, block, sender, action)
OWNERSHIP.update_ownership(deps, block, sender, action)
}

/// Get the current ownership value.
Expand Down Expand Up @@ -347,7 +345,7 @@ impl<T: AddressLike> Ownership<T> {
}

// This is a nice helper, maybe move to dedicated utils package?
pub fn none_or<T: Display>(or: Option<&T>) -> String {
fn none_or<T: Display>(or: Option<&T>) -> String {
or.map_or_else(|| "none".to_string(), |or| or.to_string())
}

Expand Down Expand Up @@ -448,8 +446,7 @@ mod tests {
{
let err = OWNERSHIP
.update_ownership(
&deps.api.clone(),
deps.as_mut().storage,
deps.as_mut(),
&mock_block_at_height(12345),
&jake,
Action::TransferOwnership {
Expand All @@ -465,8 +462,7 @@ mod tests {
{
let ownership = OWNERSHIP
.update_ownership(
&deps.api.clone(),
deps.as_mut().storage,
deps.as_mut(),
&mock_block_at_height(12345),
&larry,
Action::TransferOwnership {
Expand Down Expand Up @@ -502,8 +498,7 @@ mod tests {
{
let err = OWNERSHIP
.update_ownership(
&deps.api.clone(),
deps.as_mut().storage,
deps.as_mut(),
&mock_block_at_height(12345),
&pumpkin,
Action::AcceptOwnership,
Expand All @@ -526,8 +521,7 @@ mod tests {
{
let err = OWNERSHIP
.update_ownership(
&deps.api.clone(),
deps.as_mut().storage,
deps.as_mut(),
&mock_block_at_height(12345),
&jake,
Action::AcceptOwnership,
Expand All @@ -540,8 +534,7 @@ mod tests {
{
let err = OWNERSHIP
.update_ownership(
&deps.api.clone(),
deps.as_mut().storage,
deps.as_mut(),
&mock_block_at_height(69420),
&pumpkin,
Action::AcceptOwnership,
Expand All @@ -554,8 +547,7 @@ mod tests {
{
let ownership = OWNERSHIP
.update_ownership(
&deps.api.clone(),
deps.as_mut().storage,
deps.as_mut(),
&mock_block_at_height(10000),
&pumpkin,
Action::AcceptOwnership,
Expand Down Expand Up @@ -591,8 +583,7 @@ mod tests {
{
let err = OWNERSHIP
.update_ownership(
&deps.api.clone(),
deps.as_mut().storage,
deps.as_mut(),
&mock_block_at_height(12345),
&jake,
Action::RenounceOwnership,
Expand All @@ -605,8 +596,7 @@ mod tests {
{
let ownership = OWNERSHIP
.update_ownership(
&deps.api.clone(),
deps.as_mut().storage,
deps.as_mut(),
&mock_block_at_height(12345),
&larry,
Action::RenounceOwnership,
Expand All @@ -630,8 +620,7 @@ mod tests {
{
let err = OWNERSHIP
.update_ownership(
&deps.api.clone(),
deps.as_mut().storage,
deps.as_mut(),
&mock_block_at_height(12345),
&larry,
Action::RenounceOwnership,
Expand Down

0 comments on commit a094824

Please sign in to comment.