From 6a9dccf33b8cccef52fcc89f1f2524c330b0ba8c Mon Sep 17 00:00:00 2001 From: kwiss Date: Mon, 8 Jan 2024 16:37:25 +0100 Subject: [PATCH 1/5] docs: update readme --- crates/solis/messaging.local.json | 2 +- packages/deployer/README.md | 8 +++++--- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/crates/solis/messaging.local.json b/crates/solis/messaging.local.json index 8feaa1220..3dafb20bf 100644 --- a/crates/solis/messaging.local.json +++ b/crates/solis/messaging.local.json @@ -1,7 +1,7 @@ { "chain": "starknet", "rpc_url": "http://127.0.0.1:5050", - "contract_address": "0x45801fa380b09278abebacde1c528faa2392267e398ddaea3f29f798b6ba4db", + "contract_address": "0x4399750a2732c70e2349c59fe0b228c351f64153cd5997cbc286ba898b81b4e", "sender_address": "0x5686a647a9cdd63ade617e0baf3b364856b813b508f03903eb58a7e622d5855", "private_key": "0x33003003001800009900180300d206308b0070db00121318d17b5e6262150b", "interval": 2, diff --git a/packages/deployer/README.md b/packages/deployer/README.md index 721dfc34f..2a06c7b4a 100644 --- a/packages/deployer/README.md +++ b/packages/deployer/README.md @@ -1,7 +1,5 @@ # Using the Deployer -First use case local starknet with local solis - ### Environment Settings Navigate to the `root` directory and copy the .env.example for your needs, @@ -76,9 +74,13 @@ Execute the following commands in the `root` directory: ## Running & deploying ArkProject locally +**Install the dependencies:** +Follow the dojo installation guide: +https://book.dojoengine.org/getting-started/quick-start.html + **Use the following command:** -Start a katana for starknet +Start a katana for starknet with the previously installed dojo katana `katana` From 929d3632594aa577b8e3cb2b4b2aaa88e205994d Mon Sep 17 00:00:00 2001 From: kwiss Date: Mon, 8 Jan 2024 16:45:16 +0100 Subject: [PATCH 2/5] docs: update deployer readme --- packages/deployer/README.md | 29 ++++++++++++++++++++++------- 1 file changed, 22 insertions(+), 7 deletions(-) diff --git a/packages/deployer/README.md b/packages/deployer/README.md index 2a06c7b4a..0ff3faa06 100644 --- a/packages/deployer/README.md +++ b/packages/deployer/README.md @@ -74,26 +74,41 @@ Execute the following commands in the `root` directory: ## Running & deploying ArkProject locally -**Install the dependencies:** +**1. Build the Starknet contracts:** + +`cd contracts` +`scarb build --workspace` + +**2. Install the dojo dependencies:** Follow the dojo installation guide: https://book.dojoengine.org/getting-started/quick-start.html -**Use the following command:** - -Start a katana for starknet with the previously installed dojo katana +**3. Start a katana for starknet** +With the previously installed dojo, start katana using the following command: `katana` -Deploy all Starknet contracts on katana +**4. Deploy all Starknet contracts on katana** `pnpm run deploy:starknet:all` -Start Solis +or + +`pnpm run deploy:starknet` + +and + +`pnpm run deploy:starknet:tokens` -`RUST_LOG=trace cargo run -p solis -- --messaging ./messaging.local.json --dev` +**5. Start the Solis L3 sequencer:** + +`cargo run -p solis -- --messaging ./messaging.local.json --dev` +(the messaging.local.json file should be relative to your network, in our case local) **Deploy Solis contracts using:** `pnpm run deploy:solis` You can now use the SDK locally + +check the examples in the `packages/core` folder From 0f52b8a38ec0d6b1bfa8ba5991e88d57bbea0edb Mon Sep 17 00:00:00 2001 From: kwiss Date: Mon, 8 Jan 2024 16:48:56 +0100 Subject: [PATCH 3/5] docs: fix path & step --- packages/deployer/README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/packages/deployer/README.md b/packages/deployer/README.md index 0ff3faa06..16eeb32ec 100644 --- a/packages/deployer/README.md +++ b/packages/deployer/README.md @@ -77,6 +77,7 @@ Execute the following commands in the `root` directory: **1. Build the Starknet contracts:** `cd contracts` + `scarb build --workspace` **2. Install the dojo dependencies:** @@ -90,6 +91,8 @@ With the previously installed dojo, start katana using the following command: **4. Deploy all Starknet contracts on katana** +at the root of the repository execute: + `pnpm run deploy:starknet:all` or @@ -102,10 +105,14 @@ and **5. Start the Solis L3 sequencer:** +at the root of the repository execute: + `cargo run -p solis -- --messaging ./messaging.local.json --dev` (the messaging.local.json file should be relative to your network, in our case local) -**Deploy Solis contracts using:** +**6. Deploy Solis contracts using:** + +at the root of the repository execute: `pnpm run deploy:solis` From f5bdddc574fe38763a0a547f1667fb7eedf95d9d Mon Sep 17 00:00:00 2001 From: kwiss Date: Mon, 8 Jan 2024 16:50:33 +0100 Subject: [PATCH 4/5] docs: fix remove all cmd until ready --- packages/deployer/README.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/packages/deployer/README.md b/packages/deployer/README.md index 16eeb32ec..ebd2b6020 100644 --- a/packages/deployer/README.md +++ b/packages/deployer/README.md @@ -93,10 +93,6 @@ With the previously installed dojo, start katana using the following command: at the root of the repository execute: -`pnpm run deploy:starknet:all` - -or - `pnpm run deploy:starknet` and From 629b2c9c62a304ce482db057364e76008f3c0059 Mon Sep 17 00:00:00 2001 From: kwiss Date: Mon, 8 Jan 2024 17:01:19 +0100 Subject: [PATCH 5/5] docs: fix solis cmd --- packages/deployer/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/packages/deployer/README.md b/packages/deployer/README.md index ebd2b6020..7a4201028 100644 --- a/packages/deployer/README.md +++ b/packages/deployer/README.md @@ -103,7 +103,8 @@ and at the root of the repository execute: -`cargo run -p solis -- --messaging ./messaging.local.json --dev` +`cargo run -p solis -- --messaging crates/solis/messaging.local.json --dev` + (the messaging.local.json file should be relative to your network, in our case local) **6. Deploy Solis contracts using:**