Clique module
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)
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)
Retrieves the list of authorized signers.
Invocation |
|---|
clique.getSigners() |
Returned type | Description |
|---|---|
Address | |
Example request of clique.getSigners
clique.getSigners()
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()
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)
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)
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)
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()
SnapshotField name | Type |
|---|---|
Number | Quantity |
Hash | Hash |
Signers | Array |
SignerLimit | Quantity |
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)
SnapshotField name | Type |
|---|---|
Number | Quantity |
Hash | Hash |
Signers | Array |
SignerLimit | Quantity |
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)
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)
Last modified 1yr ago