Skip to content

Commit 97a9cb6

Browse files
committed
Add README.md and create common releases
1 parent 74adbaa commit 97a9cb6

File tree

3 files changed

+36
-24
lines changed

3 files changed

+36
-24
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Shutter Network Contracts
2+
3+
This repository contains the EVM contracts for [Shutter](https://www.shutter.network/).
4+
5+
## Installation
6+
7+
Go bindings for the shutter contracts can be generated by running
8+
9+
./gen_bindings.sh
10+
11+
Released versions are available as go package under `github.com/shutter-network/contracts/bindings/${contract name in lowercase}`.
12+
13+
## Scripts
14+
15+
There are some helper scripts (deployment, executing special contract methods, ...) in the `script/` directory.
16+
17+
**TODO: Add information for the involved scripts.**
18+
19+
## Tests
20+
21+
To manually run the tests, execute
22+
23+
forge test -vvv
24+
25+
## Contribution
26+
27+
Contributions are welcome! Feel free to [create issues](https://github.com/shutter-network/contracts/issues/new/choose) and/or open [pull requests](https://github.com/shutter-network/contracts/compare).
28+
29+
## References / other repositories
30+
31+
- [shutter.network](https://shutter.network)
32+
- [shutter-network/rolling-shutter](https://github.com/shutter-network/rolling-shutter)
33+
- [Gnosis chain spec for Shutter](https://github.com/gnosischain/specs/tree/master/shutter)

gen_gnosh_bindings.sh renamed to gen_bindings.sh

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,10 @@ CONTRACTS=(
77
"KeyperSet"
88
"EonKeyPublish"
99
"KeyBroadcastContract"
10+
"Inbox"
1011
)
11-
OUTPUT_DIR="gnoshcontracts"
12-
PACKAGE_NAME="gnoshcontracts"
12+
OUTPUT_DIR="bindings"
13+
PACKAGE_NAME="bindings"
1314

1415
mkdir -p "$OUTPUT_DIR"
1516

gen_shop_bindings.sh

Lines changed: 0 additions & 22 deletions
This file was deleted.

0 commit comments

Comments
 (0)