> Ethereum Smart Contracts and TypeScript client library for the dYdX Perpetual Contracts Protocol. Currently used by [trade.dydx.exchange](https://trade.dydx.exchange).
**Full Documentation at [docs.dydx.exchange](https://docs.dydx.exchange).**
## Table of Contents
- [Documentation](#documentation)
- [Install](#install)
- [Contracts](#contracts)
- [Security](#security)
- [Development](#development)
- [Maintainers](#maintainers)
- [License](#license)
## Documentation
Check out our full documentation at [docs.dydx.exchange](https://docs.dydx.exchange):
* [Protocol Overview](https://docs.dydx.exchange/#/perpetual-protocol)
* [Perpetual Guide and Contract Specification](https://docs.dydx.exchange/#/perpetual-guide)
## Install
`npm i -s @dydxprotocol/perpetual`
## Contracts
The current contract addresses can be found in the [`migrations/deployed.json`](https://github.com/dydxprotocol/perpetual/blob/master/migrations/deployed.json) file.
## Security
### Independent Audits
The smart contracts were audited independently by
[Zeppelin Solutions](https://zeppelin.solutions/) at commit [`c5e2b0e`](https://github.com/dydxprotocol/perpetual/tree/c5e2b0e58aaf532d2c8b1f658d1df2f6a3385318/contracts), excluding [`P1Orders.sol`](contracts/protocol/v1/P1Orders.sol).
**[Zeppelin Solutions Audit Report](https://blog.openzeppelin.com/dydx-perpetual-audit/)**
### Code Coverage
All production smart contracts are tested and have 100% line and branch coverage.
### Vulnerability Disclosure Policy
The disclosure of security vulnerabilities helps us ensure the security of our users.
**How to report a security vulnerability?**
If you believe you’ve found a security vulnerability in one of our contracts or platforms,
send it to us by emailing [security@dydx.exchange](mailto:security@dydx.exchange).
Please include the following details with your report:
* A description of the location and potential impact of the vulnerability.
* A detailed description of the steps required to reproduce the vulnerability.
**Scope**
Any vulnerability not previously disclosed by us or our independent auditors in their reports.
**Guidelines**
We require that all reporters:
* Make every effort to avoid privacy violations, degradation of user experience,
disruption to production systems, and destruction of data during security testing.
* Use the identified communication channels to report vulnerability information to us.
* Keep information about any vulnerabilities you’ve discovered confidential between yourself and
dYdX until we’ve had 30 days to resolve the issue.
If you follow these guidelines when reporting an issue to us, we commit to:
* Not pursue or support any legal action related to your findings.
* Work with you to understand and resolve the issue quickly
(including an initial confirmation of your report within 72 hours of submission).
* Grant a monetary reward based on the [OWASP risk assessment methodology](https://medium.com/dydxderivatives/announcing-bug-bounties-for-the-dydx-margin-trading-protocol-d0c817d1cda4).
## Development
### Compile Contracts
Requires a running [docker](https://docker.com) engine.
`npm run build`
### Compile TypeScript
`npm run build:js`
### Test
Requires a running [docker](https://docker.com) engine.
**Start test node:**
`docker-compose up`
**Deploy contracts to test node & run tests:**
`npm test`
**Just run tests (contracts must already be deployed to test node):**
`npm run test_only`
**Just deploy contracts to test node:**
`npm run deploy_test`
## Maintainers
- **Brendan Chou**
[@brendanchou](https://github.com/BrendanChou)
[`brendan@dydx.exchange`](mailto:brendan@dydx.exchange)
- **Ken Schiller**
[@kenadia](https://github.com/Kenadia)
[`ken@dydx.exchange`](mailto:ken@dydx.exchange)
## License
[Apache-2.0](./blob/master/LICENSE)
