SimulateTransaction gRPC Method

Parameters

transaction

object

REQUIRED

Loading...

read_mask

object

Loading...

checks

string

Loading...

do_gas_selection

boolean

Loading...

Returns

transaction

object

Loading...

digest

string

Loading...

transaction

object

Loading...

effects

object

Loading...

events

object

Loading...

timestamp

string

Loading...

outputs

array

Loading...

returnValues

array

Loading...

mutatedByRef

array

Loading...

Request

1
grpcurl \
2
  -import-path . \
3
  -proto sui/rpc/v2beta2/live_data_service.proto \
4
  -H "x-token: abcde123456789" \
5
  -d '{
6
    "transaction": {
7
      "bcs": "BASE64_TX_BYTES",
8
      "signatures": [
9
        {
10
          "scheme": "ED25519",
11
          "signature": "BASE64_SIGNATURE",
12
          "public_key": "BASE64_PUBLIC_KEY"
13
        }
14
      ]
15
    },
16
    "read_mask": { "paths": ["transaction.effects", "transaction.events"] },
17
    "checks": "ENABLED",
18
    "do_gas_selection": true
19
  }' \
20
  docs-demo.sui-mainnet.quiknode.pro:9000 \
21
  sui.rpc.v2beta2.LiveDataService/SimulateTransaction

1
grpcurl \
2
  -import-path . \
3
  -proto sui/rpc/v2beta2/live_data_service.proto \
4
  -H "x-token: abcde123456789" \
5
  -d '{
6
    "transaction": {
7
      "bcs": "BASE64_TX_BYTES",
8
      "signatures": [
9
        {
10
          "scheme": "ED25519",
11
          "signature": "BASE64_SIGNATURE",
12
          "public_key": "BASE64_PUBLIC_KEY"
13
        }
14
      ]
15
    },
16
    "read_mask": { "paths": ["transaction.effects", "transaction.events"] },
17
    "checks": "ENABLED",
18
    "do_gas_selection": true
19
  }' \
20
  docs-demo.sui-mainnet.quiknode.pro:9000 \
21
  sui.rpc.v2beta2.LiveDataService/SimulateTransaction

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
// 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.NewLiveDataServiceClient(conn)
55

56
	req := &pb.SimulateTransactionRequest{
57
		Transaction: &pb.Transaction{
58
			Bcs: &pb.BcsBytes{
59
				Bytes: []byte("YOUR_BCS_SERIALIZED_TX_BYTES"), // Replace with actual bytes
60
			},
61
		},
62
		Signatures: []*pb.Signature{
63
			{
64
				Scheme:    0, // ED25519
65
				Signature: []byte("YOUR_SIGNATURE_BYTES"), // Replace with actual bytes
66
				PublicKey: []byte("YOUR_PUBLIC_KEY_BYTES"), // Replace with actual bytes
67
			},
68
		},
69
		ReadMask: &fieldmaskpb.FieldMask{
70
			Paths: []string{
71
				"effects",
72
				"events",
73
			},
74
		},
75
	}
76

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

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

85
	// Pretty print the response
86
	marshaler := protojson.MarshalOptions{
87
		UseProtoNames:   true,
88
		EmitUnpopulated: true,
89
		Indent:          "  ",
90
	}
91

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

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

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

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
// 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.NewLiveDataServiceClient(conn)
55

56
	req := &pb.SimulateTransactionRequest{
57
		Transaction: &pb.Transaction{
58
			Bcs: &pb.BcsBytes{
59
				Bytes: []byte("YOUR_BCS_SERIALIZED_TX_BYTES"), // Replace with actual bytes
60
			},
61
		},
62
		Signatures: []*pb.Signature{
63
			{
64
				Scheme:    0, // ED25519
65
				Signature: []byte("YOUR_SIGNATURE_BYTES"), // Replace with actual bytes
66
				PublicKey: []byte("YOUR_PUBLIC_KEY_BYTES"), // Replace with actual bytes
67
			},
68
		},
69
		ReadMask: &fieldmaskpb.FieldMask{
70
			Paths: []string{
71
				"effects",
72
				"events",
73
			},
74
		},
75
	}
76

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

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

85
	// Pretty print the response
86
	marshaler := protojson.MarshalOptions{
87
		UseProtoNames:   true,
88
		EmitUnpopulated: true,
89
		Indent:          "  ",
90
	}
91

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

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

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

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/v2beta2/live_data_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 LiveDataService = proto.sui.rpc.v2beta2.LiveDataService;
28

