github.com/Inphi/go-ethereum@v1.9.7/accounts/errors.go (about)

     1  // Copyright 2017 The go-ethereum Authors
     2  // This file is part of the go-ethereum library.
     3  //
     4  // The go-ethereum library is free software: you can redistribute it and/or modify
     5  // it under the terms of the GNU Lesser General Public License as published by
     6  // the Free Software Foundation, either version 3 of the License, or
     7  // (at your option) any later version.
     8  //
     9  // The go-ethereum library is distributed in the hope that it will be useful,
    10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    12  // GNU Lesser General Public License for more details.
    13  //
    14  // You should have received a copy of the GNU Lesser General Public License
    15  // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  package accounts
    18  
    19  import (
    20  	"errors"
    21  	"fmt"
    22  )
    23  
    24  // ErrUnknownAccount is returned for any requested operation for which no backend
    25  // provides the specified account.
    26  var ErrUnknownAccount = errors.New("unknown account")
    27  
    28  // ErrUnknownWallet is returned for any requested operation for which no backend
    29  // provides the specified wallet.
    30  var ErrUnknownWallet = errors.New("unknown wallet")
    31  
    32  // ErrNotSupported is returned when an operation is requested from an account
    33  // backend that it does not support.
    34  var ErrNotSupported = errors.New("not supported")
    35  
    36  // ErrInvalidPassphrase is returned when a decryption operation receives a bad
    37  // passphrase.
    38  var ErrInvalidPassphrase = errors.New("invalid password")
    39  
    40  // ErrWalletAlreadyOpen is returned if a wallet is attempted to be opened the
    41  // second time.
    42  var ErrWalletAlreadyOpen = errors.New("wallet already open")
    43  
    44  // ErrWalletClosed is returned if a wallet is attempted to be opened the
    45  // secodn time.
    46  var ErrWalletClosed = errors.New("wallet closed")
    47  
    48  // AuthNeededError is returned by backends for signing requests where the user
    49  // is required to provide further authentication before signing can succeed.
    50  //
    51  // This usually means either that a password needs to be supplied, or perhaps a
    52  // one time PIN code displayed by some hardware device.
    53  type AuthNeededError struct {
    54  	Needed string // Extra authentication the user needs to provide
    55  }
    56  
    57  // NewAuthNeededError creates a new authentication error with the extra details
    58  // about the needed fields set.
    59  func NewAuthNeededError(needed string) error {
    60  	return &AuthNeededError{
    61  		Needed: needed,
    62  	}
    63  }
    64  
    65  // Error implements the standard error interface.
    66  func (err *AuthNeededError) Error() string {
    67  	return fmt.Sprintf("authentication needed: %s", err.Needed)
    68  }