equilibriumco/pathfinder v0.5.0

on GitHub

Highlights

• starknet v0.11.0 support
• RPC API v0.3 partial support
• removed several deprecated config options
• requires python 3.9 or 3.10 (no longer 3.8)

Changelog

Here is a quick overview of what's changed. More detail can be found in sections underneath.

Added

• support for state commitment and class commitment in pathfinder_getProof
• support for starknet v0.11
• partial support for RPC specification v0.3
  • exposed on /rpc/v0.3/ route
  • missing support for starknet_estimateFee and starknet_simulate

Changed

• starknet_call and starknet_estimateFee JSON-RPC methods return more detailed error messages
• python version requirement has changed to 3.9 or 3.10 (was 3.8 or 3.9 previously)

Fixed

• RPC accepts hex inputs for Felt without '0x' prefix. This led to confusion especially when passing in a decimal string which would get silently interpretted as hex.
• using a Nethermind Ethereum endpoint occasionally causes errors such as <block-number> could not be found to be logged.
• sync can miss new block events by getting stuck waiting for pending data.

Removed

• --config configuration option (deprecated in v0.4.1)
• --integration configuration option (deprecated in v0.4.1)
• --sequencer-url configuration option (deprecated in v0.4.1)
• --testnet2 configuration option (deprecated in v0.4.1)
• starknet_addDeployTransaction as this is no longer an allowed transaction since starknet v0.10.3
• RPC api version 0.1, which used to be served on path /rpc/v0.1

RPC API

We added support for v0.3 and removed v0.1. We still support v0.2 at both /rpc/v0.2 and /rpc (default) routes. In summary:

/                     # serves v0.2
/rpc/v0.2/            # serves v0.2
/rpc/v0.3/            # serves v0.3

We are missing starknet_estimateFee and starknet_simulate support for v0.3, which will be added in an upcoming release.

Python requirement

Note: this only applies if you are building from source. This does not impact docker users.

Pathfinder requires python to support the starknet VM used to simulate starknet transactions and function calls. Previous versions of the VM only worked with python 3.8 or 3.9 which was a hassle because most operating systems no longer directly support it. The new version of the VM bundled with starknet v0.11 now requires python version 3.9 or 3.10.

Configuration changes

Several configuration options are now removed, after they were deprecated in pathfinder v0.4.1. Here is a migration guide:

• --testnet2: use --network testnet2 instead
• --integration: use --network integration instead
• --sequencer-url: use --network custom in combination with --feeder-gateway-url and gateway-url
• --config: use environment variables or env files as an alternative