Skip to content

Commit

Permalink
docs(readme): deployer readme update (#242)
Browse files Browse the repository at this point in the history
## Description

<!-- 
Please do not leave this blank.
Describe the changes in this PR. What does it [add/remove/fix/replace]? 

For crafting a good description, consider using ChatGPT to help
articulate your changes.
-->

## What type of PR is this? (check all applicable)

- [ ] 🍕 Feature (`feat:`)
- [ ] 🐛 Bug Fix (`fix:`)
- [ ] 📝 Documentation Update (`docs:`)
- [ ] 🎨 Style (`style:`)
- [ ] 🧑‍💻 Code Refactor (`refactor:`)
- [ ] 🔥 Performance Improvements (`perf:`)
- [ ] ✅ Test (`test:`)
- [ ] 🤖 Build (`build:`)
- [ ] 🔁 CI (`ci:`)
- [ ] 📦 Chore (`chore:`)
- [ ] ⏩ Revert (`revert:`)
- [ ] 🚀 Breaking Changes (`BREAKING CHANGE:`)

## Related Tickets & Documents

<!-- 
Please use this format to link related issues: Fixes #<issue_number>
More info:
https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword
-->

## Added tests?

- [ ] 👍 yes
- [ ] 🙅 no, because they aren't needed
- [ ] 🙋 no, because I need help

## Added to documentation?

- [ ] 📜 README.md
- [ ] 📓 Documentation
- [ ] 🙅 no documentation needed

## [optional] Are there any post-deployment tasks we need to perform?

<!-- Describe any additional tasks, if any, and provide steps. -->

## [optional] What gif best describes this PR or how it makes you feel?

<!-- Share a fun gif related to your PR! -->

### PR Title and Description Guidelines:

- Ensure your PR title follows semantic versioning standards. This helps
automate releases and changelogs.
- Use types like `feat:`, `fix:`, `chore:`, `BREAKING CHANGE:` etc. in
your PR title.
- Your PR title will be used as a commit message when merging. Make sure
it adheres to [Conventional Commits
standards](https://www.conventionalcommits.org/).

## Closing Issues

<!-- 
Use keywords to close related issues. This ensures that the associated
issues will automatically close when the PR is merged.

- `Fixes #123` will close issue 123 when the PR is merged.
- `Closes #123` will also close issue 123 when the PR is merged.
- `Resolves #123` will also close issue 123 when the PR is merged.

You can also use multiple keywords in one comment:
- `Fixes #123, Resolves #456`

More info:
https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue
-->
  • Loading branch information
kwiss authored Jan 8, 2024
1 parent 03aa06c commit bb6c861
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 10 deletions.
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

0 comments on commit bb6c861

Please sign in to comment.