api/docs/METHODS_STORAGE.md

Storage

The following Storage methods are part of the default Substrate runtime.

---

system

▸ accountNonce(AccountId): Index

▸ extrinsicCount(): u32

▸ blockHash(BlockNumber): Hash

▸ extrinsicData(u32): Bytes

▸ randomSeed(): Hash

▸ number(): BlockNumber

• summary: The current block number being processed. Set by execute_block.

▸ parentHash(): Hash

▸ extrinsicsRoot(): Hash

▸ digest(): Digest

▸ events(): Vec<EventRecord>

---

consensus

▸ originalAuthorities(): Vec<SessionKey>

---

balances

▸ totalIssuance(): Balance

• summary: The total amount of stake on the system.

▸ existentialDeposit(): Balance

• summary: The minimum amount allowed to keep an account open.

▸ reclaimRebate(): Balance

• summary: The amount credited to a destination's account whose index was reclaimed.

▸ transferFee(): Balance

• summary: The fee required to make a transfer.

▸ creationFee(): Balance

• summary: The fee required to create an account. At least as big as ReclaimRebate.

▸ nextEnumSet(): AccountIndex

• summary: The next free enumeration set.

▸ enumSet(AccountIndex): Vec<AccountId>

• summary: The enumeration sets.

▸ freeBalance(AccountId): Balance

