Parameters

message

object

REQUIRED

The message to verify against. Today the only supported message types are PersonalMessage and TransactionData and the Bcs.name must be set to indicate which type of message is being verified

signature

object

REQUIRED

The signature to verify

address

string

Optional. Address to validate against the provided signature. If provided, this address will be compared against the address derived from the provided signature and a successful response will only be returned if they match

jwks

array

The set of JWKs to use when verifying Zklogin signatures. If this is empty the current set of valid JWKs stored onchain will be used

Returns

isValid

boolean

Indicates if the provided signature was valid given the requested parameters

reason

string

If is_valid is false, this is the reason for why the signature verification failed

Request

1
grpcurl -import-path . \
2
  -proto sui/rpc/v2/signature_verification_service.proto \
3
  -H "x-token: abcde123456789" \
4
  -d '{
5
    "message": {
6
      "name": "PersonalMessage",
7
      "value": "BASE64_MESSAGE_BYTES"
8
    },
9
    "signature": {
10
      "scheme": "ED25519",
11
      "signature": "BASE64_SIGNATURE",
12
      "public_key": "BASE64_PUBLIC_KEY"
13
    },
14
    "address": "0xOPTIONAL_VERIFY_AGAINST_THIS_ADDRESS"
15
  }' \
16
  docs-demo.sui-mainnet.quiknode.pro:9000 \
17
  sui.rpc.v2.SignatureVerificationService/VerifySignature
18

1
grpcurl -import-path . \
2
  -proto sui/rpc/v2/signature_verification_service.proto \
3
  -H "x-token: abcde123456789" \
4
  -d '{
5
    "message": {
6
      "name": "PersonalMessage",
7
      "value": "BASE64_MESSAGE_BYTES"
8
    },
9
    "signature": {
10
      "scheme": "ED25519",
11
      "signature": "BASE64_SIGNATURE",
12
      "public_key": "BASE64_PUBLIC_KEY"
13
    },
14
    "address": "0xOPTIONAL_VERIFY_AGAINST_THIS_ADDRESS"
15
  }' \
16
  docs-demo.sui-mainnet.quiknode.pro:9000 \
17
  sui.rpc.v2.SignatureVerificationService/VerifySignature
18

1
package main
2

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

11
	"google.golang.org/grpc"
12
	"google.golang.org/grpc/credentials"
13
	"google.golang.org/protobuf/encoding/protojson"
14
	"google.golang.org/protobuf/types/known/fieldmaskpb"
15

16
	pb "sui-grpc/sui/rpc/v2" // Your Generated .pb.go files path
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.sui-mainnet.quiknode.pro/abcde123456789
21
// endpoint will be: docs-demo.sui-mainnet.quiknode.pro:9000  {9000 is the port number for Sui gRPC}
22
// token will be : abcde123456789
23

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

29
// Auth structure for x-token
30
type auth struct {
31
	token string
32
}
33

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

