models

Documentation

Overview

Copyright (C) 2022, Ava Labs, Inc. All rights reserved. See the file LICENSE for licensing terms.

Copyright (C) 2022, Ava Labs, Inc. All rights reserved. See the file LICENSE for licensing terms.

Copyright (C) 2022, Ava Labs, Inc. All rights reserved. See the file LICENSE for licensing terms.

Copyright (C) 2022, Ava Labs, Inc. All rights reserved. See the file LICENSE for licensing terms.

Copyright (C) 2022, Ava Labs, Inc. All rights reserved. See the file LICENSE for licensing terms.

Copyright (C) 2022, Ava Labs, Inc. All rights reserved. See the file LICENSE for licensing terms.

Copyright (C) 2022, Ava Labs, Inc. All rights reserved. See the file LICENSE for licensing terms.

Index

• Constants
• type AvagoCompatiblity
• type ClusterConfig
• type Config
• type ElasticSubnet
• type ElasticSubnetConfig
• type Exportable
• type Network
  • func NetworkFromNetworkID(networkID uint32) Network
  • func NetworkFromString(s string) Network
  • func (s Network) NetworkID() (uint32, error)
  • func (s Network) String() string
• type NetworkData
• type NodeConfig
• type PermissionlessValidators
• type Sidecar
  • func (sc Sidecar) GetVMID() (string, error)
• type VMCompatibility
• type VMType
  • func VMTypeFromString(s string) VMType
  • func (v VMType) RepoName() string

Constants

const (
	SubnetEvm   = "Subnet-EVM"
	BlobVM      = "Blob VM"
	TimestampVM = "Timestamp VM"
	CustomVM    = "Custom"
)

Types

type AvagoCompatiblity

type AvagoCompatiblity map[string][]string

type ClusterConfig

type ClusterConfig struct {
	KeyPair  map[string]string   // maps key pair name to cert path
	Clusters map[string][]string // maps clusterName to nodeID list
}

type Config

type Config struct {
	MetricsEnabled bool
}

type ElasticSubnet

type ElasticSubnet struct {
	SubnetID    ids.ID
	AssetID     ids.ID
	PChainTXID  ids.ID
	TokenName   string
	TokenSymbol string
	Validators  map[string]PermissionlessValidators
	Txs         map[string]ids.ID
}

type ElasticSubnetConfig

type ElasticSubnetConfig struct {
	SubnetID                 ids.ID
	AssetID                  ids.ID
	InitialSupply            uint64
	MaxSupply                uint64
	MinConsumptionRate       uint64
	MaxConsumptionRate       uint64
	MinValidatorStake        uint64
	MaxValidatorStake        uint64
	MinStakeDuration         time.Duration
	MaxStakeDuration         time.Duration
	MinDelegationFee         uint32
	MinDelegatorStake        uint64
	MaxValidatorWeightFactor byte
	UptimeRequirement        uint32
}

type Exportable

type Exportable struct {
	Sidecar Sidecar
	Genesis []byte
}

type Network

type Network int64

const (
	Undefined Network = iota
	Mainnet
	Fuji
	Local
)

func NetworkFromNetworkID

func NetworkFromNetworkID(networkID uint32) Network

func NetworkFromString

func NetworkFromString(s string) Network

func (Network) NetworkID

func (s Network) NetworkID() (uint32, error)

func (Network) String

func (s Network) String() string

type NetworkData

type NetworkData struct {
	SubnetID     ids.ID
	BlockchainID ids.ID
	RPCVersion   int
}

type NodeConfig

type NodeConfig struct {
	NodeID        string // instance id on cloud server
	Region        string // region where cloud server instance is deployed
	AMI           string // image id for cloud server dependent on its os (e.g. ubuntu )and region deployed (e.g. us-east-1)
	KeyPair       string // key pair name used on cloud server
	CertPath      string // where the cert is stored in user's local machine ssh directory
	SecurityGroup string // security group used on cloud server
	ElasticIP     string // public IP address of the cloud server
}

type PermissionlessValidators

type PermissionlessValidators struct {
	TxID ids.ID
}

type Sidecar

type Sidecar struct {
	Name            string
	VM              VMType
	VMVersion       string
	RPCVersion      int
	Subnet          string
	TokenName       string
	ChainID         string
	Version         string
	Networks        map[string]NetworkData
	ElasticSubnet   map[string]ElasticSubnet
	ImportedFromAPM bool
	ImportedVMID    string
}

func (Sidecar) GetVMID

func (sc Sidecar) GetVMID() (string, error)

type VMCompatibility

type VMCompatibility struct {
	RPCChainVMProtocolVersion map[string]int `json:"rpcChainVMProtocolVersion"`
}

type VMType

type VMType string

func VMTypeFromString

func VMTypeFromString(s string) VMType

func (VMType) RepoName

func (v VMType) RepoName() string