ExecuteTransaction gRPC Method

Parameters

transaction

object

REQUIRED

Loading...

signatures

array

Loading...

read_mask

object

Loading...

Returns

finality

object

Loading...

certified

object

Loading...

checkpointed

string

Loading...

quorumExecuted

object

Loading...

transaction

object

Loading...

digest

string

Loading...

transaction

object

Loading...

signatures

array

Loading...

effects

object

Loading...

events

object

Loading...

checkpoint

string

Loading...

timestamp

string

Loading...

balanceChanges

array

Loading...

inputObjects

array

Loading...

outputObjects

array

Loading...

Request

1
grpcurl \
2
  -import-path . \
3
  -proto sui/rpc/v2beta2/transaction_execution_service.proto \
4
  -H "x-token: YOUR_TOKEN_VALUE" \
5
  -d '{
6
    "transaction": {
7
      "bcs": "BASE64_ENCODED_TX"
8
    },
9
    "options": {
10
      "show_input": true,
11
      "show_effects": true,
12
      "show_events": true,
13
      "show_object_changes": true,
14
      "show_balance_changes": true
15
    }
16
  }' \
17
  docs-demo.sui-mainnet.quiknode.pro:9000 \
18
  sui.rpc.v2beta2.TransactionExecutionService/ExecuteTransaction
19

1
grpcurl \
2
  -import-path . \
3
  -proto sui/rpc/v2beta2/transaction_execution_service.proto \
4
  -H "x-token: YOUR_TOKEN_VALUE" \
5
  -d '{
6
    "transaction": {
7
      "bcs": "BASE64_ENCODED_TX"
8
    },
9
    "options": {
10
      "show_input": true,
11
      "show_effects": true,
12
      "show_events": true,
13
      "show_object_changes": true,
14
      "show_balance_changes": true
15
    }
16
  }' \
17
  docs-demo.sui-mainnet.quiknode.pro:9000 \
18
  sui.rpc.v2beta2.TransactionExecutionService/ExecuteTransaction
19

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/v2beta2" // Your Generated .pb.go files path
17
)
18

19
var (
20
	token    = "YOUR_TOKEN_NUMBER"
21
	endpoint = "YOUR_QN_ENDPOINT:9000"
22
)
23

24
// x-token Auth implementation
25
type auth struct {
26
	token string
27
}
28

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

36
func main() {
37
	creds := credentials.NewTLS(&tls.Config{})
38
	opts := []grpc.DialOption{
39
		grpc.WithTransportCredentials(creds),
40
		grpc.WithPerRPCCredentials(&auth{token}),
41
	}
42

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

49
	client := pb.NewTransactionExecutionServiceClient(conn)
50

51
	bcsTx := []byte("YOUR_BCS_SERIALIZED_TX_BYTES")
52

53
	sig := &pb.UserSignature{
54
		Scheme:    pb.SignatureScheme_ED25519,
55
		Signature: []byte("YOUR_SIGNATURE_BYTES"),
56
		PublicKey: []byte("YOUR_PUBLIC_KEY_BYTES"),
57
	}
58

59
	// ReadMask specifies what response fields to return
60
	readMask := &fieldmaskpb.FieldMask{
61
		Paths: []string{"transaction", "finality"},
62
	}
63

64
	// Build request
65
	req := &pb.ExecuteTransactionRequest{
66
		Transaction: &pb.Transaction{
67
			Bcs: &pb.Bcs{
68
				Bytes: bcsTx,
69
			},
70
		},
71
		Signatures: []*pb.UserSignature{sig},
72
		ReadMask:   readMask,
73
	}
74

75
	// Context with timeout
76
	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
77
	defer cancel()
78

79
	resp, err := client.ExecuteTransaction(ctx, req)
80
	if err != nil {
81
		log.Fatalf("ExecuteTransaction failed: %v", err)
82
	}
83

84
	// Marshal response to pretty JSON
85
	marshaler := protojson.MarshalOptions{
86
		UseProtoNames:   true,
87
		EmitUnpopulated: true,
88
		Indent:          "  ",
89
	}
90
	jsonBytes, err := marshaler.Marshal(resp)
91
	if err != nil {
92
		log.Fatalf("Failed to marshal response: %v", err)
93
	}
94

95
	// Print result
96
	var pretty map[string]interface{}
97
	if err := json.Unmarshal(jsonBytes, &pretty); err != nil {
98
		log.Fatalf("Failed to parse JSON: %v", err)
99
	}
100
	output, _ := json.MarshalIndent(pretty, "", "  ")
101
	fmt.Println(string(output))
102
}
103

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/v2beta2" // Your Generated .pb.go files path
17
)
18

