enzymefinance/protocol

Enzyme Protocol Implementation

protocol's Issues

Deploy to ETHPM

Relevant branch: https://github.com/melonproject/protocol/tree/ethpm

root@x2:~/Melon/protocol$ truffle publish
Gathering contracts...
SyntaxError: Expected "!", "!=", "(", ")", "+", "++", "-", "--", "0", "<", "<=", "==", ">", ">=", "[", "^", "delete", "false", "hex", "mapping", "new", "this", "true", "v", "~", [1-9], comment, end of line, identifier, number, string, or whitespace but "{" found.
    at peg$buildStructuredError (/home/reto/.nvm/versions/node/v7.3.0/lib/node_modules/truffle/node_modules/solidity-parser/build/parser.js:1272:12)
    at Object.peg$parse [as parse] (/home/reto/.nvm/versions/node/v7.3.0/lib/node_modules/truffle/node_modules/solidity-parser/build/parser.js:13858:11)
    at Object.parse (/home/reto/.nvm/versions/node/v7.3.0/lib/node_modules/truffle/node_modules/solidity-parser/index.js:34:23)
    at /home/reto/.nvm/versions/node/v7.3.0/lib/node_modules/truffle/node_modules/truffle-compile/profiler.js:259:36
    at tryToString (fs.js:425:3)
    at FSReqWrap.readFileAfterClose [as oncomplete] (fs.js:412:12)

Track Module Usage

For Inflation as well as for satellite contracts its important to have the metrics of Module usage

Using async/await instead of then() in all files

Remove shrinkwrap.json

Remove npm-shrinkwrap.json when solidity-parser version that parses our contracts is incorporated into truffle.

Add more assets

Add them to this issue. Right now:

• SNGLS

Redo: Entire Documentation

unifiy 'referenceAsset' accross core and modules

Prev. assumed that etherToken would be referenceAsset.

Better to have this generalised; I.e. manager can decide which asset he/she would like to be measured against

Set CryptoCompare query dynamically

Requires string manipulation in Solidity, and (most likely) using CryptoCompare-compatible identifiers in the token contracts (which we may get rid of soon anyway).

• Code

Rename Analtics to PrevValue in Core

PrevValue better description of usecase of this struct

Remove babel dependency in favor of babel-cli

You have mistakenly installed the `babel` package, which is a no-op in Babel 6.
Babel's CLI commands have been moved from the `babel` package to the `babel-cli` package.

    npm uninstall babel
    npm install babel-cli

See http://babeljs.io/docs/usage/cli/ for setup instructions.

More info: https://babeljs.io/docs/usage/cli/

Affected code: https://github.com/melonproject/protocol/blob/master/package.json#L47

[Re-]write tests where applicable

@retotrinkler suggested a major re-write of the tests in this repo, adn I agree.
When we get a coverage tool working (#55) then we can know where should direct our efforts.

• Add general tests for asset tokens (preminedAsset)
• add tests for etherToken
• add tests for pricefeed
• tests for Version
• tests for invest/redeem
• test Vault

Two tests failing intermittently on Windows 7

When I run truffle test I get errors on two tests sometimes, but not all of the time.

The tests have identical code, but do not always fail together:

• One
• Two

An example of the error message I receive:

  1) Contract: PriceFeed Get multiple existent prices relative to Ether:

      Uncaught AssertionError: 4800000 == 5004003202562050000
      + expected - actual

      -4800000
      +5004003202562050000

      at priceFeedContract.getPrice.then (test\pricefeed.js:104:18)
      at process._tickCallback (internal/process/next_tick.js:103:7)

