sifgen

package
v1.4.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 21, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

README

Sifgen

Initialize a new network

To initialize a new network, run:

sifgen network create <chain-id> <node-count> <output-dir> <seed-ip-address>

Where:

Parameter Description
chain-id The Chain ID.
node-count The number of nodes (validators) to generate config for.
output-dir The root directory of where all the config files should be written to.
seed-ip-address The IP (v4) address of the seed node.

This will then output all the necessary keys and genesis files that are required to boot a new network.

Create a new node

In addition to creating a new network, you can also create a node (listener/witness) to connect to an existing network, by running:

sifgen node create <chain-id> <peer-address> <genesis-url>

Where:

Parameter Description
chain-id The Chain ID.
peer-address The peer address of the existing network node/validator to connect to.
genesis-url The URL of the genesis file to use.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Sifgen

type Sifgen struct {
	// contains filtered or unexported fields
}

func NewSifgen

func NewSifgen(chainID *string) Sifgen

func (Sifgen) KeyGenerateMnemonic

func (s Sifgen) KeyGenerateMnemonic(name, password string)

func (Sifgen) KeyRecoverFromMnemonic

func (s Sifgen) KeyRecoverFromMnemonic(mnemonic string)

func (Sifgen) NetworkCreate

func (s Sifgen) NetworkCreate(count int, outputDir, startingIPAddress string, outputFile string)

func (Sifgen) NetworkReset

func (s Sifgen) NetworkReset(networkDir string)

func (Sifgen) NewNetwork

func (s Sifgen) NewNetwork(keyringBackend string) *network.Network

func (Sifgen) NewNode

func (s Sifgen) NewNode(keyringBackend string) *node.Node

func (Sifgen) NodeReset

func (s Sifgen) NodeReset(nodeHomeDir *string)

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL