|
| 1 | +// Copyright 2016 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 bind |
| 18 | + |
| 19 | +import ( |
| 20 | + "context" |
| 21 | + "crypto/ecdsa" |
| 22 | + "errors" |
| 23 | + "io" |
| 24 | + "math/big" |
| 25 | + |
| 26 | + "github.com/ethereum/go-ethereum/accounts" |
| 27 | + "github.com/ethereum/go-ethereum/accounts/external" |
| 28 | + "github.com/ethereum/go-ethereum/accounts/keystore" |
| 29 | + "github.com/ethereum/go-ethereum/common" |
| 30 | + "github.com/ethereum/go-ethereum/core/types" |
| 31 | + "github.com/ethereum/go-ethereum/crypto" |
| 32 | + "github.com/ethereum/go-ethereum/log" |
| 33 | +) |
| 34 | + |
| 35 | +// ErrNoChainID is returned whenever the user failed to specify a chain id. |
| 36 | +var ErrNoChainID = errors.New("no chain id specified") |
| 37 | + |
| 38 | +// ErrNotAuthorized is returned when an account is not properly unlocked. |
| 39 | +var ErrNotAuthorized = errors.New("not authorized to sign this account") |
| 40 | + |
| 41 | +// NewTransactor is a utility method to easily create a transaction signer from |
| 42 | +// an encrypted json key stream and the associated passphrase. |
| 43 | +// |
| 44 | +// Deprecated: Use NewTransactorWithChainID instead. |
| 45 | +func NewTransactor(keyin io.Reader, passphrase string) (*TransactOpts, error) { |
| 46 | + log.Warn("WARNING: NewTransactor has been deprecated in favour of NewTransactorWithChainID") |
| 47 | + json, err := io.ReadAll(keyin) |
| 48 | + if err != nil { |
| 49 | + return nil, err |
| 50 | + } |
| 51 | + key, err := keystore.DecryptKey(json, passphrase) |
| 52 | + if err != nil { |
| 53 | + return nil, err |
| 54 | + } |
| 55 | + return NewKeyedTransactor(key.PrivateKey), nil |
| 56 | +} |
| 57 | + |
| 58 | +// NewKeyStoreTransactor is a utility method to easily create a transaction signer from |
| 59 | +// an decrypted key from a keystore. |
| 60 | +// |
| 61 | +// Deprecated: Use NewKeyStoreTransactorWithChainID instead. |
| 62 | +func NewKeyStoreTransactor(keystore *keystore.KeyStore, account accounts.Account) (*TransactOpts, error) { |
| 63 | + log.Warn("WARNING: NewKeyStoreTransactor has been deprecated in favour of NewTransactorWithChainID") |
| 64 | + signer := types.HomesteadSigner{} |
| 65 | + return &TransactOpts{ |
| 66 | + From: account.Address, |
| 67 | + Signer: func(address common.Address, tx *types.Transaction) (*types.Transaction, error) { |
| 68 | + if address != account.Address { |
| 69 | + return nil, ErrNotAuthorized |
| 70 | + } |
| 71 | + signature, err := keystore.SignHash(account, signer.Hash(tx).Bytes()) |
| 72 | + if err != nil { |
| 73 | + return nil, err |
| 74 | + } |
| 75 | + return tx.WithSignature(signer, signature) |
| 76 | + }, |
| 77 | + Context: context.Background(), |
| 78 | + }, nil |
| 79 | +} |
| 80 | + |
| 81 | +// NewKeyedTransactor is a utility method to easily create a transaction signer |
| 82 | +// from a single private key. |
| 83 | +// |
| 84 | +// Deprecated: Use NewKeyedTransactorWithChainID instead. |
| 85 | +func NewKeyedTransactor(key *ecdsa.PrivateKey) *TransactOpts { |
| 86 | + log.Warn("WARNING: NewKeyedTransactor has been deprecated in favour of NewKeyedTransactorWithChainID") |
| 87 | + keyAddr := crypto.PubkeyToAddress(key.PublicKey) |
| 88 | + signer := types.HomesteadSigner{} |
| 89 | + return &TransactOpts{ |
| 90 | + From: keyAddr, |
| 91 | + Signer: func(address common.Address, tx *types.Transaction) (*types.Transaction, error) { |
| 92 | + if address != keyAddr { |
| 93 | + return nil, ErrNotAuthorized |
| 94 | + } |
| 95 | + signature, err := crypto.Sign(signer.Hash(tx).Bytes(), key) |
| 96 | + if err != nil { |
| 97 | + return nil, err |
| 98 | + } |
| 99 | + return tx.WithSignature(signer, signature) |
| 100 | + }, |
| 101 | + Context: context.Background(), |
| 102 | + } |
| 103 | +} |
| 104 | + |
| 105 | +// NewTransactorWithChainID is a utility method to easily create a transaction signer from |
| 106 | +// an encrypted json key stream and the associated passphrase. |
| 107 | +func NewTransactorWithChainID(keyin io.Reader, passphrase string, chainID *big.Int) (*TransactOpts, error) { |
| 108 | + json, err := io.ReadAll(keyin) |
| 109 | + if err != nil { |
| 110 | + return nil, err |
| 111 | + } |
| 112 | + key, err := keystore.DecryptKey(json, passphrase) |
| 113 | + if err != nil { |
| 114 | + return nil, err |
| 115 | + } |
| 116 | + return NewKeyedTransactorWithChainID(key.PrivateKey, chainID) |
| 117 | +} |
| 118 | + |
| 119 | +// NewKeyStoreTransactorWithChainID is a utility method to easily create a transaction signer from |
| 120 | +// an decrypted key from a keystore. |
| 121 | +func NewKeyStoreTransactorWithChainID(keystore *keystore.KeyStore, account accounts.Account, chainID *big.Int) (*TransactOpts, error) { |
| 122 | + if chainID == nil { |
| 123 | + return nil, ErrNoChainID |
| 124 | + } |
| 125 | + signer := types.LatestSignerForChainID(chainID) |
| 126 | + return &TransactOpts{ |
| 127 | + From: account.Address, |
| 128 | + Signer: func(address common.Address, tx *types.Transaction) (*types.Transaction, error) { |
| 129 | + if address != account.Address { |
| 130 | + return nil, ErrNotAuthorized |
| 131 | + } |
| 132 | + signature, err := keystore.SignHash(account, signer.Hash(tx).Bytes()) |
| 133 | + if err != nil { |
| 134 | + return nil, err |
| 135 | + } |
| 136 | + return tx.WithSignature(signer, signature) |
| 137 | + }, |
| 138 | + Context: context.Background(), |
| 139 | + }, nil |
| 140 | +} |
| 141 | + |
| 142 | +// NewKeyedTransactorWithChainID is a utility method to easily create a transaction signer |
| 143 | +// from a single private key. |
| 144 | +func NewKeyedTransactorWithChainID(key *ecdsa.PrivateKey, chainID *big.Int) (*TransactOpts, error) { |
| 145 | + keyAddr := crypto.PubkeyToAddress(key.PublicKey) |
| 146 | + if chainID == nil { |
| 147 | + return nil, ErrNoChainID |
| 148 | + } |
| 149 | + signer := types.LatestSignerForChainID(chainID) |
| 150 | + return &TransactOpts{ |
| 151 | + From: keyAddr, |
| 152 | + Signer: func(address common.Address, tx *types.Transaction) (*types.Transaction, error) { |
| 153 | + if address != keyAddr { |
| 154 | + return nil, ErrNotAuthorized |
| 155 | + } |
| 156 | + signature, err := crypto.Sign(signer.Hash(tx).Bytes(), key) |
| 157 | + if err != nil { |
| 158 | + return nil, err |
| 159 | + } |
| 160 | + return tx.WithSignature(signer, signature) |
| 161 | + }, |
| 162 | + Context: context.Background(), |
| 163 | + }, nil |
| 164 | +} |
| 165 | + |
| 166 | +// NewClefTransactor is a utility method to easily create a transaction signer |
| 167 | +// with a clef backend. |
| 168 | +func NewClefTransactor(clef *external.ExternalSigner, account accounts.Account) *TransactOpts { |
| 169 | + return &TransactOpts{ |
| 170 | + From: account.Address, |
| 171 | + Signer: func(address common.Address, transaction *types.Transaction) (*types.Transaction, error) { |
| 172 | + if address != account.Address { |
| 173 | + return nil, ErrNotAuthorized |
| 174 | + } |
| 175 | + return clef.SignTx(account, transaction, nil) // Clef enforces its own chain id |
| 176 | + }, |
| 177 | + Context: context.Background(), |
| 178 | + } |
| 179 | +} |
0 commit comments