diff --git a/docs/src/chapter_5.md b/docs/src/chapter_5.md index d4ea4a9..c4c796b 100644 --- a/docs/src/chapter_5.md +++ b/docs/src/chapter_5.md @@ -66,26 +66,21 @@ npm run delete-account --profile= --account-file= --keystore= --account= --contract-name= --url= --fee-token= +npm run declare-contract --profile= --contract-name= --url= --fee-token= ``` -when `profile` is specified, `keystore`, `account` and `url` are not needed. But when `profile` is not specified, all three of them need to be provided. - ### Deploy Contract To deploy a contract: ``` -npm run deploy-contract --profile= --keystore= --account= --feetoken= --class= --url= +npm run deploy-contract --profile= --feetoken= --class= --url= ``` -when `profile` is specified, `keystore`, `account` and `url` are not needed. But when `profile` is not specified, all three of them need to be provided. - ### Starknet-Devnet Confirm that Docker is installed and running to use starknet-devnet. To run devnet: ``` npm run devnet ``` - ## Dojo Scripts The `contracts` folder contains all the tools needed to write, build, test and deploy dojo projects. It is built with sozo and katana. Here are common operations you can perform on your dojo contracts. @@ -113,6 +108,48 @@ To migrate your dojo project, from the base repository run: npm run migrate-dojo --name= ``` +## Kakarot Scripts +Below are npm scripts provided by `Starknet-Scaffold` for your Kakarot development. + +### Setup Kakarot +To setup Kakarot, from the base repository run: +``` +npm run setup-kakarot +``` + +### Start Kakarot +To start Kakarot, from the base repository run: +``` +npm run start-kakarot +``` + +### Deploy Kakarot L1 Messaging Contracts to Local RPC +To deploy Kakarot l1 messaging contracts locally, from the base repository run: +``` +npm run deploy-kakarot-l1-messaging-contracts-local +``` + +### Deploy Kakarot EVM Contract +To deploy a Kakarot EVM contract, from the base repository run: +``` +npm run deploy-kakarot-evm-contract --contract-path= --rpc-url= --private-key= +``` +If you need to specify constructor args, run: +``` +npm run deploy-kakarot-evm-contract --contract-path= --constructor-args= --rpc-url= --private-key= +``` + +### Declare Cairo Contract Using Keystore +To declare a Cairo contract using keystore, from the base repository run: +``` +npm run keystore-declare-contract --keystore= --account= --contract-name= --url= --fee-token= +``` + +### Deploy Cairo Contract Using Keystore +To deploy a Cairo contract using keystore, from the base repository run: +``` +npm run keystore-deploy-contract --keystore= --account= --url= --fee-token= --class-hash= +``` ## User Interface Scripts