parameters

Documentation

Index

• Constants
• Variables
• func InitL1(l1 *L1Params)
• func InitL1Lazy(f func())
• type BaseToken
• type L1Params
  • func L1() *L1Params
  • func L1NoLock() *L1Params

Constants

const MaxPayloadSize = iotago.BlockBinSerializedMaxSize -
	serializer.OneByte -
	serializer.OneByte -
	(iotago.BlockMaxParents * iotago.BlockIDLength) -
	serializer.UInt32ByteSize -

	serializer.UInt64ByteSize // Nonce

Variables

var (
	L1ForTesting = &L1Params{

		MaxPayloadSize: MaxPayloadSize,
		Protocol: &iotago.ProtocolParameters{
			Version:     tpkg.TestProtoParas.Version,
			NetworkName: tpkg.TestProtoParas.NetworkName,
			Bech32HRP:   tpkg.TestProtoParas.Bech32HRP,
			MinPoWScore: tpkg.TestProtoParas.MinPoWScore,
			RentStructure: iotago.RentStructure{
				VByteCost:    10,
				VBFactorData: 1,
				VBFactorKey:  1,
			},
			TokenSupply: tpkg.TestProtoParas.TokenSupply,
		},
		BaseToken: &BaseToken{
			Name:            "Iota",
			TickerSymbol:    "MIOTA",
			Unit:            "MIOTA",
			Subunit:         "IOTA",
			Decimals:        6,
			UseMetricPrefix: false,
		},
	}
)

Functions

func InitL1

func InitL1(l1 *L1Params)

func InitL1Lazy

func InitL1Lazy(f func())

InitL1Lazy sets a function to be called the first time L1() is called. The function must call InitL1().

Types

type BaseToken

type BaseToken struct {
	Name            string `json:"name" swagger:"desc(The base token name),required"`
	TickerSymbol    string `json:"tickerSymbol" swagger:"desc(The ticker symbol),required"`
	Unit            string `json:"unit" swagger:"desc(The token unit),required"`
	Subunit         string `json:"subunit" swagger:"desc(The token subunit),required"`
	Decimals        uint32 `json:"decimals" swagger:"desc(The token decimals),required"`
	UseMetricPrefix bool   `json:"useMetricPrefix" swagger:"desc(Whether or not the token uses a metric prefix),required"`
}

type L1Params

type L1Params struct {
	MaxPayloadSize int                        `json:"maxPayloadSize" swagger:"required"`
	Protocol       *iotago.ProtocolParameters `json:"protocol" swagger:"required"`
	BaseToken      *BaseToken                 `json:"baseToken" swagger:"required"`
}

L1Params describes parameters coming from the L1Params node

func L1

func L1() *L1Params

func L1NoLock

func L1NoLock() *L1Params