BatchGetTransactions gRPC Method

Parameters

transaction_digests

array

REQUIRED

Array of transaction digests to retrieve

read_mask

object

Field mask specifying which fields of the checkpoint to include in the response.

paths

array

List of field names to include (e.g., 'transaction', 'digest' etc). If omitted, defaults to 'digest'.

Returns

transactions

array

An array of transactions

digest

string

The unique transaction digest/hash that identifies this transaction

transaction

object

The transaction object which contains the following fields:

bcs

object

The bcs object which contains the following fields:

value

string

Base64 encoded BCS representation of the transaction

digest

string

Transaction digest matching the root digest

version

integer

Transaction format version number

kind

object

The kind object which contains the following fields:

programmableTransaction

object

The programmableTransaction object which contains the following fields:

inputs

array

An array of inputs

kind

string

Type of input (e.g., 'Input', 'Result', 'NestedResult')

objectId

string

Sui object ID if input is an object

version

string

Object version number

digest

string

Object content digest

commands

array

A sequence of programmable commands—such as moveCall, transferObjects, splitCoins, mergeCoins, makeMoveVec, publish, upgrade, transferSui, pay, paySui, payAllSui, withdraw, deposit, and deleteObject—used to perform operations like coin manipulation, swaps, and transfers. The exact commands and their fields depend on the specific actions required by the transaction

moveCall

object

The moveCall object which contains the following fields:

package

string

The Sui package ID containing the function

module

string

The module name within the package

function

string

The function name to call

typeArguments

string

A list of string values

sender

string

The Sui address that initiated and signed this transaction

gasPayment

object

The gasPayment object which contains the following fields:

objects

array

An array of objects

objectId

string

The Sui coin object ID used for gas

version

string

Version of the gas coin object

digest

string

Content digest of the gas coin

owner

string

Owner address of the gas payment objects

price

string

Gas price in MIST per gas unit

budget

string

Maximum gas budget for the transaction

expiration

object

The expiration object which contains the following fields:

kind

string

Expiration type (e.g., 'None', 'Epoch')

effects

object

The effects object which contains the following fields:

bcs

object

The bcs object which contains the following fields:

value

string

Base64 encoded BCS representation of the effects

digest

string

Effects digest hash

version

integer

Effects format version number

status

object

The status object which contains the following fields:

success

boolean

Whether the transaction executed successfully

epoch

string

The epoch number when the transaction was executed

gasUsed

object

The gasUsed object which contains the following fields:

computationCost

string

Gas units consumed for computation

storageCost

string

Gas units consumed for storage

storageRebate

string

Gas units refunded from storage cleanup

nonRefundableStorageFee

string

Permanent storage fee that cannot be refunded

transactionDigest

string

The digest of the transaction that produced these effects

gasObject

object

The gasObject object which contains the following fields:

objectId

string

The gas coin object ID

inputState

string

Initial state of the gas object

inputVersion

string

Initial version of the gas object

inputDigest

string

Initial digest of the gas object

inputOwner

object

The inputOwner object which contains the following fields:

kind

string

Owner type (e.g., 'Address', 'Object', 'Shared')

address

string

Owner's Sui address

outputState

string

Final state of the gas object after transaction

outputVersion

string

Final version of the gas object

outputDigest

string

Final digest of the gas object

outputOwner

object

The outputOwner object which contains the following fields:

kind

string

Owner type after transaction

address

string

Owner's Sui address after transaction

idOperation

string

Operation performed on the object ID

eventsDigest

string

Digest of all events emitted by the transaction

dependencies

string

A list of string values

lamportVersion

string

Global ordering version for the transaction

changedObjects

array

An array of changedObjects

objectId

string

ID of the object that was changed

inputState

string

State of the object before the transaction

inputVersion

string

Version of the object before the transaction

inputDigest

string

Digest of the object before the transaction

inputOwner

object

The inputOwner object which contains the following fields:

kind

string

Owner type before the change

address

string

Owner address before the change

outputState

string

State of the object after the transaction

idOperation

string

Operation performed on this object

unchangedSharedObjects

array

An array of unchangedSharedObjects

kind

string

Type of shared object reference

objectId

string

ID of the shared object

version

string

Version of the shared object

digest

string

Digest of the shared object

events

object

The events object which contains the following fields:

bcs

object

The bcs object which contains the following fields:

value

string

Base64 encoded BCS representation of the events

digest

string

Digest hash of all events

events

array

An array of events

packageId

string

ID of the package that emitted the event

module

string

Module name that emitted the event

sender

string

Transaction sender address

eventType

string

Full type name of the event

contents

object

The contents object which contains the following fields:

name

string

Field name in the event struct

value

string

Field value in the event struct

Request

