Address List

The address list ADO is a smart contract that facilitates setting up permissions for ADOs. Instead of setting up the permission on the ADO itself, the owner can reference this ADO instead.

Permissioning allows ADO owners to give/restrict access to addresses to execute messages on their ADOs.

ADO_type: address-list

Version: 2.1.0

InstantiateMsg

Rust

pub struct InstantiateMsg {
    pub actor_permission: Option<ActorPermission>,
    pub kernel_address: String,
    pub owner: Option<String>
}

JSON

{
"actor_permission":{
    "actor":"andr1...",
    "permission":{
        "whitelisted":null
        }
    },
"kernel_address":"andr1..."
}

Name	Type	Description
actor_permission	Option<ActionPermission>	Optional permission to set at instantiation.
kernel_address	String	Contract address of the kernel contract to be used for AMP messaging. Kernel contract address can be found in our deployed contracts.
owner	Option<String>	Optional address to specify as the owner of the ADO being created. Defaults to the sender if not specified.

ActionPermission

pub struct ActorPermission {
    pub actor: Addr,
    pub permission: Permission,
}

Name	Type	Description
actor	Addr	The address to apply the permission on.
permission	Permission	The type of permission to assign to the actor.

Permission

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

Expiration defaults to Never if not provided.

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

ExecuteMsg

AddActorPermission

Only available to the ADO owner.

Add permissioning to the specified list of actors (Addresses).

Rust

pub enum ExecuteMsg {
PermissionActors {
        actors: Vec<AndrAddr>,
        permission: LocalPermission,
    },
 }

JSON

{
"actor_permission":{
    "actors":["andr1...","andr1...",...],
    "permission":{
        "blacklisted":null
        }
    }
}

Name	Type	Description
actors	Vec<AndrAddr>	The list of addresses to apply the permission to.
permission	Permission	The type of permission to assign to the actor.

RemoveActorPermission

Only available to the ADO owner.

Removes previously set permission on the specified actors.

Rust

pub enum ExecuteMsg {
  RemovePermissions {
        actors: Vec<AndrAddr>
    },
}

JSON

{
"remove_actor_permission":{
    "actors":"andr1..."
    }
}

Name	Type	Description
actors	Vec<AndrAddr>	The address to remove permissions from.

Base Executes

The rest of the execute messages can be found in the ADO Base section.

QueryMsg

IncludesActor

Checks if the specified actor has any permissions applied.

Rust

pub enum QueryMsg {
    #[returns(IncludesActorResponse)]
    IncludesActor { actor: Addr },
    }

JSON

{
"includes_actor":{
    "actor":"andr1..."
    }
}

Name	Type	Description
actor	Addr	The address to check permissions for.

Returns true if the address has any permissions and false otherwise.

ActorPermission

Queries the permission applied on the specified actor.

Rust

pub enum QueryMsg {
   #[returns(ActorPermissionResponse)]
    ActorPermission { actor: Addr },
    }

JSON

{
"actor_permission":{
    "actor":"andr1..."
    }
}

Name	Type	Description
actor	Addr	The address to get permissions for.

Returns a Permission struct with the type of permission.

Base Queries

The rest of the query messages can be found in the ADO Base section.