ADO Base

The ADO Base contains all the common functionality applied on all ADOs upon instantiation.

InstantiateMsg

The struct used to hold important information about each instantiated ADO. Implemented as BaseInstantiateMsg.

Rust

pub struct InstantiateMsg {
    pub ado_type: String,
    pub ado_version: String,
    pub kernel_address: String,
    pub owner: Option<String>,
}

Name	Type	Description
ado_type	String	The type of the ADO. Usually, it is the same as the name. It is automatically set when an ADO is instantiated.
ado_version	String	The version of the ADO. It is automatically set when an ADO is instantiated.
kernel_address	Option<String>	The contract address of the kernel ADO responsible for communication between ADOs. Specified by the creator in the instantiation message of an ADO.
owner	Option<String>	The address of the ADO owner. Specified by the creator in the instantiation message of an ADO.

Our ADOs have a set of execute and query messages referred to as the "base executes" and "base queries". These messages are common to every ADO in our Andromeda Digital Library (Except AMP ADOs). They are listed in the AndromedaMsg and AndromedaQuery enums which we will discuss next.

Migrate Message

All of our ADOs contain a migrate message to allowing migrating an ADO to a newer version:

 pub fn migrate(
        &self,
        deps: DepsMut,
        contract_name: &str,
        contract_version: &str,
    ) -> Result<Response, ContractError> {
        // New version
        let version: Version = contract_version.parse().map_err(from_semver)?;

        // Old version
        let stored = get_contract_version(deps.storage)?;
        let storage_version: Version = stored.version.parse().map_err(from_semver)?;
        let contract_name = if contract_name.starts_with("crates.io:andromeda-") {
            contract_name.strip_prefix("crates.io:andromeda-").unwrap()
        } else if contract_name.starts_with("crates.io:") {
            contract_name.strip_prefix("crates.io:").unwrap()
        } else {
            contract_name
        };
        ensure!(
            stored.contract == contract_name,
            ContractError::CannotMigrate {
                previous_contract: stored.contract,
            }
        );

        // New version has to be newer/greater than the old version
        ensure!(
            storage_version < version,
            ContractError::CannotMigrate {
                previous_contract: stored.version,
            }
        );

        set_contract_version(deps.storage, contract_name, contract_version)?;
        Ok(Response::default())
    }