Configure a browser for viewing the private deployment

The browser is the main monitoring tool for the blockchain.

Browser Backend

The configuration of the backend is defined in the relative path /conf/server.json.

port server port
database hibernate configuration
- persistenceUnitName persistence unit name for hibernate configuration
- driver database driver class
- url url to database file or server
- user database login user
- password database login password
shards list of shards on the blockchain, excluding null for governance
nodes list of URLs to nodes on the blockchain
addresses contract addresses used by the system
- blockProducerOrchestration Block Producer Orchestration Contract
- zkNodeRegistry ZkNode Registry Contract
- largeOracle irrelevant for private deployment
- mpcToken irrelevant for private deployment
blocksBehindThreshold amount of blocks we allow to be behind reader node, before we consider the system malfunctioning
disableBlockProducerOrchestration true if, we should avoid talking to the block producer orchestration contract
disableAccountPluginTraversal if true, we should avoid traversing account plugin

Click here to view: Browser backend - Example configuration

{
  "port": 8000,
  "database": {
    "persistenceUnitName": "model",
    "driver": "org.postgresql.Driver",
    "url": "jdbc:postgresql://postgres.domain.com:5432/browser",
    "user": "postgres",
    "password": "postgres"
  },
  "shards": [
    "ShardName1",
    "ShardName2"
  ],
  "nodes": [
    "https://node1.domain.com",
    "https://node2.domain.com",
    "https://node3.domain.com"
  ],
  "addresses": {
    "blockProducerOrchestration": "02860476afca938873ff2549b6549e235a459bcede",
    "zkNodeRegistry": "02038873ff2549b6549e2038873ff2549b6549e243",
    "largeOracle": "000000000000000000000000000000000000000000",
    "mpcToken": "000000000000000000000000000000000000000000"
  },
  "blocksBehindThreshold": 20,
  "disableBlockProducerOrchestration": true,
  "disableAccountPluginTraversal": true,
}

Browser Frontend

The configuration of the frontend is defined in the relative path /conf/config.js. Along with this file, 3 image files are needed. /conf/fav.svg, /conf/fav_large.svg and /conf/logo.svg.

serverUrl url of the browser backend
blockchainUrl url of a reader node for the blockchain
blockchainShards list of shards on the blockchain, excluding null for governance
blockTimeWarningThreshold amount of blocks we allow to be behind reader node, before we consider the system malfunctioning
features set of enabled features
addresses contract addresses used by the system
- blockProducerOrchestration Block Producer Orchestration Contract
- zkNodeRegistry ZkNode Registry Contract
- deployPublic Deploy contract for normal contracts
- deployReal Deploy contract for ZK contracts
addressNames pre-named addresses in the system
palette color palette for the browser

Click here to view: Browser Frontend - Example configuration

// noinspection ES6ConvertVarToLetConst
// eslint-disable-next-line
var CONFIG = {
  serverUrl: "https://backend.domain.com",
  blockchainUrl: "https://reader.domain.com",
  blockchainShards: ["ShardName1", "ShardName2"],
  blockTimeWarningThreshold: 20,
  features: [
    "loginPrivateKey",
    "transactionPage",
    "blockPage",
    "accountPage",
    "contractPage",
    "contractPageDeployment",
    "contractPageInteraction",
  ],
  addresses: {
    blockProducerOrchestration: "01860476afca938873ff2549b6549e235a459bcede",
    zkNodeRegistry: "01a2020bb33e873ff2549b6549e23b7fd492aa0d65",
    deployPublic: "0197a340e23873ff2549b6549e23444e46308f9a4d",
    deployReal: "018bc1ccb5995a5978d5798c579d579a95785798e5d5",
  },
  addressNames: {
    "02860476afca938873ff2549b6549e235a459bcede": "Block producer orchestration",
  },
  palette: {
    primary: {
      main: "#0C194A",
      contrastText: "#FFFFFF",
    },
    secondary: {
      main: "#315DF8",
      contrastText: "#FFFFFF",
    },
    tertiary: {
      main: "#9E8FE3",
      contrastText: "#121212",
    },
    info: {
      main: "#315DF8",
      contrastText: "#FFFFFF",
    },
    error: {
      main: "#F75D31",
      contrastText: "#121212",
    },
    warning: {
      main: "#F57C00",
      contrastText: "#121212",
    },
    success: {
      main: "#43A047",
      contrastText: "#121212",
    },
    text: {
      primary: "#121212",
    },
    background: {
      default: "#FFFFFF",
    },
  },
};