feat: add sysvars (#457)

* feat: add sysvars

* fix: add checks

Author: sonicfromnewyoke

sysvar/clock.go

@@ -0,0 +1,113 @@
+// Copyright 2021 github.com/gagliardetto
+//
+// 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.
+
+package sysvar
+
+import (
+	"encoding/binary"
+
+	bin "github.com/gagliardetto/binary"
+)
+
+// ClockSize is the serialized size, in bytes, of the Clock sysvar (5 x u64/i64).
+const ClockSize = 40
+
+// Cluster timing constants from the solana-sdk clock crate.
+const (
+	DefaultTicksPerSecond  uint64 = 160
+	DefaultTicksPerSlot    uint64 = 64
+	DefaultHashesPerSecond uint64 = 10_000_000
+	SecondsPerDay          uint64 = 24 * 60 * 60
+	TicksPerDay            uint64 = DefaultTicksPerSecond * SecondsPerDay
+	// DefaultSlotsPerEpoch is ~2 days of slots (432000).
+	DefaultSlotsPerEpoch uint64 = 2 * TicksPerDay / DefaultTicksPerSlot
+	// DefaultMsPerSlot is the default slot duration in milliseconds (400).
+	DefaultMsPerSlot uint64 = 1000 * DefaultTicksPerSlot / DefaultTicksPerSecond
+	// MaxRecentBlockhashes is the number of blockhashes kept in the
+	// RecentBlockhashes sysvar (300).
+	MaxRecentBlockhashes uint64 = 120 * DefaultTicksPerSecond / DefaultTicksPerSlot
+	// MaxProcessingAge is the number of blocks a blockhash is valid for (150).
+	MaxProcessingAge uint64 = MaxRecentBlockhashes / 2
+)
+
+// Clock is the data of the Clock sysvar (account solana.SysVarClockPubkey). It records
+// the cluster's notion of time. Mirrors solana-sdk clock::Clock.
+type Clock struct {
+	// Slot is the current slot.
+	Slot uint64
+	// EpochStartTimestamp is the Unix timestamp (seconds) of the first slot in
+	// the current epoch. Signed.
+	EpochStartTimestamp int64
+	// Epoch is the current epoch.
+	Epoch uint64
+	// LeaderScheduleEpoch is the most recent epoch for which the leader schedule
+	// has been calculated.
+	LeaderScheduleEpoch uint64
+	// UnixTimestamp is the validator-estimated Unix timestamp (seconds) of the
+	// current slot. Signed.
+	UnixTimestamp int64
+}
+
+func (c Clock) MarshalWithEncoder(encoder *bin.Encoder) error {
+	if err := encoder.WriteUint64(c.Slot, binary.LittleEndian); err != nil {
+		return err
+	}
+	if err := encoder.WriteUint64(uint64(c.EpochStartTimestamp), binary.LittleEndian); err != nil {
+		return err
+	}
+	if err := encoder.WriteUint64(c.Epoch, binary.LittleEndian); err != nil {
+		return err
+	}
+	if err := encoder.WriteUint64(c.LeaderScheduleEpoch, binary.LittleEndian); err != nil {
+		return err
+	}
+	return encoder.WriteUint64(uint64(c.UnixTimestamp), binary.LittleEndian)
+}
+
+func (c *Clock) UnmarshalWithDecoder(decoder *bin.Decoder) error {
+	var err error
+	if c.Slot, err = decoder.ReadUint64(binary.LittleEndian); err != nil {
+		return err
+	}
+	v, err := decoder.ReadUint64(binary.LittleEndian)
+	if err != nil {
+		return err
+	}
+	c.EpochStartTimestamp = int64(v)
+	if c.Epoch, err = decoder.ReadUint64(binary.LittleEndian); err != nil {
+		return err
+	}
+	if c.LeaderScheduleEpoch, err = decoder.ReadUint64(binary.LittleEndian); err != nil {
+		return err
+	}
+	if v, err = decoder.ReadUint64(binary.LittleEndian); err != nil {
+		return err
+	}
+	c.UnixTimestamp = int64(v)
+	return nil
+}
+
+func (c Clock) MarshalBinary() ([]byte, error) { return encodeSysvar(c) }
+func (c *Clock) UnmarshalBinary(data []byte) error {
+	return c.UnmarshalWithDecoder(bin.NewBinDecoder(data))
+}
+
+// DecodeClock decodes Clock sysvar account data.
+func DecodeClock(data []byte) (*Clock, error) {
+	var c Clock
+	if err := c.UnmarshalBinary(data); err != nil {
+		return nil, err
+	}
+	return &c, nil
+}

sysvar/epoch_rewards.go

@@ -0,0 +1,122 @@
+// Copyright 2021 github.com/gagliardetto
+//
+// 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.
+
+package sysvar
+
+import (
+	"encoding/binary"
+	"fmt"
+
+	bin "github.com/gagliardetto/binary"
+	solana "github.com/gagliardetto/solana-go"
+)
+
+// EpochRewardsSize is the serialized size, in bytes, of the EpochRewards sysvar.
+const EpochRewardsSize = 81
+
+// EpochRewards is the data of the EpochRewards sysvar (account
+// solana.SysVarEpochRewardsPubkey): the state of the partitioned epoch-rewards
+// distribution. Mirrors solana-sdk epoch_rewards::EpochRewards.
+type EpochRewards struct {
+	// DistributionStartingBlockHeight is the block height at which rewards
+	// distribution started for the current epoch.
+	DistributionStartingBlockHeight uint64
+	// NumPartitions is the number of partitions rewards are split across.
+	NumPartitions uint64
+	// ParentBlockhash is the blockhash of the epoch's last block, used to seed
+	// the partition shuffle.
+	ParentBlockhash solana.Hash
+	// TotalPoints is the total rewards points (u128) calculated for the epoch.
+	TotalPoints bin.Uint128
+	// TotalRewards is the total rewards, in lamports, for the epoch.
+	TotalRewards uint64
+	// DistributedRewards is the rewards, in lamports, distributed so far.
+	DistributedRewards uint64
+	// Active reports whether rewards distribution is in progress.
+	Active bool
+}
+
+// Distribute records that amount more lamports of rewards have been distributed.
+// It returns an error if that would push DistributedRewards above TotalRewards
+// (or overflow), mirroring the assertion in EpochRewards::distribute.
+func (e *EpochRewards) Distribute(amount uint64) error {
+	newDistributed := e.DistributedRewards + amount
+	if newDistributed < e.DistributedRewards || newDistributed > e.TotalRewards {
+		return fmt.Errorf("epoch rewards: distributing %d would exceed total rewards %d", amount, e.TotalRewards)
+	}
+	e.DistributedRewards = newDistributed
+	return nil
+}
+
+func (e EpochRewards) MarshalWithEncoder(encoder *bin.Encoder) error {
+	if err := encoder.WriteUint64(e.DistributionStartingBlockHeight, binary.LittleEndian); err != nil {
+		return err
+	}
+	if err := encoder.WriteUint64(e.NumPartitions, binary.LittleEndian); err != nil {
+		return err
+	}
+	if err := encoder.WriteBytes(e.ParentBlockhash[:], false); err != nil {
+		return err
+	}
+	if err := encoder.WriteUint128(e.TotalPoints, binary.LittleEndian); err != nil {
+		return err
+	}
+	if err := encoder.WriteUint64(e.TotalRewards, binary.LittleEndian); err != nil {
+		return err
+	}
+	if err := encoder.WriteUint64(e.DistributedRewards, binary.LittleEndian); err != nil {
+		return err
+	}
+	return encoder.WriteBool(e.Active)
+}
+
+func (e *EpochRewards) UnmarshalWithDecoder(decoder *bin.Decoder) error {
+	var err error
+	if e.DistributionStartingBlockHeight, err = decoder.ReadUint64(binary.LittleEndian); err != nil {
+		return err
+	}
+	if e.NumPartitions, err = decoder.ReadUint64(binary.LittleEndian); err != nil {
+		return err
+	}
+	buf, err := decoder.ReadNBytes(32)
+	if err != nil {
+		return err
+	}
+	copy(e.ParentBlockhash[:], buf)
+	if e.TotalPoints, err = decoder.ReadUint128(binary.LittleEndian); err != nil {
+		return err
+	}
+	if e.TotalRewards, err = decoder.ReadUint64(binary.LittleEndian); err != nil {
+		return err
+	}
+	if e.DistributedRewards, err = decoder.ReadUint64(binary.LittleEndian); err != nil {
+		return err
+	}
+	e.Active, err = decoder.ReadBool()
+	return err
+}
+
+func (e EpochRewards) MarshalBinary() ([]byte, error) { return encodeSysvar(e) }
+func (e *EpochRewards) UnmarshalBinary(data []byte) error {
+	return e.UnmarshalWithDecoder(bin.NewBinDecoder(data))
+}
+
+// DecodeEpochRewards decodes EpochRewards sysvar account data.
+func DecodeEpochRewards(data []byte) (*EpochRewards, error) {
+	var e EpochRewards
+	if err := e.UnmarshalBinary(data); err != nil {
+		return nil, err
+	}
+	return &e, nil
+}