Changes the order of pages in the docs

TrueBlocks · Sep 27, 2023 · 2cc1d4b · 2cc1d4b
1 parent 4653bd0
commit 2cc1d4b
Show file tree

Hide file tree

Showing 17 changed files with 146 additions and 146 deletions.
diff --git a/docs/content/api/openapi.yaml b/docs/content/api/openapi.yaml
@@ -1109,16 +1109,16 @@ paths:
               schema:
                 properties:
                   data:
-                    description: Produces <a href="/data-model/accounts/#appearance">Appearance</a>, <a href="/data-model/chaindata/#block">Block</a>, <a href="/data-model/chaindata/#withdrawal">Withdrawal</a>, <a href="/data-model/chaindata/#log">Log</a>, <a href="/data-model/chaindata/#logfilter">Logfilter</a>, <a href="/data-model/chaindata/#trace">Trace</a>, <a href="/data-model/chaindata/#traceaction">Traceaction</a>, <a href="/data-model/chaindata/#traceresult">Traceresult</a>, and/or <a href="/data-model/chaindata/#blockcount">Blockcount</a> data. Corresponds to the <a href="/chifra/chaindata/#chifra-blocks">chifra blocks</a> command line.
+                    description: Produces <a href="/data-model/accounts/#appearance">Appearance</a>, <a href="/data-model/chaindata/#block">Block</a>, <a href="/data-model/chaindata/#withdrawal">Withdrawal</a>, <a href="/data-model/chaindata/#log">Log</a>, <a href="/data-model/chaindata/#trace">Trace</a>, <a href="/data-model/chaindata/#logfilter">Logfilter</a>, <a href="/data-model/chaindata/#traceaction">Traceaction</a>, <a href="/data-model/chaindata/#traceresult">Traceresult</a>, and/or <a href="/data-model/chaindata/#blockcount">Blockcount</a> data. Corresponds to the <a href="/chifra/chaindata/#chifra-blocks">chifra blocks</a> command line.
                     type: array
                     items:
                       oneOf:
                         - $ref: "#/components/schemas/appearance"
                         - $ref: "#/components/schemas/block"
                         - $ref: "#/components/schemas/withdrawal"
                         - $ref: "#/components/schemas/log"
-                        - $ref: "#/components/schemas/logFilter"
                         - $ref: "#/components/schemas/trace"
+                        - $ref: "#/components/schemas/logFilter"
                         - $ref: "#/components/schemas/traceAction"
                         - $ref: "#/components/schemas/traceResult"
                         - $ref: "#/components/schemas/blockCount"
@@ -2952,6 +2952,26 @@ components:
         encoding:
           type: string
           description: "the four-byte encoding of the transaction's function call"
+    withdrawal:
+      description: "withdrawal record for post-Shanghai withdrawals from the consensus layer"
+      type: object
+      properties:
+        address:
+          type: string
+          format: address
+          description: "the recipient for the withdrawn ether"
+        amount:
+          type: string
+          format: wei
+          description: "a nonzero amount of ether given in gwei (1e9 wei)"
+        index:
+          type: number
+          format: uint64
+          description: "a monotonically increasing zero-based index that increments by 1 per withdrawal to uniquely identify each withdrawal"
+        validatorIndex:
+          type: number
+          format: uint64
+          description: "the validator_index of the validator on the consensus layer the withdrawal corresponds to"
     receipt:
       description: "receipt data as returned from the RPC (with slight enhancements)"
       type: object
@@ -2987,26 +3007,6 @@ components:
         transactionIndex:
           type: number
           format: blknum
-    withdrawal:
-      description: "withdrawal record for post-Shanghai withdrawals from the consensus layer"
-      type: object
-      properties:
-        address:
-          type: string
-          format: address
-          description: "the recipient for the withdrawn ether"
-        amount:
-          type: string
-          format: wei
-          description: "a nonzero amount of ether given in gwei (1e9 wei)"
-        index:
-          type: number
-          format: uint64
-          description: "a monotonically increasing zero-based index that increments by 1 per withdrawal to uniquely identify each withdrawal"
-        validatorIndex:
-          type: number
-          format: uint64
-          description: "the validator_index of the validator on the consensus layer the withdrawal corresponds to"
     log:
       description: "log data as returned from the RPC (with slight enhancements)"
       type: object
