github.com/klaytn/klaytn@v1.12.1/api/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/ethapi/api.go (2018/06/04).
    19  // Modified and improved for the klaytn development.
    20  
    21  /*
    22  Package api implements the general Klaytn API functions.
    23  
    24  Overview of api package
    25  
    26  This package provides various APIs to access the data of the Klaytn node.
    27  Remote users can interact with Klyatn by calling these APIs instead of IPC.
    28  APIs are grouped by access modifiers (public or private) and namespaces (klay, txpool, debug and personal).
    29  
    30  Source Files
    31  
    32    - addrlock.go                    : implements Addrlocker which prevents another tx getting the same nonce through API.
    33    - api_private_account.go         : provides private APIs to access accounts managed by the node.
    34    - api_private_debug.go           : provides private APIs exposed over the debugging node.
    35    - api_public_account.go          : provides public APIs to access accounts managed by the node.
    36    - api_public_blockchain.go       : provides public APIs to access the Klaytn blockchain.
    37    - api_public_cypress.go          : provides public APIs to return specific information of Klaytn Cypress network.
    38    - api_public_debug.go            : provides public APIs exposed over the debugging node.
    39    - api_public_klay.go             : provides public APIs to access Klaytn related data.
    40    - api_public_net.go              : provides public APIs to offer network related RPC methods.
    41    - api_public_transaction_pool.go : provides public APIs having "klay" namespace to access transaction pool data.
    42    - api_public_tx_pool.go          : provides public APIs having "txpool" namespace to access transaction pool data.
    43    - backend.go                     : provides the common API services.
    44    - tx_args.go                     : provides API argument structures and functions.
    45  */
    46  package api