xseven0908/pathfinder

A Starknet full node written in Rust

Welcome to Pathfinder

A StarkNet full node giving you a safe view into StarkNet.

Pathfinder is currently in alpha so expect some rough edges but it is already usable today!

Features

• access the full StarkNet state history
  • includes contract code and storage, and transactions
• verifies state using Ethereum
  • calculates the StarkNet state's Patricia-Merkle Trie root on a block-by-block basis and confirms it against L1
  • this means the contract code and storage are now locally verified
• implements the StarkNet JSON-RPC API
  • Starknet APIs like starknet.js or starknet.py full support using our JSON-RPC API for interacting with Starknet
• run StarkNet functions without requiring a StarkNet transaction
  • executed against the local state
• do fee estimation for transactions

Feedback

We appreciate any feedback, especially during this alpha period. This includes any documentation issues, feature requests and bugs that you may encounter.

For help or to submit bug reports or feature requests, please open an issue or alternatively visit the StarkNet discord channel.

Running with Docker

The pathfinder node can be run in the provided Docker image. Using the Docker image is the easiest way to start pathfinder. If for any reason you're interested in how to set up all the dependencies and the Python environment yourself please check the Installation from source guide.

The following assumes you have Docker installed and ready to go. (In case of Ubuntu installing docker is as easy as running sudo snap install docker.)

The example below uses $HOME/pathfinder as the data directory where persistent files used by pathfinder will be stored. It is easiest to create the volume directory as the user who is running the docker command. If the directory gets created by docker upon startup, it might be unusable for creating files.

The following commands start the node in the background, also making sure that it starts automatically after reboot:

# Ensure the directory has been created before invoking docker
mkdir -p $HOME/pathfinder
# Start the pathfinder container instance running in the background
sudo docker run \
  --name pathfinder \
  --restart unless-stopped \
  --detach \
  -p 9545:9545 \
  --user "$(id -u):$(id -g)" \
  -e RUST_LOG=info \
  -e PATHFINDER_ETHEREUM_API_URL="https://goerli.infura.io/v3/<project-id>" \
  -v $HOME/pathfinder:/usr/share/pathfinder/data \
  eqlabs/pathfinder

To check logs you can use:

sudo docker logs -f pathfinder

The node can be stopped using

sudo docker stop pathfinder

Updating the Docker image

When pathfinder detects there has been a new release, it will log a message similar to:

WARN New pathfinder release available! Please consider updating your node! release=0.4.5

You can try pulling the latest docker image to update it:

sudo docker pull eqlabs/pathfinder

After pulling the updated image you should stop and remove the pathfinder container then re-create it with the exact same command that was used above to start the node:

# This stops the running instance
sudo docker stop pathfinder
# This removes the current instance (using the old version of pathfinder)
sudo docker rm pathfinder
# This command re-creates the container instance with the latest version
sudo docker run \
  --name pathfinder \
  --restart unless-stopped \
  --detach \
  -p 9545:9545 \
  --user "$(id -u):$(id -g)" \
  -e RUST_LOG=info \
  -e PATHFINDER_ETHEREUM_API_URL="https://goerli.infura.io/v3/<project-id>" \
  -v $HOME/pathfinder:/usr/share/pathfinder/data \
  eqlabs/pathfinder

Available images

Our images are updated on every pathfinder release. This means that the :latest docker image does not track our main branch here, but instead matches the latest pathfinder release.

Docker compose

You can also use docker-compose if you prefer that to just using Docker.

Create the folder pathfinder where your docker-compose.yaml is

mkdir -p pathfinder

# replace the value by of PATHFINDER_ETHEREUM_API_URL by the HTTP(s) URL pointing to your Ethereum node's endpoint
cp example.pathfinder-var.env pathfinder-var.env

docker-compose up -d

To check if it's running well use docker-compose logs -f.

Configuration

The pathfinder node options can be configured via the command line as well as environment variables.

The command line options are passed in after the docker run options, as follows:

sudo docker run --name pathfinder [...] eqlabs/pathfinder:latest <pathfinder options>

Using --help will display the pathfinder options, including their environment variable names:

sudo docker run --rm eqlabs/pathfinder:latest --help

Pending Support

Block times on mainnet can be prohibitively long for certain applications. As a workaround, StarkNet added the concept of a pending block which is the block currently under construction. This is supported by pathfinder, and usage is documented in the JSON-RPC API with various methods accepting "block_id"="pending".

Note that pending support is disabled by default and must be enabled by setting poll-pending=true in the configuration options.

Logging

Logging can be configured using the RUST_LOG environment variable. We recommend setting it when you start the container:

sudo docker run --name pathfinder [...] -e RUST_LOG=<log level> eqlabs/pathfinder:latest

The following log levels are supported, from most to least verbose:

trace
debug
info  # default
warn
error

Network Selection

The StarkNet network can be selected with the --network configuration option.

If --network is not specified, network selection will default to match your Ethereum endpoint:

• StarkNet mainnet for Ethereum mainnet,
• StarkNet testnet for Ethereum Goerli

Custom networks & gateway proxies

You can specify a custom network with --network custom and specifying the --gateway-url, feeder-gateway-url and chain-id options. Note that chain-id should be specified as text e.g. SN_GOERLI.

This can be used to interact with a custom StarkNet gateway, or to use a gateway proxy.

JSON-RPC API

