Splitter

Introduction

The Splitter ADO is a smart contract used to split funds to a preset number of addresses. Each of the addresses has a specific percentage assigned by the contract owner. The splitter can be locked for a specified time as a kind of insurance for recipients that their percentages will not be changed for a certain period of time.

Splitter works with both native and CW20 tokens.

We also have a set amount splitter, weighted distribution splitter, and conditional splitter.

Example

Let’s say you’re building a Web3 application and want to split revenue evenly between four contributors. You can set up the Splitter ADO with each wallet assigned 25%, and then route all incoming funds through the contract. Every time revenue comes in, it will be automatically distributed to the four recipients based on their assigned percentages.

To build trust and prevent disputes, you can also lock the splitter for, say, 6 months, guaranteeing that no one can adjust the percentages during that time. This adds an extra layer of transparency and assurance

Ado_type: splitter

Version: 2.2.0-beta.1

InstantiateMsg

A maximum of 100 recipients can be set.

The recipient addresses need to be unique.

The minimum lock_time that can be set is 1 day.

The maximum lock_time that can be set is 1 year.

Rust

pub struct InstantiateMsg {
    pub recipients: Vec<AddressPercent>,
    pub lock_time: Option<Expiry>,
    pub default_recipient:Option<Recipient>,
    pub kernel_address: String,
    pub owner: Option<String>,
}

JSON

{
    "recipients": [
               {
                "recipient":{
                    "address":"andr1..."
                },
                "percent":"0.2"
     },
     ...
    ],
"lock_time":{
    "from_now":31560000000
    },
"default_recipient":{
    "address":"andr1..."
    },
"kernel_address":"andr1...",
"owner":"andr1..."
}

Name	Type	Description
recipients	Vec<AddressPercent>	The recipient list of the splitter. Can be updated after instantiation if there is no current lock time.
lock_time	Option<Expiry>	How long the splitter is locked. Defined in seconds. When locked, no recipients can be added/changed.
default_recipient	Option<Recipient>	An optional recipient to receive any leftover funds in case the split is not exactly distributed. For example if a user sets 40% to one user, and 50% to another, and forgets about the last 10%, they would go this default recipient. Defaults to the sender if not specified.
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.

Anytime a Send execute message is sent, the amount sent will be divided amongst the recipients depending on their assigned percentage.

AddressPercent

The splitter uses a basic array of structs to determine recipients and how the funds are divided.

Rust

pub struct AddressPercent {
    pub recipient: Recipient,
    pub percent: Decimal,
}

JSON

{
    "recipient":{
        "address":"andr1..."
     },
    "percent": "0.5"
}

To be a valid recipient list the array of AddressPercent structs must meet the following requirements:

• Be non-empty

• Have percentage amounts less than or equaling 1

Read more about the Recipient struct here.

ExecuteMsg

Receive

Receives CW20 tokens sent from a CW20 ADO by performing a Send. These tokens are then automatically split to the defined recipients of the splitter.

Rust

pub enum ExecuteMsg {
    Receive(Cw20ReceiveMsg),
   }

Cw20ReceiveMsg

pub struct Cw20ReceiveMsg {
    pub sender: String,
    pub amount: Uint128,
    pub msg: Binary,
}

The msg in the Cw20ReceiveMsgshould be a base64 encoded Cw20HookMsg.

Cw20HookMsg

pub enum Cw20HookMsg {
    Send { config: Option<Vec<AddressPercent>> },
}

Send (CW20)

Divides any sent CW20 funds amongst the recipients list.

Rust

pub enum Cw20HookMsg {
  Send {
    config: Option<Vec<AddressPercent>>,
    }
}

JSON

{
"send": {}
}

Name	Type	Description
config	Option<Vec<AddressPercent>>	An optional set of recipients to split the funds to. If not defined, then the default recipient list (List defined at instantiation) will be used.

---

UpdateRecipients

Updates the recipients of the splitter contract. Only executable by the contract owner when the contract is not locked.

Only available to the contract owner when the contract is not locked.

A maximum of 100 recipients can be set.

The recipients should be unique.

Rust

pub enum ExecuteMsg {
    UpdateRecipients { 
        recipients: Vec<AddressPercent> 
    },
}

JSON

{
    "update_recipients": {
        "recipients": [
            {
                "recipient":{
                    "address":"andr1..."
                },
                "percent": "0.5"
            },
            ...
        ]
    }
}

Name	Type	Description
recipients	Vec<AddressPercent>	The new list of addresses to receive funds.

UpdateLock

Used to lock the contract for a certain period of time making it unmodifiable in any way. This can serve as a way to ensure for recipients that their weights from the splitter are fixed for a certain amount of time. The time is calculated in seconds.

Only available to the contract owner when the contract is not already locked.

The minimum time that can be set is 86,400 which is 1 day.

The maximum time that can be set is 31,536,000 which is 1 year.

Rust

pub enum ExecuteMsg {
    UpdateLock {
        lock_time: Expiry,
    },
}

JSON

{
    "update_lock": {
        "lock_time": 200000
    }
}

Name	Type	Description
lock_time	Expiry	How long the splitter is locked in seconds. When locked, cannot be changed.

Send (Native)

Divides any attached funds to the message amongst the recipients list.

You cannot send more than 5 coins with one Send.

Make sure to attach funds when executing a Send.

Rust

pub enum ExecuteMsg {
  Send {
    config: Option<Vec<AddressPercent>>,
    }
}

JSON

{
"send": {}
}

Name	Type	Description
config	Option<Vec<AddressPercent>>	An optional set of recipients to split the funds to. If not defined, then the default recipient list (List defined at instantiation) will be used.

Base Executes

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

QueryMsg

GetSplitterConfig

The current config of the Splitter contract.

Rust

pub enum QueryMsg {
    #[returns(GetSplitterConfigResponse)]
    GetSplitterConfig {},
}

JSON

{
"get_splitter_config": {}
}

GetSplitterConfigResponse

Rust

pub struct GetSplitterConfigResponse {
    pub config: Splitter,
}

JSON

{
    "config": {
        "recipients": [
            {
                "recipient":{
                   "addr":"andr1..."
                    },
                "percent": "0.5"
            },
            ...
        ],
        "locked": {
            "at_time": "1655212973"
        }
            
    }
}

Name	Type	Description
config	Splitter	The Splitter config struct.

Splitter

The splitter's config is stored in a basic struct.

pub struct Splitter {
    pub recipients: Vec<AddressPercent>,
    pub lock: MillisecondsExpiration,
    pub default_recipient: Option<Recipient>,
}

Name	Type	Description
recipients	Vec<AdressPercent>	The vector of the assigned recipients to receive the funds along with their percentages.
lock	MillisecondsExpiration	Returns the timestamp in milliseconds of the end date for the lock.
default_recipient	Option<Recipient>	The recipient to receive any leftover funds in case the split is not exactly distributed.

Base Queries

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