41
func main() {
42
	creds := credentials.NewTLS(&tls.Config{})
43
	opts := []grpc.DialOption{
44
		grpc.WithTransportCredentials(creds),
45
		grpc.WithPerRPCCredentials(&auth{token}),
46
	}
47

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

54
	client := pb.NewSignatureVerificationServiceClient(conn)
55

56
	req := &pb.VerifySignatureRequest{
57
		Signature: &pb.Signature{
58
			Scheme:    0, // ED25519
59
			Signature: []byte("YOUR_SIGNATURE_BYTES"), // Replace with actual signature
60
			PublicKey: []byte("YOUR_PUBLIC_KEY_BYTES"), // Replace with actual public key
61
		},
62
		Message: []byte("YOUR_MESSAGE_BYTES"), // Replace with actual message
63
		ReadMask: &fieldmaskpb.FieldMask{
64
			Paths: []string{
65
				"is_valid",
66
				"error",
67
			},
68
		},
69
	}
70

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

74
	resp, err := client.VerifySignature(ctx, req)
75
	if err != nil {
76
		log.Fatalf("VerifySignature failed: %v", err)
77
	}
78

79
	// Pretty print the response
80
	marshaler := protojson.MarshalOptions{
81
		UseProtoNames:   true,
82
		EmitUnpopulated: true,
83
		Indent:          "  ",
84
	}
85

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

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

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

1
package main
2

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

11
	"google.golang.org/grpc"
12
	"google.golang.org/grpc/credentials"
13
	"google.golang.org/protobuf/encoding/protojson"
14
	"google.golang.org/protobuf/types/known/fieldmaskpb"
15

16
	pb "sui-grpc/sui/rpc/v2" // Your Generated .pb.go files path
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.sui-mainnet.quiknode.pro/abcde123456789
21
// endpoint will be: docs-demo.sui-mainnet.quiknode.pro:9000  {9000 is the port number for Sui gRPC}
22
// token will be : abcde123456789
23

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

29
// Auth structure for x-token
30
type auth struct {
31
	token string
32
}
33

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

41
func main() {
42
	creds := credentials.NewTLS(&tls.Config{})
43
	opts := []grpc.DialOption{
44
		grpc.WithTransportCredentials(creds),
45
		grpc.WithPerRPCCredentials(&auth{token}),
46
	}
47

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

54
	client := pb.NewSignatureVerificationServiceClient(conn)
55

56
	req := &pb.VerifySignatureRequest{
57
		Signature: &pb.Signature{
58
			Scheme:    0, // ED25519
59
			Signature: []byte("YOUR_SIGNATURE_BYTES"), // Replace with actual signature
60
			PublicKey: []byte("YOUR_PUBLIC_KEY_BYTES"), // Replace with actual public key
61
		},
62
		Message: []byte("YOUR_MESSAGE_BYTES"), // Replace with actual message
63
		ReadMask: &fieldmaskpb.FieldMask{
64
			Paths: []string{
65
				"is_valid",
66
				"error",
67
			},
68
		},
69
	}
70

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

74
	resp, err := client.VerifySignature(ctx, req)
75
	if err != nil {
76
		log.Fatalf("VerifySignature failed: %v", err)
77
	}
78

79
	// Pretty print the response
80
	marshaler := protojson.MarshalOptions{
81
		UseProtoNames:   true,
82
		EmitUnpopulated: true,
83
		Indent:          "  ",
84
	}
85

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

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

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

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

5
// Configuration
6
const PROTO_PATH = path.join(__dirname, 'protos/proto/sui/rpc/v2/signature_verification_service.proto');
7

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

13
const endpoint = 'docs-demo.sui-mainnet.quiknode.pro:9000';
14
const token = 'abcde123456789';
15

16
// Load protobuf definitions
17
const packageDefinition = protoLoader.loadSync(PROTO_PATH, {
18
  keepCase: true,
19
  longs: String,
20
  enums: String,
21
  defaults: true,
22
  oneofs: true,
23
  includeDirs: [path.join(__dirname, 'protos/proto')],
24
});
25

26
const proto = grpc.loadPackageDefinition(packageDefinition) as any;
27
const SignatureVerificationService = proto.sui.rpc.v2.SignatureVerificationService;
28

29
// Create secure client
30
const client = new SignatureVerificationService(endpoint, grpc.credentials.createSsl());
31

32
// Add token metadata
33
const metadata = new grpc.Metadata();
34
metadata.add('x-token', token);
35

36
// Request payload
37
const request = {
38
  signature: {
39
    scheme: 0, // ED25519
40
    signature: Buffer.from('YOUR_SIGNATURE_BYTES', 'base64'), // Replace with actual signature
41
    public_key: Buffer.from('YOUR_PUBLIC_KEY_BYTES', 'base64') // Replace with actual public key
42
  },
43
  message: Buffer.from('YOUR_MESSAGE_BYTES', 'base64'), // Replace with actual message
44
  read_mask: {
45
    paths: [
46
      'is_valid',
47
      'error',
48
    ],
49
  },
50
};
51

52
// Perform gRPC call
53
client.VerifySignature(request, metadata, (err: grpc.ServiceError | null, response: any) => {
54
  if (err) {
55
    console.error('gRPC Error:', {
56
      code: err.code,
57
      message: err.message,
58
      details: err.details,
59
    });
60
  } else {
61
    console.log('VerifySignature Response:');
62
    console.log(JSON.stringify(response, null, 2));
63
  }
64
});
65

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

5
// Configuration
6
const PROTO_PATH = path.join(__dirname, 'protos/proto/sui/rpc/v2/signature_verification_service.proto');
7

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

13
const endpoint = 'docs-demo.sui-mainnet.quiknode.pro:9000';
14
const token = 'abcde123456789';
15

16
// Load protobuf definitions
17
const packageDefinition = protoLoader.loadSync(PROTO_PATH, {
18
  keepCase: true,
19
  longs: String,
20
  enums: String,
21
  defaults: true,
22
  oneofs: true,
23
  includeDirs: [path.join(__dirname, 'protos/proto')],
24
});
25

26
const proto = grpc.loadPackageDefinition(packageDefinition) as any;
27
const SignatureVerificationService = proto.sui.rpc.v2.SignatureVerificationService;
28

29
// Create secure client
30
const client = new SignatureVerificationService(endpoint, grpc.credentials.createSsl());
31

32
// Add token metadata
33
const metadata = new grpc.Metadata();
34
metadata.add('x-token', token);
35

36
// Request payload
37
const request = {
38
  signature: {
39
    scheme: 0, // ED25519
40
    signature: Buffer.from('YOUR_SIGNATURE_BYTES', 'base64'), // Replace with actual signature
41
    public_key: Buffer.from('YOUR_PUBLIC_KEY_BYTES', 'base64') // Replace with actual public key
42
  },
43
  message: Buffer.from('YOUR_MESSAGE_BYTES', 'base64'), // Replace with actual message
44
  read_mask: {
45
    paths: [
46
      'is_valid',
47
      'error',
48
    ],
49
  },
50
};
51

52
// Perform gRPC call
53
client.VerifySignature(request, metadata, (err: grpc.ServiceError | null, response: any) => {
54
  if (err) {
55
    console.error('gRPC Error:', {
56
      code: err.code,
57
      message: err.message,
58
      details: err.details,
59
    });
60
  } else {
61
    console.log('VerifySignature Response:');
62
    console.log(JSON.stringify(response, null, 2));
63
  }
64
});
65

1
import grpc
2
import json
3
from google.protobuf.field_mask_pb2 import FieldMask
4
from google.protobuf.json_format import MessageToDict
5
from sui.rpc.v2 import signature_verification_service_pb2, signature_verification_service_pb2_grpc
6

7

8
def verify_signature():
9

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

15
    endpoint = 'docs-demo.sui-mainnet.quiknode.pro:9000';
16
    token = 'abcde123456789';
17

18
    channel = grpc.secure_channel(endpoint, grpc.ssl_channel_credentials())
19
    stub = signature_verification_service_pb2_grpc.SignatureVerificationServiceStub(channel)
20

21
    read_mask = FieldMask(paths=[
22
        "is_valid",
23
        "error"
24
    ])
25

26
    request = signature_verification_service_pb2.VerifySignatureRequest(
27
        signature=signature_verification_service_pb2.Signature(
28
            scheme=0,  # ED25519
29
            signature=b"YOUR_SIGNATURE_BYTES",  # Replace with actual signature
30
            public_key=b"YOUR_PUBLIC_KEY_BYTES"  # Replace with actual public key
31
        ),
32
        message=b"YOUR_MESSAGE_BYTES",  # Replace with actual message
33
        read_mask=read_mask
34
    )
35

36
    metadata = [("x-token", token)]
37

38
    return stub.VerifySignature(request, metadata=metadata)
39

40

41
def parse_response_to_json(response):
42
    return json.dumps(
43
        MessageToDict(response, preserving_proto_field_name=True),
44
        indent=2
45
    )
46

47

48
def main():
49
    try:
50
        response = verify_signature()
51
        print(parse_response_to_json(response))
52
    except grpc.RpcError as e:
53
        print(f"{e.code().name}: {e.details()}")
54

55

56
if __name__ == "__main__":
57
    main()
58

1
import grpc
2
import json
3
from google.protobuf.field_mask_pb2 import FieldMask
4
from google.protobuf.json_format import MessageToDict
5
from sui.rpc.v2 import signature_verification_service_pb2, signature_verification_service_pb2_grpc
6

7

8
def verify_signature():
9

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

15
    endpoint = 'docs-demo.sui-mainnet.quiknode.pro:9000';
16
    token = 'abcde123456789';
17

18
    channel = grpc.secure_channel(endpoint, grpc.ssl_channel_credentials())
19
    stub = signature_verification_service_pb2_grpc.SignatureVerificationServiceStub(channel)
20

21
    read_mask = FieldMask(paths=[
22
        "is_valid",
23
        "error"
24
    ])
25

26
    request = signature_verification_service_pb2.VerifySignatureRequest(
27
        signature=signature_verification_service_pb2.Signature(
28
            scheme=0,  # ED25519
29
            signature=b"YOUR_SIGNATURE_BYTES",  # Replace with actual signature
30
            public_key=b"YOUR_PUBLIC_KEY_BYTES"  # Replace with actual public key
31
        ),
32
        message=b"YOUR_MESSAGE_BYTES",  # Replace with actual message
33
        read_mask=read_mask
34
    )
35

36
    metadata = [("x-token", token)]
37

38
    return stub.VerifySignature(request, metadata=metadata)
39

40

41
def parse_response_to_json(response):
42
    return json.dumps(
43
        MessageToDict(response, preserving_proto_field_name=True),
44
        indent=2
45
    )
46

47

48
def main():
49
    try:
50
        response = verify_signature()
51
        print(parse_response_to_json(response))
52
    except grpc.RpcError as e:
53
        print(f"{e.code().name}: {e.details()}")
54

55

56
if __name__ == "__main__":
57
    main()
58

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free