19
var (
20
	token    = "YOUR_TOKEN_NUMBER"
21
	endpoint = "YOUR_QN_ENDPOINT:9000"
22
)
23

24
// x-token Auth implementation
25
type auth struct {
26
	token string
27
}
28

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

36
func main() {
37
	creds := credentials.NewTLS(&tls.Config{})
38
	opts := []grpc.DialOption{
39
		grpc.WithTransportCredentials(creds),
40
		grpc.WithPerRPCCredentials(&auth{token}),
41
	}
42

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

49
	client := pb.NewTransactionExecutionServiceClient(conn)
50

51
	bcsTx := []byte("YOUR_BCS_SERIALIZED_TX_BYTES")
52

53
	sig := &pb.UserSignature{
54
		Scheme:    pb.SignatureScheme_ED25519,
55
		Signature: []byte("YOUR_SIGNATURE_BYTES"),
56
		PublicKey: []byte("YOUR_PUBLIC_KEY_BYTES"),
57
	}
58

59
	// ReadMask specifies what response fields to return
60
	readMask := &fieldmaskpb.FieldMask{
61
		Paths: []string{"transaction", "finality"},
62
	}
63

64
	// Build request
65
	req := &pb.ExecuteTransactionRequest{
66
		Transaction: &pb.Transaction{
67
			Bcs: &pb.Bcs{
68
				Bytes: bcsTx,
69
			},
70
		},
71
		Signatures: []*pb.UserSignature{sig},
72
		ReadMask:   readMask,
73
	}
74

75
	// Context with timeout
76
	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
77
	defer cancel()
78

79
	resp, err := client.ExecuteTransaction(ctx, req)
80
	if err != nil {
81
		log.Fatalf("ExecuteTransaction failed: %v", err)
82
	}
83

84
	// Marshal response to pretty JSON
85
	marshaler := protojson.MarshalOptions{
86
		UseProtoNames:   true,
87
		EmitUnpopulated: true,
88
		Indent:          "  ",
89
	}
90
	jsonBytes, err := marshaler.Marshal(resp)
91
	if err != nil {
92
		log.Fatalf("Failed to marshal response: %v", err)
93
	}
94

95
	// Print result
96
	var pretty map[string]interface{}
97
	if err := json.Unmarshal(jsonBytes, &pretty); err != nil {
98
		log.Fatalf("Failed to parse JSON: %v", err)
99
	}
100
	output, _ := json.MarshalIndent(pretty, "", "  ")
101
	fmt.Println(string(output))
102
}
103

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

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

10
const endpoint = 'docs-demo.sui-mainnet.quiknode.pro:9000';
11
const token = 'abcde123456789';
12

13
const PROTO_PATH = path.join(__dirname, 'protos/proto/sui/rpc/v2beta2/transaction_execution_service.proto');
14

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

25
const proto = grpc.loadPackageDefinition(packageDefinition) as any;
26
const TransactionExecutionService = proto.sui.rpc.v2beta2.TransactionExecutionService;
27

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

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

35
// Placeholder request
36
const request = {
37
  transaction: {
38
    bcs: {
39
      bytes: Buffer.from('YOUR_BCS_SERIALIZED_TX_BYTES', 'base64') // Replace with actual bytes
40
    }
41
  },
42
  signatures: [
43
    {
44
      scheme: 0, // Usually 0 = ED25519
45
      signature: Buffer.from('YOUR_SIGNATURE_BYTES', 'base64'), // Replace with actual bytes
46
      public_key: Buffer.from('YOUR_PUBLIC_KEY_BYTES', 'base64') // Replace with actual bytes
47
    }
48
  ],
49
  read_mask: {
50
    paths: ['transaction', 'finality']
51
  }
52
};
53

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

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

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

10
const endpoint = 'docs-demo.sui-mainnet.quiknode.pro:9000';
11
const token = 'abcde123456789';
12

13
const PROTO_PATH = path.join(__dirname, 'protos/proto/sui/rpc/v2beta2/transaction_execution_service.proto');
14

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

25
const proto = grpc.loadPackageDefinition(packageDefinition) as any;
26
const TransactionExecutionService = proto.sui.rpc.v2beta2.TransactionExecutionService;
27

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

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

