Council¶

Calls¶

announce_candidacy¶

Subscribe candidate

# <weight>

## weight O (1) - db: - O(1) doesn't depend on the state or parameters # </weight>

Attributes¶

Name	Type
membership_id	`T::MemberId`
staking_account_id	`T::AccountId`
reward_account_id	`T::AccountId`
stake	`Balance<T>`

Python¶

call = substrate.compose_call(
    'Council', 'announce_candidacy', {
    'membership_id': 'u64',
    'reward_account_id': 'AccountId',
    'stake': 'u128',
    'staking_account_id': 'AccountId',
}
)

candidate_remark¶

Candidate makes a remark message

# <weight>

## weight O (1) - db: - O(1) doesn't depend on the state or parameters # </weight>

Attributes¶

Name	Type
candidate_id	`T::MemberId`
msg	`Vec<u8>`

Python¶

call = substrate.compose_call(
    'Council', 'candidate_remark', {
    'candidate_id': 'u64',
    'msg': 'Bytes',
}
)

councilor_remark¶

Councilor makes a remark message

# <weight>

## weight O (1) - db: - O(1) doesn't depend on the state or parameters # </weight>

Attributes¶

Name	Type
councilor_id	`T::MemberId`
msg	`Vec<u8>`

Python¶

call = substrate.compose_call(
    'Council', 'councilor_remark', {
    'councilor_id': 'u64',
    'msg': 'Bytes',
}
)

decrease_council_budget¶

Decrease the council total budget

# <weight>

## weight O (1) - db: - O(1) doesn't depend on the state or parameters # </weight>

Attributes¶

Name	Type
reduction_amount	`Balance<T>`

Python¶

call = substrate.compose_call(
    'Council', 'decrease_council_budget', {'reduction_amount': 'u128'}
)

fund_council_budget¶

Fund the council budget by a member. <weight>

## Weight O (1) Doesn't depend on the state or parameters - DB: - O(1) doesn't depend on the state or parameters # </weight>

Attributes¶

Name	Type
member_id	`MemberId<T>`
amount	`Balance<T>`
rationale	`Vec<u8>`

Python¶

call = substrate.compose_call(
    'Council', 'fund_council_budget', {
    'amount': 'u128',
    'member_id': 'u64',
    'rationale': 'Bytes',
}
)

funding_request¶

Transfers funds from council budget to account

# <weight>

## weight O (F) where: F is the length of funding_requests - db: - O(1) doesn't depend on the state or parameters # </weight>

Attributes¶

Name	Type
funding_requests	`Vec<FundingRequestParameters<Balance<T>, T::AccountId>>`

Python¶

call = substrate.compose_call(
    'Council', 'funding_request', {
    'funding_requests': [
        {
            'account': 'AccountId',
            'amount': 'u128',
        },
    ],
}
)

plan_budget_refill¶

Plan the next budget refill.

# <weight>

## weight O (1) - db: - O(1) doesn't depend on the state or parameters # </weight>

Attributes¶

Name	Type
next_refill	`T::BlockNumber`

Python¶

call = substrate.compose_call(
    'Council', 'plan_budget_refill', {'next_refill': 'u32'}
)

release_candidacy_stake¶

Release candidacy stake that is no longer needed.

# <weight>

## weight O (1) - db: - O(1) doesn't depend on the state or parameters # </weight>

Attributes¶

Name	Type
membership_id	`T::MemberId`

Python¶

call = substrate.compose_call(
    'Council', 'release_candidacy_stake', {'membership_id': 'u64'}
)

set_budget¶

Sets the budget balance.

# <weight>

## weight O (1) - db: - O(1) doesn't depend on the state or parameters # </weight>

Attributes¶

Name	Type
balance	`Balance<T>`

Python¶

call = substrate.compose_call(
    'Council', 'set_budget', {'balance': 'u128'}
)

set_budget_increment¶

