node/vms/platformvm/txs/add_permissionless_delegator_tx.go

// Copyright (C) 2019-2026, Lux Industries Inc. All rights reserved.
// See the file LICENSE for licensing terms.

package txs

import (
	"context"
	"fmt"
	"time"

	"github.com/luxfi/constants"
	bls "github.com/luxfi/crypto/bls"
	"github.com/luxfi/ids"
	safemath "github.com/luxfi/math"
	"github.com/luxfi/node/vms/components/verify"
	"github.com/luxfi/node/vms/platformvm/fx"
	"github.com/luxfi/runtime"
	lux "github.com/luxfi/utxo"
	"github.com/luxfi/utxo/secp256k1fx"
	"github.com/luxfi/zap"
)

var (
	_ UnsignedTx      = (*AddPermissionlessDelegatorTx)(nil)
	_ DelegatorTx     = (*AddPermissionlessDelegatorTx)(nil)
	_ ScheduledStaker = (*AddPermissionlessDelegatorTx)(nil)
)

// AddPermissionlessDelegatorTx is an unsigned addPermissionlessDelegatorTx.
// The struct IS the wire: it holds the zap buffer and reads its fields by
// offset. No codec, no marshal.
//
// Wire: zap header + object{ [email protected], Validator@77, Chain@121,
// StakeOuts@153, DelegationRewardsOwner@169 }.
type AddPermissionlessDelegatorTx struct {
	spendingTx
}

const (
	offAPDValidator                = spendSize                       // 77: inline Validator (44B)
	offAPDChain                    = offAPDValidator + validatorSize // 121: chain id (32B)
	offAPDStakeOuts                = offAPDChain + 32                // 153: stake-outs list ptr (8B)
	offAPDStakeAddrs               = offAPDStakeOuts + 8             // 161: stake-outs owner-addr array ptr (8B)
	offAPDRewardsThreshold         = offAPDStakeAddrs + 8            // 169: rewards owner threshold (u32)
	offAPDRewardsLocktime          = offAPDRewardsThreshold + 4      // 173: rewards owner locktime (u64)
	offAPDRewardsAddrs             = offAPDRewardsLocktime + 8       // 181: rewards owner addr array ptr (8B)
	addPermissionlessDelegatorSize = offAPDRewardsAddrs + 8          // 189
)

// NewAddPermissionlessDelegatorTx builds the tx into a fresh zap buffer.
func NewAddPermissionlessDelegatorTx(base *lux.BaseTx, validator Validator, chain ids.ID, stakeOuts []*lux.TransferableOutput, delegationRewardsOwner fx.Owner) (*AddPermissionlessDelegatorTx, error) {
	b := zap.NewBuilder(zap.HeaderSize + 1024 + addPermissionlessDelegatorSize)
	p, err := writeSpending(b, base)
	if err != nil {
		return nil, err
	}
	stakeListOff, stakeListCount, stakeAddrOff, stakeAddrCount, err := writeExtraOuts(b, stakeOuts)
	if err != nil {
		return nil, err
	}
	ownerThreshold, ownerLocktime, ownerAddrOff, ownerAddrCount, err := writeOwner(b, delegationRewardsOwner)
	if err != nil {
		return nil, err
	}

	ob := b.StartObject(addPermissionlessDelegatorSize)
	setEnvelope(ob, kindAddPermissionlessDelegator, base, p)
	setValidator(ob, offAPDValidator, validator)
	setID(ob, offAPDChain, chain)
	ob.SetList(offAPDStakeOuts, stakeListOff, stakeListCount)
	ob.SetList(offAPDStakeAddrs, stakeAddrOff, stakeAddrCount)
	setOwner(ob, offAPDRewardsThreshold, offAPDRewardsLocktime, offAPDRewardsAddrs, ownerThreshold, ownerLocktime, ownerAddrOff, ownerAddrCount)
	ob.FinishAsRoot()

	msg, _ := zap.Parse(b.Finish())
	return &AddPermissionlessDelegatorTx{spendingTx{msg}}, nil
}

// Validator describes the validator being delegated to (offset read).
func (tx *AddPermissionlessDelegatorTx) Validator() Validator {
	return readValidator(tx.root(), offAPDValidator)
}

// Chain is the id of the chain this validator is validating (offset read).
func (tx *AddPermissionlessDelegatorTx) Chain() ids.ID { return readID(tx.root(), offAPDChain) }

// StakeOuts is where staked tokens go when done validating (offset read).
func (tx *AddPermissionlessDelegatorTx) StakeOuts() []*lux.TransferableOutput {
	return readExtraOuts(tx.root(), offAPDStakeOuts, offAPDStakeAddrs)
}

