mirror of
https://github.com/Instadapp/InstaContract.git
synced 2024-07-29 22:47:45 +00:00
68 lines
3.3 KiB
Markdown
68 lines
3.3 KiB
Markdown
|
# Moat Contract
|
||
|
|
|
||
|
|
[](https://github.com/MoatNetwork/MoatContract/blob/master/LICENSE)
|
||
|
|
[](https://travis-ci.org/MoatNetwork/MoatContract)
|
||
|
|
[](https://coveralls.io/github/MoatNetwork/MoatContract?branch=master)
|
||
|
|
[](https://circleci.com/gh/MoatNetwork/MoatContract)
|
||
|
|
|
||
|
|
> Smart Contracts powering Moat Fund
|
||
|
|
|
||
|
|
### Show some :heart:
|
||
|
|
[](https://github.com/MoatNetwork/MoatContract) [](https://github.com/MoatNetwork/MoatContract/fork) [](https://github.com/MoatNetwork/MoatContract) [](https://github.com/MoatNetwork/MoatContract)
|
||
|
|
|
||
|
|
## This project uses:
|
||
|
|
- [Truffle v5](https://truffleframework.com/)
|
||
|
|
- [Ganache](https://truffleframework.com/ganache)
|
||
|
|
- [Solium](https://github.com/duaraghav8/Solium)
|
||
|
|
- [OpenZeppelin](https://github.com/OpenZeppelin/openzeppelin-solidity)
|
||
|
|
- [Travis CI](https://travis-ci.org/MoatNetwork/MoatContract) and [Circle CI](https://circleci.com/gh/MoatNetwork/MoatContract)
|
||
|
|
- [Coveralls](https://coveralls.io/github/MoatNetwork/MoatContract?branch=master)
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
1. Install Truffle and Ganache CLI globally.
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
npm install -g truffle@beta
|
||
|
|
npm install -g ganache-cli
|
||
|
|
```
|
||
|
|
|
||
|
|
2. Create a `.env` file in the root directory and add your private key.
|
||
|
|
|
||
|
|
## Commands:
|
||
|
|
|
||
|
|
```
|
||
|
|
Compile contracts: truffle compile
|
||
|
|
Migrate contracts: truffle migrate
|
||
|
|
Test contracts: truffle test
|
||
|
|
Run eslint: npm run lint
|
||
|
|
Run solium: npm run solium
|
||
|
|
Run solidity-coverage: npm run coverage
|
||
|
|
Run lint, solium, and truffle test: npm run test
|
||
|
|
```
|
||
|
|
|
||
|
|
## License
|
||
|
|
```
|
||
|
|
MIT License
|
||
|
|
|
||
|
|
Copyright (c) 2018 Moat Network
|
||
|
|
|
||
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||
|
|
of this software and associated documentation files (the "Software"), to deal
|
||
|
|
in the Software without restriction, including without limitation the rights
|
||
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||
|
|
copies of the Software, and to permit persons to whom the Software is
|
||
|
|
furnished to do so, subject to the following conditions:
|
||
|
|
|
||
|
|
The above copyright notice and this permission notice shall be included in all
|
||
|
|
copies or substantial portions of the Software.
|
||
|
|
|
||
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||
|
|
SOFTWARE.
|
||
|
|
```
|