Updated on August 6, 2020

Onchain permissioning

Onchain permissioning uses smart contracts to store and administer the node, account, and admin allowlists. Using onchain permissioning enables all nodes to read the allowlists from a single source, the blockchain.

Note

The permissioning smart contracts and Permissioning Management Dapp are a separate product to Hyperledger Besu, located in the PegaSysEng/permissioning-smart-contracts repository.

Custom smart contracts and dapps can be implemented to work with onchain permissioning.

Permissioning contracts

The permissioning smart contracts provided in the PegaSysEng/permissioning-smart-contracts repository are:

  • Ingress contracts for nodes and accounts - proxy contracts defined in the genesis file to defer the permissioning logic to the Node Rules and Account Rules contracts. The Ingress contracts deploy to static addresses.
  • Node Rules - stores the node allowlist and node allowlist operations (for example, add and remove).
  • Account Rules - stores the accounts allowlist and account allowlist operations (for example, add and remove).
  • Admin - stores the list of admin accounts and admin list operations (for example, add and remove). There is one list of admin accounts for node and accounts.

Permissioning management Dapp

The Permissioning Management Dapp provides view and maintain access to the allowlists.

Tip

Before v1.2, the management interface used Truffle, now deprecated. For an improved user experience, use the Dapp.

Allowlists

Permissioning implements three allowlists:

  • Accounts, which can submit transactions to the network.
  • Nodes, which can join the network.
  • Admins, which are accounts able to update the accounts and nodes allowlists.

Using account permissioning and privacy

Account permissioning is incompatible with random key signing for privacy marker transactions.

If using account permissioning and privacy, a signing key must be specified using the [--privacy-marker-transaction-signing-key-file] command line option and the signing key included in the accounts allowlist.

Bootnodes

When a node joins the network, the node connects to the bootnodes until it synchronizes to the chain head, regardless of node permissions. After synchronization, the Account Rules and Node Rules smart contracts apply the permissioning rules.

If a synchronized node loses all peer connections (that is, it has zero peers), it reconnects to the bootnodes to rediscover peers.

Important

All bootnodes must be on the nodes allowlist.