See the front end hosted on github This will connect to an instance of Ganache running on localhost at port 8545.
You can also see the front end via IPFS. To connect to the IPFS version ganache must be running on port 7545
Table of Contents:
In the near future, it is expected that Ethereum will move to a Proof of Stake model. The details are uncertain as to how the process will work. This staking pool contract is designed to be quickly adapted and launched when the time is right. It may also serve as a basis for token staking contract such as OMG which is expected to launch a second layer network on top of ethereum.
The StakePool contract is designed to be a framework for staking ether as a group. Since details are few at this time, I have created a dummy contract that will act as the staking contract. The staking pool contract will manage users deposits and distribution of profits.
There is also a mock StakeContract designed to simulate the operation of the staking mechanism. This is not meant to be functional except for testing the StakePool contract.
[x] User must be able to deposit ether
[x] User must be able to stake deposited ether
[x] User must be able to UN-stake ether
[x] User must be able to withdraw unstaked ether
[x] User must be able to see deposited ether balance on GUI
[x] User must be able to see staked ether as separate value on GUI
[x] User profits will accumulate in staked ether balance
[x] Owner must be able to set the address of the staking contract.
[x] Owner must be able to collect a fee for running the staking pool.
[x] Owner must NOT be able to remove more ether than fee.
[x] Owner must be able to trigger a profit distribution.
[x] Must be able to receive funds from staking pool
[x] Must track users deposits by address
[x] Must track users staked deposits by address
[x] Must calculate profit share for each user
In actual practice the staking period will be set at 24 hours to start. In this code the staking period is set at 12 seconds for demo purposes. In addition, to simulate staking earnings, a server process is setup to deposit 0.01 ether into the mock staking contract. These deposits are taken as the income to be distributed to all the users participating in the pool.
Owner fee shall be 1% User Profit will be 99% of profits received times the user’s percentage of the total pool.
Every stake/unstake operation will modify the total staked value such that contract always maintains correct balance for the total staked balance.
In production, the owner will trigger profit distribution on a daily basis.
git clone https://github.com/AntoniosHadji/ethereum-staking-smart-contract.gitnpm run migrate to execute the migration script. In addition to running truffle migrate, this script will copy the smart contract JSON to the src directory where the front end is expecting it.npm run server to start the development server.http://localhost:8000 to see the application.In this test setup, the application is running both the client side code and server side code in the browser. In production, the server side code would be run from a server controlled by the pool owner, while the client side code can be run from any service that supports html/javascript web apps.
Automated tests can be run with npm test command.
File ./test/full-workflow.js runs the contract through the full application lifecycle.
The overall goal in writing these tests was to test each smart contract function in the context in which the front end Dapp will be interacting with the smart contract. These tests are specifically designed to test the smart contract. Not the front end code. For a production application, tests would be conducted using the front end code in addition to web3 direct manipulation.