Modules: txpool

txpool_content

Content returns the transactions contained within the transaction pool.

Params (0)

None

Result

mapstringmapstringmapstringRPCTransaction map[string]map[string]map[string]*RPCTransaction

• Required: ✓ Yes

=== "Schema"

``` Schema

- patternProperties: 
	- .*: 
		- patternProperties: 
			- .*: 
				- patternProperties: 
					- .*: 
						- additionalProperties: `false`
						- properties: 
							- accessList: 
								- items: 
									- additionalProperties: `false`
									- properties: 
										- address: 
											- pattern: `^0x[a-fA-F\d]{64}$`
											- title: `keccak`
											- type: `string`

										- storageKeys: 
											- items: 
												- description: `Hex representation of a Keccak 256 hash`
												- pattern: `^0x[a-fA-F\d]{64}$`
												- title: `keccak`
												- type: `string`

											- type: `array`


									- type: `object`

								- type: `array`

							- blockHash: 
								- pattern: `^0x[a-fA-F\d]{64}$`
								- title: `keccak`
								- type: `string`

							- blockNumber: 
								- pattern: `^0x[a-fA-F0-9]+$`
								- title: `integer`
								- type: `string`

							- chainId: 
								- pattern: `^0x[a-fA-F0-9]+$`
								- title: `integer`
								- type: `string`

							- from: 
								- pattern: `^0x[a-fA-F\d]{64}$`
								- title: `keccak`
								- type: `string`

							- gas: 
								- pattern: `^0x([a-fA-F\d])+$`
								- title: `uint64`
								- type: `string`

							- gasPrice: 
								- pattern: `^0x[a-fA-F0-9]+$`
								- title: `integer`
								- type: `string`

							- hash: 
								- pattern: `^0x[a-fA-F\d]{64}$`
								- title: `keccak`
								- type: `string`

							- input: 
								- pattern: `^0x([a-fA-F\d])+$`
								- title: `dataWord`
								- type: `string`

							- maxFeePerGas: 
								- pattern: `^0x[a-fA-F0-9]+$`
								- title: `integer`
								- type: `string`

							- maxPriorityFeePerGas: 
								- pattern: `^0x[a-fA-F0-9]+$`
								- title: `integer`
								- type: `string`

							- nonce: 
								- pattern: `^0x([a-fA-F\d])+$`
								- title: `uint64`
								- type: `string`

							- r: 
								- pattern: `^0x[a-fA-F0-9]+$`
								- title: `integer`
								- type: `string`

							- s: 
								- pattern: `^0x[a-fA-F0-9]+$`
								- title: `integer`
								- type: `string`

							- to: 
								- pattern: `^0x[a-fA-F\d]{64}$`
								- title: `keccak`
								- type: `string`

							- transactionIndex: 
								- pattern: `^0x([a-fA-F\d])+$`
								- title: `uint64`
								- type: `string`

							- type: 
								- pattern: `^0x([a-fA-F\d])+$`
								- title: `uint64`
								- type: `string`

							- v: 
								- pattern: `^0x[a-fA-F0-9]+$`
								- title: `integer`
								- type: `string`

							- value: 
								- pattern: `^0x[a-fA-F0-9]+$`
								- title: `integer`
								- type: `string`

							- yParity: 
								- pattern: `^0x([a-fA-F\d])+$`
								- title: `uint64`
								- type: `string`


						- type: `object`


				- type: `object`


		- type: `object`


- type: object


```

=== "Raw"

