CW Ownable

Utility for controlling ownership of CosmWasm smart contracts.

How to use

Initialize the owner during instantiation using the initialize_owner method provided by this crate:

```rust use cosmwasmstd::{entrypoint, DepsMut, Env, MessageInfo, Response}; use cw_ownable::OwnershipError;

[entry_point]

pub fn instantiate( deps: DepsMut, env: Env, info: MessageInfo, msg: InstantiateMsg, ) -> Result, OwnershipError> { cwownable::initializeowner(deps.storage, deps.api, msg.owner.asderef())?; Ok(Response::new()) } ```

Use the #[cw_ownable_execute] macro to extend your execute message:

```rust use cosmwasmschema::cwserde; use cwownable::cwownable_execute;

[cwownableexecute]

[cw_serde]

enum ExecuteMsg { Foo {}, Bar {}, } ```

The macro inserts a new variant, UpdateOwnership to the enum:

```rust

[cw_serde]

enum ExecuteMsg { UpdateOwnership(cw_ownable::Action), Foo {}, Bar {}, } ```

Where Action can be one of three:

• Propose to transfer the contract's ownership to another account
• Accept the proposed ownership transfer
• Renounce the ownership, permanently setting the contract's owner to vacant

Handle the messages using the update_ownership function provided by this crate:

```rust use cosmwasmstd::{entrypoint, DepsMut, Env, MessageInfo, Response}; use cwownable::{cwserde, update_ownership, OwnershipError};

[entry_point]

pub fn execute( deps: DepsMut, env: Env, info: MessageInfo, msg: ExecuteMsg, ) -> Result { match msg { ExecuteMsg::UpdateOwnership(action) => { update_ownership(deps, &env.block, &info.sender, action)?; } _ => unimplemneted!(), } Ok(Response::new()) } ```

Use the #[cw_ownable_query] macro to extend your query message:

```rust use cosmwasmschema::{cwserde, QueryResponses}; use cwownable::cwownable_query;

[cwownablequery]

[cw_serde]

[derive(QueryResponses)]

pub enum QueryMsg { #[returns(FooResponse)] Foo {}, #[returns(BarResponse)] Bar {}, } ```

The macro inserts a new variant, Ownership:

```rust

[cw_serde]

[derive(QueryResponses)]

enum ExecuteMsg { #[returns(Ownership)] Ownership {}, #[returns(FooResponse)] Foo {}, #[returns(BarResponse)] Bar {}, } ```

Handle the message using the get_ownership function provided by this crate:

```rust use cosmwasmstd::{entrypoint, Deps, Env, Binary}; use cwownable::getownership;

[entry_point]

pub fn query(deps: Deps, env: Env, msg: QueryMsg) -> StdResult { match msg { QueryMsg::Ownership {} => tobinary(&getownership(deps.storage)?), _ => unimplemented!(), } } ```

License

Contents of this crate at or prior to version 0.5.0 are published under GNU Affero General Public License v3 or later; contents after the said version are published under Apache-2.0 license.