grpcurl -proto ./sui/rpc/v2beta/ledger_service.proto -H "x-token: YOUR_TOKEN_VALUE" -d '{
  "digests": [
    "Em2WbJa7GE84ryQ8NCjTmZnjEUpvpeTtmeeZ8vREuitn"
  ],
  "read_mask": {
    "paths": [
      "digest",
      "transaction",
      "effects",
      "events"
    ]
  }
}' docs-demo.sui-mainnet.quiknode.pro:9000 sui.rpc.v2beta.LedgerService/BatchGetTransactions

package main

import (
	"context"
	"crypto/tls"
	"encoding/json"
	"fmt"
	"log"
	"time"

	"google.golang.org/grpc"
	"google.golang.org/grpc/credentials"
	"google.golang.org/protobuf/encoding/protojson"
	"google.golang.org/protobuf/types/known/fieldmaskpb"

	pb "sui-grpc/sui/proto/generated/sui/rpc/v2beta"  // 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"
)

// Auth structure for x-token
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() {
	// TLS credentials and x-token auth
	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)

	// Digest array
	digests := []string{
		"Em2WbJa7GE84ryQ8NCjTmZnjEUpvpeTtmeeZ8vREuitn",
	}

	// FieldMask to restrict returned fields
	readMask := &fieldmaskpb.FieldMask{
		Paths: []string{"digest", "transaction", "effects", "events"},
	}

	req := &pb.BatchGetTransactionsRequest{
		Digests:   digests,
		ReadMask:  readMask,
	}

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

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

	// Format response as pretty JSON
	marshaler := protojson.MarshalOptions{
		UseProtoNames:   true,
		EmitUnpopulated: true,
		Indent:          "  ",
	}

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

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

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

import * as grpc from '@grpc/grpc-js';
import * as protoLoader from '@grpc/proto-loader';
import * as path from 'path';

// Constants
const PROTO_PATH = path.join(__dirname, 'protos/sui/rpc/v2beta/ledger_service.proto');

// 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

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

// Load proto definition
const packageDefinition = protoLoader.loadSync(PROTO_PATH, {
  keepCase: true,
  longs: String,
  enums: String,
  defaults: true,
  oneofs: true,
  includeDirs: [path.join(__dirname, 'protos')],
});
const proto = grpc.loadPackageDefinition(packageDefinition) as any;
const LedgerService = proto.sui.rpc.v2beta.LedgerService;

// Create gRPC client with TLS
const client = new LedgerService(endpoint, grpc.credentials.createSsl());

// Metadata for authentication
const metadata = new grpc.Metadata();
metadata.add('x-token', token);

// Request setup
const request = {
  digests: ['Em2WbJa7GE84ryQ8NCjTmZnjEUpvpeTtmeeZ8vREuitn'], // Replace with valid digests
  read_mask: {
    paths: ['digest', 'transaction', 'effects', 'events'], // FieldMask
  },
};

// Invoke BatchGetTransactions
client.BatchGetTransactions(request, metadata, (err: grpc.ServiceError | null, response: any) => {
  if (err) {
    console.error('gRPC Error:', {
      code: err.code,
      message: err.message,
      details: err.details,
    });
  } else {
    console.log('BatchGetTransactions Response:');
    console.log(JSON.stringify(response, null, 2));
  }
});

import grpc
import json
from google.protobuf.field_mask_pb2 import FieldMask
from google.protobuf.json_format import MessageToDict
from sui.rpc.v2beta import ledger_service_pb2, ledger_service_pb2_grpc


def get_batch_transactions():
    # 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

    endpoint = 'docs-demo.sui-mainnet.quiknode.pro:9000';
    token = 'YOUR_TOKEN_HERE';

    channel = grpc.secure_channel(endpoint, grpc.ssl_channel_credentials())
    stub = ledger_service_pb2_grpc.LedgerServiceStub(channel)

    tx_digests = [
        "Em2WbJa7GE84ryQ8NCjTmZnjEUpvpeTtmeeZ8vREuitn"
    ]

    read_mask = FieldMask(paths=[
        "digest",
        "transaction",
        "effects",
        "events"
    ])

    request = ledger_service_pb2.BatchGetTransactionsRequest(
        digests=tx_digests,
        read_mask=read_mask
    )

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

    return stub.BatchGetTransactions(request, metadata=metadata)


def parse_response_to_json(response):
    return json.dumps(
        MessageToDict(response, preserving_proto_field_name=True),
        indent=2
    )


def main():
    try:
        response = get_batch_transactions()
        print(parse_response_to_json(response))
    except grpc.RpcError as e:
        print(f"{e.code().name}: {e.details()}")


if __name__ == "__main__":
    main()

Don't have an account yet?

Create your QuickNode endpoint in seconds and start building

Get started for free