Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/weeaa/goyser
🐳 Solana Geyser Go SDK
https://github.com/weeaa/goyser
bot cryptocurrency geyser mev solana
Last synced: 21 days ago
JSON representation
🐳 Solana Geyser Go SDK
- Host: GitHub
- URL: https://github.com/weeaa/goyser
- Owner: weeaa
- License: apache-2.0
- Created: 2024-06-18T21:18:44.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-12-01T19:44:13.000Z (about 1 month ago)
- Last Synced: 2024-12-01T20:28:56.424Z (about 1 month ago)
- Topics: bot, cryptocurrency, geyser, mev, solana
- Language: Go
- Homepage: https://docs.solanalabs.com/validator/geyser
- Size: 167 KB
- Stars: 23
- Watchers: 2
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Solana Geyser SDK
[](https://pkg.go.dev/github.com/weeaa/goyser?tab=doc)
[](https://goreportcard.com/report/github.com/weeaa/goyser)
[](https://opensource.org/license/apache-2-0)
This library contains tooling to interact with **[Yellowstone](https://github.com/rpcpool/yellowstone-grpc)** & **[Jito](https://github.com/jito-foundation/geyser-grpc-plugin)** Geyser plugins.
## ❇️ Contents
- [Support](#-support)
- [Methods](#-methods)
- [Installing](#-installing)
- [Examples](#-examples)
- [Subscribe to Account](#subscribe-to-account)
- [License](#-license)
## 🛟 Support
If my work has been useful in building your for-profit services/infra/bots/etc, consider donating at
`EcrHvqa5Vh4NhR3bitRZVrdcUGr1Z3o6bXHz7xgBU2FB` (SOL).
## 📡 Methods
- **Yellowstone** ✅
- `SubscribeAccounts`
- `AppendAccounts`
- `UnsubscribeAccounts`
- `UnsubscribeAccountsByFilterName`
- `UnsubscribeAllAccounts`
- `SubscribeSlots`
- `UnsubscribeSlots`
- `SubscribeTransaction`
- `UnsubscribeTransaction`
- `SubscribeTransactionStatus`
- `UnsubscribeTransactionStatus`
- `SubscribeBlocks`
- `UnsubscribeBlocks`
- `SubscribeBlocksMeta`
- `UnsubscribeBlocksMeta`
- `SubscribeEntry`
- `UnsubscribeEntry`
- `SubscribeAccountDataSlice`
- `UnsubscribeAccountDataSlice`
- **Jito** (TBD)
💡 It also contains a `ConvertTransaction` function which converts from Goyser to [github.com/gagliardetto/solana-go](https://github.com/gagliardetto/solana-go) types :)
## 💾 Installing
Go 1.22.0 or higher.
```shell
go get github.com/weeaa/goyser@latest
```
## 💻 Examples
### `Subscribe to Account`
Simple example on how to monitor an account for transactions with explanations.
```go
package main
import (
"context"
"github.com/weeaa/goyser"
"github.com/weeaa/goyser/pb"
"log"
"os"
"time"
)
const subAccount = "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v"
func main() {
ctx := context.Background()
// get the geyser rpc address
geyserRPC := os.Getenv("GEYSER_RPC")
// create geyser client
client, err := goyser.New(ctx, geyserRPC, nil)
if err != nil {
log.Fatal(err)
}
// create a new subscribe client which is tied, for our example we will name it main
// the created client is stored in client.Streams
if err = client.AddStreamClient(ctx, "main"); err != nil {
log.Fatal(err)
}
// get the stream client
streamClient := client.GetStreamClient("main")
if streamClient == nil {
log.Fatal("client does not have a stream named main")
}
// subscribe to the account you want to see txns from and set a custom filter name to filter them out later
if err = streamClient.SubscribeAccounts("accounts", &geyser_pb.SubscribeRequestFilterAccounts{
Account: []string{subAccount},
}); err != nil {
log.Fatal(err)
}
// loop through the stream and print the output
for out := range streamClient.Ch {
// u can filter the output by checking the filters
go func() {
filters := out.GetFilters()
for _, filter := range filters {
switch filter {
case "accounts":
log.Printf("account filter: %+v", out.GetAccount())
default:
log.Printf("unknown filter: %s", filter)
}
}
}()
break
}
time.Sleep(5 * time.Second)
// unsubscribe from the account
if err = streamClient.UnsubscribeAccounts("accounts", subAccount); err != nil {
log.Fatal(err)
}
}
```
## 📃 License
[Apache-2.0 License](https://github.com/weeaa/jito-go/blob/main/LICENSE).