keystores

Documentation

Overview

MIT License

Copyright (c) 2020 @protolambda

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Copyright 2022 Nethermind

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2022 Nethermind

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Constants
• Variables
• func CreateDepositData(vkgd ValidatorKeysGenData) error
• func CreateKeystores(vkgd ValidatorKeysGenData) error
• func CreateMnemonic() (string, error)
• func ValidateKeystoreDir(dir string) (errors []error)
• type KeyEntry
  • func NewKeyEntry(priv e2types.PrivateKey, keyPath string, ww *WalletWriter, insecure bool) (*KeyEntry, error)
  • func (ke *KeyEntry) MarshalJSON() ([]byte, error)
• type KeyFile
• type ValidatorKeysGenData
• type WalletOutput
• type WalletWriter
  • func NewWalletWriter(entries uint64, passphrase string) *WalletWriter
  • func (ww *WalletWriter) InsertAccount(priv e2types.PrivateKey, keyPath string, insecure bool, idx uint64) error
  • func (ww *WalletWriter) WriteOutputs(fpath string) error

Constants

const (
	DepositDataFileName      = "deposit_data.json"
	KeystorePasswordFileName = "keystore_password.txt"
	ValidatorKeysDirName     = "validator_keys"
)

Variables

var (
	ErrDepositDataNotFound              = errors.New("deposit_data.json not found")
	ErrKeystorePasswordNotFound         = errors.New("keystore_password.txt not found")
	ErrValidatorKeysDirNotFound         = errors.New("validator_keys directory not found")
	ErrValidatorKeysDirWithoutKeystores = errors.New("validator_keys directory does not contain any keystores")
	ErrInvalidKeystoreFile              = errors.New("invalid keystore file")
	ErrInvalidKeystoreFileName          = errors.New("invalid keystore file name")
	ErrInvalidKeystoreFileSchema        = errors.New("file does not match keystore schema (EIP-2335)")
	ErrInvalidDepositDataFileSchema     = errors.New("file does not match deposit data schema")
)

Functions

func CreateDepositData

func CreateDepositData(
	vkgd ValidatorKeysGenData,
) error

func CreateKeystores

func CreateKeystores(
	vkgd ValidatorKeysGenData,
) error

func CreateMnemonic

func CreateMnemonic() (string, error)

func ValidateKeystoreDir

func ValidateKeystoreDir(dir string) (errors []error)

Types

type KeyEntry

type KeyEntry struct {
	KeyFile
	// contains filtered or unexported fields
}

func NewKeyEntry

func NewKeyEntry(priv e2types.PrivateKey, keyPath string, ww *WalletWriter, insecure bool) (*KeyEntry, error)

func (*KeyEntry) MarshalJSON

func (ke *KeyEntry) MarshalJSON() ([]byte, error)

type KeyFile

type KeyFile struct {
	// contains filtered or unexported fields
}

Following EIP 2335

type ValidatorKeysGenData

type ValidatorKeysGenData struct {
	Mnemonic            string
	UseUniquePassphrase bool
	Passphrase          string
	OutputPath          string
	MinIndex            uint64
	MaxIndex            uint64
	Insecure            bool
	NetworkName         string
	ForkVersion         string
	AmountGwei          uint64
	AsJsonList          bool
	WithdrawalAddress   string
}

type WalletOutput

type WalletOutput interface {
	InsertAccount(priv e2types.PrivateKey, keyPath string, insecure bool, idx uint64) error
}

type WalletWriter

type WalletWriter struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func NewWalletWriter

func NewWalletWriter(entries uint64, passphrase string) *WalletWriter

func (*WalletWriter) InsertAccount

func (ww *WalletWriter) InsertAccount(priv e2types.PrivateKey, keyPath string, insecure bool, idx uint64) error

func (*WalletWriter) WriteOutputs

func (ww *WalletWriter) WriteOutputs(fpath string) error