From 1869522f07ab2274109b7ccccf02879f0e7dd550 Mon Sep 17 00:00:00 2001 From: Jordan Ribbink Date: Sat, 20 Sep 2025 21:06:43 -0700 Subject: [PATCH 1/8] Add system transaction reference docs --- .../transactions/get-system-transactions.md | 170 ++++++++++++++++++ 1 file changed, 170 insertions(+) create mode 100644 docs/build/tools/flow-cli/transactions/get-system-transactions.md diff --git a/docs/build/tools/flow-cli/transactions/get-system-transactions.md b/docs/build/tools/flow-cli/transactions/get-system-transactions.md new file mode 100644 index 0000000000..759c82ce76 --- /dev/null +++ b/docs/build/tools/flow-cli/transactions/get-system-transactions.md @@ -0,0 +1,170 @@ +--- +title: Get a System Transaction +description: How to get a Flow system transaction from the command line +sidebar_position: 8 +--- + +The Flow CLI provides a command to fetch the system transaction for a given block reference. You can optionally provide a transaction ID to target a specific system transaction within that block. If scheduled callbacks ran in that block, their effects and fee events may appear in the result. + +```shell +flow transactions get-system [tx_id] +``` + +## Use cases + +- System chunk transaction for protocol operations: see [Epoch Scripts and Events](../../../protocol/staking/05-epoch-scripts-events.md) and [Staking rewards via system chunk](../../../protocol/staking/08-staking-rewards.md). +- Transactions related to scheduled callbacks: see [Introduction to Scheduled Callbacks](https://developers.flow.com/blockchain-development-tutorials/flow-actions/scheduled-callbacks-introduction). Consider `--include fee-events` for callback fee details. + +## Example Usage + +```shell +> flow transactions get-system latest --network mainnet + +Status ✅ SEALED +ID 40bc4b100c1930c61381c22e0f4c10a7f5827975ee25715527c1061b8d71e5aa +Payer — +Authorizers [] + +Proposal Key: — + +No Payload Signatures +No Envelope Signatures + +Events: + Index 0 + Type A.1654653399040a61.FlowToken.TokensDeposited + Tx ID 40bc4b100c1930c61381c22e0f4c10a7f5827975ee25715527c1061b8d71e5aa + Values + - amount (UFix64): 0.00100000 + - to ({}?): 5068e27f275c546c + +Code (hidden, use --include code) + +Payload (hidden, use --include payload) +``` + +Select a specific system transaction within the block by ID: + +```shell +> flow transactions get-system latest 07a8...b433 --network mainnet +``` + +## Arguments + +### Block Reference + +- Name: `` +- Valid Input: a block ID (hex), the keyword `latest`, or a block height (number). + +The first argument is a reference to the block whose system transaction you want to fetch. + +### Transaction ID (optional) + +- Name: `[tx_id]` +- Valid Input: a transaction ID (hex). + +Optionally narrow the result to a specific system transaction within the referenced block. + +## Flags + +### Include Fields + +- Flag: `--include` +- Valid inputs: `code`, `payload`, `signatures`, `fee-events` + +Specify fields to include in the result output. Applies only to the text output. + +### Exclude Fields + +- Flag: `--exclude` +- Valid inputs: `events` + +Specify fields to exclude from the result output. Applies only to the text output. + +### Host + +- Flag: `--host` +- Valid inputs: an IP address or host address. +- Default: `127.0.0.1:3569` (Flow Emulator) + +Specify the host address of the Access API that will be +used to execute the command. This flag overrides +any host defined by the `--network` flag. + +### Network Key + +- Flag: `--network-key` +- Valid inputs: A valid network public key of the host in hex string format + +Specify the network public key of the Access API that will be +used to create secure client connections when executing the command. + +### Network + +- Flag: `--network` +- Short Flag: `-n` +- Valid inputs: the name of a network defined in the configuration (`flow.json`) +- Default: `emulator` + +Specify which network you want the command to use for execution. + +### Filter + +- Flag: `--filter` +- Short Flag: `-x` +- Valid inputs: a case-sensitive name of the result property. + +Specify any property name from the result you want to return as the only value. + +### Output + +- Flag: `--output` +- Short Flag: `-o` +- Valid inputs: `json`, `inline` + +Specify the format of the command results. + +### Save + +- Flag: `--save` +- Short Flag: `-s` +- Valid inputs: a path in the current file system. + +Specify the filename where you want the result to be saved + +### Log + +- Flag: `--log` +- Short Flag: `-l` +- Valid inputs: `none`, `error`, `debug` +- Default: `info` + +Specify the log level. Control how much output you want to see during command execution. + +### Configuration + +- Flag: `--config-path` +- Short Flag: `-f` +- Valid inputs: a path in the current file system. +- Default: `flow.json` + +Specify the path to the `flow.json` configuration file. +You can use the `-f` flag multiple times to merge +several configuration files. + +### Version Check + +- Flag: `--skip-version-check` +- Default: `false` + +Skip version check during start up to speed up process for slow connections. + +## Notes + +System transactions currently cover: +- System chunk transactions used by protocol operations. See an overview of system chunks and service events: [Epoch Scripts and Events](../../../protocol/staking/05-epoch-scripts-events.md). +- Scheduled callbacks execution. Learn more: [Introduction to Scheduled Callbacks](https://developers.flow.com/blockchain-development-tutorials/flow-actions/scheduled-callbacks-introduction). + +More resources: +- [Staking rewards via system chunk](../../../protocol/staking/08-staking-rewards.md) +- [Epoch schedule and system chunk transactions](../../../protocol/staking/03-schedule.md) From 287da0a9480a5177492ab1df112e7736cedb00c4 Mon Sep 17 00:00:00 2001 From: Jordan Ribbink Date: Sun, 21 Sep 2025 09:39:04 -0700 Subject: [PATCH 2/8] fix announcement --- .../tools/flow-cli/transactions/get-system-transactions.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/build/tools/flow-cli/transactions/get-system-transactions.md b/docs/build/tools/flow-cli/transactions/get-system-transactions.md index 759c82ce76..185c4c6cee 100644 --- a/docs/build/tools/flow-cli/transactions/get-system-transactions.md +++ b/docs/build/tools/flow-cli/transactions/get-system-transactions.md @@ -4,12 +4,16 @@ description: How to get a Flow system transaction from the command line sidebar_position: 8 --- -The Flow CLI provides a command to fetch the system transaction for a given block reference. You can optionally provide a transaction ID to target a specific system transaction within that block. If scheduled callbacks ran in that block, their effects and fee events may appear in the result. +The Flow CLI provides a command to fetch the system transaction for a given block reference. You can optionally provide a transaction ID to target a specific system transaction within that block. ```shell flow transactions get-system [tx_id] ``` +::::warning +Querying with a system transaction ID (`[tx_id]`) is part of the Forte network upgrade and is currently available on Flow Emulator (CLI v2.7.0+) and the public test network. See the announcement for context: [Forte: Introducing Actions & Agents](https://flow.com/post/forte-introducing-actions-agents-supercharging-composability-and-automation). +:::: + ## Use cases - System chunk transaction for protocol operations: see [Epoch Scripts and Events](../../../protocol/staking/05-epoch-scripts-events.md) and [Staking rewards via system chunk](../../../protocol/staking/08-staking-rewards.md). From 16854df953acc3ce03534b2f4dee46354d3b746a Mon Sep 17 00:00:00 2001 From: Jordan Ribbink Date: Sun, 21 Sep 2025 09:41:53 -0700 Subject: [PATCH 3/8] change linking style --- .../transactions/get-system-transactions.md | 20 ++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/docs/build/tools/flow-cli/transactions/get-system-transactions.md b/docs/build/tools/flow-cli/transactions/get-system-transactions.md index 185c4c6cee..681b2e8b05 100644 --- a/docs/build/tools/flow-cli/transactions/get-system-transactions.md +++ b/docs/build/tools/flow-cli/transactions/get-system-transactions.md @@ -11,13 +11,13 @@ flow transactions get-system [tx_id] ``` ::::warning -Querying with a system transaction ID (`[tx_id]`) is part of the Forte network upgrade and is currently available on Flow Emulator (CLI v2.7.0+) and the public test network. See the announcement for context: [Forte: Introducing Actions & Agents](https://flow.com/post/forte-introducing-actions-agents-supercharging-composability-and-automation). +Querying with a system transaction ID (`[tx_id]`) is part of the Forte network upgrade and is currently available on Flow Emulator (CLI v2.7.0+) and `testnet`. See the announcement for context: [Forte: Introducing Actions & Agents][forte-ann]. :::: ## Use cases -- System chunk transaction for protocol operations: see [Epoch Scripts and Events](../../../protocol/staking/05-epoch-scripts-events.md) and [Staking rewards via system chunk](../../../protocol/staking/08-staking-rewards.md). -- Transactions related to scheduled callbacks: see [Introduction to Scheduled Callbacks](https://developers.flow.com/blockchain-development-tutorials/flow-actions/scheduled-callbacks-introduction). Consider `--include fee-events` for callback fee details. +- System chunk transaction for protocol operations: see [Epoch Scripts and Events][epoch-events] and [Staking rewards via system chunk][staking-rewards]. +- Transactions related to scheduled callbacks: see [Introduction to Scheduled Callbacks][scheduled-callbacks]. Consider `--include fee-events` for callback fee details. ## Example Usage @@ -166,9 +166,15 @@ Skip version check during start up to speed up process for slow connections. ## Notes System transactions currently cover: -- System chunk transactions used by protocol operations. See an overview of system chunks and service events: [Epoch Scripts and Events](../../../protocol/staking/05-epoch-scripts-events.md). -- Scheduled callbacks execution. Learn more: [Introduction to Scheduled Callbacks](https://developers.flow.com/blockchain-development-tutorials/flow-actions/scheduled-callbacks-introduction). +- System chunk transactions used by protocol operations. See an overview of system chunks and service events: [Epoch Scripts and Events][epoch-events]. +- Scheduled callbacks execution. Learn more: [Introduction to Scheduled Callbacks][scheduled-callbacks]. More resources: -- [Staking rewards via system chunk](../../../protocol/staking/08-staking-rewards.md) -- [Epoch schedule and system chunk transactions](../../../protocol/staking/03-schedule.md) +- [Staking rewards via system chunk][staking-rewards] +- [Epoch schedule and system chunk transactions][epoch-schedule] + +[forte-ann]: https://flow.com/post/forte-introducing-actions-agents-supercharging-composability-and-automation +[epoch-events]: ../../../protocol/staking/05-epoch-scripts-events.md +[staking-rewards]: ../../../protocol/staking/08-staking-rewards.md +[scheduled-callbacks]: https://developers.flow.com/blockchain-development-tutorials/flow-actions/scheduled-callbacks-introduction +[epoch-schedule]: ../../../protocol/staking/03-schedule.md From 4ea760ba164d34473dde4123f7d26b60e77d8b8b Mon Sep 17 00:00:00 2001 From: Jordan Ribbink Date: Sun, 21 Sep 2025 10:15:26 -0700 Subject: [PATCH 4/8] docs(flow-cli): document with usage, flags, scheduled callbacks context, Forte availability note, and reference links; fix link paths; build verified --- .../transactions/get-system-transactions.md | 26 +++++++++---------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/build/tools/flow-cli/transactions/get-system-transactions.md b/docs/build/tools/flow-cli/transactions/get-system-transactions.md index 681b2e8b05..5909f9d37a 100644 --- a/docs/build/tools/flow-cli/transactions/get-system-transactions.md +++ b/docs/build/tools/flow-cli/transactions/get-system-transactions.md @@ -11,13 +11,13 @@ flow transactions get-system [tx_id] ``` ::::warning -Querying with a system transaction ID (`[tx_id]`) is part of the Forte network upgrade and is currently available on Flow Emulator (CLI v2.7.0+) and `testnet`. See the announcement for context: [Forte: Introducing Actions & Agents][forte-ann]. +Querying with a system transaction ID (`[tx_id]`) is part of the Forte network upgrade and is currently available on Flow Emulator (CLI v2.7.0+) and `testnet`. See the announcement for context: [Forte: Introducing Actions & Agents]. :::: ## Use cases -- System chunk transaction for protocol operations: see [Epoch Scripts and Events][epoch-events] and [Staking rewards via system chunk][staking-rewards]. -- Transactions related to scheduled callbacks: see [Introduction to Scheduled Callbacks][scheduled-callbacks]. Consider `--include fee-events` for callback fee details. +- System chunk transaction for protocol operations: see [Epoch Scripts and Events] and [Staking rewards via system chunk]. +- Transactions related to scheduled callbacks: see [Introduction to Scheduled Callbacks]. Consider `--include fee-events` for callback fee details. ## Example Usage @@ -166,15 +166,15 @@ Skip version check during start up to speed up process for slow connections. ## Notes System transactions currently cover: -- System chunk transactions used by protocol operations. See an overview of system chunks and service events: [Epoch Scripts and Events][epoch-events]. -- Scheduled callbacks execution. Learn more: [Introduction to Scheduled Callbacks][scheduled-callbacks]. +- System chunk transactions used by protocol operations. See an overview of system chunks and service events: [Epoch Scripts and Events]. +- Scheduled callbacks execution. Learn more: [Introduction to Scheduled Callbacks]. More resources: -- [Staking rewards via system chunk][staking-rewards] -- [Epoch schedule and system chunk transactions][epoch-schedule] - -[forte-ann]: https://flow.com/post/forte-introducing-actions-agents-supercharging-composability-and-automation -[epoch-events]: ../../../protocol/staking/05-epoch-scripts-events.md -[staking-rewards]: ../../../protocol/staking/08-staking-rewards.md -[scheduled-callbacks]: https://developers.flow.com/blockchain-development-tutorials/flow-actions/scheduled-callbacks-introduction -[epoch-schedule]: ../../../protocol/staking/03-schedule.md +- [Staking rewards via system chunk] +- [Epoch schedule and system chunk transactions] + +[Forte: Introducing Actions & Agents]: https://flow.com/post/forte-introducing-actions-agents-supercharging-composability-and-automation +[Epoch Scripts and Events]: ../../../../protocol/staking/05-epoch-scripts-events.md +[Staking rewards via system chunk]: ../../../../protocol/staking/08-staking-rewards.md +[Introduction to Scheduled Callbacks]: https://developers.flow.com/blockchain-development-tutorials/flow-actions/scheduled-callbacks-introduction +[Epoch schedule and system chunk transactions]: ../../../../protocol/staking/03-schedule.md From 61492a41e3f832a08945b8b705285468985cf425 Mon Sep 17 00:00:00 2001 From: Jordan Ribbink Date: Sun, 21 Sep 2025 10:17:49 -0700 Subject: [PATCH 5/8] docs(flow-cli): update get-system docs to link Flow Testnet and use reference-style links; fix relative paths; build passes --- .../tools/flow-cli/transactions/get-system-transactions.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/build/tools/flow-cli/transactions/get-system-transactions.md b/docs/build/tools/flow-cli/transactions/get-system-transactions.md index 5909f9d37a..77b93adc4a 100644 --- a/docs/build/tools/flow-cli/transactions/get-system-transactions.md +++ b/docs/build/tools/flow-cli/transactions/get-system-transactions.md @@ -11,7 +11,7 @@ flow transactions get-system [tx_id] ``` ::::warning -Querying with a system transaction ID (`[tx_id]`) is part of the Forte network upgrade and is currently available on Flow Emulator (CLI v2.7.0+) and `testnet`. See the announcement for context: [Forte: Introducing Actions & Agents]. +Querying with a system transaction ID (`[tx_id]`) is part of the Forte network upgrade and is currently available on Flow Emulator (CLI v2.7.0+) and [Flow Testnet]. See the announcement for context: [Forte: Introducing Actions & Agents]. :::: ## Use cases @@ -174,6 +174,7 @@ More resources: - [Epoch schedule and system chunk transactions] [Forte: Introducing Actions & Agents]: https://flow.com/post/forte-introducing-actions-agents-supercharging-composability-and-automation +[Flow Testnet]: ../../../../protocol/flow-networks/accessing-testnet.md [Epoch Scripts and Events]: ../../../../protocol/staking/05-epoch-scripts-events.md [Staking rewards via system chunk]: ../../../../protocol/staking/08-staking-rewards.md [Introduction to Scheduled Callbacks]: https://developers.flow.com/blockchain-development-tutorials/flow-actions/scheduled-callbacks-introduction From 5c4ba9fa26c36b5a70e31b4945c1f218ced0ad18 Mon Sep 17 00:00:00 2001 From: Brian Doyle Date: Mon, 22 Sep 2025 09:23:48 -0400 Subject: [PATCH 6/8] Update docs/build/tools/flow-cli/transactions/get-system-transactions.md --- .../tools/flow-cli/transactions/get-system-transactions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build/tools/flow-cli/transactions/get-system-transactions.md b/docs/build/tools/flow-cli/transactions/get-system-transactions.md index 77b93adc4a..4571205fd5 100644 --- a/docs/build/tools/flow-cli/transactions/get-system-transactions.md +++ b/docs/build/tools/flow-cli/transactions/get-system-transactions.md @@ -14,7 +14,7 @@ flow transactions get-system [tx_id] Querying with a system transaction ID (`[tx_id]`) is part of the Forte network upgrade and is currently available on Flow Emulator (CLI v2.7.0+) and [Flow Testnet]. See the announcement for context: [Forte: Introducing Actions & Agents]. :::: -## Use cases +## Use Cases - System chunk transaction for protocol operations: see [Epoch Scripts and Events] and [Staking rewards via system chunk]. - Transactions related to scheduled callbacks: see [Introduction to Scheduled Callbacks]. Consider `--include fee-events` for callback fee details. From ef3c19823b5234bed2f86223f4e6ce4a6a056ee4 Mon Sep 17 00:00:00 2001 From: Brian Doyle Date: Mon, 22 Sep 2025 09:26:27 -0400 Subject: [PATCH 7/8] Update docs/build/tools/flow-cli/transactions/get-system-transactions.md --- .../tools/flow-cli/transactions/get-system-transactions.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/build/tools/flow-cli/transactions/get-system-transactions.md b/docs/build/tools/flow-cli/transactions/get-system-transactions.md index 4571205fd5..a373c14ffd 100644 --- a/docs/build/tools/flow-cli/transactions/get-system-transactions.md +++ b/docs/build/tools/flow-cli/transactions/get-system-transactions.md @@ -11,7 +11,9 @@ flow transactions get-system [tx_id] ``` ::::warning + Querying with a system transaction ID (`[tx_id]`) is part of the Forte network upgrade and is currently available on Flow Emulator (CLI v2.7.0+) and [Flow Testnet]. See the announcement for context: [Forte: Introducing Actions & Agents]. + :::: ## Use Cases From bec2f8e2bdfc31487ed07040186dc446755c6575 Mon Sep 17 00:00:00 2001 From: Jordan Ribbink Date: Mon, 22 Sep 2025 06:42:16 -0700 Subject: [PATCH 8/8] Add keywords to doc --- .../transactions/get-system-transactions.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/build/tools/flow-cli/transactions/get-system-transactions.md b/docs/build/tools/flow-cli/transactions/get-system-transactions.md index a373c14ffd..e1483a0a0e 100644 --- a/docs/build/tools/flow-cli/transactions/get-system-transactions.md +++ b/docs/build/tools/flow-cli/transactions/get-system-transactions.md @@ -2,6 +2,20 @@ title: Get a System Transaction description: How to get a Flow system transaction from the command line sidebar_position: 8 +keywords: + - flow cli + - transactions + - system transaction + - system chunk + - scheduled callbacks + - forte upgrade + - blocks + - block id + - tx_id + - fee-events + - access api + - emulator + - testnet --- The Flow CLI provides a command to fetch the system transaction for a given block reference. You can optionally provide a transaction ID to target a specific system transaction within that block.