Sets the budget refill amount

# <weight>

## weight O (1) - db: - O(1) doesn't depend on the state or parameters # </weight>

Attributes¶

Name	Type
budget_increment	`Balance<T>`

Python¶

call = substrate.compose_call(
    'Council', 'set_budget_increment', {'budget_increment': 'u128'}
)

set_candidacy_note¶

Set short description for the user's candidacy. Can be called anytime during user's candidacy.

# <weight>

## weight O (N) where: N is the size of note in kilobytes - db: - O(1) doesn't depend on the state or parameters # </weight>

Attributes¶

Name	Type
membership_id	`T::MemberId`
note	`Vec<u8>`

Python¶

call = substrate.compose_call(
    'Council', 'set_candidacy_note', {
    'membership_id': 'u64',
    'note': 'Bytes',
}
)

set_councilor_reward¶

Sets the councilor reward per block

# <weight>

## weight O (1) - db: - O(1) doesn't depend on the state or parameters # </weight>

Attributes¶

Name	Type
councilor_reward	`Balance<T>`

Python¶

call = substrate.compose_call(
    'Council', 'set_councilor_reward', {'councilor_reward': 'u128'}
)

set_era_payout_damping_factor¶

Set the era payout damping factor

# <weight>

## weight O (1) - db: - O(1) doesn't depend on the state or parameters # </weight>

Attributes¶

Name	Type
new_parameter	`Percent`

Python¶

call = substrate.compose_call(
    'Council', 'set_era_payout_damping_factor', {'new_parameter': 'u8'}
)

withdraw_candidacy¶

Withdraw candidacy and release candidacy stake.

# <weight>

## weight O (1) - db: - O(1) doesn't depend on the state or parameters # </weight>

Attributes¶

Name	Type
membership_id	`T::MemberId`

Python¶

call = substrate.compose_call(
    'Council', 'withdraw_candidacy', {'membership_id': 'u64'}
)

Events¶

AnnouncingPeriodStarted¶

New council was elected

Attributes¶

Name	Type	Composition
None	`BlockNumber`	`u32`

BudgetBalanceSet¶

Budget balance was changed by the root.

Attributes¶

Name	Type	Composition
None	`Balance`	`u128`

BudgetIncrementUpdated¶

Budget increment has been updated.

Attributes¶

Name	Type	Composition
None	`Balance`	`u128`

BudgetRefill¶

Budget balance was increased by automatic refill.

Attributes¶

Name	Type	Composition
None	`Balance`	`u128`

BudgetRefillPlanned¶

The next budget refill was planned.

Attributes¶

Name	Type	Composition
None	`BlockNumber`	`u32`

CandidacyNoteSet¶

The candidate has set a new note for their candidacy

Attributes¶

Name	Type	Composition
None	`MemberId`	`u64`
None	`Vec<u8>`	`Bytes`

CandidacyStakeRelease¶

Candidacy stake that was no longer needed was released

Attributes¶

Name	Type	Composition
None	`MemberId`	`u64`

CandidacyWithdraw¶

Candidate has withdrawn his candidacy

Attributes¶

Name	Type	Composition
None	`MemberId`	`u64`

CandidateRemarked¶

Candidate remark message

Attributes¶

Name	Type	Composition
None	`MemberId`	`u64`
None	`Vec<u8>`	`Bytes`

CouncilBudgetDecreased¶

Councilor budget has been decreased Params: - Reduction amount

Attributes¶

Name	Type	Composition
None	`Balance`	`u128`

CouncilBudgetFunded¶

Fund the council budget. Params: - Member ID - Amount of balance - Rationale

Attributes¶

Name	Type	Composition
None	`MemberId`	`u64`
None	`Balance`	`u128`
None	`Vec<u8>`	`Bytes`

CouncilorRemarked¶

Councilor remark message

Attributes¶

Name	Type	Composition
None	`MemberId`	`u64`
None	`Vec<u8>`	`Bytes`