• summary: The 'free' balance of a given account. This is the only balance that matters in terms of most operations on tokens. It is alone 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. Furthermore, OnFreeBalanceZero callback is invoked, giving a chance to external modules to cleanup data associated with the deleted account. system::AccountNonce is also deleted if ReservedBalance is also zero (it also gets collapsed to zero if it ever becomes less than ExistentialDeposit.

▸ reservedBalance(AccountId): Balance

• summary: 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. (This is different and wholly unrelated to the Bondage system used in the staking module.) When this balance falls below the value of ExistentialDeposit, then this 'reserve account' is deleted: specifically, ReservedBalance. system::AccountNonce is also deleted if FreeBalance is also zero (it also gets collapsed to zero if it ever becomes less than ExistentialDeposit.

▸ transactionBaseFee(): Balance

• summary: The fee to be paid for making a transaction; the base.

▸ transactionByteFee(): Balance

• summary: The fee to be paid for making a transaction; the per-byte portion.

---

timestamp

▸ now(): Moment

• summary: Current time for the current block.

▸ blockPeriod(): Moment

• summary: The minimum (and advised) period between blocks.

▸ didUpdate(): bool

• summary: Did the timestamp get updated in this block?

---

session

▸ validators(): Vec<AccountId>

• summary: The current set of validators.

▸ sessionLength(): BlockNumber

• summary: Current length of the session.

▸ currentIndex(): BlockNumber

• summary: Current index of the session.

▸ currentStart(): Moment

• summary: Timestamp when current session started.

▸ forcingNewSession(): bool

• summary: New session is being forced is this entry exists; in which case, the boolean value is whether the new session should be considered a normal rotation (rewardable) or exceptional (slashable).

▸ lastLengthChange(): BlockNumber

• summary: Block at which the session length last changed.

▸ nextKeyFor(AccountId): SessionKey

• summary: The next key for a given validator.

▸ nextSessionLength(): BlockNumber

• summary: The next session length.

---

staking

▸ validatorCount(): u32

• summary: The ideal number of staking participants.

▸ minimumValidatorCount(): u32

• summary: Minimum number of staking participants before emergency conditions are imposed.

▸ sessionsPerEra(): BlockNumber

• summary: The length of a staking era in sessions.

▸ sessionReward(): Perbill

• summary: Maximum reward, per validator, that is provided per acceptable session.

▸ offlineSlash(): Perbill

• summary: Slash, per validator that is taken for the first time they are found to be offline.

▸ offlineSlashGrace(): u32

• summary: Number of instances of offline reports before slashing begins for validators.

▸ bondingDuration(): BlockNumber

• summary: The length of the bonding duration in blocks.

▸ currentEra(): BlockNumber

• summary: The current era index.

▸ validatorPreferences(AccountId): ValidatorPrefs

• summary: Preferences that a validator has.

▸ intentions(): Vec<AccountId>

• summary: All the accounts with a desire to stake.

▸ nominating(AccountId): AccountId

• summary: All nominator -> nominee relationships.

▸ nominatorsFor(AccountId): Vec<AccountId>

• summary: Nominators for a particular account.

▸ currentNominatorsFor(AccountId): Vec<AccountId>

• summary: Nominators for a particular account that is in action right now.

▸ currentSessionReward(): Balance

• summary: Maximum reward, per validator, that is provided per acceptable session.

▸ currentOfflineSlash(): Balance

• summary: Slash, per validator that is taken for the first time they are found to be offline.

▸ nextSessionsPerEra(): BlockNumber

• summary: The next value of sessions per era.

▸ lastEraLengthChange(): BlockNumber

• summary: The session index at which the era length last changed.

▸ stakeRange(): PairOf

• summary: The highest and lowest staked validator slashable balances.

▸ bondage(AccountId): BlockNumber

• summary: The block at which the who's funds become entirely liquid.

▸ slashCount(AccountId): u32

• summary: The number of times a given validator has been reported offline. This gets decremented by one each era that passes.

▸ forcingNewEra(): ()

• summary: We are forcing a new era.

---

democracy

▸ publicPropCount(): PropIndex

• summary: The number of (public) proposals that have been made so far.

▸ publicProps(): Vec<(PropIndex, Proposal, AccountId)>

• summary: The public proposals. Unsorted.

▸ depositOf(PropIndex): (Balance, Vec<AccountId>)

• summary: Those who have locked a deposit.

▸ launchPeriod(): BlockNumber

• summary: How often (in blocks) new public referenda are launched.

▸ minimumDeposit(): Balance

• summary: The minimum amount to be used as a deposit for a public referendum proposal.

▸ votingPeriod(): BlockNumber

• summary: How often (in blocks) to check for new votes.

▸ referendumCount(): ReferendumIndex

• summary: The next free referendum index, aka the number of referendums started so far.

▸ nextTally(): ReferendumIndex

• summary: The next referendum index that should be tallied.

▸ referendumInfoOf(ReferendumIndex): (BlockNumber, Proposal, VoteThreshold)

• summary: Information concerning any given referendum.

▸ votersFor(ReferendumIndex): Vec<AccountId>

• summary: Get the voters for the current proposal.

▸ voteOf((ReferendumIndex, AccountId)): bool

• summary: Get the vote, if Some, of who.

---

council

▸ candidacyBond(): Balance

• summary: How much should be locked up in order to submit one's candidacy.

▸ votingBond(): Balance

• summary: How much should be locked up in order to be able to submit votes.

▸ presentSlashPerVoter(): Balance

• summary: The punishment, per voter, if you provide an invalid presentation.

▸ carryCount(): u32

• summary: How many runners-up should have their approvals persist until the next vote.

▸ presentationDuration(): BlockNumber

• summary: How long to give each top candidate to present themselves after the vote ends.

▸ inactiveGracePeriod(): VoteIndex

• summary: How many votes need to go by after a voter's last vote before they can be reaped if their approvals are moot.

▸ votingPeriod(): BlockNumber

• summary: How often (in blocks) to check for new votes.

▸ termDuration(): BlockNumber

• summary: How long each position is active for.

▸ desiredSeats(): u32

• summary: Number of accounts that should be sitting on the council.

▸ activeCouncil(): Vec<(AccountId, BlockNumber)>

• summary: The current council. When there's a vote going on, this should still be used for executive matters.

▸ voteCount(): VoteIndex

• summary: The total number of votes that have happened or are in progress.

▸ approvalsOf(AccountId): Vec<bool>

• summary: The last cleared vote index that this voter was last active at.

▸ registerInfoOf(AccountId): (VoteIndex, u32)

• summary: The vote index and list slot that the candidate who was registered or None if they are not currently registered.

▸ lastActiveOf(AccountId): VoteIndex

• summary: The last cleared vote index that this voter was last active at.

▸ voters(): Vec<AccountId>

• summary: The present voter list.

▸ candidates(): Vec<AccountId>

• summary: The present candidate list.

▸ candidateCount(): u32

▸ nextFinalise(): (BlockNumber, u32, Vec<AccountId>)

• summary: The accounts holding the seats that will become free on the next tally.

▸ snapshotedStakes(): Vec<Balance>

• summary: The stakes as they were at the point that the vote ended.

▸ leaderboard(): Vec<(Balance, AccountId)>

• summary: Get the leaderboard if we;re in the presentation phase.

---

councilVoting

▸ cooloffPeriod(): BlockNumber

▸ votingPeriod(): BlockNumber

▸ proposals(): Vec<(BlockNumber, Hash)>

▸ proposalOf(Hash): Proposal

▸ proposalVoters(Hash): Vec<AccountId>

▸ councilVoteOf((Hash, AccountId)): bool

▸ vetoedProposal(Hash): (BlockNumber, Vec<AccountId>)

---

councilMotions

▸ proposals(): Vec<Hash>

• summary: The (hashes of) the active proposals.

▸ proposalOf(Hash): Proposal

• summary: Actual proposal for a given hash, if it's current.

▸ voting(Hash): (ProposalIndex, u32, Vec<AccountId>, Vec<AccountId>)

• summary: Votes for a given proposal: (required_yes_votes, yes_voters, no_voters).

▸ proposalCount(): u32

• summary: Proposals so far.

---

treasury

▸ proposalBond(): Permill

• summary: Proportion of funds that should be bonded in order to place a proposal. An accepted proposal gets these back. A rejected proposal doesn't.

▸ proposalBondMinimum(): Balance

• summary: Minimum amount of funds that should be placed in a deposit for making a proposal.

▸ spendPeriod(): BlockNumber

• summary: Period between successive spends.

▸ burn(): Permill

• summary: Percentage of spare funds (if any) that are burnt per spend period.

▸ pot(): Balance

• summary: Total funds available to this module for spending.

▸ proposalCount(): ProposalIndex

• summary: Number of proposals that have been made.

▸ proposals(ProposalIndex): Proposal

• summary: Proposals that have been made.

▸ approvals(): Vec<ProposalIndex>

• summary: Proposal indices that have been approved but not yet awarded.

---

substrate

These are keys that are always available to the runtime implementation

▸ code(): Bytes

• summary: Wasm code of the runtime.

▸ heapPages(): u64

• summary: Number of wasm linear memory pages required for execution of the runtime.

▸ authorityCount(): u32

• summary: Number of authorities.

▸ authorityPrefix(): u32

• summary: Prefix under which authorities are storied.

▸ extrinsicIndex(): u32

• summary: Current extrinsic index (u32) is stored under this key.

▸ changesTrieConfig(): u32

• summary: Changes trie configuration is stored under this key.

---