hq20/contracts

A set of reusable smart-contracts

contracts's Issues

ERC20 Tokenization

I think this would be a use case, more than an example or reusable code:

https://hackernoon.com/how-to-represent-physical-assets-on-a-blockchain-with-erc20-fu1yo3vkz

ERC721 Tokenization

A use case I guess?

https://www.techhq.io/8594/blockchain-development-tokenize-digital-assets/

Would it be cheaper to use enum instead of a string?

Describe the solution you'd like
In StateMachine, the states (SETUP_STATE, currentState, transitions, and states) are all bytes32. Would it be cheaper to use an enum?

Stop using itShouldThrow and use girino instead

Let's use our tool to simplify and clean it a bit https://github.com/HQ20/girino

Voting and Staking

Consider how a voting library could be built for DAO.sol.

The idea is that there are several actions that can be voted. The actions are known at coding time (for example, investing in a new venture, distributing dividends and raising funds).

Voting is the same for all actions. There is a staking token and each token is one vote. Each token cannot be used for more than one voting simultaneously.

I would like the logic to be reused between voting actions, only changing the resulting action if the vote is successful.

We might have to mess with function signatures and things like that, no idea really.

Write README for EnergyMarket.sol

This should be one of the conditions to get out of drafts :(

Consider using securify v2

Describe the solution you'd like
We currently do not have security checks. I think securify v2 might be interesting.

Release EnergyMarket.sol

Get it out of drafts and increase test coverage until tests pass.

Example of RBAC.sol usage

This could be something like an ERC20 factory, where the ERC20s created get the RBAC.sol contract and user defined roles for minters and recipients.

It might need a bit of a frontend to make sense.

Sync Issuance.sol with IssuanceEth.sol

The withdraw functions needs to be limited, and require messages should be as for IssuanceEth.sol.

Escrow Example

OpenZeppelin has Escrow contracts, but I see no examples. I like examples. Maybe even a simple use case.

Review openzeppelin's crowdsale.sol

Try to use the same terms in issuance.sol.

Bring coverage of UniswapExchange.sol up to 90%

After bringing the contract to this repo, obviously.

Create fixed point math library

Only add, sub, mul and div.

Use base64 format from ABDK and SafeMath from OpenZeppelin

Update main README.md with new modules

I think the main README.md folder scheme needs to be updated according to the changelog.

Create examples folder inside `contracts`- PR #64

Use fixed point math in Issuance.sol

There is an issue with the current formula for token issuance, which is

amount(issuanceToken) = amount(currencyToken)/issuePrice

because you cannot set a subunitary issuePrice. It should be:

amount(issuanceToken) = amount(currencyToken).fixedDiv(issuePrice, 10**18)

or something similar using fixed point math. See ABDK or Fixidity.

Consider removing IssuanceToken from Issuance.sol

Is there a reason we can't just use ERC20Detailed?

Ignore files from release package

Such as the following folders

contracts/drafts/
contracts/examples/
contracts/test/
contracts/Migrations.sol

ERC1820 Example

The latest evolution of ERC165, in that it includes a global registry of contracts and the interfaces they implement. A bit mind-bending. Obviously needs an example.

Silence warnings for ClassifiedsAdvanced.sol

,/home/alberto/Code/hq20-contracts/contracts/drafts/classifieds/ClassifiedsAdvanced.sol:35:9: Warning: Unused function parameter. Remove or comment out the variable name to silence this warning.
        address operator,
        ^--------------^

Missing scripts local_geth.sh and local_ganache.sh

Thus yarn start:geth:local and yarn start:ganache:localdon'twork.

Create classifieds market

Start by using a fixed price buy/sell market as for AB. Please write it from scratch instead of reusing their contract and name everything as for a craigslist classifieds board.

The mechanics are:

1. The market works with a currency token, like Issuance.sol.
2. Someone puts a buy or sell advert. There is no description or anything for the advert, just an address as a payload.
3. The payload address conforms for an ERC721 contract interface.
4. The buy part puts in escrow an amount of the currency token, for the sell part the ownership of the ERC721 payload is what is put in escrow.

Ask for two token addresses in the Issuance.sol constructor

Instead of creating tokens in Issuance.sol, let's have two token contracts feed to the constructor, one for currency and one for issuance.

We need to be careful to restrict minting to the right address.

Make `create*` and `transition` methods internal in StateMachine.sol

This contract will always be inherited from.

write a welcome paragraph

Could you please write a paragraph to add to the README.md? Just as a welcome message, describing what contracts repository is.
something like this https://github.com/airbnb/streamalert
or https://github.com/kamranahmedse/developer-roadmap
or https://github.com/puppeteer/puppeteer
or maybe the top 3 here https://github.com/uber
I think you get the idea. Just one paragraph. The everything else is one me 👍

Rename `acceptedToken` to `currencyToken` in Issuance.sol

Let's use this:
currencyToken: The token that is accepted in payment for investments.
issuanceToken: The token that will be issued if conditions are met.

Setup Automated Documentation Generator

ERC1404 Example

I think this is the earliest try for a security token. There are more recent ones. It would be nice to show we know how to implement things with them.

Create simple DAO

How does it work? Is there a simpler version? How to implement for a specific use case?
https://github.com/TheDAO/DAO-1.0

Be aware that the repo linked still has the infamous DAO reentrancy bug.

Add method for Owner to withdraw contract funds

This is a method for the owner to retrieve the currency stored in the issuance contract. Please come up with a suitable name.

It should be possible only on "LIVE" state.

Please merge #26 first and make this issue a PR of its own.

Move `mocks` to `contracts`

Convert JS to TS

Move StateMachine out of drafts

It's mature enough 🦄

Upgrade to Solidity 0.6

Move all mock contracts to `contracts/test`

access and lists contain some mocks, which will make it into the package.

Release ERC20Dividendable

Increase coverage so that it can get out of drafts into token.

Comment out gas tests

Either comment out the gas tests for LinkedList and friends, or move them somewhere where they don't run with yarn test.

Release Classifieds.sol

• Rename Classifieds.sol as ClassifiedsAdvanced.sol.

• Rename ClassifiedsV2.sol as Classifieds.sol and get it out of drafts.

• Increase test coverage of the Classifieds.sol outside drafts until tests pass (90%?)

Create IssuanceFactory.sol

Follow the example from uniswap.

https://github.com/albertocuestacanada/MyUniswap

Link repo and soldoc

When opening the soldoc page there is no link to go to the repo. When opening the repo in github there is no link to go to the soldoc page.

Create Whitelist contract inside access

Branch new/whitelist

This is a stripped down version of RBAC.sol, with just one Role.

An Ownable contract that keeps a mapping of address => bool

Methods:
isMember: returns mapping(address)
addMember: sets mapping(address) = true
removeMember: delete mapping(address)

There is no listing of members, that will be done in a separate issue and contract.

ERC777 example

ERC777 is supposed to supersede ERC20. OpenZeppelin has an implementation. I would like to have an example of how to use it.

Test with external project before releasing beta version

As we will be releasing the first beta version in two days, we must test it with an external project before doing it.

https://github.com/HQ20/contracts/milestone/2

Who can I assign it to?

Create an energy market

Inside contracts/examples

Dividend distribution

Dividend distribution - Is this a reusable contract or an example pattern? Maybe implement inheriting from ERC20?

https://medium.com/@weka/dividend-bearing-tokens-on-ethereum-42d01c710657

Improve README.md

Refine DividendableERC20

Take the comments here and make sure we account for them.

Add uniswap exchange

From https://github.com/albertocuestacanada/MyUniswap

Let's just add tests to the code and add it to the repo. Maybe later we will simplify it.

Uniswap thought really out of the box with a very simple DEX. CementDAO was similar, but Uniswap is much simpler. I would use this for any solution requiring a DEX.

Parallel tests?

Our tests are getting longer to run as the package grows. Would it be a good idea to parallelize them?