TrueCloudLab/neo-go
8
0
Fork 0
mirror of https://github.com/nspcc-dev/neo-go.git synced 2024-11-25 23:42:23 +00:00
Code Issues Projects Releases Packages Wiki Activity

wallet: add some warnings to Decrypt and PrivateKey docs

Browse source
This commit is contained in:
Roman Khimov 2022-09-01 21:03:37 +03:00
parent e164625a7f
commit cad0d7f00d
1 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
pkg/wallet/account.go
View file

@ -150,7 +150,9 @@ func (a *Account) GetVerificationScript() []byte {
} }
// Decrypt decrypts the EncryptedWIF with the given passphrase returning error // Decrypt decrypts the EncryptedWIF with the given passphrase returning error
// if anything goes wrong. // if anything goes wrong. After the decryption Account can be used to sign
// things unless it's locked. Don't decrypt the key unless you want to sign
// something and don't forget to call Close after use for maximum safety.
func (a *Account) Decrypt(passphrase string, scrypt keys.ScryptParams) error { func (a *Account) Decrypt(passphrase string, scrypt keys.ScryptParams) error {
var err error var err error
@ -176,7 +178,11 @@ func (a *Account) Encrypt(passphrase string, scrypt keys.ScryptParams) error {
return nil return nil
} }
// PrivateKey returns private key corresponding to the account. // PrivateKey returns private key corresponding to the account if it's unlocked.
// Please be very careful when using it, do not copy its contents and do not
// keep a pointer to it unless you absolutely need to. Most of the time you can
// use other methods (PublicKey, ScriptHash, SignHashable) depending on your
// needs and it'll be safer this way.
func (a *Account) PrivateKey() *keys.PrivateKey { func (a *Account) PrivateKey() *keys.PrivateKey {
return a.privateKey return a.privateKey
} }