hq20 / contracts Goto Github PK

View Code? Open in Web Editor NEW

459.0 20.0 108.0 4.34 MB

A set of reusable smart-contracts

Home Page: https://hq20-contracts.netlify.com/

License: Apache License 2.0

JavaScript 1.64% Solidity 35.95% Shell 0.72% TypeScript 61.68%

solidity truffle techhq reusable smart-contracts package

contracts's Introduction

Icons made by Eucalyp from www.flaticon.com

HQ20 contracts

HQ20/contracts is a Solidity project with contracts, libraries and examples to help you build fully-featured distributed applications for the real world.

Disclaimer: The contracts are expected to be used as smart contract patterns for you to draw inspiration from, and for them to be easy to understand they have been kept deliberately simple. If you decide to reuse the contracts, or to copy and paste code in them, make sure that you look for and close the vulnerabilities. If you plan to go to the mainnet, please get a third party audit done.

In a Nutshell

At the time of this writing (May 2020), this are the contents of this repository:

contracts ──┬─── access        - Access Control Contracts, some of them built on top of `AccessControl.sol`
            ├─── classifieds   - Example of a decentralized classifieds market for ERC721
            ├─── dao           - Example of building a decentralized venture capital fund
            ├─── energy        - Example of building a decentralized market for energy distribution
            ├─── exchange      - The Uniswap decentralized market contracts, with solidity tests
            ├─── introspection - Example of using ERC165 to verify contract types before casting
            ├─── issuance      - Example of an ICO, can be used as well for share issuances
            ├─── lists         - Reusable implementations of different types of linked lists
            ├─── math          - Reusable implementation of a lightweight fixed point math library
            ├─── state         - Reusable implementation of a fully-featured state machine
            ├─── token         - Token implementations, including a reusable dividend-bearing ERC20
            ├─── utils         - Reusable library to cast between `uint` and `int`.
            └─── voting        - Example implementations of token-based and address-based votings

Installation

Use the package manager yarn to install dependencies.

$ yarn add @hq20/contracts

Usage

pragma solidity ^0.6.0;
import "@hq20/contracts/contracts/access/Roles.sol"


contract MyContract is Roles {
	constructor() public Roles(msg.sender) {
		// do something
	}
}

Directories

Contracts go in contracts, test files go in test.

Inside the contracts folder the files are organized by topic and by type.

At the root of contracts are directories for each one of the topics, containing the simplest implementations that are in a mature state.

For contracts that are under development there is a contracts/drafts directory with the appropriate topic folders inside.

For contracts that are used for testing of libraries or internal methods there is a contracts/test directory with the appropriate topic folders inside.

The test directory replicates the structure of the contracts directory.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

As well as bug fixes, we will welcome updates to the basic contracts that make them even easier to understand, examples of contracts implementing a particular feature, or advanced contracts that put together a number of features into a complete use case.

Please make sure to update tests as appropriate.

License

Apache-2.0

contracts's People

Contributors

Stargazers

Watchers

Forkers

pooltogether techman34 krogla cowri richardkelley modernartistdao 0xbaer obernardovieira dapp-collections xantygc yafiabiyyu toliuyi beillahi hal909 chriscorp contractshark jpaulet flemisharchers colorstheforce darocha ernestpascual the-insight-token callmewhy swimmingjoon1001 conhecer100 jshanks21 mansoob akhmadfxidr defy-h0dl dautonomous alerapchan neuromancer1729 alexintosh installation07 thisisfinecollective anton-karlovskiy nv3ob61 haytic-inc ddtme stoychomihaylov 22388o bigchiano defiacademy lucasleandro1204 colorghost rookiepj robertlbebber cloudforge-oy yuvytung abdul-maajid roidsaa buggerbag gotocva fufugang bidcms kostek1994 hoang-it ccamateur testzhaoxiaofei shishirhome suzhugen aliwisam zmydavid the-code-giant sukantag smartsolidity devtooligan gewenfei lucian-hostco galminzhou ryonzhang vector-n bisbist aleph-works forestgun regodefies greatbn subconscious-navigator aeharvlee atiqamjad cryptojlee 37w15 scopetion tsadoklf ashurstermir enrikni collecttee letitiaspenser huyhaug huzaifahatim luckystar0831 damandal0rian mithreum linhnt31 1p3p37 0xawen francelwebdev holic5981 bitlong989 jeftarmascarenhas

contracts's Issues

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.

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.

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?

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.

Create an energy market

Inside contracts/examples

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:

The market works with a currency token, like Issuance.sol.
Someone puts a buy or sell advert. There is no description or anything for the advert, just an address as a payload.
The payload address conforms for an ERC721 contract interface.
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.

Convert JS to TS

Create IssuanceFactory.sol

Follow the example from uniswap.

https://github.com/albertocuestacanada/MyUniswap

Update main README.md with new modules

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

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 👍

Stop using itShouldThrow and use girino instead

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

Create examples folder inside `contracts`- PR #64

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,
        ^--------------^

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

This contract will always be inherited from.

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

Bring coverage of UniswapExchange.sol up to 90%

After bringing the contract to this repo, obviously.

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

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.

Missing scripts local_geth.sh and local_ganache.sh

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

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.

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%?)

Release ERC20Dividendable

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

Refine DividendableERC20

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

Ignore files from release package

Such as the following folders

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

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.

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?

Review openzeppelin's crowdsale.sol

Try to use the same terms in issuance.sol.

Sync Issuance.sol with IssuanceEth.sol

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

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.

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.

Improve README.md

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.

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`

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.

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.