Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Volara committed Oct 6, 2024
1 parent 7beec7f commit 3715ab4
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 11 deletions.
12 changes: 3 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Vana Satya Proof of Contribution - Python Template
# Volara Satya Proof of Contribution

This repository serves as a template for creating a [proof of contribution](https://docs.vana.org/vana/core-concepts/key-elements/proof-of-contribution) tasks using Python. It is executed on Vana's Satya Network, a group of highly confidential and secure compute nodes that can validate data without revealing its contents to the node operator.
This repository provides proof of contribution using Satya validators for the Volara dataset on the Vana network.

## Overview

Expand Down Expand Up @@ -56,9 +56,7 @@ The main proof logic is implemented in `volara_proof/proof.py`. To customize it,

The proof can be configured using environment variables. When running in an enclave, the environment variables must be defined in the `volara-proof.manifest.template` file as well. The following environment variables are used for this demo proof:

- `USER_EMAIL`: The email address of the data contributor, to verify data ownership

If you want to use a language other than Python, you can modify the Dockerfile to install the necessary dependencies and build the proof task in the desired language.
- `COOKIES`: The cookies for the data contributor

## Local Development

Expand Down Expand Up @@ -147,10 +145,6 @@ This template leverages several security features:
3. **Input/Output Isolation**: Input and output directories are mounted separately, ensuring clear data flow boundaries.
4. **Minimal Attack Surface**: The Gramine manifest limits the files and resources accessible to the enclave, reducing potential vulnerabilities.

## Customization

Feel free to modify any part of this template to fit your specific needs. The goal is to provide a starting point that can be easily adapted to various proof tasks.

## Contributing

If you have suggestions for improving this template, please open an issue or submit a pull request.
Expand Down
3 changes: 1 addition & 2 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ python-gnupg==0.5.2
requests==2.31.0
twitter-api-client==0.10.22
flatbuffers==24.3.25
numpy==2.0.1
aiohttp
numpy==2.0.1

0 comments on commit 3715ab4

Please sign in to comment.