Skip to content

Commit

Permalink
resolve merge conflicts
Browse files Browse the repository at this point in the history
  • Loading branch information
SwatiEY committed Jan 11, 2024
2 parents c9bf1b5 + 88b877b commit 671ef94
Show file tree
Hide file tree
Showing 11 changed files with 322 additions and 225 deletions.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
_This code is not owned by EY and EY provides no warranty and disclaims any and all liability for use of this code. Users must conduct their own diligence with respect to use for their purposes and any and all usage is on an as-is basis and at your own risk._

# starlight :stars:

Generate a zApp from a Solidity contract.
Expand All @@ -20,7 +22,7 @@ _Solidity contract --> Zolidity contract --> zappify --> zApp_

The main objective of this transpiler is to enable developers to quickly draft frameworks for zApps.

See [here](./doc/WRITEUP.md) for an enormously detailed explanation of how the transpiler works.
See [here](https://starlight-3.gitbook.io/starlight/) for the gitbook, and [here](https://starlight-3.gitbook.io/starlight/doc/writeup/) for an enormously detailed explanation of how the transpiler works.


---
Expand Down Expand Up @@ -327,6 +329,20 @@ You can also filter these commitments by variable name. Using the example above,
```
as a GET request to `http://localhost:3000/getCommitmentsByVariableName`.

#### Using secret states in the constructor

Starlight handles secret initiation in the constructor by creating a proof at the setup stage. Any user supplied inputs will be prompted for in the command line when running `./bin/setup`.

Since this inevitably creates a commitment to be sent your local db, simply restarting the zapp will **not** work. The blockchain will be aware of the constructor commitment, but your zapp will not.

If you would like to restart the zapp and redeploy the contract, always (with no running docker containers) run:

`./bin/redeploy` <-- creates a new constructor proof and saves the commitment, then deploys the shield contract

`npm run restart` <-- if you'd like to use the APIs, always **restart** rather than **start** since the latter clears your local dbs

Then, if you previously had nullifiers, reinstate them in your local sparse merkle tree by sending a POST to `http://localhost:3000/reinstateNullifiers`.

#### Deploy on public testnets

Apart from local ganache instance, Starlight output zapps can be now be deployed in Sepolia, Goerli and Polygon Mumbai as cli options. Connection to Sepolia and Goerli are made through [infura](https://infura.io/) endpoints and that of Polygon Mumbai is provided via [maticvigil](https://rpc.maticvigil.com/).
Expand Down
15 changes: 15 additions & 0 deletions doc/CONTRIBUTIONS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Contributing to Starlight

Contributions are welcome.

## Branch policy

The [master branch](https://github.com/EYBlockchain/starlight/tree/master) is a supported version per our [security policy](https://github.com/EYBlockchain/starlight/security/policy). Please make all pull requests against this version, unless you have a specific reason to branch off of another branch.

## Commit policy

We will prefer if your commit messages can please follow the [Conventional Commits](https://www.conventionalcommits.org/) specification. Some examples of good commit messages include:

- `feat(code): proofs presented in more compact form`
- `fix: remove appending of '1' to inputs`
- `refactor(parser): new api used`
17 changes: 17 additions & 0 deletions doc/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Security Policy

## Supported versions

Only the latest minor version of Starlight is supported with security updates. These updates are
published as new patch versions. All versioning follows Semantic Versioning. You can find the latest
version [released on GitHub](https://github.com/EYBlockchain/starlight/releases).

| Branch | Supported |
| --------------------------------------------------------------- | ------------------ |
| [master](https://github.com/EYBlockchain/starlight/tree/master) | :white_check_mark: |
| Earlier minor releases | :x: |

## Reporting a vulnerability

We really appreciate your help in finding bugs and vulnerabilities in this repository. Please report
bugs and vulnerabilities using [GitHub Issues](https://github.com/EYBlockchain/starlight/issues).
Loading

0 comments on commit 671ef94

Please sign in to comment.