Added getSystemTransaction implementation (#1871)

Author: mfbz

flowkit.go

@@ -891,6 +891,27 @@ func (f *Flowkit) GetTransactionsByBlockID(
 	return tx, txRes, nil
 }
 
+func (f *Flowkit) GetSystemTransaction(
+	ctx context.Context,
+	blockID flow.Identifier,
+) (*flow.Transaction, *flow.TransactionResult, error) {
+	f.logger.StartProgress("Fetching System Transaction...")
+	defer f.logger.StopProgress()
+
+	tx, err := f.gateway.GetSystemTransaction(ctx, blockID)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	// Fetch the result so that it can be correctly returned
+	result, err := f.gateway.GetSystemTransactionResult(ctx, blockID)
+	if err != nil {
+		return tx, nil, err
+	}
+
+	return tx, result, nil
+}
+
 // BuildTransaction builds a new transaction type for later signing and submitting to the network.
 //
 // AddressesRoles type defines the address for each role (payer, proposer, authorizers) and the script defines the transaction content.

gateway/emulator.go

@@ -151,6 +151,14 @@ func (g *EmulatorGateway) GetTransactionsByBlockID(ctx context.Context, id flow.
 	return txr, nil
 }
 
+func (g *EmulatorGateway) GetSystemTransaction(ctx context.Context, blockID flow.Identifier) (*flow.Transaction, error) {
+	return nil, errors.New("GetSystemTransaction is not implemented")
+}
+
+func (g *EmulatorGateway) GetSystemTransactionResult(ctx context.Context, blockID flow.Identifier) (*flow.TransactionResult, error) {
+	return nil, errors.New("GetSystemTransactionResult is not implemented")
+}
+
 func (g *EmulatorGateway) Ping() error {
 	ctx := context.Background()
 	err := g.adapter.Ping(ctx)

gateway/gateway.go

@@ -35,6 +35,8 @@ type Gateway interface {
 	GetTransactionResultsByBlockID(ctx context.Context, blockID flow.Identifier) ([]*flow.TransactionResult, error)
 	GetTransactionResult(context.Context, flow.Identifier, bool) (*flow.TransactionResult, error)
 	GetTransactionsByBlockID(context.Context, flow.Identifier) ([]*flow.Transaction, error)
+	GetSystemTransaction(ctx context.Context, blockID flow.Identifier) (*flow.Transaction, error)
+	GetSystemTransactionResult(ctx context.Context, blockID flow.Identifier) (*flow.TransactionResult, error)
 	ExecuteScript(context.Context, []byte, []cadence.Value) (cadence.Value, error)
 	ExecuteScriptAtHeight(context.Context, []byte, []cadence.Value, uint64) (cadence.Value, error)
 	ExecuteScriptAtID(context.Context, []byte, []cadence.Value, flow.Identifier) (cadence.Value, error)

gateway/grpc.go

@@ -47,9 +47,9 @@ type GrpcGateway struct {
 func NewGrpcGateway(network config.Network, opts ...grpcAccess.ClientOption) (*GrpcGateway, error) {
 	options := append(
 		[]grpcAccess.ClientOption{
-		grpcAccess.WithGRPCDialOptions(
-			grpc.WithDefaultCallOptions(grpc.MaxCallRecvMsgSize(maxGRPCMessageSize)),
-		),
+			grpcAccess.WithGRPCDialOptions(
+				grpc.WithDefaultCallOptions(grpc.MaxCallRecvMsgSize(maxGRPCMessageSize)),
+			),
 		},
 		opts...,
 	)
@@ -147,6 +147,14 @@ func (g *GrpcGateway) GetTransactionResult(ctx context.Context, ID flow.Identifi
 	return result, nil
 }
 
+func (g *GrpcGateway) GetSystemTransaction(ctx context.Context, blockID flow.Identifier) (*flow.Transaction, error) {
+	return g.client.GetSystemTransaction(ctx, blockID)
+}
+
+func (g *GrpcGateway) GetSystemTransactionResult(ctx context.Context, blockID flow.Identifier) (*flow.TransactionResult, error) {
+	return g.client.GetSystemTransactionResult(ctx, blockID)
+}
+
 // ExecuteScript executes a script on Flow through the Access API.
 func (g *GrpcGateway) ExecuteScript(ctx context.Context, script []byte, arguments []cadence.Value) (cadence.Value, error) {
 	return g.client.ExecuteScriptAtLatestBlock(ctx, script, arguments)

gateway/mocks/Gateway.go

@@ -29,16 +29,18 @@ import (
 )
 
 const (
-	GetAccountFunc            = "GetAccount"
-	SendSignedTransactionFunc = "SendSignedTransaction"
-	GetCollectionFunc         = "GetCollection"
-	GetTransactionResultFunc  = "GetTransactionResult"
-	GetEventsFunc             = "GetEvents"
-	GetLatestBlockFunc        = "GetLatestBlock"
-	GetBlockByHeightFunc      = "GetBlockByHeight"
-	GetBlockByIDFunc          = "GetBlockByID"
-	ExecuteScriptFunc         = "ExecuteScript"
-	GetTransactionFunc        = "GetTransaction"
+	GetAccountFunc                 = "GetAccount"
+	SendSignedTransactionFunc      = "SendSignedTransaction"
+	GetCollectionFunc              = "GetCollection"
+	GetTransactionResultFunc       = "GetTransactionResult"
+	GetEventsFunc                  = "GetEvents"
+	GetLatestBlockFunc             = "GetLatestBlock"
+	GetBlockByHeightFunc           = "GetBlockByHeight"
+	GetBlockByIDFunc               = "GetBlockByID"
+	ExecuteScriptFunc              = "ExecuteScript"
+	GetTransactionFunc             = "GetTransaction"
+	GetSystemTransactionFunc       = "GetSystemTransaction"
+	GetSystemTransactionResultFunc = "GetSystemTransactionResult"
 )
 
 type TestGateway struct {
@@ -55,6 +57,8 @@ type TestGateway struct {
 	GetTransaction                 *mock.Call
 	GetTransactionResultsByBlockID *mock.Call
 	GetTransactionsByBlockID       *mock.Call
+	GetSystemTransaction           *mock.Call
+	GetSystemTransactionResult     *mock.Call
 	GetLatestProtocolStateSnapshot *mock.Call
 	Ping                           *mock.Call
 	SecureConnection               *mock.Call
@@ -107,6 +111,16 @@ func DefaultMockGateway() *TestGateway {
 		GetBlockByHeight: m.On(GetBlockByHeightFunc, ctxMock, mock.Anything),
 		GetBlockByID:     m.On(GetBlockByIDFunc, ctxMock, mock.Anything),
 		GetLatestBlock:   m.On(GetLatestBlockFunc, ctxMock),
+		GetSystemTransaction: m.On(
+			GetSystemTransactionFunc,
+			ctxMock,
+			mock.AnythingOfType("flow.Identifier"),
+		),
+		GetSystemTransactionResult: m.On(
+			GetSystemTransactionResultFunc,
+			ctxMock,
+			mock.AnythingOfType("flow.Identifier"),
+		),
 	}
 
 	// default return values
@@ -130,6 +144,8 @@ func DefaultMockGateway() *TestGateway {
 	t.GetLatestBlock.Return(tests.NewBlock(), nil)
 	t.GetBlockByHeight.Return(tests.NewBlock(), nil)
 	t.GetBlockByID.Return(tests.NewBlock(), nil)
+	t.GetSystemTransaction.Return(tests.NewTransaction(), nil)
+	t.GetSystemTransactionResult.Return(tests.NewTransactionResult(nil), nil)
 
 	return t
 }