Skip to content

README.md

Latest commit

 

History

History
67 lines (53 loc) · 1.64 KB

README.md

File metadata and controls

67 lines (53 loc) · 1.64 KB

JetStream Example Client

A standalone example client to connect to JetStream proxy and process transaction data.

Features

  • Connect to JetStream gRPC endpoint
  • Filter transactions based on accounts
  • Process transaction signatures
  • Support for configuration via command-line or JSON file

For more details on updates and improvements, check the Jetstream Changelog.

Build

cargo build --release
# Run with default settings
cargo run --release

# parameters
cargo run --release -- -[params]

# Parsed endpoint subscription
cargo run --release -- -j "[PLACE_URL_HERE]" -p

Filter Configuration (JSON)

Create a filters.json file with the following structure:

{
  "filters": {
    "my-filter": {
      "account_include": ["pubkey1", "pubkey2"],
      "account_exclude": ["pubkey3"],
      "account_required": ["pubkey4"]
    },
    "another-filter": {
      "account_include": [],
      "account_exclude": [],
      "account_required": ["pubkey5", "pubkey6"]
    }
  }
}

Command-line Options

  -j, --jetstream-grpc-url <JETSTREAM_GRPC_URL>
          Jetstream gRPC URL [default: http://[SERVER-IP]:[port]]
  -f, --filter-config-path <FILTER_CONFIG_PATH>
          Filter config file path (JSON format)
  -i, --include-accounts <INCLUDE_ACCOUNTS>
          Include accounts (comma-separated Solana pubkeys)
  -e, --exclude-accounts <EXCLUDE_ACCOUNTS>
          Exclude accounts (comma-separated Solana pubkeys)
  -r, --required-accounts <REQUIRED_ACCOUNTS>
          Required accounts (comma-separated Solana pubkeys)
  -h, --help
          Print help