clique namespace

clique_discard

This method drops a currently running proposal. The signer will not cast further votes (either for or against) the address.

Parameters

1. signer: string (address)

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "clique_discard",
      "params": [signer]
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: boolean

clique_getBlockSigner

Retrieves the signer of the block with the given hash. Returns error of a block with the given hash does not exist.

Parameters

1. hash: string (hash)

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "clique_getBlockSigner",
      "params": [hash]
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: string (address)

clique_getSigners

Retrieves the list of authorized signers.

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "clique_getSigners",
      "params": []
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: array of string (address)

clique_getSignersAnnotated

Retrieves the list of authorized signers but with signer names instead of addresses

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "clique_getSignersAnnotated",
      "params": []
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: array of string

clique_getSignersAtHash

Retrieves the list of authorized signers at the specified block by hash.

Parameters

1. hash: string (hash)

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "clique_getSignersAtHash",
      "params": [hash]
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: array of string (address)

clique_getSignersAtHashAnnotated

Retrieves the list of authorized signers at the specified block by hash but with signer names instead of addresses

Parameters

1. hash: string (hash)

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "clique_getSignersAtHashAnnotated",
      "params": [hash]
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: array of string

clique_getSignersAtNumber

Retrieves the list of authorized signers at the specified block by block number.

Parameters

1. number: string (hex integer)

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "clique_getSignersAtNumber",
      "params": [number]
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: array of string (address)

clique_getSnapshot

Retrieves a snapshot of all clique state at a given block.

Parameters

1. number: string (hex integer)

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "clique_getSnapshot",
      "params": [number]
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: object

• hash: string (hash)
• number: string (hex integer)
• signerLimit: string (hex integer)
• signers: map of string (hex integer)
• tally: map of object
  • authorize: boolean
  • votes: string (hex integer)
• votes: array of object
  • address: string (address)
  • authorize: boolean
  • block: string (hex integer)
  • signer: string (address)

clique_getSnapshotAtHash

Retrieves the state snapshot at a given block.

Parameters

1. hash: string (hash)

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "clique_getSnapshotAtHash",
      "params": [hash]
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: object

• hash: string (hash)
• number: string (hex integer)
• signerLimit: string (hex integer)
• signers: map of string (hex integer)
• tally: map of object
  • authorize: boolean
  • votes: string (hex integer)
• votes: array of object
  • address: string (address)
  • authorize: boolean
  • block: string (hex integer)
  • signer: string (address)

clique_produceBlock

Forces Clique block producer to produce a new block

Parameters

1. parentHash: string (hash)

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "clique_produceBlock",
      "params": [parentHash]
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: boolean

clique_proposals

Retrieves the current proposals the node is voting on.

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "clique_proposals",
      "params": []
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: array of boolean

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.

Parameters

1. signer: string (address)

2. vote: boolean

Request

curl localhost:8545 \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "jsonrpc": "2.0",
      "id": 0,
      "method": "clique_propose",
      "params": [signer, vote]
    }'

Response

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": result
}

result: boolean