AndromedaMsg

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 all the AndromedaMsg base executes.

Rates messages are only available to ADOs that implement Rates. This would be specified in the ADOs documentaion page.

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

All the ADOs can execute:

Ownership

Messages related to the ownership of an ADO.

pub enum AndromedaMsg {
   Ownership(OwnershipMessage),
}

OwnershipMessage

The enum containing the different ownership message options.

pub enum OwnershipMessage {
    UpdateOwner {
        new_owner: Addr,
        expiration: Option<Expiry>,
    },
    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.

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

AcceptOwnership

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

Only an address that has an offer can accept it.

pub enum OwnershipMessage {
 AcceptOwnership
}

RevokeOwnershipOffer

Removes any previously placed offer by the current ADO owner.

Only available to the current ADO owner.

pub enum OwnershipMessage {
 RevokeOwnershipOffer 
}

Disown

Removes ownership from the current ADO owner.

Only available to the contract owner.

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

pub enum OwnershipMessage {
 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.

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

UpdateKernelAddress

Updates the Kernel used by the ADO.

Only available to the ADO owner.

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

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. Permissioning allows ADO owners to give/restrict access to addresses to execute messages on their ADOs.

You can use the Address List ADO to set up permissions.

Permissioning cannot bypass owner restricted messages.

pub enum AndromedaMsg {
   Permissioning(PermissioningMessage),
}

PermissioningMessage

pub enum PermissioningMessage {
  PermissionAction {
        action: String,
    },
  SetPermission {
        actors: Vec<AndrAddr>,
        action: String,
        permission: Permission,
    },
    RemovePermission {
        action: String,
        actors: Vec<AndrAddr>,
    },
    DisableActionPermissioning {
        action: String,
    },
}

PermissionAction

Makes an action permissioned. This means that if an address is not whitelisted using Set Permission, it cannot call the action.

By actions, we are reffering to execute messages.

Only available to the ADO owner.

PermissionAction blacklists all addresses from calling the action unless they are whitelisted to do so.

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

SetPermission

Assigns permissions to the specified actor. In case of whitelists, the action needs to be permissioned first by calling PermissionAction.

Only availabe to the ADO owner.

In case of blacklisting, there is no need to call PermissionAction.

pub enum PermissioningMessage {
  SetPermission {
        actors: Vec<AndrAddr>,
        action: String,
        permission: Permission,
    },
 }

Permission

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

Expiration defaults to Never if not provided.

pub enum Permission {
    Local(LocalPermission),
    Contract(AndrAddr),
}
  • Local: The permissions are directly set from this ADO. You would directly specify the type of permission in this case.

  • Contract: The permissions are taken from an Address List ADO. You would reference the Address List in this case.

LocalPermission

pub enum LocalPermission {
    Blacklisted(Option<Expiry>),
    Limited {
        expiration: Option<Expiry>,
        uses: u32,
    },
    Whitelisted(Option<Expiry>),
}
  • 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.

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

DisableActionPermissioning

Disables permissioning on an action.

This message is the reverse of a PermissionAction message.

Only available to the ADO owner.

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

Rates

Sets a rate on a specific action in the ADO. Rates are used to add taxes or royalties on ADOs where it makes sense such as NFT sales for example. Here is the list of actions that can have rates applied to them:

Only available to the ADOs that implement rates.

You can use the Rates ADO to set up rates.

pub enum AndromedaMsg {
    #[cfg(feature = "rates")]
    Rates(self::rates::RatesMessage),
}

RatesMessage

#[cw_serde]
pub enum RatesMessage {
    SetRate { action: String, rate: Rate },
    RemoveRate { action: String },
}

SetRate

Sets a rate on the specified action.

Check the table above to see which actions can have rates applied.

pub enum RatesMessage {
    SetRate {
     action: String,
     rate: Rate 
      },
}

Rate

pub enum Rate {
    Local(LocalRate),
    Contract(AndrAddr),
}
  • Local: The rate configurations are specified within the ADO itself.

  • Contract: The rate configurations are taken from a rates ADO. In this case, you need to reference the rates ADO to take the configurations from using an AndrAddr.

Local

pub struct LocalRate {
    pub rate_type: LocalRateType,
    pub recipients: Vec<Recipient>,
    pub value: LocalRateValue,
    pub description: Option<String>,
}

LocalRateType

An enum specifying the type of the rate.

pub enum LocalRateType {
    Additive,
    Deductive,
}
  • Additive: The rate amount acts as a tax and is added to the price and payed by the buyer. For example a 10% additive rate (with one recipient) on a price of 1000 uandr means the buyer has to send 1100 uandr.

  • Deductive: The rate amount acts as a royalty and is deducted from the price. For example a 10% deductive rate on a price of 1000 uandr means the buyer needs to send 1000 uand and 100 will be taken to the recipient of the rate.

LocalRateValue

Percentage is specified as a decimal. This means a rate of 10% is specified as 0.1 and not 10.

pub enum LocalRateValue {
    Percent(PercentRate),
    Flat(Coin),
} 

pub struct PercentRate {
    pub percent: Decimal,
}
  • Percent: The rate is specified as a percentage of the price using decimal.

  • Flat: The rate is specified as a fixed amount of Coin.

RemoveRate

Removes the rate set on the specified action.

pub enum RatesMessage {
  RemoveRate {
    action: String 
  },
}

Last updated

Additional Resources

GithubWebsite