Struct pallet_alliance::pallet::Pallet

pub struct Pallet<T, I = ()>(_);

The Pallet struct, the main type that implements traits and standalone functions within the pallet.

Implementations

impl<T: Config<I>, I: 'static> Pallet<T, I>

pub fn propose( origin: OriginFor<T>, threshold: u32, proposal: Box<<T as Config<I>>::Proposal>, length_bound: u32 ) -> DispatchResult

Add a new proposal to be voted on.

Must be called by a Fellow.

pub fn vote( origin: OriginFor<T>, proposal: T::Hash, index: ProposalIndex, approve: bool ) -> DispatchResult

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

Must be called by a Fellow.

pub fn init_members( origin: OriginFor<T>, fellows: Vec<T::AccountId>, allies: Vec<T::AccountId> ) -> DispatchResult

Initialize the Alliance, onboard fellows and allies.

The Alliance must be empty, and the call must provide some founding members.

Must be called by the Root origin.

pub fn disband( origin: OriginFor<T>, witness: DisbandWitness ) -> DispatchResultWithPostInfo

Disband the Alliance, remove all active members and unreserve deposits.

Witness data must be set.

pub fn set_rule(origin: OriginFor<T>, rule: Cid) -> DispatchResult

Set a new IPFS CID to the alliance rule.

pub fn announce(origin: OriginFor<T>, announcement: Cid) -> DispatchResult

Make an announcement of a new IPFS CID about alliance issues.

pub fn remove_announcement( origin: OriginFor<T>, announcement: Cid ) -> DispatchResult

Remove an announcement.

pub fn join_alliance(origin: OriginFor<T>) -> DispatchResult

Submit oneself for candidacy. A fixed deposit is reserved.

pub fn nominate_ally( origin: OriginFor<T>, who: <<T as Config>::Lookup as StaticLookup>::Source ) -> DispatchResult

A Fellow can nominate someone to join the alliance as an Ally. There is no deposit required from the nominator or nominee.

pub fn elevate_ally( origin: OriginFor<T>, ally: <<T as Config>::Lookup as StaticLookup>::Source ) -> DispatchResult

Elevate an Ally to Fellow.

pub fn give_retirement_notice(origin: OriginFor<T>) -> DispatchResult

As a member, give a retirement notice and start a retirement period required to pass in order to retire.

pub fn retire(origin: OriginFor<T>) -> DispatchResult

As a member, retire from the Alliance and unreserve the deposit.

This can only be done once you have called give_retirement_notice and the RetirementPeriod has passed.

pub fn kick_member( origin: OriginFor<T>, who: <<T as Config>::Lookup as StaticLookup>::Source ) -> DispatchResult

Kick a member from the Alliance and slash its deposit.

pub fn add_unscrupulous_items( origin: OriginFor<T>, items: Vec<UnscrupulousItem<<T as Config>::AccountId, BoundedVec<u8, <T as Config<I>>::MaxWebsiteUrlLength>>> ) -> DispatchResult

Add accounts or websites to the list of unscrupulous items.

pub fn remove_unscrupulous_items( origin: OriginFor<T>, items: Vec<UnscrupulousItem<<T as Config>::AccountId, BoundedVec<u8, <T as Config<I>>::MaxWebsiteUrlLength>>> ) -> DispatchResult

Deem some items no longer unscrupulous.

pub fn close( origin: OriginFor<T>, proposal_hash: T::Hash, index: ProposalIndex, proposal_weight_bound: Weight, length_bound: u32 ) -> DispatchResultWithPostInfo

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

Must be called by a Fellow.

pub fn abdicate_fellow_status(origin: OriginFor<T>) -> DispatchResult

Abdicate one’s position as a voting member and just be an Ally. May be used by Fellows who do not want to leave the Alliance but do not have the capacity to participate operationally for some time.

impl<T: Config<I>, I: 'static> Pallet<T, I>

pub fn rule() -> Option<Cid>

An auto-generated getter for Rule.

impl<T: Config<I>, I: 'static> Pallet<T, I>

pub fn announcements() -> BoundedVec<Cid, T::MaxAnnouncementsCount>

An auto-generated getter for Announcements.

impl<T: Config<I>, I: 'static> Pallet<T, I>

pub fn deposit_of<KArg>( k: KArg ) -> Option<<<T as Config<I>>::Currency as Currency<<T as Config>::AccountId>>::Balance>where KArg: EncodeLike<T::AccountId>,

An auto-generated getter for DepositOf.

impl<T: Config<I>, I: 'static> Pallet<T, I>

pub fn members<KArg>(k: KArg) -> BoundedVec<T::AccountId, T::MaxMembersCount>where KArg: EncodeLike<MemberRole>,

An auto-generated getter for Members.

impl<T: Config<I>, I: 'static> Pallet<T, I>

pub fn retiring_members<KArg>(k: KArg) -> Option<BlockNumberFor<T>>where KArg: EncodeLike<T::AccountId>,

An auto-generated getter for RetiringMembers.

impl<T: Config<I>, I: 'static> Pallet<T, I>

pub fn unscrupulous_accounts( ) -> BoundedVec<T::AccountId, T::MaxUnscrupulousItems>

An auto-generated getter for UnscrupulousAccounts.

impl<T: Config<I>, I: 'static> Pallet<T, I>

pub fn unscrupulous_websites( ) -> BoundedVec<BoundedVec<u8, <T as Config<I>>::MaxWebsiteUrlLength>, T::MaxUnscrupulousItems>