CouncilorRewardUpdated¶

Councilor reward has been updated.

Attributes¶

Name	Type	Composition
None	`Balance`	`u128`

EraPayoutDampingFactorSet¶

Era payou damping factor set

Attributes¶

Name	Type	Composition
None	`Percent`	`u8`

NewCandidate¶

New candidate announced

Attributes¶

Name	Type	Composition
None	`MemberId`	`u64`
None	`AccountId`	`AccountId`
None	`AccountId`	`AccountId`
None	`Balance`	`u128`

NewCouncilElected¶

New council was elected and appointed

Attributes¶

Name	Type	Composition
None	`Vec<MemberId>`	`['u64']`
None	`BlockNumber`	`u32`

NewCouncilNotElected¶

New council was not elected

Attributes¶

Name	Type	Composition
None	`BlockNumber`	`u32`

NotEnoughCandidates¶

Announcing period can't finish because of insufficient candidtate count

Attributes¶

Name	Type	Composition
None	`BlockNumber`	`u32`

RequestFunded¶

Request has been funded

Attributes¶

Name	Type	Composition
None	`AccountId`	`AccountId`
None	`Balance`	`u128`

RewardPayment¶

The whole reward was paid to the council member.

Attributes¶

Name	Type	Composition
None	`MemberId`	`u64`
None	`AccountId`	`AccountId`
None	`Balance`	`u128`
None	`Balance`	`u128`

VotingPeriodStarted¶

Candidates are announced and voting starts

Attributes¶

Name	Type	Composition
None	`u32`	`u32`

Storage functions¶

AnnouncementPeriodNr¶

Index of the current candidacy period. It is incremented everytime announcement period starts.

Python¶

result = substrate.query(
    'Council', 'AnnouncementPeriodNr', []
)

Return value¶

'u64'

Budget¶

Budget for the council's elected members rewards.

Python¶

result = substrate.query(
    'Council', 'Budget', []
)

Return value¶

'u128'

BudgetIncrement¶

Amount of balance to be refilled every budget period

Python¶

result = substrate.query(
    'Council', 'BudgetIncrement', []
)

Return value¶

'u128'

Candidates¶

Map of all candidates that ever candidated and haven't unstake yet.

Python¶

result = substrate.query(
    'Council', 'Candidates', ['u64']
)

Return value¶

{
    'cycle_id': 'u64',
    'note_hash': (None, 'scale_info::11'),
    'reward_account_id': 'AccountId',
    'stake': 'u128',
    'staking_account_id': 'AccountId',
    'vote_power': 'u128',
}

CouncilMembers¶

Current council members

Python¶

result = substrate.query(
    'Council', 'CouncilMembers', []
)

Return value¶

[
    {
        'last_payment_block': 'u32',
        'membership_id': 'u64',
        'reward_account_id': 'AccountId',
        'stake': 'u128',
        'staking_account_id': 'AccountId',
        'unpaid_reward': 'u128',
    },
]

CouncilorReward¶

Councilor reward per block

Python¶

result = substrate.query(
    'Council', 'CouncilorReward', []
)

Return value¶

'u128'

EraPayoutDampingFactor¶

Era payou damping factor: a parameter in [0,1] that can be used to reduce the era payout without changing the reward curve directly

Python¶

result = substrate.query(
    'Council', 'EraPayoutDampingFactor', []
)

Return value¶

'u8'

NextBudgetRefill¶

The next block in which the budget will be increased.

Python¶

result = substrate.query(
    'Council', 'NextBudgetRefill', []
)

Return value¶

'u32'

NextRewardPayments¶

The next block in which the elected council member rewards will be payed.

Python¶

result = substrate.query(
    'Council', 'NextRewardPayments', []
)

Return value¶

'u32'

Stage¶

Current council voting stage

Python¶

result = substrate.query(
    'Council', 'Stage', []
)

