types

Documentation

Overview

This work is licensed and released under GNU GPL v3 or any other later versions. The full text of the license is below/ found at <http://www.gnu.org/licenses/>

(c) 2023 Rocket Pool Pty Ltd. Modified under GNU GPL v3. [1.5.0]

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

Index

• Constants
• type CurrentRewardCycleDetails
• type OperatorInfo
• type OperatorWithdrawInfo
• type PoolThresholdInfo
• type RewardCycleDetails
• type RewardShare
• type ValidatorContractInfo
• type ValidatorPubkey
  • func BytesToValidatorPubkey(value []byte) ValidatorPubkey
  • func HexToValidatorPubkey(value string) (ValidatorPubkey, error)
  • func (v ValidatorPubkey) Bytes() []byte
  • func (v ValidatorPubkey) Hex() string
  • func (v ValidatorPubkey) MarshalJSON() ([]byte, error)
  • func (v ValidatorPubkey) String() string
  • func (v *ValidatorPubkey) UnmarshalJSON(data []byte) error
• type ValidatorSignature
  • func BytesToValidatorSignature(value []byte) ValidatorSignature
  • func HexToValidatorSignature(value string) (ValidatorSignature, error)
  • func (v ValidatorSignature) Bytes() []byte
  • func (v ValidatorSignature) Hex() string
  • func (v ValidatorSignature) MarshalJSON() ([]byte, error)
  • func (v ValidatorSignature) String() string
  • func (v *ValidatorSignature) UnmarshalJSON(data []byte) error

Constants

const ValidatorPubkeyLength = 48 // bytes

Validator pubkey

const ValidatorSignatureLength = 96 // bytes

Validator signature

Types

type CurrentRewardCycleDetails

type CurrentRewardCycleDetails struct {
	StartBlock *big.Int
	EndBlock   *big.Int
}

type OperatorInfo

type OperatorInfo struct {
	Active                  bool
	OptedForSocializingPool bool
	OperatorName            string
	OperatorRewardAddress   common.Address
	OperatorAddress         common.Address
}

type OperatorWithdrawInfo

type OperatorWithdrawInfo struct {
	LastWithdrawReqTimestamp *big.Int
	TotalSDWithdrawReqAmount *big.Int
}

type PoolThresholdInfo

type PoolThresholdInfo struct {
	MinThreshold      *big.Int
	MaxThreshold      *big.Int
	WithdrawThreshold *big.Int
	Units             string
}

type RewardCycleDetails

type RewardCycleDetails struct {
	CurrentIndex      *big.Int
	CurrentStartBlock *big.Int
	CurrentEndBlock   *big.Int
}

type RewardShare

type RewardShare struct {
	UserShare     *big.Int
	OperatorShare *big.Int
	ProtocolShare *big.Int
}

type ValidatorContractInfo

type ValidatorContractInfo struct {
	Status               uint8
	Pubkey               []byte
	PreDepositSignature  []byte
	DepositSignature     []byte
	WithdrawVaultAddress common.Address
	OperatorId           *big.Int
	DepositBlock         *big.Int
	WithdrawnBlock       *big.Int
}

type ValidatorPubkey

type ValidatorPubkey [ValidatorPubkeyLength]byte

func BytesToValidatorPubkey

func BytesToValidatorPubkey(value []byte) ValidatorPubkey

func HexToValidatorPubkey

func HexToValidatorPubkey(value string) (ValidatorPubkey, error)

func (ValidatorPubkey) Bytes

func (v ValidatorPubkey) Bytes() []byte

Bytes conversion

func (ValidatorPubkey) Hex

func (v ValidatorPubkey) Hex() string

String conversion

func (ValidatorPubkey) MarshalJSON

func (v ValidatorPubkey) MarshalJSON() ([]byte, error)

JSON encoding

func (ValidatorPubkey) String

func (v ValidatorPubkey) String() string

func (*ValidatorPubkey) UnmarshalJSON

func (v *ValidatorPubkey) UnmarshalJSON(data []byte) error

type ValidatorSignature

type ValidatorSignature [ValidatorSignatureLength]byte

func BytesToValidatorSignature

func BytesToValidatorSignature(value []byte) ValidatorSignature

func HexToValidatorSignature

func HexToValidatorSignature(value string) (ValidatorSignature, error)

func (ValidatorSignature) Bytes

func (v ValidatorSignature) Bytes() []byte

Bytes conversion

func (ValidatorSignature) Hex

func (v ValidatorSignature) Hex() string

String conversion

func (ValidatorSignature) MarshalJSON

func (v ValidatorSignature) MarshalJSON() ([]byte, error)

JSON encoding

func (ValidatorSignature) String

func (v ValidatorSignature) String() string

func (*ValidatorSignature) UnmarshalJSON

func (v *ValidatorSignature) UnmarshalJSON(data []byte) error