``` Raw
{
    "patternProperties": {
        ".*": {
            "patternProperties": {
                ".*": {
                    "patternProperties": {
                        ".*": {
                            "additionalProperties": false,
                            "properties": {
                                "accessList": {
                                    "items": {
                                        "additionalProperties": false,
                                        "properties": {
                                            "address": {
                                                "pattern": "^0x[a-fA-F\\d]{64}$",
                                                "title": "keccak",
                                                "type": "string"
                                            },
                                            "storageKeys": {
                                                "items": {
                                                    "description": "Hex representation of a Keccak 256 hash",
                                                    "pattern": "^0x[a-fA-F\\d]{64}$",
                                                    "title": "keccak",
                                                    "type": "string"
                                                },
                                                "type": "array"
                                            }
                                        },
                                        "type": "object"
                                    },
                                    "type": "array"
                                },
                                "blockHash": {
                                    "pattern": "^0x[a-fA-F\\d]{64}$",
                                    "title": "keccak",
                                    "type": "string"
                                },
                                "blockNumber": {
                                    "pattern": "^0x[a-fA-F0-9]+$",
                                    "title": "integer",
                                    "type": "string"
                                },
                                "chainId": {
                                    "pattern": "^0x[a-fA-F0-9]+$",
                                    "title": "integer",
                                    "type": "string"
                                },
                                "from": {
                                    "pattern": "^0x[a-fA-F\\d]{64}$",
                                    "title": "keccak",
                                    "type": "string"
                                },
                                "gas": {
                                    "pattern": "^0x([a-fA-F\\d])+$",
                                    "title": "uint64",
                                    "type": "string"
                                },
                                "gasPrice": {
                                    "pattern": "^0x[a-fA-F0-9]+$",
                                    "title": "integer",
                                    "type": "string"
                                },
                                "hash": {
                                    "pattern": "^0x[a-fA-F\\d]{64}$",
                                    "title": "keccak",
                                    "type": "string"
                                },
                                "input": {
                                    "pattern": "^0x([a-fA-F\\d])+$",
                                    "title": "dataWord",
                                    "type": "string"
                                },
                                "maxFeePerGas": {
                                    "pattern": "^0x[a-fA-F0-9]+$",
                                    "title": "integer",
                                    "type": "string"
                                },
                                "maxPriorityFeePerGas": {
                                    "pattern": "^0x[a-fA-F0-9]+$",
                                    "title": "integer",
                                    "type": "string"
                                },
                                "nonce": {
                                    "pattern": "^0x([a-fA-F\\d])+$",
                                    "title": "uint64",
                                    "type": "string"
                                },
                                "r": {
                                    "pattern": "^0x[a-fA-F0-9]+$",
                                    "title": "integer",
                                    "type": "string"
                                },
                                "s": {
                                    "pattern": "^0x[a-fA-F0-9]+$",
                                    "title": "integer",
                                    "type": "string"
                                },
                                "to": {
                                    "pattern": "^0x[a-fA-F\\d]{64}$",
                                    "title": "keccak",
                                    "type": "string"
                                },
                                "transactionIndex": {
                                    "pattern": "^0x([a-fA-F\\d])+$",
                                    "title": "uint64",
                                    "type": "string"
                                },
                                "type": {
                                    "pattern": "^0x([a-fA-F\\d])+$",
                                    "title": "uint64",
                                    "type": "string"
                                },
                                "v": {
                                    "pattern": "^0x[a-fA-F0-9]+$",
                                    "title": "integer",
                                    "type": "string"
                                },
                                "value": {
                                    "pattern": "^0x[a-fA-F0-9]+$",
                                    "title": "integer",
                                    "type": "string"
                                },
                                "yParity": {
                                    "pattern": "^0x([a-fA-F\\d])+$",
                                    "title": "uint64",
                                    "type": "string"
                                }
                            },
                            "type": "object"
                        }
                    },
                    "type": "object"
                }
            },
            "type": "object"
        }
    },
    "type": [
        "object"
    ]
}
```

Client Method Invocation Examples

=== "Shell HTTP"

``` shell
curl -X POST -H "Content-Type: application/json" http://localhost:8545 --data '{"jsonrpc": "2.0", "id": 42, "method": "txpool_content", "params": []}'
```

=== "Shell WebSocket"

``` shell
wscat -c ws://localhost:8546 -x '{"jsonrpc": "2.0", "id": 1, "method": "txpool_content", "params": []}'
```

=== "Javascript Console"

``` js
txpool.content();
```

---

txpool_contentFrom

ContentFrom returns the transactions contained within the transaction pool.

Params (1)

Parameters must be given by position.

1: addr common.Address

• Required: ✓ Yes

=== "Schema"

``` Schema

- description: `Hex representation of a Keccak 256 hash POINTER`
- pattern: `^0x[a-fA-F\d]{64}$`
- title: `keccak`
- type: string


```

=== "Raw"

``` Raw
{
    "description": "Hex representation of a Keccak 256 hash POINTER",
    "pattern": "^0x[a-fA-F\\d]{64}$",
    "title": "keccak",
    "type": [
        "string"
    ]
}
```

Result

mapstringmapstringRPCTransaction map[string]map[string]*RPCTransaction

• Required: ✓ Yes

=== "Schema"

