execution-apis/src/txpool/pool.yaml at abcfa477c21a5da0c59879fcd5949ea7c8c5b6ad · bomanaps/execution-apis · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
- name: txpool_status
  summary: Returns the number of pending and queued transactions in the pool.
  description: |
    Returns an object containing the count of transactions currently pending for
    inclusion in the next block(s), as well as ones that are scheduled for future
    execution (transactions with nonce gaps).
  params: []
  result:
    name: Transaction pool status
    schema:
      $ref: '#/components/schemas/TxpoolStatus'
  examples:
    - name: txpool_status example
      params: []
      result:
        name: Transaction pool status
        value:
          pending: '0xa'
          queued: '0x7'

- name: txpool_content
  summary: Returns the contents of the transaction pool.
  description: |
    Returns an object containing all pending and queued transactions in the pool,
    grouped by origin address and sorted by nonce. Pending transactions are ready
    for inclusion in the next block(s). Queued transactions have nonce gaps and
    are scheduled for future execution.
  params: []
  result:
    name: Transaction pool content
    schema:
      $ref: '#/components/schemas/TxpoolContent'
  examples:
    - name: txpool_content example
      params: []
      result:
        name: Transaction pool content
        value:
          pending:
            '0x0216d5032f356960cd3749c31ab34eeff21b3395':
              '806':
                blockHash: null
                blockNumber: null
                from: '0x0216d5032f356960cd3749c31ab34eeff21b3395'
                gas: '0x5208'
                gasPrice: '0xba43b7400'
                hash: '0xaf953a2d01f55cfe080c0c94150a60105e8ac3d51153058a1f03dd239dd08586'
                input: '0x'
                nonce: '0x326'
                to: '0x7f69a91a3cf4be60020fb58b893b7cbb65376db8'
                transactionIndex: null
                value: '0x19a99f0cf456000'
          queued:
            '0x0216d5032f356960cd3749c31ab34eeff21b3395':
              '808':
                blockHash: null
                blockNumber: null
                from: '0x0216d5032f356960cd3749c31ab34eeff21b3395'
                gas: '0x5208'
                gasPrice: '0xba43b7400'
                hash: '0x593f723c6f7abc7878c4927d2f1a0e6c5a6c0b4c9f5a7b2e3d4c5f6a7b8c9d0e'
                input: '0x'
                nonce: '0x328'
                to: '0x7f69a91a3cf4be60020fb58b893b7cbb65376db8'
                transactionIndex: null
                value: '0x19a99f0cf456000'

- name: txpool_contentFrom
  summary: Returns the transactions in the pool from a specific address.
  description: |
    Returns an object containing pending and queued transactions from the specified
    address, grouped by nonce. This is a filtered version of txpool_content.
  params:
    - name: address
      required: true
      schema:
        $ref: '#/components/schemas/address'
  result:
    name: Transaction pool content from address
    schema:
      $ref: '#/components/schemas/TxpoolContentFromResult'
  examples:
    - name: txpool_contentFrom example
      params:
        - name: address
          value: '0x0216d5032f356960cd3749c31ab34eeff21b3395'
      result:
        name: Transaction pool content from address
        value:
          pending:
            '806':
              blockHash: null
              blockNumber: null
              from: '0x0216d5032f356960cd3749c31ab34eeff21b3395'
              gas: '0x5208'
              gasPrice: '0xba43b7400'
              hash: '0xaf953a2d01f55cfe080c0c94150a60105e8ac3d51153058a1f03dd239dd08586'
              input: '0x'
              nonce: '0x326'
              to: '0x7f69a91a3cf4be60020fb58b893b7cbb65376db8'
              transactionIndex: null
              value: '0x19a99f0cf456000'
          queued: {}

- name: txpool_inspect
  summary: Returns a textual summary of all transactions in the pool.
  description: |
    Returns an object containing a textual summary of all pending and queued
    transactions in the pool, grouped by origin address and sorted by nonce.
    This is useful for quick inspection without full transaction details.

    Note: The response structure (nested maps of address to nonce to string) is
    standardized, but the string content format is informational and may vary
    between implementations. This method is intended for human-readable debugging
    output rather than programmatic parsing.
  params: []
  result:
    name: Transaction pool inspection
    schema:
      $ref: '#/components/schemas/TxpoolInspect'
  examples:
    - name: txpool_inspect example
      params: []
      result:
        name: Transaction pool inspection
        value:
          pending:
            '0x0216d5032f356960cd3749c31ab34eeff21b3395':
              '806': '0x7f69a91a3cf4be60020fb58b893b7cbb65376db8: 115000000000000000 wei + 21000 gas × 50000000000 wei'
          queued:
            '0x0216d5032f356960cd3749c31ab34eeff21b3395':
              '808': '0x7f69a91a3cf4be60020fb58b893b7cbb65376db8: 115000000000000000 wei + 21000 gas × 50000000000 wei'