code.vegaprotocol.io/vega@v0.79.0/wallet/api/admin_describe_wallet.go (about)

     1  // Copyright (C) 2023 Gobalsky Labs Limited
     2  //
     3  // This program is free software: you can redistribute it and/or modify
     4  // it under the terms of the GNU Affero General Public License as
     5  // published by the Free Software Foundation, either version 3 of the
     6  // License, or (at your option) any later version.
     7  //
     8  // This program is distributed in the hope that it will be useful,
     9  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    10  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    11  // GNU Affero General Public License for more details.
    12  //
    13  // You should have received a copy of the GNU Affero General Public License
    14  // along with this program.  If not, see <http://www.gnu.org/licenses/>.
    15  
    16  package api
    17  
    18  import (
    19  	"context"
    20  	"fmt"
    21  
    22  	"code.vegaprotocol.io/vega/libs/jsonrpc"
    23  
    24  	"github.com/mitchellh/mapstructure"
    25  )
    26  
    27  type AdminDescribeWalletParams struct {
    28  	Wallet string `json:"wallet"`
    29  }
    30  
    31  type AdminDescribeWalletResult struct {
    32  	Name                 string `json:"name"`
    33  	ID                   string `json:"id"`
    34  	Type                 string `json:"type"`
    35  	KeyDerivationVersion uint32 `json:"keyDerivationVersion"`
    36  }
    37  
    38  type AdminDescribeWallet struct {
    39  	walletStore WalletStore
    40  }
    41  
    42  func (h *AdminDescribeWallet) Handle(ctx context.Context, rawParams jsonrpc.Params) (jsonrpc.Result, *jsonrpc.ErrorDetails) {
    43  	params, err := validateDescribeWalletParams(rawParams)
    44  	if err != nil {
    45  		return nil, InvalidParams(err)
    46  	}
    47  
    48  	if exist, err := h.walletStore.WalletExists(ctx, params.Wallet); err != nil {
    49  		return nil, InternalError(fmt.Errorf("could not verify the wallet exists: %w", err))
    50  	} else if !exist {
    51  		return nil, InvalidParams(ErrWalletDoesNotExist)
    52  	}
    53  
    54  	alreadyUnlocked, err := h.walletStore.IsWalletAlreadyUnlocked(ctx, params.Wallet)
    55  	if err != nil {
    56  		return nil, InternalError(fmt.Errorf("could not verify whether the wallet is already unlock or not: %w", err))
    57  	}
    58  	if !alreadyUnlocked {
    59  		return nil, RequestNotPermittedError(ErrWalletIsLocked)
    60  	}
    61  
    62  	w, err := h.walletStore.GetWallet(ctx, params.Wallet)
    63  	if err != nil {
    64  		return nil, InternalError(fmt.Errorf("could not retrieve the wallet: %w", err))
    65  	}
    66  
    67  	return AdminDescribeWalletResult{
    68  		Name:                 w.Name(),
    69  		ID:                   w.ID(),
    70  		Type:                 w.Type(),
    71  		KeyDerivationVersion: w.KeyDerivationVersion(),
    72  	}, nil
    73  }
    74  
    75  func validateDescribeWalletParams(rawParams jsonrpc.Params) (AdminDescribeWalletParams, error) {
    76  	if rawParams == nil {
    77  		return AdminDescribeWalletParams{}, ErrParamsRequired
    78  	}
    79  
    80  	params := AdminDescribeWalletParams{}
    81  	if err := mapstructure.Decode(rawParams, &params); err != nil {
    82  		return AdminDescribeWalletParams{}, ErrParamsDoNotMatch
    83  	}
    84  
    85  	if params.Wallet == "" {
    86  		return AdminDescribeWalletParams{}, ErrWalletIsRequired
    87  	}
    88  
    89  	return params, nil
    90  }
    91  
    92  func NewAdminDescribeWallet(
    93  	walletStore WalletStore,
    94  ) *AdminDescribeWallet {
    95  	return &AdminDescribeWallet{
    96  		walletStore: walletStore,
    97  	}
    98  }