https://github.com/rpcpool/yellowstone-whirligig-client

Client code for Yellowstone Whirligig.
https://github.com/rpcpool/yellowstone-whirligig-client

Last synced: 10 months ago
JSON representation

Client code for Yellowstone Whirligig.

• Host: GitHub
• URL: https://github.com/rpcpool/yellowstone-whirligig-client
• Owner: rpcpool
• License: mit
• Created: 2024-02-02T12:57:05.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-02-29T05:06:20.000Z (about 2 years ago)
• Last Synced: 2024-02-29T06:24:11.082Z (about 2 years ago)
• Language: Rust
• Size: 57.6 KB
• Stars: 1
• Watchers: 8
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Whirligig Client

Client for Triton's Whirligig, Solana WebSocket interface replacement. Based on Dragon's Mouth gRPC.

https://docs.solana.com/api/websocket

## Run client

```

$ cargo run --bin ws-client -- --help

Usage: ws-client [OPTIONS] 

Commands:

  subscribe    Subscribe on updates

  get-version  Get node version

  help         Print this message or the help of the given subcommand(s)

Options:

  -e, --endpoint   WebSocket endpoint [default: ws://127.0.0.1:8000/]

  -h, --help                 Print help

$ cargo run --bin ws-client -- subscribe --help

Usage: ws-client subscribe [OPTIONS] 

Commands:

  account                 Subscribe on account updates

  logs                    Subscribe on transactions log updates

  program                 Subscribe on accounts updates owned by program

  signature               Subscribe on transaction confirmation events

  slot                    Subscribe on slot updates

  block                   Subscribe on block updates

  transaction             Subscribe on transaction updates

  transaction-deprecated  Subscribe on transaction updates (deprecated format)

  help                    Print this message or the help of the given subcommand(s)

Options:

  -c, --commitment   Commitment level of subscritpion [default: finalized] [possible values: processed, confirmed, finalized]

      --only-counter             Show only progress bar with received messages

  -h, --help                     Print help

```

## Run stress test

```

$ cargo run --release --bin ws-stress-test -- --help

Usage: ws-stress-test [OPTIONS]

Options:

  -e, --endpoint   WebSocket endpoint [default: ws://127.0.0.1:8000/streams]

  -a, --accounts   Path to file with accounts Pubkeys

  -o, --owners       Path to file with owners Pubkeys, by default some most used programs are used

  -t, --transactions         Additionally subscribe on transactions with both `accounts` and `owners`

  -h, --help                 Print help

```

By default some default accounts would be used, but you can test with specified ones. Accounts would subscribe with `account_subscribe`, owners with `program_subscribe`, accounts and owners both would subscribe with `logs_subscribe`.