refactor(iota-transactional-test-runner): document run-graphql synt…

…ax (#4699)

* feat: document run graphql syntax

* feat: Describe interpolation rules

* feat: Use a better representing example

* refactor: Add description to the provided example

* refactor: Better describe syntax rule for --cursors

* refactor: Expand on cursor syntax

* refactor: Expand on cursor syntax

* refactor: Add object cursor example

* refactor: Remove part of file path

* refactor: Clarify x for FakeId (x, y)

* refactor: Fix typo

crates/iota-transactional-test-runner/syntax.md

@@ -6,11 +6,11 @@ This currently used in the following tests:
 
 ```
 $ cargo tree -i iota-transactional-test-runner
-iota-transactional-test-runner v0.1.0 (/home/kodemartin/projects/kinesis/crates/iota-transactional-test-runner)
+iota-transactional-test-runner v0.1.0 (crates/iota-transactional-test-runner)
 [dev-dependencies]
-├── iota-adapter-transactional-tests v0.1.0 (/home/kodemartin/projects/kinesis/crates/iota-adapter-transactional-tests)
-├── iota-graphql-e2e-tests v0.1.0 (/home/kodemartin/projects/kinesis/crates/iota-graphql-e2e-tests)
-└── iota-verifier-transactional-tests v0.1.0 (/home/kodemartin/projects/kinesis/crates/iota-verifier-transactional-tests)
+├── iota-adapter-transactional-tests v0.1.0 (crates/iota-adapter-transactional-tests)
+├── iota-graphql-e2e-tests v0.1.0 (crates/iota-graphql-e2e-tests)
+└── iota-verifier-transactional-tests v0.1.0 (crates/iota-verifier-transactional-tests)
 ```
 
 ## Common rules
@@ -71,6 +71,95 @@ in the respective sections.
 
 ### `run-graphql`
 
+Allows to execute GraphQL queries with optional options and returns the output.
+
+#### Syntax:
+
+```
+//# run-graphql [OPTIONS]
+<GraphQL-query>
+```
+
+#### Options:
+
+```
+--show-usage: Displays usage information for the command.
+--show-headers: Includes HTTP headers in the output.
+--show-service-version: Displays the version of the service handling the GraphQL query.
+--cursors <cursor-list>: Specifies a list of cursors to be used within the query.
+```
+
+#### Query Interpolation
+
+The command supports **query interpolation**, allowing you to dynamically replace parts of the GraphQL query at runtime.
+It supports the following placeholders:
+
+1. **Object Placeholders**
+   - **Syntax**: `@{obj_x_y}` or `@{obj_x_y_opt}`
+   - Here, `(x, y)` corresponds to the task index and the creation index of the object within that task. The placeholder will be replaced with the object ID as a string (like `0xABCD...`).
+
+2. **Named Address Placeholders**
+   - **Syntax**: `@{NamedAddr}` or `@{NamedAddr_opt}`
+   - Substitutes known accounts and addresses that have been created during the initialization step, e.g. `init --protocol-version 1 --addresses P0=0x0 --accounts A B --simulator`
+
+3. **Cursors**
+   - **Syntax**: `//# run-graphql --cursors string1 string2 ...`
+     - Depending on the query, the raw strings passed to `--cursors` might be required in JSON, BCS or any other format that the query expects.
+     - Each string passed is automatically Base64-encoded (as all cursor values are expected to be Base64-encoded) and can be accessed in the query as `@{cursor_0}`, `@{cursor_1}`, etc., in the order provided.
+     - To generate cursor values from objects at runtime, the strings passed must correspond to the format `@{obj_x_y}` or `@{obj_x_y, checkpoint}` and are translated to Base64-encoded object cursors.
+
+All of the above rules (object placeholders, named address placeholders, cursor strings) can be used in a single query.
+Any placeholder or cursor that cannot be mapped to a known variable, object, or address will cause an error.
+
+#### Examples
+
+The following example query will replace the placeholder `@{cursor_0}` with the Base64-encoded [transaction block cursor](../../crates/iota-graphql-rpc/src/types/transaction_block.rs) `{"c":3,"t":1,"tc":1}` where `c` is the checkpoint sequence number, `t` is the transaction sequence number, and `tc` is the transaction checkpoint number.
+Cursor values depend on the query and the underlying schema. The cursor value above is specific to the GraphQL `transactionBlocks` query.
+`@{A}` and `@{P0}` will be replaced with the addresses `A` and `P0` respectively that were created during the initialization step.
+
+```
+//# run-graphql --cursors {"c":3,"t":1,"tc":1}
+{
+  transactionBlocks(first: 1, after: "@{cursor_0}", filter: {signAddress: "@{A}"}) {
+    nodes {
+      sender {
+        fakeCoinBalance: balance(type: "@{P0}::fake::FAKE") {
+          totalBalance
+        }
+        allBalances: balances {
+          nodes {
+            coinType {
+              repr
+            }
+            coinObjectCount
+            totalBalance
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+An example of a query that generates an object cursor at runtime:
+
+```
+//# run-graphql --cursors @{obj_6_0}
+{
+  address(address: "@{A}") {
+    objects(first: 2 after: "@{cursor_0}") {
+      edges {
+        node {
+          contents {
+            json
+          }
+        }
+      }
+    }
+  }
+}
+```
+
 ### `force-object-snapshot-catchup`
 
 ### `bench`