Struct substrate_gen::runtime::council::calls::TransactionApi

pub struct TransactionApi;

Implementations

impl TransactionApi

pub fn set_members( &self, new_members: Vec<AccountId32>, prime: Option<AccountId32>, old_count: u32 ) -> StaticTxPayload<SetMembers>

Set the collective’s membership.

• new_members: The new member list. Be nice to the chain and provide it sorted.
• prime: The prime member whose vote sets the default.
• old_count: The upper bound for the previous number of members in storage. Used for weight estimation.

Requires root origin.

NOTE: Does not enforce the expected MaxMembers limit on the amount of members, but the weight estimations rely on it to estimate dispatchable weight.

WARNING:

The pallet-collective can also be managed by logic outside of the pallet through the implementation of the trait [ChangeMembers]. Any call to set_members must be careful that the member set doesn’t get out of sync with other logic managing the member set.

Weight

• O(MP + N) where:
  • M old-members-count (code- and governance-bounded)
  • N new-members-count (code- and governance-bounded)
  • P proposals-count (code-bounded)
• DB:
  • 1 storage mutation (codec O(M) read, O(N) write) for reading and writing the members
  • 1 storage read (codec O(P)) for reading the proposals
  • P storage mutations (codec O(M)) for updating the votes for each proposal
  • 1 storage write (codec O(1)) for deleting the old prime and setting the new one

pub fn execute( &self, proposal: RuntimeCall, length_bound: u32 ) -> StaticTxPayload<Execute>

Dispatch a proposal from a member using the Member origin.

Origin must be a member of the collective.

Weight

• O(M + P) where M members-count (code-bounded) and P complexity of dispatching proposal
• DB: 1 read (codec O(M)) + DB access of proposal
• 1 event

pub fn propose( &self, threshold: u32, proposal: RuntimeCall, length_bound: u32 ) -> StaticTxPayload<Propose>

Add a new proposal to either be voted on or executed directly.

Requires the sender to be member.

threshold determines whether proposal is executed directly (threshold < 2) or put up for voting.

Weight

• O(B + M + P1) or O(B + M + P2) where:
  • B is proposal size in bytes (length-fee-bounded)
  • M is members-count (code- and governance-bounded)
  • branching is influenced by threshold where:
    • P1 is proposal execution complexity (threshold < 2)
    • P2 is proposals-count (code-bounded) (threshold >= 2)
• DB:
  • 1 storage read is_member (codec O(M))
  • 1 storage read ProposalOf::contains_key (codec O(1))
  • DB accesses influenced by threshold:
    • EITHER storage accesses done by proposal (threshold < 2)
    • OR proposal insertion (threshold <= 2)
      • 1 storage mutation Proposals (codec O(P2))
      • 1 storage mutation ProposalCount (codec O(1))
      • 1 storage write ProposalOf (codec O(B))
      • 1 storage write Voting (codec O(M))
  • 1 event

pub fn vote( &self, proposal: H256, index: u32, approve: bool ) -> StaticTxPayload<Vote>

Add an aye or nay vote for the sender to the given proposal.

Requires the sender to be a member.

Transaction fees will be waived if the member is voting on any particular proposal for the first time and the call is successful. Subsequent vote changes will charge a fee.

Weight

• O(M) where M is members-count (code- and governance-bounded)
• DB:
  • 1 storage read Members (codec O(M))
  • 1 storage mutation Voting (codec O(M))
• 1 event

pub fn close_old_weight( &self, proposal_hash: H256, index: u32, proposal_weight_bound: OldWeight, length_bound: u32 ) -> StaticTxPayload<CloseOldWeight>

Close a vote that is either approved, disapproved or whose voting period has ended.

May be called by any signed account in order to finish voting and close the proposal.

If called before the end of the voting period it will only close the vote if it is has enough votes to be approved or disapproved.

If called after the end of the voting period abstentions are counted as rejections unless there is a prime member set and the prime member cast an approval.

If the close operation completes successfully with disapproval, the transaction fee will be waived. Otherwise execution of the approved operation will be charged to the caller.

• proposal_weight_bound: The maximum amount of weight consumed by executing the closed proposal.
• length_bound: The upper bound for the length of the proposal in storage. Checked via storage::read so it is size_of::<u32>() == 4 larger than the pure length.

Weight

• O(B + M + P1 + P2) where:
  • B is proposal size in bytes (length-fee-bounded)
  • M is members-count (code- and governance-bounded)
  • P1 is the complexity of proposal preimage.
  • P2 is proposal-count (code-bounded)
• DB:
• 2 storage reads (Members: codec O(M), Prime: codec O(1))
• 3 mutations (Voting: codec O(M), ProposalOf: codec O(B), Proposals: codec O(P2))
• any mutations done while executing proposal (P1)
• up to 3 events

pub fn disapprove_proposal( &self, proposal_hash: H256 ) -> StaticTxPayload<DisapproveProposal>

Disapprove a proposal, close, and remove it from the system, regardless of its current state.

Must be called by the Root origin.

Parameters:

• proposal_hash: The hash of the proposal that should be disapproved.

Complexity: O(P) where P is the number of max proposals DB Weight:

• Reads: Proposals
• Writes: Voting, Proposals, ProposalOf

pub fn close( &self, proposal_hash: H256, index: u32, proposal_weight_bound: Weight, length_bound: u32 ) -> StaticTxPayload<Close>

Close a vote that is either approved, disapproved or whose voting period has ended.

May be called by any signed account in order to finish voting and close the proposal.

If called before the end of the voting period it will only close the vote if it is has enough votes to be approved or disapproved.

If called after the end of the voting period abstentions are counted as rejections unless there is a prime member set and the prime member cast an approval.

If the close operation completes successfully with disapproval, the transaction fee will be waived. Otherwise execution of the approved operation will be charged to the caller.

• proposal_weight_bound: The maximum amount of weight consumed by executing the closed proposal.
• length_bound: The upper bound for the length of the proposal in storage. Checked via storage::read so it is size_of::<u32>() == 4 larger than the pure length.

Weight

• O(B + M + P1 + P2) where:
  • B is proposal size in bytes (length-fee-bounded)
  • M is members-count (code- and governance-bounded)
  • P1 is the complexity of proposal preimage.
  • P2 is proposal-count (code-bounded)
• DB:
• 2 storage reads (Members: codec O(M), Prime: codec O(1))
• 3 mutations (Voting: codec O(M), ProposalOf: codec O(B), Proposals: codec O(P2))
• any mutations done while executing proposal (P1)
• up to 3 events