github.com/core-coin/go-core/v2@v2.1.9/accounts/errors.go (about)

     1  // Copyright 2017 by the Authors
     2  // This file is part of the go-core library.
     3  //
     4  // The go-core 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-core 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-core 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  // AuthNeededError is returned by backends for signing requests where the user
    37  // is required to provide further authentication before signing can succeed.
    38  //
    39  // This usually means either that a password needs to be supplied, or perhaps a
    40  // one time PIN code displayed by some hardware device.
    41  type AuthNeededError struct {
    42  	Needed string // Extra authentication the user needs to provide
    43  }
    44  
    45  // NewAuthNeededError creates a new authentication error with the extra details
    46  // about the needed fields set.
    47  func NewAuthNeededError(needed string) error {
    48  	return &AuthNeededError{
    49  		Needed: needed,
    50  	}
    51  }
    52  
    53  // Error implements the standard error interface.
    54  func (err *AuthNeededError) Error() string {
    55  	return fmt.Sprintf("authentication needed: %s", err.Needed)
    56  }