Tips¶

Calls¶

close_tip¶

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.

# <weight> - 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 # </weight>

Attributes¶

Name	Type
hash	`T::Hash`

Python¶

call = substrate.compose_call(
    'Tips', 'close_tip', {'hash': 'scale_info::9'}
)

report_awesome¶

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.

# <weight> - Complexity: O(R) where R length of reason. - encoding and hashing of 'reason' - DbReads: Reasons, Tips - DbWrites: Reasons, Tips # </weight>

Attributes¶

Name	Type
reason	`Vec<u8>`
who	`T::AccountId`

Python¶

call = substrate.compose_call(
    'Tips', 'report_awesome', {
    'reason': 'Bytes',
    'who': 'AccountId',
}
)

retract_tip¶

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.

# <weight> - Complexity: O(1) - Depends on the length of T::Hash which is fixed. - DbReads: Tips, origin account - DbWrites: Reasons, Tips, origin account # </weight>

Attributes¶

Name	Type
hash	`T::Hash`

Python¶

call = substrate.compose_call(
    'Tips', 'retract_tip', {'hash': 'scale_info::9'}
)

slash_tip¶

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.

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

Attributes¶

Name	Type
hash	`T::Hash`

Python¶

call = substrate.compose_call(
    'Tips', 'slash_tip', {'hash': 'scale_info::9'}
)

tip¶

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.

# <weight> - 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 # </weight>

Attributes¶

Name	Type
hash	`T::Hash`
tip_value	`BalanceOf<T>`

Python¶

call = substrate.compose_call(
    'Tips', 'tip', {
    'hash': 'scale_info::9',
    'tip_value': 'u128',
}
)

tip_new¶

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.

# <weight> - 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 # </weight>

Attributes¶

Name	Type
reason	`Vec<u8>`
who	`T::AccountId`
tip_value	`BalanceOf<T>`

Python¶

call = substrate.compose_call(
    'Tips', 'tip_new', {
    'reason': 'Bytes',
    'tip_value': 'u128',
    'who': 'AccountId',
}
)

Events¶

NewTip¶

A new tip suggestion has been opened.

Attributes¶

Name	Type	Composition
tip_hash	`T::Hash`	`scale_info::9`

TipClosed¶

A tip suggestion has been closed.

Attributes¶

Name	Type	Composition
tip_hash	`T::Hash`	`scale_info::9`
who	`T::AccountId`	`AccountId`
payout	`BalanceOf<T>`	`u128`

TipClosing¶

A tip suggestion has reached threshold and is closing.

Attributes¶

Name	Type	Composition
tip_hash	`T::Hash`	`scale_info::9`

TipRetracted¶

A tip suggestion has been retracted.

Attributes¶

Name	Type	Composition
tip_hash	`T::Hash`	`scale_info::9`

TipSlashed¶

A tip suggestion has been slashed.

Attributes¶

Name	Type	Composition
tip_hash	`T::Hash`	`scale_info::9`
finder	`T::AccountId`	`AccountId`
deposit	`BalanceOf<T>`	`u128`

Storage functions¶

Reasons¶

Simple preimage lookup from the reason's hash to the original data. Again, has an insecure enumerable hash since the key is guaranteed to be the result of a secure hash.

Python¶

result = substrate.query(
    'Tips', 'Reasons', ['scale_info::9']
)

Return value¶

'Bytes'

Tips¶

TipsMap that are not yet completed. Keyed by the hash of (reason, who) from the value. This has the insecure enumerable hash function since the key itself is already guaranteed to be a secure hash.

Python¶

result = substrate.query(
    'Tips', 'Tips', ['scale_info::9']
)

Return value¶

{
    'closes': (None, 'u32'),
    'deposit': 'u128',
    'finder': 'AccountId',
    'finders_fee': 'bool',
    'reason': 'scale_info::9',
    'tips': [('AccountId', 'u128')],
    'who': 'AccountId',
}

Constants¶

DataDepositPerByte¶

The amount held on deposit per byte within the tip report reason or bounty description.

Value¶

Python¶

constant = substrate.get_constant('Tips', 'DataDepositPerByte')

MaximumReasonLength¶

Maximum acceptable reason length.

Benchmarks depend on this value, be sure to update weights file when changing this value

Value¶

Python¶

constant = substrate.get_constant('Tips', 'MaximumReasonLength')

TipCountdown¶

The period for which a tip remains open after is has achieved threshold tippers.

Value¶

Python¶

constant = substrate.get_constant('Tips', 'TipCountdown')

TipFindersFee¶

The percent of the final tip which goes to the original reporter of the tip.

Value¶

Python¶

constant = substrate.get_constant('Tips', 'TipFindersFee')

TipReportDepositBase¶

The amount held on deposit for placing a tip report.

Value¶

Python¶

constant = substrate.get_constant('Tips', 'TipReportDepositBase')

Errors¶

AlreadyKnown¶

The tip was already found/started.

NotFinder¶

The account attempting to retract the tip is not the finder of the tip.

Premature¶

The tip cannot be claimed/closed because it's still in the countdown period.

ReasonTooBig¶

The reason given is just too big.

StillOpen¶

The tip cannot be claimed/closed because there are not enough tippers yet.

UnknownTip¶

The tip hash is unknown.