Giter Club home page Giter Club logo

creditcoin3-staking-dashboard's Introduction

Creditcoin Staking Dashboard

ci License

Production URL: https://staking.creditcoin.org

Validator Operator Setup Guide

Validator operators can add their contact information, icon, and which validators they operate, to the dashboard’s Community section. The Community feature is designed to give non-biased exposure to validator operators, and to host a fully-featured validator browser just for that operator's validators.

To add an operator, submit a PR with the following changes:

  • Thumbnail: Add your operator's thumbnail as an SVG Component in this folder.
  • Operator details: Add your operator details to the VALIDATORS_COMMUNITYJSON object in this file.

Operator Structure

The following table outlines the structure of a ValidatorCommunity entry:

Element Key Required Notes Example
Operator Name name Yes The chosen name of the operator. Validator Central
Thumbnail Name thumbnail Yes The name of your SVG component representing your thumbnail. See Below
Bio bio No A short description of your entity. Maximum 300 characters. Summing up my validator identity in a sentence or so.
Email Address email No A public email address representing the operator. [email protected]
Twitter Handle twitter No The Twitter handle representing the operator. @ParityTech
Website URL website No A live and vlid secure URL to your website. https://parity.io
Validator List validators Yes A list of validators grouped by network. At least 1 validator in 1 network must be defined. See Below

Example Operator

Upload your SVG icon as a React component. Look at the existing icons as examples, or use the SVGR Playground to convert your raw SVG file into a component.

Next, add your operator details to the ValidatorCommunity object. Only provide the validator(s) for the particular network(s) you are operating in.

The following example defines 2 validators on the Creditcoin Mainnet, and 1 on the Creditcoin Testnet:

export const ValidatorCommunity = [
  ...
  {
    name: 'Validator Central',
    thumbnail: 'ValidatorCentral',
    bio: 'Summing up my validator identity in a sentence or so. Maximum 300 characters.',
    email: '[email protected]',
    twitter: '@ParityTech',
    website: 'https://parity.io',
    validators: {
      creditcoin: [
      '1hYiMW8KSfUYChzCQSPGXvMSyKVqmyvMXqohjKr3oU5PCXF',
      '14QSBoJMHF2Zn2XEoLNSeWgqBRr8XoKPy4BxToD6yLSeFFYe'
      ],
      creditcoinTest: ['FykhnPA3pn269LAcQ8VQKDgUQ8ieAaSLwJDhAVhu3dcokVR'],
    },
  },
  ...
];

General Requirements

Requirement Notes
Accuracy Operator contact details must be working and valid.
Liveness All submitted validator addresses must be discoverable as a validator on the network in question - whether Mainnet or Testnet.
Ordering Please place your operator in alphabetical order within ValidatorCommunity. Operators are shuffled before being displayed in the dashboard, removing any bias associated with ordering methods.

Please submit an issue for any queries around adding your operator details.

creditcoin3-staking-dashboard's People

Contributors

rossbulat avatar dependabot[bot] avatar tingalin avatar mergify[bot] avatar wirednkod avatar hamidra avatar atodorov avatar frankli-dev avatar nbass3 avatar nathanwhit avatar rmnprkrl avatar stakeworld avatar adajane avatar nexus2k avatar rosee-xo avatar sanggon-kim avatar pre-commit-ci[bot] avatar dev-eunjeong avatar sekoya-labs avatar ddozen avatar bld75 avatar stepanlav avatar shawntabrizi avatar rvalle avatar pmensik avatar josepot avatar derfredy avatar tugytur avatar roileo avatar paulormart avatar

Stargazers

WoosungChoi avatar

Watchers

 avatar Zach Frederick avatar Jonathan Lafleur avatar Scott Hasbrouck avatar WoosungChoi avatar Hyun avatar Timur Abasov avatar  avatar pablito テ avatar Jon Zlotnik avatar Dylan Verstraete avatar  avatar  avatar mangozila avatar

Forkers

atodorov

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.