stellar-axelar-std 2.0.0

mod operatable;
mod ownable;
mod pausable;
#[cfg(test)]
mod testdata;
mod upgradable;

pub use operatable::*;
pub use ownable::*;
pub use pausable::*;
pub use upgradable::*;

#[macro_export]
macro_rules! derive_only {
    () => {
        /// Marker trait for interfaces that should not be implemented by using `contractimpl`.
        ///
        /// **DO NOT IMPLEMENT THIS MANUALLY!**
        #[doc(hidden)]
        pub trait DeriveOnly {}
    };
}

/// This submodule encapsulates data keys for the separate interfaces. These keys break naming conventions on purpose.
/// If a contract implements a contract type that would result in a collision with a key defined here,
/// the linter will complain about it. So as long as contracts follow regular naming conventions,
/// there is no risk of collisions.
mod storage {
    #![allow(non_camel_case_types)]

    // add a separate module for each interface with a dedicated data key.
    // Using a single enum could lead to unintentionally breaks of unrelated interfaces,
    // because the key serialization is variant order dependent.

    pub mod operator {
        use soroban_sdk::Address;
        use stellar_axelar_std::contractstorage;

        use crate as stellar_axelar_std;

        #[contractstorage]
        enum OperatorDataKey {
            #[instance]
            #[value(Address)]
            Interfaces_Operator,
        }
    }

    pub mod owner {
        use soroban_sdk::Address;
        use stellar_axelar_std::contractstorage;

        use crate as stellar_axelar_std;

        #[contractstorage]
        enum OwnerDataKey {
            #[instance]
            #[value(Address)]
            Interfaces_Owner,
        }
    }

    pub mod pausable {
        use stellar_axelar_std::contractstorage;

        use crate as stellar_axelar_std;

        #[contractstorage]
        enum PausableDataKey {
            #[instance]
            #[status]
            Interfaces_Paused,
        }
    }

    pub mod migrating {
        use stellar_axelar_std::contractstorage;

        use crate as stellar_axelar_std;

        #[contractstorage]
        enum MigratingDataKey {
            #[instance]
            #[status]
            Interfaces_Migrating,
        }
    }
}