Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dapphub/dapple
EVM contract system developer multitool
https://github.com/dapphub/dapple
Last synced: 7 days ago
JSON representation
EVM contract system developer multitool
- Host: GitHub
- URL: https://github.com/dapphub/dapple
- Owner: dapphub
- License: gpl-3.0
- Archived: true
- Created: 2015-09-14T12:22:36.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-05-13T19:23:19.000Z (over 7 years ago)
- Last Synced: 2024-04-15T01:04:06.446Z (7 months ago)
- Language: JavaScript
- Homepage:
- Size: 1.54 MB
- Stars: 298
- Watchers: 23
- Forks: 58
- Open Issues: 55
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# ATTENTION: Dapple has been deprecated in favor of a new tool called [Dapp](https://dapp.readthedocs.io). Please use that instead.
[](https://github.com/Flet/semistandard)
[](https://travis-ci.org/nexusdev/dapple)
[](https://dapphub.chat/)
[](http://dapple.readthedocs.org/en/master/?badge=master)
[](https://waffle.io/nexusdev/dapple)
[](https://david-dm.org/nexusdev/dapple)
Dapple is a Solidity developer multitool designed to manage the
growing complexity of interconnected smart contract systems.
Its core functionality encompasses three main areas:
* Package management
* Contract building
* Deployment scripting
These concepts are related in a way unique to the smart contract
ecosystem, due to each blockchain's universal singleton nature.
The central data model for Dapple is the `dappfile`, whose definition
will normally reference IPFS objects and Ethereum contract addresses.
### Installation
The normal way to install Dapple is through npm:
$ npm install -g dapple
$ dapple --help
You can read about detailed system specific installation on the [documentation](http://dapple.readthedocs.io/en/master/install/).
### Basic usage
Use `dapple init` to generate a project skeleton:
mkdir foo;
cd foo;
dapple init
By default, `build/` is where the output of `dapple build` gets put,
and `contracts/` is where Dapple looks for your contract source files.
Both of these are configured in your `dappfile` and can be overridden.
Now try writing a contract and a test (see [Dapple test harness docs](https://github.com/nexusdev/dapple/blob/master/doc/test.md)):
$ vim contracts/dapp.sol
$ vim contracts/dapp_test.sol
$ dapple test
Finally, try building your project:
$ dapple build
By default, `dapple build` builds the entire `contracts/` tree, and
emits the following:
* cached build objects
* `classes.json` — a list of type definitions
* `js_module.js` — a JavaScript module which wraps `classes.json` and
adds `Contract` objects instantiated from `web3.js` for each object in
the `dappfile`
#### Example packages
* [Dappsys](https://github.com/nexusdev/dappsys) — a contract system framework (Nexus's "standard library")
* [Feedbase](https://github.com/nexusdev/feedbase) — a simple paid feed app
* [stringutils](https://github.com/Arachnid/solidity-stringutils) — string manipulation library
* [RanDAOPlus](https://github.com/tjade273/RanDAOPlus) - Experimental Ethereum RNG based on PoW
#### More information
* [tests](http://dapple.readthedocs.io/en/master/test/)
* [packages](http://dapple.readthedocs.io/en/master/packages/)
* [Deployment scripting](http://dapple.readthedocs.io/en/master/dapplescript/)
* [Logging](http://dapple.readthedocs.io/en/master/logging/)
* [dapplerc](http://dapple.readthedocs.io/en/master/dapplerc/)
* [troubleshoot/ FAQ](http://dapple.readthedocs.io/en/master/troubleshoot/)
#### Not yet documented
* Aliasing and imports
* Environments and object linking
* Ignore/add