@polkadot/api-augment 14.0.1 → 14.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/cjs/base.d.ts +2 -0
  2. package/cjs/bundle.d.ts +2 -0
  3. package/cjs/index.d.ts +2 -0
  4. package/cjs/kusama/consts.d.ts +1044 -0
  5. package/cjs/kusama/errors.d.ts +2355 -0
  6. package/cjs/kusama/events.d.ts +2543 -0
  7. package/cjs/kusama/index.d.ts +8 -0
  8. package/cjs/kusama/query.d.ts +2378 -0
  9. package/cjs/kusama/registry.d.ts +3 -0
  10. package/cjs/kusama/runtime.d.ts +683 -0
  11. package/cjs/kusama/tx.d.ts +5778 -0
  12. package/cjs/packageDetect.d.ts +1 -0
  13. package/cjs/packageInfo.d.ts +6 -0
  14. package/cjs/packageInfo.js +1 -1
  15. package/cjs/polkadot/consts.d.ts +864 -0
  16. package/cjs/polkadot/errors.d.ts +1954 -0
  17. package/cjs/polkadot/events.d.ts +2024 -0
  18. package/cjs/polkadot/index.d.ts +8 -0
  19. package/cjs/polkadot/query.d.ts +2133 -0
  20. package/cjs/polkadot/registry.d.ts +2 -0
  21. package/cjs/polkadot/runtime.d.ts +683 -0
  22. package/cjs/polkadot/tx.d.ts +4932 -0
  23. package/cjs/substrate/consts.d.ts +1763 -0
  24. package/cjs/substrate/errors.d.ts +3409 -0
  25. package/cjs/substrate/events.d.ts +4300 -0
  26. package/cjs/substrate/index.d.ts +8 -0
  27. package/cjs/substrate/query.d.ts +2582 -0
  28. package/cjs/substrate/registry.d.ts +1 -0
  29. package/cjs/substrate/runtime.d.ts +577 -0
  30. package/cjs/substrate/tx.d.ts +10200 -0
  31. package/kusama/runtime.d.ts +253 -212
  32. package/package.json +368 -128
  33. package/packageInfo.js +1 -1
  34. package/polkadot/consts.d.ts +50 -66
  35. package/polkadot/errors.d.ts +114 -183
  36. package/polkadot/events.d.ts +83 -144
  37. package/polkadot/query.d.ts +159 -100
  38. package/polkadot/runtime.d.ts +315 -179
  39. package/polkadot/tx.d.ts +2770 -636
  40. package/substrate/runtime.d.ts +217 -175
