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

Request for Contribution: Add a page explaining the Compiled class hash #1090

Open
stoobie opened this issue Jan 17, 2024 · 14 comments · May be fixed by #1294
Open

Request for Contribution: Add a page explaining the Compiled class hash #1090

stoobie opened this issue Jan 17, 2024 · 14 comments · May be fixed by #1294
Assignees
Labels

Comments

@stoobie
Copy link
Collaborator

stoobie commented Jan 17, 2024

Please reply in the comments if you are interested.

Description

The Starknet docs explains the Class hash, but not the Compiled class hash. We need a similar page for the Compiled class hash that describes:

  • What it is, why it exists
  • Which entities use it, in what context
  • Make sure to state that you need to generate it somehow, such as with an SDK, before you can send a DECLARE transaction.
  • How an SDK and the sequencer calculate the compiled class hash, pseudo code is fine, as in Computing the Cairo class hash.
  • Use the information in the Note in commit bc419f6 at line 107.

Instructions for Contributing

  1. Leave a comment on this Issue indicating that you want to take ownership of this feature.
  2. Wait for our confirmation to start on the project.
  3. Once you have received confirmation, begin working on your contribution in a new branch.
  4. Create a new AsciiDoc file named compiled_class_hash.adoc in components/Starknet/modules/architecture_and_concepts/pages/Smart_Contracts.
  5. Add the new file to the table of contents by adding an xref to it in components/Starknet/modules/architecture_and_concepts/nav.adoc
  6. Follow these basic writing guidelines.
  7. Be ready to make changes based on review comments.

Remuneration

Compensation for the approved contributions will be provided via OnlyDust.

Deadline

Maximum of 10 days

Contact

If you have any questions or need further details, please contact @stoobie.


We look forward to your proposals. Thank you for contributing to the Starknet ecosystem!

@stoobie stoobie added the enhancement New feature or request label Jan 17, 2024
@stoobie stoobie self-assigned this Jan 17, 2024
@stoobie stoobie removed their assignment Jan 18, 2024
@hardiktheprogrammer
Copy link
Contributor

@stoobie I would like to work on this issue can you please assign me

@stoobie
Copy link
Collaborator Author

stoobie commented Jan 23, 2024

@hardiktheprogrammer Thank you for volunteering! It's yours. Go ahead and begin. Please make sure you read all the guidelines above and see the examples that I linked to.

@hardiktheprogrammer
Copy link
Contributor

@hardiktheprogrammer Thank you for volunteering! It's yours. Go ahead and begin. Please make sure you read all the guidelines above and see the examples that I linked to.

Thanks ser

@stoobie
Copy link
Collaborator Author

stoobie commented Mar 1, 2024

@hardiktheprogrammer Do you intend to work on this in the next week, or should I try to find someone else that can take it?

@stoobie
Copy link
Collaborator Author

stoobie commented Apr 1, 2024

@hardiktheprogrammer I am unassigning this. If you find that you can do this before someone else takes ownership, please let me know and I can reassign it to you.

@xiaolou86
Copy link
Contributor

Hello @stoobie , I want to take ownership of this feature.
I like the starknet-docs, it let me learn more day by day, and make money meanwhile ^.^

@stoobie
Copy link
Collaborator Author

stoobie commented Apr 2, 2024

Hey @xiaolou86, I really appreciate your initiative and spirit. I'd like to finish the Builtins page before assigning you another issue.

@xiaolou86
Copy link
Contributor

😸 🆗

@raizo07
Copy link

raizo07 commented May 11, 2024

Hello @stoobie If this is still open to contributions, I'd like to be assigned to it.

@stoobie
Copy link
Collaborator Author

stoobie commented May 20, 2024

@raizo07 Can you show me samples of anything you've written?

Also, feel free to join our Telegram group!

@raizo07
Copy link

raizo07 commented May 20, 2024

@raizo07 Can you show me samples of anything you've written?

Also, feel free to join our Telegram group!

@stoobie I'm a member of the Telegram group already.

Also I did the documentation for this repo https://github.com/strkfarm/starkfarm-client

This as well keep-starknet-strange/unruggable.meme#228

@juandiegocv27
Copy link

juandiegocv27 commented May 30, 2024

Hi @stoobie,

I am interested in taking ownership of this feature. I have also joined the Telegram group for further updates. It's my first contrution to this repo, but I also do documentation for anothers repo, like Dojo-Book. I'm very a searching info person, and love to talk about what to do. My main idea is to complete this issue maximum in the days that the issue indicates.

@stoobie
Copy link
Collaborator Author

stoobie commented Jun 4, 2024

@raizo07 I don't see you on the Telegram group. Can you raise your hand there?

Also I did the documentation for this repo https://github.com/strkfarm/starkfarm-client

I took a look, are you talking about the README, or the contents of the docs/ directory?

This as well keep-starknet-strange/unruggable.meme#228

I don't see anything there that you wrote, just that you asked to be assigned the issue.

@raizo07
Copy link

raizo07 commented Jun 4, 2024

https://github.com/strkfarm/starkfarm-client

Yeah I meant the README for Starkfarm and the Docusaurus model for Unruggable Meme. Yes I was assigned to both, of which I did the work and both PRs were merged. Also I tagged you on the telegram group with a raised hand.

@stoobie stoobie linked a pull request Jun 23, 2024 that will close this issue
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants