subscribeEntries gRPC Method - Solana gRPC

Solana gRPC is included with Scale plans and up. Learn more on our pricing page.

Parameters

This method does not accept any parameters

Returns

slot

string

Loading...

entries

string

Loading...

Request

1
package main
2

3
import (
4
	"context"
5
	"crypto/tls"
6
	"fmt"
7
	"log"
8
	"time"
9

10
	pb "shredstream/proto"
11

12
	"google.golang.org/grpc"
13
	"google.golang.org/grpc/credentials"
14
	"google.golang.org/grpc/keepalive"
15
)
16

17
// Quicknode endpoints consist of two crucial components: the endpoint name and the corresponding token
18
// For eg: QN Endpoint: https://docs-demo.solana-mainnet.quiknode.pro/abcde123456789
19
// endpoint will be: docs-demo.solana-mainnet.quiknode.pro:443  {443 is the port number for gRPC}
20
// token will be : abcde123456789
21

22
// Each message carries the serialized bytes of a Vec<Entry> of Solana ledger entries from one slot;
23
// a slot is delivered as multiple messages:
24
// https://docs.rs/solana-entry/latest/solana_entry/entry/struct.Entry.html
25
//
26
// SubscribeEntries belongs to the shredstream.ShredstreamProxy service, not to Geyser, so it needs
27
// its own generated client. Save the following as shredstream.proto and generate the client with
28
// protoc --go_out=module=shredstream:. --go-grpc_out=module=shredstream:. shredstream.proto
29
//
30
//   syntax = "proto3";
31
//   package shredstream;
32
//   option go_package = "shredstream/proto";
33
//
34
//   message SubscribeEntriesRequest {}
35
//
36
//   message Entry {
37
//     uint64 slot = 1;
38
//     bytes entries = 2;
39
//   }
40
//
41
//   service ShredstreamProxy {
42
//     rpc SubscribeEntries(SubscribeEntriesRequest) returns (stream Entry) {}
43
//   }
44
//
45
// This service does not accept compressed requests, so do not add grpc.UseCompressor to the dial options.
46

47
var (
48
	endpoint = "YOUR_QN_ENDPOINT:443"
49
	token    = "YOUR_TOKEN_NUMBER"
50
)
51

52
var kacp = keepalive.ClientParameters{
53
	Time:                10 * time.Second,
54
	Timeout:             time.Second,
55
	PermitWithoutStream: true,
56
}
57

58
type tokenAuth struct {
59
	token string
60
}
61

62
func (t tokenAuth) GetRequestMetadata(ctx context.Context, in ...string) (map[string]string, error) {
63
	return map[string]string{
64
		"x-token": t.token,
65
	}, nil
66
}
67

68
func (tokenAuth) RequireTransportSecurity() bool {
69
	return true
70
}
71

72
func main() {
73
	opts := []grpc.DialOption{
74
		grpc.WithTransportCredentials(credentials.NewTLS(&tls.Config{})),
75
		grpc.WithKeepaliveParams(kacp),
76
		grpc.WithDefaultCallOptions(grpc.MaxCallRecvMsgSize(1024*1024*1024)),
77
		grpc.WithPerRPCCredentials(tokenAuth{token: token}),
78
	}
79

80
	conn, err := grpc.NewClient(endpoint, opts...)
81
	if err != nil {
82
		log.Fatalf("Failed to connect: %v", err)
83
	}
84
	defer conn.Close()
85

86
	client := pb.NewShredstreamProxyClient(conn)
87

88
	stream, err := client.SubscribeEntries(context.Background(), &pb.SubscribeEntriesRequest{})
89
	if err != nil {
90
		log.Fatalf("Failed to subscribe to entries: %v", err)
91
	}
92

93
	for {
94
		entry, err := stream.Recv()
95
		if err != nil {
96
			fmt.Printf("Failed to receive entry: %v\n", err)
97
			return
98
		}
99

100
		fmt.Printf("Slot: %d, entries payload: %d bytes\n", entry.GetSlot(), len(entry.GetEntries()))
101
	}
102
}
103

1
package main
2

3
import (
4
	"context"
5
	"crypto/tls"
6
	"fmt"
7
	"log"
8
	"time"
9

10
	pb "shredstream/proto"
11

12
	"google.golang.org/grpc"
13
	"google.golang.org/grpc/credentials"
14
	"google.golang.org/grpc/keepalive"
15
)
16

17
// Quicknode endpoints consist of two crucial components: the endpoint name and the corresponding token
18
// For eg: QN Endpoint: https://docs-demo.solana-mainnet.quiknode.pro/abcde123456789
19
// endpoint will be: docs-demo.solana-mainnet.quiknode.pro:443  {443 is the port number for gRPC}
20
// token will be : abcde123456789
21

22
// Each message carries the serialized bytes of a Vec<Entry> of Solana ledger entries from one slot;
23
// a slot is delivered as multiple messages:
24
// https://docs.rs/solana-entry/latest/solana_entry/entry/struct.Entry.html
25
//
26
// SubscribeEntries belongs to the shredstream.ShredstreamProxy service, not to Geyser, so it needs
27
// its own generated client. Save the following as shredstream.proto and generate the client with
28
// protoc --go_out=module=shredstream:. --go-grpc_out=module=shredstream:. shredstream.proto
29
//
30
//   syntax = "proto3";
31
//   package shredstream;
32
//   option go_package = "shredstream/proto";
33
//
34
//   message SubscribeEntriesRequest {}
35
//
36
//   message Entry {
37
//     uint64 slot = 1;
38
//     bytes entries = 2;
39
//   }
40
//
41
//   service ShredstreamProxy {
42
//     rpc SubscribeEntries(SubscribeEntriesRequest) returns (stream Entry) {}
43
//   }
44
//
45
// This service does not accept compressed requests, so do not add grpc.UseCompressor to the dial options.
46

47
var (
48
	endpoint = "YOUR_QN_ENDPOINT:443"
49
	token    = "YOUR_TOKEN_NUMBER"
50
)
51

52
var kacp = keepalive.ClientParameters{
53
	Time:                10 * time.Second,
54
	Timeout:             time.Second,
55
	PermitWithoutStream: true,
56
}
57

58
type tokenAuth struct {
59
	token string
60
}
61

62
func (t tokenAuth) GetRequestMetadata(ctx context.Context, in ...string) (map[string]string, error) {
63
	return map[string]string{
64
		"x-token": t.token,
65
	}, nil
66
}
67

68
func (tokenAuth) RequireTransportSecurity() bool {
69
	return true
70
}
71

72
func main() {
73
	opts := []grpc.DialOption{
74
		grpc.WithTransportCredentials(credentials.NewTLS(&tls.Config{})),
75
		grpc.WithKeepaliveParams(kacp),
76
		grpc.WithDefaultCallOptions(grpc.MaxCallRecvMsgSize(1024*1024*1024)),
77
		grpc.WithPerRPCCredentials(tokenAuth{token: token}),
78
	}
79

80
	conn, err := grpc.NewClient(endpoint, opts...)
81
	if err != nil {
82
		log.Fatalf("Failed to connect: %v", err)
83
	}
84
	defer conn.Close()
85

86
	client := pb.NewShredstreamProxyClient(conn)
87

88
	stream, err := client.SubscribeEntries(context.Background(), &pb.SubscribeEntriesRequest{})
89
	if err != nil {
90
		log.Fatalf("Failed to subscribe to entries: %v", err)
91
	}
92

93
	for {
94
		entry, err := stream.Recv()
95
		if err != nil {
96
			fmt.Printf("Failed to receive entry: %v\n", err)
97
			return
98
		}
99

100
		fmt.Printf("Slot: %d, entries payload: %d bytes\n", entry.GetSlot(), len(entry.GetEntries()))
101
	}
102
}
103

1
import * as grpc from "@grpc/grpc-js";
2
import * as protoLoader from "@grpc/proto-loader";
3

4
// Quicknode endpoints consist of two crucial components: the endpoint name and the corresponding token
5
// For eg: QN Endpoint: https://docs-demo.solana-mainnet.quiknode.pro/abcde123456789
6
// endpoint will be: docs-demo.solana-mainnet.quiknode.pro:443  {443 is the port number for gRPC}
7
// token will be : abcde123456789
8

9
// Each message carries the serialized bytes of a Vec<Entry> of Solana ledger entries from one slot;
10
// a slot is delivered as multiple messages:
11
// https://docs.rs/solana-entry/latest/solana_entry/entry/struct.Entry.html
12
//
13
// SubscribeEntries belongs to the shredstream.ShredstreamProxy service, not to Geyser, so it is not
14
// exposed by the @triton-one/yellowstone-grpc client. Save the following as shredstream.proto next to
15
// this file and load it with @grpc/proto-loader:
16
//
17
//   syntax = "proto3";
18
//   package shredstream;
19
//   option go_package = "shredstream/proto";
20
//
21
//   message SubscribeEntriesRequest {}
22
//
23
//   message Entry {
24
//     uint64 slot = 1;
25
//     bytes entries = 2;
26
//   }
27
//
28
//   service ShredstreamProxy {
29
//     rpc SubscribeEntries(SubscribeEntriesRequest) returns (stream Entry) {}
30
//   }
31
//
32
// @grpc/grpc-js takes a host:port target, so do not prefix the endpoint with https://
33

