daostack-arc-test1 v1.0.0

DAOstack Arc

Arc is the lower layer of the DAO stack. It consists of several smart contracts deployed on the Ethereum blockchain that define the basic building blocks and standard components that can be used to implement any DAO.

Resources

• Reference Documentation
• Concepts
• Guides & Recipes
• Read the Whitepaper

Getting Started

As a Solidity library

1. Install npm package: yarn add daostack-arc/ npm install daostack-arc
2. Import in your project. import 'daostack-arc/contracts/...';

Example:

import 'daostack-arc/contracts/universalShchems/UniversalScheme.sol';
contract MyAwesomeScheme is UniversalScheme { ... }

• .sol Source code is found under node_modules/daostack-arc/contracts
• .json Compiled contracts are found under node_modules/daostack-arc/build/contracts

*Note: Arc works best in truffle based projects.

Security

DAOstack Arc is still on its alpha version. Arc is meant to provide secure, tested and community-audited code, but please use common sense when doing anything that deals with real money! We take no responsibility for your implementation decisions and any security problem you might experience.

Contributing to Arc

1. $ yarn global add truffle ganache-cli - prerequisites: have truffle and ganache-cli installed.
2. $ git clone https://github.com/daostack/daostack.git - clone the repo.
3. $ cd daostack
4. daostack/$ yarn - install dependencies.

Commands:

• truffle test - run unit tests.
• yarn lint - lint JavaScript files.
• yarn solium - lint Solidity files.

This is an open source project (GPL license).

PRs are welcome but please first consult with the Contribution guide.

Join us on Slack!

Note on windows dev environments

Windows environments are not currently officially supported. A common workaround is to use Docker. 1. use docker run -it -v absolute/path/to/local/repo:/home node /bin/bash (use ${pwd} for a relative path, eg. ${pwd}/relative) 2. $ cd /home 3. Continue development as usual inside the container. your changes are automatically synchronized with the host(windows) local repo.

Contributing to Arc Docs

Same as above, with the following exceptions:

• All docs are .md files that live under docs/ with the following structure:
  • ref/ - generated automatic documentation.
  • headers/ - manual static .md headers that are included in the generated ref/ (headers are included based on their path, which must match the path of the corrosponding generated file in ref/).
• Use yarn run docs:generate to generate docs
• In case of missing or incorrect documentation please open an issue with the label documentation, indicating the file, line number and any extra details.