0.0.0-alpha.28 • Published 6 years ago

daostack-arc v0.0.0-alpha.28

Weekly downloads
8
License
GPL-3.0
Repository
github
Last release
6 years ago

Build Status NPM Package

Arc

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

Getting Started

DAOStack integrates with Truffle, an Ethereum development environment. Please install truffle.

npm install -g truffle

Getting the source code

git clone https://github.com/daostack/arc

test

npm test

This will run ganache-cli, compile, migrate and run all tests.

using Arc as a library

Please install Truffle and initialize your project with truffle init.

npm install -g truffle
mkdir myproject && cd myproject
truffle init

To install the daostack-arc library, run:

npm init
npm install daostack-arc
  • .sol Source code is found under node_modules/daostack-arc/contracts
  • .json Compiled contracts are found under node_modules/daostack-arc/build/contracts
import 'daostack-arc/contracts/universalSchemes/UniversalScheme.sol';

contract MyContract is UniversalScheme {
  ...
}

You should be able to find all daostack-arc already built contracts (.json) ready for deployment under node_modules/daostack-arc/build/contracts/ folder.

Note on windows dev environments

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

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.

License

This is an open source project (GPL license).

Contribution

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

Join us on Slack!

Join us on Telegram!

Documentation

Read the docs!