34
const ENDPOINT = "YOUR_QN_ENDPOINT:443";
35
const TOKEN = "YOUR_TOKEN_NUMBER";
36

37
const packageDefinition = protoLoader.loadSync("./shredstream.proto", {
38
    keepCase: true,
39
    longs: String,
40
    enums: String,
41
    defaults: true,
42
    oneofs: true,
43
});
44
const shredstream = (grpc.loadPackageDefinition(packageDefinition) as any).shredstream;
45

46
function main() {
47
    const metadata = new grpc.Metadata();
48
    metadata.add("x-token", TOKEN);
49

50
    const client = new shredstream.ShredstreamProxy(ENDPOINT, grpc.credentials.createSsl());
51
    const stream = client.SubscribeEntries({}, metadata);
52

53
    stream.on("data", (entry: { slot: string; entries: Buffer }) => {
54
        console.log(`Slot: ${entry.slot}, entries payload: ${entry.entries.length} bytes`);
55
    });
56

57
    stream.on("error", (error: Error) => {
58
        console.error("Stream error:", error);
59
    });
60

61
    stream.on("end", () => {
62
        console.log("Stream ended");
63
    });
64
}
65

66
main();
67

1
import * as grpc from "@grpc/grpc-js";
2
import * as protoLoader from "@grpc/proto-loader";
3

4
// Quicknode endpoints consist of two crucial components: the endpoint name and the corresponding token
5
// For eg: QN Endpoint: https://docs-demo.solana-mainnet.quiknode.pro/abcde123456789
6
// endpoint will be: docs-demo.solana-mainnet.quiknode.pro:443  {443 is the port number for gRPC}
7
// token will be : abcde123456789
8

9
// Each message carries the serialized bytes of a Vec<Entry> of Solana ledger entries from one slot;
10
// a slot is delivered as multiple messages:
11
// https://docs.rs/solana-entry/latest/solana_entry/entry/struct.Entry.html
12
//
13
// SubscribeEntries belongs to the shredstream.ShredstreamProxy service, not to Geyser, so it is not
14
// exposed by the @triton-one/yellowstone-grpc client. Save the following as shredstream.proto next to
15
// this file and load it with @grpc/proto-loader:
16
//
17
//   syntax = "proto3";
18
//   package shredstream;
19
//   option go_package = "shredstream/proto";
20
//
21
//   message SubscribeEntriesRequest {}
22
//
23
//   message Entry {
24
//     uint64 slot = 1;
25
//     bytes entries = 2;
26
//   }
27
//
28
//   service ShredstreamProxy {
29
//     rpc SubscribeEntries(SubscribeEntriesRequest) returns (stream Entry) {}
30
//   }
31
//
32
// @grpc/grpc-js takes a host:port target, so do not prefix the endpoint with https://
33

34
const ENDPOINT = "YOUR_QN_ENDPOINT:443";
35
const TOKEN = "YOUR_TOKEN_NUMBER";
36

37
const packageDefinition = protoLoader.loadSync("./shredstream.proto", {
38
    keepCase: true,
39
    longs: String,
40
    enums: String,
41
    defaults: true,
42
    oneofs: true,
43
});
44
const shredstream = (grpc.loadPackageDefinition(packageDefinition) as any).shredstream;
45

46
function main() {
47
    const metadata = new grpc.Metadata();
48
    metadata.add("x-token", TOKEN);
49

50
    const client = new shredstream.ShredstreamProxy(ENDPOINT, grpc.credentials.createSsl());
51
    const stream = client.SubscribeEntries({}, metadata);
52

53
    stream.on("data", (entry: { slot: string; entries: Buffer }) => {
54
        console.log(`Slot: ${entry.slot}, entries payload: ${entry.entries.length} bytes`);
55
    });
56

57
    stream.on("error", (error: Error) => {
58
        console.error("Stream error:", error);
59
    });
60

61
    stream.on("end", () => {
62
        console.log("Stream ended");
63
    });
64
}
65

66
main();
67

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free