unirep / explorer Goto Github PK

The explorer of unirep on-chain data.

JavaScript 91.46% HTML 0.86% CSS 6.45% Dockerfile 0.23% Shell 0.74% Solidity 0.26%

explorer's Introduction

UniRep Protocol

💡 About UniRep

UniRep is a private and non-repudiable data system. Users can receive attestations from attesters, and voluntarily prove facts about their data without revealing the data itself. Moreover, users cannot refuse to receive attestations from an attester.

📘 Documentation

Read the medium article to know more about the concept of Unirep protocol. For more information, refer to the documentation.

📦 Project Structure

Package	Version	Description
`core`		Unirep protocol related functions.
`contracts`		Unirep smart contracts, ZKP verifiers and contract related functions.
`circuits`		Unirep circom circuits and circuit related functions.
`utils`		Utils which are used in unirep protocol.

🔋 Requirements

Intall rust and circom 2
Node.js >=16.14

🛠 Install and test

Install
```
yarn install
```
Build with trusted setup keys
```
yarn circuits keys && yarn build
```
Or build with phase 1 trusted setup circuits
```
yarn build
```
If you want to contribute to the circuits Please run yarn circuits buildOverwrite to update keys
Run test
```
yarn test
```

🎯 Contributing

Contributions are always welcome! Feel free to open any issue or send a pull request. Go to CONTRIBUTING.md and CODE_OF_CONDUCT.md to learn about how to contribute to Unirep project!

🙌🏻 Join our community

Discord server:
Twitter account:
Telegram group:

Privacy & Scaling Explorations

This project is supported by Privacy & Scaling Explorations and the Ethereum Foundation. See more projects on: https://pse.dev/projects.

explorer's People

Contributors

Stargazers

Watchers

explorer's Issues

[Backend] test failed

hardhat network not detected while runnign CI/CD for #75

[UI] Attester epoch switcher

enable viewer to switch epoch so that they can view the attestation within that epoch

[UI] Enable attester to submit information about their app

Previous thinking to have json format so that attester can upload a json that contain their app name and URL, maybe description as well

[UI] click arrows to change display order of events

for attestation events in

HomePage.jsx
EpochView.jsx

[frontend] epoch filter

Attestations/users should be filtered by epoch

[frontend] add circuit config description

add circuit config description for

HISTORY_TREE_DEPTH
FIELD_COUNT
SUM_FIELD_COUNT
REPL_NONCE_BITS
REPL_FIELD_BITS

read more description from documentation
https://developer.unirep.io/

[Protocol] Replacement data format

The replacement data field will consist of index and data
https://developer.unirep.io/docs/next/protocol/data#replacement-field

205 bits data (upper bits)
48 bits index (lower bits)

For beta 3

206 bits data (lower bits)

48 bits index (upper bits)

Some data doesn't use up to 205 bits and index will be counted from 1
so we don't have to display the whole 253 bits
e.g.
https://explorer.unirep.io/epochKey/0x234dc39bd51d43d2863585b5229749c8b23f1523059c13f01d783ccb38e75259

current version

epochKey	field Index	data	Timestamp
0x234d...75259	5	0x22c000000000000000000000000000000000000000000000000003	2 months ago

proposed solution

epochKey	field Index	data index	data	Timestamp
0x234d...75259	5	0x22c	0x03	2 months ago

[Features] Allow user to perform UST

Similar to Unirep/Unirep#168

Post event calls

Explorer will use the event from protocol to post data to FE,
https://unirep.io/docs/contracts-api/unirep-sol#events

Please research, study how to integrate these to FE.

[Frontend] explorer search not working

can only search under this network or under all network?

[Frontend] update subgraph network choices

[frontend] frontend test scripts

[Feature] Attester info description

give ECDSA signature using attester deployer key
sign text description to be shown to attester

For the initial version, we will sign a short text description about an attester site. This issue will entail ERC-1271 which describes how a smart contract can verify if a signature can sign on its behalf. However, the attester should implement this EIP, but we should check if it has been implemented or not using ERC-165. We then verify the signed message against the smart contract and update explorer.

In a follow-up issue, we can create a util that parses a stringified JSON literal.

[Frontend] favicon not found

[UI] implement activity graph elements

graph of Unirep stats on HomePage
graph of epoch activities on AttesterPage

[Design] Update data visualization

Right now we show reputation as positive/negative numbers. In Unirep/Unirep#286 we'll make the data fields more generic allowing them to be used for things other than positive/negative reputation.

So for example, an application might use the first field to store a counter for user likes (64 bits), a counter for the number of post creations (64 bits), and a counter for the number of comments created (64 bits). In this example only the first data field is being used.

The empty user data field looks like this (in binary):

00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000

When a user likes something they receive the following attestation:

00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000001

When a user creates a post they receive the following attestation:

00000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000

When these are combined (using addition) the user has a data value of

00000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000001

We can interpret this as two values stored in the data field, but only if we know how the application interprets the data. If we look at the above as raw numbers we see the following (respectively):

0
1
36893488147419103232
36893488147419103233

So it's important to look at this as data instead of numbers (like positive/negative reputation). I think on the home screen we can show total number of bytes that have been given in attestations?