diff --git a/packages/api/src/types/augment/consts.ts b/packages/api/src/types/augment/consts.ts index 362624218e..bec49c752f 100644 --- a/packages/api/src/types/augment/consts.ts +++ b/packages/api/src/types/augment/consts.ts @@ -13,18 +13,26 @@ declare module '@polkadot/metadata/Decorated/types' { babe: { [index: string]: Codec; /** - * The number of **slots** that an epoch takes. We couple sessions to epochs, i.e. we start a new session once the new epoch begins. + * The number of **slots** that an epoch takes. We couple sessions to + * epochs, i.e. we start a new session once the new epoch begins. **/ epochDuration: AugmentedConst; /** - * The expected average block time at which BABE should be creating blocks. Since BABE is probabilistic it is not trivial to figure out what the expected average block time should be based on the slot duration and the security parameter `c` (where `1 - c` represents the probability of a slot being empty). + * The expected average block time at which BABE should be creating + * blocks. Since BABE is probabilistic it is not trivial to figure out + * what the expected average block time should be based on the slot + * duration and the security parameter `c` (where `1 - c` represents + * the probability of a slot being empty). **/ expectedBlockTime: AugmentedConst; }; timestamp: { [index: string]: Codec; /** - * The minimum period between blocks. Beware that this is different to the *expected* period that the block production apparatus provides. Your chosen consensus system will generally work with this to determine a sensible block time. e.g. For Aura, it will be double this period on default settings. + * The minimum period between blocks. Beware that this is different to the *expected* period + * that the block production apparatus provides. Your chosen consensus system will generally + * work with this to determine a sensible block time. e.g. For Aura, it will be double this + * period on default settings. **/ minimumPeriod: AugmentedConst; }; @@ -68,14 +76,18 @@ declare module '@polkadot/metadata/Decorated/types' { session: { [index: string]: Codec; /** - * Used as first key for `NextKeys` and `KeyOwner` to put all the data into the same branch of the trie. + * Used as first key for `NextKeys` and `KeyOwner` to put all the data into the same branch + * of the trie. **/ dedupKeyPrefix: AugmentedConst; }; democracy: { [index: string]: Codec; /** - * The minimum period of locking and the period between a proposal being approved and enacted. It should generally be a little more than the unstake period to ensure that voting stakers have an opportunity to remove themselves from the system in the case where they are on the losing side of a vote. + * The minimum period of locking and the period between a proposal being approved and enacted. + * It should generally be a little more than the unstake period to ensure that + * voting stakers have an opportunity to remove themselves from the system in the case where + * they are on the losing side of a vote. **/ enactmentPeriod: AugmentedConst; /** @@ -125,7 +137,8 @@ declare module '@polkadot/metadata/Decorated/types' { treasury: { [index: string]: Codec; /** - * Fraction of a proposal's value that should be bonded in order to place the proposal. An accepted proposal gets these back. A rejected proposal does not. + * Fraction of a proposal's value that should be bonded in order to place the proposal. + * An accepted proposal gets these back. A rejected proposal does not. **/ proposalBond: AugmentedConst; /** @@ -160,7 +173,9 @@ declare module '@polkadot/metadata/Decorated/types' { contracts: { [index: string]: Codec; /** - * Number of block delay an extrinsic claim surcharge has. When claim surcharge is called by an extrinsic the rent is checked for current_block - delay + * Number of block delay an extrinsic claim surcharge has. + * When claim surcharge is called by an extrinsic the rent is checked + * for current_block - delay **/ signedClaimHandicap: AugmentedConst; /** @@ -168,7 +183,8 @@ declare module '@polkadot/metadata/Decorated/types' { **/ tombstoneDeposit: AugmentedConst; /** - * Size of a contract at the time of instantiaion. This is a simple way to ensure that empty contracts eventually gets deleted. + * Size of a contract at the time of instantiaion. This is a simple way to ensure that + * empty contracts eventually gets deleted. **/ storageSizeOffset: AugmentedConst; /** @@ -176,11 +192,17 @@ declare module '@polkadot/metadata/Decorated/types' { **/ rentByteFee: AugmentedConst; /** - * The amount of funds a contract should deposit in order to offset the cost of one byte. Let's suppose the deposit is 1,000 BU (balance units)/byte and the rent is 1 BU/byte/day, then a contract with 1,000,000 BU that uses 1,000 bytes of storage would pay no rent. But if the balance reduced to 500,000 BU and the storage stayed the same at 1,000, then it would pay 500 BU/day. + * The amount of funds a contract should deposit in order to offset + * the cost of one byte. + * Let's suppose the deposit is 1,000 BU (balance units)/byte and the rent is 1 BU/byte/day, + * then a contract with 1,000,000 BU that uses 1,000 bytes of storage would pay no rent. + * But if the balance reduced to 500,000 BU and the storage stayed the same at 1,000, + * then it would pay 500 BU/day. **/ rentDepositOffset: AugmentedConst; /** - * Reward that is received by the party whose touch has led to removal of a contract. + * Reward that is received by the party whose touch has led + * to removal of a contract. **/ surchargeReward: AugmentedConst; /** @@ -200,19 +222,23 @@ declare module '@polkadot/metadata/Decorated/types' { **/ transactionByteFee: AugmentedConst; /** - * The fee required to instantiate a contract instance. A reasonable default value is 21. + * The fee required to instantiate a contract instance. A reasonable default value + * is 21. **/ contractFee: AugmentedConst; /** - * The base fee charged for calling into a contract. A reasonable default value is 135. + * The base fee charged for calling into a contract. A reasonable default + * value is 135. **/ callBaseFee: AugmentedConst; /** - * The base fee charged for instantiating a contract. A reasonable default value is 175. + * The base fee charged for instantiating a contract. A reasonable default value + * is 175. **/ instantiateBaseFee: AugmentedConst; /** - * The maximum nesting level of a call/instantiate stack. A reasonable default value is 100. + * The maximum nesting level of a call/instantiate stack. A reasonable default + * value is 100. **/ maxDepth: AugmentedConst; /** @@ -220,7 +246,8 @@ declare module '@polkadot/metadata/Decorated/types' { **/ maxValueSize: AugmentedConst; /** - * The maximum amount of gas that could be expended per block. A reasonable default value is 10_000_000. + * The maximum amount of gas that could be expended per block. A reasonable + * default value is 10_000_000. **/ blockGasLimit: AugmentedConst; }; @@ -231,11 +258,13 @@ declare module '@polkadot/metadata/Decorated/types' { **/ candidateDeposit: AugmentedConst; /** - * The amount of the unpaid reward that gets deducted in the case that either a skeptic doesn't vote or someone votes in the wrong way. + * The amount of the unpaid reward that gets deducted in the case that either a skeptic + * doesn't vote or someone votes in the wrong way. **/ wrongSideDeduction: AugmentedConst; /** - * The number of times a member may vote the wrong way (or not at all, when they are a skeptic) before they become suspended. + * The number of times a member may vote the wrong way (or not at all, when they are a skeptic) + * before they become suspended. **/ maxStrikes: AugmentedConst; /** diff --git a/packages/api/src/types/augment/query.ts b/packages/api/src/types/augment/query.ts index b98715cf43..e43a95b639 100644 --- a/packages/api/src/types/augment/query.ts +++ b/packages/api/src/types/augment/query.ts @@ -80,7 +80,14 @@ declare module '@polkadot/api/types/storage' { **/ eventCount: AugmentedQuery Observable> & QueryableStorageEntry; /** - * Mapping between a topic (represented by T::Hash) and a vector of indexes of events in the `>` list. All topic vectors have deterministic storage locations depending on the topic. This allows light-clients to leverage the changes trie storage tracking mechanism and in case of changes fetch the list of events of interest. The value has the type `(T::BlockNumber, EventIndex)` because if we used only just the `EventIndex` then in case if the topic has the same contents on the next block no notification will be triggered thus the event might be lost. + * Mapping between a topic (represented by T::Hash) and a vector of indexes + * of events in the `>` list. + * All topic vectors have deterministic storage locations depending on the topic. This + * allows light-clients to leverage the changes trie storage tracking mechanism and + * in case of changes fetch the list of events of interest. + * The value has the type `(T::BlockNumber, EventIndex)` because if we used only just + * the `EventIndex` then in case if the topic has the same contents on the next block + * no notification will be triggered thus the event might be lost. **/ eventTopics: AugmentedQuery Observable>>> & QueryableStorageEntry; }; @@ -102,7 +109,8 @@ declare module '@polkadot/api/types/storage' { **/ authorities: AugmentedQuery Observable>>> & QueryableStorageEntry; /** - * The slot at which the first epoch actually started. This is 0 until the first block of the chain. + * The slot at which the first epoch actually started. This is 0 + * until the first block of the chain. **/ genesisSlot: AugmentedQuery Observable> & QueryableStorageEntry; /** @@ -110,7 +118,14 @@ declare module '@polkadot/api/types/storage' { **/ currentSlot: AugmentedQuery Observable> & QueryableStorageEntry; /** - * The epoch randomness for the *current* epoch. # Security This MUST NOT be used for gambling, as it can be influenced by a malicious validator in the short term. It MAY be used in many cryptographic protocols, however, so long as one remembers that this (like everything else on-chain) it is public. For example, it can be used where a number is needed that cannot have been chosen by an adversary, for purposes such as public-coin zero-knowledge proofs. + * The epoch randomness for the *current* epoch. + * # Security + * This MUST NOT be used for gambling, as it can be influenced by a + * malicious validator in the short term. It MAY be used in many + * cryptographic protocols, however, so long as one remembers that this + * (like everything else on-chain) it is public. For example, it can be + * used where a number is needed that cannot have been chosen by an + * adversary, for purposes such as public-coin zero-knowledge proofs. **/ randomness: AugmentedQuery Observable> & QueryableStorageEntry; /** @@ -118,12 +133,19 @@ declare module '@polkadot/api/types/storage' { **/ nextRandomness: AugmentedQuery Observable> & QueryableStorageEntry; /** - * Randomness under construction. We make a tradeoff between storage accesses and list length. We store the under-construction randomness in segments of up to `UNDER_CONSTRUCTION_SEGMENT_LENGTH`. Once a segment reaches this length, we begin the next one. We reset all segments and return to `0` at the beginning of every epoch. + * Randomness under construction. + * We make a tradeoff between storage accesses and list length. + * We store the under-construction randomness in segments of up to + * `UNDER_CONSTRUCTION_SEGMENT_LENGTH`. + * Once a segment reaches this length, we begin the next one. + * We reset all segments and return to `0` at the beginning of every + * epoch. **/ segmentIndex: AugmentedQuery Observable> & QueryableStorageEntry; underConstruction: AugmentedQuery Observable>> & QueryableStorageEntry; /** - * Temporary value (cleared at block finalization) which is `Some` if per-block initialization has already been called for current block. + * Temporary value (cleared at block finalization) which is `Some` + * if per-block initialization has already been called for current block. **/ initialized: AugmentedQuery Observable>> & QueryableStorageEntry; }; @@ -175,11 +197,26 @@ declare module '@polkadot/api/types/storage' { **/ vesting: AugmentedQuery Observable>> & QueryableStorageEntry; /** - * The 'free' balance of a given account. This is the only balance that matters in terms of most operations on tokens. It alone is used to determine the balance when in the contract execution environment. When this balance falls below the value of `ExistentialDeposit`, then the 'current account' is deleted: specifically `FreeBalance`. Further, the `OnFreeBalanceZero` callback is invoked, giving a chance to external modules to clean up data associated with the deleted account. `frame_system::AccountNonce` is also deleted if `ReservedBalance` is also zero (it also gets collapsed to zero if it ever becomes less than `ExistentialDeposit`. + * The 'free' balance of a given account. + * This is the only balance that matters in terms of most operations on tokens. It + * alone is used to determine the balance when in the contract execution environment. When this + * balance falls below the value of `ExistentialDeposit`, then the 'current account' is + * deleted: specifically `FreeBalance`. Further, the `OnFreeBalanceZero` callback + * is invoked, giving a chance to external modules to clean up data associated with + * the deleted account. + * `frame_system::AccountNonce` is also deleted if `ReservedBalance` is also zero (it also gets + * collapsed to zero if it ever becomes less than `ExistentialDeposit`. **/ freeBalance: AugmentedQuery Observable> & QueryableStorageEntry; /** - * The amount of the balance of a given account that is externally reserved; this can still get slashed, but gets slashed last of all. This balance is a 'reserve' balance that other subsystems use in order to set aside tokens that are still 'owned' by the account holder, but which are suspendable. When this balance falls below the value of `ExistentialDeposit`, then this 'reserve account' is deleted: specifically, `ReservedBalance`. `frame_system::AccountNonce` is also deleted if `FreeBalance` is also zero (it also gets collapsed to zero if it ever becomes less than `ExistentialDeposit`.) + * The amount of the balance of a given account that is externally reserved; this can still get + * slashed, but gets slashed last of all. + * This balance is a 'reserve' balance that other subsystems use in order to set aside tokens + * that are still 'owned' by the account holder, but which are suspendable. + * When this balance falls below the value of `ExistentialDeposit`, then this 'reserve account' + * is deleted: specifically, `ReservedBalance`. + * `frame_system::AccountNonce` is also deleted if `FreeBalance` is also zero (it also gets + * collapsed to zero if it ever becomes less than `ExistentialDeposit`.) **/ reservedBalance: AugmentedQuery Observable> & QueryableStorageEntry; /** @@ -202,7 +239,9 @@ declare module '@polkadot/api/types/storage' { **/ minimumValidatorCount: AugmentedQuery Observable> & QueryableStorageEntry; /** - * Any validators that may never be slashed or forcibly kicked. It's a Vec since they're easy to initialize and the performance hit is minimal (we expect no more than four invulnerables) and restricted to testnets. + * Any validators that may never be slashed or forcibly kicked. It's a Vec since they're + * easy to initialize and the performance hit is minimal (we expect no more than four + * invulnerables) and restricted to testnets. **/ invulnerables: AugmentedQuery Observable>> & QueryableStorageEntry; /** @@ -222,11 +261,15 @@ declare module '@polkadot/api/types/storage' { **/ validators: AugmentedQuery Observable> & QueryableStorageEntry; /** - * The map from nominator stash key to the set of stash keys of all validators to nominate. NOTE: is private so that we can ensure upgraded before all typical accesses. Direct storage APIs can still bypass this protection. + * The map from nominator stash key to the set of stash keys of all validators to nominate. + * NOTE: is private so that we can ensure upgraded before all typical accesses. + * Direct storage APIs can still bypass this protection. **/ nominators: AugmentedQuery Observable>> & QueryableStorageEntry; /** - * Nominators for a particular account that is in action right now. You can't iterate through validators here, but you can find them in the Session module. This is keyed by the stash account. + * Nominators for a particular account that is in action right now. You can't iterate + * through validators here, but you can find them in the Session module. + * This is keyed by the stash account. **/ stakers: AugmentedQuery Observable> & QueryableStorageEntry; /** @@ -250,7 +293,8 @@ declare module '@polkadot/api/types/storage' { **/ currentEraPointsEarned: AugmentedQuery Observable> & QueryableStorageEntry; /** - * The amount of balance actively at stake for each validator slot, currently. This is used to derive rewards and punishments. + * The amount of balance actively at stake for each validator slot, currently. + * This is used to derive rewards and punishments. **/ slotStake: AugmentedQuery Observable> & QueryableStorageEntry; /** @@ -258,11 +302,13 @@ declare module '@polkadot/api/types/storage' { **/ forceEra: AugmentedQuery Observable> & QueryableStorageEntry; /** - * The percentage of the slash that is distributed to reporters. The rest of the slashed value is handled by the `Slash`. + * The percentage of the slash that is distributed to reporters. + * The rest of the slashed value is handled by the `Slash`. **/ slashRewardFraction: AugmentedQuery Observable> & QueryableStorageEntry; /** - * The amount of currency given to reporters of a slash event which was canceled by extraordinary circumstances (e.g. governance). + * The amount of currency given to reporters of a slash event which was + * canceled by extraordinary circumstances (e.g. governance). **/ canceledSlashPayout: AugmentedQuery Observable> & QueryableStorageEntry; /** @@ -274,7 +320,8 @@ declare module '@polkadot/api/types/storage' { **/ bondedEras: AugmentedQuery Observable>>> & QueryableStorageEntry; /** - * All slashing events on validators, mapped by era to the highest slash proportion and slash value of the era. + * All slashing events on validators, mapped by era to the highest slash proportion + * and slash value of the era. **/ validatorSlashInEra: AugmentedQuery Observable>>> & QueryableStorageEntry; /** @@ -286,7 +333,8 @@ declare module '@polkadot/api/types/storage' { **/ slashingSpans: AugmentedQuery Observable>> & QueryableStorageEntry; /** - * Records information about the maximum slash of a stash within a slashing span, as well as how much reward has been paid out. + * Records information about the maximum slash of a stash within a slashing span, + * as well as how much reward has been paid out. **/ spanSlash: AugmentedQuery) => Observable> & QueryableStorageEntry; /** @@ -309,23 +357,30 @@ declare module '@polkadot/api/types/storage' { **/ currentIndex: AugmentedQuery Observable> & QueryableStorageEntry; /** - * True if the underlying economic identities or weighting behind the validators has changed in the queued validator set. + * True if the underlying economic identities or weighting behind the validators + * has changed in the queued validator set. **/ queuedChanged: AugmentedQuery Observable> & QueryableStorageEntry; /** - * The queued keys for the next session. When the next session begins, these keys will be used to determine the validator's session keys. + * The queued keys for the next session. When the next session begins, these keys + * will be used to determine the validator's session keys. **/ queuedKeys: AugmentedQuery Observable>>> & QueryableStorageEntry; /** - * Indices of disabled validators. The set is cleared when `on_session_ending` returns a new set of identities. + * Indices of disabled validators. + * The set is cleared when `on_session_ending` returns a new set of identities. **/ disabledValidators: AugmentedQuery Observable>> & QueryableStorageEntry; /** - * The next session keys for a validator. The first key is always `DEDUP_KEY_PREFIX` to have all the data in the same branch of the trie. Having all data in the same branch should prevent slowing down other queries. + * The next session keys for a validator. + * The first key is always `DEDUP_KEY_PREFIX` to have all the data in the same branch of + * the trie. Having all data in the same branch should prevent slowing down other queries. **/ nextKeys: AugmentedQuery Observable>> & QueryableStorageEntry; /** - * The owner of a key. The second key is the `KeyTypeId` + the encoded key. The first key is always `DEDUP_KEY_PREFIX` to have all the data in the same branch of the trie. Having all data in the same branch should prevent slowing down other queries. + * The owner of a key. The second key is the `KeyTypeId` + the encoded key. + * The first key is always `DEDUP_KEY_PREFIX` to have all the data in the same branch of + * the trie. Having all data in the same branch should prevent slowing down other queries. **/ keyOwner: AugmentedQuery) => Observable>> & QueryableStorageEntry; }; @@ -340,7 +395,8 @@ declare module '@polkadot/api/types/storage' { **/ publicProps: AugmentedQuery Observable>>> & QueryableStorageEntry; /** - * Map of hashes to the proposal preimage, along with who registered it and their deposit. The block number is the block at which it was deposited. + * Map of hashes to the proposal preimage, along with who registered it and their deposit. + * The block number is the block at which it was deposited. **/ preimages: AugmentedQuery Observable>>> & QueryableStorageEntry; /** @@ -352,7 +408,8 @@ declare module '@polkadot/api/types/storage' { **/ referendumCount: AugmentedQuery Observable> & QueryableStorageEntry; /** - * The lowest referendum index representing an unbaked referendum. Equal to `ReferendumCount` if there isn't a unbaked referendum. + * The lowest referendum index representing an unbaked referendum. Equal to + * `ReferendumCount` if there isn't a unbaked referendum. **/ lowestUnbaked: AugmentedQuery Observable> & QueryableStorageEntry; /** @@ -368,11 +425,15 @@ declare module '@polkadot/api/types/storage' { **/ votersFor: AugmentedQuery Observable>> & QueryableStorageEntry; /** - * Get the vote in a given referendum of a particular voter. The result is meaningful only if `voters_for` includes the voter when called with the referendum (you'll get the default `Vote` value otherwise). If you don't want to check `voters_for`, then you can also check for simple existence with `VoteOf::exists` first. + * Get the vote in a given referendum of a particular voter. The result is meaningful only + * if `voters_for` includes the voter when called with the referendum (you'll get the + * default `Vote` value otherwise). If you don't want to check `voters_for`, then you can + * also check for simple existence with `VoteOf::exists` first. **/ voteOf: AugmentedQuery) => Observable> & QueryableStorageEntry; /** - * Who is able to vote for whom. Value is the fund-holding account, key is the vote-transaction-sending account. + * Who is able to vote for whom. Value is the fund-holding account, key is the + * vote-transaction-sending account. **/ proxy: AugmentedQuery Observable>> & QueryableStorageEntry; /** @@ -380,15 +441,20 @@ declare module '@polkadot/api/types/storage' { **/ delegations: AugmentedQuery Observable>> & QueryableStorageEntry; /** - * True if the last referendum tabled was submitted externally. False if it was a public proposal. + * True if the last referendum tabled was submitted externally. False if it was a public + * proposal. **/ lastTabledWasExternal: AugmentedQuery Observable> & QueryableStorageEntry; /** - * The referendum to be tabled whenever it would be valid to table an external proposal. This happens when a referendum needs to be tabled and one of two conditions are met: - `LastTabledWasExternal` is `false`; or - `PublicProps` is empty. + * The referendum to be tabled whenever it would be valid to table an external proposal. + * This happens when a referendum needs to be tabled and one of two conditions are met: + * - `LastTabledWasExternal` is `false`; or + * - `PublicProps` is empty. **/ nextExternal: AugmentedQuery Observable>>> & QueryableStorageEntry; /** - * A record of who vetoed what. Maps proposal hash to a possible existent block number (until when it may not be resubmitted) and who vetoed it. + * A record of who vetoed what. Maps proposal hash to a possible existent block number + * (until when it may not be resubmitted) and who vetoed it. **/ blacklist: AugmentedQuery Observable]>>>> & QueryableStorageEntry; /** @@ -465,7 +531,8 @@ declare module '@polkadot/api/types/storage' { **/ stakeOf: AugmentedQuery Observable> & QueryableStorageEntry; /** - * The present candidate list. Sorted based on account-id. A current member or a runner can never enter this vector and is always implicitly assumed to be a candidate. + * The present candidate list. Sorted based on account-id. A current member or a runner can + * never enter this vector and is always implicitly assumed to be a candidate. **/ candidates: AugmentedQuery Observable>> & QueryableStorageEntry; }; @@ -479,7 +546,9 @@ declare module '@polkadot/api/types/storage' { grandpa: { [index: string]: QueryableStorageEntry; /** - * DEPRECATED This used to store the current authority set, which has been migrated to the well-known GRANDPA_AUTHORITES_KEY unhashed key. + * DEPRECATED + * This used to store the current authority set, which has been migrated to the well-known + * GRANDPA_AUTHORITES_KEY unhashed key. **/ authorities: AugmentedQuery Observable> & QueryableStorageEntry; /** @@ -499,7 +568,8 @@ declare module '@polkadot/api/types/storage' { **/ stalled: AugmentedQuery Observable>>> & QueryableStorageEntry; /** - * The number of changes (both in terms of keys and underlying economic responsibilities) in the "set" of Grandpa validators from genesis. + * The number of changes (both in terms of keys and underlying economic responsibilities) + * in the "set" of Grandpa validators from genesis. **/ currentSetId: AugmentedQuery Observable> & QueryableStorageEntry; /** @@ -522,11 +592,14 @@ declare module '@polkadot/api/types/storage' { **/ approvals: AugmentedQuery Observable>> & QueryableStorageEntry; /** - * Tips 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. + * Tips 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. **/ tips: AugmentedQuery Observable>> & QueryableStorageEntry; /** - * 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. + * 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. **/ reasons: AugmentedQuery Observable>> & QueryableStorageEntry; }; @@ -579,11 +652,13 @@ declare module '@polkadot/api/types/storage' { **/ keys: AugmentedQuery Observable>> & QueryableStorageEntry; /** - * For each session index, we keep a mapping of `AuthIndex` to `offchain::OpaqueNetworkState`. + * For each session index, we keep a mapping of `AuthIndex` + * to `offchain::OpaqueNetworkState`. **/ receivedHeartbeats: AugmentedQuery Observable>> & QueryableStorageEntry; /** - * For each session index, we keep a mapping of `T::ValidatorId` to the number of blocks authored by the given authority. + * For each session index, we keep a mapping of `T::ValidatorId` to the + * number of blocks authored by the given authority. **/ authoredBlocks: AugmentedQuery Observable> & QueryableStorageEntry; }; @@ -598,14 +673,19 @@ declare module '@polkadot/api/types/storage' { **/ concurrentReportsIndex: AugmentedQuery Observable>> & QueryableStorageEntry; /** - * Enumerates all reports of a kind along with the time they happened. All reports are sorted by the time of offence. Note that the actual type of this mapping is `Vec`, this is because values of different types are not supported at the moment so we are doing the manual serialization. + * Enumerates all reports of a kind along with the time they happened. + * All reports are sorted by the time of offence. + * Note that the actual type of this mapping is `Vec`, this is because values of + * different types are not supported at the moment so we are doing the manual serialization. **/ reportsByKindIndex: AugmentedQuery Observable> & QueryableStorageEntry; }; randomnessCollectiveFlip: { [index: string]: QueryableStorageEntry; /** - * Series of block headers from the last 81 blocks that acts as random seed material. This is arranged as a ring buffer with `block_number % 81` being the index into the `Vec` of the oldest hash. + * Series of block headers from the last 81 blocks that acts as random seed material. This + * is arranged as a ring buffer with `block_number % 81` being the index into the `Vec` of + * the oldest hash. **/ randomMaterial: AugmentedQuery Observable>> & QueryableStorageEntry; }; @@ -616,15 +696,19 @@ declare module '@polkadot/api/types/storage' { **/ identityOf: AugmentedQuery Observable>> & QueryableStorageEntry; /** - * The super-identity of an alternative "sub" identity together with its name, within that context. If the account is not some other account's sub-identity, then just `None`. + * The super-identity of an alternative "sub" identity together with its name, within that + * context. If the account is not some other account's sub-identity, then just `None`. **/ superOf: AugmentedQuery Observable>>> & QueryableStorageEntry; /** - * Alternative "sub" identities of this account. The first item is the deposit, the second is a vector of the accounts. + * Alternative "sub" identities of this account. + * The first item is the deposit, the second is a vector of the accounts. **/ subsOf: AugmentedQuery Observable]>>> & QueryableStorageEntry; /** - * The set of registrars. Not expected to get very big as can only be added through a special origin (likely a council motion). The index into this can be cast to `RegistrarIndex` to get a valid value. + * The set of registrars. Not expected to get very big as can only be added through a + * special origin (likely a council motion). + * The index into this can be cast to `RegistrarIndex` to get a valid value. **/ registrars: AugmentedQuery Observable>>> & QueryableStorageEntry; }; @@ -635,7 +719,8 @@ declare module '@polkadot/api/types/storage' { **/ founder: AugmentedQuery Observable>> & QueryableStorageEntry; /** - * A hash of the rules of this society concerning membership. Can only be set once and only by the founder. + * A hash of the rules of this society concerning membership. Can only be set once and + * only by the founder. **/ rules: AugmentedQuery Observable>> & QueryableStorageEntry; /** @@ -702,11 +787,14 @@ declare module '@polkadot/api/types/storage' { **/ recoverable: AugmentedQuery Observable>> & QueryableStorageEntry; /** - * Active recovery attempts. First account is the account to be recovered, and the second account is the user trying to recover the account. + * Active recovery attempts. + * First account is the account to be recovered, and the second account + * is the user trying to recover the account. **/ activeRecoveries: AugmentedQuery Observable>> & QueryableStorageEntry; /** - * The final list of recovered accounts. Map from the recovered account to the user who can access it. + * The final list of recovered accounts. + * Map from the recovered account to the user who can access it. **/ recovered: AugmentedQuery Observable>> & QueryableStorageEntry; }; diff --git a/packages/api/src/types/augment/tx.ts b/packages/api/src/types/augment/tx.ts index 69eb4b5182..6a493ddcfb 100644 --- a/packages/api/src/types/augment/tx.ts +++ b/packages/api/src/types/augment/tx.ts @@ -62,30 +62,128 @@ declare module '@polkadot/api/types/submittable' { utility: { [index: string]: SubmittableExtrinsicFunction; /** - * Send a batch of dispatch calls. This will execute until the first one fails and then stop. May be called from any origin. - `calls`: The calls to be dispatched from the same origin. # - The sum of the weights of the `calls`. - One event. # This will return `Ok` in all circumstances. To determine the success of the batch, an event is deposited. If a call failed and the batch was interrupted, then the `BatchInterrupted` event is deposited, along with the number of successful calls made and the error of the failed call. If all were successful, then the `BatchCompleted` event is deposited. + * Send a batch of dispatch calls. + * This will execute until the first one fails and then stop. + * May be called from any origin. + * - `calls`: The calls to be dispatched from the same origin. + * # + * - The sum of the weights of the `calls`. + * - One event. + * # + * This will return `Ok` in all circumstances. To determine the success of the batch, an + * event is deposited. If a call failed and the batch was interrupted, then the + * `BatchInterrupted` event is deposited, along with the number of successful calls made + * and the error of the failed call. If all were successful, then the `BatchCompleted` + * event is deposited. **/ batch: AugmentedSubmittable<(calls: Vec | (Call | object | string | Uint8Array)[]) => SubmittableExtrinsic>; /** - * Send a call through an indexed pseudonym of the sender. The dispatch origin for this call must be _Signed_. # - The weight of the `call`. # + * Send a call through an indexed pseudonym of the sender. + * The dispatch origin for this call must be _Signed_. + * # + * - The weight of the `call`. + * # **/ asSub: AugmentedSubmittable<(index: u16 | AnyNumber | Uint8Array, call: Call | object | string | Uint8Array) => SubmittableExtrinsic>; /** - * Register approval for a dispatch to be made from a deterministic composite account if approved by a total of `threshold - 1` of `other_signatories`. If there are enough, then dispatch the call. Payment: `MultisigDepositBase` will be reserved if this is the first approval, plus `threshold` times `MultisigDepositFactor`. It is returned once this dispatch happens or is cancelled. The dispatch origin for this call must be _Signed_. - `threshold`: The total number of approvals for this dispatch before it is executed. - `other_signatories`: The accounts (other than the sender) who can approve this dispatch. May not be empty. - `maybe_timepoint`: If this is the first approval, then this must be `None`. If it is not the first approval, then it must be `Some`, with the timepoint (block number and transaction index) of the first approval transaction. - `call`: The call to be executed. NOTE: Unless this is the final approval, you will generally want to use `approve_as_multi` instead, since it only requires a hash of the call. Result is equivalent to the dispatched result if `threshold` is exactly `1`. Otherwise on success, result is `Ok` and the result from the interior call, if it was executed, may be found in the deposited `MultisigExecuted` event. # - `O(S + Z + Call)`. - Up to one balance-reserve or unreserve operation. - One passthrough operation, one insert, both `O(S)` where `S` is the number of signatories. `S` is capped by `MaxSignatories`, with weight being proportional. - One call encode & hash, both of complexity `O(Z)` where `Z` is tx-len. - One encode & hash, both of complexity `O(S)`. - Up to one binary search and insert (`O(logS + S)`). - I/O: 1 read `O(S)`, up to 1 mutate `O(S)`. Up to one remove. - One event. - The weight of the `call`. - Storage: inserts one item, value size bounded by `MaxSignatories`, with a deposit taken for its lifetime of `MultisigDepositBase + threshold * MultisigDepositFactor`. # + * Register approval for a dispatch to be made from a deterministic composite account if + * approved by a total of `threshold - 1` of `other_signatories`. + * If there are enough, then dispatch the call. + * Payment: `MultisigDepositBase` will be reserved if this is the first approval, plus + * `threshold` times `MultisigDepositFactor`. It is returned once this dispatch happens or + * is cancelled. + * The dispatch origin for this call must be _Signed_. + * - `threshold`: The total number of approvals for this dispatch before it is executed. + * - `other_signatories`: The accounts (other than the sender) who can approve this + * dispatch. May not be empty. + * - `maybe_timepoint`: If this is the first approval, then this must be `None`. If it is + * not the first approval, then it must be `Some`, with the timepoint (block number and + * transaction index) of the first approval transaction. + * - `call`: The call to be executed. + * NOTE: Unless this is the final approval, you will generally want to use + * `approve_as_multi` instead, since it only requires a hash of the call. + * Result is equivalent to the dispatched result if `threshold` is exactly `1`. Otherwise + * on success, result is `Ok` and the result from the interior call, if it was executed, + * may be found in the deposited `MultisigExecuted` event. + * # + * - `O(S + Z + Call)`. + * - Up to one balance-reserve or unreserve operation. + * - One passthrough operation, one insert, both `O(S)` where `S` is the number of + * signatories. `S` is capped by `MaxSignatories`, with weight being proportional. + * - One call encode & hash, both of complexity `O(Z)` where `Z` is tx-len. + * - One encode & hash, both of complexity `O(S)`. + * - Up to one binary search and insert (`O(logS + S)`). + * - I/O: 1 read `O(S)`, up to 1 mutate `O(S)`. Up to one remove. + * - One event. + * - The weight of the `call`. + * - Storage: inserts one item, value size bounded by `MaxSignatories`, with a + * deposit taken for its lifetime of + * `MultisigDepositBase + threshold * MultisigDepositFactor`. + * # **/ asMulti: AugmentedSubmittable<(threshold: u16 | AnyNumber | Uint8Array, otherSignatories: Vec | (AccountId | string | Uint8Array)[], maybeTimepoint: Option | null | object | string | Uint8Array, call: Call | object | string | Uint8Array) => SubmittableExtrinsic>; /** - * Register approval for a dispatch to be made from a deterministic composite account if approved by a total of `threshold - 1` of `other_signatories`. Payment: `MultisigDepositBase` will be reserved if this is the first approval, plus `threshold` times `MultisigDepositFactor`. It is returned once this dispatch happens or is cancelled. The dispatch origin for this call must be _Signed_. - `threshold`: The total number of approvals for this dispatch before it is executed. - `other_signatories`: The accounts (other than the sender) who can approve this dispatch. May not be empty. - `maybe_timepoint`: If this is the first approval, then this must be `None`. If it is not the first approval, then it must be `Some`, with the timepoint (block number and transaction index) of the first approval transaction. - `call_hash`: The hash of the call to be executed. NOTE: If this is the final approval, you will want to use `as_multi` instead. # - `O(S)`. - Up to one balance-reserve or unreserve operation. - One passthrough operation, one insert, both `O(S)` where `S` is the number of signatories. `S` is capped by `MaxSignatories`, with weight being proportional. - One encode & hash, both of complexity `O(S)`. - Up to one binary search and insert (`O(logS + S)`). - I/O: 1 read `O(S)`, up to 1 mutate `O(S)`. Up to one remove. - One event. - Storage: inserts one item, value size bounded by `MaxSignatories`, with a deposit taken for its lifetime of `MultisigDepositBase + threshold * MultisigDepositFactor`. # + * Register approval for a dispatch to be made from a deterministic composite account if + * approved by a total of `threshold - 1` of `other_signatories`. + * Payment: `MultisigDepositBase` will be reserved if this is the first approval, plus + * `threshold` times `MultisigDepositFactor`. It is returned once this dispatch happens or + * is cancelled. + * The dispatch origin for this call must be _Signed_. + * - `threshold`: The total number of approvals for this dispatch before it is executed. + * - `other_signatories`: The accounts (other than the sender) who can approve this + * dispatch. May not be empty. + * - `maybe_timepoint`: If this is the first approval, then this must be `None`. If it is + * not the first approval, then it must be `Some`, with the timepoint (block number and + * transaction index) of the first approval transaction. + * - `call_hash`: The hash of the call to be executed. + * NOTE: If this is the final approval, you will want to use `as_multi` instead. + * # + * - `O(S)`. + * - Up to one balance-reserve or unreserve operation. + * - One passthrough operation, one insert, both `O(S)` where `S` is the number of + * signatories. `S` is capped by `MaxSignatories`, with weight being proportional. + * - One encode & hash, both of complexity `O(S)`. + * - Up to one binary search and insert (`O(logS + S)`). + * - I/O: 1 read `O(S)`, up to 1 mutate `O(S)`. Up to one remove. + * - One event. + * - Storage: inserts one item, value size bounded by `MaxSignatories`, with a + * deposit taken for its lifetime of + * `MultisigDepositBase + threshold * MultisigDepositFactor`. + * # **/ approveAsMulti: AugmentedSubmittable<(threshold: u16 | AnyNumber | Uint8Array, otherSignatories: Vec | (AccountId | string | Uint8Array)[], maybeTimepoint: Option | null | object | string | Uint8Array, callHash: Raw | string | Uint8Array) => SubmittableExtrinsic>; /** - * Cancel a pre-existing, on-going multisig transaction. Any deposit reserved previously for this operation will be unreserved on success. The dispatch origin for this call must be _Signed_. - `threshold`: The total number of approvals for this dispatch before it is executed. - `other_signatories`: The accounts (other than the sender) who can approve this dispatch. May not be empty. - `timepoint`: The timepoint (block number and transaction index) of the first approval transaction for this dispatch. - `call_hash`: The hash of the call to be executed. # - `O(S)`. - Up to one balance-reserve or unreserve operation. - One passthrough operation, one insert, both `O(S)` where `S` is the number of signatories. `S` is capped by `MaxSignatories`, with weight being proportional. - One encode & hash, both of complexity `O(S)`. - One event. - I/O: 1 read `O(S)`, one remove. - Storage: removes one item. # + * Cancel a pre-existing, on-going multisig transaction. Any deposit reserved previously + * for this operation will be unreserved on success. + * The dispatch origin for this call must be _Signed_. + * - `threshold`: The total number of approvals for this dispatch before it is executed. + * - `other_signatories`: The accounts (other than the sender) who can approve this + * dispatch. May not be empty. + * - `timepoint`: The timepoint (block number and transaction index) of the first approval + * transaction for this dispatch. + * - `call_hash`: The hash of the call to be executed. + * # + * - `O(S)`. + * - Up to one balance-reserve or unreserve operation. + * - One passthrough operation, one insert, both `O(S)` where `S` is the number of + * signatories. `S` is capped by `MaxSignatories`, with weight being proportional. + * - One encode & hash, both of complexity `O(S)`. + * - One event. + * - I/O: 1 read `O(S)`, one remove. + * - Storage: removes one item. + * # **/ cancelAsMulti: AugmentedSubmittable<(threshold: u16 | AnyNumber | Uint8Array, otherSignatories: Vec | (AccountId | string | Uint8Array)[], timepoint: Timepoint | object | string | Uint8Array, callHash: Raw | string | Uint8Array) => SubmittableExtrinsic>; }; timestamp: { [index: string]: SubmittableExtrinsicFunction; /** - * Set the current time. This call should be invoked exactly once per block. It will panic at the finalization phase, if this call hasn't been invoked by that time. The timestamp should be greater than the previous one by the amount specified by `MinimumPeriod`. The dispatch origin for this call must be `Inherent`. + * Set the current time. + * This call should be invoked exactly once per block. It will panic at the finalization + * phase, if this call hasn't been invoked by that time. + * The timestamp should be greater than the previous one by the amount specified by + * `MinimumPeriod`. + * The dispatch origin for this call must be `Inherent`. **/ set: AugmentedSubmittable<(now: Compact | AnyNumber | Uint8Array) => SubmittableExtrinsic>; }; @@ -99,58 +197,172 @@ declare module '@polkadot/api/types/submittable' { balances: { [index: string]: SubmittableExtrinsicFunction; /** - * Transfer some liquid free balance to another account. `transfer` will set the `FreeBalance` of the sender and receiver. It will decrease the total issuance of the system by the `TransferFee`. If the sender's account is below the existential deposit as a result of the transfer, the account will be reaped. The dispatch origin for this call must be `Signed` by the transactor. # - Dependent on arguments but not critical, given proper implementations for input config types. See related functions below. - It contains a limited number of reads and writes internally and no complex computation. Related functions: - `ensure_can_withdraw` is always called internally but has a bounded complexity. - Transferring balances to accounts that did not exist before will cause `T::OnNewAccount::on_new_account` to be called. - Removing enough funds from an account will trigger `T::DustRemoval::on_unbalanced` and `T::OnFreeBalanceZero::on_free_balance_zero`. - `transfer_keep_alive` works the same way as `transfer`, but has an additional check that the transfer will not kill the origin account. # + * Transfer some liquid free balance to another account. + * `transfer` will set the `FreeBalance` of the sender and receiver. + * It will decrease the total issuance of the system by the `TransferFee`. + * If the sender's account is below the existential deposit as a result + * of the transfer, the account will be reaped. + * The dispatch origin for this call must be `Signed` by the transactor. + * # + * - Dependent on arguments but not critical, given proper implementations for + * input config types. See related functions below. + * - It contains a limited number of reads and writes internally and no complex computation. + * Related functions: + * - `ensure_can_withdraw` is always called internally but has a bounded complexity. + * - Transferring balances to accounts that did not exist before will cause + * `T::OnNewAccount::on_new_account` to be called. + * - Removing enough funds from an account will trigger + * `T::DustRemoval::on_unbalanced` and `T::OnFreeBalanceZero::on_free_balance_zero`. + * - `transfer_keep_alive` works the same way as `transfer`, but has an additional + * check that the transfer will not kill the origin account. + * # **/ transfer: AugmentedSubmittable<(dest: Address | string | AccountId | AccountIndex | Uint8Array, value: Compact | AnyNumber | Uint8Array) => SubmittableExtrinsic>; /** - * Set the balances of a given account. This will alter `FreeBalance` and `ReservedBalance` in storage. it will also decrease the total issuance of the system (`TotalIssuance`). If the new free or reserved balance is below the existential deposit, it will reset the account nonce (`frame_system::AccountNonce`). The dispatch origin for this call is `root`. # - Independent of the arguments. - Contains a limited number of reads and writes. # + * Set the balances of a given account. + * This will alter `FreeBalance` and `ReservedBalance` in storage. it will + * also decrease the total issuance of the system (`TotalIssuance`). + * If the new free or reserved balance is below the existential deposit, + * it will reset the account nonce (`frame_system::AccountNonce`). + * The dispatch origin for this call is `root`. + * # + * - Independent of the arguments. + * - Contains a limited number of reads and writes. + * # **/ setBalance: AugmentedSubmittable<(who: Address | string | AccountId | AccountIndex | Uint8Array, newFree: Compact | AnyNumber | Uint8Array, newReserved: Compact | AnyNumber | Uint8Array) => SubmittableExtrinsic>; /** - * Exactly as `transfer`, except the origin must be root and the source account may be specified. + * Exactly as `transfer`, except the origin must be root and the source account may be + * specified. **/ forceTransfer: AugmentedSubmittable<(source: Address | string | AccountId | AccountIndex | Uint8Array, dest: Address | string | AccountId | AccountIndex | Uint8Array, value: Compact | AnyNumber | Uint8Array) => SubmittableExtrinsic>; /** - * Same as the [`transfer`] call, but with a check that the transfer will not kill the origin account. 99% of the time you want [`transfer`] instead. [`transfer`]: struct.Module.html#method.transfer + * Same as the [`transfer`] call, but with a check that the transfer will not kill the + * origin account. + * 99% of the time you want [`transfer`] instead. + * [`transfer`]: struct.Module.html#method.transfer **/ transferKeepAlive: AugmentedSubmittable<(dest: Address | string | AccountId | AccountIndex | Uint8Array, value: Compact | AnyNumber | Uint8Array) => SubmittableExtrinsic>; }; staking: { [index: string]: SubmittableExtrinsicFunction; /** - * Take the origin account as a stash and lock up `value` of its balance. `controller` will be the account that controls it. `value` must be more than the `minimum_balance` specified by `T::Currency`. The dispatch origin for this call must be _Signed_ by the stash account. # - Independent of the arguments. Moderate complexity. - O(1). - Three extra DB entries. NOTE: Two of the storage writes (`Self::bonded`, `Self::payee`) are _never_ cleaned unless the `origin` falls below _existential deposit_ and gets removed as dust. # + * Take the origin account as a stash and lock up `value` of its balance. `controller` will + * be the account that controls it. + * `value` must be more than the `minimum_balance` specified by `T::Currency`. + * The dispatch origin for this call must be _Signed_ by the stash account. + * # + * - Independent of the arguments. Moderate complexity. + * - O(1). + * - Three extra DB entries. + * NOTE: Two of the storage writes (`Self::bonded`, `Self::payee`) are _never_ cleaned unless + * the `origin` falls below _existential deposit_ and gets removed as dust. + * # **/ bond: AugmentedSubmittable<(controller: Address | string | AccountId | AccountIndex | Uint8Array, value: Compact | AnyNumber | Uint8Array, payee: RewardDestination | number | any) => SubmittableExtrinsic>; /** - * Add some extra amount that have appeared in the stash `free_balance` into the balance up for staking. Use this if there are additional funds in your stash account that you wish to bond. Unlike [`bond`] or [`unbond`] this function does not impose any limitation on the amount that can be added. The dispatch origin for this call must be _Signed_ by the stash, not the controller. # - Independent of the arguments. Insignificant complexity. - O(1). - One DB entry. # + * Add some extra amount that have appeared in the stash `free_balance` into the balance up + * for staking. + * Use this if there are additional funds in your stash account that you wish to bond. + * Unlike [`bond`] or [`unbond`] this function does not impose any limitation on the amount + * that can be added. + * The dispatch origin for this call must be _Signed_ by the stash, not the controller. + * # + * - Independent of the arguments. Insignificant complexity. + * - O(1). + * - One DB entry. + * # **/ bondExtra: AugmentedSubmittable<(maxAdditional: Compact | AnyNumber | Uint8Array) => SubmittableExtrinsic>; /** - * Schedule a portion of the stash to be unlocked ready for transfer out after the bond period ends. If this leaves an amount actively bonded less than T::Currency::minimum_balance(), then it is increased to the full amount. Once the unlock period is done, you can call `withdraw_unbonded` to actually move the funds out of management ready for transfer. No more than a limited number of unlocking chunks (see `MAX_UNLOCKING_CHUNKS`) can co-exists at the same time. In that case, [`Call::withdraw_unbonded`] need to be called first to remove some of the chunks (if possible). The dispatch origin for this call must be _Signed_ by the controller, not the stash. See also [`Call::withdraw_unbonded`]. # - Independent of the arguments. Limited but potentially exploitable complexity. - Contains a limited number of reads. - Each call (requires the remainder of the bonded balance to be above `minimum_balance`) will cause a new entry to be inserted into a vector (`Ledger.unlocking`) kept in storage. The only way to clean the aforementioned storage item is also user-controlled via `withdraw_unbonded`. - One DB entry. + * Schedule a portion of the stash to be unlocked ready for transfer out after the bond + * period ends. If this leaves an amount actively bonded less than + * T::Currency::minimum_balance(), then it is increased to the full amount. + * Once the unlock period is done, you can call `withdraw_unbonded` to actually move + * the funds out of management ready for transfer. + * No more than a limited number of unlocking chunks (see `MAX_UNLOCKING_CHUNKS`) + * can co-exists at the same time. In that case, [`Call::withdraw_unbonded`] need + * to be called first to remove some of the chunks (if possible). + * The dispatch origin for this call must be _Signed_ by the controller, not the stash. + * See also [`Call::withdraw_unbonded`]. + * # + * - Independent of the arguments. Limited but potentially exploitable complexity. + * - Contains a limited number of reads. + * - Each call (requires the remainder of the bonded balance to be above `minimum_balance`) + * will cause a new entry to be inserted into a vector (`Ledger.unlocking`) kept in storage. + * The only way to clean the aforementioned storage item is also user-controlled via `withdraw_unbonded`. + * - One DB entry. + * **/ unbond: AugmentedSubmittable<(value: Compact | AnyNumber | Uint8Array) => SubmittableExtrinsic>; /** - * Remove any unlocked chunks from the `unlocking` queue from our management. This essentially frees up that balance to be used by the stash account to do whatever it wants. The dispatch origin for this call must be _Signed_ by the controller, not the stash. See also [`Call::unbond`]. # - Could be dependent on the `origin` argument and how much `unlocking` chunks exist. It implies `consolidate_unlocked` which loops over `Ledger.unlocking`, which is indirectly user-controlled. See [`unbond`] for more detail. - Contains a limited number of reads, yet the size of which could be large based on `ledger`. - Writes are limited to the `origin` account key. # + * Remove any unlocked chunks from the `unlocking` queue from our management. + * This essentially frees up that balance to be used by the stash account to do + * whatever it wants. + * The dispatch origin for this call must be _Signed_ by the controller, not the stash. + * See also [`Call::unbond`]. + * # + * - Could be dependent on the `origin` argument and how much `unlocking` chunks exist. + * It implies `consolidate_unlocked` which loops over `Ledger.unlocking`, which is + * indirectly user-controlled. See [`unbond`] for more detail. + * - Contains a limited number of reads, yet the size of which could be large based on `ledger`. + * - Writes are limited to the `origin` account key. + * # **/ withdrawUnbonded: AugmentedSubmittable<() => SubmittableExtrinsic>; /** - * Declare the desire to validate for the origin controller. Effects will be felt at the beginning of the next era. The dispatch origin for this call must be _Signed_ by the controller, not the stash. # - Independent of the arguments. Insignificant complexity. - Contains a limited number of reads. - Writes are limited to the `origin` account key. # + * Declare the desire to validate for the origin controller. + * Effects will be felt at the beginning of the next era. + * The dispatch origin for this call must be _Signed_ by the controller, not the stash. + * # + * - Independent of the arguments. Insignificant complexity. + * - Contains a limited number of reads. + * - Writes are limited to the `origin` account key. + * # **/ validate: AugmentedSubmittable<(prefs: ValidatorPrefs | object | string | Uint8Array) => SubmittableExtrinsic>; /** - * Declare the desire to nominate `targets` for the origin controller. Effects will be felt at the beginning of the next era. The dispatch origin for this call must be _Signed_ by the controller, not the stash. # - The transaction's complexity is proportional to the size of `targets`, which is capped at `MAX_NOMINATIONS`. - Both the reads and writes follow a similar pattern. # + * Declare the desire to nominate `targets` for the origin controller. + * Effects will be felt at the beginning of the next era. + * The dispatch origin for this call must be _Signed_ by the controller, not the stash. + * # + * - The transaction's complexity is proportional to the size of `targets`, + * which is capped at `MAX_NOMINATIONS`. + * - Both the reads and writes follow a similar pattern. + * # **/ nominate: AugmentedSubmittable<(targets: Vec
| (Address | string | AccountId | AccountIndex | Uint8Array)[]) => SubmittableExtrinsic>; /** - * Declare no desire to either validate or nominate. Effects will be felt at the beginning of the next era. The dispatch origin for this call must be _Signed_ by the controller, not the stash. # - Independent of the arguments. Insignificant complexity. - Contains one read. - Writes are limited to the `origin` account key. # + * Declare no desire to either validate or nominate. + * Effects will be felt at the beginning of the next era. + * The dispatch origin for this call must be _Signed_ by the controller, not the stash. + * # + * - Independent of the arguments. Insignificant complexity. + * - Contains one read. + * - Writes are limited to the `origin` account key. + * # **/ chill: AugmentedSubmittable<() => SubmittableExtrinsic>; /** - * (Re-)set the payment target for a controller. Effects will be felt at the beginning of the next era. The dispatch origin for this call must be _Signed_ by the controller, not the stash. # - Independent of the arguments. Insignificant complexity. - Contains a limited number of reads. - Writes are limited to the `origin` account key. # + * (Re-)set the payment target for a controller. + * Effects will be felt at the beginning of the next era. + * The dispatch origin for this call must be _Signed_ by the controller, not the stash. + * # + * - Independent of the arguments. Insignificant complexity. + * - Contains a limited number of reads. + * - Writes are limited to the `origin` account key. + * # **/ setPayee: AugmentedSubmittable<(payee: RewardDestination | number | any) => SubmittableExtrinsic>; /** - * (Re-)set the controller of a stash. Effects will be felt at the beginning of the next era. The dispatch origin for this call must be _Signed_ by the stash, not the controller. # - Independent of the arguments. Insignificant complexity. - Contains a limited number of reads. - Writes are limited to the `origin` account key. # + * (Re-)set the controller of a stash. + * Effects will be felt at the beginning of the next era. + * The dispatch origin for this call must be _Signed_ by the stash, not the controller. + * # + * - Independent of the arguments. Insignificant complexity. + * - Contains a limited number of reads. + * - Writes are limited to the `origin` account key. + * # **/ setController: AugmentedSubmittable<(controller: Address | string | AccountId | AccountIndex | Uint8Array) => SubmittableExtrinsic>; /** @@ -158,11 +370,18 @@ declare module '@polkadot/api/types/submittable' { **/ setValidatorCount: AugmentedSubmittable<(updated: Compact | AnyNumber | Uint8Array) => SubmittableExtrinsic>; /** - * Force there to be no new eras indefinitely. # - No arguments. # + * Force there to be no new eras indefinitely. + * # + * - No arguments. + * # **/ forceNoEras: AugmentedSubmittable<() => SubmittableExtrinsic>; /** - * Force there to be a new era at the end of the next session. After this, it will be reset to normal (non-forced) behaviour. # - No arguments. # + * Force there to be a new era at the end of the next session. After this, it will be + * reset to normal (non-forced) behaviour. + * # + * - No arguments. + * # **/ forceNewEra: AugmentedSubmittable<() => SubmittableExtrinsic>; /** @@ -174,61 +393,113 @@ declare module '@polkadot/api/types/submittable' { **/ forceUnstake: AugmentedSubmittable<(stash: AccountId | string | Uint8Array) => SubmittableExtrinsic>; /** - * Force there to be a new era at the end of sessions indefinitely. # - One storage write # + * Force there to be a new era at the end of sessions indefinitely. + * # + * - One storage write + * # **/ forceNewEraAlways: AugmentedSubmittable<() => SubmittableExtrinsic>; /** - * Cancel enactment of a deferred slash. Can be called by either the root origin or the `T::SlashCancelOrigin`. passing the era and indices of the slashes for that era to kill. # - One storage write. # + * Cancel enactment of a deferred slash. Can be called by either the root origin or + * the `T::SlashCancelOrigin`. + * passing the era and indices of the slashes for that era to kill. + * # + * - One storage write. + * # **/ cancelDeferredSlash: AugmentedSubmittable<(era: EraIndex | AnyNumber | Uint8Array, slashIndices: Vec | (u32 | AnyNumber | Uint8Array)[]) => SubmittableExtrinsic>; /** - * Rebond a portion of the stash scheduled to be unlocked. # - Time complexity: O(1). Bounded by `MAX_UNLOCKING_CHUNKS`. - Storage changes: Can't increase storage, only decrease it. # + * Rebond a portion of the stash scheduled to be unlocked. + * # + * - Time complexity: O(1). Bounded by `MAX_UNLOCKING_CHUNKS`. + * - Storage changes: Can't increase storage, only decrease it. + * # **/ rebond: AugmentedSubmittable<(value: Compact | AnyNumber | Uint8Array) => SubmittableExtrinsic>; }; session: { [index: string]: SubmittableExtrinsicFunction; /** - * Sets the session key(s) of the function caller to `keys`. Allows an account to set its session key prior to becoming a validator. This doesn't take effect until the next session. The dispatch origin of this function must be signed. # - O(log n) in number of accounts. - One extra DB entry. # + * Sets the session key(s) of the function caller to `keys`. + * Allows an account to set its session key prior to becoming a validator. + * This doesn't take effect until the next session. + * The dispatch origin of this function must be signed. + * # + * - O(log n) in number of accounts. + * - One extra DB entry. + * # **/ setKeys: AugmentedSubmittable<(keys: Keys, proof: Bytes | string | Uint8Array) => SubmittableExtrinsic>; }; democracy: { [index: string]: SubmittableExtrinsicFunction; /** - * Propose a sensitive action to be taken. # - O(1). - Two DB changes, one DB entry. # + * Propose a sensitive action to be taken. + * # + * - O(1). + * - Two DB changes, one DB entry. + * # **/ propose: AugmentedSubmittable<(proposalHash: Hash | string | Uint8Array, value: Compact | AnyNumber | Uint8Array) => SubmittableExtrinsic>; /** - * Propose a sensitive action to be taken. # - O(1). - One DB entry. # + * Propose a sensitive action to be taken. + * # + * - O(1). + * - One DB entry. + * # **/ second: AugmentedSubmittable<(proposal: Compact | AnyNumber | Uint8Array) => SubmittableExtrinsic>; /** - * Vote in a referendum. If `vote.is_aye()`, the vote is to enact the proposal; otherwise it is a vote to keep the status quo. # - O(1). - One DB change, one DB entry. # + * Vote in a referendum. If `vote.is_aye()`, the vote is to enact the proposal; + * otherwise it is a vote to keep the status quo. + * # + * - O(1). + * - One DB change, one DB entry. + * # **/ vote: AugmentedSubmittable<(refIndex: Compact | AnyNumber | Uint8Array, vote: Vote | string | Uint8Array) => SubmittableExtrinsic>; /** - * Vote in a referendum on behalf of a stash. If `vote.is_aye()`, the vote is to enact the proposal; otherwise it is a vote to keep the status quo. # - O(1). - One DB change, one DB entry. # + * Vote in a referendum on behalf of a stash. If `vote.is_aye()`, the vote is to enact + * the proposal; otherwise it is a vote to keep the status quo. + * # + * - O(1). + * - One DB change, one DB entry. + * # **/ proxyVote: AugmentedSubmittable<(refIndex: Compact | AnyNumber | Uint8Array, vote: Vote | string | Uint8Array) => SubmittableExtrinsic>; /** - * Schedule an emergency cancellation of a referendum. Cannot happen twice to the same referendum. + * Schedule an emergency cancellation of a referendum. Cannot happen twice to the same + * referendum. **/ emergencyCancel: AugmentedSubmittable<(refIndex: ReferendumIndex | AnyNumber | Uint8Array) => SubmittableExtrinsic>; /** - * Schedule a referendum to be tabled once it is legal to schedule an external referendum. + * Schedule a referendum to be tabled once it is legal to schedule an external + * referendum. **/ externalPropose: AugmentedSubmittable<(proposalHash: Hash | string | Uint8Array) => SubmittableExtrinsic>; /** - * Schedule a majority-carries referendum to be tabled next once it is legal to schedule an external referendum. Unlike `external_propose`, blacklisting has no effect on this and it may replace a pre-scheduled `external_propose` call. + * Schedule a majority-carries referendum to be tabled next once it is legal to schedule + * an external referendum. + * Unlike `external_propose`, blacklisting has no effect on this and it may replace a + * pre-scheduled `external_propose` call. **/ externalProposeMajority: AugmentedSubmittable<(proposalHash: Hash | string | Uint8Array) => SubmittableExtrinsic>; /** - * Schedule a negative-turnout-bias referendum to be tabled next once it is legal to schedule an external referendum. Unlike `external_propose`, blacklisting has no effect on this and it may replace a pre-scheduled `external_propose` call. + * Schedule a negative-turnout-bias referendum to be tabled next once it is legal to + * schedule an external referendum. + * Unlike `external_propose`, blacklisting has no effect on this and it may replace a + * pre-scheduled `external_propose` call. **/ externalProposeDefault: AugmentedSubmittable<(proposalHash: Hash | string | Uint8Array) => SubmittableExtrinsic>; /** - * Schedule the currently externally-proposed majority-carries referendum to be tabled immediately. If there is no externally-proposed referendum currently, or if there is one but it is not a majority-carries referendum then it fails. - `proposal_hash`: The hash of the current external proposal. - `voting_period`: The period that is allowed for voting on this proposal. Increased to `EmergencyVotingPeriod` if too low. - `delay`: The number of block after voting has ended in approval and this should be enacted. This doesn't have a minimum amount. + * Schedule the currently externally-proposed majority-carries referendum to be tabled + * immediately. If there is no externally-proposed referendum currently, or if there is one + * but it is not a majority-carries referendum then it fails. + * - `proposal_hash`: The hash of the current external proposal. + * - `voting_period`: The period that is allowed for voting on this proposal. Increased to + * `EmergencyVotingPeriod` if too low. + * - `delay`: The number of block after voting has ended in approval and this should be + * enacted. This doesn't have a minimum amount. **/ fastTrack: AugmentedSubmittable<(proposalHash: Hash | string | Uint8Array, votingPeriod: BlockNumber | AnyNumber | Uint8Array, delay: BlockNumber | AnyNumber | Uint8Array) => SubmittableExtrinsic>; /** @@ -244,23 +515,38 @@ declare module '@polkadot/api/types/submittable' { **/ cancelQueued: AugmentedSubmittable<(which: ReferendumIndex | AnyNumber | Uint8Array) => SubmittableExtrinsic>; /** - * Specify a proxy. Called by the stash. # - One extra DB entry. # + * Specify a proxy. Called by the stash. + * # + * - One extra DB entry. + * # **/ setProxy: AugmentedSubmittable<(proxy: AccountId | string | Uint8Array) => SubmittableExtrinsic>; /** - * Clear the proxy. Called by the proxy. # - One DB clear. # + * Clear the proxy. Called by the proxy. + * # + * - One DB clear. + * # **/ resignProxy: AugmentedSubmittable<() => SubmittableExtrinsic>; /** - * Clear the proxy. Called by the stash. # - One DB clear. # + * Clear the proxy. Called by the stash. + * # + * - One DB clear. + * # **/ removeProxy: AugmentedSubmittable<(proxy: AccountId | string | Uint8Array) => SubmittableExtrinsic>; /** - * Delegate vote. # - One extra DB entry. # + * Delegate vote. + * # + * - One extra DB entry. + * # **/ delegate: AugmentedSubmittable<(to: AccountId | string | Uint8Array, conviction: Conviction | number | any) => SubmittableExtrinsic>; /** - * Undelegate vote. # - O(1). # + * Undelegate vote. + * # + * - O(1). + * # **/ undelegate: AugmentedSubmittable<() => SubmittableExtrinsic>; /** @@ -268,110 +554,193 @@ declare module '@polkadot/api/types/submittable' { **/ clearPublicProposals: AugmentedSubmittable<() => SubmittableExtrinsic>; /** - * Register the preimage for an upcoming proposal. This doesn't require the proposal to be in the dispatch queue but does require a deposit, returned once enacted. + * Register the preimage for an upcoming proposal. This doesn't require the proposal to be + * in the dispatch queue but does require a deposit, returned once enacted. **/ notePreimage: AugmentedSubmittable<(encodedProposal: Bytes | string | Uint8Array) => SubmittableExtrinsic>; /** - * Register the preimage for an upcoming proposal. This requires the proposal to be in the dispatch queue. No deposit is needed. + * Register the preimage for an upcoming proposal. This requires the proposal to be + * in the dispatch queue. No deposit is needed. **/ noteImminentPreimage: AugmentedSubmittable<(encodedProposal: Bytes | string | Uint8Array) => SubmittableExtrinsic>; /** - * Remove an expired proposal preimage and collect the deposit. This will only work after `VotingPeriod` blocks from the time that the preimage was noted, if it's the same account doing it. If it's a different account, then it'll only work an additional `EnactmentPeriod` later. + * Remove an expired proposal preimage and collect the deposit. + * This will only work after `VotingPeriod` blocks from the time that the preimage was + * noted, if it's the same account doing it. If it's a different account, then it'll only + * work an additional `EnactmentPeriod` later. **/ reapPreimage: AugmentedSubmittable<(proposalHash: Hash | string | Uint8Array) => SubmittableExtrinsic>; }; council: { [index: string]: SubmittableExtrinsicFunction; /** - * Set the collective's membership manually to `new_members`. Be nice to the chain and provide it pre-sorted. Requires root origin. + * Set the collective's membership manually to `new_members`. Be nice to the chain and + * provide it pre-sorted. + * Requires root origin. **/ setMembers: AugmentedSubmittable<(newMembers: Vec | (AccountId | string | Uint8Array)[]) => SubmittableExtrinsic>; /** - * Dispatch a proposal from a member using the `Member` origin. Origin must be a member of the collective. + * Dispatch a proposal from a member using the `Member` origin. + * Origin must be a member of the collective. **/ execute: AugmentedSubmittable<(proposal: Proposal | object | string | Uint8Array) => SubmittableExtrinsic>; /** - * # - Bounded storage reads and writes. - Argument `threshold` has bearing on weight. # + * # + * - Bounded storage reads and writes. + * - Argument `threshold` has bearing on weight. + * # **/ propose: AugmentedSubmittable<(threshold: Compact | AnyNumber | Uint8Array, proposal: Proposal | object | string | Uint8Array) => SubmittableExtrinsic>; /** - * # - Bounded storage read and writes. - Will be slightly heavier if the proposal is approved / disapproved after the vote. # + * # + * - Bounded storage read and writes. + * - Will be slightly heavier if the proposal is approved / disapproved after the vote. + * # **/ vote: AugmentedSubmittable<(proposal: Hash | string | Uint8Array, index: Compact | AnyNumber | Uint8Array, approve: bool | boolean | Uint8Array) => SubmittableExtrinsic>; }; technicalCommittee: { [index: string]: SubmittableExtrinsicFunction; /** - * Set the collective's membership manually to `new_members`. Be nice to the chain and provide it pre-sorted. Requires root origin. + * Set the collective's membership manually to `new_members`. Be nice to the chain and + * provide it pre-sorted. + * Requires root origin. **/ setMembers: AugmentedSubmittable<(newMembers: Vec | (AccountId | string | Uint8Array)[]) => SubmittableExtrinsic>; /** - * Dispatch a proposal from a member using the `Member` origin. Origin must be a member of the collective. + * Dispatch a proposal from a member using the `Member` origin. + * Origin must be a member of the collective. **/ execute: AugmentedSubmittable<(proposal: Proposal | object | string | Uint8Array) => SubmittableExtrinsic>; /** - * # - Bounded storage reads and writes. - Argument `threshold` has bearing on weight. # + * # + * - Bounded storage reads and writes. + * - Argument `threshold` has bearing on weight. + * # **/ propose: AugmentedSubmittable<(threshold: Compact | AnyNumber | Uint8Array, proposal: Proposal | object | string | Uint8Array) => SubmittableExtrinsic>; /** - * # - Bounded storage read and writes. - Will be slightly heavier if the proposal is approved / disapproved after the vote. # + * # + * - Bounded storage read and writes. + * - Will be slightly heavier if the proposal is approved / disapproved after the vote. + * # **/ vote: AugmentedSubmittable<(proposal: Hash | string | Uint8Array, index: Compact | AnyNumber | Uint8Array, approve: bool | boolean | Uint8Array) => SubmittableExtrinsic>; }; elections: { [index: string]: SubmittableExtrinsicFunction; /** - * Vote for a set of candidates for the upcoming round of election. The `votes` should: - not be empty. - be less than the number of candidates. Upon voting, `value` units of `who`'s balance is locked and a bond amount is reserved. It is the responsibility of the caller to not place all of their balance into the lock and keep some for further transactions. # #### State Reads: O(1) Writes: O(V) given `V` votes. V is bounded by 16. # + * Vote for a set of candidates for the upcoming round of election. + * The `votes` should: + * - not be empty. + * - be less than the number of candidates. + * Upon voting, `value` units of `who`'s balance is locked and a bond amount is reserved. + * It is the responsibility of the caller to not place all of their balance into the lock + * and keep some for further transactions. + * # + * #### State + * Reads: O(1) + * Writes: O(V) given `V` votes. V is bounded by 16. + * # **/ vote: AugmentedSubmittable<(votes: Vec | (AccountId | string | Uint8Array)[], value: Compact | AnyNumber | Uint8Array) => SubmittableExtrinsic>; /** - * Remove `origin` as a voter. This removes the lock and returns the bond. # #### State Reads: O(1) Writes: O(1) # + * Remove `origin` as a voter. This removes the lock and returns the bond. + * # + * #### State + * Reads: O(1) + * Writes: O(1) + * # **/ removeVoter: AugmentedSubmittable<() => SubmittableExtrinsic>; /** - * Report `target` for being an defunct voter. In case of a valid report, the reporter is rewarded by the bond amount of `target`. Otherwise, the reporter itself is removed and their bond is slashed. A defunct voter is defined to be: - a voter whose current submitted votes are all invalid. i.e. all of them are no longer a candidate nor an active member. # #### State Reads: O(NLogM) given M current candidates and N votes for `target`. Writes: O(1) # + * Report `target` for being an defunct voter. In case of a valid report, the reporter is + * rewarded by the bond amount of `target`. Otherwise, the reporter itself is removed and + * their bond is slashed. + * A defunct voter is defined to be: + * - a voter whose current submitted votes are all invalid. i.e. all of them are no + * longer a candidate nor an active member. + * # + * #### State + * Reads: O(NLogM) given M current candidates and N votes for `target`. + * Writes: O(1) + * # **/ reportDefunctVoter: AugmentedSubmittable<(target: Address | string | AccountId | AccountIndex | Uint8Array) => SubmittableExtrinsic>; /** - * Submit oneself for candidacy. A candidate will either: - Lose at the end of the term and forfeit their deposit. - Win and become a member. Members will eventually get their stash back. - Become a runner-up. Runners-ups are reserved members in case one gets forcefully removed. # #### State Reads: O(LogN) Given N candidates. Writes: O(1) # + * Submit oneself for candidacy. + * A candidate will either: + * - Lose at the end of the term and forfeit their deposit. + * - Win and become a member. Members will eventually get their stash back. + * - Become a runner-up. Runners-ups are reserved members in case one gets forcefully + * removed. + * # + * #### State + * Reads: O(LogN) Given N candidates. + * Writes: O(1) + * # **/ submitCandidacy: AugmentedSubmittable<() => SubmittableExtrinsic>; /** - * Renounce one's intention to be a candidate for the next election round. 3 potential outcomes exist: - `origin` is a candidate and not elected in any set. In this case, the bond is unreserved, returned and origin is removed as a candidate. - `origin` is a current runner up. In this case, the bond is unreserved, returned and origin is removed as a runner. - `origin` is a current member. In this case, the bond is unreserved and origin is removed as a member, consequently not being a candidate for the next round anymore. Similar to [`remove_voter`], if replacement runners exists, they are immediately used. + * Renounce one's intention to be a candidate for the next election round. 3 potential + * outcomes exist: + * - `origin` is a candidate and not elected in any set. In this case, the bond is + * unreserved, returned and origin is removed as a candidate. + * - `origin` is a current runner up. In this case, the bond is unreserved, returned and + * origin is removed as a runner. + * - `origin` is a current member. In this case, the bond is unreserved and origin is + * removed as a member, consequently not being a candidate for the next round anymore. + * Similar to [`remove_voter`], if replacement runners exists, they are immediately used. **/ renounceCandidacy: AugmentedSubmittable<() => SubmittableExtrinsic>; /** - * Remove a particular member from the set. This is effective immediately and the bond of the outgoing member is slashed. If a runner-up is available, then the best runner-up will be removed and replaces the outgoing member. Otherwise, a new phragmen round is started. Note that this does not affect the designated block number of the next election. # #### State Reads: O(do_phragmen) Writes: O(do_phragmen) # + * Remove a particular member from the set. This is effective immediately and the bond of + * the outgoing member is slashed. + * If a runner-up is available, then the best runner-up will be removed and replaces the + * outgoing member. Otherwise, a new phragmen round is started. + * Note that this does not affect the designated block number of the next election. + * # + * #### State + * Reads: O(do_phragmen) + * Writes: O(do_phragmen) + * # **/ removeMember: AugmentedSubmittable<(who: Address | string | AccountId | AccountIndex | Uint8Array) => SubmittableExtrinsic>; }; technicalMembership: { [index: string]: SubmittableExtrinsicFunction; /** - * Add a member `who` to the set. May only be called from `AddOrigin` or root. + * Add a member `who` to the set. + * May only be called from `AddOrigin` or root. **/ addMember: AugmentedSubmittable<(who: AccountId | string | Uint8Array) => SubmittableExtrinsic>; /** - * Remove a member `who` from the set. May only be called from `RemoveOrigin` or root. + * Remove a member `who` from the set. + * May only be called from `RemoveOrigin` or root. **/ removeMember: AugmentedSubmittable<(who: AccountId | string | Uint8Array) => SubmittableExtrinsic>; /** - * Swap out one member `remove` for another `add`. May only be called from `SwapOrigin` or root. + * Swap out one member `remove` for another `add`. + * May only be called from `SwapOrigin` or root. **/ swapMember: AugmentedSubmittable<(remove: AccountId | string | Uint8Array, add: AccountId | string | Uint8Array) => SubmittableExtrinsic>; /** - * Change the membership to a new set, disregarding the existing membership. Be nice and pass `members` pre-sorted. May only be called from `ResetOrigin` or root. + * Change the membership to a new set, disregarding the existing membership. Be nice and + * pass `members` pre-sorted. + * May only be called from `ResetOrigin` or root. **/ resetMembers: AugmentedSubmittable<(members: Vec | (AccountId | string | Uint8Array)[]) => SubmittableExtrinsic>; /** - * Swap out the sending member for some other key `new`. May only be called from `Signed` origin of a current member. + * Swap out the sending member for some other key `new`. + * May only be called from `Signed` origin of a current member. **/ changeKey: AugmentedSubmittable<(updated: AccountId | string | Uint8Array) => SubmittableExtrinsic>; }; finalityTracker: { [index: string]: SubmittableExtrinsicFunction; /** - * Hint that the author of this block thinks the best finalized block is the given number. + * Hint that the author of this block thinks the best finalized + * block is the given number. **/ finalHint: AugmentedSubmittable<(hint: Compact | AnyNumber | Uint8Array) => SubmittableExtrinsic>; }; @@ -385,73 +754,192 @@ declare module '@polkadot/api/types/submittable' { treasury: { [index: string]: SubmittableExtrinsicFunction; /** - * Put forward a suggestion for spending. A deposit proportional to the value is reserved and slashed if the proposal is rejected. It is returned once the proposal is awarded. # - O(1). - Limited storage reads. - One DB change, one extra DB entry. # + * Put forward a suggestion for spending. A deposit proportional to the value + * is reserved and slashed if the proposal is rejected. It is returned once the + * proposal is awarded. + * # + * - O(1). + * - Limited storage reads. + * - One DB change, one extra DB entry. + * # **/ proposeSpend: AugmentedSubmittable<(value: Compact | AnyNumber | Uint8Array, beneficiary: Address | string | AccountId | AccountIndex | Uint8Array) => SubmittableExtrinsic>; /** - * Reject a proposed spend. The original deposit will be slashed. # - O(1). - Limited storage reads. - One DB clear. # + * Reject a proposed spend. The original deposit will be slashed. + * # + * - O(1). + * - Limited storage reads. + * - One DB clear. + * # **/ rejectProposal: AugmentedSubmittable<(proposalId: Compact | AnyNumber | Uint8Array) => SubmittableExtrinsic>; /** - * Approve a proposal. At a later time, the proposal will be allocated to the beneficiary and the original deposit will be returned. # - O(1). - Limited storage reads. - One DB change. # + * Approve a proposal. At a later time, the proposal will be allocated to the beneficiary + * and the original deposit will be returned. + * # + * - O(1). + * - Limited storage reads. + * - One DB change. + * # **/ approveProposal: AugmentedSubmittable<(proposalId: Compact | AnyNumber | Uint8Array) => SubmittableExtrinsic>; /** - * 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 `TipReportDepositPerByte` 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. # - `O(R)` where `R` length of `reason`. - One balance operation. - One storage mutation (codec `O(R)`). - One event. # + * 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 + * `TipReportDepositPerByte` 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. + * # + * - `O(R)` where `R` length of `reason`. + * - One balance operation. + * - One storage mutation (codec `O(R)`). + * - One event. + * # **/ reportAwesome: AugmentedSubmittable<(reason: Bytes | string | Uint8Array, who: AccountId | string | Uint8Array) => SubmittableExtrinsic>; /** - * 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. # - `O(T)` - One balance operation. - Two storage removals (one read, codec `O(T)`). - One event. # + * 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. + * # + * - `O(T)` + * - One balance operation. + * - Two storage removals (one read, codec `O(T)`). + * - One event. + * # **/ retractTip: AugmentedSubmittable<(hash: Hash | string | Uint8Array) => SubmittableExtrinsic>; /** - * 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. # - `O(R + T)` where `R` length of `reason`, `T` is the number of tippers. `T` is naturally capped as a membership set, `R` is limited through transaction-size. - Two storage insertions (codecs `O(R)`, `O(T)`), one read `O(1)`. - One event. # + * 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. + * # + * - `O(R + T)` where `R` length of `reason`, `T` is the number of tippers. `T` is + * naturally capped as a membership set, `R` is limited through transaction-size. + * - Two storage insertions (codecs `O(R)`, `O(T)`), one read `O(1)`. + * - One event. + * # **/ tipNew: AugmentedSubmittable<(reason: Bytes | string | Uint8Array, who: AccountId | string | Uint8Array, tipValue: BalanceOf | AnyNumber | Uint8Array) => SubmittableExtrinsic>; /** - * 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. # - `O(T)` - One storage mutation (codec `O(T)`), one storage read `O(1)`. - Up to one event. # + * 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. + * # + * - `O(T)` + * - One storage mutation (codec `O(T)`), one storage read `O(1)`. + * - Up to one event. + * # **/ tip: AugmentedSubmittable<(hash: Hash | string | Uint8Array, tipValue: BalanceOf | AnyNumber | Uint8Array) => SubmittableExtrinsic>; /** - * 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. # - `O(T)` - One storage retrieval (codec `O(T)`) and two removals. - Up to three balance operations. # + * 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. + * # + * - `O(T)` + * - One storage retrieval (codec `O(T)`) and two removals. + * - Up to three balance operations. + * # **/ closeTip: AugmentedSubmittable<(hash: Hash | string | Uint8Array) => SubmittableExtrinsic>; }; contracts: { [index: string]: SubmittableExtrinsicFunction; /** - * Updates the schedule for metering contracts. The schedule must have a greater version than the stored schedule. + * Updates the schedule for metering contracts. + * The schedule must have a greater version than the stored schedule. **/ updateSchedule: AugmentedSubmittable<(schedule: Schedule | object | string | Uint8Array) => SubmittableExtrinsic>; /** - * Stores the given binary Wasm code into the chain's storage and returns its `codehash`. You can instantiate contracts only with stored code. + * Stores the given binary Wasm code into the chain's storage and returns its `codehash`. + * You can instantiate contracts only with stored code. **/ putCode: AugmentedSubmittable<(gasLimit: Compact | AnyNumber | Uint8Array, code: Bytes | string | Uint8Array) => SubmittableExtrinsic>; /** - * Makes a call to an account, optionally transferring some balance. * If the account is a smart-contract account, the associated code will be executed and any value will be transferred. * If the account is a regular account, any value will be transferred. * If no account exists and the call value is not less than `existential_deposit`, a regular account will be created and any value will be transferred. + * Makes a call to an account, optionally transferring some balance. + * * If the account is a smart-contract account, the associated code will be + * executed and any value will be transferred. + * * If the account is a regular account, any value will be transferred. + * * If no account exists and the call value is not less than `existential_deposit`, + * a regular account will be created and any value will be transferred. **/ call: AugmentedSubmittable<(dest: Address | string | AccountId | AccountIndex | Uint8Array, value: Compact | AnyNumber | Uint8Array, gasLimit: Compact | AnyNumber | Uint8Array, data: Bytes | string | Uint8Array) => SubmittableExtrinsic>; /** - * Instantiates a new contract from the `codehash` generated by `put_code`, optionally transferring some balance. Instantiation is executed as follows: - The destination address is computed based on the sender and hash of the code. - The smart-contract account is created at the computed address. - The `ctor_code` is executed in the context of the newly-created account. Buffer returned after the execution is saved as the `code` of the account. That code will be invoked upon any call received by this account. - The contract is initialized. + * Instantiates a new contract from the `codehash` generated by `put_code`, optionally transferring some balance. + * Instantiation is executed as follows: + * - The destination address is computed based on the sender and hash of the code. + * - The smart-contract account is created at the computed address. + * - The `ctor_code` is executed in the context of the newly-created account. Buffer returned + * after the execution is saved as the `code` of the account. That code will be invoked + * upon any call received by this account. + * - The contract is initialized. **/ instantiate: AugmentedSubmittable<(endowment: Compact | AnyNumber | Uint8Array, gasLimit: Compact | AnyNumber | Uint8Array, codeHash: CodeHash | string | Uint8Array, data: Bytes | string | Uint8Array) => SubmittableExtrinsic>; /** - * Allows block producers to claim a small reward for evicting a contract. If a block producer fails to do so, a regular users will be allowed to claim the reward. If contract is not evicted as a result of this call, no actions are taken and the sender is not eligible for the reward. + * Allows block producers to claim a small reward for evicting a contract. If a block producer + * fails to do so, a regular users will be allowed to claim the reward. + * If contract is not evicted as a result of this call, no actions are taken and + * the sender is not eligible for the reward. **/ claimSurcharge: AugmentedSubmittable<(dest: AccountId | string | Uint8Array, auxSender: Option | null | object | string | Uint8Array) => SubmittableExtrinsic>; }; sudo: { [index: string]: SubmittableExtrinsicFunction; /** - * Authenticates the sudo key and dispatches a function call with `Root` origin. The dispatch origin for this call must be _Signed_. # - O(1). - Limited storage reads. - One DB write (event). - Unknown weight of derivative `proposal` execution. # + * Authenticates the sudo key and dispatches a function call with `Root` origin. + * The dispatch origin for this call must be _Signed_. + * # + * - O(1). + * - Limited storage reads. + * - One DB write (event). + * - Unknown weight of derivative `proposal` execution. + * # **/ sudo: AugmentedSubmittable<(proposal: Proposal | object | string | Uint8Array) => SubmittableExtrinsic>; /** - * Authenticates the current sudo key and sets the given AccountId (`new`) as the new sudo key. The dispatch origin for this call must be _Signed_. # - O(1). - Limited storage reads. - One DB change. # + * Authenticates the current sudo key and sets the given AccountId (`new`) as the new sudo key. + * The dispatch origin for this call must be _Signed_. + * # + * - O(1). + * - Limited storage reads. + * - One DB change. + * # **/ setKey: AugmentedSubmittable<(updated: Address | string | AccountId | AccountIndex | Uint8Array) => SubmittableExtrinsic>; /** - * Authenticates the sudo key and dispatches a function call with `Signed` origin from a given account. The dispatch origin for this call must be _Signed_. # - O(1). - Limited storage reads. - One DB write (event). - Unknown weight of derivative `proposal` execution. # + * Authenticates the sudo key and dispatches a function call with `Signed` origin from + * a given account. + * The dispatch origin for this call must be _Signed_. + * # + * - O(1). + * - Limited storage reads. + * - One DB write (event). + * - Unknown weight of derivative `proposal` execution. + * # **/ sudoAs: AugmentedSubmittable<(who: Address | string | AccountId | AccountIndex | Uint8Array, proposal: Proposal | object | string | Uint8Array) => SubmittableExtrinsic>; }; @@ -462,133 +950,581 @@ declare module '@polkadot/api/types/submittable' { identity: { [index: string]: SubmittableExtrinsicFunction; /** - * Add a registrar to the system. The dispatch origin for this call must be `RegistrarOrigin` or `Root`. - `account`: the account of the registrar. Emits `RegistrarAdded` if successful. # - `O(R)` where `R` registrar-count (governance-bounded). - One storage mutation (codec `O(R)`). - One event. # + * Add a registrar to the system. + * The dispatch origin for this call must be `RegistrarOrigin` or `Root`. + * - `account`: the account of the registrar. + * Emits `RegistrarAdded` if successful. + * # + * - `O(R)` where `R` registrar-count (governance-bounded). + * - One storage mutation (codec `O(R)`). + * - One event. + * # **/ addRegistrar: AugmentedSubmittable<(account: AccountId | string | Uint8Array) => SubmittableExtrinsic>; /** - * Set an account's identity information and reserve the appropriate deposit. If the account already has identity information, the deposit is taken as part payment for the new deposit. The dispatch origin for this call must be _Signed_ and the sender must have a registered identity. - `info`: The identity information. Emits `IdentitySet` if successful. # - `O(X + R)` where `X` additional-field-count (deposit-bounded). - At most two balance operations. - One storage mutation (codec `O(X + R)`). - One event. # + * Set an account's identity information and reserve the appropriate deposit. + * If the account already has identity information, the deposit is taken as part payment + * for the new deposit. + * The dispatch origin for this call must be _Signed_ and the sender must have a registered + * identity. + * - `info`: The identity information. + * Emits `IdentitySet` if successful. + * # + * - `O(X + R)` where `X` additional-field-count (deposit-bounded). + * - At most two balance operations. + * - One storage mutation (codec `O(X + R)`). + * - One event. + * # **/ setIdentity: AugmentedSubmittable<(info: IdentityInfo | object | string | Uint8Array) => SubmittableExtrinsic>; /** - * Set the sub-accounts of the sender. Payment: Any aggregate balance reserved by previous `set_subs` calls will be returned and an amount `SubAccountDeposit` will be reserved for each item in `subs`. The dispatch origin for this call must be _Signed_ and the sender must have a registered identity. - `subs`: The identity's sub-accounts. # - `O(S)` where `S` subs-count (hard- and deposit-bounded). - At most two balance operations. - At most O(2 * S + 1) storage mutations; codec complexity `O(1 * S + S * 1)`); one storage-exists. # + * Set the sub-accounts of the sender. + * Payment: Any aggregate balance reserved by previous `set_subs` calls will be returned + * and an amount `SubAccountDeposit` will be reserved for each item in `subs`. + * The dispatch origin for this call must be _Signed_ and the sender must have a registered + * identity. + * - `subs`: The identity's sub-accounts. + * # + * - `O(S)` where `S` subs-count (hard- and deposit-bounded). + * - At most two balance operations. + * - At most O(2 * S + 1) storage mutations; codec complexity `O(1 * S + S * 1)`); + * one storage-exists. + * # **/ setSubs: AugmentedSubmittable<(subs: Vec> | ([AccountId | string | Uint8Array, Data | number | any])[]) => SubmittableExtrinsic>; /** - * Clear an account's identity info and all sub-account and return all deposits. Payment: All reserved balances on the account are returned. The dispatch origin for this call must be _Signed_ and the sender must have a registered identity. Emits `IdentityCleared` if successful. # - `O(R + S + X)`. - One balance-reserve operation. - `S + 2` storage deletions. - One event. # + * Clear an account's identity info and all sub-account and return all deposits. + * Payment: All reserved balances on the account are returned. + * The dispatch origin for this call must be _Signed_ and the sender must have a registered + * identity. + * Emits `IdentityCleared` if successful. + * # + * - `O(R + S + X)`. + * - One balance-reserve operation. + * - `S + 2` storage deletions. + * - One event. + * # **/ clearIdentity: AugmentedSubmittable<() => SubmittableExtrinsic>; /** - * Request a judgement from a registrar. Payment: At most `max_fee` will be reserved for payment to the registrar if judgement given. The dispatch origin for this call must be _Signed_ and the sender must have a registered identity. - `reg_index`: The index of the registrar whose judgement is requested. - `max_fee`: The maximum fee that may be paid. This should just be auto-populated as: ```nocompile Self::registrars(reg_index).uwnrap().fee ``` Emits `JudgementRequested` if successful. # - `O(R + X)`. - One balance-reserve operation. - Storage: 1 read `O(R)`, 1 mutate `O(X + R)`. - One event. # + * Request a judgement from a registrar. + * Payment: At most `max_fee` will be reserved for payment to the registrar if judgement + * given. + * The dispatch origin for this call must be _Signed_ and the sender must have a + * registered identity. + * - `reg_index`: The index of the registrar whose judgement is requested. + * - `max_fee`: The maximum fee that may be paid. This should just be auto-populated as: + * ```nocompile + * Self::registrars(reg_index).uwnrap().fee + * ``` + * Emits `JudgementRequested` if successful. + * # + * - `O(R + X)`. + * - One balance-reserve operation. + * - Storage: 1 read `O(R)`, 1 mutate `O(X + R)`. + * - One event. + * # **/ requestJudgement: AugmentedSubmittable<(regIndex: Compact | AnyNumber | Uint8Array, maxFee: Compact | AnyNumber | Uint8Array) => SubmittableExtrinsic>; /** - * Cancel a previous request. Payment: A previously reserved deposit is returned on success. The dispatch origin for this call must be _Signed_ and the sender must have a registered identity. - `reg_index`: The index of the registrar whose judgement is no longer requested. Emits `JudgementUnrequested` if successful. # - `O(R + X)`. - One balance-reserve operation. - One storage mutation `O(R + X)`. - One event. # + * Cancel a previous request. + * Payment: A previously reserved deposit is returned on success. + * The dispatch origin for this call must be _Signed_ and the sender must have a + * registered identity. + * - `reg_index`: The index of the registrar whose judgement is no longer requested. + * Emits `JudgementUnrequested` if successful. + * # + * - `O(R + X)`. + * - One balance-reserve operation. + * - One storage mutation `O(R + X)`. + * - One event. + * # **/ cancelRequest: AugmentedSubmittable<(regIndex: RegistrarIndex | AnyNumber | Uint8Array) => SubmittableExtrinsic>; /** - * Set the fee required for a judgement to be requested from a registrar. The dispatch origin for this call must be _Signed_ and the sender must be the account of the registrar whose index is `index`. - `index`: the index of the registrar whose fee is to be set. - `fee`: the new fee. # - `O(R)`. - One storage mutation `O(R)`. # + * Set the fee required for a judgement to be requested from a registrar. + * The dispatch origin for this call must be _Signed_ and the sender must be the account + * of the registrar whose index is `index`. + * - `index`: the index of the registrar whose fee is to be set. + * - `fee`: the new fee. + * # + * - `O(R)`. + * - One storage mutation `O(R)`. + * # **/ setFee: AugmentedSubmittable<(index: Compact | AnyNumber | Uint8Array, fee: Compact | AnyNumber | Uint8Array) => SubmittableExtrinsic>; /** - * Change the account associated with a registrar. The dispatch origin for this call must be _Signed_ and the sender must be the account of the registrar whose index is `index`. - `index`: the index of the registrar whose fee is to be set. - `new`: the new account ID. # - `O(R)`. - One storage mutation `O(R)`. # + * Change the account associated with a registrar. + * The dispatch origin for this call must be _Signed_ and the sender must be the account + * of the registrar whose index is `index`. + * - `index`: the index of the registrar whose fee is to be set. + * - `new`: the new account ID. + * # + * - `O(R)`. + * - One storage mutation `O(R)`. + * # **/ setAccountId: AugmentedSubmittable<(index: Compact | AnyNumber | Uint8Array, updated: AccountId | string | Uint8Array) => SubmittableExtrinsic>; /** - * Set the field information for a registrar. The dispatch origin for this call must be _Signed_ and the sender must be the account of the registrar whose index is `index`. - `index`: the index of the registrar whose fee is to be set. - `fields`: the fields that the registrar concerns themselves with. # - `O(R)`. - One storage mutation `O(R)`. # + * Set the field information for a registrar. + * The dispatch origin for this call must be _Signed_ and the sender must be the account + * of the registrar whose index is `index`. + * - `index`: the index of the registrar whose fee is to be set. + * - `fields`: the fields that the registrar concerns themselves with. + * # + * - `O(R)`. + * - One storage mutation `O(R)`. + * # **/ setFields: AugmentedSubmittable<(index: Compact | AnyNumber | Uint8Array, fields: IdentityFields) => SubmittableExtrinsic>; /** - * Provide a judgement for an account's identity. The dispatch origin for this call must be _Signed_ and the sender must be the account of the registrar whose index is `reg_index`. - `reg_index`: the index of the registrar whose judgement is being made. - `target`: the account whose identity the judgement is upon. This must be an account with a registered identity. - `judgement`: the judgement of the registrar of index `reg_index` about `target`. Emits `JudgementGiven` if successful. # - `O(R + X)`. - One balance-transfer operation. - Up to one account-lookup operation. - Storage: 1 read `O(R)`, 1 mutate `O(R + X)`. - One event. # + * Provide a judgement for an account's identity. + * The dispatch origin for this call must be _Signed_ and the sender must be the account + * of the registrar whose index is `reg_index`. + * - `reg_index`: the index of the registrar whose judgement is being made. + * - `target`: the account whose identity the judgement is upon. This must be an account + * with a registered identity. + * - `judgement`: the judgement of the registrar of index `reg_index` about `target`. + * Emits `JudgementGiven` if successful. + * # + * - `O(R + X)`. + * - One balance-transfer operation. + * - Up to one account-lookup operation. + * - Storage: 1 read `O(R)`, 1 mutate `O(R + X)`. + * - One event. + * # **/ provideJudgement: AugmentedSubmittable<(regIndex: Compact | AnyNumber | Uint8Array, target: Address | string | AccountId | AccountIndex | Uint8Array, judgement: IdentityJudgement | number | any) => SubmittableExtrinsic>; /** - * Remove an account's identity and sub-account information and slash the deposits. Payment: Reserved balances from `set_subs` and `set_identity` are slashed and handled by `Slash`. Verification request deposits are not returned; they should be cancelled manually using `cancel_request`. The dispatch origin for this call must be _Root_ or match `T::ForceOrigin`. - `target`: the account whose identity the judgement is upon. This must be an account with a registered identity. Emits `IdentityKilled` if successful. # - `O(R + S + X)`. - One balance-reserve operation. - `S + 2` storage mutations. - One event. # + * Remove an account's identity and sub-account information and slash the deposits. + * Payment: Reserved balances from `set_subs` and `set_identity` are slashed and handled by + * `Slash`. Verification request deposits are not returned; they should be cancelled + * manually using `cancel_request`. + * The dispatch origin for this call must be _Root_ or match `T::ForceOrigin`. + * - `target`: the account whose identity the judgement is upon. This must be an account + * with a registered identity. + * Emits `IdentityKilled` if successful. + * # + * - `O(R + S + X)`. + * - One balance-reserve operation. + * - `S + 2` storage mutations. + * - One event. + * # **/ killIdentity: AugmentedSubmittable<(target: Address | string | AccountId | AccountIndex | Uint8Array) => SubmittableExtrinsic>; }; society: { [index: string]: SubmittableExtrinsicFunction; /** - * A user outside of the society can make a bid for entry. Payment: `CandidateDeposit` will be reserved for making a bid. It is returned when the bid becomes a member, or if the bid calls `unbid`. The dispatch origin for this call must be _Signed_. Parameters: - `value`: A one time payment the bid would like to receive when joining the society. # Key: B (len of bids), C (len of candidates), M (len of members), X (balance reserve) - Storage Reads: - One storage read to check for suspended candidate. O(1) - One storage read to check for suspended member. O(1) - One storage read to retrieve all current bids. O(B) - One storage read to retrieve all current candidates. O(C) - One storage read to retrieve all members. O(M) - Storage Writes: - One storage mutate to add a new bid to the vector O(B) (TODO: possible optimization w/ read) - Up to one storage removal if bid.len() > MAX_BID_COUNT. O(1) - Notable Computation: - O(B + C + log M) search to check user is not already a part of society. - O(log B) search to insert the new bid sorted. - External Module Operations: - One balance reserve operation. O(X) - Up to one balance unreserve operation if bids.len() > MAX_BID_COUNT. - Events: - One event for new bid. - Up to one event for AutoUnbid if bid.len() > MAX_BID_COUNT. Total Complexity: O(M + B + C + logM + logB + X) # + * A user outside of the society can make a bid for entry. + * Payment: `CandidateDeposit` will be reserved for making a bid. It is returned + * when the bid becomes a member, or if the bid calls `unbid`. + * The dispatch origin for this call must be _Signed_. + * Parameters: + * - `value`: A one time payment the bid would like to receive when joining the society. + * # + * Key: B (len of bids), C (len of candidates), M (len of members), X (balance reserve) + * - Storage Reads: + * - One storage read to check for suspended candidate. O(1) + * - One storage read to check for suspended member. O(1) + * - One storage read to retrieve all current bids. O(B) + * - One storage read to retrieve all current candidates. O(C) + * - One storage read to retrieve all members. O(M) + * - Storage Writes: + * - One storage mutate to add a new bid to the vector O(B) (TODO: possible optimization w/ read) + * - Up to one storage removal if bid.len() > MAX_BID_COUNT. O(1) + * - Notable Computation: + * - O(B + C + log M) search to check user is not already a part of society. + * - O(log B) search to insert the new bid sorted. + * - External Module Operations: + * - One balance reserve operation. O(X) + * - Up to one balance unreserve operation if bids.len() > MAX_BID_COUNT. + * - Events: + * - One event for new bid. + * - Up to one event for AutoUnbid if bid.len() > MAX_BID_COUNT. + * Total Complexity: O(M + B + C + logM + logB + X) + * # **/ bid: AugmentedSubmittable<(value: BalanceOf | AnyNumber | Uint8Array) => SubmittableExtrinsic>; /** - * A bidder can remove their bid for entry into society. By doing so, they will have their candidate deposit returned or they will unvouch their voucher. Payment: The bid deposit is unreserved if the user made a bid. The dispatch origin for this call must be _Signed_ and a bidder. Parameters: - `pos`: Position in the `Bids` vector of the bid who wants to unbid. # Key: B (len of bids), X (balance unreserve) - One storage read and write to retrieve and update the bids. O(B) - Either one unreserve balance action O(X) or one vouching storage removal. O(1) - One event. Total Complexity: O(B + X) # + * A bidder can remove their bid for entry into society. + * By doing so, they will have their candidate deposit returned or + * they will unvouch their voucher. + * Payment: The bid deposit is unreserved if the user made a bid. + * The dispatch origin for this call must be _Signed_ and a bidder. + * Parameters: + * - `pos`: Position in the `Bids` vector of the bid who wants to unbid. + * # + * Key: B (len of bids), X (balance unreserve) + * - One storage read and write to retrieve and update the bids. O(B) + * - Either one unreserve balance action O(X) or one vouching storage removal. O(1) + * - One event. + * Total Complexity: O(B + X) + * # **/ unbid: AugmentedSubmittable<(pos: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic>; /** - * As a member, vouch for someone to join society by placing a bid on their behalf. There is no deposit required to vouch for a new bid, but a member can only vouch for one bid at a time. If the bid becomes a suspended candidate and ultimately rejected by the suspension judgement origin, the member will be banned from vouching again. As a vouching member, you can claim a tip if the candidate is accepted. This tip will be paid as a portion of the reward the member will receive for joining the society. The dispatch origin for this call must be _Signed_ and a member. Parameters: - `who`: The user who you would like to vouch for. - `value`: The total reward to be paid between you and the candidate if they become a member in the society. - `tip`: Your cut of the total `value` payout when the candidate is inducted into the society. Tips larger than `value` will be saturated upon payout. # Key: B (len of bids), C (len of candidates), M (len of members) - Storage Reads: - One storage read to retrieve all members. O(M) - One storage read to check member is not already vouching. O(1) - One storage read to check for suspended candidate. O(1) - One storage read to check for suspended member. O(1) - One storage read to retrieve all current bids. O(B) - One storage read to retrieve all current candidates. O(C) - Storage Writes: - One storage write to insert vouching status to the member. O(1) - One storage mutate to add a new bid to the vector O(B) (TODO: possible optimization w/ read) - Up to one storage removal if bid.len() > MAX_BID_COUNT. O(1) - Notable Computation: - O(log M) search to check sender is a member. - O(B + C + log M) search to check user is not already a part of society. - O(log B) search to insert the new bid sorted. - External Module Operations: - One balance reserve operation. O(X) - Up to one balance unreserve operation if bids.len() > MAX_BID_COUNT. - Events: - One event for vouch. - Up to one event for AutoUnbid if bid.len() > MAX_BID_COUNT. Total Complexity: O(M + B + C + logM + logB + X) # + * As a member, vouch for someone to join society by placing a bid on their behalf. + * There is no deposit required to vouch for a new bid, but a member can only vouch for + * one bid at a time. If the bid becomes a suspended candidate and ultimately rejected by + * the suspension judgement origin, the member will be banned from vouching again. + * As a vouching member, you can claim a tip if the candidate is accepted. This tip will + * be paid as a portion of the reward the member will receive for joining the society. + * The dispatch origin for this call must be _Signed_ and a member. + * Parameters: + * - `who`: The user who you would like to vouch for. + * - `value`: The total reward to be paid between you and the candidate if they become + * a member in the society. + * - `tip`: Your cut of the total `value` payout when the candidate is inducted into + * the society. Tips larger than `value` will be saturated upon payout. + * # + * Key: B (len of bids), C (len of candidates), M (len of members) + * - Storage Reads: + * - One storage read to retrieve all members. O(M) + * - One storage read to check member is not already vouching. O(1) + * - One storage read to check for suspended candidate. O(1) + * - One storage read to check for suspended member. O(1) + * - One storage read to retrieve all current bids. O(B) + * - One storage read to retrieve all current candidates. O(C) + * - Storage Writes: + * - One storage write to insert vouching status to the member. O(1) + * - One storage mutate to add a new bid to the vector O(B) (TODO: possible optimization w/ read) + * - Up to one storage removal if bid.len() > MAX_BID_COUNT. O(1) + * - Notable Computation: + * - O(log M) search to check sender is a member. + * - O(B + C + log M) search to check user is not already a part of society. + * - O(log B) search to insert the new bid sorted. + * - External Module Operations: + * - One balance reserve operation. O(X) + * - Up to one balance unreserve operation if bids.len() > MAX_BID_COUNT. + * - Events: + * - One event for vouch. + * - Up to one event for AutoUnbid if bid.len() > MAX_BID_COUNT. + * Total Complexity: O(M + B + C + logM + logB + X) + * # **/ vouch: AugmentedSubmittable<(who: AccountId | string | Uint8Array, value: BalanceOf | AnyNumber | Uint8Array, tip: BalanceOf | AnyNumber | Uint8Array) => SubmittableExtrinsic>; /** - * As a vouching member, unvouch a bid. This only works while vouched user is only a bidder (and not a candidate). The dispatch origin for this call must be _Signed_ and a vouching member. Parameters: - `pos`: Position in the `Bids` vector of the bid who should be unvouched. # Key: B (len of bids) - One storage read O(1) to check the signer is a vouching member. - One storage mutate to retrieve and update the bids. O(B) - One vouching storage removal. O(1) - One event. Total Complexity: O(B) # + * As a vouching member, unvouch a bid. This only works while vouched user is + * only a bidder (and not a candidate). + * The dispatch origin for this call must be _Signed_ and a vouching member. + * Parameters: + * - `pos`: Position in the `Bids` vector of the bid who should be unvouched. + * # + * Key: B (len of bids) + * - One storage read O(1) to check the signer is a vouching member. + * - One storage mutate to retrieve and update the bids. O(B) + * - One vouching storage removal. O(1) + * - One event. + * Total Complexity: O(B) + * # **/ unvouch: AugmentedSubmittable<(pos: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic>; /** - * As a member, vote on a candidate. The dispatch origin for this call must be _Signed_ and a member. Parameters: - `candidate`: The candidate that the member would like to bid on. - `approve`: A boolean which says if the candidate should be approved (`true`) or rejected (`false`). # Key: C (len of candidates), M (len of members) - One storage read O(M) and O(log M) search to check user is a member. - One account lookup. - One storage read O(C) and O(C) search to check that user is a candidate. - One storage write to add vote to votes. O(1) - One event. Total Complexity: O(M + logM + C) # + * As a member, vote on a candidate. + * The dispatch origin for this call must be _Signed_ and a member. + * Parameters: + * - `candidate`: The candidate that the member would like to bid on. + * - `approve`: A boolean which says if the candidate should be + * approved (`true`) or rejected (`false`). + * # + * Key: C (len of candidates), M (len of members) + * - One storage read O(M) and O(log M) search to check user is a member. + * - One account lookup. + * - One storage read O(C) and O(C) search to check that user is a candidate. + * - One storage write to add vote to votes. O(1) + * - One event. + * Total Complexity: O(M + logM + C) + * # **/ vote: AugmentedSubmittable<(candidate: Address | string | AccountId | AccountIndex | Uint8Array, approve: bool | boolean | Uint8Array) => SubmittableExtrinsic>; /** - * As a member, vote on the defender. The dispatch origin for this call must be _Signed_ and a member. Parameters: - `approve`: A boolean which says if the candidate should be approved (`true`) or rejected (`false`). # - Key: M (len of members) - One storage read O(M) and O(log M) search to check user is a member. - One storage write to add vote to votes. O(1) - One event. Total Complexity: O(M + logM) # + * As a member, vote on the defender. + * The dispatch origin for this call must be _Signed_ and a member. + * Parameters: + * - `approve`: A boolean which says if the candidate should be + * approved (`true`) or rejected (`false`). + * # + * - Key: M (len of members) + * - One storage read O(M) and O(log M) search to check user is a member. + * - One storage write to add vote to votes. O(1) + * - One event. + * Total Complexity: O(M + logM) + * # **/ defenderVote: AugmentedSubmittable<(approve: bool | boolean | Uint8Array) => SubmittableExtrinsic>; /** - * Transfer the first matured payout for the sender and remove it from the records. NOTE: This extrinsic needs to be called multiple times to claim multiple matured payouts. Payment: The member will receive a payment equal to their first matured payout to their free balance. The dispatch origin for this call must be _Signed_ and a member with payouts remaining. # Key: M (len of members), P (number of payouts for a particular member) - One storage read O(M) and O(log M) search to check signer is a member. - One storage read O(P) to get all payouts for a member. - One storage read O(1) to get the current block number. - One currency transfer call. O(X) - One storage write or removal to update the member's payouts. O(P) Total Complexity: O(M + logM + P + X) # + * Transfer the first matured payout for the sender and remove it from the records. + * NOTE: This extrinsic needs to be called multiple times to claim multiple matured payouts. + * Payment: The member will receive a payment equal to their first matured + * payout to their free balance. + * The dispatch origin for this call must be _Signed_ and a member with + * payouts remaining. + * # + * Key: M (len of members), P (number of payouts for a particular member) + * - One storage read O(M) and O(log M) search to check signer is a member. + * - One storage read O(P) to get all payouts for a member. + * - One storage read O(1) to get the current block number. + * - One currency transfer call. O(X) + * - One storage write or removal to update the member's payouts. O(P) + * Total Complexity: O(M + logM + P + X) + * # **/ payout: AugmentedSubmittable<() => SubmittableExtrinsic>; /** - * Found the society. This is done as a discrete action in order to allow for the module to be included into a running chain and can only be done once. The dispatch origin for this call must be from the _FounderSetOrigin_. Parameters: - `founder` - The first member and head of the newly founded society. - `max_members` - The initial max number of members for the society. - `rules` - The rules of this society concerning membership. # - Two storage mutates to set `Head` and `Founder`. O(1) - One storage write to add the first member to society. O(1) - One event. Total Complexity: O(1) # + * Found the society. + * This is done as a discrete action in order to allow for the + * module to be included into a running chain and can only be done once. + * The dispatch origin for this call must be from the _FounderSetOrigin_. + * Parameters: + * - `founder` - The first member and head of the newly founded society. + * - `max_members` - The initial max number of members for the society. + * - `rules` - The rules of this society concerning membership. + * # + * - Two storage mutates to set `Head` and `Founder`. O(1) + * - One storage write to add the first member to society. O(1) + * - One event. + * Total Complexity: O(1) + * # **/ found: AugmentedSubmittable<(founder: AccountId | string | Uint8Array, maxMembers: u32 | AnyNumber | Uint8Array, rules: Bytes | string | Uint8Array) => SubmittableExtrinsic>; /** - * Anull the founding of the society. The dispatch origin for this call must be Signed, and the signing account must be both the `Founder` and the `Head`. This implies that it may only be done when there is one member. # - Two storage reads O(1). - Four storage removals O(1). - One event. Total Complexity: O(1) # + * Anull the founding of the society. + * The dispatch origin for this call must be Signed, and the signing account must be both + * the `Founder` and the `Head`. This implies that it may only be done when there is one + * member. + * # + * - Two storage reads O(1). + * - Four storage removals O(1). + * - One event. + * Total Complexity: O(1) + * # **/ unfound: AugmentedSubmittable<() => SubmittableExtrinsic>; /** - * Allow suspension judgement origin to make judgement on a suspended member. If a suspended member is forgiven, we simply add them back as a member, not affecting any of the existing storage items for that member. If a suspended member is rejected, remove all associated storage items, including their payouts, and remove any vouched bids they currently have. The dispatch origin for this call must be from the _SuspensionJudgementOrigin_. Parameters: - `who` - The suspended member to be judged. - `forgive` - A boolean representing whether the suspension judgement origin forgives (`true`) or rejects (`false`) a suspended member. # Key: B (len of bids), M (len of members) - One storage read to check `who` is a suspended member. O(1) - Up to one storage write O(M) with O(log M) binary search to add a member back to society. - Up to 3 storage removals O(1) to clean up a removed member. - Up to one storage write O(B) with O(B) search to remove vouched bid from bids. - Up to one additional event if unvouch takes place. - One storage removal. O(1) - One event for the judgement. Total Complexity: O(M + logM + B) # + * Allow suspension judgement origin to make judgement on a suspended member. + * If a suspended member is forgiven, we simply add them back as a member, not affecting + * any of the existing storage items for that member. + * If a suspended member is rejected, remove all associated storage items, including + * their payouts, and remove any vouched bids they currently have. + * The dispatch origin for this call must be from the _SuspensionJudgementOrigin_. + * Parameters: + * - `who` - The suspended member to be judged. + * - `forgive` - A boolean representing whether the suspension judgement origin + * forgives (`true`) or rejects (`false`) a suspended member. + * # + * Key: B (len of bids), M (len of members) + * - One storage read to check `who` is a suspended member. O(1) + * - Up to one storage write O(M) with O(log M) binary search to add a member back to society. + * - Up to 3 storage removals O(1) to clean up a removed member. + * - Up to one storage write O(B) with O(B) search to remove vouched bid from bids. + * - Up to one additional event if unvouch takes place. + * - One storage removal. O(1) + * - One event for the judgement. + * Total Complexity: O(M + logM + B) + * # **/ judgeSuspendedMember: AugmentedSubmittable<(who: AccountId | string | Uint8Array, forgive: bool | boolean | Uint8Array) => SubmittableExtrinsic>; /** - * Allow suspended judgement origin to make judgement on a suspended candidate. If the judgement is `Approve`, we add them to society as a member with the appropriate payment for joining society. If the judgement is `Reject`, we either slash the deposit of the bid, giving it back to the society treasury, or we ban the voucher from vouching again. If the judgement is `Rebid`, we put the candidate back in the bid pool and let them go through the induction process again. The dispatch origin for this call must be from the _SuspensionJudgementOrigin_. Parameters: - `who` - The suspended candidate to be judged. - `judgement` - `Approve`, `Reject`, or `Rebid`. # Key: B (len of bids), M (len of members), X (balance action) - One storage read to check `who` is a suspended candidate. - One storage removal of the suspended candidate. - Approve Logic - One storage read to get the available pot to pay users with. O(1) - One storage write to update the available pot. O(1) - One storage read to get the current block number. O(1) - One storage read to get all members. O(M) - Up to one unreserve currency action. - Up to two new storage writes to payouts. - Up to one storage write with O(log M) binary search to add a member to society. - Reject Logic - Up to one repatriate reserved currency action. O(X) - Up to one storage write to ban the vouching member from vouching again. - Rebid Logic - Storage mutate with O(log B) binary search to place the user back into bids. - Up to one additional event if unvouch takes place. - One storage removal. - One event for the judgement. Total Complexity: O(M + logM + B + X) # + * Allow suspended judgement origin to make judgement on a suspended candidate. + * If the judgement is `Approve`, we add them to society as a member with the appropriate + * payment for joining society. + * If the judgement is `Reject`, we either slash the deposit of the bid, giving it back + * to the society treasury, or we ban the voucher from vouching again. + * If the judgement is `Rebid`, we put the candidate back in the bid pool and let them go + * through the induction process again. + * The dispatch origin for this call must be from the _SuspensionJudgementOrigin_. + * Parameters: + * - `who` - The suspended candidate to be judged. + * - `judgement` - `Approve`, `Reject`, or `Rebid`. + * # + * Key: B (len of bids), M (len of members), X (balance action) + * - One storage read to check `who` is a suspended candidate. + * - One storage removal of the suspended candidate. + * - Approve Logic + * - One storage read to get the available pot to pay users with. O(1) + * - One storage write to update the available pot. O(1) + * - One storage read to get the current block number. O(1) + * - One storage read to get all members. O(M) + * - Up to one unreserve currency action. + * - Up to two new storage writes to payouts. + * - Up to one storage write with O(log M) binary search to add a member to society. + * - Reject Logic + * - Up to one repatriate reserved currency action. O(X) + * - Up to one storage write to ban the vouching member from vouching again. + * - Rebid Logic + * - Storage mutate with O(log B) binary search to place the user back into bids. + * - Up to one additional event if unvouch takes place. + * - One storage removal. + * - One event for the judgement. + * Total Complexity: O(M + logM + B + X) + * # **/ judgeSuspendedCandidate: AugmentedSubmittable<(who: AccountId | string | Uint8Array, judgement: SocietyJudgement | number | any) => SubmittableExtrinsic>; /** - * Allows root origin to change the maximum number of members in society. Max membership count must be greater than 1. The dispatch origin for this call must be from _ROOT_. Parameters: - `max` - The maximum number of members for the society. # - One storage write to update the max. O(1) - One event. Total Complexity: O(1) # + * Allows root origin to change the maximum number of members in society. + * Max membership count must be greater than 1. + * The dispatch origin for this call must be from _ROOT_. + * Parameters: + * - `max` - The maximum number of members for the society. + * # + * - One storage write to update the max. O(1) + * - One event. + * Total Complexity: O(1) + * # **/ setMaxMembers: AugmentedSubmittable<(max: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic>; }; recovery: { [index: string]: SubmittableExtrinsicFunction; /** - * Send a call through a recovered account. The dispatch origin for this call must be _Signed_ and registered to be able to make calls on behalf of the recovered account. Parameters: - `account`: The recovered account you want to make a call on-behalf-of. - `call`: The call you want to make with the recovered account. # - The weight of the `call`. - One storage lookup to check account is recovered by `who`. O(1) # + * Send a call through a recovered account. + * The dispatch origin for this call must be _Signed_ and registered to + * be able to make calls on behalf of the recovered account. + * Parameters: + * - `account`: The recovered account you want to make a call on-behalf-of. + * - `call`: The call you want to make with the recovered account. + * # + * - The weight of the `call`. + * - One storage lookup to check account is recovered by `who`. O(1) + * # **/ asRecovered: AugmentedSubmittable<(account: AccountId | string | Uint8Array, call: Call | object | string | Uint8Array) => SubmittableExtrinsic>; /** - * Allow ROOT to bypass the recovery process and set an a rescuer account for a lost account directly. The dispatch origin for this call must be _ROOT_. Parameters: - `lost`: The "lost account" to be recovered. - `rescuer`: The "rescuer account" which can call as the lost account. # - One storage write O(1) - One event # + * Allow ROOT to bypass the recovery process and set an a rescuer account + * for a lost account directly. + * The dispatch origin for this call must be _ROOT_. + * Parameters: + * - `lost`: The "lost account" to be recovered. + * - `rescuer`: The "rescuer account" which can call as the lost account. + * # + * - One storage write O(1) + * - One event + * # **/ setRecovered: AugmentedSubmittable<(lost: AccountId | string | Uint8Array, rescuer: AccountId | string | Uint8Array) => SubmittableExtrinsic>; /** - * Create a recovery configuration for your account. This makes your account recoverable. Payment: `ConfigDepositBase` + `FriendDepositFactor` * #_of_friends balance will be reserved for storing the recovery configuration. This deposit is returned in full when the user calls `remove_recovery`. The dispatch origin for this call must be _Signed_. Parameters: - `friends`: A list of friends you trust to vouch for recovery attempts. Should be ordered and contain no duplicate values. - `threshold`: The number of friends that must vouch for a recovery attempt before the account can be recovered. Should be less than or equal to the length of the list of friends. - `delay_period`: The number of blocks after a recovery attempt is initialized that needs to pass before the account can be recovered. # - Key: F (len of friends) - One storage read to check that account is not already recoverable. O(1). - A check that the friends list is sorted and unique. O(F) - One currency reserve operation. O(X) - One storage write. O(1). Codec O(F). - One event. Total Complexity: O(F + X) # + * Create a recovery configuration for your account. This makes your account recoverable. + * Payment: `ConfigDepositBase` + `FriendDepositFactor` * #_of_friends balance + * will be reserved for storing the recovery configuration. This deposit is returned + * in full when the user calls `remove_recovery`. + * The dispatch origin for this call must be _Signed_. + * Parameters: + * - `friends`: A list of friends you trust to vouch for recovery attempts. + * Should be ordered and contain no duplicate values. + * - `threshold`: The number of friends that must vouch for a recovery attempt + * before the account can be recovered. Should be less than or equal to + * the length of the list of friends. + * - `delay_period`: The number of blocks after a recovery attempt is initialized + * that needs to pass before the account can be recovered. + * # + * - Key: F (len of friends) + * - One storage read to check that account is not already recoverable. O(1). + * - A check that the friends list is sorted and unique. O(F) + * - One currency reserve operation. O(X) + * - One storage write. O(1). Codec O(F). + * - One event. + * Total Complexity: O(F + X) + * # **/ createRecovery: AugmentedSubmittable<(friends: Vec | (AccountId | string | Uint8Array)[], threshold: u16 | AnyNumber | Uint8Array, delayPeriod: BlockNumber | AnyNumber | Uint8Array) => SubmittableExtrinsic>; /** - * Initiate the process for recovering a recoverable account. Payment: `RecoveryDeposit` balance will be reserved for initiating the recovery process. This deposit will always be repatriated to the account trying to be recovered. See `close_recovery`. The dispatch origin for this call must be _Signed_. Parameters: - `account`: The lost account that you want to recover. This account needs to be recoverable (i.e. have a recovery configuration). # - One storage read to check that account is recoverable. O(F) - One storage read to check that this recovery process hasn't already started. O(1) - One currency reserve operation. O(X) - One storage read to get the current block number. O(1) - One storage write. O(1). - One event. Total Complexity: O(F + X) # + * Initiate the process for recovering a recoverable account. + * Payment: `RecoveryDeposit` balance will be reserved for initiating the + * recovery process. This deposit will always be repatriated to the account + * trying to be recovered. See `close_recovery`. + * The dispatch origin for this call must be _Signed_. + * Parameters: + * - `account`: The lost account that you want to recover. This account + * needs to be recoverable (i.e. have a recovery configuration). + * # + * - One storage read to check that account is recoverable. O(F) + * - One storage read to check that this recovery process hasn't already started. O(1) + * - One currency reserve operation. O(X) + * - One storage read to get the current block number. O(1) + * - One storage write. O(1). + * - One event. + * Total Complexity: O(F + X) + * # **/ initiateRecovery: AugmentedSubmittable<(account: AccountId | string | Uint8Array) => SubmittableExtrinsic>; /** - * Allow a "friend" of a recoverable account to vouch for an active recovery process for that account. The dispatch origin for this call must be _Signed_ and must be a "friend" for the recoverable account. Parameters: - `lost`: The lost account that you want to recover. - `rescuer`: The account trying to rescue the lost account that you want to vouch for. The combination of these two parameters must point to an active recovery process. # Key: F (len of friends in config), V (len of vouching friends) - One storage read to get the recovery configuration. O(1), Codec O(F) - One storage read to get the active recovery process. O(1), Codec O(V) - One binary search to confirm caller is a friend. O(logF) - One binary search to confirm caller has not already vouched. O(logV) - One storage write. O(1), Codec O(V). - One event. Total Complexity: O(F + logF + V + logV) # + * Allow a "friend" of a recoverable account to vouch for an active recovery + * process for that account. + * The dispatch origin for this call must be _Signed_ and must be a "friend" + * for the recoverable account. + * Parameters: + * - `lost`: The lost account that you want to recover. + * - `rescuer`: The account trying to rescue the lost account that you + * want to vouch for. + * The combination of these two parameters must point to an active recovery + * process. + * # + * Key: F (len of friends in config), V (len of vouching friends) + * - One storage read to get the recovery configuration. O(1), Codec O(F) + * - One storage read to get the active recovery process. O(1), Codec O(V) + * - One binary search to confirm caller is a friend. O(logF) + * - One binary search to confirm caller has not already vouched. O(logV) + * - One storage write. O(1), Codec O(V). + * - One event. + * Total Complexity: O(F + logF + V + logV) + * # **/ vouchRecovery: AugmentedSubmittable<(lost: AccountId | string | Uint8Array, rescuer: AccountId | string | Uint8Array) => SubmittableExtrinsic>; /** - * Allow a successful rescuer to claim their recovered account. The dispatch origin for this call must be _Signed_ and must be a "rescuer" who has successfully completed the account recovery process: collected `threshold` or more vouches, waited `delay_period` blocks since initiation. Parameters: - `account`: The lost account that you want to claim has been successfully recovered by you. # Key: F (len of friends in config), V (len of vouching friends) - One storage read to get the recovery configuration. O(1), Codec O(F) - One storage read to get the active recovery process. O(1), Codec O(V) - One storage read to get the current block number. O(1) - One storage write. O(1), Codec O(V). - One event. Total Complexity: O(F + V) # + * Allow a successful rescuer to claim their recovered account. + * The dispatch origin for this call must be _Signed_ and must be a "rescuer" + * who has successfully completed the account recovery process: collected + * `threshold` or more vouches, waited `delay_period` blocks since initiation. + * Parameters: + * - `account`: The lost account that you want to claim has been successfully + * recovered by you. + * # + * Key: F (len of friends in config), V (len of vouching friends) + * - One storage read to get the recovery configuration. O(1), Codec O(F) + * - One storage read to get the active recovery process. O(1), Codec O(V) + * - One storage read to get the current block number. O(1) + * - One storage write. O(1), Codec O(V). + * - One event. + * Total Complexity: O(F + V) + * # **/ claimRecovery: AugmentedSubmittable<(account: AccountId | string | Uint8Array) => SubmittableExtrinsic>; /** - * As the controller of a recoverable account, close an active recovery process for your account. Payment: By calling this function, the recoverable account will receive the recovery deposit `RecoveryDeposit` placed by the rescuer. The dispatch origin for this call must be _Signed_ and must be a recoverable account with an active recovery process for it. Parameters: - `rescuer`: The account trying to rescue this recoverable account. # Key: V (len of vouching friends) - One storage read/remove to get the active recovery process. O(1), Codec O(V) - One balance call to repatriate reserved. O(X) - One event. Total Complexity: O(V + X) # + * As the controller of a recoverable account, close an active recovery + * process for your account. + * Payment: By calling this function, the recoverable account will receive + * the recovery deposit `RecoveryDeposit` placed by the rescuer. + * The dispatch origin for this call must be _Signed_ and must be a + * recoverable account with an active recovery process for it. + * Parameters: + * - `rescuer`: The account trying to rescue this recoverable account. + * # + * Key: V (len of vouching friends) + * - One storage read/remove to get the active recovery process. O(1), Codec O(V) + * - One balance call to repatriate reserved. O(X) + * - One event. + * Total Complexity: O(V + X) + * # **/ closeRecovery: AugmentedSubmittable<(rescuer: AccountId | string | Uint8Array) => SubmittableExtrinsic>; /** - * Remove the recovery process for your account. NOTE: The user must make sure to call `close_recovery` on all active recovery attempts before calling this function else it will fail. Payment: By calling this function the recoverable account will unreserve their recovery configuration deposit. (`ConfigDepositBase` + `FriendDepositFactor` * #_of_friends) The dispatch origin for this call must be _Signed_ and must be a recoverable account (i.e. has a recovery configuration). # Key: F (len of friends) - One storage read to get the prefix iterator for active recoveries. O(1) - One storage read/remove to get the recovery configuration. O(1), Codec O(F) - One balance call to unreserved. O(X) - One event. Total Complexity: O(F + X) # + * Remove the recovery process for your account. + * NOTE: The user must make sure to call `close_recovery` on all active + * recovery attempts before calling this function else it will fail. + * Payment: By calling this function the recoverable account will unreserve + * their recovery configuration deposit. + * (`ConfigDepositBase` + `FriendDepositFactor` * #_of_friends) + * The dispatch origin for this call must be _Signed_ and must be a + * recoverable account (i.e. has a recovery configuration). + * # + * Key: F (len of friends) + * - One storage read to get the prefix iterator for active recoveries. O(1) + * - One storage read/remove to get the recovery configuration. O(1), Codec O(F) + * - One balance call to unreserved. O(X) + * - One event. + * Total Complexity: O(F + X) + * # **/ removeRecovery: AugmentedSubmittable<() => SubmittableExtrinsic>; }; diff --git a/packages/types/src/scripts/util/docs.ts b/packages/types/src/scripts/util/docs.ts index 3cf2531a89..2ede3a35f2 100644 --- a/packages/types/src/scripts/util/docs.ts +++ b/packages/types/src/scripts/util/docs.ts @@ -8,15 +8,11 @@ type Arg = [Text | string, Text | string]; export function createDocComments (docs: Text[], args: Arg[] = []): string[] { const contents = [ - ...(docs.length ? [` * ${docs.map((d): string => d.toString().trim()).join(' ')}`] : []), + ...docs.map((doc): string => doc.toString().trim()).filter((doc): boolean => !!doc).map((doc): string => ` * ${doc}`), ...args.map(([name, type]): string => ` * @param ${name} ${type}`) ]; return contents.length - ? [ - '/**', - ...contents, - ' **/\n' - ] + ? ['/**', ...contents, ' **/\n'] : []; }