Clique module

clique.discard

This method drops a currently running proposal. The signer will not cast further votes (either for or against) the address.
Invocation
clique.discard(signer)
Parameter
Type
Description
signer
Address
Returned type
Description
Boolean
Example request of clique.discard
clique.discard(signer)

clique.getBlockSigner

Retrieves the signer of the block with the given hash. Returns error of a block with the given hash does not exist.
Invocation
clique.getBlockSigner(hash)
Parameter
Type
Description
hash
Hash
Returned type
Description
Address
Example request of clique.getBlockSigner
clique.getBlockSigner(hash)

clique.getSigners

Retrieves the list of authorized signers.
Invocation
clique.getSigners()
Returned type
Description
Address
Example request of clique.getSigners
clique.getSigners()

clique.getSignersAnnotated

Retrieves the list of authorized signers but with signer names instead of addresses
Invocation
clique.getSignersAnnotated()
Returned type
Description
String
Example request of clique.getSignersAnnotated
clique.getSignersAnnotated()

clique.getSignersAtHash

Retrieves the list of authorized signers at the specified block by hash.
Invocation
clique.getSignersAtHash(hash)
Parameter
Type
Description
hash
Hash
Returned type
Description
Address
Example request of clique.getSignersAtHash
clique.getSignersAtHash(hash)

clique.getSignersAtHashAnnotated

Retrieves the list of authorized signers at the specified block by hash but with signer names instead of addresses
Invocation
clique.getSignersAtHashAnnotated(hash)
Parameter
Type
Description
hash
Hash
Returned type
Description
String
Example request of clique.getSignersAtHashAnnotated
clique.getSignersAtHashAnnotated(hash)

clique.getSignersAtNumber

Retrieves the list of authorized signers at the specified block by block number.
Invocation
clique.getSignersAtNumber(number)
Parameter
Type
Description
number
Quantity
Returned type
Description
Address
Example request of clique.getSignersAtNumber
clique.getSignersAtNumber(number)

clique.getSnapshot

Retrieves a snapshot of all clique state at a given block.
Invocation
clique.getSnapshot()
Returned type
Description
Snapshot object
Example request of clique.getSnapshot
Objects in clique_getSnapshot
clique.getSnapshot()
Snapshot
Field name
Type
Number
Quantity
Hash
Hash
Signers
Array
SignerLimit
Quantity

clique.getSnapshotAtHash

Retrieves the state snapshot at a given block.
Invocation
clique.getSnapshotAtHash(hash)
Parameter
Type
Description
hash
Hash
Returned type
Description
Snapshot object
Example request of clique.getSnapshotAtHash
Objects in clique_getSnapshotAtHash
clique.getSnapshotAtHash(hash)
Snapshot
Field name
Type
Number
Quantity
Hash
Hash
Signers
Array
SignerLimit
Quantity

clique.produceBlock

Forces Clique block producer to produce a new block
Invocation
clique.produceBlock(parentHash)
Parameter
Type
Description
parentHash
Hash
Returned type
Description
Boolean
Example request of clique.produceBlock
clique.produceBlock(parentHash)

clique.propose

Adds a new authorization proposal that the signer will attempt to push through. If the vote parameter is true, the local signer votes for the given address to be included in the set of authorized signers. With vote set to false, the signer is against the address.
Invocation
clique.propose(signer, vote)
Parameter
Type
Description
signer
Address
vote
Boolean
Returned type
Description
Boolean
Example request of clique.propose
clique.propose(signer, vote)
Copy link
On this page
clique.discard
clique.getBlockSigner
clique.getSigners
clique.getSignersAnnotated
clique.getSignersAtHash
clique.getSignersAtHashAnnotated
clique.getSignersAtNumber
clique.getSnapshot
clique.getSnapshotAtHash
clique.produceBlock
clique.propose