Skip to content

Commit e9ea4da

Browse files
committed
docs: update readme
1 parent 3e62655 commit e9ea4da

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,17 @@ The system consists of multiple integrated contracts:
1717
- **VotsElectionNft**: NFT contract that mints commemorative tokens for election creators
1818
- **VotsEngineFunctionClient**: Handles external verification requests using Chainlink Functions
1919

20+
## 🔗 Chainlink Integration Files
21+
22+
The following files implement Chainlink Functions for external voter verification:
23+
24+
- **[VotsEngineFunctionClient.sol](src/VotsEngineFunctionClient.sol)** - Main Chainlink Functions client contract
25+
- **[IVotsEngineFunctionClient.sol](src/interfaces/IVotsEngineFunctionClient.sol)** - Interface for the function client
26+
- **[source.js](server/source.js)** - JavaScript code executed by Chainlink Functions
27+
- **[upload-secrets-1.js](server/upload-secrets-1.js)** - Configuration for Chainlink Functions secrets
28+
29+
> **Note**: The system uses Chainlink Functions to connect with external APIs for voter verification in a sandbox environment.
30+
2031
## ✨ Features
2132

2233
### Core Functionality
@@ -202,11 +213,11 @@ bytes32 requestId = VotsEngine.sendVerificationRequestForElection(
202213
subscriptionId // Chainlink subscription ID
203214
);
204215
```
205-
![VotsEngineFunctionClient](src/VotsEngineFunctionClient.sol)
206-
207216

208217
**Note**: The current implementation uses a sandbox environment for API verification, making it suitable for testing and demonstration purposes.
209218

219+
For detailed Chainlink Functions setup, see the [Chainlink integration files](#🔗-chainlink-integration-files) listed above.
220+
210221
### Voting Process
211222

212223
1. **Accredit Voter** (Polling Officer at physical location):

0 commit comments

Comments
 (0)