``` Schema

- patternProperties: 
	- .*: 
		- patternProperties: 
			- .*: 
				- additionalProperties: `false`
				- properties: 
					- accessList: 
						- items: 
							- additionalProperties: `false`
							- properties: 
								- address: 
									- pattern: `^0x[a-fA-F\d]{64}$`
									- title: `keccak`
									- type: `string`

								- storageKeys: 
									- items: 
										- description: `Hex representation of a Keccak 256 hash`
										- pattern: `^0x[a-fA-F\d]{64}$`
										- title: `keccak`
										- type: `string`

									- type: `array`


							- type: `object`

						- type: `array`

					- blockHash: 
						- pattern: `^0x[a-fA-F\d]{64}$`
						- title: `keccak`
						- type: `string`

					- blockNumber: 
						- pattern: `^0x[a-fA-F0-9]+$`
						- title: `integer`
						- type: `string`

					- chainId: 
						- pattern: `^0x[a-fA-F0-9]+$`
						- title: `integer`
						- type: `string`

					- from: 
						- pattern: `^0x[a-fA-F\d]{64}$`
						- title: `keccak`
						- type: `string`

					- gas: 
						- pattern: `^0x([a-fA-F\d])+$`
						- title: `uint64`
						- type: `string`

					- gasPrice: 
						- pattern: `^0x[a-fA-F0-9]+$`
						- title: `integer`
						- type: `string`

					- hash: 
						- pattern: `^0x[a-fA-F\d]{64}$`
						- title: `keccak`
						- type: `string`

					- input: 
						- pattern: `^0x([a-fA-F\d])+$`
						- title: `dataWord`
						- type: `string`

					- maxFeePerGas: 
						- pattern: `^0x[a-fA-F0-9]+$`
						- title: `integer`
						- type: `string`

					- maxPriorityFeePerGas: 
						- pattern: `^0x[a-fA-F0-9]+$`
						- title: `integer`
						- type: `string`

					- nonce: 
						- pattern: `^0x([a-fA-F\d])+$`
						- title: `uint64`
						- type: `string`

					- r: 
						- pattern: `^0x[a-fA-F0-9]+$`
						- title: `integer`
						- type: `string`

					- s: 
						- pattern: `^0x[a-fA-F0-9]+$`
						- title: `integer`
						- type: `string`

					- to: 
						- pattern: `^0x[a-fA-F\d]{64}$`
						- title: `keccak`
						- type: `string`

					- transactionIndex: 
						- pattern: `^0x([a-fA-F\d])+$`
						- title: `uint64`
						- type: `string`

					- type: 
						- pattern: `^0x([a-fA-F\d])+$`
						- title: `uint64`
						- type: `string`

					- v: 
						- pattern: `^0x[a-fA-F0-9]+$`
						- title: `integer`
						- type: `string`

					- value: 
						- pattern: `^0x[a-fA-F0-9]+$`
						- title: `integer`
						- type: `string`

					- yParity: 
						- pattern: `^0x([a-fA-F\d])+$`
						- title: `uint64`
						- type: `string`


				- type: `object`


		- type: `object`


- type: object


```

=== "Raw"

``` Raw
{
    "patternProperties": {
        ".*": {
            "patternProperties": {
                ".*": {
                    "additionalProperties": false,
                    "properties": {
                        "accessList": {
                            "items": {
                                "additionalProperties": false,
                                "properties": {
                                    "address": {
                                        "pattern": "^0x[a-fA-F\\d]{64}$",
                                        "title": "keccak",
                                        "type": "string"
                                    },
                                    "storageKeys": {
                                        "items": {
                                            "description": "Hex representation of a Keccak 256 hash",
                                            "pattern": "^0x[a-fA-F\\d]{64}$",
                                            "title": "keccak",
                                            "type": "string"
                                        },
                                        "type": "array"
                                    }
                                },
                                "type": "object"
                            },
                            "type": "array"
                        },
                        "blockHash": {
                            "pattern": "^0x[a-fA-F\\d]{64}$",
                            "title": "keccak",
                            "type": "string"
                        },
                        "blockNumber": {
                            "pattern": "^0x[a-fA-F0-9]+$",
                            "title": "integer",
                            "type": "string"
                        },
                        "chainId": {
                            "pattern": "^0x[a-fA-F0-9]+$",
                            "title": "integer",
                            "type": "string"
                        },
                        "from": {
                            "pattern": "^0x[a-fA-F\\d]{64}$",
                            "title": "keccak",
                            "type": "string"
                        },
                        "gas": {
                            "pattern": "^0x([a-fA-F\\d])+$",
                            "title": "uint64",
                            "type": "string"
                        },
                        "gasPrice": {
                            "pattern": "^0x[a-fA-F0-9]+$",
                            "title": "integer",
                            "type": "string"
                        },
                        "hash": {
                            "pattern": "^0x[a-fA-F\\d]{64}$",
                            "title": "keccak",
                            "type": "string"
                        },
                        "input": {
                            "pattern": "^0x([a-fA-F\\d])+$",
                            "title": "dataWord",
                            "type": "string"
                        },
                        "maxFeePerGas": {
                            "pattern": "^0x[a-fA-F0-9]+$",
                            "title": "integer",
                            "type": "string"
                        },
                        "maxPriorityFeePerGas": {
                            "pattern": "^0x[a-fA-F0-9]+$",
                            "title": "integer",
                            "type": "string"
                        },
                        "nonce": {
                            "pattern": "^0x([a-fA-F\\d])+$",
                            "title": "uint64",
                            "type": "string"
                        },
                        "r": {
                            "pattern": "^0x[a-fA-F0-9]+$",
                            "title": "integer",
                            "type": "string"
                        },
                        "s": {
                            "pattern": "^0x[a-fA-F0-9]+$",
                            "title": "integer",
                            "type": "string"
                        },
                        "to": {
                            "pattern": "^0x[a-fA-F\\d]{64}$",
                            "title": "keccak",
                            "type": "string"
                        },
                        "transactionIndex": {
                            "pattern": "^0x([a-fA-F\\d])+$",
                            "title": "uint64",
                            "type": "string"
                        },
                        "type": {
                            "pattern": "^0x([a-fA-F\\d])+$",
                            "title": "uint64",
                            "type": "string"
                        },
                        "v": {
                            "pattern": "^0x[a-fA-F0-9]+$",
                            "title": "integer",
                            "type": "string"
                        },
                        "value": {
                            "pattern": "^0x[a-fA-F0-9]+$",
                            "title": "integer",
                            "type": "string"
                        },
                        "yParity": {
                            "pattern": "^0x([a-fA-F\\d])+$",
                            "title": "uint64",
                            "type": "string"
                        }
                    },
                    "type": "object"
                }
            },
            "type": "object"
        }
    },
    "type": [
        "object"
    ]
}
```

