doc: added a new topic: Compiled class hash #1294

raizo07 · 2024-06-11T20:41:09Z

Description of the Changes

Add a topic explaining the compiled class hash. Closes #1090.

PR Preview URL

Compiled class hash

Check List

Changes have been done against main branch, and PR does not conflict
PR title follows the convention: <docs/feat/fix/chore>(optional scope): <description>, e.g: fix: minor typos in code

This change is

stoobie · 2024-07-08T14:54:33Z

@raizo07 Can you please rebase main on top of your branch? There are many directory changes that were implemented recently.

* Changed /documentation/ to /root/ in antora.yml. * Changed root to ROOT. * Change file names for SEO: * underscores to hyphens * uppercase to lowercase * Change file names for SEO to be match content matter * Added broken links from 3rd party sites * Update messaging-mechanism.adoc to latest on main. * Updated xrefs in messaging-mechanism.adoc. * Updated URL for preview to drop `/documentation/`

…sm (starknet-io#1289) * Change "cross-chain" to "cross-layer" in L1-L2 Messaging mechanism * Apply suggestions from code review

* create messaging_reference.adoc * add messaging_reference.adoc to nav * add the functions implemented in StarknetMessaging.sol but not part of the IStarknetMessaging.sol * Explain `deployer_address` * Added links between consumeMessageFromL2 function and ConsumedMessageToL2 event. * Added links between consumeMessageFromL2 function and ConsumedMessageToL2 event. * modify event descriptions and add event heading for functions * fix directory structure * Comment out events from internal `processMessages` function

* Update Starknet book ToC: Update outdated information about Starknet book --------- Co-authored-by: Steve Goodman <39279277+stoobie@users.noreply.github.com>

…#1292)

…#1306)

…hash calculation (starknet-io#1304)

…o#1296) * Update transactions.adoc with txs v3 fee estimation * Update transactions.adoc * Update transactions.adoc * Update transactions.adoc --------- Co-authored-by: Steve Goodman <39279277+stoobie@users.noreply.github.com>

…ount and declare transactions (starknet-io#1295) * Update transaction-life-cycle.adoc with finality status of deploy_account and declare transactions --------- Co-authored-by: Steve Goodman <39279277+stoobie@users.noreply.github.com>

…starknet-io#1302) * add validate warnings and refactor account functions page * fix typo * minor fixes

* Migrating Provers topic from the Starknet Book at https://book.starknet.io/ch03-03-provers.html. * Import sharp.adoc from the Book in order to bring in a commit with multiple contributors. * Edits, and removed sharp.adoc --------- Co-authored-by: Omar U. Espejel <espejelomar@gmail.com>

…knet-io#1275) * feat: add l1 handler transaction type version * fix: fix typo * fix: fix typo * fix: add a new ref to l1 handler transaction * fix: reword L1HandlerTransaction to L1 handler transaction in normal text * fix: reword for consistent format and better readability * Update components/Starknet/modules/architecture-and-concepts/pages/network-architecture/messaging-mechanism.adoc * Update components/Starknet/modules/architecture-and-concepts/pages/network-architecture/messaging-mechanism.adoc * fix: remove old file * Update components/Starknet/modules/architecture-and-concepts/pages/network-architecture/transactions.adoc Co-authored-by: Steve Goodman <39279277+stoobie@users.noreply.github.com> * fix: reword as suggested --------- Co-authored-by: Steve Goodman <39279277+stoobie@users.noreply.github.com>

…able. (starknet-io#1312)

starknet-bot · 2024-07-09T09:55:20Z

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1294/ .

components/Starknet/modules/architecture-and-concepts/nav.adoc

...ts/Starknet/modules/architecture-and-concepts/pages/smart-contracts/compiled_class_hash.adoc

starknet-bot · 2024-07-09T13:28:37Z

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1294/ .

stoobie

@raizo07 I want @LandauRaz to review this to make sure that the technical details are correct. I reviewed the topic for clarity. One thing that I think you should state clearly is who or what uses the compiled class hash, and if there's anything that the reader needs to actually do in order to create the compiled class hash or to use it once it's created. If this is all done automatically by other components, it would be helpful to state what those components are.

...ts/Starknet/modules/architecture-and-concepts/pages/smart-contracts/compiled_class_hash.adoc

starknet-bot · 2024-07-09T16:55:49Z

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1294/ .

starknet-bot · 2024-07-09T17:14:17Z

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1294/ .

starknet-bot · 2024-07-09T17:26:18Z

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1294/ .

starknet-bot · 2024-07-10T10:25:01Z

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1294/ .

starknet-bot · 2024-07-10T13:14:47Z

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1294/ .

starknet-bot · 2024-07-10T15:10:33Z

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1294/ .

raizo07 · 2024-07-13T13:26:24Z

@LandauRaz could you kindly review this?

starknet-bot · 2024-08-08T06:43:08Z

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1294/ .

LandauRaz · 2024-08-08T06:48:27Z

LGTM :) Thanks a lot, @raizo07!

LGTM

raizo07 added 2 commits June 11, 2024 20:33

doc: compiled class hash

6dc710b

further improvement to the doc

87a438d

raizo07 marked this pull request as ready for review June 15, 2024 06:28

raizo07 changed the title ~~doc: added an .md for the compile class hash~~ doc: added a .md file for the compile class hash Jun 15, 2024

stoobie requested review from stoobie and LandauRaz June 23, 2024 12:36

stoobie and others added 16 commits July 9, 2024 10:46

fix: Change "cross-chain" to "cross-layer" in L1-L2 Messaging mechani…

4c96cda

…sm (starknet-io#1289) * Change "cross-chain" to "cross-layer" in L1-L2 Messaging mechanism * Apply suggestions from code review

Removed seo-optimization branch from playbook. (starknet-io#1299)

1f5cd1a

docs: Update Starknet book ToC (starknet-io#1297)

5e97f6f

* Update Starknet book ToC: Update outdated information about Starknet book --------- Co-authored-by: Steve Goodman <39279277+stoobie@users.noreply.github.com>

fix typo adding class hashes in tx v3 invoke computation (starknet-io…

4c736dd

…#1292)

Update playbook.yml to use main branch for ui-bundle.zip (starknet-io…

1fd8ef3

…#1306)

Fix hash calculation documentation: change 1 to 0 in v1 (deprecated) …

570e2bf

…hash calculation (starknet-io#1304)

docs: add validate warnings and refactor the account's functions page (…

6104c44

…starknet-io#1302) * add validate warnings and refactor account functions page * fix typo * minor fixes

Update serialization-of-cairo-types.adoc (starknet-io#1307)

c65f21f

Update README.adoc

fc1c3c4

Added a link to info on the L1 handler tx type from the tx versions t…

004758a

…able. (starknet-io#1312)

stoobie reviewed Jul 9, 2024

View reviewed changes

components/Starknet/modules/architecture-and-concepts/nav.adoc Show resolved Hide resolved

stoobie added 2 commits July 9, 2024 16:21

Update components/Starknet/modules/architecture-and-concepts/nav.adoc

75991c6

Merge branch 'main' into doc/compiled_class_hash

63015b0

stoobie reviewed Jul 9, 2024

View reviewed changes

...ts/Starknet/modules/architecture-and-concepts/pages/smart-contracts/compiled_class_hash.adoc Outdated Show resolved Hide resolved

stoobie previously requested changes Jul 9, 2024

View reviewed changes

stoobie changed the title ~~doc: added a .md file for the compile class hash~~ doc: added a new topic: Compiled class hash Jul 9, 2024

raizo07 added 2 commits July 10, 2024 16:07

change file name to use hyphens

a3557bc

implement reviewed changes

06558e8

raizo07 requested a review from stoobie July 10, 2024 16:22

Update nav.adoc

5a6373f

LandauRaz mentioned this pull request Aug 8, 2024

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

Closed

LandauRaz approved these changes Aug 8, 2024

View reviewed changes

LandauRaz merged commit e690b8f into starknet-io:main Aug 8, 2024
1 check passed

raizo07 mentioned this pull request Aug 22, 2024

doc: Improve README of marketplace contracts Flex-NFT-Marketplace/Flex-Marketplace-Contract#87

Closed

1 task

raizo07 mentioned this pull request Oct 3, 2024

Add documentation on Block Explorers Scaffold-Stark/ss2-docs#25

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: added a new topic: Compiled class hash #1294

doc: added a new topic: Compiled class hash #1294

raizo07 commented Jun 11, 2024 •

edited by stoobie

Loading

stoobie commented Jul 8, 2024

starknet-bot commented Jul 9, 2024

starknet-bot commented Jul 9, 2024

stoobie left a comment

starknet-bot commented Jul 9, 2024

starknet-bot commented Jul 9, 2024

starknet-bot commented Jul 9, 2024

starknet-bot commented Jul 10, 2024

starknet-bot commented Jul 10, 2024

starknet-bot commented Jul 10, 2024

raizo07 commented Jul 13, 2024

starknet-bot commented Aug 8, 2024

LandauRaz commented Aug 8, 2024

doc: added a new topic: Compiled class hash #1294

doc: added a new topic: Compiled class hash #1294

Conversation

raizo07 commented Jun 11, 2024 • edited by stoobie Loading

Description of the Changes

PR Preview URL

Check List

stoobie commented Jul 8, 2024

starknet-bot commented Jul 9, 2024

starknet-bot commented Jul 9, 2024

stoobie left a comment

Choose a reason for hiding this comment

starknet-bot commented Jul 9, 2024

starknet-bot commented Jul 9, 2024

starknet-bot commented Jul 9, 2024

starknet-bot commented Jul 10, 2024

starknet-bot commented Jul 10, 2024

starknet-bot commented Jul 10, 2024

raizo07 commented Jul 13, 2024

starknet-bot commented Aug 8, 2024

LandauRaz commented Aug 8, 2024

raizo07 commented Jun 11, 2024 •

edited by stoobie

Loading