@@ -0,0 +1,1044 @@
1
+ import '@polkadot/api-base/types/consts';
2
+ import type { ApiTypes, AugmentedConst } from '@polkadot/api-base/types';
3
+ import type { Bytes, Option, Vec, u128, u16, u32, u64, u8 } from '@polkadot/types-codec';
4
+ import type { Codec, ITuple } from '@polkadot/types-codec/types';
5
+ import type { Perbill, Permill, Perquintill } from '@polkadot/types/interfaces/runtime';
6
+ import type { FrameSupportPalletId, FrameSystemLimitsBlockLength, FrameSystemLimitsBlockWeights, PalletReferendaTrackInfo, SpVersionRuntimeVersion, SpWeightsRuntimeDbWeight, SpWeightsWeightV2Weight, StagingXcmV4Junctions } from '@polkadot/types/lookup';
7
+ export type __AugmentedConst<ApiType extends ApiTypes> = AugmentedConst<ApiType>;
8
+ declare module '@polkadot/api-base/types/consts' {
9
+ interface AugmentedConsts<ApiType extends ApiTypes> {
10
+ auctions: {
11
+ /**
12
+ * The number of blocks over which an auction may be retroactively ended.
13
+ **/
14
+ endingPeriod: u32 & AugmentedConst<ApiType>;
15
+ leasePeriodsPerSlot: u32 & AugmentedConst<ApiType>;
16
+ /**
17
+ * The length of each sample to take during the ending period.
18
+ *
19
+ * `EndingPeriod` / `SampleLength` = Total # of Samples
20
+ **/
21
+ sampleLength: u32 & AugmentedConst<ApiType>;
22
+ slotRangeCount: u32 & AugmentedConst<ApiType>;
23
+ /**
24
+ * Generic const
25
+ **/
26
+ [key: string]: Codec;
27
+ };
28
+ babe: {
29
+ /**
30
+ * The amount of time, in slots, that each epoch should last.
31
+ * NOTE: Currently it is not possible to change the epoch duration after
32
+ * the chain has started. Attempting to do so will brick block production.
33
+ **/
34
+ epochDuration: u64 & AugmentedConst<ApiType>;
35
+ /**
36
+ * The expected average block time at which BABE should be creating
37
+ * blocks. Since BABE is probabilistic it is not trivial to figure out
38
+ * what the expected average block time should be based on the slot
39
+ * duration and the security parameter `c` (where `1 - c` represents
40
+ * the probability of a slot being empty).
41
+ **/
42
+ expectedBlockTime: u64 & AugmentedConst<ApiType>;
43
+ /**
44
+ * Max number of authorities allowed
45
+ **/
46
+ maxAuthorities: u32 & AugmentedConst<ApiType>;
47
+ /**
48
+ * The maximum number of nominators for each validator.
49
+ **/
50
+ maxNominators: u32 & AugmentedConst<ApiType>;
51
+ /**
52
+ * Generic const
53
+ **/
54
+ [key: string]: Codec;
55
+ };
56
+ balances: {
57
+ /**
58
+ * The minimum amount required to keep an account open. MUST BE GREATER THAN ZERO!
59
+ *
60
+ * If you *really* need it to be zero, you can enable the feature `insecure_zero_ed` for
61
+ * this pallet. However, you do so at your own risk: this will open up a major DoS vector.
62
+ * In case you have multiple sources of provider references, you may also get unexpected
63
+ * behaviour if you set this to zero.
64
+ *
65
+ * Bottom line: Do yourself a favour and make it at least one!
66
+ **/
67
+ existentialDeposit: u128 & AugmentedConst<ApiType>;
68
+ /**
69
+ * The maximum number of individual freeze locks that can exist on an account at any time.
70
+ **/
71
+ maxFreezes: u32 & AugmentedConst<ApiType>;
72
+ /**
73
+ * The maximum number of locks that should exist on an account.
74
+ * Not strictly enforced, but used for weight estimation.
75
+ *
76
+ * Use of locks is deprecated in favour of freezes. See `https://github.com/paritytech/substrate/pull/12951/`
77
+ **/
78
+ maxLocks: u32 & AugmentedConst<ApiType>;
79
+ /**
80
+ * The maximum number of named reserves that can exist on an account.
81
+ *
82
+ * Use of reserves is deprecated in favour of holds. See `https://github.com/paritytech/substrate/pull/12951/`
83
+ **/
84
+ maxReserves: u32 & AugmentedConst<ApiType>;
85
+ /**
86
+ * Generic const
87
+ **/
88
+ [key: string]: Codec;
89
+ };
90
+ beefy: {
91
+ /**
92
+ * The maximum number of authorities that can be added.
93
+ **/
94
+ maxAuthorities: u32 & AugmentedConst<ApiType>;
95
+ /**
96
+ * The maximum number of nominators for each validator.
97
+ **/
98
+ maxNominators: u32 & AugmentedConst<ApiType>;
99
+ /**
100
+ * The maximum number of entries to keep in the set id to session index mapping.
101
+ *
102
+ * Since the `SetIdSession` map is only used for validating equivocations this
103
+ * value should relate to the bonding duration of whatever staking system is
104
+ * being used (if any). If equivocation handling is not enabled then this value
105
+ * can be zero.
106
+ **/
107
+ maxSetIdSessionEntries: u64 & AugmentedConst<ApiType>;
108
+ /**
109
+ * Generic const
110
+ **/
111
+ [key: string]: Codec;
112
+ };
113
+ bounties: {
114
+ /**
115
+ * The amount held on deposit for placing a bounty proposal.
116
+ **/
117
+ bountyDepositBase: u128 & AugmentedConst<ApiType>;
118
+ /**
119
+ * The delay period for which a bounty beneficiary need to wait before claim the payout.
120
+ **/
121
+ bountyDepositPayoutDelay: u32 & AugmentedConst<ApiType>;
122
+ /**
123
+ * Bounty duration in blocks.
124
+ **/
125
+ bountyUpdatePeriod: u32 & AugmentedConst<ApiType>;
126
+ /**
127
+ * Minimum value for a bounty.
128
+ **/
129
+ bountyValueMinimum: u128 & AugmentedConst<ApiType>;
130
+ /**
131
+ * Maximum amount of funds that should be placed in a deposit for making a proposal.
132
+ **/
133
+ curatorDepositMax: Option<u128> & AugmentedConst<ApiType>;
134
+ /**
135
+ * Minimum amount of funds that should be placed in a deposit for making a proposal.
136
+ **/
137
+ curatorDepositMin: Option<u128> & AugmentedConst<ApiType>;
138
+ /**
139
+ * The curator deposit is calculated as a percentage of the curator fee.
140
+ *
141
+ * This deposit has optional upper and lower bounds with `CuratorDepositMax` and
142
+ * `CuratorDepositMin`.
143
+ **/
144
+ curatorDepositMultiplier: Permill & AugmentedConst<ApiType>;
145
+ /**
146
+ * The amount held on deposit per byte within the tip report reason or bounty description.
147
+ **/
148
+ dataDepositPerByte: u128 & AugmentedConst<ApiType>;
149
+ /**
150
+ * Maximum acceptable reason length.
151
+ *
152
+ * Benchmarks depend on this value, be sure to update weights file when changing this value
153
+ **/
154
+ maximumReasonLength: u32 & AugmentedConst<ApiType>;
155
+ /**
156
+ * Generic const
157
+ **/
158
+ [key: string]: Codec;
159
+ };
160
+ childBounties: {
161
+ /**
162
+ * Minimum value for a child-bounty.
163
+ **/
164
+ childBountyValueMinimum: u128 & AugmentedConst<ApiType>;
165
+ /**
166
+ * Maximum number of child bounties that can be added to a parent bounty.
167
+ **/
168
+ maxActiveChildBountyCount: u32 & AugmentedConst<ApiType>;
169
+ /**
170
+ * Generic const
171
+ **/
172
+ [key: string]: Codec;
173
+ };
174
+ claims: {
175
+ prefix: Bytes & AugmentedConst<ApiType>;
176
+ /**
177
+ * Generic const
178
+ **/
179
+ [key: string]: Codec;
180
+ };
181
+ convictionVoting: {
182
+ /**
183
+ * The maximum number of concurrent votes an account may have.
184
+ *
185
+ * Also used to compute weight, an overly large value can lead to extrinsics with large
186
+ * weight estimation: see `delegate` for instance.
187
+ **/
188
+ maxVotes: u32 & AugmentedConst<ApiType>;
189
+ /**
190
+ * The minimum period of vote locking.
191
+ *
192
+ * It should be no shorter than enactment period to ensure that in the case of an approval,
193
+ * those successful voters are locked into the consequences that their votes entail.
194
+ **/
195
+ voteLockingPeriod: u32 & AugmentedConst<ApiType>;
196
+ /**
197
+ * Generic const
198
+ **/
199
+ [key: string]: Codec;
200
+ };
201
+ coretime: {
202
+ /**
203
+ * The ParaId of the coretime chain.
204
+ **/
205
+ brokerId: u32 & AugmentedConst<ApiType>;
206
+ /**
207
+ * The coretime chain pot location.
208
+ **/
209
+ brokerPotLocation: StagingXcmV4Junctions & AugmentedConst<ApiType>;
210
+ /**
211
+ * Generic const
212
+ **/
213
+ [key: string]: Codec;
214
+ };
215
+ crowdloan: {
216
+ /**
217
+ * The minimum amount that may be contributed into a crowdloan. Should almost certainly be
218
+ * at least `ExistentialDeposit`.
219
+ **/
220
+ minContribution: u128 & AugmentedConst<ApiType>;
221
+ /**
222
+ * `PalletId` for the crowdloan pallet. An appropriate value could be
223
+ * `PalletId(*b"py/cfund")`
224
+ **/
225
+ palletId: FrameSupportPalletId & AugmentedConst<ApiType>;
226
+ /**
227
+ * Max number of storage keys to remove per extrinsic call.
228
+ **/
229
+ removeKeysLimit: u32 & AugmentedConst<ApiType>;
230
+ /**
231
+ * Generic const
232
+ **/
233
+ [key: string]: Codec;
234
+ };
235
+ electionProviderMultiPhase: {
236
+ /**
237
+ * The minimum amount of improvement to the solution score that defines a solution as
238
+ * "better" in the Signed phase.
239
+ **/
240
+ betterSignedThreshold: Perbill & AugmentedConst<ApiType>;
241
+ /**
242
+ * The maximum number of winners that can be elected by this `ElectionProvider`
243
+ * implementation.
244
+ *
245
+ * Note: This must always be greater or equal to `T::DataProvider::desired_targets()`.
246
+ **/
247
+ maxWinners: u32 & AugmentedConst<ApiType>;
248
+ minerMaxLength: u32 & AugmentedConst<ApiType>;
249
+ minerMaxVotesPerVoter: u32 & AugmentedConst<ApiType>;
250
+ minerMaxWeight: SpWeightsWeightV2Weight & AugmentedConst<ApiType>;
251
+ minerMaxWinners: u32 & AugmentedConst<ApiType>;
252
+ /**
253
+ * The priority of the unsigned transaction submitted in the unsigned-phase
254
+ **/
255
+ minerTxPriority: u64 & AugmentedConst<ApiType>;
256
+ /**
257
+ * The repeat threshold of the offchain worker.
258
+ *
259
+ * For example, if it is 5, that means that at least 5 blocks will elapse between attempts
260
+ * to submit the worker's solution.
261
+ **/
262
+ offchainRepeat: u32 & AugmentedConst<ApiType>;
263
+ /**
264
+ * Per-byte deposit for a signed solution.
265
+ **/
266
+ signedDepositByte: u128 & AugmentedConst<ApiType>;
267
+ /**
268
+ * Per-weight deposit for a signed solution.
269
+ **/
270
+ signedDepositWeight: u128 & AugmentedConst<ApiType>;
271
+ /**
272
+ * The maximum amount of unchecked solutions to refund the call fee for.
273
+ **/
274
+ signedMaxRefunds: u32 & AugmentedConst<ApiType>;
275
+ /**
276
+ * Maximum number of signed submissions that can be queued.
277
+ *
278
+ * It is best to avoid adjusting this during an election, as it impacts downstream data
279
+ * structures. In particular, `SignedSubmissionIndices<T>` is bounded on this value. If you
280
+ * update this value during an election, you _must_ ensure that
281
+ * `SignedSubmissionIndices.len()` is less than or equal to the new value. Otherwise,
282
+ * attempts to submit new solutions may cause a runtime panic.
283
+ **/
284
+ signedMaxSubmissions: u32 & AugmentedConst<ApiType>;
285
+ /**
286
+ * Maximum weight of a signed solution.
287
+ *
288
+ * If [`Config::MinerConfig`] is being implemented to submit signed solutions (outside of
289
+ * this pallet), then [`MinerConfig::solution_weight`] is used to compare against
290
+ * this value.
291
+ **/
292
+ signedMaxWeight: SpWeightsWeightV2Weight & AugmentedConst<ApiType>;
293
+ /**
294
+ * Base reward for a signed solution
295
+ **/
296
+ signedRewardBase: u128 & AugmentedConst<ApiType>;
297
+ /**
298
+ * Generic const
299
+ **/
300
+ [key: string]: Codec;
301
+ };
302
+ fastUnstake: {
303
+ /**
304
+ * Deposit to take for unstaking, to make sure we're able to slash the it in order to cover
305
+ * the costs of resources on unsuccessful unstake.
306
+ **/
307
+ deposit: u128 & AugmentedConst<ApiType>;
308
+ /**
309
+ * Generic const
310
+ **/
311
+ [key: string]: Codec;
312
+ };
313
+ fellowshipReferenda: {
314
+ /**
315
+ * Quantization level for the referendum wakeup scheduler. A higher number will result in
316
+ * fewer storage reads/writes needed for smaller voters, but also result in delays to the
317
+ * automatic referendum status changes. Explicit servicing instructions are unaffected.
318
+ **/
319
+ alarmInterval: u32 & AugmentedConst<ApiType>;
320
+ /**
321
+ * Maximum size of the referendum queue for a single track.
322
+ **/
323
+ maxQueued: u32 & AugmentedConst<ApiType>;
324
+ /**
325
+ * The minimum amount to be used as a deposit for a public referendum proposal.
326
+ **/
327
+ submissionDeposit: u128 & AugmentedConst<ApiType>;
328
+ /**
329
+ * Information concerning the different referendum tracks.
330
+ **/
331
+ tracks: Vec<ITuple<[u16, PalletReferendaTrackInfo]>> & AugmentedConst<ApiType>;
332
+ /**
333
+ * The number of blocks after submission that a referendum must begin being decided by.
334
+ * Once this passes, then anyone may cancel the referendum.
335
+ **/
336
+ undecidingTimeout: u32 & AugmentedConst<ApiType>;
337
+ /**
338
+ * Generic const
339
+ **/
340
+ [key: string]: Codec;
341
+ };
342
+ grandpa: {
343
+ /**
344
+ * Max Authorities in use
345
+ **/
346
+ maxAuthorities: u32 & AugmentedConst<ApiType>;
347
+ /**
348
+ * The maximum number of nominators for each validator.
349
+ **/
350
+ maxNominators: u32 & AugmentedConst<ApiType>;
351
+ /**
352
+ * The maximum number of entries to keep in the set id to session index mapping.
353
+ *
354
+ * Since the `SetIdSession` map is only used for validating equivocations this
355
+ * value should relate to the bonding duration of whatever staking system is
356
+ * being used (if any). If equivocation handling is not enabled then this value
357
+ * can be zero.
358
+ **/
359
+ maxSetIdSessionEntries: u64 & AugmentedConst<ApiType>;
360
+ /**
361
+ * Generic const
362
+ **/
363
+ [key: string]: Codec;
364
+ };
365
+ indices: {
366
+ /**
367
+ * The deposit needed for reserving an index.
368
+ **/
369
+ deposit: u128 & AugmentedConst<ApiType>;
370
+ /**
371
+ * Generic const
372
+ **/
373
+ [key: string]: Codec;
374
+ };
375
+ messageQueue: {
376
+ /**
377
+ * The size of the page; this implies the maximum message size which can be sent.
378
+ *
379
+ * A good value depends on the expected message sizes, their weights, the weight that is
380
+ * available for processing them and the maximal needed message size. The maximal message
381
+ * size is slightly lower than this as defined by [`MaxMessageLenOf`].
382
+ **/
383
+ heapSize: u32 & AugmentedConst<ApiType>;
384
+ /**
385
+ * The maximum amount of weight (if any) to be used from remaining weight `on_idle` which
386
+ * should be provided to the message queue for servicing enqueued items `on_idle`.
387
+ * Useful for parachains to process messages at the same block they are received.
388
+ *
389
+ * If `None`, it will not call `ServiceQueues::service_queues` in `on_idle`.
390
+ **/
391
+ idleMaxServiceWeight: Option<SpWeightsWeightV2Weight> & AugmentedConst<ApiType>;
392
+ /**
393
+ * The maximum number of stale pages (i.e. of overweight messages) allowed before culling
394
+ * can happen. Once there are more stale pages than this, then historical pages may be
395
+ * dropped, even if they contain unprocessed overweight messages.
396
+ **/
397
+ maxStale: u32 & AugmentedConst<ApiType>;
398
+ /**
399
+ * The amount of weight (if any) which should be provided to the message queue for
400
+ * servicing enqueued items `on_initialize`.
401
+ *
402
+ * This may be legitimately `None` in the case that you will call
403
+ * `ServiceQueues::service_queues` manually or set [`Self::IdleMaxServiceWeight`] to have
404
+ * it run in `on_idle`.
405
+ **/
406
+ serviceWeight: Option<SpWeightsWeightV2Weight> & AugmentedConst<ApiType>;
407
+ /**
408
+ * Generic const
409
+ **/
410
+ [key: string]: Codec;
411
+ };
412
+ multisig: {
413
+ /**
414
+ * The base amount of currency needed to reserve for creating a multisig execution or to
415
+ * store a dispatch call for later.
416
+ *
417
+ * This is held for an additional storage item whose value size is
418
+ * `4 + sizeof((BlockNumber, Balance, AccountId))` bytes and whose key size is
419
+ * `32 + sizeof(AccountId)` bytes.
420
+ **/
421
+ depositBase: u128 & AugmentedConst<ApiType>;
422
+ /**
423
+ * The amount of currency needed per unit threshold when creating a multisig execution.
424
+ *
425
+ * This is held for adding 32 bytes more into a pre-existing storage value.
426
+ **/
427
+ depositFactor: u128 & AugmentedConst<ApiType>;
428
+ /**
429
+ * The maximum amount of signatories allowed in the multisig.
430
+ **/
431
+ maxSignatories: u32 & AugmentedConst<ApiType>;
432
+ /**
433
+ * Generic const
434
+ **/
435
+ [key: string]: Codec;
436
+ };
437
+ nis: {
438
+ /**
439
+ * The base period for the duration queues. This is the common multiple across all
440
+ * supported freezing durations that can be bid upon.
441
+ **/
442
+ basePeriod: u32 & AugmentedConst<ApiType>;
443
+ /**
444
+ * Portion of the queue which is free from ordering and just a FIFO.
445
+ *
446
+ * Must be no greater than `MaxQueueLen`.
447
+ **/
448
+ fifoQueueLen: u32 & AugmentedConst<ApiType>;
449
+ /**
450
+ * The number of blocks between consecutive attempts to dequeue bids and create receipts.
451
+ *
452
+ * A larger value results in fewer storage hits each block, but a slower period to get to
453
+ * the target.
454
+ **/
455
+ intakePeriod: u32 & AugmentedConst<ApiType>;
456
+ /**
457
+ * The maximum amount of bids that can consolidated into receipts in a single intake. A
458
+ * larger value here means less of the block available for transactions should there be a
459
+ * glut of bids.
460
+ **/
461
+ maxIntakeWeight: SpWeightsWeightV2Weight & AugmentedConst<ApiType>;
462
+ /**
463
+ * Maximum number of items that may be in each duration queue.
464
+ *
465
+ * Must be larger than zero.
466
+ **/
467
+ maxQueueLen: u32 & AugmentedConst<ApiType>;
468
+ /**
469
+ * The minimum amount of funds that may be placed in a bid. Note that this
470
+ * does not actually limit the amount which may be represented in a receipt since bids may
471
+ * be split up by the system.
472
+ *
473
+ * It should be at least big enough to ensure that there is no possible storage spam attack
474
+ * or queue-filling attack.
475
+ **/
476
+ minBid: u128 & AugmentedConst<ApiType>;
477
+ /**
478
+ * The minimum amount of funds which may intentionally be left remaining under a single
479
+ * receipt.
480
+ **/
481
+ minReceipt: Perquintill & AugmentedConst<ApiType>;
482
+ /**
483
+ * The treasury's pallet id, used for deriving its sovereign account ID.
484
+ **/
485
+ palletId: FrameSupportPalletId & AugmentedConst<ApiType>;
486
+ /**
487
+ * Number of duration queues in total. This sets the maximum duration supported, which is
488
+ * this value multiplied by `Period`.
489
+ **/
490
+ queueCount: u32 & AugmentedConst<ApiType>;
491
+ /**
492
+ * The maximum proportion which may be thawed and the period over which it is reset.
493
+ **/
494
+ thawThrottle: ITuple<[Perquintill, u32]> & AugmentedConst<ApiType>;
495
+ /**
496
+ * Generic const
497
+ **/
498
+ [key: string]: Codec;
499
+ };
500
+ nisCounterpartBalances: {
501
+ /**
502
+ * The minimum amount required to keep an account open. MUST BE GREATER THAN ZERO!
503
+ *
504
+ * If you *really* need it to be zero, you can enable the feature `insecure_zero_ed` for
505
+ * this pallet. However, you do so at your own risk: this will open up a major DoS vector.
506
+ * In case you have multiple sources of provider references, you may also get unexpected
507
+ * behaviour if you set this to zero.
508
+ *
509
+ * Bottom line: Do yourself a favour and make it at least one!
510
+ **/
511
+ existentialDeposit: u128 & AugmentedConst<ApiType>;
512
+ /**
513
+ * The maximum number of individual freeze locks that can exist on an account at any time.
514
+ **/
515
+ maxFreezes: u32 & AugmentedConst<ApiType>;
516
+ /**
517
+ * The maximum number of locks that should exist on an account.
518
+ * Not strictly enforced, but used for weight estimation.
519
+ *
520
+ * Use of locks is deprecated in favour of freezes. See `https://github.com/paritytech/substrate/pull/12951/`
521
+ **/
522
+ maxLocks: u32 & AugmentedConst<ApiType>;
523
+ /**
524
+ * The maximum number of named reserves that can exist on an account.
525
+ *
526
+ * Use of reserves is deprecated in favour of holds. See `https://github.com/paritytech/substrate/pull/12951/`
527
+ **/
528
+ maxReserves: u32 & AugmentedConst<ApiType>;
529
+ /**
530
+ * Generic const
531
+ **/
532
+ [key: string]: Codec;
533
+ };
534
+ nominationPools: {
535
+ /**
536
+ * The maximum pool points-to-balance ratio that an `open` pool can have.
537
+ *
538
+ * This is important in the event slashing takes place and the pool's points-to-balance
539
+ * ratio becomes disproportional.
540
+ *
541
+ * Moreover, this relates to the `RewardCounter` type as well, as the arithmetic operations
542
+ * are a function of number of points, and by setting this value to e.g. 10, you ensure
543
+ * that the total number of points in the system are at most 10 times the total_issuance of
544
+ * the chain, in the absolute worse case.
545
+ *
546
+ * For a value of 10, the threshold would be a pool points-to-balance ratio of 10:1.
547
+ * Such a scenario would also be the equivalent of the pool being 90% slashed.
548
+ **/
549
+ maxPointsToBalance: u8 & AugmentedConst<ApiType>;
550
+ /**
551
+ * The maximum number of simultaneous unbonding chunks that can exist per member.
552
+ **/
553
+ maxUnbonding: u32 & AugmentedConst<ApiType>;
554
+ /**
555
+ * The nomination pool's pallet id.
556
+ **/
557
+ palletId: FrameSupportPalletId & AugmentedConst<ApiType>;
558
+ /**
559
+ * Generic const
560
+ **/
561
+ [key: string]: Codec;
562
+ };
563
+ onDemandAssignmentProvider: {
564
+ /**
565
+ * The maximum number of blocks some historical revenue
566
+ * information stored for.
567
+ **/
568
+ maxHistoricalRevenue: u32 & AugmentedConst<ApiType>;
569
+ /**
570
+ * Identifier for the internal revenue balance.
571
+ **/
572
+ palletId: FrameSupportPalletId & AugmentedConst<ApiType>;
573
+ /**
574
+ * The default value for the spot traffic multiplier.
575
+ **/
576
+ trafficDefaultValue: u128 & AugmentedConst<ApiType>;
577
+ /**
578
+ * Generic const
579
+ **/
580
+ [key: string]: Codec;
581
+ };
582
+ paras: {
583
+ unsignedPriority: u64 & AugmentedConst<ApiType>;
584
+ /**
585
+ * Generic const
586
+ **/
587
+ [key: string]: Codec;
588
+ };
589
+ proxy: {
590
+ /**
591
+ * The base amount of currency needed to reserve for creating an announcement.
592
+ *
593
+ * This is held when a new storage item holding a `Balance` is created (typically 16
594
+ * bytes).
595
+ **/
596
+ announcementDepositBase: u128 & AugmentedConst<ApiType>;
597
+ /**
598
+ * The amount of currency needed per announcement made.
599
+ *
600
+ * This is held for adding an `AccountId`, `Hash` and `BlockNumber` (typically 68 bytes)
601
+ * into a pre-existing storage value.
602
+ **/
603
+ announcementDepositFactor: u128 & AugmentedConst<ApiType>;
604
+ /**
605
+ * The maximum amount of time-delayed announcements that are allowed to be pending.
606
+ **/
607
+ maxPending: u32 & AugmentedConst<ApiType>;
608
+ /**
609
+ * The maximum amount of proxies allowed for a single account.
610
+ **/
611
+ maxProxies: u32 & AugmentedConst<ApiType>;
612
+ /**
613
+ * The base amount of currency needed to reserve for creating a proxy.
614
+ *
615
+ * This is held for an additional storage item whose value size is
616
+ * `sizeof(Balance)` bytes and whose key size is `sizeof(AccountId)` bytes.
617
+ **/
618
+ proxyDepositBase: u128 & AugmentedConst<ApiType>;
619
+ /**
620
+ * The amount of currency needed per proxy added.
621
+ *
622
+ * This is held for adding 32 bytes plus an instance of `ProxyType` more into a
623
+ * pre-existing storage value. Thus, when configuring `ProxyDepositFactor` one should take
624
+ * into account `32 + proxy_type.encode().len()` bytes of data.
625
+ **/
626
+ proxyDepositFactor: u128 & AugmentedConst<ApiType>;
627
+ /**
628
+ * Generic const
629
+ **/
630
+ [key: string]: Codec;
631
+ };
632
+ recovery: {
633
+ /**
634
+ * The base amount of currency needed to reserve for creating a recovery configuration.
635
+ *
636
+ * This is held for an additional storage item whose value size is
637
+ * `2 + sizeof(BlockNumber, Balance)` bytes.
638
+ **/
639
+ configDepositBase: u128 & AugmentedConst<ApiType>;
640
+ /**
641
+ * The amount of currency needed per additional user when creating a recovery
642
+ * configuration.
643
+ *
644
+ * This is held for adding `sizeof(AccountId)` bytes more into a pre-existing storage
645
+ * value.
646
+ **/
647
+ friendDepositFactor: u128 & AugmentedConst<ApiType>;
648
+ /**
649
+ * The maximum amount of friends allowed in a recovery configuration.
650
+ *
651
+ * NOTE: The threshold programmed in this Pallet uses u16, so it does
652
+ * not really make sense to have a limit here greater than u16::MAX.
653
+ * But also, that is a lot more than you should probably set this value
654
+ * to anyway...
655
+ **/
656
+ maxFriends: u32 & AugmentedConst<ApiType>;
657
+ /**
658
+ * The base amount of currency needed to reserve for starting a recovery.
659
+ *
660
+ * This is primarily held for deterring malicious recovery attempts, and should
661
+ * have a value large enough that a bad actor would choose not to place this
662
+ * deposit. It also acts to fund additional storage item whose value size is
663
+ * `sizeof(BlockNumber, Balance + T * AccountId)` bytes. Where T is a configurable
664
+ * threshold.
665
+ **/
666
+ recoveryDeposit: u128 & AugmentedConst<ApiType>;
667
+ /**
668
+ * Generic const
669
+ **/
670
+ [key: string]: Codec;
671
+ };
672
+ referenda: {
673
+ /**
674
+ * Quantization level for the referendum wakeup scheduler. A higher number will result in
675
+ * fewer storage reads/writes needed for smaller voters, but also result in delays to the
676
+ * automatic referendum status changes. Explicit servicing instructions are unaffected.
677
+ **/
678
+ alarmInterval: u32 & AugmentedConst<ApiType>;
679
+ /**
680
+ * Maximum size of the referendum queue for a single track.
681
+ **/
682
+ maxQueued: u32 & AugmentedConst<ApiType>;
683
+ /**
684
+ * The minimum amount to be used as a deposit for a public referendum proposal.
685
+ **/
686
+ submissionDeposit: u128 & AugmentedConst<ApiType>;
687
+ /**
688
+ * Information concerning the different referendum tracks.
689
+ **/
690
+ tracks: Vec<ITuple<[u16, PalletReferendaTrackInfo]>> & AugmentedConst<ApiType>;
691
+ /**
692
+ * The number of blocks after submission that a referendum must begin being decided by.
693
+ * Once this passes, then anyone may cancel the referendum.
694
+ **/
695
+ undecidingTimeout: u32 & AugmentedConst<ApiType>;
696
+ /**
697
+ * Generic const
698
+ **/
699
+ [key: string]: Codec;
700
+ };
701
+ registrar: {
702
+ /**
703
+ * The deposit to be paid per byte stored on chain.
704
+ **/
705
+ dataDepositPerByte: u128 & AugmentedConst<ApiType>;
706
+ /**
707
+ * The deposit to be paid to run a on-demand parachain.
708
+ * This should include the cost for storing the genesis head and validation code.
709
+ **/
710
+ paraDeposit: u128 & AugmentedConst<ApiType>;
711
+ /**
712
+ * Generic const
713
+ **/
714
+ [key: string]: Codec;
715
+ };
716
+ scheduler: {
717
+ /**
718
+ * The maximum weight that may be scheduled per block for any dispatchables.
719
+ **/
720
+ maximumWeight: SpWeightsWeightV2Weight & AugmentedConst<ApiType>;
721
+ /**
722
+ * The maximum number of scheduled calls in the queue for a single block.
723
+ *
724
+ * NOTE:
725
+ * + Dependent pallets' benchmarks might require a higher limit for the setting. Set a
726
+ * higher limit under `runtime-benchmarks` feature.
727
+ **/
728
+ maxScheduledPerBlock: u32 & AugmentedConst<ApiType>;
729
+ /**
730
+ * Generic const
731
+ **/
732
+ [key: string]: Codec;
733
+ };
734
+ slots: {
735
+ /**
736
+ * The number of blocks to offset each lease period by.
737
+ **/
738
+ leaseOffset: u32 & AugmentedConst<ApiType>;
739
+ /**
740
+ * The number of blocks over which a single period lasts.
741
+ **/
742
+ leasePeriod: u32 & AugmentedConst<ApiType>;
743
+ /**
744
+ * Generic const
745
+ **/
746
+ [key: string]: Codec;
747
+ };
748
+ society: {
749
+ /**
750
+ * The number of blocks between membership challenges.
751
+ **/
752
+ challengePeriod: u32 & AugmentedConst<ApiType>;
753
+ /**
754
+ * The number of blocks on which new candidates can claim their membership and be the
755
+ * named head.
756
+ **/
757
+ claimPeriod: u32 & AugmentedConst<ApiType>;
758
+ /**
759
+ * The maximum number of strikes before a member gets funds slashed.
760
+ **/
761
+ graceStrikes: u32 & AugmentedConst<ApiType>;
762
+ /**
763
+ * The maximum number of bids at once.
764
+ **/
765
+ maxBids: u32 & AugmentedConst<ApiType>;
766
+ /**
767
+ * The maximum duration of the payout lock.
768
+ **/
769
+ maxLockDuration: u32 & AugmentedConst<ApiType>;
770
+ /**
771
+ * The maximum number of payouts a member may have waiting unclaimed.
772
+ **/
773
+ maxPayouts: u32 & AugmentedConst<ApiType>;
774
+ /**
775
+ * The societies's pallet id
776
+ **/
777
+ palletId: FrameSupportPalletId & AugmentedConst<ApiType>;
778
+ /**
779
+ * The amount of incentive paid within each period. Doesn't include VoterTip.
780
+ **/
781
+ periodSpend: u128 & AugmentedConst<ApiType>;
782
+ /**
783
+ * The number of blocks on which new candidates should be voted on. Together with
784
+ * `ClaimPeriod`, this sums to the number of blocks between candidate intake periods.
785
+ **/
786
+ votingPeriod: u32 & AugmentedConst<ApiType>;
787
+ /**
788
+ * Generic const
789
+ **/
790
+ [key: string]: Codec;
791
+ };
792
+ staking: {
793
+ /**
794
+ * Number of eras that staked funds must remain bonded for.
795
+ **/
796
+ bondingDuration: u32 & AugmentedConst<ApiType>;
797
+ /**
798
+ * Number of eras to keep in history.
799
+ *
800
+ * Following information is kept for eras in `[current_era -
801
+ * HistoryDepth, current_era]`: `ErasStakers`, `ErasStakersClipped`,
802
+ * `ErasValidatorPrefs`, `ErasValidatorReward`, `ErasRewardPoints`,
803
+ * `ErasTotalStake`, `ErasStartSessionIndex`, `ClaimedRewards`, `ErasStakersPaged`,
804
+ * `ErasStakersOverview`.
805
+ *
806
+ * Must be more than the number of eras delayed by session.
807
+ * I.e. active era must always be in history. I.e. `active_era >
808
+ * current_era - history_depth` must be guaranteed.
809
+ *
810
+ * If migrating an existing pallet from storage value to config value,
811
+ * this should be set to same value or greater as in storage.
812
+ *
813
+ * Note: `HistoryDepth` is used as the upper bound for the `BoundedVec`
814
+ * item `StakingLedger.legacy_claimed_rewards`. Setting this value lower than
815
+ * the existing value can lead to inconsistencies in the
816
+ * `StakingLedger` and will need to be handled properly in a migration.
817
+ * The test `reducing_history_depth_abrupt` shows this effect.
818
+ **/
819
+ historyDepth: u32 & AugmentedConst<ApiType>;
820
+ /**
821
+ * The maximum size of each `T::ExposurePage`.
822
+ *
823
+ * An `ExposurePage` is weakly bounded to a maximum of `MaxExposurePageSize`
824
+ * nominators.
825
+ *
826
+ * For older non-paged exposure, a reward payout was restricted to the top
827
+ * `MaxExposurePageSize` nominators. This is to limit the i/o cost for the
828
+ * nominator payout.
829
+ *
830
+ * Note: `MaxExposurePageSize` is used to bound `ClaimedRewards` and is unsafe to reduce
831
+ * without handling it in a migration.
832
+ **/
833
+ maxExposurePageSize: u32 & AugmentedConst<ApiType>;
834
+ /**
835
+ * The maximum number of `unlocking` chunks a [`StakingLedger`] can
836
+ * have. Effectively determines how many unique eras a staker may be
837
+ * unbonding in.
838
+ *
839
+ * Note: `MaxUnlockingChunks` is used as the upper bound for the
840
+ * `BoundedVec` item `StakingLedger.unlocking`. Setting this value
841
+ * lower than the existing value can lead to inconsistencies in the
842
+ * `StakingLedger` and will need to be handled properly in a runtime
843
+ * migration. The test `reducing_max_unlocking_chunks_abrupt` shows
844
+ * this effect.
845
+ **/
846
+ maxUnlockingChunks: u32 & AugmentedConst<ApiType>;
847
+ /**
848
+ * Number of sessions per era.
849
+ **/
850
+ sessionsPerEra: u32 & AugmentedConst<ApiType>;
851
+ /**
852
+ * Number of eras that slashes are deferred by, after computation.
853
+ *
854
+ * This should be less than the bonding duration. Set to 0 if slashes
855
+ * should be applied immediately, without opportunity for intervention.
856
+ **/
857
+ slashDeferDuration: u32 & AugmentedConst<ApiType>;
858
+ /**
859
+ * Generic const
860
+ **/
861
+ [key: string]: Codec;
862
+ };
863
+ system: {
864
+ /**
865
+ * Maximum number of block number to block hash mappings to keep (oldest pruned first).
866
+ **/
867
+ blockHashCount: u32 & AugmentedConst<ApiType>;
868
+ /**
869
+ * The maximum length of a block (in bytes).
870
+ **/
871
+ blockLength: FrameSystemLimitsBlockLength & AugmentedConst<ApiType>;
872
+ /**
873
+ * Block & extrinsics weights: base values and limits.
874
+ **/
875
+ blockWeights: FrameSystemLimitsBlockWeights & AugmentedConst<ApiType>;
876
+ /**
877
+ * The weight of runtime database operations the runtime can invoke.
878
+ **/
879
+ dbWeight: SpWeightsRuntimeDbWeight & AugmentedConst<ApiType>;
880
+ /**
881
+ * The designated SS58 prefix of this chain.
882
+ *
883
+ * This replaces the "ss58Format" property declared in the chain spec. Reason is
884
+ * that the runtime should know about the prefix in order to make use of it as
885
+ * an identifier of the chain.
886
+ **/
887
+ ss58Prefix: u16 & AugmentedConst<ApiType>;
888
+ /**
889
+ * Get the chain's in-code version.
890
+ **/
891
+ version: SpVersionRuntimeVersion & AugmentedConst<ApiType>;
892
+ /**
893
+ * Generic const
894
+ **/
895
+ [key: string]: Codec;
896
+ };
897
+ timestamp: {
898
+ /**
899
+ * The minimum period between blocks.
900
+ *
901
+ * Be aware that this is different to the *expected* period that the block production
902
+ * apparatus provides. Your chosen consensus system will generally work with this to
903
+ * determine a sensible block time. For example, in the Aura pallet it will be double this
904
+ * period on default settings.
905
+ **/
906
+ minimumPeriod: u64 & AugmentedConst<ApiType>;
907
+ /**
908
+ * Generic const
909
+ **/
910
+ [key: string]: Codec;
911
+ };
912
+ transactionPayment: {
913
+ /**
914
+ * A fee multiplier for `Operational` extrinsics to compute "virtual tip" to boost their
915
+ * `priority`
916
+ *
917
+ * This value is multiplied by the `final_fee` to obtain a "virtual tip" that is later
918
+ * added to a tip component in regular `priority` calculations.
919
+ * It means that a `Normal` transaction can front-run a similarly-sized `Operational`
920
+ * extrinsic (with no tip), by including a tip value greater than the virtual tip.
921
+ *
922
+ * ```rust,ignore
923
+ * // For `Normal`
924
+ * let priority = priority_calc(tip);
925
+ *
926
+ * // For `Operational`
927
+ * let virtual_tip = (inclusion_fee + tip) * OperationalFeeMultiplier;
928
+ * let priority = priority_calc(tip + virtual_tip);
929
+ * ```
930
+ *
931
+ * Note that since we use `final_fee` the multiplier applies also to the regular `tip`
932
+ * sent with the transaction. So, not only does the transaction get a priority bump based
933
+ * on the `inclusion_fee`, but we also amplify the impact of tips applied to `Operational`
934
+ * transactions.
935
+ **/
936
+ operationalFeeMultiplier: u8 & AugmentedConst<ApiType>;
937
+ /**
938
+ * Generic const
939
+ **/
940
+ [key: string]: Codec;
941
+ };
942
+ treasury: {
943
+ /**
944
+ * Percentage of spare funds (if any) that are burnt per spend period.
945
+ **/
946
+ burn: Permill & AugmentedConst<ApiType>;
947
+ /**
948
+ * The maximum number of approvals that can wait in the spending queue.
949
+ *
950
+ * NOTE: This parameter is also used within the Bounties Pallet extension if enabled.
951
+ **/
952
+ maxApprovals: u32 & AugmentedConst<ApiType>;
953
+ /**
954
+ * The treasury's pallet id, used for deriving its sovereign account ID.
955
+ **/
956
+ palletId: FrameSupportPalletId & AugmentedConst<ApiType>;
957
+ /**
958
+ * The period during which an approved treasury spend has to be claimed.
959
+ **/
960
+ payoutPeriod: u32 & AugmentedConst<ApiType>;
961
+ /**
962
+ * Period between successive spends.
963
+ **/
964
+ spendPeriod: u32 & AugmentedConst<ApiType>;
965
+ /**
966
+ * Generic const
967
+ **/
968
+ [key: string]: Codec;
969
+ };
970
+ utility: {
971
+ /**
972
+ * The limit on the number of batched calls.
973
+ **/
974
+ batchedCallsLimit: u32 & AugmentedConst<ApiType>;
975
+ /**
976
+ * Generic const
977
+ **/
978
+ [key: string]: Codec;
979
+ };
980
+ vesting: {
981
+ maxVestingSchedules: u32 & AugmentedConst<ApiType>;
982
+ /**
983
+ * The minimum amount transferred to call `vested_transfer`.
984
+ **/
985
+ minVestedTransfer: u128 & AugmentedConst<ApiType>;
986
+ /**
987
+ * Generic const
988
+ **/
989
+ [key: string]: Codec;
990
+ };
991
+ voterList: {
992
+ /**
993
+ * The list of thresholds separating the various bags.
994
+ *
995
+ * Ids are separated into unsorted bags according to their score. This specifies the
996
+ * thresholds separating the bags. An id's bag is the largest bag for which the id's score
997
+ * is less than or equal to its upper threshold.
998
+ *
999
+ * When ids are iterated, higher bags are iterated completely before lower bags. This means
1000
+ * that iteration is _semi-sorted_: ids of higher score tend to come before ids of lower
1001
+ * score, but peer ids within a particular bag are sorted in insertion order.
1002
+ *
1003
+ * # Expressing the constant
1004
+ *
1005
+ * This constant must be sorted in strictly increasing order. Duplicate items are not
1006
+ * permitted.
1007
+ *
1008
+ * There is an implied upper limit of `Score::MAX`; that value does not need to be
1009
+ * specified within the bag. For any two threshold lists, if one ends with
1010
+ * `Score::MAX`, the other one does not, and they are otherwise equal, the two
1011
+ * lists will behave identically.
1012
+ *
1013
+ * # Calculation
1014
+ *
1015
+ * It is recommended to generate the set of thresholds in a geometric series, such that
1016
+ * there exists some constant ratio such that `threshold[k + 1] == (threshold[k] *
1017
+ * constant_ratio).max(threshold[k] + 1)` for all `k`.
1018
+ *
1019
+ * The helpers in the `/utils/frame/generate-bags` module can simplify this calculation.
1020
+ *
1021
+ * # Examples
1022
+ *
1023
+ * - If `BagThresholds::get().is_empty()`, then all ids are put into the same bag, and
1024
+ * iteration is strictly in insertion order.
1025
+ * - If `BagThresholds::get().len() == 64`, and the thresholds are determined according to
1026
+ * the procedure given above, then the constant ratio is equal to 2.
1027
+ * - If `BagThresholds::get().len() == 200`, and the thresholds are determined according to
1028
+ * the procedure given above, then the constant ratio is approximately equal to 1.248.
1029
+ * - If the threshold list begins `[1, 2, 3, ...]`, then an id with score 0 or 1 will fall
1030
+ * into bag 0, an id with score 2 will fall into bag 1, etc.
1031
+ *
1032
+ * # Migration
1033
+ *
1034
+ * In the event that this list ever changes, a copy of the old bags list must be retained.
1035
+ * With that `List::migrate` can be called, which will perform the appropriate migration.
1036
+ **/
1037
+ bagThresholds: Vec<u64> & AugmentedConst<ApiType>;
1038
+ /**
1039
+ * Generic const
1040
+ **/
1041
+ [key: string]: Codec;
1042
+ };
1043
+ }
1044
+ }