[ACADEMY] Sharded Voting Example by JoE11-y · Pull Request #664 · NilFoundation/nil

JoE11-y · 2025-03-26T11:07:36Z

Closes #607

📦 Description

This PR introduces the smart contract implementation for a Sharded Voting Protocol built on the =nil; blockchain. The system is designed to efficiently handle large-scale voting by distributing vote storage and logic across multiple shards.

🔧 Key Components

VoteManager.sol
- Deploys VoteShard contracts deterministically using Nil.asyncDeploy
- Supports voting directly or via the manager using voteFromManager
- Handles asynchronous vote tallying from each shard using Nil.sendRequest
VoteShard.sol
- Stores per-voter data, tracks votes by choice
- Supports secure vote casting either directly or via the manager
- Exposes a tallyVotes() function that returns vote totals for aggregation

✅ Completed

Sharded voting logic split across VoteManager and VoteShard
Asynchronous shard deployment and communication using Nil.sol
Vote validation (one vote per address)
Aggregation of vote results after the voting period
Implement runtime test script to:

idea404

Nits

idea404 · 2025-03-31T13:50:27Z

academy/sharded-voting-protocol/README.md

+1. 📥 Clone the repository:
+
+   ```sh
+   git clone https://github.com/NilFoundation/nil-voting-protocol.git


Suggested change

git clone https://github.com/NilFoundation/nil-voting-protocol.git

git clone https://github.com/NilFoundation/nil

idea404 · 2025-03-31T13:50:59Z

academy/sharded-voting-protocol/README.md

+2. 📂 Navigate to the directory and install dependencies:
+
+   ```sh
+   cd nil-voting-protocol


Suggested change

cd nil-voting-protocol

cd academy/sharded-voting-protocol

idea404 · 2025-03-31T14:10:42Z

academy/sharded-voting-protocol/task/run-voting-protocol.ts

+  return { startTime, endTime };
+}
+
+task("e2e", "🔁 End-to-end test for sharded voting").setAction(async () => {


Suggested change

task("e2e", "🔁 End-to-end test for sharded voting").setAction(async () => {

task("run-voting-protocol", "🔁 End-to-end test for sharded voting").setAction(async () => {

JoE11-y · 2025-03-31T17:25:31Z

@idea404 Done with the edits

gitshreevatsa

Thank you for opening the PR. Things work fine! Just one small change as mentioned.

gitshreevatsa · 2025-04-01T08:45:00Z

academy/sharded-voting-protocol/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "sharded-voting-protocol",
+  "description": "This is an example repository to showcase how a lending protocol can be built on top of =nil;",


Change this to voting protocol currently it is lending protocol.

Done @gitshreevatsa

gitshreevatsa · 2025-04-01T12:20:40Z

@JoE11-y
Can you please take a look at the conflicts of the files mentioned(.gitignore, package.json and ./github/workflows/publish_npm.yaml). I see they are very minor one line changes. If they were made unintentionally, please revert those changes, if there are any significances, please explain the changes made to these 3 files.

JoE11-y · 2025-04-01T21:39:36Z

@gitshreevatsa no i didn't make those changes.

Maybe it's due to the rebasing.

I'll clean it up now.

JoE11-y · 2025-04-01T21:58:10Z

Ready to go now @gitshreevatsa

JoE11-y · 2025-04-01T21:58:55Z

Or should i make the pr again, for a cleaner history?

gitshreevatsa · 2025-04-02T05:57:04Z

It is alright, don't need to open another PR. For cleaner history you can try squashing commits instead.

gitshreevatsa · 2025-04-02T08:28:07Z

@JoE11-y Thanks a lot for your contribution! 🙌

JoE11-y marked this pull request as ready for review March 26, 2025 21:35

0xAleksaOpacic added the ODHack12 Tag for issues which are suitable for ODHack week label Mar 27, 2025

idea404 reviewed Mar 31, 2025

View reviewed changes

JoE11-y requested a review from idea404 March 31, 2025 17:25

gitshreevatsa suggested changes Apr 1, 2025

View reviewed changes

Gezort force-pushed the feature-sharded-voting-example branch from 4d6d5c8 to bbf9ab5 Compare April 1, 2025 11:26

Gezort requested review from 0xAleksaOpacic, Gezort, KlonD90, Un1oR, avm, knazarov and ukorvl as code owners April 1, 2025 11:26

Gezort force-pushed the feature-sharded-voting-example branch from bbf9ab5 to 107773e Compare April 1, 2025 11:29

JoE11-y added 4 commits April 2, 2025 13:38

feat: add sharded voting contracts

7df38a6

feat: switch to async calls for tallying

7e67bc2

feat: add e2e test

fe6a8cd

feat: finalize contract and add check against double voting

24a7538

Gezort force-pushed the feature-sharded-voting-example branch from f1745a3 to 24a7538 Compare April 2, 2025 06:40

gitshreevatsa approved these changes Apr 2, 2025

View reviewed changes

Gezort temporarily deployed to prod April 2, 2025 06:46 — with GitHub Actions Inactive

Gezort temporarily deployed to prod April 2, 2025 06:47 — with GitHub Actions Inactive

gitshreevatsa added this pull request to the merge queue Apr 2, 2025

Merged via the queue into NilFoundation:main with commit 06afb78 Apr 2, 2025
15 checks passed

	git clone https://github.com/NilFoundation/nil-voting-protocol.git
	git clone https://github.com/NilFoundation/nil

	task("e2e", "🔁 End-to-end test for sharded voting").setAction(async () => {
	task("run-voting-protocol", "🔁 End-to-end test for sharded voting").setAction(async () => {

Conversation

JoE11-y commented Mar 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📦 Description

🔧 Key Components

✅ Completed

Uh oh!

idea404 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JoE11-y commented Mar 31, 2025

Uh oh!

gitshreevatsa left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gitshreevatsa commented Apr 1, 2025

Uh oh!

JoE11-y commented Apr 1, 2025

Uh oh!

JoE11-y commented Apr 1, 2025

Uh oh!

JoE11-y commented Apr 1, 2025

Uh oh!

gitshreevatsa commented Apr 2, 2025

Uh oh!

gitshreevatsa commented Apr 2, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

JoE11-y commented Mar 26, 2025 •

edited

Loading