github.com/klaytn/klaytn@v1.12.1/console/jsre/doc.go (about)

     1  // Copyright 2018 The klaytn Authors
     2  // Copyright 2015 The go-ethereum Authors
     3  // This file is part of the go-ethereum library.
     4  //
     5  // The go-ethereum library is free software: you can redistribute it and/or modify
     6  // it under the terms of the GNU Lesser General Public License as published by
     7  // the Free Software Foundation, either version 3 of the License, or
     8  // (at your option) any later version.
     9  //
    10  // The go-ethereum library is distributed in the hope that it will be useful,
    11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    13  // GNU Lesser General Public License for more details.
    14  //
    15  // You should have received a copy of the GNU Lesser General Public License
    16  // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
    17  //
    18  // This file is derived from internal/jsre/jsre.go (2018/06/04).
    19  // Modified and improved for the klaytn development.
    20  
    21  /*
    22  Package jsre provides an execution environment for JavaScript.
    23  
    24  JSRE is a generic JS runtime environment embedding the otto Javascript interpreter. <https://github.com/robertkrimen/otto>
    25   It provides some helper functions to
    26   - load code from files
    27   - run code snippets
    28   - require libraries
    29   - bind native go objects
    30  
    31  Because of JSRE, an user can utilize JavaScript in the console as needed.
    32  JSRE also provides two JavaScript libraries, bignumber.js and web3.js, for users to easily access Klaytn.
    33  
    34  Source Files
    35  
    36  Each file provides following features
    37   - completion.go	: Provides functions for keyword completion
    38   - jsre.go	: Wraps otto JavaScript interpreter and provides an event loop
    39   - pretty.go	: Prints results to the standard output in more readable way
    40  */
    41  package jsre