@@ -3066,32 +3066,6 @@ components:
           type: string
           example: "Transfer(0xcfa...9f54..."
           description: "a truncated, more readable version of the articulation"
-    logFilter:
-      description: "used by the fast path log queries for various commands"
-      type: object
-      properties:
-        fromBlock:
-          type: number
-          format: blknum
-          description: "the first block in the block range to query with eth_getLogs"
-        toBlock:
-          type: number
-          format: blknum
-          description: "the last block in the range to query with eth_getLogs"
-        blockHash:
-          type: string
-          format: hash
-          description: "an alternative to blocks specification, the hash of the block to query"
-        emitters:
-          type: array
-          items:
-            $ref: "#/components/schemas/address"
-          description: "one or more emitting addresses from which logs were emitted"
-        topics:
-          type: array
-          items:
-            $ref: "#/components/schemas/topic"
-          description: "one or more topics which logs represent"
     trace:
       description: "trace data as returned from the RPC (with slight enhancements)"
       type: object
@@ -3153,6 +3127,32 @@ components:
         compressedTrace:
           type: string
           description: "a compressed string version of the articulated trace"
+    logFilter:
+      description: "used by the fast path log queries for various commands"
+      type: object
+      properties:
+        fromBlock:
+          type: number
+          format: blknum
+          description: "the first block in the block range to query with eth_getLogs"
+        toBlock:
+          type: number
+          format: blknum
+          description: "the last block in the range to query with eth_getLogs"
+        blockHash:
+          type: string
+          format: hash
+          description: "an alternative to blocks specification, the hash of the block to query"
+        emitters:
+          type: array
+          items:
+            $ref: "#/components/schemas/address"
+          description: "one or more emitting addresses from which logs were emitted"
+        topics:
+          type: array
+          items:
+            $ref: "#/components/schemas/topic"
+          description: "one or more topics which logs represent"
     traceAction:
       description: "trace action data as returned from the RPC (with slight enhancements)"
       type: object

