Go to file
Kirill Fomichev fee0279395
Fix grpc client example
2023-01-26 12:21:18 -03:00
.github/workflows Removing unneeded apt actions, bumping checkout version (#12) 2022-12-01 17:06:54 -03:00
ci Update solana =1.14.10 (#19) 2022-12-16 10:37:32 -03:00
proto Add signature to transactions filter (#31) 2023-01-21 21:41:38 -03:00
src Fix grpc client example 2023-01-26 12:21:18 -03:00
.gitignore Allow change filter without reconnect (#10) 2022-11-22 21:22:39 -03:00
Cargo.lock Ignore data before first processed block after startup message (#33) 2023-01-23 08:33:27 -03:00
Cargo.toml Ignore data before first processed block after startup message (#33) 2023-01-23 08:33:27 -03:00
README.md Add transactions to block message, new block meta message (#27) 2023-01-12 11:37:58 -03:00
build.rs Use compiled protoc (#5) 2022-10-26 16:54:06 -03:00
config.json Add filter limits to config (#4) 2022-10-25 14:52:29 -03:00
rust-toolchain.toml Update solana =1.14.10 (#19) 2022-12-16 10:37:32 -03:00

README.md

Public GRPC interface to Geyser

Validator

$ solana-validator --geyser-plugin-config ./config.json

Plugin config check

cargo-fmt && cargo run --bin config-check -- --config config.json

Client

  • Always broadcast new slots
  • Accounts can be filtered by pubkey and owner fields, also all accounts can be broadcasted with *
$ cargo run --bin client -- --accounts --account SysvarC1ock11111111111111111111111111111111
    Finished dev [unoptimized + debuginfo] target(s) in 0.69s
     Running `target/debug/client --accounts --account SysvarC1ock11111111111111111111111111111111`
stream opened
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 })) }
^C

Filters

See proto/geyser.proto.

Slots

Currently all slots are broadcasted.

Account

Accounts can be filtered by:

  • account — acount Pubkey, match to any Pubkey from the array
  • owner — account owner Pubkey, match to any Pubkey from the array

If all fields are empty then all accounts are broadcasted. Otherwise fields works as logical AND and values in arrays as logical OR.

Transactions

  • vote — enable/disable broadcast vote transactions
  • failed — enable/disable broadcast failed transactions
  • account_include — filter transactions which use any account
  • account_exclude — filter transactions which do not use any account

If all fields are empty then all transactions are broadcasted. Otherwise fields works as logical AND and values in arrays as logical OR.

Blocks

Currently all blocks are broadcasted.

Blocks meta

Same as Blocks but without transactions.

Limit filters

It's possible to add limits for filters in config. If filters field is omitted then filters doesn't have any limits.

"grpc": {
   "filters": {
      "accounts": {
         "max": 1,
         "any": false,
         "account_max": 10,
         "account_reject": ["TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"],
         "owner_max": 10,
         "owner_reject": ["11111111111111111111111111111111"]
      },
      "slots": {
         "max": 1
      },
      "transactions": {
         "max": 1,
         "any": false,
         "account_include_max": 10,
         "account_include_reject": ["TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"],
         "account_exclude_max": 10
      },
      "blocks": {
         "max": 1
      }
   }
}