Skip to content

Commit

Permalink
docs: readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
nagmo-starkware committed Aug 2, 2023
1 parent 67d960b commit 101a526
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,16 @@ docker run --rm --name papyrus\
For more information, see [Docker's documentation](https://docs.docker.com/config/containers/resource_constraints/#limit-a-containers-access-to-memory).


## sending API requests to the node
API requests are sent to the path `/rpc/<starknet-rpc-version-id>`.
Current supported versions are:
* V0_3_0
* V0_4_0
Assuming the node is exposed at `local-host:8080` one might send requests via curl with:
```bash
curl --location 'localhost:8080/rpc/V0_3_0' --header 'Content-Type: application/json' --data '{"jsonrpc":"2.0","id":0,"method":"starknet_blockHashAndNumber"}'
```

## Endpoints

| Endpoint | Supported |
Expand Down Expand Up @@ -153,6 +163,10 @@ For more information, see [Docker's documentation](https://docs.docker.com/confi
| `starknet_pendingTransactions` | :x: |
| `starknet_syncing` | :x: |

## Deployment
We provide a helm chart for deploying the node to a kubernetes cluster.
It is located under the deployments folder.

## Roadmap

See the [open issues](https://github.com/starkware-libs/papyrus/issues) for a list of proposed features (and known issues).
Expand Down

0 comments on commit 101a526

Please sign in to comment.