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

     1  // Copyright 2018 The klaytn Authors
     2  // Copyright 2017 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 accounts/accounts.go (2018/06/04).
    19  // Modified and improved for the klaytn development.
    20  
    21  /*
    22  Package accounts implements high level Klaytn account management.
    23  
    24  There are several important data structures and their hierarchy is as below
    25   Manager -> Backend -> Wallet -> Account
    26  
    27  Source Files
    28  
    29  Each file provides the following features
    30   - accounts.go	: Provides `Account` struct and Wallet/Backend interfaces. `Account` represents a Klaytn account located at a specific location defined by the optional URL field. `Wallet` represents a software or hardware wallet and `Backend` is a wallet provider that may contain a batch of accounts they can sign transactions with
    31   - errors.go	: Provides various account related error variables and helper functions
    32   - hd.go		: Defines derivation paths for Klaytn and parser function to derive the path from a path string. Klaytn uses 8217 as its coin type
    33   - manager.go 	: Provides `Manager` which is an overarching account manager that can communicate with various backends for signing transactions
    34   - url.go 	: Provides `URL` struct which represents the canonical identification URL of a wallet or account
    35  */
    36  package accounts