Nis¶

Calls¶

communify¶

See [Pallet::communify].

Attributes¶

Name	Type
index	`ReceiptIndex`

Python¶

call = substrate.compose_call(
    'Nis', 'communify', {'index': 'u32'}
)

fund_deficit¶

See [Pallet::fund_deficit].

Attributes¶

No attributes

Python¶

call = substrate.compose_call(
    'Nis', 'fund_deficit', {}
)

place_bid¶

See [Pallet::place_bid].

Attributes¶

Name	Type
amount	`BalanceOf<T>`
duration	`u32`

Python¶

call = substrate.compose_call(
    'Nis', 'place_bid', {'amount': 'u128', 'duration': 'u32'}
)

privatize¶

See [Pallet::privatize].

Attributes¶

Name	Type
index	`ReceiptIndex`

Python¶

call = substrate.compose_call(
    'Nis', 'privatize', {'index': 'u32'}
)

retract_bid¶

See [Pallet::retract_bid].

Attributes¶

Name	Type
amount	`BalanceOf<T>`
duration	`u32`

Python¶

call = substrate.compose_call(
    'Nis', 'retract_bid', {'amount': 'u128', 'duration': 'u32'}
)

thaw_communal¶

See [Pallet::thaw_communal].

Attributes¶

Name	Type
index	`ReceiptIndex`

Python¶

call = substrate.compose_call(
    'Nis', 'thaw_communal', {'index': 'u32'}
)

thaw_private¶

See [Pallet::thaw_private].

Attributes¶

Name	Type
index	`ReceiptIndex`
maybe_proportion	`Option<Perquintill>`

Python¶

call = substrate.compose_call(
    'Nis', 'thaw_private', {
    'index': 'u32',
    'maybe_proportion': (None, 'u64'),
}
)

Events¶

BidDropped¶

A bid was dropped from a queue because of another, more substantial, bid was present.

Attributes¶

Name	Type	Composition
who	`T::AccountId`	`AccountId`
amount	`BalanceOf<T>`	`u128`
duration	`u32`	`u32`

BidPlaced¶

A bid was successfully placed.

Attributes¶

Name	Type	Composition
who	`T::AccountId`	`AccountId`
amount	`BalanceOf<T>`	`u128`
duration	`u32`	`u32`

BidRetracted¶

A bid was successfully removed (before being accepted).

Attributes¶

Name	Type	Composition
who	`T::AccountId`	`AccountId`
amount	`BalanceOf<T>`	`u128`
duration	`u32`	`u32`

Funded¶

An automatic funding of the deficit was made.

Attributes¶

Name	Type	Composition
deficit	`BalanceOf<T>`	`u128`

Issued¶

A bid was accepted. The balance may not be released until expiry.

Attributes¶

Name	Type	Composition
index	`ReceiptIndex`	`u32`
expiry	`BlockNumberFor<T>`	`u32`
who	`T::AccountId`	`AccountId`
proportion	`Perquintill`	`u64`
amount	`BalanceOf<T>`	`u128`

Thawed¶

An receipt has been (at least partially) thawed.

Attributes¶

Name	Type	Composition
index	`ReceiptIndex`	`u32`
who	`T::AccountId`	`AccountId`
proportion	`Perquintill`	`u64`
amount	`BalanceOf<T>`	`u128`
dropped	`bool`	`bool`

Transferred¶

A receipt was transfered.

Attributes¶

Name	Type	Composition
from	`T::AccountId`	`AccountId`
to	`T::AccountId`	`AccountId`
index	`ReceiptIndex`	`u32`

Storage functions¶

QueueTotals¶

The totals of items and balances within each queue. Saves a lot of storage reads in the case of sparsely packed queues.

The vector is indexed by duration in Periods, offset by one, so information on the queue whose duration is one Period would be storage 0.

Python¶

result = substrate.query(
    'Nis', 'QueueTotals', []
)

Return value¶

[('u32', 'u128')]

Queues¶

The queues of bids. Indexed by duration (in Periods).

Python¶

result = substrate.query(
    'Nis', 'Queues', ['u32']
)

