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

docs(readme): deployer readme update #242

Merged
merged 5 commits into from
Jan 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion crates/solis/messaging.local.json
Original file line number Diff line number Diff line change
@@ -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,
Expand Down
39 changes: 30 additions & 9 deletions packages/deployer/README.md
Original file line number Diff line number Diff line change
@@ -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,
Expand Down Expand Up @@ -76,22 +74,45 @@ Execute the following commands in the `root` directory:

## Running & deploying ArkProject locally

**Use the following command:**
**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

Start a katana for starknet
**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`
at the root of the repository execute:

`pnpm run deploy:starknet`

Start Solis
and

`RUST_LOG=trace cargo run -p solis -- --messaging ./messaging.local.json --dev`
`pnpm run deploy:starknet:tokens`

**5. Start the Solis L3 sequencer:**

at the root of the repository execute:

`cargo run -p solis -- --messaging crates/solis/messaging.local.json --dev`

**Deploy Solis contracts using:**
(the messaging.local.json file should be relative to your network, in our case local)

**6. Deploy Solis contracts using:**

at the root of the repository execute:

`pnpm run deploy:solis`

You can now use the SDK locally

check the examples in the `packages/core` folder
Loading