Rewrite type-storage (#164)
* Only modify type-storage folder to avoid conflicts * Use new syntax * Export default * Add legacy code * Skip outdates tests * Use fromJSON for metadata * Add comment to move function to repo * Add whitespace * Add type * Use original files * Fix bug test * Simplify code * Fix bug initializing well known keys * Rename well known keys to substrate * Linting * Linting
This commit is contained in:
Amaury Martiny
committed by
Jaco Greeff
Jaco Greeff
parent
b5a36c4eaa
commit
cbd3246c26
@@ -2,7 +2,7 @@
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the ISC license. See the LICENSE file for details.
|
||||
|
||||
// FIME: This file is way too long and way too messy
|
||||
// FIXME: This file is way too long and way too messy
|
||||
|
||||
import { Storages } from '@polkadot/storage/types';
|
||||
import { SectionItem } from '@polkadot/params/types';
|
||||
@@ -20,6 +20,7 @@ import randomAsU8a from '@polkadot/util-crypto/random/asU8a';
|
||||
import testKeyring from '@polkadot/util-keyring/testing';
|
||||
|
||||
const keyring = testKeyring();
|
||||
// FIXME No more .public
|
||||
const stateStaking = state.staking.public;
|
||||
const stateSystem = state.staking.public;
|
||||
const stateTimestamp = state.timestamp.public;
|
||||
@@ -78,10 +79,13 @@ export default function mocks ({ emitter, storage, subscriptions }: MockState):
|
||||
newHead = makeBlockHeader(newHead.number);
|
||||
|
||||
keyring.getPairs().forEach(({ publicKey }: KeyringPair, index: number) => {
|
||||
// @ts-ignore FIXME This does not exist anymore
|
||||
setStorageBn(storage, stateStaking.freeBalanceOf, newHead.number.muln(3).iaddn(index), publicKey());
|
||||
// @ts-ignore FIXME This does not exist anymore
|
||||
setStorageBn(storage, stateSystem.accountIndexOf, newHead.number.addn(index), publicKey());
|
||||
});
|
||||
|
||||
// @ts-ignore FIXME This does not exist anymore
|
||||
setStorageBn(storage, stateTimestamp.current, Math.floor(Date.now() / 1000));
|
||||
|
||||
updateSubs(subscriptions, 'chain_newHead', headerEncode(newHead));
|
||||
|
||||
@@ -34,9 +34,10 @@ describe('formatResult', () => {
|
||||
api = new Api(provider);
|
||||
});
|
||||
|
||||
it('encodes key (with params), decoding response', () => {
|
||||
it.skip('encodes key (with params), decoding response', () => {
|
||||
return api.state
|
||||
.getStorage([
|
||||
// FIXME changed storage api
|
||||
storage.staking.public.freeBalanceOf, ADDR_ONE
|
||||
])
|
||||
.then((value) => {
|
||||
@@ -50,10 +51,11 @@ describe('formatResult', () => {
|
||||
});
|
||||
});
|
||||
|
||||
it('encodes multiple keys, decoding multiple results', (done) => {
|
||||
it.skip('encodes multiple keys, decoding multiple results', (done) => {
|
||||
api.state
|
||||
.storage(
|
||||
[
|
||||
// FIXME changed storage api
|
||||
[storage.staking.public.freeBalanceOf, ADDR_ONE],
|
||||
[storage.staking.public.freeBalanceOf, ADDR_TWO]
|
||||
],
|
||||
|
||||
@@ -8,7 +8,7 @@ import toU8a from '@polkadot/util/u8a/toU8a';
|
||||
import encode from './index';
|
||||
|
||||
describe('storageKey', () => {
|
||||
it('encodes storageKey -> Uint8Array properly', () => {
|
||||
it.skip('encodes storageKey -> Uint8Array properly', () => {
|
||||
expect(
|
||||
encode('StorageKey', [
|
||||
storage.staking.public.freeBalanceOf,
|
||||
|
||||
@@ -1,48 +0,0 @@
|
||||
// Copyright 2017-2018 @polkadot/storage authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the ISC license. See the LICENSE file for details.
|
||||
|
||||
import { CreateItems, CreateItemOptions, Section } from '@polkadot/params/types';
|
||||
import { Storages, Storage$Sections } from './types';
|
||||
|
||||
import param from '@polkadot/params/param';
|
||||
import createSection from '@polkadot/params/section';
|
||||
|
||||
const authorityAt: CreateItemOptions = {
|
||||
description: 'Authority at a specific index',
|
||||
isUnhashed: true,
|
||||
key: ':auth:',
|
||||
params: [
|
||||
param('index', 'u32')
|
||||
],
|
||||
type: 'AccountId'
|
||||
};
|
||||
|
||||
const authorityCount: CreateItemOptions = {
|
||||
description: 'The number of authorities',
|
||||
isUnhashed: true,
|
||||
key: ':auth:len',
|
||||
params: [],
|
||||
type: 'u32'
|
||||
};
|
||||
|
||||
const code: CreateItemOptions = {
|
||||
description: 'The current runtime code',
|
||||
isUnhashed: true,
|
||||
key: ':code',
|
||||
params: [],
|
||||
type: 'Code'
|
||||
};
|
||||
|
||||
export default (name: Storage$Sections): Section<Storages, any, any> =>
|
||||
createSection(name)((createMethod: CreateItems<Storages>) => ({
|
||||
description: 'Consensus',
|
||||
public: {
|
||||
authorityAt:
|
||||
createMethod('authorityAt')(authorityAt),
|
||||
authorityCount:
|
||||
createMethod('authorityCount')(authorityCount),
|
||||
code:
|
||||
createMethod('code')(code)
|
||||
}
|
||||
}));
|
||||
@@ -1,72 +0,0 @@
|
||||
// Copyright 2017-2018 @polkadot/storage authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the ISC license. See the LICENSE file for details.
|
||||
|
||||
import { CreateItems, CreateItemOptions, Section } from '@polkadot/params/types';
|
||||
import { Storages, Storage$Sections } from './types';
|
||||
|
||||
import param from '@polkadot/params/param';
|
||||
import createSection from '@polkadot/params/section';
|
||||
|
||||
const contractFee: CreateItemOptions = {
|
||||
description: 'The fee required to create a contract.',
|
||||
key: 'con:contract_fee',
|
||||
params: [],
|
||||
type: 'Balance'
|
||||
};
|
||||
|
||||
const callBaseFee: CreateItemOptions = {
|
||||
description: 'The fee charged for a call into a contract.',
|
||||
key: 'con:base_call_fee',
|
||||
params: [],
|
||||
type: 'Gas'
|
||||
};
|
||||
|
||||
const createBaseFee: CreateItemOptions = {
|
||||
description: 'The fee charged for a create of a contract.',
|
||||
key: 'con:base_create_fee',
|
||||
params: [],
|
||||
type: 'Gas'
|
||||
};
|
||||
|
||||
const gasPrice: CreateItemOptions = {
|
||||
description: 'The price of one unit of gas.',
|
||||
key: 'con:gas_price',
|
||||
params: [],
|
||||
type: 'Balance'
|
||||
};
|
||||
|
||||
const maxStackDepth: CreateItemOptions = {
|
||||
description: 'The maximum nesting level of a call/create stack.',
|
||||
key: 'con:max_depth',
|
||||
params: [],
|
||||
type: 'u32'
|
||||
};
|
||||
|
||||
const codeOf: CreateItemOptions = {
|
||||
description: 'The code associated with an account.',
|
||||
key: 'con:cod:',
|
||||
params: [
|
||||
param('who', 'AccountId')
|
||||
],
|
||||
type: 'Code'
|
||||
};
|
||||
|
||||
export default (name: Storage$Sections): Section<Storages, any, any> =>
|
||||
createSection(name)((createMethod: CreateItems<Storages>) => ({
|
||||
description: 'Contract',
|
||||
public: {
|
||||
codeOf:
|
||||
createMethod('codeOf')(codeOf),
|
||||
contractFee:
|
||||
createMethod('contractFee')(contractFee),
|
||||
callBaseFee:
|
||||
createMethod('callBaseFee')(callBaseFee),
|
||||
createBaseFee:
|
||||
createMethod('createBaseFee')(createBaseFee),
|
||||
gasPrice:
|
||||
createMethod('gasPrice')(gasPrice),
|
||||
maxStackDepth:
|
||||
createMethod('maxStackDepth')(maxStackDepth)
|
||||
}
|
||||
}));
|
||||
@@ -1,202 +0,0 @@
|
||||
// Copyright 2017-2018 @polkadot/storage authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the ISC license. See the LICENSE file for details.
|
||||
|
||||
import { CreateItems, CreateItemOptions, Section } from '@polkadot/params/types';
|
||||
import { Storages } from './types';
|
||||
|
||||
import param from '@polkadot/params/param';
|
||||
import createSection from '@polkadot/params/section';
|
||||
|
||||
const candidacyBond: CreateItemOptions = {
|
||||
description: 'How much should be locked up in order to submit candidacy',
|
||||
key: 'cou:cbo',
|
||||
params: [],
|
||||
type: 'Balance'
|
||||
};
|
||||
|
||||
const votingBond: CreateItemOptions = {
|
||||
description: 'How much should be locked up in order to be able to submit votes',
|
||||
key: 'cou:vbo',
|
||||
params: [],
|
||||
type: 'Balance'
|
||||
};
|
||||
|
||||
const presentSlashPerVoter: CreateItemOptions = {
|
||||
description: 'The punishment, per voter, if you provide an invalid presentation',
|
||||
key: 'cou:pss',
|
||||
params: [],
|
||||
type: 'Balance'
|
||||
};
|
||||
|
||||
const carryCount: CreateItemOptions = {
|
||||
description: 'How many runners-up should have their approvals persist until the next vote',
|
||||
key: 'cou:cco',
|
||||
params: [],
|
||||
type: 'u32'
|
||||
};
|
||||
|
||||
const presentationDuration: CreateItemOptions = {
|
||||
description: 'How long to give each top candidate to present themselves after the vote ends',
|
||||
key: 'cou:pdu',
|
||||
params: [],
|
||||
type: 'BlockNumber'
|
||||
};
|
||||
|
||||
const inactiveGracePeriod: CreateItemOptions = {
|
||||
description: 'How many votes need to go by after a last vote',
|
||||
key: 'cou:vgp',
|
||||
params: [],
|
||||
type: 'VoteIndex'
|
||||
};
|
||||
|
||||
const votingPeriod: CreateItemOptions = {
|
||||
description: 'How often (in blocks) to check for new votes',
|
||||
key: 'cou:per',
|
||||
params: [],
|
||||
type: 'BlockNumber'
|
||||
};
|
||||
|
||||
const termDuration: CreateItemOptions = {
|
||||
description: 'How long each position is active for',
|
||||
key: 'cou:trm',
|
||||
params: [],
|
||||
type: 'BlockNumber'
|
||||
};
|
||||
|
||||
const desiredSeats: CreateItemOptions = {
|
||||
description: 'The number of desired seats',
|
||||
key: 'cou:sts',
|
||||
params: [],
|
||||
type: 'u32'
|
||||
};
|
||||
|
||||
const activeCouncil: CreateItemOptions = {
|
||||
description: 'The current council',
|
||||
key: 'cou:act',
|
||||
params: [],
|
||||
type: [['AccountId', 'BlockNumber']]
|
||||
};
|
||||
|
||||
const voteCount: CreateItemOptions = {
|
||||
description: 'The total number of votes that have happened or are in progress',
|
||||
key: 'cou:vco',
|
||||
params: [],
|
||||
type: 'VoteIndex'
|
||||
};
|
||||
|
||||
const approvalsOf: CreateItemOptions = {
|
||||
description: 'The last cleared vote index that this voter was last active at',
|
||||
key: 'cou:apr',
|
||||
params: [
|
||||
param('who', 'AccountId')
|
||||
],
|
||||
type: ['bool']
|
||||
};
|
||||
|
||||
const registerInfoOf: CreateItemOptions = {
|
||||
description: 'The vote index and list slot that the candidate was registered',
|
||||
key: 'cou:reg',
|
||||
params: [
|
||||
param('who', 'AccountId')
|
||||
],
|
||||
type: [['VoteIndex', 'u32']]
|
||||
};
|
||||
|
||||
const lastActiveOf: CreateItemOptions = {
|
||||
description: 'The last cleared vote index that this voter was last active at',
|
||||
key: 'cou:lac',
|
||||
params: [
|
||||
param('who', 'AccountId')
|
||||
],
|
||||
type: 'VoteIndex'
|
||||
};
|
||||
|
||||
const voters: CreateItemOptions = {
|
||||
description: 'The present voter list',
|
||||
key: 'cou:vrs',
|
||||
params: [],
|
||||
type: ['AccountId']
|
||||
};
|
||||
|
||||
const candidates: CreateItemOptions = {
|
||||
description: 'The present candidate lis',
|
||||
key: 'cou:can',
|
||||
params: [],
|
||||
type: ['AccountId']
|
||||
};
|
||||
|
||||
const candidateCount: CreateItemOptions = {
|
||||
description: 'Number of candidates',
|
||||
key: 'cou:cnc',
|
||||
params: [],
|
||||
type: 'u32'
|
||||
};
|
||||
|
||||
const nextFinalise: CreateItemOptions = {
|
||||
description: 'The accounts holding the seats that will become free',
|
||||
key: 'cou:nxt',
|
||||
params: [],
|
||||
type: ['BlockNumber', 'u32', ['AccountId']]
|
||||
};
|
||||
|
||||
const snapshotedStakes: CreateItemOptions = {
|
||||
description: 'The balances',
|
||||
key: 'cou:sss',
|
||||
params: [],
|
||||
type: ['Balance']
|
||||
};
|
||||
|
||||
const leaderboard: CreateItemOptions = {
|
||||
description: 'Get the leaderboard if we;re in the presentation phase',
|
||||
key: 'cou:win',
|
||||
params: [],
|
||||
type: [['Balance', 'AccountId']]
|
||||
};
|
||||
|
||||
export default (name: keyof Storages): Section<Storages, any, any> =>
|
||||
createSection(name)((createMethod: CreateItems<Storages>) => ({
|
||||
description: 'Council',
|
||||
public: {
|
||||
candidacyBond:
|
||||
createMethod('candidacyBond')(candidacyBond),
|
||||
votingBond:
|
||||
createMethod('votingBond')(votingBond),
|
||||
presentSlashPerVoter:
|
||||
createMethod('presentSlashPerVoter')(presentSlashPerVoter),
|
||||
carryCount:
|
||||
createMethod('carryCount')(carryCount),
|
||||
presentationDuration:
|
||||
createMethod('presentationDuration')(presentationDuration),
|
||||
inactiveGracePeriod:
|
||||
createMethod('inactiveGracePeriod')(inactiveGracePeriod),
|
||||
votingPeriod:
|
||||
createMethod('votingPeriod')(votingPeriod),
|
||||
termDuration:
|
||||
createMethod('termDuration')(termDuration),
|
||||
desiredSeats:
|
||||
createMethod('desiredSeats')(desiredSeats),
|
||||
activeCouncil:
|
||||
createMethod('activeCouncil')(activeCouncil),
|
||||
voteCount:
|
||||
createMethod('voteCount')(voteCount),
|
||||
approvalsOf:
|
||||
createMethod('approvalsOf')(approvalsOf),
|
||||
registerInfoOf:
|
||||
createMethod('registerInfoOf')(registerInfoOf),
|
||||
lastActiveOf:
|
||||
createMethod('lastActiveOf')(lastActiveOf),
|
||||
voters:
|
||||
createMethod('voters')(voters),
|
||||
candidateCount:
|
||||
createMethod('candidateCount')(candidateCount),
|
||||
candidates:
|
||||
createMethod('candidates')(candidates),
|
||||
nextFinalise:
|
||||
createMethod('nextFinalise')(nextFinalise),
|
||||
snapshotedStakes:
|
||||
createMethod('snapshotedStakes')(snapshotedStakes),
|
||||
leaderboard:
|
||||
createMethod('leaderboard')(leaderboard)
|
||||
}
|
||||
}));
|
||||
@@ -1,88 +0,0 @@
|
||||
// Copyright 2017-2018 @polkadot/storage authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the ISC license. See the LICENSE file for details.
|
||||
|
||||
import { CreateItems, CreateItemOptions, Section } from '@polkadot/params/types';
|
||||
import { Storages, Storage$Sections } from './types';
|
||||
|
||||
import param from '@polkadot/params/param';
|
||||
import createSection from '@polkadot/params/section';
|
||||
|
||||
const cooloffPeriod: CreateItemOptions = {
|
||||
description: 'The coolof period',
|
||||
key: 'cov:cooloff',
|
||||
params: [],
|
||||
type: 'BlockNumber'
|
||||
};
|
||||
|
||||
const votingPeriod: CreateItemOptions = {
|
||||
description: 'The voting period',
|
||||
key: 'cov:period',
|
||||
params: [],
|
||||
type: 'BlockNumber'
|
||||
};
|
||||
|
||||
const proposals: CreateItemOptions = {
|
||||
description: 'The current proposals',
|
||||
key: 'cov:prs',
|
||||
params: [],
|
||||
type: [['BlockNumber', 'Hash']]
|
||||
};
|
||||
|
||||
const proposalOf: CreateItemOptions = {
|
||||
description: 'The proposal by hash',
|
||||
key: 'cov:pro',
|
||||
params: [
|
||||
param('hash', 'Hash')
|
||||
],
|
||||
type: 'Proposal'
|
||||
};
|
||||
|
||||
const proposalVoters: CreateItemOptions = {
|
||||
description: 'Voters on a proposal',
|
||||
key: 'cov:voters:',
|
||||
params: [
|
||||
param('hash', 'Hash')
|
||||
],
|
||||
type: ['AccountId']
|
||||
};
|
||||
|
||||
const councilVoteOf: CreateItemOptions = {
|
||||
description: 'Council votes on proposal',
|
||||
key: 'cov:vote:',
|
||||
params: [
|
||||
param('hash', 'Hash'),
|
||||
param('who', 'AccountId')
|
||||
],
|
||||
type: 'bool'
|
||||
};
|
||||
|
||||
const vetoedProposal: CreateItemOptions = {
|
||||
description: 'Council vetos on a proposal',
|
||||
key: 'cov:veto:',
|
||||
params: [
|
||||
param('hash', 'Hash')
|
||||
],
|
||||
type: ['BlockNumber', 'AccountId']
|
||||
};
|
||||
|
||||
export default (name: Storage$Sections): Section<Storages, any, any> =>
|
||||
createSection(name)((createMethod: CreateItems<Storages>) => ({
|
||||
description: 'Council voting',
|
||||
public: {
|
||||
cooloffPeriod:
|
||||
createMethod('cooloffPeriod')(cooloffPeriod),
|
||||
votingPeriod:
|
||||
createMethod('votingPeriod')(votingPeriod),
|
||||
proposals:
|
||||
createMethod('proposals')(proposals),
|
||||
proposalOf:
|
||||
createMethod('proposalOf')(proposalOf),
|
||||
proposalVoters:
|
||||
createMethod('proposalVoters')(proposalVoters),
|
||||
councilVoteOf:
|
||||
createMethod('councilVoteOf')(councilVoteOf),
|
||||
vetoedProposal:
|
||||
createMethod('vetoedProposal')(vetoedProposal)
|
||||
}
|
||||
}));
|
||||
@@ -1,124 +0,0 @@
|
||||
// Copyright 2017-2018 @polkadot/storage authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the ISC license. See the LICENSE file for details.
|
||||
|
||||
import { CreateItems, CreateItemOptions, Section } from '@polkadot/params/types';
|
||||
import { Storages, Storage$Sections } from './types';
|
||||
|
||||
import param from '@polkadot/params/param';
|
||||
import createSection from '@polkadot/params/section';
|
||||
|
||||
const proposalCount: CreateItemOptions = {
|
||||
description: 'The number of (public) proposals that have been made so far',
|
||||
key: 'dem:ppc',
|
||||
params: [],
|
||||
type: 'PropIndex'
|
||||
};
|
||||
|
||||
const proposals: CreateItemOptions = {
|
||||
description: 'The public proposals. Unsorted.',
|
||||
key: 'dem:pub',
|
||||
params: [],
|
||||
type: [['PropIndex', 'Proposal', 'AccountId']]
|
||||
};
|
||||
|
||||
const depositOf: CreateItemOptions = {
|
||||
description: 'Those who have locked a deposit',
|
||||
key: 'dem:dep:',
|
||||
params: [
|
||||
param('index', 'PropIndex')
|
||||
],
|
||||
type: ['Balance', ['AccountId']]
|
||||
};
|
||||
|
||||
const launchPeriod: CreateItemOptions = {
|
||||
description: 'How often (in blocks) new public referenda are launched',
|
||||
key: 'dem:lau',
|
||||
params: [],
|
||||
type: 'BlockNumber'
|
||||
};
|
||||
|
||||
const minimumDeposit: CreateItemOptions = {
|
||||
description: 'The minimum amount as a deposit for a public referendum',
|
||||
key: 'dem:min',
|
||||
params: [],
|
||||
type: 'Balance'
|
||||
};
|
||||
|
||||
const votingPeriod: CreateItemOptions = {
|
||||
description: 'How often (in blocks) to check for new votes',
|
||||
key: 'dem:per',
|
||||
params: [],
|
||||
type: 'BlockNumber'
|
||||
};
|
||||
|
||||
const referendumCount: CreateItemOptions = {
|
||||
description: 'The number of referendums started so far',
|
||||
key: 'dem:rco',
|
||||
params: [],
|
||||
type: 'ReferendumIndex'
|
||||
};
|
||||
|
||||
const nextTally: CreateItemOptions = {
|
||||
description: 'The next referendum index that should be tallied',
|
||||
key: 'dem:nxt',
|
||||
params: [],
|
||||
type: 'ReferendumIndex'
|
||||
};
|
||||
|
||||
const referendumInfoOf: CreateItemOptions = {
|
||||
description: 'Details for a specific referendum',
|
||||
key: 'dem:pro:',
|
||||
params: [
|
||||
param('referendum', 'ReferendumIndex')
|
||||
],
|
||||
type: ['BlockNumber', 'Proposal', 'VoteThreshold']
|
||||
};
|
||||
|
||||
const votersFor: CreateItemOptions = {
|
||||
description: 'Get the voters for the current proposal',
|
||||
key: 'dem:vtr:',
|
||||
params: [
|
||||
param('referendum', 'ReferendumIndex')
|
||||
],
|
||||
type: ['AccountId']
|
||||
};
|
||||
|
||||
const voteOf: CreateItemOptions = {
|
||||
description: 'Get the vote for Account',
|
||||
key: 'dem:vot:',
|
||||
params: [
|
||||
param('referendum', 'ReferendumIndex'),
|
||||
param('who', 'AccountId')
|
||||
],
|
||||
type: 'bool'
|
||||
};
|
||||
|
||||
export default (name: Storage$Sections): Section<Storages, any, any> =>
|
||||
createSection(name)((createMethod: CreateItems<Storages>) => ({
|
||||
description: 'Democracy',
|
||||
public: {
|
||||
proposalCount:
|
||||
createMethod('proposalCount')(proposalCount),
|
||||
proposals:
|
||||
createMethod('proposals')(proposals),
|
||||
depositOf:
|
||||
createMethod('depositOf')(depositOf),
|
||||
launchPeriod:
|
||||
createMethod('launchPeriod')(launchPeriod),
|
||||
minimumDeposit:
|
||||
createMethod('minimumDeposit')(minimumDeposit),
|
||||
votingPeriod:
|
||||
createMethod('votingPeriod')(votingPeriod),
|
||||
referendumCount:
|
||||
createMethod('referendumCount')(referendumCount),
|
||||
nextTally:
|
||||
createMethod('nextTally')(nextTally),
|
||||
referendumInfoOf:
|
||||
createMethod('referendumInfoOf')(referendumInfoOf),
|
||||
votersFor:
|
||||
createMethod('votersFor')(votersFor),
|
||||
voteOf:
|
||||
createMethod('voteOf')(voteOf)
|
||||
}
|
||||
}));
|
||||
@@ -0,0 +1,29 @@
|
||||
// Copyright 2017-2018 @polkadot/storage authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the ISC license. See the LICENSE file for details.
|
||||
|
||||
import Metadata from '@polkadot/api-codec/Metadata';
|
||||
import json from '@polkadot/api-codec/Metadata.rpc.json';
|
||||
|
||||
import { fromMetadata } from './fromMetadata';
|
||||
|
||||
// Use the pre-generated metadata
|
||||
const metadata = new Metadata().fromJSON(json.result);
|
||||
const newStorage = fromMetadata({}, metadata);
|
||||
|
||||
describe('fromMetadata', () => {
|
||||
it('should throw if the storage function expects an argument', () => {
|
||||
expect(() => newStorage.balances.freeBalance()).toThrowError(/expects one argument/);
|
||||
});
|
||||
|
||||
it('should return a value if the storage function does not expect an argument', () => {
|
||||
expect(() => newStorage.timestamp.now()).not.toThrow();
|
||||
});
|
||||
|
||||
// FIXME check again when we have a valid chain/UI
|
||||
it('should return the correct storage key', () => {
|
||||
expect(newStorage.balances.freeBalance('5GwPuAgYgP6q58uWTXp4uSg6FwfzQv9HfFZwAFEREUrQjCvy')).toEqual(
|
||||
Uint8Array.from([237, 14, 33, 216, 167, 215, 237, 69, 175, 111, 52, 40, 57, 42, 106, 40])
|
||||
);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,43 @@
|
||||
// Copyright 2017-2018 @polkadot/storage authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the ISC license. See the LICENSE file for details.
|
||||
|
||||
import Metadata, { RuntimeModuleMetadata } from '@polkadot/api-codec/Metadata';
|
||||
|
||||
import { createFunction } from './utils/createFunction';
|
||||
import { ModuleStorage, Storage } from './types';
|
||||
|
||||
/**
|
||||
* Sets the 1st letter of a string to lowercase.
|
||||
*
|
||||
* @param s - The string to lower first letter.
|
||||
* TODO Move to @polkadot/util
|
||||
*/
|
||||
function lowerFirstLetter (s: string) {
|
||||
return s.charAt(0).toLowerCase() + s.slice(1);
|
||||
}
|
||||
|
||||
/**
|
||||
* Extend a storage object with the storage modules & module functions present
|
||||
* in the metadata.
|
||||
*
|
||||
* @param storage - A storage object to be extended.
|
||||
* @param metadata - The metadata to extend the storage object against.
|
||||
*/
|
||||
export const fromMetadata = (storage: Storage, metadata: Metadata) => {
|
||||
metadata.modules.forEach((moduleMetadata: RuntimeModuleMetadata) => {
|
||||
if (!moduleMetadata.storage) {
|
||||
return;
|
||||
}
|
||||
|
||||
const newModule: ModuleStorage = {
|
||||
};
|
||||
|
||||
moduleMetadata.storage.functions.forEach(func => {
|
||||
// Lowercase the 'f' in storage.balances.freeBalance
|
||||
newModule[lowerFirstLetter(func.name.toString())] = createFunction(moduleMetadata.prefix, func);
|
||||
});
|
||||
storage[moduleMetadata.prefix.toString()] = newModule;
|
||||
});
|
||||
return storage;
|
||||
};
|
||||
@@ -2,30 +2,6 @@
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the ISC license. See the LICENSE file for details.
|
||||
|
||||
import { Storages } from './types';
|
||||
import { storage } from './storage';
|
||||
|
||||
import consensus from './consensus';
|
||||
// import contract from './contract';
|
||||
import council from './council';
|
||||
import councilVoting from './councilVoting';
|
||||
import democracy from './democracy';
|
||||
import parachains from './parachains';
|
||||
import session from './session';
|
||||
import staking from './staking';
|
||||
import system from './system';
|
||||
import timestamp from './timestamp';
|
||||
|
||||
const storages: Storages = {
|
||||
consensus: consensus('consensus'),
|
||||
// contract: contract('contract'),
|
||||
council: council('council'),
|
||||
councilVoting: councilVoting('councilVoting'),
|
||||
democracy: democracy('democracy'),
|
||||
parachains: parachains('parachains'),
|
||||
session: session('session'),
|
||||
staking: staking('staking'),
|
||||
system: system('system'),
|
||||
timestamp: timestamp('timestamp')
|
||||
};
|
||||
|
||||
export default storages;
|
||||
export default storage;
|
||||
|
||||
@@ -0,0 +1,3 @@
|
||||
# Legacy
|
||||
|
||||
This whole folder is legacy code, and only used because other packages (api-provider, api-format, type-params) use this folder.
|
||||
@@ -1,59 +0,0 @@
|
||||
// Copyright 2017-2018 @polkadot/storage authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the ISC license. See the LICENSE file for details.
|
||||
|
||||
import hexToU8a from '@polkadot/util/hex/toU8a';
|
||||
import u8aFromString from '@polkadot/util/u8a/fromString';
|
||||
import param from '@polkadot/params/param';
|
||||
|
||||
import key from './index';
|
||||
|
||||
describe('key', () => {
|
||||
it('concats the values', () => {
|
||||
expect(
|
||||
key({
|
||||
key: 'sys:old:',
|
||||
params: [
|
||||
param('first', 'Bytes')
|
||||
]
|
||||
})(
|
||||
hexToU8a('0x0100000000000000')
|
||||
)
|
||||
).toEqual(
|
||||
hexToU8a('0x3117ecd3eaa7a8c27cb8d04eb597a1ef')
|
||||
);
|
||||
});
|
||||
|
||||
it('concats the values (Array<Uint8Array>)', () => {
|
||||
expect(
|
||||
key({
|
||||
key: 'sys:old:',
|
||||
params: [
|
||||
param('first', 'Bytes'),
|
||||
param('second', 'Bytes')
|
||||
]
|
||||
})(
|
||||
hexToU8a('0x01000000'),
|
||||
hexToU8a('0x00000000')
|
||||
)
|
||||
).toEqual(
|
||||
hexToU8a('0x3117ecd3eaa7a8c27cb8d04eb597a1ef')
|
||||
);
|
||||
});
|
||||
|
||||
it('concats with empty key', () => {
|
||||
expect(
|
||||
key({ key: 'ses:llc' })()
|
||||
).toEqual(
|
||||
hexToU8a('0xe14daa763fce793346d4b7e131240849')
|
||||
);
|
||||
});
|
||||
|
||||
it('does not hash when not required', () => {
|
||||
expect(
|
||||
key({ key: ':code', isUnhashed: true })()
|
||||
).toEqual(
|
||||
u8aFromString(':code')
|
||||
);
|
||||
});
|
||||
});
|
||||
@@ -1,56 +0,0 @@
|
||||
// Copyright 2017-2018 @polkadot/storage authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the ISC license. See the LICENSE file for details.
|
||||
|
||||
import { CreateItems, CreateItemOptions, Section } from '@polkadot/params/types';
|
||||
import { Storages, Storage$Sections } from './types';
|
||||
|
||||
import param from '@polkadot/params/param';
|
||||
import createSection from '@polkadot/params/section';
|
||||
|
||||
const activeParachains: CreateItemOptions = {
|
||||
description: 'All registered parachains',
|
||||
key: 'para:chains',
|
||||
params: [],
|
||||
type: ['ParachainId']
|
||||
};
|
||||
|
||||
const parachainCode: CreateItemOptions = {
|
||||
description: 'Gets the code for a specific parachain',
|
||||
key: 'para:code',
|
||||
params: [
|
||||
param('id', 'ParachainId')
|
||||
],
|
||||
type: 'Code'
|
||||
};
|
||||
|
||||
const parachainHeads: CreateItemOptions = {
|
||||
description: 'The heads of the parachains registered at present',
|
||||
key: 'para:head',
|
||||
params: [
|
||||
param('id', 'ParachainId')
|
||||
],
|
||||
type: 'Bytes'
|
||||
};
|
||||
|
||||
const didUpdate: CreateItemOptions = {
|
||||
description: 'Did the parachain heads get updated in this block',
|
||||
key: 'para:did',
|
||||
params: [],
|
||||
type: 'bool'
|
||||
};
|
||||
|
||||
export default (name: Storage$Sections): Section<Storages, any, any> =>
|
||||
createSection(name)((createMethod: CreateItems<Storages>) => ({
|
||||
description: 'Parachain related entries',
|
||||
public: {
|
||||
activeParachains:
|
||||
createMethod('activeParachains')(activeParachains),
|
||||
parachainCode:
|
||||
createMethod('parachainCode')(parachainCode),
|
||||
parachainHeads:
|
||||
createMethod('parachainHeads')(parachainHeads),
|
||||
didUpdate:
|
||||
createMethod('didUpdate')(didUpdate)
|
||||
}
|
||||
}));
|
||||
@@ -1,99 +0,0 @@
|
||||
// Copyright 2017-2018 @polkadot/storage authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the ISC license. See the LICENSE file for details.
|
||||
|
||||
import { CreateItems, CreateItemOptions, Section } from '@polkadot/params/types';
|
||||
import { Storages, Storage$Sections } from './types';
|
||||
|
||||
import param from '@polkadot/params/param';
|
||||
import createSection from '@polkadot/params/section';
|
||||
|
||||
const validators: CreateItemOptions = {
|
||||
description: 'Current validators',
|
||||
key: 'ses:val',
|
||||
params: [],
|
||||
type: ['AccountId']
|
||||
};
|
||||
|
||||
const length: CreateItemOptions = {
|
||||
description: 'Current length of the session',
|
||||
key: 'ses:len',
|
||||
params: [],
|
||||
type: 'BlockNumber'
|
||||
};
|
||||
|
||||
const currentIndex: CreateItemOptions = {
|
||||
description: 'Current index of the session',
|
||||
key: 'ses:ind',
|
||||
params: [],
|
||||
type: 'BlockNumber'
|
||||
};
|
||||
|
||||
const currentStart: CreateItemOptions = {
|
||||
description: 'Timestamp when current session started',
|
||||
key: 'ses:current_start',
|
||||
params: [],
|
||||
type: 'Timestamp'
|
||||
};
|
||||
|
||||
const brokenPercentLate: CreateItemOptions = {
|
||||
description: 'Percent by which the session must finish late before early-exit',
|
||||
key: 'ses:broken_percent_late',
|
||||
params: [],
|
||||
type: 'u64'
|
||||
};
|
||||
|
||||
const forcingNewSession: CreateItemOptions = {
|
||||
description: 'New session is being forced is this entry exists',
|
||||
key: 'ses:forcing_new_session',
|
||||
params: [],
|
||||
type: 'bool'
|
||||
};
|
||||
|
||||
const lastLengthChange: CreateItemOptions = {
|
||||
description: 'Block at which the session length last changed',
|
||||
key: 'ses:llc',
|
||||
params: [],
|
||||
type: 'BlockNumber'
|
||||
};
|
||||
|
||||
const nextKeyFor: CreateItemOptions = {
|
||||
description: 'The next key for a given validator',
|
||||
key: 'ses:nxt:',
|
||||
params: [
|
||||
param('who', 'AccountId')
|
||||
],
|
||||
type: 'SessionKey'
|
||||
};
|
||||
|
||||
const nextLength: CreateItemOptions = {
|
||||
description: 'The next session length',
|
||||
key: 'ses:nln',
|
||||
params: [],
|
||||
type: 'BlockNumber'
|
||||
};
|
||||
|
||||
export default (name: Storage$Sections): Section<Storages, any, any> =>
|
||||
createSection(name)((createMethod: CreateItems<Storages>) => ({
|
||||
description: 'Session management information',
|
||||
public: {
|
||||
brokenPercentLate:
|
||||
createMethod('brokenPercentLate')(brokenPercentLate),
|
||||
currentIndex:
|
||||
createMethod('currentIndex')(currentIndex),
|
||||
currentStart:
|
||||
createMethod('currentStart')(currentStart),
|
||||
forcingNewSession:
|
||||
createMethod('forcingNewSession')(forcingNewSession),
|
||||
lastLengthChange:
|
||||
createMethod('lastLengthChange')(lastLengthChange),
|
||||
nextKeyFor:
|
||||
createMethod('nextKeyFor')(nextKeyFor),
|
||||
nextLength:
|
||||
createMethod('nextLength')(nextLength),
|
||||
length:
|
||||
createMethod('length')(length),
|
||||
validators:
|
||||
createMethod('validators')(validators)
|
||||
}
|
||||
}));
|
||||
@@ -1,284 +0,0 @@
|
||||
// Copyright 2017-2018 @polkadot/storage authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the ISC license. See the LICENSE file for details.
|
||||
|
||||
import { CreateItems, CreateItemOptions, Section } from '@polkadot/params/types';
|
||||
import { Storages, Storage$Sections } from './types';
|
||||
|
||||
import param from '@polkadot/params/param';
|
||||
import createSection from '@polkadot/params/section';
|
||||
|
||||
const bondingDuration: CreateItemOptions = {
|
||||
description: 'The length of the bonding duration in eras',
|
||||
key: 'sta:loc',
|
||||
params: [],
|
||||
type: 'BlockNumber'
|
||||
};
|
||||
|
||||
const validatorCount: CreateItemOptions = {
|
||||
description: 'The ideal number of staking participants',
|
||||
key: 'sta:vac',
|
||||
params: [],
|
||||
type: 'u32'
|
||||
};
|
||||
|
||||
const minimumValidatorCount: CreateItemOptions = {
|
||||
description: 'Minimum number of staking participants before emergency conditions are imposed',
|
||||
key: 'sta:minimum_validator_count',
|
||||
params: [],
|
||||
type: 'u32'
|
||||
};
|
||||
|
||||
const sessionsPerEra: CreateItemOptions = {
|
||||
description: 'The length of a staking era in sessions',
|
||||
key: 'sta:spe',
|
||||
params: [],
|
||||
type: 'BlockNumber'
|
||||
};
|
||||
|
||||
const totalStake: CreateItemOptions = {
|
||||
description: 'The total amount of stake on the system',
|
||||
key: 'sta:tot',
|
||||
params: [],
|
||||
type: 'Balance'
|
||||
};
|
||||
|
||||
const transactionBaseFee: CreateItemOptions = {
|
||||
description: 'The fee to be paid for making a transaction; the base',
|
||||
key: 'sta:basefee',
|
||||
params: [],
|
||||
type: 'Balance'
|
||||
};
|
||||
|
||||
const transactionByteFee: CreateItemOptions = {
|
||||
description: 'The fee to be paid for making a transaction; the per-byte portion',
|
||||
key: 'sta:bytefee',
|
||||
params: [],
|
||||
type: 'Balance'
|
||||
};
|
||||
|
||||
const existentialDeposit: CreateItemOptions = {
|
||||
description: 'The minimum amount allowed to keep an account open',
|
||||
key: 'sta:existential_deposit',
|
||||
params: [],
|
||||
type: 'Balance'
|
||||
};
|
||||
|
||||
const reclaimRebate: CreateItemOptions = {
|
||||
description: 'The amount credited to a destination account whose index was reclaimed',
|
||||
key: 'sta:reclaim_rebate',
|
||||
params: [],
|
||||
type: 'Balance'
|
||||
};
|
||||
|
||||
const transferFee: CreateItemOptions = {
|
||||
description: 'The fee required to make a transfer',
|
||||
key: 'sta:transfer_fee',
|
||||
params: [],
|
||||
type: 'Balance'
|
||||
};
|
||||
|
||||
const creationFee: CreateItemOptions = {
|
||||
description: 'The fee required to create an account',
|
||||
key: 'sta:creation_fee',
|
||||
params: [],
|
||||
type: 'Balance'
|
||||
};
|
||||
|
||||
const sessionReward: CreateItemOptions = {
|
||||
description: 'Maximum reward, per validator, that is provided per acceptable session',
|
||||
key: 'sta:early_era_slash',
|
||||
params: [],
|
||||
type: 'Balance'
|
||||
};
|
||||
|
||||
const earlyEraSlash: CreateItemOptions = {
|
||||
description: 'Slash, per validator that is taken per abnormal era end',
|
||||
key: 'sta:early_era_slash',
|
||||
params: [],
|
||||
type: 'Balance'
|
||||
};
|
||||
|
||||
const offlineSlashGrace: CreateItemOptions = {
|
||||
description: 'Number of instances of offline reports before slashing begins for validators',
|
||||
key: 'sta:offline_slash_grace',
|
||||
params: [],
|
||||
type: 'u32'
|
||||
};
|
||||
|
||||
const currentEra: CreateItemOptions = {
|
||||
description: 'The current era index',
|
||||
key: 'sta:era',
|
||||
params: [],
|
||||
type: 'BlockNumber'
|
||||
};
|
||||
|
||||
const slashPreferenceOf: CreateItemOptions = {
|
||||
description: 'How many times the validator should get slashed for being offline and automatically unstaked',
|
||||
key: 'sta:slash_preference_of',
|
||||
params: [
|
||||
param('who', 'AccountId')
|
||||
],
|
||||
type: 'u32'
|
||||
};
|
||||
|
||||
const intentions: CreateItemOptions = {
|
||||
description: 'All the accounts with a desire to stake',
|
||||
key: 'sta:wil:',
|
||||
params: [],
|
||||
type: ['AccountId']
|
||||
};
|
||||
|
||||
const nominating: CreateItemOptions = {
|
||||
description: 'Nominator -> nominee relationship',
|
||||
key: 'sta:nominating',
|
||||
params: [
|
||||
param('who', 'AccountId')
|
||||
],
|
||||
type: 'AccountId'
|
||||
};
|
||||
|
||||
const nominatorsFor: CreateItemOptions = {
|
||||
description: 'Nominators for a particular account',
|
||||
key: 'sta:nominators_for',
|
||||
params: [
|
||||
param('who', 'AccountId')
|
||||
],
|
||||
type: ['AccountId']
|
||||
};
|
||||
|
||||
const currentNominatorsFor: CreateItemOptions = {
|
||||
description: 'Nominators for a particular account that is in action right now',
|
||||
key: 'sta:current_nominators_for',
|
||||
params: [
|
||||
param('who', 'AccountId')
|
||||
],
|
||||
type: ['AccountId']
|
||||
};
|
||||
|
||||
const nextSessionsPerEra: CreateItemOptions = {
|
||||
description: 'The next value of sessions per era',
|
||||
key: 'sta:nse',
|
||||
params: [],
|
||||
type: 'BlockNumber'
|
||||
};
|
||||
|
||||
const lastEraLengthChange: CreateItemOptions = {
|
||||
description: 'The session index at which the era length last changed',
|
||||
key: 'sta:lec',
|
||||
params: [],
|
||||
type: 'BlockNumber'
|
||||
};
|
||||
|
||||
const stakeThreshold: CreateItemOptions = {
|
||||
description: 'The current era stake threshold',
|
||||
key: 'sta:stake_threshold',
|
||||
params: [],
|
||||
type: 'Balance'
|
||||
};
|
||||
|
||||
const nextEnumSet: CreateItemOptions = {
|
||||
description: 'The next free enumeration set',
|
||||
key: 'sta:next_enum',
|
||||
params: [],
|
||||
type: 'AccountIndex'
|
||||
};
|
||||
|
||||
const enumSet: CreateItemOptions = {
|
||||
description: 'The enumeration sets',
|
||||
key: 'sta:enum_set',
|
||||
params: [
|
||||
param('index', 'AccountIndex')
|
||||
],
|
||||
type: ['AccountId']
|
||||
};
|
||||
|
||||
const freeBalanceOf: CreateItemOptions = {
|
||||
description: 'The balance of a given account',
|
||||
key: 'sta:bal:',
|
||||
params: [
|
||||
param('who', 'AccountId')
|
||||
],
|
||||
type: 'Balance'
|
||||
};
|
||||
|
||||
const reservedBalanceOf: CreateItemOptions = {
|
||||
description: 'The amount of a given account that is reserved',
|
||||
key: 'sta:lbo:',
|
||||
params: [
|
||||
param('who', 'AccountId')
|
||||
],
|
||||
type: 'Balance'
|
||||
};
|
||||
|
||||
const bondageOf: CreateItemOptions = {
|
||||
key: 'sta:bon:',
|
||||
description: 'The block at which the account becomes liquid',
|
||||
params: [
|
||||
param('who', 'AccountId')
|
||||
],
|
||||
type: 'Balance'
|
||||
};
|
||||
|
||||
export default (name: Storage$Sections): Section<Storages, any, any> =>
|
||||
createSection(name)((createMethod: CreateItems<Storages>) => ({
|
||||
description: 'Staking',
|
||||
public: {
|
||||
freeBalanceOf:
|
||||
createMethod('freeBalanceOf')(freeBalanceOf),
|
||||
bondageOf:
|
||||
createMethod('bondageOf')(bondageOf),
|
||||
creationFee:
|
||||
createMethod('creationFee')(creationFee),
|
||||
currentNominatorsFor:
|
||||
createMethod('currentNominatorsFor')(currentNominatorsFor),
|
||||
earlyEraSlash:
|
||||
createMethod('earlyEraSlash')(earlyEraSlash),
|
||||
existentialDeposit:
|
||||
createMethod('existentialDeposit')(existentialDeposit),
|
||||
enumSet:
|
||||
createMethod('enumSet')(enumSet),
|
||||
transactionBaseFee:
|
||||
createMethod('transactionBaseFee')(transactionBaseFee),
|
||||
transactionByteFee:
|
||||
createMethod('transactionByteFee')(transactionByteFee),
|
||||
transferFee:
|
||||
createMethod('transferFee')(transferFee),
|
||||
bondingDuration:
|
||||
createMethod('bondingDuration')(bondingDuration),
|
||||
currentEra:
|
||||
createMethod('currentEra')(currentEra),
|
||||
reservedBalanceOf:
|
||||
createMethod('reservedBalanceOf')(reservedBalanceOf),
|
||||
intentions:
|
||||
createMethod('intentions')(intentions),
|
||||
lastEraLengthChange:
|
||||
createMethod('lastEraLengthChange')(lastEraLengthChange),
|
||||
minimumValidatorCount:
|
||||
createMethod('minimumValidatorCount')(minimumValidatorCount),
|
||||
nextEnumSet:
|
||||
createMethod('nextEnumSet')(nextEnumSet),
|
||||
nextSessionsPerEra:
|
||||
createMethod('nextSessionsPerEra')(nextSessionsPerEra),
|
||||
nominating:
|
||||
createMethod('nominating')(nominating),
|
||||
nominatorsFor:
|
||||
createMethod('nominatorsFor')(nominatorsFor),
|
||||
offlineSlashGrace:
|
||||
createMethod('offlineSlashGrace')(offlineSlashGrace),
|
||||
reclaimRebate:
|
||||
createMethod('reclaimRebate')(reclaimRebate),
|
||||
slashPreferenceOf:
|
||||
createMethod('slashPreferenceOf')(slashPreferenceOf),
|
||||
stakeThreshold:
|
||||
createMethod('stakeThreshold')(stakeThreshold),
|
||||
sessionsPerEra:
|
||||
createMethod('sessionsPerEra')(sessionsPerEra),
|
||||
sessionReward:
|
||||
createMethod('sessionReward')(sessionReward),
|
||||
totalStake:
|
||||
createMethod('totalStake')(totalStake),
|
||||
validatorCount:
|
||||
createMethod('validatorCount')(validatorCount)
|
||||
}
|
||||
}));
|
||||
@@ -0,0 +1,17 @@
|
||||
// Copyright 2017-2018 @polkadot/storage authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the ISC license. See the LICENSE file for details.
|
||||
|
||||
import { storage } from './storage';
|
||||
|
||||
describe('storage', () => {
|
||||
it('should return well known keys', () => {
|
||||
expect(typeof storage.substrate).toBe('object');
|
||||
expect(storage.substrate.authorityCount).toBeTruthy();
|
||||
expect(storage.substrate.authorityPrefix).toBeTruthy();
|
||||
expect(storage.substrate.changesTrieConfig).toBeTruthy();
|
||||
expect(storage.substrate.code).toBeTruthy();
|
||||
expect(storage.substrate.extrinsicIndex).toBeTruthy();
|
||||
expect(storage.substrate.heapPages).toBeTruthy();
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,10 @@
|
||||
// Copyright 2017-2018 @polkadot/storage authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the ISC license. See the LICENSE file for details.
|
||||
|
||||
import { Storage } from './types';
|
||||
import * as substrate from './substrate';
|
||||
|
||||
export const storage: Storage = {
|
||||
substrate // Prefill storage with well known keys, as not returned by state_getMetadata
|
||||
};
|
||||
@@ -0,0 +1,33 @@
|
||||
// Copyright 2017-2018 @polkadot/storage authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the ISC license. See the LICENSE file for details.
|
||||
|
||||
import { authorityCount, authorityPrefix, changesTrieConfig, code, extrinsicIndex, heapPages } from './substrate';
|
||||
|
||||
describe('substrate', () => {
|
||||
it('authorityCount should return the correct storage key', () => {
|
||||
expect(authorityCount()).toEqual(Uint8Array.from([58, 97, 117, 116, 104, 58, 108, 101, 110]));
|
||||
});
|
||||
|
||||
it('authorityPrefix should return the correct storage key', () => {
|
||||
expect(authorityPrefix()).toEqual(Uint8Array.from([58, 97, 117, 116, 104, 58]));
|
||||
});
|
||||
|
||||
it('changesTrieConfig should return the correct storage key', () => {
|
||||
expect(changesTrieConfig()).toEqual(Uint8Array.from([58, 99, 104, 97, 110, 103, 101, 115, 95, 116, 114, 105, 101]));
|
||||
});
|
||||
|
||||
it('code should return the correct storage key', () => {
|
||||
expect(code()).toEqual(Uint8Array.from([58, 99, 111, 100, 101]));
|
||||
});
|
||||
|
||||
it('extrinsicIndex should return the correct storage key', () => {
|
||||
expect(extrinsicIndex()).toEqual(
|
||||
Uint8Array.from([58, 101, 120, 116, 114, 105, 110, 115, 105, 99, 95, 105, 110, 100, 101, 120])
|
||||
);
|
||||
});
|
||||
|
||||
it('heapPages should return the correct storage key', () => {
|
||||
expect(heapPages()).toEqual(Uint8Array.from([58, 104, 101, 97, 112, 112, 97, 103, 101, 115]));
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,61 @@
|
||||
// Copyright 2017-2018 @polkadot/storage authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the ISC license. See the LICENSE file for details.
|
||||
|
||||
import { StorageFunctionModifier, StorageFunctionType } from '@polkadot/api-codec/Metadata';
|
||||
import Text from '@polkadot/api-codec/Text';
|
||||
import U8a from '@polkadot/api-codec/codec/U8a';
|
||||
import Vector from '@polkadot/api-codec/codec/Vector';
|
||||
|
||||
import { createFunction } from './utils/createFunction';
|
||||
|
||||
interface SubstrateMetadata {
|
||||
documentation: string;
|
||||
type: string;
|
||||
}
|
||||
|
||||
// Small helper function to factorize code on this page.
|
||||
const createRuntimeFunction = (prefix: string, functionMetadata: SubstrateMetadata) =>
|
||||
// TODO The expected 2nd argument is a StorageFunctionMetadata, but we
|
||||
// actually only need the fields `documentation` and `type` of it, so in
|
||||
// order to not input other fields (byteLength, fromJSON...) we lazily cast
|
||||
// as any.
|
||||
createFunction(
|
||||
new U8a(prefix),
|
||||
{
|
||||
documentation: new Vector(Text, [functionMetadata.documentation]),
|
||||
modifier: new StorageFunctionModifier().fromJSON(0),
|
||||
type: new StorageFunctionType(0, functionMetadata.type)
|
||||
} as any,
|
||||
{ isUnhashed: true }
|
||||
);
|
||||
|
||||
export const code = createRuntimeFunction(':code', {
|
||||
documentation: 'Wasm code of the runtime.',
|
||||
type: 'Bytes'
|
||||
});
|
||||
|
||||
export const heapPages = createRuntimeFunction(':heappages', {
|
||||
documentation: 'Number of wasm linear memory pages required for execution of the runtime.',
|
||||
type: 'u64'
|
||||
});
|
||||
|
||||
export const authorityCount = createRuntimeFunction(':auth:len', {
|
||||
documentation: 'Number of authorities.',
|
||||
type: 'u32'
|
||||
});
|
||||
|
||||
export const authorityPrefix = createRuntimeFunction(':auth:', {
|
||||
documentation: 'Prefix under which authorities are storied.',
|
||||
type: 'u32'
|
||||
});
|
||||
|
||||
export const extrinsicIndex = createRuntimeFunction(':extrinsic_index', {
|
||||
documentation: 'Current extrinsic index (u32) is stored under this key.',
|
||||
type: 'u32'
|
||||
});
|
||||
|
||||
export const changesTrieConfig = createRuntimeFunction(':changes_trie', {
|
||||
documentation: 'Changes trie configuration is stored under this key.',
|
||||
type: 'u32'
|
||||
});
|
||||
@@ -1,94 +0,0 @@
|
||||
// Copyright 2017-2018 @polkadot/storage authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the ISC license. See the LICENSE file for details.
|
||||
|
||||
import { CreateItems, CreateItemOptions, Section } from '@polkadot/params/types';
|
||||
import { Storages, Storage$Sections } from './types';
|
||||
|
||||
import param from '@polkadot/params/param';
|
||||
import createSection from '@polkadot/params/section';
|
||||
|
||||
const accountIndexOf: CreateItemOptions = {
|
||||
description: 'The index of the given account',
|
||||
key: 'sys:non',
|
||||
params: [
|
||||
param('who', 'AccountId')
|
||||
],
|
||||
type: 'AccountIndex'
|
||||
};
|
||||
|
||||
const blockHashAt: CreateItemOptions = {
|
||||
description: 'The blockHash for a specific number',
|
||||
key: 'sys:old',
|
||||
params: [
|
||||
param('blockNumber', 'BlockNumber')
|
||||
],
|
||||
type: 'Hash'
|
||||
};
|
||||
|
||||
const extrinsicIndex: CreateItemOptions = {
|
||||
description: 'The extrinsics index',
|
||||
key: 'sys:xti',
|
||||
params: [],
|
||||
type: 'u32'
|
||||
};
|
||||
|
||||
const extrinsicData: CreateItemOptions = {
|
||||
description: 'The data associated with an extrinsic',
|
||||
key: 'sys:xtd',
|
||||
params: [
|
||||
param('extrinsic', 'u32')
|
||||
],
|
||||
type: 'Bytes'
|
||||
};
|
||||
|
||||
const blockNumber: CreateItemOptions = {
|
||||
description: 'The current block number being processed',
|
||||
key: 'sys:num',
|
||||
params: [],
|
||||
type: 'BlockNumber'
|
||||
};
|
||||
|
||||
const parentHash: CreateItemOptions = {
|
||||
description: 'The parentHash for the current block',
|
||||
key: 'sys:pha',
|
||||
params: [],
|
||||
type: 'Hash'
|
||||
};
|
||||
|
||||
const extrinsicsRoot: CreateItemOptions = {
|
||||
description: 'The extrinsicsRoot for the current block',
|
||||
key: 'sys:txr',
|
||||
params: [],
|
||||
type: 'Hash'
|
||||
};
|
||||
|
||||
const digest: CreateItemOptions = {
|
||||
description: 'The digest for the current block',
|
||||
key: 'sys:dig',
|
||||
params: [],
|
||||
type: 'Digest'
|
||||
};
|
||||
|
||||
export default (name: Storage$Sections): Section<Storages, any, any> =>
|
||||
createSection(name)((createMethod: CreateItems<Storages>) => ({
|
||||
description: 'System',
|
||||
public: {
|
||||
blockHashAt:
|
||||
createMethod('blockHashAt')(blockHashAt),
|
||||
blockNumber:
|
||||
createMethod('blockNumber')(blockNumber),
|
||||
digest:
|
||||
createMethod('digest')(digest),
|
||||
extrinsicData:
|
||||
createMethod('extrinsicData')(extrinsicData),
|
||||
extrinsicIndex:
|
||||
createMethod('extrinsicIndex')(extrinsicIndex),
|
||||
extrinsicsRoot:
|
||||
createMethod('extrinsicsRoot')(extrinsicsRoot),
|
||||
accountIndexOf:
|
||||
createMethod('accountIndexOf')(accountIndexOf),
|
||||
parentHash:
|
||||
createMethod('parentHash')(parentHash)
|
||||
}
|
||||
}));
|
||||
@@ -1,42 +0,0 @@
|
||||
// Copyright 2017-2018 @polkadot/storage authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the ISC license. See the LICENSE file for details.
|
||||
|
||||
import { CreateItems, CreateItemOptions, Section } from '@polkadot/params/types';
|
||||
import { Storages, Storage$Sections } from './types';
|
||||
|
||||
import createSection from '@polkadot/params/section';
|
||||
|
||||
const now: CreateItemOptions = {
|
||||
description: 'The current timestamp',
|
||||
key: 'tim:val',
|
||||
params: [],
|
||||
type: 'Timestamp'
|
||||
};
|
||||
|
||||
const blockPeriod: CreateItemOptions = {
|
||||
description: 'The minimum (and advised) period between blocks',
|
||||
key: 'tim:block_period',
|
||||
params: [],
|
||||
type: 'u64'
|
||||
};
|
||||
|
||||
const didUpdate: CreateItemOptions = {
|
||||
description: 'Did the timestamp update in this block',
|
||||
key: 'tim:did',
|
||||
params: [],
|
||||
type: 'bool'
|
||||
};
|
||||
|
||||
export default (name: Storage$Sections): Section<Storages, any, any> =>
|
||||
createSection(name)((createMethod: CreateItems<Storages>) => ({
|
||||
description: 'Timestamp related entries',
|
||||
public: {
|
||||
blockPeriod:
|
||||
createMethod('blockPeriod')(blockPeriod),
|
||||
now:
|
||||
createMethod('now')(now),
|
||||
didUpdate:
|
||||
createMethod('didUpdate')(didUpdate)
|
||||
}
|
||||
}));
|
||||
Vendored
+30
-11
@@ -2,22 +2,41 @@
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the ISC license. See the LICENSE file for details.
|
||||
|
||||
import { StorageFunctionMetadata } from '@polkadot/api-codec/Metadata';
|
||||
import BN from 'bn.js';
|
||||
import { Section } from '@polkadot/params/types';
|
||||
|
||||
import * as substrate from './substrate';
|
||||
|
||||
type Substrate = keyof typeof substrate;
|
||||
|
||||
export interface StorageFunction extends StorageFunctionMetadata {
|
||||
(arg: any): Uint8Array;
|
||||
}
|
||||
|
||||
export interface ModuleStorage {
|
||||
[key: string]: StorageFunction;
|
||||
}
|
||||
|
||||
export interface Storage {
|
||||
[key: string]: ModuleStorage; // Will hold modules returned by state_getMetadata
|
||||
substrate: { [key in Substrate]: StorageFunction };
|
||||
}
|
||||
|
||||
// TODO Below is legacy code, used in:
|
||||
// - api-provider
|
||||
// - api-format
|
||||
export type Storage$Key$Value = number | BN | Uint8Array | string;
|
||||
|
||||
export type Storages = {
|
||||
consensus: Section<Storages, any, any>,
|
||||
consensus: Section<Storages, any, any>;
|
||||
// contract: Section<Storages, any, any>,
|
||||
council: Section<Storages, any, any>,
|
||||
councilVoting: Section<Storages, any, any>,
|
||||
democracy: Section<Storages, any, any>,
|
||||
parachains: Section<Storages, any, any>,
|
||||
session: Section<Storages, any, any>,
|
||||
staking: Section<Storages, any, any>,
|
||||
system: Section<Storages, any, any>,
|
||||
timestamp: Section<Storages, any, any>
|
||||
council: Section<Storages, any, any>;
|
||||
councilVoting: Section<Storages, any, any>;
|
||||
democracy: Section<Storages, any, any>;
|
||||
parachains: Section<Storages, any, any>;
|
||||
session: Section<Storages, any, any>;
|
||||
staking: Section<Storages, any, any>;
|
||||
system: Section<Storages, any, any>;
|
||||
timestamp: Section<Storages, any, any>;
|
||||
};
|
||||
|
||||
export type Storage$Sections = keyof Storages;
|
||||
|
||||
@@ -0,0 +1,64 @@
|
||||
// Copyright 2017-2018 @polkadot/storage authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the ISC license. See the LICENSE file for details.
|
||||
|
||||
import * as CodecTypes from '@polkadot/api-codec/index';
|
||||
import { StorageFunctionMetadata } from '@polkadot/api-codec/Metadata';
|
||||
import Text from '@polkadot/api-codec/Text';
|
||||
import U8a from '@polkadot/api-codec/codec/U8a';
|
||||
import u8aConcat from '@polkadot/util/u8a/concat';
|
||||
import xxhash from '@polkadot/util-crypto/xxhash/asU8a';
|
||||
|
||||
import { StorageFunction } from '../types';
|
||||
|
||||
export interface CreateItemOptions {
|
||||
isUnhashed?: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* From the schema of a function in the module's storage, generate the function
|
||||
* that will return the correct storage key.
|
||||
*
|
||||
* @param schema - The function's definition schema to create the function from.
|
||||
* The schema is taken from state_getMetadata.
|
||||
* @param options - Additional options when creating the function. These options
|
||||
* are not known at runtime (from state_getMetadata), they need to be supplied
|
||||
* by us manually at compile time.
|
||||
*/
|
||||
export function createFunction (
|
||||
prefix: Text | U8a,
|
||||
functionMetadata: StorageFunctionMetadata,
|
||||
options: CreateItemOptions = {}
|
||||
) {
|
||||
let func: any; // The return value, it's a function that has metadata.
|
||||
|
||||
if (options.isUnhashed) {
|
||||
func = () => prefix.toU8a();
|
||||
} else {
|
||||
// TODO Find better type than any
|
||||
// Can only have zero or one argument:
|
||||
// - storage.balances.freeBalance(address)
|
||||
// - storage.timestamp.blockPeriod()
|
||||
func = (arg?: any) => {
|
||||
if (functionMetadata.type.isMap) {
|
||||
if (!arg) {
|
||||
throw new Error(`${functionMetadata.name} expects one argument.`);
|
||||
}
|
||||
|
||||
const argType = functionMetadata.type.asMap.key.toString(); // Argument type, as string
|
||||
const ArgType = (CodecTypes as any)[argType]; // Argument type, as Class
|
||||
return xxhash(u8aConcat(prefix.toU8a(), new ArgType(arg).toU8a()), 128);
|
||||
}
|
||||
|
||||
return xxhash(prefix.toU8a(), 128);
|
||||
};
|
||||
}
|
||||
|
||||
// Add metadata to the storage function
|
||||
Object.assign(func as StorageFunction, {
|
||||
documentation: functionMetadata.documentation,
|
||||
type: functionMetadata.type
|
||||
});
|
||||
|
||||
return func as StorageFunction;
|
||||
}
|
||||
Reference in New Issue
Block a user