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

chore: features documentation #89

Closed
wants to merge 4 commits into from
Closed

chore: features documentation #89

wants to merge 4 commits into from

Conversation

MarvyNwaokobia
Copy link
Contributor

Description

Chapter 4 documentation on features of the Starknet Scaffold

Additional Information

Copy link

vercel bot commented May 28, 2024

@MarvyNwaokobia is attempting to deploy a commit to the argentlabs Team on Vercel.

A member of the Team first needs to authorize it.

The Starknet Scaffold provides a set of features that perform various operations. This section gives a guide on how to make use of the various features available.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove The

Rewrite to:
Starknet Scaffold provides a suite of tools and features aimed at simplifying your development experience. This section provides insight on how to make use of the various features available.

3. [Faucet](./chapter_4/subchapter_3.md)
4. [Wikipedia](./chapter_4/subchapter_4.md)
5. [Converter](./chapter_4/subchapter_5.md)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's also an address book now. Please include that

@@ -0,0 +1,13 @@
# Deployer

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sub chapter names should not be written in camel case. should be instead:

subchapter_1
subchapter_2

etc

@@ -0,0 +1,13 @@
# Deployer

The scaffold deployer is a simple tool for seamlessly deploying smart contracts to Starknet testnet and mainnet.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*for seamlessly declaring and deploying


## Declare section

This section is for declaring the contract by inputing the Contract Class JSON file (Sierra) and the Compiled Contract Class JSON file (CASM). During declaration, a class hash is returned which can be used to deploy the contract.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rewrite to:

This section takes in the Contract Class JSON file (Sierra) and the Compiled Contract Class JSON file (CASM), then declares the contract.
Once declared, a class hash is returned which can be used to deploy the contract.


## Deploy section

This is for deploying a declared contract. For deploying a contract it takes in the class hash and constructor arguments as parameters.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rewrite to:

This section takes in the declared class hash and its constructor arguments, then deploys the contract.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants