https://github.com/glistenstar/etoken
https://github.com/glistenstar/etoken
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/glistenstar/etoken
- Owner: GlistenSTAR
- License: mit
- Created: 2021-06-23T17:59:26.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-04-22T18:00:17.000Z (about 2 years ago)
- Last Synced: 2025-01-26T03:28:13.453Z (4 months ago)
- Language: JavaScript
- Size: 773 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# eToken - an [eToro](https://www.etoro.com/) stablecoin
[](https://circleci.com/gh/etoroxlabs/eToken) [](https://coveralls.io/github/etoroxlabs/eToken)
eToken is stablecoin implementation by [eToro](https://www.etoro.com/) targeting the [Ethereum](https://www.ethereum.org/) platform.
## USAGE
To test the library and setup the development environment, issue the following commands in a shell:
```shell
yarn install
yarn test # compile and test
```
### Prerequisites
You need to have [`yarn`](https://yarnpkg.com/) and [`node`](https://nodejs.org/) installed.
This repository has only been tested on UNIX-derived systems.
## Design overview
See [separate document](docs/design_overview.md).
## FILES
Path | Description
------------- | -------------
`contracts/` | All the solidity files making up the implementation
`contracts/token` | Contains the eToken implementation
`contracts/token/ERC20` | ERC20 implementation using an external storage
`contracts/roles` | Defines the roles implementation, i.e. whitelisting, blacklisting, miners etc.
`contracts/lifecycle` | Implements lifecycle behaviors. Taken from OpenZeppelin
`contracts/mocks` | Contracts used specifically for testing purposes
`test/` | Contains testing code in JavaScript
`scripts/` | Specific scripts for testing, coverage & upgrading tokens