Client Method Invocation Examples

=== "Shell HTTP"

``` shell
curl -X POST -H "Content-Type: application/json" http://localhost:8545 --data '{"jsonrpc": "2.0", "id": 42, "method": "txpool_contentFrom", "params": [<addr>]}'
```

=== "Shell WebSocket"

``` shell
wscat -c ws://localhost:8546 -x '{"jsonrpc": "2.0", "id": 1, "method": "txpool_contentFrom", "params": [<addr>]}'
```

=== "Javascript Console"

``` js
txpool.contentFrom(addr);
```

---

txpool_inspect

Inspect retrieves the content of the transaction pool and flattens it into an easily inspectable list.

Params (0)

None

Result

mapstringmapstringmapstringstring map[string]map[string]map[string]string

• Required: ✓ Yes

=== "Schema"

``` Schema

- patternProperties: 
	- .*: 
		- patternProperties: 
			- .*: 
				- patternProperties: 
					- .*: 
						- type: `string`


				- type: `object`


		- type: `object`


- type: object


```

=== "Raw"

``` Raw
{
    "patternProperties": {
        ".*": {
            "patternProperties": {
                ".*": {
                    "patternProperties": {
                        ".*": {
                            "type": "string"
                        }
                    },
                    "type": "object"
                }
            },
            "type": "object"
        }
    },
    "type": [
        "object"
    ]
}
```

Client Method Invocation Examples

=== "Shell HTTP"

``` shell
curl -X POST -H "Content-Type: application/json" http://localhost:8545 --data '{"jsonrpc": "2.0", "id": 42, "method": "txpool_inspect", "params": []}'
```

=== "Shell WebSocket"

``` shell
wscat -c ws://localhost:8546 -x '{"jsonrpc": "2.0", "id": 1, "method": "txpool_inspect", "params": []}'
```

=== "Javascript Console"

``` js
txpool.inspect();
```

---

txpool_status

Status returns the number of pending and queued transaction in the pool.

Params (0)

None

Result

mapstringhexutilUint map[string]hexutil.Uint

• Required: ✓ Yes

=== "Schema"

``` Schema

- patternProperties: 
	- .*: 
		- description: `Hex representation of a uint`
		- pattern: `^0x([a-fA-F\d])+$`
		- title: `uint`
		- type: `string`


- type: object


```

=== "Raw"

``` Raw
{
    "patternProperties": {
        ".*": {
            "description": "Hex representation of a uint",
            "pattern": "^0x([a-fA-F\\d])+$",
            "title": "uint",
            "type": "string"
        }
    },
    "type": [
        "object"
    ]
}
```

Client Method Invocation Examples

=== "Shell HTTP"

``` shell
curl -X POST -H "Content-Type: application/json" http://localhost:8545 --data '{"jsonrpc": "2.0", "id": 42, "method": "txpool_status", "params": []}'
```

=== "Shell WebSocket"

``` shell
wscat -c ws://localhost:8546 -x '{"jsonrpc": "2.0", "id": 1, "method": "txpool_status", "params": []}'
```

=== "Javascript Console"

``` js
txpool.status();
```