diff --git a/docs/content/chifra/chaindata.md b/docs/content/chifra/chaindata.md
@@ -82,8 +82,8 @@ Data models produced by this tool:
 - [block](/data-model/chaindata/#block)
 - [withdrawal](/data-model/chaindata/#withdrawal)
 - [log](/data-model/chaindata/#log)
-- [logfilter](/data-model/chaindata/#logfilter)
 - [trace](/data-model/chaindata/#trace)
+- [logfilter](/data-model/chaindata/#logfilter)
 - [traceaction](/data-model/chaindata/#traceaction)
 - [traceresult](/data-model/chaindata/#traceresult)
 - [blockcount](/data-model/chaindata/#blockcount)

diff --git a/docs/content/data-model/chaindata.md b/docs/content/data-model/chaindata.md
@@ -122,6 +122,24 @@ Transfers consist of the following fields:
 | priceSource      | the on-chain source from which the spot price was taken                                        | string    |
 | encoding         | the four-byte encoding of the transaction's function call                                      | string    |
 
+## Withdrawal
+
+<!-- markdownlint-disable MD033 MD036 MD041 -->
+`withdrawals` is an array present in post-Shanghai blocks representing Consensys layer staking reward withdrawals. Note that the amount present is in Gwei. The `withdrawals` array is not present in pre-Shanghai blocks.
+
+The following commands produce and manage Withdrawals:
+
+- [chifra blocks](/chifra/chaindata/#chifra-blocks)
+
+Withdrawals consist of the following fields:
+
+| Field          | Description                                                                                                          | Type    |
+| -------------- | -------------------------------------------------------------------------------------------------------------------- | ------- |
+| address        | the recipient for the withdrawn ether                                                                                | address |
+| amount         | a nonzero amount of ether given in gwei (1e9 wei)                                                                    | wei     |
+| index          | a monotonically increasing zero-based index that increments by 1 per withdrawal to uniquely identify each withdrawal | uint64  |
+| validatorIndex | the validator_index of the validator on the consensus layer the withdrawal corresponds to                            | uint64  |
+
 ## Receipt
 
 <!-- markdownlint-disable MD033 MD036 MD041 -->
@@ -151,24 +169,6 @@ Receipts consist of the following fields:
 | transactionHash  |                                                                            | hash                                |
 | transactionIndex |                                                                            | blknum                              |
 
-## Withdrawal
-
-<!-- markdownlint-disable MD033 MD036 MD041 -->
-`withdrawals` is an array present in post-Shanghai blocks representing Consensys layer staking reward withdrawals. Note that the amount present is in Gwei. The `withdrawals` array is not present in pre-Shanghai blocks.
-
-The following commands produce and manage Withdrawals:
-
-- [chifra blocks](/chifra/chaindata/#chifra-blocks)
-
-Withdrawals consist of the following fields:
-
-| Field          | Description                                                                                                          | Type    |
-| -------------- | -------------------------------------------------------------------------------------------------------------------- | ------- |
-| address        | the recipient for the withdrawn ether                                                                                | address |
-| amount         | a nonzero amount of ether given in gwei (1e9 wei)                                                                    | wei     |
-| index          | a monotonically increasing zero-based index that increments by 1 per withdrawal to uniquely identify each withdrawal | uint64  |
-| validatorIndex | the validator_index of the validator on the consensus layer the withdrawal corresponds to                            | uint64  |
-
 ## Log
 
 <!-- markdownlint-disable MD033 MD036 MD041 -->
@@ -200,26 +200,6 @@ Logs consist of the following fields:
 | articulatedLog   | a human-readable version of the topic and data fields                                             | [Function](/data-model/other/#function) |
 | compressedLog    | a truncated, more readable version of the articulation                                            | string                                  |
 
-## LogFilter
-
-<!-- markdownlint-disable MD033 MD036 MD041 -->
-Log filters are used to speed up querying of the node when searching for logs.
-
-The following commands produce and manage LogFilters:
-
-- [chifra blocks](/chifra/chaindata/#chifra-blocks)
-- [chifra logs](/chifra/chaindata/#chifra-logs)
-
-LogFilters consist of the following fields:
-
-| Field     | Description                                                            | Type          |
-| --------- | ---------------------------------------------------------------------- | ------------- |
-| fromBlock | the first block in the block range to query with eth_getLogs           | blknum        |
-| toBlock   | the last block in the range to query with eth_getLogs                  | blknum        |
-| blockHash | an alternative to blocks specification, the hash of the block to query | hash          |
-| emitters  | one or more emitting addresses from which logs were emitted            | Address       |
-| topics    | one or more topics which logs represent                                | topic[]       |
-
 ## Trace
 
 <!-- markdownlint-disable MD033 MD036 MD041 -->
@@ -272,6 +252,26 @@ Fields that change during self-destruct transaction:
 |               | Action.RefundAddress  |                          |
 |               | Action.Balance        |                          |
 
+## LogFilter
+
+<!-- markdownlint-disable MD033 MD036 MD041 -->
+Log filters are used to speed up querying of the node when searching for logs.
+
+The following commands produce and manage LogFilters:
+
+- [chifra blocks](/chifra/chaindata/#chifra-blocks)
+- [chifra logs](/chifra/chaindata/#chifra-logs)
+
+LogFilters consist of the following fields:
+
+| Field     | Description                                                            | Type          |
+| --------- | ---------------------------------------------------------------------- | ------------- |
+| fromBlock | the first block in the block range to query with eth_getLogs           | blknum        |
+| toBlock   | the last block in the range to query with eth_getLogs                  | blknum        |
+| blockHash | an alternative to blocks specification, the hash of the block to query | hash          |
+| emitters  | one or more emitting addresses from which logs were emitted            | Address       |
+| topics    | one or more topics which logs represent                                | topic[]       |
+
 ## TraceAction
 
 <!-- markdownlint-disable MD033 MD036 MD041 -->

diff --git a/docs/readmes/chaindata-blocks.md b/docs/readmes/chaindata-blocks.md
@@ -59,8 +59,8 @@ Data models produced by this tool:
 - [block](/data-model/chaindata/#block)
 - [withdrawal](/data-model/chaindata/#withdrawal)
 - [log](/data-model/chaindata/#log)
-- [logfilter](/data-model/chaindata/#logfilter)
 - [trace](/data-model/chaindata/#trace)
+- [logfilter](/data-model/chaindata/#logfilter)
 - [traceaction](/data-model/chaindata/#traceaction)
 - [traceresult](/data-model/chaindata/#traceresult)
 - [blockcount](/data-model/chaindata/#blockcount)

diff --git a/docs/templates/api/components.txt b/docs/templates/api/components.txt
@@ -580,6 +580,26 @@ components:
         encoding:
           type: string
           description: "the four-byte encoding of the transaction's function call"
+    withdrawal:
+      description: "withdrawal record for post-Shanghai withdrawals from the consensus layer"
+      type: object
+      properties:
+        address:
+          type: string
+          format: address
+          description: "the recipient for the withdrawn ether"
+        amount:
+          type: string
+          format: wei
+          description: "a nonzero amount of ether given in gwei (1e9 wei)"
+        index:
+          type: number
+          format: uint64
+          description: "a monotonically increasing zero-based index that increments by 1 per withdrawal to uniquely identify each withdrawal"
+        validatorIndex:
+          type: number
+          format: uint64
+          description: "the validator_index of the validator on the consensus layer the withdrawal corresponds to"
     receipt:
       description: "receipt data as returned from the RPC (with slight enhancements)"
       type: object
@@ -615,26 +635,6 @@ components:
         transactionIndex:
           type: number
           format: blknum
-    withdrawal:
-      description: "withdrawal record for post-Shanghai withdrawals from the consensus layer"
-      type: object
-      properties:
-        address:
-          type: string
-          format: address
-          description: "the recipient for the withdrawn ether"
-        amount:
-          type: string
-          format: wei
-          description: "a nonzero amount of ether given in gwei (1e9 wei)"
-        index:
-          type: number
-          format: uint64
-          description: "a monotonically increasing zero-based index that increments by 1 per withdrawal to uniquely identify each withdrawal"
-        validatorIndex:
-          type: number
-          format: uint64
-          description: "the validator_index of the validator on the consensus layer the withdrawal corresponds to"
     log:
       description: "log data as returned from the RPC (with slight enhancements)"
       type: object
@@ -694,32 +694,6 @@ components:
           type: string
           example: "Transfer(0xcfa...9f54..."
           description: "a truncated, more readable version of the articulation"
-    logFilter:
-      description: "used by the fast path log queries for various commands"
-      type: object
-      properties:
-        fromBlock:
-          type: number
-          format: blknum
-          description: "the first block in the block range to query with eth_getLogs"
-        toBlock:
-          type: number
-          format: blknum
-          description: "the last block in the range to query with eth_getLogs"
-        blockHash:
-          type: string
-          format: hash
-          description: "an alternative to blocks specification, the hash of the block to query"
-        emitters:
-          type: array
-          items:
-            $ref: "#/components/schemas/address"
-          description: "one or more emitting addresses from which logs were emitted"
-        topics:
-          type: array
-          items:
-            $ref: "#/components/schemas/topic"
-          description: "one or more topics which logs represent"
     trace:
       description: "trace data as returned from the RPC (with slight enhancements)"
       type: object
@@ -781,6 +755,32 @@ components:
         compressedTrace:
           type: string
           description: "a compressed string version of the articulated trace"
+    logFilter:
+      description: "used by the fast path log queries for various commands"
+      type: object
+      properties:
+        fromBlock:
+          type: number
+          format: blknum
+          description: "the first block in the block range to query with eth_getLogs"
+        toBlock:
+          type: number
+          format: blknum
+          description: "the last block in the range to query with eth_getLogs"
+        blockHash:
+          type: string
+          format: hash
+          description: "an alternative to blocks specification, the hash of the block to query"
+        emitters:
+          type: array
+          items:
+            $ref: "#/components/schemas/address"
+          description: "one or more emitting addresses from which logs were emitted"
+        topics:
+          type: array
+          items:
+            $ref: "#/components/schemas/topic"
+          description: "one or more topics which logs represent"
     traceAction:
       description: "trace action data as returned from the RPC (with slight enhancements)"
       type: object

diff --git a/src/apps/chifra/internal/blocks/README.md b/src/apps/chifra/internal/blocks/README.md
@@ -59,8 +59,8 @@ Data models produced by this tool:
 - [block](/data-model/chaindata/#block)
 - [withdrawal](/data-model/chaindata/#withdrawal)
 - [log](/data-model/chaindata/#log)
-- [logfilter](/data-model/chaindata/#logfilter)
 - [trace](/data-model/chaindata/#trace)
+- [logfilter](/data-model/chaindata/#logfilter)
 - [traceaction](/data-model/chaindata/#traceaction)
 - [traceresult](/data-model/chaindata/#traceresult)
 - [blockcount](/data-model/chaindata/#blockcount)