diff --git a/bin/cli.mjs b/bin/cli.mjs index b09cc52..a28b4b3 100755 --- a/bin/cli.mjs +++ b/bin/cli.mjs @@ -49,6 +49,7 @@ try { `${FRONTEND_BASE_PATH}/burner`, `${FRONTEND_BASE_PATH}/wikipedia`, `${FRONTEND_BASE_PATH}/scaffold-deployer`, + `${FRONTEND_BASE_PATH}/address-book`, `${FRONTEND_BASE_PATH}/components/Burner`, `${FRONTEND_BASE_PATH}/components/BurnerWallet`, `${FRONTEND_BASE_PATH}/components/ScaffoldDeployer`, diff --git a/docs/src/chapter_1.md b/docs/src/chapter_1.md index 2f941c3..2433ebc 100644 --- a/docs/src/chapter_1.md +++ b/docs/src/chapter_1.md @@ -1,6 +1,8 @@ -Starknet-Scaffold is a comprehensive, open-source toolkit designed for developing decentralized applications (dApps) on Starknet. This toolkit includes the most popular and functional tools, ensuring an up-to-date development environment. Starknet-Scaffold simplifies the process of forking the Starknet development stack through an adaptable frontend that seamlessly integrates with smart contracts. Additionally, it provides optimized scripts to streamline the processes of contract building, declaring, and deploying, thereby enhancing developer efficiency. +# Introduction -Starknet-Scaffold was built using a robust technology stack, including: +Starknet-Scaffold is a comprehensive, open-source toolkit designed for developing decentralized applications (dApps) on Starknet. This toolkit includes the most popular and functional tools, ensuring an up-to-date development environment. + +Starknet-Scaffold was built using a robust technology stack, which includes: 1. **NextJS**: A powerful React framework that enables server-side rendering and static site generation, improving performance and SEO for web applications. It provides a seamless development experience with features like file-based routing and API routes. diff --git a/docs/src/chapter_2/subchapter_1.md b/docs/src/chapter_2/subchapter_1.md index ffb822c..75056f2 100644 --- a/docs/src/chapter_2/subchapter_1.md +++ b/docs/src/chapter_2/subchapter_1.md @@ -1,6 +1,6 @@ # Installation -This documentation provides detailed instructions on how to install and set up Starknet-Scaffold, an open-source, up-to-date toolkit for building decentralized applications (dapps) on Starknet. +This documentation provides detailed instructions on how to install and set up Starknet-Scaffold. ## Requirements @@ -11,6 +11,7 @@ Before you begin, ensure you have the following tools installed on your system: * [Git](https://git-scm.com/downloads) * [Scarb](https://docs.swmansion.com/scarb/download.html) * [Starknet Foundry](https://foundry-rs.github.io/starknet-foundry/getting-started/installation.html) +* [Docker](https://docs.docker.com/get-docker/) ## Installation Methods @@ -19,7 +20,7 @@ Before you begin, ensure you have the following tools installed on your system: ### Method One: Using `create-starknet-app` executable. -The recommended way to start with Starknet-Scaffold is by using the `create-starknet-app` command. This method allows you to choose between different boilerplate types based on your project needs. +The recommended way to get started with Starknet-Scaffold is by using the `create-starknet-app` executable. This method allows you to choose between different boilerplate types based on your project needs. 1. Run the executable diff --git a/docs/src/chapter_2/subchapter_2.md b/docs/src/chapter_2/subchapter_2.md index 58bb437..0e49999 100644 --- a/docs/src/chapter_2/subchapter_2.md +++ b/docs/src/chapter_2/subchapter_2.md @@ -19,8 +19,6 @@ After setting up your project using either method, follow these steps to get you This will download and install all the important packages specified in the `package.json` file. 2. To build your Cairo contracts: - - Build the contract to ensure all files are correctly compiled and prepared for development: ``` npm run build-contracts @@ -32,8 +30,10 @@ After setting up your project using either method, follow these steps to get you npm run start ``` - This command will start a local server and open your default web browser to display your new Starknet-Scaffold project. + This command kickstarts a local development server for your new project. Starknet-Scaffold provides other scripts to facilitate development. We will cover more of these available scripts in the coming chapters. -You now have a fully set up and running installation of Starknet-Scaffold at https://localhost:3000. For further customization and detailed instructions, please refer to the documentation. \ No newline at end of file +starknet scaffold + +You now have a fully set up and running installation of Starknet-Scaffold at `https://localhost:3000`. For further customization and detailed instructions, please refer to the documentation. \ No newline at end of file diff --git a/docs/src/chapter_4/subchapter_1.md b/docs/src/chapter_4/subchapter_1.md index 88b4a2b..629d24e 100644 --- a/docs/src/chapter_4/subchapter_1.md +++ b/docs/src/chapter_4/subchapter_1.md @@ -9,6 +9,10 @@ This tools interface consists of two sections; the declare and deploy section. 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. +starknet deployer + ## Deploy section This section takes in the declared class hash and its constructor arguments, then deploys the contract. + +starknet deployer diff --git a/docs/src/chapter_4/subchapter_2.md b/docs/src/chapter_4/subchapter_2.md index 8d170e2..fbb34ed 100644 --- a/docs/src/chapter_4/subchapter_2.md +++ b/docs/src/chapter_4/subchapter_2.md @@ -1,6 +1,6 @@ # Burner Wallet -The burner wallet tool enables users to generate burner wallets which are temporary wallets that can be generated and used during the course of development. Burner wallets are only supported on the Sepolia network and a user can only only generate a maximum of five wallets at a time. +The Burner wallet tool enables users to generate temporary wallets for use during the course of development. Burner wallets are only supported on the Sepolia network and a user can only generate a maximum of five wallets at a time. A generated wallet UI gives us information such as ETH and STRK balance and address. The burner wallet can be funded using the [Faucet](subchapter_3.md) tool. @@ -10,6 +10,8 @@ In order for the generated burner wallet to be used, it has to be connected. Aft Transfer tokens by inputting the recipient address and amount. 2. Execute smart contract calls: - The generated wallet can execute functions from other smart contracts by inputting the contract address, function name and arguments. + Execute functions from other smart contracts by inputting the contract address, function name and arguments. -The user can also clear all generated wallets. +Users have the ability to also clear the generated wallets. + +starknet burner diff --git a/docs/src/chapter_4/subchapter_3.md b/docs/src/chapter_4/subchapter_3.md index a2bc4a2..8055eb1 100644 --- a/docs/src/chapter_4/subchapter_3.md +++ b/docs/src/chapter_4/subchapter_3.md @@ -1,3 +1,6 @@ # Faucet -This is sepETH/sepSTRK faucet tool for claiming ETH/STRK sepolia testnet tokens. In order to use it, the user types in the wallet address and specifies the test token they wish to receive then they send a request. This takes some seconds to reflect. This tool can be used to fund generated burner wallets. +This is a sepETH/sepSTRK faucet tool built by the Starknet Foundation. +You can claim ETH/STRK sepolia testnet tokens for development. This tool can be used to fund generated burner wallets. + +starknet burner diff --git a/docs/src/chapter_4/subchapter_4.md b/docs/src/chapter_4/subchapter_4.md index 57be0d6..d0b146c 100644 --- a/docs/src/chapter_4/subchapter_4.md +++ b/docs/src/chapter_4/subchapter_4.md @@ -1,12 +1,14 @@ # Wikipedia -The wikipedia tool is a collection of Starknet/Cairo learning resources in the ecosystem. These resources are in a tabular form which is paginated and sortable. +The Wikipedia is a collection of Starknet/Cairo learning resources within the ecosystem. -The columns of the table are; +The columns of the table are: -1. Name: name of the resource. -2. Description: A short description of the tool mentioned. -3. Status: States whether the tool/resource is up to date or not. -4. URL: A link to the tool/resource. +- Name: The name of the resource. +- Description: A short description of the mentioned tool. +- Status: Indicates whether the tool/resource is up-to-date or not. +- URL: A link to the tool/resource. -This tool has a search functionality to easily find resources. +This tool also includes a search functionality to easily find resources. + +starknet burner diff --git a/docs/src/chapter_4/subchapter_5.md b/docs/src/chapter_4/subchapter_5.md index c028922..45814cd 100644 --- a/docs/src/chapter_4/subchapter_5.md +++ b/docs/src/chapter_4/subchapter_5.md @@ -1,3 +1,5 @@ # Converter -A collection of utility functions for Starknet related conversions. This tool works by inputting a value you wish to convert after you are given the felt, hex, string, felt array, selector, u256, big3 equivalent that can be used anywhere else. +A collection of utility functions for Starknet related conversions. Convert between hex, felts, strings, selectors and uint256s. + +starknet burner diff --git a/docs/src/chapter_4/subchapter_6.md b/docs/src/chapter_4/subchapter_6.md index 324054e..13ee8eb 100644 --- a/docs/src/chapter_4/subchapter_6.md +++ b/docs/src/chapter_4/subchapter_6.md @@ -1,3 +1,3 @@ # Address Book -This is a tool that lists all relevant contract addresses within the starknet ecosystem. +The address book contains a list of all relevant contract addresses within the starknet ecosystem. diff --git a/docs/src/chapter_5.md b/docs/src/chapter_5.md index fc712ef..dac5442 100644 --- a/docs/src/chapter_5.md +++ b/docs/src/chapter_5.md @@ -1,87 +1,84 @@ -# Starknet-Scaffold Scripts Overview +# Scripts Overview -## Contract Scripts +## Contract Scripts -Below are scripts provided by `Starknet-Scaffold` for contract management. +Below are npx scripts provided by `Starknet-Scaffold` for your smart contract development. ### Build Contract -Initiate the contract building process with the following command. +To build your contracts: ``` npm run build-contracts ``` ### Format contracts -Leverage `Scarb’s` native formatting capabilities to tidy up your contracts. +Leverage `Scarb’s` native formatting capabilities by running: ``` npm run format-contracts ``` - -### Test contracts -The following comand will kick off the testing sequence for your contracts and receive the corresponding results. +### Test contracts +To run your Starknet Foundry tests: ``` npm run test-contracts ``` - -### Run custom `starknet-foundry` scripts -To run custom starknet foundry deploy/declare/invoke script, use the specified command, ensure to replace placeholders with actual parameters. +### Run custom `starknet-foundry` scripts +To run a custom starknet foundry deploy/declare/invoke script: ``` npm run contract-scripts --url= --account= ``` - -### Generate an SRC-5 interface ID for your contracts -Create an `SRC-5 interface ID` for your contracts using the command provided. +### Generate an SRC-5 interface ID for your contracts +To generate an `SRC-5 interface ID`, run: ``` npm run generate-interface ``` - -### Declare Contract -Declaring a contract is an important step to ensure its availability on the network. Once declared, the contract can then be implemented and interacted with. +### Prepare Account for deployment +To prepare your account for deployment, run: ``` -npm run delete-account --url= --name= --network= +npm run prepare-account --url= --name= ``` +generates a profile which is added to scarb.toml and can be passed to other commands. -### Deploy Account -After `declaring` your contract, you can use the command below to deploy. Make sure to specify the profile from `Scarb.toml` where the name corresponds to your account name. Additionally, you should provide the maximum fee +### Deploy Account +To deploy an account: ``` npm run deploy-account --profile= --name= --maxfee= ``` - +where the profile is gotten from scarb.toml, name is the prepared account and maxfee is the specified max fee. ### Delete Account -To delete an account run the following command. Please ensure to replace all placeholders with the actual parameters: +To delete an account: ``` npm run delete-account --url= --name= --network= ``` - +### Declare Contract +To declare a Starknet contract: +``` +npm run delete-account --url= --name= --network= +``` ### Starknet-Devnet -Confirm that Docker is installed and running correctly to utilize starknet-devnet effectively. +Confirm that Docker is installed and running to use starknet-devnet. To run devnet: ``` npm run devnet ``` - ## User Interface Scripts The following are scripts from `Starknet-Scaffold` for handling the user interface. - ### Run Frontend -To run UI, from the `base` repository: +To run UI, from the base repository: ``` npm run start ``` - - ### Run Frontend -For compiling your frontend, in the `root` directory execute: +To build your frontend, from the base repository run: ``` npm run build-ui ``` diff --git a/docs/src/chapter_6.md b/docs/src/chapter_6.md index 503fcb2..cffce9f 100644 --- a/docs/src/chapter_6.md +++ b/docs/src/chapter_6.md @@ -2,18 +2,17 @@ ## Introduction -Starknet Devnet is a development network (devnet) implemented in Rust, similar to the Python-based starknet-devnet.With Devnet, you can simulate Starknet in the comfort of your local network. Fork mainnet/testnet to interact with real-world smart contracts, while maintaining isolation. +Starknet Devnet is a development network (devnet) implemented in Rust. With Devnet, you can simulate Starknet in the comfort of your local network. Fork mainnet/testnet to interact with real-world smart contracts, while maintaining isolation. ## Prerequisites: - -1. Docker Installation: Docker has to be installed for the script to work. +Docker has to be installed for the script to work. ## Run Starknet-Devnet -Ensure to have Docker installed. To run starknet-devnet: +To run starknet-devnet: ``` npm run devnet ``` -Check out the official starknet devnet documentation [here](https://book.starknet.io/ch02-06-starknet-devnet.html). +Check out the official starknet devnet documentation [here](https://0xspaceshard.github.io/starknet-devnet-rs/). diff --git a/docs/src/chapter_7.md b/docs/src/chapter_7.md index 08b5dd4..c65898f 100644 --- a/docs/src/chapter_7.md +++ b/docs/src/chapter_7.md @@ -1,4 +1,4 @@ -# Starknet Address Book +# Address Book @@ -10,6 +10,7 @@ This provides a detailed list of relevant contract addresses on Starknet, includ | -------------------- | ------------------------------------------ | | Core Contract | 0xc662c410C0ECf747543f5bA90660f6ABeBD9C8c4 | | GpsStatementVerifier | 0x47312450B3Ac8b5b8e247a6bB6d523e7605bDb60 | +| STRK | 0x04718f5a0fc34cc1af16a1cdee98ffb20c31f5cd61d6ab07201858f4287c938d | ### Tokens diff --git a/docs/src/chapter_8.md b/docs/src/chapter_8.md index f266f21..29e7d93 100644 --- a/docs/src/chapter_8.md +++ b/docs/src/chapter_8.md @@ -1,4 +1,4 @@ -# Starknet-Scaffold Contributing Guide +# Contributing Guide Welcome to the Starknet Scaffold contributing guide! Thank you for investing your time in contributing to our project. This guide aims to provide a comprehensive overview of the contribution workflow, ensuring an effective and efficient process for everyone involved. diff --git a/docs/src/public/burner.png b/docs/src/public/burner.png new file mode 100644 index 0000000..440ef85 Binary files /dev/null and b/docs/src/public/burner.png differ diff --git a/docs/src/public/converter.png b/docs/src/public/converter.png new file mode 100644 index 0000000..8b6cb60 Binary files /dev/null and b/docs/src/public/converter.png differ diff --git a/docs/src/public/declare.png b/docs/src/public/declare.png new file mode 100644 index 0000000..629575c Binary files /dev/null and b/docs/src/public/declare.png differ diff --git a/docs/src/public/deploy.png b/docs/src/public/deploy.png new file mode 100644 index 0000000..b5c8f95 Binary files /dev/null and b/docs/src/public/deploy.png differ diff --git a/docs/src/public/faucet.png b/docs/src/public/faucet.png new file mode 100644 index 0000000..82499c2 Binary files /dev/null and b/docs/src/public/faucet.png differ diff --git a/docs/src/public/home.png b/docs/src/public/home.png new file mode 100644 index 0000000..11fd83f Binary files /dev/null and b/docs/src/public/home.png differ diff --git a/docs/src/public/wikipedia.png b/docs/src/public/wikipedia.png new file mode 100644 index 0000000..82838ac Binary files /dev/null and b/docs/src/public/wikipedia.png differ