You can interact with StarkNet using the JSON-RPC API. Pathfinder supports the official StarkNet RPC API and in addition supplements this with its own pathfinder specific extensions such as pathfinder_getProof.

Currently pathfinder supports both v0.2.1 and v0.3.0 versions of the StarkNet JSON-RPC specification. v0.1 is not supported anymore. The path of the URL used to access the JSON-RPC server determines which version of the API is served:

• the v0.2.1 API is exposed on the / and /rpc/v0.2 paths
• the v0.3.0 API is exposed on the /rpc/v0.3 path
• the pathfinder extension API is exposed on /rpc/pathfinder/v0.1

Note that the pathfinder extension is versioned separately from the StarkNet specification itself.

API v0.2.1

Pathfinder supports v0.2.1 of the Starknet JSON-RPC specification, with the following changes:

• To be able to represent DECLARE V2 transactions introduced in Starknet 0.11.0 we use DECLARE_TXN type from v0.3.0 of the JSON-RPC specification.
• DECLARE transactions prior to introduction of DECLARE V1 are represented the same way as DECLARE_TXN_V1 type from v0.3.0 of the JSON-RPC specification, except for their version field being set to 0.
• To be able to also represent Cairo 1.x classes (i.e. Sierra classes) introduced in Starknet 0.11.0 we use CONTRACT_CLASS type from v0.3.0 of the JSON-RPC specification along CONTRACT_CLASS type from v0.2.1 for Cairo 0.x classes.

Use the playground link to check the list of methods and the parameters.

Transaction write API v0.2.1

Here are links to the specification and the playground.

Note that:

• mainnet requires an additional token parameter to submit deploy and declare transactions.
• starknet_addDeployTransaction is not supported.
• All BROADCASTED V0 transactions are not supported.
• To be able to represent BROADCASTED DECLARE V2 transactions introduced in Starknet 0.11.0 we use BROADCASTED_DECLARE_TXN type from v0.3.0 of the JSON-RPC specification.

pathfinder extension API

You can find the API specification here.

Monitoring API

Pathfinder has a monitoring API which can be enabled with the --monitor-address configuration option.

Health

/health provides a method to check the health status of your pathfinder node, and is commonly useful in Kubernetes docker setups. It returns a 200 OK status if the node is healthy.

Readiness

pathfinder does several things before it is ready to respond to RPC queries. In most cases this startup time is less than a second, however there are certain scenarios where this can be considerably longer. For example, applying an expensive database migration after an upgrade could take several minutes (or even longer) on testnet. Or perhaps our startup network checks fail many times due to connection issues.

/ready provides a way of checking whether the node's JSON-RPC API is ready to be queried. It returns a 503 Service Unavailable status until all startup tasks complete, and then 200 OK from then on.

Metrics

/metrics provides a Prometheus metrics scrape endpoint. Currently the following metrics are available:

RPC related counters

• rpc_method_calls_total,
• rpc_method_calls_failed_total,

You must use the label key method to retrieve a counter for a particular RPC method, for example:

rpc_method_calls_total{method="starknet_getStateUpdate"}
rpc_method_calls_failed_total{method="starknet_chainId"}

You may also use the label key version to specify a particular version of the RPC API, for example:

rpc_method_calls_total{method="starknet_getEvents", version="v0.3"}

Python subprocess related counters

• extpy_processes_launched_total incremented each time python subprocess is launched
• extpy_processes_exited_total with labels, incremented each time python subprocess exits normally
• extpy_processes_failed_total incremented each time python subprocess exits abnormally

Feeder Gateway and Gateway related counters

• gateway_requests_total
• gateway_requests_failed_total

Labels:

• method, to retrieve a counter for a particular sequencer request type
• tag
  • works with: get_block, get_state_update
  • valid values:
    • pending
    • latest
• reason
  • works with: gateway_requests_failed_total
  • valid values:
    • decode
    • starknet
    • rate_limiting

Valid examples:

gateway_requests_total{method="get_block"}
gateway_requests_total{method="get_block", tag="latest"}
gateway_requests_failed_total{method="get_state_update"}
gateway_requests_failed_total{method="get_state_update", tag="pending"}
gateway_requests_failed_total{method="get_state_update", tag="pending", reason="starknet"}
gateway_requests_failed_total{method="get_state_update", reason="rate_limiting"}

These will not work:

• gateway_requests_total{method="get_transaction", tag="latest"}, tag is not supported for that method
• gateway_requests_total{method="get_transaction", reason="decode"}, reason is only supported for failures.

License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Questions / FAQ

Questions are welcome! If you have any questions regarding Pathfinder, feel free to ask them using Newton.

FAQ

• How do I run a Pathfinder node?

• Why should I run a Pathfinder node?

• What resources are required to run a Pathfinder node?

• Are there rewards for running a Pathfinder node?

• How do I connect my wallet to my Pathfinder node?

• How do I interact with my Pathfinder node?

• My Alchemy dashboard usage is low?

• How to select the network my Pathfinder node runs on?

• How do I see my Pathfinder logs?

• How do I move my Pathfinder node to another server / disk?

• Error compiling Pathfinder (rust)

• Python issues with Pathfinder

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

If you would like to contribute to the py/ parts, which interface with cairo-lang, please include a mention that you agree to relicense the python parts as necessary to abide with future cairo-lang license. See contributing.md for more information.