https://github.com/autonomoussoftware/metronome
Metronome autonomous system
https://github.com/autonomoussoftware/metronome
Last synced: 7 months ago
JSON representation
Metronome autonomous system
- Host: GitHub
- URL: https://github.com/autonomoussoftware/metronome
- Owner: autonomoussoftware
- License: mit
- Created: 2018-02-24T06:11:52.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-08-24T00:04:10.000Z (over 3 years ago)
- Last Synced: 2025-04-22T12:59:09.539Z (10 months ago)
- Language: JavaScript
- Homepage:
- Size: 10.9 MB
- Stars: 15
- Watchers: 9
- Forks: 10
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Ⓜ️ Metronome Token Contracts as described in the [Metronome User's Manual](https://www.metronome.io/pdf/owners_manual.pdf)
## Index
1. [Requirements](#requirements)
1. [Getting Started](#getting-started)
1. [Installation](#installation)
1. [Test Suite](#test-suite)
1. [License](#license)
## Requirements
You will need a MacOS or Linux system.
- Install the latest version of `parity`.
- Install the latest version of `solc`.
- Install the latest version of `npm`.
Local development is worked against TestRPC (which will be installed via `npm`). Parity is used to test against a local dev-chain (see `parity-spec.json`) and can also be used to test agains Ropsten TestNet or the Public MainNet.
## Getting Started
### Production Environment
* **Explorer URL**: https://explorer.metronome.io
* **Auction Board URL**: https://metronome.io
### Production Contracts
**Version**: autonomoussoftware/metronome#35a6cd3
**Ethereum Contract addresses**
Contract | Address | Description
--- | --- | ---
Auctions | 0x9d9BcDd249E439AAaB545F59a33812E39A8e3072 | Use for purchasing newly minted MET
Proceeds | 0x68c4b7d05fAE45bCb6192bb93e246C77E98360e1 | Stores all auction proceeds
AutonomousConverter | 0x686e5ac50D9236A9b7406791256e47feDDB26AbA | Use for exchanging MET/ETH after initial auction is over
METToken | 0xa3d58c4E56fedCae3a7c43A725aeE9A71F0ece4e | Use this address for MET ERC20 functions and third-party wallets
**Ethereum Classic Contracts**
Contract | Address | Description
--- | --- | ---
Auctions | 0xF5269Caa54F1f776dD996Db35992D599e14d8a3B | Use for purchasing newly minted MET
Proceeds | 0x09ACED531359ceFfAD9759a9252E1D82E3557Eb2 | Stores all auction proceeds
AutonomousConverter | 0x567EEBB6397cC8345e5A7eAE288994bf45FDF85B | Use for exchanging MET/ETC after initial auction is over
METToken | 0xA4d3A7b00056Cc5D8206b3b2983bfe0C107D90da | Use this address for MET ERC20 functions and third-party wallets
### Development environment
#### Installation
- `npm install` to install all module dependencies
- `npm test` to compile all the contracts and run the entire test suite agains TestRPC
- `TESTFILE=test/.js npm run testrpc:single` to compile and run a single test file
#### Parity Local Dev Chain Testing
- `./deploy` to compile all the contracts and deploy them to a local parity dev-chain (this script will automatically start Parity)
- `geth attach --preload js/metronome.js,js/const.js,js/initMetronome.js` to open a geth console and start metronome
- `geth attach --preload js/metronome.js,js/const.js,js/initPostAuction.js` to open a geth console and start metronme (bypassing the initial auction)
Here geth console commands to emulate auction transactions
- `loadScript('js/testStart.js')` to load a geth test script for auction buys
- call `pingBuy()` to simulate a buy (this will also initiate a buy every 30 seconds)
## Test Suite
Sample code of how to interact with the smart contracts can be viewed in the Truffle tests.
### Unit Tests (`./test`)
- `shared` folder contains utility code shared amongs multiple test cases
- `auctions.js` tests for the Auction contract
- `deployment.js` tests for emulating actual deployment process for all the contracts
- `erc-compliance.js` tests for ERC20 and ERC827 compliance
- `fixedMath.js` tests for the Fixed Math contract (internal functions used by Metronome)
- `formula.js` tests for the Formula contract (math for minting calculations)
- `metronome.js` tests for Metronome use cases involving the AutonomousConverter
- `mtnToken.js` tests for MET Token use cases (i.e., transfering tokens)
- `owned.js` tests for Ownership operations (i.e., changeOwnership)
- `pricer.js` tests for Pricer contract (internal functions used by Metronome)
- `proceeds.js` tests for Proceeds contract to manage ETH funds
- `smartToken.js` tests for internal SmartToken contract used by AutonomousConverter
- `tokenLocker.js` tests used for time locking founder tokens
- `tokenPorter.js` tests for exporting MET tokens to be imported to another chain
### Timed Tests (`./timed-tests`)
Simuating time proved to be a challenge, so we had to migrate a seperate suite of tests so that we can take advantage of `evm_increaseTime`. This allowed us to better test targeted scenarios that depended on system time.
- `ac.js` timed tests for AutonomousConverter
- `auctions.js` timed tests for Auctions
- `proceeds.js` timed tests for Proceeds
- `subscriptions.js` timed tests for MET Token subscriptions
- `tokenLocker.js` timed tests for TokenLocker withdraws
## LICENSE
[MIT License](https://github.com/autonomoussoftware/metronome/blob/master/LICENSE).