Primitive

Introduction

The Primitive ADO is a smart contract that is used to store data. It is a simple contract that allows us to store key/value pairs acting like a database.

The Primitive ADO can be set to one of the following:

• Private: Only accessible by the contract owner of the ADO.

• Public: Accessible by anyone.

• Restricted: Only accessible to the key owner.

You can add a fee for setting keys using our rates.

Ado_type: primitive

Version: 2.1.0

InstantiateMsg

Rust

pub struct InstantiateMsg {
    pub restriction:PrimitiveRestriction,
    pub kernel_address: String,
    pub owner: Option<String>
}

JSON

Name	Type	Description
restriction	PrimitiveRestriction	Specifies who has access to add/delete data into the primitive ADO.
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.

PrimitiveRestriction

An enum defining the different types of restrictions that can be set.

pub enum PrimitiveRestriction {
    Private,
    Public,
    Restricted,
}

• Private: Only accessible by the contract owner of the ADO.

• Public: Accessible by anyone.

• Restricted: Only accessible to the key owner (The address that first set the key).

ExecuteMsg

SetValue

Sets a value for the named key. When we need to extract the value that has been saved we would use the key.

If keyis not specified the default key ("default") will be used.

If SetValue uses a name that is already in use, the old value is overwritten by the latest value.

Rust

pub enum ExecuteMsg {
  SetValue {
        key: Option<String>,
        value: Primitive,
     }
  }

JSON

Name	Type	Description
key	Option<String>	The key for the data. The default key "default" will be used if it is not specified.
value	Primitive	The value of the data.

Primitive

An enum to specify the type of data you are saving.

pub enum Primitive {
    Uint128(Uint128),
    Decimal(Decimal),
    Coin(Coin),
    Addr(Addr),
    String(String),
    Bool(bool),
    Binary(Binary),
}

DeleteValue

Deletes the data attached to the specified key.

If key is not specified the default key ("default") will be used.

Rust

   pub enum ExecuteMsg{
   DeleteValue {
        key: Option<String>,
    }
 }

JSON

Name	Type	Description
key	Option<String>	Thel key for the data to delete. If not specified, the default key "default" will be used.

UpdateRestriction

Changes the restriction set on the primitive.

Only available to the contract owner.

Rust

pub enum ExecuteMsg {
 UpdateRestriction {
        restriction: PrimitiveRestriction,
    },
}

JSON

Name	Type	Description
restriction	PrimitiveRestriction	The new restriction type to use for the primitve ADO.

Rates

Sets a fee on adding values to the primitive.

Only available to the contract owner.

Only a Flat rate type is accepted.

You can read more here about setting rates.

Base Executes

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

QueryMsg

GetValue

Gets the value asociated to the specified key.

Rust

pub enum QueryMsg { 
 #[returns(GetValueResponse)]
    GetValue { key: Option<String> },
    }

JSON

Name	Type	Description
key	Option<String>	The key to get the value for. The default key is used if it is not specified.

GetValueResponse

Rust

pub struct GetValueResponse {
    pub key: String,
    pub value: Primitive,
}

JSON

Name	Type	Description
key	String	The key you are getting the value for.
value	Primitive	The value for the specified key.

AllKeys

Gets all the keys that are currently saved in the primitive ADO.

Rust

pub enum QueryMsg {
 #[returns(Vec<String>)]
    AllKeys {},
    }

JSON

Returns a Vec<String> containing all the available keys.

OwnerKeys

Gets all the keys that belong to the specified owner address.

Rust

pub enum QueryMsg {
    #[returns(Vec<String>)]
    OwnerKeys { owner: AndrAddr },
    }

JSON

Name	Type	Description
owner	AndrAddr	The address to get the keys for.

Returns a Vec<String> containing all the keys belonging to the specified owner.

Base Queries

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