35
// Placeholder request
36
const request = {
37
  transaction: {
38
    bcs: {
39
      bytes: Buffer.from('YOUR_BCS_SERIALIZED_TX_BYTES', 'base64') // Replace with actual bytes
40
    }
41
  },
42
  signatures: [
43
    {
44
      scheme: 0, // Usually 0 = ED25519
45
      signature: Buffer.from('YOUR_SIGNATURE_BYTES', 'base64'), // Replace with actual bytes
46
      public_key: Buffer.from('YOUR_PUBLIC_KEY_BYTES', 'base64') // Replace with actual bytes
47
    }
48
  ],
49
  read_mask: {
50
    paths: ['transaction', 'finality']
51
  }
52
};
53

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

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.v2beta2 import (
6
    transaction_execution_service_pb2,
7
    transaction_execution_service_pb2_grpc,
8
    transaction_pb2,
9
    signature_pb2,
10
    bcs_pb2
11
)
12

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

18
endpoint = 'docs-demo.sui-mainnet.quiknode.pro:9000';
19
token = 'abcde123456789';
20

21
def execute_transaction():
22
    channel = grpc.secure_channel(endpoint, grpc.ssl_channel_credentials())
23
    stub = transaction_execution_service_pb2_grpc.TransactionExecutionServiceStub(channel)
24

25
    # === PLACEHOLDER: BCS-serialized transaction ===
26
    transaction = transaction_pb2.Transaction(
27
        bcs=bcs_pb2.Bcs(
28
            bytes=b"YOUR_BCS_SERIALIZED_TX_BYTES"
29
        )
30
    )
31

32
    signature = signature_pb2.UserSignature(
33
        scheme=0,  # e.g., 0 = ED25519
34
        signature=b"YOUR_SIGNATURE_BYTES",
35
        public_key=b"YOUR_PUBLIC_KEY_BYTES"
36
    )
37

38
    read_mask = FieldMask(paths=["transaction", "finality"])
39

40
    request = transaction_execution_service_pb2.ExecuteTransactionRequest(
41
        transaction=transaction,
42
        signatures=[signature],
43
        read_mask=read_mask
44
    )
45

46
    metadata = [("x-token", token)]
47

48
    try:
49
        response = stub.ExecuteTransaction(request, metadata=metadata)
50
        return MessageToDict(response, preserving_proto_field_name=True)
51
    except grpc.RpcError as e:
52
        return {
53
            "error": e.code().name,
54
            "details": e.details()
55
        }
56

57

58
def main():
59
    result = execute_transaction()
60
    print(json.dumps(result, indent=2))
61

62

63
if __name__ == "__main__":
64
    main()
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.v2beta2 import (
6
    transaction_execution_service_pb2,
7
    transaction_execution_service_pb2_grpc,
8
    transaction_pb2,
9
    signature_pb2,
10
    bcs_pb2
11
)
12

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

18
endpoint = 'docs-demo.sui-mainnet.quiknode.pro:9000';
19
token = 'abcde123456789';
20

21
def execute_transaction():
22
    channel = grpc.secure_channel(endpoint, grpc.ssl_channel_credentials())
23
    stub = transaction_execution_service_pb2_grpc.TransactionExecutionServiceStub(channel)
24

25
    # === PLACEHOLDER: BCS-serialized transaction ===
26
    transaction = transaction_pb2.Transaction(
27
        bcs=bcs_pb2.Bcs(
28
            bytes=b"YOUR_BCS_SERIALIZED_TX_BYTES"
29
        )
30
    )
31

32
    signature = signature_pb2.UserSignature(
33
        scheme=0,  # e.g., 0 = ED25519
34
        signature=b"YOUR_SIGNATURE_BYTES",
35
        public_key=b"YOUR_PUBLIC_KEY_BYTES"
36
    )
37

38
    read_mask = FieldMask(paths=["transaction", "finality"])
39

40
    request = transaction_execution_service_pb2.ExecuteTransactionRequest(
41
        transaction=transaction,
42
        signatures=[signature],
43
        read_mask=read_mask
44
    )
45

46
    metadata = [("x-token", token)]
47

48
    try:
49
        response = stub.ExecuteTransaction(request, metadata=metadata)
50
        return MessageToDict(response, preserving_proto_field_name=True)
51
    except grpc.RpcError as e:
52
        return {
53
            "error": e.code().name,
54
            "details": e.details()
55
        }
56

57

58
def main():
59
    result = execute_transaction()
60
    print(json.dumps(result, indent=2))
61

62

63
if __name__ == "__main__":
64
    main()
65

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free