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: Updated README with trace endpoints & requirements note #872

Merged
merged 4 commits into from
Apr 7, 2022
Merged
Changes from 1 commit
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
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ NOTE: Node LTS (`long term support`) versions start with an even number, and odd
- [Available endpoints](https://paritytech.github.io/substrate-api-sidecar/dist/)
- [Chain integration guide](./guides/CHAIN_INTEGRATION.md)
- [Docker](#docker)
- [Note for maintainers](#note-for-maintainers)
- [Notes for maintainers](#notes-for-maintainers)
- [Hardware requirements](#hardware-requirements)

## NPM package installation and usage

Expand Down Expand Up @@ -93,6 +94,18 @@ node_modules/.bin/substrate-api-sidecar

[Click here for full endpoint docs.](https://paritytech.github.io/substrate-api-sidecar/dist/)

In the full endpoints doc, you will also find the following `trace` related endpoints :
- /experimental/blocks/{blockId}/traces/operations?actions=false
- /experimental/blocks/head/traces/operations?actions=false
- /experimental/blocks/{blockId}/traces
- /experimental/blocks/head/traces
Imod7 marked this conversation as resolved.
Show resolved Hide resolved

To have access to these endpoints you need to :
1. Run your node with the flag `—unsafe-rpc-external`
2. Check in sidecar if `BlocksTrace` controller is active for the chain you are running.

Currently `BlocksTrace` controller is active in [Polkadot](https://github.com/paritytech/substrate-api-sidecar/blob/ff0cef5eaeeef74f9a931a0355d83fc5ebdea645/src/chains-config/polkadotControllers.ts#L17) and [Kusama](https://github.com/paritytech/substrate-api-sidecar/blob/ff0cef5eaeeef74f9a931a0355d83fc5ebdea645/src/chains-config/kusamaControllers.ts#L17).

## Source code installation and usage

### Quick install
Expand Down Expand Up @@ -373,3 +386,7 @@ NOTE: You must be a member of the `@substrate` NPM org and must belong to the `D
#### Publish Calc Package

1. `cd` into `calc/pkg` and `npm login`, then `npm publish`.

## Hardware requirements

Sidecar is a stateless program and thus has no specific hardware requirements to run (disk space, memory, etc.).
Imod7 marked this conversation as resolved.
Show resolved Hide resolved