Return value¶

[{'amount': 'u128', 'who': 'AccountId'}]

Receipts¶

The currently outstanding receipts, indexed according to the order of creation.

Python¶

result = substrate.query(
    'Nis', 'Receipts', ['u32']
)

Return value¶

{'expiry': 'u32', 'owner': (None, ('AccountId', 'u128')), 'proportion': 'u64'}

Summary¶

Summary information over the general state.

Python¶

result = substrate.query(
    'Nis', 'Summary', []
)

Return value¶

{
    'index': 'u32',
    'last_period': 'u32',
    'proportion_owed': 'u64',
    'receipts_on_hold': 'u128',
    'thawed': 'u64',
}

Constants¶

BasePeriod¶

The base period for the duration queues. This is the common multiple across all supported freezing durations that can be bid upon.

Value¶

Python¶

constant = substrate.get_constant('Nis', 'BasePeriod')

FifoQueueLen¶

Portion of the queue which is free from ordering and just a FIFO.

Must be no greater than MaxQueueLen.

Value¶

Python¶

constant = substrate.get_constant('Nis', 'FifoQueueLen')

IntakePeriod¶

The number of blocks between consecutive attempts to dequeue bids and create receipts.

A larger value results in fewer storage hits each block, but a slower period to get to the target.

Value¶

Python¶

constant = substrate.get_constant('Nis', 'IntakePeriod')

MaxIntakeWeight¶

The maximum amount of bids that can consolidated into receipts in a single intake. A larger value here means less of the block available for transactions should there be a glut of bids.

Value¶

{'proof_size': 1844674407370955161, 'ref_time': 200000000000}

Python¶

constant = substrate.get_constant('Nis', 'MaxIntakeWeight')

MaxQueueLen¶

Maximum number of items that may be in each duration queue.

Must be larger than zero.

Value¶

Python¶

constant = substrate.get_constant('Nis', 'MaxQueueLen')

MinBid¶

The minimum amount of funds that may be placed in a bid. Note that this does not actually limit the amount which may be represented in a receipt since bids may be split up by the system.

It should be at least big enough to ensure that there is no possible storage spam attack or queue-filling attack.

Value¶

3333333333300

Python¶

constant = substrate.get_constant('Nis', 'MinBid')

MinReceipt¶

The minimum amount of funds which may intentionally be left remaining under a single receipt.

Value¶

100000000000

Python¶

constant = substrate.get_constant('Nis', 'MinReceipt')

PalletId¶

The treasury's pallet id, used for deriving its sovereign account ID.

Value¶

'0x70792f6e69732020'

Python¶

constant = substrate.get_constant('Nis', 'PalletId')

QueueCount¶

Number of duration queues in total. This sets the maximum duration supported, which is this value multiplied by Period.

Value¶

Python¶

constant = substrate.get_constant('Nis', 'QueueCount')

ThawThrottle¶

The maximum proportion which may be thawed and the period over which it is reset.

Value¶

(250000000000000000, 5)

Python¶

constant = substrate.get_constant('Nis', 'ThawThrottle')

Errors¶

AlreadyCommunal¶

The receipt is already communal.

AlreadyFunded¶

There are enough funds for what is required.

AlreadyPrivate¶

The receipt is already private.

AmountTooSmall¶

The amount of the bid is less than the minimum allowed.

BidTooLow¶

The queue for the bid's duration is full and the amount bid is too low to get in through replacing an existing bid.

DurationTooBig¶

The duration is the bid is greater than the number of queues.

DurationTooSmall¶

The duration of the bid is less than one.

MakesDust¶

The operation would result in a receipt worth an insignficant value.

NotExpired¶

Bond not yet at expiry date.

NotOwner¶

Not the owner of the receipt.

PortionTooBig¶

The portion supplied is beyond the value of the receipt.

Throttled¶

The thaw throttle has been reached for this period.

Unfunded¶

Not enough funds are held to pay out.

UnknownBid¶

The given bid for retraction is not found.

UnknownReceipt¶

Receipt index is unknown.