# @aragon/os

> Core contracts for Aragon

Latest version **4.4.0** (published 2020-03-02) · (GPL-3.0-or-later OR MIT) license · 0 weekly downloads

## Install

```sh
npm install @aragon/os
pnpm add @aragon/os
yarn add @aragon/os
bun add @aragon/os
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; large bundle.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.4.0 |
| Published | 2020-03-02 |
| First published | 2018-01-14 |
| Weekly downloads | 0 |
| License | (GPL-3.0-or-later OR MIT) |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 24.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 678 |
| Author | Aragon Association |
| Maintainers | ajsantander, aragon-ci, bingen, bpierre, evalir, facuspagnuolo, gabrielg, izqui, luisivan, sohkai |

## Links

- npm: https://www.npmjs.com/package/@aragon/os
- Repository: https://github.com/aragon/aragonOS
- Homepage: https://github.com/aragon/aragonOS#readme
- Issues: https://github.com/aragon/aragonOS/issues
- npm.io page: https://npm.io/package/@aragon/os

## Dependencies (4)

- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.1
- [homedir](https://npm.io/package/homedir.md) ^0.6.0
- [truffle-flattener](https://npm.io/package/truffle-flattener.md) ^1.2.9
- [@aragon/truffle-config-v4](https://npm.io/package/@aragon/truffle-config-v4.md) ^1.0.1

## Recent versions

- 4.4.0 (latest) — 2020-03-02
- 5.0.0-rc.0 (next) — 2020-08-26
- 5.0.0-beta.8 (beta) — 2020-08-18
- 5.0.0-beta.7 — 2020-08-04
- 5.0.0-beta.6 — 2020-07-30
- 5.0.0-beta.5 — 2020-07-28
- 5.0.0-beta.4 — 2020-07-27
- 5.0.0-beta.3 — 2020-07-15
- 5.0.0-beta.2 — 2020-07-15
- 5.0.0-beta.1 — 2020-07-02
- 5.0.0-beta.0 — 2020-06-26
- 4.3.0 — 2019-09-03
- 4.2.1 — 2019-07-11
- 4.2.0 — 2019-04-15
- 4.1.0 — 2019-03-09
- … 34 more at https://npm.io/package/@aragon/os/versions

## README

# aragonOS <img align="right" src="https://raw.githubusercontent.com/aragon/design/master/readme-logo.png" height="80px" /> [![Travis branch](https://img.shields.io/travis/aragon/aragonOS/master.svg?style=for-the-badge)](https://travis-ci.org/aragon/aragonOS) [![Coveralls branch](https://img.shields.io/coveralls/aragon/aragonOS/master.svg?style=for-the-badge)](https://coveralls.io/github/aragon/aragonOS?branch=master) [![npm](https://img.shields.io/npm/v/@aragon/os.svg?style=for-the-badge)](https://www.npmjs.com/package/@aragon/os)

This repo contains Aragon's reference implementation of [aragonOS](https://hack.aragon.org/docs/aragonos-intro.html).

#### 🚨 Security review status: bug bounty
aragonOS 4 has undergone two independent professional security reviews, and the issues raised have been resolved. However there is a [bug bounty program](https://wiki.aragon.org/dev/bug_bounty/) for rewarding hackers who find security vulnerabilities. There is a bounty pool of $250,000 USD, you can find more information [here](https://wiki.aragon.org/dev/bug_bounty/).

#### 👋 Get started contributing with a [good first issue](https://github.com/aragon/aragonOS/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
Don't be shy to contribute even the smallest tweak. Everyone will be especially nice and helpful to beginners to help you get started!

## Documentation

Visit the [Aragon Developer Portal](https://hack.aragon.org/docs/aragonos-intro.html) for in-depth documentation on the [architecture](https://hack.aragon.org/docs/aragonos-ref.html) and different parts of the system.

## Developing aragonOS locally

```sh
npm install
npm test

# Lint needs to pass as well
npm run lint
```

## Deploying

### APM
```sh
OWNER=[APM owner address] ENS=[ENS registry address] npx truffle exec --network [network] scripts/deploy-apm.js
```

- `ENS`: If no ENS registry address is provided, it will deploy a dummy ENS instance to the network. If the ENS registry is provided, the name `aragonpm.eth` must be owned by the deployer account.
- `OWNER`: The account that will be the initial owner of the APM registry

## Adding aragonOS as a dependency to your Aragon app

```
npm i --save-dev @aragon/os
```

Check the [Aragon Developer Portal](https://hack.aragon.org) for detailed documentation and tutorials on how to use aragonOS to build an Aragon app.

## Contributing

For more details about contributing to aragonOS, please check the [contributing guide](./CONTRIBUTING.md).

---
_Source: https://npm.io/package/@aragon/os · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._