Skip to content

Latest commit

 

History

History
83 lines (58 loc) · 3.33 KB

README.md

File metadata and controls

83 lines (58 loc) · 3.33 KB

YieldScan

Scanning yield on nominated proof-of-stake networks. Starting with Kusama.

Table of contents

Currently supported networks

Description

We aim to solve the problems of information asymmetry and lack of transparency that are faced by the Polkadot community in identifying returns on staking, which incurs time and capital costs to nominators in taking staking decisions.

This project is funded and supported by the Web3 Foundation - under Wave 6.

Usage

Pre-requisites

  • PolkadotJS browser extension
  • At least one account on Kusama with enough balance to pay for transaction fees and bond funds.

Currently, the app can be used on https://yieldscan.onrender.com/.

⚠️ IMPORTANT: Please note that this project is still under development and bugs and issues are to be expected.

Borrowing from Kusama's tagline - "Expect Chaos"

The project is broadly divided into 2 sections - Network details and Returns Calculator.

Network Details

The network details section of the app contains collated information about validators and nominators. For details, view the Network Details Overview Wiki

Network Details - Nominators

Network Details - Validators

Returns Calculator

The returns calculator allows users to see their potential daily earnings by entering their budget and selecting their risk preference and reduces cognitive load involved with staking. For details on how to use the calculator UI, view Returns Calculator Wiki

Returns Calculator

Development

Pre-requisites

Installation Instructions

  1. Clone into the repository
git clone https://github.com/buidl-labs/YieldScan.git
cd YieldScan
  1. Install dependencies
yarn install
  1. Start the development server
yarn start

Dependencies

This project relies on polkadot-chains-indexer for it's backend.

Gratitude