Enum pallet_tips::pallet::Call

pub enum Call<T: Config<I>, I: 'static = ()> {
    report_awesome {
        reason: Vec<u8>,
        who: <<T as Config>::Lookup as StaticLookup>::Source,
    },
    retract_tip {
        hash: T::Hash,
    },
    tip_new {
        reason: Vec<u8>,
        who: <<T as Config>::Lookup as StaticLookup>::Source,
        tip_value: BalanceOf<T, I>,
    },
    tip {
        hash: T::Hash,
        tip_value: BalanceOf<T, I>,
    },
    close_tip {
        hash: T::Hash,
    },
    slash_tip {
        hash: T::Hash,
    },
    // some variants omitted
}

Contains one variant per dispatchable that can be called by an extrinsic.

Variants

report_awesome

Fields

reason: Vec<u8>

who: <<T as Config>::Lookup as StaticLookup>::Source

Report something reason that deserves a tip and claim any eventual the finder’s fee.

The dispatch origin for this call must be Signed.

Payment: TipReportDepositBase will be reserved from the origin account, as well as DataDepositPerByte for each byte in reason.

• reason: The reason for, or the thing that deserves, the tip; generally this will be a UTF-8-encoded URL.
• who: The account which should be credited for the tip.

Emits NewTip if successful.

• Complexity: O(R) where R length of reason.
  • encoding and hashing of ‘reason’
• DbReads: Reasons, Tips
• DbWrites: Reasons, Tips

retract_tip

Fields

hash: T::Hash

Retract a prior tip-report from report_awesome, and cancel the process of tipping.

If successful, the original deposit will be unreserved.

The dispatch origin for this call must be Signed and the tip identified by hash must have been reported by the signing account through report_awesome (and not through tip_new).

• hash: The identity of the open tip for which a tip value is declared. This is formed as the hash of the tuple of the original tip reason and the beneficiary account ID.

Emits TipRetracted if successful.

• Complexity: O(1)
  • Depends on the length of T::Hash which is fixed.
• DbReads: Tips, origin account
• DbWrites: Reasons, Tips, origin account

tip_new

Fields

reason: Vec<u8>

who: <<T as Config>::Lookup as StaticLookup>::Source

tip_value: BalanceOf<T, I>

Give a tip for something new; no finder’s fee will be taken.

The dispatch origin for this call must be Signed and the signing account must be a member of the Tippers set.

• reason: The reason for, or the thing that deserves, the tip; generally this will be a UTF-8-encoded URL.
• who: The account which should be credited for the tip.
• tip_value: The amount of tip that the sender would like to give. The median tip value of active tippers will be given to the who.

Emits NewTip if successful.

• Complexity: O(R + T) where R length of reason, T is the number of tippers.
  • O(T): decoding Tipper vec of length T. T is charged as upper bound given by ContainsLengthBound. The actual cost depends on the implementation of T::Tippers.
  • O(R): hashing and encoding of reason of length R
• DbReads: Tippers, Reasons
• DbWrites: Reasons, Tips

tip

Fields

hash: T::Hash

tip_value: BalanceOf<T, I>

Declare a tip value for an already-open tip.

The dispatch origin for this call must be Signed and the signing account must be a member of the Tippers set.

• hash: The identity of the open tip for which a tip value is declared. This is formed as the hash of the tuple of the hash of the original tip reason and the beneficiary account ID.
• tip_value: The amount of tip that the sender would like to give. The median tip value of active tippers will be given to the who.

Emits TipClosing if the threshold of tippers has been reached and the countdown period has started.

• Complexity: O(T) where T is the number of tippers. decoding Tipper vec of length T, insert tip and check closing, T is charged as upper bound given by ContainsLengthBound. The actual cost depends on the implementation of T::Tippers.

  Actually weight could be lower as it depends on how many tips are in OpenTip but it is weighted as if almost full i.e of length T-1.

• DbReads: Tippers, Tips

• DbWrites: Tips

close_tip

Fields

hash: T::Hash

Close and payout a tip.

