yellowstone-grpc/README.md

51 lines
2.6 KiB
Markdown
Raw Normal View History

2022-10-19 07:34:41 -07:00
# Public GRPC interface to Geyser
### Validator
```bash
$ solana-validator --geyser-plugin-config ./config.json
```
### Client
- Always broadcast new slots
- Accounts can be filtered by `pubkey` and `owner` fields, also all accounts can be broadcasted with `*`
```
2022-10-20 16:43:19 -07:00
$ cargo run --bin client -- --accounts --account SysvarC1ock11111111111111111111111111111111
Finished dev [unoptimized + debuginfo] target(s) in 0.69s
Running `target/debug/client --accounts --account SysvarC1ock11111111111111111111111111111111`
2022-10-19 07:34:41 -07:00
stream opened
2022-10-20 16:43:19 -07:00
new message: SubscribeUpdate { filters: ["client"], update_oneof: Some(Account(SubscribeUpdateAccount { account: Some(SubscribeUpdateAccountInfo { pubkey: [6, 167, 213, 23, 24, 199, 116, 201, 40, 86, 99, 152, 105, 29, 94, 182, 139, 94, 184, 163, 155, 75, 109, 92, 115, 85, 91, 33, 0, 0, 0, 0], lamports: 1169280, owner: [6, 167, 213, 23, 24, 117, 247, 41, 199, 61, 147, 64, 143, 33, 97, 32, 6, 126, 216, 140, 118, 224, 140, 40, 127, 193, 148, 96, 0, 0, 0, 0], executable: false, rent_epoch: 0, data: [57, 29, 0, 0, 0, 0, 0, 0, 165, 160, 80, 99, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 221, 189, 80, 99, 0, 0, 0, 0], write_version: 53718 }), slot: 7481, is_startup: false })) }
new message: SubscribeUpdate { filters: ["client"], update_oneof: Some(Account(SubscribeUpdateAccount { account: Some(SubscribeUpdateAccountInfo { pubkey: [6, 167, 213, 23, 24, 199, 116, 201, 40, 86, 99, 152, 105, 29, 94, 182, 139, 94, 184, 163, 155, 75, 109, 92, 115, 85, 91, 33, 0, 0, 0, 0], lamports: 1169280, owner: [6, 167, 213, 23, 24, 117, 247, 41, 199, 61, 147, 64, 143, 33, 97, 32, 6, 126, 216, 140, 118, 224, 140, 40, 127, 193, 148, 96, 0, 0, 0, 0], executable: false, rent_epoch: 0, data: [58, 29, 0, 0, 0, 0, 0, 0, 165, 160, 80, 99, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 222, 189, 80, 99, 0, 0, 0, 0], write_version: 53725 }), slot: 7482, is_startup: false })) }
2022-10-19 07:34:41 -07:00
^C
```
2022-10-19 15:19:59 -07:00
### Filters
See [proto/geyser.proto](proto/geyser.proto).
#### Slots
- `enabled` — broadcast slots updates
#### Account
Accounts can be filtered by:
2022-10-20 16:43:19 -07:00
- `any` — stream all accounts, if active all other filters should be disabled
2022-10-19 15:19:59 -07:00
- `account` — acount Pubkey, match to any Pubkey from the array
- `owner` — account owner Pubkey, match to any Pubkey from the array
2022-10-20 16:43:19 -07:00
All fields in filter are optional but at least 1 is required. Fields works as logical `AND`. Values in the arrays works as logical `OR`.
#### Transactions
- `any` — stream all transactions
- `vote` — enable/disable broadcast `vote` transactions
- `failed` — enable/disable broadcast `failed` transactions
2022-10-20 18:06:23 -07:00
#### Blocks
- `any` — stream all blocks