dipdup-io / stone-packaging

Various forms of distribution for the Starkware Stone prover and verifier
https://stone-packaging.pages.dev
MIT License
16 stars 28 forks source link

[Book] Stone configuration #29

Closed dmirgaleev closed 1 month ago

dmirgaleev commented 1 month ago

Add a documentation page that describes how to create a configuration file for the Stone prover, what are the security settings of the FRI protocol, what is the format of the config file.

Path to your markdown file: docs/pages/usage/configuration.md

References:

Jemiiah commented 1 month ago

Hi @dmirgaleev ,Please let me work on this when od hack starts.

onlydustapp[bot] commented 1 month ago

Hi @Jemiiah! Maintainers during the ODHack # 8.0 will be tracking applications via OnlyDust. Therefore, in order for you to have a chance at being assigned to this issue, please apply directly here, or else your application may not be considered.

anonfedora commented 1 month ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I’m a blockchain developer with strong experience in building smart contracts and working with blockchain protocols. I’ve worked with technologies like Solidity, Cairo, and zero-knowledge proofs, which are at the core of systems like the Stone prover. I also have skills in Backend/Frontend web development using TypeScript, and ReactJS, NestJS, so I can document and explain complex setups in a way that makes sense.

How I plan on tackling this issue

With my background in zk-proof systems and experience in dApp development, I understand how to configure protocols to ensure security and efficiency. This means I can write documentation that’s not only clear but also practical for developers.

First, I’d do a deep dive into the Stone prover and FRI protocol to fully understand how the configuration file works and what the security settings are. From there, I’ll break down the documentation into three parts:

Creating the Config File – I’ll guide users through setting up the config file, explaining each option in a simple way, with recommended settings.

FRI Protocol Security Settings – I’ll break down the security options for the FRI protocol, like how to set up soundness and error correction, and explain what each setting does in terms of security.

Config File Format – I’ll provide the actual format of the config file (JSON or YAML), with explanations for each field and sample configurations to make things easy to follow.

Finally, I’ll test everything myself to make sure the instructions are correct and work in practice. By keeping it clear and straightforward, I’ll make sure the documentation is helpful for both beginners and experienced developers.

CollinsC1O commented 1 month ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I am a front-end and also a blockchain developer with experience in technical writing and documentation

How I plan on tackling this issue

I can implement a very good documentation on the Stone configuration

Jemiiah commented 1 month ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

@dmirgaleev I would love to work on this issue when ODHack starts I have worked on about 6 different documentation issue on different repositories this is my OD Hack portfolio : https://app.onlydust.com/u/Jemiiah I have a very good track record on docs issues here are some of the repositories I have worked on: Flex-NFT-Marketplace/Flex-Marketplace-Contract#106 dragan2234/worldcoin-scroll-bridge#13 dragan2234/worldcoin-scroll-bridge#11 NethermindEth/StarknetByExample#200

How I plan on tackling this issue

accurately and follow all instructions provided above

LazarusAA commented 1 month ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Hi, I'm Alvaro Lazarus a passionate blockchain developer with experience on Solidity, Cairo, Rust, TypeScript, Python and zero-knowledge proofs. I love working on clean documentations which makes me confident I can complete this issue perfectly, Id love for this to be my first contribution to the Stone-Packaging project.

How I plan on tackling this issue

  1. Research: Explore the Stone prover and FRI protocol to gain a solid understanding of the configuration file and its security settings.

  2. Documentation Structure: Break the documentation into three main parts:

  1. Verification: Test all instructions to confirm they are accurate and functional.

  2. Maintain Clarity: Ensure the documentation is easy to follow and accessible for developers of all skill levels.

dmirgaleev commented 1 month ago

Hello @Jemiiah! Welcome aboard! Please don't hesitate to join our Telegram group https://t.me/baking_bad_odhack to ask questions and share your progress! Happy hacking!

Jemiiah commented 1 month ago

thank you @dmirgaleev already in the group if I have any question won't hesitate to ask

dmirgaleev commented 1 month ago

Hey @Jemiiah! Do you have any progress so far?

Jemiiah commented 1 month ago

@dmirgaleev would be creating a PR today sorry for the delay

dmirgaleev commented 1 month ago

Friendly heads up that you have until Sunday (October 6) to push your final PR. @Jemiiah

Jemiiah commented 1 month ago

okay great sir