ping gRPC Method - Solana gRPC

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

Parameters

count

integer

Loading...

Returns

count

integer

Loading...

Request

1
package main
2

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

10
	pb "yellowstone/proto"
11

12

13
	"google.golang.org/grpc"
14
	"google.golang.org/grpc/credentials"
15
	"google.golang.org/grpc/encoding/gzip"
16
	"google.golang.org/grpc/keepalive"
17
)
18

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

24
var (
25
	endpoint = "YOUR_QN_ENDPOINT:443"
26
	token    = "YOUR_TOKEN_NUMBER"
27
)
28

29
var kacp = keepalive.ClientParameters{
30
	Time:                10 * time.Second,
31
	Timeout:             time.Second,
32
	PermitWithoutStream: true,
33
}
34

35
type tokenAuth struct {
36
	token string
37
}
38

39
func (t tokenAuth) GetRequestMetadata(ctx context.Context, in ...string) (map[string]string, error) {
40
	return map[string]string{
41
		"x-token": t.token,
42
	}, nil
43
}
44

45
func (tokenAuth) RequireTransportSecurity() bool {
46
	return true
47
}
48

49
func main() {
50
	opts := []grpc.DialOption{
51
		grpc.WithTransportCredentials(credentials.NewTLS(&tls.Config{})),
52
		grpc.WithKeepaliveParams(kacp),
53
		grpc.WithDefaultCallOptions(grpc.MaxCallRecvMsgSize(1024*1024*1024), grpc.UseCompressor(gzip.Name)),
54
		grpc.WithPerRPCCredentials(tokenAuth{token: token}),
55
	}
56

57
	conn, err := grpc.NewClient(endpoint, opts...)
58
	if err != nil {
59
		log.Fatalf("Failed to connect: %v", err)
60
	}
61
	defer conn.Close()
62

63
	client := pb.NewGeyserClient(conn)
64

65
    ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
66
    defer cancel()
67

68
    pingResponse, err := client.Ping(ctx, &pb.PingRequest{Count: 1})
69
	if err != nil {
70
		log.Fatalf("Failed to get Ping: %v", err)
71
	}
72
	fmt.Printf("  Ping Response: %d\n", pingResponse.GetCount())
73

74
}
75

1
package main
2

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

10
	pb "yellowstone/proto"
11

12

13
	"google.golang.org/grpc"
14
	"google.golang.org/grpc/credentials"
15
	"google.golang.org/grpc/encoding/gzip"
16
	"google.golang.org/grpc/keepalive"
17
)
18

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

24
var (
25
	endpoint = "YOUR_QN_ENDPOINT:443"
26
	token    = "YOUR_TOKEN_NUMBER"
27
)
28

29
var kacp = keepalive.ClientParameters{
30
	Time:                10 * time.Second,
31
	Timeout:             time.Second,
32
	PermitWithoutStream: true,
33
}
34

35
type tokenAuth struct {
36
	token string
37
}
38

39
func (t tokenAuth) GetRequestMetadata(ctx context.Context, in ...string) (map[string]string, error) {
40
	return map[string]string{
41
		"x-token": t.token,
42
	}, nil
43
}
44

45
func (tokenAuth) RequireTransportSecurity() bool {
46
	return true
47
}
48

49
func main() {
50
	opts := []grpc.DialOption{
51
		grpc.WithTransportCredentials(credentials.NewTLS(&tls.Config{})),
52
		grpc.WithKeepaliveParams(kacp),
53
		grpc.WithDefaultCallOptions(grpc.MaxCallRecvMsgSize(1024*1024*1024), grpc.UseCompressor(gzip.Name)),
54
		grpc.WithPerRPCCredentials(tokenAuth{token: token}),
55
	}
56

57
	conn, err := grpc.NewClient(endpoint, opts...)
58
	if err != nil {
59
		log.Fatalf("Failed to connect: %v", err)
60
	}
61
	defer conn.Close()
62

63
	client := pb.NewGeyserClient(conn)
64

65
    ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
66
    defer cancel()
67

68
    pingResponse, err := client.Ping(ctx, &pb.PingRequest{Count: 1})
69
	if err != nil {
70
		log.Fatalf("Failed to get Ping: %v", err)
71
	}
72
	fmt.Printf("  Ping Response: %d\n", pingResponse.GetCount())
73

74
}
75

1
import Client, {
2
    CommitmentLevel,
3
    SubscribeRequest,
4
    SubscribeRequestFilterAccountsFilter,
5
} from "@triton-one/yellowstone-grpc";
6

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

12
const ENDPOINT = "https://YOUR_QN_ENDPOINT:443";
13
const TOKEN = "YOUR_TOKEN_NUMBER";
14

15
async function main() {
16
    const client = new Client(ENDPOINT, TOKEN, {
17
        grpcDefaultCompressionAlgorithm: 0, // 0 = gzip, 1 = zstd
18
    });
19
    await client.connect();
20
    const response = await client.ping(1);
21
    console.log(`Response: ${response.count}`);
22
}
23

24
main()
25
    .catch((err) => {
26
        console.error(err);
27
        process.exit(1);
28
    })
29

1
import Client, {
2
    CommitmentLevel,
3
    SubscribeRequest,
4
    SubscribeRequestFilterAccountsFilter,
5
} from "@triton-one/yellowstone-grpc";
6

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

12
const ENDPOINT = "https://YOUR_QN_ENDPOINT:443";
13
const TOKEN = "YOUR_TOKEN_NUMBER";
14

15
async function main() {
16
    const client = new Client(ENDPOINT, TOKEN, {
17
        grpcDefaultCompressionAlgorithm: 0, // 0 = gzip, 1 = zstd
18
    });
19
    await client.connect();
20
    const response = await client.ping(1);
21
    console.log(`Response: ${response.count}`);
22
}
23

24
main()
25
    .catch((err) => {
26
        console.error(err);
27
        process.exit(1);
28
    })
29

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free