The dispatch origin for this call must be Signed.

The tip identified by hash must have finished its countdown period.

• hash: The identity of the open tip for which a tip value is declared. This is formed as the hash of the tuple of the original tip reason and the beneficiary account ID.

• Complexity: O(T) where T is the number of tippers. decoding Tipper vec of length T. T is charged as upper bound given by ContainsLengthBound. The actual cost depends on the implementation of T::Tippers.
• DbReads: Tips, Tippers, tip finder
• DbWrites: Reasons, Tips, Tippers, tip finder

slash_tip

Fields

hash: T::Hash

Remove and slash an already-open tip.

May only be called from T::RejectOrigin.

As a result, the finder is slashed and the deposits are lost.

Emits TipSlashed if successful.

T is charged as upper bound given by ContainsLengthBound. The actual cost depends on the implementation of T::Tippers.

Implementations

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

pub fn new_call_variant_report_awesome(
    reason: Vec<u8>,
    who: <<T as Config>::Lookup as StaticLookup>::Source
) -> Self

Create a call with the variant report_awesome.

pub fn new_call_variant_retract_tip(hash: T::Hash) -> Self

Create a call with the variant retract_tip.

pub fn new_call_variant_tip_new(
    reason: Vec<u8>,
    who: <<T as Config>::Lookup as StaticLookup>::Source,
    tip_value: BalanceOf<T, I>
) -> Self

Create a call with the variant tip_new.

pub fn new_call_variant_tip(hash: T::Hash, tip_value: BalanceOf<T, I>) -> Self

Create a call with the variant tip.

pub fn new_call_variant_close_tip(hash: T::Hash) -> Self

Create a call with the variant close_tip.

pub fn new_call_variant_slash_tip(hash: T::Hash) -> Self

Create a call with the variant slash_tip.

Trait Implementations

impl<T: Config<I>, I: 'static> Clone for Call<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: Config<I>, I: 'static> Debug for Call<T, I>

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

Formats the value using the given formatter.

impl<T: Config<I>, I: 'static> Decode for Call<T, I>

fn decode<__CodecInputEdqy: Input>(
    __codec_input_edqy: &mut __CodecInputEdqy
) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn skip<I>(input: &mut I) -> Result<(), Error>where
    I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<T: Config<I>, I: 'static> Encode for Call<T, I>

fn encode_to<__CodecOutputEdqy: Output + ?Sized>(
    &self,
    __codec_dest_edqy: &mut __CodecOutputEdqy
)

Convert self to a slice and append it to the destination.

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode(&self) -> Vec<u8, Global>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> Rwhere
    F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<T: Config<I>, I: 'static> GetCallName for Call<T, I>

fn get_call_name(&self) -> &'static str

Return the function name of the Call.

fn get_call_names() -> &'static [&'static str]

Return all function names.

impl<T: Config<I>, I: 'static> GetDispatchInfo for Call<T, I>

fn get_dispatch_info(&self) -> DispatchInfo

Return a DispatchInfo, containing relevant information of this dispatch.

impl<T: Config<I>, I: 'static> PartialEq<Call<T, I>> for Call<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, I> TypeInfo for Call<T, I>where
    PhantomData<(T, I)>: TypeInfo + 'static,
    <<T as Config>::Lookup as StaticLookup>::Source: TypeInfo + 'static,
    T::Hash: TypeInfo + 'static,
    BalanceOf<T, I>: HasCompact,
    T: Config<I> + 'static,
    I: 'static,

type Identity = Call<T, I>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<T: Config<I>, I: 'static> UnfilteredDispatchable for Call<T, I>

type Origin = <T as Config>::Origin

The origin type of the runtime, (i.e. frame_system::Config::Origin).

fn dispatch_bypass_filter(
    self,
    origin: Self::Origin
) -> DispatchResultWithPostInfo

Dispatch this call but do not check the filter in origin.

impl<T: Config<I>, I: 'static> EncodeLike<Call<T, I>> for Call<T, I>

impl<T: Config<I>, I: 'static> Eq for Call<T, I>