diff --git a/.develop/openrpc-validator-cli.js b/.develop/openrpc-validator-cli.js new file mode 100755 index 0000000000..e598e4b170 --- /dev/null +++ b/.develop/openrpc-validator-cli.js @@ -0,0 +1,55 @@ +#!/usr/bin/env node +"use strict"; +Object.defineProperty(exports, "__esModule", { value: true }); +var schema_utils_js_1 = require("@open-rpc/schema-utils-js"); +var program = require('commander').program; +program.version("0.0.1"); +program.option("-v, --verbose", "verbose logging"); +program.parse(process.argv); +// Get either stdin or first argument. +// https://gist.github.com/ishu3101/9fa58ca1440f780d6288 +var args = program.args; // process.argv.slice(2); +var input = args[0]; +var isTTY = process.stdin.isTTY; +var stdin = process.stdin; +var stdout = process.stdout; +// If no STDIN and no arguments, display usage message +if (isTTY && args.length === 0) { + program.help(); +} +// If no STDIN but arguments given +else if (isTTY && args.length !== 0) { + handleShellArguments(); +} +// read from STDIN +else { + handlePipedContent(); +} +function handlePipedContent() { + var data = ''; + stdin.on('readable', function () { + var chuck = stdin.read(); + if (chuck !== null) { + data += chuck; + } + }); + stdin.on('end', function () { + doValidate(data); + }); +} +function handleShellArguments() { + doValidate(input); +} +function doValidate(input) { + if (input === "") { + process.exit(2); + } + schema_utils_js_1.parseOpenRPCDocument(input).then(function (doc) { + if (program.verbose) + console.log(doc); + console.log("OK"); + }).catch(function (err) { + console.log("PARSE FAIL", err); + process.exit(1); + }); +} diff --git a/.develop/serve.py b/.develop/serve.py new file mode 100755 index 0000000000..a5ca694f48 --- /dev/null +++ b/.develop/serve.py @@ -0,0 +1,61 @@ +import SimpleHTTPServer +import sys + +# https://gist.github.com/enjalot/2904124 +class CORSHTTPRequestHandler(SimpleHTTPServer.SimpleHTTPRequestHandler): + def send_head(self): + """Common code for GET and HEAD commands. + This sends the response code and MIME headers. + Return value is either a file object (which has to be copied + to the outputfile by the caller unless the command was HEAD, + and must be closed by the caller under all circumstances), or + None, in which case the caller has nothing further to do. + """ + path = self.translate_path(self.path) + f = None + if os.path.isdir(path): + if not self.path.endswith('/'): + # redirect browser - doing basically what apache does + self.send_response(301) + self.send_header("Location", self.path + "/") + self.end_headers() + return None + for index in "index.html", "index.htm": + index = os.path.join(path, index) + if os.path.exists(index): + path = index + break + else: + return self.list_directory(path) + ctype = self.guess_type(path) + try: + # Always read in binary mode. Opening files in text mode may cause + # newline translations, making the actual size of the content + # transmitted *less* than the content-length! + f = open(path, 'rb') + except IOError: + self.send_error(404, "File not found") + return None + self.send_response(200) + self.send_header("Content-type", ctype) + fs = os.fstat(f.fileno()) + self.send_header("Content-Length", str(fs[6])) + self.send_header("Last-Modified", self.date_time_string(fs.st_mtime)) + self.send_header("Access-Control-Allow-Origin", "*") + self.end_headers() + return f + + +if __name__ == "__main__": + import os + import SocketServer + + PORT = (len(sys.argv) > 1 and int(sys.argv[1])) or 31338 + + Handler = CORSHTTPRequestHandler + #Handler = SimpleHTTPServer.SimpleHTTPRequestHandler + + httpd = SocketServer.TCPServer(("", PORT), Handler) + + print "serving at port", PORT + httpd.serve_forever() \ No newline at end of file diff --git a/.develop/spec.json b/.develop/spec.json new file mode 100644 index 0000000000..51d89b8553 --- /dev/null +++ b/.develop/spec.json @@ -0,0 +1,9716 @@ +{ + "openrpc": "1.2.4", + "info": { + "title": "Core-Geth Ethereum JSON-RPC: tcp:127.0.0.1:8545", + "description": "This API lets you interact with an EVM-based client via JSON-RPC", + "termsOfService": "https://github.com/etclabscore/core-geth/blob/master/COPYING", + "contact": { + "name": "", + "url": "", + "email": "" + }, + "license": { + "name": "Apache-2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" + }, + "version": "1.0.10-2020-04-10T12:32:39-05:00-1586539959" + }, + "servers": [], + "methods": [ + { + "name": "admin_addPeer", + "tags": [], + "summary": "AddPeer requests connecting to a remote node, and also maintaining the new\nconnection at all times, even reconnecting if it is lost.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/node/api.go#L45](https://github.com/ethereum/go-ethereum/blob/master/node/api.go#L45)\n```go\n// AddPeer requests connecting to a remote node, and also maintaining the new\n// connection at all times, even reconnecting if it is lost.\nfunc (api *PrivateAdminAPI) AddPeer(url string) (bool, error) {\n\n\tserver := api.node.Server()\n\tif server == nil {\n\t\treturn false, ErrNodeStopped\n\t}\n\n\tnode, err := enode.Parse(enode.ValidSchemes, url)\n\tif err != nil {\n\t\treturn false, fmt.Errorf(\"invalid enode: %v\", err)\n\t}\n\tserver.AddPeer(node)\n\treturn true, nil\n}\n```", + "externalDocs": { + "description": "line=45", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + } + ], + "result": { + "name": "bool", + "summary": "", + "description": "`bool`", + "required": true, + "deprecated": false, + "schema": { + "description": "bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_addTrustedPeer", + "tags": [], + "summary": "AddTrustedPeer allows a remote node to always connect, even if slots are full\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/node/api.go#L77](https://github.com/ethereum/go-ethereum/blob/master/node/api.go#L77)\n```go\n// AddTrustedPeer allows a remote node to always connect, even if slots are full\nfunc (api *PrivateAdminAPI) AddTrustedPeer(url string) (bool, error) {\n\n\tserver := api.node.Server()\n\tif server == nil {\n\t\treturn false, ErrNodeStopped\n\t}\n\tnode, err := enode.Parse(enode.ValidSchemes, url)\n\tif err != nil {\n\t\treturn false, fmt.Errorf(\"invalid enode: %v\", err)\n\t}\n\tserver.AddTrustedPeer(node)\n\treturn true, nil\n}\n```", + "externalDocs": { + "description": "line=77", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + } + ], + "result": { + "name": "bool", + "summary": "", + "description": "`bool`", + "required": true, + "deprecated": false, + "schema": { + "description": "bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_datadir", + "tags": [], + "summary": "Datadir retrieves the current data directory the node is using.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/node/api.go#L295](https://github.com/ethereum/go-ethereum/blob/master/node/api.go#L295)\n```go\n// Datadir retrieves the current data directory the node is using.\nfunc (api *PublicAdminAPI) Datadir() string {\n\treturn api.node.DataDir()\n}\n```", + "externalDocs": { + "description": "line=295", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go" + }, + "params": [], + "result": { + "name": "string", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_exportChain", + "tags": [], + "summary": "ExportChain exports the current blockchain into a local file,\nor a range of blocks if first and last are non-nil\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L171](https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L171)\n```go\n// ExportChain exports the current blockchain into a local file,\n// or a range of blocks if first and last are non-nil\nfunc (api *PrivateAdminAPI) ExportChain(file string, first *uint64, last *uint64) (bool, error) {\n\tif first == nil \u0026\u0026 last != nil {\n\t\treturn false, errors.New(\"last cannot be specified without first\")\n\t}\n\tif first != nil \u0026\u0026 last == nil {\n\t\thead := api.eth.BlockChain().CurrentHeader().Number.Uint64()\n\t\tlast = \u0026head\n\t}\n\tif _, err := os.Stat(file); err == nil {\n\n\t\treturn false, errors.New(\"location would overwrite an existing file\")\n\t}\n\n\tout, err := os.OpenFile(file, os.O_CREATE|os.O_WRONLY|os.O_TRUNC, os.ModePerm)\n\tif err != nil {\n\t\treturn false, err\n\t}\n\tdefer out.Close()\n\n\tvar writer io.Writer = out\n\tif strings.HasSuffix(file, \".gz\") {\n\t\twriter = gzip.NewWriter(writer)\n\t\tdefer writer.(*gzip.Writer).Close()\n\t}\n\n\tif first != nil {\n\t\tif err := api.eth.BlockChain().ExportN(writer, *first, *last); err != nil {\n\t\t\treturn false, err\n\t\t}\n\t} else if err := api.eth.BlockChain().Export(writer); err != nil {\n\t\treturn false, err\n\t}\n\treturn true, nil\n}\n```", + "externalDocs": { + "description": "line=171", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + }, + { + "name": "first", + "summary": "", + "description": "`*uint64`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + { + "type": "null" + } + ] + } + }, + { + "name": "last", + "summary": "", + "description": "`*uint64`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + { + "type": "null" + } + ] + } + } + ], + "result": { + "name": "bool", + "summary": "", + "description": "`bool`", + "required": true, + "deprecated": false, + "schema": { + "description": "bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_importChain", + "tags": [], + "summary": "ImportChain imports a blockchain from a local file.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L219](https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L219)\n```go\n// ImportChain imports a blockchain from a local file.\nfunc (api *PrivateAdminAPI) ImportChain(file string) (bool, error) {\n\n\tin, err := os.Open(file)\n\tif err != nil {\n\t\treturn false, err\n\t}\n\tdefer in.Close()\n\n\tvar reader io.Reader = in\n\tif strings.HasSuffix(file, \".gz\") {\n\t\tif reader, err = gzip.NewReader(reader); err != nil {\n\t\t\treturn false, err\n\t\t}\n\t}\n\n\tstream := rlp.NewStream(reader, 0)\n\n\tblocks, index := make([]*types.Block, 0, 2500), 0\n\tfor batch := 0; ; batch++ {\n\n\t\tfor len(blocks) \u003c cap(blocks) {\n\t\t\tblock := new(types.Block)\n\t\t\tif err := stream.Decode(block); err == io.EOF {\n\t\t\t\tbreak\n\t\t\t} else if err != nil {\n\t\t\t\treturn false, fmt.Errorf(\"block %d: failed to parse: %v\", index, err)\n\t\t\t}\n\t\t\tblocks = append(blocks, block)\n\t\t\tindex++\n\t\t}\n\t\tif len(blocks) == 0 {\n\t\t\tbreak\n\t\t}\n\n\t\tif hasAllBlocks(api.eth.BlockChain(), blocks) {\n\t\t\tblocks = blocks[:0]\n\t\t\tcontinue\n\t\t}\n\n\t\tif _, err := api.eth.BlockChain().InsertChain(blocks); err != nil {\n\t\t\treturn false, fmt.Errorf(\"batch %d: failed to insert: %v\", batch, err)\n\t\t}\n\t\tblocks = blocks[:0]\n\t}\n\treturn true, nil\n}\n```", + "externalDocs": { + "description": "line=219", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + } + ], + "result": { + "name": "bool", + "summary": "", + "description": "`bool`", + "required": true, + "deprecated": false, + "schema": { + "description": "bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_nodeInfo", + "tags": [], + "summary": "NodeInfo retrieves all the information we know about the host node at the\nprotocol granularity.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/node/api.go#L285](https://github.com/ethereum/go-ethereum/blob/master/node/api.go#L285)\n```go\n// NodeInfo retrieves all the information we know about the host node at the\n// protocol granularity.\nfunc (api *PublicAdminAPI) NodeInfo() (*p2p.NodeInfo, error) {\n\tserver := api.node.Server()\n\tif server == nil {\n\t\treturn nil, ErrNodeStopped\n\t}\n\treturn server.NodeInfo(), nil\n}\n```", + "externalDocs": { + "description": "line=285", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go" + }, + "params": [], + "result": { + "name": "*p2p.NodeInfo", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/p2p.*NodeInfo`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "enode": { + "type": "string" + }, + "enr": { + "type": "string" + }, + "id": { + "type": "string" + }, + "ip": { + "type": "string" + }, + "listenAddr": { + "type": "string" + }, + "name": { + "type": "string" + }, + "ports": { + "type": "object", + "properties": { + "discovery": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "listener": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + }, + "protocols": { + "type": "object", + "patternProperties": { + ".*": { + "additionalProperties": true + } + } + } + }, + "additionalProperties": false + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_peerEvents", + "tags": [], + "summary": "PeerEvents creates an RPC subscription which receives peer events from the\nnode's p2p.Server\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/node/api.go#L109](https://github.com/ethereum/go-ethereum/blob/master/node/api.go#L109)\n```go\n// PeerEvents creates an RPC subscription which receives peer events from the\n// node's p2p.Server\nfunc (api *PrivateAdminAPI) PeerEvents(ctx context.Context) (*rpc.Subscription, error) {\n\n\tserver := api.node.Server()\n\tif server == nil {\n\t\treturn nil, ErrNodeStopped\n\t}\n\n\tnotifier, supported := rpc.NotifierFromContext(ctx)\n\tif !supported {\n\t\treturn nil, rpc.ErrNotificationsUnsupported\n\t}\n\trpcSub := notifier.CreateSubscription()\n\n\tgo func() {\n\t\tevents := make(chan *p2p.PeerEvent)\n\t\tsub := server.SubscribeEvents(events)\n\t\tdefer sub.Unsubscribe()\n\n\t\tfor {\n\t\t\tselect {\n\t\t\tcase event := \u003c-events:\n\t\t\t\tnotifier.Notify(rpcSub.ID, event)\n\t\t\tcase \u003c-sub.Err():\n\t\t\t\treturn\n\t\t\tcase \u003c-rpcSub.Err():\n\t\t\t\treturn\n\t\t\tcase \u003c-notifier.Closed():\n\t\t\t\treturn\n\t\t\t}\n\t\t}\n\t}()\n\n\treturn rpcSub, nil\n}\n```", + "externalDocs": { + "description": "line=109", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go" + }, + "params": [], + "result": { + "name": "*rpc.Subscription", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/rpc.*Subscription`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "github.com/ethereum/go-ethereum/rpc.*Subscription", + "type": "object", + "title": "Subscription" + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_peers", + "tags": [], + "summary": "Peers retrieves all the information we know about each individual peer at the\nprotocol granularity.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/node/api.go#L275](https://github.com/ethereum/go-ethereum/blob/master/node/api.go#L275)\n```go\n// Peers retrieves all the information we know about each individual peer at the\n// protocol granularity.\nfunc (api *PublicAdminAPI) Peers() ([]*p2p.PeerInfo, error) {\n\tserver := api.node.Server()\n\tif server == nil {\n\t\treturn nil, ErrNodeStopped\n\t}\n\treturn server.PeersInfo(), nil\n}\n```", + "externalDocs": { + "description": "line=275", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go" + }, + "params": [], + "result": { + "name": "[]*p2p.PeerInfo", + "summary": "", + "description": "``", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "object", + "properties": { + "caps": { + "type": "array", + "items": { + "type": "string" + } + }, + "enode": { + "type": "string" + }, + "enr": { + "type": "string" + }, + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "network": { + "type": "object", + "properties": { + "inbound": { + "type": "boolean" + }, + "localAddress": { + "type": "string" + }, + "remoteAddress": { + "type": "string" + }, + "static": { + "type": "boolean" + }, + "trusted": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "protocols": { + "type": "object", + "properties": { + "inbound": { + "type": "boolean" + }, + "localAddress": { + "type": "string" + }, + "remoteAddress": { + "type": "string" + }, + "static": { + "type": "boolean" + }, + "trusted": { + "type": "boolean" + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false + } + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_removePeer", + "tags": [], + "summary": "RemovePeer disconnects from a remote node if the connection exists\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/node/api.go#L61](https://github.com/ethereum/go-ethereum/blob/master/node/api.go#L61)\n```go\n// RemovePeer disconnects from a remote node if the connection exists\nfunc (api *PrivateAdminAPI) RemovePeer(url string) (bool, error) {\n\n\tserver := api.node.Server()\n\tif server == nil {\n\t\treturn false, ErrNodeStopped\n\t}\n\n\tnode, err := enode.Parse(enode.ValidSchemes, url)\n\tif err != nil {\n\t\treturn false, fmt.Errorf(\"invalid enode: %v\", err)\n\t}\n\tserver.RemovePeer(node)\n\treturn true, nil\n}\n```", + "externalDocs": { + "description": "line=61", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + } + ], + "result": { + "name": "bool", + "summary": "", + "description": "`bool`", + "required": true, + "deprecated": false, + "schema": { + "description": "bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_removeTrustedPeer", + "tags": [], + "summary": "RemoveTrustedPeer removes a remote node from the trusted peer set, but it\ndoes not disconnect it automatically.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/node/api.go#L93](https://github.com/ethereum/go-ethereum/blob/master/node/api.go#L93)\n```go\n// RemoveTrustedPeer removes a remote node from the trusted peer set, but it\n// does not disconnect it automatically.\nfunc (api *PrivateAdminAPI) RemoveTrustedPeer(url string) (bool, error) {\n\n\tserver := api.node.Server()\n\tif server == nil {\n\t\treturn false, ErrNodeStopped\n\t}\n\tnode, err := enode.Parse(enode.ValidSchemes, url)\n\tif err != nil {\n\t\treturn false, fmt.Errorf(\"invalid enode: %v\", err)\n\t}\n\tserver.RemoveTrustedPeer(node)\n\treturn true, nil\n}\n```", + "externalDocs": { + "description": "line=93", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + } + ], + "result": { + "name": "bool", + "summary": "", + "description": "`bool`", + "required": true, + "deprecated": false, + "schema": { + "description": "bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_startRPC", + "tags": [], + "summary": "StartRPC starts the HTTP RPC API server.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/node/api.go#L146](https://github.com/ethereum/go-ethereum/blob/master/node/api.go#L146)\n```go\n// StartRPC starts the HTTP RPC API server.\nfunc (api *PrivateAdminAPI) StartRPC(host *string, port *int, cors *string, apis *string, vhosts *string) (bool, error) {\n\tapi.node.lock.Lock()\n\tdefer api.node.lock.Unlock()\n\n\tif api.node.httpHandler != nil {\n\t\treturn false, fmt.Errorf(\"HTTP RPC already running on %s\", api.node.httpEndpoint)\n\t}\n\n\tif host == nil {\n\t\th := DefaultHTTPHost\n\t\tif api.node.config.HTTPHost != \"\" {\n\t\t\th = api.node.config.HTTPHost\n\t\t}\n\t\thost = \u0026h\n\t}\n\tif port == nil {\n\t\tport = \u0026api.node.config.HTTPPort\n\t}\n\n\tallowedOrigins := api.node.config.HTTPCors\n\tif cors != nil {\n\t\tallowedOrigins = nil\n\t\tfor _, origin := range strings.Split(*cors, \",\") {\n\t\t\tallowedOrigins = append(allowedOrigins, strings.TrimSpace(origin))\n\t\t}\n\t}\n\n\tallowedVHosts := api.node.config.HTTPVirtualHosts\n\tif vhosts != nil {\n\t\tallowedVHosts = nil\n\t\tfor _, vhost := range strings.Split(*host, \",\") {\n\t\t\tallowedVHosts = append(allowedVHosts, strings.TrimSpace(vhost))\n\t\t}\n\t}\n\n\tmodules := api.node.httpWhitelist\n\tif apis != nil {\n\t\tmodules = nil\n\t\tfor _, m := range strings.Split(*apis, \",\") {\n\t\t\tmodules = append(modules, strings.TrimSpace(m))\n\t\t}\n\t}\n\n\tif err := api.node.startHTTP(fmt.Sprintf(\"%s:%d\", *host, *port), api.node.rpcAPIs, modules, allowedOrigins, allowedVHosts, api.node.config.HTTPTimeouts, api.node.config.WSOrigins); err != nil {\n\t\treturn false, err\n\t}\n\treturn true, nil\n}\n```", + "externalDocs": { + "description": "line=146", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go" + }, + "params": [ + { + "name": "host", + "summary": "", + "description": "`*string`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "*string", + "type": "string" + }, + { + "type": "null" + } + ] + } + }, + { + "name": "port", + "summary": "", + "description": "`*int`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + { + "type": "null" + } + ] + } + }, + { + "name": "cors", + "summary": "", + "description": "`*string`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "*string", + "type": "string" + }, + { + "type": "null" + } + ] + } + }, + { + "name": "apis", + "summary": "", + "description": "`*string`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "*string", + "type": "string" + }, + { + "type": "null" + } + ] + } + }, + { + "name": "vhosts", + "summary": "", + "description": "`*string`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "*string", + "type": "string" + }, + { + "type": "null" + } + ] + } + } + ], + "result": { + "name": "bool", + "summary": "", + "description": "`bool`", + "required": true, + "deprecated": false, + "schema": { + "description": "bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_startWS", + "tags": [], + "summary": "StartWS starts the websocket RPC API server.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/node/api.go#L208](https://github.com/ethereum/go-ethereum/blob/master/node/api.go#L208)\n```go\n// StartWS starts the websocket RPC API server.\nfunc (api *PrivateAdminAPI) StartWS(host *string, port *int, allowedOrigins *string, apis *string) (bool, error) {\n\tapi.node.lock.Lock()\n\tdefer api.node.lock.Unlock()\n\n\tif api.node.wsHandler != nil {\n\t\treturn false, fmt.Errorf(\"WebSocket RPC already running on %s\", api.node.wsEndpoint)\n\t}\n\n\tif host == nil {\n\t\th := DefaultWSHost\n\t\tif api.node.config.WSHost != \"\" {\n\t\t\th = api.node.config.WSHost\n\t\t}\n\t\thost = \u0026h\n\t}\n\tif port == nil {\n\t\tport = \u0026api.node.config.WSPort\n\t}\n\n\torigins := api.node.config.WSOrigins\n\tif allowedOrigins != nil {\n\t\torigins = nil\n\t\tfor _, origin := range strings.Split(*allowedOrigins, \",\") {\n\t\t\torigins = append(origins, strings.TrimSpace(origin))\n\t\t}\n\t}\n\n\tmodules := api.node.config.WSModules\n\tif apis != nil {\n\t\tmodules = nil\n\t\tfor _, m := range strings.Split(*apis, \",\") {\n\t\t\tmodules = append(modules, strings.TrimSpace(m))\n\t\t}\n\t}\n\n\tif err := api.node.startWS(fmt.Sprintf(\"%s:%d\", *host, *port), api.node.rpcAPIs, modules, origins, api.node.config.WSExposeAll); err != nil {\n\t\treturn false, err\n\t}\n\treturn true, nil\n}\n```", + "externalDocs": { + "description": "line=208", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go" + }, + "params": [ + { + "name": "host", + "summary": "", + "description": "`*string`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "*string", + "type": "string" + }, + { + "type": "null" + } + ] + } + }, + { + "name": "port", + "summary": "", + "description": "`*int`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + { + "type": "null" + } + ] + } + }, + { + "name": "allowedOrigins", + "summary": "", + "description": "`*string`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "*string", + "type": "string" + }, + { + "type": "null" + } + ] + } + }, + { + "name": "apis", + "summary": "", + "description": "`*string`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "*string", + "type": "string" + }, + { + "type": "null" + } + ] + } + } + ], + "result": { + "name": "bool", + "summary": "", + "description": "`bool`", + "required": true, + "deprecated": false, + "schema": { + "description": "bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_stopRPC", + "tags": [], + "summary": "StopRPC terminates an already running HTTP RPC API endpoint.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/node/api.go#L196](https://github.com/ethereum/go-ethereum/blob/master/node/api.go#L196)\n```go\n// StopRPC terminates an already running HTTP RPC API endpoint.\nfunc (api *PrivateAdminAPI) StopRPC() (bool, error) {\n\tapi.node.lock.Lock()\n\tdefer api.node.lock.Unlock()\n\n\tif api.node.httpHandler == nil {\n\t\treturn false, fmt.Errorf(\"HTTP RPC not running\")\n\t}\n\tapi.node.stopHTTP()\n\treturn true, nil\n}\n```", + "externalDocs": { + "description": "line=196", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go" + }, + "params": [], + "result": { + "name": "bool", + "summary": "", + "description": "`bool`", + "required": true, + "deprecated": false, + "schema": { + "description": "bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_stopWS", + "tags": [], + "summary": "StopWS terminates an already running websocket RPC API endpoint.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/node/api.go#L250](https://github.com/ethereum/go-ethereum/blob/master/node/api.go#L250)\n```go\n// StopWS terminates an already running websocket RPC API endpoint.\nfunc (api *PrivateAdminAPI) StopWS() (bool, error) {\n\tapi.node.lock.Lock()\n\tdefer api.node.lock.Unlock()\n\n\tif api.node.wsHandler == nil {\n\t\treturn false, fmt.Errorf(\"WebSocket RPC not running\")\n\t}\n\tapi.node.stopWS()\n\treturn true, nil\n}\n```", + "externalDocs": { + "description": "line=250", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go" + }, + "params": [], + "result": { + "name": "bool", + "summary": "", + "description": "`bool`", + "required": true, + "deprecated": false, + "schema": { + "description": "bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_accountRange", + "tags": [], + "summary": "AccountRange enumerates all accounts in the latest state\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L395](https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L395)\n```go\n// AccountRange enumerates all accounts in the latest state\nfunc (api *PrivateDebugAPI) AccountRange(ctx context.Context, start *common.Hash, maxResults int) (AccountRangeResult, error) {\n\tvar statedb *state.StateDB\n\tvar err error\n\tblock := api.eth.blockchain.CurrentBlock()\n\n\tif len(block.Transactions()) == 0 {\n\t\tstatedb, err = api.computeStateDB(block, defaultTraceReexec)\n\t\tif err != nil {\n\t\t\treturn AccountRangeResult{}, err\n\t\t}\n\t} else {\n\t\t_, _, statedb, err = api.computeTxEnv(block.Hash(), len(block.Transactions())-1, 0)\n\t\tif err != nil {\n\t\t\treturn AccountRangeResult{}, err\n\t\t}\n\t}\n\n\ttrie, err := statedb.Database().OpenTrie(block.Header().Root)\n\tif err != nil {\n\t\treturn AccountRangeResult{}, err\n\t}\n\n\treturn accountRange(trie, start, maxResults)\n}\n```", + "externalDocs": { + "description": "line=395", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go" + }, + "params": [ + { + "name": "start", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.*Hash`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "type": "null" + } + ] + } + }, + { + "name": "maxResults", + "summary": "", + "description": "`int`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "AccountRangeResult", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/eth.AccountRangeResult`", + "required": true, + "deprecated": false, + "schema": { + "type": "object", + "properties": { + "accounts": { + "type": "object", + "patternProperties": { + ".*": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + }, + "next": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "additionalProperties": false + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_backtraceAt", + "tags": [], + "summary": "BacktraceAt sets the log backtrace location. See package log for details on\nthe pattern syntax.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L68](https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L68)\n```go\n// BacktraceAt sets the log backtrace location. See package log for details on\n// the pattern syntax.\nfunc (*HandlerT) BacktraceAt(location string) error {\n\treturn glogger.BacktraceAt(location)\n}\n```", + "externalDocs": { + "description": "line=68", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go" + }, + "params": [ + { + "name": "location", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + } + ], + "result": { + "name": "Null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_blockProfile", + "tags": [], + "summary": "BlockProfile turns on goroutine profiling for nsec seconds and writes profile data to\nfile. It uses a profile rate of 1 for most accurate information. If a different rate is\ndesired, set the rate and write the profile manually.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L147](https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L147)\n```go\n// BlockProfile turns on goroutine profiling for nsec seconds and writes profile data to\n// file. It uses a profile rate of 1 for most accurate information. If a different rate is\n// desired, set the rate and write the profile manually.\nfunc (*HandlerT) BlockProfile(file string, nsec uint) error {\n\truntime.SetBlockProfileRate(1)\n\ttime.Sleep(time.Duration(nsec) * time.Second)\n\tdefer runtime.SetBlockProfileRate(0)\n\treturn writeProfile(\"block\", file)\n}\n```", + "externalDocs": { + "description": "line=147", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + }, + { + "name": "nsec", + "summary": "", + "description": "`uint`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "Null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_chaindbCompact", + "tags": [], + "summary": "ChaindbCompact flattens the entire key-value database into a single level,\nremoving all unused slots and merging all keys.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1774](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1774)\n```go\n// ChaindbCompact flattens the entire key-value database into a single level,\n// removing all unused slots and merging all keys.\nfunc (api *PrivateDebugAPI) ChaindbCompact() error {\n\tfor b := byte(0); b \u003c 255; b++ {\n\t\tlog.Info(\"Compacting chain database\", \"range\", fmt.Sprintf(\"0x%0.2X-0x%0.2X\", b, b+1))\n\t\tif err := api.b.ChainDb().Compact([]byte{b}, []byte{b + 1}); err != nil {\n\t\t\tlog.Error(\"Database compaction failed\", \"err\", err)\n\t\t\treturn err\n\t\t}\n\t}\n\treturn nil\n}\n```", + "externalDocs": { + "description": "line=1774", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [], + "result": { + "name": "Null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_chaindbProperty", + "tags": [], + "summary": "ChaindbProperty returns leveldb properties of the key-value database.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1763](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1763)\n```go\n// ChaindbProperty returns leveldb properties of the key-value database.\nfunc (api *PrivateDebugAPI) ChaindbProperty(property string) (string, error) {\n\tif property == \"\" {\n\t\tproperty = \"leveldb.stats\"\n\t} else if !strings.HasPrefix(property, \"leveldb.\") {\n\t\tproperty = \"leveldb.\" + property\n\t}\n\treturn api.b.ChainDb().Stat(property)\n}\n```", + "externalDocs": { + "description": "line=1763", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "property", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + } + ], + "result": { + "name": "string", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_cpuProfile", + "tags": [], + "summary": "CpuProfile turns on CPU profiling for nsec seconds and writes\nprofile data to file.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L88](https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L88)\n```go\n// CpuProfile turns on CPU profiling for nsec seconds and writes\n// profile data to file.\nfunc (h *HandlerT) CpuProfile(file string, nsec uint) error {\n\tif err := h.StartCPUProfile(file); err != nil {\n\t\treturn err\n\t}\n\ttime.Sleep(time.Duration(nsec) * time.Second)\n\th.StopCPUProfile()\n\treturn nil\n}\n```", + "externalDocs": { + "description": "line=88", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + }, + { + "name": "nsec", + "summary": "", + "description": "`uint`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "Null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_dumpBlock", + "tags": [], + "summary": "DumpBlock retrieves the entire state of the database at a given block.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L280](https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L280)\n```go\n// DumpBlock retrieves the entire state of the database at a given block.\nfunc (api *PublicDebugAPI) DumpBlock(blockNr rpc.BlockNumber) (state.Dump, error) {\n\tif blockNr == rpc.PendingBlockNumber {\n\n\t\t_, stateDb := api.eth.miner.Pending()\n\t\treturn stateDb.RawDump(false, false, true), nil\n\t}\n\tvar block *types.Block\n\tif blockNr == rpc.LatestBlockNumber {\n\t\tblock = api.eth.blockchain.CurrentBlock()\n\t} else {\n\t\tblock = api.eth.blockchain.GetBlockByNumber(uint64(blockNr))\n\t}\n\tif block == nil {\n\t\treturn state.Dump{}, fmt.Errorf(\"block #%d not found\", blockNr)\n\t}\n\tstateDb, err := api.eth.BlockChain().StateAt(block.Root())\n\tif err != nil {\n\t\treturn state.Dump{}, err\n\t}\n\treturn stateDb.RawDump(false, false, true), nil\n}\n```", + "externalDocs": { + "description": "line=280", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go" + }, + "params": [ + { + "name": "blockNr", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/rpc.BlockNumber`", + "required": true, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc.BlockNumber", + "oneOf": [ + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + }, + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + ] + } + } + ], + "result": { + "name": "state.Dump", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/core/state.Dump`", + "required": true, + "deprecated": false, + "schema": { + "type": "object", + "properties": { + "accounts": { + "type": "object", + "patternProperties": { + ".*": { + "type": "object", + "properties": { + "address": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "balance": { + "type": "string" + }, + "code": { + "type": "string" + }, + "codeHash": { + "type": "string" + }, + "key": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "root": { + "type": "string" + }, + "storage": { + "type": "object", + "patternProperties": { + ".*": { + "type": "string" + } + } + } + }, + "additionalProperties": false + } + } + }, + "root": { + "type": "string" + } + }, + "additionalProperties": false + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_freeOSMemory", + "tags": [], + "summary": "FreeOSMemory returns unused memory to the OS.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L200](https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L200)\n```go\n// FreeOSMemory returns unused memory to the OS.\nfunc (*HandlerT) FreeOSMemory() {\n\tdebug.FreeOSMemory()\n}\n```", + "externalDocs": { + "description": "line=200", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go" + }, + "params": [], + "result": { + "name": "Null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_gcStats", + "tags": [], + "summary": "GcStats returns GC statistics.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L80](https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L80)\n```go\n// GcStats returns GC statistics.\nfunc (*HandlerT) GcStats() *debug.GCStats {\n\ts := new(debug.GCStats)\n\tdebug.ReadGCStats(s)\n\treturn s\n}\n```", + "externalDocs": { + "description": "line=80", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go" + }, + "params": [], + "result": { + "name": "*debug.GCStats", + "summary": "", + "description": "`runtime/debug.*GCStats`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "LastGC": { + "type": "string", + "format": "date-time" + }, + "NumGC": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Pause": { + "type": "array", + "items": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "PauseEnd": { + "type": "array", + "items": { + "type": "string", + "format": "date-time" + } + }, + "PauseQuantiles": { + "type": "array", + "items": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "PauseTotal": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_getBadBlocks", + "tags": [], + "summary": "GetBadBlocks returns a list of the last 'bad blocks' that the client has seen on the network\nand returns them as a JSON list of block-hashes\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L333](https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L333)\n```go\n// GetBadBlocks returns a list of the last 'bad blocks' that the client has seen on the network\n// and returns them as a JSON list of block-hashes\nfunc (api *PrivateDebugAPI) GetBadBlocks(ctx context.Context) ([]*BadBlockArgs, error) {\n\tblocks := api.eth.BlockChain().BadBlocks()\n\tresults := make([]*BadBlockArgs, len(blocks))\n\n\tvar err error\n\tfor i, block := range blocks {\n\t\tresults[i] = \u0026BadBlockArgs{\n\t\t\tHash: block.Hash(),\n\t\t}\n\t\tif rlpBytes, err := rlp.EncodeToBytes(block); err != nil {\n\t\t\tresults[i].RLP = err.Error()\n\t\t} else {\n\t\t\tresults[i].RLP = fmt.Sprintf(\"0x%x\", rlpBytes)\n\t\t}\n\t\tif results[i].Block, err = ethapi.RPCMarshalBlock(block, true, true); err != nil {\n\t\t\tresults[i].Block = map[string]interface{}{\"error\": err.Error()}\n\t\t}\n\t}\n\treturn results, nil\n}\n```", + "externalDocs": { + "description": "line=333", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go" + }, + "params": [], + "result": { + "name": "[]*BadBlockArgs", + "summary": "", + "description": "``", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "object", + "properties": { + "block": { + "type": "object", + "patternProperties": { + ".*": { + "additionalProperties": true + } + } + }, + "hash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "rlp": { + "type": "string" + } + }, + "additionalProperties": false + } + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_getBlockRlp", + "tags": [], + "summary": "GetBlockRlp retrieves the RLP encoded for of a single block.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1681](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1681)\n```go\n// GetBlockRlp retrieves the RLP encoded for of a single block.\nfunc (api *PublicDebugAPI) GetBlockRlp(ctx context.Context, number uint64) (string, error) {\n\tblock, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number))\n\tif block == nil {\n\t\treturn \"\", fmt.Errorf(\"block #%d not found\", number)\n\t}\n\tencoded, err := rlp.EncodeToBytes(block)\n\tif err != nil {\n\t\treturn \"\", err\n\t}\n\treturn fmt.Sprintf(\"%x\", encoded), nil\n}\n```", + "externalDocs": { + "description": "line=1681", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "`uint64`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "string", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_getModifiedAccountsByHash", + "tags": [], + "summary": "GetModifiedAccountsByHash returns all accounts that have changed between the\ntwo blocks specified. A change is defined as a difference in nonce, balance,\ncode hash, or storage hash.\n\nWith one parameter, returns the list of accounts modified in the specified block.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L502](https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L502)\n```go\n// GetModifiedAccountsByHash returns all accounts that have changed between the\n// two blocks specified. A change is defined as a difference in nonce, balance,\n// code hash, or storage hash.\n//\n// With one parameter, returns the list of accounts modified in the specified block.\nfunc (api *PrivateDebugAPI) GetModifiedAccountsByHash(startHash common.Hash, endHash *common.Hash) ([]common.Address, error) {\n\tvar startBlock, endBlock *types.Block\n\tstartBlock = api.eth.blockchain.GetBlockByHash(startHash)\n\tif startBlock == nil {\n\t\treturn nil, fmt.Errorf(\"start block %x not found\", startHash)\n\t}\n\n\tif endHash == nil {\n\t\tendBlock = startBlock\n\t\tstartBlock = api.eth.blockchain.GetBlockByHash(startBlock.ParentHash())\n\t\tif startBlock == nil {\n\t\t\treturn nil, fmt.Errorf(\"block %x has no parent\", endBlock.Number())\n\t\t}\n\t} else {\n\t\tendBlock = api.eth.blockchain.GetBlockByHash(*endHash)\n\t\tif endBlock == nil {\n\t\t\treturn nil, fmt.Errorf(\"end block %x not found\", *endHash)\n\t\t}\n\t}\n\treturn api.getModifiedAccounts(startBlock, endBlock)\n}\n```", + "externalDocs": { + "description": "line=502", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go" + }, + "params": [ + { + "name": "startHash", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Hash`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "endHash", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.*Hash`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "type": "null" + } + ] + } + } + ], + "result": { + "name": "[]common.Address", + "summary": "", + "description": "``", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "array", + "items": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_getModifiedAccountsByNumber", + "tags": [], + "summary": "GetModifiedAccountsByNumber returns all accounts that have changed between the\ntwo blocks specified. A change is defined as a difference in nonce, balance,\ncode hash, or storage hash.\n\nWith one parameter, returns the list of accounts modified in the specified block.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L474](https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L474)\n```go\n// GetModifiedAccountsByNumber returns all accounts that have changed between the\n// two blocks specified. A change is defined as a difference in nonce, balance,\n// code hash, or storage hash.\n//\n// With one parameter, returns the list of accounts modified in the specified block.\nfunc (api *PrivateDebugAPI) GetModifiedAccountsByNumber(startNum uint64, endNum *uint64) ([]common.Address, error) {\n\tvar startBlock, endBlock *types.Block\n\n\tstartBlock = api.eth.blockchain.GetBlockByNumber(startNum)\n\tif startBlock == nil {\n\t\treturn nil, fmt.Errorf(\"start block %x not found\", startNum)\n\t}\n\n\tif endNum == nil {\n\t\tendBlock = startBlock\n\t\tstartBlock = api.eth.blockchain.GetBlockByHash(startBlock.ParentHash())\n\t\tif startBlock == nil {\n\t\t\treturn nil, fmt.Errorf(\"block %x has no parent\", endBlock.Number())\n\t\t}\n\t} else {\n\t\tendBlock = api.eth.blockchain.GetBlockByNumber(*endNum)\n\t\tif endBlock == nil {\n\t\t\treturn nil, fmt.Errorf(\"end block %d not found\", *endNum)\n\t\t}\n\t}\n\treturn api.getModifiedAccounts(startBlock, endBlock)\n}\n```", + "externalDocs": { + "description": "line=474", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go" + }, + "params": [ + { + "name": "startNum", + "summary": "", + "description": "`uint64`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + { + "name": "endNum", + "summary": "", + "description": "`*uint64`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + { + "type": "null" + } + ] + } + } + ], + "result": { + "name": "[]common.Address", + "summary": "", + "description": "``", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "array", + "items": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_goTrace", + "tags": [], + "summary": "GoTrace turns on tracing for nsec seconds and writes\ntrace data to file.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L135](https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L135)\n```go\n// GoTrace turns on tracing for nsec seconds and writes\n// trace data to file.\nfunc (h *HandlerT) GoTrace(file string, nsec uint) error {\n\tif err := h.StartGoTrace(file); err != nil {\n\t\treturn err\n\t}\n\ttime.Sleep(time.Duration(nsec) * time.Second)\n\th.StopGoTrace()\n\treturn nil\n}\n```", + "externalDocs": { + "description": "line=135", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + }, + { + "name": "nsec", + "summary": "", + "description": "`uint`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "Null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_memStats", + "tags": [], + "summary": "MemStats returns detailed runtime memory statistics.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L73](https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L73)\n```go\n// MemStats returns detailed runtime memory statistics.\nfunc (*HandlerT) MemStats() *runtime.MemStats {\n\ts := new(runtime.MemStats)\n\truntime.ReadMemStats(s)\n\treturn s\n}\n```", + "externalDocs": { + "description": "line=73", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go" + }, + "params": [], + "result": { + "name": "*runtime.MemStats", + "summary": "", + "description": "`runtime.*MemStats`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "Alloc": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "BuckHashSys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "BySize": { + "type": "array", + "maxItems": 61, + "minItems": 61, + "items": { + "type": "object", + "properties": { + "Frees": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Mallocs": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Size": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "DebugGC": { + "type": "boolean" + }, + "EnableGC": { + "type": "boolean" + }, + "Frees": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "GCCPUFraction": { + "type": "number" + }, + "GCSys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "HeapAlloc": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "HeapIdle": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "HeapInuse": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "HeapObjects": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "HeapReleased": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "HeapSys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "LastGC": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Lookups": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "MCacheInuse": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "MCacheSys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "MSpanInuse": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "MSpanSys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Mallocs": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "NextGC": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "NumForcedGC": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "NumGC": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "OtherSys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "PauseEnd": { + "type": "array", + "maxItems": 256, + "minItems": 256, + "items": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "PauseNs": { + "type": "array", + "maxItems": 256, + "minItems": 256, + "items": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "PauseTotalNs": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "StackInuse": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "StackSys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Sys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "TotalAlloc": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_mutexProfile", + "tags": [], + "summary": "MutexProfile turns on mutex profiling for nsec seconds and writes profile data to file.\nIt uses a profile rate of 1 for most accurate information. If a different rate is\ndesired, set the rate and write the profile manually.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L168](https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L168)\n```go\n// MutexProfile turns on mutex profiling for nsec seconds and writes profile data to file.\n// It uses a profile rate of 1 for most accurate information. If a different rate is\n// desired, set the rate and write the profile manually.\nfunc (*HandlerT) MutexProfile(file string, nsec uint) error {\n\truntime.SetMutexProfileFraction(1)\n\ttime.Sleep(time.Duration(nsec) * time.Second)\n\tdefer runtime.SetMutexProfileFraction(0)\n\treturn writeProfile(\"mutex\", file)\n}\n```", + "externalDocs": { + "description": "line=168", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + }, + { + "name": "nsec", + "summary": "", + "description": "`uint`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "Null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_preimage", + "tags": [], + "summary": "Preimage is a debug API function that returns the preimage for a sha3 hash, if known.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L317](https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L317)\n```go\n// Preimage is a debug API function that returns the preimage for a sha3 hash, if known.\nfunc (api *PrivateDebugAPI) Preimage(ctx context.Context, hash common.Hash) (hexutil.Bytes, error) {\n\tif preimage := rawdb.ReadPreimage(api.eth.ChainDb(), hash); preimage != nil {\n\t\treturn preimage, nil\n\t}\n\treturn nil, errors.New(\"unknown preimage\")\n}\n```", + "externalDocs": { + "description": "line=317", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Hash`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "hexutil.Bytes", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.Bytes`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of some bytes", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_printBlock", + "tags": [], + "summary": "PrintBlock retrieves a block and returns its pretty printed form.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1733](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1733)\n```go\n// PrintBlock retrieves a block and returns its pretty printed form.\nfunc (api *PublicDebugAPI) PrintBlock(ctx context.Context, number uint64) (string, error) {\n\tblock, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number))\n\tif block == nil {\n\t\treturn \"\", fmt.Errorf(\"block #%d not found\", number)\n\t}\n\treturn spew.Sdump(block), nil\n}\n```", + "externalDocs": { + "description": "line=1733", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "`uint64`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "string", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_seedHash", + "tags": [], + "summary": "SeedHash retrieves the seed hash of a block.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1742](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1742)\n```go\n// SeedHash retrieves the seed hash of a block.\nfunc (api *PublicDebugAPI) SeedHash(ctx context.Context, number uint64) (string, error) {\n\tblock, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number))\n\tif block == nil {\n\t\treturn \"\", fmt.Errorf(\"block #%d not found\", number)\n\t}\n\treturn fmt.Sprintf(\"0x%x\", ethash.SeedHash(number)), nil\n}\n```", + "externalDocs": { + "description": "line=1742", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "`uint64`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "string", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_setBlockProfileRate", + "tags": [], + "summary": "SetBlockProfileRate sets the rate of goroutine block profile data collection.\nrate 0 disables block profiling.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L156](https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L156)\n```go\n// SetBlockProfileRate sets the rate of goroutine block profile data collection.\n// rate 0 disables block profiling.\nfunc (*HandlerT) SetBlockProfileRate(rate int) {\n\truntime.SetBlockProfileRate(rate)\n}\n```", + "externalDocs": { + "description": "line=156", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go" + }, + "params": [ + { + "name": "rate", + "summary": "", + "description": "`int`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "Null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_setGCPercent", + "tags": [], + "summary": "SetGCPercent sets the garbage collection target percentage. It returns the previous\nsetting. A negative value disables GC.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L206](https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L206)\n```go\n// SetGCPercent sets the garbage collection target percentage. It returns the previous\n// setting. A negative value disables GC.\nfunc (*HandlerT) SetGCPercent(v int) int {\n\treturn debug.SetGCPercent(v)\n}\n```", + "externalDocs": { + "description": "line=206", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go" + }, + "params": [ + { + "name": "v", + "summary": "", + "description": "`int`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "int", + "summary": "", + "description": "`int`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_setHead", + "tags": [], + "summary": "SetHead rewinds the head of the blockchain to a previous block.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1786](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1786)\n```go\n// SetHead rewinds the head of the blockchain to a previous block.\nfunc (api *PrivateDebugAPI) SetHead(number hexutil.Uint64) {\n\tapi.b.SetHead(uint64(number))\n}\n```", + "externalDocs": { + "description": "line=1786", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.Uint64`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a uint64", + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + } + } + ], + "result": { + "name": "Null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_setMutexProfileFraction", + "tags": [], + "summary": "SetMutexProfileFraction sets the rate of mutex profiling.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L177](https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L177)\n```go\n// SetMutexProfileFraction sets the rate of mutex profiling.\nfunc (*HandlerT) SetMutexProfileFraction(rate int) {\n\truntime.SetMutexProfileFraction(rate)\n}\n```", + "externalDocs": { + "description": "line=177", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go" + }, + "params": [ + { + "name": "rate", + "summary": "", + "description": "`int`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "Null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_stacks", + "tags": [], + "summary": "Stacks returns a printed representation of the stacks of all goroutines.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L193](https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L193)\n```go\n// Stacks returns a printed representation of the stacks of all goroutines.\nfunc (*HandlerT) Stacks() string {\n\tbuf := new(bytes.Buffer)\n\tpprof.Lookup(\"goroutine\").WriteTo(buf, 2)\n\treturn buf.String()\n}\n```", + "externalDocs": { + "description": "line=193", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go" + }, + "params": [], + "result": { + "name": "string", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_standardTraceBadBlockToFile", + "tags": [], + "summary": "StandardTraceBadBlockToFile dumps the structured logs created during the\nexecution of EVM against a block pulled from the pool of bad ones to the\nlocal file system and returns a list of files to the caller.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/api_tracer.go#L432](https://github.com/ethereum/go-ethereum/blob/master/eth/api_tracer.go#L432)\n```go\n// StandardTraceBadBlockToFile dumps the structured logs created during the\n// execution of EVM against a block pulled from the pool of bad ones to the\n// local file system and returns a list of files to the caller.\nfunc (api *PrivateDebugAPI) StandardTraceBadBlockToFile(ctx context.Context, hash common.Hash, config *StdTraceConfig) ([]string, error) {\n\tblocks := api.eth.blockchain.BadBlocks()\n\tfor _, block := range blocks {\n\t\tif block.Hash() == hash {\n\t\t\treturn api.standardTraceBlockToFile(ctx, block, config)\n\t\t}\n\t}\n\treturn nil, fmt.Errorf(\"bad block %#x not found\", hash)\n}\n```", + "externalDocs": { + "description": "line=432", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Hash`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "config", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/eth.*StdTraceConfig`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "TxHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "additionalProperties": false + }, + { + "type": "null" + } + ] + } + } + ], + "result": { + "name": "[]string", + "summary": "", + "description": "``", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_standardTraceBlockToFile", + "tags": [], + "summary": "StandardTraceBlockToFile dumps the structured logs created during the\nexecution of EVM to the local file system and returns a list of files\nto the caller.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/api_tracer.go#L421](https://github.com/ethereum/go-ethereum/blob/master/eth/api_tracer.go#L421)\n```go\n// StandardTraceBlockToFile dumps the structured logs created during the\n// execution of EVM to the local file system and returns a list of files\n// to the caller.\nfunc (api *PrivateDebugAPI) StandardTraceBlockToFile(ctx context.Context, hash common.Hash, config *StdTraceConfig) ([]string, error) {\n\tblock := api.eth.blockchain.GetBlockByHash(hash)\n\tif block == nil {\n\t\treturn nil, fmt.Errorf(\"block %#x not found\", hash)\n\t}\n\treturn api.standardTraceBlockToFile(ctx, block, config)\n}\n```", + "externalDocs": { + "description": "line=421", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Hash`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "config", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/eth.*StdTraceConfig`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "TxHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "additionalProperties": false + }, + { + "type": "null" + } + ] + } + } + ], + "result": { + "name": "[]string", + "summary": "", + "description": "``", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_startCPUProfile", + "tags": [], + "summary": "StartCPUProfile turns on CPU profiling, writing to the given file.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L98](https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L98)\n```go\n// StartCPUProfile turns on CPU profiling, writing to the given file.\nfunc (h *HandlerT) StartCPUProfile(file string) error {\n\th.mu.Lock()\n\tdefer h.mu.Unlock()\n\tif h.cpuW != nil {\n\t\treturn errors.New(\"CPU profiling already in progress\")\n\t}\n\tf, err := os.Create(expandHome(file))\n\tif err != nil {\n\t\treturn err\n\t}\n\tif err := pprof.StartCPUProfile(f); err != nil {\n\t\tf.Close()\n\t\treturn err\n\t}\n\th.cpuW = f\n\th.cpuFile = file\n\tlog.Info(\"CPU profiling started\", \"dump\", h.cpuFile)\n\treturn nil\n}\n```", + "externalDocs": { + "description": "line=98", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + } + ], + "result": { + "name": "Null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_startGoTrace", + "tags": [], + "summary": "StartGoTrace turns on tracing, writing to the given file.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/debug/trace.go#L30](https://github.com/ethereum/go-ethereum/blob/master/internal/debug/trace.go#L30)\n```go\n// StartGoTrace turns on tracing, writing to the given file.\nfunc (h *HandlerT) StartGoTrace(file string) error {\n\th.mu.Lock()\n\tdefer h.mu.Unlock()\n\tif h.traceW != nil {\n\t\treturn errors.New(\"trace already in progress\")\n\t}\n\tf, err := os.Create(expandHome(file))\n\tif err != nil {\n\t\treturn err\n\t}\n\tif err := trace.Start(f); err != nil {\n\t\tf.Close()\n\t\treturn err\n\t}\n\th.traceW = f\n\th.traceFile = file\n\tlog.Info(\"Go tracing started\", \"dump\", h.traceFile)\n\treturn nil\n}\n```", + "externalDocs": { + "description": "line=30", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/trace.go" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + } + ], + "result": { + "name": "Null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_stopCPUProfile", + "tags": [], + "summary": "StopCPUProfile stops an ongoing CPU profile.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L119](https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L119)\n```go\n// StopCPUProfile stops an ongoing CPU profile.\nfunc (h *HandlerT) StopCPUProfile() error {\n\th.mu.Lock()\n\tdefer h.mu.Unlock()\n\tpprof.StopCPUProfile()\n\tif h.cpuW == nil {\n\t\treturn errors.New(\"CPU profiling not in progress\")\n\t}\n\tlog.Info(\"Done writing CPU profile\", \"dump\", h.cpuFile)\n\th.cpuW.Close()\n\th.cpuW = nil\n\th.cpuFile = \"\"\n\treturn nil\n}\n```", + "externalDocs": { + "description": "line=119", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go" + }, + "params": [], + "result": { + "name": "Null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_stopGoTrace", + "tags": [], + "summary": "StopTrace stops an ongoing trace.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/debug/trace.go#L51](https://github.com/ethereum/go-ethereum/blob/master/internal/debug/trace.go#L51)\n```go\n// StopTrace stops an ongoing trace.\nfunc (h *HandlerT) StopGoTrace() error {\n\th.mu.Lock()\n\tdefer h.mu.Unlock()\n\ttrace.Stop()\n\tif h.traceW == nil {\n\t\treturn errors.New(\"trace not in progress\")\n\t}\n\tlog.Info(\"Done writing Go trace\", \"dump\", h.traceFile)\n\th.traceW.Close()\n\th.traceW = nil\n\th.traceFile = \"\"\n\treturn nil\n}\n```", + "externalDocs": { + "description": "line=51", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/trace.go" + }, + "params": [], + "result": { + "name": "Null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_storageRangeAt", + "tags": [], + "summary": "StorageRangeAt returns the storage at the given block height and transaction index.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L434](https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L434)\n```go\n// StorageRangeAt returns the storage at the given block height and transaction index.\nfunc (api *PrivateDebugAPI) StorageRangeAt(ctx context.Context, blockHash common.Hash, txIndex int, contractAddress common.Address, keyStart hexutil.Bytes, maxResult int) (StorageRangeResult, error) {\n\t_, _, statedb, err := api.computeTxEnv(blockHash, txIndex, 0)\n\tif err != nil {\n\t\treturn StorageRangeResult{}, err\n\t}\n\tst := statedb.StorageTrie(contractAddress)\n\tif st == nil {\n\t\treturn StorageRangeResult{}, fmt.Errorf(\"account %x doesn't exist\", contractAddress)\n\t}\n\treturn storageRangeAt(st, keyStart, maxResult)\n}\n```", + "externalDocs": { + "description": "line=434", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go" + }, + "params": [ + { + "name": "blockHash", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Hash`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "txIndex", + "summary": "", + "description": "`int`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + { + "name": "contractAddress", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Address`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "keyStart", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.Bytes`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of some bytes", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + { + "type": "null" + } + ] + } + }, + { + "name": "maxResult", + "summary": "", + "description": "`int`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "StorageRangeResult", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/eth.StorageRangeResult`", + "required": true, + "deprecated": false, + "schema": { + "type": "object", + "properties": { + "nextKey": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "storage": { + "type": "object", + "patternProperties": { + ".*": { + "type": "object", + "properties": { + "key": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "additionalProperties": false + } + } + } + }, + "additionalProperties": false + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_testSignCliqueBlock", + "tags": [], + "summary": "TestSignCliqueBlock fetches the given block number, and attempts to sign it as a clique header with the\ngiven address, returning the address of the recovered signature\n\nThis is a temporary method to debug the externalsigner integration,\nTODO: Remove this method when the integration is mature\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1698](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1698)\n```go\n// TestSignCliqueBlock fetches the given block number, and attempts to sign it as a clique header with the\n// given address, returning the address of the recovered signature\n//\n// This is a temporary method to debug the externalsigner integration,\n// TODO: Remove this method when the integration is mature\nfunc (api *PublicDebugAPI) TestSignCliqueBlock(ctx context.Context, address common.Address, number uint64) (common.Address, error) {\n\tblock, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number))\n\tif block == nil {\n\t\treturn common.Address{}, fmt.Errorf(\"block #%d not found\", number)\n\t}\n\theader := block.Header()\n\theader.Extra = make([]byte, 32+65)\n\tencoded := clique.CliqueRLP(header)\n\n\taccount := accounts.Account{Address: address}\n\twallet, err := api.b.AccountManager().Find(account)\n\tif err != nil {\n\t\treturn common.Address{}, err\n\t}\n\n\tsignature, err := wallet.SignData(account, accounts.MimetypeClique, encoded)\n\tif err != nil {\n\t\treturn common.Address{}, err\n\t}\n\tsealHash := clique.SealHash(header).Bytes()\n\tlog.Info(\"test signing of clique block\",\n\t\t\"Sealhash\", fmt.Sprintf(\"%x\", sealHash),\n\t\t\"signature\", fmt.Sprintf(\"%x\", signature))\n\tpubkey, err := crypto.Ecrecover(sealHash, signature)\n\tif err != nil {\n\t\treturn common.Address{}, err\n\t}\n\tvar signer common.Address\n\tcopy(signer[:], crypto.Keccak256(pubkey[1:])[12:])\n\n\treturn signer, nil\n}\n```", + "externalDocs": { + "description": "line=1698", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "address", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Address`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "number", + "summary": "", + "description": "`uint64`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "common.Address", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Address`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceBadBlock", + "tags": [], + "summary": "TraceBadBlockByHash returns the structured logs created during the execution of\nEVM against a block pulled from the pool of bad ones and returns them as a JSON\nobject.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/api_tracer.go#L408](https://github.com/ethereum/go-ethereum/blob/master/eth/api_tracer.go#L408)\n```go\n// TraceBadBlockByHash returns the structured logs created during the execution of\n// EVM against a block pulled from the pool of bad ones and returns them as a JSON\n// object.\nfunc (api *PrivateDebugAPI) TraceBadBlock(ctx context.Context, hash common.Hash, config *TraceConfig) ([]*txTraceResult, error) {\n\tblocks := api.eth.blockchain.BadBlocks()\n\tfor _, block := range blocks {\n\t\tif block.Hash() == hash {\n\t\t\treturn api.traceBlock(ctx, block, config)\n\t\t}\n\t}\n\treturn nil, fmt.Errorf(\"bad block %#x not found\", hash)\n}\n```", + "externalDocs": { + "description": "line=408", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Hash`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "config", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/eth.*TraceConfig`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Timeout": { + "type": "string" + }, + "Tracer": { + "type": "string" + } + }, + "additionalProperties": false + }, + { + "type": "null" + } + ] + } + } + ], + "result": { + "name": "[]*txTraceResult", + "summary": "", + "description": "``", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "object", + "properties": { + "error": { + "type": "string" + }, + "result": { + "additionalProperties": true + } + }, + "additionalProperties": false + } + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceBlock", + "tags": [], + "summary": "TraceBlock returns the structured logs created during the execution of EVM\nand returns them as a JSON object.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/api_tracer.go#L387](https://github.com/ethereum/go-ethereum/blob/master/eth/api_tracer.go#L387)\n```go\n// TraceBlock returns the structured logs created during the execution of EVM\n// and returns them as a JSON object.\nfunc (api *PrivateDebugAPI) TraceBlock(ctx context.Context, blob []byte, config *TraceConfig) ([]*txTraceResult, error) {\n\tblock := new(types.Block)\n\tif err := rlp.Decode(bytes.NewReader(blob), block); err != nil {\n\t\treturn nil, fmt.Errorf(\"could not decode block: %v\", err)\n\t}\n\treturn api.traceBlock(ctx, block, config)\n}\n```", + "externalDocs": { + "description": "line=387", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go" + }, + "params": [ + { + "name": "blob", + "summary": "", + "description": "``", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of a variable length byte array", + "type": "string", + "title": "bytes", + "pattern": "^0x([a-fA-F0-9]?)+$" + }, + { + "type": "null" + } + ] + } + }, + { + "name": "config", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/eth.*TraceConfig`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Timeout": { + "type": "string" + }, + "Tracer": { + "type": "string" + } + }, + "additionalProperties": false + }, + { + "type": "null" + } + ] + } + } + ], + "result": { + "name": "[]*txTraceResult", + "summary": "", + "description": "``", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "object", + "properties": { + "error": { + "type": "string" + }, + "result": { + "additionalProperties": true + } + }, + "additionalProperties": false + } + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceBlockByHash", + "tags": [], + "summary": "TraceBlockByHash returns the structured logs created during the execution of\nEVM and returns them as a JSON object.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/api_tracer.go#L377](https://github.com/ethereum/go-ethereum/blob/master/eth/api_tracer.go#L377)\n```go\n// TraceBlockByHash returns the structured logs created during the execution of\n// EVM and returns them as a JSON object.\nfunc (api *PrivateDebugAPI) TraceBlockByHash(ctx context.Context, hash common.Hash, config *TraceConfig) ([]*txTraceResult, error) {\n\tblock := api.eth.blockchain.GetBlockByHash(hash)\n\tif block == nil {\n\t\treturn nil, fmt.Errorf(\"block %#x not found\", hash)\n\t}\n\treturn api.traceBlock(ctx, block, config)\n}\n```", + "externalDocs": { + "description": "line=377", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Hash`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "config", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/eth.*TraceConfig`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Timeout": { + "type": "string" + }, + "Tracer": { + "type": "string" + } + }, + "additionalProperties": false + }, + { + "type": "null" + } + ] + } + } + ], + "result": { + "name": "[]*txTraceResult", + "summary": "", + "description": "``", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "object", + "properties": { + "error": { + "type": "string" + }, + "result": { + "additionalProperties": true + } + }, + "additionalProperties": false + } + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceBlockByNumber", + "tags": [], + "summary": "TraceBlockByNumber returns the structured logs created during the execution of\nEVM and returns them as a JSON object.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/api_tracer.go#L356](https://github.com/ethereum/go-ethereum/blob/master/eth/api_tracer.go#L356)\n```go\n// TraceBlockByNumber returns the structured logs created during the execution of\n// EVM and returns them as a JSON object.\nfunc (api *PrivateDebugAPI) TraceBlockByNumber(ctx context.Context, number rpc.BlockNumber, config *TraceConfig) ([]*txTraceResult, error) {\n\t// Fetch the block that we want to trace\n\tvar block *types.Block\n\n\tswitch number {\n\tcase rpc.PendingBlockNumber:\n\t\tblock = api.eth.miner.PendingBlock()\n\tcase rpc.LatestBlockNumber:\n\t\tblock = api.eth.blockchain.CurrentBlock()\n\tdefault:\n\t\tblock = api.eth.blockchain.GetBlockByNumber(uint64(number))\n\t}\n\n\tif block == nil {\n\t\treturn nil, fmt.Errorf(\"block #%d not found\", number)\n\t}\n\treturn api.traceBlock(ctx, block, config)\n}\n```", + "externalDocs": { + "description": "line=356", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/rpc.BlockNumber`", + "required": true, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc.BlockNumber", + "oneOf": [ + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + }, + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + ] + } + }, + { + "name": "config", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/eth.*TraceConfig`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Timeout": { + "type": "string" + }, + "Tracer": { + "type": "string" + } + }, + "additionalProperties": false + }, + { + "type": "null" + } + ] + } + } + ], + "result": { + "name": "[]*txTraceResult", + "summary": "", + "description": "``", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "object", + "properties": { + "error": { + "type": "string" + }, + "result": { + "additionalProperties": true + } + }, + "additionalProperties": false + } + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceBlockFromFile", + "tags": [], + "summary": "TraceBlockFromFile returns the structured logs created during the execution of\nEVM and returns them as a JSON object.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/api_tracer.go#L397](https://github.com/ethereum/go-ethereum/blob/master/eth/api_tracer.go#L397)\n```go\n// TraceBlockFromFile returns the structured logs created during the execution of\n// EVM and returns them as a JSON object.\nfunc (api *PrivateDebugAPI) TraceBlockFromFile(ctx context.Context, file string, config *TraceConfig) ([]*txTraceResult, error) {\n\tblob, err := ioutil.ReadFile(file)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"could not read file: %v\", err)\n\t}\n\treturn api.TraceBlock(ctx, blob, config)\n}\n```", + "externalDocs": { + "description": "line=397", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + }, + { + "name": "config", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/eth.*TraceConfig`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Timeout": { + "type": "string" + }, + "Tracer": { + "type": "string" + } + }, + "additionalProperties": false + }, + { + "type": "null" + } + ] + } + } + ], + "result": { + "name": "[]*txTraceResult", + "summary": "", + "description": "``", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "object", + "properties": { + "error": { + "type": "string" + }, + "result": { + "additionalProperties": true + } + }, + "additionalProperties": false + } + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceChain", + "tags": [], + "summary": "TraceChain returns the structured logs created during the execution of EVM\nbetween two blocks (excluding start) and returns them as a JSON object.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/api_tracer.go#L105](https://github.com/ethereum/go-ethereum/blob/master/eth/api_tracer.go#L105)\n```go\n// TraceChain returns the structured logs created during the execution of EVM\n// between two blocks (excluding start) and returns them as a JSON object.\nfunc (api *PrivateDebugAPI) TraceChain(ctx context.Context, start, end rpc.BlockNumber, config *TraceConfig) (*rpc.Subscription, error) {\n\t// Fetch the block interval that we want to trace\n\tvar from, to *types.Block\n\n\tswitch start {\n\tcase rpc.PendingBlockNumber:\n\t\tfrom = api.eth.miner.PendingBlock()\n\tcase rpc.LatestBlockNumber:\n\t\tfrom = api.eth.blockchain.CurrentBlock()\n\tdefault:\n\t\tfrom = api.eth.blockchain.GetBlockByNumber(uint64(start))\n\t}\n\tswitch end {\n\tcase rpc.PendingBlockNumber:\n\t\tto = api.eth.miner.PendingBlock()\n\tcase rpc.LatestBlockNumber:\n\t\tto = api.eth.blockchain.CurrentBlock()\n\tdefault:\n\t\tto = api.eth.blockchain.GetBlockByNumber(uint64(end))\n\t}\n\n\tif from == nil {\n\t\treturn nil, fmt.Errorf(\"starting block #%d not found\", start)\n\t}\n\tif to == nil {\n\t\treturn nil, fmt.Errorf(\"end block #%d not found\", end)\n\t}\n\tif from.Number().Cmp(to.Number()) \u003e= 0 {\n\t\treturn nil, fmt.Errorf(\"end block (#%d) needs to come after start block (#%d)\", end, start)\n\t}\n\treturn api.traceChain(ctx, from, to, config)\n}\n```", + "externalDocs": { + "description": "line=105", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go" + }, + "params": [ + { + "name": "start", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/rpc.BlockNumber`", + "required": true, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc.BlockNumber", + "oneOf": [ + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + }, + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + ] + } + }, + { + "name": "end", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/rpc.BlockNumber`", + "required": true, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc.BlockNumber", + "oneOf": [ + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + }, + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + ] + } + }, + { + "name": "config", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/eth.*TraceConfig`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Timeout": { + "type": "string" + }, + "Tracer": { + "type": "string" + } + }, + "additionalProperties": false + }, + { + "type": "null" + } + ] + } + } + ], + "result": { + "name": "*rpc.Subscription", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/rpc.*Subscription`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "github.com/ethereum/go-ethereum/rpc.*Subscription", + "type": "object", + "title": "Subscription" + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceTransaction", + "tags": [], + "summary": "FIXME: Is this really supposed to return an *ethapi.ExecutionResult type, or the empty interface in case not *vm.StructLogger?\nTraceTransaction returns the structured logs created during the execution of EVM\nand returns them as a JSON object.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/api_tracer.go#L706](https://github.com/ethereum/go-ethereum/blob/master/eth/api_tracer.go#L706)\n```go\n// FIXME: Is this really supposed to return an *ethapi.ExecutionResult type, or the empty interface in case not *vm.StructLogger?\n// TraceTransaction returns the structured logs created during the execution of EVM\n// and returns them as a JSON object.\nfunc (api *PrivateDebugAPI) TraceTransaction(ctx context.Context, hash common.Hash, config *TraceConfig) (*ethapi.ExecutionResult, error) {\n\n\ttx, blockHash, _, index := rawdb.ReadTransaction(api.eth.ChainDb(), hash)\n\tif tx == nil {\n\t\treturn nil, fmt.Errorf(\"transaction %#x not found\", hash)\n\t}\n\treexec := defaultTraceReexec\n\tif config != nil \u0026\u0026 config.Reexec != nil {\n\t\treexec = *config.Reexec\n\t}\n\tmsg, vmctx, statedb, err := api.computeTxEnv(blockHash, int(index), reexec)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn api.traceTx(ctx, msg, vmctx, statedb, config)\n}\n```", + "externalDocs": { + "description": "line=706", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Hash`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "config", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/eth.*TraceConfig`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Timeout": { + "type": "string" + }, + "Tracer": { + "type": "string" + } + }, + "additionalProperties": false + }, + { + "type": "null" + } + ] + } + } + ], + "result": { + "name": "*ethapi.ExecutionResult", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/internal/ethapi.*ExecutionResult`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "failed": { + "type": "boolean" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "returnValue": { + "type": "string" + }, + "structLogs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "depth": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "error": { + "additionalProperties": true + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasCost": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "memory": { + "type": "array", + "items": { + "type": "string" + } + }, + "op": { + "type": "string" + }, + "pc": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "stack": { + "type": "array", + "items": { + "type": "string" + } + }, + "storage": { + "type": "object", + "patternProperties": { + ".*": { + "type": "string" + } + } + } + }, + "additionalProperties": false + } + } + }, + "additionalProperties": false + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_verbosity", + "tags": [], + "summary": "Verbosity sets the log verbosity ceiling. The verbosity of individual packages\nand source files can be raised using Vmodule.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L57](https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L57)\n```go\n// Verbosity sets the log verbosity ceiling. The verbosity of individual packages\n// and source files can be raised using Vmodule.\nfunc (*HandlerT) Verbosity(level int) {\n\tglogger.Verbosity(log.Lvl(level))\n}\n```", + "externalDocs": { + "description": "line=57", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go" + }, + "params": [ + { + "name": "level", + "summary": "", + "description": "`int`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "Null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_vmodule", + "tags": [], + "summary": "Vmodule sets the log verbosity pattern. See package log for details on the\npattern syntax.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L62](https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L62)\n```go\n// Vmodule sets the log verbosity pattern. See package log for details on the\n// pattern syntax.\nfunc (*HandlerT) Vmodule(pattern string) error {\n\treturn glogger.Vmodule(pattern)\n}\n```", + "externalDocs": { + "description": "line=62", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go" + }, + "params": [ + { + "name": "pattern", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + } + ], + "result": { + "name": "Null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_writeBlockProfile", + "tags": [], + "summary": "WriteBlockProfile writes a goroutine blocking profile to the given file.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L161](https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L161)\n```go\n// WriteBlockProfile writes a goroutine blocking profile to the given file.\nfunc (*HandlerT) WriteBlockProfile(file string) error {\n\treturn writeProfile(\"block\", file)\n}\n```", + "externalDocs": { + "description": "line=161", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + } + ], + "result": { + "name": "Null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_writeMemProfile", + "tags": [], + "summary": "WriteMemProfile writes an allocation profile to the given file.\nNote that the profiling rate cannot be set through the API,\nit must be set on the command line.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L188](https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L188)\n```go\n// WriteMemProfile writes an allocation profile to the given file.\n// Note that the profiling rate cannot be set through the API,\n// it must be set on the command line.\nfunc (*HandlerT) WriteMemProfile(file string) error {\n\treturn writeProfile(\"heap\", file)\n}\n```", + "externalDocs": { + "description": "line=188", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + } + ], + "result": { + "name": "Null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_writeMutexProfile", + "tags": [], + "summary": "WriteMutexProfile writes a goroutine blocking profile to the given file.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L181](https://github.com/ethereum/go-ethereum/blob/master/internal/debug/api.go#L181)\n```go\n// WriteMutexProfile writes a goroutine blocking profile to the given file.\nfunc (*HandlerT) WriteMutexProfile(file string) error {\n\treturn writeProfile(\"mutex\", file)\n}\n```", + "externalDocs": { + "description": "line=181", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + } + ], + "result": { + "name": "Null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_accounts", + "tags": [], + "summary": "Accounts returns the collection of accounts this node manages\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L220](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L220)\n```go\n// Accounts returns the collection of accounts this node manages\nfunc (s *PublicAccountAPI) Accounts() []common.Address {\n\treturn s.am.Accounts()\n}\n```", + "externalDocs": { + "description": "line=220", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [], + "result": { + "name": "[]common.Address", + "summary": "", + "description": "``", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "array", + "items": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_blockNumber", + "tags": [], + "summary": "BlockNumber returns the block number of the chain head.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L552](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L552)\n```go\n// BlockNumber returns the block number of the chain head.\nfunc (s *PublicBlockChainAPI) BlockNumber() hexutil.Uint64 {\n\theader, _ := s.b.HeaderByNumber(context.Background(), rpc.LatestBlockNumber)\n\treturn hexutil.Uint64(header.Number.Uint64())\n}\n```", + "externalDocs": { + "description": "line=552", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [], + "result": { + "name": "hexutil.Uint64", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.Uint64`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a uint64", + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_call", + "tags": [], + "summary": "Call executes the given transaction on the state for the given block number.\n\nAdditionally, the caller can specify a batch of contract for fields overriding.\n\nNote, this function doesn't make and changes in the state/blockchain and is\nuseful to execute and retrieve values.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L900](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L900)\n```go\n// Call executes the given transaction on the state for the given block number.\n//\n// Additionally, the caller can specify a batch of contract for fields overriding.\n//\n// Note, this function doesn't make and changes in the state/blockchain and is\n// useful to execute and retrieve values.\nfunc (s *PublicBlockChainAPI) Call(ctx context.Context, args CallArgs, blockNrOrHash rpc.BlockNumberOrHash, overrides *map[common.Address]account) (hexutil.Bytes, error) {\n\tvar accounts map[common.Address]account\n\tif overrides != nil {\n\t\taccounts = *overrides\n\t}\n\tresult, _, _, err := DoCall(ctx, s.b, args, blockNrOrHash, accounts, vm.Config{}, 5*time.Second, s.b.RPCGasCap())\n\treturn (hexutil.Bytes)(result), err\n}\n```", + "externalDocs": { + "description": "line=900", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/internal/ethapi.CallArgs`", + "required": true, + "deprecated": false, + "schema": { + "type": "object", + "properties": { + "data": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "from": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "gas": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + { + "name": "blockNrOrHash", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/rpc.BlockNumberOrHash`", + "required": true, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc.BlockNumberOrHash", + "title": "blockNumberOrHash", + "oneOf": [ + { + "oneOf": [ + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + }, + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + ] + }, + { + "allOf": [ + { + "oneOf": [ + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + }, + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + ] + }, + { + "type": "object", + "required": ["requireCanonical"], + "properties": { + "requireCanonical": { + "type": "boolean" + } + }, + "additionalProperties": false + } + ] + } + ] + } + }, + { + "name": "overrides", + "summary": "", + "description": "`*`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "*", + "type": "object", + "patternProperties": { + ".*": { + "type": "object", + "properties": { + "balance": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "code": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "nonce": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "state": { + "type": "object", + "patternProperties": { + ".*": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + }, + "stateDiff": { + "type": "object", + "patternProperties": { + ".*": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + } + }, + "additionalProperties": false + } + } + }, + { + "type": "null" + } + ] + } + } + ], + "result": { + "name": "hexutil.Bytes", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.Bytes`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of some bytes", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_chainId", + "tags": [], + "summary": "ChainId is the EIP-155 replay-protection chain id for the current ethereum chain config.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L70](https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L70)\n```go\n// ChainId is the EIP-155 replay-protection chain id for the current ethereum chain config.\nfunc (api *PublicEthereumAPI) ChainId() hexutil.Uint64 {\n\tchainID := new(big.Int)\n\tif config := api.e.blockchain.Config(); config.IsEnabled(config.GetEIP155Transition, api.e.blockchain.CurrentBlock().Number()) {\n\t\tchainID = config.GetChainID()\n\t}\n\treturn (hexutil.Uint64)(chainID.Uint64())\n}\n```", + "externalDocs": { + "description": "line=70", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go" + }, + "params": [], + "result": { + "name": "hexutil.Uint64", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.Uint64`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a uint64", + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_chainId", + "tags": [], + "summary": "ChainId returns the chainID value for transaction replay protection.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L547](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L547)\n```go\n// ChainId returns the chainID value for transaction replay protection.\nfunc (s *PublicBlockChainAPI) ChainId() *hexutil.Big {\n\treturn (*hexutil.Big)(s.b.ChainConfig().GetChainID())\n}\n```", + "externalDocs": { + "description": "line=547", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [], + "result": { + "name": "*hexutil.Big", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.*Big`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_coinbase", + "tags": [], + "summary": "Coinbase is the address that mining rewards will be send to (alias for Etherbase)\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L60](https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L60)\n```go\n// Coinbase is the address that mining rewards will be send to (alias for Etherbase)\nfunc (api *PublicEthereumAPI) Coinbase() (common.Address, error) {\n\treturn api.Etherbase()\n}\n```", + "externalDocs": { + "description": "line=60", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go" + }, + "params": [], + "result": { + "name": "common.Address", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Address`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_estimateGas", + "tags": [], + "summary": "EstimateGas returns an estimate of the amount of gas needed to execute the\ngiven transaction against the current pending block.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L966](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L966)\n```go\n// EstimateGas returns an estimate of the amount of gas needed to execute the\n// given transaction against the current pending block.\nfunc (s *PublicBlockChainAPI) EstimateGas(ctx context.Context, args CallArgs) (hexutil.Uint64, error) {\n\tblockNrOrHash := rpc.BlockNumberOrHashWithNumber(rpc.PendingBlockNumber)\n\treturn DoEstimateGas(ctx, s.b, args, blockNrOrHash, s.b.RPCGasCap())\n}\n```", + "externalDocs": { + "description": "line=966", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/internal/ethapi.CallArgs`", + "required": true, + "deprecated": false, + "schema": { + "type": "object", + "properties": { + "data": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "from": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "gas": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + } + ], + "result": { + "name": "hexutil.Uint64", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.Uint64`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a uint64", + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_etherbase", + "tags": [], + "summary": "Etherbase is the address that mining rewards will be send to\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L55](https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L55)\n```go\n// Etherbase is the address that mining rewards will be send to\nfunc (api *PublicEthereumAPI) Etherbase() (common.Address, error) {\n\treturn api.e.Etherbase()\n}\n```", + "externalDocs": { + "description": "line=55", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go" + }, + "params": [], + "result": { + "name": "common.Address", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Address`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_fillTransaction", + "tags": [], + "summary": "FillTransaction fills the defaults (nonce, gas, gasPrice) on a given unsigned transaction,\nand returns it to the caller for further processing (signing + broadcast)\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1515](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1515)\n```go\n// FillTransaction fills the defaults (nonce, gas, gasPrice) on a given unsigned transaction,\n// and returns it to the caller for further processing (signing + broadcast)\nfunc (s *PublicTransactionPoolAPI) FillTransaction(ctx context.Context, args SendTxArgs) (*SignTransactionResult, error) {\n\n\tif err := args.setDefaults(ctx, s.b); err != nil {\n\t\treturn nil, err\n\t}\n\n\ttx := args.toTransaction()\n\tdata, err := rlp.EncodeToBytes(tx)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\treturn \u0026SignTransactionResult{data, tx}, nil\n}\n```", + "externalDocs": { + "description": "line=1515", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/internal/ethapi.SendTxArgs`", + "required": true, + "deprecated": false, + "schema": { + "type": "object", + "properties": { + "data": { + "description": "Field 'input' should be preferred", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "from": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "gas": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "nonce": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + } + ], + "result": { + "name": "*SignTransactionResult", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/internal/ethapi.*SignTransactionResult`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "raw": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "tx": { + "type": "object", + "additionalProperties": false + } + }, + "additionalProperties": false + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_gasPrice", + "tags": [], + "summary": "GasPrice returns a suggestion for a gas price.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L67](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L67)\n```go\n// GasPrice returns a suggestion for a gas price.\nfunc (s *PublicEthereumAPI) GasPrice(ctx context.Context) (*hexutil.Big, error) {\n\tprice, err := s.b.SuggestPrice(ctx)\n\treturn (*hexutil.Big)(price), err\n}\n```", + "externalDocs": { + "description": "line=67", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [], + "result": { + "name": "*hexutil.Big", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.*Big`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getBalance", + "tags": [], + "summary": "GetBalance returns the amount of wei for the given address in the state of the\ngiven block number. The rpc.LatestBlockNumber and rpc.PendingBlockNumber meta\nblock numbers are also allowed.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L560](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L560)\n```go\n// GetBalance returns the amount of wei for the given address in the state of the\n// given block number. The rpc.LatestBlockNumber and rpc.PendingBlockNumber meta\n// block numbers are also allowed.\nfunc (s *PublicBlockChainAPI) GetBalance(ctx context.Context, address common.Address, blockNrOrHash rpc.BlockNumberOrHash) (*hexutil.Big, error) {\n\tstate, _, err := s.b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash)\n\tif state == nil || err != nil {\n\t\treturn nil, err\n\t}\n\treturn (*hexutil.Big)(state.GetBalance(address)), state.Error()\n}\n```", + "externalDocs": { + "description": "line=560", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "address", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Address`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "blockNrOrHash", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/rpc.BlockNumberOrHash`", + "required": true, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc.BlockNumberOrHash", + "title": "blockNumberOrHash", + "oneOf": [ + { + "oneOf": [ + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + }, + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + ] + }, + { + "allOf": [ + { + "oneOf": [ + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + }, + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + ] + }, + { + "type": "object", + "required": ["requireCanonical"], + "properties": { + "requireCanonical": { + "type": "boolean" + } + }, + "additionalProperties": false + } + ] + } + ] + } + } + ], + "result": { + "name": "*hexutil.Big", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.*Big`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getBlockByHash", + "tags": [], + "summary": "GetBlockByHash returns the requested block. When fullTx is true all transactions in the block are returned in full\ndetail, otherwise only the transaction hash is returned.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L683](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L683)\n```go\n// GetBlockByHash returns the requested block. When fullTx is true all transactions in the block are returned in full\n// detail, otherwise only the transaction hash is returned.\nfunc (s *PublicBlockChainAPI) GetBlockByHash(ctx context.Context, hash common.Hash, fullTx bool) (map[string]interface{}, error) {\n\tblock, err := s.b.BlockByHash(ctx, hash)\n\tif block != nil {\n\t\treturn s.rpcMarshalBlock(block, true, fullTx)\n\t}\n\treturn nil, err\n}\n```", + "externalDocs": { + "description": "line=683", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Hash`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "fullTx", + "summary": "", + "description": "`bool`", + "required": true, + "deprecated": false, + "schema": { + "description": "bool", + "type": "boolean" + } + } + ], + "result": { + "name": "map[string]interface{}", + "summary": "", + "description": "``", + "required": true, + "deprecated": false, + "schema": { + "type": "object", + "patternProperties": { + ".*": { + "additionalProperties": true + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getBlockByNumber", + "tags": [], + "summary": "GetBlockByNumber returns the requested canonical block.\n* When blockNr is -1 the chain head is returned.\n* When blockNr is -2 the pending chain head is returned.\n* When fullTx is true all transactions in the block are returned, otherwise\n only the transaction hash is returned.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L666](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L666)\n```go\n// GetBlockByNumber returns the requested canonical block.\n// * When blockNr is -1 the chain head is returned.\n// * When blockNr is -2 the pending chain head is returned.\n// * When fullTx is true all transactions in the block are returned, otherwise\n// only the transaction hash is returned.\nfunc (s *PublicBlockChainAPI) GetBlockByNumber(ctx context.Context, number rpc.BlockNumber, fullTx bool) (map[string]interface{}, error) {\n\tblock, err := s.b.BlockByNumber(ctx, number)\n\tif block != nil \u0026\u0026 err == nil {\n\t\tresponse, err := s.rpcMarshalBlock(block, true, fullTx)\n\t\tif err == nil \u0026\u0026 number == rpc.PendingBlockNumber {\n\n\t\t\tfor _, field := range []string{\"hash\", \"nonce\", \"miner\"} {\n\t\t\t\tresponse[field] = nil\n\t\t\t}\n\t\t}\n\t\treturn response, err\n\t}\n\treturn nil, err\n}\n```", + "externalDocs": { + "description": "line=666", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/rpc.BlockNumber`", + "required": true, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc.BlockNumber", + "oneOf": [ + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + }, + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + ] + } + }, + { + "name": "fullTx", + "summary": "", + "description": "`bool`", + "required": true, + "deprecated": false, + "schema": { + "description": "bool", + "type": "boolean" + } + } + ], + "result": { + "name": "map[string]interface{}", + "summary": "", + "description": "``", + "required": true, + "deprecated": false, + "schema": { + "type": "object", + "patternProperties": { + ".*": { + "additionalProperties": true + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getBlockTransactionCountByHash", + "tags": [], + "summary": "GetBlockTransactionCountByHash returns the number of transactions in the block with the given hash.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1216](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1216)\n```go\n// GetBlockTransactionCountByHash returns the number of transactions in the block with the given hash.\nfunc (s *PublicTransactionPoolAPI) GetBlockTransactionCountByHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint {\n\tif block, _ := s.b.BlockByHash(ctx, blockHash); block != nil {\n\t\tn := hexutil.Uint(len(block.Transactions()))\n\t\treturn \u0026n\n\t}\n\treturn nil\n}\n```", + "externalDocs": { + "description": "line=1216", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "blockHash", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Hash`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "*hexutil.Uint", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.*Uint`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of a uint", + "type": "string", + "title": "uint", + "pattern": "^0x([a-fA-F\\d])+$" + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getBlockTransactionCountByNumber", + "tags": [], + "summary": "GetBlockTransactionCountByNumber returns the number of transactions in the block with the given block number.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1207](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1207)\n```go\n// GetBlockTransactionCountByNumber returns the number of transactions in the block with the given block number.\nfunc (s *PublicTransactionPoolAPI) GetBlockTransactionCountByNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint {\n\tif block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {\n\t\tn := hexutil.Uint(len(block.Transactions()))\n\t\treturn \u0026n\n\t}\n\treturn nil\n}\n```", + "externalDocs": { + "description": "line=1207", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "blockNr", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/rpc.BlockNumber`", + "required": true, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc.BlockNumber", + "oneOf": [ + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + }, + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + ] + } + } + ], + "result": { + "name": "*hexutil.Uint", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.*Uint`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of a uint", + "type": "string", + "title": "uint", + "pattern": "^0x([a-fA-F\\d])+$" + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getCode", + "tags": [], + "summary": "GetCode returns the code stored at the given address in the state for the given block number.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L742](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L742)\n```go\n// GetCode returns the code stored at the given address in the state for the given block number.\nfunc (s *PublicBlockChainAPI) GetCode(ctx context.Context, address common.Address, blockNrOrHash rpc.BlockNumberOrHash) (hexutil.Bytes, error) {\n\tstate, _, err := s.b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash)\n\tif state == nil || err != nil {\n\t\treturn nil, err\n\t}\n\tcode := state.GetCode(address)\n\treturn code, state.Error()\n}\n```", + "externalDocs": { + "description": "line=742", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "address", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Address`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "blockNrOrHash", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/rpc.BlockNumberOrHash`", + "required": true, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc.BlockNumberOrHash", + "title": "blockNumberOrHash", + "oneOf": [ + { + "oneOf": [ + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + }, + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + ] + }, + { + "allOf": [ + { + "oneOf": [ + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + }, + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + ] + }, + { + "type": "object", + "required": ["requireCanonical"], + "properties": { + "requireCanonical": { + "type": "boolean" + } + }, + "additionalProperties": false + } + ] + } + ] + } + } + ], + "result": { + "name": "hexutil.Bytes", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.Bytes`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of some bytes", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getFilterChanges", + "tags": [], + "summary": "GetFilterChanges returns the logs for the filter with the given id since\nlast time it was called. This can be used for polling.\n\nFor pending transaction and block filters the result is []common.Hash.\n(pending)Log filters return []Log.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_getfilterchanges\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/filters/api.go#L413](https://github.com/ethereum/go-ethereum/blob/master/eth/filters/api.go#L413)\n```go\n// GetFilterChanges returns the logs for the filter with the given id since\n// last time it was called. This can be used for polling.\n//\n// For pending transaction and block filters the result is []common.Hash.\n// (pending)Log filters return []Log.\n//\n// https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_getfilterchanges\nfunc (api *PublicFilterAPI) GetFilterChanges(id rpc.ID) (interface{}, error) {\n\tapi.filtersMu.Lock()\n\tdefer api.filtersMu.Unlock()\n\n\tif f, found := api.filters[id]; found {\n\t\tif !f.deadline.Stop() {\n\n\t\t\t\u003c-f.deadline.C\n\t\t}\n\t\tf.deadline.Reset(deadline)\n\n\t\tswitch f.typ {\n\t\tcase PendingTransactionsSubscription, BlocksSubscription:\n\t\t\thashes := f.hashes\n\t\t\tf.hashes = nil\n\t\t\treturn returnHashes(hashes), nil\n\t\tcase LogsSubscription, MinedAndPendingLogsSubscription:\n\t\t\tlogs := f.logs\n\t\t\tf.logs = nil\n\t\t\treturn returnLogs(logs), nil\n\t\t}\n\t}\n\n\treturn []interface{}{}, fmt.Errorf(\"filter not found\")\n}\n```", + "externalDocs": { + "description": "line=413", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go" + }, + "params": [ + { + "name": "id", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/rpc.ID`", + "required": true, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc.ID", + "type": "string" + } + } + ], + "result": { + "name": "interface{}", + "summary": "", + "description": "``", + "required": true, + "deprecated": false, + "schema": { + "additionalProperties": true + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getFilterLogs", + "tags": [], + "summary": "GetFilterLogs returns the logs for the filter with the given id.\nIf the filter could not be found an empty array of logs is returned.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_getfilterlogs\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/filters/api.go#L372](https://github.com/ethereum/go-ethereum/blob/master/eth/filters/api.go#L372)\n```go\n// GetFilterLogs returns the logs for the filter with the given id.\n// If the filter could not be found an empty array of logs is returned.\n//\n// https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_getfilterlogs\nfunc (api *PublicFilterAPI) GetFilterLogs(ctx context.Context, id rpc.ID) ([]*types.Log, error) {\n\tapi.filtersMu.Lock()\n\tf, found := api.filters[id]\n\tapi.filtersMu.Unlock()\n\n\tif !found || f.typ != LogsSubscription {\n\t\treturn nil, fmt.Errorf(\"filter not found\")\n\t}\n\n\tvar filter *Filter\n\tif f.crit.BlockHash != nil {\n\n\t\tfilter = NewBlockFilter(api.backend, *f.crit.BlockHash, f.crit.Addresses, f.crit.Topics)\n\t} else {\n\n\t\tbegin := rpc.LatestBlockNumber.Int64()\n\t\tif f.crit.FromBlock != nil {\n\t\t\tbegin = f.crit.FromBlock.Int64()\n\t\t}\n\t\tend := rpc.LatestBlockNumber.Int64()\n\t\tif f.crit.ToBlock != nil {\n\t\t\tend = f.crit.ToBlock.Int64()\n\t\t}\n\n\t\tfilter = NewRangeFilter(api.backend, begin, end, f.crit.Addresses, f.crit.Topics)\n\t}\n\n\tlogs, err := filter.Logs(ctx)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\treturn returnLogs(logs), nil\n}\n```", + "externalDocs": { + "description": "line=372", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go" + }, + "params": [ + { + "name": "id", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/rpc.ID`", + "required": true, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc.ID", + "type": "string" + } + } + ], + "result": { + "name": "[]*types.Log", + "summary": "", + "description": "``", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "object", + "properties": { + "address": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "blockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "blockNumber": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "data": { + "type": "string", + "title": "bytes", + "pattern": "^0x([a-fA-F0-9]?)+$" + }, + "logIndex": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "removed": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "transactionHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "transactionIndex": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getHashrate", + "tags": [], + "summary": "GetHashrate returns the current hashrate for local CPU miner and remote miner.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/consensus/ethash/api.go#L110](https://github.com/ethereum/go-ethereum/blob/master/consensus/ethash/api.go#L110)\n```go\n// GetHashrate returns the current hashrate for local CPU miner and remote miner.\nfunc (api *API) GetHashrate() uint64 {\n\treturn uint64(api.ethash.Hashrate())\n}\n```", + "externalDocs": { + "description": "line=110", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go" + }, + "params": [], + "result": { + "name": "uint64", + "summary": "", + "description": "`uint64`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getHeaderByHash", + "tags": [], + "summary": "GetHeaderByHash returns the requested header by hash.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L653](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L653)\n```go\n// GetHeaderByHash returns the requested header by hash.\nfunc (s *PublicBlockChainAPI) GetHeaderByHash(ctx context.Context, hash common.Hash) map[string]interface{} {\n\theader, _ := s.b.HeaderByHash(ctx, hash)\n\tif header != nil {\n\t\treturn s.rpcMarshalHeader(header)\n\t}\n\treturn nil\n}\n```", + "externalDocs": { + "description": "line=653", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Hash`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "map[string]interface{}", + "summary": "", + "description": "``", + "required": true, + "deprecated": false, + "schema": { + "type": "object", + "patternProperties": { + ".*": { + "additionalProperties": true + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getHeaderByNumber", + "tags": [], + "summary": "GetHeaderByNumber returns the requested canonical block header.\n* When blockNr is -1 the chain head is returned.\n* When blockNr is -2 the pending chain head is returned.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L637](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L637)\n```go\n// GetHeaderByNumber returns the requested canonical block header.\n// * When blockNr is -1 the chain head is returned.\n// * When blockNr is -2 the pending chain head is returned.\nfunc (s *PublicBlockChainAPI) GetHeaderByNumber(ctx context.Context, number rpc.BlockNumber) (map[string]interface{}, error) {\n\theader, err := s.b.HeaderByNumber(ctx, number)\n\tif header != nil \u0026\u0026 err == nil {\n\t\tresponse := s.rpcMarshalHeader(header)\n\t\tif number == rpc.PendingBlockNumber {\n\n\t\t\tfor _, field := range []string{\"hash\", \"nonce\", \"miner\"} {\n\t\t\t\tresponse[field] = nil\n\t\t\t}\n\t\t}\n\t\treturn response, err\n\t}\n\treturn nil, err\n}\n```", + "externalDocs": { + "description": "line=637", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/rpc.BlockNumber`", + "required": true, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc.BlockNumber", + "oneOf": [ + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + }, + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + ] + } + } + ], + "result": { + "name": "map[string]interface{}", + "summary": "", + "description": "``", + "required": true, + "deprecated": false, + "schema": { + "type": "object", + "patternProperties": { + ".*": { + "additionalProperties": true + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getLogs", + "tags": [], + "summary": "GetLogs returns logs matching the given argument that are stored within the state.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_getlogs\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/filters/api.go#L325](https://github.com/ethereum/go-ethereum/blob/master/eth/filters/api.go#L325)\n```go\n// GetLogs returns logs matching the given argument that are stored within the state.\n//\n// https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_getlogs\nfunc (api *PublicFilterAPI) GetLogs(ctx context.Context, crit FilterCriteria) ([]*types.Log, error) {\n\tvar filter *Filter\n\tif crit.BlockHash != nil {\n\n\t\tfilter = NewBlockFilter(api.backend, *crit.BlockHash, crit.Addresses, crit.Topics)\n\t} else {\n\n\t\tbegin := rpc.LatestBlockNumber.Int64()\n\t\tif crit.FromBlock != nil {\n\t\t\tbegin = crit.FromBlock.Int64()\n\t\t}\n\t\tend := rpc.LatestBlockNumber.Int64()\n\t\tif crit.ToBlock != nil {\n\t\t\tend = crit.ToBlock.Int64()\n\t\t}\n\n\t\tfilter = NewRangeFilter(api.backend, begin, end, crit.Addresses, crit.Topics)\n\t}\n\n\tlogs, err := filter.Logs(ctx)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\treturn returnLogs(logs), err\n}\n```", + "externalDocs": { + "description": "line=325", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go" + }, + "params": [ + { + "name": "crit", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/eth/filters.FilterCriteria`", + "required": true, + "deprecated": false, + "schema": { + "type": "object", + "properties": { + "Addresses": { + "type": "array", + "items": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "BlockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "FromBlock": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "ToBlock": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Topics": { + "type": "array", + "items": { + "type": "array", + "items": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + } + }, + "additionalProperties": false + } + } + ], + "result": { + "name": "[]*types.Log", + "summary": "", + "description": "``", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "object", + "properties": { + "address": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "blockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "blockNumber": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "data": { + "type": "string", + "title": "bytes", + "pattern": "^0x([a-fA-F0-9]?)+$" + }, + "logIndex": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "removed": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "transactionHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "transactionIndex": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getProof", + "tags": [], + "summary": "GetProof returns the Merkle-proof for a given account and optionally some storage keys.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L585](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L585)\n```go\n// GetProof returns the Merkle-proof for a given account and optionally some storage keys.\nfunc (s *PublicBlockChainAPI) GetProof(ctx context.Context, address common.Address, storageKeys []string, blockNrOrHash rpc.BlockNumberOrHash) (*AccountResult, error) {\n\tstate, _, err := s.b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash)\n\tif state == nil || err != nil {\n\t\treturn nil, err\n\t}\n\n\tstorageTrie := state.StorageTrie(address)\n\tstorageHash := types.EmptyRootHash\n\tcodeHash := state.GetCodeHash(address)\n\tstorageProof := make([]StorageResult, len(storageKeys))\n\n\tif storageTrie != nil {\n\t\tstorageHash = storageTrie.Hash()\n\t} else {\n\n\t\tcodeHash = crypto.Keccak256Hash(nil)\n\t}\n\n\tfor i, key := range storageKeys {\n\t\tif storageTrie != nil {\n\t\t\tproof, storageError := state.GetStorageProof(address, common.HexToHash(key))\n\t\t\tif storageError != nil {\n\t\t\t\treturn nil, storageError\n\t\t\t}\n\t\t\tstorageProof[i] = StorageResult{key, (*hexutil.Big)(state.GetState(address, common.HexToHash(key)).Big()), common.ToHexArray(proof)}\n\t\t} else {\n\t\t\tstorageProof[i] = StorageResult{key, \u0026hexutil.Big{}, []string{}}\n\t\t}\n\t}\n\n\taccountProof, proofErr := state.GetProof(address)\n\tif proofErr != nil {\n\t\treturn nil, proofErr\n\t}\n\n\treturn \u0026AccountResult{\n\t\tAddress:\taddress,\n\t\tAccountProof:\tcommon.ToHexArray(accountProof),\n\t\tBalance:\t(*hexutil.Big)(state.GetBalance(address)),\n\t\tCodeHash:\tcodeHash,\n\t\tNonce:\t\thexutil.Uint64(state.GetNonce(address)),\n\t\tStorageHash:\tstorageHash,\n\t\tStorageProof:\tstorageProof,\n\t}, state.Error()\n}\n```", + "externalDocs": { + "description": "line=585", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "address", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Address`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "storageKeys", + "summary": "", + "description": "``", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ] + } + }, + { + "name": "blockNrOrHash", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/rpc.BlockNumberOrHash`", + "required": true, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc.BlockNumberOrHash", + "title": "blockNumberOrHash", + "oneOf": [ + { + "oneOf": [ + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + }, + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + ] + }, + { + "allOf": [ + { + "oneOf": [ + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + }, + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + ] + }, + { + "type": "object", + "required": ["requireCanonical"], + "properties": { + "requireCanonical": { + "type": "boolean" + } + }, + "additionalProperties": false + } + ] + } + ] + } + } + ], + "result": { + "name": "*AccountResult", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/internal/ethapi.*AccountResult`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "accountProof": { + "type": "array", + "items": { + "type": "string" + } + }, + "address": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "balance": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "codeHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "nonce": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "storageHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "storageProof": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "proof": { + "type": "array", + "items": { + "type": "string" + } + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + } + }, + "additionalProperties": false + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getRawTransactionByBlockHashAndIndex", + "tags": [], + "summary": "GetRawTransactionByBlockHashAndIndex returns the bytes of the transaction for the given block hash and index.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1249](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1249)\n```go\n// GetRawTransactionByBlockHashAndIndex returns the bytes of the transaction for the given block hash and index.\nfunc (s *PublicTransactionPoolAPI) GetRawTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) hexutil.Bytes {\n\tif block, _ := s.b.BlockByHash(ctx, blockHash); block != nil {\n\t\treturn newRPCRawTransactionFromBlockIndex(block, uint64(index))\n\t}\n\treturn nil\n}\n```", + "externalDocs": { + "description": "line=1249", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "blockHash", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Hash`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "index", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.Uint`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a uint", + "type": "string", + "title": "uint", + "pattern": "^0x([a-fA-F\\d])+$" + } + } + ], + "result": { + "name": "hexutil.Bytes", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.Bytes`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of some bytes", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getRawTransactionByBlockNumberAndIndex", + "tags": [], + "summary": "GetRawTransactionByBlockNumberAndIndex returns the bytes of the transaction for the given block number and index.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1241](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1241)\n```go\n// GetRawTransactionByBlockNumberAndIndex returns the bytes of the transaction for the given block number and index.\nfunc (s *PublicTransactionPoolAPI) GetRawTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) hexutil.Bytes {\n\tif block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {\n\t\treturn newRPCRawTransactionFromBlockIndex(block, uint64(index))\n\t}\n\treturn nil\n}\n```", + "externalDocs": { + "description": "line=1241", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "blockNr", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/rpc.BlockNumber`", + "required": true, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc.BlockNumber", + "oneOf": [ + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + }, + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + ] + } + }, + { + "name": "index", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.Uint`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a uint", + "type": "string", + "title": "uint", + "pattern": "^0x([a-fA-F\\d])+$" + } + } + ], + "result": { + "name": "hexutil.Bytes", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.Bytes`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of some bytes", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getRawTransactionByHash", + "tags": [], + "summary": "GetRawTransactionByHash returns the bytes of the transaction for the given hash.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1295](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1295)\n```go\n// GetRawTransactionByHash returns the bytes of the transaction for the given hash.\nfunc (s *PublicTransactionPoolAPI) GetRawTransactionByHash(ctx context.Context, hash common.Hash) (hexutil.Bytes, error) {\n\n\ttx, _, _, _, err := s.b.GetTransaction(ctx, hash)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tif tx == nil {\n\t\tif tx = s.b.GetPoolTransaction(hash); tx == nil {\n\n\t\t\treturn nil, nil\n\t\t}\n\t}\n\n\treturn rlp.EncodeToBytes(tx)\n}\n```", + "externalDocs": { + "description": "line=1295", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Hash`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "hexutil.Bytes", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.Bytes`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of some bytes", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getStorageAt", + "tags": [], + "summary": "GetStorageAt returns the storage from the state at the given address, key and\nblock number. The rpc.LatestBlockNumber and rpc.PendingBlockNumber meta block\nnumbers are also allowed.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L754](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L754)\n```go\n// GetStorageAt returns the storage from the state at the given address, key and\n// block number. The rpc.LatestBlockNumber and rpc.PendingBlockNumber meta block\n// numbers are also allowed.\nfunc (s *PublicBlockChainAPI) GetStorageAt(ctx context.Context, address common.Address, key string, blockNrOrHash rpc.BlockNumberOrHash) (hexutil.Bytes, error) {\n\tstate, _, err := s.b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash)\n\tif state == nil || err != nil {\n\t\treturn nil, err\n\t}\n\tres := state.GetState(address, common.HexToHash(key))\n\treturn res[:], state.Error()\n}\n```", + "externalDocs": { + "description": "line=754", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "address", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Address`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "key", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + }, + { + "name": "blockNrOrHash", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/rpc.BlockNumberOrHash`", + "required": true, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc.BlockNumberOrHash", + "title": "blockNumberOrHash", + "oneOf": [ + { + "oneOf": [ + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + }, + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + ] + }, + { + "allOf": [ + { + "oneOf": [ + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + }, + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + ] + }, + { + "type": "object", + "required": ["requireCanonical"], + "properties": { + "requireCanonical": { + "type": "boolean" + } + }, + "additionalProperties": false + } + ] + } + ] + } + } + ], + "result": { + "name": "hexutil.Bytes", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.Bytes`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of some bytes", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getTransactionByBlockHashAndIndex", + "tags": [], + "summary": "GetTransactionByBlockHashAndIndex returns the transaction for the given block hash and index.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1233](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1233)\n```go\n// GetTransactionByBlockHashAndIndex returns the transaction for the given block hash and index.\nfunc (s *PublicTransactionPoolAPI) GetTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) *RPCTransaction {\n\tif block, _ := s.b.BlockByHash(ctx, blockHash); block != nil {\n\t\treturn newRPCTransactionFromBlockIndex(block, uint64(index))\n\t}\n\treturn nil\n}\n```", + "externalDocs": { + "description": "line=1233", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "blockHash", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Hash`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "index", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.Uint`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a uint", + "type": "string", + "title": "uint", + "pattern": "^0x([a-fA-F\\d])+$" + } + } + ], + "result": { + "name": "*RPCTransaction", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/internal/ethapi.*RPCTransaction`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "blockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "blockNumber": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "from": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "gas": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "hash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "nonce": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "r": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "s": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "transactionIndex": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "v": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getTransactionByBlockNumberAndIndex", + "tags": [], + "summary": "GetTransactionByBlockNumberAndIndex returns the transaction for the given block number and index.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1225](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1225)\n```go\n// GetTransactionByBlockNumberAndIndex returns the transaction for the given block number and index.\nfunc (s *PublicTransactionPoolAPI) GetTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) *RPCTransaction {\n\tif block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {\n\t\treturn newRPCTransactionFromBlockIndex(block, uint64(index))\n\t}\n\treturn nil\n}\n```", + "externalDocs": { + "description": "line=1225", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "blockNr", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/rpc.BlockNumber`", + "required": true, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc.BlockNumber", + "oneOf": [ + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + }, + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + ] + } + }, + { + "name": "index", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.Uint`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a uint", + "type": "string", + "title": "uint", + "pattern": "^0x([a-fA-F\\d])+$" + } + } + ], + "result": { + "name": "*RPCTransaction", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/internal/ethapi.*RPCTransaction`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "blockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "blockNumber": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "from": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "gas": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "hash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "nonce": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "r": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "s": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "transactionIndex": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "v": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getTransactionByHash", + "tags": [], + "summary": "GetTransactionByHash returns the transaction for the given hash\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1276](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1276)\n```go\n// GetTransactionByHash returns the transaction for the given hash\nfunc (s *PublicTransactionPoolAPI) GetTransactionByHash(ctx context.Context, hash common.Hash) (*RPCTransaction, error) {\n\n\ttx, blockHash, blockNumber, index, err := s.b.GetTransaction(ctx, hash)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tif tx != nil {\n\t\treturn newRPCTransaction(tx, blockHash, blockNumber, index), nil\n\t}\n\n\tif tx := s.b.GetPoolTransaction(hash); tx != nil {\n\t\treturn newRPCPendingTransaction(tx), nil\n\t}\n\n\treturn nil, nil\n}\n```", + "externalDocs": { + "description": "line=1276", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Hash`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "*RPCTransaction", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/internal/ethapi.*RPCTransaction`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "blockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "blockNumber": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "from": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "gas": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "hash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "nonce": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "r": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "s": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "transactionIndex": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "v": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getTransactionCount", + "tags": [], + "summary": "GetTransactionCount returns the number of transactions the given address has sent for the given block number\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1257](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1257)\n```go\n// GetTransactionCount returns the number of transactions the given address has sent for the given block number\nfunc (s *PublicTransactionPoolAPI) GetTransactionCount(ctx context.Context, address common.Address, blockNrOrHash rpc.BlockNumberOrHash) (*hexutil.Uint64, error) {\n\n\tif blockNr, ok := blockNrOrHash.Number(); ok \u0026\u0026 blockNr == rpc.PendingBlockNumber {\n\t\tnonce, err := s.b.GetPoolNonce(ctx, address)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\treturn (*hexutil.Uint64)(\u0026nonce), nil\n\t}\n\n\tstate, _, err := s.b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash)\n\tif state == nil || err != nil {\n\t\treturn nil, err\n\t}\n\tnonce := state.GetNonce(address)\n\treturn (*hexutil.Uint64)(\u0026nonce), state.Error()\n}\n```", + "externalDocs": { + "description": "line=1257", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "address", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Address`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "blockNrOrHash", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/rpc.BlockNumberOrHash`", + "required": true, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc.BlockNumberOrHash", + "title": "blockNumberOrHash", + "oneOf": [ + { + "oneOf": [ + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + }, + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + ] + }, + { + "allOf": [ + { + "oneOf": [ + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + }, + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + ] + }, + { + "type": "object", + "required": ["requireCanonical"], + "properties": { + "requireCanonical": { + "type": "boolean" + } + }, + "additionalProperties": false + } + ] + } + ] + } + } + ], + "result": { + "name": "*hexutil.Uint64", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.*Uint64`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of a uint64", + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getTransactionReceipt", + "tags": [], + "summary": "GetTransactionReceipt returns the transaction receipt for the given transaction hash.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1312](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1312)\n```go\n// GetTransactionReceipt returns the transaction receipt for the given transaction hash.\nfunc (s *PublicTransactionPoolAPI) GetTransactionReceipt(ctx context.Context, hash common.Hash) (map[string]interface{}, error) {\n\ttx, blockHash, blockNumber, index := rawdb.ReadTransaction(s.b.ChainDb(), hash)\n\tif tx == nil {\n\t\treturn nil, nil\n\t}\n\treceipts, err := s.b.GetReceipts(ctx, blockHash)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tif len(receipts) \u003c= int(index) {\n\t\treturn nil, nil\n\t}\n\treceipt := receipts[index]\n\n\tvar signer types.Signer = types.FrontierSigner{}\n\tif tx.Protected() {\n\t\tsigner = types.NewEIP155Signer(tx.ChainId())\n\t}\n\tfrom, _ := types.Sender(signer, tx)\n\n\tfields := map[string]interface{}{\n\t\t\"blockHash\":\t\tblockHash,\n\t\t\"blockNumber\":\t\thexutil.Uint64(blockNumber),\n\t\t\"transactionHash\":\thash,\n\t\t\"transactionIndex\":\thexutil.Uint64(index),\n\t\t\"from\":\t\t\tfrom,\n\t\t\"to\":\t\t\ttx.To(),\n\t\t\"gasUsed\":\t\thexutil.Uint64(receipt.GasUsed),\n\t\t\"cumulativeGasUsed\":\thexutil.Uint64(receipt.CumulativeGasUsed),\n\t\t\"contractAddress\":\tnil,\n\t\t\"logs\":\t\t\treceipt.Logs,\n\t\t\"logsBloom\":\t\treceipt.Bloom,\n\t}\n\n\tif len(receipt.PostState) \u003e 0 {\n\t\tfields[\"root\"] = hexutil.Bytes(receipt.PostState)\n\t} else {\n\t\tfields[\"status\"] = hexutil.Uint(receipt.Status)\n\t}\n\tif receipt.Logs == nil {\n\t\tfields[\"logs\"] = [][]*types.Log{}\n\t}\n\n\tif receipt.ContractAddress != (common.Address{}) {\n\t\tfields[\"contractAddress\"] = receipt.ContractAddress\n\t}\n\treturn fields, nil\n}\n```", + "externalDocs": { + "description": "line=1312", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Hash`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "map[string]interface{}", + "summary": "", + "description": "``", + "required": true, + "deprecated": false, + "schema": { + "type": "object", + "patternProperties": { + ".*": { + "additionalProperties": true + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getUncleByBlockHashAndIndex", + "tags": [], + "summary": "GetUncleByBlockHashAndIndex returns the uncle block for the given block hash and index. When fullTx is true\nall transactions in the block are returned in full detail, otherwise only the transaction hash is returned.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L709](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L709)\n```go\n// GetUncleByBlockHashAndIndex returns the uncle block for the given block hash and index. When fullTx is true\n// all transactions in the block are returned in full detail, otherwise only the transaction hash is returned.\nfunc (s *PublicBlockChainAPI) GetUncleByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) (map[string]interface{}, error) {\n\tblock, err := s.b.BlockByHash(ctx, blockHash)\n\tif block != nil {\n\t\tuncles := block.Uncles()\n\t\tif index \u003e= hexutil.Uint(len(uncles)) {\n\t\t\tlog.Debug(\"Requested uncle not found\", \"number\", block.Number(), \"hash\", blockHash, \"index\", index)\n\t\t\treturn nil, nil\n\t\t}\n\t\tblock = types.NewBlockWithHeader(uncles[index])\n\t\treturn s.rpcMarshalBlock(block, false, false)\n\t}\n\treturn nil, err\n}\n```", + "externalDocs": { + "description": "line=709", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "blockHash", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Hash`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "index", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.Uint`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a uint", + "type": "string", + "title": "uint", + "pattern": "^0x([a-fA-F\\d])+$" + } + } + ], + "result": { + "name": "map[string]interface{}", + "summary": "", + "description": "``", + "required": true, + "deprecated": false, + "schema": { + "type": "object", + "patternProperties": { + ".*": { + "additionalProperties": true + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getUncleByBlockNumberAndIndex", + "tags": [], + "summary": "GetUncleByBlockNumberAndIndex returns the uncle block for the given block hash and index. When fullTx is true\nall transactions in the block are returned in full detail, otherwise only the transaction hash is returned.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L693](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L693)\n```go\n// GetUncleByBlockNumberAndIndex returns the uncle block for the given block hash and index. When fullTx is true\n// all transactions in the block are returned in full detail, otherwise only the transaction hash is returned.\nfunc (s *PublicBlockChainAPI) GetUncleByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) (map[string]interface{}, error) {\n\tblock, err := s.b.BlockByNumber(ctx, blockNr)\n\tif block != nil {\n\t\tuncles := block.Uncles()\n\t\tif index \u003e= hexutil.Uint(len(uncles)) {\n\t\t\tlog.Debug(\"Requested uncle not found\", \"number\", blockNr, \"hash\", block.Hash(), \"index\", index)\n\t\t\treturn nil, nil\n\t\t}\n\t\tblock = types.NewBlockWithHeader(uncles[index])\n\t\treturn s.rpcMarshalBlock(block, false, false)\n\t}\n\treturn nil, err\n}\n```", + "externalDocs": { + "description": "line=693", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "blockNr", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/rpc.BlockNumber`", + "required": true, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc.BlockNumber", + "oneOf": [ + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + }, + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + ] + } + }, + { + "name": "index", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.Uint`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a uint", + "type": "string", + "title": "uint", + "pattern": "^0x([a-fA-F\\d])+$" + } + } + ], + "result": { + "name": "map[string]interface{}", + "summary": "", + "description": "``", + "required": true, + "deprecated": false, + "schema": { + "type": "object", + "patternProperties": { + ".*": { + "additionalProperties": true + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getUncleCountByBlockHash", + "tags": [], + "summary": "GetUncleCountByBlockHash returns number of uncles in the block for the given block hash\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L733](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L733)\n```go\n// GetUncleCountByBlockHash returns number of uncles in the block for the given block hash\nfunc (s *PublicBlockChainAPI) GetUncleCountByBlockHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint {\n\tif block, _ := s.b.BlockByHash(ctx, blockHash); block != nil {\n\t\tn := hexutil.Uint(len(block.Uncles()))\n\t\treturn \u0026n\n\t}\n\treturn nil\n}\n```", + "externalDocs": { + "description": "line=733", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "blockHash", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Hash`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "*hexutil.Uint", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.*Uint`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of a uint", + "type": "string", + "title": "uint", + "pattern": "^0x([a-fA-F\\d])+$" + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getUncleCountByBlockNumber", + "tags": [], + "summary": "GetUncleCountByBlockNumber returns number of uncles in the block for the given block number\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L724](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L724)\n```go\n// GetUncleCountByBlockNumber returns number of uncles in the block for the given block number\nfunc (s *PublicBlockChainAPI) GetUncleCountByBlockNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint {\n\tif block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {\n\t\tn := hexutil.Uint(len(block.Uncles()))\n\t\treturn \u0026n\n\t}\n\treturn nil\n}\n```", + "externalDocs": { + "description": "line=724", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "blockNr", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/rpc.BlockNumber`", + "required": true, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc.BlockNumber", + "oneOf": [ + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + }, + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + ] + } + } + ], + "result": { + "name": "*hexutil.Uint", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.*Uint`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of a uint", + "type": "string", + "title": "uint", + "pattern": "^0x([a-fA-F\\d])+$" + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getWork", + "tags": [], + "summary": "GetWork returns a work package for external miner.\n\nThe work package consists of 3 strings:\n result[0] - 32 bytes hex encoded current block header pow-hash\n result[1] - 32 bytes hex encoded seed hash used for DAG\n result[2] - 32 bytes hex encoded boundary condition (\"target\"), 2^256/difficulty\n result[3] - hex encoded block number\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/consensus/ethash/api.go#L41](https://github.com/ethereum/go-ethereum/blob/master/consensus/ethash/api.go#L41)\n```go\n// GetWork returns a work package for external miner.\n//\n// The work package consists of 3 strings:\n// result[0] - 32 bytes hex encoded current block header pow-hash\n// result[1] - 32 bytes hex encoded seed hash used for DAG\n// result[2] - 32 bytes hex encoded boundary condition (\"target\"), 2^256/difficulty\n// result[3] - hex encoded block number\nfunc (api *API) GetWork() ([4]string, error) {\n\tif api.ethash.remote == nil {\n\t\treturn [4]string{}, errors.New(\"not supported\")\n\t}\n\n\tvar (\n\t\tworkCh\t= make(chan [4]string, 1)\n\t\terrc\t= make(chan error, 1)\n\t)\n\tselect {\n\tcase api.ethash.remote.fetchWorkCh \u003c- \u0026sealWork{errc: errc, res: workCh}:\n\tcase \u003c-api.ethash.remote.exitCh:\n\t\treturn [4]string{}, errEthashStopped\n\t}\n\tselect {\n\tcase work := \u003c-workCh:\n\t\treturn work, nil\n\tcase err := \u003c-errc:\n\t\treturn [4]string{}, err\n\t}\n}\n```", + "externalDocs": { + "description": "line=41", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go" + }, + "params": [], + "result": { + "name": "[4]string", + "summary": "", + "description": "``", + "required": true, + "deprecated": false, + "schema": { + "type": "array", + "maxItems": 4, + "minItems": 4, + "items": { + "type": "string" + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_hashrate", + "tags": [], + "summary": "Hashrate returns the POW hashrate\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L65](https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L65)\n```go\n// Hashrate returns the POW hashrate\nfunc (api *PublicEthereumAPI) Hashrate() hexutil.Uint64 {\n\treturn hexutil.Uint64(api.e.Miner().HashRate())\n}\n```", + "externalDocs": { + "description": "line=65", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go" + }, + "params": [], + "result": { + "name": "hexutil.Uint64", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.Uint64`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a uint64", + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_logs", + "tags": [], + "summary": "Logs creates a subscription that fires for all new log that match the given filter criteria.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/filters/api.go#L236](https://github.com/ethereum/go-ethereum/blob/master/eth/filters/api.go#L236)\n```go\n// Logs creates a subscription that fires for all new log that match the given filter criteria.\nfunc (api *PublicFilterAPI) Logs(ctx context.Context, crit FilterCriteria) (*rpc.Subscription, error) {\n\tnotifier, supported := rpc.NotifierFromContext(ctx)\n\tif !supported {\n\t\treturn \u0026rpc.Subscription{}, rpc.ErrNotificationsUnsupported\n\t}\n\n\tvar (\n\t\trpcSub\t\t= notifier.CreateSubscription()\n\t\tmatchedLogs\t= make(chan []*types.Log)\n\t)\n\n\tlogsSub, err := api.events.SubscribeLogs(ethereum.FilterQuery(crit), matchedLogs)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tgo func() {\n\n\t\tfor {\n\t\t\tselect {\n\t\t\tcase logs := \u003c-matchedLogs:\n\t\t\t\tfor _, log := range logs {\n\t\t\t\t\tnotifier.Notify(rpcSub.ID, \u0026log)\n\t\t\t\t}\n\t\t\tcase \u003c-rpcSub.Err():\n\t\t\t\tlogsSub.Unsubscribe()\n\t\t\t\treturn\n\t\t\tcase \u003c-notifier.Closed():\n\t\t\t\tlogsSub.Unsubscribe()\n\t\t\t\treturn\n\t\t\t}\n\t\t}\n\t}()\n\n\treturn rpcSub, nil\n}\n```", + "externalDocs": { + "description": "line=236", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go" + }, + "params": [ + { + "name": "crit", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/eth/filters.FilterCriteria`", + "required": true, + "deprecated": false, + "schema": { + "type": "object", + "properties": { + "Addresses": { + "type": "array", + "items": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "BlockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "FromBlock": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "ToBlock": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Topics": { + "type": "array", + "items": { + "type": "array", + "items": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + } + }, + "additionalProperties": false + } + } + ], + "result": { + "name": "*rpc.Subscription", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/rpc.*Subscription`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "github.com/ethereum/go-ethereum/rpc.*Subscription", + "type": "object", + "title": "Subscription" + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_mining", + "tags": [], + "summary": "Mining returns an indication if this node is currently mining.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L91](https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L91)\n```go\n// Mining returns an indication if this node is currently mining.\nfunc (api *PublicMinerAPI) Mining() bool {\n\treturn api.e.IsMining()\n}\n```", + "externalDocs": { + "description": "line=91", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go" + }, + "params": [], + "result": { + "name": "bool", + "summary": "", + "description": "`bool`", + "required": true, + "deprecated": false, + "schema": { + "description": "bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_newBlockFilter", + "tags": [], + "summary": "NewBlockFilter creates a filter that fetches blocks that are imported into the chain.\nIt is part of the filter package since polling goes with eth_getFilterChanges.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_newblockfilter\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/filters/api.go#L174](https://github.com/ethereum/go-ethereum/blob/master/eth/filters/api.go#L174)\n```go\n// NewBlockFilter creates a filter that fetches blocks that are imported into the chain.\n// It is part of the filter package since polling goes with eth_getFilterChanges.\n//\n// https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_newblockfilter\nfunc (api *PublicFilterAPI) NewBlockFilter() rpc.ID {\n\tvar (\n\t\theaders\t\t= make(chan *types.Header)\n\t\theaderSub\t= api.events.SubscribeNewHeads(headers)\n\t)\n\n\tapi.filtersMu.Lock()\n\tapi.filters[headerSub.ID] = \u0026filter{typ: BlocksSubscription, deadline: time.NewTimer(deadline), hashes: make([]common.Hash, 0), s: headerSub}\n\tapi.filtersMu.Unlock()\n\n\tgo func() {\n\t\tfor {\n\t\t\tselect {\n\t\t\tcase h := \u003c-headers:\n\t\t\t\tapi.filtersMu.Lock()\n\t\t\t\tif f, found := api.filters[headerSub.ID]; found {\n\t\t\t\t\tf.hashes = append(f.hashes, h.Hash())\n\t\t\t\t}\n\t\t\t\tapi.filtersMu.Unlock()\n\t\t\tcase \u003c-headerSub.Err():\n\t\t\t\tapi.filtersMu.Lock()\n\t\t\t\tdelete(api.filters, headerSub.ID)\n\t\t\t\tapi.filtersMu.Unlock()\n\t\t\t\treturn\n\t\t\t}\n\t\t}\n\t}()\n\n\treturn headerSub.ID\n}\n```", + "externalDocs": { + "description": "line=174", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go" + }, + "params": [], + "result": { + "name": "rpc.ID", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/rpc.ID`", + "required": true, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc.ID", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_newFilter", + "tags": [], + "summary": "NewFilter creates a new filter and returns the filter id. It can be\nused to retrieve logs when the state changes. This method cannot be\nused to fetch logs that are already stored in the state.\n\nDefault criteria for the from and to block are \"latest\".\nUsing \"latest\" as block number will return logs for mined blocks.\nUsing \"pending\" as block number returns logs for not yet mined (pending) blocks.\nIn case logs are removed (chain reorg) previously returned logs are returned\nagain but with the removed property set to true.\n\nIn case \"fromBlock\" \u003e \"toBlock\" an error is returned.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_newfilter\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/filters/api.go#L290](https://github.com/ethereum/go-ethereum/blob/master/eth/filters/api.go#L290)\n```go\n// NewFilter creates a new filter and returns the filter id. It can be\n// used to retrieve logs when the state changes. This method cannot be\n// used to fetch logs that are already stored in the state.\n//\n// Default criteria for the from and to block are \"latest\".\n// Using \"latest\" as block number will return logs for mined blocks.\n// Using \"pending\" as block number returns logs for not yet mined (pending) blocks.\n// In case logs are removed (chain reorg) previously returned logs are returned\n// again but with the removed property set to true.\n//\n// In case \"fromBlock\" \u003e \"toBlock\" an error is returned.\n//\n// https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_newfilter\nfunc (api *PublicFilterAPI) NewFilter(crit FilterCriteria) (rpc.ID, error) {\n\tlogs := make(chan []*types.Log)\n\tlogsSub, err := api.events.SubscribeLogs(ethereum.FilterQuery(crit), logs)\n\tif err != nil {\n\t\treturn rpc.ID(\"\"), err\n\t}\n\n\tapi.filtersMu.Lock()\n\tapi.filters[logsSub.ID] = \u0026filter{typ: LogsSubscription, crit: crit, deadline: time.NewTimer(deadline), logs: make([]*types.Log, 0), s: logsSub}\n\tapi.filtersMu.Unlock()\n\n\tgo func() {\n\t\tfor {\n\t\t\tselect {\n\t\t\tcase l := \u003c-logs:\n\t\t\t\tapi.filtersMu.Lock()\n\t\t\t\tif f, found := api.filters[logsSub.ID]; found {\n\t\t\t\t\tf.logs = append(f.logs, l...)\n\t\t\t\t}\n\t\t\t\tapi.filtersMu.Unlock()\n\t\t\tcase \u003c-logsSub.Err():\n\t\t\t\tapi.filtersMu.Lock()\n\t\t\t\tdelete(api.filters, logsSub.ID)\n\t\t\t\tapi.filtersMu.Unlock()\n\t\t\t\treturn\n\t\t\t}\n\t\t}\n\t}()\n\n\treturn logsSub.ID, nil\n}\n```", + "externalDocs": { + "description": "line=290", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go" + }, + "params": [ + { + "name": "crit", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/eth/filters.FilterCriteria`", + "required": true, + "deprecated": false, + "schema": { + "type": "object", + "properties": { + "Addresses": { + "type": "array", + "items": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "BlockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "FromBlock": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "ToBlock": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Topics": { + "type": "array", + "items": { + "type": "array", + "items": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + } + }, + "additionalProperties": false + } + } + ], + "result": { + "name": "rpc.ID", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/rpc.ID`", + "required": true, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc.ID", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_newHeads", + "tags": [], + "summary": "NewHeads send a notification each time a new (header) block is appended to the chain.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/filters/api.go#L206](https://github.com/ethereum/go-ethereum/blob/master/eth/filters/api.go#L206)\n```go\n// NewHeads send a notification each time a new (header) block is appended to the chain.\nfunc (api *PublicFilterAPI) NewHeads(ctx context.Context) (*rpc.Subscription, error) {\n\tnotifier, supported := rpc.NotifierFromContext(ctx)\n\tif !supported {\n\t\treturn \u0026rpc.Subscription{}, rpc.ErrNotificationsUnsupported\n\t}\n\n\trpcSub := notifier.CreateSubscription()\n\n\tgo func() {\n\t\theaders := make(chan *types.Header)\n\t\theadersSub := api.events.SubscribeNewHeads(headers)\n\n\t\tfor {\n\t\t\tselect {\n\t\t\tcase h := \u003c-headers:\n\t\t\t\tnotifier.Notify(rpcSub.ID, h)\n\t\t\tcase \u003c-rpcSub.Err():\n\t\t\t\theadersSub.Unsubscribe()\n\t\t\t\treturn\n\t\t\tcase \u003c-notifier.Closed():\n\t\t\t\theadersSub.Unsubscribe()\n\t\t\t\treturn\n\t\t\t}\n\t\t}\n\t}()\n\n\treturn rpcSub, nil\n}\n```", + "externalDocs": { + "description": "line=206", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go" + }, + "params": [], + "result": { + "name": "*rpc.Subscription", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/rpc.*Subscription`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "github.com/ethereum/go-ethereum/rpc.*Subscription", + "type": "object", + "title": "Subscription" + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_newPendingTransactionFilter", + "tags": [], + "summary": "NewPendingTransactionFilter creates a filter that fetches pending transaction hashes\nas transactions enter the pending state.\n\nIt is part of the filter package because this filter can be used through the\n`eth_getFilterChanges` polling method that is also used for log filters.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_newpendingtransactionfilter\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/filters/api.go#L104](https://github.com/ethereum/go-ethereum/blob/master/eth/filters/api.go#L104)\n```go\n// NewPendingTransactionFilter creates a filter that fetches pending transaction hashes\n// as transactions enter the pending state.\n//\n// It is part of the filter package because this filter can be used through the\n// `eth_getFilterChanges` polling method that is also used for log filters.\n//\n// https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_newpendingtransactionfilter\nfunc (api *PublicFilterAPI) NewPendingTransactionFilter() rpc.ID {\n\tvar (\n\t\tpendingTxs\t= make(chan []common.Hash)\n\t\tpendingTxSub\t= api.events.SubscribePendingTxs(pendingTxs)\n\t)\n\n\tapi.filtersMu.Lock()\n\tapi.filters[pendingTxSub.ID] = \u0026filter{typ: PendingTransactionsSubscription, deadline: time.NewTimer(deadline), hashes: make([]common.Hash, 0), s: pendingTxSub}\n\tapi.filtersMu.Unlock()\n\n\tgo func() {\n\t\tfor {\n\t\t\tselect {\n\t\t\tcase ph := \u003c-pendingTxs:\n\t\t\t\tapi.filtersMu.Lock()\n\t\t\t\tif f, found := api.filters[pendingTxSub.ID]; found {\n\t\t\t\t\tf.hashes = append(f.hashes, ph...)\n\t\t\t\t}\n\t\t\t\tapi.filtersMu.Unlock()\n\t\t\tcase \u003c-pendingTxSub.Err():\n\t\t\t\tapi.filtersMu.Lock()\n\t\t\t\tdelete(api.filters, pendingTxSub.ID)\n\t\t\t\tapi.filtersMu.Unlock()\n\t\t\t\treturn\n\t\t\t}\n\t\t}\n\t}()\n\n\treturn pendingTxSub.ID\n}\n```", + "externalDocs": { + "description": "line=104", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go" + }, + "params": [], + "result": { + "name": "rpc.ID", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/rpc.ID`", + "required": true, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc.ID", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_newPendingTransactions", + "tags": [], + "summary": "NewPendingTransactions creates a subscription that is triggered each time a transaction\nenters the transaction pool and was signed from one of the transactions this nodes manages.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/filters/api.go#L137](https://github.com/ethereum/go-ethereum/blob/master/eth/filters/api.go#L137)\n```go\n// NewPendingTransactions creates a subscription that is triggered each time a transaction\n// enters the transaction pool and was signed from one of the transactions this nodes manages.\nfunc (api *PublicFilterAPI) NewPendingTransactions(ctx context.Context) (*rpc.Subscription, error) {\n\tnotifier, supported := rpc.NotifierFromContext(ctx)\n\tif !supported {\n\t\treturn \u0026rpc.Subscription{}, rpc.ErrNotificationsUnsupported\n\t}\n\n\trpcSub := notifier.CreateSubscription()\n\n\tgo func() {\n\t\ttxHashes := make(chan []common.Hash, 128)\n\t\tpendingTxSub := api.events.SubscribePendingTxs(txHashes)\n\n\t\tfor {\n\t\t\tselect {\n\t\t\tcase hashes := \u003c-txHashes:\n\n\t\t\t\tfor _, h := range hashes {\n\t\t\t\t\tnotifier.Notify(rpcSub.ID, h)\n\t\t\t\t}\n\t\t\tcase \u003c-rpcSub.Err():\n\t\t\t\tpendingTxSub.Unsubscribe()\n\t\t\t\treturn\n\t\t\tcase \u003c-notifier.Closed():\n\t\t\t\tpendingTxSub.Unsubscribe()\n\t\t\t\treturn\n\t\t\t}\n\t\t}\n\t}()\n\n\treturn rpcSub, nil\n}\n```", + "externalDocs": { + "description": "line=137", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go" + }, + "params": [], + "result": { + "name": "*rpc.Subscription", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/rpc.*Subscription`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "github.com/ethereum/go-ethereum/rpc.*Subscription", + "type": "object", + "title": "Subscription" + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_pendingTransactions", + "tags": [], + "summary": "PendingTransactions returns the transactions that are in the transaction pool\nand have a from address that is one of the accounts this node manages.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1599](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1599)\n```go\n// PendingTransactions returns the transactions that are in the transaction pool\n// and have a from address that is one of the accounts this node manages.\nfunc (s *PublicTransactionPoolAPI) PendingTransactions() ([]*RPCTransaction, error) {\n\tpending, err := s.b.GetPoolTransactions()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\taccounts := make(map[common.Address]struct{})\n\tfor _, wallet := range s.b.AccountManager().Wallets() {\n\t\tfor _, account := range wallet.Accounts() {\n\t\t\taccounts[account.Address] = struct{}{}\n\t\t}\n\t}\n\ttransactions := make([]*RPCTransaction, 0, len(pending))\n\tfor _, tx := range pending {\n\t\tvar signer types.Signer = types.HomesteadSigner{}\n\t\tif tx.Protected() {\n\t\t\tsigner = types.NewEIP155Signer(tx.ChainId())\n\t\t}\n\t\tfrom, _ := types.Sender(signer, tx)\n\t\tif _, exists := accounts[from]; exists {\n\t\t\ttransactions = append(transactions, newRPCPendingTransaction(tx))\n\t\t}\n\t}\n\treturn transactions, nil\n}\n```", + "externalDocs": { + "description": "line=1599", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [], + "result": { + "name": "[]*RPCTransaction", + "summary": "", + "description": "``", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "object", + "properties": { + "blockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "blockNumber": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "from": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "gas": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "hash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "nonce": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "r": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "s": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "transactionIndex": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "v": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_protocolVersion", + "tags": [], + "summary": "ProtocolVersion returns the current Ethereum protocol version this node supports\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L73](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L73)\n```go\n// ProtocolVersion returns the current Ethereum protocol version this node supports\nfunc (s *PublicEthereumAPI) ProtocolVersion() hexutil.Uint {\n\treturn hexutil.Uint(s.b.ProtocolVersion())\n}\n```", + "externalDocs": { + "description": "line=73", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [], + "result": { + "name": "hexutil.Uint", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.Uint`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a uint", + "type": "string", + "title": "uint", + "pattern": "^0x([a-fA-F\\d])+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_resend", + "tags": [], + "summary": "Resend accepts an existing transaction and a new gas price and limit. It will remove\nthe given transaction from the pool and reinsert it with the new gas price and limit.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1626](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1626)\n```go\n// Resend accepts an existing transaction and a new gas price and limit. It will remove\n// the given transaction from the pool and reinsert it with the new gas price and limit.\nfunc (s *PublicTransactionPoolAPI) Resend(ctx context.Context, sendArgs SendTxArgs, gasPrice *hexutil.Big, gasLimit *hexutil.Uint64) (common.Hash, error) {\n\tif sendArgs.Nonce == nil {\n\t\treturn common.Hash{}, fmt.Errorf(\"missing transaction nonce in transaction spec\")\n\t}\n\tif err := sendArgs.setDefaults(ctx, s.b); err != nil {\n\t\treturn common.Hash{}, err\n\t}\n\tmatchTx := sendArgs.toTransaction()\n\tpending, err := s.b.GetPoolTransactions()\n\tif err != nil {\n\t\treturn common.Hash{}, err\n\t}\n\n\tfor _, p := range pending {\n\t\tvar signer types.Signer = types.HomesteadSigner{}\n\t\tif p.Protected() {\n\t\t\tsigner = types.NewEIP155Signer(p.ChainId())\n\t\t}\n\t\twantSigHash := signer.Hash(matchTx)\n\n\t\tif pFrom, err := types.Sender(signer, p); err == nil \u0026\u0026 pFrom == sendArgs.From \u0026\u0026 signer.Hash(p) == wantSigHash {\n\n\t\t\tif gasPrice != nil \u0026\u0026 (*big.Int)(gasPrice).Sign() != 0 {\n\t\t\t\tsendArgs.GasPrice = gasPrice\n\t\t\t}\n\t\t\tif gasLimit != nil \u0026\u0026 *gasLimit != 0 {\n\t\t\t\tsendArgs.Gas = gasLimit\n\t\t\t}\n\t\t\tsignedTx, err := s.sign(sendArgs.From, sendArgs.toTransaction())\n\t\t\tif err != nil {\n\t\t\t\treturn common.Hash{}, err\n\t\t\t}\n\t\t\tif err = s.b.SendTx(ctx, signedTx); err != nil {\n\t\t\t\treturn common.Hash{}, err\n\t\t\t}\n\t\t\treturn signedTx.Hash(), nil\n\t\t}\n\t}\n\n\treturn common.Hash{}, fmt.Errorf(\"transaction %#x not found\", matchTx.Hash())\n}\n```", + "externalDocs": { + "description": "line=1626", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "sendArgs", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/internal/ethapi.SendTxArgs`", + "required": true, + "deprecated": false, + "schema": { + "type": "object", + "properties": { + "data": { + "description": "Field 'input' should be preferred", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "from": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "gas": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "nonce": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + { + "name": "gasPrice", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.*Big`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + { + "type": "null" + } + ] + } + }, + { + "name": "gasLimit", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.*Uint64`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of a uint64", + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + { + "type": "null" + } + ] + } + } + ], + "result": { + "name": "common.Hash", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Hash`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_sendRawTransaction", + "tags": [], + "summary": "SendRawTransaction will add the signed transaction to the transaction pool.\nThe sender is responsible for signing the transaction and using the correct nonce.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1531](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1531)\n```go\n// SendRawTransaction will add the signed transaction to the transaction pool.\n// The sender is responsible for signing the transaction and using the correct nonce.\nfunc (s *PublicTransactionPoolAPI) SendRawTransaction(ctx context.Context, encodedTx hexutil.Bytes) (common.Hash, error) {\n\ttx := new(types.Transaction)\n\tif err := rlp.DecodeBytes(encodedTx, tx); err != nil {\n\t\treturn common.Hash{}, err\n\t}\n\treturn SubmitTransaction(ctx, s.b, tx)\n}\n```", + "externalDocs": { + "description": "line=1531", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "encodedTx", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.Bytes`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of some bytes", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + { + "type": "null" + } + ] + } + } + ], + "result": { + "name": "common.Hash", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Hash`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_sendTransaction", + "tags": [], + "summary": "SendTransaction creates a transaction for the given argument, sign it and submit it to the\ntransaction pool.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1483](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1483)\n```go\n// SendTransaction creates a transaction for the given argument, sign it and submit it to the\n// transaction pool.\nfunc (s *PublicTransactionPoolAPI) SendTransaction(ctx context.Context, args SendTxArgs) (common.Hash, error) {\n\n\taccount := accounts.Account{Address: args.From}\n\n\twallet, err := s.b.AccountManager().Find(account)\n\tif err != nil {\n\t\treturn common.Hash{}, err\n\t}\n\n\tif args.Nonce == nil {\n\n\t\ts.nonceLock.LockAddr(args.From)\n\t\tdefer s.nonceLock.UnlockAddr(args.From)\n\t}\n\n\tif err := args.setDefaults(ctx, s.b); err != nil {\n\t\treturn common.Hash{}, err\n\t}\n\n\ttx := args.toTransaction()\n\n\tsigned, err := wallet.SignTx(account, tx, s.b.ChainConfig().GetChainID())\n\tif err != nil {\n\t\treturn common.Hash{}, err\n\t}\n\treturn SubmitTransaction(ctx, s.b, signed)\n}\n```", + "externalDocs": { + "description": "line=1483", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/internal/ethapi.SendTxArgs`", + "required": true, + "deprecated": false, + "schema": { + "type": "object", + "properties": { + "data": { + "description": "Field 'input' should be preferred", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "from": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "gas": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "nonce": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + } + ], + "result": { + "name": "common.Hash", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Hash`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_sign", + "tags": [], + "summary": "Sign calculates an ECDSA signature for:\nkeccack256(\"\\x19Ethereum Signed Message:\\n\" + len(message) + message).\n\nNote, the produced signature conforms to the secp256k1 curve R, S and V values,\nwhere the V value will be 27 or 28 for legacy reasons.\n\nThe account associated with addr must be unlocked.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1548](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1548)\n```go\n// Sign calculates an ECDSA signature for:\n// keccack256(\"\\x19Ethereum Signed Message:\\n\" + len(message) + message).\n//\n// Note, the produced signature conforms to the secp256k1 curve R, S and V values,\n// where the V value will be 27 or 28 for legacy reasons.\n//\n// The account associated with addr must be unlocked.\n//\n// https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign\nfunc (s *PublicTransactionPoolAPI) Sign(addr common.Address, data hexutil.Bytes) (hexutil.Bytes, error) {\n\n\taccount := accounts.Account{Address: addr}\n\n\twallet, err := s.b.AccountManager().Find(account)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tsignature, err := wallet.SignText(account, data)\n\tif err == nil {\n\t\tsignature[64] += 27\n\t}\n\treturn signature, err\n}\n```", + "externalDocs": { + "description": "line=1548", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "addr", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Address`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "data", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.Bytes`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of some bytes", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + { + "type": "null" + } + ] + } + } + ], + "result": { + "name": "hexutil.Bytes", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.Bytes`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of some bytes", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_signTransaction", + "tags": [], + "summary": "SignTransaction will sign the given transaction with the from account.\nThe node needs to have the private key of the account corresponding with\nthe given from address and it needs to be unlocked.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1573](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1573)\n```go\n// SignTransaction will sign the given transaction with the from account.\n// The node needs to have the private key of the account corresponding with\n// the given from address and it needs to be unlocked.\nfunc (s *PublicTransactionPoolAPI) SignTransaction(ctx context.Context, args SendTxArgs) (*SignTransactionResult, error) {\n\tif args.Gas == nil {\n\t\treturn nil, fmt.Errorf(\"gas not specified\")\n\t}\n\tif args.GasPrice == nil {\n\t\treturn nil, fmt.Errorf(\"gasPrice not specified\")\n\t}\n\tif args.Nonce == nil {\n\t\treturn nil, fmt.Errorf(\"nonce not specified\")\n\t}\n\tif err := args.setDefaults(ctx, s.b); err != nil {\n\t\treturn nil, err\n\t}\n\ttx, err := s.sign(args.From, args.toTransaction())\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tdata, err := rlp.EncodeToBytes(tx)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\treturn \u0026SignTransactionResult{data, tx}, nil\n}\n```", + "externalDocs": { + "description": "line=1573", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/internal/ethapi.SendTxArgs`", + "required": true, + "deprecated": false, + "schema": { + "type": "object", + "properties": { + "data": { + "description": "Field 'input' should be preferred", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "from": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "gas": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "nonce": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + } + ], + "result": { + "name": "*SignTransactionResult", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/internal/ethapi.*SignTransactionResult`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "raw": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "tx": { + "type": "object", + "additionalProperties": false + } + }, + "additionalProperties": false + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_submitHashRate", + "tags": [], + "summary": "SubmitHashrate can be used for remote miners to submit their hash rate.\nThis enables the node to report the combined hash rate of all miners\nwhich submit work through this node.\n\nIt accepts the miner hash rate and an identifier which must be unique\nbetween nodes.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/consensus/ethash/api.go#L92](https://github.com/ethereum/go-ethereum/blob/master/consensus/ethash/api.go#L92)\n```go\n// SubmitHashrate can be used for remote miners to submit their hash rate.\n// This enables the node to report the combined hash rate of all miners\n// which submit work through this node.\n//\n// It accepts the miner hash rate and an identifier which must be unique\n// between nodes.\nfunc (api *API) SubmitHashRate(rate hexutil.Uint64, id common.Hash) bool {\n\tif api.ethash.remote == nil {\n\t\treturn false\n\t}\n\n\tvar done = make(chan struct{}, 1)\n\tselect {\n\tcase api.ethash.remote.submitRateCh \u003c- \u0026hashrate{done: done, rate: uint64(rate), id: id}:\n\tcase \u003c-api.ethash.remote.exitCh:\n\t\treturn false\n\t}\n\n\t\u003c-done\n\treturn true\n}\n```", + "externalDocs": { + "description": "line=92", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go" + }, + "params": [ + { + "name": "rate", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.Uint64`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a uint64", + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + } + }, + { + "name": "id", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Hash`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "bool", + "summary": "", + "description": "`bool`", + "required": true, + "deprecated": false, + "schema": { + "description": "bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_submitWork", + "tags": [], + "summary": "SubmitWork can be used by external miner to submit their POW solution.\nIt returns an indication if the work was accepted.\nNote either an invalid solution, a stale work a non-existent work will return false.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/consensus/ethash/api.go#L66](https://github.com/ethereum/go-ethereum/blob/master/consensus/ethash/api.go#L66)\n```go\n// SubmitWork can be used by external miner to submit their POW solution.\n// It returns an indication if the work was accepted.\n// Note either an invalid solution, a stale work a non-existent work will return false.\nfunc (api *API) SubmitWork(nonce types.BlockNonce, hash, digest common.Hash) bool {\n\tif api.ethash.remote == nil {\n\t\treturn false\n\t}\n\n\tvar errc = make(chan error, 1)\n\tselect {\n\tcase api.ethash.remote.submitWorkCh \u003c- \u0026mineResult{\n\t\tnonce:\t\tnonce,\n\t\tmixDigest:\tdigest,\n\t\thash:\t\thash,\n\t\terrc:\t\terrc,\n\t}:\n\tcase \u003c-api.ethash.remote.exitCh:\n\t\treturn false\n\t}\n\terr := \u003c-errc\n\treturn err == nil\n}\n```", + "externalDocs": { + "description": "line=66", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go" + }, + "params": [ + { + "name": "nonce", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/core/types.BlockNonce`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + { + "name": "hash", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Hash`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "digest", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Hash`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "bool", + "summary": "", + "description": "`bool`", + "required": true, + "deprecated": false, + "schema": { + "description": "bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_subscribeSyncStatus", + "tags": [], + "summary": "SubscribeSyncStatus creates a subscription that will broadcast new synchronisation updates.\nThe given channel must receive interface values, the result can either\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/downloader/api.go#L163](https://github.com/ethereum/go-ethereum/blob/master/eth/downloader/api.go#L163)\n```go\n// SubscribeSyncStatus creates a subscription that will broadcast new synchronisation updates.\n// The given channel must receive interface values, the result can either\nfunc (api *PublicDownloaderAPI) SubscribeSyncStatus(status chan interface{}) *SyncStatusSubscription {\n\tapi.installSyncSubscription \u003c- status\n\treturn \u0026SyncStatusSubscription{api: api, c: status}\n}\n```", + "externalDocs": { + "description": "line=163", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/downloader/api.go" + }, + "params": [ + { + "name": "status", + "summary": "", + "description": "``", + "required": true, + "deprecated": false, + "schema": { + "type": "object", + "title": "\u003cunknown\u003e" + } + } + ], + "result": { + "name": "*SyncStatusSubscription", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/eth/downloader.*SyncStatusSubscription`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "object", + "additionalProperties": false + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_syncing", + "tags": [], + "summary": "Syncing provides information when this nodes starts synchronising with the Ethereum network and when it's finished.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/downloader/api.go#L93](https://github.com/ethereum/go-ethereum/blob/master/eth/downloader/api.go#L93)\n```go\n// Syncing provides information when this nodes starts synchronising with the Ethereum network and when it's finished.\nfunc (api *PublicDownloaderAPI) Syncing(ctx context.Context) (*rpc.Subscription, error) {\n\tnotifier, supported := rpc.NotifierFromContext(ctx)\n\tif !supported {\n\t\treturn \u0026rpc.Subscription{}, rpc.ErrNotificationsUnsupported\n\t}\n\n\trpcSub := notifier.CreateSubscription()\n\n\tgo func() {\n\t\tstatuses := make(chan interface{})\n\t\tsub := api.SubscribeSyncStatus(statuses)\n\n\t\tfor {\n\t\t\tselect {\n\t\t\tcase status := \u003c-statuses:\n\t\t\t\tnotifier.Notify(rpcSub.ID, status)\n\t\t\tcase \u003c-rpcSub.Err():\n\t\t\t\tsub.Unsubscribe()\n\t\t\t\treturn\n\t\t\tcase \u003c-notifier.Closed():\n\t\t\t\tsub.Unsubscribe()\n\t\t\t\treturn\n\t\t\t}\n\t\t}\n\t}()\n\n\treturn rpcSub, nil\n}\n```", + "externalDocs": { + "description": "line=93", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/downloader/api.go" + }, + "params": [], + "result": { + "name": "*rpc.Subscription", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/rpc.*Subscription`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "github.com/ethereum/go-ethereum/rpc.*Subscription", + "type": "object", + "title": "Subscription" + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_syncing", + "tags": [], + "summary": "Syncing returns false in case the node is currently not syncing with the network. It can be up to date or has not\nyet received the latest block headers from its pears. In case it is synchronizing:\n- startingBlock: block number this node started to synchronise from\n- currentBlock: block number this node is currently importing\n- highestBlock: block number of the highest block header this node has received from peers\n- pulledStates: number of state entries processed until now\n- knownStates: number of known state entries that still need to be pulled\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L106](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L106)\n```go\n// Syncing returns false in case the node is currently not syncing with the network. It can be up to date or has not\n// yet received the latest block headers from its pears. In case it is synchronizing:\n// - startingBlock: block number this node started to synchronise from\n// - currentBlock: block number this node is currently importing\n// - highestBlock: block number of the highest block header this node has received from peers\n// - pulledStates: number of state entries processed until now\n// - knownStates: number of known state entries that still need to be pulled\nfunc (s *PublicEthereumAPI) Syncing() (EthSyncingResult, error) {\n\tprogress := s.b.Downloader().Progress()\n\n\tif progress.CurrentBlock \u003e= progress.HighestBlock {\n\t\tnot := EthSyncingResultSyncing(false)\n\t\treturn EthSyncingResult{Syncing: not}, nil\n\t}\n\n\treturn EthSyncingResult{\n\t\tSyncing:\ttrue,\n\t\tProgress: \u0026EthSyncingResultProgress{\n\t\t\thexutil.Uint64(progress.StartingBlock),\n\t\t\thexutil.Uint64(progress.CurrentBlock),\n\t\t\thexutil.Uint64(progress.HighestBlock),\n\t\t\thexutil.Uint64(progress.PulledStates),\n\t\t\thexutil.Uint64(progress.KnownStates),\n\t\t},\n\t}, nil\n}\n```", + "externalDocs": { + "description": "line=106", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [], + "result": { + "name": "EthSyncingResult", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/internal/ethapi.EthSyncingResult`", + "required": true, + "deprecated": false, + "schema": { + "type": "object", + "oneOf": [ + { + "type": "boolean", + "title": "Syncing" + }, + { + "type": "object", + "properties": { + "CurrentgBlock": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "HighestgBlock": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "KnownStates": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "PulledStates": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "StartingBlock": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + } + }, + "additionalProperties": false + } + ], + "properties": { + "Progress": { + "type": "object", + "properties": { + "CurrentgBlock": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "HighestgBlock": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "KnownStates": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "PulledStates": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "StartingBlock": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + } + }, + "additionalProperties": false + }, + "Syncing": { + "type": "boolean", + "title": "Syncing" + } + }, + "additionalProperties": false + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_uninstallFilter", + "tags": [], + "summary": "UninstallFilter removes the filter with the given filter id.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_uninstallfilter\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/filters/api.go#L354](https://github.com/ethereum/go-ethereum/blob/master/eth/filters/api.go#L354)\n```go\n// UninstallFilter removes the filter with the given filter id.\n//\n// https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_uninstallfilter\nfunc (api *PublicFilterAPI) UninstallFilter(id rpc.ID) bool {\n\tapi.filtersMu.Lock()\n\tf, found := api.filters[id]\n\tif found {\n\t\tdelete(api.filters, id)\n\t}\n\tapi.filtersMu.Unlock()\n\tif found {\n\t\tf.s.Unsubscribe()\n\t}\n\n\treturn found\n}\n```", + "externalDocs": { + "description": "line=354", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go" + }, + "params": [ + { + "name": "id", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/rpc.ID`", + "required": true, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc.ID", + "type": "string" + } + } + ], + "result": { + "name": "bool", + "summary": "", + "description": "`bool`", + "required": true, + "deprecated": false, + "schema": { + "description": "bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "ethash_getHashrate", + "tags": [], + "summary": "GetHashrate returns the current hashrate for local CPU miner and remote miner.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/consensus/ethash/api.go#L110](https://github.com/ethereum/go-ethereum/blob/master/consensus/ethash/api.go#L110)\n```go\n// GetHashrate returns the current hashrate for local CPU miner and remote miner.\nfunc (api *API) GetHashrate() uint64 {\n\treturn uint64(api.ethash.Hashrate())\n}\n```", + "externalDocs": { + "description": "line=110", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go" + }, + "params": [], + "result": { + "name": "uint64", + "summary": "", + "description": "`uint64`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "ethash_getWork", + "tags": [], + "summary": "GetWork returns a work package for external miner.\n\nThe work package consists of 3 strings:\n result[0] - 32 bytes hex encoded current block header pow-hash\n result[1] - 32 bytes hex encoded seed hash used for DAG\n result[2] - 32 bytes hex encoded boundary condition (\"target\"), 2^256/difficulty\n result[3] - hex encoded block number\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/consensus/ethash/api.go#L41](https://github.com/ethereum/go-ethereum/blob/master/consensus/ethash/api.go#L41)\n```go\n// GetWork returns a work package for external miner.\n//\n// The work package consists of 3 strings:\n// result[0] - 32 bytes hex encoded current block header pow-hash\n// result[1] - 32 bytes hex encoded seed hash used for DAG\n// result[2] - 32 bytes hex encoded boundary condition (\"target\"), 2^256/difficulty\n// result[3] - hex encoded block number\nfunc (api *API) GetWork() ([4]string, error) {\n\tif api.ethash.remote == nil {\n\t\treturn [4]string{}, errors.New(\"not supported\")\n\t}\n\n\tvar (\n\t\tworkCh\t= make(chan [4]string, 1)\n\t\terrc\t= make(chan error, 1)\n\t)\n\tselect {\n\tcase api.ethash.remote.fetchWorkCh \u003c- \u0026sealWork{errc: errc, res: workCh}:\n\tcase \u003c-api.ethash.remote.exitCh:\n\t\treturn [4]string{}, errEthashStopped\n\t}\n\tselect {\n\tcase work := \u003c-workCh:\n\t\treturn work, nil\n\tcase err := \u003c-errc:\n\t\treturn [4]string{}, err\n\t}\n}\n```", + "externalDocs": { + "description": "line=41", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go" + }, + "params": [], + "result": { + "name": "[4]string", + "summary": "", + "description": "``", + "required": true, + "deprecated": false, + "schema": { + "type": "array", + "maxItems": 4, + "minItems": 4, + "items": { + "type": "string" + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "ethash_submitHashRate", + "tags": [], + "summary": "SubmitHashrate can be used for remote miners to submit their hash rate.\nThis enables the node to report the combined hash rate of all miners\nwhich submit work through this node.\n\nIt accepts the miner hash rate and an identifier which must be unique\nbetween nodes.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/consensus/ethash/api.go#L92](https://github.com/ethereum/go-ethereum/blob/master/consensus/ethash/api.go#L92)\n```go\n// SubmitHashrate can be used for remote miners to submit their hash rate.\n// This enables the node to report the combined hash rate of all miners\n// which submit work through this node.\n//\n// It accepts the miner hash rate and an identifier which must be unique\n// between nodes.\nfunc (api *API) SubmitHashRate(rate hexutil.Uint64, id common.Hash) bool {\n\tif api.ethash.remote == nil {\n\t\treturn false\n\t}\n\n\tvar done = make(chan struct{}, 1)\n\tselect {\n\tcase api.ethash.remote.submitRateCh \u003c- \u0026hashrate{done: done, rate: uint64(rate), id: id}:\n\tcase \u003c-api.ethash.remote.exitCh:\n\t\treturn false\n\t}\n\n\t\u003c-done\n\treturn true\n}\n```", + "externalDocs": { + "description": "line=92", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go" + }, + "params": [ + { + "name": "rate", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.Uint64`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a uint64", + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + } + }, + { + "name": "id", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Hash`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "bool", + "summary": "", + "description": "`bool`", + "required": true, + "deprecated": false, + "schema": { + "description": "bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "ethash_submitWork", + "tags": [], + "summary": "SubmitWork can be used by external miner to submit their POW solution.\nIt returns an indication if the work was accepted.\nNote either an invalid solution, a stale work a non-existent work will return false.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/consensus/ethash/api.go#L66](https://github.com/ethereum/go-ethereum/blob/master/consensus/ethash/api.go#L66)\n```go\n// SubmitWork can be used by external miner to submit their POW solution.\n// It returns an indication if the work was accepted.\n// Note either an invalid solution, a stale work a non-existent work will return false.\nfunc (api *API) SubmitWork(nonce types.BlockNonce, hash, digest common.Hash) bool {\n\tif api.ethash.remote == nil {\n\t\treturn false\n\t}\n\n\tvar errc = make(chan error, 1)\n\tselect {\n\tcase api.ethash.remote.submitWorkCh \u003c- \u0026mineResult{\n\t\tnonce:\t\tnonce,\n\t\tmixDigest:\tdigest,\n\t\thash:\t\thash,\n\t\terrc:\t\terrc,\n\t}:\n\tcase \u003c-api.ethash.remote.exitCh:\n\t\treturn false\n\t}\n\terr := \u003c-errc\n\treturn err == nil\n}\n```", + "externalDocs": { + "description": "line=66", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go" + }, + "params": [ + { + "name": "nonce", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/core/types.BlockNonce`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + { + "name": "hash", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Hash`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "digest", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Hash`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "bool", + "summary": "", + "description": "`bool`", + "required": true, + "deprecated": false, + "schema": { + "description": "bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_getHashrate", + "tags": [], + "summary": "GetHashrate returns the current hashrate of the miner.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L153](https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L153)\n```go\n// GetHashrate returns the current hashrate of the miner.\nfunc (api *PrivateMinerAPI) GetHashrate() uint64 {\n\treturn api.e.miner.HashRate()\n}\n```", + "externalDocs": { + "description": "line=153", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go" + }, + "params": [], + "result": { + "name": "uint64", + "summary": "", + "description": "`uint64`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_setEtherbase", + "tags": [], + "summary": "SetEtherbase sets the etherbase of the miner\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L142](https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L142)\n```go\n// SetEtherbase sets the etherbase of the miner\nfunc (api *PrivateMinerAPI) SetEtherbase(etherbase common.Address) bool {\n\tapi.e.SetEtherbase(etherbase)\n\treturn true\n}\n```", + "externalDocs": { + "description": "line=142", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go" + }, + "params": [ + { + "name": "etherbase", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Address`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "bool", + "summary": "", + "description": "`bool`", + "required": true, + "deprecated": false, + "schema": { + "description": "bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_setExtra", + "tags": [], + "summary": "SetExtra sets the extra data string that is included when this miner mines a block.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L124](https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L124)\n```go\n// SetExtra sets the extra data string that is included when this miner mines a block.\nfunc (api *PrivateMinerAPI) SetExtra(extra string) (bool, error) {\n\tif err := api.e.Miner().SetExtra([]byte(extra)); err != nil {\n\t\treturn false, err\n\t}\n\treturn true, nil\n}\n```", + "externalDocs": { + "description": "line=124", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go" + }, + "params": [ + { + "name": "extra", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + } + ], + "result": { + "name": "bool", + "summary": "", + "description": "`bool`", + "required": true, + "deprecated": false, + "schema": { + "description": "bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_setGasPrice", + "tags": [], + "summary": "SetGasPrice sets the minimum accepted gas price for the miner.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L132](https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L132)\n```go\n// SetGasPrice sets the minimum accepted gas price for the miner.\nfunc (api *PrivateMinerAPI) SetGasPrice(gasPrice hexutil.Big) bool {\n\tapi.e.lock.Lock()\n\tapi.e.gasPrice = (*big.Int)(\u0026gasPrice)\n\tapi.e.lock.Unlock()\n\n\tapi.e.txPool.SetGasPrice((*big.Int)(\u0026gasPrice))\n\treturn true\n}\n```", + "externalDocs": { + "description": "line=132", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go" + }, + "params": [ + { + "name": "gasPrice", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.Big`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "bool", + "summary": "", + "description": "`bool`", + "required": true, + "deprecated": false, + "schema": { + "description": "bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_setRecommitInterval", + "tags": [], + "summary": "SetRecommitInterval updates the interval for miner sealing work recommitting.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L148](https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L148)\n```go\n// SetRecommitInterval updates the interval for miner sealing work recommitting.\nfunc (api *PrivateMinerAPI) SetRecommitInterval(interval int) {\n\tapi.e.Miner().SetRecommitInterval(time.Duration(interval) * time.Millisecond)\n}\n```", + "externalDocs": { + "description": "line=148", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go" + }, + "params": [ + { + "name": "interval", + "summary": "", + "description": "`int`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "Null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_start", + "tags": [], + "summary": "Start starts the miner with the given number of threads. If threads is nil,\nthe number of workers started is equal to the number of logical CPUs that are\nusable by this process. If mining is already running, this method adjust the\nnumber of threads allowed to use and updates the minimum price required by the\ntransaction pool.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L110](https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L110)\n```go\n// Start starts the miner with the given number of threads. If threads is nil,\n// the number of workers started is equal to the number of logical CPUs that are\n// usable by this process. If mining is already running, this method adjust the\n// number of threads allowed to use and updates the minimum price required by the\n// transaction pool.\nfunc (api *PrivateMinerAPI) Start(threads *int) error {\n\tif threads == nil {\n\t\treturn api.e.StartMining(runtime.NumCPU())\n\t}\n\treturn api.e.StartMining(*threads)\n}\n```", + "externalDocs": { + "description": "line=110", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go" + }, + "params": [ + { + "name": "threads", + "summary": "", + "description": "`*int`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + { + "type": "null" + } + ] + } + } + ], + "result": { + "name": "Null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_stop", + "tags": [], + "summary": "Stop terminates the miner, both at the consensus engine level as well as at\nthe block creation level.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L119](https://github.com/ethereum/go-ethereum/blob/master/eth/api.go#L119)\n```go\n// Stop terminates the miner, both at the consensus engine level as well as at\n// the block creation level.\nfunc (api *PrivateMinerAPI) Stop() {\n\tapi.e.StopMining()\n}\n```", + "externalDocs": { + "description": "line=119", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go" + }, + "params": [], + "result": { + "name": "Null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "net_listening", + "tags": [], + "summary": "Listening returns an indication if the node is listening for network connections.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1803](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1803)\n```go\n// Listening returns an indication if the node is listening for network connections.\nfunc (s *PublicNetAPI) Listening() bool {\n\treturn true\n}\n```", + "externalDocs": { + "description": "line=1803", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [], + "result": { + "name": "bool", + "summary": "", + "description": "`bool`", + "required": true, + "deprecated": false, + "schema": { + "description": "bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "net_peerCount", + "tags": [], + "summary": "PeerCount returns the number of connected peers\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1807](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1807)\n```go\n// PeerCount returns the number of connected peers\nfunc (s *PublicNetAPI) PeerCount() hexutil.Uint {\n\treturn hexutil.Uint(s.net.PeerCount())\n}\n```", + "externalDocs": { + "description": "line=1807", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [], + "result": { + "name": "hexutil.Uint", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.Uint`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a uint", + "type": "string", + "title": "uint", + "pattern": "^0x([a-fA-F\\d])+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "net_version", + "tags": [], + "summary": "Version returns the current ethereum protocol version.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1812](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L1812)\n```go\n// Version returns the current ethereum protocol version.\nfunc (s *PublicNetAPI) Version() string {\n\treturn fmt.Sprintf(\"%d\", s.networkVersion)\n}\n```", + "externalDocs": { + "description": "line=1812", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [], + "result": { + "name": "string", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_deriveAccount", + "tags": [], + "summary": "DeriveAccount requests a HD wallet to derive a new account, optionally pinning\nit for later reuse.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L293](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L293)\n```go\n// DeriveAccount requests a HD wallet to derive a new account, optionally pinning\n// it for later reuse.\nfunc (s *PrivateAccountAPI) DeriveAccount(url string, path string, pin *bool) (accounts.Account, error) {\n\twallet, err := s.am.Wallet(url)\n\tif err != nil {\n\t\treturn accounts.Account{}, err\n\t}\n\tderivPath, err := accounts.ParseDerivationPath(path)\n\tif err != nil {\n\t\treturn accounts.Account{}, err\n\t}\n\tif pin == nil {\n\t\tpin = new(bool)\n\t}\n\treturn wallet.Derive(derivPath, *pin)\n}\n```", + "externalDocs": { + "description": "line=293", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + }, + { + "name": "path", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + }, + { + "name": "pin", + "summary": "", + "description": "`*bool`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "*bool", + "type": "boolean" + }, + { + "type": "null" + } + ] + } + } + ], + "result": { + "name": "accounts.Account", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/accounts.Account`", + "required": true, + "deprecated": false, + "schema": { + "type": "object", + "properties": { + "address": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "url": { + "type": "object", + "properties": { + "Path": { + "type": "string" + }, + "Scheme": { + "type": "string" + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_ecRecover", + "tags": [], + "summary": "EcRecover returns the address for the account that was used to create the signature.\nNote, this function is compatible with eth_sign and personal_sign. As such it recovers\nthe address of:\nhash = keccak256(\"\\x19Ethereum Signed Message:\\n\"${message length}${message})\naddr = ecrecover(hash, signature)\n\nNote, the signature must conform to the secp256k1 curve R, S and V values, where\nthe V value must be 27 or 28 for legacy reasons.\n\nhttps://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_ecRecover\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L471](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L471)\n```go\n// EcRecover returns the address for the account that was used to create the signature.\n// Note, this function is compatible with eth_sign and personal_sign. As such it recovers\n// the address of:\n// hash = keccak256(\"\\x19Ethereum Signed Message:\\n\"${message length}${message})\n// addr = ecrecover(hash, signature)\n//\n// Note, the signature must conform to the secp256k1 curve R, S and V values, where\n// the V value must be 27 or 28 for legacy reasons.\n//\n// https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_ecRecover\nfunc (s *PrivateAccountAPI) EcRecover(ctx context.Context, data, sig hexutil.Bytes) (common.Address, error) {\n\tif len(sig) != crypto.SignatureLength {\n\t\treturn common.Address{}, fmt.Errorf(\"signature must be %d bytes long\", crypto.SignatureLength)\n\t}\n\tif sig[crypto.RecoveryIDOffset] != 27 \u0026\u0026 sig[crypto.RecoveryIDOffset] != 28 {\n\t\treturn common.Address{}, fmt.Errorf(\"invalid Ethereum signature (V is not 27 or 28)\")\n\t}\n\tsig[crypto.RecoveryIDOffset] -= 27\n\n\trpk, err := crypto.SigToPub(accounts.TextHash(data), sig)\n\tif err != nil {\n\t\treturn common.Address{}, err\n\t}\n\treturn crypto.PubkeyToAddress(*rpk), nil\n}\n```", + "externalDocs": { + "description": "line=471", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "data", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.Bytes`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of some bytes", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + { + "type": "null" + } + ] + } + }, + { + "name": "sig", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.Bytes`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of some bytes", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + { + "type": "null" + } + ] + } + } + ], + "result": { + "name": "common.Address", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Address`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_importRawKey", + "tags": [], + "summary": "ImportRawKey stores the given hex encoded ECDSA key into the key directory,\nencrypting it with the passphrase.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L327](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L327)\n```go\n// ImportRawKey stores the given hex encoded ECDSA key into the key directory,\n// encrypting it with the passphrase.\nfunc (s *PrivateAccountAPI) ImportRawKey(privkey string, password string) (common.Address, error) {\n\tkey, err := crypto.HexToECDSA(privkey)\n\tif err != nil {\n\t\treturn common.Address{}, err\n\t}\n\tacc, err := fetchKeystore(s.am).ImportECDSA(key, password)\n\treturn acc.Address, err\n}\n```", + "externalDocs": { + "description": "line=327", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "privkey", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + }, + { + "name": "password", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + } + ], + "result": { + "name": "common.Address", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Address`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_initializeWallet", + "tags": [], + "summary": "InitializeWallet initializes a new wallet at the provided URL, by generating and returning a new private key.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L494](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L494)\n```go\n// InitializeWallet initializes a new wallet at the provided URL, by generating and returning a new private key.\nfunc (s *PrivateAccountAPI) InitializeWallet(ctx context.Context, url string) (string, error) {\n\twallet, err := s.am.Wallet(url)\n\tif err != nil {\n\t\treturn \"\", err\n\t}\n\n\tentropy, err := bip39.NewEntropy(256)\n\tif err != nil {\n\t\treturn \"\", err\n\t}\n\n\tmnemonic, err := bip39.NewMnemonic(entropy)\n\tif err != nil {\n\t\treturn \"\", err\n\t}\n\n\tseed := bip39.NewSeed(mnemonic, \"\")\n\n\tswitch wallet := wallet.(type) {\n\tcase *scwallet.Wallet:\n\t\treturn mnemonic, wallet.Initialize(seed)\n\tdefault:\n\t\treturn \"\", fmt.Errorf(\"specified wallet does not support initialization\")\n\t}\n}\n```", + "externalDocs": { + "description": "line=494", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + } + ], + "result": { + "name": "string", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_listAccounts", + "tags": [], + "summary": "listAccounts will return a list of addresses for accounts this node manages.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L243](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L243)\n```go\n// listAccounts will return a list of addresses for accounts this node manages.\nfunc (s *PrivateAccountAPI) ListAccounts() []common.Address {\n\treturn s.am.Accounts()\n}\n```", + "externalDocs": { + "description": "line=243", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [], + "result": { + "name": "[]common.Address", + "summary": "", + "description": "``", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "array", + "items": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_listWallets", + "tags": [], + "summary": "ListWallets will return a list of wallets this node manages.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L257](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L257)\n```go\n// ListWallets will return a list of wallets this node manages.\nfunc (s *PrivateAccountAPI) ListWallets() []rawWallet {\n\twallets := make([]rawWallet, 0)\n\tfor _, wallet := range s.am.Wallets() {\n\t\tstatus, failure := wallet.Status()\n\n\t\traw := rawWallet{\n\t\t\tURL:\t\twallet.URL().String(),\n\t\t\tStatus:\t\tstatus,\n\t\t\tAccounts:\twallet.Accounts(),\n\t\t}\n\t\tif failure != nil {\n\t\t\traw.Failure = failure.Error()\n\t\t}\n\t\twallets = append(wallets, raw)\n\t}\n\treturn wallets\n}\n```", + "externalDocs": { + "description": "line=257", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [], + "result": { + "name": "[]rawWallet", + "summary": "", + "description": "``", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "object", + "properties": { + "accounts": { + "type": "array", + "items": { + "type": "object", + "properties": { + "address": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "url": { + "type": "object", + "properties": { + "Path": { + "type": "string" + }, + "Scheme": { + "type": "string" + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false + } + }, + "failure": { + "type": "string" + }, + "status": { + "type": "string" + }, + "url": { + "type": "string" + } + }, + "additionalProperties": false + } + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_lockAccount", + "tags": [], + "summary": "LockAccount will lock the account associated with the given address when it's unlocked.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L364](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L364)\n```go\n// LockAccount will lock the account associated with the given address when it's unlocked.\nfunc (s *PrivateAccountAPI) LockAccount(addr common.Address) bool {\n\treturn fetchKeystore(s.am).Lock(addr) == nil\n}\n```", + "externalDocs": { + "description": "line=364", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "addr", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Address`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "bool", + "summary": "", + "description": "`bool`", + "required": true, + "deprecated": false, + "schema": { + "description": "bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_newAccount", + "tags": [], + "summary": "NewAccount will create a new account and returns the address for the new account.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L309](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L309)\n```go\n// NewAccount will create a new account and returns the address for the new account.\nfunc (s *PrivateAccountAPI) NewAccount(password string) (common.Address, error) {\n\tacc, err := fetchKeystore(s.am).NewAccount(password)\n\tif err == nil {\n\t\tlog.Info(\"Your new key was generated\", \"address\", acc.Address)\n\t\tlog.Warn(\"Please backup your key file!\", \"path\", acc.URL.Path)\n\t\tlog.Warn(\"Please remember your password!\")\n\t\treturn acc.Address, nil\n\t}\n\treturn common.Address{}, err\n}\n```", + "externalDocs": { + "description": "line=309", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "password", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + } + ], + "result": { + "name": "common.Address", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Address`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_openWallet", + "tags": [], + "summary": "OpenWallet initiates a hardware wallet opening procedure, establishing a USB\nconnection and attempting to authenticate via the provided passphrase. Note,\nthe method may return an extra challenge requiring a second open (e.g. the\nTrezor PIN matrix challenge).\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L279](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L279)\n```go\n// OpenWallet initiates a hardware wallet opening procedure, establishing a USB\n// connection and attempting to authenticate via the provided passphrase. Note,\n// the method may return an extra challenge requiring a second open (e.g. the\n// Trezor PIN matrix challenge).\nfunc (s *PrivateAccountAPI) OpenWallet(url string, passphrase *string) error {\n\twallet, err := s.am.Wallet(url)\n\tif err != nil {\n\t\treturn err\n\t}\n\tpass := \"\"\n\tif passphrase != nil {\n\t\tpass = *passphrase\n\t}\n\treturn wallet.Open(pass)\n}\n```", + "externalDocs": { + "description": "line=279", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + }, + { + "name": "passphrase", + "summary": "", + "description": "`*string`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "*string", + "type": "string" + }, + { + "type": "null" + } + ] + } + } + ], + "result": { + "name": "Null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_sendTransaction", + "tags": [], + "summary": "SendTransaction will create a transaction from the given arguments and\ntries to sign it with the key associated with args.To. If the given passwd isn't\nable to decrypt the key it fails.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L391](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L391)\n```go\n// SendTransaction will create a transaction from the given arguments and\n// tries to sign it with the key associated with args.To. If the given passwd isn't\n// able to decrypt the key it fails.\nfunc (s *PrivateAccountAPI) SendTransaction(ctx context.Context, args SendTxArgs, passwd string) (common.Hash, error) {\n\tif args.Nonce == nil {\n\n\t\ts.nonceLock.LockAddr(args.From)\n\t\tdefer s.nonceLock.UnlockAddr(args.From)\n\t}\n\tsigned, err := s.signTransaction(ctx, \u0026args, passwd)\n\tif err != nil {\n\t\tlog.Warn(\"Failed transaction send attempt\", \"from\", args.From, \"to\", args.To, \"value\", args.Value.ToInt(), \"err\", err)\n\t\treturn common.Hash{}, err\n\t}\n\treturn SubmitTransaction(ctx, s.b, signed)\n}\n```", + "externalDocs": { + "description": "line=391", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/internal/ethapi.SendTxArgs`", + "required": true, + "deprecated": false, + "schema": { + "type": "object", + "properties": { + "data": { + "description": "Field 'input' should be preferred", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "from": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "gas": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "nonce": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + { + "name": "passwd", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + } + ], + "result": { + "name": "common.Hash", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Hash`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_sign", + "tags": [], + "summary": "Sign calculates an Ethereum ECDSA signature for:\nkeccack256(\"\\x19Ethereum Signed Message:\\n\" + len(message) + message))\n\nNote, the produced signature conforms to the secp256k1 curve R, S and V values,\nwhere the V value will be 27 or 28 for legacy reasons.\n\nThe key used to calculate the signature is decrypted with the given password.\n\nhttps://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_sign\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L443](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L443)\n```go\n// Sign calculates an Ethereum ECDSA signature for:\n// keccack256(\"\\x19Ethereum Signed Message:\\n\" + len(message) + message))\n//\n// Note, the produced signature conforms to the secp256k1 curve R, S and V values,\n// where the V value will be 27 or 28 for legacy reasons.\n//\n// The key used to calculate the signature is decrypted with the given password.\n//\n// https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_sign\nfunc (s *PrivateAccountAPI) Sign(ctx context.Context, data hexutil.Bytes, addr common.Address, passwd string) (hexutil.Bytes, error) {\n\n\taccount := accounts.Account{Address: addr}\n\n\twallet, err := s.b.AccountManager().Find(account)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tsignature, err := wallet.SignTextWithPassphrase(account, passwd, data)\n\tif err != nil {\n\t\tlog.Warn(\"Failed data sign attempt\", \"address\", addr, \"err\", err)\n\t\treturn nil, err\n\t}\n\tsignature[crypto.RecoveryIDOffset] += 27\n\treturn signature, nil\n}\n```", + "externalDocs": { + "description": "line=443", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "data", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.Bytes`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of some bytes", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + { + "type": "null" + } + ] + } + }, + { + "name": "addr", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Address`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "passwd", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + } + ], + "result": { + "name": "hexutil.Bytes", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.Bytes`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of some bytes", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_signAndSendTransaction", + "tags": [], + "summary": "SignAndSendTransaction was renamed to SendTransaction. This method is deprecated\nand will be removed in the future. It primary goal is to give clients time to update.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L489](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L489)\n```go\n// SignAndSendTransaction was renamed to SendTransaction. This method is deprecated\n// and will be removed in the future. It primary goal is to give clients time to update.\nfunc (s *PrivateAccountAPI) SignAndSendTransaction(ctx context.Context, args SendTxArgs, passwd string) (common.Hash, error) {\n\treturn s.SendTransaction(ctx, args, passwd)\n}\n```", + "externalDocs": { + "description": "line=489", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/internal/ethapi.SendTxArgs`", + "required": true, + "deprecated": false, + "schema": { + "type": "object", + "properties": { + "data": { + "description": "Field 'input' should be preferred", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "from": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "gas": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "nonce": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + { + "name": "passwd", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + } + ], + "result": { + "name": "common.Hash", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Hash`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "deprecated": true, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_signTransaction", + "tags": [], + "summary": "SignTransaction will create a transaction from the given arguments and\ntries to sign it with the key associated with args.To. If the given passwd isn't\nable to decrypt the key it fails. The transaction is returned in RLP-form, not broadcast\nto other nodes\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L410](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L410)\n```go\n// SignTransaction will create a transaction from the given arguments and\n// tries to sign it with the key associated with args.To. If the given passwd isn't\n// able to decrypt the key it fails. The transaction is returned in RLP-form, not broadcast\n// to other nodes\nfunc (s *PrivateAccountAPI) SignTransaction(ctx context.Context, args SendTxArgs, passwd, passwd2 string) (*SignTransactionResult, error) {\n\n\tif args.Gas == nil {\n\t\treturn nil, fmt.Errorf(\"gas not specified\")\n\t}\n\tif args.GasPrice == nil {\n\t\treturn nil, fmt.Errorf(\"gasPrice not specified\")\n\t}\n\tif args.Nonce == nil {\n\t\treturn nil, fmt.Errorf(\"nonce not specified\")\n\t}\n\tsigned, err := s.signTransaction(ctx, \u0026args, passwd)\n\tif err != nil {\n\t\tlog.Warn(\"Failed transaction sign attempt\", \"from\", args.From, \"to\", args.To, \"value\", args.Value.ToInt(), \"err\", err)\n\t\treturn nil, err\n\t}\n\tdata, err := rlp.EncodeToBytes(signed)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\treturn \u0026SignTransactionResult{data, signed}, nil\n}\n```", + "externalDocs": { + "description": "line=410", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/internal/ethapi.SendTxArgs`", + "required": true, + "deprecated": false, + "schema": { + "type": "object", + "properties": { + "data": { + "description": "Field 'input' should be preferred", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "from": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "gas": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "nonce": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + { + "name": "passwd", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + }, + { + "name": "passwd2", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + } + ], + "result": { + "name": "*SignTransactionResult", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/internal/ethapi.*SignTransactionResult`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "raw": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "tx": { + "type": "object", + "additionalProperties": false + } + }, + "additionalProperties": false + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_unlockAccount", + "tags": [], + "summary": "UnlockAccount will unlock the account associated with the given address with\nthe given password for duration seconds. If duration is nil it will use a\ndefault of 300 seconds. It returns an indication if the account was unlocked.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L339](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L339)\n```go\n// UnlockAccount will unlock the account associated with the given address with\n// the given password for duration seconds. If duration is nil it will use a\n// default of 300 seconds. It returns an indication if the account was unlocked.\nfunc (s *PrivateAccountAPI) UnlockAccount(ctx context.Context, addr common.Address, password string, duration *uint64) (bool, error) {\n\n\tif s.b.ExtRPCEnabled() \u0026\u0026 !s.b.AccountManager().Config().InsecureUnlockAllowed {\n\t\treturn false, errors.New(\"account unlock with HTTP access is forbidden\")\n\t}\n\n\tconst max = uint64(time.Duration(math.MaxInt64) / time.Second)\n\tvar d time.Duration\n\tif duration == nil {\n\t\td = 300 * time.Second\n\t} else if *duration \u003e max {\n\t\treturn false, errors.New(\"unlock duration too large\")\n\t} else {\n\t\td = time.Duration(*duration) * time.Second\n\t}\n\terr := fetchKeystore(s.am).TimedUnlock(accounts.Account{Address: addr}, password, d)\n\tif err != nil {\n\t\tlog.Warn(\"Failed account unlock attempt\", \"address\", addr, \"err\", err)\n\t}\n\treturn err == nil, err\n}\n```", + "externalDocs": { + "description": "line=339", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "addr", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common.Address`", + "required": true, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "password", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + }, + { + "name": "duration", + "summary": "", + "description": "`*uint64`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + { + "type": "null" + } + ] + } + } + ], + "result": { + "name": "bool", + "summary": "", + "description": "`bool`", + "required": true, + "deprecated": false, + "schema": { + "description": "bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_unpair", + "tags": [], + "summary": "Unpair deletes a pairing between wallet and geth.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L521](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L521)\n```go\n// Unpair deletes a pairing between wallet and geth.\nfunc (s *PrivateAccountAPI) Unpair(ctx context.Context, url string, pin string) error {\n\twallet, err := s.am.Wallet(url)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\tswitch wallet := wallet.(type) {\n\tcase *scwallet.Wallet:\n\t\treturn wallet.Unpair([]byte(pin))\n\tdefault:\n\t\treturn fmt.Errorf(\"specified wallet does not support pairing\")\n\t}\n}\n```", + "externalDocs": { + "description": "line=521", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + }, + { + "name": "pin", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + } + ], + "result": { + "name": "Null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "txpool_content", + "tags": [], + "summary": "Content returns the transactions contained within the transaction pool.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L138](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L138)\n```go\n// Content returns the transactions contained within the transaction pool.\nfunc (s *PublicTxPoolAPI) Content() map[string]map[string]map[string]*RPCTransaction {\n\tcontent := map[string]map[string]map[string]*RPCTransaction{\n\t\t\"pending\":\tmake(map[string]map[string]*RPCTransaction),\n\t\t\"queued\":\tmake(map[string]map[string]*RPCTransaction),\n\t}\n\tpending, queue := s.b.TxPoolContent()\n\n\tfor account, txs := range pending {\n\t\tdump := make(map[string]*RPCTransaction)\n\t\tfor _, tx := range txs {\n\t\t\tdump[fmt.Sprintf(\"%d\", tx.Nonce())] = newRPCPendingTransaction(tx)\n\t\t}\n\t\tcontent[\"pending\"][account.Hex()] = dump\n\t}\n\n\tfor account, txs := range queue {\n\t\tdump := make(map[string]*RPCTransaction)\n\t\tfor _, tx := range txs {\n\t\t\tdump[fmt.Sprintf(\"%d\", tx.Nonce())] = newRPCPendingTransaction(tx)\n\t\t}\n\t\tcontent[\"queued\"][account.Hex()] = dump\n\t}\n\treturn content\n}\n```", + "externalDocs": { + "description": "line=138", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [], + "result": { + "name": "map[string]map[string]map[string]*RPCTransaction", + "summary": "", + "description": "``", + "required": true, + "deprecated": false, + "schema": { + "type": "object", + "patternProperties": { + ".*": { + "type": "object", + "patternProperties": { + ".*": { + "type": "object", + "patternProperties": { + ".*": { + "type": "object", + "properties": { + "blockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "blockNumber": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "from": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "gas": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "hash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "nonce": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "r": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "s": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "transactionIndex": { + "type": "string", + "title": "uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }, + "v": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + } + } + } + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "txpool_inspect", + "tags": [], + "summary": "Inspect retrieves the content of the transaction pool and flattens it into an\neasily inspectable list.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L175](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L175)\n```go\n// Inspect retrieves the content of the transaction pool and flattens it into an\n// easily inspectable list.\nfunc (s *PublicTxPoolAPI) Inspect() map[string]map[string]map[string]string {\n\tcontent := map[string]map[string]map[string]string{\n\t\t\"pending\":\tmake(map[string]map[string]string),\n\t\t\"queued\":\tmake(map[string]map[string]string),\n\t}\n\tpending, queue := s.b.TxPoolContent()\n\n\t// Define a formatter to flatten a transaction into a string\n\tvar format = func(tx *types.Transaction) string {\n\t\tif to := tx.To(); to != nil {\n\t\t\treturn fmt.Sprintf(\"%s: %v wei + %v gas × %v wei\", tx.To().Hex(), tx.Value(), tx.Gas(), tx.GasPrice())\n\t\t}\n\t\treturn fmt.Sprintf(\"contract creation: %v wei + %v gas × %v wei\", tx.Value(), tx.Gas(), tx.GasPrice())\n\t}\n\n\tfor account, txs := range pending {\n\t\tdump := make(map[string]string)\n\t\tfor _, tx := range txs {\n\t\t\tdump[fmt.Sprintf(\"%d\", tx.Nonce())] = format(tx)\n\t\t}\n\t\tcontent[\"pending\"][account.Hex()] = dump\n\t}\n\n\tfor account, txs := range queue {\n\t\tdump := make(map[string]string)\n\t\tfor _, tx := range txs {\n\t\t\tdump[fmt.Sprintf(\"%d\", tx.Nonce())] = format(tx)\n\t\t}\n\t\tcontent[\"queued\"][account.Hex()] = dump\n\t}\n\treturn content\n}\n```", + "externalDocs": { + "description": "line=175", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [], + "result": { + "name": "map[string]map[string]map[string]string", + "summary": "", + "description": "``", + "required": true, + "deprecated": false, + "schema": { + "type": "object", + "patternProperties": { + ".*": { + "type": "object", + "patternProperties": { + ".*": { + "type": "object", + "patternProperties": { + ".*": { + "type": "string" + } + } + } + } + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "txpool_status", + "tags": [], + "summary": "Status returns the number of pending and queued transaction in the pool.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L165](https://github.com/ethereum/go-ethereum/blob/master/internal/ethapi/api.go#L165)\n```go\n// Status returns the number of pending and queued transaction in the pool.\nfunc (s *PublicTxPoolAPI) Status() map[string]hexutil.Uint {\n\tpending, queue := s.b.Stats()\n\treturn map[string]hexutil.Uint{\n\t\t\"pending\":\thexutil.Uint(pending),\n\t\t\"queued\":\thexutil.Uint(queue),\n\t}\n}\n```", + "externalDocs": { + "description": "line=165", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go" + }, + "params": [], + "result": { + "name": "map[string]hexutil.Uint", + "summary": "", + "description": "``", + "required": true, + "deprecated": false, + "schema": { + "type": "object", + "patternProperties": { + ".*": { + "description": "Hex representation of a uint", + "type": "string", + "title": "uint", + "pattern": "^0x([a-fA-F\\d])+$" + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "web3_clientVersion", + "tags": [], + "summary": "ClientVersion returns the node name\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/node/api.go#L309](https://github.com/ethereum/go-ethereum/blob/master/node/api.go#L309)\n```go\n// ClientVersion returns the node name\nfunc (s *PublicWeb3API) ClientVersion() string {\n\treturn s.stack.Server().Name\n}\n```", + "externalDocs": { + "description": "line=309", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go" + }, + "params": [], + "result": { + "name": "string", + "summary": "", + "description": "`string`", + "required": true, + "deprecated": false, + "schema": { + "description": "string", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "web3_sha3", + "tags": [], + "summary": "Sha3 applies the ethereum sha3 implementation on the input.\nIt assumes the input is hex encoded.\n", + "description": "[https://github.com/ethereum/go-ethereum/blob/master/node/api.go#L315](https://github.com/ethereum/go-ethereum/blob/master/node/api.go#L315)\n```go\n// Sha3 applies the ethereum sha3 implementation on the input.\n// It assumes the input is hex encoded.\nfunc (s *PublicWeb3API) Sha3(input hexutil.Bytes) hexutil.Bytes {\n\treturn crypto.Keccak256(input)\n}\n```", + "externalDocs": { + "description": "line=315", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go" + }, + "params": [ + { + "name": "input", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.Bytes`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of some bytes", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + { + "type": "null" + } + ] + } + } + ], + "result": { + "name": "hexutil.Bytes", + "summary": "", + "description": "`github.com/ethereum/go-ethereum/common/hexutil.Bytes`", + "required": true, + "deprecated": false, + "schema": { + "oneOf": [ + { + "description": "Hex representation of some bytes", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d])+$" + }, + { + "type": "null" + } + ] + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + } + ], + "components": {}, + "externalDocs": { + "description": "Source", + "url": "https://github.com/etclabscore/core-geth" + } +} diff --git a/.develop/spec1.json b/.develop/spec1.json new file mode 100644 index 0000000000..5dca410660 --- /dev/null +++ b/.develop/spec1.json @@ -0,0 +1,8447 @@ +{ + "openrpc": "1.2.4", + "info": { + "title": "Ethereum JSON-RPC", + "description": "This API lets you interact with an EVM-based client via JSON-RPC", + "termsOfService": "https://github.com/etclabscore/core-geth/blob/master/COPYING", + "contact": { + "name": "", + "url": "", + "email": "" + }, + "license": { + "name": "Apache-2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" + }, + "version": "1.0.10" + }, + "servers": [ + { + "name": "tcp", + "url": "http://127.0.0.1:8545", + "description": "CoreGeth/v1.11.2-unstable" + } + ], + "methods": [ + { + "name": "admin_addPeer", + "tags": [], + "summary": "AddPeer requests connecting to a remote node, and also maintaining the new\nconnection at all times, even reconnecting if it is lost.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).AddPeer", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:45" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "admin_addPeerResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_addTrustedPeer", + "tags": [], + "summary": "AddTrustedPeer allows a remote node to always connect, even if slots are full\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).AddTrustedPeer", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:77" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "admin_addTrustedPeerResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_datadir", + "tags": [], + "summary": "Datadir retrieves the current data directory the node is using.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PublicAdminAPI).Datadir", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:295" + }, + "params": [], + "result": { + "name": "admin_datadirResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_exportChain", + "tags": [], + "summary": "ExportChain exports the current blockchain into a local file,\nor a range of blocks if first and last are non-nil\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateAdminAPI).ExportChain", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:171" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "first", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:uint64", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "last", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:uint64", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "admin_exportChainResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_importChain", + "tags": [], + "summary": "ImportChain imports a blockchain from a local file.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateAdminAPI).ImportChain", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:219" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "admin_importChainResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_nodeInfo", + "tags": [], + "summary": "NodeInfo retrieves all the information we know about the host node at the\nprotocol granularity.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PublicAdminAPI).NodeInfo", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:285" + }, + "params": [], + "result": { + "name": "admin_nodeInfoResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/p2p:NodeInfo", + "type": "object", + "required": [ + "id", + "name", + "enode", + "enr", + "ip", + "ports", + "listenAddr", + "protocols" + ], + "properties": { + "enode": { + "type": "string" + }, + "enr": { + "type": "string" + }, + "id": { + "type": "string" + }, + "ip": { + "type": "string" + }, + "listenAddr": { + "type": "string" + }, + "name": { + "type": "string" + }, + "ports": { + "$ref": "#/components/schemas/NodeInfoPorts", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "protocols": { + "type": "object", + "patternProperties": { + ".*": { + "additionalProperties": true + } + } + } + }, + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_peers", + "tags": [], + "summary": "Peers retrieves all the information we know about each individual peer at the\nprotocol granularity.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PublicAdminAPI).Peers", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:275" + }, + "params": [], + "result": { + "name": "admin_peersResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_removePeer", + "tags": [], + "summary": "RemovePeer disconnects from a remote node if the connection exists\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).RemovePeer", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:61" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "admin_removePeerResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_removeTrustedPeer", + "tags": [], + "summary": "RemoveTrustedPeer removes a remote node from the trusted peer set, but it\ndoes not disconnect it automatically.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).RemoveTrustedPeer", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:93" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "admin_removeTrustedPeerResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_startRPC", + "tags": [], + "summary": "StartRPC starts the HTTP RPC API server.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).StartRPC", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:146" + }, + "params": [ + { + "name": "host", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "port", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:int", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "cors", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "apis", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "vhosts", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "admin_startRPCResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_startWS", + "tags": [], + "summary": "StartWS starts the websocket RPC API server.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).StartWS", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:208" + }, + "params": [ + { + "name": "host", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "port", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:int", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "allowedOrigins", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "apis", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "admin_startWSResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_stopRPC", + "tags": [], + "summary": "StopRPC terminates an already running HTTP RPC API endpoint.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).StopRPC", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:196" + }, + "params": [], + "result": { + "name": "admin_stopRPCResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_stopWS", + "tags": [], + "summary": "StopWS terminates an already running websocket RPC API endpoint.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).StopWS", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:250" + }, + "params": [], + "result": { + "name": "admin_stopWSResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_accountRange", + "tags": [], + "summary": "AccountRange enumerates all accounts in the latest state\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).AccountRange", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:395" + }, + "params": [ + { + "name": "start", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/common:Hash", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "maxResults", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":int", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_accountRangeResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/eth:AccountRangeResult", + "type": "object", + "required": ["accounts", "next"], + "properties": { + "accounts": { + "type": "object", + "patternProperties": { + ".*": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + }, + "next": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_backtraceAt", + "tags": [], + "summary": "BacktraceAt sets the log backtrace location. See package log for details on\nthe pattern syntax.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).BacktraceAt", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:68" + }, + "params": [ + { + "name": "location", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Null", + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_blockProfile", + "tags": [], + "summary": "BlockProfile turns on goroutine profiling for nsec seconds and writes profile data to\nfile. It uses a profile rate of 1 for most accurate information. If a different rate is\ndesired, set the rate and write the profile manually.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).BlockProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:147" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "nsec", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":uint", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Null", + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_chaindbCompact", + "tags": [], + "summary": "ChaindbCompact flattens the entire key-value database into a single level,\nremoving all unused slots and merging all keys.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateDebugAPI).ChaindbCompact", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1759" + }, + "params": [], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Null", + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_chaindbProperty", + "tags": [], + "summary": "ChaindbProperty returns leveldb properties of the key-value database.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateDebugAPI).ChaindbProperty", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1748" + }, + "params": [ + { + "name": "property", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_chaindbPropertyResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_cpuProfile", + "tags": [], + "summary": "CpuProfile turns on CPU profiling for nsec seconds and writes\nprofile data to file.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).CpuProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:88" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "nsec", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":uint", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Null", + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_dumpBlock", + "tags": [], + "summary": "DumpBlock retrieves the entire state of the database at a given block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PublicDebugAPI).DumpBlock", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:280" + }, + "params": [ + { + "name": "blockNr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc:rpc.BlockNumber", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_dumpBlockResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/core/state:state.Dump", + "type": "object", + "required": ["root", "accounts"], + "properties": { + "accounts": { + "type": "object", + "patternProperties": { + ".*": { + "$ref": "#/components/schemas/DumpAccount", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + }, + "root": { + "type": "string" + } + }, + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_freeOSMemory", + "tags": [], + "summary": "FreeOSMemory returns unused memory to the OS.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).FreeOSMemory", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:200" + }, + "params": [], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Null", + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_gcStats", + "tags": [], + "summary": "GcStats returns GC statistics.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).GcStats", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:80" + }, + "params": [], + "result": { + "name": "debug_gcStatsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*runtime/debug:GCStats", + "type": "object", + "required": [ + "LastGC", + "NumGC", + "PauseTotal", + "Pause", + "PauseEnd", + "PauseQuantiles" + ], + "properties": { + "LastGC": { + "type": "string", + "format": "date-time" + }, + "NumGC": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Pause": { + "type": "array", + "items": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "PauseEnd": { + "type": "array", + "items": { + "type": "string", + "format": "date-time" + } + }, + "PauseQuantiles": { + "type": "array", + "items": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "PauseTotal": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_getBadBlocks", + "tags": [], + "summary": "GetBadBlocks returns a list of the last 'bad blocks' that the client has seen on the network\nand returns them as a JSON list of block-hashes\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).GetBadBlocks", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:333" + }, + "params": [], + "result": { + "name": "debug_getBadBlocksResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_getBlockRlp", + "tags": [], + "summary": "GetBlockRlp retrieves the RLP encoded for of a single block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicDebugAPI).GetBlockRlp", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1666" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":uint64", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_getBlockRlpResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_getModifiedAccountsByHash", + "tags": [], + "summary": "GetModifiedAccountsByHash returns all accounts that have changed between the\ntwo blocks specified. A change is defined as a difference in nonce, balance,\ncode hash, or storage hash.\n\nWith one parameter, returns the list of accounts modified in the specified block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).GetModifiedAccountsByHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:502" + }, + "params": [ + { + "name": "startHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Hash", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "endHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/common:Hash", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_getModifiedAccountsByHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_getModifiedAccountsByNumber", + "tags": [], + "summary": "GetModifiedAccountsByNumber returns all accounts that have changed between the\ntwo blocks specified. A change is defined as a difference in nonce, balance,\ncode hash, or storage hash.\n\nWith one parameter, returns the list of accounts modified in the specified block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).GetModifiedAccountsByNumber", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:474" + }, + "params": [ + { + "name": "startNum", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":uint64", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "endNum", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:uint64", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_getModifiedAccountsByNumberResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_goTrace", + "tags": [], + "summary": "GoTrace turns on tracing for nsec seconds and writes\ntrace data to file.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).GoTrace", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:135" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "nsec", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":uint", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Null", + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_memStats", + "tags": [], + "summary": "MemStats returns detailed runtime memory statistics.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).MemStats", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:73" + }, + "params": [], + "result": { + "name": "debug_memStatsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*runtime:MemStats", + "type": "object", + "required": [ + "Alloc", + "TotalAlloc", + "Sys", + "Lookups", + "Mallocs", + "Frees", + "HeapAlloc", + "HeapSys", + "HeapIdle", + "HeapInuse", + "HeapReleased", + "HeapObjects", + "StackInuse", + "StackSys", + "MSpanInuse", + "MSpanSys", + "MCacheInuse", + "MCacheSys", + "BuckHashSys", + "GCSys", + "OtherSys", + "NextGC", + "LastGC", + "PauseTotalNs", + "PauseNs", + "PauseEnd", + "NumGC", + "NumForcedGC", + "GCCPUFraction", + "EnableGC", + "DebugGC", + "BySize" + ], + "properties": { + "Alloc": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "BuckHashSys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "BySize": { + "type": "array", + "maxItems": 61, + "minItems": 61, + "items": { + "$ref": "#/definitions/", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "DebugGC": { + "type": "boolean" + }, + "EnableGC": { + "type": "boolean" + }, + "Frees": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "GCCPUFraction": { + "type": "number" + }, + "GCSys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "HeapAlloc": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "HeapIdle": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "HeapInuse": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "HeapObjects": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "HeapReleased": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "HeapSys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "LastGC": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Lookups": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "MCacheInuse": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "MCacheSys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "MSpanInuse": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "MSpanSys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Mallocs": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "NextGC": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "NumForcedGC": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "NumGC": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "OtherSys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "PauseEnd": { + "type": "array", + "maxItems": 256, + "minItems": 256, + "items": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "PauseNs": { + "type": "array", + "maxItems": 256, + "minItems": 256, + "items": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "PauseTotalNs": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "StackInuse": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "StackSys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Sys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "TotalAlloc": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_mutexProfile", + "tags": [], + "summary": "MutexProfile turns on mutex profiling for nsec seconds and writes profile data to file.\nIt uses a profile rate of 1 for most accurate information. If a different rate is\ndesired, set the rate and write the profile manually.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).MutexProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:168" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "nsec", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":uint", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Null", + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_preimage", + "tags": [], + "summary": "Preimage is a debug API function that returns the preimage for a sha3 hash, if known.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).Preimage", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:317" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Hash", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_preimageResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common/hexutil:hexutil.Bytes", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_printBlock", + "tags": [], + "summary": "PrintBlock retrieves a block and returns its pretty printed form.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicDebugAPI).PrintBlock", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1718" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":uint64", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_printBlockResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_seedHash", + "tags": [], + "summary": "SeedHash retrieves the seed hash of a block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicDebugAPI).SeedHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1727" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":uint64", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_seedHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_setBlockProfileRate", + "tags": [], + "summary": "SetBlockProfileRate sets the rate of goroutine block profile data collection.\nrate 0 disables block profiling.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).SetBlockProfileRate", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:156" + }, + "params": [ + { + "name": "rate", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":int", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Null", + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_setGCPercent", + "tags": [], + "summary": "SetGCPercent sets the garbage collection target percentage. It returns the previous\nsetting. A negative value disables GC.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).SetGCPercent", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:206" + }, + "params": [ + { + "name": "v", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":int", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_setGCPercentResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":int", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_setHead", + "tags": [], + "summary": "SetHead rewinds the head of the blockchain to a previous block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateDebugAPI).SetHead", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1771" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common/hexutil:hexutil.Uint64", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Null", + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_setMutexProfileFraction", + "tags": [], + "summary": "SetMutexProfileFraction sets the rate of mutex profiling.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).SetMutexProfileFraction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:177" + }, + "params": [ + { + "name": "rate", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":int", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Null", + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_stacks", + "tags": [], + "summary": "Stacks returns a printed representation of the stacks of all goroutines.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).Stacks", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:193" + }, + "params": [], + "result": { + "name": "debug_stacksResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_standardTraceBadBlockToFile", + "tags": [], + "summary": "StandardTraceBadBlockToFile dumps the structured logs created during the\nexecution of EVM against a block pulled from the pool of bad ones to the\nlocal file system and returns a list of files to the caller.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).StandardTraceBadBlockToFile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:432" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Hash", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/eth:StdTraceConfig", + "type": "object", + "required": [ + "DisableMemory", + "DisableStack", + "DisableStorage", + "Debug", + "Limit", + "Reexec", + "TxHash" + ], + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "TxHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_standardTraceBadBlockToFileResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_standardTraceBlockToFile", + "tags": [], + "summary": "StandardTraceBlockToFile dumps the structured logs created during the\nexecution of EVM to the local file system and returns a list of files\nto the caller.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).StandardTraceBlockToFile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:421" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Hash", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/eth:StdTraceConfig", + "type": "object", + "required": [ + "DisableMemory", + "DisableStack", + "DisableStorage", + "Debug", + "Limit", + "Reexec", + "TxHash" + ], + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "TxHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_standardTraceBlockToFileResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_startCPUProfile", + "tags": [], + "summary": "StartCPUProfile turns on CPU profiling, writing to the given file.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).StartCPUProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:98" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Null", + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_startGoTrace", + "tags": [], + "summary": "StartGoTrace turns on tracing, writing to the given file.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).StartGoTrace", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/trace.go:30" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Null", + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_stopCPUProfile", + "tags": [], + "summary": "StopCPUProfile stops an ongoing CPU profile.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).StopCPUProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:119" + }, + "params": [], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Null", + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_stopGoTrace", + "tags": [], + "summary": "StopTrace stops an ongoing trace.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).StopGoTrace", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/trace.go:51" + }, + "params": [], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Null", + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_storageRangeAt", + "tags": [], + "summary": "StorageRangeAt returns the storage at the given block height and transaction index.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).StorageRangeAt", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:434" + }, + "params": [ + { + "name": "blockHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Hash", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "txIndex", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":int", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "contractAddress", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "keyStart", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common/hexutil:hexutil.Bytes", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "maxResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":int", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_storageRangeAtResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/eth:StorageRangeResult", + "type": "object", + "required": ["storage", "nextKey"], + "properties": { + "nextKey": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "storage": { + "type": "object", + "patternProperties": { + ".*": { + "$ref": "#/definitions/storageEntry", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + } + }, + "additionalProperties": false, + "definitions": { + "storageEntry": { + "type": "object", + "required": ["key", "value"], + "properties": { + "key": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "additionalProperties": false + } + }, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_testSignCliqueBlock", + "tags": [], + "summary": "TestSignCliqueBlock fetches the given block number, and attempts to sign it as a clique header with the\ngiven address, returning the address of the recovered signature\n\nThis is a temporary method to debug the externalsigner integration,\nTODO: Remove this method when the integration is mature\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicDebugAPI).TestSignCliqueBlock", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1683" + }, + "params": [ + { + "name": "address", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":uint64", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_testSignCliqueBlockResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceBadBlock", + "tags": [], + "summary": "TraceBadBlockByHash returns the structured logs created during the execution of\nEVM against a block pulled from the pool of bad ones and returns them as a JSON\nobject.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).TraceBadBlock", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:408" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Hash", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/eth:TraceConfig", + "type": "object", + "required": [ + "DisableMemory", + "DisableStack", + "DisableStorage", + "Debug", + "Limit", + "Tracer", + "Timeout", + "Reexec" + ], + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Timeout": { + "type": "string" + }, + "Tracer": { + "type": "string" + } + }, + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_traceBadBlockResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceBlock", + "tags": [], + "summary": "TraceBlock returns the structured logs created during the execution of EVM\nand returns them as a JSON object.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).TraceBlock", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:387" + }, + "params": [ + { + "name": "blob", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/eth:TraceConfig", + "type": "object", + "required": [ + "DisableMemory", + "DisableStack", + "DisableStorage", + "Debug", + "Limit", + "Tracer", + "Timeout", + "Reexec" + ], + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Timeout": { + "type": "string" + }, + "Tracer": { + "type": "string" + } + }, + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_traceBlockResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceBlockByHash", + "tags": [], + "summary": "TraceBlockByHash returns the structured logs created during the execution of\nEVM and returns them as a JSON object.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).TraceBlockByHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:377" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Hash", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/eth:TraceConfig", + "type": "object", + "required": [ + "DisableMemory", + "DisableStack", + "DisableStorage", + "Debug", + "Limit", + "Tracer", + "Timeout", + "Reexec" + ], + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Timeout": { + "type": "string" + }, + "Tracer": { + "type": "string" + } + }, + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_traceBlockByHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceBlockByNumber", + "tags": [], + "summary": "TraceBlockByNumber returns the structured logs created during the execution of\nEVM and returns them as a JSON object.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).TraceBlockByNumber", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:356" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc:rpc.BlockNumber", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/eth:TraceConfig", + "type": "object", + "required": [ + "DisableMemory", + "DisableStack", + "DisableStorage", + "Debug", + "Limit", + "Tracer", + "Timeout", + "Reexec" + ], + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Timeout": { + "type": "string" + }, + "Tracer": { + "type": "string" + } + }, + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_traceBlockByNumberResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceBlockFromFile", + "tags": [], + "summary": "TraceBlockFromFile returns the structured logs created during the execution of\nEVM and returns them as a JSON object.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).TraceBlockFromFile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:397" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/eth:TraceConfig", + "type": "object", + "required": [ + "DisableMemory", + "DisableStack", + "DisableStorage", + "Debug", + "Limit", + "Tracer", + "Timeout", + "Reexec" + ], + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Timeout": { + "type": "string" + }, + "Tracer": { + "type": "string" + } + }, + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_traceBlockFromFileResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceTransaction", + "tags": [], + "summary": "FIXME: Is this really supposed to return an *ethapi.ExecutionResult type, or the empty interface in case not *vm.StructLogger?\nTraceTransaction returns the structured logs created during the execution of EVM\nand returns them as a JSON object.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).TraceTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:706" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Hash", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/eth:TraceConfig", + "type": "object", + "required": [ + "DisableMemory", + "DisableStack", + "DisableStorage", + "Debug", + "Limit", + "Tracer", + "Timeout", + "Reexec" + ], + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Timeout": { + "type": "string" + }, + "Tracer": { + "type": "string" + } + }, + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_traceTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/internal/ethapi:ExecutionResult", + "type": "object", + "required": ["gas", "failed", "returnValue", "structLogs"], + "properties": { + "failed": { + "type": "boolean" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "returnValue": { + "type": "string" + }, + "structLogs": { + "type": "array", + "items": { + "$ref": "#/definitions/StructLogRes", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + }, + "additionalProperties": false, + "definitions": { + "StructLogRes": { + "type": "object", + "required": ["pc", "op", "gas", "gasCost", "depth"], + "properties": { + "depth": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "error": { + "additionalProperties": true + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasCost": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "memory": { + "type": "array", + "items": { + "type": "string" + } + }, + "op": { + "type": "string" + }, + "pc": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "stack": { + "type": "array", + "items": { + "type": "string" + } + }, + "storage": { + "type": "object", + "patternProperties": { + ".*": { + "type": "string" + } + } + } + }, + "additionalProperties": false + } + }, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_verbosity", + "tags": [], + "summary": "Verbosity sets the log verbosity ceiling. The verbosity of individual packages\nand source files can be raised using Vmodule.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).Verbosity", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:57" + }, + "params": [ + { + "name": "level", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":int", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Null", + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_vmodule", + "tags": [], + "summary": "Vmodule sets the log verbosity pattern. See package log for details on the\npattern syntax.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).Vmodule", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:62" + }, + "params": [ + { + "name": "pattern", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Null", + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_writeBlockProfile", + "tags": [], + "summary": "WriteBlockProfile writes a goroutine blocking profile to the given file.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).WriteBlockProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:161" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Null", + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_writeMemProfile", + "tags": [], + "summary": "WriteMemProfile writes an allocation profile to the given file.\nNote that the profiling rate cannot be set through the API,\nit must be set on the command line.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).WriteMemProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:188" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Null", + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_writeMutexProfile", + "tags": [], + "summary": "WriteMutexProfile writes a goroutine blocking profile to the given file.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).WriteMutexProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:181" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Null", + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_accounts", + "tags": [], + "summary": "Accounts returns the collection of accounts this node manages\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicAccountAPI).Accounts", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:193" + }, + "params": [], + "result": { + "name": "eth_accountsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_blockNumber", + "tags": [], + "summary": "BlockNumber returns the block number of the chain head.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).BlockNumber", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:525" + }, + "params": [], + "result": { + "name": "eth_blockNumberResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common/hexutil:hexutil.Uint64", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_call", + "tags": [], + "summary": "Call executes the given transaction on the state for the given block number.\n\nAdditionally, the caller can specify a batch of contract for fields overriding.\n\nNote, this function doesn't make and changes in the state/blockchain and is\nuseful to execute and retrieve values.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).Call", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:877" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi:CallArgs", + "type": "object", + "required": ["from", "to", "gas", "gasPrice", "value", "data"], + "properties": { + "data": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "from": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "blockNrOrHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc:rpc.BlockNumberOrHash", + "type": "object", + "properties": { + "blockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "blockNumber": { + "title": "blockNumberOrTag", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + } + ] + }, + "requireCanonical": { + "type": "boolean" + } + }, + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "overrides", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_callResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common/hexutil:hexutil.Bytes", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_chainId", + "tags": [], + "summary": "ChainId is the EIP-155 replay-protection chain id for the current ethereum chain config.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PublicEthereumAPI).ChainId", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:70" + }, + "params": [], + "result": { + "name": "eth_chainIdResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common/hexutil:hexutil.Uint64", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_coinbase", + "tags": [], + "summary": "Coinbase is the address that mining rewards will be send to (alias for Etherbase)\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PublicEthereumAPI).Coinbase", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:60" + }, + "params": [], + "result": { + "name": "eth_coinbaseResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_estimateGas", + "tags": [], + "summary": "EstimateGas returns an estimate of the amount of gas needed to execute the\ngiven transaction against the current pending block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).EstimateGas", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:951" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi:CallArgs", + "type": "object", + "required": ["from", "to", "gas", "gasPrice", "value", "data"], + "properties": { + "data": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "from": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_estimateGasResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common/hexutil:hexutil.Uint64", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_etherbase", + "tags": [], + "summary": "Etherbase is the address that mining rewards will be send to\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PublicEthereumAPI).Etherbase", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:55" + }, + "params": [], + "result": { + "name": "eth_etherbaseResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_fillTransaction", + "tags": [], + "summary": "FillTransaction fills the defaults (nonce, gas, gasPrice) on a given unsigned transaction,\nand returns it to the caller for further processing (signing + broadcast)\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).FillTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1500" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi:SendTxArgs", + "type": "object", + "required": [ + "from", + "to", + "gas", + "gasPrice", + "value", + "nonce", + "data", + "input" + ], + "properties": { + "data": { + "description": "Field 'input' should be preferred", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_fillTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/internal/ethapi:SignTransactionResult", + "type": "object", + "required": ["raw", "tx"], + "properties": { + "raw": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "tx": { + "$ref": "#/definitions/Transaction", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "additionalProperties": false, + "definitions": { + "Transaction": { + "type": "object", + "additionalProperties": false + } + }, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_gasPrice", + "tags": [], + "summary": "GasPrice returns a suggestion for a gas price.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicEthereumAPI).GasPrice", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:66" + }, + "params": [], + "result": { + "name": "eth_gasPriceResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/common/hexutil:Big", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getBalance", + "tags": [], + "summary": "GetBalance returns the amount of wei for the given address in the state of the\ngiven block number. The rpc.LatestBlockNumber and rpc.PendingBlockNumber meta\nblock numbers are also allowed.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetBalance", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:533" + }, + "params": [ + { + "name": "address", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "blockNrOrHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc:rpc.BlockNumberOrHash", + "type": "object", + "properties": { + "blockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "blockNumber": { + "title": "blockNumberOrTag", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + } + ] + }, + "requireCanonical": { + "type": "boolean" + } + }, + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_getBalanceResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/common/hexutil:Big", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getBlockByHash", + "tags": [], + "summary": "GetBlockByHash returns the requested block. When fullTx is true all transactions in the block are returned in full\ndetail, otherwise only the transaction hash is returned.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetBlockByHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:656" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Hash", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "fullTx", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_getBlockByHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getBlockByNumber", + "tags": [], + "summary": "GetBlockByNumber returns the requested canonical block.\n* When blockNr is -1 the chain head is returned.\n* When blockNr is -2 the pending chain head is returned.\n* When fullTx is true all transactions in the block are returned, otherwise\n only the transaction hash is returned.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetBlockByNumber", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:639" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc:rpc.BlockNumber", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "fullTx", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_getBlockByNumberResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getBlockTransactionCountByHash", + "tags": [], + "summary": "GetBlockTransactionCountByHash returns the number of transactions in the block with the given hash.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetBlockTransactionCountByHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1201" + }, + "params": [ + { + "name": "blockHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Hash", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_getBlockTransactionCountByHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/common/hexutil:Uint", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getBlockTransactionCountByNumber", + "tags": [], + "summary": "GetBlockTransactionCountByNumber returns the number of transactions in the block with the given block number.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetBlockTransactionCountByNumber", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1192" + }, + "params": [ + { + "name": "blockNr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc:rpc.BlockNumber", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_getBlockTransactionCountByNumberResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/common/hexutil:Uint", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getCode", + "tags": [], + "summary": "GetCode returns the code stored at the given address in the state for the given block number.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetCode", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:715" + }, + "params": [ + { + "name": "address", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "blockNrOrHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc:rpc.BlockNumberOrHash", + "type": "object", + "properties": { + "blockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "blockNumber": { + "title": "blockNumberOrTag", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + } + ] + }, + "requireCanonical": { + "type": "boolean" + } + }, + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_getCodeResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common/hexutil:hexutil.Bytes", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getFilterChanges", + "tags": [], + "summary": "GetFilterChanges returns the logs for the filter with the given id since\nlast time it was called. This can be used for polling.\n\nFor pending transaction and block filters the result is []common.Hash.\n(pending)Log filters return []Log.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_getfilterchanges\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth/filters.(*PublicFilterAPI).GetFilterChanges", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go:413" + }, + "params": [ + { + "name": "id", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc:rpc.ID", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_getFilterChangesResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getFilterLogs", + "tags": [], + "summary": "GetFilterLogs returns the logs for the filter with the given id.\nIf the filter could not be found an empty array of logs is returned.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_getfilterlogs\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth/filters.(*PublicFilterAPI).GetFilterLogs", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go:372" + }, + "params": [ + { + "name": "id", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc:rpc.ID", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_getFilterLogsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getHashrate", + "tags": [], + "summary": "GetHashrate returns the current hashrate for local CPU miner and remote miner.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).GetHashrate", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:110" + }, + "params": [], + "result": { + "name": "eth_getHashrateResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":uint64", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getHeaderByHash", + "tags": [], + "summary": "GetHeaderByHash returns the requested header by hash.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetHeaderByHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:626" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Hash", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_getHeaderByHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getHeaderByNumber", + "tags": [], + "summary": "GetHeaderByNumber returns the requested canonical block header.\n* When blockNr is -1 the chain head is returned.\n* When blockNr is -2 the pending chain head is returned.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetHeaderByNumber", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:610" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc:rpc.BlockNumber", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_getHeaderByNumberResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getLogs", + "tags": [], + "summary": "GetLogs returns logs matching the given argument that are stored within the state.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_getlogs\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth/filters.(*PublicFilterAPI).GetLogs", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go:325" + }, + "params": [ + { + "name": "crit", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/eth/filters:FilterCriteria", + "type": "object", + "required": [ + "BlockHash", + "FromBlock", + "ToBlock", + "Addresses", + "Topics" + ], + "properties": { + "Addresses": { + "type": "array", + "items": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + "BlockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "FromBlock": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "ToBlock": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Topics": { + "type": "array", + "items": { + "type": "array", + "items": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + } + }, + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_getLogsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getProof", + "tags": [], + "summary": "GetProof returns the Merkle-proof for a given account and optionally some storage keys.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetProof", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:558" + }, + "params": [ + { + "name": "address", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "storageKeys", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "blockNrOrHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc:rpc.BlockNumberOrHash", + "type": "object", + "properties": { + "blockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "blockNumber": { + "title": "blockNumberOrTag", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + } + ] + }, + "requireCanonical": { + "type": "boolean" + } + }, + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_getProofResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/internal/ethapi:AccountResult", + "type": "object", + "required": [ + "address", + "accountProof", + "balance", + "codeHash", + "nonce", + "storageHash", + "storageProof" + ], + "properties": { + "accountProof": { + "type": "array", + "items": { + "type": "string" + } + }, + "address": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "balance": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "codeHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "storageHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "storageProof": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageResult", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + }, + "additionalProperties": false, + "definitions": { + "StorageResult": { + "type": "object", + "required": ["key", "value", "proof"], + "properties": { + "key": { + "type": "string" + }, + "proof": { + "type": "array", + "items": { + "type": "string" + } + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getRawTransactionByBlockHashAndIndex", + "tags": [], + "summary": "GetRawTransactionByBlockHashAndIndex returns the bytes of the transaction for the given block hash and index.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetRawTransactionByBlockHashAndIndex", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1234" + }, + "params": [ + { + "name": "blockHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Hash", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "index", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common/hexutil:hexutil.Uint", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_getRawTransactionByBlockHashAndIndexResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common/hexutil:hexutil.Bytes", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getRawTransactionByBlockNumberAndIndex", + "tags": [], + "summary": "GetRawTransactionByBlockNumberAndIndex returns the bytes of the transaction for the given block number and index.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetRawTransactionByBlockNumberAndIndex", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1226" + }, + "params": [ + { + "name": "blockNr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc:rpc.BlockNumber", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "index", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common/hexutil:hexutil.Uint", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_getRawTransactionByBlockNumberAndIndexResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common/hexutil:hexutil.Bytes", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getRawTransactionByHash", + "tags": [], + "summary": "GetRawTransactionByHash returns the bytes of the transaction for the given hash.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetRawTransactionByHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1280" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Hash", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_getRawTransactionByHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common/hexutil:hexutil.Bytes", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getStorageAt", + "tags": [], + "summary": "GetStorageAt returns the storage from the state at the given address, key and\nblock number. The rpc.LatestBlockNumber and rpc.PendingBlockNumber meta block\nnumbers are also allowed.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetStorageAt", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:727" + }, + "params": [ + { + "name": "address", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "key", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "blockNrOrHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc:rpc.BlockNumberOrHash", + "type": "object", + "properties": { + "blockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "blockNumber": { + "title": "blockNumberOrTag", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + } + ] + }, + "requireCanonical": { + "type": "boolean" + } + }, + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_getStorageAtResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common/hexutil:hexutil.Bytes", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getTransactionByBlockHashAndIndex", + "tags": [], + "summary": "GetTransactionByBlockHashAndIndex returns the transaction for the given block hash and index.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetTransactionByBlockHashAndIndex", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1218" + }, + "params": [ + { + "name": "blockHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Hash", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "index", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common/hexutil:hexutil.Uint", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_getTransactionByBlockHashAndIndexResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/internal/ethapi:RPCTransaction", + "type": "object", + "required": [ + "blockHash", + "blockNumber", + "from", + "gas", + "gasPrice", + "hash", + "input", + "nonce", + "to", + "transactionIndex", + "value", + "v", + "r", + "s" + ], + "properties": { + "blockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "blockNumber": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "hash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "r": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "s": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "transactionIndex": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "v": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getTransactionByBlockNumberAndIndex", + "tags": [], + "summary": "GetTransactionByBlockNumberAndIndex returns the transaction for the given block number and index.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetTransactionByBlockNumberAndIndex", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1210" + }, + "params": [ + { + "name": "blockNr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc:rpc.BlockNumber", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "index", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common/hexutil:hexutil.Uint", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_getTransactionByBlockNumberAndIndexResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/internal/ethapi:RPCTransaction", + "type": "object", + "required": [ + "blockHash", + "blockNumber", + "from", + "gas", + "gasPrice", + "hash", + "input", + "nonce", + "to", + "transactionIndex", + "value", + "v", + "r", + "s" + ], + "properties": { + "blockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "blockNumber": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "hash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "r": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "s": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "transactionIndex": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "v": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getTransactionByHash", + "tags": [], + "summary": "GetTransactionByHash returns the transaction for the given hash\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetTransactionByHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1261" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Hash", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_getTransactionByHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/internal/ethapi:RPCTransaction", + "type": "object", + "required": [ + "blockHash", + "blockNumber", + "from", + "gas", + "gasPrice", + "hash", + "input", + "nonce", + "to", + "transactionIndex", + "value", + "v", + "r", + "s" + ], + "properties": { + "blockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "blockNumber": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "hash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "r": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "s": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "transactionIndex": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "v": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getTransactionCount", + "tags": [], + "summary": "GetTransactionCount returns the number of transactions the given address has sent for the given block number\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetTransactionCount", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1242" + }, + "params": [ + { + "name": "address", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "blockNrOrHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc:rpc.BlockNumberOrHash", + "type": "object", + "properties": { + "blockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "blockNumber": { + "title": "blockNumberOrTag", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + } + ] + }, + "requireCanonical": { + "type": "boolean" + } + }, + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_getTransactionCountResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/common/hexutil:Uint64", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getTransactionReceipt", + "tags": [], + "summary": "GetTransactionReceipt returns the transaction receipt for the given transaction hash.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetTransactionReceipt", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1297" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Hash", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_getTransactionReceiptResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getUncleByBlockHashAndIndex", + "tags": [], + "summary": "GetUncleByBlockHashAndIndex returns the uncle block for the given block hash and index. When fullTx is true\nall transactions in the block are returned in full detail, otherwise only the transaction hash is returned.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetUncleByBlockHashAndIndex", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:682" + }, + "params": [ + { + "name": "blockHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Hash", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "index", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common/hexutil:hexutil.Uint", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_getUncleByBlockHashAndIndexResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getUncleByBlockNumberAndIndex", + "tags": [], + "summary": "GetUncleByBlockNumberAndIndex returns the uncle block for the given block hash and index. When fullTx is true\nall transactions in the block are returned in full detail, otherwise only the transaction hash is returned.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetUncleByBlockNumberAndIndex", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:666" + }, + "params": [ + { + "name": "blockNr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc:rpc.BlockNumber", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "index", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common/hexutil:hexutil.Uint", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_getUncleByBlockNumberAndIndexResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getUncleCountByBlockHash", + "tags": [], + "summary": "GetUncleCountByBlockHash returns number of uncles in the block for the given block hash\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetUncleCountByBlockHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:706" + }, + "params": [ + { + "name": "blockHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Hash", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_getUncleCountByBlockHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/common/hexutil:Uint", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getUncleCountByBlockNumber", + "tags": [], + "summary": "GetUncleCountByBlockNumber returns number of uncles in the block for the given block number\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetUncleCountByBlockNumber", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:697" + }, + "params": [ + { + "name": "blockNr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc:rpc.BlockNumber", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_getUncleCountByBlockNumberResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/common/hexutil:Uint", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getWork", + "tags": [], + "summary": "GetWork returns a work package for external miner.\n\nThe work package consists of 3 strings:\n result[0] - 32 bytes hex encoded current block header pow-hash\n result[1] - 32 bytes hex encoded seed hash used for DAG\n result[2] - 32 bytes hex encoded boundary condition (\"target\"), 2^256/difficulty\n result[3] - hex encoded block number\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).GetWork", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:41" + }, + "params": [], + "result": { + "name": "eth_getWorkResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_hashrate", + "tags": [], + "summary": "Hashrate returns the POW hashrate\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PublicEthereumAPI).Hashrate", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:65" + }, + "params": [], + "result": { + "name": "eth_hashrateResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common/hexutil:hexutil.Uint64", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_mining", + "tags": [], + "summary": "Mining returns an indication if this node is currently mining.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PublicMinerAPI).Mining", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:91" + }, + "params": [], + "result": { + "name": "eth_miningResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_newBlockFilter", + "tags": [], + "summary": "NewBlockFilter creates a filter that fetches blocks that are imported into the chain.\nIt is part of the filter package since polling goes with eth_getFilterChanges.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_newblockfilter\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth/filters.(*PublicFilterAPI).NewBlockFilter", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go:174" + }, + "params": [], + "result": { + "name": "eth_newBlockFilterResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc:rpc.ID", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_newFilter", + "tags": [], + "summary": "NewFilter creates a new filter and returns the filter id. It can be\nused to retrieve logs when the state changes. This method cannot be\nused to fetch logs that are already stored in the state.\n\nDefault criteria for the from and to block are \"latest\".\nUsing \"latest\" as block number will return logs for mined blocks.\nUsing \"pending\" as block number returns logs for not yet mined (pending) blocks.\nIn case logs are removed (chain reorg) previously returned logs are returned\nagain but with the removed property set to true.\n\nIn case \"fromBlock\" \u003e \"toBlock\" an error is returned.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_newfilter\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth/filters.(*PublicFilterAPI).NewFilter", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go:290" + }, + "params": [ + { + "name": "crit", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/eth/filters:FilterCriteria", + "type": "object", + "required": [ + "BlockHash", + "FromBlock", + "ToBlock", + "Addresses", + "Topics" + ], + "properties": { + "Addresses": { + "type": "array", + "items": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + "BlockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "FromBlock": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "ToBlock": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Topics": { + "type": "array", + "items": { + "type": "array", + "items": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + } + }, + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_newFilterResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc:rpc.ID", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_newPendingTransactionFilter", + "tags": [], + "summary": "NewPendingTransactionFilter creates a filter that fetches pending transaction hashes\nas transactions enter the pending state.\n\nIt is part of the filter package because this filter can be used through the\n`eth_getFilterChanges` polling method that is also used for log filters.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_newpendingtransactionfilter\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth/filters.(*PublicFilterAPI).NewPendingTransactionFilter", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go:104" + }, + "params": [], + "result": { + "name": "eth_newPendingTransactionFilterResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc:rpc.ID", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_pendingTransactions", + "tags": [], + "summary": "PendingTransactions returns the transactions that are in the transaction pool\nand have a from address that is one of the accounts this node manages.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).PendingTransactions", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1584" + }, + "params": [], + "result": { + "name": "eth_pendingTransactionsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_protocolVersion", + "tags": [], + "summary": "ProtocolVersion returns the current Ethereum protocol version this node supports\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicEthereumAPI).ProtocolVersion", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:72" + }, + "params": [], + "result": { + "name": "eth_protocolVersionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common/hexutil:hexutil.Uint", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_resend", + "tags": [], + "summary": "Resend accepts an existing transaction and a new gas price and limit. It will remove\nthe given transaction from the pool and reinsert it with the new gas price and limit.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).Resend", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1611" + }, + "params": [ + { + "name": "sendArgs", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi:SendTxArgs", + "type": "object", + "required": [ + "from", + "to", + "gas", + "gasPrice", + "value", + "nonce", + "data", + "input" + ], + "properties": { + "data": { + "description": "Field 'input' should be preferred", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "gasPrice", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/common/hexutil:Big", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "gasLimit", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/common/hexutil:Uint64", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_resendResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Hash", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_sendRawTransaction", + "tags": [], + "summary": "SendRawTransaction will add the signed transaction to the transaction pool.\nThe sender is responsible for signing the transaction and using the correct nonce.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).SendRawTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1516" + }, + "params": [ + { + "name": "encodedTx", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common/hexutil:hexutil.Bytes", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_sendRawTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Hash", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_sendTransaction", + "tags": [], + "summary": "SendTransaction creates a transaction for the given argument, sign it and submit it to the\ntransaction pool.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).SendTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1468" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi:SendTxArgs", + "type": "object", + "required": [ + "from", + "to", + "gas", + "gasPrice", + "value", + "nonce", + "data", + "input" + ], + "properties": { + "data": { + "description": "Field 'input' should be preferred", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_sendTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Hash", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_sign", + "tags": [], + "summary": "Sign calculates an ECDSA signature for:\nkeccack256(\"\\x19Ethereum Signed Message:\\n\" + len(message) + message).\n\nNote, the produced signature conforms to the secp256k1 curve R, S and V values,\nwhere the V value will be 27 or 28 for legacy reasons.\n\nThe account associated with addr must be unlocked.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).Sign", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1533" + }, + "params": [ + { + "name": "addr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "data", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common/hexutil:hexutil.Bytes", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_signResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common/hexutil:hexutil.Bytes", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_signTransaction", + "tags": [], + "summary": "SignTransaction will sign the given transaction with the from account.\nThe node needs to have the private key of the account corresponding with\nthe given from address and it needs to be unlocked.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).SignTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1558" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi:SendTxArgs", + "type": "object", + "required": [ + "from", + "to", + "gas", + "gasPrice", + "value", + "nonce", + "data", + "input" + ], + "properties": { + "data": { + "description": "Field 'input' should be preferred", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_signTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/internal/ethapi:SignTransactionResult", + "type": "object", + "required": ["raw", "tx"], + "properties": { + "raw": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "tx": { + "$ref": "#/definitions/Transaction", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "additionalProperties": false, + "definitions": { + "Transaction": { + "type": "object", + "additionalProperties": false + } + }, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_submitHashRate", + "tags": [], + "summary": "SubmitHashrate can be used for remote miners to submit their hash rate.\nThis enables the node to report the combined hash rate of all miners\nwhich submit work through this node.\n\nIt accepts the miner hash rate and an identifier which must be unique\nbetween nodes.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).SubmitHashRate", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:92" + }, + "params": [ + { + "name": "rate", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common/hexutil:hexutil.Uint64", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "id", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Hash", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_submitHashRateResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_submitWork", + "tags": [], + "summary": "SubmitWork can be used by external miner to submit their POW solution.\nIt returns an indication if the work was accepted.\nNote either an invalid solution, a stale work a non-existent work will return false.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).SubmitWork", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:66" + }, + "params": [ + { + "name": "nonce", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/core/types:types.BlockNonce", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Hash", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "digest", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Hash", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_submitWorkResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_syncing", + "tags": [], + "summary": "Syncing returns false in case the node is currently not syncing with the network. It can be up to date or has not\nyet received the latest block headers from its pears. In case it is synchronizing:\n- startingBlock: block number this node started to synchronise from\n- currentBlock: block number this node is currently importing\n- highestBlock: block number of the highest block header this node has received from peers\n- pulledStates: number of state entries processed until now\n- knownStates: number of known state entries that still need to be pulled\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicEthereumAPI).Syncing", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:83" + }, + "params": [], + "result": { + "name": "eth_syncingResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_uninstallFilter", + "tags": [], + "summary": "UninstallFilter removes the filter with the given filter id.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_uninstallfilter\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth/filters.(*PublicFilterAPI).UninstallFilter", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go:354" + }, + "params": [ + { + "name": "id", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc:rpc.ID", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_uninstallFilterResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "ethash_getHashrate", + "tags": [], + "summary": "GetHashrate returns the current hashrate for local CPU miner and remote miner.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).GetHashrate", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:110" + }, + "params": [], + "result": { + "name": "ethash_getHashrateResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":uint64", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "ethash_getWork", + "tags": [], + "summary": "GetWork returns a work package for external miner.\n\nThe work package consists of 3 strings:\n result[0] - 32 bytes hex encoded current block header pow-hash\n result[1] - 32 bytes hex encoded seed hash used for DAG\n result[2] - 32 bytes hex encoded boundary condition (\"target\"), 2^256/difficulty\n result[3] - hex encoded block number\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).GetWork", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:41" + }, + "params": [], + "result": { + "name": "ethash_getWorkResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "ethash_submitHashRate", + "tags": [], + "summary": "SubmitHashrate can be used for remote miners to submit their hash rate.\nThis enables the node to report the combined hash rate of all miners\nwhich submit work through this node.\n\nIt accepts the miner hash rate and an identifier which must be unique\nbetween nodes.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).SubmitHashRate", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:92" + }, + "params": [ + { + "name": "rate", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common/hexutil:hexutil.Uint64", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "id", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Hash", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "ethash_submitHashRateResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "ethash_submitWork", + "tags": [], + "summary": "SubmitWork can be used by external miner to submit their POW solution.\nIt returns an indication if the work was accepted.\nNote either an invalid solution, a stale work a non-existent work will return false.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).SubmitWork", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:66" + }, + "params": [ + { + "name": "nonce", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/core/types:types.BlockNonce", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Hash", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "digest", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Hash", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "ethash_submitWorkResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_getHashrate", + "tags": [], + "summary": "GetHashrate returns the current hashrate of the miner.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateMinerAPI).GetHashrate", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:153" + }, + "params": [], + "result": { + "name": "miner_getHashrateResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":uint64", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_setEtherbase", + "tags": [], + "summary": "SetEtherbase sets the etherbase of the miner\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateMinerAPI).SetEtherbase", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:142" + }, + "params": [ + { + "name": "etherbase", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "miner_setEtherbaseResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_setExtra", + "tags": [], + "summary": "SetExtra sets the extra data string that is included when this miner mines a block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateMinerAPI).SetExtra", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:124" + }, + "params": [ + { + "name": "extra", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "miner_setExtraResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_setGasPrice", + "tags": [], + "summary": "SetGasPrice sets the minimum accepted gas price for the miner.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateMinerAPI).SetGasPrice", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:132" + }, + "params": [ + { + "name": "gasPrice", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common/hexutil:hexutil.Big", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "miner_setGasPriceResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_setRecommitInterval", + "tags": [], + "summary": "SetRecommitInterval updates the interval for miner sealing work recommitting.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateMinerAPI).SetRecommitInterval", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:148" + }, + "params": [ + { + "name": "interval", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":int", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Null", + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_start", + "tags": [], + "summary": "Start starts the miner with the given number of threads. If threads is nil,\nthe number of workers started is equal to the number of logical CPUs that are\nusable by this process. If mining is already running, this method adjust the\nnumber of threads allowed to use and updates the minimum price required by the\ntransaction pool.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateMinerAPI).Start", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:110" + }, + "params": [ + { + "name": "threads", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:int", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Null", + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_stop", + "tags": [], + "summary": "Stop terminates the miner, both at the consensus engine level as well as at\nthe block creation level.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateMinerAPI).Stop", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:119" + }, + "params": [], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Null", + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "net_listening", + "tags": [], + "summary": "Listening returns an indication if the node is listening for network connections.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicNetAPI).Listening", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1788" + }, + "params": [], + "result": { + "name": "net_listeningResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "net_peerCount", + "tags": [], + "summary": "PeerCount returns the number of connected peers\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicNetAPI).PeerCount", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1792" + }, + "params": [], + "result": { + "name": "net_peerCountResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common/hexutil:hexutil.Uint", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "net_version", + "tags": [], + "summary": "Version returns the current ethereum protocol version.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicNetAPI).Version", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1797" + }, + "params": [], + "result": { + "name": "net_versionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_deriveAccount", + "tags": [], + "summary": "DeriveAccount requests a HD wallet to derive a new account, optionally pinning\nit for later reuse.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).DeriveAccount", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:266" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "path", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "pin", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:bool", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "personal_deriveAccountResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/accounts:accounts.Account", + "type": "object", + "required": ["address", "url"], + "properties": { + "address": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "url": { + "$ref": "#/definitions/URL", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "additionalProperties": false, + "definitions": { + "URL": { + "type": "object", + "required": ["Scheme", "Path"], + "properties": { + "Path": { + "type": "string" + }, + "Scheme": { + "type": "string" + } + }, + "additionalProperties": false + } + }, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_ecRecover", + "tags": [], + "summary": "EcRecover returns the address for the account that was used to create the signature.\nNote, this function is compatible with eth_sign and personal_sign. As such it recovers\nthe address of:\nhash = keccak256(\"\\x19Ethereum Signed Message:\\n\"${message length}${message})\naddr = ecrecover(hash, signature)\n\nNote, the signature must conform to the secp256k1 curve R, S and V values, where\nthe V value must be 27 or 28 for legacy reasons.\n\nhttps://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_ecRecover\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).EcRecover", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:444" + }, + "params": [ + { + "name": "data", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common/hexutil:hexutil.Bytes", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "sig", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common/hexutil:hexutil.Bytes", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "personal_ecRecoverResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_importRawKey", + "tags": [], + "summary": "ImportRawKey stores the given hex encoded ECDSA key into the key directory,\nencrypting it with the passphrase.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).ImportRawKey", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:300" + }, + "params": [ + { + "name": "privkey", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "password", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "personal_importRawKeyResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_initializeWallet", + "tags": [], + "summary": "InitializeWallet initializes a new wallet at the provided URL, by generating and returning a new private key.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).InitializeWallet", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:467" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "personal_initializeWalletResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_listAccounts", + "tags": [], + "summary": "listAccounts will return a list of addresses for accounts this node manages.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).ListAccounts", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:216" + }, + "params": [], + "result": { + "name": "personal_listAccountsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_listWallets", + "tags": [], + "summary": "ListWallets will return a list of wallets this node manages.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).ListWallets", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:230" + }, + "params": [], + "result": { + "name": "personal_listWalletsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_lockAccount", + "tags": [], + "summary": "LockAccount will lock the account associated with the given address when it's unlocked.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).LockAccount", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:337" + }, + "params": [ + { + "name": "addr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "personal_lockAccountResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_newAccount", + "tags": [], + "summary": "NewAccount will create a new account and returns the address for the new account.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).NewAccount", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:282" + }, + "params": [ + { + "name": "password", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "personal_newAccountResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_openWallet", + "tags": [], + "summary": "OpenWallet initiates a hardware wallet opening procedure, establishing a USB\nconnection and attempting to authenticate via the provided passphrase. Note,\nthe method may return an extra challenge requiring a second open (e.g. the\nTrezor PIN matrix challenge).\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).OpenWallet", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:252" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "passphrase", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Null", + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_sendTransaction", + "tags": [], + "summary": "SendTransaction will create a transaction from the given arguments and\ntries to sign it with the key associated with args.To. If the given passwd isn't\nable to decrypt the key it fails.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).SendTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:364" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi:SendTxArgs", + "type": "object", + "required": [ + "from", + "to", + "gas", + "gasPrice", + "value", + "nonce", + "data", + "input" + ], + "properties": { + "data": { + "description": "Field 'input' should be preferred", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "passwd", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "personal_sendTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Hash", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_sign", + "tags": [], + "summary": "Sign calculates an Ethereum ECDSA signature for:\nkeccack256(\"\\x19Ethereum Signed Message:\\n\" + len(message) + message))\n\nNote, the produced signature conforms to the secp256k1 curve R, S and V values,\nwhere the V value will be 27 or 28 for legacy reasons.\n\nThe key used to calculate the signature is decrypted with the given password.\n\nhttps://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_sign\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).Sign", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:416" + }, + "params": [ + { + "name": "data", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common/hexutil:hexutil.Bytes", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "addr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "passwd", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "personal_signResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common/hexutil:hexutil.Bytes", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_signAndSendTransaction", + "tags": [], + "summary": "SignAndSendTransaction was renamed to SendTransaction. This method is deprecated\nand will be removed in the future. It primary goal is to give clients time to update.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).SignAndSendTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:462" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi:SendTxArgs", + "type": "object", + "required": [ + "from", + "to", + "gas", + "gasPrice", + "value", + "nonce", + "data", + "input" + ], + "properties": { + "data": { + "description": "Field 'input' should be preferred", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "passwd", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "personal_signAndSendTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Hash", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_signTransaction", + "tags": [], + "summary": "SignTransaction will create a transaction from the given arguments and\ntries to sign it with the key associated with args.To. If the given passwd isn't\nable to decrypt the key it fails. The transaction is returned in RLP-form, not broadcast\nto other nodes\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).SignTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:383" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi:SendTxArgs", + "type": "object", + "required": [ + "from", + "to", + "gas", + "gasPrice", + "value", + "nonce", + "data", + "input" + ], + "properties": { + "data": { + "description": "Field 'input' should be preferred", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "passwd", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "passwd2", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "personal_signTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/internal/ethapi:SignTransactionResult", + "type": "object", + "required": ["raw", "tx"], + "properties": { + "raw": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "tx": { + "$ref": "#/definitions/Transaction", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "additionalProperties": false, + "definitions": { + "Transaction": { + "type": "object", + "additionalProperties": false + } + }, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_unlockAccount", + "tags": [], + "summary": "UnlockAccount will unlock the account associated with the given address with\nthe given password for duration seconds. If duration is nil it will use a\ndefault of 300 seconds. It returns an indication if the account was unlocked.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).UnlockAccount", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:312" + }, + "params": [ + { + "name": "addr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "password", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "duration", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:uint64", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "personal_unlockAccountResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_unpair", + "tags": [], + "summary": "Unpair deletes a pairing between wallet and geth.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).Unpair", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:494" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "pin", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Null", + "type": "null" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "txpool_content", + "tags": [], + "summary": "Content returns the transactions contained within the transaction pool.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTxPoolAPI).Content", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:111" + }, + "params": [], + "result": { + "name": "txpool_contentResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "txpool_inspect", + "tags": [], + "summary": "Inspect retrieves the content of the transaction pool and flattens it into an\neasily inspectable list.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTxPoolAPI).Inspect", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:148" + }, + "params": [], + "result": { + "name": "txpool_inspectResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "txpool_status", + "tags": [], + "summary": "Status returns the number of pending and queued transaction in the pool.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTxPoolAPI).Status", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:138" + }, + "params": [], + "result": { + "name": "txpool_statusResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "web3_clientVersion", + "tags": [], + "summary": "ClientVersion returns the node name\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PublicWeb3API).ClientVersion", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:309" + }, + "params": [], + "result": { + "name": "web3_clientVersionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "web3_sha3", + "tags": [], + "summary": "Sha3 applies the ethereum sha3 implementation on the input.\nIt assumes the input is hex encoded.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PublicWeb3API).Sha3", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:315" + }, + "params": [ + { + "name": "input", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common/hexutil:hexutil.Bytes", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "web3_sha3Result", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common/hexutil:hexutil.Bytes", + "type": "object", + "additionalProperties": false, + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + } + ], + "components": { + "schemas": { + "NodeInfoPorts": { + "type": "object", + "required": ["discovery", "listener"], + "properties": { + "discovery": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "listener": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + }, + "DumpAccount": { + "type": "object", + "required": ["balance", "nonce", "root", "codeHash"], + "properties": { + "address": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "balance": { + "type": "string" + }, + "code": { + "type": "string" + }, + "codeHash": { + "type": "string" + }, + "key": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "root": { + "type": "string" + }, + "storage": { + "type": "object", + "patternProperties": { + ".*": { + "type": "string" + } + } + } + }, + "additionalProperties": false + } + } + }, + "externalDocs": { + "description": "Source", + "url": "https://github.com/etclabscore/core-geth" + } +} diff --git a/.develop/spec2.json b/.develop/spec2.json new file mode 100755 index 0000000000..8414083d8e --- /dev/null +++ b/.develop/spec2.json @@ -0,0 +1,5841 @@ +{ + "openrpc": "1.2.4", + "info": { + "title": "Ethereum JSON-RPC", + "description": "This API lets you interact with an EVM-based client via JSON-RPC", + "termsOfService": "https://github.com/etclabscore/core-geth/blob/master/COPYING", + "contact": { + "name": "", + "url": "", + "email": "" + }, + "license": { + "name": "Apache-2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" + }, + "version": "1.0.10" + }, + "servers": [ + { + "name": "tcp", + "url": "http://127.0.0.1:8545", + "description": "CoreGeth/v1.11.2-unstable" + } + ], + "methods": [ + { + "name": "admin_addPeer", + "tags": [], + "summary": "AddPeer requests connecting to a remote node, and also maintaining the new\nconnection at all times, even reconnecting if it is lost.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).AddPeer", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:45" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + } + ], + "result": { + "name": "admin_addPeerResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/1d850e3a" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_addTrustedPeer", + "tags": [], + "summary": "AddTrustedPeer allows a remote node to always connect, even if slots are full\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).AddTrustedPeer", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:77" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + } + ], + "result": { + "name": "admin_addTrustedPeerResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/1d850e3a" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_datadir", + "tags": [], + "summary": "Datadir retrieves the current data directory the node is using.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PublicAdminAPI).Datadir", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:295" + }, + "params": [], + "result": { + "name": "admin_datadirResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_exportChain", + "tags": [], + "summary": "ExportChain exports the current blockchain into a local file,\nor a range of blocks if first and last are non-nil\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateAdminAPI).ExportChain", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:171" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + }, + { + "name": "first", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/3b25fedd" + } + }, + { + "name": "last", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/3b25fedd" + } + } + ], + "result": { + "name": "admin_exportChainResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/1d850e3a" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_importChain", + "tags": [], + "summary": "ImportChain imports a blockchain from a local file.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateAdminAPI).ImportChain", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:219" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + } + ], + "result": { + "name": "admin_importChainResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/1d850e3a" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_nodeInfo", + "tags": [], + "summary": "NodeInfo retrieves all the information we know about the host node at the\nprotocol granularity.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PublicAdminAPI).NodeInfo", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:285" + }, + "params": [], + "result": { + "name": "admin_nodeInfoResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/19d14d7c" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_peers", + "tags": [], + "summary": "Peers retrieves all the information we know about each individual peer at the\nprotocol granularity.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PublicAdminAPI).Peers", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:275" + }, + "params": [], + "result": { + "name": "admin_peersResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/3d6ca2ce" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_removePeer", + "tags": [], + "summary": "RemovePeer disconnects from a remote node if the connection exists\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).RemovePeer", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:61" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + } + ], + "result": { + "name": "admin_removePeerResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/1d850e3a" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_removeTrustedPeer", + "tags": [], + "summary": "RemoveTrustedPeer removes a remote node from the trusted peer set, but it\ndoes not disconnect it automatically.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).RemoveTrustedPeer", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:93" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + } + ], + "result": { + "name": "admin_removeTrustedPeerResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/1d850e3a" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_startRPC", + "tags": [], + "summary": "StartRPC starts the HTTP RPC API server.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).StartRPC", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:146" + }, + "params": [ + { + "name": "host", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ee62999c" + } + }, + { + "name": "port", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/5ac6539d" + } + }, + { + "name": "cors", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ee62999c" + } + }, + { + "name": "apis", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ee62999c" + } + }, + { + "name": "vhosts", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ee62999c" + } + } + ], + "result": { + "name": "admin_startRPCResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/1d850e3a" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_startWS", + "tags": [], + "summary": "StartWS starts the websocket RPC API server.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).StartWS", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:208" + }, + "params": [ + { + "name": "host", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ee62999c" + } + }, + { + "name": "port", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/5ac6539d" + } + }, + { + "name": "allowedOrigins", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ee62999c" + } + }, + { + "name": "apis", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ee62999c" + } + } + ], + "result": { + "name": "admin_startWSResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/1d850e3a" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_stopRPC", + "tags": [], + "summary": "StopRPC terminates an already running HTTP RPC API endpoint.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).StopRPC", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:196" + }, + "params": [], + "result": { + "name": "admin_stopRPCResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/1d850e3a" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_stopWS", + "tags": [], + "summary": "StopWS terminates an already running websocket RPC API endpoint.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).StopWS", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:250" + }, + "params": [], + "result": { + "name": "admin_stopWSResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/1d850e3a" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_accountRange", + "tags": [], + "summary": "AccountRange enumerates all accounts in the latest state\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).AccountRange", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:395" + }, + "params": [ + { + "name": "start", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/77a4ae92" + } + }, + { + "name": "maxResults", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/2dda9d56" + } + } + ], + "result": { + "name": "debug_accountRangeResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ba54eab6" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_backtraceAt", + "tags": [], + "summary": "BacktraceAt sets the log backtrace location. See package log for details on\nthe pattern syntax.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).BacktraceAt", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:68" + }, + "params": [ + { + "name": "location", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ea9c7b32" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_blockProfile", + "tags": [], + "summary": "BlockProfile turns on goroutine profiling for nsec seconds and writes profile data to\nfile. It uses a profile rate of 1 for most accurate information. If a different rate is\ndesired, set the rate and write the profile manually.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).BlockProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:147" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + }, + { + "name": "nsec", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/7cd1a15c" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ea9c7b32" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_chaindbCompact", + "tags": [], + "summary": "ChaindbCompact flattens the entire key-value database into a single level,\nremoving all unused slots and merging all keys.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateDebugAPI).ChaindbCompact", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1789" + }, + "params": [], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ea9c7b32" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_chaindbProperty", + "tags": [], + "summary": "ChaindbProperty returns leveldb properties of the key-value database.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateDebugAPI).ChaindbProperty", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1778" + }, + "params": [ + { + "name": "property", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + } + ], + "result": { + "name": "debug_chaindbPropertyResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_cpuProfile", + "tags": [], + "summary": "CpuProfile turns on CPU profiling for nsec seconds and writes\nprofile data to file.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).CpuProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:88" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + }, + { + "name": "nsec", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/7cd1a15c" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ea9c7b32" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_dumpBlock", + "tags": [], + "summary": "DumpBlock retrieves the entire state of the database at a given block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PublicDebugAPI).DumpBlock", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:280" + }, + "params": [ + { + "name": "blockNr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/77d20ccc" + } + } + ], + "result": { + "name": "debug_dumpBlockResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/cf91b34a" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_freeOSMemory", + "tags": [], + "summary": "FreeOSMemory returns unused memory to the OS.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).FreeOSMemory", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:200" + }, + "params": [], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ea9c7b32" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_gcStats", + "tags": [], + "summary": "GcStats returns GC statistics.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).GcStats", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:80" + }, + "params": [], + "result": { + "name": "debug_gcStatsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ad646739" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_getBadBlocks", + "tags": [], + "summary": "GetBadBlocks returns a list of the last 'bad blocks' that the client has seen on the network\nand returns them as a JSON list of block-hashes\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).GetBadBlocks", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:333" + }, + "params": [], + "result": { + "name": "debug_getBadBlocksResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/7199b7b0" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_getBlockRlp", + "tags": [], + "summary": "GetBlockRlp retrieves the RLP encoded for of a single block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicDebugAPI).GetBlockRlp", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1696" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/15d2db86" + } + } + ], + "result": { + "name": "debug_getBlockRlpResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_getModifiedAccountsByHash", + "tags": [], + "summary": "GetModifiedAccountsByHash returns all accounts that have changed between the\ntwo blocks specified. A change is defined as a difference in nonce, balance,\ncode hash, or storage hash.\n\nWith one parameter, returns the list of accounts modified in the specified block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).GetModifiedAccountsByHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:502" + }, + "params": [ + { + "name": "startHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c96f4211" + } + }, + { + "name": "endHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/77a4ae92" + } + } + ], + "result": { + "name": "debug_getModifiedAccountsByHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/0b965467" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_getModifiedAccountsByNumber", + "tags": [], + "summary": "GetModifiedAccountsByNumber returns all accounts that have changed between the\ntwo blocks specified. A change is defined as a difference in nonce, balance,\ncode hash, or storage hash.\n\nWith one parameter, returns the list of accounts modified in the specified block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).GetModifiedAccountsByNumber", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:474" + }, + "params": [ + { + "name": "startNum", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/15d2db86" + } + }, + { + "name": "endNum", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/3b25fedd" + } + } + ], + "result": { + "name": "debug_getModifiedAccountsByNumberResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/0b965467" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_goTrace", + "tags": [], + "summary": "GoTrace turns on tracing for nsec seconds and writes\ntrace data to file.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).GoTrace", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:135" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + }, + { + "name": "nsec", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/7cd1a15c" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ea9c7b32" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_memStats", + "tags": [], + "summary": "MemStats returns detailed runtime memory statistics.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).MemStats", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:73" + }, + "params": [], + "result": { + "name": "debug_memStatsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/4b37eb21" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_mutexProfile", + "tags": [], + "summary": "MutexProfile turns on mutex profiling for nsec seconds and writes profile data to file.\nIt uses a profile rate of 1 for most accurate information. If a different rate is\ndesired, set the rate and write the profile manually.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).MutexProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:168" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + }, + { + "name": "nsec", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/7cd1a15c" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ea9c7b32" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_preimage", + "tags": [], + "summary": "Preimage is a debug API function that returns the preimage for a sha3 hash, if known.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).Preimage", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:317" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c96f4211" + } + } + ], + "result": { + "name": "debug_preimageResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c789004b" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_printBlock", + "tags": [], + "summary": "PrintBlock retrieves a block and returns its pretty printed form.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicDebugAPI).PrintBlock", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1748" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/15d2db86" + } + } + ], + "result": { + "name": "debug_printBlockResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_seedHash", + "tags": [], + "summary": "SeedHash retrieves the seed hash of a block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicDebugAPI).SeedHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1757" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/15d2db86" + } + } + ], + "result": { + "name": "debug_seedHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_setBlockProfileRate", + "tags": [], + "summary": "SetBlockProfileRate sets the rate of goroutine block profile data collection.\nrate 0 disables block profiling.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).SetBlockProfileRate", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:156" + }, + "params": [ + { + "name": "rate", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/2dda9d56" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ea9c7b32" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_setGCPercent", + "tags": [], + "summary": "SetGCPercent sets the garbage collection target percentage. It returns the previous\nsetting. A negative value disables GC.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).SetGCPercent", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:206" + }, + "params": [ + { + "name": "v", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/2dda9d56" + } + } + ], + "result": { + "name": "debug_setGCPercentResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/2dda9d56" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_setHead", + "tags": [], + "summary": "SetHead rewinds the head of the blockchain to a previous block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateDebugAPI).SetHead", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1801" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/cf076949" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ea9c7b32" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_setMutexProfileFraction", + "tags": [], + "summary": "SetMutexProfileFraction sets the rate of mutex profiling.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).SetMutexProfileFraction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:177" + }, + "params": [ + { + "name": "rate", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/2dda9d56" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ea9c7b32" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_stacks", + "tags": [], + "summary": "Stacks returns a printed representation of the stacks of all goroutines.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).Stacks", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:193" + }, + "params": [], + "result": { + "name": "debug_stacksResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_standardTraceBadBlockToFile", + "tags": [], + "summary": "StandardTraceBadBlockToFile dumps the structured logs created during the\nexecution of EVM against a block pulled from the pool of bad ones to the\nlocal file system and returns a list of files to the caller.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).StandardTraceBadBlockToFile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:432" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c96f4211" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/57913d61" + } + } + ], + "result": { + "name": "debug_standardTraceBadBlockToFileResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/872b45d1" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_standardTraceBlockToFile", + "tags": [], + "summary": "StandardTraceBlockToFile dumps the structured logs created during the\nexecution of EVM to the local file system and returns a list of files\nto the caller.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).StandardTraceBlockToFile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:421" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c96f4211" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/57913d61" + } + } + ], + "result": { + "name": "debug_standardTraceBlockToFileResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/872b45d1" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_startCPUProfile", + "tags": [], + "summary": "StartCPUProfile turns on CPU profiling, writing to the given file.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).StartCPUProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:98" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ea9c7b32" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_startGoTrace", + "tags": [], + "summary": "StartGoTrace turns on tracing, writing to the given file.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).StartGoTrace", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/trace.go:30" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ea9c7b32" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_stopCPUProfile", + "tags": [], + "summary": "StopCPUProfile stops an ongoing CPU profile.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).StopCPUProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:119" + }, + "params": [], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ea9c7b32" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_stopGoTrace", + "tags": [], + "summary": "StopTrace stops an ongoing trace.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).StopGoTrace", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/trace.go:51" + }, + "params": [], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ea9c7b32" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_storageRangeAt", + "tags": [], + "summary": "StorageRangeAt returns the storage at the given block height and transaction index.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).StorageRangeAt", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:434" + }, + "params": [ + { + "name": "blockHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c96f4211" + } + }, + { + "name": "txIndex", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/2dda9d56" + } + }, + { + "name": "contractAddress", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/953fd027" + } + }, + { + "name": "keyStart", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c789004b" + } + }, + { + "name": "maxResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/2dda9d56" + } + } + ], + "result": { + "name": "debug_storageRangeAtResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/96ea3f6d" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_testSignCliqueBlock", + "tags": [], + "summary": "TestSignCliqueBlock fetches the given block number, and attempts to sign it as a clique header with the\ngiven address, returning the address of the recovered signature\n\nThis is a temporary method to debug the externalsigner integration,\nTODO: Remove this method when the integration is mature\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicDebugAPI).TestSignCliqueBlock", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1713" + }, + "params": [ + { + "name": "address", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/953fd027" + } + }, + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/15d2db86" + } + } + ], + "result": { + "name": "debug_testSignCliqueBlockResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/953fd027" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceBadBlock", + "tags": [], + "summary": "TraceBadBlockByHash returns the structured logs created during the execution of\nEVM against a block pulled from the pool of bad ones and returns them as a JSON\nobject.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).TraceBadBlock", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:408" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c96f4211" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c9ce359d" + } + } + ], + "result": { + "name": "debug_traceBadBlockResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/a94a2cf3" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceBlock", + "tags": [], + "summary": "TraceBlock returns the structured logs created during the execution of EVM\nand returns them as a JSON object.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).TraceBlock", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:387" + }, + "params": [ + { + "name": "blob", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/7535b0b5" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c9ce359d" + } + } + ], + "result": { + "name": "debug_traceBlockResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/a94a2cf3" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceBlockByHash", + "tags": [], + "summary": "TraceBlockByHash returns the structured logs created during the execution of\nEVM and returns them as a JSON object.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).TraceBlockByHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:377" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c96f4211" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c9ce359d" + } + } + ], + "result": { + "name": "debug_traceBlockByHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/a94a2cf3" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceBlockByNumber", + "tags": [], + "summary": "TraceBlockByNumber returns the structured logs created during the execution of\nEVM and returns them as a JSON object.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).TraceBlockByNumber", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:356" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/77d20ccc" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c9ce359d" + } + } + ], + "result": { + "name": "debug_traceBlockByNumberResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/a94a2cf3" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceBlockFromFile", + "tags": [], + "summary": "TraceBlockFromFile returns the structured logs created during the execution of\nEVM and returns them as a JSON object.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).TraceBlockFromFile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:397" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c9ce359d" + } + } + ], + "result": { + "name": "debug_traceBlockFromFileResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/a94a2cf3" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceTransaction", + "tags": [], + "summary": "FIXME: Is this really supposed to return an *ethapi.ExecutionResult type, or the empty interface in case not *vm.StructLogger?\nTraceTransaction returns the structured logs created during the execution of EVM\nand returns them as a JSON object.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).TraceTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:706" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c96f4211" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c9ce359d" + } + } + ], + "result": { + "name": "debug_traceTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/17f70f68" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_verbosity", + "tags": [], + "summary": "Verbosity sets the log verbosity ceiling. The verbosity of individual packages\nand source files can be raised using Vmodule.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).Verbosity", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:57" + }, + "params": [ + { + "name": "level", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/2dda9d56" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ea9c7b32" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_vmodule", + "tags": [], + "summary": "Vmodule sets the log verbosity pattern. See package log for details on the\npattern syntax.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).Vmodule", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:62" + }, + "params": [ + { + "name": "pattern", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ea9c7b32" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_writeBlockProfile", + "tags": [], + "summary": "WriteBlockProfile writes a goroutine blocking profile to the given file.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).WriteBlockProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:161" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ea9c7b32" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_writeMemProfile", + "tags": [], + "summary": "WriteMemProfile writes an allocation profile to the given file.\nNote that the profiling rate cannot be set through the API,\nit must be set on the command line.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).WriteMemProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:188" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ea9c7b32" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_writeMutexProfile", + "tags": [], + "summary": "WriteMutexProfile writes a goroutine blocking profile to the given file.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).WriteMutexProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:181" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ea9c7b32" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_accounts", + "tags": [], + "summary": "Accounts returns the collection of accounts this node manages\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicAccountAPI).Accounts", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:223" + }, + "params": [], + "result": { + "name": "eth_accountsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/0b965467" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_blockNumber", + "tags": [], + "summary": "BlockNumber returns the block number of the chain head.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).BlockNumber", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:555" + }, + "params": [], + "result": { + "name": "eth_blockNumberResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/cf076949" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_call", + "tags": [], + "summary": "Call executes the given transaction on the state for the given block number.\n\nAdditionally, the caller can specify a batch of contract for fields overriding.\n\nNote, this function doesn't make and changes in the state/blockchain and is\nuseful to execute and retrieve values.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).Call", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:907" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/b2c4cbc8" + } + }, + { + "name": "blockNrOrHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/56f4037d" + } + }, + { + "name": "overrides", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/fa7edfc7" + } + } + ], + "result": { + "name": "eth_callResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c789004b" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_chainId", + "tags": [], + "summary": "ChainId is the EIP-155 replay-protection chain id for the current ethereum chain config.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PublicEthereumAPI).ChainId", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:70" + }, + "params": [], + "result": { + "name": "eth_chainIdResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/cf076949" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_coinbase", + "tags": [], + "summary": "Coinbase is the address that mining rewards will be send to (alias for Etherbase)\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PublicEthereumAPI).Coinbase", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:60" + }, + "params": [], + "result": { + "name": "eth_coinbaseResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/953fd027" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_estimateGas", + "tags": [], + "summary": "EstimateGas returns an estimate of the amount of gas needed to execute the\ngiven transaction against the current pending block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).EstimateGas", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:981" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/b2c4cbc8" + } + } + ], + "result": { + "name": "eth_estimateGasResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/cf076949" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_etherbase", + "tags": [], + "summary": "Etherbase is the address that mining rewards will be send to\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PublicEthereumAPI).Etherbase", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:55" + }, + "params": [], + "result": { + "name": "eth_etherbaseResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/953fd027" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_fillTransaction", + "tags": [], + "summary": "FillTransaction fills the defaults (nonce, gas, gasPrice) on a given unsigned transaction,\nand returns it to the caller for further processing (signing + broadcast)\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).FillTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1530" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/2618493c" + } + } + ], + "result": { + "name": "eth_fillTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/809e8ef0" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_gasPrice", + "tags": [], + "summary": "GasPrice returns a suggestion for a gas price.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicEthereumAPI).GasPrice", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:67" + }, + "params": [], + "result": { + "name": "eth_gasPriceResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/67e24145" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getBalance", + "tags": [], + "summary": "GetBalance returns the amount of wei for the given address in the state of the\ngiven block number. The rpc.LatestBlockNumber and rpc.PendingBlockNumber meta\nblock numbers are also allowed.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetBalance", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:563" + }, + "params": [ + { + "name": "address", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/953fd027" + } + }, + { + "name": "blockNrOrHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/56f4037d" + } + } + ], + "result": { + "name": "eth_getBalanceResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/67e24145" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getBlockByHash", + "tags": [], + "summary": "GetBlockByHash returns the requested block. When fullTx is true all transactions in the block are returned in full\ndetail, otherwise only the transaction hash is returned.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetBlockByHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:686" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c96f4211" + } + }, + { + "name": "fullTx", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/1d850e3a" + } + } + ], + "result": { + "name": "eth_getBlockByHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/64660f7a" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getBlockByNumber", + "tags": [], + "summary": "GetBlockByNumber returns the requested canonical block.\n* When blockNr is -1 the chain head is returned.\n* When blockNr is -2 the pending chain head is returned.\n* When fullTx is true all transactions in the block are returned, otherwise\n only the transaction hash is returned.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetBlockByNumber", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:669" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/77d20ccc" + } + }, + { + "name": "fullTx", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/1d850e3a" + } + } + ], + "result": { + "name": "eth_getBlockByNumberResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/64660f7a" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getBlockTransactionCountByHash", + "tags": [], + "summary": "GetBlockTransactionCountByHash returns the number of transactions in the block with the given hash.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetBlockTransactionCountByHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1231" + }, + "params": [ + { + "name": "blockHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c96f4211" + } + } + ], + "result": { + "name": "eth_getBlockTransactionCountByHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/3a6d16fd" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getBlockTransactionCountByNumber", + "tags": [], + "summary": "GetBlockTransactionCountByNumber returns the number of transactions in the block with the given block number.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetBlockTransactionCountByNumber", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1222" + }, + "params": [ + { + "name": "blockNr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/77d20ccc" + } + } + ], + "result": { + "name": "eth_getBlockTransactionCountByNumberResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/3a6d16fd" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getCode", + "tags": [], + "summary": "GetCode returns the code stored at the given address in the state for the given block number.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetCode", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:745" + }, + "params": [ + { + "name": "address", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/953fd027" + } + }, + { + "name": "blockNrOrHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/56f4037d" + } + } + ], + "result": { + "name": "eth_getCodeResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c789004b" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getFilterChanges", + "tags": [], + "summary": "GetFilterChanges returns the logs for the filter with the given id since\nlast time it was called. This can be used for polling.\n\nFor pending transaction and block filters the result is []common.Hash.\n(pending)Log filters return []Log.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_getfilterchanges\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth/filters.(*PublicFilterAPI).GetFilterChanges", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go:413" + }, + "params": [ + { + "name": "id", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/5ef1292e" + } + } + ], + "result": { + "name": "eth_getFilterChangesResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/b4478bb6" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getFilterLogs", + "tags": [], + "summary": "GetFilterLogs returns the logs for the filter with the given id.\nIf the filter could not be found an empty array of logs is returned.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_getfilterlogs\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth/filters.(*PublicFilterAPI).GetFilterLogs", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go:372" + }, + "params": [ + { + "name": "id", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/5ef1292e" + } + } + ], + "result": { + "name": "eth_getFilterLogsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/7bad17ff" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getHashrate", + "tags": [], + "summary": "GetHashrate returns the current hashrate for local CPU miner and remote miner.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).GetHashrate", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:110" + }, + "params": [], + "result": { + "name": "eth_getHashrateResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/15d2db86" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getHeaderByHash", + "tags": [], + "summary": "GetHeaderByHash returns the requested header by hash.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetHeaderByHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:656" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c96f4211" + } + } + ], + "result": { + "name": "eth_getHeaderByHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/64660f7a" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getHeaderByNumber", + "tags": [], + "summary": "GetHeaderByNumber returns the requested canonical block header.\n* When blockNr is -1 the chain head is returned.\n* When blockNr is -2 the pending chain head is returned.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetHeaderByNumber", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:640" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/77d20ccc" + } + } + ], + "result": { + "name": "eth_getHeaderByNumberResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/64660f7a" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getLogs", + "tags": [], + "summary": "GetLogs returns logs matching the given argument that are stored within the state.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_getlogs\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth/filters.(*PublicFilterAPI).GetLogs", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go:325" + }, + "params": [ + { + "name": "crit", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/a3f9291b" + } + } + ], + "result": { + "name": "eth_getLogsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/7bad17ff" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getProof", + "tags": [], + "summary": "GetProof returns the Merkle-proof for a given account and optionally some storage keys.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetProof", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:588" + }, + "params": [ + { + "name": "address", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/953fd027" + } + }, + { + "name": "storageKeys", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/872b45d1" + } + }, + { + "name": "blockNrOrHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/56f4037d" + } + } + ], + "result": { + "name": "eth_getProofResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/7f1a20fd" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getRawTransactionByBlockHashAndIndex", + "tags": [], + "summary": "GetRawTransactionByBlockHashAndIndex returns the bytes of the transaction for the given block hash and index.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetRawTransactionByBlockHashAndIndex", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1264" + }, + "params": [ + { + "name": "blockHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c96f4211" + } + }, + { + "name": "index", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/1d92a8cf" + } + } + ], + "result": { + "name": "eth_getRawTransactionByBlockHashAndIndexResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c789004b" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getRawTransactionByBlockNumberAndIndex", + "tags": [], + "summary": "GetRawTransactionByBlockNumberAndIndex returns the bytes of the transaction for the given block number and index.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetRawTransactionByBlockNumberAndIndex", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1256" + }, + "params": [ + { + "name": "blockNr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/77d20ccc" + } + }, + { + "name": "index", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/1d92a8cf" + } + } + ], + "result": { + "name": "eth_getRawTransactionByBlockNumberAndIndexResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c789004b" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getRawTransactionByHash", + "tags": [], + "summary": "GetRawTransactionByHash returns the bytes of the transaction for the given hash.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetRawTransactionByHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1310" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c96f4211" + } + } + ], + "result": { + "name": "eth_getRawTransactionByHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c789004b" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getStorageAt", + "tags": [], + "summary": "GetStorageAt returns the storage from the state at the given address, key and\nblock number. The rpc.LatestBlockNumber and rpc.PendingBlockNumber meta block\nnumbers are also allowed.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetStorageAt", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:757" + }, + "params": [ + { + "name": "address", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/953fd027" + } + }, + { + "name": "key", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + }, + { + "name": "blockNrOrHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/56f4037d" + } + } + ], + "result": { + "name": "eth_getStorageAtResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c789004b" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getTransactionByBlockHashAndIndex", + "tags": [], + "summary": "GetTransactionByBlockHashAndIndex returns the transaction for the given block hash and index.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetTransactionByBlockHashAndIndex", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1248" + }, + "params": [ + { + "name": "blockHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c96f4211" + } + }, + { + "name": "index", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/1d92a8cf" + } + } + ], + "result": { + "name": "eth_getTransactionByBlockHashAndIndexResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbe5a657" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getTransactionByBlockNumberAndIndex", + "tags": [], + "summary": "GetTransactionByBlockNumberAndIndex returns the transaction for the given block number and index.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetTransactionByBlockNumberAndIndex", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1240" + }, + "params": [ + { + "name": "blockNr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/77d20ccc" + } + }, + { + "name": "index", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/1d92a8cf" + } + } + ], + "result": { + "name": "eth_getTransactionByBlockNumberAndIndexResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbe5a657" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getTransactionByHash", + "tags": [], + "summary": "GetTransactionByHash returns the transaction for the given hash\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetTransactionByHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1291" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c96f4211" + } + } + ], + "result": { + "name": "eth_getTransactionByHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbe5a657" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getTransactionCount", + "tags": [], + "summary": "GetTransactionCount returns the number of transactions the given address has sent for the given block number\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetTransactionCount", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1272" + }, + "params": [ + { + "name": "address", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/953fd027" + } + }, + { + "name": "blockNrOrHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/56f4037d" + } + } + ], + "result": { + "name": "eth_getTransactionCountResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/2f1ff889" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getTransactionReceipt", + "tags": [], + "summary": "GetTransactionReceipt returns the transaction receipt for the given transaction hash.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetTransactionReceipt", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1327" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c96f4211" + } + } + ], + "result": { + "name": "eth_getTransactionReceiptResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/64660f7a" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getUncleByBlockHashAndIndex", + "tags": [], + "summary": "GetUncleByBlockHashAndIndex returns the uncle block for the given block hash and index. When fullTx is true\nall transactions in the block are returned in full detail, otherwise only the transaction hash is returned.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetUncleByBlockHashAndIndex", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:712" + }, + "params": [ + { + "name": "blockHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c96f4211" + } + }, + { + "name": "index", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/1d92a8cf" + } + } + ], + "result": { + "name": "eth_getUncleByBlockHashAndIndexResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/64660f7a" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getUncleByBlockNumberAndIndex", + "tags": [], + "summary": "GetUncleByBlockNumberAndIndex returns the uncle block for the given block hash and index. When fullTx is true\nall transactions in the block are returned in full detail, otherwise only the transaction hash is returned.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetUncleByBlockNumberAndIndex", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:696" + }, + "params": [ + { + "name": "blockNr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/77d20ccc" + } + }, + { + "name": "index", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/1d92a8cf" + } + } + ], + "result": { + "name": "eth_getUncleByBlockNumberAndIndexResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/64660f7a" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getUncleCountByBlockHash", + "tags": [], + "summary": "GetUncleCountByBlockHash returns number of uncles in the block for the given block hash\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetUncleCountByBlockHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:736" + }, + "params": [ + { + "name": "blockHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c96f4211" + } + } + ], + "result": { + "name": "eth_getUncleCountByBlockHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/3a6d16fd" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getUncleCountByBlockNumber", + "tags": [], + "summary": "GetUncleCountByBlockNumber returns number of uncles in the block for the given block number\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetUncleCountByBlockNumber", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:727" + }, + "params": [ + { + "name": "blockNr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/77d20ccc" + } + } + ], + "result": { + "name": "eth_getUncleCountByBlockNumberResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/3a6d16fd" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getWork", + "tags": [], + "summary": "GetWork returns a work package for external miner.\n\nThe work package consists of 3 strings:\n result[0] - 32 bytes hex encoded current block header pow-hash\n result[1] - 32 bytes hex encoded seed hash used for DAG\n result[2] - 32 bytes hex encoded boundary condition (\"target\"), 2^256/difficulty\n result[3] - hex encoded block number\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).GetWork", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:41" + }, + "params": [], + "result": { + "name": "eth_getWorkResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c5820385" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_hashrate", + "tags": [], + "summary": "Hashrate returns the POW hashrate\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PublicEthereumAPI).Hashrate", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:65" + }, + "params": [], + "result": { + "name": "eth_hashrateResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/cf076949" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_mining", + "tags": [], + "summary": "Mining returns an indication if this node is currently mining.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PublicMinerAPI).Mining", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:91" + }, + "params": [], + "result": { + "name": "eth_miningResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/1d850e3a" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_newBlockFilter", + "tags": [], + "summary": "NewBlockFilter creates a filter that fetches blocks that are imported into the chain.\nIt is part of the filter package since polling goes with eth_getFilterChanges.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_newblockfilter\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth/filters.(*PublicFilterAPI).NewBlockFilter", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go:174" + }, + "params": [], + "result": { + "name": "eth_newBlockFilterResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/5ef1292e" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_newFilter", + "tags": [], + "summary": "NewFilter creates a new filter and returns the filter id. It can be\nused to retrieve logs when the state changes. This method cannot be\nused to fetch logs that are already stored in the state.\n\nDefault criteria for the from and to block are \"latest\".\nUsing \"latest\" as block number will return logs for mined blocks.\nUsing \"pending\" as block number returns logs for not yet mined (pending) blocks.\nIn case logs are removed (chain reorg) previously returned logs are returned\nagain but with the removed property set to true.\n\nIn case \"fromBlock\" \u003e \"toBlock\" an error is returned.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_newfilter\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth/filters.(*PublicFilterAPI).NewFilter", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go:290" + }, + "params": [ + { + "name": "crit", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/a3f9291b" + } + } + ], + "result": { + "name": "eth_newFilterResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/5ef1292e" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_newPendingTransactionFilter", + "tags": [], + "summary": "NewPendingTransactionFilter creates a filter that fetches pending transaction hashes\nas transactions enter the pending state.\n\nIt is part of the filter package because this filter can be used through the\n`eth_getFilterChanges` polling method that is also used for log filters.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_newpendingtransactionfilter\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth/filters.(*PublicFilterAPI).NewPendingTransactionFilter", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go:104" + }, + "params": [], + "result": { + "name": "eth_newPendingTransactionFilterResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/5ef1292e" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_pendingTransactions", + "tags": [], + "summary": "PendingTransactions returns the transactions that are in the transaction pool\nand have a from address that is one of the accounts this node manages.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).PendingTransactions", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1614" + }, + "params": [], + "result": { + "name": "eth_pendingTransactionsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c40084a1" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_protocolVersion", + "tags": [], + "summary": "ProtocolVersion returns the current Ethereum protocol version this node supports\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicEthereumAPI).ProtocolVersion", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:73" + }, + "params": [], + "result": { + "name": "eth_protocolVersionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/1d92a8cf" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_resend", + "tags": [], + "summary": "Resend accepts an existing transaction and a new gas price and limit. It will remove\nthe given transaction from the pool and reinsert it with the new gas price and limit.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).Resend", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1641" + }, + "params": [ + { + "name": "sendArgs", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/2618493c" + } + }, + { + "name": "gasPrice", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/67e24145" + } + }, + { + "name": "gasLimit", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/2f1ff889" + } + } + ], + "result": { + "name": "eth_resendResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c96f4211" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_sendRawTransaction", + "tags": [], + "summary": "SendRawTransaction will add the signed transaction to the transaction pool.\nThe sender is responsible for signing the transaction and using the correct nonce.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).SendRawTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1546" + }, + "params": [ + { + "name": "encodedTx", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c789004b" + } + } + ], + "result": { + "name": "eth_sendRawTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c96f4211" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_sendTransaction", + "tags": [], + "summary": "SendTransaction creates a transaction for the given argument, sign it and submit it to the\ntransaction pool.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).SendTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1498" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/2618493c" + } + } + ], + "result": { + "name": "eth_sendTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c96f4211" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_sign", + "tags": [], + "summary": "Sign calculates an ECDSA signature for:\nkeccack256(\"\\x19Ethereum Signed Message:\\n\" + len(message) + message).\n\nNote, the produced signature conforms to the secp256k1 curve R, S and V values,\nwhere the V value will be 27 or 28 for legacy reasons.\n\nThe account associated with addr must be unlocked.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).Sign", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1563" + }, + "params": [ + { + "name": "addr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/953fd027" + } + }, + { + "name": "data", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c789004b" + } + } + ], + "result": { + "name": "eth_signResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c789004b" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_signTransaction", + "tags": [], + "summary": "SignTransaction will sign the given transaction with the from account.\nThe node needs to have the private key of the account corresponding with\nthe given from address and it needs to be unlocked.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).SignTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1588" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/2618493c" + } + } + ], + "result": { + "name": "eth_signTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/809e8ef0" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_submitHashRate", + "tags": [], + "summary": "SubmitHashrate can be used for remote miners to submit their hash rate.\nThis enables the node to report the combined hash rate of all miners\nwhich submit work through this node.\n\nIt accepts the miner hash rate and an identifier which must be unique\nbetween nodes.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).SubmitHashRate", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:92" + }, + "params": [ + { + "name": "rate", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/cf076949" + } + }, + { + "name": "id", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c96f4211" + } + } + ], + "result": { + "name": "eth_submitHashRateResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/1d850e3a" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_submitWork", + "tags": [], + "summary": "SubmitWork can be used by external miner to submit their POW solution.\nIt returns an indication if the work was accepted.\nNote either an invalid solution, a stale work a non-existent work will return false.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).SubmitWork", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:66" + }, + "params": [ + { + "name": "nonce", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/54aa2e54" + } + }, + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c96f4211" + } + }, + { + "name": "digest", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c96f4211" + } + } + ], + "result": { + "name": "eth_submitWorkResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/1d850e3a" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_syncing", + "tags": [], + "summary": "Syncing returns false in case the node is currently not syncing with the network. It can be up to date or has not\nyet received the latest block headers from its pears. In case it is synchronizing:\n- startingBlock: block number this node started to synchronise from\n- currentBlock: block number this node is currently importing\n- highestBlock: block number of the highest block header this node has received from peers\n- pulledStates: number of state entries processed until now\n- knownStates: number of known state entries that still need to be pulled\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicEthereumAPI).Syncing", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:109" + }, + "params": [], + "result": { + "name": "eth_syncingResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/598766fa" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_uninstallFilter", + "tags": [], + "summary": "UninstallFilter removes the filter with the given filter id.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_uninstallfilter\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth/filters.(*PublicFilterAPI).UninstallFilter", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go:354" + }, + "params": [ + { + "name": "id", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/5ef1292e" + } + } + ], + "result": { + "name": "eth_uninstallFilterResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/1d850e3a" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "ethash_getHashrate", + "tags": [], + "summary": "GetHashrate returns the current hashrate for local CPU miner and remote miner.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).GetHashrate", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:110" + }, + "params": [], + "result": { + "name": "ethash_getHashrateResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/15d2db86" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "ethash_getWork", + "tags": [], + "summary": "GetWork returns a work package for external miner.\n\nThe work package consists of 3 strings:\n result[0] - 32 bytes hex encoded current block header pow-hash\n result[1] - 32 bytes hex encoded seed hash used for DAG\n result[2] - 32 bytes hex encoded boundary condition (\"target\"), 2^256/difficulty\n result[3] - hex encoded block number\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).GetWork", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:41" + }, + "params": [], + "result": { + "name": "ethash_getWorkResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c5820385" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "ethash_submitHashRate", + "tags": [], + "summary": "SubmitHashrate can be used for remote miners to submit their hash rate.\nThis enables the node to report the combined hash rate of all miners\nwhich submit work through this node.\n\nIt accepts the miner hash rate and an identifier which must be unique\nbetween nodes.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).SubmitHashRate", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:92" + }, + "params": [ + { + "name": "rate", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/cf076949" + } + }, + { + "name": "id", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c96f4211" + } + } + ], + "result": { + "name": "ethash_submitHashRateResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/1d850e3a" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "ethash_submitWork", + "tags": [], + "summary": "SubmitWork can be used by external miner to submit their POW solution.\nIt returns an indication if the work was accepted.\nNote either an invalid solution, a stale work a non-existent work will return false.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).SubmitWork", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:66" + }, + "params": [ + { + "name": "nonce", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/54aa2e54" + } + }, + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c96f4211" + } + }, + { + "name": "digest", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c96f4211" + } + } + ], + "result": { + "name": "ethash_submitWorkResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/1d850e3a" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_getHashrate", + "tags": [], + "summary": "GetHashrate returns the current hashrate of the miner.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateMinerAPI).GetHashrate", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:153" + }, + "params": [], + "result": { + "name": "miner_getHashrateResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/15d2db86" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_setEtherbase", + "tags": [], + "summary": "SetEtherbase sets the etherbase of the miner\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateMinerAPI).SetEtherbase", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:142" + }, + "params": [ + { + "name": "etherbase", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/953fd027" + } + } + ], + "result": { + "name": "miner_setEtherbaseResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/1d850e3a" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_setExtra", + "tags": [], + "summary": "SetExtra sets the extra data string that is included when this miner mines a block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateMinerAPI).SetExtra", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:124" + }, + "params": [ + { + "name": "extra", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + } + ], + "result": { + "name": "miner_setExtraResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/1d850e3a" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_setGasPrice", + "tags": [], + "summary": "SetGasPrice sets the minimum accepted gas price for the miner.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateMinerAPI).SetGasPrice", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:132" + }, + "params": [ + { + "name": "gasPrice", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/7ed7a408" + } + } + ], + "result": { + "name": "miner_setGasPriceResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/1d850e3a" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_setRecommitInterval", + "tags": [], + "summary": "SetRecommitInterval updates the interval for miner sealing work recommitting.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateMinerAPI).SetRecommitInterval", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:148" + }, + "params": [ + { + "name": "interval", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/2dda9d56" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ea9c7b32" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_start", + "tags": [], + "summary": "Start starts the miner with the given number of threads. If threads is nil,\nthe number of workers started is equal to the number of logical CPUs that are\nusable by this process. If mining is already running, this method adjust the\nnumber of threads allowed to use and updates the minimum price required by the\ntransaction pool.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateMinerAPI).Start", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:110" + }, + "params": [ + { + "name": "threads", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/5ac6539d" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ea9c7b32" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_stop", + "tags": [], + "summary": "Stop terminates the miner, both at the consensus engine level as well as at\nthe block creation level.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateMinerAPI).Stop", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:119" + }, + "params": [], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ea9c7b32" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "net_listening", + "tags": [], + "summary": "Listening returns an indication if the node is listening for network connections.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicNetAPI).Listening", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1818" + }, + "params": [], + "result": { + "name": "net_listeningResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/1d850e3a" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "net_peerCount", + "tags": [], + "summary": "PeerCount returns the number of connected peers\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicNetAPI).PeerCount", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1822" + }, + "params": [], + "result": { + "name": "net_peerCountResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/1d92a8cf" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "net_version", + "tags": [], + "summary": "Version returns the current ethereum protocol version.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicNetAPI).Version", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1827" + }, + "params": [], + "result": { + "name": "net_versionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_deriveAccount", + "tags": [], + "summary": "DeriveAccount requests a HD wallet to derive a new account, optionally pinning\nit for later reuse.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).DeriveAccount", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:296" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + }, + { + "name": "path", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + }, + { + "name": "pin", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/dc32604d" + } + } + ], + "result": { + "name": "personal_deriveAccountResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/3a7ed679" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_ecRecover", + "tags": [], + "summary": "EcRecover returns the address for the account that was used to create the signature.\nNote, this function is compatible with eth_sign and personal_sign. As such it recovers\nthe address of:\nhash = keccak256(\"\\x19Ethereum Signed Message:\\n\"${message length}${message})\naddr = ecrecover(hash, signature)\n\nNote, the signature must conform to the secp256k1 curve R, S and V values, where\nthe V value must be 27 or 28 for legacy reasons.\n\nhttps://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_ecRecover\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).EcRecover", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:474" + }, + "params": [ + { + "name": "data", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c789004b" + } + }, + { + "name": "sig", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c789004b" + } + } + ], + "result": { + "name": "personal_ecRecoverResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/953fd027" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_importRawKey", + "tags": [], + "summary": "ImportRawKey stores the given hex encoded ECDSA key into the key directory,\nencrypting it with the passphrase.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).ImportRawKey", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:330" + }, + "params": [ + { + "name": "privkey", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + }, + { + "name": "password", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + } + ], + "result": { + "name": "personal_importRawKeyResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/953fd027" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_initializeWallet", + "tags": [], + "summary": "InitializeWallet initializes a new wallet at the provided URL, by generating and returning a new private key.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).InitializeWallet", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:497" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + } + ], + "result": { + "name": "personal_initializeWalletResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_listAccounts", + "tags": [], + "summary": "listAccounts will return a list of addresses for accounts this node manages.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).ListAccounts", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:246" + }, + "params": [], + "result": { + "name": "personal_listAccountsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/0b965467" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_listWallets", + "tags": [], + "summary": "ListWallets will return a list of wallets this node manages.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).ListWallets", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:260" + }, + "params": [], + "result": { + "name": "personal_listWalletsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/dec2410a" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_lockAccount", + "tags": [], + "summary": "LockAccount will lock the account associated with the given address when it's unlocked.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).LockAccount", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:367" + }, + "params": [ + { + "name": "addr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/953fd027" + } + } + ], + "result": { + "name": "personal_lockAccountResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/1d850e3a" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_newAccount", + "tags": [], + "summary": "NewAccount will create a new account and returns the address for the new account.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).NewAccount", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:312" + }, + "params": [ + { + "name": "password", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + } + ], + "result": { + "name": "personal_newAccountResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/953fd027" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_openWallet", + "tags": [], + "summary": "OpenWallet initiates a hardware wallet opening procedure, establishing a USB\nconnection and attempting to authenticate via the provided passphrase. Note,\nthe method may return an extra challenge requiring a second open (e.g. the\nTrezor PIN matrix challenge).\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).OpenWallet", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:282" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + }, + { + "name": "passphrase", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ee62999c" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ea9c7b32" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_sendTransaction", + "tags": [], + "summary": "SendTransaction will create a transaction from the given arguments and\ntries to sign it with the key associated with args.To. If the given passwd isn't\nable to decrypt the key it fails.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).SendTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:394" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/2618493c" + } + }, + { + "name": "passwd", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + } + ], + "result": { + "name": "personal_sendTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c96f4211" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_sign", + "tags": [], + "summary": "Sign calculates an Ethereum ECDSA signature for:\nkeccack256(\"\\x19Ethereum Signed Message:\\n\" + len(message) + message))\n\nNote, the produced signature conforms to the secp256k1 curve R, S and V values,\nwhere the V value will be 27 or 28 for legacy reasons.\n\nThe key used to calculate the signature is decrypted with the given password.\n\nhttps://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_sign\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).Sign", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:446" + }, + "params": [ + { + "name": "data", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c789004b" + } + }, + { + "name": "addr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/953fd027" + } + }, + { + "name": "passwd", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + } + ], + "result": { + "name": "personal_signResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c789004b" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_signAndSendTransaction", + "tags": [], + "summary": "SignAndSendTransaction was renamed to SendTransaction. This method is deprecated\nand will be removed in the future. It primary goal is to give clients time to update.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).SignAndSendTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:492" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/2618493c" + } + }, + { + "name": "passwd", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + } + ], + "result": { + "name": "personal_signAndSendTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c96f4211" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_signTransaction", + "tags": [], + "summary": "SignTransaction will create a transaction from the given arguments and\ntries to sign it with the key associated with args.To. If the given passwd isn't\nable to decrypt the key it fails. The transaction is returned in RLP-form, not broadcast\nto other nodes\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).SignTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:413" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/2618493c" + } + }, + { + "name": "passwd", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + }, + { + "name": "passwd2", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + } + ], + "result": { + "name": "personal_signTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/809e8ef0" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_unlockAccount", + "tags": [], + "summary": "UnlockAccount will unlock the account associated with the given address with\nthe given password for duration seconds. If duration is nil it will use a\ndefault of 300 seconds. It returns an indication if the account was unlocked.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).UnlockAccount", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:342" + }, + "params": [ + { + "name": "addr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/953fd027" + } + }, + { + "name": "password", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + }, + { + "name": "duration", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/3b25fedd" + } + } + ], + "result": { + "name": "personal_unlockAccountResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/1d850e3a" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_unpair", + "tags": [], + "summary": "Unpair deletes a pairing between wallet and geth.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).Unpair", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:524" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + }, + { + "name": "pin", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + } + ], + "result": { + "name": "null", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/ea9c7b32" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "txpool_content", + "tags": [], + "summary": "Content returns the transactions contained within the transaction pool.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTxPoolAPI).Content", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:141" + }, + "params": [], + "result": { + "name": "txpool_contentResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/b351847b" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "txpool_inspect", + "tags": [], + "summary": "Inspect retrieves the content of the transaction pool and flattens it into an\neasily inspectable list.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTxPoolAPI).Inspect", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:178" + }, + "params": [], + "result": { + "name": "txpool_inspectResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/7d50a3ed" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "txpool_status", + "tags": [], + "summary": "Status returns the number of pending and queued transaction in the pool.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTxPoolAPI).Status", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:168" + }, + "params": [], + "result": { + "name": "txpool_statusResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/34edbd73" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "web3_clientVersion", + "tags": [], + "summary": "ClientVersion returns the node name\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PublicWeb3API).ClientVersion", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:309" + }, + "params": [], + "result": { + "name": "web3_clientVersionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/bbfa9c31" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "web3_sha3", + "tags": [], + "summary": "Sha3 applies the ethereum sha3 implementation on the input.\nIt assumes the input is hex encoded.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PublicWeb3API).Sha3", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:315" + }, + "params": [ + { + "name": "input", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c789004b" + } + } + ], + "result": { + "name": "web3_sha3Result", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/c789004b" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + } + ], + "components": { + "schemas": { + "0b965467": { + "$ref": "#/components/schemas/array.0e2ed272" + }, + "15d2db86": { + "$ref": "#/components/schemas/uint64_string.integer.99afc08e" + }, + "17f70f68": { + "$ref": "#/components/schemas/object.ExecutionResult.5cba9189" + }, + "19d14d7c": { + "$ref": "#/components/schemas/object.NodeInfo.531cf050" + }, + "1d850e3a": { + "$ref": "#/components/schemas/bool_boolean.66977b29" + }, + "1d92a8cf": { + "$ref": "#/components/schemas/hexutil.Uint_string.integer.1fd7f86a" + }, + "2618493c": { + "$ref": "#/components/schemas/object.SendTxArgs.6470304b" + }, + "2dda9d56": { + "$ref": "#/components/schemas/int_string.integer.d105ce99" + }, + "2f1ff889": { + "$ref": "#/components/schemas/Uint64_string.integer.34584798" + }, + "34edbd73": { + "$ref": "#/components/schemas/object.c79a510c" + }, + "3a6d16fd": { + "$ref": "#/components/schemas/Uint_string.integer.334b351a" + }, + "3a7ed679": { + "$ref": "#/components/schemas/object.Account.fe9d6649" + }, + "3b25fedd": { + "$ref": "#/components/schemas/uint64_string.integer.6f4a1a95" + }, + "3d6ca2ce": { + "$ref": "#/components/schemas/array.ab5f0bb5" + }, + "4b37eb21": { + "$ref": "#/components/schemas/object.MemStats.372ed753" + }, + "54aa2e54": { + "$ref": "#/components/schemas/types.BlockNonce_string.integer.b33e8698" + }, + "56f4037d": { + "$ref": "#/components/schemas/rpc.BlockNumberOrHash_blockNumberOrHash.d4005edc" + }, + "57913d61": { + "$ref": "#/components/schemas/object.StdTraceConfig.b88a4f58" + }, + "598766fa": { + "$ref": "#/components/schemas/object.EthSyncingResult.7f592c20" + }, + "5ac6539d": { + "$ref": "#/components/schemas/int_string.integer.ce902a4d" + }, + "5ef1292e": { + "$ref": "#/components/schemas/rpc.ID_string.ffd91372" + }, + "64660f7a": { + "$ref": "#/components/schemas/object.0134db4e" + }, + "67e24145": { + "$ref": "#/components/schemas/Big_string.integer.ddafdcbc" + }, + "7199b7b0": { + "$ref": "#/components/schemas/array.a8b9dbac" + }, + "7535b0b5": { + "$ref": "#/components/schemas/string.bytes.99a4fec9" + }, + "77a4ae92": { + "$ref": "#/components/schemas/Hash_string.keccak.4e9cb34b" + }, + "77d20ccc": { + "$ref": "#/components/schemas/rpc.BlockNumber_blockNumberOrTag.6c30ca5d" + }, + "7bad17ff": { + "$ref": "#/components/schemas/array.5429abe2" + }, + "7cd1a15c": { + "$ref": "#/components/schemas/uint_string.integer.ddf1775d" + }, + "7d50a3ed": { + "$ref": "#/components/schemas/object.07ae319c" + }, + "7ed7a408": { + "$ref": "#/components/schemas/hexutil.Big_string.integer.e9fbc064" + }, + "7f1a20fd": { + "$ref": "#/components/schemas/object.AccountResult.459f3632" + }, + "809e8ef0": { + "$ref": "#/components/schemas/object.SignTransactionResult.d3a3acba" + }, + "872b45d1": { + "$ref": "#/components/schemas/array.2800749e" + }, + "953fd027": { + "$ref": "#/components/schemas/common.Address_string.address.d6bf798c" + }, + "96ea3f6d": { + "$ref": "#/components/schemas/object.StorageRangeResult.caeac994" + }, + "a3f9291b": { + "$ref": "#/components/schemas/object.FilterCriteria.6a25dd91" + }, + "a94a2cf3": { + "$ref": "#/components/schemas/array.7e99ae42" + }, + "ad646739": { + "$ref": "#/components/schemas/object.GCStats.ddfbe9cd" + }, + "b2c4cbc8": { + "$ref": "#/components/schemas/object.CallArgs.db0e8113" + }, + "b351847b": { + "$ref": "#/components/schemas/object.d31233b1" + }, + "b4478bb6": { + "$ref": "#/components/schemas/3ef9ee5c" + }, + "ba54eab6": { + "$ref": "#/components/schemas/object.AccountRangeResult.949b14a3" + }, + "bbe5a657": { + "$ref": "#/components/schemas/object.RPCTransaction.1ea92fcd" + }, + "bbfa9c31": { + "$ref": "#/components/schemas/string_string.301d5adc" + }, + "c40084a1": { + "$ref": "#/components/schemas/array.f050d6b7" + }, + "c5820385": { + "$ref": "#/components/schemas/array.09c4961f" + }, + "c789004b": { + "$ref": "#/components/schemas/hexutil.Bytes_string.dataWord.991c4306" + }, + "c96f4211": { + "$ref": "#/components/schemas/common.Hash_string.keccak.b92d32d1" + }, + "c9ce359d": { + "$ref": "#/components/schemas/object.TraceConfig.a31a343b" + }, + "cf076949": { + "$ref": "#/components/schemas/hexutil.Uint64_string.integer.9327e20a" + }, + "cf91b34a": { + "$ref": "#/components/schemas/object.Dump.42f08fb6" + }, + "dc32604d": { + "$ref": "#/components/schemas/bool_boolean.9b89f070" + }, + "dec2410a": { + "$ref": "#/components/schemas/array.2f80fd20" + }, + "ea9c7b32": { + "$ref": "#/components/schemas/Null_null.2d1dcd4c" + }, + "ee62999c": { + "$ref": "#/components/schemas/string_string.043590b5" + }, + "fa7edfc7": { + "$ref": "#/components/schemas/object.89791ecd" + } + } + }, + "externalDocs": { + "description": "Source", + "url": "https://github.com/etclabscore/core-geth" + } +} \ No newline at end of file diff --git a/.develop/test.sh b/.develop/test.sh new file mode 100755 index 0000000000..1830258f29 --- /dev/null +++ b/.develop/test.sh @@ -0,0 +1,46 @@ +#!/usr/bin/env bash +set -e + +echo "Building ./build/bin/devgeth" +go build -o ./build/bin/devgeth ./cmd/geth + +# Clean up any bad leftovers. +pkill -f ./build/bin/devgeth || true +rm -fr /tmp/gethddd + +onexit(){ + pkill -f ./build/bin/devgeth + rm -fr /tmp/gethddd +} +trap onexit EXIT + +./build/bin/devgeth --port 30313 --datadir=/tmp/gethddd --nodiscover --maxpeers=0 --rpc --rpcapi=admin,debug,eth,ethash,miner,net,personal,rpc,txpool,web3 >/tmp/geth.log 2>&1 & +# ./build/bin/devgeth --port 30313 --datadir=/tmp/gethddd --nodiscover --maxpeers=0 --rpc --rpcapi=eth,net,txpool,web3 >/tmp/geth.log 2>&1 & +disown +gethpid=$! +echo "Geth PID: ${gethpid}" + +# Wait for geth to start up. +echo "Waiting 3 for geth to startup..." +sleep 3 + +# Save a copy of the generated openrpc document by HTTP RPC query. +http --json POST http://localhost:8545 id:=$(date +%s) method='rpc_discover' params:='[]' | jj -p 'result' | tee "$(pwd)/.develop/spec.json" + +echo +echo "Geth log:" +echo "---------------------------------------------" +cat /tmp/geth.log +echo "---------------------------------------------" +echo + +# Update our gist before validation; the script will exit if the validator fails. +gist -u 4da4c08765679dac1899543002d1f545 "$(pwd)/.develop/spec.json" >/dev/null 2>&1 & + +# Run the OpenRPC document validator. +# Not sure the install here actually works. FIXME. +# command -v openrpc-generator-cli >/dev/null 2>&1 || { npm install -g @etclabscore/openrpc-generator-cli; } +openrpc-validator-cli "$(pwd)/.develop/spec.json" + +kill $gethpid + diff --git a/.golangci.yml b/.golangci.yml index 6cf5bbeade..31a30d367f 100644 --- a/.golangci.yml +++ b/.golangci.yml @@ -49,3 +49,6 @@ issues: - path: cmd/faucet/ linters: - deadcode + - path: rpc/gzip.go + linters: + - deadcode diff --git a/accounts/abi/bind/bind_test.go b/accounts/abi/bind/bind_test.go index a6cf3dbcfc..e0ce5fb0b0 100644 --- a/accounts/abi/bind/bind_test.go +++ b/accounts/abi/bind/bind_test.go @@ -17,6 +17,7 @@ package bind import ( + "bufio" "fmt" "io/ioutil" "os" @@ -1642,11 +1643,44 @@ func TestGolangBindings(t *testing.T) { t.Fatalf("failed to convert binding test to modules: %v\n%s", err, out) } pwd, _ := os.Getwd() - replacer := exec.Command(gocmd, "mod", "edit", "-replace", "github.com/ethereum/go-ethereum="+filepath.Join(pwd, "..", "..", "..")) // Repo root + repoRoot := filepath.Join(pwd, "..", "..", "..") + + replacer := exec.Command(gocmd, "mod", "edit", "-replace", "github.com/ethereum/go-ethereum="+repoRoot) replacer.Dir = pkg if out, err := replacer.CombinedOutput(); err != nil { t.Fatalf("failed to replace binding test dependency to current source tree: %v\n%s", err, out) } + + // Scan the repo root (go-ethereum) go.mod file, and carry over + // any "replace" directive statements. + // This keeps this test from failing because of mismatch dependency types + // compared to the actual parent project. + rootGoMod, err := os.Open(filepath.Join(repoRoot, "go.mod")) + if err != nil { + t.Fatal(err) + } + scnr := bufio.NewScanner(rootGoMod) + for scnr.Scan() { + line := scnr.Text() + if strings.HasPrefix(line, "replace ") { + // Dissemble the statement to usable bits and format. + line = strings.TrimPrefix(line, "replace ") + spl := strings.Split(line, "=>") + from, to := strings.TrimSpace(spl[0]), strings.TrimSpace(spl[1]) + from, to = strings.Replace(from, " ", "@", 1), strings.Replace(to, " ", "@", 1) + + // Make the 'go mod edit -replace' command. + replacer = exec.Command(gocmd, "mod", "edit", "-replace", from+"="+to) + replacer.Dir = pkg + if out, err := replacer.CombinedOutput(); err != nil { + t.Fatalf("failed to replace binding test dependency to current source tree: %v\n%s", err, out) + } + } + } + if err := scnr.Err(); err != nil { + t.Fatal(err) + } + // Test the entire package and report any failures cmd := exec.Command(gocmd, "test", "-v", "-count", "1") cmd.Dir = pkg diff --git a/cmd/clef/main.go b/cmd/clef/main.go index b2c8812ab2..af4b3cbdd2 100644 --- a/cmd/clef/main.go +++ b/cmd/clef/main.go @@ -539,18 +539,25 @@ func signer(c *cli.Context) error { vhosts := splitAndTrim(c.GlobalString(utils.RPCVirtualHostsFlag.Name)) cors := splitAndTrim(c.GlobalString(utils.RPCCORSDomainFlag.Name)) + srv := rpc.NewServer() + _, err := node.RegisterApisFromWhitelist(rpcAPI, []string{"account"}, srv, false) + if err != nil { + utils.Fatalf("Could not register API: %w", err) + } + handler := node.NewHTTPHandlerStack(srv, cors, vhosts) + // start http server httpEndpoint := fmt.Sprintf("%s:%d", c.GlobalString(utils.RPCListenAddrFlag.Name), c.Int(rpcPortFlag.Name)) - listener, _, err := rpc.StartHTTPEndpoint(httpEndpoint, rpcAPI, []string{"account"}, cors, vhosts, rpc.DefaultHTTPTimeouts) + listener, err := node.StartHTTPEndpoint(httpEndpoint, rpc.DefaultHTTPTimeouts, handler) if err != nil { utils.Fatalf("Could not start RPC api: %v", err) } - extapiURL = fmt.Sprintf("http://%s", httpEndpoint) + extapiURL = fmt.Sprintf("http://%v/", listener.Addr()) log.Info("HTTP endpoint opened", "url", extapiURL) defer func() { listener.Close() - log.Info("HTTP endpoint closed", "url", httpEndpoint) + log.Info("HTTP endpoint closed", "url", extapiURL) }() } if !c.GlobalBool(utils.IPCDisabledFlag.Name) { diff --git a/cmd/geth/main.go b/cmd/geth/main.go index 31cb3a5f8f..9c72a767ef 100644 --- a/cmd/geth/main.go +++ b/cmd/geth/main.go @@ -38,12 +38,10 @@ import ( "github.com/ethereum/go-ethereum/eth/downloader" "github.com/ethereum/go-ethereum/ethclient" "github.com/ethereum/go-ethereum/internal/debug" - "github.com/ethereum/go-ethereum/internal/openrpc" "github.com/ethereum/go-ethereum/les" "github.com/ethereum/go-ethereum/log" "github.com/ethereum/go-ethereum/metrics" "github.com/ethereum/go-ethereum/node" - "github.com/ethereum/go-ethereum/rpc" cli "gopkg.in/urfave/cli.v1" ) @@ -250,10 +248,6 @@ func init() { console.Stdin.Close() // Resets terminal mode. return nil } - - if err := rpc.SetDefaultOpenRPCSchemaRaw(openrpc.OpenRPCSchema); err != nil { - log.Crit("Setting OpenRPC default", "error", err) - } } func main() { diff --git a/cmd/geth/retesteth.go b/cmd/geth/retesteth.go index a1cce2cd6a..607bbdb049 100644 --- a/cmd/geth/retesteth.go +++ b/cmd/geth/retesteth.go @@ -891,6 +891,14 @@ func retesteth(ctx *cli.Context) error { vhosts := splitAndTrim(ctx.GlobalString(utils.RPCVirtualHostsFlag.Name)) cors := splitAndTrim(ctx.GlobalString(utils.RPCCORSDomainFlag.Name)) + // register apis and create handler stack + srv := rpc.NewServer() + _, err := node.RegisterApisFromWhitelist(rpcAPI, []string{"test", "eth", "debug", "web3"}, srv, false) + if err != nil { + utils.Fatalf("Could not register RPC apis: %w", err) + } + handler := node.NewHTTPHandlerStack(srv, cors, vhosts) + // start http server var RetestethHTTPTimeouts = rpc.HTTPTimeouts{ ReadTimeout: 120 * time.Second, @@ -898,7 +906,7 @@ func retesteth(ctx *cli.Context) error { IdleTimeout: 120 * time.Second, } httpEndpoint := fmt.Sprintf("%s:%d", ctx.GlobalString(utils.RPCListenAddrFlag.Name), ctx.Int(rpcPortFlag.Name)) - listener, _, err := rpc.StartHTTPEndpoint(httpEndpoint, rpcAPI, []string{"test", "eth", "debug", "web3"}, cors, vhosts, RetestethHTTPTimeouts) + listener, err := node.StartHTTPEndpoint(httpEndpoint, RetestethHTTPTimeouts, handler) if err != nil { utils.Fatalf("Could not start RPC api: %v", err) } diff --git a/develop-openrpc-doc.sh b/develop-openrpc-doc.sh new file mode 100755 index 0000000000..7c98915e26 --- /dev/null +++ b/develop-openrpc-doc.sh @@ -0,0 +1,23 @@ +#!/usr/bin/env bash + +set -e + +[[ -f openrpc.json ]] || { wget --no-check-certificate https://raw.githubusercontent.com/etclabscore/ethereum-json-rpc-specification/master/openrpc.json; } + +if ! pgrep geth > /dev/null 2>&1; then +( +make geth && ./build/bin/geth --datadir=/tmp/gethddd --nodiscover --maxpeers=0 --rpc --rpcapi=admin,debug,eth,ethash,miner,net,personal,rpc,txpool,web3 +)& +fi + +# Logs are truncated with each run, they only show the latest state. +http --json POST http://localhost:8545 id:=$(date +%s) method=rpc_setOpenRPCDiscoverDocument params:='["./openrpc.json"]' |& tee openrpc_set.log +grep -q error openrpc_set.log && exit 1 +http --json POST http://localhost:8545 id:=$(date +%s) method=rpc_describeOpenRPC params:='[]' | jj -p > openrpc_describe.log + +http --json POST http://localhost:8545 id:=$(date +%s) method=rpc_describe params:='[]' | jj -p > rpc_describe.log + +# Developer can then inspect the logs, eg. + +# cat openrpc_describe.log | jj -p | head -40 + diff --git a/eth/api_tracer.go b/eth/api_tracer.go index cdfe60cb69..27c57b1693 100644 --- a/eth/api_tracer.go +++ b/eth/api_tracer.go @@ -20,6 +20,7 @@ import ( "bufio" "bytes" "context" + "encoding/json" "errors" "fmt" "io/ioutil" @@ -699,9 +700,10 @@ func (api *PrivateDebugAPI) computeStateDB(block *types.Block, reexec uint64) (* return statedb, nil } +// FIXME: Is this really supposed to return an *ethapi.ExecutionResult type, or the empty interface in case not *vm.StructLogger? // TraceTransaction returns the structured logs created during the execution of EVM // and returns them as a JSON object. -func (api *PrivateDebugAPI) TraceTransaction(ctx context.Context, hash common.Hash, config *TraceConfig) (interface{}, error) { +func (api *PrivateDebugAPI) TraceTransaction(ctx context.Context, hash common.Hash, config *TraceConfig) (*ethapi.ExecutionResult, error) { // Retrieve the transaction and assemble its EVM context tx, blockHash, _, index := rawdb.ReadTransaction(api.eth.ChainDb(), hash) if tx == nil { @@ -722,7 +724,7 @@ func (api *PrivateDebugAPI) TraceTransaction(ctx context.Context, hash common.Ha // traceTx configures a new tracer according to the provided configuration, and // executes the given message in the provided environment. The return value will // be tracer dependent. -func (api *PrivateDebugAPI) traceTx(ctx context.Context, message core.Message, vmctx vm.Context, statedb *state.StateDB, config *TraceConfig) (interface{}, error) { +func (api *PrivateDebugAPI) traceTx(ctx context.Context, message core.Message, vmctx vm.Context, statedb *state.StateDB, config *TraceConfig) (*ethapi.ExecutionResult, error) { // Assemble the structured logger or the JavaScript tracer var ( tracer vm.Tracer @@ -773,7 +775,16 @@ func (api *PrivateDebugAPI) traceTx(ctx context.Context, message core.Message, v }, nil case *tracers.Tracer: - return tracer.GetResult() + m, err := tracer.GetResult() + if err != nil { + return nil, err + } + r := ethapi.ExecutionResult{} + err = json.Unmarshal(m, &r) + if err != nil { + return nil, err + } + return &r, nil default: panic(fmt.Sprintf("bad tracer type %T", tracer)) diff --git a/ethereum-json-rpc.json b/ethereum-json-rpc.json new file mode 100644 index 0000000000..4e8f62245a --- /dev/null +++ b/ethereum-json-rpc.json @@ -0,0 +1,8931 @@ +{ + "openrpc": "1.2.4", + "info": { + "title": "Ethereum JSON-RPC", + "description": "This API lets you interact with an EVM-based client via JSON-RPC", + "termsOfService": "https://github.com/etclabscore/core-geth/blob/master/COPYING", + "contact": { + "name": "", + "url": "", + "email": "" + }, + "license": { + "name": "Apache-2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" + }, + "version": "1.0.10" + }, + "servers": [ + { + "name": "tcp", + "url": "127.0.0.1:8545", + "summary": "", + "description": "CoreGeth/v1.11.2-unstable", + "variables": null + } + ], + "methods": [ + { + "name": "admin_addPeer", + "tags": [], + "summary": "AddPeer requests connecting to a remote node, and also maintaining the new\nconnection at all times, even reconnecting if it is lost.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).AddPeer", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:45" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "admin_addPeerResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_addTrustedPeer", + "tags": [], + "summary": "AddTrustedPeer allows a remote node to always connect, even if slots are full\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).AddTrustedPeer", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:77" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "admin_addTrustedPeerResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_datadir", + "tags": [], + "summary": "Datadir retrieves the current data directory the node is using.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PublicAdminAPI).Datadir", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:295" + }, + "params": [], + "result": { + "name": "admin_datadirResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_exportChain", + "tags": [], + "summary": "ExportChain exports the current blockchain into a local file,\nor a range of blocks if first and last are non-nil\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateAdminAPI).ExportChain", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:171" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "first", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + { + "name": "last", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "admin_exportChainResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_importChain", + "tags": [], + "summary": "ImportChain imports a blockchain from a local file.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateAdminAPI).ImportChain", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:219" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "admin_importChainResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_nodeInfo", + "tags": [], + "summary": "NodeInfo retrieves all the information we know about the host node at the\nprotocol granularity.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PublicAdminAPI).NodeInfo", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:285" + }, + "params": [], + "result": { + "name": "admin_nodeInfoResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/p2p:NodeInfo", + "definitions": { + "": { + "type": "object", + "required": ["discovery", "listener"], + "properties": { + "discovery": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "listener": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + }, + "NodeInfo": { + "type": "object", + "required": [ + "id", + "name", + "enode", + "enr", + "ip", + "ports", + "listenAddr", + "protocols" + ], + "properties": { + "enode": { + "type": "string" + }, + "enr": { + "type": "string" + }, + "id": { + "type": "string" + }, + "ip": { + "type": "string" + }, + "listenAddr": { + "type": "string" + }, + "name": { + "type": "string" + }, + "ports": { + "$ref": "#/definitions/", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "protocols": { + "$ref": "#/definitions/" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/NodeInfo", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_peers", + "tags": [], + "summary": "Peers retrieves all the information we know about each individual peer at the\nprotocol granularity.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PublicAdminAPI).Peers", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:275" + }, + "params": [], + "result": { + "name": "admin_peersResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/PeerInfo", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "definitions": { + "": { + "type": "object", + "required": [ + "localAddress", + "remoteAddress", + "inbound", + "trusted", + "static" + ], + "properties": { + "inbound": { + "type": "boolean" + }, + "localAddress": { + "type": "string" + }, + "remoteAddress": { + "type": "string" + }, + "static": { + "type": "boolean" + }, + "trusted": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "PeerInfo": { + "type": "object", + "required": [ + "enode", + "id", + "name", + "caps", + "network", + "protocols" + ], + "properties": { + "caps": { + "type": "array", + "items": { + "type": "string" + } + }, + "enode": { + "type": "string" + }, + "enr": { + "type": "string" + }, + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "network": { + "$ref": "#/definitions/", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "protocols": { + "$ref": "#/definitions/" + } + }, + "additionalProperties": false + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_removePeer", + "tags": [], + "summary": "RemovePeer disconnects from a remote node if the connection exists\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).RemovePeer", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:61" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "admin_removePeerResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_removeTrustedPeer", + "tags": [], + "summary": "RemoveTrustedPeer removes a remote node from the trusted peer set, but it\ndoes not disconnect it automatically.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).RemoveTrustedPeer", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:93" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "admin_removeTrustedPeerResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_startRPC", + "tags": [], + "summary": "StartRPC starts the HTTP RPC API server.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).StartRPC", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:146" + }, + "params": [ + { + "name": "host", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:string", + "type": "string" + } + }, + { + "name": "port", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + { + "name": "cors", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:string", + "type": "string" + } + }, + { + "name": "apis", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:string", + "type": "string" + } + }, + { + "name": "vhosts", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:string", + "type": "string" + } + } + ], + "result": { + "name": "admin_startRPCResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_startWS", + "tags": [], + "summary": "StartWS starts the websocket RPC API server.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).StartWS", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:208" + }, + "params": [ + { + "name": "host", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:string", + "type": "string" + } + }, + { + "name": "port", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + { + "name": "allowedOrigins", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:string", + "type": "string" + } + }, + { + "name": "apis", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:string", + "type": "string" + } + } + ], + "result": { + "name": "admin_startWSResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_stopRPC", + "tags": [], + "summary": "StopRPC terminates an already running HTTP RPC API endpoint.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).StopRPC", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:196" + }, + "params": [], + "result": { + "name": "admin_stopRPCResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_stopWS", + "tags": [], + "summary": "StopWS terminates an already running websocket RPC API endpoint.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).StopWS", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:250" + }, + "params": [], + "result": { + "name": "admin_stopWSResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_accountRange", + "tags": [], + "summary": "AccountRange enumerates all accounts in the latest state\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).AccountRange", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:395" + }, + "params": [ + { + "name": "start", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "maxResults", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "debug_accountRangeResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/eth:AccountRangeResult", + "definitions": { + "AccountRangeResult": { + "type": "object", + "required": ["accounts", "next"], + "properties": { + "accounts": { + "type": "object", + "patternProperties": { + ".*": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + }, + "next": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/AccountRangeResult", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_backtraceAt", + "tags": [], + "summary": "BacktraceAt sets the log backtrace location. See package log for details on\nthe pattern syntax.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).BacktraceAt", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:68" + }, + "params": [ + { + "name": "location", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_blockProfile", + "tags": [], + "summary": "BlockProfile turns on goroutine profiling for nsec seconds and writes profile data to\nfile. It uses a profile rate of 1 for most accurate information. If a different rate is\ndesired, set the rate and write the profile manually.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).BlockProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:147" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "nsec", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_chaindbCompact", + "tags": [], + "summary": "ChaindbCompact flattens the entire key-value database into a single level,\nremoving all unused slots and merging all keys.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateDebugAPI).ChaindbCompact", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1759" + }, + "params": [], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_chaindbProperty", + "tags": [], + "summary": "ChaindbProperty returns leveldb properties of the key-value database.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateDebugAPI).ChaindbProperty", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1748" + }, + "params": [ + { + "name": "property", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "debug_chaindbPropertyResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_cpuProfile", + "tags": [], + "summary": "CpuProfile turns on CPU profiling for nsec seconds and writes\nprofile data to file.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).CpuProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:88" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "nsec", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_dumpBlock", + "tags": [], + "summary": "DumpBlock retrieves the entire state of the database at a given block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PublicDebugAPI).DumpBlock", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:280" + }, + "params": [ + { + "name": "blockNr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Block tag or hex representation of a block number", + "title": "blockNumberOrTag", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + } + ] + } + } + ], + "result": { + "name": "debug_dumpBlockResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/core/state:state.Dump", + "definitions": { + "Dump": { + "type": "object", + "required": ["root", "accounts"], + "properties": { + "accounts": { + "type": "object", + "patternProperties": { + ".*": { + "$ref": "#/definitions/DumpAccount", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + }, + "root": { + "type": "string" + } + }, + "additionalProperties": false + }, + "DumpAccount": { + "type": "object", + "required": ["balance", "nonce", "root", "codeHash"], + "properties": { + "address": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "balance": { + "type": "string" + }, + "code": { + "type": "string" + }, + "codeHash": { + "type": "string" + }, + "key": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "root": { + "type": "string" + }, + "storage": { + "type": "object", + "patternProperties": { + ".*": { + "type": "string" + } + } + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/Dump", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_freeOSMemory", + "tags": [], + "summary": "FreeOSMemory returns unused memory to the OS.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).FreeOSMemory", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:200" + }, + "params": [], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_gcStats", + "tags": [], + "summary": "GcStats returns GC statistics.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).GcStats", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:80" + }, + "params": [], + "result": { + "name": "debug_gcStatsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*runtime/debug:GCStats", + "definitions": { + "GCStats": { + "type": "object", + "required": [ + "LastGC", + "NumGC", + "PauseTotal", + "Pause", + "PauseEnd", + "PauseQuantiles" + ], + "properties": { + "LastGC": { + "type": "string", + "format": "date-time" + }, + "NumGC": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Pause": { + "type": "array", + "items": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "PauseEnd": { + "type": "array", + "items": { + "type": "string", + "format": "date-time" + } + }, + "PauseQuantiles": { + "type": "array", + "items": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "PauseTotal": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/GCStats", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_getBadBlocks", + "tags": [], + "summary": "GetBadBlocks returns a list of the last 'bad blocks' that the client has seen on the network\nand returns them as a JSON list of block-hashes\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).GetBadBlocks", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:333" + }, + "params": [], + "result": { + "name": "debug_getBadBlocksResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/BadBlockArgs", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "definitions": { + "BadBlockArgs": { + "type": "object", + "required": ["hash", "block", "rlp"], + "properties": { + "block": { + "type": "object", + "patternProperties": { + ".*": { + "additionalProperties": true + } + } + }, + "hash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "rlp": { + "type": "string" + } + }, + "additionalProperties": false + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_getBlockRlp", + "tags": [], + "summary": "GetBlockRlp retrieves the RLP encoded for of a single block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicDebugAPI).GetBlockRlp", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1666" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "debug_getBlockRlpResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_getModifiedAccountsByHash", + "tags": [], + "summary": "GetModifiedAccountsByHash returns all accounts that have changed between the\ntwo blocks specified. A change is defined as a difference in nonce, balance,\ncode hash, or storage hash.\n\nWith one parameter, returns the list of accounts modified in the specified block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).GetModifiedAccountsByHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:502" + }, + "params": [ + { + "name": "startHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "endHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "debug_getModifiedAccountsByHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_getModifiedAccountsByNumber", + "tags": [], + "summary": "GetModifiedAccountsByNumber returns all accounts that have changed between the\ntwo blocks specified. A change is defined as a difference in nonce, balance,\ncode hash, or storage hash.\n\nWith one parameter, returns the list of accounts modified in the specified block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).GetModifiedAccountsByNumber", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:474" + }, + "params": [ + { + "name": "startNum", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + { + "name": "endNum", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "debug_getModifiedAccountsByNumberResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_goTrace", + "tags": [], + "summary": "GoTrace turns on tracing for nsec seconds and writes\ntrace data to file.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).GoTrace", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:135" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "nsec", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_memStats", + "tags": [], + "summary": "MemStats returns detailed runtime memory statistics.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).MemStats", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:73" + }, + "params": [], + "result": { + "name": "debug_memStatsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*runtime:MemStats", + "definitions": { + "": { + "type": "object", + "required": ["Size", "Mallocs", "Frees"], + "properties": { + "Frees": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Mallocs": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Size": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + }, + "MemStats": { + "type": "object", + "required": [ + "Alloc", + "TotalAlloc", + "Sys", + "Lookups", + "Mallocs", + "Frees", + "HeapAlloc", + "HeapSys", + "HeapIdle", + "HeapInuse", + "HeapReleased", + "HeapObjects", + "StackInuse", + "StackSys", + "MSpanInuse", + "MSpanSys", + "MCacheInuse", + "MCacheSys", + "BuckHashSys", + "GCSys", + "OtherSys", + "NextGC", + "LastGC", + "PauseTotalNs", + "PauseNs", + "PauseEnd", + "NumGC", + "NumForcedGC", + "GCCPUFraction", + "EnableGC", + "DebugGC", + "BySize" + ], + "properties": { + "Alloc": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "BuckHashSys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "BySize": { + "type": "array", + "maxItems": 61, + "minItems": 61, + "items": { + "$ref": "#/definitions/", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "DebugGC": { + "type": "boolean" + }, + "EnableGC": { + "type": "boolean" + }, + "Frees": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "GCCPUFraction": { + "type": "number" + }, + "GCSys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "HeapAlloc": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "HeapIdle": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "HeapInuse": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "HeapObjects": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "HeapReleased": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "HeapSys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "LastGC": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Lookups": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "MCacheInuse": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "MCacheSys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "MSpanInuse": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "MSpanSys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Mallocs": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "NextGC": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "NumForcedGC": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "NumGC": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "OtherSys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "PauseEnd": { + "type": "array", + "maxItems": 256, + "minItems": 256, + "items": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "PauseNs": { + "type": "array", + "maxItems": 256, + "minItems": 256, + "items": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "PauseTotalNs": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "StackInuse": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "StackSys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Sys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "TotalAlloc": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/MemStats", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_mutexProfile", + "tags": [], + "summary": "MutexProfile turns on mutex profiling for nsec seconds and writes profile data to file.\nIt uses a profile rate of 1 for most accurate information. If a different rate is\ndesired, set the rate and write the profile manually.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).MutexProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:168" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "nsec", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_preimage", + "tags": [], + "summary": "Preimage is a debug API function that returns the preimage for a sha3 hash, if known.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).Preimage", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:317" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "debug_preimageResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_printBlock", + "tags": [], + "summary": "PrintBlock retrieves a block and returns its pretty printed form.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicDebugAPI).PrintBlock", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1718" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "debug_printBlockResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_seedHash", + "tags": [], + "summary": "SeedHash retrieves the seed hash of a block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicDebugAPI).SeedHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1727" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "debug_seedHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_setBlockProfileRate", + "tags": [], + "summary": "SetBlockProfileRate sets the rate of goroutine block profile data collection.\nrate 0 disables block profiling.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).SetBlockProfileRate", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:156" + }, + "params": [ + { + "name": "rate", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_setGCPercent", + "tags": [], + "summary": "SetGCPercent sets the garbage collection target percentage. It returns the previous\nsetting. A negative value disables GC.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).SetGCPercent", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:206" + }, + "params": [ + { + "name": "v", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "debug_setGCPercentResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_setHead", + "tags": [], + "summary": "SetHead rewinds the head of the blockchain to a previous block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateDebugAPI).SetHead", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1771" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_setMutexProfileFraction", + "tags": [], + "summary": "SetMutexProfileFraction sets the rate of mutex profiling.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).SetMutexProfileFraction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:177" + }, + "params": [ + { + "name": "rate", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_stacks", + "tags": [], + "summary": "Stacks returns a printed representation of the stacks of all goroutines.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).Stacks", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:193" + }, + "params": [], + "result": { + "name": "debug_stacksResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_standardTraceBadBlockToFile", + "tags": [], + "summary": "StandardTraceBadBlockToFile dumps the structured logs created during the\nexecution of EVM against a block pulled from the pool of bad ones to the\nlocal file system and returns a list of files to the caller.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).StandardTraceBadBlockToFile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:432" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/eth:StdTraceConfig", + "definitions": { + "StdTraceConfig": { + "type": "object", + "required": [ + "DisableMemory", + "DisableStack", + "DisableStorage", + "Debug", + "Limit", + "Reexec", + "TxHash" + ], + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "TxHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/StdTraceConfig", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_standardTraceBadBlockToFileResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_standardTraceBlockToFile", + "tags": [], + "summary": "StandardTraceBlockToFile dumps the structured logs created during the\nexecution of EVM to the local file system and returns a list of files\nto the caller.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).StandardTraceBlockToFile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:421" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/eth:StdTraceConfig", + "definitions": { + "StdTraceConfig": { + "type": "object", + "required": [ + "DisableMemory", + "DisableStack", + "DisableStorage", + "Debug", + "Limit", + "Reexec", + "TxHash" + ], + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "TxHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/StdTraceConfig", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_standardTraceBlockToFileResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_startCPUProfile", + "tags": [], + "summary": "StartCPUProfile turns on CPU profiling, writing to the given file.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).StartCPUProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:98" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_startGoTrace", + "tags": [], + "summary": "StartGoTrace turns on tracing, writing to the given file.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).StartGoTrace", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/trace.go:30" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_stopCPUProfile", + "tags": [], + "summary": "StopCPUProfile stops an ongoing CPU profile.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).StopCPUProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:119" + }, + "params": [], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_stopGoTrace", + "tags": [], + "summary": "StopTrace stops an ongoing trace.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).StopGoTrace", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/trace.go:51" + }, + "params": [], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_storageRangeAt", + "tags": [], + "summary": "StorageRangeAt returns the storage at the given block height and transaction index.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).StorageRangeAt", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:434" + }, + "params": [ + { + "name": "blockHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "txIndex", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + { + "name": "contractAddress", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + { + "name": "keyStart", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + }, + { + "name": "maxResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "debug_storageRangeAtResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/eth:StorageRangeResult", + "definitions": { + "StorageRangeResult": { + "type": "object", + "required": ["storage", "nextKey"], + "properties": { + "nextKey": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "storage": { + "type": "object", + "patternProperties": { + ".*": { + "$ref": "#/definitions/storageEntry", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + } + }, + "additionalProperties": false + }, + "storageEntry": { + "type": "object", + "required": ["key", "value"], + "properties": { + "key": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/StorageRangeResult", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_testSignCliqueBlock", + "tags": [], + "summary": "TestSignCliqueBlock fetches the given block number, and attempts to sign it as a clique header with the\ngiven address, returning the address of the recovered signature\n\nThis is a temporary method to debug the externalsigner integration,\nTODO: Remove this method when the integration is mature\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicDebugAPI).TestSignCliqueBlock", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1683" + }, + "params": [ + { + "name": "address", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "debug_testSignCliqueBlockResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceBadBlock", + "tags": [], + "summary": "TraceBadBlockByHash returns the structured logs created during the execution of\nEVM against a block pulled from the pool of bad ones and returns them as a JSON\nobject.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).TraceBadBlock", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:408" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/eth:TraceConfig", + "definitions": { + "TraceConfig": { + "type": "object", + "required": [ + "DisableMemory", + "DisableStack", + "DisableStorage", + "Debug", + "Limit", + "Tracer", + "Timeout", + "Reexec" + ], + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Timeout": { + "type": "string" + }, + "Tracer": { + "type": "string" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/TraceConfig", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_traceBadBlockResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/txTraceResult", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "definitions": { + "txTraceResult": { + "type": "object", + "properties": { + "error": { + "type": "string" + }, + "result": { + "additionalProperties": true + } + }, + "additionalProperties": false + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceBlock", + "tags": [], + "summary": "TraceBlock returns the structured logs created during the execution of EVM\nand returns them as a JSON object.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).TraceBlock", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:387" + }, + "params": [ + { + "name": "blob", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a variable length byte array", + "type": "string", + "title": "bytes", + "pattern": "^0x([a-fA-F0-9]?)+$" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/eth:TraceConfig", + "definitions": { + "TraceConfig": { + "type": "object", + "required": [ + "DisableMemory", + "DisableStack", + "DisableStorage", + "Debug", + "Limit", + "Tracer", + "Timeout", + "Reexec" + ], + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Timeout": { + "type": "string" + }, + "Tracer": { + "type": "string" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/TraceConfig", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_traceBlockResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/txTraceResult", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "definitions": { + "txTraceResult": { + "type": "object", + "properties": { + "error": { + "type": "string" + }, + "result": { + "additionalProperties": true + } + }, + "additionalProperties": false + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceBlockByHash", + "tags": [], + "summary": "TraceBlockByHash returns the structured logs created during the execution of\nEVM and returns them as a JSON object.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).TraceBlockByHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:377" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/eth:TraceConfig", + "definitions": { + "TraceConfig": { + "type": "object", + "required": [ + "DisableMemory", + "DisableStack", + "DisableStorage", + "Debug", + "Limit", + "Tracer", + "Timeout", + "Reexec" + ], + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Timeout": { + "type": "string" + }, + "Tracer": { + "type": "string" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/TraceConfig", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_traceBlockByHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/txTraceResult", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "definitions": { + "txTraceResult": { + "type": "object", + "properties": { + "error": { + "type": "string" + }, + "result": { + "additionalProperties": true + } + }, + "additionalProperties": false + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceBlockByNumber", + "tags": [], + "summary": "TraceBlockByNumber returns the structured logs created during the execution of\nEVM and returns them as a JSON object.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).TraceBlockByNumber", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:356" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Block tag or hex representation of a block number", + "title": "blockNumberOrTag", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + } + ] + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/eth:TraceConfig", + "definitions": { + "TraceConfig": { + "type": "object", + "required": [ + "DisableMemory", + "DisableStack", + "DisableStorage", + "Debug", + "Limit", + "Tracer", + "Timeout", + "Reexec" + ], + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Timeout": { + "type": "string" + }, + "Tracer": { + "type": "string" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/TraceConfig", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_traceBlockByNumberResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/txTraceResult", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "definitions": { + "txTraceResult": { + "type": "object", + "properties": { + "error": { + "type": "string" + }, + "result": { + "additionalProperties": true + } + }, + "additionalProperties": false + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceBlockFromFile", + "tags": [], + "summary": "TraceBlockFromFile returns the structured logs created during the execution of\nEVM and returns them as a JSON object.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).TraceBlockFromFile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:397" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/eth:TraceConfig", + "definitions": { + "TraceConfig": { + "type": "object", + "required": [ + "DisableMemory", + "DisableStack", + "DisableStorage", + "Debug", + "Limit", + "Tracer", + "Timeout", + "Reexec" + ], + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Timeout": { + "type": "string" + }, + "Tracer": { + "type": "string" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/TraceConfig", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_traceBlockFromFileResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/txTraceResult", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "definitions": { + "txTraceResult": { + "type": "object", + "properties": { + "error": { + "type": "string" + }, + "result": { + "additionalProperties": true + } + }, + "additionalProperties": false + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceTransaction", + "tags": [], + "summary": "FIXME: Is this really supposed to return an *ethapi.ExecutionResult type, or the empty interface in case not *vm.StructLogger?\nTraceTransaction returns the structured logs created during the execution of EVM\nand returns them as a JSON object.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).TraceTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:706" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/eth:TraceConfig", + "definitions": { + "TraceConfig": { + "type": "object", + "required": [ + "DisableMemory", + "DisableStack", + "DisableStorage", + "Debug", + "Limit", + "Tracer", + "Timeout", + "Reexec" + ], + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Timeout": { + "type": "string" + }, + "Tracer": { + "type": "string" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/TraceConfig", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_traceTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/internal/ethapi:ExecutionResult", + "definitions": { + "ExecutionResult": { + "type": "object", + "required": ["gas", "failed", "returnValue", "structLogs"], + "properties": { + "failed": { + "type": "boolean" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "returnValue": { + "type": "string" + }, + "structLogs": { + "type": "array", + "items": { + "$ref": "#/definitions/StructLogRes", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + }, + "additionalProperties": false + }, + "StructLogRes": { + "type": "object", + "required": ["pc", "op", "gas", "gasCost", "depth"], + "properties": { + "depth": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "error": { + "additionalProperties": true + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasCost": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "memory": { + "type": "array", + "items": { + "type": "string" + } + }, + "op": { + "type": "string" + }, + "pc": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "stack": { + "type": "array", + "items": { + "type": "string" + } + }, + "storage": { + "type": "object", + "patternProperties": { + ".*": { + "type": "string" + } + } + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/ExecutionResult", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_verbosity", + "tags": [], + "summary": "Verbosity sets the log verbosity ceiling. The verbosity of individual packages\nand source files can be raised using Vmodule.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).Verbosity", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:57" + }, + "params": [ + { + "name": "level", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_vmodule", + "tags": [], + "summary": "Vmodule sets the log verbosity pattern. See package log for details on the\npattern syntax.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).Vmodule", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:62" + }, + "params": [ + { + "name": "pattern", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_writeBlockProfile", + "tags": [], + "summary": "WriteBlockProfile writes a goroutine blocking profile to the given file.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).WriteBlockProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:161" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_writeMemProfile", + "tags": [], + "summary": "WriteMemProfile writes an allocation profile to the given file.\nNote that the profiling rate cannot be set through the API,\nit must be set on the command line.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).WriteMemProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:188" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_writeMutexProfile", + "tags": [], + "summary": "WriteMutexProfile writes a goroutine blocking profile to the given file.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).WriteMutexProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:181" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_accounts", + "tags": [], + "summary": "Accounts returns the collection of accounts this node manages\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicAccountAPI).Accounts", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:193" + }, + "params": [], + "result": { + "name": "eth_accountsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_blockNumber", + "tags": [], + "summary": "BlockNumber returns the block number of the chain head.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).BlockNumber", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:525" + }, + "params": [], + "result": { + "name": "eth_blockNumberResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_call", + "tags": [], + "summary": "Call executes the given transaction on the state for the given block number.\n\nAdditionally, the caller can specify a batch of contract for fields overriding.\n\nNote, this function doesn't make and changes in the state/blockchain and is\nuseful to execute and retrieve values.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).Call", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:877" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi:CallArgs", + "definitions": { + "CallArgs": { + "type": "object", + "required": ["from", "to", "gas", "gasPrice", "value", "data"], + "properties": { + "data": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "from": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/CallArgs", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "blockNrOrHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a block number or hash", + "title": "blockNumberOrHash", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + ] + } + }, + { + "name": "overrides", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:", + "type": "object", + "patternProperties": { + ".*": { + "$ref": "#/definitions/account", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "definitions": { + "account": { + "type": "object", + "required": ["nonce", "code", "balance", "state", "stateDiff"], + "properties": { + "balance": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "code": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "state": { + "type": "object", + "patternProperties": { + ".*": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + }, + "stateDiff": { + "type": "object", + "patternProperties": { + ".*": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + } + }, + "additionalProperties": false + } + } + } + } + ], + "result": { + "name": "eth_callResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_chainId", + "tags": [], + "summary": "ChainId is the EIP-155 replay-protection chain id for the current ethereum chain config.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PublicEthereumAPI).ChainId", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:70" + }, + "params": [], + "result": { + "name": "eth_chainIdResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_coinbase", + "tags": [], + "summary": "Coinbase is the address that mining rewards will be send to (alias for Etherbase)\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PublicEthereumAPI).Coinbase", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:60" + }, + "params": [], + "result": { + "name": "eth_coinbaseResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_estimateGas", + "tags": [], + "summary": "EstimateGas returns an estimate of the amount of gas needed to execute the\ngiven transaction against the current pending block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).EstimateGas", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:951" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi:CallArgs", + "definitions": { + "CallArgs": { + "type": "object", + "required": ["from", "to", "gas", "gasPrice", "value", "data"], + "properties": { + "data": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "from": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/CallArgs", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_estimateGasResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_etherbase", + "tags": [], + "summary": "Etherbase is the address that mining rewards will be send to\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PublicEthereumAPI).Etherbase", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:55" + }, + "params": [], + "result": { + "name": "eth_etherbaseResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_fillTransaction", + "tags": [], + "summary": "FillTransaction fills the defaults (nonce, gas, gasPrice) on a given unsigned transaction,\nand returns it to the caller for further processing (signing + broadcast)\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).FillTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1500" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi:SendTxArgs", + "definitions": { + "SendTxArgs": { + "type": "object", + "required": [ + "from", + "to", + "gas", + "gasPrice", + "value", + "nonce", + "data", + "input" + ], + "properties": { + "data": { + "description": "Field _input_ should be preferred", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/SendTxArgs", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_fillTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/internal/ethapi:SignTransactionResult", + "definitions": { + "SignTransactionResult": { + "type": "object", + "required": ["raw", "tx"], + "properties": { + "raw": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "tx": { + "$ref": "#/definitions/Transaction", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "additionalProperties": false + }, + "Transaction": { + "type": "object", + "additionalProperties": false + } + }, + "$ref": "#/definitions/SignTransactionResult", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_gasPrice", + "tags": [], + "summary": "GasPrice returns a suggestion for a gas price.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicEthereumAPI).GasPrice", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:66" + }, + "params": [], + "result": { + "name": "eth_gasPriceResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getBalance", + "tags": [], + "summary": "GetBalance returns the amount of wei for the given address in the state of the\ngiven block number. The rpc.LatestBlockNumber and rpc.PendingBlockNumber meta\nblock numbers are also allowed.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetBalance", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:533" + }, + "params": [ + { + "name": "address", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + { + "name": "blockNrOrHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a block number or hash", + "title": "blockNumberOrHash", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + ] + } + } + ], + "result": { + "name": "eth_getBalanceResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getBlockByHash", + "tags": [], + "summary": "GetBlockByHash returns the requested block. When fullTx is true all transactions in the block are returned in full\ndetail, otherwise only the transaction hash is returned.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetBlockByHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:656" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "fullTx", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + } + ], + "result": { + "name": "eth_getBlockByHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "patternProperties": { + ".*": { + "additionalProperties": true + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getBlockByNumber", + "tags": [], + "summary": "GetBlockByNumber returns the requested canonical block.\n* When blockNr is -1 the chain head is returned.\n* When blockNr is -2 the pending chain head is returned.\n* When fullTx is true all transactions in the block are returned, otherwise\n only the transaction hash is returned.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetBlockByNumber", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:639" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Block tag or hex representation of a block number", + "title": "blockNumberOrTag", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + } + ] + } + }, + { + "name": "fullTx", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + } + ], + "result": { + "name": "eth_getBlockByNumberResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "patternProperties": { + ".*": { + "additionalProperties": true + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getBlockTransactionCountByHash", + "tags": [], + "summary": "GetBlockTransactionCountByHash returns the number of transactions in the block with the given hash.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetBlockTransactionCountByHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1201" + }, + "params": [ + { + "name": "blockHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "eth_getBlockTransactionCountByHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getBlockTransactionCountByNumber", + "tags": [], + "summary": "GetBlockTransactionCountByNumber returns the number of transactions in the block with the given block number.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetBlockTransactionCountByNumber", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1192" + }, + "params": [ + { + "name": "blockNr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Block tag or hex representation of a block number", + "title": "blockNumberOrTag", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + } + ] + } + } + ], + "result": { + "name": "eth_getBlockTransactionCountByNumberResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getCode", + "tags": [], + "summary": "GetCode returns the code stored at the given address in the state for the given block number.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetCode", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:715" + }, + "params": [ + { + "name": "address", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + { + "name": "blockNrOrHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a block number or hash", + "title": "blockNumberOrHash", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + ] + } + } + ], + "result": { + "name": "eth_getCodeResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getFilterChanges", + "tags": [], + "summary": "GetFilterChanges returns the logs for the filter with the given id since\nlast time it was called. This can be used for polling.\n\nFor pending transaction and block filters the result is []common.Hash.\n(pending)Log filters return []Log.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_getfilterchanges\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth/filters.(*PublicFilterAPI).GetFilterChanges", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go:413" + }, + "params": [ + { + "name": "id", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc:rpc.ID", + "type": "string" + } + } + ], + "result": { + "name": "eth_getFilterChangesResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "additionalProperties": true + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getFilterLogs", + "tags": [], + "summary": "GetFilterLogs returns the logs for the filter with the given id.\nIf the filter could not be found an empty array of logs is returned.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_getfilterlogs\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth/filters.(*PublicFilterAPI).GetFilterLogs", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go:372" + }, + "params": [ + { + "name": "id", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc:rpc.ID", + "type": "string" + } + } + ], + "result": { + "name": "eth_getFilterLogsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Log", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "definitions": { + "Log": { + "type": "object", + "required": [ + "address", + "topics", + "data", + "blockNumber", + "transactionHash", + "transactionIndex", + "blockHash", + "logIndex", + "removed" + ], + "properties": { + "address": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "blockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "blockNumber": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "data": { + "type": "string", + "title": "bytes", + "pattern": "^0x([a-fA-F0-9]?)+$" + }, + "logIndex": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "removed": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "transactionHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "transactionIndex": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getHashrate", + "tags": [], + "summary": "GetHashrate returns the current hashrate for local CPU miner and remote miner.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).GetHashrate", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:110" + }, + "params": [], + "result": { + "name": "eth_getHashrateResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getHeaderByHash", + "tags": [], + "summary": "GetHeaderByHash returns the requested header by hash.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetHeaderByHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:626" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "eth_getHeaderByHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "patternProperties": { + ".*": { + "additionalProperties": true + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getHeaderByNumber", + "tags": [], + "summary": "GetHeaderByNumber returns the requested canonical block header.\n* When blockNr is -1 the chain head is returned.\n* When blockNr is -2 the pending chain head is returned.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetHeaderByNumber", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:610" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Block tag or hex representation of a block number", + "title": "blockNumberOrTag", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + } + ] + } + } + ], + "result": { + "name": "eth_getHeaderByNumberResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "patternProperties": { + ".*": { + "additionalProperties": true + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getLogs", + "tags": [], + "summary": "GetLogs returns logs matching the given argument that are stored within the state.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_getlogs\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth/filters.(*PublicFilterAPI).GetLogs", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go:325" + }, + "params": [ + { + "name": "crit", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/eth/filters:FilterCriteria", + "definitions": { + "FilterCriteria": { + "type": "object", + "required": [ + "BlockHash", + "FromBlock", + "ToBlock", + "Addresses", + "Topics" + ], + "properties": { + "Addresses": { + "type": "array", + "items": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + "BlockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "FromBlock": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "ToBlock": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Topics": { + "type": "array", + "items": { + "type": "array", + "items": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/FilterCriteria", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_getLogsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Log", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "definitions": { + "Log": { + "type": "object", + "required": [ + "address", + "topics", + "data", + "blockNumber", + "transactionHash", + "transactionIndex", + "blockHash", + "logIndex", + "removed" + ], + "properties": { + "address": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "blockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "blockNumber": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "data": { + "type": "string", + "title": "bytes", + "pattern": "^0x([a-fA-F0-9]?)+$" + }, + "logIndex": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "removed": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "transactionHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "transactionIndex": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getProof", + "tags": [], + "summary": "GetProof returns the Merkle-proof for a given account and optionally some storage keys.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetProof", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:558" + }, + "params": [ + { + "name": "address", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + { + "name": "storageKeys", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "blockNrOrHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a block number or hash", + "title": "blockNumberOrHash", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + ] + } + } + ], + "result": { + "name": "eth_getProofResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/internal/ethapi:AccountResult", + "definitions": { + "AccountResult": { + "type": "object", + "required": [ + "address", + "accountProof", + "balance", + "codeHash", + "nonce", + "storageHash", + "storageProof" + ], + "properties": { + "accountProof": { + "type": "array", + "items": { + "type": "string" + } + }, + "address": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "balance": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "codeHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "storageHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "storageProof": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageResult", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + }, + "additionalProperties": false + }, + "StorageResult": { + "type": "object", + "required": ["key", "value", "proof"], + "properties": { + "key": { + "type": "string" + }, + "proof": { + "type": "array", + "items": { + "type": "string" + } + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/AccountResult", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getRawTransactionByBlockHashAndIndex", + "tags": [], + "summary": "GetRawTransactionByBlockHashAndIndex returns the bytes of the transaction for the given block hash and index.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetRawTransactionByBlockHashAndIndex", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1234" + }, + "params": [ + { + "name": "blockHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "index", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "eth_getRawTransactionByBlockHashAndIndexResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getRawTransactionByBlockNumberAndIndex", + "tags": [], + "summary": "GetRawTransactionByBlockNumberAndIndex returns the bytes of the transaction for the given block number and index.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetRawTransactionByBlockNumberAndIndex", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1226" + }, + "params": [ + { + "name": "blockNr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Block tag or hex representation of a block number", + "title": "blockNumberOrTag", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + } + ] + } + }, + { + "name": "index", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "eth_getRawTransactionByBlockNumberAndIndexResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getRawTransactionByHash", + "tags": [], + "summary": "GetRawTransactionByHash returns the bytes of the transaction for the given hash.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetRawTransactionByHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1280" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "eth_getRawTransactionByHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getStorageAt", + "tags": [], + "summary": "GetStorageAt returns the storage from the state at the given address, key and\nblock number. The rpc.LatestBlockNumber and rpc.PendingBlockNumber meta block\nnumbers are also allowed.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetStorageAt", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:727" + }, + "params": [ + { + "name": "address", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + { + "name": "key", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "blockNrOrHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a block number or hash", + "title": "blockNumberOrHash", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + ] + } + } + ], + "result": { + "name": "eth_getStorageAtResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getTransactionByBlockHashAndIndex", + "tags": [], + "summary": "GetTransactionByBlockHashAndIndex returns the transaction for the given block hash and index.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetTransactionByBlockHashAndIndex", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1218" + }, + "params": [ + { + "name": "blockHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "index", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "eth_getTransactionByBlockHashAndIndexResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/internal/ethapi:RPCTransaction", + "definitions": { + "RPCTransaction": { + "type": "object", + "required": [ + "blockHash", + "blockNumber", + "from", + "gas", + "gasPrice", + "hash", + "input", + "nonce", + "to", + "transactionIndex", + "value", + "v", + "r", + "s" + ], + "properties": { + "blockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "blockNumber": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "hash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "r": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "s": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "transactionIndex": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "v": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/RPCTransaction", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getTransactionByBlockNumberAndIndex", + "tags": [], + "summary": "GetTransactionByBlockNumberAndIndex returns the transaction for the given block number and index.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetTransactionByBlockNumberAndIndex", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1210" + }, + "params": [ + { + "name": "blockNr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Block tag or hex representation of a block number", + "title": "blockNumberOrTag", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + } + ] + } + }, + { + "name": "index", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "eth_getTransactionByBlockNumberAndIndexResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/internal/ethapi:RPCTransaction", + "definitions": { + "RPCTransaction": { + "type": "object", + "required": [ + "blockHash", + "blockNumber", + "from", + "gas", + "gasPrice", + "hash", + "input", + "nonce", + "to", + "transactionIndex", + "value", + "v", + "r", + "s" + ], + "properties": { + "blockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "blockNumber": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "hash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "r": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "s": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "transactionIndex": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "v": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/RPCTransaction", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getTransactionByHash", + "tags": [], + "summary": "GetTransactionByHash returns the transaction for the given hash\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetTransactionByHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1261" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "eth_getTransactionByHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/internal/ethapi:RPCTransaction", + "definitions": { + "RPCTransaction": { + "type": "object", + "required": [ + "blockHash", + "blockNumber", + "from", + "gas", + "gasPrice", + "hash", + "input", + "nonce", + "to", + "transactionIndex", + "value", + "v", + "r", + "s" + ], + "properties": { + "blockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "blockNumber": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "hash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "r": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "s": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "transactionIndex": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "v": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/RPCTransaction", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getTransactionCount", + "tags": [], + "summary": "GetTransactionCount returns the number of transactions the given address has sent for the given block number\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetTransactionCount", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1242" + }, + "params": [ + { + "name": "address", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + { + "name": "blockNrOrHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a block number or hash", + "title": "blockNumberOrHash", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + ] + } + } + ], + "result": { + "name": "eth_getTransactionCountResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getTransactionReceipt", + "tags": [], + "summary": "GetTransactionReceipt returns the transaction receipt for the given transaction hash.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetTransactionReceipt", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1297" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "eth_getTransactionReceiptResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "patternProperties": { + ".*": { + "additionalProperties": true + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getUncleByBlockHashAndIndex", + "tags": [], + "summary": "GetUncleByBlockHashAndIndex returns the uncle block for the given block hash and index. When fullTx is true\nall transactions in the block are returned in full detail, otherwise only the transaction hash is returned.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetUncleByBlockHashAndIndex", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:682" + }, + "params": [ + { + "name": "blockHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "index", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "eth_getUncleByBlockHashAndIndexResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "patternProperties": { + ".*": { + "additionalProperties": true + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getUncleByBlockNumberAndIndex", + "tags": [], + "summary": "GetUncleByBlockNumberAndIndex returns the uncle block for the given block hash and index. When fullTx is true\nall transactions in the block are returned in full detail, otherwise only the transaction hash is returned.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetUncleByBlockNumberAndIndex", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:666" + }, + "params": [ + { + "name": "blockNr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Block tag or hex representation of a block number", + "title": "blockNumberOrTag", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + } + ] + } + }, + { + "name": "index", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "eth_getUncleByBlockNumberAndIndexResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "patternProperties": { + ".*": { + "additionalProperties": true + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getUncleCountByBlockHash", + "tags": [], + "summary": "GetUncleCountByBlockHash returns number of uncles in the block for the given block hash\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetUncleCountByBlockHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:706" + }, + "params": [ + { + "name": "blockHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "eth_getUncleCountByBlockHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getUncleCountByBlockNumber", + "tags": [], + "summary": "GetUncleCountByBlockNumber returns number of uncles in the block for the given block number\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetUncleCountByBlockNumber", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:697" + }, + "params": [ + { + "name": "blockNr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Block tag or hex representation of a block number", + "title": "blockNumberOrTag", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + } + ] + } + } + ], + "result": { + "name": "eth_getUncleCountByBlockNumberResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getWork", + "tags": [], + "summary": "GetWork returns a work package for external miner.\n\nThe work package consists of 3 strings:\n result[0] - 32 bytes hex encoded current block header pow-hash\n result[1] - 32 bytes hex encoded seed hash used for DAG\n result[2] - 32 bytes hex encoded boundary condition (\"target\"), 2^256/difficulty\n result[3] - hex encoded block number\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).GetWork", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:41" + }, + "params": [], + "result": { + "name": "eth_getWorkResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "maxItems": 4, + "minItems": 4, + "items": { + "type": "string" + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_hashrate", + "tags": [], + "summary": "Hashrate returns the POW hashrate\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PublicEthereumAPI).Hashrate", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:65" + }, + "params": [], + "result": { + "name": "eth_hashrateResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_mining", + "tags": [], + "summary": "Mining returns an indication if this node is currently mining.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PublicMinerAPI).Mining", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:91" + }, + "params": [], + "result": { + "name": "eth_miningResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_newBlockFilter", + "tags": [], + "summary": "NewBlockFilter creates a filter that fetches blocks that are imported into the chain.\nIt is part of the filter package since polling goes with eth_getFilterChanges.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_newblockfilter\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth/filters.(*PublicFilterAPI).NewBlockFilter", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go:174" + }, + "params": [], + "result": { + "name": "eth_newBlockFilterResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc:rpc.ID", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_newFilter", + "tags": [], + "summary": "NewFilter creates a new filter and returns the filter id. It can be\nused to retrieve logs when the state changes. This method cannot be\nused to fetch logs that are already stored in the state.\n\nDefault criteria for the from and to block are \"latest\".\nUsing \"latest\" as block number will return logs for mined blocks.\nUsing \"pending\" as block number returns logs for not yet mined (pending) blocks.\nIn case logs are removed (chain reorg) previously returned logs are returned\nagain but with the removed property set to true.\n\nIn case \"fromBlock\" \u003e \"toBlock\" an error is returned.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_newfilter\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth/filters.(*PublicFilterAPI).NewFilter", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go:290" + }, + "params": [ + { + "name": "crit", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/eth/filters:FilterCriteria", + "definitions": { + "FilterCriteria": { + "type": "object", + "required": [ + "BlockHash", + "FromBlock", + "ToBlock", + "Addresses", + "Topics" + ], + "properties": { + "Addresses": { + "type": "array", + "items": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + "BlockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "FromBlock": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "ToBlock": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Topics": { + "type": "array", + "items": { + "type": "array", + "items": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/FilterCriteria", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_newFilterResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc:rpc.ID", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_newPendingTransactionFilter", + "tags": [], + "summary": "NewPendingTransactionFilter creates a filter that fetches pending transaction hashes\nas transactions enter the pending state.\n\nIt is part of the filter package because this filter can be used through the\n`eth_getFilterChanges` polling method that is also used for log filters.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_newpendingtransactionfilter\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth/filters.(*PublicFilterAPI).NewPendingTransactionFilter", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go:104" + }, + "params": [], + "result": { + "name": "eth_newPendingTransactionFilterResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc:rpc.ID", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_pendingTransactions", + "tags": [], + "summary": "PendingTransactions returns the transactions that are in the transaction pool\nand have a from address that is one of the accounts this node manages.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).PendingTransactions", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1584" + }, + "params": [], + "result": { + "name": "eth_pendingTransactionsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/RPCTransaction", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "definitions": { + "RPCTransaction": { + "type": "object", + "required": [ + "blockHash", + "blockNumber", + "from", + "gas", + "gasPrice", + "hash", + "input", + "nonce", + "to", + "transactionIndex", + "value", + "v", + "r", + "s" + ], + "properties": { + "blockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "blockNumber": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "hash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "r": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "s": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "transactionIndex": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "v": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_protocolVersion", + "tags": [], + "summary": "ProtocolVersion returns the current Ethereum protocol version this node supports\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicEthereumAPI).ProtocolVersion", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:72" + }, + "params": [], + "result": { + "name": "eth_protocolVersionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_resend", + "tags": [], + "summary": "Resend accepts an existing transaction and a new gas price and limit. It will remove\nthe given transaction from the pool and reinsert it with the new gas price and limit.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).Resend", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1611" + }, + "params": [ + { + "name": "sendArgs", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi:SendTxArgs", + "definitions": { + "SendTxArgs": { + "type": "object", + "required": [ + "from", + "to", + "gas", + "gasPrice", + "value", + "nonce", + "data", + "input" + ], + "properties": { + "data": { + "description": "Field _input_ should be preferred", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/SendTxArgs", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "gasPrice", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + { + "name": "gasLimit", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "eth_resendResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_sendRawTransaction", + "tags": [], + "summary": "SendRawTransaction will add the signed transaction to the transaction pool.\nThe sender is responsible for signing the transaction and using the correct nonce.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).SendRawTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1516" + }, + "params": [ + { + "name": "encodedTx", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + } + ], + "result": { + "name": "eth_sendRawTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_sendTransaction", + "tags": [], + "summary": "SendTransaction creates a transaction for the given argument, sign it and submit it to the\ntransaction pool.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).SendTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1468" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi:SendTxArgs", + "definitions": { + "SendTxArgs": { + "type": "object", + "required": [ + "from", + "to", + "gas", + "gasPrice", + "value", + "nonce", + "data", + "input" + ], + "properties": { + "data": { + "description": "Field _input_ should be preferred", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/SendTxArgs", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_sendTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_sign", + "tags": [], + "summary": "Sign calculates an ECDSA signature for:\nkeccack256(\"\\x19Ethereum Signed Message:\\n\" + len(message) + message).\n\nNote, the produced signature conforms to the secp256k1 curve R, S and V values,\nwhere the V value will be 27 or 28 for legacy reasons.\n\nThe account associated with addr must be unlocked.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).Sign", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1533" + }, + "params": [ + { + "name": "addr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + { + "name": "data", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + } + ], + "result": { + "name": "eth_signResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_signTransaction", + "tags": [], + "summary": "SignTransaction will sign the given transaction with the from account.\nThe node needs to have the private key of the account corresponding with\nthe given from address and it needs to be unlocked.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).SignTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1558" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi:SendTxArgs", + "definitions": { + "SendTxArgs": { + "type": "object", + "required": [ + "from", + "to", + "gas", + "gasPrice", + "value", + "nonce", + "data", + "input" + ], + "properties": { + "data": { + "description": "Field _input_ should be preferred", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/SendTxArgs", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_signTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/internal/ethapi:SignTransactionResult", + "definitions": { + "SignTransactionResult": { + "type": "object", + "required": ["raw", "tx"], + "properties": { + "raw": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "tx": { + "$ref": "#/definitions/Transaction", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "additionalProperties": false + }, + "Transaction": { + "type": "object", + "additionalProperties": false + } + }, + "$ref": "#/definitions/SignTransactionResult", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_submitHashRate", + "tags": [], + "summary": "SubmitHashrate can be used for remote miners to submit their hash rate.\nThis enables the node to report the combined hash rate of all miners\nwhich submit work through this node.\n\nIt accepts the miner hash rate and an identifier which must be unique\nbetween nodes.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).SubmitHashRate", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:92" + }, + "params": [ + { + "name": "rate", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + { + "name": "id", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "eth_submitHashRateResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_submitWork", + "tags": [], + "summary": "SubmitWork can be used by external miner to submit their POW solution.\nIt returns an indication if the work was accepted.\nNote either an invalid solution, a stale work a non-existent work will return false.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).SubmitWork", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:66" + }, + "params": [ + { + "name": "nonce", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/core/types:types.BlockNonce", + "type": "array", + "maxItems": 8, + "minItems": 8, + "items": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + }, + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "digest", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "eth_submitWorkResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_syncing", + "tags": [], + "summary": "Syncing returns false in case the node is currently not syncing with the network. It can be up to date or has not\nyet received the latest block headers from its pears. In case it is synchronizing:\n- startingBlock: block number this node started to synchronise from\n- currentBlock: block number this node is currently importing\n- highestBlock: block number of the highest block header this node has received from peers\n- pulledStates: number of state entries processed until now\n- knownStates: number of known state entries that still need to be pulled\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicEthereumAPI).Syncing", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:83" + }, + "params": [], + "result": { + "name": "eth_syncingResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "additionalProperties": true + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_uninstallFilter", + "tags": [], + "summary": "UninstallFilter removes the filter with the given filter id.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_uninstallfilter\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth/filters.(*PublicFilterAPI).UninstallFilter", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go:354" + }, + "params": [ + { + "name": "id", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc:rpc.ID", + "type": "string" + } + } + ], + "result": { + "name": "eth_uninstallFilterResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "ethash_getHashrate", + "tags": [], + "summary": "GetHashrate returns the current hashrate for local CPU miner and remote miner.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).GetHashrate", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:110" + }, + "params": [], + "result": { + "name": "ethash_getHashrateResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "ethash_getWork", + "tags": [], + "summary": "GetWork returns a work package for external miner.\n\nThe work package consists of 3 strings:\n result[0] - 32 bytes hex encoded current block header pow-hash\n result[1] - 32 bytes hex encoded seed hash used for DAG\n result[2] - 32 bytes hex encoded boundary condition (\"target\"), 2^256/difficulty\n result[3] - hex encoded block number\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).GetWork", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:41" + }, + "params": [], + "result": { + "name": "ethash_getWorkResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "maxItems": 4, + "minItems": 4, + "items": { + "type": "string" + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "ethash_submitHashRate", + "tags": [], + "summary": "SubmitHashrate can be used for remote miners to submit their hash rate.\nThis enables the node to report the combined hash rate of all miners\nwhich submit work through this node.\n\nIt accepts the miner hash rate and an identifier which must be unique\nbetween nodes.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).SubmitHashRate", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:92" + }, + "params": [ + { + "name": "rate", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + { + "name": "id", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "ethash_submitHashRateResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "ethash_submitWork", + "tags": [], + "summary": "SubmitWork can be used by external miner to submit their POW solution.\nIt returns an indication if the work was accepted.\nNote either an invalid solution, a stale work a non-existent work will return false.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).SubmitWork", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:66" + }, + "params": [ + { + "name": "nonce", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/core/types:types.BlockNonce", + "type": "array", + "maxItems": 8, + "minItems": 8, + "items": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + }, + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "digest", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "ethash_submitWorkResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_getHashrate", + "tags": [], + "summary": "GetHashrate returns the current hashrate of the miner.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateMinerAPI).GetHashrate", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:153" + }, + "params": [], + "result": { + "name": "miner_getHashrateResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_setEtherbase", + "tags": [], + "summary": "SetEtherbase sets the etherbase of the miner\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateMinerAPI).SetEtherbase", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:142" + }, + "params": [ + { + "name": "etherbase", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + } + ], + "result": { + "name": "miner_setEtherbaseResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_setExtra", + "tags": [], + "summary": "SetExtra sets the extra data string that is included when this miner mines a block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateMinerAPI).SetExtra", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:124" + }, + "params": [ + { + "name": "extra", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "miner_setExtraResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_setGasPrice", + "tags": [], + "summary": "SetGasPrice sets the minimum accepted gas price for the miner.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateMinerAPI).SetGasPrice", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:132" + }, + "params": [ + { + "name": "gasPrice", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "miner_setGasPriceResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_setRecommitInterval", + "tags": [], + "summary": "SetRecommitInterval updates the interval for miner sealing work recommitting.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateMinerAPI).SetRecommitInterval", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:148" + }, + "params": [ + { + "name": "interval", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_start", + "tags": [], + "summary": "Start starts the miner with the given number of threads. If threads is nil,\nthe number of workers started is equal to the number of logical CPUs that are\nusable by this process. If mining is already running, this method adjust the\nnumber of threads allowed to use and updates the minimum price required by the\ntransaction pool.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateMinerAPI).Start", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:110" + }, + "params": [ + { + "name": "threads", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_stop", + "tags": [], + "summary": "Stop terminates the miner, both at the consensus engine level as well as at\nthe block creation level.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateMinerAPI).Stop", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:119" + }, + "params": [], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "net_listening", + "tags": [], + "summary": "Listening returns an indication if the node is listening for network connections.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicNetAPI).Listening", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1788" + }, + "params": [], + "result": { + "name": "net_listeningResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "net_peerCount", + "tags": [], + "summary": "PeerCount returns the number of connected peers\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicNetAPI).PeerCount", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1792" + }, + "params": [], + "result": { + "name": "net_peerCountResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "net_version", + "tags": [], + "summary": "Version returns the current ethereum protocol version.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicNetAPI).Version", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1797" + }, + "params": [], + "result": { + "name": "net_versionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_deriveAccount", + "tags": [], + "summary": "DeriveAccount requests a HD wallet to derive a new account, optionally pinning\nit for later reuse.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).DeriveAccount", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:266" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "path", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "pin", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:bool", + "type": "boolean" + } + } + ], + "result": { + "name": "personal_deriveAccountResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/accounts:accounts.Account", + "definitions": { + "Account": { + "type": "object", + "required": ["address", "url"], + "properties": { + "address": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "url": { + "$ref": "#/definitions/URL", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "additionalProperties": false + }, + "URL": { + "type": "object", + "required": ["Scheme", "Path"], + "properties": { + "Path": { + "type": "string" + }, + "Scheme": { + "type": "string" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/Account", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_ecRecover", + "tags": [], + "summary": "EcRecover returns the address for the account that was used to create the signature.\nNote, this function is compatible with eth_sign and personal_sign. As such it recovers\nthe address of:\nhash = keccak256(\"\\x19Ethereum Signed Message:\\n\"${message length}${message})\naddr = ecrecover(hash, signature)\n\nNote, the signature must conform to the secp256k1 curve R, S and V values, where\nthe V value must be 27 or 28 for legacy reasons.\n\nhttps://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_ecRecover\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).EcRecover", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:444" + }, + "params": [ + { + "name": "data", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + }, + { + "name": "sig", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + } + ], + "result": { + "name": "personal_ecRecoverResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_importRawKey", + "tags": [], + "summary": "ImportRawKey stores the given hex encoded ECDSA key into the key directory,\nencrypting it with the passphrase.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).ImportRawKey", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:300" + }, + "params": [ + { + "name": "privkey", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "password", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "personal_importRawKeyResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_initializeWallet", + "tags": [], + "summary": "InitializeWallet initializes a new wallet at the provided URL, by generating and returning a new private key.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).InitializeWallet", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:467" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "personal_initializeWalletResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_listAccounts", + "tags": [], + "summary": "listAccounts will return a list of addresses for accounts this node manages.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).ListAccounts", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:216" + }, + "params": [], + "result": { + "name": "personal_listAccountsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_listWallets", + "tags": [], + "summary": "ListWallets will return a list of wallets this node manages.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).ListWallets", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:230" + }, + "params": [], + "result": { + "name": "personal_listWalletsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/rawWallet", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "definitions": { + "Account": { + "type": "object", + "required": ["address", "url"], + "properties": { + "address": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "url": { + "$ref": "#/definitions/URL", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "additionalProperties": false + }, + "URL": { + "type": "object", + "required": ["Scheme", "Path"], + "properties": { + "Path": { + "type": "string" + }, + "Scheme": { + "type": "string" + } + }, + "additionalProperties": false + }, + "rawWallet": { + "type": "object", + "required": ["url", "status"], + "properties": { + "accounts": { + "type": "array", + "items": { + "$ref": "#/definitions/Account", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "failure": { + "type": "string" + }, + "status": { + "type": "string" + }, + "url": { + "type": "string" + } + }, + "additionalProperties": false + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_lockAccount", + "tags": [], + "summary": "LockAccount will lock the account associated with the given address when it's unlocked.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).LockAccount", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:337" + }, + "params": [ + { + "name": "addr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + } + ], + "result": { + "name": "personal_lockAccountResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_newAccount", + "tags": [], + "summary": "NewAccount will create a new account and returns the address for the new account.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).NewAccount", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:282" + }, + "params": [ + { + "name": "password", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "personal_newAccountResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_openWallet", + "tags": [], + "summary": "OpenWallet initiates a hardware wallet opening procedure, establishing a USB\nconnection and attempting to authenticate via the provided passphrase. Note,\nthe method may return an extra challenge requiring a second open (e.g. the\nTrezor PIN matrix challenge).\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).OpenWallet", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:252" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "passphrase", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:string", + "type": "string" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_sendTransaction", + "tags": [], + "summary": "SendTransaction will create a transaction from the given arguments and\ntries to sign it with the key associated with args.To. If the given passwd isn't\nable to decrypt the key it fails.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).SendTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:364" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi:SendTxArgs", + "definitions": { + "SendTxArgs": { + "type": "object", + "required": [ + "from", + "to", + "gas", + "gasPrice", + "value", + "nonce", + "data", + "input" + ], + "properties": { + "data": { + "description": "Field _input_ should be preferred", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/SendTxArgs", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "passwd", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "personal_sendTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_sign", + "tags": [], + "summary": "Sign calculates an Ethereum ECDSA signature for:\nkeccack256(\"\\x19Ethereum Signed Message:\\n\" + len(message) + message))\n\nNote, the produced signature conforms to the secp256k1 curve R, S and V values,\nwhere the V value will be 27 or 28 for legacy reasons.\n\nThe key used to calculate the signature is decrypted with the given password.\n\nhttps://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_sign\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).Sign", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:416" + }, + "params": [ + { + "name": "data", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + }, + { + "name": "addr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + { + "name": "passwd", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "personal_signResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_signAndSendTransaction", + "tags": [], + "summary": "SignAndSendTransaction was renamed to SendTransaction. This method is deprecated\nand will be removed in the future. It primary goal is to give clients time to update.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).SignAndSendTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:462" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi:SendTxArgs", + "definitions": { + "SendTxArgs": { + "type": "object", + "required": [ + "from", + "to", + "gas", + "gasPrice", + "value", + "nonce", + "data", + "input" + ], + "properties": { + "data": { + "description": "Field _input_ should be preferred", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/SendTxArgs", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "passwd", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "personal_signAndSendTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_signTransaction", + "tags": [], + "summary": "SignTransaction will create a transaction from the given arguments and\ntries to sign it with the key associated with args.To. If the given passwd isn't\nable to decrypt the key it fails. The transaction is returned in RLP-form, not broadcast\nto other nodes\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).SignTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:383" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi:SendTxArgs", + "definitions": { + "SendTxArgs": { + "type": "object", + "required": [ + "from", + "to", + "gas", + "gasPrice", + "value", + "nonce", + "data", + "input" + ], + "properties": { + "data": { + "description": "Field _input_ should be preferred", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/SendTxArgs", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "passwd", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "passwd2", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "personal_signTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/internal/ethapi:SignTransactionResult", + "definitions": { + "SignTransactionResult": { + "type": "object", + "required": ["raw", "tx"], + "properties": { + "raw": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "tx": { + "$ref": "#/definitions/Transaction", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "additionalProperties": false + }, + "Transaction": { + "type": "object", + "additionalProperties": false + } + }, + "$ref": "#/definitions/SignTransactionResult", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_unlockAccount", + "tags": [], + "summary": "UnlockAccount will unlock the account associated with the given address with\nthe given password for duration seconds. If duration is nil it will use a\ndefault of 300 seconds. It returns an indication if the account was unlocked.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).UnlockAccount", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:312" + }, + "params": [ + { + "name": "addr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + { + "name": "password", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "duration", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "personal_unlockAccountResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_unpair", + "tags": [], + "summary": "Unpair deletes a pairing between wallet and geth.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).Unpair", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:494" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "pin", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "txpool_content", + "tags": [], + "summary": "Content returns the transactions contained within the transaction pool.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTxPoolAPI).Content", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:111" + }, + "params": [], + "result": { + "name": "txpool_contentResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "patternProperties": { + ".*": { + "type": "object", + "patternProperties": { + ".*": { + "type": "object", + "patternProperties": { + ".*": { + "$ref": "#/definitions/RPCTransaction", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + } + } + } + }, + "definitions": { + "RPCTransaction": { + "type": "object", + "required": [ + "blockHash", + "blockNumber", + "from", + "gas", + "gasPrice", + "hash", + "input", + "nonce", + "to", + "transactionIndex", + "value", + "v", + "r", + "s" + ], + "properties": { + "blockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "blockNumber": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "hash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "r": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "s": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "transactionIndex": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "v": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "txpool_inspect", + "tags": [], + "summary": "Inspect retrieves the content of the transaction pool and flattens it into an\neasily inspectable list.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTxPoolAPI).Inspect", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:148" + }, + "params": [], + "result": { + "name": "txpool_inspectResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "patternProperties": { + ".*": { + "type": "object", + "patternProperties": { + ".*": { + "type": "object", + "patternProperties": { + ".*": { + "type": "string" + } + } + } + } + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "txpool_status", + "tags": [], + "summary": "Status returns the number of pending and queued transaction in the pool.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTxPoolAPI).Status", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:138" + }, + "params": [], + "result": { + "name": "txpool_statusResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "patternProperties": { + ".*": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "web3_clientVersion", + "tags": [], + "summary": "ClientVersion returns the node name\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PublicWeb3API).ClientVersion", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:309" + }, + "params": [], + "result": { + "name": "web3_clientVersionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "web3_sha3", + "tags": [], + "summary": "Sha3 applies the ethereum sha3 implementation on the input.\nIt assumes the input is hex encoded.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PublicWeb3API).Sha3", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:315" + }, + "params": [ + { + "name": "input", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + } + ], + "result": { + "name": "web3_sha3Result", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + } + ], + "components": { + "contentDescriptors": null, + "schemas": null, + "examples": null, + "links": null, + "errors": null, + "examplePairingObjects": null, + "tags": null + }, + "externalDocs": { + "description": "", + "url": "" + } +} diff --git a/go.mod b/go.mod index 63849121eb..2a68880c42 100644 --- a/go.mod +++ b/go.mod @@ -3,76 +3,79 @@ module github.com/ethereum/go-ethereum go 1.13 require ( - github.com/Azure/azure-pipeline-go v0.2.2 // indirect - github.com/Azure/azure-storage-blob-go v0.7.0 - github.com/Azure/go-autorest/autorest/adal v0.8.0 // indirect - github.com/StackExchange/wmi v0.0.0-20180116203802-5d049714c4a6 // indirect - github.com/VictoriaMetrics/fastcache v1.5.3 + github.com/Azure/azure-storage-blob-go v0.8.0 + github.com/VictoriaMetrics/fastcache v1.5.4 + github.com/alecthomas/jsonschema v0.0.2 github.com/aristanetworks/goarista v0.0.0-20170210015632-ea17b1a17847 github.com/aws/aws-sdk-go v1.25.48 github.com/btcsuite/btcd v0.0.0-20171128150713-2e60448ffcc6 github.com/cespare/cp v0.1.0 - github.com/cespare/xxhash/v2 v2.1.1 // indirect - github.com/cloudflare/cloudflare-go v0.10.2-0.20190916151808-a80f83b9add9 + github.com/cloudflare/cloudflare-go v0.10.7 github.com/davecgh/go-spew v1.1.1 github.com/deckarep/golang-set v0.0.0-20180603214616-504e848d77ea - github.com/dlclark/regexp2 v1.2.0 // indirect github.com/docker/docker v1.4.2-0.20180625184442-8e610b2b55bf github.com/dop251/goja v0.0.0-20200219165308-d1232e640a87 github.com/edsrzf/mmap-go v0.0.0-20160512033002-935e0e8a636c github.com/elastic/gosigar v0.8.1-0.20180330100440-37f05ff46ffa - github.com/fatih/color v1.3.0 + github.com/etclabscore/go-openrpc-reflect v0.0.20 + github.com/fatih/color v1.6.0 github.com/fjl/memsize v0.0.0-20180418122429-ca190fb6ffbc github.com/gballet/go-libpcsclite v0.0.0-20190607065134-2772fd86a8ff - github.com/go-ole/go-ole v1.2.1 // indirect - github.com/go-sourcemap/sourcemap v2.1.2+incompatible // indirect github.com/go-stack/stack v1.8.0 - github.com/go-test/deep v1.0.5 + github.com/go-test/deep v1.0.4 github.com/golang/protobuf v1.3.2-0.20190517061210-b285ee9cfc6c github.com/golang/snappy v0.0.1 - github.com/google/go-cmp v0.3.1 // indirect - github.com/gorilla/websocket v1.4.1-0.20190629185528-ae1634f6a989 + github.com/google/uuid v1.1.1 // indirect + github.com/gorilla/websocket v1.4.1 github.com/graph-gophers/graphql-go v0.0.0-20191115155744-f33e81362277 + github.com/gregdhill/go-openrpc v0.0.1 github.com/hashicorp/golang-lru v0.0.0-20160813221303-0a025b7e63ad github.com/huin/goupnp v0.0.0-20161224104101-679507af18f3 github.com/iancoleman/strcase v0.0.0-20191112232945-16388991a334 github.com/influxdata/influxdb v1.2.3-0.20180221223340-01288bdb0883 github.com/jackpal/go-nat-pmp v1.0.2-0.20160603034137-1fa385a6f458 github.com/julienschmidt/httprouter v1.2.0 - github.com/karalabe/usb v0.0.0-20190919080040-51dc0efba356 - github.com/kylelemons/godebug v1.1.0 // indirect + github.com/karalabe/usb v0.0.0-20191104083709-911d15fe12a9 github.com/mattn/go-colorable v0.1.0 github.com/mattn/go-isatty v0.0.5-0.20180830101745-3fb116b82035 github.com/mitchellh/go-homedir v1.1.0 - github.com/naoina/go-stringutil v0.1.0 // indirect github.com/naoina/toml v0.1.2-0.20170918210437-9fafd6967416 github.com/olekukonko/tablewriter v0.0.2-0.20190409134802-7e037d187b0c - github.com/pborman/uuid v0.0.0-20170112150404-1b00554d8222 + github.com/onsi/ginkgo v1.8.0 // indirect + github.com/onsi/gomega v1.5.0 // indirect + github.com/pborman/uuid v1.2.0 + github.com/pelletier/go-toml v1.4.0 // indirect github.com/peterh/liner v1.1.1-0.20190123174540-a2c9a5303de7 github.com/prometheus/tsdb v0.7.1 github.com/rjeczalik/notify v0.9.1 github.com/rs/cors v0.0.0-20160617231935-a62a804a8a00 - github.com/rs/xhandler v0.0.0-20160618193221-ed27b6fd6521 // indirect github.com/spf13/cobra v0.0.5 github.com/spf13/viper v1.6.2 github.com/status-im/keycard-go v0.0.0-20190316090335-8537d3370df4 github.com/steakknife/bloomfilter v0.0.0-20180922174646-6819c0d2a570 - github.com/steakknife/hamming v0.0.0-20180906055917-c99c65617cd3 // indirect github.com/stretchr/testify v1.4.0 github.com/syndtr/goleveldb v1.0.1-0.20190923125748-758128399b1d github.com/tidwall/gjson v1.3.5 github.com/tidwall/pretty v1.0.0 - github.com/tyler-smith/go-bip39 v0.0.0-20181017060643-dbb3b84ba2ef + github.com/tyler-smith/go-bip39 v1.0.1-0.20181017060643-dbb3b84ba2ef github.com/wsddn/go-ecdh v0.0.0-20161211032359-48726bab9208 golang.org/x/crypto v0.0.0-20200311171314-f7b00557c8c4 - golang.org/x/net v0.0.0-20200301022130-244492dfa37a // indirect - golang.org/x/sync v0.0.0-20181221193216-37e7f081c4d4 - golang.org/x/sys v0.0.0-20200302150141-5c8b2ff67527 + golang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e + golang.org/x/sys v0.0.0-20200323222414-85ca7c5b95cd golang.org/x/text v0.3.2 - golang.org/x/time v0.0.0-20190308202827-9d24e82272b4 + golang.org/x/time v0.0.0-20191024005414-555d28b269f0 gopkg.in/natefinch/npipe.v2 v2.0.0-20160621034901-c1b8fa8bdcce gopkg.in/olebedev/go-duktape.v3 v3.0.0-20190213234257-ec84240a7772 gopkg.in/urfave/cli.v1 v1.20.0 - gotest.tools v2.2.0+incompatible // indirect ) + +// see https://github.com/golang/lint/issues/436#issuecomment-482066447 +replace github.com/golang/lint v0.0.0-20190409202823-959b441ac422 => github.com/golang/lint v0.0.0-20190409202823-5614ed5bae6fb75893070bdc0996a68765fdd275 + +// Use a local development version, managed as a submodule. +replace github.com/gregdhill/go-openrpc => github.com/etclabscore/go-openrpc v0.0.1 + +replace github.com/alecthomas/jsonschema => github.com/etclabscore/go-jsonschema-reflect v0.0.2 + +// replace github.com/etclabscore/go-openrpc-reflect => /home/ia/go/src/github.com/etclabscore/go-openrpc-reflect diff --git a/go.sum b/go.sum index 71b294ecdb..676a3abbdc 100644 --- a/go.sum +++ b/go.sum @@ -1,10 +1,10 @@ cloud.google.com/go v0.26.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw= -github.com/Azure/azure-pipeline-go v0.2.1 h1:OLBdZJ3yvOn2MezlWvbrBMTEUQC72zAftRZOMdj5HYo= github.com/Azure/azure-pipeline-go v0.2.1/go.mod h1:UGSo8XybXnIGZ3epmeBw7Jdz+HiUVpqIlpz/HKHylF4= github.com/Azure/azure-pipeline-go v0.2.2 h1:6oiIS9yaG6XCCzhgAgKFfIWyo4LLCiDhZot6ltoThhY= github.com/Azure/azure-pipeline-go v0.2.2/go.mod h1:4rQ/NZncSvGqNkkOsNpOU1tgoNuIlp9AfUH5G1tvCHc= -github.com/Azure/azure-storage-blob-go v0.7.0 h1:MuueVOYkufCxJw5YZzF842DY2MBsp+hLuh2apKY0mck= github.com/Azure/azure-storage-blob-go v0.7.0/go.mod h1:f9YQKtsG1nMisotuTPpO0tjNuEjKRYAcJU8/ydDI++4= +github.com/Azure/azure-storage-blob-go v0.8.0 h1:53qhf0Oxa0nOjgbDeeYPUeyiNmafAFEY95rZLK0Tj6o= +github.com/Azure/azure-storage-blob-go v0.8.0/go.mod h1:lPI3aLPpuLTeUwh1sViKXFxwl2B6teiRqI0deQUvsw0= github.com/Azure/go-autorest/autorest v0.9.0 h1:MRvx8gncNaXJqOoLmhNjUAKh33JJF8LyxPhomEtOsjs= github.com/Azure/go-autorest/autorest v0.9.0/go.mod h1:xyHB1BMZT0cuDHU7I0+g046+BFDTQ8rEZB0s4Yfa6bI= github.com/Azure/go-autorest/autorest/adal v0.5.0/go.mod h1:8Z9fGy2MpX0PvDjB1pEgQTmVqjGhiHBW7RJJEciWzS0= @@ -25,12 +25,16 @@ github.com/BurntSushi/toml v0.3.1 h1:WXkYYl6Yr3qBf1K79EBnL4mak0OimBfB0XUf9Vl28OQ github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU= github.com/OneOfOne/xxhash v1.2.2/go.mod h1:HSdplMjZKSmBqAxg5vPj2TmRDmfkzw+cTzAElWljhcU= github.com/OneOfOne/xxhash v1.2.5/go.mod h1:eZbhyaAYD41SGSSsnmcpxVoRiQ/MPUTjUdIIOT9Um7Q= +github.com/PuerkitoBio/purell v1.1.1 h1:WEQqlqaGbrPkxLJWfBwQmfEAE1Z7ONdDLqrN38tNFfI= +github.com/PuerkitoBio/purell v1.1.1/go.mod h1:c11w/QuzBsJSee3cPx9rAFu61PvFxuPbtSwDGJws/X0= +github.com/PuerkitoBio/urlesc v0.0.0-20170810143723-de5bf2ad4578 h1:d+Bc7a5rLufV/sSk/8dngufqelfh6jnri85riMAaF/M= +github.com/PuerkitoBio/urlesc v0.0.0-20170810143723-de5bf2ad4578/go.mod h1:uGdkoq3SwY9Y+13GIhn11/XLaGBb4BfwItxLd5jeuXE= github.com/StackExchange/wmi v0.0.0-20180116203802-5d049714c4a6 h1:fLjPD/aNc3UIOA6tDi6QXUemppXK3P9BI7mr2hd6gx8= github.com/StackExchange/wmi v0.0.0-20180116203802-5d049714c4a6/go.mod h1:3eOhrUMpNV+6aFIbp5/iudMxNCF27Vw2OZgy4xEx0Fg= -github.com/VictoriaMetrics/fastcache v1.5.3 h1:2odJnXLbFZcoV9KYtQ+7TH1UOq3dn3AssMgieaezkR4= github.com/VictoriaMetrics/fastcache v1.5.3/go.mod h1:+jv9Ckb+za/P1ZRg/sulP5Ni1v49daAVERr0H3CuscE= +github.com/VictoriaMetrics/fastcache v1.5.4 h1:0BaXbRH01RycJk79OOBwMCXlNryko9z4yEf6RqbP+Xo= +github.com/VictoriaMetrics/fastcache v1.5.4/go.mod h1:ptDBkNMQI4RtmVo8VS/XwRY6RoTu1dAWCbrk+6WsEM8= github.com/alecthomas/template v0.0.0-20160405071501-a0175ee3bccc/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc= -github.com/alecthomas/units v0.0.0-20151022065526-2efee857e7cf h1:qet1QNfXsQxTZqLG4oE62mJzwPIB8+Tee4RNCL9ulrY= github.com/alecthomas/units v0.0.0-20151022065526-2efee857e7cf/go.mod h1:ybxpYRFXyAe+OPACYpWeL0wqObRcbAqCMya13uyzqw0= github.com/allegro/bigcache v1.2.1-0.20190218064605-e24eb225f156 h1:eMwmnE/GDgah4HI848JfFxHt+iPb26b4zyfspmqY0/8= github.com/allegro/bigcache v1.2.1-0.20190218064605-e24eb225f156/go.mod h1:Cb/ax3seSYIx7SuZdm2G2xzfwmv3TPSk2ucNfQESPXM= @@ -51,8 +55,9 @@ github.com/cespare/xxhash/v2 v2.0.1-0.20190104013014-3767db7a7e18/go.mod h1:HD5P github.com/cespare/xxhash/v2 v2.1.1 h1:6MnRN8NT7+YBpUIWxHtefFZOKTAPgGjpQSxqLNn0+qY= github.com/cespare/xxhash/v2 v2.1.1/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs= github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw= -github.com/cloudflare/cloudflare-go v0.10.2-0.20190916151808-a80f83b9add9 h1:J82+/8rub3qSy0HxEnoYD8cs+HDlHWYrqYXe2Vqxluk= github.com/cloudflare/cloudflare-go v0.10.2-0.20190916151808-a80f83b9add9/go.mod h1:1MxXX1Ux4x6mqPmjkUgTP1CdXIBXKX7T+Jk9Gxrmx+U= +github.com/cloudflare/cloudflare-go v0.10.7 h1:thMe3rovu9cDWyvCjWXQfSJ0/BfGgjwk/DvLhRoycPs= +github.com/cloudflare/cloudflare-go v0.10.7/go.mod h1:ciusowHNZQXqYH2MrFivTLXQt8lpqLLoaKDEMPcBF1s= github.com/coreos/bbolt v1.3.2/go.mod h1:iRUV2dpdMOn7Bo10OQBFzIJO9kkE559Wcmn+qkEiiKk= github.com/coreos/etcd v3.3.10+incompatible/go.mod h1:uF7uidLiAD3TWHmW31ZFd/JWoc32PjwdhPthX9715RE= github.com/coreos/go-etcd v2.0.0+incompatible/go.mod h1:Jez6KQU2B/sWsbdaef3ED8NzMklzPG4d5KIOhIy30Tk= @@ -79,8 +84,18 @@ github.com/edsrzf/mmap-go v0.0.0-20160512033002-935e0e8a636c h1:JHHhtb9XWJrGNMcr github.com/edsrzf/mmap-go v0.0.0-20160512033002-935e0e8a636c/go.mod h1:YO35OhQPt3KJa3ryjFM5Bs14WD66h8eGKpfaBNrHW5M= github.com/elastic/gosigar v0.8.1-0.20180330100440-37f05ff46ffa h1:XKAhUk/dtp+CV0VO6mhG2V7jA9vbcGcnYF/Ay9NjZrY= github.com/elastic/gosigar v0.8.1-0.20180330100440-37f05ff46ffa/go.mod h1:cdorVVzy1fhmEqmtgqkoE3bYtCfSCkVyjTyCIo22xvs= -github.com/fatih/color v1.3.0 h1:YehCCcyeQ6Km0D6+IapqPinWBK6y+0eB5umvZXK9WPs= +github.com/etclabscore/go-jsonschema-reflect v0.0.2 h1:4cVcR6pyHT+fdUhqUej9OvlQjo7IvdZZ57yXFLwp7Lk= +github.com/etclabscore/go-jsonschema-reflect v0.0.2/go.mod h1:zNMg3LbT7+7+1sJl6meG0U55ipDR9d0RN0dYQ8V3uCs= +github.com/etclabscore/go-jsonschema-walk v0.0.5 h1:onCqRkan6UYqxb2AfQCnrH3RDLxE7N1dsNBD99ruZ2A= +github.com/etclabscore/go-jsonschema-walk v0.0.5/go.mod h1:ONvrTA7ocniep83ygMhbeTweRpaEIH8Ei/D/2OKgu6U= +github.com/etclabscore/go-openrpc v0.0.1 h1:q+3HXSkP0FdEoamkEvqDn5CITAeFkoIJ3wnEC6mQFS8= +github.com/etclabscore/go-openrpc v0.0.1/go.mod h1:a1eRkbhd3DYpRH2lnuUsVG+QMTI+v0hGnsis8C9hMrA= +github.com/etclabscore/go-openrpc-reflect v0.0.20 h1:2LPwe2MsWtYQmPi/y9HkpvD7vpMkT4tRH64sV4eR930= +github.com/etclabscore/go-openrpc-reflect v0.0.20/go.mod h1:x0WuJn8p8Kku63g7K5z1P9OuyPfwJhPG6yNsUsj7cvM= +github.com/ethereum/go-ethereum v1.9.12/go.mod h1:PvsVkQmhZFx92Y+h2ylythYlheEDt/uBgFbl61Js/jo= github.com/fatih/color v1.3.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4= +github.com/fatih/color v1.6.0 h1:66qjqZk8kalYAvDRtM1AdAJQI0tj4Wrue3Eq3B3pmFU= +github.com/fatih/color v1.6.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4= github.com/fjl/memsize v0.0.0-20180418122429-ca190fb6ffbc h1:jtW8jbpkO4YirRSyepBOH8E+2HEw6/hKkBvFPwhUN8c= github.com/fjl/memsize v0.0.0-20180418122429-ca190fb6ffbc/go.mod h1:VvhXpOYNQvB+uIk2RvXzuaQtkQJzzIx6lSBe1xv7hi0= github.com/fsnotify/fsnotify v1.4.7 h1:IXs+QLmnXW2CcXuY+8Mzv/fWEsPGWxqefPtCP5CnV9I= @@ -90,42 +105,60 @@ github.com/gballet/go-libpcsclite v0.0.0-20190607065134-2772fd86a8ff/go.mod h1:x github.com/ghodss/yaml v1.0.0/go.mod h1:4dBDuWmgqj2HViK6kFavaiC9ZROes6MMH2rRYeMEF04= github.com/go-kit/kit v0.8.0 h1:Wz+5lgoB0kkuqLEc6NVmwRknTKP6dTGbSqvhZtBI/j0= github.com/go-kit/kit v0.8.0/go.mod h1:xBxKIO96dXMWWy0MnWVtmwkA9/13aqxPnvrjFYMA2as= -github.com/go-logfmt/logfmt v0.3.0 h1:8HUsc87TaSWLKwrnumgC8/YconD2fJQsRJAsWaPg2ic= github.com/go-logfmt/logfmt v0.3.0/go.mod h1:Qt1PoO58o5twSAckw1HlFXLmHsOX5/0LbT9GBnD5lWE= github.com/go-logfmt/logfmt v0.4.0 h1:MP4Eh7ZCb31lleYCFuwm0oe4/YGak+5l1vA2NOE80nA= github.com/go-logfmt/logfmt v0.4.0/go.mod h1:3RMwSq7FuexP4Kalkev3ejPJsZTpXXBr9+V4qmtdjCk= github.com/go-ole/go-ole v1.2.1 h1:2lOsA72HgjxAuMlKpFiCbHTvu44PIVkZ5hqm3RSdI/E= github.com/go-ole/go-ole v1.2.1/go.mod h1:7FAglXiTm7HKlQRDeOQ6ZNUHidzCWXuZWq/1dTyBNF8= +github.com/go-openapi/jsonpointer v0.19.2/go.mod h1:3akKfEdA7DF1sugOqz1dVQHBcuDBPKZGEoHC/NkiQRg= +github.com/go-openapi/jsonpointer v0.19.3 h1:gihV7YNZK1iK6Tgwwsxo2rJbD1GTbdm72325Bq8FI3w= +github.com/go-openapi/jsonpointer v0.19.3/go.mod h1:Pl9vOtqEWErmShwVjC8pYs9cog34VGT37dQOVbmoatg= +github.com/go-openapi/jsonreference v0.19.2/go.mod h1:jMjeRr2HHw6nAVajTXJ4eiUwohSTlpa0o73RUL1owJc= +github.com/go-openapi/jsonreference v0.19.3 h1:5cxNfTy0UVC3X8JL5ymxzyoUZmo8iZb+jeTWn7tUa8o= +github.com/go-openapi/jsonreference v0.19.3/go.mod h1:rjx6GuL8TTa9VaixXglHmQmIL98+wF9xc8zWvFonSJ8= +github.com/go-openapi/spec v0.19.2/go.mod h1:sCxk3jxKgioEJikev4fgkNmwS+3kuYdJtcsZsD5zxMY= +github.com/go-openapi/spec v0.19.7 h1:0xWSeMd35y5avQAThZR2PkEuqSosoS5t6gDH4L8n11M= +github.com/go-openapi/spec v0.19.7/go.mod h1:Hm2Jr4jv8G1ciIAo+frC/Ft+rR2kQDh8JHKHb3gWUSk= +github.com/go-openapi/swag v0.19.2/go.mod h1:POnQmlKehdgb5mhVOsnJFsivZCEZ/vjK9gh66Z9tfKk= +github.com/go-openapi/swag v0.19.5/go.mod h1:POnQmlKehdgb5mhVOsnJFsivZCEZ/vjK9gh66Z9tfKk= +github.com/go-openapi/swag v0.19.8 h1:vfK6jLhs7OI4tAXkvkooviaE1JEPcw3mutyegLHHjmk= +github.com/go-openapi/swag v0.19.8/go.mod h1:ao+8BpOPyKdpQz3AOJfbeEVpLmWAvlT1IfTe5McPyhY= github.com/go-sourcemap/sourcemap v2.1.2+incompatible h1:0b/xya7BKGhXuqFESKM4oIiRo9WOt2ebz7KxfreD6ug= github.com/go-sourcemap/sourcemap v2.1.2+incompatible/go.mod h1:F8jJfvm2KbVjc5NqelyYJmf/v5J0dwNLS2mL4sNA1Jg= github.com/go-stack/stack v1.8.0 h1:5SgMzNM5HxrEjV0ww2lTmX6E2Izsfxas4+YHWRs3Lsk= github.com/go-stack/stack v1.8.0/go.mod h1:v0f6uXyyMGvRgIKkXu+yp6POWl0qKG85gN/melR3HDY= -github.com/go-test/deep v1.0.5 h1:AKODKU3pDH1RzZzm6YZu77YWtEAq6uh1rLIAQlay2qc= -github.com/go-test/deep v1.0.5/go.mod h1:QV8Hv/iy04NyLBxAdO9njL0iVPN1S4d/A3NVv1V36o8= -github.com/gogo/protobuf v1.1.1 h1:72R+M5VuhED/KujmZVcIquuo8mBgX4oVda//DQb3PXo= +github.com/go-test/deep v1.0.4 h1:u2CU3YKy9I2pmu9pX0eq50wCgjfGIt539SqR7FbHiho= +github.com/go-test/deep v1.0.4/go.mod h1:wGDj63lr65AM2AQyKZd/NYHGb0R+1RLqB8NKt3aSFNA= +github.com/gobuffalo/envy v1.7.0/go.mod h1:n7DRkBerg/aorDM8kbduw5dN3oXGswK5liaSCx4T5NI= +github.com/gobuffalo/logger v1.0.0/go.mod h1:2zbswyIUa45I+c+FLXuWl9zSWEiVuthsk8ze5s8JvPs= +github.com/gobuffalo/packd v0.3.0/go.mod h1:zC7QkmNkYVGKPw4tHpBQ+ml7W/3tIebgeo1b36chA3Q= +github.com/gobuffalo/packr/v2 v2.6.0/go.mod h1:sgEE1xNZ6G0FNN5xn9pevVu4nywaxHvgup67xisti08= github.com/gogo/protobuf v1.1.1/go.mod h1:r8qH/GZQm5c6nD/R0oafs1akxWv10x8SbQlK7atdtwQ= github.com/gogo/protobuf v1.2.1/go.mod h1:hp+jE20tsWTFYpLwKvXlhS1hjn+gTNwPg2I6zVXpSg4= github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q= github.com/golang/groupcache v0.0.0-20190129154638-5b532d6fd5ef/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= github.com/golang/mock v1.1.1/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A= -github.com/golang/protobuf v1.2.0 h1:P3YflyNX/ehuJFLhxviNdFxQPkGK5cDcApsge1SqnvM= +github.com/golang/mock v1.4.3 h1:GV+pQPG/EUUbkh47niozDcADz6go/dUwhVzdUQHIVRw= +github.com/golang/mock v1.4.3/go.mod h1:UOMv5ysSaYNkG+OFQykRIcU/QvvxJf3p21QfJ2Bt3cw= github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= -github.com/golang/protobuf v1.3.1 h1:YF8+flBXS5eO826T4nzqPrxfhQThhXl0YzfuUPu4SBg= github.com/golang/protobuf v1.3.1/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= github.com/golang/protobuf v1.3.2-0.20190517061210-b285ee9cfc6c h1:zqAKixg3cTcIasAMJV+EcfVbWwLpOZ7LeoWJvcuD/5Q= github.com/golang/protobuf v1.3.2-0.20190517061210-b285ee9cfc6c/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= github.com/golang/snappy v0.0.1 h1:Qgr9rKW7uDUkrbSmQeiDsGa8SjGyCOGtuasMWwvp2P4= github.com/golang/snappy v0.0.1/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q= github.com/google/btree v1.0.0/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ= -github.com/google/go-cmp v0.2.0 h1:+dTQ8DZQJz0Mb/HjFlkptS1FeQ4cWSnN941F8aEG4SQ= github.com/google/go-cmp v0.2.0/go.mod h1:oXzfMopK8JAjlY9xF4vHSVASa0yLyX7SntLO5aqRK0M= github.com/google/go-cmp v0.3.1 h1:Xye71clBPdm5HgqGwUkwhbynsUJZhDbS20FvLhQ2izg= github.com/google/go-cmp v0.3.1/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU= +github.com/google/uuid v1.0.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= +github.com/google/uuid v1.1.1 h1:Gkbcsh/GbpXz7lPftLA3P6TYMwjCLYm83jiFQZF/3gY= +github.com/google/uuid v1.1.1/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1 h1:EGx4pi6eqNxGaHF6qqu48+N2wcFQ5qg5FXgOdqsJ5d8= github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1/go.mod h1:wJfORRmW1u3UXTncJ5qlYoELFm8eSnnEO6hX4iZ3EWY= github.com/gorilla/websocket v1.4.0/go.mod h1:E7qHFY5m1UJ88s3WnNqhKjPHQ0heANvMoAMk2YaljkQ= -github.com/gorilla/websocket v1.4.1-0.20190629185528-ae1634f6a989 h1:giknQ4mEuDFmmHSrGcbargOuLHQGtywqo4mheITex54= github.com/gorilla/websocket v1.4.1-0.20190629185528-ae1634f6a989/go.mod h1:E7qHFY5m1UJ88s3WnNqhKjPHQ0heANvMoAMk2YaljkQ= +github.com/gorilla/websocket v1.4.1 h1:q7AeDBpnBk8AogcD4DSag/Ukw/KV+YhzLj2bP5HvKCM= +github.com/gorilla/websocket v1.4.1/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE= github.com/graph-gophers/graphql-go v0.0.0-20191115155744-f33e81362277 h1:E0whKxgp2ojts0FDgUA8dl62bmH0LxKanMoBr6MDTDM= github.com/graph-gophers/graphql-go v0.0.0-20191115155744-f33e81362277/go.mod h1:9CQHMSxwO4MprSdzoIEobiHpoLtHm77vfxsvsIN5Vuc= github.com/grpc-ecosystem/go-grpc-middleware v1.0.0/go.mod h1:FiyG127CGDf3tlThmgyCl78X/SZQqEOJBCDaAfeWzPs= @@ -139,8 +172,11 @@ github.com/hpcloud/tail v1.0.0 h1:nfCOvKYfkgYP8hkirhJocXT2+zOD8yUNjXaWfTlyFKI= github.com/hpcloud/tail v1.0.0/go.mod h1:ab1qPbhIpdTxEkNHXyeSf5vhxWSCs/tWer42PpOxQnU= github.com/huin/goupnp v0.0.0-20161224104101-679507af18f3 h1:DqD8eigqlUm0+znmx7zhL0xvTW3+e1jCekJMfBUADWI= github.com/huin/goupnp v0.0.0-20161224104101-679507af18f3/go.mod h1:MZ2ZmwcBpvOoJ22IJsc7va19ZwoheaBk43rKg12SKag= +github.com/iancoleman/orderedmap v0.0.0-20190318233801-ac98e3ecb4b0 h1:i462o439ZjprVSFSZLZxcsoAe592sZB1rci2Z8j4wdk= +github.com/iancoleman/orderedmap v0.0.0-20190318233801-ac98e3ecb4b0/go.mod h1:N0Wam8K1arqPXNWjMo21EXnBPOPp36vB07FNRdD2geA= github.com/iancoleman/strcase v0.0.0-20191112232945-16388991a334 h1:VHgatEHNcBFEB7inlalqfNqw65aNkM1lGX2yt3NmbS8= github.com/iancoleman/strcase v0.0.0-20191112232945-16388991a334/go.mod h1:SK73tn/9oHe+/Y0h39VT4UCxmurVJkR5NA7kMEAOgSE= +github.com/imdario/mergo v0.3.7/go.mod h1:2EnlNZ0deacrJVfApfmtdGgDfMuh/nq6Ok1EcJh5FfA= github.com/inconshreveable/mousetrap v1.0.0 h1:Z8tu5sraLXCXIcARxBp/8cbvlwVa7Z1NHg9XEKhtSvM= github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8= github.com/influxdata/influxdb v1.2.3-0.20180221223340-01288bdb0883 h1:FSeK4fZCo8u40n2JMnyAsd6x7+SbvoOMHvQOU/n10P4= @@ -149,21 +185,27 @@ github.com/jackpal/go-nat-pmp v1.0.2-0.20160603034137-1fa385a6f458 h1:6OvNmYgJye github.com/jackpal/go-nat-pmp v1.0.2-0.20160603034137-1fa385a6f458/go.mod h1:QPH045xvCAeXUZOxsnwmrtiCoxIr9eob+4orBN1SBKc= github.com/jmespath/go-jmespath v0.0.0-20180206201540-c2b33e8439af h1:pmfjZENx5imkbgOkpRUYLnmbU7UEFbjtDA2hxJ1ichM= github.com/jmespath/go-jmespath v0.0.0-20180206201540-c2b33e8439af/go.mod h1:Nht3zPeWKUH0NzdCt2Blrr5ys8VGpn0CEB0cQHVjt7k= +github.com/joho/godotenv v1.3.0/go.mod h1:7hK45KPybAkOC6peb+G5yklZfMxEjkZhHbwpqxOKXbg= github.com/jonboulle/clockwork v0.1.0/go.mod h1:Ii8DK3G1RaLaWxj9trq07+26W01tbo22gdxWY5EU2bo= github.com/jtolds/gls v4.20.0+incompatible h1:xdiiI2gbIgH/gLH7ADydsJ1uDOEzR8yvV7C0MuV77Wo= github.com/jtolds/gls v4.20.0+incompatible/go.mod h1:QJZ7F/aHp+rZTRtaJ1ow/lLfFfVYBRgL+9YlvaHOwJU= +github.com/julienschmidt/httprouter v1.1.1-0.20170430222011-975b5c4c7c21/go.mod h1:SYymIcj16QtmaHHD7aYtjjsJG7VTCxuUUipMqKk8s4w= github.com/julienschmidt/httprouter v1.2.0 h1:TDTW5Yz1mjftljbcKqRcrYhd4XeOoI98t+9HbQbYf7g= github.com/julienschmidt/httprouter v1.2.0/go.mod h1:SYymIcj16QtmaHHD7aYtjjsJG7VTCxuUUipMqKk8s4w= -github.com/karalabe/usb v0.0.0-20190919080040-51dc0efba356 h1:I/yrLt2WilKxlQKCM52clh5rGzTKpVctGT1lH4Dc8Jw= github.com/karalabe/usb v0.0.0-20190919080040-51dc0efba356/go.mod h1:Od972xHfMJowv7NGVDiWVxk2zxnWgjLlJzE+F4F7AGU= +github.com/karalabe/usb v0.0.0-20191104083709-911d15fe12a9 h1:ZHuwnjpP8LsVsUYqTqeVAI+GfDfJ6UNPrExZF+vX/DQ= +github.com/karalabe/usb v0.0.0-20191104083709-911d15fe12a9/go.mod h1:Od972xHfMJowv7NGVDiWVxk2zxnWgjLlJzE+F4F7AGU= +github.com/karrick/godirwalk v1.10.12/go.mod h1:RoGL9dQei4vP9ilrpETWE8CLOZ1kiN0LhBygSwrAsHA= github.com/kisielk/errcheck v1.1.0/go.mod h1:EZBBE59ingxPouuu3KfxchcWSUPOHkagtvWXihfKN4Q= github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck= github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ= +github.com/konsorten/go-windows-terminal-sequences v1.0.2/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ= github.com/kr/logfmt v0.0.0-20140226030751-b84e30acd515 h1:T+h1c/A9Gawja4Y9mFVWj2vyii2bbUNDw3kt9VxK2EY= github.com/kr/logfmt v0.0.0-20140226030751-b84e30acd515/go.mod h1:+0opPa2QZZtGFBFZlji/RkVcI2GknAs/DXo4wKdlNEc= github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI= github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= +github.com/kr/pty v1.1.5/go.mod h1:9r2w37qlBe7rQ6e1fg1S/9xpWHSnaqNdHD3WcMdbPDA= github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE= github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= github.com/kylelemons/godebug v1.1.0 h1:RPNrshWIDI6G2gRW9EHilWtl7Z6Sb1BR0xunSBf0SNc= @@ -171,15 +213,17 @@ github.com/kylelemons/godebug v1.1.0/go.mod h1:9/0rRGxNHcop5bhtWyNeEfOS8JIWk580+ github.com/magiconair/properties v1.8.0/go.mod h1:PppfXfuXeibc/6YijjN8zIbojt8czPbwD3XqdrwzmxQ= github.com/magiconair/properties v1.8.1 h1:ZC2Vc7/ZFkGmsVC9KvOjumD+G5lXy2RtTKyzRKO2BQ4= github.com/magiconair/properties v1.8.1/go.mod h1:PppfXfuXeibc/6YijjN8zIbojt8czPbwD3XqdrwzmxQ= +github.com/mailru/easyjson v0.0.0-20190614124828-94de47d64c63/go.mod h1:C1wdFJiN94OJF2b5HbByQZoLdCWB1Yqtg26g4irojpc= +github.com/mailru/easyjson v0.0.0-20190626092158-b2ccc519800e/go.mod h1:C1wdFJiN94OJF2b5HbByQZoLdCWB1Yqtg26g4irojpc= +github.com/mailru/easyjson v0.7.1 h1:mdxE1MF9o53iCb2Ghj1VfWvh7ZOwHpnVG/xwXrV90U8= +github.com/mailru/easyjson v0.7.1/go.mod h1:KAzv3t3aY1NaHWoQz1+4F1ccyAH66Jk7yos7ldAVICs= github.com/mattn/go-colorable v0.1.0 h1:v2XXALHHh6zHfYTJ+cSkwtyffnaOyR1MXaA91mTrb8o= github.com/mattn/go-colorable v0.1.0/go.mod h1:9vuHe8Xs5qXnSaW/c/ABM9alt+Vo+STaOChaDxuIBZU= -github.com/mattn/go-ieproxy v0.0.0-20190610004146-91bb50d98149 h1:HfxbT6/JcvIljmERptWhwa8XzP7H3T+Z2N26gTsaDaA= github.com/mattn/go-ieproxy v0.0.0-20190610004146-91bb50d98149/go.mod h1:31jz6HNzdxOmlERGGEc4v/dMssOfmp2p5bT/okiKFFc= github.com/mattn/go-ieproxy v0.0.0-20190702010315-6dee0af9227d h1:oNAwILwmgWKFpuU+dXvI6dl9jG2mAWAZLX3r9s0PPiw= github.com/mattn/go-ieproxy v0.0.0-20190702010315-6dee0af9227d/go.mod h1:31jz6HNzdxOmlERGGEc4v/dMssOfmp2p5bT/okiKFFc= github.com/mattn/go-isatty v0.0.5-0.20180830101745-3fb116b82035 h1:USWjF42jDCSEeikX/G1g40ZWnsPXN5WkZ4jMHZWyBK4= github.com/mattn/go-isatty v0.0.5-0.20180830101745-3fb116b82035/go.mod h1:M+lRXTBqGeGNdLjl/ufCoiOlB5xdOkqRJdNxMWT7Zi4= -github.com/mattn/go-runewidth v0.0.3 h1:a+kO+98RDGEfo6asOGMmpodZq4FNtnGP54yps8BzLR4= github.com/mattn/go-runewidth v0.0.3/go.mod h1:LwmH8dsx7+W8Uxz3IHJYH5QSwggIsqBzpuz5H//U1FU= github.com/mattn/go-runewidth v0.0.4 h1:2BvfKmzob6Bmd4YsL0zygOqfdFnK7GR4QL06Do4/p7Y= github.com/mattn/go-runewidth v0.0.4/go.mod h1:LwmH8dsx7+W8Uxz3IHJYH5QSwggIsqBzpuz5H//U1FU= @@ -194,24 +238,26 @@ github.com/naoina/go-stringutil v0.1.0/go.mod h1:XJ2SJL9jCtBh+P9q5btrd/Ylo8XwT/h github.com/naoina/toml v0.1.2-0.20170918210437-9fafd6967416 h1:shk/vn9oCoOTmwcouEdwIeOtOGA/ELRUw/GwvxwfT+0= github.com/naoina/toml v0.1.2-0.20170918210437-9fafd6967416/go.mod h1:NBIhNtsFMo3G2szEBne+bO4gS192HuIYRqfvOWb4i1E= github.com/oklog/ulid v1.3.1/go.mod h1:CirwcVhetQ6Lv90oh/F+FBtV6XMibvdAFo93nm5qn4U= -github.com/olekukonko/tablewriter v0.0.1 h1:b3iUnf1v+ppJiOfNX4yxxqfWKMQPZR5yoh8urCTFX88= github.com/olekukonko/tablewriter v0.0.1/go.mod h1:vsDQFd/mU46D+Z4whnwzcISnGGzXWMclvtLoiIKAKIo= github.com/olekukonko/tablewriter v0.0.2-0.20190409134802-7e037d187b0c h1:1RHs3tNxjXGHeul8z2t6H2N2TlAqpKe5yryJztRx4Jk= github.com/olekukonko/tablewriter v0.0.2-0.20190409134802-7e037d187b0c/go.mod h1:vsDQFd/mU46D+Z4whnwzcISnGGzXWMclvtLoiIKAKIo= github.com/onsi/ginkgo v1.6.0/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE= -github.com/onsi/ginkgo v1.7.0 h1:WSHQ+IS43OoUrWtD1/bbclrwK8TTH5hzp+umCiuxHgs= github.com/onsi/ginkgo v1.7.0/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE= -github.com/onsi/gomega v1.4.3 h1:RE1xgDvH7imwFD45h+u2SgIfERHlS2yNG4DObb5BSKU= +github.com/onsi/ginkgo v1.8.0 h1:VkHVNpR4iVnU8XQR6DBm8BqYjN7CRzw+xKUbVVbbW9w= +github.com/onsi/ginkgo v1.8.0/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE= github.com/onsi/gomega v1.4.3/go.mod h1:ex+gbHU/CVuBBDIJjb2X0qEXbFg53c61hWP/1CpauHY= +github.com/onsi/gomega v1.5.0 h1:izbySO9zDPmjJ8rDjLvkA2zJHIo+HkYXHnf7eN7SSyo= +github.com/onsi/gomega v1.5.0/go.mod h1:ex+gbHU/CVuBBDIJjb2X0qEXbFg53c61hWP/1CpauHY= github.com/opentracing/opentracing-go v1.1.0 h1:pWlfV3Bxv7k65HYwkikxat0+s3pV4bsqf19k25Ur8rU= github.com/opentracing/opentracing-go v1.1.0/go.mod h1:UkNAQd3GIcIGf0SeVgPpRdFStlNbqXla1AfSYxPUl2o= -github.com/pborman/uuid v0.0.0-20170112150404-1b00554d8222 h1:goeTyGkArOZIVOMA0dQbyuPWGNQJZGPwPu/QS9GlpnA= github.com/pborman/uuid v0.0.0-20170112150404-1b00554d8222/go.mod h1:VyrYX9gd7irzKovcSS6BIIEwPRkP2Wm2m9ufcdFSJ34= -github.com/pelletier/go-toml v1.2.0 h1:T5zMGML61Wp+FlcbWjRDT7yAxhJNAiPPLOFECq181zc= +github.com/pborman/uuid v1.2.0 h1:J7Q5mO4ysT1dv8hyrUGHb9+ooztCXu1D8MY8DZYsu3g= +github.com/pborman/uuid v1.2.0/go.mod h1:X/NO0urCmaxf9VXbdlT7C2Yzkj2IKimNn4k+gtPdI/k= github.com/pelletier/go-toml v1.2.0/go.mod h1:5z9KED0ma1S8pY6P1sdut58dfprrGBbd/94hg7ilaic= +github.com/pelletier/go-toml v1.4.0 h1:u3Z1r+oOXJIkxqw34zVhyPgjBsm6X2wn21NWs/HfSeg= +github.com/pelletier/go-toml v1.4.0/go.mod h1:PN7xzY2wHTK0K9p34ErDQMlFxa51Fk0OUruD3k1mMwo= github.com/peterh/liner v1.1.1-0.20190123174540-a2c9a5303de7 h1:oYW+YCJ1pachXTQmzR3rNLYGGz4g/UgFcjb28p/viDM= github.com/peterh/liner v1.1.1-0.20190123174540-a2c9a5303de7/go.mod h1:CRroGNssyjTd/qIG2FyxByd2S8JEAZXBl4qUrZf8GS0= -github.com/pkg/errors v0.8.0 h1:WdK/asTD0HN+q6hsWO3/vpuAkAr+tw6aNJNDFFf0+qw= github.com/pkg/errors v0.8.0/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= github.com/pkg/errors v0.8.1 h1:iURUrRGxPUNPdy5/HRSm+Yj6okJ6UtLINN0Q9M4+h3I= github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= @@ -225,11 +271,14 @@ github.com/prometheus/common v0.0.0-20181113130724-41aa239b4cce/go.mod h1:daVV7q github.com/prometheus/common v0.4.0/go.mod h1:TNfzLD0ON7rHzMJeJkieUDPYmFC7Snx/y86RQel1bk4= github.com/prometheus/procfs v0.0.0-20181005140218-185b4288413d/go.mod h1:c3At6R/oaqEKCNdg8wHV1ftS6bRYblBhIjjI8uT2IGk= github.com/prometheus/procfs v0.0.0-20190507164030-5867b95ac084/go.mod h1:TjEm7ze935MbeOT/UhFTIMYKhuLP4wbCsTZCD3I8kEA= +github.com/prometheus/tsdb v0.6.2-0.20190402121629-4f204dcbc150/go.mod h1:qhTCs0VvXwvX/y3TZrWD7rabWM+ijKTux40TwIPHuXU= github.com/prometheus/tsdb v0.7.1 h1:YZcsG11NqnK4czYLrWd9mpEuAJIHVQLwdrleYfszMAA= github.com/prometheus/tsdb v0.7.1/go.mod h1:qhTCs0VvXwvX/y3TZrWD7rabWM+ijKTux40TwIPHuXU= github.com/rjeczalik/notify v0.9.1 h1:CLCKso/QK1snAlnhNR/CNvNiFU2saUtjV0bx3EwNeCE= github.com/rjeczalik/notify v0.9.1/go.mod h1:rKwnCoCGeuQnwBtTSPL9Dad03Vh2n40ePRrjvIXnJho= github.com/rogpeppe/fastuuid v0.0.0-20150106093220-6724a57986af/go.mod h1:XWv6SoW27p1b0cqNHllgS5HIMJraePCO15w5zCzIWYg= +github.com/rogpeppe/go-internal v1.1.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4= +github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4= github.com/rs/cors v0.0.0-20160617231935-a62a804a8a00 h1:8DPul/X0IT/1TNMIxoKLwdemEOBBHDC/K4EB16Cw5WE= github.com/rs/cors v0.0.0-20160617231935-a62a804a8a00/go.mod h1:gFx+x8UowdsKA9AchylcLynDq+nNFfI8FkUZdN/jGCU= github.com/rs/xhandler v0.0.0-20160618193221-ed27b6fd6521 h1:3hxavr+IHMsQBrYUPQM5v0CgENFktkkbg1sfpgM3h20= @@ -238,6 +287,7 @@ github.com/russross/blackfriday v1.5.2/go.mod h1:JO/DiYxRf+HjHt06OyowR9PTA263kcR github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc= github.com/sirupsen/logrus v1.2.0/go.mod h1:LxeOpSwHxABJmUn/MG1IvRgCAasNZTLOkJPxbbu5VWo= +github.com/sirupsen/logrus v1.4.2/go.mod h1:tLMulIdttU9McNUspp0xgXVQah82FyeX6MwdIuYE2rE= github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d h1:zE9ykElWQ6/NYmHa3jpm/yHnI4xSofP+UP6SpjHcSeM= github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d/go.mod h1:OnSkiWE9lh6wB0YB77sQom3nweQdgAjqCqsofrRNTgc= github.com/smartystreets/goconvey v1.6.4 h1:fv0U8FUIMPNf1L9lnHLvLhgicrIVChEkdzIKYqbNC9s= @@ -266,7 +316,8 @@ github.com/steakknife/hamming v0.0.0-20180906055917-c99c65617cd3 h1:njlZPzLwU639 github.com/steakknife/hamming v0.0.0-20180906055917-c99c65617cd3/go.mod h1:hpGUWaI9xL8pRQCTXQgocU38Qw1g0Us7n5PxxTwTCYU= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= -github.com/stretchr/testify v1.2.2 h1:bSDNvY7ZPG5RlJ8otE/7V6gMiyenm9RtJ7IUVIAoJ1w= +github.com/stretchr/objx v0.2.0 h1:Hbg2NidpLE8veEBkEZTL3CvlkUIVzuU9jDplZO54c48= +github.com/stretchr/objx v0.2.0/go.mod h1:qt09Ya8vawLte6SNmTgCsAVtYtaKzEcn8ATUoHMkEqE= github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= github.com/stretchr/testify v1.4.0 h1:2E4SXV/wtOkTonXsotYi4li6zVWxYlZuYNCXe9XRJyk= @@ -275,6 +326,7 @@ github.com/subosito/gotenv v1.2.0 h1:Slr1R9HxAlEKefgq5jn9U+DnETlIUa6HfgEzj0g5d7s github.com/subosito/gotenv v1.2.0/go.mod h1:N0PQaV/YGNqwC0u51sEeR/aUtSLEXKX9iv69rRypqCw= github.com/syndtr/goleveldb v1.0.1-0.20190923125748-758128399b1d h1:gZZadD8H+fF+n9CmNhYL1Y0dJB+kLOmKd7FbPJLeGHs= github.com/syndtr/goleveldb v1.0.1-0.20190923125748-758128399b1d/go.mod h1:9OrXJhf154huy1nPWmuSrkgjPUtUNhA+Zmy+6AESzuA= +github.com/test-go/testify v1.1.4/go.mod h1:rH7cfJo/47vWGdi4GPj16x3/t1xGOj2YxzmNQzk2ghU= github.com/tidwall/gjson v1.3.5 h1:2oW9FBNu8qt9jy5URgrzsVx/T/KSn3qn/smJQ0crlDQ= github.com/tidwall/gjson v1.3.5/go.mod h1:P256ACg0Mn+j1RXIDXoss50DeIABTYK1PULOJHhxOls= github.com/tidwall/match v1.0.1 h1:PnKP62LPNxHKTwvHHZZzdOAOCtsJTjo6dZLCwpKm5xc= @@ -282,8 +334,8 @@ github.com/tidwall/match v1.0.1/go.mod h1:LujAq0jyVjBy028G1WhWfIzbpQfMO8bBZ6Tyb0 github.com/tidwall/pretty v1.0.0 h1:HsD+QiTn7sK6flMKIvNmpqz1qrpP3Ps6jOKIKMooyg4= github.com/tidwall/pretty v1.0.0/go.mod h1:XNkn88O1ChpSDQmQeStsy+sBenx6DDtFZJxhVysOjyk= github.com/tmc/grpc-websocket-proxy v0.0.0-20190109142713-0ad062ec5ee5/go.mod h1:ncp9v5uamzpCO7NfCPTXjqaC+bZgJeR0sMTm6dMHP7U= -github.com/tyler-smith/go-bip39 v0.0.0-20181017060643-dbb3b84ba2ef h1:luEzjJzktS9eU0CmI0uApXHLP/lKzOoRPrJhd71J8ik= -github.com/tyler-smith/go-bip39 v0.0.0-20181017060643-dbb3b84ba2ef/go.mod h1:sJ5fKU0s6JVwZjjcUEX2zFOnvq0ASQ2K9Zr6cf67kNs= +github.com/tyler-smith/go-bip39 v1.0.1-0.20181017060643-dbb3b84ba2ef h1:wHSqTBrZW24CsNJDfeh9Ex6Pm0Rcpc7qrgKBiL44vF4= +github.com/tyler-smith/go-bip39 v1.0.1-0.20181017060643-dbb3b84ba2ef/go.mod h1:sJ5fKU0s6JVwZjjcUEX2zFOnvq0ASQ2K9Zr6cf67kNs= github.com/ugorji/go v1.1.4/go.mod h1:uQMGLiO92mf5W77hV/PUCpI3pbzQx3CRekS0kk+RGrc= github.com/ugorji/go/codec v0.0.0-20181204163529-d75b2dcb6bc8/go.mod h1:VFNgLljTbGfSG7qAOspJ7OScBnGdDN/yBr0sguwnwf0= github.com/urfave/cli v1.22.1/go.mod h1:Gos4lmkARVdJ6EkW0WaNv/tZAAMe9V7XWyB60NtXRu0= @@ -297,8 +349,9 @@ go.uber.org/multierr v1.1.0/go.mod h1:wR5kodmAFQ0UK8QlbwjlSNy0Z68gJhDJUG5sjR94q/ go.uber.org/zap v1.10.0/go.mod h1:vwi/ZaCAaUcBkycHslxD9B2zi4UTXhF60s6SWpuDF0Q= golang.org/x/crypto v0.0.0-20180904163835-0709b304e793/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= golang.org/x/crypto v0.0.0-20181203042331-505ab145d0a9/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= -golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2 h1:VklqNMn3ovrHsnt90PveolxSbWFaJdECFbxSq0Mqo2M= golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/crypto v0.0.0-20190611184440-5c40567a22f8/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= +golang.org/x/crypto v0.0.0-20190621222207-cc06ce4a13d4/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= golang.org/x/crypto v0.0.0-20200311171314-f7b00557c8c4 h1:QmwruyY+bKbDDL0BaglrbZABEali68eoMFhTZpCjYVA= golang.org/x/crypto v0.0.0-20200311171314-f7b00557c8c4/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= golang.org/x/lint v0.0.0-20181026193005-c67002cb31c3/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE= @@ -310,35 +363,48 @@ golang.org/x/net v0.0.0-20181220203305-927f97764cc3/go.mod h1:mL1N/T3taQHkDXs73r golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= golang.org/x/net v0.0.0-20190522155817-f3200d17e092/go.mod h1:HSz+uSET+XFnRR8LxR5pz3Of3rY3CfYBVs4xY44aLks= -golang.org/x/net v0.0.0-20200301022130-244492dfa37a h1:GuSPYbZzB5/dcLNCwLQLsg3obCJtX9IJhpXkvY7kzk0= +golang.org/x/net v0.0.0-20190613194153-d28f0bde5980/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20190827160401-ba9fcec4b297/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20191101175033-0deb6923b6d9/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20200301022130-244492dfa37a/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20200324143707-d3edc9973b7e h1:3G+cUijn7XD+S4eJFddp53Pv7+slrESplyjG25HgL+k= +golang.org/x/net v0.0.0-20200324143707-d3edc9973b7e/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A= golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= -golang.org/x/sync v0.0.0-20181108010431-42b317875d0f h1:Bl/8QSvNqXvPGPGXa2z5xUTmV7VDcZyvRZ+QQXkXTZQ= golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= -golang.org/x/sync v0.0.0-20181221193216-37e7f081c4d4 h1:YUO/7uOKsKeq9UokNS62b8FYywz3ker1l1vDZRCRefw= golang.org/x/sync v0.0.0-20181221193216-37e7f081c4d4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e h1:vcxGaoTs7kV8m5Np9uUNQin4BrLOthgV7252N8V+FwY= +golang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sys v0.0.0-20180830151530-49385e6e1522/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20180905080454-ebe1bf3edb33/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20180909124046-d0be0721c37e/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20181107165924-66b7b1311ac8/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20181116152217-5ac8a444bdc5/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20181205085412-a5c9d58dba9a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= -golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a h1:1BGLXjeY4akVXGgbC9HugT3Jv3hCI0z56oJR5vAMgBU= golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= -golang.org/x/sys v0.0.0-20200302150141-5c8b2ff67527 h1:uYVVQ9WP/Ds2ROhcaGPeIdVq0RIXVLwsHlnvJ+cT1So= +golang.org/x/sys v0.0.0-20190422165155-953cdadca894/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190515120540-06a5c4944438/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190616124812-15dcb6c0061f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200302150141-5c8b2ff67527/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200323222414-85ca7c5b95cd h1:xhmwyvizuTgC2qz7ZlMluP20uW+C3Rm0FD/WLDX8884= +golang.org/x/sys v0.0.0-20200323222414-85ca7c5b95cd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/text v0.0.0-20170915032832-14c0d48ead0c/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.2 h1:tW2bmiBqwgJj/UpqtC8EpXEZVYOwU0yG4iWbprSVAcs= golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk= -golang.org/x/time v0.0.0-20190308202827-9d24e82272b4 h1:SvFZT6jyqRaOeXpc5h/JSfZenJ2O330aBsf7JfSUXmQ= golang.org/x/time v0.0.0-20190308202827-9d24e82272b4/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= +golang.org/x/time v0.0.0-20191024005414-555d28b269f0 h1:/5xXl8Y5W96D+TtHSlonuFqGHIWVuyCkGJLwGh9JJFs= +golang.org/x/time v0.0.0-20191024005414-555d28b269f0/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/tools v0.0.0-20180221164845-07fd8470d635/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20190114222345-bf090417da8b/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= golang.org/x/tools v0.0.0-20190328211700-ab21143f2384/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= +golang.org/x/tools v0.0.0-20190425150028-36563e24a262/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q= +golang.org/x/tools v0.0.0-20190614205625-5aca471b1d59/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc= +golang.org/x/tools v0.0.0-20190628153133-6cdbf07be9d0/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc= google.golang.org/appengine v1.1.0/go.mod h1:EbEs0AVv82hx2wNQdGPgUI5lhzA/G0D9YwlJXL52JkM= google.golang.org/genproto v0.0.0-20180817151627-c66870c02cf8/go.mod h1:JiN7NxoALGmiZfu7CAH4rXhgtRTLTxftemlI0sWmxmc= google.golang.org/grpc v1.19.0/go.mod h1:mqu4LbDTu4XGKhr4mRzUsmM4RtVoemTSY81AxZiDr8c= @@ -347,6 +413,7 @@ gopkg.in/alecthomas/kingpin.v2 v2.2.6/go.mod h1:FMv+mEhP44yOT+4EoQTLFTRgOQ1FBLks gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY= gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/errgo.v2 v2.1.0/go.mod h1:hNsd1EY+bozCKY1Ytp96fpM3vjJbqLJn88ws8XvfDNI= gopkg.in/fsnotify.v1 v1.4.7 h1:xOHLXZwVvI9hhs+cLKq5+I5onOuwQLhQwiu63xxlHs4= gopkg.in/fsnotify.v1 v1.4.7/go.mod h1:Tz8NjZHkW78fSQdbUxIjBTcgA1z1m8ZHf0WmKUhAMys= gopkg.in/ini.v1 v1.51.0 h1:AQvPpx3LzTDM0AjnIRlVFwFFGC+npRopjZxLJj6gdno= @@ -361,12 +428,13 @@ gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7/go.mod h1:dt/ZhP58zS4L8KSrWD gopkg.in/urfave/cli.v1 v1.20.0 h1:NdAVW6RYxDif9DhDHaAortIu956m2c0v+09AZBPTbE0= gopkg.in/urfave/cli.v1 v1.20.0/go.mod h1:vuBzUtMdQeixQj8LVd+/98pzhxNGQoyuPBlsXHOQNO0= gopkg.in/yaml.v2 v2.0.0-20170812160011-eb3733d160e7/go.mod h1:JAlM8MvJe8wmxCU4Bli9HhUf9+ttbYbLASfIpnQbh74= -gopkg.in/yaml.v2 v2.2.1 h1:mUhvW9EsL+naU5Q3cakzfE91YhliOondGd6ZrsDBHQE= gopkg.in/yaml.v2 v2.2.1/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= -gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw= gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= -gopkg.in/yaml.v2 v2.2.4 h1:/eiJrUcujPVeJ3xlSWaiNi3uSVmDGBK1pDHUHAnao1I= gopkg.in/yaml.v2 v2.2.4/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.2.8 h1:obN1ZagJSUGI0Ek/LBmuj4SNLPfIny3KsKFopxRdj10= +gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= gotest.tools v2.2.0+incompatible h1:VsBPFP1AI068pPrMxtb/S8Zkgf9xEmTLJjfM+P5UIEo= gotest.tools v2.2.0+incompatible/go.mod h1:DsYFclhRJ6vuDpmuTbkuFWG+y2sxOXAzmJt81HFBacw= honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= +rsc.io/quote/v3 v3.1.0/go.mod h1:yEA65RcK8LyAZtP9Kv3t0HmxON59tX3rD+tICJqUlj0= +rsc.io/sampler v1.3.0/go.mod h1:T1hPZKmBbMNahiBKFy5HrXp6adAjACjK9JXDnKaTXpA= diff --git a/graphql/service.go b/graphql/service.go index f640756806..a206053024 100644 --- a/graphql/service.go +++ b/graphql/service.go @@ -23,6 +23,7 @@ import ( "github.com/ethereum/go-ethereum/internal/ethapi" "github.com/ethereum/go-ethereum/log" + "github.com/ethereum/go-ethereum/node" "github.com/ethereum/go-ethereum/p2p" "github.com/ethereum/go-ethereum/rpc" "github.com/graph-gophers/graphql-go" @@ -35,7 +36,7 @@ type Service struct { cors []string // Allowed CORS domains vhosts []string // Recognised vhosts timeouts rpc.HTTPTimeouts // Timeout settings for HTTP requests. - backend ethapi.Backend // The backend that queries will operate onn. + backend ethapi.Backend // The backend that queries will operate on. handler http.Handler // The `http.Handler` used to answer queries. listener net.Listener // The listening socket. } @@ -68,7 +69,18 @@ func (s *Service) Start(server *p2p.Server) error { if s.listener, err = net.Listen("tcp", s.endpoint); err != nil { return err } - go rpc.NewHTTPServer(s.cors, s.vhosts, s.timeouts, s.handler).Serve(s.listener) + // create handler stack and wrap the graphql handler + handler := node.NewHTTPHandlerStack(s.handler, s.cors, s.vhosts) + // make sure timeout values are meaningful + node.CheckTimeouts(&s.timeouts) + // create http server + httpSrv := &http.Server{ + Handler: handler, + ReadTimeout: s.timeouts.ReadTimeout, + WriteTimeout: s.timeouts.WriteTimeout, + IdleTimeout: s.timeouts.IdleTimeout, + } + go httpSrv.Serve(s.listener) log.Info("GraphQL endpoint opened", "url", fmt.Sprintf("http://%s", s.endpoint)) return nil } diff --git a/internal/ethapi/api.go b/internal/ethapi/api.go index 5b32e7bf91..bfade9f19c 100644 --- a/internal/ethapi/api.go +++ b/internal/ethapi/api.go @@ -19,6 +19,7 @@ package ethapi import ( "bytes" "context" + "encoding/json" "errors" "fmt" "math/big" @@ -73,6 +74,28 @@ func (s *PublicEthereumAPI) ProtocolVersion() hexutil.Uint { return hexutil.Uint(s.b.ProtocolVersion()) } +type EthSyncingResult struct { + Syncing EthSyncingResultSyncing `jsonschema:"oneof"` // `jsonschema:"oneof_type=EthSyncingResultSyncing"` + Progress *EthSyncingResultProgress `jsonschema:"oneof"` // `jsonschema:"oneof_type=EthSyncingResultProgress"` +} + +type EthSyncingResultSyncing bool + +type EthSyncingResultProgress struct { + StartingBlock hexutil.Uint64 + CurrentgBlock hexutil.Uint64 + HighestgBlock hexutil.Uint64 + PulledStates hexutil.Uint64 + KnownStates hexutil.Uint64 +} + +func (r EthSyncingResult) MarshalJSON() ([]byte, error) { + if !r.Syncing { + return json.Marshal(r.Syncing) + } + return json.Marshal(r.Progress) +} + // Syncing returns false in case the node is currently not syncing with the network. It can be up to date or has not // yet received the latest block headers from its pears. In case it is synchronizing: // - startingBlock: block number this node started to synchronise from @@ -80,20 +103,24 @@ func (s *PublicEthereumAPI) ProtocolVersion() hexutil.Uint { // - highestBlock: block number of the highest block header this node has received from peers // - pulledStates: number of state entries processed until now // - knownStates: number of known state entries that still need to be pulled -func (s *PublicEthereumAPI) Syncing() (interface{}, error) { +func (s *PublicEthereumAPI) Syncing() (EthSyncingResult, error) { progress := s.b.Downloader().Progress() // Return not syncing if the synchronisation already completed if progress.CurrentBlock >= progress.HighestBlock { - return false, nil + not := EthSyncingResultSyncing(false) + return EthSyncingResult{Syncing: not}, nil } // Otherwise gather the block sync stats - return map[string]interface{}{ - "startingBlock": hexutil.Uint64(progress.StartingBlock), - "currentBlock": hexutil.Uint64(progress.CurrentBlock), - "highestBlock": hexutil.Uint64(progress.HighestBlock), - "pulledStates": hexutil.Uint64(progress.PulledStates), - "knownStates": hexutil.Uint64(progress.KnownStates), + return EthSyncingResult{ + Syncing: true, + Progress: &EthSyncingResultProgress{ + hexutil.Uint64(progress.StartingBlock), + hexutil.Uint64(progress.CurrentBlock), + hexutil.Uint64(progress.HighestBlock), + hexutil.Uint64(progress.PulledStates), + hexutil.Uint64(progress.KnownStates), + }, }, nil } @@ -380,7 +407,7 @@ func (s *PrivateAccountAPI) SendTransaction(ctx context.Context, args SendTxArgs // tries to sign it with the key associated with args.To. If the given passwd isn't // able to decrypt the key it fails. The transaction is returned in RLP-form, not broadcast // to other nodes -func (s *PrivateAccountAPI) SignTransaction(ctx context.Context, args SendTxArgs, passwd string) (*SignTransactionResult, error) { +func (s *PrivateAccountAPI) SignTransaction(ctx context.Context, args SendTxArgs, passwd, passwd2 string) (*SignTransactionResult, error) { // No need to obtain the noncelock mutex, since we won't be sending this // tx into the transaction pool, but right back to the user if args.Gas == nil { @@ -1355,7 +1382,7 @@ type SendTxArgs struct { Nonce *hexutil.Uint64 `json:"nonce"` // We accept "data" and "input" for backwards-compatibility reasons. "input" is the // newer name and should be preferred by clients. - Data *hexutil.Bytes `json:"data"` + Data *hexutil.Bytes `json:"data" jsonschema:"description=Field 'input' should be preferred"` Input *hexutil.Bytes `json:"input"` } diff --git a/internal/openrpc/openrpc_schema_test.go b/internal/openrpc/openrpc_schema_test.go deleted file mode 100644 index 6f13550ba4..0000000000 --- a/internal/openrpc/openrpc_schema_test.go +++ /dev/null @@ -1,30 +0,0 @@ -// Copyright 2019 The multi-geth Authors -// This file is part of the multi-geth library. -// -// The multi-geth library is free software: you can redistribute it and/or modify -// it under the terms of the GNU Lesser General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -// (at your option) any later version. -// -// The multi-geth library is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU Lesser General Public License for more details. -// -// You should have received a copy of the GNU Lesser General Public License -// along with the multi-geth library. If not, see . - -package openrpc_test - -import ( - "testing" - - "github.com/ethereum/go-ethereum/internal/openrpc" - "github.com/ethereum/go-ethereum/rpc" -) - -func TestDefaultSchema(t *testing.T) { - if err := rpc.SetDefaultOpenRPCSchemaRaw(openrpc.OpenRPCSchema); err != nil { - t.Fatal(err) - } -} diff --git a/mobile/ethclient.go b/mobile/ethclient.go index 662125c4ad..cba50f7bfe 100644 --- a/mobile/ethclient.go +++ b/mobile/ethclient.go @@ -241,7 +241,7 @@ func (ec *EthereumClient) SubscribeFilterLogs(ctx *Context, query *FilterQuery, // Pending State -// GetPendingBalanceAt returns the wei balance of the given account in the pending state. +// PendingBalanceAt returns the wei balance of the given account in the pending state. func (ec *EthereumClient) GetPendingBalanceAt(ctx *Context, account *Address) (balance *BigInt, _ error) { rawBalance, err := ec.client.PendingBalanceAt(ctx.context, account.address) return &BigInt{rawBalance}, err diff --git a/node/api.go b/node/api.go index 66cd1dde33..1a73d1321d 100644 --- a/node/api.go +++ b/node/api.go @@ -186,7 +186,7 @@ func (api *PrivateAdminAPI) StartRPC(host *string, port *int, cors *string, apis } } - if err := api.node.startHTTP(fmt.Sprintf("%s:%d", *host, *port), api.node.rpcAPIs, modules, allowedOrigins, allowedVHosts, api.node.config.HTTPTimeouts); err != nil { + if err := api.node.startHTTP(fmt.Sprintf("%s:%d", *host, *port), api.node.rpcAPIs, modules, allowedOrigins, allowedVHosts, api.node.config.HTTPTimeouts, api.node.config.WSOrigins); err != nil { return false, err } return true, nil diff --git a/node/config.go b/node/config.go index f5a05acc5a..ebdfa3ec89 100644 --- a/node/config.go +++ b/node/config.go @@ -288,7 +288,7 @@ func (c *Config) ExtRPCEnabled() bool { func (c *Config) NodeName() string { name := c.name() // Backwards compatibility: previous versions used Geth or MultiGeth - if strings.ToLower(name) == "geth" || strings.ToLower(name) == "geth-testnet" || strings.ToLower(name) == "multigeth" { + if strings.ToLower(name) == "geth" || strings.ToLower(name) == "geth-testnet" { name = "CoreGeth" } if params.VersionName != "" { diff --git a/node/doc.go b/node/doc.go index e3cc58e5f4..dfa11cee29 100644 --- a/node/doc.go +++ b/node/doc.go @@ -39,7 +39,7 @@ offered by registered services will be offered on those endpoints. Users can res endpoint to a subset of RPC modules. Node itself offers the "debug", "admin" and "web3" modules. -Service implementations can open LevelDB databases through the service context. Package +Service implementations can ipcOpenRPC LevelDB databases through the service context. Package node chooses the file system location of each database. If the node is configured to run without a data directory, databases are opened in memory instead. diff --git a/node/endpoints.go b/node/endpoints.go new file mode 100644 index 0000000000..8cd6b4d1c8 --- /dev/null +++ b/node/endpoints.go @@ -0,0 +1,99 @@ +// Copyright 2018 The go-ethereum Authors +// This file is part of the go-ethereum library. +// +// The go-ethereum library is free software: you can redistribute it and/or modify +// it under the terms of the GNU Lesser General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// The go-ethereum library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Lesser General Public License for more details. +// +// You should have received a copy of the GNU Lesser General Public License +// along with the go-ethereum library. If not, see . + +package node + +import ( + "net" + "net/http" + "time" + + "github.com/ethereum/go-ethereum/log" + "github.com/ethereum/go-ethereum/rpc" +) + +// StartHTTPEndpoint starts the HTTP RPC endpoint. +func StartHTTPEndpoint(endpoint string, timeouts rpc.HTTPTimeouts, handler http.Handler) (net.Listener, error) { + // start the HTTP listener + var ( + listener net.Listener + err error + ) + if listener, err = net.Listen("tcp", endpoint); err != nil { + return nil, err + } + // make sure timeout values are meaningful + CheckTimeouts(&timeouts) + // Bundle and start the HTTP server + httpSrv := &http.Server{ + Handler: handler, + ReadTimeout: timeouts.ReadTimeout, + WriteTimeout: timeouts.WriteTimeout, + IdleTimeout: timeouts.IdleTimeout, + } + go httpSrv.Serve(listener) + return listener, err +} + +// startWSEndpoint starts a websocket endpoint. +func startWSEndpoint(endpoint string, handler http.Handler) (net.Listener, error) { + // start the HTTP listener + var ( + listener net.Listener + err error + ) + if listener, err = net.Listen("tcp", endpoint); err != nil { + return nil, err + } + wsSrv := &http.Server{Handler: handler} + go wsSrv.Serve(listener) + return listener, err +} + +// checkModuleAvailability checks that all names given in modules are actually +// available API services. It assumes that the MetadataApi module ("rpc") is always available; +// the registration of this "rpc" module happens in NewServer() and is thus common to all endpoints. +func checkModuleAvailability(modules []string, apis []rpc.API) (bad, available []string) { + availableSet := make(map[string]struct{}) + for _, api := range apis { + if _, ok := availableSet[api.Namespace]; !ok { + availableSet[api.Namespace] = struct{}{} + available = append(available, api.Namespace) + } + } + for _, name := range modules { + if _, ok := availableSet[name]; !ok && name != rpc.MetadataApi { + bad = append(bad, name) + } + } + return bad, available +} + +// CheckTimeouts ensures that timeout values are meaningful +func CheckTimeouts(timeouts *rpc.HTTPTimeouts) { + if timeouts.ReadTimeout < time.Second { + log.Warn("Sanitizing invalid HTTP read timeout", "provided", timeouts.ReadTimeout, "updated", rpc.DefaultHTTPTimeouts.ReadTimeout) + timeouts.ReadTimeout = rpc.DefaultHTTPTimeouts.ReadTimeout + } + if timeouts.WriteTimeout < time.Second { + log.Warn("Sanitizing invalid HTTP write timeout", "provided", timeouts.WriteTimeout, "updated", rpc.DefaultHTTPTimeouts.WriteTimeout) + timeouts.WriteTimeout = rpc.DefaultHTTPTimeouts.WriteTimeout + } + if timeouts.IdleTimeout < time.Second { + log.Warn("Sanitizing invalid HTTP idle timeout", "provided", timeouts.IdleTimeout, "updated", rpc.DefaultHTTPTimeouts.IdleTimeout) + timeouts.IdleTimeout = rpc.DefaultHTTPTimeouts.IdleTimeout + } +} diff --git a/node/node.go b/node/node.go index 1bdd5af7d2..b6ae45d139 100644 --- a/node/node.go +++ b/node/node.go @@ -26,6 +26,7 @@ import ( "strings" "sync" + go_openrpc_reflect "github.com/etclabscore/go-openrpc-reflect" "github.com/ethereum/go-ethereum/accounts" "github.com/ethereum/go-ethereum/core/rawdb" "github.com/ethereum/go-ethereum/ethdb" @@ -34,6 +35,7 @@ import ( "github.com/ethereum/go-ethereum/log" "github.com/ethereum/go-ethereum/p2p" "github.com/ethereum/go-ethereum/rpc" + go_openrpc_types "github.com/gregdhill/go-openrpc/types" "github.com/prometheus/tsdb/fileutil" ) @@ -55,15 +57,18 @@ type Node struct { rpcAPIs []rpc.API // List of APIs currently provided by the node inprocHandler *rpc.Server // In-process RPC request handler to process the API requests + ipcOpenRPC *OpenRPCDocument ipcEndpoint string // IPC endpoint to listen at (empty = IPC disabled) ipcListener net.Listener // IPC RPC listener socket to serve API requests ipcHandler *rpc.Server // IPC RPC request handler to process the API requests + httpOpenRPC *OpenRPCDocument httpEndpoint string // HTTP endpoint (interface + port) to listen at (empty = HTTP disabled) httpWhitelist []string // HTTP RPC modules to allow through this endpoint httpListener net.Listener // HTTP RPC listener socket to server API requests httpHandler *rpc.Server // HTTP RPC request handler to process the API requests + wsOpenRPC *OpenRPCDocument wsEndpoint string // Websocket endpoint (interface + port) to listen at (empty = websocket disabled) wsListener net.Listener // Websocket RPC listener socket to server API requests wsHandler *rpc.Server // Websocket RPC request handler to process the API requests @@ -74,6 +79,54 @@ type Node struct { log log.Logger } +type OpenRPCDocument struct { + *go_openrpc_reflect.Document + serviceDescriptor go_openrpc_reflect.ReceiverServiceDescriptor +} + +func newOpenRPCDocument(listener net.Listener) *OpenRPCDocument { + //listener.Addr().String() + openrpcServerConfig := &go_openrpc_reflect.ServerDescriptorT{ + ServiceOpenRPCInfoFn: func() go_openrpc_types.Info { + return go_openrpc_types.Info{ + Title: "Core-Geth Ethereum JSON-RPC: " + listener.Addr().Network() + ":" + listener.Addr().String(), + Description: "This API lets you interact with an EVM-based client via JSON-RPC", + TermsOfService: "https://github.com/etclabscore/core-geth/blob/master/COPYING", + Contact: go_openrpc_types.Contact{ + Name: "", + URL: "", + Email: "", + }, + License: go_openrpc_types.License{ + Name: "Apache-2.0", + URL: "https://www.apache.org/licenses/LICENSE-2.0.html", + }, + Version: "1.0.10", + } + }, + ServiceOpenRPCExternalDocsFn: func() *go_openrpc_types.ExternalDocs { + return &go_openrpc_types.ExternalDocs{ + Description: "Source", + URL: "https://github.com/etclabscore/core-geth", + } + }, + } + + rp := go_openrpc_reflect.EthereumRPCDescriptor + rp.ProviderParseOptions.TypeMapper = OpenRPCJSONSchemaTypeMapper + + return &OpenRPCDocument{ + Document: go_openrpc_reflect.NewReflectDocument(openrpcServerConfig), + serviceDescriptor: rp, + } +} + +func (d *OpenRPCDocument) registerOpenRPCAPIs(apis []rpc.API) { + for _, api := range apis { + d.Document.Reflector.RegisterReceiverWithName(api.Namespace, api.Service, d.serviceDescriptor) + } +} + // New creates a new P2P node, ready for protocol registration. func New(conf *Config) (*Node, error) { // Copy config and resolve the datadir so future changes to the current @@ -158,7 +211,7 @@ func (n *Node) Register(constructor ServiceConstructor) error { return nil } -// Start create a live P2P node and starts running it. +// Start creates a live P2P node and starts running it. func (n *Node) Start() error { n.lock.Lock() defer n.lock.Unlock() @@ -235,7 +288,8 @@ func (n *Node) Start() error { // Mark the service started for potential cleanup started = append(started, kind) } - // Lastly start the configured RPC interfaces + + // Lastly, start the configured RPC interfaces if err := n.startRPC(services); err != nil { for _, service := range services { service.Stop() @@ -274,7 +328,7 @@ func (n *Node) openDataDir() error { return nil } -// startRPC is a helper method to start all the various RPC endpoint during node +// startRPC is a helper method to start all the various RPC endpoints during node // startup. It's not meant to be called at any time afterwards as it makes certain // assumptions about the state of the node. func (n *Node) startRPC(services map[reflect.Type]Service) error { @@ -283,6 +337,7 @@ func (n *Node) startRPC(services map[reflect.Type]Service) error { for _, service := range services { apis = append(apis, service.APIs()...) } + // Start the various API endpoints, terminating all in case of errors if err := n.startInProc(apis); err != nil { return err @@ -291,17 +346,21 @@ func (n *Node) startRPC(services map[reflect.Type]Service) error { n.stopInProc() return err } - if err := n.startHTTP(n.httpEndpoint, apis, n.config.HTTPModules, n.config.HTTPCors, n.config.HTTPVirtualHosts, n.config.HTTPTimeouts); err != nil { + if err := n.startHTTP(n.httpEndpoint, apis, n.config.HTTPModules, n.config.HTTPCors, n.config.HTTPVirtualHosts, n.config.HTTPTimeouts, n.config.WSOrigins); err != nil { n.stopIPC() n.stopInProc() return err } - if err := n.startWS(n.wsEndpoint, apis, n.config.WSModules, n.config.WSOrigins, n.config.WSExposeAll); err != nil { - n.stopHTTP() - n.stopIPC() - n.stopInProc() - return err + // if endpoints are not the same, start separate servers + if n.httpEndpoint != n.wsEndpoint { + if err := n.startWS(n.wsEndpoint, apis, n.config.WSModules, n.config.WSOrigins, n.config.WSExposeAll); err != nil { + n.stopHTTP() + n.stopIPC() + n.stopInProc() + return err + } } + // All API endpoints started successfully n.rpcAPIs = apis return nil @@ -338,8 +397,17 @@ func (n *Node) startIPC(apis []rpc.API) error { if err != nil { return err } + + // Register the API documentation. + n.ipcOpenRPC = newOpenRPCDocument(listener) + n.ipcOpenRPC.registerOpenRPCAPIs(apis) + if err := handler.RegisterName("rpc", n.ipcOpenRPC); err != nil { + return err + } + n.ipcListener = listener n.ipcHandler = handler + n.log.Info("IPC endpoint opened", "url", n.ipcEndpoint) return nil } @@ -359,20 +427,44 @@ func (n *Node) stopIPC() { } // startHTTP initializes and starts the HTTP RPC endpoint. -func (n *Node) startHTTP(endpoint string, apis []rpc.API, modules []string, cors []string, vhosts []string, timeouts rpc.HTTPTimeouts) error { +func (n *Node) startHTTP(endpoint string, apis []rpc.API, modules []string, cors []string, vhosts []string, timeouts rpc.HTTPTimeouts, wsOrigins []string) error { // Short circuit if the HTTP endpoint isn't being exposed if endpoint == "" { return nil } - listener, handler, err := rpc.StartHTTPEndpoint(endpoint, apis, modules, cors, vhosts, timeouts) + // register apis and create handler stack + srv := rpc.NewServer() + registeredAPIs, err := RegisterApisFromWhitelist(apis, modules, srv, false) if err != nil { return err } - n.log.Info("HTTP endpoint opened", "url", fmt.Sprintf("http://%s", endpoint), "cors", strings.Join(cors, ","), "vhosts", strings.Join(vhosts, ",")) + handler := NewHTTPHandlerStack(srv, cors, vhosts) + // wrap handler in websocket handler only if websocket port is the same as http rpc + if n.httpEndpoint == n.wsEndpoint { + handler = NewWebsocketUpgradeHandler(handler, srv.WebsocketHandler(wsOrigins)) + } + listener, err := StartHTTPEndpoint(endpoint, timeouts, handler) + if err != nil { + return err + } + + // Register the API documentation. + n.httpOpenRPC = newOpenRPCDocument(listener) + n.httpOpenRPC.registerOpenRPCAPIs(registeredAPIs) + if err := srv.RegisterName("rpc", n.httpOpenRPC); err != nil { + return err + } + + n.log.Info("HTTP endpoint opened", "url", fmt.Sprintf("http://%v/", listener.Addr()), + "cors", strings.Join(cors, ","), + "vhosts", strings.Join(vhosts, ",")) + if n.httpEndpoint == n.wsEndpoint { + n.log.Info("WebSocket endpoint opened", "url", fmt.Sprintf("ws://%v", listener.Addr())) + } // All listeners booted successfully n.httpEndpoint = endpoint n.httpListener = listener - n.httpHandler = handler + n.httpHandler = srv return nil } @@ -380,10 +472,10 @@ func (n *Node) startHTTP(endpoint string, apis []rpc.API, modules []string, cors // stopHTTP terminates the HTTP RPC endpoint. func (n *Node) stopHTTP() { if n.httpListener != nil { + url := fmt.Sprintf("http://%v/", n.httpListener.Addr()) n.httpListener.Close() n.httpListener = nil - - n.log.Info("HTTP endpoint closed", "url", fmt.Sprintf("http://%s", n.httpEndpoint)) + n.log.Info("HTTP endpoint closed", "url", url) } if n.httpHandler != nil { n.httpHandler.Stop() @@ -397,15 +489,30 @@ func (n *Node) startWS(endpoint string, apis []rpc.API, modules []string, wsOrig if endpoint == "" { return nil } - listener, handler, err := rpc.StartWSEndpoint(endpoint, apis, modules, wsOrigins, exposeAll) + + srv := rpc.NewServer() + handler := srv.WebsocketHandler(wsOrigins) + registeredAPIs, err := RegisterApisFromWhitelist(apis, modules, srv, exposeAll) if err != nil { return err } + listener, err := startWSEndpoint(endpoint, handler) + if err != nil { + return err + } + // Register the API documentation. + n.wsOpenRPC = newOpenRPCDocument(listener) + n.wsOpenRPC.registerOpenRPCAPIs(registeredAPIs) + if err := srv.RegisterName("rpc", n.wsOpenRPC); err != nil { + return err + } + n.log.Info("WebSocket endpoint opened", "url", fmt.Sprintf("ws://%s", listener.Addr())) + // All listeners booted successfully n.wsEndpoint = endpoint n.wsListener = listener - n.wsHandler = handler + n.wsHandler = srv return nil } @@ -639,6 +746,7 @@ func (n *Node) ResolvePath(x string) string { } // apis returns the collection of RPC descriptors this node offers. +// These are appended to by default. func (n *Node) apis() []rpc.API { return []rpc.API{ { @@ -659,6 +767,34 @@ func (n *Node) apis() []rpc.API { Version: "1.0", Service: NewPublicWeb3API(n), Public: true, + }, { + Namespace: "rpc", + Version: "1.0", + Service: n.ipcOpenRPC, + Public: true, }, } } + +// RegisterApisFromWhitelist checks the given modules' availability, generates a whitelist based on the allowed modules, +// and then registers all of the APIs exposed by the services. +func RegisterApisFromWhitelist(apis []rpc.API, modules []string, srv *rpc.Server, exposeAll bool) (registeredApis []rpc.API, err error) { + if bad, available := checkModuleAvailability(modules, apis); len(bad) > 0 { + log.Error("Unavailable modules in HTTP API list", "unavailable", bad, "available", available) + } + // Generate the whitelist based on the allowed modules + whitelist := make(map[string]bool) + for _, module := range modules { + whitelist[module] = true + } + // Register all the APIs exposed by the services + for _, api := range apis { + if exposeAll || whitelist[api.Namespace] || (len(whitelist) == 0 && api.Public) { + if err := srv.RegisterName(api.Namespace, api.Service); err != nil { + return registeredApis, err + } + registeredApis = append(registeredApis, api) + } + } + return registeredApis, nil +} diff --git a/node/node_test.go b/node/node_test.go index c464771cd8..e246731fef 100644 --- a/node/node_test.go +++ b/node/node_test.go @@ -19,6 +19,7 @@ package node import ( "errors" "io/ioutil" + "net/http" "os" "reflect" "testing" @@ -27,6 +28,8 @@ import ( "github.com/ethereum/go-ethereum/crypto" "github.com/ethereum/go-ethereum/p2p" "github.com/ethereum/go-ethereum/rpc" + + "github.com/stretchr/testify/assert" ) var ( @@ -597,3 +600,58 @@ func TestAPIGather(t *testing.T) { } } } + +func TestWebsocketHTTPOnSamePort_WebsocketRequest(t *testing.T) { + node := startHTTP(t) + defer node.stopHTTP() + + wsReq, err := http.NewRequest(http.MethodGet, "http://127.0.0.1:7453", nil) + if err != nil { + t.Error("could not issue new http request ", err) + } + wsReq.Header.Set("Connection", "upgrade") + wsReq.Header.Set("Upgrade", "websocket") + wsReq.Header.Set("Sec-WebSocket-Version", "13") + wsReq.Header.Set("Sec-Websocket-Key", "SGVsbG8sIHdvcmxkIQ==") + + resp := doHTTPRequest(t, wsReq) + assert.Equal(t, "websocket", resp.Header.Get("Upgrade")) +} + +func TestWebsocketHTTPOnSamePort_HTTPRequest(t *testing.T) { + node := startHTTP(t) + defer node.stopHTTP() + + httpReq, err := http.NewRequest(http.MethodGet, "http://127.0.0.1:7453", nil) + if err != nil { + t.Error("could not issue new http request ", err) + } + httpReq.Header.Set("Accept-Encoding", "gzip") + + resp := doHTTPRequest(t, httpReq) + assert.Equal(t, "gzip", resp.Header.Get("Content-Encoding")) +} + +func startHTTP(t *testing.T) *Node { + conf := &Config{HTTPPort: 7453, WSPort: 7453} + node, err := New(conf) + if err != nil { + t.Error("could not create a new node ", err) + } + + err = node.startHTTP("127.0.0.1:7453", []rpc.API{}, []string{}, []string{}, []string{}, rpc.HTTPTimeouts{}, []string{}) + if err != nil { + t.Error("could not start http service on node ", err) + } + + return node +} + +func doHTTPRequest(t *testing.T, req *http.Request) *http.Response { + client := &http.Client{} + resp, err := client.Do(req) + if err != nil { + t.Error("could not issue a GET request to the given endpoint", err) + } + return resp +} diff --git a/node/openrpc.go b/node/openrpc.go new file mode 100644 index 0000000000..1a67057d84 --- /dev/null +++ b/node/openrpc.go @@ -0,0 +1,170 @@ +package node + +import ( + "encoding/json" + "fmt" + "math/big" + "reflect" + + "github.com/alecthomas/jsonschema" + "github.com/ethereum/go-ethereum/common" + "github.com/ethereum/go-ethereum/common/hexutil" + "github.com/ethereum/go-ethereum/core/types" + "github.com/ethereum/go-ethereum/rpc" +) + +const bytesD = `{ +"title": "bytes", +"type": "string", +"description": "Hex representation of a variable length byte array", +"pattern": "^0x([a-fA-F0-9]?)+$" +}` +const integerD = `{ + "title": "integer", + "type": "string", + "pattern": "^0x[a-fA-F0-9]+$", + "description": "Hex representation of the integer" + }` +const commonAddressD = `{ + "title": "keccak", + "type": "string", + "description": "Hex representation of a Keccak 256 hash POINTER", + "pattern": "^0x[a-fA-F\\d]{64}$" + }` +const commonHashD = `{ + "title": "keccak", + "type": "string", + "description": "Hex representation of a Keccak 256 hash", + "pattern": "^0x[a-fA-F\\d]{64}$" + }` +const hexutilBytesD = `{ + "title": "dataWord", + "type": "string", + "description": "Hex representation of some bytes", + "pattern": "^0x([a-fA-F\\d])+$" + }` +const hexutilUintD = `{ + "title": "uint", + "type": "string", + "description": "Hex representation of a uint", + "pattern": "^0x([a-fA-F\\d])+$" + }` +const hexutilUint64D = `{ + "title": "uint64", + "type": "string", + "description": "Hex representation of a uint64", + "pattern": "^0x([a-fA-F\\d])+$" + }` +const blockNumberTagD = `{ + "title": "blockNumberTag", + "type": "string", + "description": "The optional block height description", + "enum": [ + "earliest", + "latest", + "pending" + ] + }` + +var blockNumberOrHashD = fmt.Sprintf(`{ + "oneOf": [ + %s, + %s + ] + }`, blockNumberTagD, commonHashD) + +var emptyInterface interface{} + +// schemaDictEntry represents a type association passed to the jsonschema reflector. +type schemaDictEntry struct { + example interface{} + rawJson string +} + +// OpenRPCJSONSchemaTypeMapper contains the application-specific type mapping +// passed to the jsonschema reflector, used in generating a runtime representation +// of specific API objects. +func OpenRPCJSONSchemaTypeMapper(ty reflect.Type) *jsonschema.Type { + unmarshalJSONToJSONSchemaType := func(input string) *jsonschema.Type { + var js jsonschema.Type + err := json.Unmarshal([]byte(input), &js) + if err != nil { + panic(err) + } + return &js + } + + if ty.Kind() == reflect.Ptr { + ty = ty.Elem() + } + + // Second, handle other types. + // Use a slice instead of a map because it preserves order, as a logic safeguard/fallback. + dict := []schemaDictEntry{ + {emptyInterface, fmt.Sprintf(`{ + "oneOf": [{"additionalProperties": true}, {"type": "null"}] + }`)}, + {[]byte{}, bytesD}, + {big.Int{}, integerD}, + {types.BlockNonce{}, integerD}, + {common.Address{}, commonAddressD}, + {common.Hash{}, commonHashD}, + {hexutil.Big{}, integerD}, + {hexutil.Bytes{}, hexutilBytesD}, + {hexutil.Uint(0), hexutilUintD}, + {hexutil.Uint64(0), hexutilUint64D}, + {rpc.BlockNumber(0), blockNumberOrHashD}, + {rpc.BlockNumberOrHash{}, fmt.Sprintf(`{ + "title": "blockNumberOrHash", + "oneOf": [ + %s, + { + "allOf": [ + %s, + { + "type": "object", + "properties": { + "requireCanonical": { + "type": "boolean" + } + }, + "additionalProperties": false + } + ] + } + ] + }`, blockNumberOrHashD, blockNumberOrHashD)}, + {rpc.Subscription{}, fmt.Sprintf(`{ + "type": "object", + "title": "Subscription", + "summary": "" + }`)}, + } + + for _, d := range dict { + if reflect.TypeOf(d.example) == ty { + tt := unmarshalJSONToJSONSchemaType(d.rawJson) + + return tt + } + } + + // Handle primitive types in case there are generic cases + // specific to our services. + switch ty.Kind() { + case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64, reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64: + // Return all integer types as the hex representation integer schemea. + ret := unmarshalJSONToJSONSchemaType(integerD) + return ret + case reflect.Struct: + case reflect.Map: + case reflect.Slice, reflect.Array: + case reflect.Float32, reflect.Float64: + case reflect.Bool: + case reflect.String: + case reflect.Ptr, reflect.Interface: + default: + } + + return nil +} diff --git a/node/rpcstack.go b/node/rpcstack.go new file mode 100644 index 0000000000..70aa0d4555 --- /dev/null +++ b/node/rpcstack.go @@ -0,0 +1,159 @@ +// Copyright 2020 The go-ethereum Authors +// This file is part of the go-ethereum library. +// +// The go-ethereum library is free software: you can redistribute it and/or modify +// it under the terms of the GNU Lesser General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// The go-ethereum library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Lesser General Public License for more details. +// +// You should have received a copy of the GNU Lesser General Public License +// along with the go-ethereum library. If not, see . + +package node + +import ( + "compress/gzip" + "io" + "io/ioutil" + "net" + "net/http" + "strings" + "sync" + + "github.com/ethereum/go-ethereum/log" + "github.com/rs/cors" +) + +// NewHTTPHandlerStack returns wrapped http-related handlers +func NewHTTPHandlerStack(srv http.Handler, cors []string, vhosts []string) http.Handler { + // Wrap the CORS-handler within a host-handler + handler := newCorsHandler(srv, cors) + handler = newVHostHandler(vhosts, handler) + return newGzipHandler(handler) +} + +func newCorsHandler(srv http.Handler, allowedOrigins []string) http.Handler { + // disable CORS support if user has not specified a custom CORS configuration + if len(allowedOrigins) == 0 { + return srv + } + c := cors.New(cors.Options{ + AllowedOrigins: allowedOrigins, + AllowedMethods: []string{http.MethodPost, http.MethodGet}, + MaxAge: 600, + AllowedHeaders: []string{"*"}, + }) + return c.Handler(srv) +} + +// virtualHostHandler is a handler which validates the Host-header of incoming requests. +// Using virtual hosts can help prevent DNS rebinding attacks, where a 'random' domain name points to +// the service ip address (but without CORS headers). By verifying the targeted virtual host, we can +// ensure that it's a destination that the node operator has defined. +type virtualHostHandler struct { + vhosts map[string]struct{} + next http.Handler +} + +func newVHostHandler(vhosts []string, next http.Handler) http.Handler { + vhostMap := make(map[string]struct{}) + for _, allowedHost := range vhosts { + vhostMap[strings.ToLower(allowedHost)] = struct{}{} + } + return &virtualHostHandler{vhostMap, next} +} + +// ServeHTTP serves JSON-RPC requests over HTTP, implements http.Handler +func (h *virtualHostHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) { + // if r.Host is not set, we can continue serving since a browser would set the Host header + if r.Host == "" { + h.next.ServeHTTP(w, r) + return + } + host, _, err := net.SplitHostPort(r.Host) + if err != nil { + // Either invalid (too many colons) or no port specified + host = r.Host + } + if ipAddr := net.ParseIP(host); ipAddr != nil { + // It's an IP address, we can serve that + h.next.ServeHTTP(w, r) + return + + } + // Not an IP address, but a hostname. Need to validate + if _, exist := h.vhosts["*"]; exist { + h.next.ServeHTTP(w, r) + return + } + if _, exist := h.vhosts[host]; exist { + h.next.ServeHTTP(w, r) + return + } + http.Error(w, "invalid host specified", http.StatusForbidden) +} + +var gzPool = sync.Pool{ + New: func() interface{} { + w := gzip.NewWriter(ioutil.Discard) + return w + }, +} + +type gzipResponseWriter struct { + io.Writer + http.ResponseWriter +} + +func (w *gzipResponseWriter) WriteHeader(status int) { + w.Header().Del("Content-Length") + w.ResponseWriter.WriteHeader(status) +} + +func (w *gzipResponseWriter) Write(b []byte) (int, error) { + return w.Writer.Write(b) +} + +func newGzipHandler(next http.Handler) http.Handler { + return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + if !strings.Contains(r.Header.Get("Accept-Encoding"), "gzip") { + next.ServeHTTP(w, r) + return + } + + w.Header().Set("Content-Encoding", "gzip") + + gz := gzPool.Get().(*gzip.Writer) + defer gzPool.Put(gz) + + gz.Reset(w) + defer gz.Close() + + next.ServeHTTP(&gzipResponseWriter{ResponseWriter: w, Writer: gz}, r) + }) +} + +// NewWebsocketUpgradeHandler returns a websocket handler that serves an incoming request only if it contains an upgrade +// request to the websocket protocol. If not, serves the the request with the http handler. +func NewWebsocketUpgradeHandler(h http.Handler, ws http.Handler) http.Handler { + return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + if isWebsocket(r) { + ws.ServeHTTP(w, r) + log.Debug("serving websocket request") + return + } + + h.ServeHTTP(w, r) + }) +} + +// isWebsocket checks the header of an http request for a websocket upgrade request. +func isWebsocket(r *http.Request) bool { + return strings.ToLower(r.Header.Get("Upgrade")) == "websocket" && + strings.ToLower(r.Header.Get("Connection")) == "upgrade" +} diff --git a/node/rpcstack_test.go b/node/rpcstack_test.go new file mode 100644 index 0000000000..9db03181c9 --- /dev/null +++ b/node/rpcstack_test.go @@ -0,0 +1,38 @@ +package node + +import ( + "net/http" + "net/http/httptest" + "testing" + + "github.com/ethereum/go-ethereum/rpc" + "github.com/stretchr/testify/assert" +) + +func TestNewWebsocketUpgradeHandler_websocket(t *testing.T) { + srv := rpc.NewServer() + + handler := NewWebsocketUpgradeHandler(nil, srv.WebsocketHandler([]string{})) + ts := httptest.NewServer(handler) + defer ts.Close() + + responses := make(chan *http.Response) + go func(responses chan *http.Response) { + client := &http.Client{} + + req, _ := http.NewRequest(http.MethodGet, ts.URL, nil) + req.Header.Set("Connection", "upgrade") + req.Header.Set("Upgrade", "websocket") + req.Header.Set("Sec-WebSocket-Version", "13") + req.Header.Set("Sec-Websocket-Key", "SGVsbG8sIHdvcmxkIQ==") + + resp, err := client.Do(req) + if err != nil { + t.Error("could not issue a GET request to the test http server", err) + } + responses <- resp + }(responses) + + response := <-responses + assert.Equal(t, "websocket", response.Header.Get("Upgrade")) +} diff --git a/node/service_test.go b/node/service_test.go index 5da8e9e434..021bcf14ee 100644 --- a/node/service_test.go +++ b/node/service_test.go @@ -41,7 +41,7 @@ func TestContextDatabases(t *testing.T) { ctx := &ServiceContext{Config: Config{Name: "unit-test", DataDir: dir}} db, err := ctx.OpenDatabase("persistent", 0, 0, "") if err != nil { - t.Fatalf("failed to open persistent database: %v", err) + t.Fatalf("failed to ipcOpenRPC persistent database: %v", err) } db.Close() @@ -52,7 +52,7 @@ func TestContextDatabases(t *testing.T) { ctx = &ServiceContext{Config: Config{DataDir: ""}} db, err = ctx.OpenDatabase("ephemeral", 0, 0, "") if err != nil { - t.Fatalf("failed to open ephemeral database: %v", err) + t.Fatalf("failed to ipcOpenRPC ephemeral database: %v", err) } db.Close() diff --git a/internal/openrpc/openrpc_schema.go b/openrpc.json similarity index 94% rename from internal/openrpc/openrpc_schema.go rename to openrpc.json index bc3fcb4747..a8a9ba0c34 100644 --- a/internal/openrpc/openrpc_schema.go +++ b/openrpc.json @@ -1,26 +1,3 @@ -// Copyright 2019 The go-ethereum Authors -// This file is part of the go-ethereum library. -// -// The go-ethereum library is free software: you can redistribute it and/or modify -// it under the terms of the GNU Lesser General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -// (at your option) any later version. -// -// The go-ethereum library is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU Lesser General Public License for more details. -// -// You should have received a copy of the GNU Lesser General Public License -// along with the go-ethereum library. If not, see . - -package openrpc - -// This file contains a string constant containing the JSON schema data for OpenRPC. - -// OpenRPCSchema defines the default full suite of possibly available go-ethereum RPC -// methods. -const OpenRPCSchema = ` { "openrpc": "1.0.0", "info": { @@ -33,6 +10,68 @@ const OpenRPCSchema = ` } }, "methods": [ + { + "name": "admin_addPeer", + "description": "adds a peer", + "summary": "Adds a peer", + "params": [ + { + "$ref": "#/components/contentDescriptors/Enode" + } + ], + "result": { + "name": "addPeerResult", + "description": "whether added", + "schema": { + "$ref": "#/components/schemas/Bool" + } + } + }, + { + "name": "admin_addTrustedPeer", + "description": "adds a trusted peer", + "summary": "Adds a trusted peer", + "params": [ + { + "$ref": "#/components/contentDescriptors/Enode" + } + ], + "result": { + "name": "addPeerResult", + "description": "whether added", + "schema": { + "$ref": "#/components/schemas/Bool" + } + } + }, + { + "name": "admin_datadir", + "summary": "Filesystem path to the data directory", + "description": "Filesystem path to the data directory", + "params": [], + "result": { + "name": "path", + "description": "path to datadir", + "schema": { + "title": "datadir path", + "type": "string" + } + } + }, + { + "name": "admin_exportChain", + "summary": "Export chain", + "description": "Filesystem path to the data directory", + "params": [], + "result": { + "name": "path", + "description": "path to datadir", + "schema": { + "title": "datadir path", + "type": "string" + } + } + }, { "name": "web3_clientVersion", "description": "Returns the version of the current client", @@ -40,7 +79,7 @@ const OpenRPCSchema = ` "params": [], "result": { "name": "clientVersion", - "description": "client version", + "description": "client version ", "schema": { "title": "clientVersion", "type": "string" @@ -93,7 +132,7 @@ const OpenRPCSchema = ` "params": [], "result": { "name": "netListeningResult", - "description": "` + "`" + `true` + "`" + ` if listening is active or ` + "`" + `false` + "`" + ` if listening is not active", + "description": "`true` if listening is active or `false` if listening is not active", "schema": { "title": "isNetListening", "type": "boolean" @@ -259,7 +298,7 @@ const OpenRPCSchema = ` }, { "name": "includeTransactions", - "description": "If ` + "`" + `true` + "`" + ` it returns the full transaction objects, if ` + "`" + `false` + "`" + ` only the hashes of the transactions.", + "description": "If `true` it returns the full transaction objects, if `false` only the hashes of the transactions.", "required": true, "schema": { "title": "isTransactionsIncluded", @@ -283,7 +322,7 @@ const OpenRPCSchema = ` }, { "name": "includeTransactions", - "description": "If ` + "`" + `true` + "`" + ` it returns the full transaction objects, if ` + "`" + `false` + "`" + ` only the hashes of the transactions.", + "description": "If `true` it returns the full transaction objects, if `false` only the hashes of the transactions.", "required": true, "schema": { "title": "isTransactionsIncluded", @@ -855,7 +894,7 @@ const OpenRPCSchema = ` ], "result": { "name": "filterId", - "description": "The filter ID for use in ` + "`" + `eth_getFilterChanges` + "`" + `", + "description": "The filter ID for use in `eth_getFilterChanges`", "schema": { "$ref": "#/components/schemas/Integer" } @@ -871,7 +910,7 @@ const OpenRPCSchema = ` }, { "name": "eth_pendingTransactions", - "summary": "Returns the pending transactions list", + "summary": "Returns the transactions that are pending in the transaction pool and have a from address that is one of the accounts this node manages.", "params": [], "result": { "name": "pendingTransactions", @@ -913,35 +952,6 @@ const OpenRPCSchema = ` } } }, - { - "name": "eth_submitHashrate", - "deprecated": true, - "summary": "Used for submitting mining hashrate.", - "params": [ - { - "name": "hashRate", - "required": true, - "schema": { - "$ref": "#/components/schemas/DataWord" - } - }, - { - "name": "id", - "required": true, - "description": "String identifying the client", - "schema": { - "$ref": "#/components/schemas/DataWord" - } - } - ], - "result": { - "name": "submitHashRateSuccess", - "description": "whether of not submitting went through successfully", - "schema": { - "type": "boolean" - } - } - }, { "name": "eth_submitWork", "summary": "Used for submitting a proof-of-work solution.", @@ -993,7 +1003,7 @@ const OpenRPCSchema = ` ], "result": { "name": "solutionInvalidExample", - "description": "this example should return ` + "`" + `false` + "`" + ` as it is not a valid pow to submit", + "description": "this example should return `false` as it is not a valid pow to submit", "value": false } } @@ -1100,10 +1110,10 @@ const OpenRPCSchema = ` "title": "storageProofValue", "description": "The value of the storage slot in its account tree", "$ref": "#/components/schemas/Integer" - }, + }, "proof": { "$ref": "#/components/schemas/ProofNodes" - } + } } } }, @@ -1354,7 +1364,7 @@ const OpenRPCSchema = ` ] }, "BlockHashOrNull": { - "title": "blockNumberOrNull", + "title": "blockHashOrNull", "description": "The block hash or null when its the pending block", "$ref": "#/components/schemas/KeccakOrPending" }, @@ -1506,6 +1516,7 @@ const OpenRPCSchema = ` "description": "Array of transaction objects, or 32 Bytes transaction hashes depending on the last given parameter", "type": "array", "items": { + "title": "transactionOrTransactionHash", "oneOf": [ { "$ref": "#/components/schemas/Transaction" @@ -1630,6 +1641,11 @@ const OpenRPCSchema = ` "type": "null", "description": "Null" }, + "Bool": { + "title": "bool", + "type": "boolean", + "description": "Bool" + }, "Integer": { "title": "integer", "type": "string", @@ -1666,9 +1682,24 @@ const OpenRPCSchema = ` "type": "string", "description": "Hex representation of a variable length byte array", "pattern": "^0x([a-fA-F0-9]?)+$" + }, + "Enode": { + "title": "enode", + "type": "string", + "description": "ethereum node address", + "pattern": "^enode://" } }, "contentDescriptors": { + "Enode": { + "name": "enode", + "summary": "an ethereum node address", + "description": "An enode", + "required": true, + "schema": { + "$ref": "#/components/schemas/Enode" + } + }, "Block": { "name": "block", "summary": "A block", @@ -1700,6 +1731,7 @@ const OpenRPCSchema = ` "name": "gasPrice", "required": true, "schema": { + "title": "gasPriceResult", "description": "Integer of the current gas price", "$ref": "#/components/schemas/Integer" } @@ -1715,6 +1747,7 @@ const OpenRPCSchema = ` "name": "transactionResult", "description": "Returns a transaction or null", "schema": { + "title": "TransactionOrNull", "oneOf": [ { "$ref": "#/components/schemas/Transaction" @@ -1802,6 +1835,7 @@ const OpenRPCSchema = ` "name": "logs", "description": "An array of all logs matching filter with given id.", "schema": { + "title": "setOfLogs", "type": "array", "items": { "$ref": "#/components/schemas/Log" @@ -1818,6 +1852,7 @@ const OpenRPCSchema = ` "name": "blockNumber", "required": true, "schema": { + "title": "blockNumberOrTag", "oneOf": [ { "$ref": "#/components/schemas/BlockNumber" @@ -1838,5 +1873,3 @@ const OpenRPCSchema = ` } } } - -` diff --git a/openrpc_describe.log b/openrpc_describe.log new file mode 100644 index 0000000000..f327cded22 --- /dev/null +++ b/openrpc_describe.log @@ -0,0 +1,5744 @@ +{ + "jsonrpc": "2.0", + "id": 1584386006, + "result": { + "Over": null, + "Under": [ + { + "name": "admin_importChain", + "tags": [], + "summary": "ImportChain imports a blockchain from a local file.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateAdminAPI).ImportChain", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:219" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "admin_importChainResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_nodeInfo", + "tags": [], + "summary": "NodeInfo retrieves all the information we know about the host node at the\nprotocol granularity.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PublicAdminAPI).NodeInfo", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:285" + }, + "params": [], + "result": { + "name": "admin_nodeInfoResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/p2p:NodeInfo", + "definitions": { + "": { + "type": "object", + "required": ["discovery", "listener"], + "properties": { + "discovery": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "listener": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + }, + "NodeInfo": { + "type": "object", + "required": [ + "id", + "name", + "enode", + "enr", + "ip", + "ports", + "listenAddr", + "protocols" + ], + "properties": { + "enode": { + "type": "string" + }, + "enr": { + "type": "string" + }, + "id": { + "type": "string" + }, + "ip": { + "type": "string" + }, + "listenAddr": { + "type": "string" + }, + "name": { + "type": "string" + }, + "ports": { + "$ref": "#/definitions/", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "protocols": { + "$ref": "#/definitions/" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/NodeInfo", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_peers", + "tags": [], + "summary": "Peers retrieves all the information we know about each individual peer at the\nprotocol granularity.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PublicAdminAPI).Peers", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:275" + }, + "params": [], + "result": { + "name": "admin_peersResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/PeerInfo", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "definitions": { + "": { + "type": "object", + "required": [ + "localAddress", + "remoteAddress", + "inbound", + "trusted", + "static" + ], + "properties": { + "inbound": { + "type": "boolean" + }, + "localAddress": { + "type": "string" + }, + "remoteAddress": { + "type": "string" + }, + "static": { + "type": "boolean" + }, + "trusted": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "PeerInfo": { + "type": "object", + "required": [ + "enode", + "id", + "name", + "caps", + "network", + "protocols" + ], + "properties": { + "caps": { + "type": "array", + "items": { + "type": "string" + } + }, + "enode": { + "type": "string" + }, + "enr": { + "type": "string" + }, + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "network": { + "$ref": "#/definitions/", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "protocols": { + "$ref": "#/definitions/" + } + }, + "additionalProperties": false + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_removePeer", + "tags": [], + "summary": "RemovePeer disconnects from a remote node if the connection exists\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).RemovePeer", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:61" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "admin_removePeerResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_removeTrustedPeer", + "tags": [], + "summary": "RemoveTrustedPeer removes a remote node from the trusted peer set, but it\ndoes not disconnect it automatically.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).RemoveTrustedPeer", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:93" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "admin_removeTrustedPeerResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_startRPC", + "tags": [], + "summary": "StartRPC starts the HTTP RPC API server.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).StartRPC", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:146" + }, + "params": [ + { + "name": "host", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:string", + "type": "string" + } + }, + { + "name": "port", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + { + "name": "cors", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:string", + "type": "string" + } + }, + { + "name": "apis", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:string", + "type": "string" + } + }, + { + "name": "vhosts", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:string", + "type": "string" + } + } + ], + "result": { + "name": "admin_startRPCResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_startWS", + "tags": [], + "summary": "StartWS starts the websocket RPC API server.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).StartWS", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:208" + }, + "params": [ + { + "name": "host", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:string", + "type": "string" + } + }, + { + "name": "port", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + { + "name": "allowedOrigins", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:string", + "type": "string" + } + }, + { + "name": "apis", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:string", + "type": "string" + } + } + ], + "result": { + "name": "admin_startWSResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_stopRPC", + "tags": [], + "summary": "StopRPC terminates an already running HTTP RPC API endpoint.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).StopRPC", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:196" + }, + "params": [], + "result": { + "name": "admin_stopRPCResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_stopWS", + "tags": [], + "summary": "StopWS terminates an already running websocket RPC API endpoint.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).StopWS", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:250" + }, + "params": [], + "result": { + "name": "admin_stopWSResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_accountRange", + "tags": [], + "summary": "AccountRange enumerates all accounts in the latest state\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).AccountRange", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:395" + }, + "params": [ + { + "name": "start", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "maxResults", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "debug_accountRangeResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/eth:AccountRangeResult", + "definitions": { + "AccountRangeResult": { + "type": "object", + "required": ["accounts", "next"], + "properties": { + "accounts": { + "type": "object", + "patternProperties": { + ".*": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + }, + "next": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/AccountRangeResult", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_backtraceAt", + "tags": [], + "summary": "BacktraceAt sets the log backtrace location. See package log for details on\nthe pattern syntax.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).BacktraceAt", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:68" + }, + "params": [ + { + "name": "location", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_blockProfile", + "tags": [], + "summary": "BlockProfile turns on goroutine profiling for nsec seconds and writes profile data to\nfile. It uses a profile rate of 1 for most accurate information. If a different rate is\ndesired, set the rate and write the profile manually.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).BlockProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:147" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "nsec", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_chaindbCompact", + "tags": [], + "summary": "ChaindbCompact flattens the entire key-value database into a single level,\nremoving all unused slots and merging all keys.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateDebugAPI).ChaindbCompact", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1759" + }, + "params": [], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_chaindbProperty", + "tags": [], + "summary": "ChaindbProperty returns leveldb properties of the key-value database.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateDebugAPI).ChaindbProperty", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1748" + }, + "params": [ + { + "name": "property", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "debug_chaindbPropertyResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_cpuProfile", + "tags": [], + "summary": "CpuProfile turns on CPU profiling for nsec seconds and writes\nprofile data to file.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).CpuProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:88" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "nsec", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_dumpBlock", + "tags": [], + "summary": "DumpBlock retrieves the entire state of the database at a given block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PublicDebugAPI).DumpBlock", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:280" + }, + "params": [ + { + "name": "blockNr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Block tag or hex representation of a block number", + "title": "blockNumberOrTag", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + } + ] + } + } + ], + "result": { + "name": "debug_dumpBlockResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/core/state:state.Dump", + "definitions": { + "Dump": { + "type": "object", + "required": ["root", "accounts"], + "properties": { + "accounts": { + "type": "object", + "patternProperties": { + ".*": { + "$ref": "#/definitions/DumpAccount", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + }, + "root": { + "type": "string" + } + }, + "additionalProperties": false + }, + "DumpAccount": { + "type": "object", + "required": ["balance", "nonce", "root", "codeHash"], + "properties": { + "address": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "balance": { + "type": "string" + }, + "code": { + "type": "string" + }, + "codeHash": { + "type": "string" + }, + "key": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "root": { + "type": "string" + }, + "storage": { + "type": "object", + "patternProperties": { + ".*": { + "type": "string" + } + } + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/Dump", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_freeOSMemory", + "tags": [], + "summary": "FreeOSMemory returns unused memory to the OS.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).FreeOSMemory", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:200" + }, + "params": [], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_gcStats", + "tags": [], + "summary": "GcStats returns GC statistics.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).GcStats", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:80" + }, + "params": [], + "result": { + "name": "debug_gcStatsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*runtime/debug:GCStats", + "definitions": { + "GCStats": { + "type": "object", + "required": [ + "LastGC", + "NumGC", + "PauseTotal", + "Pause", + "PauseEnd", + "PauseQuantiles" + ], + "properties": { + "LastGC": { + "type": "string", + "format": "date-time" + }, + "NumGC": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Pause": { + "type": "array", + "items": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "PauseEnd": { + "type": "array", + "items": { + "type": "string", + "format": "date-time" + } + }, + "PauseQuantiles": { + "type": "array", + "items": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "PauseTotal": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/GCStats", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_getBadBlocks", + "tags": [], + "summary": "GetBadBlocks returns a list of the last 'bad blocks' that the client has seen on the network\nand returns them as a JSON list of block-hashes\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).GetBadBlocks", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:333" + }, + "params": [], + "result": { + "name": "debug_getBadBlocksResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/BadBlockArgs", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "definitions": { + "BadBlockArgs": { + "type": "object", + "required": ["hash", "block", "rlp"], + "properties": { + "block": { + "type": "object", + "patternProperties": { + ".*": { + "additionalProperties": true + } + } + }, + "hash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "rlp": { + "type": "string" + } + }, + "additionalProperties": false + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_getBlockRlp", + "tags": [], + "summary": "GetBlockRlp retrieves the RLP encoded for of a single block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicDebugAPI).GetBlockRlp", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1666" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "debug_getBlockRlpResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_getModifiedAccountsByHash", + "tags": [], + "summary": "GetModifiedAccountsByHash returns all accounts that have changed between the\ntwo blocks specified. A change is defined as a difference in nonce, balance,\ncode hash, or storage hash.\n\nWith one parameter, returns the list of accounts modified in the specified block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).GetModifiedAccountsByHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:502" + }, + "params": [ + { + "name": "startHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "endHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "debug_getModifiedAccountsByHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_getModifiedAccountsByNumber", + "tags": [], + "summary": "GetModifiedAccountsByNumber returns all accounts that have changed between the\ntwo blocks specified. A change is defined as a difference in nonce, balance,\ncode hash, or storage hash.\n\nWith one parameter, returns the list of accounts modified in the specified block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).GetModifiedAccountsByNumber", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:474" + }, + "params": [ + { + "name": "startNum", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + { + "name": "endNum", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "debug_getModifiedAccountsByNumberResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_goTrace", + "tags": [], + "summary": "GoTrace turns on tracing for nsec seconds and writes\ntrace data to file.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).GoTrace", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:135" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "nsec", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_memStats", + "tags": [], + "summary": "MemStats returns detailed runtime memory statistics.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).MemStats", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:73" + }, + "params": [], + "result": { + "name": "debug_memStatsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*runtime:MemStats", + "definitions": { + "": { + "type": "object", + "required": ["Size", "Mallocs", "Frees"], + "properties": { + "Frees": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Mallocs": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Size": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + }, + "MemStats": { + "type": "object", + "required": [ + "Alloc", + "TotalAlloc", + "Sys", + "Lookups", + "Mallocs", + "Frees", + "HeapAlloc", + "HeapSys", + "HeapIdle", + "HeapInuse", + "HeapReleased", + "HeapObjects", + "StackInuse", + "StackSys", + "MSpanInuse", + "MSpanSys", + "MCacheInuse", + "MCacheSys", + "BuckHashSys", + "GCSys", + "OtherSys", + "NextGC", + "LastGC", + "PauseTotalNs", + "PauseNs", + "PauseEnd", + "NumGC", + "NumForcedGC", + "GCCPUFraction", + "EnableGC", + "DebugGC", + "BySize" + ], + "properties": { + "Alloc": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "BuckHashSys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "BySize": { + "type": "array", + "maxItems": 61, + "minItems": 61, + "items": { + "$ref": "#/definitions/", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "DebugGC": { + "type": "boolean" + }, + "EnableGC": { + "type": "boolean" + }, + "Frees": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "GCCPUFraction": { + "type": "number" + }, + "GCSys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "HeapAlloc": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "HeapIdle": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "HeapInuse": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "HeapObjects": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "HeapReleased": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "HeapSys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "LastGC": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Lookups": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "MCacheInuse": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "MCacheSys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "MSpanInuse": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "MSpanSys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Mallocs": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "NextGC": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "NumForcedGC": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "NumGC": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "OtherSys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "PauseEnd": { + "type": "array", + "maxItems": 256, + "minItems": 256, + "items": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "PauseNs": { + "type": "array", + "maxItems": 256, + "minItems": 256, + "items": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "PauseTotalNs": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "StackInuse": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "StackSys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Sys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "TotalAlloc": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/MemStats", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_mutexProfile", + "tags": [], + "summary": "MutexProfile turns on mutex profiling for nsec seconds and writes profile data to file.\nIt uses a profile rate of 1 for most accurate information. If a different rate is\ndesired, set the rate and write the profile manually.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).MutexProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:168" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "nsec", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_preimage", + "tags": [], + "summary": "Preimage is a debug API function that returns the preimage for a sha3 hash, if known.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).Preimage", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:317" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "debug_preimageResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_printBlock", + "tags": [], + "summary": "PrintBlock retrieves a block and returns its pretty printed form.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicDebugAPI).PrintBlock", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1718" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "debug_printBlockResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_seedHash", + "tags": [], + "summary": "SeedHash retrieves the seed hash of a block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicDebugAPI).SeedHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1727" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "debug_seedHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_setBlockProfileRate", + "tags": [], + "summary": "SetBlockProfileRate sets the rate of goroutine block profile data collection.\nrate 0 disables block profiling.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).SetBlockProfileRate", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:156" + }, + "params": [ + { + "name": "rate", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_setGCPercent", + "tags": [], + "summary": "SetGCPercent sets the garbage collection target percentage. It returns the previous\nsetting. A negative value disables GC.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).SetGCPercent", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:206" + }, + "params": [ + { + "name": "v", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "debug_setGCPercentResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_setHead", + "tags": [], + "summary": "SetHead rewinds the head of the blockchain to a previous block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateDebugAPI).SetHead", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1771" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_setMutexProfileFraction", + "tags": [], + "summary": "SetMutexProfileFraction sets the rate of mutex profiling.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).SetMutexProfileFraction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:177" + }, + "params": [ + { + "name": "rate", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_stacks", + "tags": [], + "summary": "Stacks returns a printed representation of the stacks of all goroutines.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).Stacks", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:193" + }, + "params": [], + "result": { + "name": "debug_stacksResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_standardTraceBadBlockToFile", + "tags": [], + "summary": "StandardTraceBadBlockToFile dumps the structured logs created during the\nexecution of EVM against a block pulled from the pool of bad ones to the\nlocal file system and returns a list of files to the caller.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).StandardTraceBadBlockToFile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:432" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/eth:StdTraceConfig", + "definitions": { + "StdTraceConfig": { + "type": "object", + "required": [ + "DisableMemory", + "DisableStack", + "DisableStorage", + "Debug", + "Limit", + "Reexec", + "TxHash" + ], + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "TxHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/StdTraceConfig", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_standardTraceBadBlockToFileResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_standardTraceBlockToFile", + "tags": [], + "summary": "StandardTraceBlockToFile dumps the structured logs created during the\nexecution of EVM to the local file system and returns a list of files\nto the caller.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).StandardTraceBlockToFile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:421" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/eth:StdTraceConfig", + "definitions": { + "StdTraceConfig": { + "type": "object", + "required": [ + "DisableMemory", + "DisableStack", + "DisableStorage", + "Debug", + "Limit", + "Reexec", + "TxHash" + ], + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "TxHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/StdTraceConfig", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_standardTraceBlockToFileResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_startCPUProfile", + "tags": [], + "summary": "StartCPUProfile turns on CPU profiling, writing to the given file.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).StartCPUProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:98" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_startGoTrace", + "tags": [], + "summary": "StartGoTrace turns on tracing, writing to the given file.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).StartGoTrace", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/trace.go:30" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_stopCPUProfile", + "tags": [], + "summary": "StopCPUProfile stops an ongoing CPU profile.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).StopCPUProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:119" + }, + "params": [], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_stopGoTrace", + "tags": [], + "summary": "StopTrace stops an ongoing trace.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).StopGoTrace", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/trace.go:51" + }, + "params": [], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_storageRangeAt", + "tags": [], + "summary": "StorageRangeAt returns the storage at the given block height and transaction index.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).StorageRangeAt", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:434" + }, + "params": [ + { + "name": "blockHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "txIndex", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + { + "name": "contractAddress", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + { + "name": "keyStart", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + }, + { + "name": "maxResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "debug_storageRangeAtResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/eth:StorageRangeResult", + "definitions": { + "StorageRangeResult": { + "type": "object", + "required": ["storage", "nextKey"], + "properties": { + "nextKey": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "storage": { + "type": "object", + "patternProperties": { + ".*": { + "$ref": "#/definitions/storageEntry", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + } + }, + "additionalProperties": false + }, + "storageEntry": { + "type": "object", + "required": ["key", "value"], + "properties": { + "key": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/StorageRangeResult", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_testSignCliqueBlock", + "tags": [], + "summary": "TestSignCliqueBlock fetches the given block number, and attempts to sign it as a clique header with the\ngiven address, returning the address of the recovered signature\n\nThis is a temporary method to debug the externalsigner integration,\nTODO: Remove this method when the integration is mature\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicDebugAPI).TestSignCliqueBlock", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1683" + }, + "params": [ + { + "name": "address", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "debug_testSignCliqueBlockResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceBadBlock", + "tags": [], + "summary": "TraceBadBlockByHash returns the structured logs created during the execution of\nEVM against a block pulled from the pool of bad ones and returns them as a JSON\nobject.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).TraceBadBlock", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:408" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/eth:TraceConfig", + "definitions": { + "TraceConfig": { + "type": "object", + "required": [ + "DisableMemory", + "DisableStack", + "DisableStorage", + "Debug", + "Limit", + "Tracer", + "Timeout", + "Reexec" + ], + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Timeout": { + "type": "string" + }, + "Tracer": { + "type": "string" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/TraceConfig", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_traceBadBlockResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/txTraceResult", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "definitions": { + "txTraceResult": { + "type": "object", + "properties": { + "error": { + "type": "string" + }, + "result": { + "additionalProperties": true + } + }, + "additionalProperties": false + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceBlock", + "tags": [], + "summary": "TraceBlock returns the structured logs created during the execution of EVM\nand returns them as a JSON object.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).TraceBlock", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:387" + }, + "params": [ + { + "name": "blob", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a variable length byte array", + "type": "string", + "title": "bytes", + "pattern": "^0x([a-fA-F0-9]?)+$" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/eth:TraceConfig", + "definitions": { + "TraceConfig": { + "type": "object", + "required": [ + "DisableMemory", + "DisableStack", + "DisableStorage", + "Debug", + "Limit", + "Tracer", + "Timeout", + "Reexec" + ], + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Timeout": { + "type": "string" + }, + "Tracer": { + "type": "string" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/TraceConfig", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_traceBlockResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/txTraceResult", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "definitions": { + "txTraceResult": { + "type": "object", + "properties": { + "error": { + "type": "string" + }, + "result": { + "additionalProperties": true + } + }, + "additionalProperties": false + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceBlockByHash", + "tags": [], + "summary": "TraceBlockByHash returns the structured logs created during the execution of\nEVM and returns them as a JSON object.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).TraceBlockByHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:377" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/eth:TraceConfig", + "definitions": { + "TraceConfig": { + "type": "object", + "required": [ + "DisableMemory", + "DisableStack", + "DisableStorage", + "Debug", + "Limit", + "Tracer", + "Timeout", + "Reexec" + ], + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Timeout": { + "type": "string" + }, + "Tracer": { + "type": "string" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/TraceConfig", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_traceBlockByHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/txTraceResult", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "definitions": { + "txTraceResult": { + "type": "object", + "properties": { + "error": { + "type": "string" + }, + "result": { + "additionalProperties": true + } + }, + "additionalProperties": false + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceBlockByNumber", + "tags": [], + "summary": "TraceBlockByNumber returns the structured logs created during the execution of\nEVM and returns them as a JSON object.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).TraceBlockByNumber", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:356" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Block tag or hex representation of a block number", + "title": "blockNumberOrTag", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + } + ] + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/eth:TraceConfig", + "definitions": { + "TraceConfig": { + "type": "object", + "required": [ + "DisableMemory", + "DisableStack", + "DisableStorage", + "Debug", + "Limit", + "Tracer", + "Timeout", + "Reexec" + ], + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Timeout": { + "type": "string" + }, + "Tracer": { + "type": "string" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/TraceConfig", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_traceBlockByNumberResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/txTraceResult", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "definitions": { + "txTraceResult": { + "type": "object", + "properties": { + "error": { + "type": "string" + }, + "result": { + "additionalProperties": true + } + }, + "additionalProperties": false + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceBlockFromFile", + "tags": [], + "summary": "TraceBlockFromFile returns the structured logs created during the execution of\nEVM and returns them as a JSON object.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).TraceBlockFromFile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:397" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/eth:TraceConfig", + "definitions": { + "TraceConfig": { + "type": "object", + "required": [ + "DisableMemory", + "DisableStack", + "DisableStorage", + "Debug", + "Limit", + "Tracer", + "Timeout", + "Reexec" + ], + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Timeout": { + "type": "string" + }, + "Tracer": { + "type": "string" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/TraceConfig", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_traceBlockFromFileResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/txTraceResult", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "definitions": { + "txTraceResult": { + "type": "object", + "properties": { + "error": { + "type": "string" + }, + "result": { + "additionalProperties": true + } + }, + "additionalProperties": false + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceTransaction", + "tags": [], + "summary": "FIXME: Is this really supposed to return an *ethapi.ExecutionResult type, or the empty interface in case not *vm.StructLogger?\nTraceTransaction returns the structured logs created during the execution of EVM\nand returns them as a JSON object.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).TraceTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:706" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/eth:TraceConfig", + "definitions": { + "TraceConfig": { + "type": "object", + "required": [ + "DisableMemory", + "DisableStack", + "DisableStorage", + "Debug", + "Limit", + "Tracer", + "Timeout", + "Reexec" + ], + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Timeout": { + "type": "string" + }, + "Tracer": { + "type": "string" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/TraceConfig", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_traceTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/internal/ethapi:ExecutionResult", + "definitions": { + "ExecutionResult": { + "type": "object", + "required": ["gas", "failed", "returnValue", "structLogs"], + "properties": { + "failed": { + "type": "boolean" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "returnValue": { + "type": "string" + }, + "structLogs": { + "type": "array", + "items": { + "$ref": "#/definitions/StructLogRes", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + }, + "additionalProperties": false + }, + "StructLogRes": { + "type": "object", + "required": ["pc", "op", "gas", "gasCost", "depth"], + "properties": { + "depth": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "error": { + "additionalProperties": true + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasCost": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "memory": { + "type": "array", + "items": { + "type": "string" + } + }, + "op": { + "type": "string" + }, + "pc": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "stack": { + "type": "array", + "items": { + "type": "string" + } + }, + "storage": { + "type": "object", + "patternProperties": { + ".*": { + "type": "string" + } + } + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/ExecutionResult", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_verbosity", + "tags": [], + "summary": "Verbosity sets the log verbosity ceiling. The verbosity of individual packages\nand source files can be raised using Vmodule.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).Verbosity", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:57" + }, + "params": [ + { + "name": "level", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_vmodule", + "tags": [], + "summary": "Vmodule sets the log verbosity pattern. See package log for details on the\npattern syntax.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).Vmodule", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:62" + }, + "params": [ + { + "name": "pattern", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_writeBlockProfile", + "tags": [], + "summary": "WriteBlockProfile writes a goroutine blocking profile to the given file.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).WriteBlockProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:161" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_writeMemProfile", + "tags": [], + "summary": "WriteMemProfile writes an allocation profile to the given file.\nNote that the profiling rate cannot be set through the API,\nit must be set on the command line.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).WriteMemProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:188" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_writeMutexProfile", + "tags": [], + "summary": "WriteMutexProfile writes a goroutine blocking profile to the given file.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).WriteMutexProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:181" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_accounts", + "tags": [], + "summary": "Accounts returns the collection of accounts this node manages\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicAccountAPI).Accounts", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:193" + }, + "params": [], + "result": { + "name": "eth_accountsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_etherbase", + "tags": [], + "summary": "Etherbase is the address that mining rewards will be send to\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PublicEthereumAPI).Etherbase", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:55" + }, + "params": [], + "result": { + "name": "eth_etherbaseResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_fillTransaction", + "tags": [], + "summary": "FillTransaction fills the defaults (nonce, gas, gasPrice) on a given unsigned transaction,\nand returns it to the caller for further processing (signing + broadcast)\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).FillTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1500" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi:SendTxArgs", + "definitions": { + "SendTxArgs": { + "type": "object", + "required": [ + "from", + "to", + "gas", + "gasPrice", + "value", + "nonce", + "data", + "input" + ], + "properties": { + "data": { + "description": "Field _input_ should be preferred", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/SendTxArgs", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_fillTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/internal/ethapi:SignTransactionResult", + "definitions": { + "SignTransactionResult": { + "type": "object", + "required": ["raw", "tx"], + "properties": { + "raw": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "tx": { + "$ref": "#/definitions/Transaction", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "additionalProperties": false + }, + "Transaction": { + "type": "object", + "additionalProperties": false + } + }, + "$ref": "#/definitions/SignTransactionResult", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getHashrate", + "tags": [], + "summary": "GetHashrate returns the current hashrate for local CPU miner and remote miner.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).GetHashrate", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:110" + }, + "params": [], + "result": { + "name": "eth_getHashrateResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getHeaderByHash", + "tags": [], + "summary": "GetHeaderByHash returns the requested header by hash.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetHeaderByHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:626" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "eth_getHeaderByHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "patternProperties": { + ".*": { + "additionalProperties": true + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getHeaderByNumber", + "tags": [], + "summary": "GetHeaderByNumber returns the requested canonical block header.\n* When blockNr is -1 the chain head is returned.\n* When blockNr is -2 the pending chain head is returned.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetHeaderByNumber", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:610" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Block tag or hex representation of a block number", + "title": "blockNumberOrTag", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + } + ] + } + } + ], + "result": { + "name": "eth_getHeaderByNumberResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "patternProperties": { + ".*": { + "additionalProperties": true + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_resend", + "tags": [], + "summary": "Resend accepts an existing transaction and a new gas price and limit. It will remove\nthe given transaction from the pool and reinsert it with the new gas price and limit.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).Resend", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1611" + }, + "params": [ + { + "name": "sendArgs", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi:SendTxArgs", + "definitions": { + "SendTxArgs": { + "type": "object", + "required": [ + "from", + "to", + "gas", + "gasPrice", + "value", + "nonce", + "data", + "input" + ], + "properties": { + "data": { + "description": "Field _input_ should be preferred", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/SendTxArgs", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "gasPrice", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + { + "name": "gasLimit", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "eth_resendResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_sendTransaction", + "tags": [], + "summary": "SendTransaction creates a transaction for the given argument, sign it and submit it to the\ntransaction pool.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).SendTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1468" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi:SendTxArgs", + "definitions": { + "SendTxArgs": { + "type": "object", + "required": [ + "from", + "to", + "gas", + "gasPrice", + "value", + "nonce", + "data", + "input" + ], + "properties": { + "data": { + "description": "Field _input_ should be preferred", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/SendTxArgs", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_sendTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_sign", + "tags": [], + "summary": "Sign calculates an ECDSA signature for:\nkeccack256(\"\\x19Ethereum Signed Message:\\n\" + len(message) + message).\n\nNote, the produced signature conforms to the secp256k1 curve R, S and V values,\nwhere the V value will be 27 or 28 for legacy reasons.\n\nThe account associated with addr must be unlocked.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).Sign", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1533" + }, + "params": [ + { + "name": "addr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + { + "name": "data", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + } + ], + "result": { + "name": "eth_signResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_signTransaction", + "tags": [], + "summary": "SignTransaction will sign the given transaction with the from account.\nThe node needs to have the private key of the account corresponding with\nthe given from address and it needs to be unlocked.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).SignTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1558" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi:SendTxArgs", + "definitions": { + "SendTxArgs": { + "type": "object", + "required": [ + "from", + "to", + "gas", + "gasPrice", + "value", + "nonce", + "data", + "input" + ], + "properties": { + "data": { + "description": "Field _input_ should be preferred", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/SendTxArgs", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_signTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/internal/ethapi:SignTransactionResult", + "definitions": { + "SignTransactionResult": { + "type": "object", + "required": ["raw", "tx"], + "properties": { + "raw": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "tx": { + "$ref": "#/definitions/Transaction", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "additionalProperties": false + }, + "Transaction": { + "type": "object", + "additionalProperties": false + } + }, + "$ref": "#/definitions/SignTransactionResult", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_submitHashRate", + "tags": [], + "summary": "SubmitHashrate can be used for remote miners to submit their hash rate.\nThis enables the node to report the combined hash rate of all miners\nwhich submit work through this node.\n\nIt accepts the miner hash rate and an identifier which must be unique\nbetween nodes.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).SubmitHashRate", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:92" + }, + "params": [ + { + "name": "rate", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + { + "name": "id", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "eth_submitHashRateResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "ethash_getHashrate", + "tags": [], + "summary": "GetHashrate returns the current hashrate for local CPU miner and remote miner.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).GetHashrate", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:110" + }, + "params": [], + "result": { + "name": "ethash_getHashrateResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "ethash_getWork", + "tags": [], + "summary": "GetWork returns a work package for external miner.\n\nThe work package consists of 3 strings:\n result[0] - 32 bytes hex encoded current block header pow-hash\n result[1] - 32 bytes hex encoded seed hash used for DAG\n result[2] - 32 bytes hex encoded boundary condition (\"target\"), 2^256/difficulty\n result[3] - hex encoded block number\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).GetWork", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:41" + }, + "params": [], + "result": { + "name": "ethash_getWorkResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "maxItems": 4, + "minItems": 4, + "items": { + "type": "string" + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "ethash_submitHashRate", + "tags": [], + "summary": "SubmitHashrate can be used for remote miners to submit their hash rate.\nThis enables the node to report the combined hash rate of all miners\nwhich submit work through this node.\n\nIt accepts the miner hash rate and an identifier which must be unique\nbetween nodes.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).SubmitHashRate", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:92" + }, + "params": [ + { + "name": "rate", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + { + "name": "id", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "ethash_submitHashRateResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "ethash_submitWork", + "tags": [], + "summary": "SubmitWork can be used by external miner to submit their POW solution.\nIt returns an indication if the work was accepted.\nNote either an invalid solution, a stale work a non-existent work will return false.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).SubmitWork", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:66" + }, + "params": [ + { + "name": "nonce", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/core/types:types.BlockNonce", + "type": "array", + "maxItems": 8, + "minItems": 8, + "items": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + }, + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "digest", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "ethash_submitWorkResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_getHashrate", + "tags": [], + "summary": "GetHashrate returns the current hashrate of the miner.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateMinerAPI).GetHashrate", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:153" + }, + "params": [], + "result": { + "name": "miner_getHashrateResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_setEtherbase", + "tags": [], + "summary": "SetEtherbase sets the etherbase of the miner\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateMinerAPI).SetEtherbase", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:142" + }, + "params": [ + { + "name": "etherbase", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + } + ], + "result": { + "name": "miner_setEtherbaseResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_setExtra", + "tags": [], + "summary": "SetExtra sets the extra data string that is included when this miner mines a block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateMinerAPI).SetExtra", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:124" + }, + "params": [ + { + "name": "extra", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "miner_setExtraResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_setGasPrice", + "tags": [], + "summary": "SetGasPrice sets the minimum accepted gas price for the miner.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateMinerAPI).SetGasPrice", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:132" + }, + "params": [ + { + "name": "gasPrice", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "miner_setGasPriceResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_setRecommitInterval", + "tags": [], + "summary": "SetRecommitInterval updates the interval for miner sealing work recommitting.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateMinerAPI).SetRecommitInterval", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:148" + }, + "params": [ + { + "name": "interval", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_start", + "tags": [], + "summary": "Start starts the miner with the given number of threads. If threads is nil,\nthe number of workers started is equal to the number of logical CPUs that are\nusable by this process. If mining is already running, this method adjust the\nnumber of threads allowed to use and updates the minimum price required by the\ntransaction pool.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateMinerAPI).Start", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:110" + }, + "params": [ + { + "name": "threads", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_stop", + "tags": [], + "summary": "Stop terminates the miner, both at the consensus engine level as well as at\nthe block creation level.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateMinerAPI).Stop", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:119" + }, + "params": [], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_deriveAccount", + "tags": [], + "summary": "DeriveAccount requests a HD wallet to derive a new account, optionally pinning\nit for later reuse.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).DeriveAccount", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:266" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "path", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "pin", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:bool", + "type": "boolean" + } + } + ], + "result": { + "name": "personal_deriveAccountResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/accounts:accounts.Account", + "definitions": { + "Account": { + "type": "object", + "required": ["address", "url"], + "properties": { + "address": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "url": { + "$ref": "#/definitions/URL", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "additionalProperties": false + }, + "URL": { + "type": "object", + "required": ["Scheme", "Path"], + "properties": { + "Path": { + "type": "string" + }, + "Scheme": { + "type": "string" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/Account", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_ecRecover", + "tags": [], + "summary": "EcRecover returns the address for the account that was used to create the signature.\nNote, this function is compatible with eth_sign and personal_sign. As such it recovers\nthe address of:\nhash = keccak256(\"\\x19Ethereum Signed Message:\\n\"${message length}${message})\naddr = ecrecover(hash, signature)\n\nNote, the signature must conform to the secp256k1 curve R, S and V values, where\nthe V value must be 27 or 28 for legacy reasons.\n\nhttps://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_ecRecover\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).EcRecover", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:444" + }, + "params": [ + { + "name": "data", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + }, + { + "name": "sig", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + } + ], + "result": { + "name": "personal_ecRecoverResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_importRawKey", + "tags": [], + "summary": "ImportRawKey stores the given hex encoded ECDSA key into the key directory,\nencrypting it with the passphrase.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).ImportRawKey", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:300" + }, + "params": [ + { + "name": "privkey", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "password", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "personal_importRawKeyResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_initializeWallet", + "tags": [], + "summary": "InitializeWallet initializes a new wallet at the provided URL, by generating and returning a new private key.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).InitializeWallet", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:467" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "personal_initializeWalletResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_listAccounts", + "tags": [], + "summary": "listAccounts will return a list of addresses for accounts this node manages.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).ListAccounts", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:216" + }, + "params": [], + "result": { + "name": "personal_listAccountsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_listWallets", + "tags": [], + "summary": "ListWallets will return a list of wallets this node manages.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).ListWallets", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:230" + }, + "params": [], + "result": { + "name": "personal_listWalletsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/rawWallet", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "definitions": { + "Account": { + "type": "object", + "required": ["address", "url"], + "properties": { + "address": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "url": { + "$ref": "#/definitions/URL", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "additionalProperties": false + }, + "URL": { + "type": "object", + "required": ["Scheme", "Path"], + "properties": { + "Path": { + "type": "string" + }, + "Scheme": { + "type": "string" + } + }, + "additionalProperties": false + }, + "rawWallet": { + "type": "object", + "required": ["url", "status"], + "properties": { + "accounts": { + "type": "array", + "items": { + "$ref": "#/definitions/Account", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "failure": { + "type": "string" + }, + "status": { + "type": "string" + }, + "url": { + "type": "string" + } + }, + "additionalProperties": false + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_lockAccount", + "tags": [], + "summary": "LockAccount will lock the account associated with the given address when it's unlocked.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).LockAccount", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:337" + }, + "params": [ + { + "name": "addr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + } + ], + "result": { + "name": "personal_lockAccountResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_newAccount", + "tags": [], + "summary": "NewAccount will create a new account and returns the address for the new account.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).NewAccount", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:282" + }, + "params": [ + { + "name": "password", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "personal_newAccountResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_openWallet", + "tags": [], + "summary": "OpenWallet initiates a hardware wallet opening procedure, establishing a USB\nconnection and attempting to authenticate via the provided passphrase. Note,\nthe method may return an extra challenge requiring a second open (e.g. the\nTrezor PIN matrix challenge).\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).OpenWallet", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:252" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "passphrase", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:string", + "type": "string" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_sendTransaction", + "tags": [], + "summary": "SendTransaction will create a transaction from the given arguments and\ntries to sign it with the key associated with args.To. If the given passwd isn't\nable to decrypt the key it fails.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).SendTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:364" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi:SendTxArgs", + "definitions": { + "SendTxArgs": { + "type": "object", + "required": [ + "from", + "to", + "gas", + "gasPrice", + "value", + "nonce", + "data", + "input" + ], + "properties": { + "data": { + "description": "Field _input_ should be preferred", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/SendTxArgs", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "passwd", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "personal_sendTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_sign", + "tags": [], + "summary": "Sign calculates an Ethereum ECDSA signature for:\nkeccack256(\"\\x19Ethereum Signed Message:\\n\" + len(message) + message))\n\nNote, the produced signature conforms to the secp256k1 curve R, S and V values,\nwhere the V value will be 27 or 28 for legacy reasons.\n\nThe key used to calculate the signature is decrypted with the given password.\n\nhttps://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_sign\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).Sign", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:416" + }, + "params": [ + { + "name": "data", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + }, + { + "name": "addr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + { + "name": "passwd", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "personal_signResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_signAndSendTransaction", + "tags": [], + "summary": "SignAndSendTransaction was renamed to SendTransaction. This method is deprecated\nand will be removed in the future. It primary goal is to give clients time to update.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).SignAndSendTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:462" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi:SendTxArgs", + "definitions": { + "SendTxArgs": { + "type": "object", + "required": [ + "from", + "to", + "gas", + "gasPrice", + "value", + "nonce", + "data", + "input" + ], + "properties": { + "data": { + "description": "Field _input_ should be preferred", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/SendTxArgs", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "passwd", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "personal_signAndSendTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_signTransaction", + "tags": [], + "summary": "SignTransaction will create a transaction from the given arguments and\ntries to sign it with the key associated with args.To. If the given passwd isn't\nable to decrypt the key it fails. The transaction is returned in RLP-form, not broadcast\nto other nodes\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).SignTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:383" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi:SendTxArgs", + "definitions": { + "SendTxArgs": { + "type": "object", + "required": [ + "from", + "to", + "gas", + "gasPrice", + "value", + "nonce", + "data", + "input" + ], + "properties": { + "data": { + "description": "Field _input_ should be preferred", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/SendTxArgs", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "passwd", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "passwd2", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "personal_signTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/internal/ethapi:SignTransactionResult", + "definitions": { + "SignTransactionResult": { + "type": "object", + "required": ["raw", "tx"], + "properties": { + "raw": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "tx": { + "$ref": "#/definitions/Transaction", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "additionalProperties": false + }, + "Transaction": { + "type": "object", + "additionalProperties": false + } + }, + "$ref": "#/definitions/SignTransactionResult", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_unlockAccount", + "tags": [], + "summary": "UnlockAccount will unlock the account associated with the given address with\nthe given password for duration seconds. If duration is nil it will use a\ndefault of 300 seconds. It returns an indication if the account was unlocked.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).UnlockAccount", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:312" + }, + "params": [ + { + "name": "addr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + { + "name": "password", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "duration", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "personal_unlockAccountResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_unpair", + "tags": [], + "summary": "Unpair deletes a pairing between wallet and geth.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).Unpair", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:494" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "pin", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "txpool_content", + "tags": [], + "summary": "Content returns the transactions contained within the transaction pool.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTxPoolAPI).Content", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:111" + }, + "params": [], + "result": { + "name": "txpool_contentResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "patternProperties": { + ".*": { + "type": "object", + "patternProperties": { + ".*": { + "type": "object", + "patternProperties": { + ".*": { + "$ref": "#/definitions/RPCTransaction", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + } + } + } + }, + "definitions": { + "RPCTransaction": { + "type": "object", + "required": [ + "blockHash", + "blockNumber", + "from", + "gas", + "gasPrice", + "hash", + "input", + "nonce", + "to", + "transactionIndex", + "value", + "v", + "r", + "s" + ], + "properties": { + "blockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "blockNumber": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "hash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "r": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "s": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "transactionIndex": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "v": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "txpool_inspect", + "tags": [], + "summary": "Inspect retrieves the content of the transaction pool and flattens it into an\neasily inspectable list.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTxPoolAPI).Inspect", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:148" + }, + "params": [], + "result": { + "name": "txpool_inspectResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "patternProperties": { + ".*": { + "type": "object", + "patternProperties": { + ".*": { + "type": "object", + "patternProperties": { + ".*": { + "type": "string" + } + } + } + } + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "txpool_status", + "tags": [], + "summary": "Status returns the number of pending and queued transaction in the pool.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTxPoolAPI).Status", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:138" + }, + "params": [], + "result": { + "name": "txpool_statusResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "patternProperties": { + ".*": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + } + ] + } +} diff --git a/openrpc_set.log b/openrpc_set.log new file mode 100644 index 0000000000..02e5203b48 --- /dev/null +++ b/openrpc_set.log @@ -0,0 +1 @@ +{"jsonrpc":"2.0","id":1584386006,"result":null} diff --git a/p2p/server.go b/p2p/server.go index c87b7758df..1876c0953a 100644 --- a/p2p/server.go +++ b/p2p/server.go @@ -1054,19 +1054,21 @@ func (srv *Server) runPeer(p *Peer) { // NodeInfo represents a short summary of the information known about the host. type NodeInfo struct { - ID string `json:"id"` // Unique node identifier (also the encryption key) - Name string `json:"name"` // Name of the node, including client type, version, OS, custom data - Enode string `json:"enode"` // Enode URL for adding this peer from remote peers - ENR string `json:"enr"` // Ethereum Node Record - IP string `json:"ip"` // IP address of the node - Ports struct { - Discovery int `json:"discovery"` // UDP listening port for discovery protocol - Listener int `json:"listener"` // TCP listening port for RLPx - } `json:"ports"` + ID string `json:"id"` // Unique node identifier (also the encryption key) + Name string `json:"name"` // Name of the node, including client type, version, OS, custom data + Enode string `json:"enode"` // Enode URL for adding this peer from remote peers + ENR string `json:"enr"` // Ethereum Node Record + IP string `json:"ip"` // IP address of the node + Ports NodeInfoPorts `json:"ports"` ListenAddr string `json:"listenAddr"` Protocols map[string]interface{} `json:"protocols"` } +type NodeInfoPorts struct { + Discovery int `json:"discovery"` // UDP listening port for discovery protocol + Listener int `json:"listener"` // TCP listening port for RLPx +} + // NodeInfo gathers and returns a collection of metadata known about the host. func (srv *Server) NodeInfo() *NodeInfo { // Gather and assemble the generic node infos diff --git a/params/bootnodes_kotti.go b/params/bootnodes_kotti.go index 5fc6dbc003..582851be9f 100644 --- a/params/bootnodes_kotti.go +++ b/params/bootnodes_kotti.go @@ -18,14 +18,14 @@ package params // KottiBootnodes are the enode URLs of the P2P bootstrap nodes running on the // Kotti test network. var KottiBootnodes = []string{ - "enode://06333009fc9ef3c9e174768e495722a7f98fe7afd4660542e983005f85e556028410fd03278944f44cfe5437b1750b5e6bd1738f700fe7da3626d52010d2954c@51.141.15.254:30303", // @paritytech authority + "enode://06333009fc9ef3c9e174768e495722a7f98fe7afd4660542e983005f85e556028410fd03278944f44cfe5437b1750b5e6bd1738f700fe7da3626d52010d2954c@51.141.15.254:30303", // @paritytech authority "enode://ae8658da8d255d1992c3ec6e62e11d6e1c5899aa1566504bc1ff96a0c9c8bd44838372be643342553817f5cc7d78f1c83a8093dee13d77b3b0a583c050c81940@18.232.185.151:30303", "enode://67913271d14f445689e8310270c304d42f268428f2de7a4ac0275bea97690e021df6f549f462503ff4c7a81d9dd27288867bbfa2271477d0911378b8944fae55@157.230.239.163:30303", "enode://e8a786a894db053fe6886e283fc4385389ad034e04a692a26335f30b714059efd5cead0e410ecd783ce095888fdafcc21a685f13501594e969d6f5ac7ba0388c@86.103.236.55:63384", - "enode://4956f6924335c951cb70cbc169a85c081f6ff0b374aa2815453b8a3132b49613f38a1a6b8e103f878dbec86364f60091e92a376d7cd3aca9d82d2f2554794e63@51.15.97.240:41235", // @q9f core-geth ginan - "enode://6c9a052c01bb9995fa53bebfcdbc17733fe90708270d0e6d8e38dc57b32e1dbe8c287590b634ee9753b94ba302f411c96519c7fa07df0df6a6848149d819b2c5@51.15.70.7:41235", // @q9f core-geth polis - "enode://95a7302fd8f35d9ad716a591b90dfe839dbf2d3d6a6737ef39e07899f844ad82f1659dd6212492922dd36705fb0a1e984c1d5d5c42069d5bd329388831e820c1@51.15.97.240:45678", // @q9f parity ginan - "enode://8c5c4dec9a0728c7058d3c29698bae888adc244e443cebc21f3d708a20751511acbf98a52b5e5ea472f8715c658913e8084123461fd187a4980a0600420b0791@51.15.70.7:45678", // @q9f parity polis + "enode://4956f6924335c951cb70cbc169a85c081f6ff0b374aa2815453b8a3132b49613f38a1a6b8e103f878dbec86364f60091e92a376d7cd3aca9d82d2f2554794e63@51.15.97.240:41235", // @q9f core-geth ginan + "enode://6c9a052c01bb9995fa53bebfcdbc17733fe90708270d0e6d8e38dc57b32e1dbe8c287590b634ee9753b94ba302f411c96519c7fa07df0df6a6848149d819b2c5@51.15.70.7:41235", // @q9f core-geth polis + "enode://95a7302fd8f35d9ad716a591b90dfe839dbf2d3d6a6737ef39e07899f844ad82f1659dd6212492922dd36705fb0a1e984c1d5d5c42069d5bd329388831e820c1@51.15.97.240:45678", // @q9f parity ginan + "enode://8c5c4dec9a0728c7058d3c29698bae888adc244e443cebc21f3d708a20751511acbf98a52b5e5ea472f8715c658913e8084123461fd187a4980a0600420b0791@51.15.70.7:45678", // @q9f parity polis "enode://efd7391a3bed73ad74ae5760319bb48f9c9f1983ff22964422688cdb426c5d681004ece26c47121396653cf9bafe7104aa4ecff70e24cc5b11fd76be8e5afce0@51.158.191.43:45678", // @q9f besu mizar } diff --git a/rpc/client_test.go b/rpc/client_test.go index 1d87d96671..8a996aeda5 100644 --- a/rpc/client_test.go +++ b/rpc/client_test.go @@ -413,15 +413,14 @@ func TestClientHTTP(t *testing.T) { // Launch concurrent requests. var ( results = make([]echoResult, 100) - errc = make(chan error) + errc = make(chan error, len(results)) wantResult = echoResult{"a", 1, new(echoArgs)} ) defer client.Close() for i := range results { i := i go func() { - errc <- client.Call(&results[i], "test_echo", - wantResult.String, wantResult.Int, wantResult.Args) + errc <- client.Call(&results[i], "test_echo", wantResult.String, wantResult.Int, wantResult.Args) }() } diff --git a/rpc/endpoints.go b/rpc/endpoints.go index ed295adfc0..9fc0705172 100644 --- a/rpc/endpoints.go +++ b/rpc/endpoints.go @@ -22,89 +22,6 @@ import ( "github.com/ethereum/go-ethereum/log" ) -// checkModuleAvailability check that all names given in modules are actually -// available API services. -func checkModuleAvailability(modules []string, apis []API) (bad, available []string) { - availableSet := make(map[string]struct{}) - for _, api := range apis { - if _, ok := availableSet[api.Namespace]; !ok { - availableSet[api.Namespace] = struct{}{} - available = append(available, api.Namespace) - } - } - for _, name := range modules { - if _, ok := availableSet[name]; !ok { - bad = append(bad, name) - } - } - return bad, available -} - -// StartHTTPEndpoint starts the HTTP RPC endpoint, configured with cors/vhosts/modules. -func StartHTTPEndpoint(endpoint string, apis []API, modules []string, cors []string, vhosts []string, timeouts HTTPTimeouts) (net.Listener, *Server, error) { - if bad, available := checkModuleAvailability(modules, apis); len(bad) > 0 { - log.Error("Unavailable modules in HTTP API list", "unavailable", bad, "available", available) - } - // Generate the whitelist based on the allowed modules - whitelist := make(map[string]bool) - for _, module := range modules { - whitelist[module] = true - } - // Register all the APIs exposed by the services - handler := NewServer() - for _, api := range apis { - if whitelist[api.Namespace] || (len(whitelist) == 0 && api.Public) { - if err := handler.RegisterName(api.Namespace, api.Service); err != nil { - return nil, nil, err - } - log.Debug("HTTP registered", "namespace", api.Namespace) - } - } - // All APIs registered, start the HTTP listener - var ( - listener net.Listener - err error - ) - if listener, err = net.Listen("tcp", endpoint); err != nil { - return nil, nil, err - } - go NewHTTPServer(cors, vhosts, timeouts, handler).Serve(listener) - return listener, handler, err -} - -// StartWSEndpoint starts a websocket endpoint. -func StartWSEndpoint(endpoint string, apis []API, modules []string, wsOrigins []string, exposeAll bool) (net.Listener, *Server, error) { - if bad, available := checkModuleAvailability(modules, apis); len(bad) > 0 { - log.Error("Unavailable modules in WS API list", "unavailable", bad, "available", available) - } - // Generate the whitelist based on the allowed modules - whitelist := make(map[string]bool) - for _, module := range modules { - whitelist[module] = true - } - // Register all the APIs exposed by the services - handler := NewServer() - for _, api := range apis { - if exposeAll || whitelist[api.Namespace] || (len(whitelist) == 0 && api.Public) { - if err := handler.RegisterName(api.Namespace, api.Service); err != nil { - return nil, nil, err - } - log.Debug("WebSocket registered", "service", api.Service, "namespace", api.Namespace) - } - } - // All APIs registered, start the HTTP listener - var ( - listener net.Listener - err error - ) - if listener, err = net.Listen("tcp", endpoint); err != nil { - return nil, nil, err - } - go NewWSServer(wsOrigins, handler).Serve(listener) - return listener, handler, err - -} - // StartIPCEndpoint starts an IPC endpoint. func StartIPCEndpoint(ipcEndpoint string, apis []API) (net.Listener, *Server, error) { // Register all the APIs exposed by the services. diff --git a/rpc/handler.go b/rpc/handler.go index ab32cf47e4..c8571ad795 100644 --- a/rpc/handler.go +++ b/rpc/handler.go @@ -327,8 +327,22 @@ func (h *handler) handleCall(cp *callProc, msg *jsonrpcMessage) *jsonrpcMessage if err != nil { return msg.errorResponse(&invalidParamsError{err.Error()}) } - - return h.runMethod(cp.ctx, msg, callb, args) + start := time.Now() + answer := h.runMethod(cp.ctx, msg, callb, args) + + // Collect the statistics for RPC calls if metrics is enabled. + // We only care about pure rpc call. Filter out subscription. + if callb != h.unsubscribeCb { + rpcRequestGauge.Inc(1) + if answer.Error != nil { + failedReqeustGauge.Inc(1) + } else { + successfulRequestGauge.Inc(1) + } + rpcServingTimer.UpdateSince(start) + newRPCServingTimer(msg.Method, answer.Error == nil).UpdateSince(start) + } + return answer } // handleSubscribe processes *_subscribe method calls. diff --git a/rpc/http.go b/rpc/http.go index 40810c7b44..b3ce0a5b5e 100644 --- a/rpc/http.go +++ b/rpc/http.go @@ -25,14 +25,9 @@ import ( "io" "io/ioutil" "mime" - "net" "net/http" - "strings" "sync" "time" - - "github.com/ethereum/go-ethereum/log" - "github.com/rs/cors" ) const ( @@ -209,37 +204,6 @@ func (t *httpServerConn) RemoteAddr() string { // SetWriteDeadline does nothing and always returns nil. func (t *httpServerConn) SetWriteDeadline(time.Time) error { return nil } -// NewHTTPServer creates a new HTTP RPC server around an API provider. -// -// Deprecated: Server implements http.Handler -func NewHTTPServer(cors []string, vhosts []string, timeouts HTTPTimeouts, srv http.Handler) *http.Server { - // Wrap the CORS-handler within a host-handler - handler := newCorsHandler(srv, cors) - handler = newVHostHandler(vhosts, handler) - handler = newGzipHandler(handler) - - // Make sure timeout values are meaningful - if timeouts.ReadTimeout < time.Second { - log.Warn("Sanitizing invalid HTTP read timeout", "provided", timeouts.ReadTimeout, "updated", DefaultHTTPTimeouts.ReadTimeout) - timeouts.ReadTimeout = DefaultHTTPTimeouts.ReadTimeout - } - if timeouts.WriteTimeout < time.Second { - log.Warn("Sanitizing invalid HTTP write timeout", "provided", timeouts.WriteTimeout, "updated", DefaultHTTPTimeouts.WriteTimeout) - timeouts.WriteTimeout = DefaultHTTPTimeouts.WriteTimeout - } - if timeouts.IdleTimeout < time.Second { - log.Warn("Sanitizing invalid HTTP idle timeout", "provided", timeouts.IdleTimeout, "updated", DefaultHTTPTimeouts.IdleTimeout) - timeouts.IdleTimeout = DefaultHTTPTimeouts.IdleTimeout - } - // Bundle and start the HTTP server - return &http.Server{ - Handler: handler, - ReadTimeout: timeouts.ReadTimeout, - WriteTimeout: timeouts.WriteTimeout, - IdleTimeout: timeouts.IdleTimeout, - } -} - // ServeHTTP serves JSON-RPC requests over HTTP. func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request) { // Permit dumb empty requests for remote health-checks (AWS) @@ -250,8 +214,8 @@ func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request) { http.Error(w, err.Error(), code) return } - // All checks passed, create a codec that reads direct from the request body - // until EOF, write the response to w, and order the server to process a + // All checks passed, create a codec that reads directly from the request body + // until EOF, writes the response to w, and orders the server to process a // single request. ctx := r.Context() ctx = context.WithValue(ctx, "remote", r.RemoteAddr) @@ -296,64 +260,3 @@ func validateRequest(r *http.Request) (int, error) { err := fmt.Errorf("invalid content type, only %s is supported", contentType) return http.StatusUnsupportedMediaType, err } - -func newCorsHandler(srv http.Handler, allowedOrigins []string) http.Handler { - // disable CORS support if user has not specified a custom CORS configuration - if len(allowedOrigins) == 0 { - return srv - } - c := cors.New(cors.Options{ - AllowedOrigins: allowedOrigins, - AllowedMethods: []string{http.MethodPost, http.MethodGet}, - MaxAge: 600, - AllowedHeaders: []string{"*"}, - }) - return c.Handler(srv) -} - -// virtualHostHandler is a handler which validates the Host-header of incoming requests. -// The virtualHostHandler can prevent DNS rebinding attacks, which do not utilize CORS-headers, -// since they do in-domain requests against the RPC api. Instead, we can see on the Host-header -// which domain was used, and validate that against a whitelist. -type virtualHostHandler struct { - vhosts map[string]struct{} - next http.Handler -} - -// ServeHTTP serves JSON-RPC requests over HTTP, implements http.Handler -func (h *virtualHostHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) { - // if r.Host is not set, we can continue serving since a browser would set the Host header - if r.Host == "" { - h.next.ServeHTTP(w, r) - return - } - host, _, err := net.SplitHostPort(r.Host) - if err != nil { - // Either invalid (too many colons) or no port specified - host = r.Host - } - if ipAddr := net.ParseIP(host); ipAddr != nil { - // It's an IP address, we can serve that - h.next.ServeHTTP(w, r) - return - - } - // Not an IP address, but a hostname. Need to validate - if _, exist := h.vhosts["*"]; exist { - h.next.ServeHTTP(w, r) - return - } - if _, exist := h.vhosts[host]; exist { - h.next.ServeHTTP(w, r) - return - } - http.Error(w, "invalid host specified", http.StatusForbidden) -} - -func newVHostHandler(vhosts []string, next http.Handler) http.Handler { - vhostMap := make(map[string]struct{}) - for _, allowedHost := range vhosts { - vhostMap[strings.ToLower(allowedHost)] = struct{}{} - } - return &virtualHostHandler{vhostMap, next} -} diff --git a/rpc/json.go b/rpc/json.go index 980574ed7e..61631a3d76 100644 --- a/rpc/json.go +++ b/rpc/json.go @@ -31,6 +31,7 @@ import ( const ( vsn = "2.0" + serviceMethodSeparator = "_" subscribeMethodSuffix = "_subscribe" unsubscribeMethodSuffix = "_unsubscribe" notificationMethodSuffix = "_subscription" @@ -38,20 +39,7 @@ const ( defaultWriteTimeout = 10 * time.Second // used if context has no deadline ) -var ( - null = json.RawMessage("null") - serviceMethodSeparators = []string{"_", "."} - errInvalidMethodName = errors.New("invalid method name") -) - -func elementizeMethodName(methodName string) (module, method string, err error) { - for _, sep := range serviceMethodSeparators { - if s := strings.SplitN(methodName, sep, 2); len(s) == 2 { - return s[0], s[1], nil - } - } - return "", "", errInvalidMethodName -} +var null = json.RawMessage("null") type subscriptionResult struct { ID string `json:"subscription"` @@ -94,8 +82,8 @@ func (msg *jsonrpcMessage) isUnsubscribe() bool { } func (msg *jsonrpcMessage) namespace() string { - module, _, _ := elementizeMethodName(msg.Method) - return module // even if err != nil, empty string is returned so err can be ignored + elem := strings.SplitN(msg.Method, serviceMethodSeparator, 2) + return elem[0] } func (msg *jsonrpcMessage) String() string { diff --git a/rpc/openrpc.go b/rpc/metrics.go similarity index 54% rename from rpc/openrpc.go rename to rpc/metrics.go index fce062fbd2..7fb6fc0a17 100644 --- a/rpc/openrpc.go +++ b/rpc/metrics.go @@ -1,4 +1,4 @@ -// Copyright 2019 The go-ethereum Authors +// Copyright 2020 The go-ethereum Authors // This file is part of the go-ethereum library. // // The go-ethereum library is free software: you can redistribute it and/or modify @@ -16,10 +16,24 @@ package rpc -type OpenRPCDiscoverSchemaT struct { - OpenRPC string `json:"openrpc"` - Info map[string]interface{} `json:"info"` - Servers []map[string]interface{} `json:"servers"` - Methods []map[string]interface{} `json:"methods"` - Components map[string]interface{} `json:"components"` +import ( + "fmt" + + "github.com/ethereum/go-ethereum/metrics" +) + +var ( + rpcRequestGauge = metrics.NewRegisteredGauge("rpc/requests", nil) + successfulRequestGauge = metrics.NewRegisteredGauge("rpc/success", nil) + failedReqeustGauge = metrics.NewRegisteredGauge("rpc/failure", nil) + rpcServingTimer = metrics.NewRegisteredTimer("rpc/duration/all", nil) +) + +func newRPCServingTimer(method string, valid bool) metrics.Timer { + flag := "success" + if !valid { + flag = "failure" + } + m := fmt.Sprintf("rpc/duration/%s/%s", method, flag) + return metrics.GetOrRegisterTimer(m, nil) } diff --git a/rpc/server.go b/rpc/server.go index 9d9eeb7641..94ca967b71 100644 --- a/rpc/server.go +++ b/rpc/server.go @@ -18,9 +18,6 @@ package rpc import ( "context" - "encoding/json" - "errors" - "fmt" "io" "sync/atomic" @@ -30,16 +27,6 @@ import ( const MetadataApi = "rpc" -var ( - // defaultOpenRPCSchemaRaw can be used to establish a default (package-wide) OpenRPC schema from raw JSON. - // Methods will be cross referenced with actual registered method names in order to serve - // only server-enabled methods, enabling user and on-the-fly server endpoint availability configuration. - defaultOpenRPCSchemaRaw string - - errOpenRPCDiscoverUnavailable = errors.New("openrpc discover data unavailable") - errOpenRPCDiscoverSchemaInvalid = errors.New("openrpc discover data invalid") -) - // CodecOption specifies which type of messages a codec supports. // // Deprecated: this option is no longer honored by Server. @@ -55,55 +42,22 @@ const ( // Server is an RPC server. type Server struct { - services serviceRegistry - idgen func() ID - run int32 - codecs mapset.Set - OpenRPCSchemaRaw string + services serviceRegistry + idgen func() ID + run int32 + codecs mapset.Set } // NewServer creates a new server instance with no registered handlers. func NewServer() *Server { - server := &Server{ - idgen: randomIDGenerator(), - codecs: mapset.NewSet(), - run: 1, - OpenRPCSchemaRaw: defaultOpenRPCSchemaRaw, - } + server := &Server{idgen: randomIDGenerator(), codecs: mapset.NewSet(), run: 1} + // Register the default service providing meta information about the RPC service such // as the services and methods it offers. - rpcService := &RPCService{server: server} + rpcService := &RPCService{server} server.RegisterName(MetadataApi, rpcService) - return server -} - -func validateOpenRPCSchemaRaw(schemaJSON string) error { - if schemaJSON == "" { - return errOpenRPCDiscoverSchemaInvalid - } - var schema OpenRPCDiscoverSchemaT - if err := json.Unmarshal([]byte(schemaJSON), &schema); err != nil { - return fmt.Errorf("%v: %v", errOpenRPCDiscoverSchemaInvalid, err) - } - return nil -} -// SetDefaultOpenRPCSchemaRaw validates and sets the package-wide OpenRPC schema data. -func SetDefaultOpenRPCSchemaRaw(schemaJSON string) error { - if err := validateOpenRPCSchemaRaw(schemaJSON); err != nil { - return err - } - defaultOpenRPCSchemaRaw = schemaJSON - return nil -} - -// SetOpenRPCSchemaRaw validates and sets the raw OpenRPC schema data for a server. -func (s *Server) SetOpenRPCSchemaRaw(schemaJSON string) error { - if err := validateOpenRPCSchemaRaw(schemaJSON); err != nil { - return err - } - s.OpenRPCSchemaRaw = schemaJSON - return nil + return server } // RegisterName creates a service for the given receiver type under the given name. When no @@ -111,7 +65,11 @@ func (s *Server) SetOpenRPCSchemaRaw(schemaJSON string) error { // subscription an error is returned. Otherwise a new service is created and added to the // service collection this server provides to clients. func (s *Server) RegisterName(name string, receiver interface{}) error { - return s.services.registerName(name, receiver) + err := s.services.registerName(name, receiver) + if err != nil { + return err + } + return nil } // ServeCodec reads incoming requests from codec, calls the appropriate callback and writes @@ -193,66 +151,3 @@ func (s *RPCService) Modules() map[string]string { } return modules } - -func (s *RPCService) methods() map[string][]string { - s.server.services.mu.Lock() - defer s.server.services.mu.Unlock() - - methods := make(map[string][]string) - for name, ser := range s.server.services.services { - for s := range ser.callbacks { - _, ok := methods[name] - if !ok { - methods[name] = []string{s} - } else { - methods[name] = append(methods[name], s) - } - } - } - return methods -} - -// Discover returns a configured schema that is audited for actual server availability. -// Only methods that the server makes available are included in the 'methods' array of -// the discover schema. Components are not audited. -func (s *RPCService) Discover() (schema *OpenRPCDiscoverSchemaT, err error) { - if s.server.OpenRPCSchemaRaw == "" { - return nil, errOpenRPCDiscoverUnavailable - } - schema = &OpenRPCDiscoverSchemaT{ - Servers: make([]map[string]interface{}, 0), - } - err = json.Unmarshal([]byte(s.server.OpenRPCSchemaRaw), schema) - if err != nil { - log.Crit("openrpc json umarshal", "error", err) - } - - // Audit documented schema methods vs. actual server availability - // This removes methods described in the OpenRPC JSON schema document - // which are not currently exposed on the server's API. - // This is done on the fly (as opposed to at servre init or schema setting) - // because it's possible that exposed APIs could be modified in proc. - schemaMethodsAvailable := []map[string]interface{}{} - serverMethodsAvailable := s.methods() - - for _, m := range schema.Methods { - module, path, err := elementizeMethodName(m["name"].(string)) - if err != nil { - return nil, err - } - paths, ok := serverMethodsAvailable[module] - if !ok { - continue - } - - // the module exists, does the path exist? - for _, pa := range paths { - if pa == path { - schemaMethodsAvailable = append(schemaMethodsAvailable, m) - break - } - } - } - schema.Methods = schemaMethodsAvailable - return -} diff --git a/rpc/service.go b/rpc/service.go index 58e5265e7d..bef891ea11 100644 --- a/rpc/service.go +++ b/rpc/service.go @@ -22,6 +22,7 @@ import ( "fmt" "reflect" "runtime" + "strings" "sync" "unicode" @@ -93,13 +94,13 @@ func (r *serviceRegistry) registerName(name string, rcvr interface{}) error { // callback returns the callback corresponding to the given RPC method name. func (r *serviceRegistry) callback(method string) *callback { - module, mthd, err := elementizeMethodName(method) - if err != nil { + elem := strings.SplitN(method, serviceMethodSeparator, 2) + if len(elem) != 2 { return nil } r.mu.Lock() defer r.mu.Unlock() - return r.services[module].callbacks[mthd] + return r.services[elem[0]].callbacks[elem[1]] } // subscription returns a subscription callback in the given service. diff --git a/rpc/subscription.go b/rpc/subscription.go index 8992bfc5e1..f9d60dcb98 100644 --- a/rpc/subscription.go +++ b/rpc/subscription.go @@ -153,7 +153,7 @@ func (n *Notifier) takeSubscription() *Subscription { return n.sub } -// acticate is called after the subscription ID was sent to client. Notifications are +// activate is called after the subscription ID was sent to client. Notifications are // buffered before activation. This prevents notifications being sent to the client before // the subscription ID is sent to the client. func (n *Notifier) activate() error { @@ -179,7 +179,7 @@ func (n *Notifier) send(sub *Subscription, data json.RawMessage) error { }) } -// A Subscription is created by a notifier and tight to that notifier. The client can use +// A Subscription is created by a notifier and tied to that notifier. The client can use // this subscription to wait for an unsubscribe request for the client, see Err(). type Subscription struct { ID ID diff --git a/rpc/subscription_test.go b/rpc/subscription_test.go index c3a918a832..54a053dba8 100644 --- a/rpc/subscription_test.go +++ b/rpc/subscription_test.go @@ -125,22 +125,25 @@ func TestSubscriptions(t *testing.T) { // This test checks that unsubscribing works. func TestServerUnsubscribe(t *testing.T) { + p1, p2 := net.Pipe() + defer p2.Close() + // Start the server. server := newTestServer() - service := ¬ificationTestService{unsubscribed: make(chan string)} + service := ¬ificationTestService{unsubscribed: make(chan string, 1)} server.RegisterName("nftest2", service) - p1, p2 := net.Pipe() go server.ServeCodec(NewCodec(p1), 0) - p2.SetDeadline(time.Now().Add(10 * time.Second)) - // Subscribe. + p2.SetDeadline(time.Now().Add(10 * time.Second)) p2.Write([]byte(`{"jsonrpc":"2.0","id":1,"method":"nftest2_subscribe","params":["someSubscription",0,10]}`)) // Handle received messages. - resps := make(chan subConfirmation) - notifications := make(chan subscriptionResult) - errors := make(chan error) + var ( + resps = make(chan subConfirmation) + notifications = make(chan subscriptionResult) + errors = make(chan error, 1) + ) go waitForMessages(json.NewDecoder(p2), resps, notifications, errors) // Receive the subscription ID. @@ -173,34 +176,45 @@ type subConfirmation struct { subid ID } +// waitForMessages reads RPC messages from 'in' and dispatches them into the given channels. +// It stops if there is an error. func waitForMessages(in *json.Decoder, successes chan subConfirmation, notifications chan subscriptionResult, errors chan error) { for { - var msg jsonrpcMessage - if err := in.Decode(&msg); err != nil { - errors <- fmt.Errorf("decode error: %v", err) + resp, notification, err := readAndValidateMessage(in) + if err != nil { + errors <- err return + } else if resp != nil { + successes <- *resp + } else { + notifications <- *notification } - switch { - case msg.isNotification(): - var res subscriptionResult - if err := json.Unmarshal(msg.Params, &res); err != nil { - errors <- fmt.Errorf("invalid subscription result: %v", err) - } else { - notifications <- res - } - case msg.isResponse(): - var c subConfirmation - if msg.Error != nil { - errors <- msg.Error - } else if err := json.Unmarshal(msg.Result, &c.subid); err != nil { - errors <- fmt.Errorf("invalid response: %v", err) - } else { - json.Unmarshal(msg.ID, &c.reqid) - successes <- c - } - default: - errors <- fmt.Errorf("unrecognized message: %v", msg) - return + } +} + +func readAndValidateMessage(in *json.Decoder) (*subConfirmation, *subscriptionResult, error) { + var msg jsonrpcMessage + if err := in.Decode(&msg); err != nil { + return nil, nil, fmt.Errorf("decode error: %v", err) + } + switch { + case msg.isNotification(): + var res subscriptionResult + if err := json.Unmarshal(msg.Params, &res); err != nil { + return nil, nil, fmt.Errorf("invalid subscription result: %v", err) + } + return nil, &res, nil + case msg.isResponse(): + var c subConfirmation + if msg.Error != nil { + return nil, nil, msg.Error + } else if err := json.Unmarshal(msg.Result, &c.subid); err != nil { + return nil, nil, fmt.Errorf("invalid response: %v", err) + } else { + json.Unmarshal(msg.ID, &c.reqid) + return &c, nil, nil } + default: + return nil, nil, fmt.Errorf("unrecognized message: %v", msg) } } diff --git a/rpc/websocket.go b/rpc/websocket.go index b7ec56c6a6..6e37b8522d 100644 --- a/rpc/websocket.go +++ b/rpc/websocket.go @@ -38,13 +38,6 @@ const ( var wsBufferPool = new(sync.Pool) -// NewWSServer creates a new websocket RPC server around an API provider. -// -// Deprecated: use Server.WebsocketHandler -func NewWSServer(allowedOrigins []string, srv *Server) *http.Server { - return &http.Server{Handler: srv.WebsocketHandler(allowedOrigins)} -} - // WebsocketHandler returns a handler that serves JSON-RPC to WebSocket connections. // // allowedOrigins should be a comma-separated list of allowed origin URLs. diff --git a/rpc/websocket_test.go b/rpc/websocket_test.go index f2a8438d7c..f54fc3cd54 100644 --- a/rpc/websocket_test.go +++ b/rpc/websocket_test.go @@ -142,6 +142,7 @@ func TestClientWebsocketPing(t *testing.T) { // Wait for the subscription result. timeout := time.NewTimer(5 * time.Second) + defer timeout.Stop() for { select { case err := <-sub.Err(): @@ -227,9 +228,11 @@ func wsPingTestHandler(t *testing.T, conn *websocket.Conn, shutdown, sendPing <- // Write messages. var ( - sendResponse <-chan time.Time - wantPong string + wantPong string + timer = time.NewTimer(0) ) + defer timer.Stop() + <-timer.C for { select { case _, open := <-sendPing: @@ -246,11 +249,10 @@ func wsPingTestHandler(t *testing.T, conn *websocket.Conn, shutdown, sendPing <- t.Errorf("got pong with wrong data %q", data) } wantPong = "" - sendResponse = time.NewTimer(200 * time.Millisecond).C - case <-sendResponse: + timer.Reset(200 * time.Millisecond) + case <-timer.C: t.Logf("server sending response") conn.WriteMessage(websocket.TextMessage, []byte(subNotify)) - sendResponse = nil case <-shutdown: conn.Close() return diff --git a/rpc_describe.log b/rpc_describe.log new file mode 100644 index 0000000000..fe52868ec9 --- /dev/null +++ b/rpc_describe.log @@ -0,0 +1,8955 @@ +{ + "jsonrpc": "2.0", + "id": 1584386007, + "result": { + "openrpc": "1.2.4", + "info": { + "title": "Ethereum JSON-RPC", + "description": "This API lets you interact with an EVM-based client via JSON-RPC", + "termsOfService": "https://github.com/etclabscore/core-geth/blob/master/COPYING", + "contact": { + "name": "", + "url": "", + "email": "" + }, + "license": { + "name": "Apache-2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" + }, + "version": "1.0.10" + }, + "servers": [ + { + "name": "tcp", + "url": "127.0.0.1:8545", + "summary": "", + "description": "CoreGeth/v1.11.2-unstable", + "variables": null + } + ], + "methods": [ + { + "name": "admin_addPeer", + "tags": [], + "summary": "AddPeer requests connecting to a remote node, and also maintaining the new\nconnection at all times, even reconnecting if it is lost.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).AddPeer", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:45" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "admin_addPeerResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_addTrustedPeer", + "tags": [], + "summary": "AddTrustedPeer allows a remote node to always connect, even if slots are full\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).AddTrustedPeer", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:77" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "admin_addTrustedPeerResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_datadir", + "tags": [], + "summary": "Datadir retrieves the current data directory the node is using.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PublicAdminAPI).Datadir", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:295" + }, + "params": [], + "result": { + "name": "admin_datadirResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_exportChain", + "tags": [], + "summary": "ExportChain exports the current blockchain into a local file,\nor a range of blocks if first and last are non-nil\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateAdminAPI).ExportChain", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:171" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "first", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + { + "name": "last", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "admin_exportChainResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_importChain", + "tags": [], + "summary": "ImportChain imports a blockchain from a local file.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateAdminAPI).ImportChain", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:219" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "admin_importChainResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_nodeInfo", + "tags": [], + "summary": "NodeInfo retrieves all the information we know about the host node at the\nprotocol granularity.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PublicAdminAPI).NodeInfo", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:285" + }, + "params": [], + "result": { + "name": "admin_nodeInfoResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/p2p:NodeInfo", + "definitions": { + "": { + "type": "object", + "required": ["discovery", "listener"], + "properties": { + "discovery": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "listener": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + }, + "NodeInfo": { + "type": "object", + "required": [ + "id", + "name", + "enode", + "enr", + "ip", + "ports", + "listenAddr", + "protocols" + ], + "properties": { + "enode": { + "type": "string" + }, + "enr": { + "type": "string" + }, + "id": { + "type": "string" + }, + "ip": { + "type": "string" + }, + "listenAddr": { + "type": "string" + }, + "name": { + "type": "string" + }, + "ports": { + "$ref": "#/definitions/", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "protocols": { + "$ref": "#/definitions/" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/NodeInfo", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_peers", + "tags": [], + "summary": "Peers retrieves all the information we know about each individual peer at the\nprotocol granularity.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PublicAdminAPI).Peers", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:275" + }, + "params": [], + "result": { + "name": "admin_peersResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/PeerInfo", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "definitions": { + "": { + "type": "object", + "required": [ + "localAddress", + "remoteAddress", + "inbound", + "trusted", + "static" + ], + "properties": { + "inbound": { + "type": "boolean" + }, + "localAddress": { + "type": "string" + }, + "remoteAddress": { + "type": "string" + }, + "static": { + "type": "boolean" + }, + "trusted": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "PeerInfo": { + "type": "object", + "required": [ + "enode", + "id", + "name", + "caps", + "network", + "protocols" + ], + "properties": { + "caps": { + "type": "array", + "items": { + "type": "string" + } + }, + "enode": { + "type": "string" + }, + "enr": { + "type": "string" + }, + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "network": { + "$ref": "#/definitions/", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "protocols": { + "$ref": "#/definitions/" + } + }, + "additionalProperties": false + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_removePeer", + "tags": [], + "summary": "RemovePeer disconnects from a remote node if the connection exists\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).RemovePeer", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:61" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "admin_removePeerResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_removeTrustedPeer", + "tags": [], + "summary": "RemoveTrustedPeer removes a remote node from the trusted peer set, but it\ndoes not disconnect it automatically.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).RemoveTrustedPeer", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:93" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "admin_removeTrustedPeerResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_startRPC", + "tags": [], + "summary": "StartRPC starts the HTTP RPC API server.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).StartRPC", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:146" + }, + "params": [ + { + "name": "host", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:string", + "type": "string" + } + }, + { + "name": "port", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + { + "name": "cors", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:string", + "type": "string" + } + }, + { + "name": "apis", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:string", + "type": "string" + } + }, + { + "name": "vhosts", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:string", + "type": "string" + } + } + ], + "result": { + "name": "admin_startRPCResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_startWS", + "tags": [], + "summary": "StartWS starts the websocket RPC API server.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).StartWS", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:208" + }, + "params": [ + { + "name": "host", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:string", + "type": "string" + } + }, + { + "name": "port", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + { + "name": "allowedOrigins", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:string", + "type": "string" + } + }, + { + "name": "apis", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:string", + "type": "string" + } + } + ], + "result": { + "name": "admin_startWSResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_stopRPC", + "tags": [], + "summary": "StopRPC terminates an already running HTTP RPC API endpoint.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).StopRPC", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:196" + }, + "params": [], + "result": { + "name": "admin_stopRPCResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "admin_stopWS", + "tags": [], + "summary": "StopWS terminates an already running websocket RPC API endpoint.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PrivateAdminAPI).StopWS", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:250" + }, + "params": [], + "result": { + "name": "admin_stopWSResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_accountRange", + "tags": [], + "summary": "AccountRange enumerates all accounts in the latest state\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).AccountRange", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:395" + }, + "params": [ + { + "name": "start", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "maxResults", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "debug_accountRangeResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/eth:AccountRangeResult", + "definitions": { + "AccountRangeResult": { + "type": "object", + "required": ["accounts", "next"], + "properties": { + "accounts": { + "type": "object", + "patternProperties": { + ".*": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + }, + "next": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/AccountRangeResult", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_backtraceAt", + "tags": [], + "summary": "BacktraceAt sets the log backtrace location. See package log for details on\nthe pattern syntax.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).BacktraceAt", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:68" + }, + "params": [ + { + "name": "location", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_blockProfile", + "tags": [], + "summary": "BlockProfile turns on goroutine profiling for nsec seconds and writes profile data to\nfile. It uses a profile rate of 1 for most accurate information. If a different rate is\ndesired, set the rate and write the profile manually.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).BlockProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:147" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "nsec", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_chaindbCompact", + "tags": [], + "summary": "ChaindbCompact flattens the entire key-value database into a single level,\nremoving all unused slots and merging all keys.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateDebugAPI).ChaindbCompact", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1759" + }, + "params": [], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_chaindbProperty", + "tags": [], + "summary": "ChaindbProperty returns leveldb properties of the key-value database.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateDebugAPI).ChaindbProperty", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1748" + }, + "params": [ + { + "name": "property", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "debug_chaindbPropertyResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_cpuProfile", + "tags": [], + "summary": "CpuProfile turns on CPU profiling for nsec seconds and writes\nprofile data to file.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).CpuProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:88" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "nsec", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_dumpBlock", + "tags": [], + "summary": "DumpBlock retrieves the entire state of the database at a given block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PublicDebugAPI).DumpBlock", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:280" + }, + "params": [ + { + "name": "blockNr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Block tag or hex representation of a block number", + "title": "blockNumberOrTag", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + } + ] + } + } + ], + "result": { + "name": "debug_dumpBlockResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/core/state:state.Dump", + "definitions": { + "Dump": { + "type": "object", + "required": ["root", "accounts"], + "properties": { + "accounts": { + "type": "object", + "patternProperties": { + ".*": { + "$ref": "#/definitions/DumpAccount", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + }, + "root": { + "type": "string" + } + }, + "additionalProperties": false + }, + "DumpAccount": { + "type": "object", + "required": ["balance", "nonce", "root", "codeHash"], + "properties": { + "address": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "balance": { + "type": "string" + }, + "code": { + "type": "string" + }, + "codeHash": { + "type": "string" + }, + "key": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "root": { + "type": "string" + }, + "storage": { + "type": "object", + "patternProperties": { + ".*": { + "type": "string" + } + } + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/Dump", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_freeOSMemory", + "tags": [], + "summary": "FreeOSMemory returns unused memory to the OS.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).FreeOSMemory", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:200" + }, + "params": [], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_gcStats", + "tags": [], + "summary": "GcStats returns GC statistics.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).GcStats", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:80" + }, + "params": [], + "result": { + "name": "debug_gcStatsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*runtime/debug:GCStats", + "definitions": { + "GCStats": { + "type": "object", + "required": [ + "LastGC", + "NumGC", + "PauseTotal", + "Pause", + "PauseEnd", + "PauseQuantiles" + ], + "properties": { + "LastGC": { + "type": "string", + "format": "date-time" + }, + "NumGC": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Pause": { + "type": "array", + "items": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "PauseEnd": { + "type": "array", + "items": { + "type": "string", + "format": "date-time" + } + }, + "PauseQuantiles": { + "type": "array", + "items": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "PauseTotal": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/GCStats", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_getBadBlocks", + "tags": [], + "summary": "GetBadBlocks returns a list of the last 'bad blocks' that the client has seen on the network\nand returns them as a JSON list of block-hashes\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).GetBadBlocks", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:333" + }, + "params": [], + "result": { + "name": "debug_getBadBlocksResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/BadBlockArgs", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "definitions": { + "BadBlockArgs": { + "type": "object", + "required": ["hash", "block", "rlp"], + "properties": { + "block": { + "type": "object", + "patternProperties": { + ".*": { + "additionalProperties": true + } + } + }, + "hash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "rlp": { + "type": "string" + } + }, + "additionalProperties": false + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_getBlockRlp", + "tags": [], + "summary": "GetBlockRlp retrieves the RLP encoded for of a single block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicDebugAPI).GetBlockRlp", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1666" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "debug_getBlockRlpResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_getModifiedAccountsByHash", + "tags": [], + "summary": "GetModifiedAccountsByHash returns all accounts that have changed between the\ntwo blocks specified. A change is defined as a difference in nonce, balance,\ncode hash, or storage hash.\n\nWith one parameter, returns the list of accounts modified in the specified block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).GetModifiedAccountsByHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:502" + }, + "params": [ + { + "name": "startHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "endHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash POINTER", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "debug_getModifiedAccountsByHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_getModifiedAccountsByNumber", + "tags": [], + "summary": "GetModifiedAccountsByNumber returns all accounts that have changed between the\ntwo blocks specified. A change is defined as a difference in nonce, balance,\ncode hash, or storage hash.\n\nWith one parameter, returns the list of accounts modified in the specified block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).GetModifiedAccountsByNumber", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:474" + }, + "params": [ + { + "name": "startNum", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + { + "name": "endNum", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "debug_getModifiedAccountsByNumberResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_goTrace", + "tags": [], + "summary": "GoTrace turns on tracing for nsec seconds and writes\ntrace data to file.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).GoTrace", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:135" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "nsec", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_memStats", + "tags": [], + "summary": "MemStats returns detailed runtime memory statistics.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).MemStats", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:73" + }, + "params": [], + "result": { + "name": "debug_memStatsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*runtime:MemStats", + "definitions": { + "": { + "type": "object", + "required": ["Size", "Mallocs", "Frees"], + "properties": { + "Frees": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Mallocs": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Size": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + }, + "MemStats": { + "type": "object", + "required": [ + "Alloc", + "TotalAlloc", + "Sys", + "Lookups", + "Mallocs", + "Frees", + "HeapAlloc", + "HeapSys", + "HeapIdle", + "HeapInuse", + "HeapReleased", + "HeapObjects", + "StackInuse", + "StackSys", + "MSpanInuse", + "MSpanSys", + "MCacheInuse", + "MCacheSys", + "BuckHashSys", + "GCSys", + "OtherSys", + "NextGC", + "LastGC", + "PauseTotalNs", + "PauseNs", + "PauseEnd", + "NumGC", + "NumForcedGC", + "GCCPUFraction", + "EnableGC", + "DebugGC", + "BySize" + ], + "properties": { + "Alloc": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "BuckHashSys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "BySize": { + "type": "array", + "maxItems": 61, + "minItems": 61, + "items": { + "$ref": "#/definitions/", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "DebugGC": { + "type": "boolean" + }, + "EnableGC": { + "type": "boolean" + }, + "Frees": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "GCCPUFraction": { + "type": "number" + }, + "GCSys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "HeapAlloc": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "HeapIdle": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "HeapInuse": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "HeapObjects": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "HeapReleased": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "HeapSys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "LastGC": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Lookups": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "MCacheInuse": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "MCacheSys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "MSpanInuse": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "MSpanSys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Mallocs": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "NextGC": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "NumForcedGC": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "NumGC": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "OtherSys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "PauseEnd": { + "type": "array", + "maxItems": 256, + "minItems": 256, + "items": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "PauseNs": { + "type": "array", + "maxItems": 256, + "minItems": 256, + "items": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "PauseTotalNs": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "StackInuse": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "StackSys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Sys": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "TotalAlloc": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/MemStats", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_mutexProfile", + "tags": [], + "summary": "MutexProfile turns on mutex profiling for nsec seconds and writes profile data to file.\nIt uses a profile rate of 1 for most accurate information. If a different rate is\ndesired, set the rate and write the profile manually.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).MutexProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:168" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "nsec", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_preimage", + "tags": [], + "summary": "Preimage is a debug API function that returns the preimage for a sha3 hash, if known.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).Preimage", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:317" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "debug_preimageResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_printBlock", + "tags": [], + "summary": "PrintBlock retrieves a block and returns its pretty printed form.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicDebugAPI).PrintBlock", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1718" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "debug_printBlockResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_seedHash", + "tags": [], + "summary": "SeedHash retrieves the seed hash of a block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicDebugAPI).SeedHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1727" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "debug_seedHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_setBlockProfileRate", + "tags": [], + "summary": "SetBlockProfileRate sets the rate of goroutine block profile data collection.\nrate 0 disables block profiling.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).SetBlockProfileRate", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:156" + }, + "params": [ + { + "name": "rate", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_setGCPercent", + "tags": [], + "summary": "SetGCPercent sets the garbage collection target percentage. It returns the previous\nsetting. A negative value disables GC.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).SetGCPercent", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:206" + }, + "params": [ + { + "name": "v", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "debug_setGCPercentResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_setHead", + "tags": [], + "summary": "SetHead rewinds the head of the blockchain to a previous block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateDebugAPI).SetHead", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1771" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_setMutexProfileFraction", + "tags": [], + "summary": "SetMutexProfileFraction sets the rate of mutex profiling.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).SetMutexProfileFraction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:177" + }, + "params": [ + { + "name": "rate", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_stacks", + "tags": [], + "summary": "Stacks returns a printed representation of the stacks of all goroutines.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).Stacks", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:193" + }, + "params": [], + "result": { + "name": "debug_stacksResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_standardTraceBadBlockToFile", + "tags": [], + "summary": "StandardTraceBadBlockToFile dumps the structured logs created during the\nexecution of EVM against a block pulled from the pool of bad ones to the\nlocal file system and returns a list of files to the caller.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).StandardTraceBadBlockToFile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:432" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/eth:StdTraceConfig", + "definitions": { + "StdTraceConfig": { + "type": "object", + "required": [ + "DisableMemory", + "DisableStack", + "DisableStorage", + "Debug", + "Limit", + "Reexec", + "TxHash" + ], + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "TxHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/StdTraceConfig", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_standardTraceBadBlockToFileResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_standardTraceBlockToFile", + "tags": [], + "summary": "StandardTraceBlockToFile dumps the structured logs created during the\nexecution of EVM to the local file system and returns a list of files\nto the caller.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).StandardTraceBlockToFile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:421" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/eth:StdTraceConfig", + "definitions": { + "StdTraceConfig": { + "type": "object", + "required": [ + "DisableMemory", + "DisableStack", + "DisableStorage", + "Debug", + "Limit", + "Reexec", + "TxHash" + ], + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "TxHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/StdTraceConfig", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_standardTraceBlockToFileResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_startCPUProfile", + "tags": [], + "summary": "StartCPUProfile turns on CPU profiling, writing to the given file.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).StartCPUProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:98" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_startGoTrace", + "tags": [], + "summary": "StartGoTrace turns on tracing, writing to the given file.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).StartGoTrace", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/trace.go:30" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_stopCPUProfile", + "tags": [], + "summary": "StopCPUProfile stops an ongoing CPU profile.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).StopCPUProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:119" + }, + "params": [], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_stopGoTrace", + "tags": [], + "summary": "StopTrace stops an ongoing trace.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).StopGoTrace", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/trace.go:51" + }, + "params": [], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_storageRangeAt", + "tags": [], + "summary": "StorageRangeAt returns the storage at the given block height and transaction index.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).StorageRangeAt", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:434" + }, + "params": [ + { + "name": "blockHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "txIndex", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + { + "name": "contractAddress", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + { + "name": "keyStart", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + }, + { + "name": "maxResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "debug_storageRangeAtResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/eth:StorageRangeResult", + "definitions": { + "StorageRangeResult": { + "type": "object", + "required": ["storage", "nextKey"], + "properties": { + "nextKey": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "storage": { + "type": "object", + "patternProperties": { + ".*": { + "$ref": "#/definitions/storageEntry", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + } + }, + "additionalProperties": false + }, + "storageEntry": { + "type": "object", + "required": ["key", "value"], + "properties": { + "key": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/StorageRangeResult", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_testSignCliqueBlock", + "tags": [], + "summary": "TestSignCliqueBlock fetches the given block number, and attempts to sign it as a clique header with the\ngiven address, returning the address of the recovered signature\n\nThis is a temporary method to debug the externalsigner integration,\nTODO: Remove this method when the integration is mature\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicDebugAPI).TestSignCliqueBlock", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1683" + }, + "params": [ + { + "name": "address", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "debug_testSignCliqueBlockResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceBadBlock", + "tags": [], + "summary": "TraceBadBlockByHash returns the structured logs created during the execution of\nEVM against a block pulled from the pool of bad ones and returns them as a JSON\nobject.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).TraceBadBlock", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:408" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/eth:TraceConfig", + "definitions": { + "TraceConfig": { + "type": "object", + "required": [ + "DisableMemory", + "DisableStack", + "DisableStorage", + "Debug", + "Limit", + "Tracer", + "Timeout", + "Reexec" + ], + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Timeout": { + "type": "string" + }, + "Tracer": { + "type": "string" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/TraceConfig", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_traceBadBlockResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/txTraceResult", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "definitions": { + "txTraceResult": { + "type": "object", + "properties": { + "error": { + "type": "string" + }, + "result": { + "additionalProperties": true + } + }, + "additionalProperties": false + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceBlock", + "tags": [], + "summary": "TraceBlock returns the structured logs created during the execution of EVM\nand returns them as a JSON object.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).TraceBlock", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:387" + }, + "params": [ + { + "name": "blob", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a variable length byte array", + "type": "string", + "title": "bytes", + "pattern": "^0x([a-fA-F0-9]?)+$" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/eth:TraceConfig", + "definitions": { + "TraceConfig": { + "type": "object", + "required": [ + "DisableMemory", + "DisableStack", + "DisableStorage", + "Debug", + "Limit", + "Tracer", + "Timeout", + "Reexec" + ], + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Timeout": { + "type": "string" + }, + "Tracer": { + "type": "string" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/TraceConfig", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_traceBlockResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/txTraceResult", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "definitions": { + "txTraceResult": { + "type": "object", + "properties": { + "error": { + "type": "string" + }, + "result": { + "additionalProperties": true + } + }, + "additionalProperties": false + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceBlockByHash", + "tags": [], + "summary": "TraceBlockByHash returns the structured logs created during the execution of\nEVM and returns them as a JSON object.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).TraceBlockByHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:377" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/eth:TraceConfig", + "definitions": { + "TraceConfig": { + "type": "object", + "required": [ + "DisableMemory", + "DisableStack", + "DisableStorage", + "Debug", + "Limit", + "Tracer", + "Timeout", + "Reexec" + ], + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Timeout": { + "type": "string" + }, + "Tracer": { + "type": "string" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/TraceConfig", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_traceBlockByHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/txTraceResult", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "definitions": { + "txTraceResult": { + "type": "object", + "properties": { + "error": { + "type": "string" + }, + "result": { + "additionalProperties": true + } + }, + "additionalProperties": false + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceBlockByNumber", + "tags": [], + "summary": "TraceBlockByNumber returns the structured logs created during the execution of\nEVM and returns them as a JSON object.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).TraceBlockByNumber", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:356" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Block tag or hex representation of a block number", + "title": "blockNumberOrTag", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + } + ] + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/eth:TraceConfig", + "definitions": { + "TraceConfig": { + "type": "object", + "required": [ + "DisableMemory", + "DisableStack", + "DisableStorage", + "Debug", + "Limit", + "Tracer", + "Timeout", + "Reexec" + ], + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Timeout": { + "type": "string" + }, + "Tracer": { + "type": "string" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/TraceConfig", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_traceBlockByNumberResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/txTraceResult", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "definitions": { + "txTraceResult": { + "type": "object", + "properties": { + "error": { + "type": "string" + }, + "result": { + "additionalProperties": true + } + }, + "additionalProperties": false + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceBlockFromFile", + "tags": [], + "summary": "TraceBlockFromFile returns the structured logs created during the execution of\nEVM and returns them as a JSON object.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).TraceBlockFromFile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:397" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/eth:TraceConfig", + "definitions": { + "TraceConfig": { + "type": "object", + "required": [ + "DisableMemory", + "DisableStack", + "DisableStorage", + "Debug", + "Limit", + "Tracer", + "Timeout", + "Reexec" + ], + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Timeout": { + "type": "string" + }, + "Tracer": { + "type": "string" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/TraceConfig", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_traceBlockFromFileResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/txTraceResult", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "definitions": { + "txTraceResult": { + "type": "object", + "properties": { + "error": { + "type": "string" + }, + "result": { + "additionalProperties": true + } + }, + "additionalProperties": false + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_traceTransaction", + "tags": [], + "summary": "FIXME: Is this really supposed to return an *ethapi.ExecutionResult type, or the empty interface in case not *vm.StructLogger?\nTraceTransaction returns the structured logs created during the execution of EVM\nand returns them as a JSON object.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateDebugAPI).TraceTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api_tracer.go:706" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "config", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/eth:TraceConfig", + "definitions": { + "TraceConfig": { + "type": "object", + "required": [ + "DisableMemory", + "DisableStack", + "DisableStorage", + "Debug", + "Limit", + "Tracer", + "Timeout", + "Reexec" + ], + "properties": { + "Debug": { + "type": "boolean" + }, + "DisableMemory": { + "type": "boolean" + }, + "DisableStack": { + "type": "boolean" + }, + "DisableStorage": { + "type": "boolean" + }, + "Limit": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Reexec": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Timeout": { + "type": "string" + }, + "Tracer": { + "type": "string" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/TraceConfig", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "debug_traceTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/internal/ethapi:ExecutionResult", + "definitions": { + "ExecutionResult": { + "type": "object", + "required": ["gas", "failed", "returnValue", "structLogs"], + "properties": { + "failed": { + "type": "boolean" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "returnValue": { + "type": "string" + }, + "structLogs": { + "type": "array", + "items": { + "$ref": "#/definitions/StructLogRes", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + }, + "additionalProperties": false + }, + "StructLogRes": { + "type": "object", + "required": ["pc", "op", "gas", "gasCost", "depth"], + "properties": { + "depth": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "error": { + "additionalProperties": true + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasCost": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "memory": { + "type": "array", + "items": { + "type": "string" + } + }, + "op": { + "type": "string" + }, + "pc": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "stack": { + "type": "array", + "items": { + "type": "string" + } + }, + "storage": { + "type": "object", + "patternProperties": { + ".*": { + "type": "string" + } + } + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/ExecutionResult", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_verbosity", + "tags": [], + "summary": "Verbosity sets the log verbosity ceiling. The verbosity of individual packages\nand source files can be raised using Vmodule.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).Verbosity", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:57" + }, + "params": [ + { + "name": "level", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_vmodule", + "tags": [], + "summary": "Vmodule sets the log verbosity pattern. See package log for details on the\npattern syntax.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).Vmodule", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:62" + }, + "params": [ + { + "name": "pattern", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_writeBlockProfile", + "tags": [], + "summary": "WriteBlockProfile writes a goroutine blocking profile to the given file.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).WriteBlockProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:161" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_writeMemProfile", + "tags": [], + "summary": "WriteMemProfile writes an allocation profile to the given file.\nNote that the profiling rate cannot be set through the API,\nit must be set on the command line.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).WriteMemProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:188" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "debug_writeMutexProfile", + "tags": [], + "summary": "WriteMutexProfile writes a goroutine blocking profile to the given file.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/debug.(*HandlerT).WriteMutexProfile", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/debug/api.go:181" + }, + "params": [ + { + "name": "file", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_accounts", + "tags": [], + "summary": "Accounts returns the collection of accounts this node manages\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicAccountAPI).Accounts", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:193" + }, + "params": [], + "result": { + "name": "eth_accountsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_blockNumber", + "tags": [], + "summary": "BlockNumber returns the block number of the chain head.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).BlockNumber", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:525" + }, + "params": [], + "result": { + "name": "eth_blockNumberResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_call", + "tags": [], + "summary": "Call executes the given transaction on the state for the given block number.\n\nAdditionally, the caller can specify a batch of contract for fields overriding.\n\nNote, this function doesn't make and changes in the state/blockchain and is\nuseful to execute and retrieve values.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).Call", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:877" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi:CallArgs", + "definitions": { + "CallArgs": { + "type": "object", + "required": [ + "from", + "to", + "gas", + "gasPrice", + "value", + "data" + ], + "properties": { + "data": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "from": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/CallArgs", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "blockNrOrHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a block number or hash", + "title": "blockNumberOrHash", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + ] + } + }, + { + "name": "overrides", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:", + "type": "object", + "patternProperties": { + ".*": { + "$ref": "#/definitions/account", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "definitions": { + "account": { + "type": "object", + "required": [ + "nonce", + "code", + "balance", + "state", + "stateDiff" + ], + "properties": { + "balance": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "code": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "state": { + "type": "object", + "patternProperties": { + ".*": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + }, + "stateDiff": { + "type": "object", + "patternProperties": { + ".*": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + } + }, + "additionalProperties": false + } + } + } + } + ], + "result": { + "name": "eth_callResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_chainId", + "tags": [], + "summary": "ChainId is the EIP-155 replay-protection chain id for the current ethereum chain config.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PublicEthereumAPI).ChainId", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:70" + }, + "params": [], + "result": { + "name": "eth_chainIdResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_coinbase", + "tags": [], + "summary": "Coinbase is the address that mining rewards will be send to (alias for Etherbase)\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PublicEthereumAPI).Coinbase", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:60" + }, + "params": [], + "result": { + "name": "eth_coinbaseResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_estimateGas", + "tags": [], + "summary": "EstimateGas returns an estimate of the amount of gas needed to execute the\ngiven transaction against the current pending block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).EstimateGas", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:951" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi:CallArgs", + "definitions": { + "CallArgs": { + "type": "object", + "required": [ + "from", + "to", + "gas", + "gasPrice", + "value", + "data" + ], + "properties": { + "data": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "from": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/CallArgs", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_estimateGasResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_etherbase", + "tags": [], + "summary": "Etherbase is the address that mining rewards will be send to\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PublicEthereumAPI).Etherbase", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:55" + }, + "params": [], + "result": { + "name": "eth_etherbaseResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_fillTransaction", + "tags": [], + "summary": "FillTransaction fills the defaults (nonce, gas, gasPrice) on a given unsigned transaction,\nand returns it to the caller for further processing (signing + broadcast)\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).FillTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1500" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi:SendTxArgs", + "definitions": { + "SendTxArgs": { + "type": "object", + "required": [ + "from", + "to", + "gas", + "gasPrice", + "value", + "nonce", + "data", + "input" + ], + "properties": { + "data": { + "description": "Field _input_ should be preferred", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/SendTxArgs", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_fillTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/internal/ethapi:SignTransactionResult", + "definitions": { + "SignTransactionResult": { + "type": "object", + "required": ["raw", "tx"], + "properties": { + "raw": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "tx": { + "$ref": "#/definitions/Transaction", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "additionalProperties": false + }, + "Transaction": { + "type": "object", + "additionalProperties": false + } + }, + "$ref": "#/definitions/SignTransactionResult", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_gasPrice", + "tags": [], + "summary": "GasPrice returns a suggestion for a gas price.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicEthereumAPI).GasPrice", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:66" + }, + "params": [], + "result": { + "name": "eth_gasPriceResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getBalance", + "tags": [], + "summary": "GetBalance returns the amount of wei for the given address in the state of the\ngiven block number. The rpc.LatestBlockNumber and rpc.PendingBlockNumber meta\nblock numbers are also allowed.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetBalance", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:533" + }, + "params": [ + { + "name": "address", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + { + "name": "blockNrOrHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a block number or hash", + "title": "blockNumberOrHash", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + ] + } + } + ], + "result": { + "name": "eth_getBalanceResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getBlockByHash", + "tags": [], + "summary": "GetBlockByHash returns the requested block. When fullTx is true all transactions in the block are returned in full\ndetail, otherwise only the transaction hash is returned.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetBlockByHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:656" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "fullTx", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + } + ], + "result": { + "name": "eth_getBlockByHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "patternProperties": { + ".*": { + "additionalProperties": true + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getBlockByNumber", + "tags": [], + "summary": "GetBlockByNumber returns the requested canonical block.\n* When blockNr is -1 the chain head is returned.\n* When blockNr is -2 the pending chain head is returned.\n* When fullTx is true all transactions in the block are returned, otherwise\n only the transaction hash is returned.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetBlockByNumber", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:639" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Block tag or hex representation of a block number", + "title": "blockNumberOrTag", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + } + ] + } + }, + { + "name": "fullTx", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + } + ], + "result": { + "name": "eth_getBlockByNumberResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "patternProperties": { + ".*": { + "additionalProperties": true + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getBlockTransactionCountByHash", + "tags": [], + "summary": "GetBlockTransactionCountByHash returns the number of transactions in the block with the given hash.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetBlockTransactionCountByHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1201" + }, + "params": [ + { + "name": "blockHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "eth_getBlockTransactionCountByHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getBlockTransactionCountByNumber", + "tags": [], + "summary": "GetBlockTransactionCountByNumber returns the number of transactions in the block with the given block number.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetBlockTransactionCountByNumber", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1192" + }, + "params": [ + { + "name": "blockNr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Block tag or hex representation of a block number", + "title": "blockNumberOrTag", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + } + ] + } + } + ], + "result": { + "name": "eth_getBlockTransactionCountByNumberResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getCode", + "tags": [], + "summary": "GetCode returns the code stored at the given address in the state for the given block number.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetCode", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:715" + }, + "params": [ + { + "name": "address", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + { + "name": "blockNrOrHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a block number or hash", + "title": "blockNumberOrHash", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + ] + } + } + ], + "result": { + "name": "eth_getCodeResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getFilterChanges", + "tags": [], + "summary": "GetFilterChanges returns the logs for the filter with the given id since\nlast time it was called. This can be used for polling.\n\nFor pending transaction and block filters the result is []common.Hash.\n(pending)Log filters return []Log.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_getfilterchanges\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth/filters.(*PublicFilterAPI).GetFilterChanges", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go:413" + }, + "params": [ + { + "name": "id", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc:rpc.ID", + "type": "string" + } + } + ], + "result": { + "name": "eth_getFilterChangesResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "additionalProperties": true + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getFilterLogs", + "tags": [], + "summary": "GetFilterLogs returns the logs for the filter with the given id.\nIf the filter could not be found an empty array of logs is returned.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_getfilterlogs\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth/filters.(*PublicFilterAPI).GetFilterLogs", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go:372" + }, + "params": [ + { + "name": "id", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc:rpc.ID", + "type": "string" + } + } + ], + "result": { + "name": "eth_getFilterLogsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Log", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "definitions": { + "Log": { + "type": "object", + "required": [ + "address", + "topics", + "data", + "blockNumber", + "transactionHash", + "transactionIndex", + "blockHash", + "logIndex", + "removed" + ], + "properties": { + "address": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "blockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "blockNumber": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "data": { + "type": "string", + "title": "bytes", + "pattern": "^0x([a-fA-F0-9]?)+$" + }, + "logIndex": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "removed": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "transactionHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "transactionIndex": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getHashrate", + "tags": [], + "summary": "GetHashrate returns the current hashrate for local CPU miner and remote miner.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).GetHashrate", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:110" + }, + "params": [], + "result": { + "name": "eth_getHashrateResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getHeaderByHash", + "tags": [], + "summary": "GetHeaderByHash returns the requested header by hash.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetHeaderByHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:626" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "eth_getHeaderByHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "patternProperties": { + ".*": { + "additionalProperties": true + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getHeaderByNumber", + "tags": [], + "summary": "GetHeaderByNumber returns the requested canonical block header.\n* When blockNr is -1 the chain head is returned.\n* When blockNr is -2 the pending chain head is returned.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetHeaderByNumber", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:610" + }, + "params": [ + { + "name": "number", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Block tag or hex representation of a block number", + "title": "blockNumberOrTag", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + } + ] + } + } + ], + "result": { + "name": "eth_getHeaderByNumberResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "patternProperties": { + ".*": { + "additionalProperties": true + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getLogs", + "tags": [], + "summary": "GetLogs returns logs matching the given argument that are stored within the state.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_getlogs\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth/filters.(*PublicFilterAPI).GetLogs", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go:325" + }, + "params": [ + { + "name": "crit", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/eth/filters:FilterCriteria", + "definitions": { + "FilterCriteria": { + "type": "object", + "required": [ + "BlockHash", + "FromBlock", + "ToBlock", + "Addresses", + "Topics" + ], + "properties": { + "Addresses": { + "type": "array", + "items": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + "BlockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "FromBlock": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "ToBlock": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Topics": { + "type": "array", + "items": { + "type": "array", + "items": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/FilterCriteria", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_getLogsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Log", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "definitions": { + "Log": { + "type": "object", + "required": [ + "address", + "topics", + "data", + "blockNumber", + "transactionHash", + "transactionIndex", + "blockHash", + "logIndex", + "removed" + ], + "properties": { + "address": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "blockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "blockNumber": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "data": { + "type": "string", + "title": "bytes", + "pattern": "^0x([a-fA-F0-9]?)+$" + }, + "logIndex": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "removed": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "transactionHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "transactionIndex": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getProof", + "tags": [], + "summary": "GetProof returns the Merkle-proof for a given account and optionally some storage keys.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetProof", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:558" + }, + "params": [ + { + "name": "address", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + { + "name": "storageKeys", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "blockNrOrHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a block number or hash", + "title": "blockNumberOrHash", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + ] + } + } + ], + "result": { + "name": "eth_getProofResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/internal/ethapi:AccountResult", + "definitions": { + "AccountResult": { + "type": "object", + "required": [ + "address", + "accountProof", + "balance", + "codeHash", + "nonce", + "storageHash", + "storageProof" + ], + "properties": { + "accountProof": { + "type": "array", + "items": { + "type": "string" + } + }, + "address": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "balance": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "codeHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "storageHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "storageProof": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageResult", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + }, + "additionalProperties": false + }, + "StorageResult": { + "type": "object", + "required": ["key", "value", "proof"], + "properties": { + "key": { + "type": "string" + }, + "proof": { + "type": "array", + "items": { + "type": "string" + } + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/AccountResult", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getRawTransactionByBlockHashAndIndex", + "tags": [], + "summary": "GetRawTransactionByBlockHashAndIndex returns the bytes of the transaction for the given block hash and index.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetRawTransactionByBlockHashAndIndex", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1234" + }, + "params": [ + { + "name": "blockHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "index", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "eth_getRawTransactionByBlockHashAndIndexResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getRawTransactionByBlockNumberAndIndex", + "tags": [], + "summary": "GetRawTransactionByBlockNumberAndIndex returns the bytes of the transaction for the given block number and index.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetRawTransactionByBlockNumberAndIndex", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1226" + }, + "params": [ + { + "name": "blockNr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Block tag or hex representation of a block number", + "title": "blockNumberOrTag", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + } + ] + } + }, + { + "name": "index", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "eth_getRawTransactionByBlockNumberAndIndexResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getRawTransactionByHash", + "tags": [], + "summary": "GetRawTransactionByHash returns the bytes of the transaction for the given hash.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetRawTransactionByHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1280" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "eth_getRawTransactionByHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getStorageAt", + "tags": [], + "summary": "GetStorageAt returns the storage from the state at the given address, key and\nblock number. The rpc.LatestBlockNumber and rpc.PendingBlockNumber meta block\nnumbers are also allowed.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetStorageAt", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:727" + }, + "params": [ + { + "name": "address", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + { + "name": "key", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "blockNrOrHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a block number or hash", + "title": "blockNumberOrHash", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + ] + } + } + ], + "result": { + "name": "eth_getStorageAtResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getTransactionByBlockHashAndIndex", + "tags": [], + "summary": "GetTransactionByBlockHashAndIndex returns the transaction for the given block hash and index.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetTransactionByBlockHashAndIndex", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1218" + }, + "params": [ + { + "name": "blockHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "index", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "eth_getTransactionByBlockHashAndIndexResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/internal/ethapi:RPCTransaction", + "definitions": { + "RPCTransaction": { + "type": "object", + "required": [ + "blockHash", + "blockNumber", + "from", + "gas", + "gasPrice", + "hash", + "input", + "nonce", + "to", + "transactionIndex", + "value", + "v", + "r", + "s" + ], + "properties": { + "blockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "blockNumber": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "hash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "r": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "s": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "transactionIndex": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "v": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/RPCTransaction", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getTransactionByBlockNumberAndIndex", + "tags": [], + "summary": "GetTransactionByBlockNumberAndIndex returns the transaction for the given block number and index.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetTransactionByBlockNumberAndIndex", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1210" + }, + "params": [ + { + "name": "blockNr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Block tag or hex representation of a block number", + "title": "blockNumberOrTag", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + } + ] + } + }, + { + "name": "index", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "eth_getTransactionByBlockNumberAndIndexResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/internal/ethapi:RPCTransaction", + "definitions": { + "RPCTransaction": { + "type": "object", + "required": [ + "blockHash", + "blockNumber", + "from", + "gas", + "gasPrice", + "hash", + "input", + "nonce", + "to", + "transactionIndex", + "value", + "v", + "r", + "s" + ], + "properties": { + "blockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "blockNumber": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "hash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "r": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "s": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "transactionIndex": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "v": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/RPCTransaction", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getTransactionByHash", + "tags": [], + "summary": "GetTransactionByHash returns the transaction for the given hash\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetTransactionByHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1261" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "eth_getTransactionByHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/internal/ethapi:RPCTransaction", + "definitions": { + "RPCTransaction": { + "type": "object", + "required": [ + "blockHash", + "blockNumber", + "from", + "gas", + "gasPrice", + "hash", + "input", + "nonce", + "to", + "transactionIndex", + "value", + "v", + "r", + "s" + ], + "properties": { + "blockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "blockNumber": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "hash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "r": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "s": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "transactionIndex": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "v": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/RPCTransaction", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getTransactionCount", + "tags": [], + "summary": "GetTransactionCount returns the number of transactions the given address has sent for the given block number\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetTransactionCount", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1242" + }, + "params": [ + { + "name": "address", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + { + "name": "blockNrOrHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a block number or hash", + "title": "blockNumberOrHash", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + ] + } + } + ], + "result": { + "name": "eth_getTransactionCountResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getTransactionReceipt", + "tags": [], + "summary": "GetTransactionReceipt returns the transaction receipt for the given transaction hash.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).GetTransactionReceipt", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1297" + }, + "params": [ + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "eth_getTransactionReceiptResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "patternProperties": { + ".*": { + "additionalProperties": true + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getUncleByBlockHashAndIndex", + "tags": [], + "summary": "GetUncleByBlockHashAndIndex returns the uncle block for the given block hash and index. When fullTx is true\nall transactions in the block are returned in full detail, otherwise only the transaction hash is returned.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetUncleByBlockHashAndIndex", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:682" + }, + "params": [ + { + "name": "blockHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "index", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "eth_getUncleByBlockHashAndIndexResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "patternProperties": { + ".*": { + "additionalProperties": true + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getUncleByBlockNumberAndIndex", + "tags": [], + "summary": "GetUncleByBlockNumberAndIndex returns the uncle block for the given block hash and index. When fullTx is true\nall transactions in the block are returned in full detail, otherwise only the transaction hash is returned.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetUncleByBlockNumberAndIndex", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:666" + }, + "params": [ + { + "name": "blockNr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Block tag or hex representation of a block number", + "title": "blockNumberOrTag", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + } + ] + } + }, + { + "name": "index", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "eth_getUncleByBlockNumberAndIndexResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "patternProperties": { + ".*": { + "additionalProperties": true + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getUncleCountByBlockHash", + "tags": [], + "summary": "GetUncleCountByBlockHash returns number of uncles in the block for the given block hash\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetUncleCountByBlockHash", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:706" + }, + "params": [ + { + "name": "blockHash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "eth_getUncleCountByBlockHashResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getUncleCountByBlockNumber", + "tags": [], + "summary": "GetUncleCountByBlockNumber returns number of uncles in the block for the given block number\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicBlockChainAPI).GetUncleCountByBlockNumber", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:697" + }, + "params": [ + { + "name": "blockNr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Block tag or hex representation of a block number", + "title": "blockNumberOrTag", + "oneOf": [ + { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + { + "description": "The optional block height description", + "type": "string", + "title": "blockNumberTag", + "enum": ["earliest", "latest", "pending"] + } + ] + } + } + ], + "result": { + "name": "eth_getUncleCountByBlockNumberResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_getWork", + "tags": [], + "summary": "GetWork returns a work package for external miner.\n\nThe work package consists of 3 strings:\n result[0] - 32 bytes hex encoded current block header pow-hash\n result[1] - 32 bytes hex encoded seed hash used for DAG\n result[2] - 32 bytes hex encoded boundary condition (\"target\"), 2^256/difficulty\n result[3] - hex encoded block number\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).GetWork", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:41" + }, + "params": [], + "result": { + "name": "eth_getWorkResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "maxItems": 4, + "minItems": 4, + "items": { + "type": "string" + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_hashrate", + "tags": [], + "summary": "Hashrate returns the POW hashrate\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PublicEthereumAPI).Hashrate", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:65" + }, + "params": [], + "result": { + "name": "eth_hashrateResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_mining", + "tags": [], + "summary": "Mining returns an indication if this node is currently mining.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PublicMinerAPI).Mining", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:91" + }, + "params": [], + "result": { + "name": "eth_miningResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_newBlockFilter", + "tags": [], + "summary": "NewBlockFilter creates a filter that fetches blocks that are imported into the chain.\nIt is part of the filter package since polling goes with eth_getFilterChanges.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_newblockfilter\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth/filters.(*PublicFilterAPI).NewBlockFilter", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go:174" + }, + "params": [], + "result": { + "name": "eth_newBlockFilterResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc:rpc.ID", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_newFilter", + "tags": [], + "summary": "NewFilter creates a new filter and returns the filter id. It can be\nused to retrieve logs when the state changes. This method cannot be\nused to fetch logs that are already stored in the state.\n\nDefault criteria for the from and to block are \"latest\".\nUsing \"latest\" as block number will return logs for mined blocks.\nUsing \"pending\" as block number returns logs for not yet mined (pending) blocks.\nIn case logs are removed (chain reorg) previously returned logs are returned\nagain but with the removed property set to true.\n\nIn case \"fromBlock\" \u003e \"toBlock\" an error is returned.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_newfilter\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth/filters.(*PublicFilterAPI).NewFilter", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go:290" + }, + "params": [ + { + "name": "crit", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/eth/filters:FilterCriteria", + "definitions": { + "FilterCriteria": { + "type": "object", + "required": [ + "BlockHash", + "FromBlock", + "ToBlock", + "Addresses", + "Topics" + ], + "properties": { + "Addresses": { + "type": "array", + "items": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + "BlockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "FromBlock": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "ToBlock": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "Topics": { + "type": "array", + "items": { + "type": "array", + "items": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/FilterCriteria", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_newFilterResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc:rpc.ID", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_newPendingTransactionFilter", + "tags": [], + "summary": "NewPendingTransactionFilter creates a filter that fetches pending transaction hashes\nas transactions enter the pending state.\n\nIt is part of the filter package because this filter can be used through the\n`eth_getFilterChanges` polling method that is also used for log filters.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_newpendingtransactionfilter\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth/filters.(*PublicFilterAPI).NewPendingTransactionFilter", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go:104" + }, + "params": [], + "result": { + "name": "eth_newPendingTransactionFilterResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc:rpc.ID", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_pendingTransactions", + "tags": [], + "summary": "PendingTransactions returns the transactions that are in the transaction pool\nand have a from address that is one of the accounts this node manages.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).PendingTransactions", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1584" + }, + "params": [], + "result": { + "name": "eth_pendingTransactionsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/RPCTransaction", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "definitions": { + "RPCTransaction": { + "type": "object", + "required": [ + "blockHash", + "blockNumber", + "from", + "gas", + "gasPrice", + "hash", + "input", + "nonce", + "to", + "transactionIndex", + "value", + "v", + "r", + "s" + ], + "properties": { + "blockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "blockNumber": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "hash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "r": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "s": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "transactionIndex": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "v": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_protocolVersion", + "tags": [], + "summary": "ProtocolVersion returns the current Ethereum protocol version this node supports\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicEthereumAPI).ProtocolVersion", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:72" + }, + "params": [], + "result": { + "name": "eth_protocolVersionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_resend", + "tags": [], + "summary": "Resend accepts an existing transaction and a new gas price and limit. It will remove\nthe given transaction from the pool and reinsert it with the new gas price and limit.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).Resend", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1611" + }, + "params": [ + { + "name": "sendArgs", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi:SendTxArgs", + "definitions": { + "SendTxArgs": { + "type": "object", + "required": [ + "from", + "to", + "gas", + "gasPrice", + "value", + "nonce", + "data", + "input" + ], + "properties": { + "data": { + "description": "Field _input_ should be preferred", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/SendTxArgs", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "gasPrice", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + { + "name": "gasLimit", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "eth_resendResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_sendRawTransaction", + "tags": [], + "summary": "SendRawTransaction will add the signed transaction to the transaction pool.\nThe sender is responsible for signing the transaction and using the correct nonce.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).SendRawTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1516" + }, + "params": [ + { + "name": "encodedTx", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + } + ], + "result": { + "name": "eth_sendRawTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_sendTransaction", + "tags": [], + "summary": "SendTransaction creates a transaction for the given argument, sign it and submit it to the\ntransaction pool.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).SendTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1468" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi:SendTxArgs", + "definitions": { + "SendTxArgs": { + "type": "object", + "required": [ + "from", + "to", + "gas", + "gasPrice", + "value", + "nonce", + "data", + "input" + ], + "properties": { + "data": { + "description": "Field _input_ should be preferred", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/SendTxArgs", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_sendTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_sign", + "tags": [], + "summary": "Sign calculates an ECDSA signature for:\nkeccack256(\"\\x19Ethereum Signed Message:\\n\" + len(message) + message).\n\nNote, the produced signature conforms to the secp256k1 curve R, S and V values,\nwhere the V value will be 27 or 28 for legacy reasons.\n\nThe account associated with addr must be unlocked.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).Sign", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1533" + }, + "params": [ + { + "name": "addr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + { + "name": "data", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + } + ], + "result": { + "name": "eth_signResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_signTransaction", + "tags": [], + "summary": "SignTransaction will sign the given transaction with the from account.\nThe node needs to have the private key of the account corresponding with\nthe given from address and it needs to be unlocked.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTransactionPoolAPI).SignTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1558" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi:SendTxArgs", + "definitions": { + "SendTxArgs": { + "type": "object", + "required": [ + "from", + "to", + "gas", + "gasPrice", + "value", + "nonce", + "data", + "input" + ], + "properties": { + "data": { + "description": "Field _input_ should be preferred", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/SendTxArgs", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + ], + "result": { + "name": "eth_signTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/internal/ethapi:SignTransactionResult", + "definitions": { + "SignTransactionResult": { + "type": "object", + "required": ["raw", "tx"], + "properties": { + "raw": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "tx": { + "$ref": "#/definitions/Transaction", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "additionalProperties": false + }, + "Transaction": { + "type": "object", + "additionalProperties": false + } + }, + "$ref": "#/definitions/SignTransactionResult", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_submitHashRate", + "tags": [], + "summary": "SubmitHashrate can be used for remote miners to submit their hash rate.\nThis enables the node to report the combined hash rate of all miners\nwhich submit work through this node.\n\nIt accepts the miner hash rate and an identifier which must be unique\nbetween nodes.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).SubmitHashRate", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:92" + }, + "params": [ + { + "name": "rate", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + { + "name": "id", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "eth_submitHashRateResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_submitWork", + "tags": [], + "summary": "SubmitWork can be used by external miner to submit their POW solution.\nIt returns an indication if the work was accepted.\nNote either an invalid solution, a stale work a non-existent work will return false.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).SubmitWork", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:66" + }, + "params": [ + { + "name": "nonce", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/core/types:types.BlockNonce", + "type": "array", + "maxItems": 8, + "minItems": 8, + "items": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + }, + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "digest", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "eth_submitWorkResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_syncing", + "tags": [], + "summary": "Syncing returns false in case the node is currently not syncing with the network. It can be up to date or has not\nyet received the latest block headers from its pears. In case it is synchronizing:\n- startingBlock: block number this node started to synchronise from\n- currentBlock: block number this node is currently importing\n- highestBlock: block number of the highest block header this node has received from peers\n- pulledStates: number of state entries processed until now\n- knownStates: number of known state entries that still need to be pulled\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicEthereumAPI).Syncing", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:83" + }, + "params": [], + "result": { + "name": "eth_syncingResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "additionalProperties": true + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "eth_uninstallFilter", + "tags": [], + "summary": "UninstallFilter removes the filter with the given filter id.\n\nhttps://github.com/ethereum/wiki/wiki/JSON-RPC#eth_uninstallfilter\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth/filters.(*PublicFilterAPI).UninstallFilter", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/filters/api.go:354" + }, + "params": [ + { + "name": "id", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/rpc:rpc.ID", + "type": "string" + } + } + ], + "result": { + "name": "eth_uninstallFilterResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "ethash_getHashrate", + "tags": [], + "summary": "GetHashrate returns the current hashrate for local CPU miner and remote miner.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).GetHashrate", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:110" + }, + "params": [], + "result": { + "name": "ethash_getHashrateResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "ethash_getWork", + "tags": [], + "summary": "GetWork returns a work package for external miner.\n\nThe work package consists of 3 strings:\n result[0] - 32 bytes hex encoded current block header pow-hash\n result[1] - 32 bytes hex encoded seed hash used for DAG\n result[2] - 32 bytes hex encoded boundary condition (\"target\"), 2^256/difficulty\n result[3] - hex encoded block number\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).GetWork", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:41" + }, + "params": [], + "result": { + "name": "ethash_getWorkResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "maxItems": 4, + "minItems": 4, + "items": { + "type": "string" + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "ethash_submitHashRate", + "tags": [], + "summary": "SubmitHashrate can be used for remote miners to submit their hash rate.\nThis enables the node to report the combined hash rate of all miners\nwhich submit work through this node.\n\nIt accepts the miner hash rate and an identifier which must be unique\nbetween nodes.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).SubmitHashRate", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:92" + }, + "params": [ + { + "name": "rate", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + { + "name": "id", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "ethash_submitHashRateResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "ethash_submitWork", + "tags": [], + "summary": "SubmitWork can be used by external miner to submit their POW solution.\nIt returns an indication if the work was accepted.\nNote either an invalid solution, a stale work a non-existent work will return false.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/consensus/ethash.(*API).SubmitWork", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/consensus/ethash/api.go:66" + }, + "params": [ + { + "name": "nonce", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/core/types:types.BlockNonce", + "type": "array", + "maxItems": 8, + "minItems": 8, + "items": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + }, + { + "name": "hash", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + { + "name": "digest", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + } + ], + "result": { + "name": "ethash_submitWorkResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_getHashrate", + "tags": [], + "summary": "GetHashrate returns the current hashrate of the miner.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateMinerAPI).GetHashrate", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:153" + }, + "params": [], + "result": { + "name": "miner_getHashrateResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_setEtherbase", + "tags": [], + "summary": "SetEtherbase sets the etherbase of the miner\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateMinerAPI).SetEtherbase", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:142" + }, + "params": [ + { + "name": "etherbase", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + } + ], + "result": { + "name": "miner_setEtherbaseResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_setExtra", + "tags": [], + "summary": "SetExtra sets the extra data string that is included when this miner mines a block.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateMinerAPI).SetExtra", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:124" + }, + "params": [ + { + "name": "extra", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "miner_setExtraResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_setGasPrice", + "tags": [], + "summary": "SetGasPrice sets the minimum accepted gas price for the miner.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateMinerAPI).SetGasPrice", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:132" + }, + "params": [ + { + "name": "gasPrice", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "miner_setGasPriceResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_setRecommitInterval", + "tags": [], + "summary": "SetRecommitInterval updates the interval for miner sealing work recommitting.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateMinerAPI).SetRecommitInterval", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:148" + }, + "params": [ + { + "name": "interval", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_start", + "tags": [], + "summary": "Start starts the miner with the given number of threads. If threads is nil,\nthe number of workers started is equal to the number of logical CPUs that are\nusable by this process. If mining is already running, this method adjust the\nnumber of threads allowed to use and updates the minimum price required by the\ntransaction pool.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateMinerAPI).Start", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:110" + }, + "params": [ + { + "name": "threads", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "miner_stop", + "tags": [], + "summary": "Stop terminates the miner, both at the consensus engine level as well as at\nthe block creation level.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/eth.(*PrivateMinerAPI).Stop", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/eth/api.go:119" + }, + "params": [], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "net_listening", + "tags": [], + "summary": "Listening returns an indication if the node is listening for network connections.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicNetAPI).Listening", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1788" + }, + "params": [], + "result": { + "name": "net_listeningResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "net_peerCount", + "tags": [], + "summary": "PeerCount returns the number of connected peers\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicNetAPI).PeerCount", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1792" + }, + "params": [], + "result": { + "name": "net_peerCountResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "net_version", + "tags": [], + "summary": "Version returns the current ethereum protocol version.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicNetAPI).Version", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:1797" + }, + "params": [], + "result": { + "name": "net_versionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_deriveAccount", + "tags": [], + "summary": "DeriveAccount requests a HD wallet to derive a new account, optionally pinning\nit for later reuse.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).DeriveAccount", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:266" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "path", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "pin", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:bool", + "type": "boolean" + } + } + ], + "result": { + "name": "personal_deriveAccountResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/accounts:accounts.Account", + "definitions": { + "Account": { + "type": "object", + "required": ["address", "url"], + "properties": { + "address": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "url": { + "$ref": "#/definitions/URL", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "additionalProperties": false + }, + "URL": { + "type": "object", + "required": ["Scheme", "Path"], + "properties": { + "Path": { + "type": "string" + }, + "Scheme": { + "type": "string" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/Account", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_ecRecover", + "tags": [], + "summary": "EcRecover returns the address for the account that was used to create the signature.\nNote, this function is compatible with eth_sign and personal_sign. As such it recovers\nthe address of:\nhash = keccak256(\"\\x19Ethereum Signed Message:\\n\"${message length}${message})\naddr = ecrecover(hash, signature)\n\nNote, the signature must conform to the secp256k1 curve R, S and V values, where\nthe V value must be 27 or 28 for legacy reasons.\n\nhttps://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_ecRecover\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).EcRecover", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:444" + }, + "params": [ + { + "name": "data", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + }, + { + "name": "sig", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + } + ], + "result": { + "name": "personal_ecRecoverResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_importRawKey", + "tags": [], + "summary": "ImportRawKey stores the given hex encoded ECDSA key into the key directory,\nencrypting it with the passphrase.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).ImportRawKey", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:300" + }, + "params": [ + { + "name": "privkey", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "password", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "personal_importRawKeyResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_initializeWallet", + "tags": [], + "summary": "InitializeWallet initializes a new wallet at the provided URL, by generating and returning a new private key.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).InitializeWallet", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:467" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "personal_initializeWalletResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_listAccounts", + "tags": [], + "summary": "listAccounts will return a list of addresses for accounts this node manages.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).ListAccounts", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:216" + }, + "params": [], + "result": { + "name": "personal_listAccountsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_listWallets", + "tags": [], + "summary": "ListWallets will return a list of wallets this node manages.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).ListWallets", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:230" + }, + "params": [], + "result": { + "name": "personal_listWalletsResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/rawWallet", + "$schema": "http://json-schema.org/draft-04/schema" + }, + "definitions": { + "Account": { + "type": "object", + "required": ["address", "url"], + "properties": { + "address": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "url": { + "$ref": "#/definitions/URL", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "additionalProperties": false + }, + "URL": { + "type": "object", + "required": ["Scheme", "Path"], + "properties": { + "Path": { + "type": "string" + }, + "Scheme": { + "type": "string" + } + }, + "additionalProperties": false + }, + "rawWallet": { + "type": "object", + "required": ["url", "status"], + "properties": { + "accounts": { + "type": "array", + "items": { + "$ref": "#/definitions/Account", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "failure": { + "type": "string" + }, + "status": { + "type": "string" + }, + "url": { + "type": "string" + } + }, + "additionalProperties": false + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_lockAccount", + "tags": [], + "summary": "LockAccount will lock the account associated with the given address when it's unlocked.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).LockAccount", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:337" + }, + "params": [ + { + "name": "addr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + } + ], + "result": { + "name": "personal_lockAccountResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_newAccount", + "tags": [], + "summary": "NewAccount will create a new account and returns the address for the new account.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).NewAccount", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:282" + }, + "params": [ + { + "name": "password", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "personal_newAccountResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_openWallet", + "tags": [], + "summary": "OpenWallet initiates a hardware wallet opening procedure, establishing a USB\nconnection and attempting to authenticate via the provided passphrase. Note,\nthe method may return an extra challenge requiring a second open (e.g. the\nTrezor PIN matrix challenge).\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).OpenWallet", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:252" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "passphrase", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*:string", + "type": "string" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_sendTransaction", + "tags": [], + "summary": "SendTransaction will create a transaction from the given arguments and\ntries to sign it with the key associated with args.To. If the given passwd isn't\nable to decrypt the key it fails.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).SendTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:364" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi:SendTxArgs", + "definitions": { + "SendTxArgs": { + "type": "object", + "required": [ + "from", + "to", + "gas", + "gasPrice", + "value", + "nonce", + "data", + "input" + ], + "properties": { + "data": { + "description": "Field _input_ should be preferred", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/SendTxArgs", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "passwd", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "personal_sendTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_sign", + "tags": [], + "summary": "Sign calculates an Ethereum ECDSA signature for:\nkeccack256(\"\\x19Ethereum Signed Message:\\n\" + len(message) + message))\n\nNote, the produced signature conforms to the secp256k1 curve R, S and V values,\nwhere the V value will be 27 or 28 for legacy reasons.\n\nThe key used to calculate the signature is decrypted with the given password.\n\nhttps://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_sign\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).Sign", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:416" + }, + "params": [ + { + "name": "data", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + }, + { + "name": "addr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + { + "name": "passwd", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "personal_signResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_signAndSendTransaction", + "tags": [], + "summary": "SignAndSendTransaction was renamed to SendTransaction. This method is deprecated\nand will be removed in the future. It primary goal is to give clients time to update.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).SignAndSendTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:462" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi:SendTxArgs", + "definitions": { + "SendTxArgs": { + "type": "object", + "required": [ + "from", + "to", + "gas", + "gasPrice", + "value", + "nonce", + "data", + "input" + ], + "properties": { + "data": { + "description": "Field _input_ should be preferred", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/SendTxArgs", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "passwd", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "personal_signAndSendTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a Keccak 256 hash", + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_signTransaction", + "tags": [], + "summary": "SignTransaction will create a transaction from the given arguments and\ntries to sign it with the key associated with args.To. If the given passwd isn't\nable to decrypt the key it fails. The transaction is returned in RLP-form, not broadcast\nto other nodes\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).SignTransaction", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:383" + }, + "params": [ + { + "name": "args", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi:SendTxArgs", + "definitions": { + "SendTxArgs": { + "type": "object", + "required": [ + "from", + "to", + "gas", + "gasPrice", + "value", + "nonce", + "data", + "input" + ], + "properties": { + "data": { + "description": "Field _input_ should be preferred", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + }, + "$ref": "#/definitions/SendTxArgs", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + { + "name": "passwd", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "passwd2", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": { + "name": "personal_signTransactionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "*github.com/ethereum/go-ethereum/internal/ethapi:SignTransactionResult", + "definitions": { + "SignTransactionResult": { + "type": "object", + "required": ["raw", "tx"], + "properties": { + "raw": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "tx": { + "$ref": "#/definitions/Transaction", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "additionalProperties": false + }, + "Transaction": { + "type": "object", + "additionalProperties": false + } + }, + "$ref": "#/definitions/SignTransactionResult", + "$schema": "http://json-schema.org/draft-04/schema" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_unlockAccount", + "tags": [], + "summary": "UnlockAccount will unlock the account associated with the given address with\nthe given password for duration seconds. If duration is nil it will use a\ndefault of 300 seconds. It returns an indication if the account was unlocked.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).UnlockAccount", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:312" + }, + "params": [ + { + "name": "addr", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "github.com/ethereum/go-ethereum/common:common.Address", + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + } + }, + { + "name": "password", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "duration", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + ], + "result": { + "name": "personal_unlockAccountResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":bool", + "type": "boolean" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "personal_unpair", + "tags": [], + "summary": "Unpair deletes a pairing between wallet and geth.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PrivateAccountAPI).Unpair", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:494" + }, + "params": [ + { + "name": "url", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + { + "name": "pin", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + } + ], + "result": null, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "txpool_content", + "tags": [], + "summary": "Content returns the transactions contained within the transaction pool.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTxPoolAPI).Content", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:111" + }, + "params": [], + "result": { + "name": "txpool_contentResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "patternProperties": { + ".*": { + "type": "object", + "patternProperties": { + ".*": { + "type": "object", + "patternProperties": { + ".*": { + "$ref": "#/definitions/RPCTransaction", + "$schema": "http://json-schema.org/draft-04/schema" + } + } + } + } + } + }, + "definitions": { + "RPCTransaction": { + "type": "object", + "required": [ + "blockHash", + "blockNumber", + "from", + "gas", + "gasPrice", + "hash", + "input", + "nonce", + "to", + "transactionIndex", + "value", + "v", + "r", + "s" + ], + "properties": { + "blockHash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "blockNumber": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "from": { + "type": "string", + "title": "address", + "pattern": "^0x[a-fA-F\\d]{40}$" + }, + "gas": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "gasPrice": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "hash": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "input": { + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + }, + "nonce": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "r": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "s": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "to": { + "type": "string", + "title": "keccak", + "pattern": "^0x[a-fA-F\\d]{64}$" + }, + "transactionIndex": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "v": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + }, + "value": { + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + }, + "additionalProperties": false + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "txpool_inspect", + "tags": [], + "summary": "Inspect retrieves the content of the transaction pool and flattens it into an\neasily inspectable list.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTxPoolAPI).Inspect", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:148" + }, + "params": [], + "result": { + "name": "txpool_inspectResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "patternProperties": { + ".*": { + "type": "object", + "patternProperties": { + ".*": { + "type": "object", + "patternProperties": { + ".*": { + "type": "string" + } + } + } + } + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "txpool_status", + "tags": [], + "summary": "Status returns the number of pending and queued transaction in the pool.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/internal/ethapi.(*PublicTxPoolAPI).Status", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/internal/ethapi/api.go:138" + }, + "params": [], + "result": { + "name": "txpool_statusResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "type": "object", + "patternProperties": { + ".*": { + "description": "Hex representation of the integer", + "type": "string", + "title": "integer", + "pattern": "^0x[a-fA-F0-9]+$" + } + } + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "web3_clientVersion", + "tags": [], + "summary": "ClientVersion returns the node name\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PublicWeb3API).ClientVersion", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:309" + }, + "params": [], + "result": { + "name": "web3_clientVersionResult", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": ":string", + "type": "string" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + }, + { + "name": "web3_sha3", + "tags": [], + "summary": "Sha3 applies the ethereum sha3 implementation on the input.\nIt assumes the input is hex encoded.\n", + "description": "", + "externalDocs": { + "description": "github.com/ethereum/go-ethereum/node.(*PublicWeb3API).Sha3", + "url": "file:///home/ia/go/src/github.com/ethereum/go-ethereum/node/api.go:315" + }, + "params": [ + { + "name": "input", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + } + ], + "result": { + "name": "web3_sha3Result", + "summary": "", + "description": "", + "required": false, + "deprecated": false, + "schema": { + "description": "Hex representation of a 256 bit unit of data", + "type": "string", + "title": "dataWord", + "pattern": "^0x([a-fA-F\\d]{64})?$" + } + }, + "deprecated": false, + "servers": [], + "errors": [], + "links": [], + "paramStructure": "by-position", + "examples": [] + } + ], + "components": { + "contentDescriptors": null, + "schemas": null, + "examples": null, + "links": null, + "errors": null, + "examplePairingObjects": null, + "tags": null + }, + "externalDocs": { + "description": "", + "url": "" + } + } +}