Could this be because these test cases are running in async? (Though I thought async.mapSeries was supposed to run them in order, but I'm not sure)

Update to latest truffle version

Remove trailing commas in {key: value} lists

In accordance with upcoming changes here, and more discussion here.

Add Ripple token

Restrict trade to liquidity provider

As for initial version trade will be restricted to:

• only takeOrders and

• takeOrders only from LiquidityProvider (i.e. order.owner == LiquidityProviderAddress)

• no makeOrder functionality

• in takeOrder only if order.owner == liquidityprovider

Subscribe and redeem through subscribe and redeem modules

Subscribe with only Ether and redeem by receiving only Ether

Version: Ability to decomission individual vaults

https://github.com/melonproject/protocol/blob/master/contracts/governance/Version.sol#L130-L137

Automated update of config files on new contract deployment

Write a script to update (at minimum) the addresses in this config, and perhaps others, with newly-deployed addresses (available by truffle networks or through truffle's contract abstractions).

Governance: Ability to decommission entire Versions

https://github.com/melonproject/protocol/blob/master/contracts/governance/Governance.sol#L37

we can make this simple: doesn't even need to be multisig initially (mutlisig would require some testing for contract to contract calls)

could just be one account that controlls this - if we have time we can implement and test multisig solution

Include generating contract JSON files as part of the build process

See this comment.
Some options for build scripts:

• gulp
• grunt
• keep using NPM scripts

Related:

• melonproject/daemon#15
• melonproject/satellite#13

Add ProofOfEmail smart contracts

• https://github.com/melonproject/satellite/blob/master/truffle/contracts/ProofOfEmail.sol
• Deploy to kovan
• Deploy npm

include open orders on exchanges in nav calculation

Keep a changelog

Travis' comment https://github.com/melonproject/satellite/issues/15

Subscribe module investment w EtherToken instead of Ether

Abstraction done on Interface layer not contract layer

Using flow as static type checker

Ref https://flow.org/

Split Vault.sol into several files

Vault.sol is getting really big, and may have functionality that could be kicked out into other solidity files.
We can probably make at least 2 files out of it if we wanted.
Lower priority than adding functionality/bugfixes.

Better NPM module

• Exclude contracts / migrations for NPM
• Make import happen like import Vault from '@melonproject/protocol/Vault.json'

Using natspec for contracts

https://github.com/ethereum/wiki/wiki/Ethereum-Natural-Specification-Format

Redeeming independent of active price feed

Redeem option that is independent of active data feed.
From limit order option to percentage of ownership option

Add code coverage badge

Requires ability to calculate code coverage.
Can use something like this for that.

• Waiting on issue
• Waiting on #64 (coverage doesn't make much sense with failing tests)

Change subscribe/redeem function to payout in MLN

Function name of redeemInReferenceAsset would change to redeemInMelon, or similar.

utils/ folder mostly deprecated - needs restructuring

Add tokenregistrar

Eg something like

• https://github.com/0xProject/contracts/blob/master/contracts/TokenRegistry.sol
• with settings file instead of custom contracts
• looks super useful for deployment

would also help solve #6

Asset.decimals linked in Universe

uint decimals not part of ERC20 standard - hence better to not assume they are there for all such assets

Environmental setting for foundation, kovan, stagin etc deployments

Currently, our dev-env and stage.melonport.com all point to the same smart contracts.

But there should be two:

• The current live one
• The current stage/dev

To differentiate between stage and live, add -stage to the version like specified in http://semver.org/#spec-item-9

Adding of actual pre and post conditions

using require and assert instead of modifiers to enforce pre and post conditions throughout

Successive subscribe calls fail

This occurs when the offered value is less than total value of shares in fund.

Some contract functions are difficult to test

More of a constant thing we can do, but good to do this thoroughly at this stage as well.

1. Scan each contract's code for testability
2. Make functions more testable where it makes sense

Testability resources:

• how to make untestable code
• how to make testable code
• js-specific testability
• language-agnostic principles
• finally, parameterized idempotence can go a long way

Subscribe module testcase for creating and annihilation shares

Initial Version of Risk Mgmt module

Possibility of jumping orders; There is no enforcement of manager to take best offered order

• Initial solution:
  Assert that:
  order.owner === address(liquidityProvider)
  for takeOrder

Remove hardcoded static array size in favour of dynamic array

This issue is contingent on merge of subscribe-redeem branch in its current form

Had to use a bit of a hack in order to return an array from an external contract call here.

Apparently we cannot yet return a dynamic array from an external function call in solidity yet, so the current workaround is to just make a very large (mostly empty) static array.

We should not have more than 200 assets in a portfolio for a long long time, so this artificial limit will work for the time being, but should be removed as soon as possible.

There may also be another approach to the problem I haven't thought about. Maybe we can use mappings instead of returning array at all?

Add etherToken, melonToken addresses as parameters in Universe constructor contract

Add: Function to efficiently parse and return list of addresses of active vaults

similar to #75

getNumberOfActiveOrders on exchange contract

We could optimise the syncing of orders by having a getNumberOfActiveOrders of the exchange contract. With this, we can count the synced active orders against this number and stop as soon as we reached getNumberOfActiveOrders.

Add: Accounting for Orders/amounts placed/held on exchnages

Make a version of calcSharePrice that is readonly

For interface reasons on portal and to make subscribe module function more efficient

Verify asset contracts on etherscan

In `core` contract - investing via portfolio split as default; other options in `subscription module`

In core contract use:

• createShares(..)
• createSharesOnBehalf(..)

Participation Module as a way to invest in portfolio using only one asset, that gets split up into protfolio 'split' which gets added to core.

Rational: less friction for portfolio manager.

More Assets like MKR, DGX, DGD, GNT, SNGLS