varsm/ufragments

Smart contracts for Ampleforth Protocol (working name uFragments)

Ampleforth

  

Ampleforth (code name uFragments) is a decentralized elastic supply protocol. It maintains a stable unit price by adjusting supply directly to and from wallet holders. You can read the whitepaper for the motivation and a complete description of the protocol.

This repository is a collection of smart contracts that implement the Ampleforth protocol on the Ethereum blockchain.

Table of Contents

• Install
• Testing
• Contribute
• License

Install

# Install project dependencies
npm install

# Install ethereum local blockchain(s) and associated dependencies
npx setup-local-chains

Testing

# You can use the following command to start a local blockchain instance
npx start-chain [ganacheUnitTest|gethUnitTest]

# Run all unit tests
npm test

# Run unit tests in isolation
npx truffle --network ganacheUnitTest test test/unit/uFragments.js

Contribute

To report bugs within this package, please create an issue in this repository. When submitting code ensure that it is free of lint errors and has 100% test coverage.

# Lint code
npm run lint

# View code coverage
npm run coverage

License

GNU General Public License v3.0 (c) 2018 Fragments, Inc.