starknet-docs icon indicating copy to clipboard operation
starknet-docs copied to clipboard

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

Open stoobie opened this issue 1 year ago • 9 comments

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 bc419f6cfa7f3ce5e0054313b720299e12800bf2 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 avatar Jan 17 '24 14:01 stoobie

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

hardiktheprogrammer avatar Jan 22 '24 18:01 hardiktheprogrammer

@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.

stoobie avatar Jan 23 '24 08:01 stoobie

@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

hardiktheprogrammer avatar Jan 23 '24 10:01 hardiktheprogrammer

@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 avatar Mar 01 '24 08:03 stoobie

@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.

stoobie avatar Apr 01 '24 07:04 stoobie

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 ^.^

xiaolou86 avatar Apr 01 '24 08:04 xiaolou86

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

stoobie avatar Apr 02 '24 15:04 stoobie

😸 🆗

xiaolou86 avatar Apr 03 '24 02:04 xiaolou86

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

raizo07 avatar May 11 '24 03:05 raizo07

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

Also, feel free to join our Telegram group!

stoobie avatar May 20 '24 13:05 stoobie

@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 https://github.com/keep-starknet-strange/unruggable.meme/issues/228

raizo07 avatar May 20 '24 15:05 raizo07

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.

juandiegocv27 avatar May 30 '24 19:05 juandiegocv27

@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 https://github.com/keep-starknet-strange/unruggable.meme/issues/228

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

stoobie avatar Jun 04 '24 07:06 stoobie

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.

raizo07 avatar Jun 04 '24 07:06 raizo07

Closed by #1294.

LandauRaz avatar Aug 08 '24 06:08 LandauRaz