console

Documentation

Index

• Constants
• type Config
• type Console
  • func New(config Config) (*Console, error)
  • func (c *Console) AutoCompleteInput(line string, pos int) (string, []string, string)
  • func (c *Console) Evaluate(statement string)
  • func (c *Console) Interactive()
  • func (c *Console) Stop(graceful bool) error
  • func (c *Console) StopInteractive()
  • func (c *Console) Welcome()

Constants

const DefaultPrompt = "> "

DefaultPrompt is the default prompt line prefix to use for user input querying.

const HistoryFile = "history"

HistoryFile is the file within the data directory to store input scrollback.

Types

type Config

type Config struct {
	DataDir  string              // Data directory to store the console history at
	DocRoot  string              // Filesystem path from where to load JavaScript files from
	Client   *rpc.Client         // RPC client to execute Ethereum requests through
	Prompt   string              // Input prompt prefix string (defaults to DefaultPrompt)
	Prompter prompt.UserPrompter // Input prompter to allow interactive user feedback (defaults to TerminalPrompter)
	Printer  io.Writer           // Output writer to serialize any display strings to (defaults to os.Stdout)
	Preload  []string            // Absolute paths to JavaScript files to preload
}

Config is the collection of configurations to fine tune the behavior of the JavaScript console.

type Console

type Console struct {
	// contains filtered or unexported fields
}

Console is a JavaScript interpreted runtime environment. It is a fully fledged JavaScript console attached to a running node via an external or in-process RPC client.

func New

func New(config Config) (*Console, error)

New initializes a JavaScript interpreted runtime environment and sets defaults with the config struct.

func (*Console) AutoCompleteInput

func (c *Console) AutoCompleteInput(line string, pos int) (string, []string, string)

AutoCompleteInput is a pre-assembled word completer to be used by the user input prompter to provide hints to the user about the methods available.

func (*Console) Evaluate

func (c *Console) Evaluate(statement string)

Evaluate executes code and pretty prints the result to the specified output stream.

func (*Console) Interactive

func (c *Console) Interactive()

Interactive starts an interactive user session, where input is prompted from the configured user prompter.

func (*Console) Stop

func (c *Console) Stop(graceful bool) error

Stop cleans up the console and terminates the runtime environment.

func (*Console) StopInteractive

func (c *Console) StopInteractive()

StopInteractive causes Interactive to return as soon as possible.

func (*Console) Welcome

func (c *Console) Welcome()

Welcome show summary of current Geth instance and some metadata about the console's available modules.