AndromedaMsg V1.0.0

The set of execute messages common to all ADOs in the Andromeda Logic Library.

AndromedaMsg

All of the ADOs can call most of the base execute messages found in the AndromedaMsg enum.

AMP ADOs are the only ADOs that do not implement the AndromedaMsg base executes.

Rust

#[cw_serde]
pub enum AndromedaMsg {
    Ownership(OwnershipMessage),
    
    UpdateAppContract {
        address: String,
    },
    
    UpdateKernelAddress {
        address: Addr,
    },
    
    #[serde(rename = "amp_receive")]
    AMPReceive(AMPPkt),
    Permissioning(PermissioningMessage),
    }
}

All the ADOs can execute:

• Ownership messages
• UpdateAppContract
• UpdateKernelAddress
• AMPReceive
• Permissioning messages

Ownership

Messages related to the ownership of an ADO.

Rust

pub enum AndromedaMsg {
   Ownership(OwnershipMessage),
}

OwnershipMessage

The enum containing the different ownership message options.

pub enum OwnershipMessage {
    UpdateOwner {
        new_owner: Addr,
        expiration: Option<MillisecondsExpiration>,
    },
    RevokeOwnershipOffer,
    AcceptOwnership,
    Disown,
}

UpdateOwner

Offers the ADO's ownership to the specified new_owner. Once the offer has been made, the new_owner address can call AcceptOwnership to accept becoming the owner of the ADO.

Only available to the current ADO owner.

Only one offer can be made at a time.

Rust

pub enum OwnershipMessage {
  UpdateOwner {
        new_owner: Addr,
        expiration: Option<MillisecondsExpiration>,
    },
 }

JSON

{
"ownership":{
    "update_owner":{
        "new_owner":"andr1...",
        "expiration": 173493923498234
        }
    }
}

Name	Type	Description
new_owner	Addr	The address to offer ownership to.
expiration	Option<MillisecondsExpiration>	An optional expiration to the ownership offer. Uses a Timestamp in milliseconds.

AcceptOwnership

Accepts the offer to become the new owner of the ADO.

Only an address that has an offer can accept it.

Rust

pub enum OwnershipMessage {
 AcceptOwnership
}

JSON

{
"ownership":{
    "accept_ownership":{}
   }
}

RevokeOwnershipOffer

Removes any previously placed offer by the current ADO owner.

Only available to the current ADO owner.

Rust

pub enum OwnershipMessage {
 RevokeOwnershipOffer 
}

JSON

{
"ownership":{
    "revoke_ownership_offer":{}
   }
}

Disown

Removes ownership from the current ADO owner.

Only available to the contract owner.

Once disowned, an ADO can never have an owner again.

Rust

pub enum OwnershipMessage {
 Disown 
}

JSON

{
"ownership":{
    "disown":{}
    }
}

---

UpdateAppContract

Updates the referenced App contract of an ADO. This allows the ADO to reference by name the components of the new App contract.

Only available to the ADO owner.

Rust

pub enum AndromedaMsg {
  UpdateAppContract {
        address: String,
        },
    }

JSON

{
"update_app_contract":{
    "address":"andr1..."
    }
}

Name	Type	Description
address	String	The address of the new App contract.

UpdateKernelAddress

Updates the Kernel used by the ADO.

Only available to the ADO owner.

Rust

pub enum AndromedaMsg {
    UpdateKernelAddress {
        address: Addr,
    }
}

JSON

{
"update_kernel_address":{
    "address":"andr1..."
    }
}

Name	Type	Description
address	Addr	The contract address of the new kernel to be used by the ADO.

AMPReceive

This message is not called by the user, but is the case that handles receiving AMP messsages from the Kernel. It first verifies the AMP packet and then proceeds to execute the attached execute messges. The AMP packet is verified by checking the following:

1. The origin matches the sender

2. The sender is the kernel

3. The sender has a code ID stored within the ADODB (and as such is a valid ADO)

Permissioning

Messages related to the permissioning of an ADO.

Rust

pub enum AndromedaMsg {
   Permissioning(PermissioningMessage),
}

PermissioningMessage

pub enum PermissioningMessage {
  PermissionAction {
        action: String,
    },
    SetPermission {
        actor: AndrAddr,
        action: String,
        permission: Permission,
    },
    RemovePermission {
        action: String,
        actor: AndrAddr,
    },
    DisableActionPermissioning {
        action: String,
    },
}

PermissionAction

Enables permissioning on an action.

By actions, we are reffering to execute messages.

Only available to the ADO owner.

Permissioning an action will allow you to call SetPermission on that action.

Rust

pub enum PermissioningMessage {
      PermissionAction {
        action: String,
    },
}

JSON

{
"permissioning":{
    "permission_action":{
        "action":"Mint"
    }
  }
}

Name	Type	Description
action	String	The action/execute message to permission.

SetPermission

Assigns permissions to the specified actor. The action needs to be permissioned by calling PermissionAction before

Only availabe to the ADO owner.

The action needs to be permissioned by calling PermissionAction to be able to set a permission for it.

Rust

pub enum PermissioningMessage {
  SetPermission {
        actor: AndrAddr,
        action: String,
        permission: Permission,
    },
 }

JSON

{
"permissioning"{
    "set_permission":{
        "actor"::"andr1...",
        "action":"Mint",
        "permission":{
            "limited":{
                "uses": 5
                }
            }
        }
    }
}

Name	Type	Description
actor	AndrAddr	The address to assign permissions for.
action	String	The execute message to assign a permission for. Action needs to be capitalized i.e. "UpdateSale" to specify the UpdateSale execute.
permission	Permission	The type of permission assigned.

Permission

An enum to represent a user's permission for an action:

Expiration defaults to Never if not provided.

pub enum Permission {
    Blacklisted(Option<MillisecondsExpiration>),
    Limited {
        expiration: Option<MillisecondsExpiration>,
        uses: u32,
    },
    Whitelisted(Option<MillisecondsExpiration>),
}

All expirations are set as a timestamp in milliseconds using the MillisecondsExpiration type.

• Blacklisted: The user cannot perform the action until after the provided expiration.

• Limited: The user can perform the action while uses are remaining and before the provided expiration.

• Whitelisted: The user can perform the action until the provided expiration.

RemovePermission

Remove a previously assigned permission for the specified actor.

Only available to the ADO owner.

Rust

pub enum PermissioningMessage {
     RemovePermission {
        action: String,
        actor: AndrAddr,
    },
 }

JSON

{
"permissioning":{
    "remove_permission":{
        "actor":"andr1...",
        "action":"Mint"
        }
    }
}

Name	Type	Description
actor	AndrAddr	The address that you want to remove permissions for.
action	String	The execute message to have its permission removed for the specified actor.

DisableActionPermissioning

Disables permissioning on an action.

This message is the reverse of a PermissionAction message.

Only available to the ADO owner.

Rust

pub enum PermissioningMessage {
      DisableActionPermissioning {
        action: String,
    },
}

JSON

{
"permissioning":{
    "disable_action_permissioning":{
        "action":"Mint"
    }
  }
}

Name	Type	Description
action	String	The action/execute message to remove permissioning for.