sdk/models/sidecar.go

// Copyright (C) 2022, Lux Industries Inc All rights reserved.
// See the file LICENSE for licensing terms.
package models

import (
	"github.com/luxfi/ids"
)

type TokenInfo struct {
	Name     string `json:"name"`
	Symbol   string `json:"symbol"`
	Decimals uint8  `json:"decimals"`
	Supply   string `json:"supply"`
}

type NetworkData struct {
	ChainID                    ids.ID // Chain identifier (validator set)
	BlockchainID               ids.ID // Blockchain ID
	RPCVersion                 int
	RPCEndpoints               []string // RPC endpoints for the network
	WSEndpoints                []string // WebSocket endpoints for the network
	TeleporterRegistryAddress  string   // Teleporter registry address
	TeleporterMessengerAddress string   // Teleporter messenger address
	ValidatorManagerAddress    string   // Validator manager contract address
	ValidatorIDs               []string // Validator IDs for the network
}

type MultisigTxInfo struct {
	Threshold uint32   `json:"threshold"`
	Addresses []string `json:"addresses"`
}

type PermissionlessValidators struct {
	TxID ids.ID
}
type ElasticChain struct {
	ChainID     ids.ID // Chain identifier
	AssetID     ids.ID
	PChainTXID  ids.ID
	TokenName   string
	TokenSymbol string
	Validators  map[string]PermissionlessValidators
	Txs         map[string]ids.ID
}

// ElasticNet is an alias for ElasticChain (deprecated)
type ElasticNet = ElasticChain

type Sidecar struct {
	Name            string
	VM              VMType
	VMID            string
	VMVersion       string
	RPCVersion      int
	Chain           string // Chain name
	ChainID         ids.ID // Chain identifier (validator set)
	BlockchainID    ids.ID
	TokenName       string
	TokenSymbol     string
	EVMChainID      string
	Version         string
	Networks        map[string]NetworkData
	ElasticChain    map[string]ElasticChain
	ImportedFromLPM bool
	ImportedVMID    string

	// Custom VM support
	CustomVMRepoURL     string
	CustomVMBranch      string
	CustomVMBuildScript string

	// L1/L2 Architecture (2025)
	Sovereign     bool   `json:"sovereign"`     // true for L1, false for L2/chain
	BaseChain     string `json:"baseChain"`     // For L2s: ethereum, lux-l1, lux, op-mainnet
	BasedRollup   bool   `json:"basedRollup"`   // true for L1-sequenced rollups
	SequencerType string `json:"sequencerType"` // based, centralized, distributed

	// Based Rollup Configuration
	InboxContract     string `json:"inboxContract"`     // Contract on base chain
	L1BlockTime       int    `json:"l1BlockTime"`       // Base chain block time in ms
	PreconfirmEnabled bool   `json:"preconfirmEnabled"` // Fast confirmations

	// Token & Economics
	TokenInfo  TokenInfo `json:"tokenInfo"`
	RentalPlan string    `json:"rentalPlan"` // For L1s: monthly, annual, perpetual

	// Validator Management
	ValidatorManagement   string `json:"validatorManagement"`             // proof-of-authority, proof-of-stake
	ValidatorManagerOwner string `json:"validatorManagerOwner,omitempty"` // Owner address for POA
	ProxyContractOwner    string `json:"proxyContractOwner,omitempty"`    // Owner address for proxy contract
	PoS                   bool   `json:"pos,omitempty"`                   // Whether using Proof of Stake
	UseACP99              bool   `json:"useACP99,omitempty"`              // Whether to use ACP-99

	// Migration info
	MigratedAt int64 `json:"migratedAt"` // When chain became L1

	// Chain layer (1=L1, 2=L2, 3=L3)
	ChainLayer int `json:"chainLayer"` // Default 2 for backward compat

	// EVM specific fields
	EVMMainnetChainID uint32 `json:"evmMainnetChainID,omitempty"`

	// Teleporter
	TeleporterReady            bool   `json:"teleporterReady,omitempty"` // Whether teleporter is deployed
	RunRelayer                 bool   `json:"runRelayer,omitempty"`      // Whether to run relayer
	TeleporterKey              string `json:"teleporterKey,omitempty"`   // Teleporter key
	TeleporterVersion          string `json:"teleporterVersion,omitempty"`
	TeleporterMessengerAddress string `json:"teleporterMessengerAddress,omitempty"`
	TeleporterRegistryAddress  string `json:"teleporterRegistryAddress,omitempty"`

	// Extra network-specific data (for L3 support etc)
	ExtraNetworkData map[string]interface{} `json:"extraNetworkData,omitempty"`

	// Validator Manager address for L1 deployments (legacy)
	ValidatorManagerAddress string `json:"validatorManagerAddress,omitempty"`

	// Protocol compatibility version
	ProtocolCompatibility string `json:"protocolCompatibility,omitempty"`

	// Validator staking configuration
	MinStake          uint64  `json:"minStake,omitempty"`
	RewardRate        float64 `json:"rewardRate,omitempty"`
	DelegationEnabled bool    `json:"delegationEnabled,omitempty"`

	// Protocol compatibility flags
	LuxCompatible  bool `json:"luxCompatible,omitempty"`
	WarpEnabled    bool `json:"warpEnabled,omitempty"`
	OPStackEnabled bool `json:"opStackEnabled,omitempty"`
	RollupSupport  bool `json:"rollupSupport,omitempty"`
}

func (sc Sidecar) GetVMID() (string, error) {
	// get vmid
	var vmid string
	if sc.ImportedFromLPM {
		vmid = sc.ImportedVMID
	} else {
		// Use the VMID field directly if not imported from LPM
		vmid = sc.VMID
	}
	return vmid, nil
}

// MigrationTx represents a chain to L1 migration transaction
type MigrationTx struct {
	ChainID             ids.ID `json:"chainId"`
	BlockchainID        ids.ID `json:"blockchainId"`
	ValidatorManagement string `json:"validatorManagement"`
	RentalPlan          string `json:"rentalPlan"`
	Timestamp           int64  `json:"timestamp"`
}

// NetworkDataIsEmpty checks if the sidecar has no network data
func (sc *Sidecar) NetworkDataIsEmpty() bool {
	return len(sc.Networks) == 0
}