Cleansatmining-simulator NPM

cleansatmining-simulator

The simulator is a standalone React component to simulate Bitcoin mining profitability.

simulator

Installation

In order to use the simulator in your app you only have to add it as a dependency :

yarn add cleansatmining-simulator

How to use

Import the simulator in your React component :

import { Simulator } from 'cleansatmining-simulator';

export MyComponent = () => {
  return (
    <>
      <h1>My Simulator</h1>
      <Simulator productData={productData} />
    </>
  )
};

Simulator properties

The simulator requires a SimulationProductData object as props, this object has the following attributes :

Property	Type	Description
`networkExaHashrate`	`number`	Network computing power
`bitcoinValueForSimulation`	`number`	Bitcoin value for simulation in $, simulator is initialized with this BTC value
`minInvestmentAmount`	`number`	Min investment amount in $
`maxInvestmentAmount`	`number`	Max investment amount in $
`networkTransactionFees`	`number`	Network Transaction Fees (e.g. 0.015 for 1.5%)
`asicsHashrate`	`number`	ASICS Hashrate
`asicsPower`	`number`	ASICS Power
`electricityPriceKwh`	`number`	Electricity cost per kWh in $
`containerUnitNumber`	`number`	Container unit number, not required. To be filled only if
		`asicsHashrate` and `asicsPower` must be multiplied by the number of units.
`simulatorSiteUptime`	`number`	Simulator site uptime (e.g. 0.9 for 90%)
`operatorFeesRate`	`number`	Operator fees rate (e.g. 0.15 for 15%)
`csmFeesRate`	`number`	CSM fees rate (e.g. 0.1 for 10%)
`csmOperationalFeesRate`	`number`	CSM operational fees rate (e.g. 0.05 for 5%)
`poolFees`	`number`	Pool fees (e.g. 0.01 for 1%)
`isRate`	`number`	IS rate (e.g. 0.1357 for 13.57%)
`provisionRate`	`number`	Provision rate (e.g. 0.2 for 20%)
`asics`	`number`	ASICS
`vat`	`number`	VAT in $
`miscellaneousEquipment`	`number`	Miscellaneous equipment in $
`totalInvestment`	`number`	Total investment in $

The simulator may take an initial invested amount as a prop, which is a number. If not provided, the default value will be SimulationProductData.

Required dependencies in your project

The simulator uses Poppins, a sans-serif font from Google Fonts. A link to the font must be added in the HTML file :

<html>
  <head>
    ...
    <link rel="preconnect" href="https://fonts.googleapis.com" />
    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
    <link
      href="https://fonts.googleapis.com/css2?family=Poppins:ital,wght@0,100;0,200;0,300;0,400;0,500;0,600;0,700;0,800;0,900;1,100;1,200;1,300;1,400;1,500;1,600;1,700;1,800;1,900&display=swap"
      rel="stylesheet"
    />
    ...
  </head>
  ...
</html>