// DelegationRewardsOwner is where staking rewards go when done validating.
func (tx *AddPermissionlessDelegatorTx) DelegationRewardsOwner() fx.Owner {
	return readOwner(tx.root(), offAPDRewardsThreshold, offAPDRewardsLocktime, offAPDRewardsAddrs)
}

// ---- Staker / DelegatorTx / ScheduledStaker interface ----

func (tx *AddPermissionlessDelegatorTx) ChainID() ids.ID {
	return tx.Chain()
}

func (tx *AddPermissionlessDelegatorTx) NodeID() ids.NodeID {
	return tx.Validator().NodeID
}

func (*AddPermissionlessDelegatorTx) PublicKey() (*bls.PublicKey, bool, error) {
	return nil, false, nil
}

func (tx *AddPermissionlessDelegatorTx) StartTime() time.Time {
	return time.Unix(int64(tx.Validator().Start), 0)
}

func (tx *AddPermissionlessDelegatorTx) EndTime() time.Time {
	return time.Unix(int64(tx.Validator().End), 0)
}

func (tx *AddPermissionlessDelegatorTx) Weight() uint64 {
	return tx.Validator().Wght
}

func (tx *AddPermissionlessDelegatorTx) PendingPriority() Priority {
	if tx.Chain() == constants.PrimaryNetworkID {
		return PrimaryNetworkDelegatorPermissionlessPendingPriority
	}
	return ChainPermissionlessDelegatorPendingPriority
}

func (tx *AddPermissionlessDelegatorTx) CurrentPriority() Priority {
	if tx.Chain() == constants.PrimaryNetworkID {
		return PrimaryNetworkDelegatorCurrentPriority
	}
	return ChainPermissionlessDelegatorCurrentPriority
}

// Stake is where staked tokens go when done validating, with FxID set on
// each output (secp256k1fx) as the legacy InitRuntime did.
func (tx *AddPermissionlessDelegatorTx) Stake() []*lux.TransferableOutput {
	outs := tx.StakeOuts()
	for _, out := range outs {
		out.FxID = secp256k1fx.ID
	}
	return outs
}

func (tx *AddPermissionlessDelegatorTx) RewardsOwner() fx.Owner {
	return tx.DelegationRewardsOwner()
}

// SyntacticVerify returns nil iff [tx] is valid.
func (tx *AddPermissionlessDelegatorTx) SyntacticVerify(rt *runtime.Runtime) error {
	if tx == nil {
		return ErrNilTx
	}
	stakeOuts := tx.StakeOuts()
	if len(stakeOuts) == 0 { // Ensure there is provided stake
		return errNoStake
	}

	if err := verifyBaseTx(tx.baseTx(), rt); err != nil {
		return fmt.Errorf("failed to verify BaseTx: %w", err)
	}
	v := tx.Validator()
	if err := verify.All(&v, tx.DelegationRewardsOwner()); err != nil {
		return fmt.Errorf("failed to verify validator or rewards owner: %w", err)
	}

	for _, out := range stakeOuts {
		if err := out.Verify(); err != nil {
			return fmt.Errorf("failed to verify output: %w", err)
		}
	}

	firstStakeOutput := stakeOuts[0]
	stakedAssetID := firstStakeOutput.AssetID()
	totalStakeWeight := firstStakeOutput.Output().Amount()
	for _, out := range stakeOuts[1:] {
		newWeight, err := safemath.Add(totalStakeWeight, out.Output().Amount())
		if err != nil {
			return err
		}
		totalStakeWeight = newWeight

		assetID := out.AssetID()
		if assetID != stakedAssetID {
			return fmt.Errorf("%w: %q and %q", errMultipleStakedAssets, stakedAssetID, assetID)
		}
	}

	switch {
	case !lux.IsSortedTransferableOutputs(stakeOuts):
		return errOutputsNotSorted
	case totalStakeWeight != v.Wght:
		return fmt.Errorf("%w, delegator weight %d total stake weight %d",
			errDelegatorWeightMismatch,
			v.Wght,
			totalStakeWeight,
		)
	}
	return nil
}

func (tx *AddPermissionlessDelegatorTx) Visit(visitor Visitor) error {
	return visitor.AddPermissionlessDelegatorTx(tx)
}

// Initialize is a no-op; Runtime is passed explicitly to InitRuntime.
func (tx *AddPermissionlessDelegatorTx) Initialize(ctx context.Context) error {
	return nil
}