Skip to content

Commit 4f98409

Browse files
authored
update readme with security and audit info (#131)
1 parent b707a9a commit 4f98409

File tree

1 file changed

+9
-45
lines changed

1 file changed

+9
-45
lines changed

README.md

Lines changed: 9 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,12 @@
22

33
[![Coverage Status](https://coveralls.io/repos/github/IndexCoop/index-coop-smart-contracts/badge.svg)](https://coveralls.io/github/IndexCoop/index-coop-smart-contracts)
44

5-
# index
5+
# Index Cooperative Smart Contracts
66

7-
This repo houses the [index-coop][22]'s Solidity smart contracts.
7+
This repo houses the [index-coop][22]'s Solidity smart contracts which are built on [Set Protocol V2][29]. There is a separate repository for [Index Protocol](https://github.com/IndexCoop/index-protocol), a good-fath fork of Set V2 that Index Coop will continue to develop. Head over to that repo to find our newer smart contracts.
88

99
[22]: https://www.indexcoop.com/
10+
[29]: https://github.com/SetProtocol/set-protocol-v2
1011

1112
## Install (for development)
1213

@@ -34,7 +35,7 @@ OR `yarn test:clean` if contract typings need to be updated
3435

3536
### Run Integration Tests
3637

37-
`yarn chain:fork:ethereum` in one terminal to run chain fork. replace ethereum with polygon or optimism if needed, see package.json
38+
`yarn chain:fork:ethereum` in one terminal to run chain fork. replace ethereum with polygon if needed, see package.json
3839

3940
`yarn test:integration:ethereum` in another terminal, replace chain again as needed
4041

@@ -63,49 +64,12 @@ npm install @indexcoop/index-coop-smart-contracts
6364
## Contributing
6465
We highly encourage participation from the community to help shape the development of Index-Coop. If you are interested in developing on `index-coop` or have any questions, please ping us on [Discord](https://discord.com/invite/RKZ4S3b).
6566

66-
## Security
67+
## Security Audits
6768

68-
### TODO: Independent Audits
69+
Set Protocol V2 has undergone multiple audits. For more information see https://index-coop.gitbook.io/index-coop-community-handbook/protocols/security-and-audits
6970

70-
### Code Coverage
71+
## Vulnerability Reporting ##
7172

72-
All smart contracts are tested and have 100% line and branch coverage.
73+
If you believe you’ve found a security vulnerability in one of our contracts or platforms, we encourage you to submit it through our [ImmuneFi Bug Bounty][32] program.
7374

74-
### Vulnerability Disclosure Policy
75-
76-
The disclosure of security vulnerabilities helps us ensure the security of our users.
77-
78-
**How to report a security vulnerability?**
79-
80-
If you believe you’ve found a security vulnerability in one of our contracts or platforms,
81-
send it to us by emailing [[email protected]](mailto:[email protected]).
82-
Please include the following details with your report:
83-
84-
* A description of the location and potential impact of the vulnerability.
85-
86-
* A detailed description of the steps required to reproduce the vulnerability.
87-
88-
**Scope**
89-
90-
Any vulnerability not previously disclosed by us or our independent auditors in their reports.
91-
92-
**Guidelines**
93-
94-
We require that all reporters:
95-
96-
* Make every effort to avoid privacy violations, degradation of user experience,
97-
disruption to production systems, and destruction of data during security testing.
98-
99-
* Use the identified communication channels to report vulnerability information to us.
100-
101-
* Keep information about any vulnerabilities you’ve discovered confidential between yourself and
102-
Set until we’ve had 30 days to resolve the issue.
103-
104-
If you follow these guidelines when reporting an issue to us, we commit to:
105-
106-
* Not pursue or support any legal action related to your findings.
107-
108-
* Work with you to understand and resolve the issue quickly
109-
(including an initial confirmation of your report within 72 hours of submission).
110-
111-
* Grant a monetary reward based on the OWASP risk assessment methodology.
75+
[32]: https://immunefi.com/bounty/indexcoop/

0 commit comments

Comments
 (0)