29
// Create secure client
30
const client = new LiveDataService(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
  transaction: {
39
    bcs: {
40
      bytes: Buffer.from('YOUR_BCS_SERIALIZED_TX_BYTES', 'base64') // Replace with actual bytes
41
    }
42
  },
43
  signatures: [
44
    {
45
      scheme: 0, // Usually 0 = ED25519
46
      signature: Buffer.from('YOUR_SIGNATURE_BYTES', 'base64'), // Replace with actual bytes
47
      public_key: Buffer.from('YOUR_PUBLIC_KEY_BYTES', 'base64') // Replace with actual bytes
48
    }
49
  ],
50
  read_mask: {
51
    paths: ['effects', 'events']
52
  }
53
};
54

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

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/v2beta2/live_data_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 LiveDataService = proto.sui.rpc.v2beta2.LiveDataService;
28

29
// Create secure client
30
const client = new LiveDataService(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
  transaction: {
39
    bcs: {
40
      bytes: Buffer.from('YOUR_BCS_SERIALIZED_TX_BYTES', 'base64') // Replace with actual bytes
41
    }
42
  },
43
  signatures: [
44
    {
45
      scheme: 0, // Usually 0 = ED25519
46
      signature: Buffer.from('YOUR_SIGNATURE_BYTES', 'base64'), // Replace with actual bytes
47
      public_key: Buffer.from('YOUR_PUBLIC_KEY_BYTES', 'base64') // Replace with actual bytes
48
    }
49
  ],
50
  read_mask: {
51
    paths: ['effects', 'events']
52
  }
53
};
54

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

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 live_data_service_pb2, live_data_service_pb2_grpc
6

7

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

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

17
    channel = grpc.secure_channel(endpoint, grpc.ssl_channel_credentials())
18
    stub = live_data_service_pb2_grpc.LiveDataServiceStub(channel)
19

20
    read_mask = FieldMask(paths=[
21
        "effects",
22
        "events"
23
    ])
24

25
    request = live_data_service_pb2.SimulateTransactionRequest(
26
        transaction=live_data_service_pb2.Transaction(
27
            bcs=live_data_service_pb2.BcsBytes(
28
                bytes=b"YOUR_BCS_SERIALIZED_TX_BYTES"  # Replace with actual bytes
29
            )
30
        ),
31
        signatures=[
32
            live_data_service_pb2.Signature(
33
                scheme=0,  # ED25519
34
                signature=b"YOUR_SIGNATURE_BYTES",  # Replace with actual bytes
35
                public_key=b"YOUR_PUBLIC_KEY_BYTES"  # Replace with actual bytes
36
            )
37
        ],
38
        read_mask=read_mask
39
    )
40

41
    metadata = [("x-token", token)]
42

43
    return stub.SimulateTransaction(request, metadata=metadata)
44

45

46
def parse_response_to_json(response):
47
    return json.dumps(
48
        MessageToDict(response, preserving_proto_field_name=True),
49
        indent=2
50
    )
51

52

53
def main():
54
    try:
55
        response = simulate_transaction()
56
        print(parse_response_to_json(response))
57
    except grpc.RpcError as e:
58
        print(f"{e.code().name}: {e.details()}")
59

60
if __name__ == "__main__":
61
    main()
62

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 live_data_service_pb2, live_data_service_pb2_grpc
6

7

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

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

17
    channel = grpc.secure_channel(endpoint, grpc.ssl_channel_credentials())
18
    stub = live_data_service_pb2_grpc.LiveDataServiceStub(channel)
19

20
    read_mask = FieldMask(paths=[
21
        "effects",
22
        "events"
23
    ])
24

25
    request = live_data_service_pb2.SimulateTransactionRequest(
26
        transaction=live_data_service_pb2.Transaction(
27
            bcs=live_data_service_pb2.BcsBytes(
28
                bytes=b"YOUR_BCS_SERIALIZED_TX_BYTES"  # Replace with actual bytes
29
            )
30
        ),
31
        signatures=[
32
            live_data_service_pb2.Signature(
33
                scheme=0,  # ED25519
34
                signature=b"YOUR_SIGNATURE_BYTES",  # Replace with actual bytes
35
                public_key=b"YOUR_PUBLIC_KEY_BYTES"  # Replace with actual bytes
36
            )
37
        ],
38
        read_mask=read_mask
39
    )
40

41
    metadata = [("x-token", token)]
42

43
    return stub.SimulateTransaction(request, metadata=metadata)
44

45

46
def parse_response_to_json(response):
47
    return json.dumps(
48
        MessageToDict(response, preserving_proto_field_name=True),
49
        indent=2
50
    )
51

52

53
def main():
54
    try:
55
        response = simulate_transaction()
56
        print(parse_response_to_json(response))
57
    except grpc.RpcError as e:
58
        print(f"{e.code().name}: {e.details()}")
59

60
if __name__ == "__main__":
61
    main()
62

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free