Struct Ownership

pub struct Ownership<T: AddressLike> {
    pub owner: GovernanceDetails<T>,
    pub pending_owner: Option<GovernanceDetails<T>>,
    pub pending_expiry: Option<Expiration>,
}

The contract’s ownership info

Fields

owner: GovernanceDetails<T>

The contract’s current owner.

pending_owner: Option<GovernanceDetails<T>>

The account who has been proposed to take over the ownership. None if there isn’t a pending ownership transfer.

pending_expiry: Option<Expiration>

The deadline for the pending owner to accept the ownership. None if there isn’t a pending ownership transfer, or if a transfer exists and it doesn’t have a deadline.

Implementations

impl<T: AddressLike> Ownership<T>

pub fn into_attributes(self) -> Vec<Attribute>

Serializes the current ownership state as attributes which may be used in a message response. Serialization is done according to the std::fmt::Display implementation for T and cosmwasm_std::Expiration (for pending_expiry). If an ownership field has no value, "none" will be serialized.

Attribute keys used:

• owner
• pending_owner
• pending_expiry

Callers should take care not to use these keys elsewhere in their response as CosmWasm will override reused attribute keys.

Example

use abstract_std::objects::{ownership::Ownership, gov_type::GovernanceDetails};
use cw_utils::Expiration;
use cosmwasm_std::Attribute;

let ownership = Ownership {
        owner: GovernanceDetails::Monarchy{ monarch: "blue".to_owned() },
        pending_owner: None,
        pending_expiry: Some(Expiration::Never {})
};
assert_eq!(
    ownership.into_attributes(),
    vec![
        Attribute::new("owner", "monarch"),
        Attribute::new("pending_owner", "none"),
        Attribute::new("pending_expiry", "expiration: never")
    ],
)

pub fn assert_owner_can_change(&self) -> Result<(), GovOwnershipError>

Assert current owner supports governance change

Trait Implementations

impl<T: Clone + AddressLike> Clone for Ownership<T>

fn clone(&self) -> Ownership<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug + AddressLike> Debug for Ownership<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Ownership<T>

where T: Deserialize<'de> + AddressLike,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: AddressLike + JsonSchema> JsonSchema for Ownership<T>

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl<T: PartialEq + AddressLike> PartialEq for Ownership<T>

fn eq(&self, other: &Ownership<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Serialize for Ownership<T>

where T: Serialize + AddressLike,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: AddressLike> StructuralPartialEq for Ownership<T>