Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restruct code (2) #59

Closed
3 of 4 tasks
rrtoledo opened this issue Nov 7, 2024 · 0 comments
Closed
3 of 4 tasks

Restruct code (2) #59

rrtoledo opened this issue Nov 7, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@rrtoledo
Copy link
Collaborator

rrtoledo commented Nov 7, 2024

Why

Add single point of access to the user with a wrapper class to facilitate generics and avoid parameter redundancy

What

image

Tasks

@rrtoledo rrtoledo self-assigned this Nov 7, 2024
@rrtoledo rrtoledo added the enhancement New feature or request label Nov 7, 2024
@rrtoledo rrtoledo linked a pull request Nov 12, 2024 that will close this issue
9 tasks
@rrtoledo rrtoledo linked a pull request Dec 24, 2024 that will close this issue
9 tasks
@rrtoledo rrtoledo mentioned this issue Jan 2, 2025
9 tasks
rrtoledo added a commit that referenced this issue Jan 21, 2025
## Content

This PR includes:
- Moving Hashes in utils
- Fixing clippy

## Pre-submit checklist

- Branch
    - [x] Tests are provided (if possible)
    - [x] Commit sequence broadly makes sense
    - [x] Key commits have useful messages
- PR
    - [x] No clippy warnings in the CI
    - [x] Self-reviewed the diff
    - [x] Useful pull request description
    - [x] Reviewer requested
- Documentation
    - [x] Update README file (if relevant)
    - [x] Update documentation website (if relevant)

## Comments

Misc changes from  from former #66 and #116

## Issue(s)

Relates to #59
rrtoledo added a commit that referenced this issue Jan 21, 2025
## Content


This PR includes
- Rename wrapper file and structure to Telescope

## Pre-submit checklist

- Branch
    - [x] Tests are provided (if possible)
    - [x] Commit sequence broadly makes sense
    - [x] Key commits have useful messages
- PR
    - [x] No clippy warnings in the CI
    - [x] Self-reviewed the diff
    - [x] Useful pull request description
    - [x] Reviewer requested
- Documentation
    - [x] Update README file (if relevant)
    - [x] Update documentation website (if relevant)

## Comments

Rename wrapper commits from former #66 and #116

## Issue(s)

Relates to #59
rrtoledo added a commit that referenced this issue Jan 21, 2025
## Content

This PR includes:
- Remove params structure dealing with user parameters
- Rename setup structure params (dealing with internal parameters)
- Move init.rs into setup.rs and use implementation block

## Pre-submit checklist

- Branch
    - [x] Tests are provided (if possible)
    - [x] Commit sequence broadly makes sense
    - [x] Key commits have useful messages
- PR
    - [x] No clippy warnings in the CI
    - [x] Self-reviewed the diff
    - [x] Useful pull request description
    - [x] Reviewer requested
- Documentation
    - [x] Update README file (if relevant)
    - [x] Update documentation website (if relevant)

## Comments

Misc changes from  former #66 and #116

## Issue(s)

<!-- The issue(s) this PR relates to or closes -->

Relates to #59
rrtoledo added a commit that referenced this issue Jan 21, 2025
## Content


This PR includes:
- Moves algo.rs into proof.rs and use implementation block

## Pre-submit checklist

- Branch
    - [x] Tests are provided (if possible)
    - [x] Commit sequence broadly makes sense
    - [x] Key commits have useful messages
- PR
    - [x] No clippy warnings in the CI
    - [x] Self-reviewed the diff
    - [x] Useful pull request description
    - [x] Reviewer requested
- Documentation
    - [x] Update README file (if relevant)
    - [x] Update documentation website (if relevant)

## Comments

Misc changes from  former #66 and #116
## Issue(s)


Relates to #59
rrtoledo added a commit that referenced this issue Jan 21, 2025
## Content

This PR includes:
- Adding doc to public facing functions

## Pre-submit checklist

- Branch
    - [x] Tests are provided (if possible)
    - [x] Commit sequence broadly makes sense
    - [x] Key commits have useful messages
- PR
    - [x] No clippy warnings in the CI
    - [x] Self-reviewed the diff
    - [x] Useful pull request description
    - [x] Reviewer requested
- Documentation
    - [x] Update README file (if relevant)
    - [x] Update documentation website (if relevant)

## Comments
Misc changes from former #66
and #116

To easily import the doc changes, I had to import some changes on the
code. These can be dismissed in this PR as they are already in previous
ones.

## Issue(s)

Relates to #59
rrtoledo added a commit that referenced this issue Jan 21, 2025
## Content

Blocked by #116.

This PR aims at restructuring the Simple Lottery code (similarly to PR
#116 for Centralized telescope) to have a user facing structure from
which we can directly prove and verify. More particularly,

- Moves code in implementation block
- Moves implementation block in struct file
- Renamed the user facing wrapper structure
- Removed the user parameter structure and renamed the internal
parameter structure

Additionnally, this PR
- Fixed error in proof generation
- Add documentation to public facing functions

## Pre-submit checklist

- Branch
    - [x] Tests are provided (if possible)
    - [x] Commit sequence broadly makes sense
    - [x] Key commits have useful messages
- PR
    - [x] No clippy warnings in the CI
    - [x] Self-reviewed the diff
    - [x] Useful pull request description
    - [x] Reviewer requested
- Documentation
    - [x] Update README file (if relevant)
    - [x] Update documentation website (if relevant)

## Comments


## Issue(s)

<!-- The issue(s) this PR relates to or closes -->

Relates to #59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
1 participant