An auto-generated getter for UnscrupulousWebsites.

impl<T: Config<I>, I: 'static> Pallet<T, I>

pub fn is_member(who: &T::AccountId) -> bool

Check if a user is a alliance member.

pub fn is_member_of(who: &T::AccountId, role: MemberRole) -> bool

Check if an account has a given role.

Trait Implementations

impl<T, I: 'static> Benchmarking for Pallet<T, I>where T: Config + Config<I>,

fn benchmarks(extra: bool) -> Vec<BenchmarkMetadata>

Get the benchmarks available for this pallet. Generally there is one benchmark per extrinsic, so these are sometimes just called “extrinsics”.

fn run_benchmark( extrinsic: &[u8], c: &[(BenchmarkParameter, u32)], whitelist: &[TrackedStorageKey], verify: bool, internal_repeats: u32 ) -> Result<Vec<BenchmarkResult>, BenchmarkError>

Run the benchmarks for this pallet.

impl<T: Config<I>, I: 'static> Callable<T> for Pallet<T, I>

type RuntimeCall = Call<T, I>

impl<T, I> Clone for Pallet<T, I>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T, I> Debug for Pallet<T, I>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Config<I>, I: 'static> GetStorageVersion for Pallet<T, I>

type CurrentStorageVersion = StorageVersion

This will be filled out by the pallet macro.

fn current_storage_version() -> Self::CurrentStorageVersion

Returns the current storage version as supported by the pallet.

fn on_chain_storage_version() -> StorageVersion

Returns the on-chain storage version of the pallet as stored in the storage.

impl<T: Config<I>, I: 'static> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn on_initialize(_n: BlockNumber) -> Weight

Block initialization hook. This is called at the very beginning of block execution.

fn on_finalize(_n: BlockNumber)

Block finalization hook. This is called at the very end of block execution.

fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight

Hook to consume a block’s idle time. This will run when the block is being finalized (before Hooks::on_finalize).

fn on_runtime_upgrade() -> Weight

Hook executed when a code change (aka. a “runtime upgrade”) is detected by FRAME.

fn try_state(_n: BlockNumber) -> Result<(), DispatchError>

Execute the sanity checks of this pallet, per block.

fn pre_upgrade() -> Result<Vec<u8, Global>, DispatchError>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade(_state: Vec<u8, Global>) -> Result<(), DispatchError>

Execute some post-checks after a runtime upgrade.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a pallet allows you to perform long-running tasks that are dispatched as separate threads, and entirely independent of the main wasm runtime.

fn integrity_test()

Check the integrity of this pallet’s configuration.

impl<T: Config<I>, I: 'static> IntegrityTest for Pallet<T, I>

fn integrity_test()

See Hooks::integrity_test.

impl<T: Config<I>, I: 'static> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn offchain_worker(n: BlockNumberFor<T>)

This function is being called after every block import (when fully synced).

impl<T: Config<I>, I: 'static> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn on_finalize(n: BlockNumberFor<T>)

See Hooks::on_finalize.

impl<T: Config<I>, I: 'static> OnGenesis for Pallet<T, I>

fn on_genesis()

Something that should happen at genesis.

impl<T: Config<I>, I: 'static> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn on_idle(n: BlockNumberFor<T>, remaining_weight: Weight) -> Weight

See Hooks::on_idle.

impl<T: Config<I>, I: 'static> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn on_initialize(n: BlockNumberFor<T>) -> Weight

See Hooks::on_initialize.

impl<T: Config<I>, I: 'static> OnRuntimeUpgrade for Pallet<T, I>

fn on_runtime_upgrade() -> Weight

See Hooks::on_runtime_upgrade.

fn pre_upgrade() -> Result<Vec<u8>, TryRuntimeError>

See Hooks::pre_upgrade.

fn post_upgrade(state: Vec<u8>) -> Result<(), TryRuntimeError>

See Hooks::post_upgrade.

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, DispatchError>

The expected and default behavior of this method is to handle executing pre_upgrade -> on_runtime_upgrade -> post_upgrade hooks for a migration.

impl<T: Config<I>, I: 'static> PalletInfoAccess for Pallet<T, I>

fn index() -> usize

Index of the pallet as configured in the runtime.

fn name() -> &'static str

Name of the pallet as configured in the runtime.

fn module_name() -> &'static str

Name of the Rust module containing the pallet.

fn crate_version() -> CrateVersion

Version of the crate containing the pallet.

impl<T: Config<I>, I: 'static> PalletsInfoAccess for Pallet<T, I>

fn count() -> usize

The number of pallets’ information that this type represents.

fn infos() -> Vec<PalletInfoData>

All of the pallets’ information that this type represents.

impl<T, I> PartialEq<Pallet<T, I>> for Pallet<T, I>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Config<I>, I: 'static> StorageInfoTrait for Pallet<T, I>

fn storage_info() -> Vec<StorageInfo>

impl<T: Config<I>, I: 'static> TryState<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn try_state( n: BlockNumberFor<T>, _s: TryStateSelect ) -> Result<(), TryRuntimeError>

Execute the state checks.

impl<T: Config<I>, I: 'static> WhitelistedStorageKeys for Pallet<T, I>

fn whitelisted_storage_keys() -> Vec<TrackedStorageKey>

Returns a Vec<TrackedStorageKey> indicating the storage keys that should be whitelisted during benchmarking. This means that those keys will be excluded from the benchmarking performance calculation.

impl<T, I> Eq for Pallet<T, I>