diff --git a/docs/METHODS_EXTRINSICS.md b/docs/METHODS_EXTRINSICS.md index 7c8f1e8abc..a726b3db00 100644 --- a/docs/METHODS_EXTRINSICS.md +++ b/docs/METHODS_EXTRINSICS.md @@ -202,23 +202,26 @@ ___ ### staking ▸ **bond**(controller: `Address`, value: `Compact`, payee: `RewardDestination`) -- **summary**: Take the origin account as a stash and lock up `value` of its balance. `controller` will be the account that controls it. +- **summary**: Take the origin account as a stash and lock up `value` of its balance. `controller` will be the account that controls it. The dispatch origin for this call must be _Signed_. ▸ **bondExtra**(max_additional: `BalanceOf`) -- **summary**: 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. NOTE: This call must be made by the controller, not the stash. +- **summary**: 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. The dispatch origin for this call must be _Signed_ by the controller, not the stash. ▸ **chill**() -- **summary**: Declare no desire to either validate or nominate. Effects will be felt at the beginning of the next era. NOTE: This call must be made by the controller, not the stash. +- **summary**: 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. ▸ **forceNewEra**(apply_rewards: `bool`) - **summary**: Force there to be a new era. This also forces a new session immediately after. `apply_rewards` should be true for validators to get the session reward. ▸ **nominate**(targets: `Vec
`) -- **summary**: Declare the desire to nominate `targets` for the origin controller. Effects will be felt at the beginning of the next era. NOTE: This call must be made by the controller, not the stash. +- **summary**: 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. ▸ **setBondingDuration**(new: `Compact`) - **summary**: The length of the bonding duration in eras. +▸ **setController**(controller: `Address`) +- **summary**: (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. + ▸ **setInvulnerables**(validators: `Vec`) - **summary**: Set the validators who cannot be slashed (if any). @@ -226,7 +229,7 @@ ___ - **summary**: Set the offline slash grace period. ▸ **setPayee**(payee: `RewardDestination`) -- **summary**: (Re-)set the payment target for a controller. Effects will be felt at the beginning of the next era. NOTE: This call must be made by the controller, not the stash. +- **summary**: (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. ▸ **setSessionsPerEra**(new: `Compact`) - **summary**: Set the number of sessions in an era. @@ -235,13 +238,13 @@ ___ - **summary**: The ideal number of validators. ▸ **unbond**(value: `Compact`) -- **summary**: 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::existential_deposit(), 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. NOTE: This call must be made by the controller, not the stash. See also [`Call::withdraw_unbonded`]. +- **summary**: 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::existential_deposit(), 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. The dispatch origin for this call must be _Signed_ by the controller, not the stash. See also [`Call::withdraw_unbonded`]. ▸ **validate**(prefs: `ValidatorPrefs`) -- **summary**: Declare the desire to validate for the origin controller. Effects will be felt at the beginning of the next era. NOTE: This call must be made by the controller, not the stash. +- **summary**: 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. ▸ **withdrawUnbonded**() -- **summary**: 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. NOTE: This call must be made by the controller, not the stash. See also [`Call::unbond`]. +- **summary**: 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`]. ___ diff --git a/docs/METHODS_STORAGE.md b/docs/METHODS_STORAGE.md index 1af02a2e0b..cdc34634fa 100644 --- a/docs/METHODS_STORAGE.md +++ b/docs/METHODS_STORAGE.md @@ -81,6 +81,12 @@ ___ ### contract +▸ **accountCounter**(): `u64` +- **summary**: The subtrie counter + +▸ **accountInfoOf**(`AccountId`): `Option` +- **summary**: The code associated with a given account. + ▸ **blockGasLimit**(): `Gas` - **summary**: The maximum amount of gas that could be expended per block. @@ -327,23 +333,21 @@ ___ ▸ **bondingDuration**(): `BlockNumber` - **summary**: The length of the bonding duration in blocks. +▸ **currentElected**(): `Vec` +- **summary**: The currently elected validator set keyed by stash account ID. + ▸ **currentEra**(): `BlockNumber` - **summary**: The current era index. ▸ **currentEraReward**(): `BalanceOf` - **summary**: The accumulated reward for the current era. Reset to zero at the beginning of the era and increased for every successfully finished session. -▸ **currentOfflineSlash**(): `BalanceOf` -- **summary**: Slash, per validator that is taken for the first time they are found to be offline. - ▸ **currentSessionReward**(): `BalanceOf` - **summary**: Maximum reward, per validator, that is provided per acceptable session. ▸ **forcingNewEra**(): `Option` - **summary**: We are forcing a new era. -▸ **invulerables**(): `Vec` - ▸ **invulnerables**(): `Vec` - **summary**: Any validators that may never be slashed or forcibly kicked. It's a Vec since they're easy to initialise and the performance hit is minimal (we expect no more than four invulnerables) and restricted to testnets. @@ -360,7 +364,7 @@ ___ - **summary**: The next value of sessions per era. ▸ **nominators**(`AccountId`): `Vec` -- **summary**: The set of keys are all controllers that want to nominate. The value are the nominations. +- **summary**: The map from nominator stash key to the set of stash keys of all validators to nominate. ▸ **offlineSlash**(): `Perbill` - **summary**: Slash, per validator that is taken for the first time they are found to be offline. @@ -369,7 +373,7 @@ ___ - **summary**: Number of instances of offline reports before slashing begins for validators. ▸ **payee**(`AccountId`): `RewardDestination` -- **summary**: Where the reward payment should be made. +- **summary**: Where the reward payment should be made. Keyed by stash. ▸ **recentlyOffline**(): `Vec<(AccountId,BlockNumber,u32)>` - **summary**: Most recent `RECENT_OFFLINE_COUNT` instances. (who it was, when it was reported, how many instances they were offline for). @@ -387,13 +391,13 @@ ___ - **summary**: The amount of balance actively at stake for each validator slot, currently. This is used to derive rewards and punishments. ▸ **stakers**(`AccountId`): `Exposure` -- **summary**: 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 `sessions` module. +- **summary**: 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 `sessions` module. This is keyed by the stash account. ▸ **validatorCount**(): `u32` - **summary**: The ideal number of staking participants. ▸ **validators**(`AccountId`): `ValidatorPrefs` -- **summary**: The set of keys are all controllers that want to validate. The values are the preferences that a validator has. +- **summary**: The map from (wannabe) validator stash key to the preferences of that validator. ___ diff --git a/lerna.json b/lerna.json index c343a00a35..7695cdfb0b 100644 --- a/lerna.json +++ b/lerna.json @@ -9,5 +9,5 @@ "packages": [ "packages/*" ], - "version": "0.51.0-beta.0" + "version": "0.51.0-beta.1" } diff --git a/package.json b/package.json index 09e3b962c1..58fd0d7219 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "version": "0.51.0-beta.0", + "version": "0.51.0-beta.1", "private": true, "engines": { "node": ">=10.13.0", diff --git a/packages/api-derive/package.json b/packages/api-derive/package.json index 626622bedc..d54ea385e2 100644 --- a/packages/api-derive/package.json +++ b/packages/api-derive/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/api-derive", - "version": "0.51.0-beta.0", + "version": "0.51.0-beta.1", "description": "Common functions used across Polkadot, derived from RPC calls and storage queries.", "main": "index.js", "keywords": [ @@ -31,8 +31,8 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/api-derive#readme", "dependencies": { "@babel/runtime": "^7.4.0", - "@polkadot/api": "^0.51.0-beta.0", - "@polkadot/types": "^0.51.0-beta.0", + "@polkadot/api": "^0.51.0-beta.1", + "@polkadot/types": "^0.51.0-beta.1", "@types/memoizee": "^0.4.2", "memoizee": "^0.4.14" } diff --git a/packages/api/package.json b/packages/api/package.json index 373c68c158..9540c00a8e 100644 --- a/packages/api/package.json +++ b/packages/api/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/api", - "version": "0.51.0-beta.0", + "version": "0.51.0-beta.1", "description": "Promise and RxJS wrappers around the Polkadot JS RPC", "main": "index.js", "keywords": [ @@ -30,12 +30,12 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/api#readme", "dependencies": { "@babel/runtime": "^7.4.0", - "@polkadot/api-derive": "^0.51.0-beta.0", - "@polkadot/extrinsics": "^0.51.0-beta.0", - "@polkadot/rpc-provider": "^0.51.0-beta.0", - "@polkadot/rpc-rx": "^0.51.0-beta.0", - "@polkadot/storage": "^0.51.0-beta.0", - "@polkadot/types": "^0.51.0-beta.0", + "@polkadot/api-derive": "^0.51.0-beta.1", + "@polkadot/extrinsics": "^0.51.0-beta.1", + "@polkadot/rpc-provider": "^0.51.0-beta.1", + "@polkadot/rpc-rx": "^0.51.0-beta.1", + "@polkadot/storage": "^0.51.0-beta.1", + "@polkadot/types": "^0.51.0-beta.1", "@polkadot/util-crypto": "^0.41.0-beta.1" } } diff --git a/packages/rpc-core/package.json b/packages/rpc-core/package.json index 9ce90dca1a..ef6eded8b9 100644 --- a/packages/rpc-core/package.json +++ b/packages/rpc-core/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/rpc-core", - "version": "0.51.0-beta.0", + "version": "0.51.0-beta.1", "description": "A JavaScript wrapper for the Polkadot JsonRPC interface", "main": "index.js", "keywords": [ @@ -30,9 +30,9 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/rpc-core#readme", "dependencies": { "@babel/runtime": "^7.4.0", - "@polkadot/jsonrpc": "^0.51.0-beta.0", - "@polkadot/rpc-provider": "^0.51.0-beta.0", - "@polkadot/types": "^0.51.0-beta.0", + "@polkadot/jsonrpc": "^0.51.0-beta.1", + "@polkadot/rpc-provider": "^0.51.0-beta.1", + "@polkadot/types": "^0.51.0-beta.1", "@polkadot/util": "^0.41.0-beta.1" } } diff --git a/packages/rpc-provider/package.json b/packages/rpc-provider/package.json index e4e6334ca6..1850e8949e 100644 --- a/packages/rpc-provider/package.json +++ b/packages/rpc-provider/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/rpc-provider", - "version": "0.51.0-beta.0", + "version": "0.51.0-beta.1", "description": "Transport providers for the API", "main": "index.js", "keywords": [ @@ -31,7 +31,7 @@ "dependencies": { "@babel/runtime": "^7.4.0", "@polkadot/keyring": "^0.41.0-beta.1", - "@polkadot/storage": "^0.51.0-beta.0", + "@polkadot/storage": "^0.51.0-beta.1", "@polkadot/util": "^0.41.0-beta.1", "@polkadot/util-crypto": "^0.41.0-beta.1", "@types/nock": "^9.3.1", diff --git a/packages/rpc-rx/package.json b/packages/rpc-rx/package.json index 489c6fd849..7061647286 100644 --- a/packages/rpc-rx/package.json +++ b/packages/rpc-rx/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/rpc-rx", - "version": "0.51.0-beta.0", + "version": "0.51.0-beta.1", "description": "An RxJs wrapper around the Polkadot JS API", "main": "index.js", "keywords": [ @@ -30,8 +30,8 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/rpc-rx#readme", "dependencies": { "@babel/runtime": "^7.4.0", - "@polkadot/rpc-core": "^0.51.0-beta.0", - "@polkadot/rpc-provider": "^0.51.0-beta.0", + "@polkadot/rpc-core": "^0.51.0-beta.1", + "@polkadot/rpc-provider": "^0.51.0-beta.1", "@types/memoizee": "^0.4.2", "@types/rx": "^4.1.1", "memoizee": "^0.4.14", diff --git a/packages/type-extrinsics/package.json b/packages/type-extrinsics/package.json index d69cf91f82..a349fe068c 100644 --- a/packages/type-extrinsics/package.json +++ b/packages/type-extrinsics/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/extrinsics", - "version": "0.51.0-beta.0", + "version": "0.51.0-beta.1", "main": "index.js", "repository": "https://github.com/polkadot-js/api.git", "author": "Jaco Greeff ", @@ -11,7 +11,7 @@ "license": "Apache-2.0", "dependencies": { "@babel/runtime": "^7.4.0", - "@polkadot/types": "^0.51.0-beta.0", + "@polkadot/types": "^0.51.0-beta.1", "@polkadot/util": "^0.41.0-beta.1" } } diff --git a/packages/type-jsonrpc/package.json b/packages/type-jsonrpc/package.json index 8b1847f6b8..93a2b9f855 100644 --- a/packages/type-jsonrpc/package.json +++ b/packages/type-jsonrpc/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/jsonrpc", - "version": "0.51.0-beta.0", + "version": "0.51.0-beta.1", "description": "Method definitions for the Polkadot RPC layer", "main": "index.js", "engines": { diff --git a/packages/type-storage/package.json b/packages/type-storage/package.json index 3543a4637a..b2dc361ac9 100644 --- a/packages/type-storage/package.json +++ b/packages/type-storage/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/storage", - "version": "0.51.0-beta.0", + "version": "0.51.0-beta.1", "description": "Generic wrapper wrapper around state storage", "main": "index.js", "engines": { @@ -31,7 +31,7 @@ "dependencies": { "@babel/runtime": "^7.4.0", "@polkadot/keyring": "^0.41.0-beta.1", - "@polkadot/types": "^0.51.0-beta.0", + "@polkadot/types": "^0.51.0-beta.1", "@polkadot/util": "^0.41.0-beta.1", "@polkadot/util-crypto": "^0.41.0-beta.1" } diff --git a/packages/types/package.json b/packages/types/package.json index 8ffd068f0c..34536684e7 100644 --- a/packages/types/package.json +++ b/packages/types/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/types", - "version": "0.51.0-beta.0", + "version": "0.51.0-beta.1", "description": "Implementation of the Parity codec", "main": "index.js", "keywords": [