Making Sui gRPC Requests with Go

개요

Go is a statically-typed, compiled language known for its simplicity, efficiency, and strong concurrency support. Follow the official installation guide to install Go. Verify the installation:

go version

Authentication Required for Sui gRPC

To ensure secure access to Sui gRPC, users are required to authenticate themselves. This authentication process is necessary before utilizing any method. Quicknode endpoints consist of two crucial components: the endpoint 그리고 이에 상응하는 토큰. 사용자는 메서드 호출을 수행하기 전에 이 두 구성 요소를 사용하여 인증 자격 증명을 포함한 gRPC 구성해야 합니다.

Authentication for the Sui gRPC can be handled in two ways:

기본 인증
x-token 인증

이 문서 전반에 걸쳐, 우리는 다음 중 하나를 getClientWithBasicAuth 또는 getClientWithXToken 이러한 다양한 인증 메커니즘을 처리하는 방법을 보여주는 함수들입니다.

기본 인증

그 getClientWithBasicAuth 이 함수는 자격 증명을 base64로 인코딩하는 기본 인증(Basic Authentication)을 사용하여 인증을 처리하는 방법을 보여줍니다. 다음은 해당 함수의 코드 구현입니다. getClientWithBasicAuth 기능뿐만 아니라 basicAuth RPC 자격 증명 구현:

import (
	"문맥"
	"crypto/tls"
	"encoding/base64"
	"fmt"
	"google.golang.grpc"
	"google.golang.grpc"
)

func getClientWithBasicAuth(endpoint, token string) (client.GRPCClient, error) {
	target := endpoint + ".sui-mainnet.quiknode.pro:9000" // for TLS connections
	conn, err := grpc.Dial(target,
		grpc.WithTransportCredentials(credentials.NewTLS(&tls.Config{})),
		grpc.WithPerRPCCredentials(basicAuth{
			username: endpoint,
			password: token,
		}),
	)
	if err != nil {
		return nil, fmt.Errorf("Unable to dial endpoint %w", err)
	}
	return client.NewGRPCClient(conn), nil
}

// basicAuth implements the credentials.PerRPCCredentials interface to support basic authentication for grpc requests.
type basicAuth struct {
	username string
	password string
}

func (b basicAuth) GetRequestMetadata(ctx context.Context, in ...string) (map[string]string, error) {
	auth := b.username + ":" + b.password
	enc := base64.StdEncoding.EncodeToString([]byte(auth))
	return map[string]string{"authorization": "Basic " + enc}, nil
}

func (basicAuth) RequireTransportSecurity() bool {
	return false
}

그 getClientWithBasicAuth 이 함수는 gRPC 필요한 보안 옵션으로 구성하고, 지정된 endpoint 연결을 설정합니다. 9000. It takes the endpoint name and token as input parameters and returns an instance of the GRPCClient interface, which you can use to make authenticated API calls.

client, err := getClientWithBasicAuth("ENDPOINT_NAME", "TOKEN")
if err != nil {
	log.Fatalf("err: %v", err)
}

x-token 인증

그 getClientWithXToken 이 함수는 x-token을 사용하여 인증을 처리하는 방법을 보여줍니다. 이 방법은 각 요청의 x-token 헤더에 토큰을 추가합니다.

import (
    "문맥"
    "crypto/tls"
    "fmt"
    "github.com/fbsobreira/gosui-sdk/pkg/client"
    "google.golang.grpc"
    "google.golang.grpc"
)

func getClientWithXToken(endpoint, token string) (client.GRPCClient, error) {
    target := endpoint + ".sui-mainnet.quiknode.pro:9000" // for TLS connections
    conn, err := grpc.Dial(target,
        grpc.WithTransportCredentials(credentials.NewTLS(&tls.Config{})),
        grpc.WithPerRPCCredentials(auth{
            token: token,
        }),
    )
    if err != nil {
        return nil, fmt.Errorf("Unable to dial endpoint %w", err)
    }
    return client.NewGRPCClient(conn), nil
}

// auth implements the credentials.PerRPCCredentials interface to support x-token authentication for grpc requests.
type auth struct {
    token string
}

func (a *auth) GetRequestMetadata(ctx context.Context, uri ...string) (map[string]string, error) {
    return map[string]string{
        "x-token": a.token,
    }, nil
}

func (auth) RequireTransportSecurity() bool {
    return false
}

이 방법은 기본 인증 예제와 유사하게 gRPC 구성하지만, x-token 헤더에 인증 토큰을 포함시킵니다. 이 함수를 사용하여 API 호출을 수행하는 방법은 다음과 같습니다:

client, err := getClientWithXToken("ENDPOINT_NAME", "TOKEN")
if err != nil {
    log.Fatalf("err: %v", err)
}

The below section provides a step-by-step process to set up a Go environment for making gRPC requests. The instructions include setting up Go, configuring dependencies, and implementing authentication mechanisms.

Initiating the Go Project for Sui gRPC

Step 1: Create a New Project Directory

Create a dedicated directory for your Sui gRPC project and navigate into it:

mkdir sui-grpc
cd sui-grpc

Step 2: Initialize a Go Module

Create a Go module for your project. The module name can match your directory name or be a repository URL:

go mod init sui-grpc # directory name

Step 3: Install gRPC and Protobuf Dependencies

Ensure you have both 가기 그리고 protoc installed on your machine.

You can Install the core gRPC and Protobuf libraries by following commands:

go get google.golang.org/grpc
go get google.golang.org/protobuf

You can also define versions directly in your go.mod:

require (
    google.golang.org/grpc v1.60.0
    google.golang.org/protobuf v1.33.0
)

Next, install the protoc plugins for Go:

go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest

Make sure $GOPATH/bin is in your system’s PATH. You can follow below steps to set the system PATH for GO.

팁

To use Go-installed tools globally (e.g., protoc-gen-go, grpcurl), add $GOPATH/bin to your system PATH.

For macOS / Linux

Add to your shell config file:

echo 'export PATH="$PATH:$(go env GOPATH)/bin"' >> ~/.bashrc
source ~/.bashrc

Use .zshrc instead of .bashrc if you're using Zsh.

Verify:

which protoc-gen-go

For Windows

Open Start Menu → search for Environment Variables
Under System Variables, select Path → click Edit
Click New and add:

%USERPROFILE%\go\bin

Open a new Command Prompt or PowerShell and verify:

where protoc-gen-go

Step 4: Organize Your Project Directory

만들기 protos folder to store the original Protocol Buffer definition files:

mkdir protos

Download the official Sui proto files from the MystenLabs/sui repository. Extract and place the entire sui directory structure into your newly created protos folder. Alternatively, you can run the following commands:

# Clone the repository with minimal depth
git clone https://github.com/MystenLabs/sui-apis.git --depth=1

# Copy the proto files to your working directory
cp -r sui-apis/proto protos

# Remove the cloned repository (optional)
rm -rf sui-apis

Your project structure should look like this:

sui-grpc/
├── protos/
│   └── sui/
│       └── rpc/
│           └── v2/
│               ├── ledger_service.proto
│               ├── object.proto
│               ├── transaction.proto
│               └── ... (other proto files)
├── go.mod

Step 5: Generate Go Code from Proto Files

First, we need to add go_package to each .proto File. For that we need to modify each .proto file (e.g. argument.proto, checkpoint.proto, etc.) to include a go_package option near the top:

syntax = "proto3";

package sui.rpc.v2;

option go_package = "sui/rpc/v2";

Once the go_package is added and your folder structure matches the above layout, generate the .pb.go files by running the following command:

protoc \
  --proto_path=protos/proto \
  --go_out=. \
  --go-grpc_out=. \
  protos/proto/sui/rpc/v2/*.proto

Step 6: Create a Main Go File

Set up a main Go file for implementing client or server logic:

touch main.go

You can copy and paste the following sample code into your main.go file to get started. The example demonstrates how to interact with the Sui gRPC service to fetch object information.

package main

import (
	"문맥"
	"crypto/tls"
	"encoding/json"
	"fmt"
	"로그"
	"시간"

	"google.golang.grpc"
	"google.golang.grpc"
	"google.golang.org/protobuf/encoding/protojson"

	pb "sui-grpc/sui/rpc/v2"  // Your Generated .pb.go files path
)

// Quicknode endpoints consist of two crucial components: the endpoint name and the corresponding token
// For eg: QN Endpoint: https://docs-demo.sui-mainnet.quiknode.pro/abcde123456789
// endpoint will be: docs-demo.sui-mainnet.quiknode.pro:9000  {9000 is the port number for Sui gRPC}
// token will be : abcde123456789

var (
	token    = "YOUR_TOKEN_NUMBER"
	endpoint = "YOUR_QN_ENDPOINT:9000"
)

type auth struct {
	token string
}

func (a *auth) GetRequestMetadata(ctx context.Context, uri ...string) (map[string]string, error) {
	return map[string]string{"x-token": a.token}, nil
}
func (a *auth) RequireTransportSecurity() bool {
	return true
}

func main() {
	creds := credentials.NewTLS(&tls.Config{})
	opts := []grpc.DialOption{
		grpc.WithTransportCredentials(creds),
		grpc.WithPerRPCCredentials(&auth{token}),
	}

	conn, err := grpc.Dial(endpoint, opts...)
	if err != nil {
		log.Fatalf("Failed to connect: %v", err)
	}
	defer conn.Close()

	client := pb.NewLedgerServiceClient(conn)

	// Object ID to fetch
	objectID := "0x27c4fdb3b846aa3ae4a65ef5127a309aa3c1f466671471a806d8912a18b253e8"

	// Build request with field mask
	req := &pb.BatchGetObjectsRequest{
    Requests: []*pb.GetObjectRequest{
        {
            ObjectId: &objectID,
        },
    },
	}

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

	resp, err := client.BatchGetObjects(ctx, req)
	if err != nil {
		log.Fatalf("BatchGetObjects failed: %v", err)
	}

	// Pretty print the response
	marshaler := protojson.MarshalOptions{
		UseProtoNames:   true,
		EmitUnpopulated: true,
		Indent:          "  ",
	}

	jsonBytes, err := marshaler.Marshal(resp)
	if err != nil {
		log.Fatalf("Failed to marshal: %v", err)
	}

	var pretty map[string]interface{}
	if err := json.Unmarshal(jsonBytes, &pretty); err != nil {
		log.Fatalf("Failed to parse JSON: %v", err)
	}

	out, _ := json.MarshalIndent(pretty, "", "  ")
	fmt.Println(string(out))
}

Step 7: Run Your Code

Before running your code, clean up and ensure all dependencies are correctly resolved:

go mod tidy

Build and run the project using:

main.go를 실행해 보세요

Making Sui gRPC Requests with Go

개요​

Authentication Required for Sui gRPC​

기본 인증​

x-token 인증​

Initiating the Go Project for Sui gRPC​

Step 1: Create a New Project Directory​

Step 2: Initialize a Go Module​

Step 3: Install gRPC and Protobuf Dependencies​

For macOS / Linux​

For Windows​

Step 4: Organize Your Project Directory​

Step 5: Generate Go Code from Proto Files​

Step 6: Create a Main Go File​

Step 7: Run Your Code​

개요