https://github.com/masaun/mstable-as-yield-source
mStable's mAsset (mUSD) as a yield source for PoolTogether🎫 🎟
https://github.com/masaun/mstable-as-yield-source
mstable pooltogether solidity truffle web3js
Last synced: 7 months ago
JSON representation
mStable's mAsset (mUSD) as a yield source for PoolTogether🎫 🎟
- Host: GitHub
- URL: https://github.com/masaun/mstable-as-yield-source
- Owner: masaun
- Created: 2021-03-20T00:38:43.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-04-01T13:49:16.000Z (about 5 years ago)
- Last Synced: 2025-02-02T10:43:12.219Z (over 1 year ago)
- Topics: mstable, pooltogether, solidity, truffle, web3js
- Language: Solidity
- Homepage:
- Size: 850 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# mStable's mAsset (mUSD) as a yield source for PoolTogether🎫 🎟
***
## 【Introduction of the mStable's mAsset (mUSD) as a yield source for PoolTogether🎫 🎟】
- This is a smart contract that mStable's mAsset (mUSD) as a yield source for PoolTogether.
***
## 【Workflow】
- Diagram of workflow
***
## 【Remarks】
- Version for following the `PoolTogether` smart contract
- Solidity (Solc): v0.6.12
- Truffle: v5.1.60
- web3.js: v1.2.9
- openzeppelin-solidity: v3.2.0
- ganache-cli: v6.9.1 (ganache-core: 2.10.2)
***
## 【Setup】
### ① Install modules
- Install npm modules in the root directory
```
$ npm install
```
### ② Compile & migrate contracts (on local)
```
$ npm run migrate:local
```
### ③ Test (Mainnet-fork approach)
- 1: Start ganache-cli with mainnet-fork
```
$ ganache-cli -d --fork https://mainnet.infura.io/v3/{YOUR INFURA KEY}@{BLOCK_NUMBER}
```
(※ `-d` option is the option in order to be able to use same address on Ganache-CLI every time)
- 2: Execute test of the smart-contracts (on the local)
- Test for the MStableYieldSource contract
`$ npm run test:MStableYieldSource`
($ truffle test ./test/test-local/MStableYieldSource.test.js)
***
## 【References】
- PoolTogether
- Doc: https://docs.pooltogether.com/protocol/prize-strategy
- Workshop: https://www.youtube.com/watch?v=sTsMt0zdOHY
- GR9 Prize：https://github.com/pooltogether/Gitcoin_Grants_Round_9_Bounties
- mStable
- Doc：https://docs.mstable.org/developers/introduction
- idea：https://docs.mstable.org/developers/introduction#bb4f
- Saving：https://docs.mstable.org/mstable-assets/massets/native-interest-rate
- Live dApp (Ropsten, Kovan)：https://docs.mstable.org/developers/introduction#live-apps
- Deployed-addresses on Mainnet
- PoolTogether：https://docs.pooltogether.com/networks/ethereum#builders
- mStable：https://docs.mstable.org/developers/deployed-addresses
- GR9 Prize in Gitcoin
https://gitcoin.co/issue/pooltogether/Gitcoin_Grants_Round_9_Bounties/1/100025059