package
1.12.3-warp-verify6
Repository: https://github.com/ava-labs/avalanchego.git
Documentation: pkg.go.dev

# README

Genesis

The Genesis package converts formatted JSON files into the genesis of the Primary Network. For the simplest example, see the Local Genesis JSON file.

The genesis JSON file contains the following properties:

  • networkID: A unique identifier for the blockchain, must be a number in the range [0, 2^32).
  • allocations: The list of initial addresses, their initial balances and the unlock schedule for each.
  • startTime: The time of the beginning of the blockchain, it must be a Unix timestamp and it can't be a time in the future.
  • initialStakeDuration: The stake duration, in seconds, of the validators that exist at network genesis.
  • initialStakeDurationOffset: The offset, in seconds, between the end times of the validators that exist at genesis.
  • initialStakedFunds: A list of addresses that own the funds staked at genesis (each address must be present in allocations as well)
  • initialStakers: The validators that exist at genesis. Each element contains the rewardAddress, NodeID and the delegationFee of the validator.
  • cChainGenesis: The genesis info to be passed to the C-Chain.
  • message: A message to include in the genesis. Not required.

Allocations and Genesis Stakers

Each allocation contains the following fields:

  • ethAddr: Annotation of corresponding Ethereum address holding an ERC-20 token
  • avaxAddr: X/P Chain address to receive the allocation
  • initialAmount: Initial unlocked amount minted to the avaxAddr on the X-Chain
  • unlockSchedule: List of locked, stakeable UTXOs minted to avaxAddr on the P-Chain

Note: if an avaxAddr from allocations is included in initialStakers, the genesis includes all the UTXOs specified in the unlockSchedule as part of the locked stake of the corresponding genesis validator. Otherwise, the locked UTXO is created directly on the P-Chain.

# Packages

No description provided by the author

# Functions

Aliases returns the default aliases based on the network ID.
No description provided by the author
FromConfig returns: 1.
FromFile returns the genesis data of the Platform Chain.
FromFlag returns the genesis data of the Platform Chain.
GetBootstrappers returns all default bootstrappers for the provided network.
GetCheckpoints returns all known checkpoints for the chain on the requested network.
No description provided by the author
GetConfigContent loads a *Config from a provided environment variable.
GetConfigFile loads a *Config from a provided filepath.
No description provided by the author
No description provided by the author
GetValidators returns recent validators for the requested network.
SampleBootstrappers returns the some beacons this node should connect to.
No description provided by the author

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

No description provided by the author
No description provided by the author
FujiConfig is the config that should be used to generate the fuji genesis.
FujiParams are the params used for the fuji testnet.
LocalConfig is the config that should be used to generate a local genesis.
LocalParams are the params used for local networks.
MainnetConfig is the config that should be used to generate the mainnet genesis.
MainnetParams are the params used for mainnet.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

No description provided by the author
Represents the relationship between the nodeID and the nodeIP.
Config contains the genesis addresses used to construct a genesis.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
UnparsedConfig contains the genesis addresses used to construct a genesis.
No description provided by the author