Skip to content

Commit ebd4132

Browse files
adding details about scheduled transactions to transaction related gRPC endpoints in the access api (#1590)
* adding details about scheduled transactions to transaction related gRPC endpoints in the access api * Update docs/protocol/access-onchain-data/index.md Co-authored-by: Peter Argue <89119817+peterargue@users.noreply.github.com> * Update docs/protocol/access-onchain-data/index.md Co-authored-by: Peter Argue <89119817+peterargue@users.noreply.github.com> * adding Scheduled Transactions request and response description to access api doc * Update docs/protocol/access-onchain-data/index.md Co-authored-by: Peter Argue <89119817+peterargue@users.noreply.github.com> * Update docs/protocol/access-onchain-data/index.md Co-authored-by: Peter Argue <89119817+peterargue@users.noreply.github.com> --------- Co-authored-by: Peter Argue <89119817+peterargue@users.noreply.github.com>
1 parent 6d75218 commit ebd4132

File tree

1 file changed

+69
-1
lines changed
  • docs/protocol/access-onchain-data

1 file changed

+69
-1
lines changed

docs/protocol/access-onchain-data/index.md

Lines changed: 69 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -311,9 +311,11 @@ message SendTransactionResponse {
311311

312312
`GetTransaction` gets a [transaction](#transaction) by ID.
313313

314+
Any type of transaction - user submitted, scheduled transaction or a system transaction can be queried.
315+
314316
If the transaction is not found in the access node cache, the request is forwarded to a collection node.
315317

316-
_Currently, only transactions within the current epoch can be queried._
318+
_Currently, only transactions within the current network upgrade can be queried._
317319

318320
```proto
319321
rpc GetTransaction (GetTransactionRequest) returns (TransactionResponse)
@@ -347,6 +349,8 @@ message TransactionResponse {
347349

348350
`GetTransactionsByBlockID` gets all the [transactions](#transaction) for a specified block.
349351

352+
The response includes user transactions, scheduled transactions, and system transactions.
353+
350354
```proto
351355
rpc GetTransactionsByBlockID(GetTransactionsByBlockIDRequest) returns (TransactionsResponse);
352356
```
@@ -373,6 +377,8 @@ message TransactionsResponse {
373377

374378
`GetTransactionResult` gets the execution result of a transaction.
375379

380+
Any type of transaction - user submitted, scheduled transaction or a system transaction can be queried.
381+
376382
```proto
377383
rpc GetTransactionResult (GetTransactionRequest) returns (TransactionResultResponse)
378384
```
@@ -409,6 +415,8 @@ message TransactionResultResponse {
409415

410416
`GetTransactionResultByIndex` gets a transaction's result at a specified block and index.
411417

418+
Any type of transaction - user submitted, scheduled transaction or a system transaction can be queried.
419+
412420
```proto
413421
rpc GetTransactionResultByIndex(GetTransactionByIndexRequest) returns (TransactionResultResponse);
414422
```
@@ -444,6 +452,8 @@ message TransactionResultResponse {
444452

445453
`GetTransactionResultsByBlockID` gets all the transaction results for a specified block.
446454

455+
The response includes results for user transactions, scheduled transactions, and system transactions.
456+
447457
```proto
448458
rpc GetTransactionResultsByBlockID(GetTransactionsByBlockIDRequest) returns (TransactionResultsResponse);
449459
```
@@ -466,10 +476,66 @@ message TransactionResultsResponse {
466476
}
467477
```
468478

479+
### GetScheduledTransaction
480+
481+
`GetScheduledTransaction` gets the scheduled transaction body for a given scheduled transaction ID.
482+
483+
```proto
484+
rpc GetScheduledTransaction(GetScheduledTransactionRequest) returns (TransactionResponse);
485+
```
486+
487+
#### Request
488+
489+
```proto
490+
message GetScheduledTransactionRequest {
491+
uint64 id = 1;
492+
entities.ExecutionStateQuery execution_state_query = 2;
493+
}
494+
```
495+
496+
#### Response
497+
498+
```proto
499+
message TransactionResponse {
500+
entities.Transaction transaction = 1;
501+
entities.Metadata metadata = 2;
502+
}
503+
```
504+
505+
### GetScheduledTransactionResult
506+
507+
GetScheduledTransactionResult gets a scheduled transaction result for a given scheduled transaction ID
508+
509+
```proto
510+
rpc GetScheduledTransactionResult(GetScheduledTransactionResultRequest)
511+
returns (TransactionResultResponse);
512+
```
513+
514+
#### Request
515+
516+
```proto
517+
message GetScheduledTransactionResultRequest {
518+
uint64 id = 1;
519+
entities.EventEncodingVersion event_encoding_version = 2;
520+
entities.ExecutionStateQuery execution_state_query = 3;
521+
}
522+
```
523+
524+
#### Response
525+
526+
```proto
527+
message TransactionResponse {
528+
entities.Transaction transaction = 1;
529+
entities.Metadata metadata = 2;
530+
}
531+
```
532+
469533
### GetSystemTransaction
470534

471535
`GetSystemTransaction` gets the system transaction for a block.
472536

537+
_Scheduled Transactions will not be included in the response_
538+
473539
```proto
474540
rpc GetSystemTransaction(GetSystemTransactionRequest) returns (TransactionResponse);
475541
```
@@ -495,6 +561,8 @@ message TransactionResponse {
495561

496562
`GetSystemTransactionResult` gets the system transaction result for a block.
497563

564+
_Scheduled Transactions will not be included in the response_
565+
498566
```proto
499567
rpc GetSystemTransactionResult(GetSystemTransactionResultRequest) returns (TransactionResultResponse);
500568
```

0 commit comments

Comments
 (0)