https://github.com/second-state/interest-earner-user-interface
A user interface for the interest earner smart contract
https://github.com/second-state/interest-earner-user-interface
Last synced: 17 days ago
JSON representation
A user interface for the interest earner smart contract
- Host: GitHub
- URL: https://github.com/second-state/interest-earner-user-interface
- Owner: second-state
- License: mit
- Created: 2022-02-19T23:36:47.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-03-21T23:24:52.000Z (over 4 years ago)
- Last Synced: 2025-10-10T02:44:00.967Z (10 months ago)
- Language: JavaScript
- Size: 12.7 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Interest Earner User Interface (UI)
# What does it do?
Interacts with the [interest earner smart contract](https://github.com/second-state/interest-earner-smart-contract), which allows users to stake and unstake tokens.
# How do end users interact with the interest earner UI
Users simply load the page, (the user's account details are automatically pre-filled in the address input box)
## Staking tokens
The user then simply types in the amount of tokens they would like to stake
The user then clicks the "Stake Tokens" button
## Unstaking tokens
The user clicks the "Unstake Tokens" button
# Where is the interest earner smart contract
The [interest earner smart contract](https://github.com/second-state/interest-earner-smart-contract) is deployed on the Ethereum mainnet and then this UI source code is updated with the interest earner contract's ABI, deployment address and so forth. This interest earner UI instantiates the staking contract in order to interact and transfer tokens to end users and so forth.
# How to deploy this UI
Clone this repository
```
git clone git@github.com:second-state/interest-earner-user-interface.git
```
## ABI and address of interest earner contract
Paste the ABI into the `interest_earner_abi.json` file and the address of the interest earner contract's successfully deployed contract instance into the `interest_earner_contract_address.json` file.
## Contract address of ERC20 contract (NOT staking contract)
Paste the ABI into the `erc20_abi.json` file and the address of the ERC20's successfully deployed contract instance into the `erc20_contract_address.json` file.
## Installing
Then simply type
```
npm install
```
## Running
### Run on local
To run on local system, type
```
node server.js
```
The site will then be hosted at `http://localhost/`
### GitHub pages
To publish/deploy on GitHub pages, simply type
```
npm run deploy
```
The site will then be hosted to [https://second-state.github.io/interest-earner-user-interface/html/index.html](https://second-state.github.io/interest-earner-user-interface/html/index.html)
## Usage
Just browse to the URL where the UI is hosted and ensure that your MetaMask wallet is configured to run on the same network (where the contracts are deployed). Default is Ethereum mainnet.
