quantus/api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[CI Skip] 0.81.0-beta.0

Browse Source
This commit is contained in:
Travis CI
2019-06-06 11:56:56 +00:00
parent 3227ce20a2
commit b2b2a2cdde
14 changed files with 79 additions and 114 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/METHODS_EVENTS.md
+10 -16
View File
@@ -9,8 +9,6 @@ Events are emitted for certain operations on the runtime. The following sections
- **[councilMotions](#councilMotions)**
- **[councilVoting](#councilVoting)**
- **[democracy](#democracy)**
- **[grandpa](#grandpa)**
@@ -96,22 +94,14 @@ ___
▸ **Executed**(`Hash`, `bool`)
- **summary**: A motion was executed; `bool` is true if returned without error.
▸ **Proposed**(`AccountId`, `ProposalIndex`, `Hash`, `u32`)
- **summary**: A motion (given hash) has been proposed (by given account) with a threshold (given u32).
▸ **MemberExecuted**(`Hash`, `bool`)
- **summary**: A single councillor did some action; `bool` is true if returned without error.
▸ **Voted**(`AccountId`, `Hash`, `bool`, `u32`, `u32`)
- **summary**: A motion (given hash) has been voted on by given account, leaving a tally (yes votes and no votes given as u32s respectively).
▸ **Proposed**(`AccountId`, `ProposalIndex`, `Hash`, `MemberCount`)
- **summary**: A motion (given hash) has been proposed (by given account) with a threshold (given `MemberCount`).
___
### councilVoting
▸ **TallyCancelation**(`Hash`, `u32`, `u32`, `u32`)
- **summary**: A voting tally has happened for a referendum cancellation vote. Last three are yes, no, abstain counts.
▸ **TallyReferendum**(`Hash`, `u32`, `u32`, `u32`)
- **summary**: A voting tally has happened for a referendum vote. Last three are yes, no, abstain counts.
▸ **Voted**(`AccountId`, `Hash`, `bool`, `MemberCount`, `MemberCount`)
- **summary**: A motion (given hash) has been voted on by given account, leaving a tally (yes votes and no votes given respectively as `MemberCount`).
___
@@ -124,6 +114,8 @@ ___
▸ **Executed**(`ReferendumIndex`, `bool`)
▸ **ExternalTabled**()
▸ **NotPassed**(`ReferendumIndex`)
▸ **Passed**(`ReferendumIndex`)
@@ -136,6 +128,8 @@ ___
▸ **Undelegated**(`AccountId`)
▸ **Vetoed**(`AccountId`, `Hash`, `BlockNumber`)
___
docs/METHODS_EXTRINSICS.md
+25 -27
View File
@@ -11,8 +11,6 @@ _The following sections contain Extrinsics methods are part of the default Subst
- **[councilMotions](#councilMotions)**
- **[councilVoting](#councilVoting)**
- **[democracy](#democracy)**
- **[](#)**
@@ -105,7 +103,7 @@ ___
- **summary**: Remove a voter. For it not to be a bond-consuming no-op, all approved candidate indices must now be either unregistered or registered to a candidate that registered the slot after the voter gave their last approval set. May be called by anyone. Returns the voter deposit to `signed`.
▸ **removeMember**(who: `Address`)
- **summary**: Remove a particular member. A tally will happen instantly (if not already in a presentation period) to fill the seat if removal means that the desired members are not met. This is effective immediately.
- **summary**: Remove a particular member from the council. This is effective immediately. Note: A tally should happen instantly (if not already in a presentation period) to fill the seat if removal means that the desired members are not met.
▸ **retractVoter**(index: `Compact<u32>`)
- **summary**: Remove a voter. All votes are cancelled and the voter deposit is returned.
@@ -114,7 +112,7 @@ ___
- **summary**: Set candidate approvals. Approval slots stay valid as long as candidates in those slots are registered.
▸ **setDesiredSeats**(count: `Compact<u32>`)
- **summary**: Set the desired member count; if lower than the current count, then seats will not be up election when they expire. If more, then a new vote will be started if one is not already in progress.
- **summary**: Set the desired member count; if lower than the current count, then seats will not be up election when they expire. If more, then a new vote will be started if one is not already in progress.
▸ **setPresentationDuration**(count: `Compact<BlockNumber>`)
- **summary**: Set the presentation duration. If there is currently a vote being presented for, will invoke `finalize_vote`.
@@ -130,44 +128,44 @@ ___
### councilMotions
▸ **propose**(threshold: `Compact<u32>`, proposal: `Proposal`)
▸ **execute**(proposal: `Proposal`)
- **summary**: Dispatch a proposal from a councilor using the `Member` origin. Origin must be a council member.
▸ **propose**(threshold: `Compact<MemberCount>`, proposal: `Proposal`)
▸ **vote**(proposal: `Hash`, index: `Compact<ProposalIndex>`, approve: `bool`)
___
### councilVoting
▸ **propose**(proposal: `Proposal`)
▸ **setCooloffPeriod**(blocks: `Compact<BlockNumber>`)
▸ **setVotingPeriod**(blocks: `Compact<BlockNumber>`)
▸ **veto**(proposal_hash: `Hash`)
▸ **vote**(proposal: `Hash`, approve: `bool`)
___
### democracy
▸ **cancelQueued**(when: `Compact<BlockNumber>`, which: `Compact<u32>`)
▸ **cancelQueued**(when: `Compact<BlockNumber>`, which: `Compact<u32>`, what: `Compact<ReferendumIndex>`)
- **summary**: Cancel a proposal queued for enactment.
▸ **cancelReferendum**(ref_index: `Compact<ReferendumIndex>`)
- **summary**: Remove a referendum.
▸ **delegate**(to: `AccountId`, lock_periods: `LockPeriods`)
▸ **delegate**(to: `AccountId`, conviction: `Conviction`)
- **summary**: Delegate vote.
▸ **emergencyCancel**(ref_index: `ReferendumIndex`)
- **summary**: Schedule an emergency cancellation of a referendum. Cannot happen twice to the same referendum.
▸ **emergencyPropose**(proposal: `Proposal`, threshold: `VoteThreshold`, voting_period: `BlockNumber`, delay: `BlockNumber`)
- **summary**: Schedule an emergency referendum. This will create a new referendum for the `proposal`, approved as long as counted votes exceed `threshold` and, if approved, enacted after the given `delay`. It may be called from either the Root or the Emergency origin.
▸ **externalPropose**(proposal: `Proposal`)
- **summary**: Schedule a referendum to be tabled once it is legal to schedule an external referendum.
▸ **externalProposeMajority**(proposal: `Proposal`)
- **summary**: Schedule a majority-carries referendum to be tabled next once it is legal to schedule an external referendum.
▸ **propose**(proposal: `Proposal`, value: `Compact<BalanceOf>`)
- **summary**: Propose a sensitive action to be taken.
▸ **proxyVote**(ref_index: `Compact<ReferendumIndex>`, vote: `Vote`)
- **summary**: 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.
- **summary**: 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.
▸ **removeProxy**(proxy: `AccountId`)
- **summary**: Clear the proxy. Called by the stash.
@@ -181,12 +179,12 @@ ___
▸ **setProxy**(proxy: `AccountId`)
- **summary**: Specify a proxy. Called by the stash.
▸ **startReferendum**(proposal: `Proposal`, threshold: `VoteThreshold`, delay: `BlockNumber`)
- **summary**: Start a referendum.
▸ **undelegate**()
- **summary**: Undelegate vote.
▸ **vetoExternal**(proposal_hash: `Hash`)
- **summary**: Veto and blacklist the external proposal hash.
▸ **vote**(ref_index: `Compact<ReferendumIndex>`, vote: `Vote`)
- **summary**: 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.
@@ -262,7 +260,7 @@ ___
- **summary**: The ideal number of validators.
▸ **unbond**(value: `Compact<BalanceOf>`)
- **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`].
- **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. 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`].
▸ **validate**(prefs: `ValidatorPrefs`)
- **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.
docs/METHODS_STORAGE.md
+17 -44
View File
@@ -11,8 +11,6 @@ _The following sections contain Storage methods are part of the default Substrat
- **[councilMotions](#councilMotions)**
- **[councilVoting](#councilVoting)**
- **[democracy](#democracy)**
- **[grandpaFinality](#grandpaFinality)**
@@ -223,39 +221,23 @@ ___
- **summary**: Actual proposal for a given hash, if it's current.
▸ **proposals**(): `Vec<Hash>`
- **summary**: The (hashes of) the active proposals.
- **summary**: The hashes of the active proposals.
▸ **voting**(`Hash`): `Option<(ProposalIndex,u32,Vec<AccountId>,Vec<AccountId>)>`
- **summary**: Votes for a given proposal: (required_yes_votes, yes_voters, no_voters).
___
### councilVoting
▸ **cooloffPeriod**(): `BlockNumber`
▸ **councilVoteOf**(`(Hash,AccountId)`): `Option<bool>`
▸ **enactDelayPeriod**(): `BlockNumber`
- **summary**: Number of blocks by which to delay enactment of successful, non-unanimous-council-instigated referendum proposals.
▸ **proposalOf**(`Hash`): `Option<Proposal>`
▸ **proposals**(): `Vec<(BlockNumber,Hash)>`
▸ **proposalVoters**(`Hash`): `Vec<AccountId>`
▸ **vetoedProposal**(`Hash`): `Option<(BlockNumber,Vec<AccountId>)>`
▸ **votingPeriod**(): `BlockNumber`
▸ **voting**(`Hash`): `Option<Votes>`
- **summary**: Votes on a given proposal, if it is ongoing.
___
### democracy
▸ **delegations**(`AccountId`): `((AccountId,LockPeriods), Linkage<AccountId>)`
▸ **blacklist**(`Hash`): `Option<(BlockNumber,Vec<AccountId>)>`
- **summary**: 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.
▸ **cancellations**(`Hash`): `bool`
- **summary**: Record of all proposals that have been subject to emergency cancellation.
▸ **delegations**(`AccountId`): `((AccountId,Conviction), Linkage<AccountId>)`
- **summary**: Get the account (and lock periods) to which another account is delegating vote.
▸ **depositOf**(`PropIndex`): `Option<(BalanceOf,Vec<AccountId>)>`
@@ -264,23 +246,17 @@ ___
▸ **dispatchQueue**(`BlockNumber`): `Vec<Option<(Proposal,ReferendumIndex)>>`
- **summary**: Queue of successful referenda to be dispatched.
▸ **launchPeriod**(): `BlockNumber`
- **summary**: How often (in blocks) new public referenda are launched.
▸ **lastTabledWasExternal**(): `bool`
- **summary**: True if the last referendum tabled was submitted externally. False if it was a public proposal.
▸ **maxLockPeriods**(): `LockPeriods`
- **summary**: The maximum number of additional lock periods a voter may offer to strengthen their vote. Multiples of `PublicDelay`.
▸ **minimumDeposit**(): `BalanceOf`
- **summary**: The minimum amount to be used as a deposit for a public referendum proposal.
▸ **nextExternal**(): `Option<(Proposal,VoteThreshold)>`
- **summary**: 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.
▸ **nextTally**(): `ReferendumIndex`
- **summary**: The next referendum index that should be tallied.
▸ **proxy**(`AccountId`): `Option<AccountId>`
- **summary**: Who is able to vote for whom. Value is the fund-holding account, key is the vote-transaction-sending account.
▸ **publicDelay**(): `BlockNumber`
- **summary**: The delay before enactment for all public referenda.
- **summary**: Who is able to vote for whom. Value is the fund-holding account, key is the vote-transaction-sending account.
▸ **publicPropCount**(): `PropIndex`
- **summary**: The number of (public) proposals that have been made so far.
@@ -295,14 +271,11 @@ ___
- **summary**: Information concerning any given referendum.
▸ **voteOf**(`(ReferendumIndex,AccountId)`): `Vote`
- **summary**: 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.
- **summary**: 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.
▸ **votersFor**(`ReferendumIndex`): `Vec<AccountId>`
- **summary**: Get the voters for the current proposal.
▸ **votingPeriod**(): `BlockNumber`
- **summary**: How often (in blocks) to check for new votes.
___
@@ -513,7 +486,7 @@ ___
- **summary**: Total funds available to this module for spending.
▸ **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.
- **summary**: 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.
▸ **proposalBondMinimum**(): `BalanceOf`
- **summary**: Minimum amount of funds that should be placed in a deposit for making a proposal.
lerna.json
+1 -1
View File
@@ -9,5 +9,5 @@
"packages": [
"packages/*"
],
"version": "0.80.1"
"version": "0.81.0-beta.0"
}
package.json
+1 -1
View File
@@ -1,5 +1,5 @@
{
"version": "0.80.1",
"version": "0.81.0-beta.0",
"private": true,
"engines": {
"yarn": "^1.10.1"
packages/api-derive/package.json
+3 -3
View File
@@ -1,6 +1,6 @@
{
"name": "@polkadot/api-derive",
"version": "0.80.1",
"version": "0.81.0-beta.0",
"description": "Common functions used across Polkadot, derived from RPC calls and storage queries.",
"main": "index.js",
"keywords": [
@@ -28,9 +28,9 @@
"homepage": "https://github.com/polkadot-js/api/tree/master/packages/api-derive#readme",
"dependencies": {
"@babel/runtime": "^7.4.5",
"@polkadot/api": "^0.80.1",
"@polkadot/api": "^0.81.0-beta.0",
"@polkadot/keyring": "^0.92.1",
"@polkadot/types": "^0.80.1",
"@polkadot/types": "^0.81.0-beta.0",
"@types/memoizee": "^0.4.2",
"memoizee": "^0.4.14"
}
packages/api/package.json
+7 -7
View File
@@ -1,6 +1,6 @@
{
"name": "@polkadot/api",
"version": "0.80.1",
"version": "0.81.0-beta.0",
"description": "Promise and RxJS wrappers around the Polkadot JS RPC",
"main": "index.js",
"keywords": [
@@ -27,12 +27,12 @@
"homepage": "https://github.com/polkadot-js/api/tree/master/packages/api#readme",
"dependencies": {
"@babel/runtime": "^7.4.5",
"@polkadot/api-derive": "^0.80.1",
"@polkadot/extrinsics": "^0.80.1",
"@polkadot/rpc-provider": "^0.80.1",
"@polkadot/rpc-rx": "^0.80.1",
"@polkadot/storage": "^0.80.1",
"@polkadot/types": "^0.80.1",
"@polkadot/api-derive": "^0.81.0-beta.0",
"@polkadot/extrinsics": "^0.81.0-beta.0",
"@polkadot/rpc-provider": "^0.81.0-beta.0",
"@polkadot/rpc-rx": "^0.81.0-beta.0",
"@polkadot/storage": "^0.81.0-beta.0",
"@polkadot/types": "^0.81.0-beta.0",
"@polkadot/util-crypto": "^0.92.1"
},
"devDependencies": {
packages/rpc-core/package.json
+4 -4
View File
@@ -1,6 +1,6 @@
{
"name": "@polkadot/rpc-core",
"version": "0.80.1",
"version": "0.81.0-beta.0",
"description": "A JavaScript wrapper for the Polkadot JsonRPC interface",
"main": "index.js",
"keywords": [
@@ -27,9 +27,9 @@
"homepage": "https://github.com/polkadot-js/api/tree/master/packages/rpc-core#readme",
"dependencies": {
"@babel/runtime": "^7.4.5",
"@polkadot/jsonrpc": "^0.80.1",
"@polkadot/rpc-provider": "^0.80.1",
"@polkadot/types": "^0.80.1",
"@polkadot/jsonrpc": "^0.81.0-beta.0",
"@polkadot/rpc-provider": "^0.81.0-beta.0",
"@polkadot/types": "^0.81.0-beta.0",
"@polkadot/util": "^0.92.1"
}
}
packages/rpc-provider/package.json
+2 -2
View File
@@ -1,6 +1,6 @@
{
"name": "@polkadot/rpc-provider",
"version": "0.80.1",
"version": "0.81.0-beta.0",
"description": "Transport providers for the API",
"main": "index.js",
"keywords": [
@@ -27,7 +27,7 @@
"homepage": "https://github.com/polkadot-js/api/tree/master/packages/rpc-provider#readme",
"dependencies": {
"@babel/runtime": "^7.4.5",
"@polkadot/storage": "^0.80.1",
"@polkadot/storage": "^0.81.0-beta.0",
"@polkadot/util": "^0.92.1",
"@polkadot/util-crypto": "^0.92.1",
"@types/nock": "^10.0.3",
packages/rpc-rx/package.json
+3 -3
View File
@@ -1,6 +1,6 @@
{
"name": "@polkadot/rpc-rx",
"version": "0.80.1",
"version": "0.81.0-beta.0",
"description": "An RxJs wrapper around the Polkadot JS API",
"main": "index.js",
"keywords": [
@@ -27,8 +27,8 @@
"homepage": "https://github.com/polkadot-js/api/tree/master/packages/rpc-rx#readme",
"dependencies": {
"@babel/runtime": "^7.4.5",
"@polkadot/rpc-core": "^0.80.1",
"@polkadot/rpc-provider": "^0.80.1",
"@polkadot/rpc-core": "^0.81.0-beta.0",
"@polkadot/rpc-provider": "^0.81.0-beta.0",
"@types/memoizee": "^0.4.2",
"@types/rx": "^4.1.1",
"memoizee": "^0.4.14",
packages/type-extrinsics/package.json
+2 -2
View File
@@ -1,6 +1,6 @@
{
"name": "@polkadot/extrinsics",
"version": "0.80.1",
"version": "0.81.0-beta.0",
"main": "index.js",
"repository": "https://github.com/polkadot-js/api.git",
"author": "Jaco Greeff <jacogr@gmail.com>",
@@ -11,7 +11,7 @@
"license": "Apache-2.0",
"dependencies": {
"@babel/runtime": "^7.4.5",
"@polkadot/types": "^0.80.1",
"@polkadot/types": "^0.81.0-beta.0",
"@polkadot/util": "^0.92.1"
}
}
packages/type-jsonrpc/package.json
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@polkadot/jsonrpc",
"version": "0.80.1",
"version": "0.81.0-beta.0",
"description": "Method definitions for the Polkadot RPC layer",
"main": "index.js",
"publishConfig": {
packages/type-storage/package.json
+2 -2
View File
@@ -1,6 +1,6 @@
{
"name": "@polkadot/storage",
"version": "0.80.1",
"version": "0.81.0-beta.0",
"description": "Generic wrapper wrapper around state storage",
"main": "index.js",
"publishConfig": {
@@ -27,7 +27,7 @@
"homepage": "https://github.com/polkadot-js/api/tree/master/packages/type-storage#readme",
"dependencies": {
"@babel/runtime": "^7.4.5",
"@polkadot/types": "^0.80.1",
"@polkadot/types": "^0.81.0-beta.0",
"@polkadot/util": "^0.92.1",
"@polkadot/util-crypto": "^0.92.1"
},
packages/types/package.json
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@polkadot/types",
"version": "0.80.1",
"version": "0.81.0-beta.0",
"description": "Implementation of the Parity codec",
"main": "index.js",
"keywords": [