unirep / unirep-social

An anonymous social media platform.

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.

unirep-social's Issues

[backend] Register user signup with interep contract. Check for double registration

Don't store full post content on blockchain

Build airdrop system in unirep social

[Design] Allow user to edit & delete the post during epoch

[frontend] Show username on post or comment if a graffiti pre-image was proved

• design
• implement

Rich Text Editor: integrate to Unirep Social frontend

[contracts] Add function to claim a username

• Add a mapping of hashed usernames to booleans to prevent multiple users having the same username
• Add a function to attest to an updated graffiti value

[frontend] correctly show spent and activities

[Design] UI for user name input and selection when posting

[frontend] change signup flow UI/UX to oauth with Github/Twitter/Reddit.

after designer has designed the new flow and UI

[frontend] Edit post functionality

[contracts] Allow negative rep proof to collect airdrop from subsidy

Mobile navigation is missing

In the responsive view, the navigation was just display as burger menu,
we want to help the navigation when user is in mobile.

current:

expected result:

[frontend] Add text field to set a username

• add request to the backend
• add text field on user page

[frontend] user transition interface shouldn't block the whole screen

As a user I want to keep reading the website without having to UST if I don't want to.

[frontend/backend] Add oauth logic for Github/Twitter/Reddit

Don't connect to database, just go through the flow and callback. Database connection/identity registration will be in a different task.

[frontend] new rep system interaction implementation

[Design] Adjust "about" page so user can learn the updated info

Need to revisit the about page to see if all information are up to dated.

UI bug on "get started"

the border width is too large at right side

the progress bar is way too wide, it should be same width as the content, see expected result

mobile view we probably can enhance more, but above here is nice to fixed, not a deal breaker. btn position seems offset 4 px at y-axis and the progress bar went off the screen.

Remove sinon-chai dep

Let's make sure to bump our hardat chai matcher version and remove sinon-chai when NomicFoundation/hardhat#2843 is merged.

[circuits] Allow a user to prove negative reputation

[Design] Allow user to search a hashtag/topic

[Frontend] Back to top button should not be shown if no content

currently, the back to top button is at a fixed location, no matter what scenario.

sometimes the post is pretty short, it doesn't need to display back to top.

Cache proving keys

Right now the prover downloads the proving and verifying keys every time it verifies or proves. We need to cache these files locally to avoid excessive network requests.

[Frontend] The banner should be dismissable

when user click "close" at top banner, next time they login, the banner should automatically hide.

[frontend] correctly show progress

[frontend] Show user balance and spend from subsidy

[contracts] Edit post functionality

We can allow a user to edit a post by providing a proof of epoch key ownership, the old hash of the post, and the new content.

Includes a function taking an old hash + new hash + proof.

[contracts] Proof nullifiers to prevent replay attack

If we use proofs other from Unirep contract (proveNegativeRep, proveSubsidyKey,...) we should use a proof nullifier (as in Unirep contract) to prevent replay attack (e.g. other users can use the same proof to post with subsidy and use the subsidy quota of others)

[contracts] Allow action to spend from subsidy or rep proof

[frontend+backend] Add button for user to do negative reputation proof

Reputation creation

Right now we give people 30 rep every epoch. Instead we could use a system where users get a 30 rep subsidy each epoch. The first 30 rep spent is covered by the system. After that it's taken out of the users rep balance. If the user doesn't spend or receive any rep in an epoch their balance is unchanged.

• rep is only created by interactions in the system
• people can't hoard rep by getting airdrops and never spending
• if people create posts/comments just for exchanging rep others can vote and take rep away (vote negatively on the posts/comment for free)

This would also make the case of missing an epoch more clean. Right now if a user doesn't do a UST for an epoch they miss 30 rep for each epoch they skip.

[backend] Search function

[circuit] Write a circuit that proves an epoch key and graffiti pre-image only

Currently, ReputationProof circuit is the only thing we have for verifying graffiti pre-image. We should write a circuit that proves an epoch key and graffiti pre-image only. It will save lots of calldata.
Context: #96 (comment)

Gas price watcher

The transaction manager has a hardcoded gas price right now. This should be changed to a value that is calculated periodically using the median gas price. Omitting the field and allowing ethers to automatically fill it caused an error for some reason.

It's probably a good idea to do this ourselves anyway so we can in the future do things like optimize away from local highs in the gas markets.

[Design] New rep system interaction

Iterate the UI to provide clarity for user when they interact with the app

relate to: #76

[backend] Edit post functionality

• Accept a proof, send the transaction
• Hash the post content
• Update the database

[Frontend] As a user, I'd like to see the topic (hastag) and all related post so I can follow the related conversation

[frontend/backend] change signup flow FUNCTION to oauth with Github/Twitter/Reddit

[frontend] Allow a user to prove their username (graffiti pre-image) when proving reputation (posting/commenting/voting)

Event synchronization

The backend currently loads all events at once using a queryFilter call. This will break after a few hundred events exist for a topic. I solved this problem in zkopru by starting at the block where the contract was created (or the block of the latest event in the DB) and then loading events for a batch of 1000 blocks, then ingesting, then repeat. Once I reach the head block I start a subscription listener. You can see it here. I think we should use a similar strategy for this backend.

[frontend] Infinite scroll

As an user, I want the page can be infinitely scrolled so that I won't feel bored

[backend] Add a route to request a username

We need a route to request a username. This could be /api/usernames POST.

• The route should accept and verify a ZK proof proving the epoch key and current graffiti pre-image
• The route should accept a username that is being requested

The route should then check if the username is free, and if it is use the setUsername function in the unirep social contract to claim it. The username will need to be hashed with poseidon offchain so the hash is what is submitted in the contract call.

Refactor to use on chain trees

[contracts] deploy interep contract with unirep-social contract

[Fronted] Release note

As a team, we would like to inform users of what has been released in the build, so that users can learn the progress of the app.

• probably better using CMS for this type of thing, either on wordpress or other, something simple.

Rich Text Editor: collaborate with Tsukino

As an user, I want to edit my post or comment with freely styling to make my article looks great

• collaborate with tsukino
• integrate to Unirep-Social and adjust the styling

[Design] Easily sign up

Related to:

• #44
• #36

[core] should add tests for unirep social synchronizer

• Synchronizer should successfully catches events
• Synchronizer should successfully store data in db

Jest SyntaxError: Cannot use import statement outside a module

Describe the bug
The issue I am facing is configuring Jest to understand ESM modules. Specifically, when I test the router.js file get the error SyntaxError: Cannot use import statement outside a module. This can only happen if the configurations are off, but not sure where the problem is after trying multiple different configurations. I made a StackOverflow with the configurations and errors I have and can make a PR if anyone would know a better way to configure this.

To Reproduce
Steps to reproduce the behavior:

1. Use current configurations for Jest and Bable shown in the StackOverflow post
2. Run yarn test src/__tests__/router.js
3. See error: SyntaxError: Cannot use import statement outside a module

Expected behavior
Passing test

Screenshots
Screen shot is in StackOverflow post but will show code-trace here:

Additional context
More context can be given surrounding this issue by reading the links to the post I specified in the StackOverflow post.