Return value¶

{
    'changed_at': 'u32',
    'stage': {
        'Announcing': {'candidates_count': 'u32', 'ends_at': 'u32'},
        'Election': {'candidates_count': 'u32'},
        'Idle': {'ends_at': 'u32'},
    },
}

Constants¶

AnnouncingPeriodDuration¶

Duration of annoncing period

Value¶

Python¶

constant = substrate.get_constant('Council', 'AnnouncingPeriodDuration')

BudgetRefillPeriod¶

Interval between automatic budget refills.

Value¶

Python¶

constant = substrate.get_constant('Council', 'BudgetRefillPeriod')

CandidacyLockId¶

Exports const - candidacy lock id.

Value¶

'0x63616e6469646163'

Python¶

constant = substrate.get_constant('Council', 'CandidacyLockId')

CouncilSize¶

Council member count

Value¶

Python¶

constant = substrate.get_constant('Council', 'CouncilSize')

CouncilorLockId¶

Exports const - councilor lock id.

Value¶

'0x636f756e63696c6f'

Python¶

constant = substrate.get_constant('Council', 'CouncilorLockId')

ElectedMemberRewardPeriod¶

Interval for automatic reward payments.

Value¶

Python¶

constant = substrate.get_constant('Council', 'ElectedMemberRewardPeriod')

IdlePeriodDuration¶

Duration of idle period

Value¶

Python¶

constant = substrate.get_constant('Council', 'IdlePeriodDuration')

MinCandidateStake¶

Minimum stake candidate has to lock

Value¶

1666666666660000

Python¶

constant = substrate.get_constant('Council', 'MinCandidateStake')

MinNumberOfExtraCandidates¶

Minimum number of extra candidates needed for the valid election. Number of total candidates is equal to council size plus extra candidates.

Value¶

Python¶

constant = substrate.get_constant('Council', 'MinNumberOfExtraCandidates')

Errors¶

ArithmeticError¶

Unexpected arithmetic error (overflow / underflow)

BadOrigin¶

Origin is invalid.

CandidacyStakeTooLow¶

Candidate haven't provided sufficient stake.

CandidateDoesNotExist¶

Candidate id not found

CantCandidateNow¶

User tried to announce candidacy outside of the candidacy announcement period.

CantCandidateTwice¶

User tried to announce candidacy twice in the same elections.

CantReleaseStakeNow¶

User tried to release stake outside of the revealing period.

CantVoteForYourself¶

Candidate can't vote for himself.

CantWithdrawCandidacyNow¶

Can't withdraw candidacy outside of the candidacy announcement period.

ConflictingStake¶

User tried to announce candidacy with an account that has the conflicting type of stake with candidacy stake and has not enough balance for staking for both purposes.

EmptyFundingRequests¶

Funding requests without recieving accounts

InsufficientBalanceForStaking¶

Insufficient balance for candidacy staking.

InsufficientBalanceForTransfer¶

Cannot withdraw: insufficient budget balance.

InsufficientFundsForFundingRequest¶

Insufficent funds in council for executing 'Funding Request'

InsufficientTokensForFunding¶

Insufficient tokens for funding (on member controller account)

InvalidAccountToStakeReuse¶

The combination of membership id and account id is invalid for unstaking an existing candidacy stake.

MemberIdNotMatchAccount¶

Invalid membership.

NoStake¶

User tried to release stake when no stake exists.

NotCandidatingNow¶

User tried to withdraw candidacy when not candidating.

NotCouncilor¶

The member is not a councilor.

ReductionAmountTooLarge¶

Cannot reduce the budget by the given amount.

RepeatedFundRequestAccount¶

The same account is recieving funds from the same request twice

StakeStillNeeded¶

Council member and candidates can't withdraw stake yet.

ZeroBalanceFundRequest¶

Fund request no balance

ZeroTokensFunding¶

Trying to fund with zero tokens