Skip to content

Commit

Permalink
example docs, readme
Browse files Browse the repository at this point in the history
  • Loading branch information
drspacemn committed Nov 30, 2023
1 parent a04c09a commit b4f5446
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 15 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ jobs:
# Run end-to-end tests
- name: Run end-to-end tests
id: e2e_test
run: ./e2e-tests.sh
run: ./scripts/e2e-tests.sh
# Generate job summary
- name: Generate job summary
run: cat summary.md >> $GITHUB_STEP_SUMMARY
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ examples/wasm/dist/*
!examples/wasm/dist/index.html
examples/wasm/package-lock.json
examples/wasm/Cargo.lock
examples/core/Cargo.lock

# Beerus Documentation
book/book
Expand Down
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[workspace]
members = ["crates/core", "crates/rpc", "crates/cli"]
exclude = ["examples/wasm"]
exclude = ["examples"]
resolver = "2"

[workspace.dependencies]
Expand Down
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,12 +63,6 @@ cargo run -p beerus-cli -- -c examples/conf/beerus.toml
hurl examples/rpc/starknet_getStateRoot.hurl
```

### Examples

```bash
cargo run -p beerus-core --example basic
```

## Development

#### Build
Expand All @@ -93,6 +87,14 @@ docker build . -t beerus
docker run -e NETWORK=<arg> -e ETH_EXECUTION_RPC=<arg> -e STARKNET_RPC=<arg> -it beerus
```

#### Examples (currently broken on Helios deps)

```bash
cd examples/core
cargo run --example basic
cargo run --example call
```

##### Beerus JS(wasm demo)

Dependencies:
Expand Down Expand Up @@ -120,7 +122,7 @@ npm run build

## Endpoint support

*Starknet endpoints* (in compliance with [Starknet specs](https://playground.open-rpc.org/?uiSchema%5BappBar%5D%5Bui:splitView%5D=false&schemaUrl=https://raw.githubusercontent.com/starkware-libs/starknet-specs/master/api/starknet_api_openrpc.json&uiSchema%5BappBar%5D%5Bui:input%5D=false&uiSchema%5BappBar%5D%5Bui:darkMode%5D=true&uiSchema%5BappBar%5D%5Bui:examplesDropdown%5D=false)):
*Starknet endpoints* (in compliance with [Starknet specs](https://github.com/starkware-libs/starknet-specs)):

| Endpoint | Supported |
| :----------------------------------------- | :----------------- |
Expand Down
11 changes: 5 additions & 6 deletions examples/core/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,11 @@ version = "0.3.0"

[dependencies]
beerus-core = { path = "../../crates/core"}
tracing-subscriber.workspace = true
tracing.workspace = true
starknet.workspace = true
eyre.workspace = true
async-std = { workspace = true, features = ["attributes", "tokio1"] }

starknet = "0.6.0"
tracing = "0.1.40"
tracing-subscriber = "0.3.17"
eyre = "0.6.8"
async-std = { version = "1.12.0", features = ["attributes", "tokio1"] }

[[example]]
name = "basic"
Expand Down

0 comments on commit b4f5446

Please sign in to comment.