From 01b716dd9b138c2de3c2a9b072a72bcb1e70fe47 Mon Sep 17 00:00:00 2001 From: vishal <1117327+vishalchangrani@users.noreply.github.com> Date: Mon, 17 Nov 2025 15:13:18 -0800 Subject: [PATCH 1/6] adding details about scheduled transactions to transaction related gRPC endpoints in the access api --- docs/protocol/access-onchain-data/index.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/protocol/access-onchain-data/index.md b/docs/protocol/access-onchain-data/index.md index d4a6e2c82f..2c9ad983f5 100644 --- a/docs/protocol/access-onchain-data/index.md +++ b/docs/protocol/access-onchain-data/index.md @@ -311,9 +311,11 @@ message SendTransactionResponse { `GetTransaction` gets a [transaction](#transaction) by ID. +Any type of transaction - user submitted, scheduled transaction or a system transaction can be queried. + If the transaction is not found in the access node cache, the request is forwarded to a collection node. -_Currently, only transactions within the current epoch can be queried._ +_Currently, only transactions within the current network upgrade can be queried._ ```proto rpc GetTransaction (GetTransactionRequest) returns (TransactionResponse) @@ -347,6 +349,10 @@ message TransactionResponse { `GetTransactionsByBlockID` gets all the [transactions](#transaction) for a specified block. +The response includes user transactions and scheduled transactions. + +_Response does not include the system transaction_ + ```proto rpc GetTransactionsByBlockID(GetTransactionsByBlockIDRequest) returns (TransactionsResponse); ``` @@ -373,6 +379,8 @@ message TransactionsResponse { `GetTransactionResult` gets the execution result of a transaction. +Any type of transaction - user submitted, scheduled transaction or a system transaction can be queried. + ```proto rpc GetTransactionResult (GetTransactionRequest) returns (TransactionResultResponse) ``` @@ -409,6 +417,8 @@ message TransactionResultResponse { `GetTransactionResultByIndex` gets a transaction's result at a specified block and index. +Any type of transaction - user submitted, scheduled transaction or a system transaction can be queried. + ```proto rpc GetTransactionResultByIndex(GetTransactionByIndexRequest) returns (TransactionResultResponse); ``` @@ -444,6 +454,8 @@ message TransactionResultResponse { `GetTransactionResultsByBlockID` gets all the transaction results for a specified block. +Any type of transaction - user submitted, scheduled transaction or a system transaction can be queried. + ```proto rpc GetTransactionResultsByBlockID(GetTransactionsByBlockIDRequest) returns (TransactionResultsResponse); ``` @@ -470,6 +482,8 @@ message TransactionResultsResponse { `GetSystemTransaction` gets the system transaction for a block. +_Scheduled Transactions will not be included in the response_ + ```proto rpc GetSystemTransaction(GetSystemTransactionRequest) returns (TransactionResponse); ``` @@ -495,6 +509,8 @@ message TransactionResponse { `GetSystemTransactionResult` gets the system transaction result for a block. +_Scheduled Transactions will not be included in the response_ + ```proto rpc GetSystemTransactionResult(GetSystemTransactionResultRequest) returns (TransactionResultResponse); ``` From fc267a142f34dbb6e9abfe6ddf3abd8bdf3e5026 Mon Sep 17 00:00:00 2001 From: Vishal <1117327+vishalchangrani@users.noreply.github.com> Date: Mon, 24 Nov 2025 09:39:01 -0800 Subject: [PATCH 2/6] Update docs/protocol/access-onchain-data/index.md Co-authored-by: Peter Argue <89119817+peterargue@users.noreply.github.com> --- docs/protocol/access-onchain-data/index.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/protocol/access-onchain-data/index.md b/docs/protocol/access-onchain-data/index.md index 2c9ad983f5..414c4d4e8f 100644 --- a/docs/protocol/access-onchain-data/index.md +++ b/docs/protocol/access-onchain-data/index.md @@ -349,9 +349,7 @@ message TransactionResponse { `GetTransactionsByBlockID` gets all the [transactions](#transaction) for a specified block. -The response includes user transactions and scheduled transactions. - -_Response does not include the system transaction_ +The response includes user transactions, scheduled transactions, and system transactions. ```proto rpc GetTransactionsByBlockID(GetTransactionsByBlockIDRequest) returns (TransactionsResponse); From d2888521298d2d8bcc9c488185fc59fbf2656fa0 Mon Sep 17 00:00:00 2001 From: Vishal <1117327+vishalchangrani@users.noreply.github.com> Date: Mon, 24 Nov 2025 09:39:13 -0800 Subject: [PATCH 3/6] Update docs/protocol/access-onchain-data/index.md Co-authored-by: Peter Argue <89119817+peterargue@users.noreply.github.com> --- docs/protocol/access-onchain-data/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/protocol/access-onchain-data/index.md b/docs/protocol/access-onchain-data/index.md index 414c4d4e8f..401ad465ad 100644 --- a/docs/protocol/access-onchain-data/index.md +++ b/docs/protocol/access-onchain-data/index.md @@ -452,7 +452,7 @@ message TransactionResultResponse { `GetTransactionResultsByBlockID` gets all the transaction results for a specified block. -Any type of transaction - user submitted, scheduled transaction or a system transaction can be queried. +The response includes results for user transactions, scheduled transactions, and system transactions. ```proto rpc GetTransactionResultsByBlockID(GetTransactionsByBlockIDRequest) returns (TransactionResultsResponse); From 197c4c0e412ef12ce54ccbce2e65fe9cb28ff67d Mon Sep 17 00:00:00 2001 From: vishal <1117327+vishalchangrani@users.noreply.github.com> Date: Mon, 24 Nov 2025 10:25:27 -0800 Subject: [PATCH 4/6] adding Scheduled Transactions request and response description to access api doc --- docs/protocol/access-onchain-data/index.md | 54 ++++++++++++++++++++++ 1 file changed, 54 insertions(+) diff --git a/docs/protocol/access-onchain-data/index.md b/docs/protocol/access-onchain-data/index.md index 401ad465ad..c467ab847e 100644 --- a/docs/protocol/access-onchain-data/index.md +++ b/docs/protocol/access-onchain-data/index.md @@ -476,6 +476,60 @@ message TransactionResultsResponse { } ``` +### GetScheduledTransaction + +`GetScheduledTransaction` gets the scheduled transaction body for a given callback ID. + +```proto +rpc GetScheduledTransaction(GetScheduledTransactionRequest) returns (TransactionResponse); +``` + +#### Request + +```proto +message GetScheduledTransactionRequest { + uint64 id = 1; + entities.ExecutionStateQuery execution_state_query = 2; +} +``` + +#### Response + +```proto +message TransactionResponse { + entities.Transaction transaction = 1; + entities.Metadata metadata = 2; +} +``` + +### GetScheduledTransactionResult + +GetScheduledTransactionResult gets a scheduled transaction result for a given callback ID + +```proto +rpc GetScheduledTransactionResult(GetScheduledTransactionResultRequest) +returns (TransactionResultResponse); +``` + +#### Request + +```proto +message GetScheduledTransactionResultRequest { + uint64 id = 1; + entities.EventEncodingVersion event_encoding_version = 2; + entities.ExecutionStateQuery execution_state_query = 3; +} +``` + +#### Response + +```proto +message TransactionResponse { + entities.Transaction transaction = 1; + entities.Metadata metadata = 2; +} +``` + ### GetSystemTransaction `GetSystemTransaction` gets the system transaction for a block. From 4e203eafba5ead65505ea704a9dfe4b7ae0a130a Mon Sep 17 00:00:00 2001 From: Vishal <1117327+vishalchangrani@users.noreply.github.com> Date: Wed, 26 Nov 2025 15:21:30 -0800 Subject: [PATCH 5/6] Update docs/protocol/access-onchain-data/index.md Co-authored-by: Peter Argue <89119817+peterargue@users.noreply.github.com> --- docs/protocol/access-onchain-data/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/protocol/access-onchain-data/index.md b/docs/protocol/access-onchain-data/index.md index c467ab847e..1b165d7cea 100644 --- a/docs/protocol/access-onchain-data/index.md +++ b/docs/protocol/access-onchain-data/index.md @@ -478,7 +478,7 @@ message TransactionResultsResponse { ### GetScheduledTransaction -`GetScheduledTransaction` gets the scheduled transaction body for a given callback ID. +`GetScheduledTransaction` gets the scheduled transaction body for a given scheduled transaction ID. ```proto rpc GetScheduledTransaction(GetScheduledTransactionRequest) returns (TransactionResponse); From bc92a8d01a138d44df5f64e4046ca0f78abfd034 Mon Sep 17 00:00:00 2001 From: Vishal <1117327+vishalchangrani@users.noreply.github.com> Date: Wed, 26 Nov 2025 15:21:37 -0800 Subject: [PATCH 6/6] Update docs/protocol/access-onchain-data/index.md Co-authored-by: Peter Argue <89119817+peterargue@users.noreply.github.com> --- docs/protocol/access-onchain-data/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/protocol/access-onchain-data/index.md b/docs/protocol/access-onchain-data/index.md index 1b165d7cea..1341d684a1 100644 --- a/docs/protocol/access-onchain-data/index.md +++ b/docs/protocol/access-onchain-data/index.md @@ -504,7 +504,7 @@ message TransactionResponse { ### GetScheduledTransactionResult -GetScheduledTransactionResult gets a scheduled transaction result for a given callback ID +GetScheduledTransactionResult gets a scheduled transaction result for a given scheduled transaction ID ```proto rpc GetScheduledTransactionResult(GetScheduledTransactionResultRequest)